home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / misc / adoc / source / libfun.h < prev    next >
C/C++ Source or Header  |  1995-04-13  |  3KB  |  89 lines
  1. /*                                                               -*- C -*-
  2.  *  LIBFUN.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: libfun.h,v 1.7 1995/04/12 13:33:48 tf Exp $ */
  24.  
  25. #ifndef LIBFUN_H
  26. #define LIBFUN_H
  27.  
  28. /* prototypes */
  29.  
  30. #if defined(__cplusplus) || defined(cplusplus)
  31. extern "C" {
  32. #endif
  33.  
  34. #ifndef __P
  35.  
  36. #if defined (__STDC__) || defined(__cplusplus)
  37. #define __P(protos) protos
  38. #else /* !(__STDC__ || __cplusplus) */
  39. #define __P(protos) ()
  40. #endif /* __STDC__ || __cplusplus */
  41.  
  42. #endif /* !__P */
  43.  
  44.  
  45. extern int newfun   __P( (char *libfun) );
  46. /* add a function `libfun' = "library/function" */
  47.  
  48. extern int newsec   __P( (char *title) );
  49. /* begin a new section `title' in the description of the current function */
  50.  
  51. extern int addtext  __P( (char *text) );
  52. /* add a portion of text to the current section */
  53.  
  54. extern void funsort  __P( (void) );
  55. /* sort the functions alphabetically */
  56.  
  57. extern int funexpand __P( (char **macros) );
  58. /* expand the body text of all functions via strexpand() */
  59.  
  60. extern int funindent __P( (int indent, int tabsize) );
  61. /* rework indentation of all body text lines */
  62.  
  63. extern char *getfun __P( (char *name) );
  64. /* get the name of function `name' or the current function if `name' == (char *)0 */
  65.  
  66. extern char *getsec __P( (char *name) );
  67. /* get the text of section `name' or the current section if `name' == (char *)0 */
  68.  
  69. extern char *stepfun __P( (int trigger) );
  70. /* get the name of a function: next = 1, previous = -1, first = 0 */
  71.  
  72. extern char *stepsec __P( (int trigger) );
  73. /* get the name of a section: next = 1, previous = -1, first = 0 */
  74.  
  75. extern char *pushfun __P( (void) );
  76. extern char *popfun __P( (void) );
  77.  
  78. extern int islib __P( (char *name) );
  79. /* return 1 if there is at least one function `name/...' or 0 otherwise */
  80.  
  81. extern void funfree  __P( (void) );
  82. /* delete all functions and their descriptive data */
  83.  
  84. #if defined(__cplusplus) || defined(cplusplus)
  85. }
  86. #endif /* C++ */
  87.  
  88. #endif /* !LIBFUN_H */
  89.