chpp

Tutorial and Reference

last updated 13 January 1998 for version 0.2

Mark Probst (schani@unix.cslab.tuwien.ac.at)


Table of Contents


Introduction

chpp is a preprocessor. Therefore, its main purpose is to modify input text by including other input files and by macro expansion. Programs performing these tasks already exist, among them the popular C Preprocessor (cpp) and m4, which have proven to be convenient and valuable tools suitable for a variety of tasks. The motivation for chpp is thus questionable.

What distinguishes chpp from at least the two programs mentioned above are mainly two features:

chpp consists of two parts which could, in some sense, be seen as two separate passes over the input file. This is not entirely true, though, since the two parts are intertwined and cannot be separated. The first part, which performs command processing, is similar to what cpp does. It allows the inclusion of other files, simple macro definitions and conditional inclusion and exclusion of parts of the input. The second part does macro processing and is the actual workhorse and core of chpp.

Although macro processing on its own could do anything that can be accomplished with commands, the latter are not only easier to use but also easier to read and therefore improve clarity.

What chpp stands for

chpp does not stand for Chakotay Preprocessor.

Uses for chpp

chpp can be used very well as

What chpp should not be used for

chpp should, due to its nature, not be used for

Planned but not yet Implemented Features

We are planning to change chpp's dynamic scoping to a lexical scoping scheme. Furthermore, we want to introduce references (i.e. pointers) to the language, which also implies the need for garbage collection. These two features would not only make chpp a cleaner language but should also open the possibility of making the chpp interpreter a lot faster.

We would also like to add a few extension packages to chpp, which will make it more suitable for and easier to apply to various applications, most notably CGI scripting, HTML generation and database interfacing.

Obtaining chpp

