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