ctags/main/entry.h

   1 /*
   2 *
   3 *   Copyright (c) 1998-2001, Darren Hiebert
   4 *
   5 *   This source code is released for free distribution under the terms of the
   6 *   GNU General Public License.
   7 *
   8 *   External interface to entry.c
   9 */
  10 #ifndef _ENTRY_H
  11 #define _ENTRY_H
  12
  13 /*
  14 *   INCLUDE FILES
  15 */
  16 #include "general.h"    /* must always come first */
  17
  18 #include "mio.h"
  19 #include "vstring.h"
  20 #include "kind.h"
  21
  22 /*
  23 *   MACROS
  24 */
  25 #define WHOLE_FILE  -1L
  26
  27 /*
  28 *   DATA DECLARATIONS
  29 */
  30
  31 /*  Maintains the state of the tag file.
  32  */
  33 typedef struct eTagFile {
  34         char *name;
  35         char *directory;
  36         MIO *mio;
  37         struct sNumTags { unsigned long added, prev; } numTags;
  38         struct sMax { size_t line, tag, file; } max;
  39         struct sEtags {
  40                 char *name;
  41                 MIO *mio;
  42                 size_t byteCount;
  43         } etags;
  44         vString *vLine;
  45 } tagFile;
  46
  47 typedef struct sTagFields {
  48         unsigned int count;         /* number of additional extension flags */
  49         const char *const *label;   /* list of labels for extension flags */
  50         const char *const *value;   /* list of values for extension flags */
  51 } tagFields;
  52
  53 /*  Information about the current tag candidate.
  54  */
  55 typedef struct sTagEntryInfo {
  56         boolean     lineNumberEntry;/* pattern or line number entry */
  57         unsigned long lineNumber;   /* line number of tag */
  58         MIOPos      filePosition;   /* file position of line containing tag */
  59         const char* language;       /* language of source file */
  60         boolean     isFileScope;    /* is tag visible only within source file? */
  61         boolean     isFileEntry;    /* is this just an entry for a file name? */
  62         boolean     truncateLine;   /* truncate tag line at end of tag name? */
  63         const char *sourceFileName; /* name of source file */
  64         const char *name;           /* name of the tag */
  65         const char *kindName;       /* kind of tag */
  66         char        kind;           /* single character representation of kind */
  67         struct {
  68                 const char* access;
  69                 const char* fileScope;
  70                 const char* implementation;
  71                 const char* inheritance;
  72
  73                 const kindOption* scopeKind;
  74                 const char* scopeName;
  75
  76                 const char *signature; /* Argument list for functions and macros with arguments */
  77                 const char *varType;
  78         } extensionFields;          /* list of extension fields*/
  79 } tagEntryInfo;
  80
  81 /*
  82 *   GLOBAL VARIABLES
  83 */
  84 extern tagFile TagFile;
  85
  86 /*
  87 *   FUNCTION PROTOTYPES
  88 */
  89 extern void freeTagFileResources (void);
  90 extern const char *tagFileName (void);
  91 extern void copyBytes (MIO* const fromMio, MIO* const toMio, const long size);
  92 extern void copyFile (const char *const from, const char *const to, const long size);
  93 extern void openTagFile (void);
  94 extern void closeTagFile (const boolean resize);
  95 extern void beginEtagsFile (void);
  96 extern void endEtagsFile (const char *const name);
  97 extern void makeTagEntry (const tagEntryInfo *const tag);
  98 extern void initTagEntry (tagEntryInfo *const e, const char *const name);
  99
 100 #endif  /* _ENTRY_H */
 101
 102 /* vi:set tabstop=4 shiftwidth=4: */