[Chapter 34] 34.13 Hold Space: The Set-Aside Buffer
Author: Jerry Peek, Tim O'Reilly & Mike Loukides
Date: 1998-08-04T21:47:20Z

#

| Chapter 34 The sed Stream Editor |

## 34.13 Hold Space: The Set-Aside Buffer

The pattern space is a buffer (52.9) that contains the current input line. There is also a set-aside buffer called the hold space. The contents of the pattern space can be copied to the hold space, and the contents of the hold space can be copied to the pattern space. A group of commands allows you to move data between the hold space and the pattern space. The hold space is used for temporary storage, and that's it. Individual commands can't address the hold space or alter its contents.

The most frequent use of the hold space is to have it retain a duplicate of the current input line while you change the original in the pattern space. [It's also used as a way to do the "move" and "copy" commands that most editors have - but which sed can't do directly because it's designed for editing a stream of input text line-by-line. -GU ] The commands that affect the hold space are:

Hold | h or H | Copy or append contents of pattern space to hold space.
Get | g or G | Copy or append contents of hold space to pattern space.
Exchange | x | Swap contents of hold space and pattern space.

Each of these commands can take an address that specifies a single line or a range of lines. The hold commands (h,H ) move data into the hold space and the get commands (g,G ) move data from the hold space back into the pattern space. The difference between the lowercase and uppercase versions of the same command is that the lowercase command overwrites the contents of the target buffer, while the uppercase command appends to the existing contents. The hold command replaces the contents of the hold space with the contents of the pattern space. The get command replaces the contents of the pattern space with the contents of the hold space.

The Hold command puts a newline followed by the contents of the pattern space after the contents of the hold space. (The newline is appended to the hold space even if the hold space is empty.) The Get command puts a newline followed by the contents of the hold space after the contents of the pattern space.

The exchange command (x) swaps the contents of the two buffers. It has no side effects on either buffer.

Here's an example to illustrate putting lines into the hold space and retrieving them later. We are going to write a script that reads a particular HTML file and copies all headings to the end of the file for a summary. The headings we want start with `<H1>` or `<H2>`. For example:

>     ...
>     <BODY>
>     <H1>Introduction</H1>
>     The blah blah blah
>     <H1>Background of the Project</H1>
>        ...
>     <H2>The First Year</H2>
>        ...
>     <H2>The Second Year</H2>
>        ...
>     </BODY>

The object is to copy those headings into the hold space as sed reads them. When sed reaches the end of the body (at the `</BODY>` tag), output `Summary:`; then output the saved tags, without the heading tags (`<H1>` or `<H2>`).

Look at the script:

>     /^<H[12]>/H
>     /^<\/BODY>/ {
>         i\
>     <STRONG>Summary:</STRONG>
>         x
>         G
>         s/<\/*H[12]>//g
>     }

Any line matching `<H1>` or `<H2>` is added to the hold space. (All those lines are also printed; that's the default in sed unless lines have been deleted.) The last part of the script watches for the `</BODY>` tag. When it's reached, sed inserts the `Summary:` heading. Then the script uses `x` to exchange the pattern space (which has the `</BODY>` tag) with the saved headers from the hold space. Now the pattern space has the saved headers. Next, a `G` adds the `</BODY>` tag to the end of the headers in the pattern space. Finally, a substitute command strips the `<H1>`, `</H1>`, `<H2>`, and `</H2>` tags. At the end of the script, the pattern space is printed by default.

The sequence of x followed by G is a way to find a matching line - in this case, `</BODY>`-and insert the contents of the hold space before the matched line. In other words, it's like an i command that inserts the hold space at the current line.

The script could do more cleanup and formatting. For instance, it could make the saved headings into a list with `<UL>` and `<LI>`. But this example is mostly about the hold space.

Here's the result of running the script on the sample file:

>     % sed -f sedscr report.html
>        ...
>     <BODY>
>     <H1>Introduction</H1>
>     The blah blah blah
>     <H1>Background of the Project</H1>
>        ...
>     <H2>The First Year</H2>
>        ...
>     <H2>The Second Year</H2>
>        ...
>     <STRONG>Summary:</STRONG>

>     Introduction
>     Background of the Project
>     The First Year
>     The Second Year
>     </BODY>

For other scripts that use the hold space, see articles 34.17 and 25.12. For a fanciful analogy that makes clear how it works, see article 34.16.

- DD, JP

34.12 Transformations on Text |  | 34.14 Transforming Part of a Line