usr.bin/ctags/ctags.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1987, 1993, 1994
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)ctags.h     8.3 (Berkeley) 4/2/94
  32  *
  33  * $FreeBSD$
  34  *
  35  */
  36
  37 #define bool    char
  38
  39 #define YES             1
  40 #define NO              0
  41 #define EOS             '\0'
  42
  43 #define ENDLINE         50              /* max length of pattern */
  44 #define MAXTOKEN        250             /* max size of single token */
  45
  46 #define SETLINE         {++lineno;lineftell = ftell(inf);}
  47 #define GETC(op,exp)    ((c = getc(inf)) op (int)exp)
  48
  49 /*
  50  * These character classification macros assume that the (EOF & 0xff) element
  51  * of the arrays is always 'NO', as the EOF return from getc() gets masked
  52  * to that value.  Masking with 0xff has no effect for normal characters
  53  * returned by getc() provided chars have 8 bits.
  54  */
  55
  56 #define iswhite(arg)    _wht[arg & 0xff]        /* T if char is white */
  57 #define begtoken(arg)   _btk[arg & 0xff]        /* T if char can start token */
  58 #define intoken(arg)    _itk[arg & 0xff]        /* T if char can be in token */
  59 #define endtoken(arg)   _etk[arg & 0xff]        /* T if char ends tokens */
  60 #define isgood(arg)     _gd[arg & 0xff] /* T if char can be after ')' */
  61
  62 typedef struct nd_st {                  /* sorting structure */
  63         struct nd_st    *left,
  64                         *right;         /* left and right sons */
  65         char    *entry,                 /* function or type name */
  66                 *file,                  /* file name */
  67                 *pat;                   /* search pattern */
  68         int     lno;                    /* for -x option */
  69         bool    been_warned;            /* set if noticed dup */
  70 } NODE;
  71
  72 extern char     *curfile;               /* current input file name */
  73 extern NODE     *head;                  /* head of the sorted binary tree */
  74 extern FILE    *inf;                    /* ioptr for current input file */
  75 extern FILE    *outf;                   /* ioptr for current output file */
  76 extern long     lineftell;              /* ftell after getc( inf ) == '\n' */
  77 extern int      lineno;                 /* line number of current line */
  78 extern int      dflag;                  /* -d: non-macro defines */
  79 extern int      tflag;                  /* -t: create tags for typedefs */
  80 extern int      vflag;                  /* -v: vgrind style index output */
  81 extern int      wflag;                  /* -w: suppress warnings */
  82 extern int      xflag;                  /* -x: cxref style output */
  83 extern bool     _wht[], _etk[], _itk[], _btk[], _gd[];
  84 extern char     lbuf[LINE_MAX];
  85 extern char    *lbp;
  86 extern char     searchar;               /* ex search character */
  87
  88 extern int      cicmp(const char *);
  89 extern void     get_line(void);
  90 extern void     pfnote(const char *, int);
  91 extern int      skip_key(int);
  92 extern void     put_entries(NODE *);
  93 extern void     toss_yysec(void);
  94 extern void     l_entries(void);
  95 extern void     y_entries(void);
  96 extern int      PF_funcs(void);
  97 extern void     c_entries(void);
  98 extern void     skip_comment(int);