util/robodoc/Source/robodoc.h

   1 /*
   2  *    ROBODoc - a documentation extraction program for several languages.
   3  *
   4  *    Copyright (C) 1994-1999  Frans Slothouber and Jacco van Weert.
   5  *    This program is free software; you can redistribute it and/or modify
   6  *    it under the terms of the GNU General Public License as published by
   7  *    the Free Software Foundation; either version 2 of the License, or
   8  *    (at your option) any later version.
   9  *
  10  *    This program is distributed in the hope that it will be useful,
  11  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *    GNU General Public License for more details.
  14  *
  15  *    You should have received a copy of the GNU General Public License
  16  *    along with this program; if not, write to the Free Software
  17  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  18  *    MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #ifndef VERSION
  27 #define VERSION "unknown"
  28 #endif
  29
  30 #define COMMENT_ROBODOC \
  31     "Generated with ROBODoc Version " VERSION " (" __DATE__ ")\n"
  32 #define COMMENT_COPYRIGHT\
  33     "ROBODoc (c) 1994-2001 by Frans Slothouber and Jacco van Weert.\n"
  34
  35 #define DO_SORT             (1<<0)
  36 #define DO_MAKE_XREFS       (1<<1)
  37 #define DO_USE_XREFS        (1<<2)
  38 #define DO_TOC              (1<<3)
  39 #define DO_MAKE_DOCUMENT    (1<<4)
  40 #define DO_INCLUDE_INTERNAL (1<<5)
  41 #define DO_INTERNAL_ONLY    (1<<6)
  42 #define DO_TELL             (1<<7)
  43 #define DO_INDEX            (1<<8)
  44 #define DO_SINGLEDOC        (1<<9)
  45 #define DO_NOSOURCE         (1<<10)
  46
  47 /* Output Modes */
  48
  49 enum
  50   {
  51     ASCII = 0, AMIGAGUIDE, HTML, LATEX, RTF, SIZE_MODES
  52   };
  53
  54 /* Reserved for Future Use */
  55
  56 enum
  57   {
  58     ANSI, GNUINFO, TROFF, XML
  59   };
  60
  61 /* Evil macros !! */
  62
  63 #define skip_while(cond) { for (;*cur_char && (cond);cur_char++) ; }
  64 #define find_eol   { for (;*cur_char && *cur_char!='\n';cur_char++) ; }
  65 #define find_quote { for (;*cur_char && *cur_char!='\"';cur_char++) ; }
  66
  67 #ifndef FALSE
  68 #define FALSE 0
  69 #endif
  70
  71 #ifndef TRUE
  72 #define TRUE  1
  73 #endif
  74
  75 /* Prototypes */
  76
  77 void RB_Analyse_Arguments (int, char **, char **, char **);
  78 void RB_Set_Doc_Base (char *path);
  79 void RB_Close_The_Shop (void);
  80
  81
  82 #define MAX_LINE_LEN 512
  83
  84 extern char *whoami;
  85 extern char *document_title;
  86 extern int output_mode;
  87 extern int course_of_action;
  88 extern int tab_size;
  89 extern char doc_base[1024];     /* PetteriK */
  90 extern int line_number;
  91 extern char line_buffer[MAX_LINE_LEN];