xref: /freebsd/usr.bin/ctags/ctags.h (revision 87b0195a)
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  */
32 
33 /* This header requires bool for some externed symbols. */
34 #include <stdbool.h>
35 
36 #define	EOS		'\0'
37 
38 #define	ENDLINE		50		/* max length of pattern */
39 #define	MAXTOKEN	250		/* max size of single token */
40 
41 #define	SETLINE		{++lineno;lineftell = ftell(inf);}
42 #define	GETC(op,exp)	((c = getc(inf)) op (int)exp)
43 
44 /*
45  * These character classification macros assume that the (EOF & 0xff) element
46  * of the arrays is always 'NO', as the EOF return from getc() gets masked
47  * to that value.  Masking with 0xff has no effect for normal characters
48  * returned by getc() provided chars have 8 bits.
49  */
50 
51 #define	iswhite(arg)	_wht[arg & 0xff]	/* T if char is white */
52 #define	begtoken(arg)	_btk[arg & 0xff]	/* T if char can start token */
53 #define	intoken(arg)	_itk[arg & 0xff]	/* T if char can be in token */
54 #define	endtoken(arg)	_etk[arg & 0xff]	/* T if char ends tokens */
55 #define	isgood(arg)	_gd[arg & 0xff]	/* T if char can be after ')' */
56 
57 typedef struct nd_st {			/* sorting structure */
58 	struct nd_st	*left,
59 			*right;		/* left and right sons */
60 	char	*entry,			/* function or type name */
61 		*file,			/* file name */
62 		*pat;			/* search pattern */
63 	int	lno;			/* for -x option */
64 	bool	been_warned;		/* set if noticed dup */
65 } NODE;
66 
67 extern char	*curfile;		/* current input file name */
68 extern NODE	*head;			/* head of the sorted binary tree */
69 extern FILE    *inf;			/* ioptr for current input file */
70 extern FILE    *outf;			/* ioptr for current output file */
71 extern long	lineftell;		/* ftell after getc( inf ) == '\n' */
72 extern int	lineno;			/* line number of current line */
73 extern int	dflag;			/* -d: non-macro defines */
74 extern int	tflag;			/* -t: create tags for typedefs */
75 extern int	vflag;			/* -v: vgrind style index output */
76 extern int	wflag;			/* -w: suppress warnings */
77 extern int	xflag;			/* -x: cxref style output */
78 extern bool	_wht[], _etk[], _itk[], _btk[], _gd[];
79 extern char	lbuf[LINE_MAX];
80 extern char    *lbp;
81 extern char	searchar;		/* ex search character */
82 
83 extern bool	cicmp(const char *);
84 extern void	get_line(void);
85 extern void	pfnote(const char *, int);
86 extern bool	skip_key(int);
87 extern void	put_entries(NODE *);
88 extern void	toss_yysec(void);
89 extern void	l_entries(void);
90 extern void	y_entries(void);
91 extern bool	PF_funcs(void);
92 extern void	c_entries(void);
93 extern void	skip_comment(int);
94