home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / misc / adoc / source / adoc.h next >
C/C++ Source or Header  |  1995-04-13  |  3KB  |  95 lines
  1. /*                                                               -*- C -*-
  2.  *  ADOC.H
  3.  *
  4.  *  (c)Copyright 1995 by Tobias Ferber,  All Rights Reserved
  5.  *
  6.  *  This file is part of ADOC.
  7.  *
  8.  *  ADOC is free software; you can redistribute it and/or modify
  9.  *  it under the terms of the GNU General Public License as published
  10.  *  by the Free Software Foundation; either version 1 of the License,
  11.  *  or (at your option) any later version.
  12.  *
  13.  *  ADOC is distributed in the hope that it will be useful,
  14.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.  *  GNU General Public License for more details.
  17.  *
  18.  *  You should have received a copy of the GNU General Public License
  19.  *  along with this program; see the file COPYING.  If not, write to
  20.  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  */
  22.  
  23. /* $VER: $Id: adoc.h,v 1.11 1995/03/25 13:24:16 tf Exp $ */
  24.  
  25. #ifndef ADOC_H
  26. #define ADOC_H
  27.  
  28. #include <stdio.h>
  29.  
  30. /* prototypes */
  31.  
  32. #if defined(__cplusplus) || defined(cplusplus)
  33. extern "C" {
  34. #endif
  35.  
  36. /* args.c */
  37. extern char *convert_args(char *);
  38. extern void display_args(int which);
  39.  
  40. /* strarg.c */
  41. extern int strarg(char *key, ...);
  42.  
  43. /* strexpand.c */
  44. extern char *strexpand(char *, char **);
  45.  
  46. /* gencode.c */
  47. extern int gen_autodoc_toc(FILE *fp);
  48. extern int gen_autodoc(FILE *fp, int cols, int tabsize, int flags, char **body_macros);
  49. extern int gen_texinfo_header(FILE *fp, char *fname, char **header_macros);
  50. extern int gen_texinfo(FILE *fp, int tabsize, int flags, char *body_environment, char **body_macros);
  51.  
  52. /* adoc.yy */
  53. extern int read_source(char *, int, int);
  54.  
  55. /* main.c */
  56. extern FILE *get_ferr(void);
  57.  
  58. /* flag whether or not autodoc comments must begin in column 1 or not */
  59. #define SCANNER_ALLOW_INDENTED_COMMENTS  (1<<0)
  60.  
  61. /* flag whether or not to remove the indentation of body text lines */
  62. #define SCANNER_UNINDENT_BODYTEXT        (1<<1)
  63.  
  64. /* flags for the texinfo code generator */
  65.  
  66. #define TEXI_GROUP_SECTIONS      (1<<0)
  67. #define TEXI_FUNCTION_NEWPAGE    (1<<1)
  68. #define TEXI_PARSE_REFERENCES    (1<<2)
  69. #define TEXI_ITEMIZE_REFERENCES  (1<<3)
  70. #define TEXI_CREATE_HEADER       (1<<4)
  71. #define TEXI_TABLE_FUNCTIONS     (1<<5)
  72. #define TEXI_NO_INDEX            (1<<6)
  73.  
  74. /* flags for the autodoc code generator */
  75.  
  76. #define ADOC_FORM_FEEDS          (1<<0)
  77.  
  78. /* initially `warn_mask' is set to WARN_NORMAL, so importatnt warnings are visible */
  79.  
  80. #define WARN_NORMAL              (1<<0)
  81. #define WARN_BROKEN_COMMENTS     (1<<0)
  82. #define WARN_STRANGE_TEXT        (1<<0)
  83. #define WARN_UNKNOWN_KEYWORDS    (1<<1)
  84. #define WARN_MISSING_KEYWORDS    (1<<2)
  85. #define WARN_UNTITLED_SECTION    (1<<3)
  86.  
  87. #define WARN_ALL                 (~0)
  88. #define WARN_NONE                (0)
  89.  
  90. #if defined(__cplusplus) || defined(cplusplus)
  91. }
  92. #endif /* C++ */
  93.  
  94. #endif /* !ADOC_H */
  95.