HTMLINDEX
HTML Skeleton Page For a Routine Library

HTMLINDEX is a C++ program which builds a "skeleton" HTML page for a C, C++, FORTRAN77 or FORTRAN90 source code file, documenting every routine in the file...if each routine has been appropriately marked. The information after the marker is usually a one line explanations of what the routine does.

For a C file, the special marker line has the form

        Purpose:

          ROUTINE has this purpose.
      

For a C++ file, the special marker line has the form

      // Purpose:
      //
      //    ROUTINE has this purpose.
      

For a FORTRAN77 file, the special marker line has the form

      cc ROUTINE has this purpose.
      

For a FORTRAN90 file, the special marker line has the form

      !! ROUTINE has this purpose.
      

After a little editing, the page is ready for posting.

Usage:

htmlindex myprog.c > myprog.html

• myprog.c is a C file to be processed.

Licensing:

The computer code and data files described and made available on this web page are distributed under the GNU LGPL license.

Languages:

HTMLINDEX is available in a C++ version.

Related Data and Programs:

CATALOG, a C++ program which reads a C, C++, FORTRAN77 or FORTRAN90 program and prints every line that begins with a special index tag. If the program has been marked up expecting this convention, it is a handy way of making a table of contents of a program file.

EXTRACT, a FORTRAN90 program which extracts a subroutine, function or module by name from a FORTRAN77 or FORTRAN90 file.

F77_CLEANUP, a FORTRAN90 program which makes a copy of a FORTRAN77 file in which some minor cleanups have been made.

F77SPLIT, a C program which reads a FORTRAN77 file and creates individual files for every subroutine or function in the file.

F90SPLIT, a FORTRAN90 program which reads a FORTRAN90 file and creates individual files for every subroutine or function in the file.

FIXCON, a FORTRAN90 program which reads a FORTRAN file that uses FORTRAN77 continuation statements, and makes a copy that uses FORTRAN90 continuation instead.

INCLUDE_FILES, a FORTRAN90 program which reads a FORTRAN program with INCLUDE statements, and makes a copy with the indicated files included.

Source Code:

• htmlindex.cpp, the source code;

List of Routines:

• MAIN is the main program for HTMLINDEX.
• CH_CAP capitalizes a single character.
• CH_INDEX_FIRST finds the first occurrence of a character in a string.
• GET_FILE_TYPE determines the type of a file.
• HANDLE_C processes a single C file.
• HANDLE_CC processes a single C++ file.
• HANDLE_F77 processes a single FORTRAN77 file.
• HANDLE_F90 processes a single FORTRAN90 file.
• I4_MIN returns the minimum of two I4's.
• S_BEGIN reports whether string 1 begins with string 2.
• S_CAP capitalizes all the characters in a string.
• S_LAST_CH points to the last occurrence of a character in a string.
• TIMESTAMP prints the current YMDHMS date as a time stamp.

You can go up one level to the C++ source codes.