cdg.h

reads a set of C-source files and generates a two-column listing of those sources

/* cdg.h -- Constants, macros, externs and prototypes for C Doc. Generator */
/*
    This is part of cdg - a C-source Documentation Generator.
    Copyright (C) 1995, 1996 Peter Knoppers.

    This program 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.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#define MAJORVERSION	  1
#define MINORVERSION	  2

#define MAXIDENTIFIER	MAXCOLUMN	/* max namelen of identifier */
#define MAXCOLUMN	 80		/* width of source listing line */
#define MAXBUF		200		/* somewhat bigger than MAXPAGECOL */
#define MAXCOPYRIGHT	  3		/* size of footer text */
#define MAXPAGELINE	 60		/* height (Hmm) of page in lines */
#define LINESPERCOLUMN	 50		/* listing/table lines per column */
#define MAXPAGECOL	180		/* positions on a line */
#define MINCOLSEP	  2		/* minimal spacing between columns */
#define COLUMNHEADLINE	  2		/* top of the page */
#define BODYHEADLINE	  5		/* top of the columns */
#define COLWIDTH	((MAXPAGECOL - MINCOLSEP * (cols - 1)) / cols)
#define ADDCOLSEP	((MAXPAGECOL + 1 - MINCOLSEP * (cols - 1) - \
			COLWIDTH * cols) / cols) /* this is either 0 or 1 */
#define COLSEP				(MINCOLSEP + ADDCOLSEP)

#define HIGHLIGHTWORD	((char) 0x01)	/* Boldface or underline next word */

extern char makedatestring[];		/* contains date/time of this prgm */

extern int totalinsertednewlines;	/* total number of lines broken */
extern int outputlineno;		/* lineno in copyout */
extern int column;			/* position in outputline in copyout */
extern char identifierstring[];		/* filled by the lex scanner */
extern int yylineno;			/* lineno in input of lex scanner */
extern char headerline[];		/* text for column header */
extern int cols;			/* number of colums on page */
extern int pageno;			/* number of current page */
extern char printertype[];		/* description of output format */

extern FILE * listfile;			/* temporary list file */
extern FILE * tagfile;			/* tag file (usually temporary) */
extern FILE * yyin;			/* source input file */

/* Prototypes (page.c)*/
void trim (char * l);
void addline (char * l);
void addlinehard (int where, char * l);
void flushpage (int newcolcount);
void copyout (char c);
void update_insertednewlines (void);
/* Prototypes (parse.c) */
void maketag (int lineno, char * identifier, char type);
int parsefile (void);
/* Prototypes (scan.l / scan.h) */
int nextinputfile (char * filename);
int yylex (void);