Using the HTML Compiler

4.3.8Generating stub routines

Generating the VFS file entries and function stubs for the code which is executed by SSI and CGI commands is a time-consuming task, with great potential for error. Therefore, the HTML Compiler does it for you. The last eleven lines of Example 4-1 on page 4-5 illustrate this.

The first of these eleven lines, the ipmask file, is an SSI entry that, when included in an SSI command such as:

<!--#include file="ipmask"-->

inserts the currently-set IP mask into the HTML document.

To perform this, a file named ipmask must exist in the VFS, and this VFS entry must have a pointer to a routine that sends the current IP mask to the data stream. By adding the -s option to the ipmask input file line, the HTML Compiler is informed that ipmask is an SSI executable file, rather than a data file. The compiler then:

•generates the function prototype

•generates a stub of the routine named on the input file line

•makes a VFS entry with a pointer to the SSI routine.

The generated function prototype is placed in the include file output from the compiler (htmldata.h by default). The actual routine stubs are placed in the default output C code file ( htmldata.c by default), in a section which is #ifdefed out.

Note

You must copy the stub routines into a port-dependent file and edit them there.

Otherwise, they are overwritten the next time you run the compiler.

In the demonstration program, these routines have been moved to httpport.c.

The CGI routines and cvar formatting are handled in a manner similar to the SSI routines. Prototypes are placed in the default output include file, and routine stubs are generated in the same #ifdefed out section of the default output C file. The function parameters for CGI and SSI routines are different, so be careful not to confuse the two options in the input file.

Appendix A

Building the Demonstration Program

This appendix details the requirements, installation procedure, and steps required to build the demonstration program. Instructions are provided for using both ADS for Windows and ADS for command-line environments.

This chapter contains the following sections:

•Requirements on page A-2

•Installation procedure on page A-3

•Building using ADS for Windows on page A-4

•Building using ADS from the command line on page A-6.