digitalmars.com                        
Last update Sun Sep 8 21:42:01 2013

Embedding C in HTML

The C compiler is designed to be able to extract and compile C code embedded within HTML files. This capability means that C code can be written to be displayed within a browser utilizing the full formatting and display capability of HTML.

For example, it is possible to make all uses of a class name actually be hyperlinks to where the class is defined. There's nothing new to learn for the person browsing the code, he just uses the normal features of an HTML browser. Strings can be displayed in green, comments in red, and keywords in boldface, for one possibility. It is even possible to embed pictures in the code, as normal HTML image tags.

Embedding C in HTML makes it possible to put the documentation for code and the code itself all together in one file. It is no longer necessary to relegate documentation in comments, to be extracted later by a tech writer. The code and the documentation for it can be maintained simultaneously, with no duplication of effort.

How it works is straightforward. If the source file to the compiler ends in .htm or .html, the code is assumed to be embedded in HTML. The source is then preprocessed by stripping all text outside of <code> and </code> tags. Then, all other HTML tags are stripped, and embedded character encodings are converted to ASCII. All newlines in the original HTML remain in their corresponding positions in the preprocessed text, so the debug line numbers remain consistent. The resulting text is then fed to the C compiler.

Here's an example of the C program "hello world" embedded in this very HTML file. This file can be compiled and run.

#include <stdio.h>

int main()
{
     printf("hello world\n");
     return 0;
}
Home | Runtime Library | IDDE Reference | STL | Search | Download | Forums