chpp is available for free download on the world-wide-web. Point your web-browser at @url{http://chakotay.ml.org/} (or @url{http://chakotay.ml.org/chpp/} if you are using an ancient browser). From there you can download the latest version of chpp.

The History of chpp

Not much here, yet.

Problems and Known Bugs

chpp is far from error-free in its current version. It works quite reliably now when not stressed too far, though. The biggest problem is currently that chpp's error handling is insufficient. chpp does not report some errors, while others cause it to crash or to end up in an endless loop. We do of course plan to change this in the future.

Reporting Bugs

Before you tell us about a bug, please check that you are using the latest version of chpp (see section Obtaining chpp). If this is not the case, please upgrade and try again.

Please do not report bugs that concern chpp's error handling. We know that it is unreliable and buggy and will change that. You should, however, report any incident where chpp does anything wrong with a script which you believe is correct. In such a case, please write us an email containing the script that causes chpp to fail and any additional files that your script needs. Better yet, try to narrow the bug down to the smallest script possible. Do also include information on the configuration you ran chpp on, especially if the bug only happens to show up with this configuration. The email address you should send your bug-report to is @email{chpp@unix.cslab.tuwien.ac.at}.

Licence and Warranty

chpp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

chpp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with chpp; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

The Authors

chpp was designed and implemented by Heinz Deinhart and Mark Probst. Check out the chpp homepage (see section Obtaining chpp) for more information.

Acknowledgements

Our thanks go to Tatjana Svizensky for proofreading this manual and to Herbert P@"otzl for donating the hash-table functions, which we were too lazy, erm, too busy to implement, and for not reading the examples chapter of this document.

A Guided Tour through chpp

Invoking chpp

To get a quick overview of chpp command line syntax, just type

chpp --help

The general chpp syntax is

chpp [option ...] [filename ...]

chpp reads and processes all specified files in sequential order, as if they were one file. If no file is specified, chpp reads from standard input. Output is written to standard output if not otherwise specified.

The following is a summary and description of all available chpp options:

--version
Prints out the version number of the invoked chpp.
--help
Prints out a summary of chpp command line syntax.
--output filename
-o filename
Specifies that output should be written to file filename.
--include-dir dir
-I dir
Adds dir to the list of standard include directories.
-D name=value
Defines the chpp variable name with the value value.
--generate-dependencies
-M
Generates a dependency list suitable for make like cpp.

Examples

This chapter gives a few more practical examples of the use of chpp, illustrating a few of its many possible applications.

Song Lyrics

Let us assume you have gathered a collection of song lyrics by various performers as text files. You wish to generate not only HTML files for all the songs but also an index page for each performer which contains, sorted by album, hyperlinks to all the song HTML files.

The song files you have collected all look like this:

Gloria

I try to sing this song.
I try to stand up.
But I can't find my feet.
I try, I try to speak up.
But only in you I'm complete.
...

Furthermore, assume you have created a directory for each performer containing a directory for each album where the song files reside. The names of the directories not necessarily match the corresponding performer's name or the album's, as these often contain spaces, which are uncommon in file names. The same applies to the song file names. Thus, our first task is to somehow associate the names of the performers, albums and songs with the song files. We have a bonus for the song names since these are included in the song files themselves (in the first line). For simplicity we will include this information in the files themselves, namely as HTML comments containing assignments in chpp syntax. To modify the files, we will use the following chpp script:

#include files.chh
%<file=%fopen(%SONGFILENAME)>\
%<songname=%removews(%fgets(%file))>\
<!-- %%<song=%songname>%%<album=%ALBUM>%%<perf=%PERF> -->
%frest(%file)\
%fclose(%file)\

The variables SONGFILENAME, ALBUM and PERF must be set via the command-line. We can now convert all files in one album with the following shell-command (assuming we are in the correct directory and that all song files have the extension `.txt'):

$ pwd
/home/schani/lyrics/u2/october
$ for fn in *.txt ; do
>   chpp -DSONGFILENAME=$fn -DALBUM='October' \
>        -DPERF='U2' ../../convert.ch >../$fn
> done

Note that we have generated the modified files in the performer's directory. After we have done this for all albums, we can delete the album directories. The song files now look like this:

<!-- %<song=Gloria>%<album=October>%<perf=U2> -->

I try to sing this song.
I try to stand up.
But I can't find my feet.
I try, I try to speak up.
But only in you I'm complete.
...

We will now generate HTML files for the songs. For simplicity, we will generate a simple HTML file which contains the song text in a <pre> block:

#include files.chh
%<file=%fopen(%SONGFILENAME)>%void(%{%fgets(%file)})\
\
<html> <head>
<title>%song - %album - %perf</title>
</head> <body>
<h1>%song</h1>
<pre>
%frest(%file)\
</pre>
</body>
</html>
%fclose(file)\

Since the information about the song title, album and performer is coded as chpp code in the first line, we can obtain it by just evaluating it and ignoring its result. With this script we can now generate HTML files for all songs of one performer with the following bash command:

$ pwd
/home/schani/lyrics/u2
$ for fn in *.txt ; do
>   chpp -DSONGFILENAME=$fn ../template.ch >${fn%.txt}.html
> done

Finally, we need to generate an index file for each performer containing hyperlinks to all songs. This file is generated by the following chpp script:

#include files.chh
%<albums=%hash()>\
%<file=%fpipe(/bin/sh,-c,ls *.txt)>\
%foreach(songfilename,%split(%removews(%frest(file)),%"[ \n]+"),
    %<songfile=%fopen(%songfilename)>\
    %void(%{%fgets(%songfile)})\
    %fclose(%songfile)\
    %<htmlfile=%void(%match(%"(.*)\\.",%songfilename))%1.html>\
    %ifdefkey(%albums,%album,
        %<albums{%album}{%song}=%htmlfile>
    ,
        %<albums{%album}=%hash(%song,%htmlfile)>
    )\
)\
%fclose(file)\
\
<html>
<head>
<title>%perf</title>
</head>
<body>
<h1>%perf</h1>
%foreach(album,%sort(%keys(%albums)),\
    <h2>%album</h2>%"\n"<blockquote>%"\n"\
    %foreach(song,%sort(%keys(%albums{%album})),\
        <p><a href="%albums{%album}{%song}">%song</a>%"\n"\
    )\
    </blockquote>%"\n"\
)\
</body>
</html>

The first part of the file gets all information about the songs in the current directory. It generates an entry in the hash %albums for each album, which in turn is a hash containing all names of the HTML files indexed by the song names. The second part just iterates through this table, producing an <h2> for each album and an anchor for each song within.

Web Site

Suppose you were to create a web-site with three main pages: News, Tips and Tricks. Each of these pages should have a layout similar to this:

  N   N EEEE W     W  SSS         News
  NN  N E    W     W S
  N N N EEE   W W W   SSS         _Tips_
  N  NN E     W W W      S
  N   N EEEE   W W    SSS         _Tricks_

--------------------------------------------

This is good news!

--------------------------------------------

         News | _Tips_ | _Tricks_

The header consists of a big graphic banner denoting the title of this particular page. On the right side of the banner are three little graphics, each standing for one of the pages. Two of them lead to the other two pages, whereas the one for the actual page is not functional and grayed out.

The footer consists of a textual link bar with two active links and one 'inactive link' (normal text) for the actual page.

Although these three pages are easy to implement with conventional methods, this becomes increasingly difficult when there are more pages or even hierarchical structures of pages. We will thus use this as an example of how to easily create HTML pages with chpp, leaving more sophisticated designs to the gentle reader.

Ideally, we would like, say, the news source file (which we name `news.csml'), as rendered above, to look like this:

#include header.chml

This is good news!

#include footer.chml

This way, we need not be concerned with the design of the header and footer when we work on the pages and we can easily modify the header and footer in one central place, although they apply to our whole web-site.

Now we need a place where we can enter all the names of the main pages of our web-site and associate them with their corresponding files. We call this file `menu.chml':

%addmenuentry(News,news.csml)
%addmenuentry(Tips,tips.csml)
%addmenuentry(Tricks,tricks.csml)

We simply assume that the generated HTML files will have the same base-name as the sources but the extension `.html'. We furthermore assume that for each main-page we have three additional graphics available, namely one containing the large banner and two containing the small icons, where one of the two is grayed out. These images have the format JPEG, hence the extension `.jpg'. Their base-names consist of the base-names of their main-pages followed by one of the suffixes `_l', `_s' and `_s_g', where `l' denotes large, `s' small and `g' gray.

The include-file `header.chml' fulfills two purposes: Firstly, it must process the information of the file `menu.chml' and secondly, it must generate the header of the HTML file. Since the latter depends on the former, we will focus our attention on processing the information of `menu.chml'. Each main page will be represented by a hash containing the keys filename, name, htmlfilename, imglarge, imgsmall and imgsmallgray, the meanings of which should be obvious. We will collect all these hashes in a list named menu, which will contain these hashes in the order in which they were entered in `menu.chml'. Since `menu.chml' is already in chpp syntax, all we need to do is to define a macro addmenuentry which creates such a hash and appends it to the list menu:

%<menu=%list()>\
%define(addmenuentry,name,filename,
    %<basename=%void(%match(%"(.*)\\.csml$",%filename))%1>\
    %<menu=%append(%menu,
        %hash(filename,%filename,
              name,%name,
              htmlfilename,%basename.html,
              imglarge,%<basename>_l.jpg,
              imgsmall,%<basename>_s.jpg,
              imgsmallgray,%<basename>_s_g.jpg))>
)\

Now we can include `menu.chml' for its side-effects:

%void(
#include menu.chml
)\

Finally, for convenience, we define a variable thisentry which contains the hash that applies to the currently processed page:

%<thisentry=%foreach(menuentry,%menu,
    %if(%streq(%menuentry{filename},%mainfilename),%menuentry))>\

Now we are set and can generate the header of the HTML file:

<html>
<head>
<title>%thisentry{name}</title>
</head>
<body>
<table>
<td>
<img src="%thisentry{imglarge}" alt="%thisentry{name}">
<td>
#include choicestrip.chml
</table>
<hr>

The file `choicestrip.chml' generates a vertical table consisting of the small images for the main-pages with links. It is quite simple:

<table border=0 cellspacing=0 cellpadding=0>
%foreach(menuentry,%menu,
    <tr><td>\
    %if(%streq(%menuentry{filename},%thisentry{filename}),
        <img src="%menuentry{imgsmallgray}" alt="%menuentry{name}">
    ,
        <a href="%menuentry{htmlfilename}">\
        <img border=0 src="%menuentry{imgsmall}" alt="%menuentry{name}">\
        </a>
    )
)
</table>

The footer is even more simple: It contains a horizontal rule and a choice-bar:

<hr>
#include choicebar.chml
</body>
</html>

`choicebar.chml' is similar to `choicestrip.chml':

<h5><center>
%<barentries=%list()>\
%foreach(menuentry,%menu,
    %<barentries=%append(%barentries,
        %if(%streq(%menuentry{filename},%thisentry{filename}),
            %menuentry{name}
        ,
            <a href="%menuentry{htmlfilename}">%menuentry{name}</a>
        )
    )>
)\
%join(%" | ",%barentries)
</center></h5>

All we need now is a comfortable way to create all HTML files from the sources. This is what makefiles are for. They have the additional advantage that files are regenerated only when needed, i.e. when of the files that the file to be created depends on has changed. A makefile for gnumake suitable for our simple purposes would look like this:

CHFILES=header.chml footer.chml choicebar.chml choicestrip.chml

all : news.html tips.html tricks.html

%.html : %.csml
	../../macros -o $ $<

news.html tricks.html tips.html : $(CHFILES)

clean :
	rm -f news.html tips.html tricks.html

Tautogen

Suppose we have a simple context-sensitive grammar, which we want to use to generate sentences, which is quite the opposite of parsing sentences of that grammar. To illustrate this more clearly, let us assume we have file like this:

--sentence
$subject $verb $object.
$subject, while $gerund $object, $verb $object.
$subject watches $object $gerund $object.

--subject
$person
The $adjective $person

--object
$person

--person
Butthead
Mrs Krabappel
Charlie Brown
Mrs Robinson

--adjective
observant
naive
embarassed

--verb
kisses
kicks
envies

--gerund
holding
zapping
hugging
smashing

The file is separated into several categories containing so-called productions for so-called non-terminals. The first non-terminal is called the start non-terminal, which is, in out case, sentence. We start by picking by random one of the right-hand-sides of the productions of the start non-terminal (i.e. one of the lines following the introduction of sentence). Now we repeat the following cycle until our string contains no more placeholders (words prefixed by the dollar sign ($)): Replace the first placeholder by the right-hand-side of a randomly picked production for that placeholder.

The process could evolve like this:

$sentence
$subject, while $gerund $object, $verb $object.
The $adjective $person, while $gerund $object, $verb $object.
The naive $person, while $gerund $object, $verb $object.
The naive Charlie Brown, while $gerund $object, $verb $object.
The naive Charlie Brown, while hugging $object, $verb $object.
The naive Charlie Brown, while hugging $person, $verb $object.
The naive Charlie Brown, while hugging Mrs Robinson, $verb $object.
The naive Charlie Brown, while hugging Mrs Robinson, kicks $object.
The naive Charlie Brown, while hugging Mrs Robinson, kicks $person.
The naive Charlie Brown, while hugging Mrs Robinson, kicks Butthead.

It is easy to see that this simple algorithm even allows for recursive grammars.

This example is not a typical application for a pre-processor. It should rather demonstrate that chpp can be used very succesfully for tackling problems not in its direct field of application, i.e. that it is suitable for more general problems.

You may have noticed that our grammar file is not in chpp syntax, so we have the choice of either converting it or parsing it at run-time. Since the former has the disadvantage of being more complicated in usage (the grammar would have to be converted each time it is changed) and is not easier to implement than the letter, the choice is obvious.

The first step of our application is reading in the grammar file, which we call `grammar'. Its content will be stored in a hash data, where the keys are the names of the non-terminals and the values are the lists of the right-hand-sides of the corresponding productions.

%<file=%fopen(grammar)>\
%<current=runaway>\
%<data=%hash(runaway,%list())>\
%until(%feof(%file),
    %<line=%removews(%fgets(%file))>\
    %if(%[%match(%"^--([a-zA-Z0-9_]+)",%line)!=-1],
        %<current=%1>\
        %<data{%current}=%list()>\
        %ifdef(start,,%<start=%current>)
    ,
        %if(%line,%<data{%current}[%listlength(%data{%current})]=%line>)
    )
)\
%fclose(%file)\

We then proceed to define some variables and macros. First, if the variable n, which will denote the number of sentences generated, is not defined (it could be defined on the command-line), it is set to 10:

%ifdef(n,,%<n=10>)\

The macro some, when called with the name of a non-terminal, returns the right-hand-side of a random production for that non-terminal:

%define(some,nt,%data{%nt}[%random(%listlength(%data{%nt}))])\

The generation of the sentences is now a fairly trivial task:

%for(i,1,%n,
    %<current=%some(%start)>\
    %while(%<mp=%match(%"\\$([a-zA-Z0-9_]+)",%current)>%[mp!=-1],
        %<current=%replacesubstring(%current,%mp,%strlength(%0),%some(%1))>
    )\
    %current%"\n\n"
)\

Language Reference

Files processed with chpp are passed through two stages, which are, however, not sequential in nature but can rather be viewed as coroutines. The first stage processes commands (see section Commands). Command processing is a sequential process, i.e. no loops or recursions occur. The second stage is macro processing (see section The Meta-Char) and allows for loops as well as for recursion.

Commands

Command processing is line-oriented. It affects only lines which have, as their first non-whitespace character, the command-char (#). All other lines are passed through literally. Another function of command processing is the concatenation of lines: If the last character of a line is the backslash (\), then the backslash, the following newline and all leading whitespace of the next line are ignored.

A line invoking a command consists of optional whitespace at the beginning, the command-char #, optional whitespace, the command name, whitespace and the command arguments (if any). Thus, the following lines are all commands (given that the command names exist):

#abc
    #def arg
 #  ghi too many arguments

while the following lines are not:

this is a line without commands.
although this line contains a # it is not a command.

Command Reference

Command: include filename

Command: define name[(argname[,argname...])] value

Command: edefine name

Command: if condition

Command: ifdefined symbol
Command: ifdef symbol

Command: ifnotdefined symbol
Command: ifndef symbol

Command: error message

Command: discard
Command: disc

The Meta-Char

The second stage processes everything that is passed through by the first stage. It is called macro processing because its main use is the expansion of macros. There is just one special character for this stage, namely the meta-char (%). Only character sequences beginning with the meta-char are modified by the macro processing stage. All other characters are simply passed through. Since chpp was designed to be non-intrusive, even uses of the meta-char which do not correspond to the uses described in this chapter are copied verbatim. For example:

Temerature today is 10% above normal.
=> Temperature today is 10% above normal.

In cases where it is absolutely necessary that the meta-char not be interpreted as special, it can be quoted with itself (i.e. %%), yielding one meta-char. Example:

%<heinz=deinz>\
%%heinz evals to %heinz.
=> %heinz evals to deinz.

Data Types

The only primitive type in chpp is the string. Values of that type are referred to as scalars (see section Scalars). Values of any type can be combined arbitrarily to lists (see section Lists) and hashes (see section Hashes). Macros (see section Macros) also form a data type as they can be stored and used, even though they cannot be directly manipulated.

Scalars

Scalars are strings of arbitrary length (including the length 0).

Lists

Lists are ordered collections of arbitrary values indexed by consecutive numbers starting at 0. It follows that lists cannot have holes.

Hashes

Hashes are ordered collections of arbitrary values indexed by arbitrary scalars, i.e. they establish a so-called key/value mapping.

Macros

Macros are what most programming languages call functions. A macro in chpp is a body of text which can be parameterized by formal arguments which are implicitly assigned the values of the actual arguments in a local scope upon invocation. Thus, having defined a macro

%define(hello,name,Gruess Dich Gott %name!)

calling the macro with the argument Heinz

%hello(Heinz)

is semantically equivalent to

%locals(name,%<name=Heinz>Gruess Dich Gott %name!)

Variables

In order to be able to retain values for subsequent use it is necessary to store them in variables.

Accessing Variables

There are two different syntactic forms of variable access, called the short and the long form.

The short form consists of the meta-char followed by the variable name, e.g. %name. The variable name is taken as-is, i.e. is not evaluated. The variable name ends with the first char that is not a letter, a digit or the underscore (_). If a variable with the given name does not exist, the whole string is not interpreted as a variable access and is copied verbatim, i.e. %name evaluates to %name if there is no variable with the name name.

The long form consists of the meta-char followed by the variable name within angle brackets, e.g. %<name>. The variable name is evaluated before the variable is looked up, making it possible, for example, to use variable names containing right angle brackets: The term %<%">>>"> accesses the variable >>>. If a variable with the name does not exists, an error message is issued.

List and Hash Subscription

If the variable is a list or a hash, it can be subscribed by appending the index in brackets or curly braces to the name, in both the short and the long form. In order to access nested data structures, any number of such indexes can be used in one access, for example %name[3]{foo}.

Macro Invocation

A macro can be invoked by appending, in the short or long form of variable access, to the variable name or subscript a left parenthesis followed by the actual arguments separated by commas followed by a right parenthesis, e.g. %list(a,b). The value that is yielded by the macro invocation cannot be subscribed further, i.e. %list(a,b)[1] is not allowed. However, see section Subscribing Non-Variables.

Arguments of a macro-call are processed as follows: First, all leading and trailing whitespace from all arguments is removed. Then, the remaining strings are evaluated and the results are passed by-value as arguments to the macro. In order to pass an argument with leading or trailing whitespace to a macro, it must be quoted. For example:

%define(foobar,arg,"%arg")

%foobar(  xyz  )
=> "xyz"
%foobar(    )
=> ""
%foobar(  %"  "  )
=> "  "
%foobar(%"  xyz  ")
=> "  xyz  "

Subscribing Non-Variables

It is possible to subscribe values that are not variables, for example ones that are returned from macros, by using a modified long form of variable access. Instead of the variable name the expression yielding the value enclosed in parentheses is used. Upon evaluation, the expression is evaluated and all following subscriptions are applied to it. Example:

%<(%list(a,b))[1]>
=> b

Assignment

Assignment syntax is an enhancement of the long form of variable access. The last subscription (or the variable name, if no subscription is used) is followed by an equal sign (=) which is followed by an expression yielding the value to be assigned.

When assigning is attempted to an element of a list which is out of bounds, the list is enlarged. Elements between the formerly last element and the newly added element default to the empty string. Indexes less then 0 are not allowed.

Assigning to a key in a hash which is not part of it, adds the key/value pair to the hash.

It is not possible to assign to a subscript of a value which is not subscribable, i.e. it is not possible to do %<bar[3]=foo> if bar is not a list. To make bar an empty list, simply do %<bar=%list()>.

Assignment always copies the assigned value. In other words, there are no references or pointers. However, see section Planned but not yet Implemented Features.

Scoping Rules

chpp uses dynamic scoping (see, however, section Planned but not yet Implemented Features). This means that a variable is visible from the time its declaration is executed until the time its scope level ceases to exist. This also means that the scope of a variable is not immediately evident from the source of the program.

A new scope level is created when a macro is called and when the macro locals is executed. A macro call introduces a new scope level which contains all arguments to the macro, while local creates a new scope level with arbitrary variable names, which are initialized to be the empty string. The scope which is the one last created is called the innermost scope, while the outermost scope, which is always available, is referred to as the global scope.

Upon variable access all scopes starting with the innermost scope are tested for containing a variable with that name and, if one is found, that variable is used. If no scope containing a variable with that name is found, an error message is produced.

When a value is assigned to a variable, each scope, string with the innermost scope is searched for a variable bearing that name and, if one is found, the value is assigned to the variable in that scope. If the variable is not contained in any scope, a new variable is created in the global scope.

Arithmetic Expansion

chpp permits the evaluation of arithmetic expressions by enclosing the expression in square brackets ([]) preceded by the meta-char. The expression is first evaluated according to chpp rules and the resulting value is treated as an arithmetic expression which, in turn, yields a number. Whitespace between operators and operands is ignored. The following table is a summary of all available operators together with their arity. They are sorted by precedence, the first line being of the highest precedence. All binary operators evaluate from left to right. All operators have the same meaning as the corresponding operators in the C language.

@multitable @columnfractions .2 .8

  • Operators @tab Arity
  • !, ~, - @tab unary
  • *, /, % @tab binary
  • +, - @tab binary
  • <, >, <=, >= @tab binary
  • ==, != @tab binary
  • & @tab binary
  • ^ @tab binary
  • | @tab binary
  • && @tab binary
  • || @tab binary Precedence of operators can be overridden by using parentheses (()). In order to make arithmetic expressions more readable, it is allowed to refer to the values of variables within an arithmetic expression by writing its name--without a preceding meta-char. Note that subscription and macro invocation using this syntax is not allowed. Some examples:
    %[1+2]
    => 3
    %[1.5+3.3]
    => 4.800000
    %[3==3]
    => 1
    %[3!=3]
    => 0
    %[(1+2)*(3+4)]
    => 21
    %<x=4>%[%x+1]
    => 5
    %<x=4>%[x+1]
    => 5
    

    Quotation

    To prevent some string from evaluation, it can be quoted by enclosing it in a pair of double-quotes (""), preceded by the meta-char. The only special characters after the first double-quote are the quote-char (the backslash, \) and the closing double-quote. The quote-char gives special meanings to some characters following it: an n becomes a newline character and a t is interpreted as a tabulator. All other character preceded by the quote-char stand for themselves. This includes the quote-char and the double-quote, i.e. %"\\\"" evaluates to \".

    Explicit Evaluation

    In order to evaluate a string twice, for example to evaluate the contents of a variable, the string must be enclosed in curly braces ({}), preceded by the meta-char. Example:

    %<a=abc>%<b=%%a>%{%b}
    => abc
    

    Macro Reference

    Flow Control

    The macros in this section are special macros in that their arguments are not automatically evaluated before the macro-call but instead are evaluated by the macros themselves. Therefore it is exactly specified when the arguments to these macros are evaluated.

    Macro: if (condition,consequence[,alternative])
    Evaluates condition and, if its boolean value is TRUE, executed consequence. Otherwise, alternative is executed, if specified.

    Macro: ifdef (symbol,consequence[,alternative])
    Evaluates symbol. If a symbol with the resulting name exists, consequence is executed. Otherwise, if alternative is specified, it is executed.

    Macro: ifdefkey (hash,key,consequence[,alternative])
    Evaluates hash and key. If a key with the value of key is contained in the value of hash, consequence is executed. Otherwise, if alternative is specified, it is executed.

    Macro: for (counter,start,stop,[increment,]expr)
    Evaluates counter, start, stop and, if specified, increment. The values of start, stop and increment must be numbers. If increment is not specified, an increment of @math{1} is used if start is greater than stop, otherwise @math{-1}. The symbol counter is set to start. Then, while the value of counter is before or equal to stop in the counting direction, expr is executed and counter is incremented by increment.

    A few examples:

    %for(i,1,10,%i%" ")
    => 1 2 3 4 5 6 7 8 9 10
    %for(i,10,1,%i%" ")
    => 10 9 8 7 6 5 4 3 2 1
    %for(i,1,10,2,%i%" ")
    => 1 3 5 7 9
    %for(i,10,1,-2,%i%" ")
    => 10 8 6 4 2
    %for(i,1,10,0,%i%" ")
    error--> increment in for-loop cannot be zero
    %for(i,10,1,1,%i%" ")
    =>
    

    Macro: foreach (counter,list,expr)
    Evaluates counter and list, which must yield a list. Then iterates over this list, assigning each element to the symbol counter and executing expr.

    Macro: foreachkey (counter,hash,expr)
    Evaluates counter and hash, which must yield a hash. Then iterates over all keys in the hash, assigning each key to the symbol counter and executing expr.

    Macro: while (condition,expr)
    Evaluates condition. If this yields a boolean value of TRUE, expr is executed, otherwise the loop is finished. Then repeats the cycle.

    Macro: until (condition,expr)
    Evaluates condition. If this yields a boolean value of TRUE, the loop is finished, otherwise expr is executed. Then repeats the cycle.

    Macro: dowhile (expr,condition)
    Executes expr, then evaluates condition. If this yields a boolean value of TRUE, the cycle is repeated.

    Macro: dountil (expr,condition)
    Executes expr, then evaluates condition. If this yields a boolean value of TRUE, the loop is finished, otherwise the cycle is repeated.

    List Operations

    Macro: list ([element,...])
    Returns a list with all specified elements in that order, beginning with index 0. Note that %list() returns an empty list while %list(%"") returns a list with one element, which is the empty string.

    Macro: listlength (list)
    Returns the number of elements in the list list.

    Macro: split (string,regexp)
    Splits the string string into parts separated by the regular expression regexp. Returns a list containing these parts. Example:

    %encode(%split(foo::bar:rules,:+))
    => %list(%"foo",%"bar",%"rules")
    

    Macro: join (string,list)
    Joins the elements of the list list by inserting between two sequential elements the string string. Example:

    %join(:,%list(the,quick,brown,fox))
    => the:quick:brown:fox
    

    Macro: sort (list)
    Sorts the elements of the list list, which should be strings, according to the order specified by the strcmp() C function. Returns the resulting list.

    Macro: append (list,element)
    Returns a list which is formed by appending element to the list list.

    Macro: uniq (list)
    Returns a list which is formed by removing of all sequential occurences of the same element in list all but one element each. Example:

    %encode(%uniq(%list(a,b,b,c,d,e,e,e,f)))
    => %list(%"a",%"b",%"c",%"d",%"e",%"f")
    

    Hash Operations

    Macro: hash ([key,value,...])
    Returns a hash containing all the specified key/value pairs.

    Macro: hashcount (hash)
    Returns the number of key/value pairs in the hash hash.

    Macro: keys (hash)
    Returns a list of all keys in the hash hash in no particular order.

    File Operations

    Macro: fopen (filename[,mode])
    Opens the file named filename and returns a handle to it. If the file could not be opened, for example because it does not exists, for lack of permission or if mode is illegal, returns -1. The file is opened for reading if mode is omitted or is r. The file is opened for writing if mode is w.

    Macro: fpipe (executable[,arg...])
    Forks off a child process, starts the specified executable with the specified parameters and returns a handle for reading this processes standard output. Returns -1 if something goes wrong. Note that the arguments are not subject to shell expansion, since the process does not start a subshell. If you want shell expansion, you have to start a subshell explicitly. For example, to list all files beginning with an a:

    %pipe(/bin/sh,-c,ls a*)
    

    Macro: fclose (file)
    Closes the file associated with the handle file.

    Macro: fgets (file)
    Reads one line from the file associated with the handle file and returns it. The newline character is included.

    Macro: fputs (file,string)
    Writes string to the file associated with the handle file, which must have been opened for writing.

    Macro: feof (file)
    Returns boolean TRUE if the end of the file associated with the handle file is reached, FALSE otherwise.

    Macro: fstat (filename)
    Returns a hash containing information on the file with name filename. Returns an empty hash if the file does not exist. Otherwise, the hash contains values for the following keys:

    uid
    User ID of owner.
    gid
    Group ID of owner.
    size
    Size in bytes.
    blksize
    Blocksize for filesystem I/O.
    blocks
    Number of blocks allocated.
    atime
    Time of last access.
    mtime
    Time of last modification.
    ctime
    Time of last change.

    All times are given in seconds since January 1, 1970, 00:00:00 GMT. For detailed description of these values see stat(2).

    String Operations

    Macro: match (regexp,string)
    Searches the string string for the first occurrence of the regular expression regexp and returns the index of the first character of this substring. If no match was found, returns -1. Furthermore, sets the variables with numerical names (beginning with @math{1}) to the contents of the corresponding submatches (parts of the regular expression enclosed by parentheses). The variable 0 contains the whole match. For example:

    %match(%"\.([^.]*)$",alittlepicture.jpg) %1
    => 14 jpg
    

    Macro: gsub (string,regexp,replacement)
    Replaces all occurences of the regular expression regexp in string with the string replacement and returns the resulting string. Example:

    %gsub(HEINZI Deinzi,[Ee][Ii],!)
    => H!NZI D!nzi
    

    Macro: removews (string)
    Returns a string which results from removing all leading and trailing whitespace from the string string.

    Macro: strlength (string)
    Returns the length of the string string.

    Macro: substring (start,[length,]string)
    Returns a substring of the string string. If it is called with two arguments and start is positive, then the substring beginning with index start is returned. If start is negative, the last -start characters are returned. If called with two arguments, start specifies the index of the first character in the substring. If length is positive, it specifies the length of substring. If it is negative, then -length specifies the index of the character following the last character of the substring. Examples:

    %substring(3,0123456789)
    => 3456789
    %substring(-3,0123456789)
    => 789
    %substring(2,3,0123456789)
    => 234
    %substring(2,-5,0123456789)
    => 234
    

    Macro: streq (string1,string2)
    Returns a boolean value of TRUE if string1 and string2 are equal, otherwise FALSE.

    Macro: strcmp (string1,string2)
    Returns the result of the strcmp() C function with string1 and string2.

    Macro: chr (code)
    Returns a string with the character with character code code.

    Macro: number (number,base)
    Formats the decimal integer number according to the given base base, which must be between 2 and 36 inclusive. Example:

    %number(34,2)
    => 100010
    %number(-255,16)
    => -ff
    

    Miscellaneous

    Macro: void (expr)
    Executes expr but discard the result. Example:

    %void(%match(%"\.([^.]*)$",alittlepicture.jpg))%1
    => jpg
    

    Macro: outputenable (flag)
    If the boolean value of flag is TRUE, enables output, otherwise disables it. If output is disabled, everything is evaluated as usual, but chpp does not output anything.

    Macro: depend (dependency[,target])
    Adds the filename dependency to the list of dependencies for the file target. If target is not specified, the name of the output file is used.

    Macro: warning (message)
    Causes chpp to give a warning with the message message.

    Macro: error (message)
    Causes chpp to signal an error with the message message.

    Macro: encode (value)
    Returns a string which, upon evaluation, yields a value equal to value.

    Macro: random (limit)
    Returns a random number in the interval 0 to limit-1. The random number are uniformly distributed.

    Symbol Table Manipulation

    Macro: define (name,argname[,argname...],body)
    Defines a macro with the name name and the specified argument names. The body body is not evaluated.

    Macro: locals (symbol[,symbol...],body)
    Executed body in a new scope with the specified local variables.

    Internal Variables

    Variable: outputenabled
    Is 1 if output is enabled, 0 otherwise. Output can be enabled and disabled with the macro outputenable.

    Variable: dependencing
    Is 1 if chpp was started to generate dependencies (option --generate-dependencies), 0 otherwise.

    Variable: mainfilename
    Is set to the filename of the currently executed top-level source file.

    Package Reference

    `files.chh'

    Macro: frest (file)
    Returns the not yet read contents of the file associated with the handle file.

    Macro: fwholefile (filename)
    Returns the whole contents of the file with the name filename.

    `strings.chh'

    Macro: replacesubstring (string,start,length,replacement)
    Returns a string resulting from replacing the substring starting at index start with length length of string by the string replacement.

    Macro: strneq (string1,string2)
    Returns a boolean value of TRUE if string1 and string2 are not equal, otherwise TRUE.

    Macro Index

    a

  • append
  • c

  • chr
  • d

  • define, define
  • depend
  • disc
  • discard
  • dountil
  • dowhile
  • e

  • edefine
  • encode
  • error, error
  • f

  • fclose
  • feof
  • fgets
  • fopen
  • for
  • foreach
  • foreachkey
  • fpipe
  • fputs
  • frest
  • fstat
  • fwholefile
  • g

  • gsub
  • h

  • hash
  • hashcount
  • i

  • if, if
  • ifdef, ifdef
  • ifdefined
  • ifdefkey
  • ifndef
  • ifnotdefined
  • include
  • j

  • join
  • k

  • keys
  • l

  • list
  • listlength
  • locals
  • m

  • match
  • n

  • number
  • o

  • outputenable
  • r

  • random
  • removews
  • replacesubstring
  • s

  • sort
  • split
  • strcmp
  • streq
  • strlength
  • strneq
  • substring
  • u

  • uniq
  • until
  • v

  • void
  • w

  • warning
  • while
  • Concept Index


    This document was generated on 3 Febuary 1998 using the texi2html translator version 1.51.