]> code.delx.au - gnu-emacs/blob - lib-src/etags.c
Merge from emacs--rel--22
[gnu-emacs] / lib-src / etags.c
1 /* Tags file maker to go with GNU Emacs -*- coding: latin-1 -*-
2
3 Copyright (C) 1984 The Regents of the University of California
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are
7 met:
8 1. Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the
13 distribution.
14 3. Neither the name of the University nor the names of its
15 contributors may be used to endorse or promote products derived
16 from this software without specific prior written permission.
17
18 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS''
19 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS
22 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
25 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
28 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30
31 Copyright (C) 1984, 1987, 1988, 1989, 1993, 1994, 1995, 1998, 1999,
32 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
33 Free Software Foundation, Inc.
34
35 This file is not considered part of GNU Emacs.
36
37 This program is free software; you can redistribute it and/or modify
38 it under the terms of the GNU General Public License as published by
39 the Free Software Foundation; either version 2 of the License, or
40 (at your option) any later version.
41
42 This program is distributed in the hope that it will be useful,
43 but WITHOUT ANY WARRANTY; without even the implied warranty of
44 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45 GNU General Public License for more details.
46
47 You should have received a copy of the GNU General Public License
48 along with this program; if not, write to the Free Software Foundation,
49 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
50
51
52 /* NB To comply with the above BSD license, copyright information is
53 reproduced in etc/ETAGS.README. That file should be updated when the
54 above notices are.
55
56 To the best of our knowledge, this code was originally based on the
57 ctags.c distributed with BSD4.2, which was copyrighted by the
58 University of California, as described above. */
59
60
61 /*
62 * Authors:
63 * 1983 Ctags originally by Ken Arnold.
64 * 1984 Fortran added by Jim Kleckner.
65 * 1984 Ed Pelegri-Llopart added C typedefs.
66 * 1985 Emacs TAGS format by Richard Stallman.
67 * 1989 Sam Kendall added C++.
68 * 1992 Joseph B. Wells improved C and C++ parsing.
69 * 1993 Francesco Potortì reorganised C and C++.
70 * 1994 Line-by-line regexp tags by Tom Tromey.
71 * 2001 Nested classes by Francesco Potortì (concept by Mykola Dzyuba).
72 * 2002 #line directives by Francesco Potortì.
73 *
74 * Francesco Potortì <pot@gnu.org> has maintained and improved it since 1993.
75 */
76
77 /*
78 * If you want to add support for a new language, start by looking at the LUA
79 * language, which is the simplest. Alternatively, consider shipping a
80 * configuration file containing regexp definitions for etags.
81 */
82
83 char pot_etags_version[] = "@(#) pot revision number is 17.31";
84
85 #define TRUE 1
86 #define FALSE 0
87
88 #ifdef DEBUG
89 # undef DEBUG
90 # define DEBUG TRUE
91 #else
92 # define DEBUG FALSE
93 # define NDEBUG /* disable assert */
94 #endif
95
96 #ifdef HAVE_CONFIG_H
97 # include <config.h>
98 /* On some systems, Emacs defines static as nothing for the sake
99 of unexec. We don't want that here since we don't use unexec. */
100 # undef static
101 # ifndef PTR /* for XEmacs */
102 # define PTR void *
103 # endif
104 # ifndef __P /* for XEmacs */
105 # define __P(args) args
106 # endif
107 #else /* no config.h */
108 # if defined(__STDC__) && (__STDC__ || defined(__SUNPRO_C))
109 # define __P(args) args /* use prototypes */
110 # define PTR void * /* for generic pointers */
111 # else /* not standard C */
112 # define __P(args) () /* no prototypes */
113 # define const /* remove const for old compilers' sake */
114 # define PTR long * /* don't use void* */
115 # endif
116 #endif /* !HAVE_CONFIG_H */
117
118 #ifndef _GNU_SOURCE
119 # define _GNU_SOURCE 1 /* enables some compiler checks on GNU */
120 #endif
121
122 /* WIN32_NATIVE is for XEmacs.
123 MSDOS, WINDOWSNT, DOS_NT are for Emacs. */
124 #ifdef WIN32_NATIVE
125 # undef MSDOS
126 # undef WINDOWSNT
127 # define WINDOWSNT
128 #endif /* WIN32_NATIVE */
129
130 #ifdef MSDOS
131 # undef MSDOS
132 # define MSDOS TRUE
133 # include <fcntl.h>
134 # include <sys/param.h>
135 # include <io.h>
136 # ifndef HAVE_CONFIG_H
137 # define DOS_NT
138 # include <sys/config.h>
139 # endif
140 #else
141 # define MSDOS FALSE
142 #endif /* MSDOS */
143
144 #ifdef WINDOWSNT
145 # include <stdlib.h>
146 # include <fcntl.h>
147 # include <string.h>
148 # include <direct.h>
149 # include <io.h>
150 # define MAXPATHLEN _MAX_PATH
151 # undef HAVE_NTGUI
152 # undef DOS_NT
153 # define DOS_NT
154 # ifndef HAVE_GETCWD
155 # define HAVE_GETCWD
156 # endif /* undef HAVE_GETCWD */
157 #else /* not WINDOWSNT */
158 # ifdef STDC_HEADERS
159 # include <stdlib.h>
160 # include <string.h>
161 # else /* no standard C headers */
162 extern char *getenv ();
163 extern char *strcpy ();
164 extern char *strncpy ();
165 extern char *strcat ();
166 extern char *strncat ();
167 extern unsigned long strlen ();
168 extern PTR malloc ();
169 extern PTR realloc ();
170 # ifdef VMS
171 # define EXIT_SUCCESS 1
172 # define EXIT_FAILURE 0
173 # else /* no VMS */
174 # define EXIT_SUCCESS 0
175 # define EXIT_FAILURE 1
176 # endif
177 # endif
178 #endif /* !WINDOWSNT */
179
180 #ifdef HAVE_UNISTD_H
181 # include <unistd.h>
182 #else
183 # if defined (HAVE_GETCWD) && !defined (WINDOWSNT)
184 extern char *getcwd (char *buf, size_t size);
185 # endif
186 #endif /* HAVE_UNISTD_H */
187
188 #include <stdio.h>
189 #include <ctype.h>
190 #include <errno.h>
191 #ifndef errno
192 extern int errno;
193 #endif
194 #include <sys/types.h>
195 #include <sys/stat.h>
196
197 #include <assert.h>
198 #ifdef NDEBUG
199 # undef assert /* some systems have a buggy assert.h */
200 # define assert(x) ((void) 0)
201 #endif
202
203 #if !defined (S_ISREG) && defined (S_IFREG)
204 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
205 #endif
206
207 #ifdef NO_LONG_OPTIONS /* define this if you don't have GNU getopt */
208 # define NO_LONG_OPTIONS TRUE
209 # define getopt_long(argc,argv,optstr,lopts,lind) getopt (argc, argv, optstr)
210 extern char *optarg;
211 extern int optind, opterr;
212 #else
213 # define NO_LONG_OPTIONS FALSE
214 # include <getopt.h>
215 #endif /* NO_LONG_OPTIONS */
216
217 #ifndef HAVE_CONFIG_H /* this is a standalone compilation */
218 # ifdef __CYGWIN__ /* compiling on Cygwin */
219 !!! NOTICE !!!
220 the regex.h distributed with Cygwin is not compatible with etags, alas!
221 If you want regular expression support, you should delete this notice and
222 arrange to use the GNU regex.h and regex.c.
223 # endif
224 #endif
225 #include <regex.h>
226
227 /* Define CTAGS to make the program "ctags" compatible with the usual one.
228 Leave it undefined to make the program "etags", which makes emacs-style
229 tag tables and tags typedefs, #defines and struct/union/enum by default. */
230 #ifdef CTAGS
231 # undef CTAGS
232 # define CTAGS TRUE
233 #else
234 # define CTAGS FALSE
235 #endif
236
237 #define streq(s,t) (assert((s)!=NULL || (t)!=NULL), !strcmp (s, t))
238 #define strcaseeq(s,t) (assert((s)!=NULL && (t)!=NULL), !etags_strcasecmp (s, t))
239 #define strneq(s,t,n) (assert((s)!=NULL || (t)!=NULL), !strncmp (s, t, n))
240 #define strncaseeq(s,t,n) (assert((s)!=NULL && (t)!=NULL), !etags_strncasecmp (s, t, n))
241
242 #define CHARS 256 /* 2^sizeof(char) */
243 #define CHAR(x) ((unsigned int)(x) & (CHARS - 1))
244 #define iswhite(c) (_wht[CHAR(c)]) /* c is white (see white) */
245 #define notinname(c) (_nin[CHAR(c)]) /* c is not in a name (see nonam) */
246 #define begtoken(c) (_btk[CHAR(c)]) /* c can start token (see begtk) */
247 #define intoken(c) (_itk[CHAR(c)]) /* c can be in token (see midtk) */
248 #define endtoken(c) (_etk[CHAR(c)]) /* c ends tokens (see endtk) */
249
250 #define ISALNUM(c) isalnum (CHAR(c))
251 #define ISALPHA(c) isalpha (CHAR(c))
252 #define ISDIGIT(c) isdigit (CHAR(c))
253 #define ISLOWER(c) islower (CHAR(c))
254
255 #define lowcase(c) tolower (CHAR(c))
256 #define upcase(c) toupper (CHAR(c))
257
258
259 /*
260 * xnew, xrnew -- allocate, reallocate storage
261 *
262 * SYNOPSIS: Type *xnew (int n, Type);
263 * void xrnew (OldPointer, int n, Type);
264 */
265 #if DEBUG
266 # include "chkmalloc.h"
267 # define xnew(n,Type) ((Type *) trace_malloc (__FILE__, __LINE__, \
268 (n) * sizeof (Type)))
269 # define xrnew(op,n,Type) ((op) = (Type *) trace_realloc (__FILE__, __LINE__, \
270 (char *) (op), (n) * sizeof (Type)))
271 #else
272 # define xnew(n,Type) ((Type *) xmalloc ((n) * sizeof (Type)))
273 # define xrnew(op,n,Type) ((op) = (Type *) xrealloc ( \
274 (char *) (op), (n) * sizeof (Type)))
275 #endif
276
277 #define bool int
278
279 typedef void Lang_function __P((FILE *));
280
281 typedef struct
282 {
283 char *suffix; /* file name suffix for this compressor */
284 char *command; /* takes one arg and decompresses to stdout */
285 } compressor;
286
287 typedef struct
288 {
289 char *name; /* language name */
290 char *help; /* detailed help for the language */
291 Lang_function *function; /* parse function */
292 char **suffixes; /* name suffixes of this language's files */
293 char **filenames; /* names of this language's files */
294 char **interpreters; /* interpreters for this language */
295 bool metasource; /* source used to generate other sources */
296 } language;
297
298 typedef struct fdesc
299 {
300 struct fdesc *next; /* for the linked list */
301 char *infname; /* uncompressed input file name */
302 char *infabsname; /* absolute uncompressed input file name */
303 char *infabsdir; /* absolute dir of input file */
304 char *taggedfname; /* file name to write in tagfile */
305 language *lang; /* language of file */
306 char *prop; /* file properties to write in tagfile */
307 bool usecharno; /* etags tags shall contain char number */
308 bool written; /* entry written in the tags file */
309 } fdesc;
310
311 typedef struct node_st
312 { /* sorting structure */
313 struct node_st *left, *right; /* left and right sons */
314 fdesc *fdp; /* description of file to whom tag belongs */
315 char *name; /* tag name */
316 char *regex; /* search regexp */
317 bool valid; /* write this tag on the tag file */
318 bool is_func; /* function tag: use regexp in CTAGS mode */
319 bool been_warned; /* warning already given for duplicated tag */
320 int lno; /* line number tag is on */
321 long cno; /* character number line starts on */
322 } node;
323
324 /*
325 * A `linebuffer' is a structure which holds a line of text.
326 * `readline_internal' reads a line from a stream into a linebuffer
327 * and works regardless of the length of the line.
328 * SIZE is the size of BUFFER, LEN is the length of the string in
329 * BUFFER after readline reads it.
330 */
331 typedef struct
332 {
333 long size;
334 int len;
335 char *buffer;
336 } linebuffer;
337
338 /* Used to support mixing of --lang and file names. */
339 typedef struct
340 {
341 enum {
342 at_language, /* a language specification */
343 at_regexp, /* a regular expression */
344 at_filename, /* a file name */
345 at_stdin, /* read from stdin here */
346 at_end /* stop parsing the list */
347 } arg_type; /* argument type */
348 language *lang; /* language associated with the argument */
349 char *what; /* the argument itself */
350 } argument;
351
352 /* Structure defining a regular expression. */
353 typedef struct regexp
354 {
355 struct regexp *p_next; /* pointer to next in list */
356 language *lang; /* if set, use only for this language */
357 char *pattern; /* the regexp pattern */
358 char *name; /* tag name */
359 struct re_pattern_buffer *pat; /* the compiled pattern */
360 struct re_registers regs; /* re registers */
361 bool error_signaled; /* already signaled for this regexp */
362 bool force_explicit_name; /* do not allow implict tag name */
363 bool ignore_case; /* ignore case when matching */
364 bool multi_line; /* do a multi-line match on the whole file */
365 } regexp;
366
367
368 /* Many compilers barf on this:
369 Lang_function Ada_funcs;
370 so let's write it this way */
371 static void Ada_funcs __P((FILE *));
372 static void Asm_labels __P((FILE *));
373 static void C_entries __P((int c_ext, FILE *));
374 static void default_C_entries __P((FILE *));
375 static void plain_C_entries __P((FILE *));
376 static void Cjava_entries __P((FILE *));
377 static void Cobol_paragraphs __P((FILE *));
378 static void Cplusplus_entries __P((FILE *));
379 static void Cstar_entries __P((FILE *));
380 static void Erlang_functions __P((FILE *));
381 static void Forth_words __P((FILE *));
382 static void Fortran_functions __P((FILE *));
383 static void HTML_labels __P((FILE *));
384 static void Lisp_functions __P((FILE *));
385 static void Lua_functions __P((FILE *));
386 static void Makefile_targets __P((FILE *));
387 static void Pascal_functions __P((FILE *));
388 static void Perl_functions __P((FILE *));
389 static void PHP_functions __P((FILE *));
390 static void PS_functions __P((FILE *));
391 static void Prolog_functions __P((FILE *));
392 static void Python_functions __P((FILE *));
393 static void Scheme_functions __P((FILE *));
394 static void TeX_commands __P((FILE *));
395 static void Texinfo_nodes __P((FILE *));
396 static void Yacc_entries __P((FILE *));
397 static void just_read_file __P((FILE *));
398
399 static void print_language_names __P((void));
400 static void print_version __P((void));
401 static void print_help __P((argument *));
402 int main __P((int, char **));
403
404 static compressor *get_compressor_from_suffix __P((char *, char **));
405 static language *get_language_from_langname __P((const char *));
406 static language *get_language_from_interpreter __P((char *));
407 static language *get_language_from_filename __P((char *, bool));
408 static void readline __P((linebuffer *, FILE *));
409 static long readline_internal __P((linebuffer *, FILE *));
410 static bool nocase_tail __P((char *));
411 static void get_tag __P((char *, char **));
412
413 static void analyse_regex __P((char *));
414 static void free_regexps __P((void));
415 static void regex_tag_multiline __P((void));
416 static void error __P((const char *, const char *));
417 static void suggest_asking_for_help __P((void));
418 void fatal __P((char *, char *));
419 static void pfatal __P((char *));
420 static void add_node __P((node *, node **));
421
422 static void init __P((void));
423 static void process_file_name __P((char *, language *));
424 static void process_file __P((FILE *, char *, language *));
425 static void find_entries __P((FILE *));
426 static void free_tree __P((node *));
427 static void free_fdesc __P((fdesc *));
428 static void pfnote __P((char *, bool, char *, int, int, long));
429 static void make_tag __P((char *, int, bool, char *, int, int, long));
430 static void invalidate_nodes __P((fdesc *, node **));
431 static void put_entries __P((node *));
432
433 static char *concat __P((char *, char *, char *));
434 static char *skip_spaces __P((char *));
435 static char *skip_non_spaces __P((char *));
436 static char *savenstr __P((char *, int));
437 static char *savestr __P((char *));
438 static char *etags_strchr __P((const char *, int));
439 static char *etags_strrchr __P((const char *, int));
440 static int etags_strcasecmp __P((const char *, const char *));
441 static int etags_strncasecmp __P((const char *, const char *, int));
442 static char *etags_getcwd __P((void));
443 static char *relative_filename __P((char *, char *));
444 static char *absolute_filename __P((char *, char *));
445 static char *absolute_dirname __P((char *, char *));
446 static bool filename_is_absolute __P((char *f));
447 static void canonicalize_filename __P((char *));
448 static void linebuffer_init __P((linebuffer *));
449 static void linebuffer_setlen __P((linebuffer *, int));
450 static PTR xmalloc __P((unsigned int));
451 static PTR xrealloc __P((char *, unsigned int));
452
453 \f
454 static char searchar = '/'; /* use /.../ searches */
455
456 static char *tagfile; /* output file */
457 static char *progname; /* name this program was invoked with */
458 static char *cwd; /* current working directory */
459 static char *tagfiledir; /* directory of tagfile */
460 static FILE *tagf; /* ioptr for tags file */
461
462 static fdesc *fdhead; /* head of file description list */
463 static fdesc *curfdp; /* current file description */
464 static int lineno; /* line number of current line */
465 static long charno; /* current character number */
466 static long linecharno; /* charno of start of current line */
467 static char *dbp; /* pointer to start of current tag */
468
469 static const int invalidcharno = -1;
470
471 static node *nodehead; /* the head of the binary tree of tags */
472 static node *last_node; /* the last node created */
473
474 static linebuffer lb; /* the current line */
475 static linebuffer filebuf; /* a buffer containing the whole file */
476 static linebuffer token_name; /* a buffer containing a tag name */
477
478 /* boolean "functions" (see init) */
479 static bool _wht[CHARS], _nin[CHARS], _itk[CHARS], _btk[CHARS], _etk[CHARS];
480 static char
481 /* white chars */
482 *white = " \f\t\n\r\v",
483 /* not in a name */
484 *nonam = " \f\t\n\r()=,;", /* look at make_tag before modifying! */
485 /* token ending chars */
486 *endtk = " \t\n\r\"'#()[]{}=-+%*/&|^~!<>;,.:?",
487 /* token starting chars */
488 *begtk = "ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz$~@",
489 /* valid in-token chars */
490 *midtk = "ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz$0123456789";
491
492 static bool append_to_tagfile; /* -a: append to tags */
493 /* The next five default to TRUE for etags, but to FALSE for ctags. */
494 static bool typedefs; /* -t: create tags for C and Ada typedefs */
495 static bool typedefs_or_cplusplus; /* -T: create tags for C typedefs, level */
496 /* 0 struct/enum/union decls, and C++ */
497 /* member functions. */
498 static bool constantypedefs; /* -d: create tags for C #define, enum */
499 /* constants and variables. */
500 /* -D: opposite of -d. Default under ctags. */
501 static bool globals; /* create tags for global variables */
502 static bool members; /* create tags for C member variables */
503 static bool declarations; /* --declarations: tag them and extern in C&Co*/
504 static bool no_line_directive; /* ignore #line directives (undocumented) */
505 static bool no_duplicates; /* no duplicate tags for ctags (undocumented) */
506 static bool update; /* -u: update tags */
507 static bool vgrind_style; /* -v: create vgrind style index output */
508 static bool no_warnings; /* -w: suppress warnings (undocumented) */
509 static bool cxref_style; /* -x: create cxref style output */
510 static bool cplusplus; /* .[hc] means C++, not C */
511 static bool ignoreindent; /* -I: ignore indentation in C */
512 static bool packages_only; /* --packages-only: in Ada, only tag packages*/
513
514 /* STDIN is defined in LynxOS system headers */
515 #ifdef STDIN
516 # undef STDIN
517 #endif
518
519 #define STDIN 0x1001 /* returned by getopt_long on --parse-stdin */
520 static bool parsing_stdin; /* --parse-stdin used */
521
522 static regexp *p_head; /* list of all regexps */
523 static bool need_filebuf; /* some regexes are multi-line */
524
525 static struct option longopts[] =
526 {
527 { "append", no_argument, NULL, 'a' },
528 { "packages-only", no_argument, &packages_only, TRUE },
529 { "c++", no_argument, NULL, 'C' },
530 { "declarations", no_argument, &declarations, TRUE },
531 { "no-line-directive", no_argument, &no_line_directive, TRUE },
532 { "no-duplicates", no_argument, &no_duplicates, TRUE },
533 { "help", no_argument, NULL, 'h' },
534 { "help", no_argument, NULL, 'H' },
535 { "ignore-indentation", no_argument, NULL, 'I' },
536 { "language", required_argument, NULL, 'l' },
537 { "members", no_argument, &members, TRUE },
538 { "no-members", no_argument, &members, FALSE },
539 { "output", required_argument, NULL, 'o' },
540 { "regex", required_argument, NULL, 'r' },
541 { "no-regex", no_argument, NULL, 'R' },
542 { "ignore-case-regex", required_argument, NULL, 'c' },
543 { "parse-stdin", required_argument, NULL, STDIN },
544 { "version", no_argument, NULL, 'V' },
545
546 #if CTAGS /* Ctags options */
547 { "backward-search", no_argument, NULL, 'B' },
548 { "cxref", no_argument, NULL, 'x' },
549 { "defines", no_argument, NULL, 'd' },
550 { "globals", no_argument, &globals, TRUE },
551 { "typedefs", no_argument, NULL, 't' },
552 { "typedefs-and-c++", no_argument, NULL, 'T' },
553 { "update", no_argument, NULL, 'u' },
554 { "vgrind", no_argument, NULL, 'v' },
555 { "no-warn", no_argument, NULL, 'w' },
556
557 #else /* Etags options */
558 { "no-defines", no_argument, NULL, 'D' },
559 { "no-globals", no_argument, &globals, FALSE },
560 { "include", required_argument, NULL, 'i' },
561 #endif
562 { NULL }
563 };
564
565 static compressor compressors[] =
566 {
567 { "z", "gzip -d -c"},
568 { "Z", "gzip -d -c"},
569 { "gz", "gzip -d -c"},
570 { "GZ", "gzip -d -c"},
571 { "bz2", "bzip2 -d -c" },
572 { NULL }
573 };
574
575 /*
576 * Language stuff.
577 */
578
579 /* Ada code */
580 static char *Ada_suffixes [] =
581 { "ads", "adb", "ada", NULL };
582 static char Ada_help [] =
583 "In Ada code, functions, procedures, packages, tasks and types are\n\
584 tags. Use the `--packages-only' option to create tags for\n\
585 packages only.\n\
586 Ada tag names have suffixes indicating the type of entity:\n\
587 Entity type: Qualifier:\n\
588 ------------ ----------\n\
589 function /f\n\
590 procedure /p\n\
591 package spec /s\n\
592 package body /b\n\
593 type /t\n\
594 task /k\n\
595 Thus, `M-x find-tag <RET> bidule/b <RET>' will go directly to the\n\
596 body of the package `bidule', while `M-x find-tag <RET> bidule <RET>'\n\
597 will just search for any tag `bidule'.";
598
599 /* Assembly code */
600 static char *Asm_suffixes [] =
601 { "a", /* Unix assembler */
602 "asm", /* Microcontroller assembly */
603 "def", /* BSO/Tasking definition includes */
604 "inc", /* Microcontroller include files */
605 "ins", /* Microcontroller include files */
606 "s", "sa", /* Unix assembler */
607 "S", /* cpp-processed Unix assembler */
608 "src", /* BSO/Tasking C compiler output */
609 NULL
610 };
611 static char Asm_help [] =
612 "In assembler code, labels appearing at the beginning of a line,\n\
613 followed by a colon, are tags.";
614
615
616 /* Note that .c and .h can be considered C++, if the --c++ flag was
617 given, or if the `class' or `template' keyowrds are met inside the file.
618 That is why default_C_entries is called for these. */
619 static char *default_C_suffixes [] =
620 { "c", "h", NULL };
621 static char default_C_help [] =
622 "In C code, any C function or typedef is a tag, and so are\n\
623 definitions of `struct', `union' and `enum'. `#define' macro\n\
624 definitions and `enum' constants are tags unless you specify\n\
625 `--no-defines'. Global variables are tags unless you specify\n\
626 `--no-globals' and so are struct members unless you specify\n\
627 `--no-members'. Use of `--no-globals', `--no-defines' and\n\
628 `--no-members' can make the tags table file much smaller.\n\
629 You can tag function declarations and external variables by\n\
630 using `--declarations'.";
631
632 static char *Cplusplus_suffixes [] =
633 { "C", "c++", "cc", "cpp", "cxx", "H", "h++", "hh", "hpp", "hxx",
634 "M", /* Objective C++ */
635 "pdb", /* Postscript with C syntax */
636 NULL };
637 static char Cplusplus_help [] =
638 "In C++ code, all the tag constructs of C code are tagged. (Use\n\
639 --help --lang=c --lang=c++ for full help.)\n\
640 In addition to C tags, member functions are also recognized. Member\n\
641 variables are recognized unless you use the `--no-members' option.\n\
642 Tags for variables and functions in classes are named `CLASS::VARIABLE'\n\
643 and `CLASS::FUNCTION'. `operator' definitions have tag names like\n\
644 `operator+'.";
645
646 static char *Cjava_suffixes [] =
647 { "java", NULL };
648 static char Cjava_help [] =
649 "In Java code, all the tags constructs of C and C++ code are\n\
650 tagged. (Use --help --lang=c --lang=c++ --lang=java for full help.)";
651
652
653 static char *Cobol_suffixes [] =
654 { "COB", "cob", NULL };
655 static char Cobol_help [] =
656 "In Cobol code, tags are paragraph names; that is, any word\n\
657 starting in column 8 and followed by a period.";
658
659 static char *Cstar_suffixes [] =
660 { "cs", "hs", NULL };
661
662 static char *Erlang_suffixes [] =
663 { "erl", "hrl", NULL };
664 static char Erlang_help [] =
665 "In Erlang code, the tags are the functions, records and macros\n\
666 defined in the file.";
667
668 char *Forth_suffixes [] =
669 { "fth", "tok", NULL };
670 static char Forth_help [] =
671 "In Forth code, tags are words defined by `:',\n\
672 constant, code, create, defer, value, variable, buffer:, field.";
673
674 static char *Fortran_suffixes [] =
675 { "F", "f", "f90", "for", NULL };
676 static char Fortran_help [] =
677 "In Fortran code, functions, subroutines and block data are tags.";
678
679 static char *HTML_suffixes [] =
680 { "htm", "html", "shtml", NULL };
681 static char HTML_help [] =
682 "In HTML input files, the tags are the `title' and the `h1', `h2',\n\
683 `h3' headers. Also, tags are `name=' in anchors and all\n\
684 occurrences of `id='.";
685
686 static char *Lisp_suffixes [] =
687 { "cl", "clisp", "el", "l", "lisp", "LSP", "lsp", "ml", NULL };
688 static char Lisp_help [] =
689 "In Lisp code, any function defined with `defun', any variable\n\
690 defined with `defvar' or `defconst', and in general the first\n\
691 argument of any expression that starts with `(def' in column zero\n\
692 is a tag.";
693
694 static char *Lua_suffixes [] =
695 { "lua", "LUA", NULL };
696 static char Lua_help [] =
697 "In Lua scripts, all functions are tags.";
698
699 static char *Makefile_filenames [] =
700 { "Makefile", "makefile", "GNUMakefile", "Makefile.in", "Makefile.am", NULL};
701 static char Makefile_help [] =
702 "In makefiles, targets are tags; additionally, variables are tags\n\
703 unless you specify `--no-globals'.";
704
705 static char *Objc_suffixes [] =
706 { "lm", /* Objective lex file */
707 "m", /* Objective C file */
708 NULL };
709 static char Objc_help [] =
710 "In Objective C code, tags include Objective C definitions for classes,\n\
711 class categories, methods and protocols. Tags for variables and\n\
712 functions in classes are named `CLASS::VARIABLE' and `CLASS::FUNCTION'.\n\
713 (Use --help --lang=c --lang=objc --lang=java for full help.)";
714
715 static char *Pascal_suffixes [] =
716 { "p", "pas", NULL };
717 static char Pascal_help [] =
718 "In Pascal code, the tags are the functions and procedures defined\n\
719 in the file.";
720 /* " // this is for working around an Emacs highlighting bug... */
721
722 static char *Perl_suffixes [] =
723 { "pl", "pm", NULL };
724 static char *Perl_interpreters [] =
725 { "perl", "@PERL@", NULL };
726 static char Perl_help [] =
727 "In Perl code, the tags are the packages, subroutines and variables\n\
728 defined by the `package', `sub', `my' and `local' keywords. Use\n\
729 `--globals' if you want to tag global variables. Tags for\n\
730 subroutines are named `PACKAGE::SUB'. The name for subroutines\n\
731 defined in the default package is `main::SUB'.";
732
733 static char *PHP_suffixes [] =
734 { "php", "php3", "php4", NULL };
735 static char PHP_help [] =
736 "In PHP code, tags are functions, classes and defines. Unless you use\n\
737 the `--no-members' option, vars are tags too.";
738
739 static char *plain_C_suffixes [] =
740 { "pc", /* Pro*C file */
741 NULL };
742
743 static char *PS_suffixes [] =
744 { "ps", "psw", NULL }; /* .psw is for PSWrap */
745 static char PS_help [] =
746 "In PostScript code, the tags are the functions.";
747
748 static char *Prolog_suffixes [] =
749 { "prolog", NULL };
750 static char Prolog_help [] =
751 "In Prolog code, tags are predicates and rules at the beginning of\n\
752 line.";
753
754 static char *Python_suffixes [] =
755 { "py", NULL };
756 static char Python_help [] =
757 "In Python code, `def' or `class' at the beginning of a line\n\
758 generate a tag.";
759
760 /* Can't do the `SCM' or `scm' prefix with a version number. */
761 static char *Scheme_suffixes [] =
762 { "oak", "sch", "scheme", "SCM", "scm", "SM", "sm", "ss", "t", NULL };
763 static char Scheme_help [] =
764 "In Scheme code, tags include anything defined with `def' or with a\n\
765 construct whose name starts with `def'. They also include\n\
766 variables set with `set!' at top level in the file.";
767
768 static char *TeX_suffixes [] =
769 { "bib", "clo", "cls", "ltx", "sty", "TeX", "tex", NULL };
770 static char TeX_help [] =
771 "In LaTeX text, the argument of any of the commands `\\chapter',\n\
772 `\\section', `\\subsection', `\\subsubsection', `\\eqno', `\\label',\n\
773 `\\ref', `\\cite', `\\bibitem', `\\part', `\\appendix', `\\entry',\n\
774 `\\index', `\\def', `\\newcommand', `\\renewcommand',\n\
775 `\\newenvironment' or `\\renewenvironment' is a tag.\n\
776 \n\
777 Other commands can be specified by setting the environment variable\n\
778 `TEXTAGS' to a colon-separated list like, for example,\n\
779 TEXTAGS=\"mycommand:myothercommand\".";
780
781
782 static char *Texinfo_suffixes [] =
783 { "texi", "texinfo", "txi", NULL };
784 static char Texinfo_help [] =
785 "for texinfo files, lines starting with @node are tagged.";
786
787 static char *Yacc_suffixes [] =
788 { "y", "y++", "ym", "yxx", "yy", NULL }; /* .ym is Objective yacc file */
789 static char Yacc_help [] =
790 "In Bison or Yacc input files, each rule defines as a tag the\n\
791 nonterminal it constructs. The portions of the file that contain\n\
792 C code are parsed as C code (use --help --lang=c --lang=yacc\n\
793 for full help).";
794
795 static char auto_help [] =
796 "`auto' is not a real language, it indicates to use\n\
797 a default language for files base on file name suffix and file contents.";
798
799 static char none_help [] =
800 "`none' is not a real language, it indicates to only do\n\
801 regexp processing on files.";
802
803 static char no_lang_help [] =
804 "No detailed help available for this language.";
805
806
807 /*
808 * Table of languages.
809 *
810 * It is ok for a given function to be listed under more than one
811 * name. I just didn't.
812 */
813
814 static language lang_names [] =
815 {
816 { "ada", Ada_help, Ada_funcs, Ada_suffixes },
817 { "asm", Asm_help, Asm_labels, Asm_suffixes },
818 { "c", default_C_help, default_C_entries, default_C_suffixes },
819 { "c++", Cplusplus_help, Cplusplus_entries, Cplusplus_suffixes },
820 { "c*", no_lang_help, Cstar_entries, Cstar_suffixes },
821 { "cobol", Cobol_help, Cobol_paragraphs, Cobol_suffixes },
822 { "erlang", Erlang_help, Erlang_functions, Erlang_suffixes },
823 { "forth", Forth_help, Forth_words, Forth_suffixes },
824 { "fortran", Fortran_help, Fortran_functions, Fortran_suffixes },
825 { "html", HTML_help, HTML_labels, HTML_suffixes },
826 { "java", Cjava_help, Cjava_entries, Cjava_suffixes },
827 { "lisp", Lisp_help, Lisp_functions, Lisp_suffixes },
828 { "lua", Lua_help, Lua_functions, Lua_suffixes },
829 { "makefile", Makefile_help,Makefile_targets,NULL,Makefile_filenames},
830 { "objc", Objc_help, plain_C_entries, Objc_suffixes },
831 { "pascal", Pascal_help, Pascal_functions, Pascal_suffixes },
832 { "perl",Perl_help,Perl_functions,Perl_suffixes,NULL,Perl_interpreters},
833 { "php", PHP_help, PHP_functions, PHP_suffixes },
834 { "postscript",PS_help, PS_functions, PS_suffixes },
835 { "proc", no_lang_help, plain_C_entries, plain_C_suffixes },
836 { "prolog", Prolog_help, Prolog_functions, Prolog_suffixes },
837 { "python", Python_help, Python_functions, Python_suffixes },
838 { "scheme", Scheme_help, Scheme_functions, Scheme_suffixes },
839 { "tex", TeX_help, TeX_commands, TeX_suffixes },
840 { "texinfo", Texinfo_help, Texinfo_nodes, Texinfo_suffixes },
841 { "yacc", Yacc_help,Yacc_entries,Yacc_suffixes,NULL,NULL,TRUE},
842 { "auto", auto_help }, /* default guessing scheme */
843 { "none", none_help, just_read_file }, /* regexp matching only */
844 { NULL } /* end of list */
845 };
846
847 \f
848 static void
849 print_language_names ()
850 {
851 language *lang;
852 char **name, **ext;
853
854 puts ("\nThese are the currently supported languages, along with the\n\
855 default file names and dot suffixes:");
856 for (lang = lang_names; lang->name != NULL; lang++)
857 {
858 printf (" %-*s", 10, lang->name);
859 if (lang->filenames != NULL)
860 for (name = lang->filenames; *name != NULL; name++)
861 printf (" %s", *name);
862 if (lang->suffixes != NULL)
863 for (ext = lang->suffixes; *ext != NULL; ext++)
864 printf (" .%s", *ext);
865 puts ("");
866 }
867 puts ("where `auto' means use default language for files based on file\n\
868 name suffix, and `none' means only do regexp processing on files.\n\
869 If no language is specified and no matching suffix is found,\n\
870 the first line of the file is read for a sharp-bang (#!) sequence\n\
871 followed by the name of an interpreter. If no such sequence is found,\n\
872 Fortran is tried first; if no tags are found, C is tried next.\n\
873 When parsing any C file, a \"class\" or \"template\" keyword\n\
874 switches to C++.");
875 puts ("Compressed files are supported using gzip and bzip2.\n\
876 \n\
877 For detailed help on a given language use, for example,\n\
878 etags --help --lang=ada.");
879 }
880
881 #ifndef EMACS_NAME
882 # define EMACS_NAME "standalone"
883 #endif
884 #ifndef VERSION
885 # define VERSION "17.31"
886 #endif
887 static void
888 print_version ()
889 {
890 /* Makes it easier to update automatically. */
891 char emacs_copyright[] = "Copyright (C) 2007 Free Software Foundation, Inc.";
892
893 printf ("%s (%s %s)\n", (CTAGS) ? "ctags" : "etags", EMACS_NAME, VERSION);
894 puts (emacs_copyright);
895 puts ("This program is distributed under the terms in ETAGS.README");
896
897 exit (EXIT_SUCCESS);
898 }
899
900 static void
901 print_help (argbuffer)
902 argument *argbuffer;
903 {
904 bool help_for_lang = FALSE;
905
906 for (; argbuffer->arg_type != at_end; argbuffer++)
907 if (argbuffer->arg_type == at_language)
908 {
909 if (help_for_lang)
910 puts ("");
911 puts (argbuffer->lang->help);
912 help_for_lang = TRUE;
913 }
914
915 if (help_for_lang)
916 exit (EXIT_SUCCESS);
917
918 printf ("Usage: %s [options] [[regex-option ...] file-name] ...\n\
919 \n\
920 These are the options accepted by %s.\n", progname, progname);
921 if (NO_LONG_OPTIONS)
922 puts ("WARNING: long option names do not work with this executable,\n\
923 as it is not linked with GNU getopt.");
924 else
925 puts ("You may use unambiguous abbreviations for the long option names.");
926 puts (" A - as file name means read names from stdin (one per line).\n\
927 Absolute names are stored in the output file as they are.\n\
928 Relative ones are stored relative to the output file's directory.\n");
929
930 puts ("-a, --append\n\
931 Append tag entries to existing tags file.");
932
933 puts ("--packages-only\n\
934 For Ada files, only generate tags for packages.");
935
936 if (CTAGS)
937 puts ("-B, --backward-search\n\
938 Write the search commands for the tag entries using '?', the\n\
939 backward-search command instead of '/', the forward-search command.");
940
941 /* This option is mostly obsolete, because etags can now automatically
942 detect C++. Retained for backward compatibility and for debugging and
943 experimentation. In principle, we could want to tag as C++ even
944 before any "class" or "template" keyword.
945 puts ("-C, --c++\n\
946 Treat files whose name suffix defaults to C language as C++ files.");
947 */
948
949 puts ("--declarations\n\
950 In C and derived languages, create tags for function declarations,");
951 if (CTAGS)
952 puts ("\tand create tags for extern variables if --globals is used.");
953 else
954 puts
955 ("\tand create tags for extern variables unless --no-globals is used.");
956
957 if (CTAGS)
958 puts ("-d, --defines\n\
959 Create tag entries for C #define constants and enum constants, too.");
960 else
961 puts ("-D, --no-defines\n\
962 Don't create tag entries for C #define constants and enum constants.\n\
963 This makes the tags file smaller.");
964
965 if (!CTAGS)
966 puts ("-i FILE, --include=FILE\n\
967 Include a note in tag file indicating that, when searching for\n\
968 a tag, one should also consult the tags file FILE after\n\
969 checking the current file.");
970
971 puts ("-l LANG, --language=LANG\n\
972 Force the following files to be considered as written in the\n\
973 named language up to the next --language=LANG option.");
974
975 if (CTAGS)
976 puts ("--globals\n\
977 Create tag entries for global variables in some languages.");
978 else
979 puts ("--no-globals\n\
980 Do not create tag entries for global variables in some\n\
981 languages. This makes the tags file smaller.");
982 if (CTAGS)
983 puts ("--members\n\
984 Create tag entries for members of structures in some languages.");
985 else
986 puts ("--no-members\n\
987 Do not create tag entries for members of structures\n\
988 in some languages.");
989
990 puts ("-r REGEXP, --regex=REGEXP or --regex=@regexfile\n\
991 Make a tag for each line matching a regular expression pattern\n\
992 in the following files. {LANGUAGE}REGEXP uses REGEXP for LANGUAGE\n\
993 files only. REGEXFILE is a file containing one REGEXP per line.\n\
994 REGEXP takes the form /TAGREGEXP/TAGNAME/MODS, where TAGNAME/ is\n\
995 optional. The TAGREGEXP pattern is anchored (as if preceded by ^).");
996 puts (" If TAGNAME/ is present, the tags created are named.\n\
997 For example Tcl named tags can be created with:\n\
998 --regex=\"/proc[ \\t]+\\([^ \\t]+\\)/\\1/.\".\n\
999 MODS are optional one-letter modifiers: `i' means to ignore case,\n\
1000 `m' means to allow multi-line matches, `s' implies `m' and\n\
1001 causes dot to match any character, including newline.");
1002 puts ("-R, --no-regex\n\
1003 Don't create tags from regexps for the following files.");
1004 puts ("-I, --ignore-indentation\n\
1005 In C and C++ do not assume that a closing brace in the first\n\
1006 column is the final brace of a function or structure definition.");
1007 puts ("-o FILE, --output=FILE\n\
1008 Write the tags to FILE.");
1009 puts ("--parse-stdin=NAME\n\
1010 Read from standard input and record tags as belonging to file NAME.");
1011
1012 if (CTAGS)
1013 {
1014 puts ("-t, --typedefs\n\
1015 Generate tag entries for C and Ada typedefs.");
1016 puts ("-T, --typedefs-and-c++\n\
1017 Generate tag entries for C typedefs, C struct/enum/union tags,\n\
1018 and C++ member functions.");
1019 }
1020
1021 if (CTAGS)
1022 puts ("-u, --update\n\
1023 Update the tag entries for the given files, leaving tag\n\
1024 entries for other files in place. Currently, this is\n\
1025 implemented by deleting the existing entries for the given\n\
1026 files and then rewriting the new entries at the end of the\n\
1027 tags file. It is often faster to simply rebuild the entire\n\
1028 tag file than to use this.");
1029
1030 if (CTAGS)
1031 {
1032 puts ("-v, --vgrind\n\
1033 Print on the standard output an index of items intended for\n\
1034 human consumption, similar to the output of vgrind. The index\n\
1035 is sorted, and gives the page number of each item.");
1036 # if PRINT_UNDOCUMENTED_OPTIONS_HELP
1037 puts ("-w, --no-duplicates\n\
1038 Do not create duplicate tag entries, for compatibility with\n\
1039 traditional ctags.");
1040 puts ("-w, --no-warn\n\
1041 Suppress warning messages about duplicate tag entries.");
1042 # endif /* PRINT_UNDOCUMENTED_OPTIONS_HELP */
1043 puts ("-x, --cxref\n\
1044 Like --vgrind, but in the style of cxref, rather than vgrind.\n\
1045 The output uses line numbers instead of page numbers, but\n\
1046 beyond that the differences are cosmetic; try both to see\n\
1047 which you like.");
1048 }
1049
1050 puts ("-V, --version\n\
1051 Print the version of the program.\n\
1052 -h, --help\n\
1053 Print this help message.\n\
1054 Followed by one or more `--language' options prints detailed\n\
1055 help about tag generation for the specified languages.");
1056
1057 print_language_names ();
1058
1059 puts ("");
1060 puts ("Report bugs to bug-gnu-emacs@gnu.org");
1061
1062 exit (EXIT_SUCCESS);
1063 }
1064
1065 \f
1066 #ifdef VMS /* VMS specific functions */
1067
1068 #define EOS '\0'
1069
1070 /* This is a BUG! ANY arbitrary limit is a BUG!
1071 Won't someone please fix this? */
1072 #define MAX_FILE_SPEC_LEN 255
1073 typedef struct {
1074 short curlen;
1075 char body[MAX_FILE_SPEC_LEN + 1];
1076 } vspec;
1077
1078 /*
1079 v1.05 nmm 26-Jun-86 fn_exp - expand specification of list of file names
1080 returning in each successive call the next file name matching the input
1081 spec. The function expects that each in_spec passed
1082 to it will be processed to completion; in particular, up to and
1083 including the call following that in which the last matching name
1084 is returned, the function ignores the value of in_spec, and will
1085 only start processing a new spec with the following call.
1086 If an error occurs, on return out_spec contains the value
1087 of in_spec when the error occurred.
1088
1089 With each successive file name returned in out_spec, the
1090 function's return value is one. When there are no more matching
1091 names the function returns zero. If on the first call no file
1092 matches in_spec, or there is any other error, -1 is returned.
1093 */
1094
1095 #include <rmsdef.h>
1096 #include <descrip.h>
1097 #define OUTSIZE MAX_FILE_SPEC_LEN
1098 static short
1099 fn_exp (out, in)
1100 vspec *out;
1101 char *in;
1102 {
1103 static long context = 0;
1104 static struct dsc$descriptor_s o;
1105 static struct dsc$descriptor_s i;
1106 static bool pass1 = TRUE;
1107 long status;
1108 short retval;
1109
1110 if (pass1)
1111 {
1112 pass1 = FALSE;
1113 o.dsc$a_pointer = (char *) out;
1114 o.dsc$w_length = (short)OUTSIZE;
1115 i.dsc$a_pointer = in;
1116 i.dsc$w_length = (short)strlen(in);
1117 i.dsc$b_dtype = DSC$K_DTYPE_T;
1118 i.dsc$b_class = DSC$K_CLASS_S;
1119 o.dsc$b_dtype = DSC$K_DTYPE_VT;
1120 o.dsc$b_class = DSC$K_CLASS_VS;
1121 }
1122 if ((status = lib$find_file(&i, &o, &context, 0, 0)) == RMS$_NORMAL)
1123 {
1124 out->body[out->curlen] = EOS;
1125 return 1;
1126 }
1127 else if (status == RMS$_NMF)
1128 retval = 0;
1129 else
1130 {
1131 strcpy(out->body, in);
1132 retval = -1;
1133 }
1134 lib$find_file_end(&context);
1135 pass1 = TRUE;
1136 return retval;
1137 }
1138
1139 /*
1140 v1.01 nmm 19-Aug-85 gfnames - return in successive calls the
1141 name of each file specified by the provided arg expanding wildcards.
1142 */
1143 static char *
1144 gfnames (arg, p_error)
1145 char *arg;
1146 bool *p_error;
1147 {
1148 static vspec filename = {MAX_FILE_SPEC_LEN, "\0"};
1149
1150 switch (fn_exp (&filename, arg))
1151 {
1152 case 1:
1153 *p_error = FALSE;
1154 return filename.body;
1155 case 0:
1156 *p_error = FALSE;
1157 return NULL;
1158 default:
1159 *p_error = TRUE;
1160 return filename.body;
1161 }
1162 }
1163
1164 #ifndef OLD /* Newer versions of VMS do provide `system'. */
1165 system (cmd)
1166 char *cmd;
1167 {
1168 error ("%s", "system() function not implemented under VMS");
1169 }
1170 #endif
1171
1172 #define VERSION_DELIM ';'
1173 char *massage_name (s)
1174 char *s;
1175 {
1176 char *start = s;
1177
1178 for ( ; *s; s++)
1179 if (*s == VERSION_DELIM)
1180 {
1181 *s = EOS;
1182 break;
1183 }
1184 else
1185 *s = lowcase (*s);
1186 return start;
1187 }
1188 #endif /* VMS */
1189
1190 \f
1191 int
1192 main (argc, argv)
1193 int argc;
1194 char *argv[];
1195 {
1196 int i;
1197 unsigned int nincluded_files;
1198 char **included_files;
1199 argument *argbuffer;
1200 int current_arg, file_count;
1201 linebuffer filename_lb;
1202 bool help_asked = FALSE;
1203 #ifdef VMS
1204 bool got_err;
1205 #endif
1206 char *optstring;
1207 int opt;
1208
1209
1210 #ifdef DOS_NT
1211 _fmode = O_BINARY; /* all of files are treated as binary files */
1212 #endif /* DOS_NT */
1213
1214 progname = argv[0];
1215 nincluded_files = 0;
1216 included_files = xnew (argc, char *);
1217 current_arg = 0;
1218 file_count = 0;
1219
1220 /* Allocate enough no matter what happens. Overkill, but each one
1221 is small. */
1222 argbuffer = xnew (argc, argument);
1223
1224 /*
1225 * If etags, always find typedefs and structure tags. Why not?
1226 * Also default to find macro constants, enum constants, struct
1227 * members and global variables.
1228 */
1229 if (!CTAGS)
1230 {
1231 typedefs = typedefs_or_cplusplus = constantypedefs = TRUE;
1232 globals = members = TRUE;
1233 }
1234
1235 /* When the optstring begins with a '-' getopt_long does not rearrange the
1236 non-options arguments to be at the end, but leaves them alone. */
1237 optstring = concat (NO_LONG_OPTIONS ? "" : "-",
1238 "ac:Cf:Il:o:r:RSVhH",
1239 (CTAGS) ? "BxdtTuvw" : "Di:");
1240
1241 while ((opt = getopt_long (argc, argv, optstring, longopts, NULL)) != EOF)
1242 switch (opt)
1243 {
1244 case 0:
1245 /* If getopt returns 0, then it has already processed a
1246 long-named option. We should do nothing. */
1247 break;
1248
1249 case 1:
1250 /* This means that a file name has been seen. Record it. */
1251 argbuffer[current_arg].arg_type = at_filename;
1252 argbuffer[current_arg].what = optarg;
1253 ++current_arg;
1254 ++file_count;
1255 break;
1256
1257 case STDIN:
1258 /* Parse standard input. Idea by Vivek <vivek@etla.org>. */
1259 argbuffer[current_arg].arg_type = at_stdin;
1260 argbuffer[current_arg].what = optarg;
1261 ++current_arg;
1262 ++file_count;
1263 if (parsing_stdin)
1264 fatal ("cannot parse standard input more than once", (char *)NULL);
1265 parsing_stdin = TRUE;
1266 break;
1267
1268 /* Common options. */
1269 case 'a': append_to_tagfile = TRUE; break;
1270 case 'C': cplusplus = TRUE; break;
1271 case 'f': /* for compatibility with old makefiles */
1272 case 'o':
1273 if (tagfile)
1274 {
1275 error ("-o option may only be given once.", (char *)NULL);
1276 suggest_asking_for_help ();
1277 /* NOTREACHED */
1278 }
1279 tagfile = optarg;
1280 break;
1281 case 'I':
1282 case 'S': /* for backward compatibility */
1283 ignoreindent = TRUE;
1284 break;
1285 case 'l':
1286 {
1287 language *lang = get_language_from_langname (optarg);
1288 if (lang != NULL)
1289 {
1290 argbuffer[current_arg].lang = lang;
1291 argbuffer[current_arg].arg_type = at_language;
1292 ++current_arg;
1293 }
1294 }
1295 break;
1296 case 'c':
1297 /* Backward compatibility: support obsolete --ignore-case-regexp. */
1298 optarg = concat (optarg, "i", ""); /* memory leak here */
1299 /* FALLTHRU */
1300 case 'r':
1301 argbuffer[current_arg].arg_type = at_regexp;
1302 argbuffer[current_arg].what = optarg;
1303 ++current_arg;
1304 break;
1305 case 'R':
1306 argbuffer[current_arg].arg_type = at_regexp;
1307 argbuffer[current_arg].what = NULL;
1308 ++current_arg;
1309 break;
1310 case 'V':
1311 print_version ();
1312 break;
1313 case 'h':
1314 case 'H':
1315 help_asked = TRUE;
1316 break;
1317
1318 /* Etags options */
1319 case 'D': constantypedefs = FALSE; break;
1320 case 'i': included_files[nincluded_files++] = optarg; break;
1321
1322 /* Ctags options. */
1323 case 'B': searchar = '?'; break;
1324 case 'd': constantypedefs = TRUE; break;
1325 case 't': typedefs = TRUE; break;
1326 case 'T': typedefs = typedefs_or_cplusplus = TRUE; break;
1327 case 'u': update = TRUE; break;
1328 case 'v': vgrind_style = TRUE; /*FALLTHRU*/
1329 case 'x': cxref_style = TRUE; break;
1330 case 'w': no_warnings = TRUE; break;
1331 default:
1332 suggest_asking_for_help ();
1333 /* NOTREACHED */
1334 }
1335
1336 /* No more options. Store the rest of arguments. */
1337 for (; optind < argc; optind++)
1338 {
1339 argbuffer[current_arg].arg_type = at_filename;
1340 argbuffer[current_arg].what = argv[optind];
1341 ++current_arg;
1342 ++file_count;
1343 }
1344
1345 argbuffer[current_arg].arg_type = at_end;
1346
1347 if (help_asked)
1348 print_help (argbuffer);
1349 /* NOTREACHED */
1350
1351 if (nincluded_files == 0 && file_count == 0)
1352 {
1353 error ("no input files specified.", (char *)NULL);
1354 suggest_asking_for_help ();
1355 /* NOTREACHED */
1356 }
1357
1358 if (tagfile == NULL)
1359 tagfile = CTAGS ? "tags" : "TAGS";
1360 cwd = etags_getcwd (); /* the current working directory */
1361 if (cwd[strlen (cwd) - 1] != '/')
1362 {
1363 char *oldcwd = cwd;
1364 cwd = concat (oldcwd, "/", "");
1365 free (oldcwd);
1366 }
1367 /* Relative file names are made relative to the current directory. */
1368 if (streq (tagfile, "-")
1369 || strneq (tagfile, "/dev/", 5))
1370 tagfiledir = cwd;
1371 else
1372 tagfiledir = absolute_dirname (tagfile, cwd);
1373
1374 init (); /* set up boolean "functions" */
1375
1376 linebuffer_init (&lb);
1377 linebuffer_init (&filename_lb);
1378 linebuffer_init (&filebuf);
1379 linebuffer_init (&token_name);
1380
1381 if (!CTAGS)
1382 {
1383 if (streq (tagfile, "-"))
1384 {
1385 tagf = stdout;
1386 #ifdef DOS_NT
1387 /* Switch redirected `stdout' to binary mode (setting `_fmode'
1388 doesn't take effect until after `stdout' is already open). */
1389 if (!isatty (fileno (stdout)))
1390 setmode (fileno (stdout), O_BINARY);
1391 #endif /* DOS_NT */
1392 }
1393 else
1394 tagf = fopen (tagfile, append_to_tagfile ? "a" : "w");
1395 if (tagf == NULL)
1396 pfatal (tagfile);
1397 }
1398
1399 /*
1400 * Loop through files finding functions.
1401 */
1402 for (i = 0; i < current_arg; i++)
1403 {
1404 static language *lang; /* non-NULL if language is forced */
1405 char *this_file;
1406
1407 switch (argbuffer[i].arg_type)
1408 {
1409 case at_language:
1410 lang = argbuffer[i].lang;
1411 break;
1412 case at_regexp:
1413 analyse_regex (argbuffer[i].what);
1414 break;
1415 case at_filename:
1416 #ifdef VMS
1417 while ((this_file = gfnames (argbuffer[i].what, &got_err)) != NULL)
1418 {
1419 if (got_err)
1420 {
1421 error ("can't find file %s\n", this_file);
1422 argc--, argv++;
1423 }
1424 else
1425 {
1426 this_file = massage_name (this_file);
1427 }
1428 #else
1429 this_file = argbuffer[i].what;
1430 #endif
1431 /* Input file named "-" means read file names from stdin
1432 (one per line) and use them. */
1433 if (streq (this_file, "-"))
1434 {
1435 if (parsing_stdin)
1436 fatal ("cannot parse standard input AND read file names from it",
1437 (char *)NULL);
1438 while (readline_internal (&filename_lb, stdin) > 0)
1439 process_file_name (filename_lb.buffer, lang);
1440 }
1441 else
1442 process_file_name (this_file, lang);
1443 #ifdef VMS
1444 }
1445 #endif
1446 break;
1447 case at_stdin:
1448 this_file = argbuffer[i].what;
1449 process_file (stdin, this_file, lang);
1450 break;
1451 }
1452 }
1453
1454 free_regexps ();
1455 free (lb.buffer);
1456 free (filebuf.buffer);
1457 free (token_name.buffer);
1458
1459 if (!CTAGS || cxref_style)
1460 {
1461 /* Write the remaining tags to tagf (ETAGS) or stdout (CXREF). */
1462 put_entries (nodehead);
1463 free_tree (nodehead);
1464 nodehead = NULL;
1465 if (!CTAGS)
1466 {
1467 fdesc *fdp;
1468
1469 /* Output file entries that have no tags. */
1470 for (fdp = fdhead; fdp != NULL; fdp = fdp->next)
1471 if (!fdp->written)
1472 fprintf (tagf, "\f\n%s,0\n", fdp->taggedfname);
1473
1474 while (nincluded_files-- > 0)
1475 fprintf (tagf, "\f\n%s,include\n", *included_files++);
1476
1477 if (fclose (tagf) == EOF)
1478 pfatal (tagfile);
1479 }
1480
1481 exit (EXIT_SUCCESS);
1482 }
1483
1484 if (update)
1485 {
1486 char cmd[BUFSIZ];
1487 for (i = 0; i < current_arg; ++i)
1488 {
1489 switch (argbuffer[i].arg_type)
1490 {
1491 case at_filename:
1492 case at_stdin:
1493 break;
1494 default:
1495 continue; /* the for loop */
1496 }
1497 sprintf (cmd,
1498 "mv %s OTAGS;fgrep -v '\t%s\t' OTAGS >%s;rm OTAGS",
1499 tagfile, argbuffer[i].what, tagfile);
1500 if (system (cmd) != EXIT_SUCCESS)
1501 fatal ("failed to execute shell command", (char *)NULL);
1502 }
1503 append_to_tagfile = TRUE;
1504 }
1505
1506 tagf = fopen (tagfile, append_to_tagfile ? "a" : "w");
1507 if (tagf == NULL)
1508 pfatal (tagfile);
1509 put_entries (nodehead); /* write all the tags (CTAGS) */
1510 free_tree (nodehead);
1511 nodehead = NULL;
1512 if (fclose (tagf) == EOF)
1513 pfatal (tagfile);
1514
1515 if (CTAGS)
1516 if (append_to_tagfile || update)
1517 {
1518 char cmd[2*BUFSIZ+20];
1519 /* Maybe these should be used:
1520 setenv ("LC_COLLATE", "C", 1);
1521 setenv ("LC_ALL", "C", 1); */
1522 sprintf (cmd, "sort -u -o %.*s %.*s", BUFSIZ, tagfile, BUFSIZ, tagfile);
1523 exit (system (cmd));
1524 }
1525 return EXIT_SUCCESS;
1526 }
1527
1528
1529 /*
1530 * Return a compressor given the file name. If EXTPTR is non-zero,
1531 * return a pointer into FILE where the compressor-specific
1532 * extension begins. If no compressor is found, NULL is returned
1533 * and EXTPTR is not significant.
1534 * Idea by Vladimir Alexiev <vladimir@cs.ualberta.ca> (1998)
1535 */
1536 static compressor *
1537 get_compressor_from_suffix (file, extptr)
1538 char *file;
1539 char **extptr;
1540 {
1541 compressor *compr;
1542 char *slash, *suffix;
1543
1544 /* This relies on FN to be after canonicalize_filename,
1545 so we don't need to consider backslashes on DOS_NT. */
1546 slash = etags_strrchr (file, '/');
1547 suffix = etags_strrchr (file, '.');
1548 if (suffix == NULL || suffix < slash)
1549 return NULL;
1550 if (extptr != NULL)
1551 *extptr = suffix;
1552 suffix += 1;
1553 /* Let those poor souls who live with DOS 8+3 file name limits get
1554 some solace by treating foo.cgz as if it were foo.c.gz, etc.
1555 Only the first do loop is run if not MSDOS */
1556 do
1557 {
1558 for (compr = compressors; compr->suffix != NULL; compr++)
1559 if (streq (compr->suffix, suffix))
1560 return compr;
1561 if (!MSDOS)
1562 break; /* do it only once: not really a loop */
1563 if (extptr != NULL)
1564 *extptr = ++suffix;
1565 } while (*suffix != '\0');
1566 return NULL;
1567 }
1568
1569
1570
1571 /*
1572 * Return a language given the name.
1573 */
1574 static language *
1575 get_language_from_langname (name)
1576 const char *name;
1577 {
1578 language *lang;
1579
1580 if (name == NULL)
1581 error ("empty language name", (char *)NULL);
1582 else
1583 {
1584 for (lang = lang_names; lang->name != NULL; lang++)
1585 if (streq (name, lang->name))
1586 return lang;
1587 error ("unknown language \"%s\"", name);
1588 }
1589
1590 return NULL;
1591 }
1592
1593
1594 /*
1595 * Return a language given the interpreter name.
1596 */
1597 static language *
1598 get_language_from_interpreter (interpreter)
1599 char *interpreter;
1600 {
1601 language *lang;
1602 char **iname;
1603
1604 if (interpreter == NULL)
1605 return NULL;
1606 for (lang = lang_names; lang->name != NULL; lang++)
1607 if (lang->interpreters != NULL)
1608 for (iname = lang->interpreters; *iname != NULL; iname++)
1609 if (streq (*iname, interpreter))
1610 return lang;
1611
1612 return NULL;
1613 }
1614
1615
1616
1617 /*
1618 * Return a language given the file name.
1619 */
1620 static language *
1621 get_language_from_filename (file, case_sensitive)
1622 char *file;
1623 bool case_sensitive;
1624 {
1625 language *lang;
1626 char **name, **ext, *suffix;
1627
1628 /* Try whole file name first. */
1629 for (lang = lang_names; lang->name != NULL; lang++)
1630 if (lang->filenames != NULL)
1631 for (name = lang->filenames; *name != NULL; name++)
1632 if ((case_sensitive)
1633 ? streq (*name, file)
1634 : strcaseeq (*name, file))
1635 return lang;
1636
1637 /* If not found, try suffix after last dot. */
1638 suffix = etags_strrchr (file, '.');
1639 if (suffix == NULL)
1640 return NULL;
1641 suffix += 1;
1642 for (lang = lang_names; lang->name != NULL; lang++)
1643 if (lang->suffixes != NULL)
1644 for (ext = lang->suffixes; *ext != NULL; ext++)
1645 if ((case_sensitive)
1646 ? streq (*ext, suffix)
1647 : strcaseeq (*ext, suffix))
1648 return lang;
1649 return NULL;
1650 }
1651
1652 \f
1653 /*
1654 * This routine is called on each file argument.
1655 */
1656 static void
1657 process_file_name (file, lang)
1658 char *file;
1659 language *lang;
1660 {
1661 struct stat stat_buf;
1662 FILE *inf;
1663 fdesc *fdp;
1664 compressor *compr;
1665 char *compressed_name, *uncompressed_name;
1666 char *ext, *real_name;
1667 int retval;
1668
1669 canonicalize_filename (file);
1670 if (streq (file, tagfile) && !streq (tagfile, "-"))
1671 {
1672 error ("skipping inclusion of %s in self.", file);
1673 return;
1674 }
1675 if ((compr = get_compressor_from_suffix (file, &ext)) == NULL)
1676 {
1677 compressed_name = NULL;
1678 real_name = uncompressed_name = savestr (file);
1679 }
1680 else
1681 {
1682 real_name = compressed_name = savestr (file);
1683 uncompressed_name = savenstr (file, ext - file);
1684 }
1685
1686 /* If the canonicalized uncompressed name
1687 has already been dealt with, skip it silently. */
1688 for (fdp = fdhead; fdp != NULL; fdp = fdp->next)
1689 {
1690 assert (fdp->infname != NULL);
1691 if (streq (uncompressed_name, fdp->infname))
1692 goto cleanup;
1693 }
1694
1695 if (stat (real_name, &stat_buf) != 0)
1696 {
1697 /* Reset real_name and try with a different name. */
1698 real_name = NULL;
1699 if (compressed_name != NULL) /* try with the given suffix */
1700 {
1701 if (stat (uncompressed_name, &stat_buf) == 0)
1702 real_name = uncompressed_name;
1703 }
1704 else /* try all possible suffixes */
1705 {
1706 for (compr = compressors; compr->suffix != NULL; compr++)
1707 {
1708 compressed_name = concat (file, ".", compr->suffix);
1709 if (stat (compressed_name, &stat_buf) != 0)
1710 {
1711 if (MSDOS)
1712 {
1713 char *suf = compressed_name + strlen (file);
1714 size_t suflen = strlen (compr->suffix) + 1;
1715 for ( ; suf[1]; suf++, suflen--)
1716 {
1717 memmove (suf, suf + 1, suflen);
1718 if (stat (compressed_name, &stat_buf) == 0)
1719 {
1720 real_name = compressed_name;
1721 break;
1722 }
1723 }
1724 if (real_name != NULL)
1725 break;
1726 } /* MSDOS */
1727 free (compressed_name);
1728 compressed_name = NULL;
1729 }
1730 else
1731 {
1732 real_name = compressed_name;
1733 break;
1734 }
1735 }
1736 }
1737 if (real_name == NULL)
1738 {
1739 perror (file);
1740 goto cleanup;
1741 }
1742 } /* try with a different name */
1743
1744 if (!S_ISREG (stat_buf.st_mode))
1745 {
1746 error ("skipping %s: it is not a regular file.", real_name);
1747 goto cleanup;
1748 }
1749 if (real_name == compressed_name)
1750 {
1751 char *cmd = concat (compr->command, " ", real_name);
1752 inf = (FILE *) popen (cmd, "r");
1753 free (cmd);
1754 }
1755 else
1756 inf = fopen (real_name, "r");
1757 if (inf == NULL)
1758 {
1759 perror (real_name);
1760 goto cleanup;
1761 }
1762
1763 process_file (inf, uncompressed_name, lang);
1764
1765 if (real_name == compressed_name)
1766 retval = pclose (inf);
1767 else
1768 retval = fclose (inf);
1769 if (retval < 0)
1770 pfatal (file);
1771
1772 cleanup:
1773 if (compressed_name) free (compressed_name);
1774 if (uncompressed_name) free (uncompressed_name);
1775 last_node = NULL;
1776 curfdp = NULL;
1777 return;
1778 }
1779
1780 static void
1781 process_file (fh, fn, lang)
1782 FILE *fh;
1783 char *fn;
1784 language *lang;
1785 {
1786 static const fdesc emptyfdesc;
1787 fdesc *fdp;
1788
1789 /* Create a new input file description entry. */
1790 fdp = xnew (1, fdesc);
1791 *fdp = emptyfdesc;
1792 fdp->next = fdhead;
1793 fdp->infname = savestr (fn);
1794 fdp->lang = lang;
1795 fdp->infabsname = absolute_filename (fn, cwd);
1796 fdp->infabsdir = absolute_dirname (fn, cwd);
1797 if (filename_is_absolute (fn))
1798 {
1799 /* An absolute file name. Canonicalize it. */
1800 fdp->taggedfname = absolute_filename (fn, NULL);
1801 }
1802 else
1803 {
1804 /* A file name relative to cwd. Make it relative
1805 to the directory of the tags file. */
1806 fdp->taggedfname = relative_filename (fn, tagfiledir);
1807 }
1808 fdp->usecharno = TRUE; /* use char position when making tags */
1809 fdp->prop = NULL;
1810 fdp->written = FALSE; /* not written on tags file yet */
1811
1812 fdhead = fdp;
1813 curfdp = fdhead; /* the current file description */
1814
1815 find_entries (fh);
1816
1817 /* If not Ctags, and if this is not metasource and if it contained no #line
1818 directives, we can write the tags and free all nodes pointing to
1819 curfdp. */
1820 if (!CTAGS
1821 && curfdp->usecharno /* no #line directives in this file */
1822 && !curfdp->lang->metasource)
1823 {
1824 node *np, *prev;
1825
1826 /* Look for the head of the sublist relative to this file. See add_node
1827 for the structure of the node tree. */
1828 prev = NULL;
1829 for (np = nodehead; np != NULL; prev = np, np = np->left)
1830 if (np->fdp == curfdp)
1831 break;
1832
1833 /* If we generated tags for this file, write and delete them. */
1834 if (np != NULL)
1835 {
1836 /* This is the head of the last sublist, if any. The following
1837 instructions depend on this being true. */
1838 assert (np->left == NULL);
1839
1840 assert (fdhead == curfdp);
1841 assert (last_node->fdp == curfdp);
1842 put_entries (np); /* write tags for file curfdp->taggedfname */
1843 free_tree (np); /* remove the written nodes */
1844 if (prev == NULL)
1845 nodehead = NULL; /* no nodes left */
1846 else
1847 prev->left = NULL; /* delete the pointer to the sublist */
1848 }
1849 }
1850 }
1851
1852 /*
1853 * This routine sets up the boolean pseudo-functions which work
1854 * by setting boolean flags dependent upon the corresponding character.
1855 * Every char which is NOT in that string is not a white char. Therefore,
1856 * all of the array "_wht" is set to FALSE, and then the elements
1857 * subscripted by the chars in "white" are set to TRUE. Thus "_wht"
1858 * of a char is TRUE if it is the string "white", else FALSE.
1859 */
1860 static void
1861 init ()
1862 {
1863 register char *sp;
1864 register int i;
1865
1866 for (i = 0; i < CHARS; i++)
1867 iswhite(i) = notinname(i) = begtoken(i) = intoken(i) = endtoken(i) = FALSE;
1868 for (sp = white; *sp != '\0'; sp++) iswhite (*sp) = TRUE;
1869 for (sp = nonam; *sp != '\0'; sp++) notinname (*sp) = TRUE;
1870 notinname('\0') = notinname('\n');
1871 for (sp = begtk; *sp != '\0'; sp++) begtoken (*sp) = TRUE;
1872 begtoken('\0') = begtoken('\n');
1873 for (sp = midtk; *sp != '\0'; sp++) intoken (*sp) = TRUE;
1874 intoken('\0') = intoken('\n');
1875 for (sp = endtk; *sp != '\0'; sp++) endtoken (*sp) = TRUE;
1876 endtoken('\0') = endtoken('\n');
1877 }
1878
1879 /*
1880 * This routine opens the specified file and calls the function
1881 * which finds the function and type definitions.
1882 */
1883 static void
1884 find_entries (inf)
1885 FILE *inf;
1886 {
1887 char *cp;
1888 language *lang = curfdp->lang;
1889 Lang_function *parser = NULL;
1890
1891 /* If user specified a language, use it. */
1892 if (lang != NULL && lang->function != NULL)
1893 {
1894 parser = lang->function;
1895 }
1896
1897 /* Else try to guess the language given the file name. */
1898 if (parser == NULL)
1899 {
1900 lang = get_language_from_filename (curfdp->infname, TRUE);
1901 if (lang != NULL && lang->function != NULL)
1902 {
1903 curfdp->lang = lang;
1904 parser = lang->function;
1905 }
1906 }
1907
1908 /* Else look for sharp-bang as the first two characters. */
1909 if (parser == NULL
1910 && readline_internal (&lb, inf) > 0
1911 && lb.len >= 2
1912 && lb.buffer[0] == '#'
1913 && lb.buffer[1] == '!')
1914 {
1915 char *lp;
1916
1917 /* Set lp to point at the first char after the last slash in the
1918 line or, if no slashes, at the first nonblank. Then set cp to
1919 the first successive blank and terminate the string. */
1920 lp = etags_strrchr (lb.buffer+2, '/');
1921 if (lp != NULL)
1922 lp += 1;
1923 else
1924 lp = skip_spaces (lb.buffer + 2);
1925 cp = skip_non_spaces (lp);
1926 *cp = '\0';
1927
1928 if (strlen (lp) > 0)
1929 {
1930 lang = get_language_from_interpreter (lp);
1931 if (lang != NULL && lang->function != NULL)
1932 {
1933 curfdp->lang = lang;
1934 parser = lang->function;
1935 }
1936 }
1937 }
1938
1939 /* We rewind here, even if inf may be a pipe. We fail if the
1940 length of the first line is longer than the pipe block size,
1941 which is unlikely. */
1942 rewind (inf);
1943
1944 /* Else try to guess the language given the case insensitive file name. */
1945 if (parser == NULL)
1946 {
1947 lang = get_language_from_filename (curfdp->infname, FALSE);
1948 if (lang != NULL && lang->function != NULL)
1949 {
1950 curfdp->lang = lang;
1951 parser = lang->function;
1952 }
1953 }
1954
1955 /* Else try Fortran or C. */
1956 if (parser == NULL)
1957 {
1958 node *old_last_node = last_node;
1959
1960 curfdp->lang = get_language_from_langname ("fortran");
1961 find_entries (inf);
1962
1963 if (old_last_node == last_node)
1964 /* No Fortran entries found. Try C. */
1965 {
1966 /* We do not tag if rewind fails.
1967 Only the file name will be recorded in the tags file. */
1968 rewind (inf);
1969 curfdp->lang = get_language_from_langname (cplusplus ? "c++" : "c");
1970 find_entries (inf);
1971 }
1972 return;
1973 }
1974
1975 if (!no_line_directive
1976 && curfdp->lang != NULL && curfdp->lang->metasource)
1977 /* It may be that this is a bingo.y file, and we already parsed a bingo.c
1978 file, or anyway we parsed a file that is automatically generated from
1979 this one. If this is the case, the bingo.c file contained #line
1980 directives that generated tags pointing to this file. Let's delete
1981 them all before parsing this file, which is the real source. */
1982 {
1983 fdesc **fdpp = &fdhead;
1984 while (*fdpp != NULL)
1985 if (*fdpp != curfdp
1986 && streq ((*fdpp)->taggedfname, curfdp->taggedfname))
1987 /* We found one of those! We must delete both the file description
1988 and all tags referring to it. */
1989 {
1990 fdesc *badfdp = *fdpp;
1991
1992 /* Delete the tags referring to badfdp->taggedfname
1993 that were obtained from badfdp->infname. */
1994 invalidate_nodes (badfdp, &nodehead);
1995
1996 *fdpp = badfdp->next; /* remove the bad description from the list */
1997 free_fdesc (badfdp);
1998 }
1999 else
2000 fdpp = &(*fdpp)->next; /* advance the list pointer */
2001 }
2002
2003 assert (parser != NULL);
2004
2005 /* Generic initialisations before reading from file. */
2006 linebuffer_setlen (&filebuf, 0); /* reset the file buffer */
2007
2008 /* Generic initialisations before parsing file with readline. */
2009 lineno = 0; /* reset global line number */
2010 charno = 0; /* reset global char number */
2011 linecharno = 0; /* reset global char number of line start */
2012
2013 parser (inf);
2014
2015 regex_tag_multiline ();
2016 }
2017
2018 \f
2019 /*
2020 * Check whether an implicitly named tag should be created,
2021 * then call `pfnote'.
2022 * NAME is a string that is internally copied by this function.
2023 *
2024 * TAGS format specification
2025 * Idea by Sam Kendall <kendall@mv.mv.com> (1997)
2026 * The following is explained in some more detail in etc/ETAGS.EBNF.
2027 *
2028 * make_tag creates tags with "implicit tag names" (unnamed tags)
2029 * if the following are all true, assuming NONAM=" \f\t\n\r()=,;":
2030 * 1. NAME does not contain any of the characters in NONAM;
2031 * 2. LINESTART contains name as either a rightmost, or rightmost but
2032 * one character, substring;
2033 * 3. the character, if any, immediately before NAME in LINESTART must
2034 * be a character in NONAM;
2035 * 4. the character, if any, immediately after NAME in LINESTART must
2036 * also be a character in NONAM.
2037 *
2038 * The implementation uses the notinname() macro, which recognises the
2039 * characters stored in the string `nonam'.
2040 * etags.el needs to use the same characters that are in NONAM.
2041 */
2042 static void
2043 make_tag (name, namelen, is_func, linestart, linelen, lno, cno)
2044 char *name; /* tag name, or NULL if unnamed */
2045 int namelen; /* tag length */
2046 bool is_func; /* tag is a function */
2047 char *linestart; /* start of the line where tag is */
2048 int linelen; /* length of the line where tag is */
2049 int lno; /* line number */
2050 long cno; /* character number */
2051 {
2052 bool named = (name != NULL && namelen > 0);
2053
2054 if (!CTAGS && named) /* maybe set named to false */
2055 /* Let's try to make an implicit tag name, that is, create an unnamed tag
2056 such that etags.el can guess a name from it. */
2057 {
2058 int i;
2059 register char *cp = name;
2060
2061 for (i = 0; i < namelen; i++)
2062 if (notinname (*cp++))
2063 break;
2064 if (i == namelen) /* rule #1 */
2065 {
2066 cp = linestart + linelen - namelen;
2067 if (notinname (linestart[linelen-1]))
2068 cp -= 1; /* rule #4 */
2069 if (cp >= linestart /* rule #2 */
2070 && (cp == linestart
2071 || notinname (cp[-1])) /* rule #3 */
2072 && strneq (name, cp, namelen)) /* rule #2 */
2073 named = FALSE; /* use implicit tag name */
2074 }
2075 }
2076
2077 if (named)
2078 name = savenstr (name, namelen);
2079 else
2080 name = NULL;
2081 pfnote (name, is_func, linestart, linelen, lno, cno);
2082 }
2083
2084 /* Record a tag. */
2085 static void
2086 pfnote (name, is_func, linestart, linelen, lno, cno)
2087 char *name; /* tag name, or NULL if unnamed */
2088 bool is_func; /* tag is a function */
2089 char *linestart; /* start of the line where tag is */
2090 int linelen; /* length of the line where tag is */
2091 int lno; /* line number */
2092 long cno; /* character number */
2093 {
2094 register node *np;
2095
2096 assert (name == NULL || name[0] != '\0');
2097 if (CTAGS && name == NULL)
2098 return;
2099
2100 np = xnew (1, node);
2101
2102 /* If ctags mode, change name "main" to M<thisfilename>. */
2103 if (CTAGS && !cxref_style && streq (name, "main"))
2104 {
2105 register char *fp = etags_strrchr (curfdp->taggedfname, '/');
2106 np->name = concat ("M", fp == NULL ? curfdp->taggedfname : fp + 1, "");
2107 fp = etags_strrchr (np->name, '.');
2108 if (fp != NULL && fp[1] != '\0' && fp[2] == '\0')
2109 fp[0] = '\0';
2110 }
2111 else
2112 np->name = name;
2113 np->valid = TRUE;
2114 np->been_warned = FALSE;
2115 np->fdp = curfdp;
2116 np->is_func = is_func;
2117 np->lno = lno;
2118 if (np->fdp->usecharno)
2119 /* Our char numbers are 0-base, because of C language tradition?
2120 ctags compatibility? old versions compatibility? I don't know.
2121 Anyway, since emacs's are 1-base we expect etags.el to take care
2122 of the difference. If we wanted to have 1-based numbers, we would
2123 uncomment the +1 below. */
2124 np->cno = cno /* + 1 */ ;
2125 else
2126 np->cno = invalidcharno;
2127 np->left = np->right = NULL;
2128 if (CTAGS && !cxref_style)
2129 {
2130 if (strlen (linestart) < 50)
2131 np->regex = concat (linestart, "$", "");
2132 else
2133 np->regex = savenstr (linestart, 50);
2134 }
2135 else
2136 np->regex = savenstr (linestart, linelen);
2137
2138 add_node (np, &nodehead);
2139 }
2140
2141 /*
2142 * free_tree ()
2143 * recurse on left children, iterate on right children.
2144 */
2145 static void
2146 free_tree (np)
2147 register node *np;
2148 {
2149 while (np)
2150 {
2151 register node *node_right = np->right;
2152 free_tree (np->left);
2153 if (np->name != NULL)
2154 free (np->name);
2155 free (np->regex);
2156 free (np);
2157 np = node_right;
2158 }
2159 }
2160
2161 /*
2162 * free_fdesc ()
2163 * delete a file description
2164 */
2165 static void
2166 free_fdesc (fdp)
2167 register fdesc *fdp;
2168 {
2169 if (fdp->infname != NULL) free (fdp->infname);
2170 if (fdp->infabsname != NULL) free (fdp->infabsname);
2171 if (fdp->infabsdir != NULL) free (fdp->infabsdir);
2172 if (fdp->taggedfname != NULL) free (fdp->taggedfname);
2173 if (fdp->prop != NULL) free (fdp->prop);
2174 free (fdp);
2175 }
2176
2177 /*
2178 * add_node ()
2179 * Adds a node to the tree of nodes. In etags mode, sort by file
2180 * name. In ctags mode, sort by tag name. Make no attempt at
2181 * balancing.
2182 *
2183 * add_node is the only function allowed to add nodes, so it can
2184 * maintain state.
2185 */
2186 static void
2187 add_node (np, cur_node_p)
2188 node *np, **cur_node_p;
2189 {
2190 register int dif;
2191 register node *cur_node = *cur_node_p;
2192
2193 if (cur_node == NULL)
2194 {
2195 *cur_node_p = np;
2196 last_node = np;
2197 return;
2198 }
2199
2200 if (!CTAGS)
2201 /* Etags Mode */
2202 {
2203 /* For each file name, tags are in a linked sublist on the right
2204 pointer. The first tags of different files are a linked list
2205 on the left pointer. last_node points to the end of the last
2206 used sublist. */
2207 if (last_node != NULL && last_node->fdp == np->fdp)
2208 {
2209 /* Let's use the same sublist as the last added node. */
2210 assert (last_node->right == NULL);
2211 last_node->right = np;
2212 last_node = np;
2213 }
2214 else if (cur_node->fdp == np->fdp)
2215 {
2216 /* Scanning the list we found the head of a sublist which is
2217 good for us. Let's scan this sublist. */
2218 add_node (np, &cur_node->right);
2219 }
2220 else
2221 /* The head of this sublist is not good for us. Let's try the
2222 next one. */
2223 add_node (np, &cur_node->left);
2224 } /* if ETAGS mode */
2225
2226 else
2227 {
2228 /* Ctags Mode */
2229 dif = strcmp (np->name, cur_node->name);
2230
2231 /*
2232 * If this tag name matches an existing one, then
2233 * do not add the node, but maybe print a warning.
2234 */
2235 if (no_duplicates && !dif)
2236 {
2237 if (np->fdp == cur_node->fdp)
2238 {
2239 if (!no_warnings)
2240 {
2241 fprintf (stderr, "Duplicate entry in file %s, line %d: %s\n",
2242 np->fdp->infname, lineno, np->name);
2243 fprintf (stderr, "Second entry ignored\n");
2244 }
2245 }
2246 else if (!cur_node->been_warned && !no_warnings)
2247 {
2248 fprintf
2249 (stderr,
2250 "Duplicate entry in files %s and %s: %s (Warning only)\n",
2251 np->fdp->infname, cur_node->fdp->infname, np->name);
2252 cur_node->been_warned = TRUE;
2253 }
2254 return;
2255 }
2256
2257 /* Actually add the node */
2258 add_node (np, dif < 0 ? &cur_node->left : &cur_node->right);
2259 } /* if CTAGS mode */
2260 }
2261
2262 /*
2263 * invalidate_nodes ()
2264 * Scan the node tree and invalidate all nodes pointing to the
2265 * given file description (CTAGS case) or free them (ETAGS case).
2266 */
2267 static void
2268 invalidate_nodes (badfdp, npp)
2269 fdesc *badfdp;
2270 node **npp;
2271 {
2272 node *np = *npp;
2273
2274 if (np == NULL)
2275 return;
2276
2277 if (CTAGS)
2278 {
2279 if (np->left != NULL)
2280 invalidate_nodes (badfdp, &np->left);
2281 if (np->fdp == badfdp)
2282 np->valid = FALSE;
2283 if (np->right != NULL)
2284 invalidate_nodes (badfdp, &np->right);
2285 }
2286 else
2287 {
2288 assert (np->fdp != NULL);
2289 if (np->fdp == badfdp)
2290 {
2291 *npp = np->left; /* detach the sublist from the list */
2292 np->left = NULL; /* isolate it */
2293 free_tree (np); /* free it */
2294 invalidate_nodes (badfdp, npp);
2295 }
2296 else
2297 invalidate_nodes (badfdp, &np->left);
2298 }
2299 }
2300
2301 \f
2302 static int total_size_of_entries __P((node *));
2303 static int number_len __P((long));
2304
2305 /* Length of a non-negative number's decimal representation. */
2306 static int
2307 number_len (num)
2308 long num;
2309 {
2310 int len = 1;
2311 while ((num /= 10) > 0)
2312 len += 1;
2313 return len;
2314 }
2315
2316 /*
2317 * Return total number of characters that put_entries will output for
2318 * the nodes in the linked list at the right of the specified node.
2319 * This count is irrelevant with etags.el since emacs 19.34 at least,
2320 * but is still supplied for backward compatibility.
2321 */
2322 static int
2323 total_size_of_entries (np)
2324 register node *np;
2325 {
2326 register int total = 0;
2327
2328 for (; np != NULL; np = np->right)
2329 if (np->valid)
2330 {
2331 total += strlen (np->regex) + 1; /* pat\177 */
2332 if (np->name != NULL)
2333 total += strlen (np->name) + 1; /* name\001 */
2334 total += number_len ((long) np->lno) + 1; /* lno, */
2335 if (np->cno != invalidcharno) /* cno */
2336 total += number_len (np->cno);
2337 total += 1; /* newline */
2338 }
2339
2340 return total;
2341 }
2342
2343 static void
2344 put_entries (np)
2345 register node *np;
2346 {
2347 register char *sp;
2348 static fdesc *fdp = NULL;
2349
2350 if (np == NULL)
2351 return;
2352
2353 /* Output subentries that precede this one */
2354 if (CTAGS)
2355 put_entries (np->left);
2356
2357 /* Output this entry */
2358 if (np->valid)
2359 {
2360 if (!CTAGS)
2361 {
2362 /* Etags mode */
2363 if (fdp != np->fdp)
2364 {
2365 fdp = np->fdp;
2366 fprintf (tagf, "\f\n%s,%d\n",
2367 fdp->taggedfname, total_size_of_entries (np));
2368 fdp->written = TRUE;
2369 }
2370 fputs (np->regex, tagf);
2371 fputc ('\177', tagf);
2372 if (np->name != NULL)
2373 {
2374 fputs (np->name, tagf);
2375 fputc ('\001', tagf);
2376 }
2377 fprintf (tagf, "%d,", np->lno);
2378 if (np->cno != invalidcharno)
2379 fprintf (tagf, "%ld", np->cno);
2380 fputs ("\n", tagf);
2381 }
2382 else
2383 {
2384 /* Ctags mode */
2385 if (np->name == NULL)
2386 error ("internal error: NULL name in ctags mode.", (char *)NULL);
2387
2388 if (cxref_style)
2389 {
2390 if (vgrind_style)
2391 fprintf (stdout, "%s %s %d\n",
2392 np->name, np->fdp->taggedfname, (np->lno + 63) / 64);
2393 else
2394 fprintf (stdout, "%-16s %3d %-16s %s\n",
2395 np->name, np->lno, np->fdp->taggedfname, np->regex);
2396 }
2397 else
2398 {
2399 fprintf (tagf, "%s\t%s\t", np->name, np->fdp->taggedfname);
2400
2401 if (np->is_func)
2402 { /* function or #define macro with args */
2403 putc (searchar, tagf);
2404 putc ('^', tagf);
2405
2406 for (sp = np->regex; *sp; sp++)
2407 {
2408 if (*sp == '\\' || *sp == searchar)
2409 putc ('\\', tagf);
2410 putc (*sp, tagf);
2411 }
2412 putc (searchar, tagf);
2413 }
2414 else
2415 { /* anything else; text pattern inadequate */
2416 fprintf (tagf, "%d", np->lno);
2417 }
2418 putc ('\n', tagf);
2419 }
2420 }
2421 } /* if this node contains a valid tag */
2422
2423 /* Output subentries that follow this one */
2424 put_entries (np->right);
2425 if (!CTAGS)
2426 put_entries (np->left);
2427 }
2428
2429 \f
2430 /* C extensions. */
2431 #define C_EXT 0x00fff /* C extensions */
2432 #define C_PLAIN 0x00000 /* C */
2433 #define C_PLPL 0x00001 /* C++ */
2434 #define C_STAR 0x00003 /* C* */
2435 #define C_JAVA 0x00005 /* JAVA */
2436 #define C_AUTO 0x01000 /* C, but switch to C++ if `class' is met */
2437 #define YACC 0x10000 /* yacc file */
2438
2439 /*
2440 * The C symbol tables.
2441 */
2442 enum sym_type
2443 {
2444 st_none,
2445 st_C_objprot, st_C_objimpl, st_C_objend,
2446 st_C_gnumacro,
2447 st_C_ignore, st_C_attribute,
2448 st_C_javastruct,
2449 st_C_operator,
2450 st_C_class, st_C_template,
2451 st_C_struct, st_C_extern, st_C_enum, st_C_define, st_C_typedef
2452 };
2453
2454 static unsigned int hash __P((const char *, unsigned int));
2455 static struct C_stab_entry * in_word_set __P((const char *, unsigned int));
2456 static enum sym_type C_symtype __P((char *, int, int));
2457
2458 /* Feed stuff between (but not including) %[ and %] lines to:
2459 gperf -m 5
2460 %[
2461 %compare-strncmp
2462 %enum
2463 %struct-type
2464 struct C_stab_entry { char *name; int c_ext; enum sym_type type; }
2465 %%
2466 if, 0, st_C_ignore
2467 for, 0, st_C_ignore
2468 while, 0, st_C_ignore
2469 switch, 0, st_C_ignore
2470 return, 0, st_C_ignore
2471 __attribute__, 0, st_C_attribute
2472 @interface, 0, st_C_objprot
2473 @protocol, 0, st_C_objprot
2474 @implementation,0, st_C_objimpl
2475 @end, 0, st_C_objend
2476 import, (C_JAVA & ~C_PLPL), st_C_ignore
2477 package, (C_JAVA & ~C_PLPL), st_C_ignore
2478 friend, C_PLPL, st_C_ignore
2479 extends, (C_JAVA & ~C_PLPL), st_C_javastruct
2480 implements, (C_JAVA & ~C_PLPL), st_C_javastruct
2481 interface, (C_JAVA & ~C_PLPL), st_C_struct
2482 class, 0, st_C_class
2483 namespace, C_PLPL, st_C_struct
2484 domain, C_STAR, st_C_struct
2485 union, 0, st_C_struct
2486 struct, 0, st_C_struct
2487 extern, 0, st_C_extern
2488 enum, 0, st_C_enum
2489 typedef, 0, st_C_typedef
2490 define, 0, st_C_define
2491 undef, 0, st_C_define
2492 operator, C_PLPL, st_C_operator
2493 template, 0, st_C_template
2494 # DEFUN used in emacs, the next three used in glibc (SYSCALL only for mach).
2495 DEFUN, 0, st_C_gnumacro
2496 SYSCALL, 0, st_C_gnumacro
2497 ENTRY, 0, st_C_gnumacro
2498 PSEUDO, 0, st_C_gnumacro
2499 # These are defined inside C functions, so currently they are not met.
2500 # EXFUN used in glibc, DEFVAR_* in emacs.
2501 #EXFUN, 0, st_C_gnumacro
2502 #DEFVAR_, 0, st_C_gnumacro
2503 %]
2504 and replace lines between %< and %> with its output, then:
2505 - remove the #if characterset check
2506 - make in_word_set static and not inline. */
2507 /*%<*/
2508 /* C code produced by gperf version 3.0.1 */
2509 /* Command-line: gperf -m 5 */
2510 /* Computed positions: -k'2-3' */
2511
2512 struct C_stab_entry { char *name; int c_ext; enum sym_type type; };
2513 /* maximum key range = 33, duplicates = 0 */
2514
2515 #ifdef __GNUC__
2516 __inline
2517 #else
2518 #ifdef __cplusplus
2519 inline
2520 #endif
2521 #endif
2522 static unsigned int
2523 hash (str, len)
2524 register const char *str;
2525 register unsigned int len;
2526 {
2527 static unsigned char asso_values[] =
2528 {
2529 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2530 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2531 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2532 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2533 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2534 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2535 35, 35, 35, 35, 35, 35, 35, 35, 35, 15,
2536 14, 35, 35, 35, 35, 35, 35, 35, 14, 35,
2537 35, 35, 35, 12, 13, 35, 35, 35, 35, 12,
2538 35, 35, 35, 35, 35, 1, 35, 16, 35, 6,
2539 23, 0, 0, 35, 22, 0, 35, 35, 5, 0,
2540 0, 15, 1, 35, 6, 35, 8, 19, 35, 16,
2541 4, 5, 35, 35, 35, 35, 35, 35, 35, 35,
2542 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2543 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2544 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2545 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2546 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2547 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2548 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2549 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2550 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2551 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2552 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2553 35, 35, 35, 35, 35, 35, 35, 35, 35, 35,
2554 35, 35, 35, 35, 35, 35
2555 };
2556 register int hval = len;
2557
2558 switch (hval)
2559 {
2560 default:
2561 hval += asso_values[(unsigned char)str[2]];
2562 /*FALLTHROUGH*/
2563 case 2:
2564 hval += asso_values[(unsigned char)str[1]];
2565 break;
2566 }
2567 return hval;
2568 }
2569
2570 static struct C_stab_entry *
2571 in_word_set (str, len)
2572 register const char *str;
2573 register unsigned int len;
2574 {
2575 enum
2576 {
2577 TOTAL_KEYWORDS = 32,
2578 MIN_WORD_LENGTH = 2,
2579 MAX_WORD_LENGTH = 15,
2580 MIN_HASH_VALUE = 2,
2581 MAX_HASH_VALUE = 34
2582 };
2583
2584 static struct C_stab_entry wordlist[] =
2585 {
2586 {""}, {""},
2587 {"if", 0, st_C_ignore},
2588 {""},
2589 {"@end", 0, st_C_objend},
2590 {"union", 0, st_C_struct},
2591 {"define", 0, st_C_define},
2592 {"import", (C_JAVA & ~C_PLPL), st_C_ignore},
2593 {"template", 0, st_C_template},
2594 {"operator", C_PLPL, st_C_operator},
2595 {"@interface", 0, st_C_objprot},
2596 {"implements", (C_JAVA & ~C_PLPL), st_C_javastruct},
2597 {"friend", C_PLPL, st_C_ignore},
2598 {"typedef", 0, st_C_typedef},
2599 {"return", 0, st_C_ignore},
2600 {"@implementation",0, st_C_objimpl},
2601 {"@protocol", 0, st_C_objprot},
2602 {"interface", (C_JAVA & ~C_PLPL), st_C_struct},
2603 {"extern", 0, st_C_extern},
2604 {"extends", (C_JAVA & ~C_PLPL), st_C_javastruct},
2605 {"struct", 0, st_C_struct},
2606 {"domain", C_STAR, st_C_struct},
2607 {"switch", 0, st_C_ignore},
2608 {"enum", 0, st_C_enum},
2609 {"for", 0, st_C_ignore},
2610 {"namespace", C_PLPL, st_C_struct},
2611 {"class", 0, st_C_class},
2612 {"while", 0, st_C_ignore},
2613 {"undef", 0, st_C_define},
2614 {"package", (C_JAVA & ~C_PLPL), st_C_ignore},
2615 {"__attribute__", 0, st_C_attribute},
2616 {"SYSCALL", 0, st_C_gnumacro},
2617 {"ENTRY", 0, st_C_gnumacro},
2618 {"PSEUDO", 0, st_C_gnumacro},
2619 {"DEFUN", 0, st_C_gnumacro}
2620 };
2621
2622 if (len <= MAX_WORD_LENGTH && len >= MIN_WORD_LENGTH)
2623 {
2624 register int key = hash (str, len);
2625
2626 if (key <= MAX_HASH_VALUE && key >= 0)
2627 {
2628 register const char *s = wordlist[key].name;
2629
2630 if (*str == *s && !strncmp (str + 1, s + 1, len - 1) && s[len] == '\0')
2631 return &wordlist[key];
2632 }
2633 }
2634 return 0;
2635 }
2636 /*%>*/
2637
2638 static enum sym_type
2639 C_symtype (str, len, c_ext)
2640 char *str;
2641 int len;
2642 int c_ext;
2643 {
2644 register struct C_stab_entry *se = in_word_set (str, len);
2645
2646 if (se == NULL || (se->c_ext && !(c_ext & se->c_ext)))
2647 return st_none;
2648 return se->type;
2649 }
2650
2651 \f
2652 /*
2653 * Ignoring __attribute__ ((list))
2654 */
2655 static bool inattribute; /* looking at an __attribute__ construct */
2656
2657 /*
2658 * C functions and variables are recognized using a simple
2659 * finite automaton. fvdef is its state variable.
2660 */
2661 static enum
2662 {
2663 fvnone, /* nothing seen */
2664 fdefunkey, /* Emacs DEFUN keyword seen */
2665 fdefunname, /* Emacs DEFUN name seen */
2666 foperator, /* func: operator keyword seen (cplpl) */
2667 fvnameseen, /* function or variable name seen */
2668 fstartlist, /* func: just after open parenthesis */
2669 finlist, /* func: in parameter list */
2670 flistseen, /* func: after parameter list */
2671 fignore, /* func: before open brace */
2672 vignore /* var-like: ignore until ';' */
2673 } fvdef;
2674
2675 static bool fvextern; /* func or var: extern keyword seen; */
2676
2677 /*
2678 * typedefs are recognized using a simple finite automaton.
2679 * typdef is its state variable.
2680 */
2681 static enum
2682 {
2683 tnone, /* nothing seen */
2684 tkeyseen, /* typedef keyword seen */
2685 ttypeseen, /* defined type seen */
2686 tinbody, /* inside typedef body */
2687 tend, /* just before typedef tag */
2688 tignore /* junk after typedef tag */
2689 } typdef;
2690
2691 /*
2692 * struct-like structures (enum, struct and union) are recognized
2693 * using another simple finite automaton. `structdef' is its state
2694 * variable.
2695 */
2696 static enum
2697 {
2698 snone, /* nothing seen yet,
2699 or in struct body if bracelev > 0 */
2700 skeyseen, /* struct-like keyword seen */
2701 stagseen, /* struct-like tag seen */
2702 scolonseen /* colon seen after struct-like tag */
2703 } structdef;
2704
2705 /*
2706 * When objdef is different from onone, objtag is the name of the class.
2707 */
2708 static char *objtag = "<uninited>";
2709
2710 /*
2711 * Yet another little state machine to deal with preprocessor lines.
2712 */
2713 static enum
2714 {
2715 dnone, /* nothing seen */
2716 dsharpseen, /* '#' seen as first char on line */
2717 ddefineseen, /* '#' and 'define' seen */
2718 dignorerest /* ignore rest of line */
2719 } definedef;
2720
2721 /*
2722 * State machine for Objective C protocols and implementations.
2723 * Idea by Tom R.Hageman <tom@basil.icce.rug.nl> (1995)
2724 */
2725 static enum
2726 {
2727 onone, /* nothing seen */
2728 oprotocol, /* @interface or @protocol seen */
2729 oimplementation, /* @implementations seen */
2730 otagseen, /* class name seen */
2731 oparenseen, /* parenthesis before category seen */
2732 ocatseen, /* category name seen */
2733 oinbody, /* in @implementation body */
2734 omethodsign, /* in @implementation body, after +/- */
2735 omethodtag, /* after method name */
2736 omethodcolon, /* after method colon */
2737 omethodparm, /* after method parameter */
2738 oignore /* wait for @end */
2739 } objdef;
2740
2741
2742 /*
2743 * Use this structure to keep info about the token read, and how it
2744 * should be tagged. Used by the make_C_tag function to build a tag.
2745 */
2746 static struct tok
2747 {
2748 char *line; /* string containing the token */
2749 int offset; /* where the token starts in LINE */
2750 int length; /* token length */
2751 /*
2752 The previous members can be used to pass strings around for generic
2753 purposes. The following ones specifically refer to creating tags. In this
2754 case the token contained here is the pattern that will be used to create a
2755 tag.
2756 */
2757 bool valid; /* do not create a tag; the token should be
2758 invalidated whenever a state machine is
2759 reset prematurely */
2760 bool named; /* create a named tag */
2761 int lineno; /* source line number of tag */
2762 long linepos; /* source char number of tag */
2763 } token; /* latest token read */
2764
2765 /*
2766 * Variables and functions for dealing with nested structures.
2767 * Idea by Mykola Dzyuba <mdzyuba@yahoo.com> (2001)
2768 */
2769 static void pushclass_above __P((int, char *, int));
2770 static void popclass_above __P((int));
2771 static void write_classname __P((linebuffer *, char *qualifier));
2772
2773 static struct {
2774 char **cname; /* nested class names */
2775 int *bracelev; /* nested class brace level */
2776 int nl; /* class nesting level (elements used) */
2777 int size; /* length of the array */
2778 } cstack; /* stack for nested declaration tags */
2779 /* Current struct nesting depth (namespace, class, struct, union, enum). */
2780 #define nestlev (cstack.nl)
2781 /* After struct keyword or in struct body, not inside a nested function. */
2782 #define instruct (structdef == snone && nestlev > 0 \
2783 && bracelev == cstack.bracelev[nestlev-1] + 1)
2784
2785 static void
2786 pushclass_above (bracelev, str, len)
2787 int bracelev;
2788 char *str;
2789 int len;
2790 {
2791 int nl;
2792
2793 popclass_above (bracelev);
2794 nl = cstack.nl;
2795 if (nl >= cstack.size)
2796 {
2797 int size = cstack.size *= 2;
2798 xrnew (cstack.cname, size, char *);
2799 xrnew (cstack.bracelev, size, int);
2800 }
2801 assert (nl == 0 || cstack.bracelev[nl-1] < bracelev);
2802 cstack.cname[nl] = (str == NULL) ? NULL : savenstr (str, len);
2803 cstack.bracelev[nl] = bracelev;
2804 cstack.nl = nl + 1;
2805 }
2806
2807 static void
2808 popclass_above (bracelev)
2809 int bracelev;
2810 {
2811 int nl;
2812
2813 for (nl = cstack.nl - 1;
2814 nl >= 0 && cstack.bracelev[nl] >= bracelev;
2815 nl--)
2816 {
2817 if (cstack.cname[nl] != NULL)
2818 free (cstack.cname[nl]);
2819 cstack.nl = nl;
2820 }
2821 }
2822
2823 static void
2824 write_classname (cn, qualifier)
2825 linebuffer *cn;
2826 char *qualifier;
2827 {
2828 int i, len;
2829 int qlen = strlen (qualifier);
2830
2831 if (cstack.nl == 0 || cstack.cname[0] == NULL)
2832 {
2833 len = 0;
2834 cn->len = 0;
2835 cn->buffer[0] = '\0';
2836 }
2837 else
2838 {
2839 len = strlen (cstack.cname[0]);
2840 linebuffer_setlen (cn, len);
2841 strcpy (cn->buffer, cstack.cname[0]);
2842 }
2843 for (i = 1; i < cstack.nl; i++)
2844 {
2845 char *s;
2846 int slen;
2847
2848 s = cstack.cname[i];
2849 if (s == NULL)
2850 continue;
2851 slen = strlen (s);
2852 len += slen + qlen;
2853 linebuffer_setlen (cn, len);
2854 strncat (cn->buffer, qualifier, qlen);
2855 strncat (cn->buffer, s, slen);
2856 }
2857 }
2858
2859 \f
2860 static bool consider_token __P((char *, int, int, int *, int, int, bool *));
2861 static void make_C_tag __P((bool));
2862
2863 /*
2864 * consider_token ()
2865 * checks to see if the current token is at the start of a
2866 * function or variable, or corresponds to a typedef, or
2867 * is a struct/union/enum tag, or #define, or an enum constant.
2868 *
2869 * *IS_FUNC gets TRUE iff the token is a function or #define macro
2870 * with args. C_EXTP points to which language we are looking at.
2871 *
2872 * Globals
2873 * fvdef IN OUT
2874 * structdef IN OUT
2875 * definedef IN OUT
2876 * typdef IN OUT
2877 * objdef IN OUT
2878 */
2879
2880 static bool
2881 consider_token (str, len, c, c_extp, bracelev, parlev, is_func_or_var)
2882 register char *str; /* IN: token pointer */
2883 register int len; /* IN: token length */
2884 register int c; /* IN: first char after the token */
2885 int *c_extp; /* IN, OUT: C extensions mask */
2886 int bracelev; /* IN: brace level */
2887 int parlev; /* IN: parenthesis level */
2888 bool *is_func_or_var; /* OUT: function or variable found */
2889 {
2890 /* When structdef is stagseen, scolonseen, or snone with bracelev > 0,
2891 structtype is the type of the preceding struct-like keyword, and
2892 structbracelev is the brace level where it has been seen. */
2893 static enum sym_type structtype;
2894 static int structbracelev;
2895 static enum sym_type toktype;
2896
2897
2898 toktype = C_symtype (str, len, *c_extp);
2899
2900 /*
2901 * Skip __attribute__
2902 */
2903 if (toktype == st_C_attribute)
2904 {
2905 inattribute = TRUE;
2906 return FALSE;
2907 }
2908
2909 /*
2910 * Advance the definedef state machine.
2911 */
2912 switch (definedef)
2913 {
2914 case dnone:
2915 /* We're not on a preprocessor line. */
2916 if (toktype == st_C_gnumacro)
2917 {
2918 fvdef = fdefunkey;
2919 return FALSE;
2920 }
2921 break;
2922 case dsharpseen:
2923 if (toktype == st_C_define)
2924 {
2925 definedef = ddefineseen;
2926 }
2927 else
2928 {
2929 definedef = dignorerest;
2930 }
2931 return FALSE;
2932 case ddefineseen:
2933 /*
2934 * Make a tag for any macro, unless it is a constant
2935 * and constantypedefs is FALSE.
2936 */
2937 definedef = dignorerest;
2938 *is_func_or_var = (c == '(');
2939 if (!*is_func_or_var && !constantypedefs)
2940 return FALSE;
2941 else
2942 return TRUE;
2943 case dignorerest:
2944 return FALSE;
2945 default:
2946 error ("internal error: definedef value.", (char *)NULL);
2947 }
2948
2949 /*
2950 * Now typedefs
2951 */
2952 switch (typdef)
2953 {
2954 case tnone:
2955 if (toktype == st_C_typedef)
2956 {
2957 if (typedefs)
2958 typdef = tkeyseen;
2959 fvextern = FALSE;
2960 fvdef = fvnone;
2961 return FALSE;
2962 }
2963 break;
2964 case tkeyseen:
2965 switch (toktype)
2966 {
2967 case st_none:
2968 case st_C_class:
2969 case st_C_struct:
2970 case st_C_enum:
2971 typdef = ttypeseen;
2972 }
2973 break;
2974 case ttypeseen:
2975 if (structdef == snone && fvdef == fvnone)
2976 {
2977 fvdef = fvnameseen;
2978 return TRUE;
2979 }
2980 break;
2981 case tend:
2982 switch (toktype)
2983 {
2984 case st_C_class:
2985 case st_C_struct:
2986 case st_C_enum:
2987 return FALSE;
2988 }
2989 return TRUE;
2990 }
2991
2992 /*
2993 * This structdef business is NOT invoked when we are ctags and the
2994 * file is plain C. This is because a struct tag may have the same
2995 * name as another tag, and this loses with ctags.
2996 */
2997 switch (toktype)
2998 {
2999 case st_C_javastruct:
3000 if (structdef == stagseen)
3001 structdef = scolonseen;
3002 return FALSE;
3003 case st_C_template:
3004 case st_C_class:
3005 if ((*c_extp & C_AUTO) /* automatic detection of C++ language */
3006 && bracelev == 0
3007 && definedef == dnone && structdef == snone
3008 && typdef == tnone && fvdef == fvnone)
3009 *c_extp = (*c_extp | C_PLPL) & ~C_AUTO;
3010 if (toktype == st_C_template)
3011 break;
3012 /* FALLTHRU */
3013 case st_C_struct:
3014 case st_C_enum:
3015 if (parlev == 0
3016 && fvdef != vignore
3017 && (typdef == tkeyseen
3018 || (typedefs_or_cplusplus && structdef == snone)))
3019 {
3020 structdef = skeyseen;
3021 structtype = toktype;
3022 structbracelev = bracelev;
3023 if (fvdef == fvnameseen)
3024 fvdef = fvnone;
3025 }
3026 return FALSE;
3027 }
3028
3029 if (structdef == skeyseen)
3030 {
3031 structdef = stagseen;
3032 return TRUE;
3033 }
3034
3035 if (typdef != tnone)
3036 definedef = dnone;
3037
3038 /* Detect Objective C constructs. */
3039 switch (objdef)
3040 {
3041 case onone:
3042 switch (toktype)
3043 {
3044 case st_C_objprot:
3045 objdef = oprotocol;
3046 return FALSE;
3047 case st_C_objimpl:
3048 objdef = oimplementation;
3049 return FALSE;
3050 }
3051 break;
3052 case oimplementation:
3053 /* Save the class tag for functions or variables defined inside. */
3054 objtag = savenstr (str, len);
3055 objdef = oinbody;
3056 return FALSE;
3057 case oprotocol:
3058 /* Save the class tag for categories. */
3059 objtag = savenstr (str, len);
3060 objdef = otagseen;
3061 *is_func_or_var = TRUE;
3062 return TRUE;
3063 case oparenseen:
3064 objdef = ocatseen;
3065 *is_func_or_var = TRUE;
3066 return TRUE;
3067 case oinbody:
3068 break;
3069 case omethodsign:
3070 if (parlev == 0)
3071 {
3072 fvdef = fvnone;
3073 objdef = omethodtag;
3074 linebuffer_setlen (&token_name, len);
3075 strncpy (token_name.buffer, str, len);
3076 token_name.buffer[len] = '\0';
3077 return TRUE;
3078 }
3079 return FALSE;
3080 case omethodcolon:
3081 if (parlev == 0)
3082 objdef = omethodparm;
3083 return FALSE;
3084 case omethodparm:
3085 if (parlev == 0)
3086 {
3087 fvdef = fvnone;
3088 objdef = omethodtag;
3089 linebuffer_setlen (&token_name, token_name.len + len);
3090 strncat (token_name.buffer, str, len);
3091 return TRUE;
3092 }
3093 return FALSE;
3094 case oignore:
3095 if (toktype == st_C_objend)
3096 {
3097 /* Memory leakage here: the string pointed by objtag is
3098 never released, because many tests would be needed to
3099 avoid breaking on incorrect input code. The amount of
3100 memory leaked here is the sum of the lengths of the
3101 class tags.
3102 free (objtag); */
3103 objdef = onone;
3104 }
3105 return FALSE;
3106 }
3107
3108 /* A function, variable or enum constant? */
3109 switch (toktype)
3110 {
3111 case st_C_extern:
3112 fvextern = TRUE;
3113 switch (fvdef)
3114 {
3115 case finlist:
3116 case flistseen:
3117 case fignore:
3118 case vignore:
3119 break;
3120 default:
3121 fvdef = fvnone;
3122 }
3123 return FALSE;
3124 case st_C_ignore:
3125 fvextern = FALSE;
3126 fvdef = vignore;
3127 return FALSE;
3128 case st_C_operator:
3129 fvdef = foperator;
3130 *is_func_or_var = TRUE;
3131 return TRUE;
3132 case st_none:
3133 if (constantypedefs
3134 && structdef == snone
3135 && structtype == st_C_enum && bracelev > structbracelev)
3136 return TRUE; /* enum constant */
3137 switch (fvdef)
3138 {
3139 case fdefunkey:
3140 if (bracelev > 0)
3141 break;
3142 fvdef = fdefunname; /* GNU macro */
3143 *is_func_or_var = TRUE;
3144 return TRUE;
3145 case fvnone:
3146 switch (typdef)
3147 {
3148 case ttypeseen:
3149 return FALSE;
3150 case tnone:
3151 if ((strneq (str, "asm", 3) && endtoken (str[3]))
3152 || (strneq (str, "__asm__", 7) && endtoken (str[7])))
3153 {
3154 fvdef = vignore;
3155 return FALSE;
3156 }
3157 break;
3158 }
3159 /* FALLTHRU */
3160 case fvnameseen:
3161 if (len >= 10 && strneq (str+len-10, "::operator", 10))
3162 {
3163 if (*c_extp & C_AUTO) /* automatic detection of C++ */
3164 *c_extp = (*c_extp | C_PLPL) & ~C_AUTO;
3165 fvdef = foperator;
3166 *is_func_or_var = TRUE;
3167 return TRUE;
3168 }
3169 if (bracelev > 0 && !instruct)
3170 break;
3171 fvdef = fvnameseen; /* function or variable */
3172 *is_func_or_var = TRUE;
3173 return TRUE;
3174 }
3175 break;
3176 }
3177
3178 return FALSE;
3179 }
3180
3181 \f
3182 /*
3183 * C_entries often keeps pointers to tokens or lines which are older than
3184 * the line currently read. By keeping two line buffers, and switching
3185 * them at end of line, it is possible to use those pointers.
3186 */
3187 static struct
3188 {
3189 long linepos;
3190 linebuffer lb;
3191 } lbs[2];
3192
3193 #define current_lb_is_new (newndx == curndx)
3194 #define switch_line_buffers() (curndx = 1 - curndx)
3195
3196 #define curlb (lbs[curndx].lb)
3197 #define newlb (lbs[newndx].lb)
3198 #define curlinepos (lbs[curndx].linepos)
3199 #define newlinepos (lbs[newndx].linepos)
3200
3201 #define plainc ((c_ext & C_EXT) == C_PLAIN)
3202 #define cplpl (c_ext & C_PLPL)
3203 #define cjava ((c_ext & C_JAVA) == C_JAVA)
3204
3205 #define CNL_SAVE_DEFINEDEF() \
3206 do { \
3207 curlinepos = charno; \
3208 readline (&curlb, inf); \
3209 lp = curlb.buffer; \
3210 quotednl = FALSE; \
3211 newndx = curndx; \
3212 } while (0)
3213
3214 #define CNL() \
3215 do { \
3216 CNL_SAVE_DEFINEDEF(); \
3217 if (savetoken.valid) \
3218 { \
3219 token = savetoken; \
3220 savetoken.valid = FALSE; \
3221 } \
3222 definedef = dnone; \
3223 } while (0)
3224
3225
3226 static void
3227 make_C_tag (isfun)
3228 bool isfun;
3229 {
3230 /* This function is never called when token.valid is FALSE, but
3231 we must protect against invalid input or internal errors. */
3232 if (!DEBUG && !token.valid)
3233 return;
3234
3235 if (token.valid)
3236 make_tag (token_name.buffer, token_name.len, isfun, token.line,
3237 token.offset+token.length+1, token.lineno, token.linepos);
3238 else /* this case is optimised away if !DEBUG */
3239 make_tag (concat ("INVALID TOKEN:-->", token_name.buffer, ""),
3240 token_name.len + 17, isfun, token.line,
3241 token.offset+token.length+1, token.lineno, token.linepos);
3242
3243 token.valid = FALSE;
3244 }
3245
3246
3247 /*
3248 * C_entries ()
3249 * This routine finds functions, variables, typedefs,
3250 * #define's, enum constants and struct/union/enum definitions in
3251 * C syntax and adds them to the list.
3252 */
3253 static void
3254 C_entries (c_ext, inf)
3255 int c_ext; /* extension of C */
3256 FILE *inf; /* input file */
3257 {
3258 register char c; /* latest char read; '\0' for end of line */
3259 register char *lp; /* pointer one beyond the character `c' */
3260 int curndx, newndx; /* indices for current and new lb */
3261 register int tokoff; /* offset in line of start of current token */
3262 register int toklen; /* length of current token */
3263 char *qualifier; /* string used to qualify names */
3264 int qlen; /* length of qualifier */
3265 int bracelev; /* current brace level */
3266 int bracketlev; /* current bracket level */
3267 int parlev; /* current parenthesis level */
3268 int attrparlev; /* __attribute__ parenthesis level */
3269 int templatelev; /* current template level */
3270 int typdefbracelev; /* bracelev where a typedef struct body begun */
3271 bool incomm, inquote, inchar, quotednl, midtoken;
3272 bool yacc_rules; /* in the rules part of a yacc file */
3273 struct tok savetoken = {0}; /* token saved during preprocessor handling */
3274
3275
3276 linebuffer_init (&lbs[0].lb);
3277 linebuffer_init (&lbs[1].lb);
3278 if (cstack.size == 0)
3279 {
3280 cstack.size = (DEBUG) ? 1 : 4;
3281 cstack.nl = 0;
3282 cstack.cname = xnew (cstack.size, char *);
3283 cstack.bracelev = xnew (cstack.size, int);
3284 }
3285
3286 tokoff = toklen = typdefbracelev = 0; /* keep compiler quiet */
3287 curndx = newndx = 0;
3288 lp = curlb.buffer;
3289 *lp = 0;
3290
3291 fvdef = fvnone; fvextern = FALSE; typdef = tnone;
3292 structdef = snone; definedef = dnone; objdef = onone;
3293 yacc_rules = FALSE;
3294 midtoken = inquote = inchar = incomm = quotednl = FALSE;
3295 token.valid = savetoken.valid = FALSE;
3296 bracelev = bracketlev = parlev = attrparlev = templatelev = 0;
3297 if (cjava)
3298 { qualifier = "."; qlen = 1; }
3299 else
3300 { qualifier = "::"; qlen = 2; }
3301
3302
3303 while (!feof (inf))
3304 {
3305 c = *lp++;
3306 if (c == '\\')
3307 {
3308 /* If we are at the end of the line, the next character is a
3309 '\0'; do not skip it, because it is what tells us
3310 to read the next line. */
3311 if (*lp == '\0')
3312 {
3313 quotednl = TRUE;
3314 continue;
3315 }
3316 lp++;
3317 c = ' ';
3318 }
3319 else if (incomm)
3320 {
3321 switch (c)
3322 {
3323 case '*':
3324 if (*lp == '/')
3325 {
3326 c = *lp++;
3327 incomm = FALSE;
3328 }
3329 break;
3330 case '\0':
3331 /* Newlines inside comments do not end macro definitions in
3332 traditional cpp. */
3333 CNL_SAVE_DEFINEDEF ();
3334 break;
3335 }
3336 continue;
3337 }
3338 else if (inquote)
3339 {
3340 switch (c)
3341 {
3342 case '"':
3343 inquote = FALSE;
3344 break;
3345 case '\0':
3346 /* Newlines inside strings do not end macro definitions
3347 in traditional cpp, even though compilers don't
3348 usually accept them. */
3349 CNL_SAVE_DEFINEDEF ();
3350 break;
3351 }
3352 continue;
3353 }
3354 else if (inchar)
3355 {
3356 switch (c)
3357 {
3358 case '\0':
3359 /* Hmmm, something went wrong. */
3360 CNL ();
3361 /* FALLTHRU */
3362 case '\'':
3363 inchar = FALSE;
3364 break;
3365 }
3366 continue;
3367 }
3368 else if (bracketlev > 0)
3369 {
3370 switch (c)
3371 {
3372 case ']':
3373 if (--bracketlev > 0)
3374 continue;
3375 break;
3376 case '\0':
3377 CNL_SAVE_DEFINEDEF ();
3378 break;
3379 }
3380 continue;
3381 }
3382 else switch (c)
3383 {
3384 case '"':
3385 inquote = TRUE;
3386 if (inattribute)
3387 break;
3388 switch (fvdef)
3389 {
3390 case fdefunkey:
3391 case fstartlist:
3392 case finlist:
3393 case fignore:
3394 case vignore:
3395 break;
3396 default:
3397 fvextern = FALSE;
3398 fvdef = fvnone;
3399 }
3400 continue;
3401 case '\'':
3402 inchar = TRUE;
3403 if (inattribute)
3404 break;
3405 if (fvdef != finlist && fvdef != fignore && fvdef !=vignore)
3406 {
3407 fvextern = FALSE;
3408 fvdef = fvnone;
3409 }
3410 continue;
3411 case '/':
3412 if (*lp == '*')
3413 {
3414 incomm = TRUE;
3415 lp++;
3416 c = ' ';
3417 }
3418 else if (/* cplpl && */ *lp == '/')
3419 {
3420 c = '\0';
3421 }
3422 break;
3423 case '%':
3424 if ((c_ext & YACC) && *lp == '%')
3425 {
3426 /* Entering or exiting rules section in yacc file. */
3427 lp++;
3428 definedef = dnone; fvdef = fvnone; fvextern = FALSE;
3429 typdef = tnone; structdef = snone;
3430 midtoken = inquote = inchar = incomm = quotednl = FALSE;
3431 bracelev = 0;
3432 yacc_rules = !yacc_rules;
3433 continue;
3434 }
3435 else
3436 break;
3437 case '#':
3438 if (definedef == dnone)
3439 {
3440 char *cp;
3441 bool cpptoken = TRUE;
3442
3443 /* Look back on this line. If all blanks, or nonblanks
3444 followed by an end of comment, this is a preprocessor
3445 token. */
3446 for (cp = newlb.buffer; cp < lp-1; cp++)
3447 if (!iswhite (*cp))
3448 {
3449 if (*cp == '*' && *(cp+1) == '/')
3450 {
3451 cp++;
3452 cpptoken = TRUE;
3453 }
3454 else
3455 cpptoken = FALSE;
3456 }
3457 if (cpptoken)
3458 definedef = dsharpseen;
3459 } /* if (definedef == dnone) */
3460 continue;
3461 case '[':
3462 bracketlev++;
3463 continue;
3464 } /* switch (c) */
3465
3466
3467 /* Consider token only if some involved conditions are satisfied. */
3468 if (typdef != tignore
3469 && definedef != dignorerest
3470 && fvdef != finlist
3471 && templatelev == 0
3472 && (definedef != dnone
3473 || structdef != scolonseen)
3474 && !inattribute)
3475 {
3476 if (midtoken)
3477 {
3478 if (endtoken (c))
3479 {
3480 if (c == ':' && *lp == ':' && begtoken (lp[1]))
3481 /* This handles :: in the middle,
3482 but not at the beginning of an identifier.
3483 Also, space-separated :: is not recognised. */
3484 {
3485 if (c_ext & C_AUTO) /* automatic detection of C++ */
3486 c_ext = (c_ext | C_PLPL) & ~C_AUTO;
3487 lp += 2;
3488 toklen += 2;
3489 c = lp[-1];
3490 goto still_in_token;
3491 }
3492 else
3493 {
3494 bool funorvar = FALSE;
3495
3496 if (yacc_rules
3497 || consider_token (newlb.buffer + tokoff, toklen, c,
3498 &c_ext, bracelev, parlev,
3499 &funorvar))
3500 {
3501 if (fvdef == foperator)
3502 {
3503 char *oldlp = lp;
3504 lp = skip_spaces (lp-1);
3505 if (*lp != '\0')
3506 lp += 1;
3507 while (*lp != '\0'
3508 && !iswhite (*lp) && *lp != '(')
3509 lp += 1;
3510 c = *lp++;
3511 toklen += lp - oldlp;
3512 }
3513 token.named = FALSE;
3514 if (!plainc
3515 && nestlev > 0 && definedef == dnone)
3516 /* in struct body */
3517 {
3518 write_classname (&token_name, qualifier);
3519 linebuffer_setlen (&token_name,
3520 token_name.len+qlen+toklen);
3521 strcat (token_name.buffer, qualifier);
3522 strncat (token_name.buffer,
3523 newlb.buffer + tokoff, toklen);
3524 token.named = TRUE;
3525 }
3526 else if (objdef == ocatseen)
3527 /* Objective C category */
3528 {
3529 int len = strlen (objtag) + 2 + toklen;
3530 linebuffer_setlen (&token_name, len);
3531 strcpy (token_name.buffer, objtag);
3532 strcat (token_name.buffer, "(");
3533 strncat (token_name.buffer,
3534 newlb.buffer + tokoff, toklen);
3535 strcat (token_name.buffer, ")");
3536 token.named = TRUE;
3537 }
3538 else if (objdef == omethodtag
3539 || objdef == omethodparm)
3540 /* Objective C method */
3541 {
3542 token.named = TRUE;
3543 }
3544 else if (fvdef == fdefunname)
3545 /* GNU DEFUN and similar macros */
3546 {
3547 bool defun = (newlb.buffer[tokoff] == 'F');
3548 int off = tokoff;
3549 int len = toklen;
3550
3551 /* Rewrite the tag so that emacs lisp DEFUNs
3552 can be found by their elisp name */
3553 if (defun)
3554 {
3555 off += 1;
3556 len -= 1;
3557 }
3558 linebuffer_setlen (&token_name, len);
3559 strncpy (token_name.buffer,
3560 newlb.buffer + off, len);
3561 token_name.buffer[len] = '\0';
3562 if (defun)
3563 while (--len >= 0)
3564 if (token_name.buffer[len] == '_')
3565 token_name.buffer[len] = '-';
3566 token.named = defun;
3567 }
3568 else
3569 {
3570 linebuffer_setlen (&token_name, toklen);
3571 strncpy (token_name.buffer,
3572 newlb.buffer + tokoff, toklen);
3573 token_name.buffer[toklen] = '\0';
3574 /* Name macros and members. */
3575 token.named = (structdef == stagseen
3576 || typdef == ttypeseen
3577 || typdef == tend
3578 || (funorvar
3579 && definedef == dignorerest)
3580 || (funorvar
3581 && definedef == dnone
3582 && structdef == snone
3583 && bracelev > 0));
3584 }
3585 token.lineno = lineno;
3586 token.offset = tokoff;
3587 token.length = toklen;
3588 token.line = newlb.buffer;
3589 token.linepos = newlinepos;
3590 token.valid = TRUE;
3591
3592 if (definedef == dnone
3593 && (fvdef == fvnameseen
3594 || fvdef == foperator
3595 || structdef == stagseen
3596 || typdef == tend
3597 || typdef == ttypeseen
3598 || objdef != onone))
3599 {
3600 if (current_lb_is_new)
3601 switch_line_buffers ();
3602 }
3603 else if (definedef != dnone
3604 || fvdef == fdefunname
3605 || instruct)
3606 make_C_tag (funorvar);
3607 }
3608 else /* not yacc and consider_token failed */
3609 {
3610 if (inattribute && fvdef == fignore)
3611 {
3612 /* We have just met __attribute__ after a
3613 function parameter list: do not tag the
3614 function again. */
3615 fvdef = fvnone;
3616 }
3617 }
3618 midtoken = FALSE;
3619 }
3620 } /* if (endtoken (c)) */
3621 else if (intoken (c))
3622 still_in_token:
3623 {
3624 toklen++;
3625 continue;
3626 }
3627 } /* if (midtoken) */
3628 else if (begtoken (c))
3629 {
3630 switch (definedef)
3631 {
3632 case dnone:
3633 switch (fvdef)
3634 {
3635 case fstartlist:
3636 /* This prevents tagging fb in
3637 void (__attribute__((noreturn)) *fb) (void);
3638 Fixing this is not easy and not very important. */
3639 fvdef = finlist;
3640 continue;
3641 case flistseen:
3642 if (plainc || declarations)
3643 {
3644 make_C_tag (TRUE); /* a function */
3645 fvdef = fignore;
3646 }
3647 break;
3648 }
3649 if (structdef == stagseen && !cjava)
3650 {
3651 popclass_above (bracelev);
3652 structdef = snone;
3653 }
3654 break;
3655 case dsharpseen:
3656 savetoken = token;
3657 break;
3658 }
3659 if (!yacc_rules || lp == newlb.buffer + 1)
3660 {
3661 tokoff = lp - 1 - newlb.buffer;
3662 toklen = 1;
3663 midtoken = TRUE;
3664 }
3665 continue;
3666 } /* if (begtoken) */
3667 } /* if must look at token */
3668
3669
3670 /* Detect end of line, colon, comma, semicolon and various braces
3671 after having handled a token.*/
3672 switch (c)
3673 {
3674 case ':':
3675 if (inattribute)
3676 break;
3677 if (yacc_rules && token.offset == 0 && token.valid)
3678 {
3679 make_C_tag (FALSE); /* a yacc function */
3680 break;
3681 }
3682 if (definedef != dnone)
3683 break;
3684 switch (objdef)
3685 {
3686 case otagseen:
3687 objdef = oignore;
3688 make_C_tag (TRUE); /* an Objective C class */
3689 break;
3690 case omethodtag:
3691 case omethodparm:
3692 objdef = omethodcolon;
3693 linebuffer_setlen (&token_name, token_name.len + 1);
3694 strcat (token_name.buffer, ":");
3695 break;
3696 }
3697 if (structdef == stagseen)
3698 {
3699 structdef = scolonseen;
3700 break;
3701 }
3702 /* Should be useless, but may be work as a safety net. */
3703 if (cplpl && fvdef == flistseen)
3704 {
3705 make_C_tag (TRUE); /* a function */
3706 fvdef = fignore;
3707 break;
3708 }
3709 break;
3710 case ';':
3711 if (definedef != dnone || inattribute)
3712 break;
3713 switch (typdef)
3714 {
3715 case tend:
3716 case ttypeseen:
3717 make_C_tag (FALSE); /* a typedef */
3718 typdef = tnone;
3719 fvdef = fvnone;
3720 break;
3721 case tnone:
3722 case tinbody:
3723 case tignore:
3724 switch (fvdef)
3725 {
3726 case fignore:
3727 if (typdef == tignore || cplpl)
3728 fvdef = fvnone;
3729 break;
3730 case fvnameseen:
3731 if ((globals && bracelev == 0 && (!fvextern || declarations))
3732 || (members && instruct))
3733 make_C_tag (FALSE); /* a variable */
3734 fvextern = FALSE;
3735 fvdef = fvnone;
3736 token.valid = FALSE;
3737 break;
3738 case flistseen:
3739 if ((declarations
3740 && (cplpl || !instruct)
3741 && (typdef == tnone || (typdef != tignore && instruct)))
3742 || (members
3743 && plainc && instruct))
3744 make_C_tag (TRUE); /* a function */
3745 /* FALLTHRU */
3746 default:
3747 fvextern = FALSE;
3748 fvdef = fvnone;
3749 if (declarations
3750 && cplpl && structdef == stagseen)
3751 make_C_tag (FALSE); /* forward declaration */
3752 else
3753 token.valid = FALSE;
3754 } /* switch (fvdef) */
3755 /* FALLTHRU */
3756 default:
3757 if (!instruct)
3758 typdef = tnone;
3759 }
3760 if (structdef == stagseen)
3761 structdef = snone;
3762 break;
3763 case ',':
3764 if (definedef != dnone || inattribute)
3765 break;
3766 switch (objdef)
3767 {
3768 case omethodtag:
3769 case omethodparm:
3770 make_C_tag (TRUE); /* an Objective C method */
3771 objdef = oinbody;
3772 break;
3773 }
3774 switch (fvdef)
3775 {
3776 case fdefunkey:
3777 case foperator:
3778 case fstartlist:
3779 case finlist:
3780 case fignore:
3781 case vignore:
3782 break;
3783 case fdefunname:
3784 fvdef = fignore;
3785 break;
3786 case fvnameseen:
3787 if (parlev == 0
3788 && ((globals
3789 && bracelev == 0
3790 && templatelev == 0
3791 && (!fvextern || declarations))
3792 || (members && instruct)))
3793 make_C_tag (FALSE); /* a variable */
3794 break;
3795 case flistseen:
3796 if ((declarations && typdef == tnone && !instruct)
3797 || (members && typdef != tignore && instruct))
3798 {
3799 make_C_tag (TRUE); /* a function */
3800 fvdef = fvnameseen;
3801 }
3802 else if (!declarations)
3803 fvdef = fvnone;
3804 token.valid = FALSE;
3805 break;
3806 default:
3807 fvdef = fvnone;
3808 }
3809 if (structdef == stagseen)
3810 structdef = snone;
3811 break;
3812 case ']':
3813 if (definedef != dnone || inattribute)
3814 break;
3815 if (structdef == stagseen)
3816 structdef = snone;
3817 switch (typdef)
3818 {
3819 case ttypeseen:
3820 case tend:
3821 typdef = tignore;
3822 make_C_tag (FALSE); /* a typedef */
3823 break;
3824 case tnone:
3825 case tinbody:
3826 switch (fvdef)
3827 {
3828 case foperator:
3829 case finlist:
3830 case fignore:
3831 case vignore:
3832 break;
3833 case fvnameseen:
3834 if ((members && bracelev == 1)
3835 || (globals && bracelev == 0
3836 && (!fvextern || declarations)))
3837 make_C_tag (FALSE); /* a variable */
3838 /* FALLTHRU */
3839 default:
3840 fvdef = fvnone;
3841 }
3842 break;
3843 }
3844 break;
3845 case '(':
3846 if (inattribute)
3847 {
3848 attrparlev++;
3849 break;
3850 }
3851 if (definedef != dnone)
3852 break;
3853 if (objdef == otagseen && parlev == 0)
3854 objdef = oparenseen;
3855 switch (fvdef)
3856 {
3857 case fvnameseen:
3858 if (typdef == ttypeseen
3859 && *lp != '*'
3860 && !instruct)
3861 {
3862 /* This handles constructs like:
3863 typedef void OperatorFun (int fun); */
3864 make_C_tag (FALSE);
3865 typdef = tignore;
3866 fvdef = fignore;
3867 break;
3868 }
3869 /* FALLTHRU */
3870 case foperator:
3871 fvdef = fstartlist;
3872 break;
3873 case flistseen:
3874 fvdef = finlist;
3875 break;
3876 }
3877 parlev++;
3878 break;
3879 case ')':
3880 if (inattribute)
3881 {
3882 if (--attrparlev == 0)
3883 inattribute = FALSE;
3884 break;
3885 }
3886 if (definedef != dnone)
3887 break;
3888 if (objdef == ocatseen && parlev == 1)
3889 {
3890 make_C_tag (TRUE); /* an Objective C category */
3891 objdef = oignore;
3892 }
3893 if (--parlev == 0)
3894 {
3895 switch (fvdef)
3896 {
3897 case fstartlist:
3898 case finlist:
3899 fvdef = flistseen;
3900 break;
3901 }
3902 if (!instruct
3903 && (typdef == tend
3904 || typdef == ttypeseen))
3905 {
3906 typdef = tignore;
3907 make_C_tag (FALSE); /* a typedef */
3908 }
3909 }
3910 else if (parlev < 0) /* can happen due to ill-conceived #if's. */
3911 parlev = 0;
3912 break;
3913 case '{':
3914 if (definedef != dnone)
3915 break;
3916 if (typdef == ttypeseen)
3917 {
3918 /* Whenever typdef is set to tinbody (currently only
3919 here), typdefbracelev should be set to bracelev. */
3920 typdef = tinbody;
3921 typdefbracelev = bracelev;
3922 }
3923 switch (fvdef)
3924 {
3925 case flistseen:
3926 make_C_tag (TRUE); /* a function */
3927 /* FALLTHRU */
3928 case fignore:
3929 fvdef = fvnone;
3930 break;
3931 case fvnone:
3932 switch (objdef)
3933 {
3934 case otagseen:
3935 make_C_tag (TRUE); /* an Objective C class */
3936 objdef = oignore;
3937 break;
3938 case omethodtag:
3939 case omethodparm:
3940 make_C_tag (TRUE); /* an Objective C method */
3941 objdef = oinbody;
3942 break;
3943 default:
3944 /* Neutralize `extern "C" {' grot. */
3945 if (bracelev == 0 && structdef == snone && nestlev == 0
3946 && typdef == tnone)
3947 bracelev = -1;
3948 }
3949 break;
3950 }
3951 switch (structdef)
3952 {
3953 case skeyseen: /* unnamed struct */
3954 pushclass_above (bracelev, NULL, 0);
3955 structdef = snone;
3956 break;
3957 case stagseen: /* named struct or enum */
3958 case scolonseen: /* a class */
3959 pushclass_above (bracelev,token.line+token.offset, token.length);
3960 structdef = snone;
3961 make_C_tag (FALSE); /* a struct or enum */
3962 break;
3963 }
3964 bracelev++;
3965 break;
3966 case '*':
3967 if (definedef != dnone)
3968 break;
3969 if (fvdef == fstartlist)
3970 {
3971 fvdef = fvnone; /* avoid tagging `foo' in `foo (*bar()) ()' */
3972 token.valid = FALSE;
3973 }
3974 break;
3975 case '}':
3976 if (definedef != dnone)
3977 break;
3978 if (!ignoreindent && lp == newlb.buffer + 1)
3979 {
3980 if (bracelev != 0)
3981 token.valid = FALSE;
3982 bracelev = 0; /* reset brace level if first column */
3983 parlev = 0; /* also reset paren level, just in case... */
3984 }
3985 else if (bracelev > 0)
3986 bracelev--;
3987 else
3988 token.valid = FALSE; /* something gone amiss, token unreliable */
3989 popclass_above (bracelev);
3990 structdef = snone;
3991 /* Only if typdef == tinbody is typdefbracelev significant. */
3992 if (typdef == tinbody && bracelev <= typdefbracelev)
3993 {
3994 assert (bracelev == typdefbracelev);
3995 typdef = tend;
3996 }
3997 break;
3998 case '=':
3999 if (definedef != dnone)
4000 break;
4001 switch (fvdef)
4002 {
4003 case foperator:
4004 case finlist:
4005 case fignore:
4006 case vignore:
4007 break;
4008 case fvnameseen:
4009 if ((members && bracelev == 1)
4010 || (globals && bracelev == 0 && (!fvextern || declarations)))
4011 make_C_tag (FALSE); /* a variable */
4012 /* FALLTHRU */
4013 default:
4014 fvdef = vignore;
4015 }
4016 break;
4017 case '<':
4018 if (cplpl
4019 && (structdef == stagseen || fvdef == fvnameseen))
4020 {
4021 templatelev++;
4022 break;
4023 }
4024 goto resetfvdef;
4025 case '>':
4026 if (templatelev > 0)
4027 {
4028 templatelev--;
4029 break;
4030 }
4031 goto resetfvdef;
4032 case '+':
4033 case '-':
4034 if (objdef == oinbody && bracelev == 0)
4035 {
4036 objdef = omethodsign;
4037 break;
4038 }
4039 /* FALLTHRU */
4040 resetfvdef:
4041 case '#': case '~': case '&': case '%': case '/':
4042 case '|': case '^': case '!': case '.': case '?':
4043 if (definedef != dnone)
4044 break;
4045 /* These surely cannot follow a function tag in C. */
4046 switch (fvdef)
4047 {
4048 case foperator:
4049 case finlist:
4050 case fignore:
4051 case vignore:
4052 break;
4053 default:
4054 fvdef = fvnone;
4055 }
4056 break;
4057 case '\0':
4058 if (objdef == otagseen)
4059 {
4060 make_C_tag (TRUE); /* an Objective C class */
4061 objdef = oignore;
4062 }
4063 /* If a macro spans multiple lines don't reset its state. */
4064 if (quotednl)
4065 CNL_SAVE_DEFINEDEF ();
4066 else
4067 CNL ();
4068 break;
4069 } /* switch (c) */
4070
4071 } /* while not eof */
4072
4073 free (lbs[0].lb.buffer);
4074 free (lbs[1].lb.buffer);
4075 }
4076
4077 /*
4078 * Process either a C++ file or a C file depending on the setting
4079 * of a global flag.
4080 */
4081 static void
4082 default_C_entries (inf)
4083 FILE *inf;
4084 {
4085 C_entries (cplusplus ? C_PLPL : C_AUTO, inf);
4086 }
4087
4088 /* Always do plain C. */
4089 static void
4090 plain_C_entries (inf)
4091 FILE *inf;
4092 {
4093 C_entries (0, inf);
4094 }
4095
4096 /* Always do C++. */
4097 static void
4098 Cplusplus_entries (inf)
4099 FILE *inf;
4100 {
4101 C_entries (C_PLPL, inf);
4102 }
4103
4104 /* Always do Java. */
4105 static void
4106 Cjava_entries (inf)
4107 FILE *inf;
4108 {
4109 C_entries (C_JAVA, inf);
4110 }
4111
4112 /* Always do C*. */
4113 static void
4114 Cstar_entries (inf)
4115 FILE *inf;
4116 {
4117 C_entries (C_STAR, inf);
4118 }
4119
4120 /* Always do Yacc. */
4121 static void
4122 Yacc_entries (inf)
4123 FILE *inf;
4124 {
4125 C_entries (YACC, inf);
4126 }
4127
4128 \f
4129 /* Useful macros. */
4130 #define LOOP_ON_INPUT_LINES(file_pointer, line_buffer, char_pointer) \
4131 for (; /* loop initialization */ \
4132 !feof (file_pointer) /* loop test */ \
4133 && /* instructions at start of loop */ \
4134 (readline (&line_buffer, file_pointer), \
4135 char_pointer = line_buffer.buffer, \
4136 TRUE); \
4137 )
4138
4139 #define LOOKING_AT(cp, kw) /* kw is the keyword, a literal string */ \
4140 ((assert("" kw), TRUE) /* syntax error if not a literal string */ \
4141 && strneq ((cp), kw, sizeof(kw)-1) /* cp points at kw */ \
4142 && notinname ((cp)[sizeof(kw)-1]) /* end of kw */ \
4143 && ((cp) = skip_spaces((cp)+sizeof(kw)-1))) /* skip spaces */
4144
4145 /* Similar to LOOKING_AT but does not use notinname, does not skip */
4146 #define LOOKING_AT_NOCASE(cp, kw) /* the keyword is a literal string */ \
4147 ((assert("" kw), TRUE) /* syntax error if not a literal string */ \
4148 && strncaseeq ((cp), kw, sizeof(kw)-1) /* cp points at kw */ \
4149 && ((cp) += sizeof(kw)-1)) /* skip spaces */
4150
4151 /*
4152 * Read a file, but do no processing. This is used to do regexp
4153 * matching on files that have no language defined.
4154 */
4155 static void
4156 just_read_file (inf)
4157 FILE *inf;
4158 {
4159 register char *dummy;
4160
4161 LOOP_ON_INPUT_LINES (inf, lb, dummy)
4162 continue;
4163 }
4164
4165 \f
4166 /* Fortran parsing */
4167
4168 static void F_takeprec __P((void));
4169 static void F_getit __P((FILE *));
4170
4171 static void
4172 F_takeprec ()
4173 {
4174 dbp = skip_spaces (dbp);
4175 if (*dbp != '*')
4176 return;
4177 dbp++;
4178 dbp = skip_spaces (dbp);
4179 if (strneq (dbp, "(*)", 3))
4180 {
4181 dbp += 3;
4182 return;
4183 }
4184 if (!ISDIGIT (*dbp))
4185 {
4186 --dbp; /* force failure */
4187 return;
4188 }
4189 do
4190 dbp++;
4191 while (ISDIGIT (*dbp));
4192 }
4193
4194 static void
4195 F_getit (inf)
4196 FILE *inf;
4197 {
4198 register char *cp;
4199
4200 dbp = skip_spaces (dbp);
4201 if (*dbp == '\0')
4202 {
4203 readline (&lb, inf);
4204 dbp = lb.buffer;
4205 if (dbp[5] != '&')
4206 return;
4207 dbp += 6;
4208 dbp = skip_spaces (dbp);
4209 }
4210 if (!ISALPHA (*dbp) && *dbp != '_' && *dbp != '$')
4211 return;
4212 for (cp = dbp + 1; *cp != '\0' && intoken (*cp); cp++)
4213 continue;
4214 make_tag (dbp, cp-dbp, TRUE,
4215 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4216 }
4217
4218
4219 static void
4220 Fortran_functions (inf)
4221 FILE *inf;
4222 {
4223 LOOP_ON_INPUT_LINES (inf, lb, dbp)
4224 {
4225 if (*dbp == '%')
4226 dbp++; /* Ratfor escape to fortran */
4227 dbp = skip_spaces (dbp);
4228 if (*dbp == '\0')
4229 continue;
4230 switch (lowcase (*dbp))
4231 {
4232 case 'i':
4233 if (nocase_tail ("integer"))
4234 F_takeprec ();
4235 break;
4236 case 'r':
4237 if (nocase_tail ("real"))
4238 F_takeprec ();
4239 break;
4240 case 'l':
4241 if (nocase_tail ("logical"))
4242 F_takeprec ();
4243 break;
4244 case 'c':
4245 if (nocase_tail ("complex") || nocase_tail ("character"))
4246 F_takeprec ();
4247 break;
4248 case 'd':
4249 if (nocase_tail ("double"))
4250 {
4251 dbp = skip_spaces (dbp);
4252 if (*dbp == '\0')
4253 continue;
4254 if (nocase_tail ("precision"))
4255 break;
4256 continue;
4257 }
4258 break;
4259 }
4260 dbp = skip_spaces (dbp);
4261 if (*dbp == '\0')
4262 continue;
4263 switch (lowcase (*dbp))
4264 {
4265 case 'f':
4266 if (nocase_tail ("function"))
4267 F_getit (inf);
4268 continue;
4269 case 's':
4270 if (nocase_tail ("subroutine"))
4271 F_getit (inf);
4272 continue;
4273 case 'e':
4274 if (nocase_tail ("entry"))
4275 F_getit (inf);
4276 continue;
4277 case 'b':
4278 if (nocase_tail ("blockdata") || nocase_tail ("block data"))
4279 {
4280 dbp = skip_spaces (dbp);
4281 if (*dbp == '\0') /* assume un-named */
4282 make_tag ("blockdata", 9, TRUE,
4283 lb.buffer, dbp - lb.buffer, lineno, linecharno);
4284 else
4285 F_getit (inf); /* look for name */
4286 }
4287 continue;
4288 }
4289 }
4290 }
4291
4292 \f
4293 /*
4294 * Ada parsing
4295 * Original code by
4296 * Philippe Waroquiers (1998)
4297 */
4298
4299 static void Ada_getit __P((FILE *, char *));
4300
4301 /* Once we are positioned after an "interesting" keyword, let's get
4302 the real tag value necessary. */
4303 static void
4304 Ada_getit (inf, name_qualifier)
4305 FILE *inf;
4306 char *name_qualifier;
4307 {
4308 register char *cp;
4309 char *name;
4310 char c;
4311
4312 while (!feof (inf))
4313 {
4314 dbp = skip_spaces (dbp);
4315 if (*dbp == '\0'
4316 || (dbp[0] == '-' && dbp[1] == '-'))
4317 {
4318 readline (&lb, inf);
4319 dbp = lb.buffer;
4320 }
4321 switch (lowcase(*dbp))
4322 {
4323 case 'b':
4324 if (nocase_tail ("body"))
4325 {
4326 /* Skipping body of procedure body or package body or ....
4327 resetting qualifier to body instead of spec. */
4328 name_qualifier = "/b";
4329 continue;
4330 }
4331 break;
4332 case 't':
4333 /* Skipping type of task type or protected type ... */
4334 if (nocase_tail ("type"))
4335 continue;
4336 break;
4337 }
4338 if (*dbp == '"')
4339 {
4340 dbp += 1;
4341 for (cp = dbp; *cp != '\0' && *cp != '"'; cp++)
4342 continue;
4343 }
4344 else
4345 {
4346 dbp = skip_spaces (dbp);
4347 for (cp = dbp;
4348 (*cp != '\0'
4349 && (ISALPHA (*cp) || ISDIGIT (*cp) || *cp == '_' || *cp == '.'));
4350 cp++)
4351 continue;
4352 if (cp == dbp)
4353 return;
4354 }
4355 c = *cp;
4356 *cp = '\0';
4357 name = concat (dbp, name_qualifier, "");
4358 *cp = c;
4359 make_tag (name, strlen (name), TRUE,
4360 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4361 free (name);
4362 if (c == '"')
4363 dbp = cp + 1;
4364 return;
4365 }
4366 }
4367
4368 static void
4369 Ada_funcs (inf)
4370 FILE *inf;
4371 {
4372 bool inquote = FALSE;
4373 bool skip_till_semicolumn = FALSE;
4374
4375 LOOP_ON_INPUT_LINES (inf, lb, dbp)
4376 {
4377 while (*dbp != '\0')
4378 {
4379 /* Skip a string i.e. "abcd". */
4380 if (inquote || (*dbp == '"'))
4381 {
4382 dbp = etags_strchr ((inquote) ? dbp : dbp+1, '"');
4383 if (dbp != NULL)
4384 {
4385 inquote = FALSE;
4386 dbp += 1;
4387 continue; /* advance char */
4388 }
4389 else
4390 {
4391 inquote = TRUE;
4392 break; /* advance line */
4393 }
4394 }
4395
4396 /* Skip comments. */
4397 if (dbp[0] == '-' && dbp[1] == '-')
4398 break; /* advance line */
4399
4400 /* Skip character enclosed in single quote i.e. 'a'
4401 and skip single quote starting an attribute i.e. 'Image. */
4402 if (*dbp == '\'')
4403 {
4404 dbp++ ;
4405 if (*dbp != '\0')
4406 dbp++;
4407 continue;
4408 }
4409
4410 if (skip_till_semicolumn)
4411 {
4412 if (*dbp == ';')
4413 skip_till_semicolumn = FALSE;
4414 dbp++;
4415 continue; /* advance char */
4416 }
4417
4418 /* Search for beginning of a token. */
4419 if (!begtoken (*dbp))
4420 {
4421 dbp++;
4422 continue; /* advance char */
4423 }
4424
4425 /* We are at the beginning of a token. */
4426 switch (lowcase(*dbp))
4427 {
4428 case 'f':
4429 if (!packages_only && nocase_tail ("function"))
4430 Ada_getit (inf, "/f");
4431 else
4432 break; /* from switch */
4433 continue; /* advance char */
4434 case 'p':
4435 if (!packages_only && nocase_tail ("procedure"))
4436 Ada_getit (inf, "/p");
4437 else if (nocase_tail ("package"))
4438 Ada_getit (inf, "/s");
4439 else if (nocase_tail ("protected")) /* protected type */
4440 Ada_getit (inf, "/t");
4441 else
4442 break; /* from switch */
4443 continue; /* advance char */
4444
4445 case 'u':
4446 if (typedefs && !packages_only && nocase_tail ("use"))
4447 {
4448 /* when tagging types, avoid tagging use type Pack.Typename;
4449 for this, we will skip everything till a ; */
4450 skip_till_semicolumn = TRUE;
4451 continue; /* advance char */
4452 }
4453
4454 case 't':
4455 if (!packages_only && nocase_tail ("task"))
4456 Ada_getit (inf, "/k");
4457 else if (typedefs && !packages_only && nocase_tail ("type"))
4458 {
4459 Ada_getit (inf, "/t");
4460 while (*dbp != '\0')
4461 dbp += 1;
4462 }
4463 else
4464 break; /* from switch */
4465 continue; /* advance char */
4466 }
4467
4468 /* Look for the end of the token. */
4469 while (!endtoken (*dbp))
4470 dbp++;
4471
4472 } /* advance char */
4473 } /* advance line */
4474 }
4475
4476 \f
4477 /*
4478 * Unix and microcontroller assembly tag handling
4479 * Labels: /^[a-zA-Z_.$][a-zA_Z0-9_.$]*[: ^I^J]/
4480 * Idea by Bob Weiner, Motorola Inc. (1994)
4481 */
4482 static void
4483 Asm_labels (inf)
4484 FILE *inf;
4485 {
4486 register char *cp;
4487
4488 LOOP_ON_INPUT_LINES (inf, lb, cp)
4489 {
4490 /* If first char is alphabetic or one of [_.$], test for colon
4491 following identifier. */
4492 if (ISALPHA (*cp) || *cp == '_' || *cp == '.' || *cp == '$')
4493 {
4494 /* Read past label. */
4495 cp++;
4496 while (ISALNUM (*cp) || *cp == '_' || *cp == '.' || *cp == '$')
4497 cp++;
4498 if (*cp == ':' || iswhite (*cp))
4499 /* Found end of label, so copy it and add it to the table. */
4500 make_tag (lb.buffer, cp - lb.buffer, TRUE,
4501 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4502 }
4503 }
4504 }
4505
4506 \f
4507 /*
4508 * Perl support
4509 * Perl sub names: /^sub[ \t\n]+[^ \t\n{]+/
4510 * Perl variable names: /^(my|local).../
4511 * Original code by Bart Robinson <lomew@cs.utah.edu> (1995)
4512 * Additions by Michael Ernst <mernst@alum.mit.edu> (1997)
4513 * Ideas by Kai Großjohann <Kai.Grossjohann@CS.Uni-Dortmund.DE> (2001)
4514 */
4515 static void
4516 Perl_functions (inf)
4517 FILE *inf;
4518 {
4519 char *package = savestr ("main"); /* current package name */
4520 register char *cp;
4521
4522 LOOP_ON_INPUT_LINES (inf, lb, cp)
4523 {
4524 skip_spaces(cp);
4525
4526 if (LOOKING_AT (cp, "package"))
4527 {
4528 free (package);
4529 get_tag (cp, &package);
4530 }
4531 else if (LOOKING_AT (cp, "sub"))
4532 {
4533 char *pos;
4534 char *sp = cp;
4535
4536 while (!notinname (*cp))
4537 cp++;
4538 if (cp == sp)
4539 continue; /* nothing found */
4540 if ((pos = etags_strchr (sp, ':')) != NULL
4541 && pos < cp && pos[1] == ':')
4542 /* The name is already qualified. */
4543 make_tag (sp, cp - sp, TRUE,
4544 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4545 else
4546 /* Qualify it. */
4547 {
4548 char savechar, *name;
4549
4550 savechar = *cp;
4551 *cp = '\0';
4552 name = concat (package, "::", sp);
4553 *cp = savechar;
4554 make_tag (name, strlen(name), TRUE,
4555 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4556 free (name);
4557 }
4558 }
4559 else if (globals) /* only if we are tagging global vars */
4560 {
4561 /* Skip a qualifier, if any. */
4562 bool qual = LOOKING_AT (cp, "my") || LOOKING_AT (cp, "local");
4563 /* After "my" or "local", but before any following paren or space. */
4564 char *varstart = cp;
4565
4566 if (qual /* should this be removed? If yes, how? */
4567 && (*cp == '$' || *cp == '@' || *cp == '%'))
4568 {
4569 varstart += 1;
4570 do
4571 cp++;
4572 while (ISALNUM (*cp) || *cp == '_');
4573 }
4574 else if (qual)
4575 {
4576 /* Should be examining a variable list at this point;
4577 could insist on seeing an open parenthesis. */
4578 while (*cp != '\0' && *cp != ';' && *cp != '=' && *cp != ')')
4579 cp++;
4580 }
4581 else
4582 continue;
4583
4584 make_tag (varstart, cp - varstart, FALSE,
4585 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4586 }
4587 }
4588 free (package);
4589 }
4590
4591
4592 /*
4593 * Python support
4594 * Look for /^[\t]*def[ \t\n]+[^ \t\n(:]+/ or /^class[ \t\n]+[^ \t\n(:]+/
4595 * Idea by Eric S. Raymond <esr@thyrsus.com> (1997)
4596 * More ideas by seb bacon <seb@jamkit.com> (2002)
4597 */
4598 static void
4599 Python_functions (inf)
4600 FILE *inf;
4601 {
4602 register char *cp;
4603
4604 LOOP_ON_INPUT_LINES (inf, lb, cp)
4605 {
4606 cp = skip_spaces (cp);
4607 if (LOOKING_AT (cp, "def") || LOOKING_AT (cp, "class"))
4608 {
4609 char *name = cp;
4610 while (!notinname (*cp) && *cp != ':')
4611 cp++;
4612 make_tag (name, cp - name, TRUE,
4613 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4614 }
4615 }
4616 }
4617
4618 \f
4619 /*
4620 * PHP support
4621 * Look for:
4622 * - /^[ \t]*function[ \t\n]+[^ \t\n(]+/
4623 * - /^[ \t]*class[ \t\n]+[^ \t\n]+/
4624 * - /^[ \t]*define\(\"[^\"]+/
4625 * Only with --members:
4626 * - /^[ \t]*var[ \t\n]+\$[^ \t\n=;]/
4627 * Idea by Diez B. Roggisch (2001)
4628 */
4629 static void
4630 PHP_functions (inf)
4631 FILE *inf;
4632 {
4633 register char *cp, *name;
4634 bool search_identifier = FALSE;
4635
4636 LOOP_ON_INPUT_LINES (inf, lb, cp)
4637 {
4638 cp = skip_spaces (cp);
4639 name = cp;
4640 if (search_identifier
4641 && *cp != '\0')
4642 {
4643 while (!notinname (*cp))
4644 cp++;
4645 make_tag (name, cp - name, TRUE,
4646 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4647 search_identifier = FALSE;
4648 }
4649 else if (LOOKING_AT (cp, "function"))
4650 {
4651 if(*cp == '&')
4652 cp = skip_spaces (cp+1);
4653 if(*cp != '\0')
4654 {
4655 name = cp;
4656 while (!notinname (*cp))
4657 cp++;
4658 make_tag (name, cp - name, TRUE,
4659 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4660 }
4661 else
4662 search_identifier = TRUE;
4663 }
4664 else if (LOOKING_AT (cp, "class"))
4665 {
4666 if (*cp != '\0')
4667 {
4668 name = cp;
4669 while (*cp != '\0' && !iswhite (*cp))
4670 cp++;
4671 make_tag (name, cp - name, FALSE,
4672 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4673 }
4674 else
4675 search_identifier = TRUE;
4676 }
4677 else if (strneq (cp, "define", 6)
4678 && (cp = skip_spaces (cp+6))
4679 && *cp++ == '('
4680 && (*cp == '"' || *cp == '\''))
4681 {
4682 char quote = *cp++;
4683 name = cp;
4684 while (*cp != quote && *cp != '\0')
4685 cp++;
4686 make_tag (name, cp - name, FALSE,
4687 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4688 }
4689 else if (members
4690 && LOOKING_AT (cp, "var")
4691 && *cp == '$')
4692 {
4693 name = cp;
4694 while (!notinname(*cp))
4695 cp++;
4696 make_tag (name, cp - name, FALSE,
4697 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
4698 }
4699 }
4700 }
4701
4702 \f
4703 /*
4704 * Cobol tag functions
4705 * We could look for anything that could be a paragraph name.
4706 * i.e. anything that starts in column 8 is one word and ends in a full stop.
4707 * Idea by Corny de Souza (1993)
4708 */
4709 static void
4710 Cobol_paragraphs (inf)
4711 FILE *inf;
4712 {
4713 register char *bp, *ep;
4714
4715 LOOP_ON_INPUT_LINES (inf, lb, bp)
4716 {
4717 if (lb.len < 9)
4718 continue;
4719 bp += 8;
4720
4721 /* If eoln, compiler option or comment ignore whole line. */
4722 if (bp[-1] != ' ' || !ISALNUM (bp[0]))
4723 continue;
4724
4725 for (ep = bp; ISALNUM (*ep) || *ep == '-'; ep++)
4726 continue;
4727 if (*ep++ == '.')
4728 make_tag (bp, ep - bp, TRUE,
4729 lb.buffer, ep - lb.buffer + 1, lineno, linecharno);
4730 }
4731 }
4732
4733 \f
4734 /*
4735 * Makefile support
4736 * Ideas by Assar Westerlund <assar@sics.se> (2001)
4737 */
4738 static void
4739 Makefile_targets (inf)
4740 FILE *inf;
4741 {
4742 register char *bp;
4743
4744 LOOP_ON_INPUT_LINES (inf, lb, bp)
4745 {
4746 if (*bp == '\t' || *bp == '#')
4747 continue;
4748 while (*bp != '\0' && *bp != '=' && *bp != ':')
4749 bp++;
4750 if (*bp == ':' || (globals && *bp == '='))
4751 {
4752 /* We should detect if there is more than one tag, but we do not.
4753 We just skip initial and final spaces. */
4754 char * namestart = skip_spaces (lb.buffer);
4755 while (--bp > namestart)
4756 if (!notinname (*bp))
4757 break;
4758 make_tag (namestart, bp - namestart + 1, TRUE,
4759 lb.buffer, bp - lb.buffer + 2, lineno, linecharno);
4760 }
4761 }
4762 }
4763
4764 \f
4765 /*
4766 * Pascal parsing
4767 * Original code by Mosur K. Mohan (1989)
4768 *
4769 * Locates tags for procedures & functions. Doesn't do any type- or
4770 * var-definitions. It does look for the keyword "extern" or
4771 * "forward" immediately following the procedure statement; if found,
4772 * the tag is skipped.
4773 */
4774 static void
4775 Pascal_functions (inf)
4776 FILE *inf;
4777 {
4778 linebuffer tline; /* mostly copied from C_entries */
4779 long save_lcno;
4780 int save_lineno, namelen, taglen;
4781 char c, *name;
4782
4783 bool /* each of these flags is TRUE iff: */
4784 incomment, /* point is inside a comment */
4785 inquote, /* point is inside '..' string */
4786 get_tagname, /* point is after PROCEDURE/FUNCTION
4787 keyword, so next item = potential tag */
4788 found_tag, /* point is after a potential tag */
4789 inparms, /* point is within parameter-list */
4790 verify_tag; /* point has passed the parm-list, so the
4791 next token will determine whether this
4792 is a FORWARD/EXTERN to be ignored, or
4793 whether it is a real tag */
4794
4795 save_lcno = save_lineno = namelen = taglen = 0; /* keep compiler quiet */
4796 name = NULL; /* keep compiler quiet */
4797 dbp = lb.buffer;
4798 *dbp = '\0';
4799 linebuffer_init (&tline);
4800
4801 incomment = inquote = FALSE;
4802 found_tag = FALSE; /* have a proc name; check if extern */
4803 get_tagname = FALSE; /* found "procedure" keyword */
4804 inparms = FALSE; /* found '(' after "proc" */
4805 verify_tag = FALSE; /* check if "extern" is ahead */
4806
4807
4808 while (!feof (inf)) /* long main loop to get next char */
4809 {
4810 c = *dbp++;
4811 if (c == '\0') /* if end of line */
4812 {
4813 readline (&lb, inf);
4814 dbp = lb.buffer;
4815 if (*dbp == '\0')
4816 continue;
4817 if (!((found_tag && verify_tag)
4818 || get_tagname))
4819 c = *dbp++; /* only if don't need *dbp pointing
4820 to the beginning of the name of
4821 the procedure or function */
4822 }
4823 if (incomment)
4824 {
4825 if (c == '}') /* within { } comments */
4826 incomment = FALSE;
4827 else if (c == '*' && *dbp == ')') /* within (* *) comments */
4828 {
4829 dbp++;
4830 incomment = FALSE;
4831 }
4832 continue;
4833 }
4834 else if (inquote)
4835 {
4836 if (c == '\'')
4837 inquote = FALSE;
4838 continue;
4839 }
4840 else
4841 switch (c)
4842 {
4843 case '\'':
4844 inquote = TRUE; /* found first quote */
4845 continue;
4846 case '{': /* found open { comment */
4847 incomment = TRUE;
4848 continue;
4849 case '(':
4850 if (*dbp == '*') /* found open (* comment */
4851 {
4852 incomment = TRUE;
4853 dbp++;
4854 }
4855 else if (found_tag) /* found '(' after tag, i.e., parm-list */
4856 inparms = TRUE;
4857 continue;
4858 case ')': /* end of parms list */
4859 if (inparms)
4860 inparms = FALSE;
4861 continue;
4862 case ';':
4863 if (found_tag && !inparms) /* end of proc or fn stmt */
4864 {
4865 verify_tag = TRUE;
4866 break;
4867 }
4868 continue;
4869 }
4870 if (found_tag && verify_tag && (*dbp != ' '))
4871 {
4872 /* Check if this is an "extern" declaration. */
4873 if (*dbp == '\0')
4874 continue;
4875 if (lowcase (*dbp == 'e'))
4876 {
4877 if (nocase_tail ("extern")) /* superfluous, really! */
4878 {
4879 found_tag = FALSE;
4880 verify_tag = FALSE;
4881 }
4882 }
4883 else if (lowcase (*dbp) == 'f')
4884 {
4885 if (nocase_tail ("forward")) /* check for forward reference */
4886 {
4887 found_tag = FALSE;
4888 verify_tag = FALSE;
4889 }
4890 }
4891 if (found_tag && verify_tag) /* not external proc, so make tag */
4892 {
4893 found_tag = FALSE;
4894 verify_tag = FALSE;
4895 make_tag (name, namelen, TRUE,
4896 tline.buffer, taglen, save_lineno, save_lcno);
4897 continue;
4898 }
4899 }
4900 if (get_tagname) /* grab name of proc or fn */
4901 {
4902 char *cp;
4903
4904 if (*dbp == '\0')
4905 continue;
4906
4907 /* Find block name. */
4908 for (cp = dbp + 1; *cp != '\0' && !endtoken (*cp); cp++)
4909 continue;
4910
4911 /* Save all values for later tagging. */
4912 linebuffer_setlen (&tline, lb.len);
4913 strcpy (tline.buffer, lb.buffer);
4914 save_lineno = lineno;
4915 save_lcno = linecharno;
4916 name = tline.buffer + (dbp - lb.buffer);
4917 namelen = cp - dbp;
4918 taglen = cp - lb.buffer + 1;
4919
4920 dbp = cp; /* set dbp to e-o-token */
4921 get_tagname = FALSE;
4922 found_tag = TRUE;
4923 continue;
4924
4925 /* And proceed to check for "extern". */
4926 }
4927 else if (!incomment && !inquote && !found_tag)
4928 {
4929 /* Check for proc/fn keywords. */
4930 switch (lowcase (c))
4931 {
4932 case 'p':
4933 if (nocase_tail ("rocedure")) /* c = 'p', dbp has advanced */
4934 get_tagname = TRUE;
4935 continue;
4936 case 'f':
4937 if (nocase_tail ("unction"))
4938 get_tagname = TRUE;
4939 continue;
4940 }
4941 }
4942 } /* while not eof */
4943
4944 free (tline.buffer);
4945 }
4946
4947 \f
4948 /*
4949 * Lisp tag functions
4950 * look for (def or (DEF, quote or QUOTE
4951 */
4952
4953 static void L_getit __P((void));
4954
4955 static void
4956 L_getit ()
4957 {
4958 if (*dbp == '\'') /* Skip prefix quote */
4959 dbp++;
4960 else if (*dbp == '(')
4961 {
4962 dbp++;
4963 /* Try to skip "(quote " */
4964 if (!LOOKING_AT (dbp, "quote") && !LOOKING_AT (dbp, "QUOTE"))
4965 /* Ok, then skip "(" before name in (defstruct (foo)) */
4966 dbp = skip_spaces (dbp);
4967 }
4968 get_tag (dbp, NULL);
4969 }
4970
4971 static void
4972 Lisp_functions (inf)
4973 FILE *inf;
4974 {
4975 LOOP_ON_INPUT_LINES (inf, lb, dbp)
4976 {
4977 if (dbp[0] != '(')
4978 continue;
4979
4980 if (strneq (dbp+1, "def", 3) || strneq (dbp+1, "DEF", 3))
4981 {
4982 dbp = skip_non_spaces (dbp);
4983 dbp = skip_spaces (dbp);
4984 L_getit ();
4985 }
4986 else
4987 {
4988 /* Check for (foo::defmumble name-defined ... */
4989 do
4990 dbp++;
4991 while (!notinname (*dbp) && *dbp != ':');
4992 if (*dbp == ':')
4993 {
4994 do
4995 dbp++;
4996 while (*dbp == ':');
4997
4998 if (strneq (dbp, "def", 3) || strneq (dbp, "DEF", 3))
4999 {
5000 dbp = skip_non_spaces (dbp);
5001 dbp = skip_spaces (dbp);
5002 L_getit ();
5003 }
5004 }
5005 }
5006 }
5007 }
5008
5009 \f
5010 /*
5011 * Lua script language parsing
5012 * Original code by David A. Capello <dacap@users.sourceforge.net> (2004)
5013 *
5014 * "function" and "local function" are tags if they start at column 1.
5015 */
5016 static void
5017 Lua_functions (inf)
5018 FILE *inf;
5019 {
5020 register char *bp;
5021
5022 LOOP_ON_INPUT_LINES (inf, lb, bp)
5023 {
5024 if (bp[0] != 'f' && bp[0] != 'l')
5025 continue;
5026
5027 (void)LOOKING_AT (bp, "local"); /* skip possible "local" */
5028
5029 if (LOOKING_AT (bp, "function"))
5030 get_tag (bp, NULL);
5031 }
5032 }
5033
5034 \f
5035 /*
5036 * Postscript tags
5037 * Just look for lines where the first character is '/'
5038 * Also look at "defineps" for PSWrap
5039 * Ideas by:
5040 * Richard Mlynarik <mly@adoc.xerox.com> (1997)
5041 * Masatake Yamato <masata-y@is.aist-nara.ac.jp> (1999)
5042 */
5043 static void
5044 PS_functions (inf)
5045 FILE *inf;
5046 {
5047 register char *bp, *ep;
5048
5049 LOOP_ON_INPUT_LINES (inf, lb, bp)
5050 {
5051 if (bp[0] == '/')
5052 {
5053 for (ep = bp+1;
5054 *ep != '\0' && *ep != ' ' && *ep != '{';
5055 ep++)
5056 continue;
5057 make_tag (bp, ep - bp, TRUE,
5058 lb.buffer, ep - lb.buffer + 1, lineno, linecharno);
5059 }
5060 else if (LOOKING_AT (bp, "defineps"))
5061 get_tag (bp, NULL);
5062 }
5063 }
5064
5065 \f
5066 /*
5067 * Forth tags
5068 * Ignore anything after \ followed by space or in ( )
5069 * Look for words defined by :
5070 * Look for constant, code, create, defer, value, and variable
5071 * OBP extensions: Look for buffer:, field,
5072 * Ideas by Eduardo Horvath <eeh@netbsd.org> (2004)
5073 */
5074 static void
5075 Forth_words (inf)
5076 FILE *inf;
5077 {
5078 register char *bp;
5079
5080 LOOP_ON_INPUT_LINES (inf, lb, bp)
5081 while ((bp = skip_spaces (bp))[0] != '\0')
5082 if (bp[0] == '\\' && iswhite(bp[1]))
5083 break; /* read next line */
5084 else if (bp[0] == '(' && iswhite(bp[1]))
5085 do /* skip to ) or eol */
5086 bp++;
5087 while (*bp != ')' && *bp != '\0');
5088 else if ((bp[0] == ':' && iswhite(bp[1]) && bp++)
5089 || LOOKING_AT_NOCASE (bp, "constant")
5090 || LOOKING_AT_NOCASE (bp, "code")
5091 || LOOKING_AT_NOCASE (bp, "create")
5092 || LOOKING_AT_NOCASE (bp, "defer")
5093 || LOOKING_AT_NOCASE (bp, "value")
5094 || LOOKING_AT_NOCASE (bp, "variable")
5095 || LOOKING_AT_NOCASE (bp, "buffer:")
5096 || LOOKING_AT_NOCASE (bp, "field"))
5097 get_tag (skip_spaces (bp), NULL); /* Yay! A definition! */
5098 else
5099 bp = skip_non_spaces (bp);
5100 }
5101
5102 \f
5103 /*
5104 * Scheme tag functions
5105 * look for (def... xyzzy
5106 * (def... (xyzzy
5107 * (def ... ((...(xyzzy ....
5108 * (set! xyzzy
5109 * Original code by Ken Haase (1985?)
5110 */
5111 static void
5112 Scheme_functions (inf)
5113 FILE *inf;
5114 {
5115 register char *bp;
5116
5117 LOOP_ON_INPUT_LINES (inf, lb, bp)
5118 {
5119 if (strneq (bp, "(def", 4) || strneq (bp, "(DEF", 4))
5120 {
5121 bp = skip_non_spaces (bp+4);
5122 /* Skip over open parens and white space */
5123 while (notinname (*bp))
5124 bp++;
5125 get_tag (bp, NULL);
5126 }
5127 if (LOOKING_AT (bp, "(SET!") || LOOKING_AT (bp, "(set!"))
5128 get_tag (bp, NULL);
5129 }
5130 }
5131
5132 \f
5133 /* Find tags in TeX and LaTeX input files. */
5134
5135 /* TEX_toktab is a table of TeX control sequences that define tags.
5136 * Each entry records one such control sequence.
5137 *
5138 * Original code from who knows whom.
5139 * Ideas by:
5140 * Stefan Monnier (2002)
5141 */
5142
5143 static linebuffer *TEX_toktab = NULL; /* Table with tag tokens */
5144
5145 /* Default set of control sequences to put into TEX_toktab.
5146 The value of environment var TEXTAGS is prepended to this. */
5147 static char *TEX_defenv = "\
5148 :chapter:section:subsection:subsubsection:eqno:label:ref:cite:bibitem\
5149 :part:appendix:entry:index:def\
5150 :newcommand:renewcommand:newenvironment:renewenvironment";
5151
5152 static void TEX_mode __P((FILE *));
5153 static void TEX_decode_env __P((char *, char *));
5154
5155 static char TEX_esc = '\\';
5156 static char TEX_opgrp = '{';
5157 static char TEX_clgrp = '}';
5158
5159 /*
5160 * TeX/LaTeX scanning loop.
5161 */
5162 static void
5163 TeX_commands (inf)
5164 FILE *inf;
5165 {
5166 char *cp;
5167 linebuffer *key;
5168
5169 /* Select either \ or ! as escape character. */
5170 TEX_mode (inf);
5171
5172 /* Initialize token table once from environment. */
5173 if (TEX_toktab == NULL)
5174 TEX_decode_env ("TEXTAGS", TEX_defenv);
5175
5176 LOOP_ON_INPUT_LINES (inf, lb, cp)
5177 {
5178 /* Look at each TEX keyword in line. */
5179 for (;;)
5180 {
5181 /* Look for a TEX escape. */
5182 while (*cp++ != TEX_esc)
5183 if (cp[-1] == '\0' || cp[-1] == '%')
5184 goto tex_next_line;
5185
5186 for (key = TEX_toktab; key->buffer != NULL; key++)
5187 if (strneq (cp, key->buffer, key->len))
5188 {
5189 register char *p;
5190 int namelen, linelen;
5191 bool opgrp = FALSE;
5192
5193 cp = skip_spaces (cp + key->len);
5194 if (*cp == TEX_opgrp)
5195 {
5196 opgrp = TRUE;
5197 cp++;
5198 }
5199 for (p = cp;
5200 (!iswhite (*p) && *p != '#' &&
5201 *p != TEX_opgrp && *p != TEX_clgrp);
5202 p++)
5203 continue;
5204 namelen = p - cp;
5205 linelen = lb.len;
5206 if (!opgrp || *p == TEX_clgrp)
5207 {
5208 while (*p != '\0' && *p != TEX_opgrp && *p != TEX_clgrp)
5209 p++;
5210 linelen = p - lb.buffer + 1;
5211 }
5212 make_tag (cp, namelen, TRUE,
5213 lb.buffer, linelen, lineno, linecharno);
5214 goto tex_next_line; /* We only tag a line once */
5215 }
5216 }
5217 tex_next_line:
5218 ;
5219 }
5220 }
5221
5222 #define TEX_LESC '\\'
5223 #define TEX_SESC '!'
5224
5225 /* Figure out whether TeX's escapechar is '\\' or '!' and set grouping
5226 chars accordingly. */
5227 static void
5228 TEX_mode (inf)
5229 FILE *inf;
5230 {
5231 int c;
5232
5233 while ((c = getc (inf)) != EOF)
5234 {
5235 /* Skip to next line if we hit the TeX comment char. */
5236 if (c == '%')
5237 while (c != '\n' && c != EOF)
5238 c = getc (inf);
5239 else if (c == TEX_LESC || c == TEX_SESC )
5240 break;
5241 }
5242
5243 if (c == TEX_LESC)
5244 {
5245 TEX_esc = TEX_LESC;
5246 TEX_opgrp = '{';
5247 TEX_clgrp = '}';
5248 }
5249 else
5250 {
5251 TEX_esc = TEX_SESC;
5252 TEX_opgrp = '<';
5253 TEX_clgrp = '>';
5254 }
5255 /* If the input file is compressed, inf is a pipe, and rewind may fail.
5256 No attempt is made to correct the situation. */
5257 rewind (inf);
5258 }
5259
5260 /* Read environment and prepend it to the default string.
5261 Build token table. */
5262 static void
5263 TEX_decode_env (evarname, defenv)
5264 char *evarname;
5265 char *defenv;
5266 {
5267 register char *env, *p;
5268 int i, len;
5269
5270 /* Append default string to environment. */
5271 env = getenv (evarname);
5272 if (!env)
5273 env = defenv;
5274 else
5275 {
5276 char *oldenv = env;
5277 env = concat (oldenv, defenv, "");
5278 }
5279
5280 /* Allocate a token table */
5281 for (len = 1, p = env; p;)
5282 if ((p = etags_strchr (p, ':')) && *++p != '\0')
5283 len++;
5284 TEX_toktab = xnew (len, linebuffer);
5285
5286 /* Unpack environment string into token table. Be careful about */
5287 /* zero-length strings (leading ':', "::" and trailing ':') */
5288 for (i = 0; *env != '\0';)
5289 {
5290 p = etags_strchr (env, ':');
5291 if (!p) /* End of environment string. */
5292 p = env + strlen (env);
5293 if (p - env > 0)
5294 { /* Only non-zero strings. */
5295 TEX_toktab[i].buffer = savenstr (env, p - env);
5296 TEX_toktab[i].len = p - env;
5297 i++;
5298 }
5299 if (*p)
5300 env = p + 1;
5301 else
5302 {
5303 TEX_toktab[i].buffer = NULL; /* Mark end of table. */
5304 TEX_toktab[i].len = 0;
5305 break;
5306 }
5307 }
5308 }
5309
5310 \f
5311 /* Texinfo support. Dave Love, Mar. 2000. */
5312 static void
5313 Texinfo_nodes (inf)
5314 FILE * inf;
5315 {
5316 char *cp, *start;
5317 LOOP_ON_INPUT_LINES (inf, lb, cp)
5318 if (LOOKING_AT (cp, "@node"))
5319 {
5320 start = cp;
5321 while (*cp != '\0' && *cp != ',')
5322 cp++;
5323 make_tag (start, cp - start, TRUE,
5324 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
5325 }
5326 }
5327
5328 \f
5329 /*
5330 * HTML support.
5331 * Contents of <title>, <h1>, <h2>, <h3> are tags.
5332 * Contents of <a name=xxx> are tags with name xxx.
5333 *
5334 * Francesco Potortì, 2002.
5335 */
5336 static void
5337 HTML_labels (inf)
5338 FILE * inf;
5339 {
5340 bool getnext = FALSE; /* next text outside of HTML tags is a tag */
5341 bool skiptag = FALSE; /* skip to the end of the current HTML tag */
5342 bool intag = FALSE; /* inside an html tag, looking for ID= */
5343 bool inanchor = FALSE; /* when INTAG, is an anchor, look for NAME= */
5344 char *end;
5345
5346
5347 linebuffer_setlen (&token_name, 0); /* no name in buffer */
5348
5349 LOOP_ON_INPUT_LINES (inf, lb, dbp)
5350 for (;;) /* loop on the same line */
5351 {
5352 if (skiptag) /* skip HTML tag */
5353 {
5354 while (*dbp != '\0' && *dbp != '>')
5355 dbp++;
5356 if (*dbp == '>')
5357 {
5358 dbp += 1;
5359 skiptag = FALSE;
5360 continue; /* look on the same line */
5361 }
5362 break; /* go to next line */
5363 }
5364
5365 else if (intag) /* look for "name=" or "id=" */
5366 {
5367 while (*dbp != '\0' && *dbp != '>'
5368 && lowcase (*dbp) != 'n' && lowcase (*dbp) != 'i')
5369 dbp++;
5370 if (*dbp == '\0')
5371 break; /* go to next line */
5372 if (*dbp == '>')
5373 {
5374 dbp += 1;
5375 intag = FALSE;
5376 continue; /* look on the same line */
5377 }
5378 if ((inanchor && LOOKING_AT_NOCASE (dbp, "name="))
5379 || LOOKING_AT_NOCASE (dbp, "id="))
5380 {
5381 bool quoted = (dbp[0] == '"');
5382
5383 if (quoted)
5384 for (end = ++dbp; *end != '\0' && *end != '"'; end++)
5385 continue;
5386 else
5387 for (end = dbp; *end != '\0' && intoken (*end); end++)
5388 continue;
5389 linebuffer_setlen (&token_name, end - dbp);
5390 strncpy (token_name.buffer, dbp, end - dbp);
5391 token_name.buffer[end - dbp] = '\0';
5392
5393 dbp = end;
5394 intag = FALSE; /* we found what we looked for */
5395 skiptag = TRUE; /* skip to the end of the tag */
5396 getnext = TRUE; /* then grab the text */
5397 continue; /* look on the same line */
5398 }
5399 dbp += 1;
5400 }
5401
5402 else if (getnext) /* grab next tokens and tag them */
5403 {
5404 dbp = skip_spaces (dbp);
5405 if (*dbp == '\0')
5406 break; /* go to next line */
5407 if (*dbp == '<')
5408 {
5409 intag = TRUE;
5410 inanchor = (lowcase (dbp[1]) == 'a' && !intoken (dbp[2]));
5411 continue; /* look on the same line */
5412 }
5413
5414 for (end = dbp + 1; *end != '\0' && *end != '<'; end++)
5415 continue;
5416 make_tag (token_name.buffer, token_name.len, TRUE,
5417 dbp, end - dbp, lineno, linecharno);
5418 linebuffer_setlen (&token_name, 0); /* no name in buffer */
5419 getnext = FALSE;
5420 break; /* go to next line */
5421 }
5422
5423 else /* look for an interesting HTML tag */
5424 {
5425 while (*dbp != '\0' && *dbp != '<')
5426 dbp++;
5427 if (*dbp == '\0')
5428 break; /* go to next line */
5429 intag = TRUE;
5430 if (lowcase (dbp[1]) == 'a' && !intoken (dbp[2]))
5431 {
5432 inanchor = TRUE;
5433 continue; /* look on the same line */
5434 }
5435 else if (LOOKING_AT_NOCASE (dbp, "<title>")
5436 || LOOKING_AT_NOCASE (dbp, "<h1>")
5437 || LOOKING_AT_NOCASE (dbp, "<h2>")
5438 || LOOKING_AT_NOCASE (dbp, "<h3>"))
5439 {
5440 intag = FALSE;
5441 getnext = TRUE;
5442 continue; /* look on the same line */
5443 }
5444 dbp += 1;
5445 }
5446 }
5447 }
5448
5449 \f
5450 /*
5451 * Prolog support
5452 *
5453 * Assumes that the predicate or rule starts at column 0.
5454 * Only the first clause of a predicate or rule is added.
5455 * Original code by Sunichirou Sugou (1989)
5456 * Rewritten by Anders Lindgren (1996)
5457 */
5458 static int prolog_pr __P((char *, char *));
5459 static void prolog_skip_comment __P((linebuffer *, FILE *));
5460 static int prolog_atom __P((char *, int));
5461
5462 static void
5463 Prolog_functions (inf)
5464 FILE *inf;
5465 {
5466 char *cp, *last;
5467 int len;
5468 int allocated;
5469
5470 allocated = 0;
5471 len = 0;
5472 last = NULL;
5473
5474 LOOP_ON_INPUT_LINES (inf, lb, cp)
5475 {
5476 if (cp[0] == '\0') /* Empty line */
5477 continue;
5478 else if (iswhite (cp[0])) /* Not a predicate */
5479 continue;
5480 else if (cp[0] == '/' && cp[1] == '*') /* comment. */
5481 prolog_skip_comment (&lb, inf);
5482 else if ((len = prolog_pr (cp, last)) > 0)
5483 {
5484 /* Predicate or rule. Store the function name so that we
5485 only generate a tag for the first clause. */
5486 if (last == NULL)
5487 last = xnew(len + 1, char);
5488 else if (len + 1 > allocated)
5489 xrnew (last, len + 1, char);
5490 allocated = len + 1;
5491 strncpy (last, cp, len);
5492 last[len] = '\0';
5493 }
5494 }
5495 if (last != NULL)
5496 free (last);
5497 }
5498
5499
5500 static void
5501 prolog_skip_comment (plb, inf)
5502 linebuffer *plb;
5503 FILE *inf;
5504 {
5505 char *cp;
5506
5507 do
5508 {
5509 for (cp = plb->buffer; *cp != '\0'; cp++)
5510 if (cp[0] == '*' && cp[1] == '/')
5511 return;
5512 readline (plb, inf);
5513 }
5514 while (!feof(inf));
5515 }
5516
5517 /*
5518 * A predicate or rule definition is added if it matches:
5519 * <beginning of line><Prolog Atom><whitespace>(
5520 * or <beginning of line><Prolog Atom><whitespace>:-
5521 *
5522 * It is added to the tags database if it doesn't match the
5523 * name of the previous clause header.
5524 *
5525 * Return the size of the name of the predicate or rule, or 0 if no
5526 * header was found.
5527 */
5528 static int
5529 prolog_pr (s, last)
5530 char *s;
5531 char *last; /* Name of last clause. */
5532 {
5533 int pos;
5534 int len;
5535
5536 pos = prolog_atom (s, 0);
5537 if (pos < 1)
5538 return 0;
5539
5540 len = pos;
5541 pos = skip_spaces (s + pos) - s;
5542
5543 if ((s[pos] == '.'
5544 || (s[pos] == '(' && (pos += 1))
5545 || (s[pos] == ':' && s[pos + 1] == '-' && (pos += 2)))
5546 && (last == NULL /* save only the first clause */
5547 || len != (int)strlen (last)
5548 || !strneq (s, last, len)))
5549 {
5550 make_tag (s, len, TRUE, s, pos, lineno, linecharno);
5551 return len;
5552 }
5553 else
5554 return 0;
5555 }
5556
5557 /*
5558 * Consume a Prolog atom.
5559 * Return the number of bytes consumed, or -1 if there was an error.
5560 *
5561 * A prolog atom, in this context, could be one of:
5562 * - An alphanumeric sequence, starting with a lower case letter.
5563 * - A quoted arbitrary string. Single quotes can escape themselves.
5564 * Backslash quotes everything.
5565 */
5566 static int
5567 prolog_atom (s, pos)
5568 char *s;
5569 int pos;
5570 {
5571 int origpos;
5572
5573 origpos = pos;
5574
5575 if (ISLOWER(s[pos]) || (s[pos] == '_'))
5576 {
5577 /* The atom is unquoted. */
5578 pos++;
5579 while (ISALNUM(s[pos]) || (s[pos] == '_'))
5580 {
5581 pos++;
5582 }
5583 return pos - origpos;
5584 }
5585 else if (s[pos] == '\'')
5586 {
5587 pos++;
5588
5589 for (;;)
5590 {
5591 if (s[pos] == '\'')
5592 {
5593 pos++;
5594 if (s[pos] != '\'')
5595 break;
5596 pos++; /* A double quote */
5597 }
5598 else if (s[pos] == '\0')
5599 /* Multiline quoted atoms are ignored. */
5600 return -1;
5601 else if (s[pos] == '\\')
5602 {
5603 if (s[pos+1] == '\0')
5604 return -1;
5605 pos += 2;
5606 }
5607 else
5608 pos++;
5609 }
5610 return pos - origpos;
5611 }
5612 else
5613 return -1;
5614 }
5615
5616 \f
5617 /*
5618 * Support for Erlang
5619 *
5620 * Generates tags for functions, defines, and records.
5621 * Assumes that Erlang functions start at column 0.
5622 * Original code by Anders Lindgren (1996)
5623 */
5624 static int erlang_func __P((char *, char *));
5625 static void erlang_attribute __P((char *));
5626 static int erlang_atom __P((char *));
5627
5628 static void
5629 Erlang_functions (inf)
5630 FILE *inf;
5631 {
5632 char *cp, *last;
5633 int len;
5634 int allocated;
5635
5636 allocated = 0;
5637 len = 0;
5638 last = NULL;
5639
5640 LOOP_ON_INPUT_LINES (inf, lb, cp)
5641 {
5642 if (cp[0] == '\0') /* Empty line */
5643 continue;
5644 else if (iswhite (cp[0])) /* Not function nor attribute */
5645 continue;
5646 else if (cp[0] == '%') /* comment */
5647 continue;
5648 else if (cp[0] == '"') /* Sometimes, strings start in column one */
5649 continue;
5650 else if (cp[0] == '-') /* attribute, e.g. "-define" */
5651 {
5652 erlang_attribute (cp);
5653 if (last != NULL)
5654 {
5655 free (last);
5656 last = NULL;
5657 }
5658 }
5659 else if ((len = erlang_func (cp, last)) > 0)
5660 {
5661 /*
5662 * Function. Store the function name so that we only
5663 * generates a tag for the first clause.
5664 */
5665 if (last == NULL)
5666 last = xnew (len + 1, char);
5667 else if (len + 1 > allocated)
5668 xrnew (last, len + 1, char);
5669 allocated = len + 1;
5670 strncpy (last, cp, len);
5671 last[len] = '\0';
5672 }
5673 }
5674 if (last != NULL)
5675 free (last);
5676 }
5677
5678
5679 /*
5680 * A function definition is added if it matches:
5681 * <beginning of line><Erlang Atom><whitespace>(
5682 *
5683 * It is added to the tags database if it doesn't match the
5684 * name of the previous clause header.
5685 *
5686 * Return the size of the name of the function, or 0 if no function
5687 * was found.
5688 */
5689 static int
5690 erlang_func (s, last)
5691 char *s;
5692 char *last; /* Name of last clause. */
5693 {
5694 int pos;
5695 int len;
5696
5697 pos = erlang_atom (s);
5698 if (pos < 1)
5699 return 0;
5700
5701 len = pos;
5702 pos = skip_spaces (s + pos) - s;
5703
5704 /* Save only the first clause. */
5705 if (s[pos++] == '('
5706 && (last == NULL
5707 || len != (int)strlen (last)
5708 || !strneq (s, last, len)))
5709 {
5710 make_tag (s, len, TRUE, s, pos, lineno, linecharno);
5711 return len;
5712 }
5713
5714 return 0;
5715 }
5716
5717
5718 /*
5719 * Handle attributes. Currently, tags are generated for defines
5720 * and records.
5721 *
5722 * They are on the form:
5723 * -define(foo, bar).
5724 * -define(Foo(M, N), M+N).
5725 * -record(graph, {vtab = notable, cyclic = true}).
5726 */
5727 static void
5728 erlang_attribute (s)
5729 char *s;
5730 {
5731 char *cp = s;
5732
5733 if ((LOOKING_AT (cp, "-define") || LOOKING_AT (cp, "-record"))
5734 && *cp++ == '(')
5735 {
5736 int len = erlang_atom (skip_spaces (cp));
5737 if (len > 0)
5738 make_tag (cp, len, TRUE, s, cp + len - s, lineno, linecharno);
5739 }
5740 return;
5741 }
5742
5743
5744 /*
5745 * Consume an Erlang atom (or variable).
5746 * Return the number of bytes consumed, or -1 if there was an error.
5747 */
5748 static int
5749 erlang_atom (s)
5750 char *s;
5751 {
5752 int pos = 0;
5753
5754 if (ISALPHA (s[pos]) || s[pos] == '_')
5755 {
5756 /* The atom is unquoted. */
5757 do
5758 pos++;
5759 while (ISALNUM (s[pos]) || s[pos] == '_');
5760 }
5761 else if (s[pos] == '\'')
5762 {
5763 for (pos++; s[pos] != '\''; pos++)
5764 if (s[pos] == '\0' /* multiline quoted atoms are ignored */
5765 || (s[pos] == '\\' && s[++pos] == '\0'))
5766 return 0;
5767 pos++;
5768 }
5769
5770 return pos;
5771 }
5772
5773 \f
5774 static char *scan_separators __P((char *));
5775 static void add_regex __P((char *, language *));
5776 static char *substitute __P((char *, char *, struct re_registers *));
5777
5778 /*
5779 * Take a string like "/blah/" and turn it into "blah", verifying
5780 * that the first and last characters are the same, and handling
5781 * quoted separator characters. Actually, stops on the occurrence of
5782 * an unquoted separator. Also process \t, \n, etc. and turn into
5783 * appropriate characters. Works in place. Null terminates name string.
5784 * Returns pointer to terminating separator, or NULL for
5785 * unterminated regexps.
5786 */
5787 static char *
5788 scan_separators (name)
5789 char *name;
5790 {
5791 char sep = name[0];
5792 char *copyto = name;
5793 bool quoted = FALSE;
5794
5795 for (++name; *name != '\0'; ++name)
5796 {
5797 if (quoted)
5798 {
5799 switch (*name)
5800 {
5801 case 'a': *copyto++ = '\007'; break; /* BEL (bell) */
5802 case 'b': *copyto++ = '\b'; break; /* BS (back space) */
5803 case 'd': *copyto++ = 0177; break; /* DEL (delete) */
5804 case 'e': *copyto++ = 033; break; /* ESC (delete) */
5805 case 'f': *copyto++ = '\f'; break; /* FF (form feed) */
5806 case 'n': *copyto++ = '\n'; break; /* NL (new line) */
5807 case 'r': *copyto++ = '\r'; break; /* CR (carriage return) */
5808 case 't': *copyto++ = '\t'; break; /* TAB (horizontal tab) */
5809 case 'v': *copyto++ = '\v'; break; /* VT (vertical tab) */
5810 default:
5811 if (*name == sep)
5812 *copyto++ = sep;
5813 else
5814 {
5815 /* Something else is quoted, so preserve the quote. */
5816 *copyto++ = '\\';
5817 *copyto++ = *name;
5818 }
5819 break;
5820 }
5821 quoted = FALSE;
5822 }
5823 else if (*name == '\\')
5824 quoted = TRUE;
5825 else if (*name == sep)
5826 break;
5827 else
5828 *copyto++ = *name;
5829 }
5830 if (*name != sep)
5831 name = NULL; /* signal unterminated regexp */
5832
5833 /* Terminate copied string. */
5834 *copyto = '\0';
5835 return name;
5836 }
5837
5838 /* Look at the argument of --regex or --no-regex and do the right
5839 thing. Same for each line of a regexp file. */
5840 static void
5841 analyse_regex (regex_arg)
5842 char *regex_arg;
5843 {
5844 if (regex_arg == NULL)
5845 {
5846 free_regexps (); /* --no-regex: remove existing regexps */
5847 return;
5848 }
5849
5850 /* A real --regexp option or a line in a regexp file. */
5851 switch (regex_arg[0])
5852 {
5853 /* Comments in regexp file or null arg to --regex. */
5854 case '\0':
5855 case ' ':
5856 case '\t':
5857 break;
5858
5859 /* Read a regex file. This is recursive and may result in a
5860 loop, which will stop when the file descriptors are exhausted. */
5861 case '@':
5862 {
5863 FILE *regexfp;
5864 linebuffer regexbuf;
5865 char *regexfile = regex_arg + 1;
5866
5867 /* regexfile is a file containing regexps, one per line. */
5868 regexfp = fopen (regexfile, "r");
5869 if (regexfp == NULL)
5870 {
5871 pfatal (regexfile);
5872 return;
5873 }
5874 linebuffer_init (&regexbuf);
5875 while (readline_internal (&regexbuf, regexfp) > 0)
5876 analyse_regex (regexbuf.buffer);
5877 free (regexbuf.buffer);
5878 fclose (regexfp);
5879 }
5880 break;
5881
5882 /* Regexp to be used for a specific language only. */
5883 case '{':
5884 {
5885 language *lang;
5886 char *lang_name = regex_arg + 1;
5887 char *cp;
5888
5889 for (cp = lang_name; *cp != '}'; cp++)
5890 if (*cp == '\0')
5891 {
5892 error ("unterminated language name in regex: %s", regex_arg);
5893 return;
5894 }
5895 *cp++ = '\0';
5896 lang = get_language_from_langname (lang_name);
5897 if (lang == NULL)
5898 return;
5899 add_regex (cp, lang);
5900 }
5901 break;
5902
5903 /* Regexp to be used for any language. */
5904 default:
5905 add_regex (regex_arg, NULL);
5906 break;
5907 }
5908 }
5909
5910 /* Separate the regexp pattern, compile it,
5911 and care for optional name and modifiers. */
5912 static void
5913 add_regex (regexp_pattern, lang)
5914 char *regexp_pattern;
5915 language *lang;
5916 {
5917 static struct re_pattern_buffer zeropattern;
5918 char sep, *pat, *name, *modifiers;
5919 const char *err;
5920 struct re_pattern_buffer *patbuf;
5921 regexp *rp;
5922 bool
5923 force_explicit_name = TRUE, /* do not use implicit tag names */
5924 ignore_case = FALSE, /* case is significant */
5925 multi_line = FALSE, /* matches are done one line at a time */
5926 single_line = FALSE; /* dot does not match newline */
5927
5928
5929 if (strlen(regexp_pattern) < 3)
5930 {
5931 error ("null regexp", (char *)NULL);
5932 return;
5933 }
5934 sep = regexp_pattern[0];
5935 name = scan_separators (regexp_pattern);
5936 if (name == NULL)
5937 {
5938 error ("%s: unterminated regexp", regexp_pattern);
5939 return;
5940 }
5941 if (name[1] == sep)
5942 {
5943 error ("null name for regexp \"%s\"", regexp_pattern);
5944 return;
5945 }
5946 modifiers = scan_separators (name);
5947 if (modifiers == NULL) /* no terminating separator --> no name */
5948 {
5949 modifiers = name;
5950 name = "";
5951 }
5952 else
5953 modifiers += 1; /* skip separator */
5954
5955 /* Parse regex modifiers. */
5956 for (; modifiers[0] != '\0'; modifiers++)
5957 switch (modifiers[0])
5958 {
5959 case 'N':
5960 if (modifiers == name)
5961 error ("forcing explicit tag name but no name, ignoring", NULL);
5962 force_explicit_name = TRUE;
5963 break;
5964 case 'i':
5965 ignore_case = TRUE;
5966 break;
5967 case 's':
5968 single_line = TRUE;
5969 /* FALLTHRU */
5970 case 'm':
5971 multi_line = TRUE;
5972 need_filebuf = TRUE;
5973 break;
5974 default:
5975 {
5976 char wrongmod [2];
5977 wrongmod[0] = modifiers[0];
5978 wrongmod[1] = '\0';
5979 error ("invalid regexp modifier `%s', ignoring", wrongmod);
5980 }
5981 break;
5982 }
5983
5984 patbuf = xnew (1, struct re_pattern_buffer);
5985 *patbuf = zeropattern;
5986 if (ignore_case)
5987 {
5988 static char lc_trans[CHARS];
5989 int i;
5990 for (i = 0; i < CHARS; i++)
5991 lc_trans[i] = lowcase (i);
5992 patbuf->translate = lc_trans; /* translation table to fold case */
5993 }
5994
5995 if (multi_line)
5996 pat = concat ("^", regexp_pattern, ""); /* anchor to beginning of line */
5997 else
5998 pat = regexp_pattern;
5999
6000 if (single_line)
6001 re_set_syntax (RE_SYNTAX_EMACS | RE_DOT_NEWLINE);
6002 else
6003 re_set_syntax (RE_SYNTAX_EMACS);
6004
6005 err = re_compile_pattern (pat, strlen (regexp_pattern), patbuf);
6006 if (multi_line)
6007 free (pat);
6008 if (err != NULL)
6009 {
6010 error ("%s while compiling pattern", err);
6011 return;
6012 }
6013
6014 rp = p_head;
6015 p_head = xnew (1, regexp);
6016 p_head->pattern = savestr (regexp_pattern);
6017 p_head->p_next = rp;
6018 p_head->lang = lang;
6019 p_head->pat = patbuf;
6020 p_head->name = savestr (name);
6021 p_head->error_signaled = FALSE;
6022 p_head->force_explicit_name = force_explicit_name;
6023 p_head->ignore_case = ignore_case;
6024 p_head->multi_line = multi_line;
6025 }
6026
6027 /*
6028 * Do the substitutions indicated by the regular expression and
6029 * arguments.
6030 */
6031 static char *
6032 substitute (in, out, regs)
6033 char *in, *out;
6034 struct re_registers *regs;
6035 {
6036 char *result, *t;
6037 int size, dig, diglen;
6038
6039 result = NULL;
6040 size = strlen (out);
6041
6042 /* Pass 1: figure out how much to allocate by finding all \N strings. */
6043 if (out[size - 1] == '\\')
6044 fatal ("pattern error in \"%s\"", out);
6045 for (t = etags_strchr (out, '\\');
6046 t != NULL;
6047 t = etags_strchr (t + 2, '\\'))
6048 if (ISDIGIT (t[1]))
6049 {
6050 dig = t[1] - '0';
6051 diglen = regs->end[dig] - regs->start[dig];
6052 size += diglen - 2;
6053 }
6054 else
6055 size -= 1;
6056
6057 /* Allocate space and do the substitutions. */
6058 assert (size >= 0);
6059 result = xnew (size + 1, char);
6060
6061 for (t = result; *out != '\0'; out++)
6062 if (*out == '\\' && ISDIGIT (*++out))
6063 {
6064 dig = *out - '0';
6065 diglen = regs->end[dig] - regs->start[dig];
6066 strncpy (t, in + regs->start[dig], diglen);
6067 t += diglen;
6068 }
6069 else
6070 *t++ = *out;
6071 *t = '\0';
6072
6073 assert (t <= result + size);
6074 assert (t - result == (int)strlen (result));
6075
6076 return result;
6077 }
6078
6079 /* Deallocate all regexps. */
6080 static void
6081 free_regexps ()
6082 {
6083 regexp *rp;
6084 while (p_head != NULL)
6085 {
6086 rp = p_head->p_next;
6087 free (p_head->pattern);
6088 free (p_head->name);
6089 free (p_head);
6090 p_head = rp;
6091 }
6092 return;
6093 }
6094
6095 /*
6096 * Reads the whole file as a single string from `filebuf' and looks for
6097 * multi-line regular expressions, creating tags on matches.
6098 * readline already dealt with normal regexps.
6099 *
6100 * Idea by Ben Wing <ben@666.com> (2002).
6101 */
6102 static void
6103 regex_tag_multiline ()
6104 {
6105 char *buffer = filebuf.buffer;
6106 regexp *rp;
6107 char *name;
6108
6109 for (rp = p_head; rp != NULL; rp = rp->p_next)
6110 {
6111 int match = 0;
6112
6113 if (!rp->multi_line)
6114 continue; /* skip normal regexps */
6115
6116 /* Generic initialisations before parsing file from memory. */
6117 lineno = 1; /* reset global line number */
6118 charno = 0; /* reset global char number */
6119 linecharno = 0; /* reset global char number of line start */
6120
6121 /* Only use generic regexps or those for the current language. */
6122 if (rp->lang != NULL && rp->lang != curfdp->lang)
6123 continue;
6124
6125 while (match >= 0 && match < filebuf.len)
6126 {
6127 match = re_search (rp->pat, buffer, filebuf.len, charno,
6128 filebuf.len - match, &rp->regs);
6129 switch (match)
6130 {
6131 case -2:
6132 /* Some error. */
6133 if (!rp->error_signaled)
6134 {
6135 error ("regexp stack overflow while matching \"%s\"",
6136 rp->pattern);
6137 rp->error_signaled = TRUE;
6138 }
6139 break;
6140 case -1:
6141 /* No match. */
6142 break;
6143 default:
6144 if (match == rp->regs.end[0])
6145 {
6146 if (!rp->error_signaled)
6147 {
6148 error ("regexp matches the empty string: \"%s\"",
6149 rp->pattern);
6150 rp->error_signaled = TRUE;
6151 }
6152 match = -3; /* exit from while loop */
6153 break;
6154 }
6155
6156 /* Match occurred. Construct a tag. */
6157 while (charno < rp->regs.end[0])
6158 if (buffer[charno++] == '\n')
6159 lineno++, linecharno = charno;
6160 name = rp->name;
6161 if (name[0] == '\0')
6162 name = NULL;
6163 else /* make a named tag */
6164 name = substitute (buffer, rp->name, &rp->regs);
6165 if (rp->force_explicit_name)
6166 /* Force explicit tag name, if a name is there. */
6167 pfnote (name, TRUE, buffer + linecharno,
6168 charno - linecharno + 1, lineno, linecharno);
6169 else
6170 make_tag (name, strlen (name), TRUE, buffer + linecharno,
6171 charno - linecharno + 1, lineno, linecharno);
6172 break;
6173 }
6174 }
6175 }
6176 }
6177
6178 \f
6179 static bool
6180 nocase_tail (cp)
6181 char *cp;
6182 {
6183 register int len = 0;
6184
6185 while (*cp != '\0' && lowcase (*cp) == lowcase (dbp[len]))
6186 cp++, len++;
6187 if (*cp == '\0' && !intoken (dbp[len]))
6188 {
6189 dbp += len;
6190 return TRUE;
6191 }
6192 return FALSE;
6193 }
6194
6195 static void
6196 get_tag (bp, namepp)
6197 register char *bp;
6198 char **namepp;
6199 {
6200 register char *cp = bp;
6201
6202 if (*bp != '\0')
6203 {
6204 /* Go till you get to white space or a syntactic break */
6205 for (cp = bp + 1; !notinname (*cp); cp++)
6206 continue;
6207 make_tag (bp, cp - bp, TRUE,
6208 lb.buffer, cp - lb.buffer + 1, lineno, linecharno);
6209 }
6210
6211 if (namepp != NULL)
6212 *namepp = savenstr (bp, cp - bp);
6213 }
6214
6215 /*
6216 * Read a line of text from `stream' into `lbp', excluding the
6217 * newline or CR-NL, if any. Return the number of characters read from
6218 * `stream', which is the length of the line including the newline.
6219 *
6220 * On DOS or Windows we do not count the CR character, if any before the
6221 * NL, in the returned length; this mirrors the behavior of Emacs on those
6222 * platforms (for text files, it translates CR-NL to NL as it reads in the
6223 * file).
6224 *
6225 * If multi-line regular expressions are requested, each line read is
6226 * appended to `filebuf'.
6227 */
6228 static long
6229 readline_internal (lbp, stream)
6230 linebuffer *lbp;
6231 register FILE *stream;
6232 {
6233 char *buffer = lbp->buffer;
6234 register char *p = lbp->buffer;
6235 register char *pend;
6236 int chars_deleted;
6237
6238 pend = p + lbp->size; /* Separate to avoid 386/IX compiler bug. */
6239
6240 for (;;)
6241 {
6242 register int c = getc (stream);
6243 if (p == pend)
6244 {
6245 /* We're at the end of linebuffer: expand it. */
6246 lbp->size *= 2;
6247 xrnew (buffer, lbp->size, char);
6248 p += buffer - lbp->buffer;
6249 pend = buffer + lbp->size;
6250 lbp->buffer = buffer;
6251 }
6252 if (c == EOF)
6253 {
6254 *p = '\0';
6255 chars_deleted = 0;
6256 break;
6257 }
6258 if (c == '\n')
6259 {
6260 if (p > buffer && p[-1] == '\r')
6261 {
6262 p -= 1;
6263 #ifdef DOS_NT
6264 /* Assume CRLF->LF translation will be performed by Emacs
6265 when loading this file, so CRs won't appear in the buffer.
6266 It would be cleaner to compensate within Emacs;
6267 however, Emacs does not know how many CRs were deleted
6268 before any given point in the file. */
6269 chars_deleted = 1;
6270 #else
6271 chars_deleted = 2;
6272 #endif
6273 }
6274 else
6275 {
6276 chars_deleted = 1;
6277 }
6278 *p = '\0';
6279 break;
6280 }
6281 *p++ = c;
6282 }
6283 lbp->len = p - buffer;
6284
6285 if (need_filebuf /* we need filebuf for multi-line regexps */
6286 && chars_deleted > 0) /* not at EOF */
6287 {
6288 while (filebuf.size <= filebuf.len + lbp->len + 1) /* +1 for \n */
6289 {
6290 /* Expand filebuf. */
6291 filebuf.size *= 2;
6292 xrnew (filebuf.buffer, filebuf.size, char);
6293 }
6294 strncpy (filebuf.buffer + filebuf.len, lbp->buffer, lbp->len);
6295 filebuf.len += lbp->len;
6296 filebuf.buffer[filebuf.len++] = '\n';
6297 filebuf.buffer[filebuf.len] = '\0';
6298 }
6299
6300 return lbp->len + chars_deleted;
6301 }
6302
6303 /*
6304 * Like readline_internal, above, but in addition try to match the
6305 * input line against relevant regular expressions and manage #line
6306 * directives.
6307 */
6308 static void
6309 readline (lbp, stream)
6310 linebuffer *lbp;
6311 FILE *stream;
6312 {
6313 long result;
6314
6315 linecharno = charno; /* update global char number of line start */
6316 result = readline_internal (lbp, stream); /* read line */
6317 lineno += 1; /* increment global line number */
6318 charno += result; /* increment global char number */
6319
6320 /* Honour #line directives. */
6321 if (!no_line_directive)
6322 {
6323 static bool discard_until_line_directive;
6324
6325 /* Check whether this is a #line directive. */
6326 if (result > 12 && strneq (lbp->buffer, "#line ", 6))
6327 {
6328 unsigned int lno;
6329 int start = 0;
6330
6331 if (sscanf (lbp->buffer, "#line %u \"%n", &lno, &start) >= 1
6332 && start > 0) /* double quote character found */
6333 {
6334 char *endp = lbp->buffer + start;
6335
6336 while ((endp = etags_strchr (endp, '"')) != NULL
6337 && endp[-1] == '\\')
6338 endp++;
6339 if (endp != NULL)
6340 /* Ok, this is a real #line directive. Let's deal with it. */
6341 {
6342 char *taggedabsname; /* absolute name of original file */
6343 char *taggedfname; /* name of original file as given */
6344 char *name; /* temp var */
6345
6346 discard_until_line_directive = FALSE; /* found it */
6347 name = lbp->buffer + start;
6348 *endp = '\0';
6349 canonicalize_filename (name); /* for DOS */
6350 taggedabsname = absolute_filename (name, tagfiledir);
6351 if (filename_is_absolute (name)
6352 || filename_is_absolute (curfdp->infname))
6353 taggedfname = savestr (taggedabsname);
6354 else
6355 taggedfname = relative_filename (taggedabsname,tagfiledir);
6356
6357 if (streq (curfdp->taggedfname, taggedfname))
6358 /* The #line directive is only a line number change. We
6359 deal with this afterwards. */
6360 free (taggedfname);
6361 else
6362 /* The tags following this #line directive should be
6363 attributed to taggedfname. In order to do this, set
6364 curfdp accordingly. */
6365 {
6366 fdesc *fdp; /* file description pointer */
6367
6368 /* Go look for a file description already set up for the
6369 file indicated in the #line directive. If there is
6370 one, use it from now until the next #line
6371 directive. */
6372 for (fdp = fdhead; fdp != NULL; fdp = fdp->next)
6373 if (streq (fdp->infname, curfdp->infname)
6374 && streq (fdp->taggedfname, taggedfname))
6375 /* If we remove the second test above (after the &&)
6376 then all entries pertaining to the same file are
6377 coalesced in the tags file. If we use it, then
6378 entries pertaining to the same file but generated
6379 from different files (via #line directives) will
6380 go into separate sections in the tags file. These
6381 alternatives look equivalent. The first one
6382 destroys some apparently useless information. */
6383 {
6384 curfdp = fdp;
6385 free (taggedfname);
6386 break;
6387 }
6388 /* Else, if we already tagged the real file, skip all
6389 input lines until the next #line directive. */
6390 if (fdp == NULL) /* not found */
6391 for (fdp = fdhead; fdp != NULL; fdp = fdp->next)
6392 if (streq (fdp->infabsname, taggedabsname))
6393 {
6394 discard_until_line_directive = TRUE;
6395 free (taggedfname);
6396 break;
6397 }
6398 /* Else create a new file description and use that from
6399 now on, until the next #line directive. */
6400 if (fdp == NULL) /* not found */
6401 {
6402 fdp = fdhead;
6403 fdhead = xnew (1, fdesc);
6404 *fdhead = *curfdp; /* copy curr. file description */
6405 fdhead->next = fdp;
6406 fdhead->infname = savestr (curfdp->infname);
6407 fdhead->infabsname = savestr (curfdp->infabsname);
6408 fdhead->infabsdir = savestr (curfdp->infabsdir);
6409 fdhead->taggedfname = taggedfname;
6410 fdhead->usecharno = FALSE;
6411 fdhead->prop = NULL;
6412 fdhead->written = FALSE;
6413 curfdp = fdhead;
6414 }
6415 }
6416 free (taggedabsname);
6417 lineno = lno - 1;
6418 readline (lbp, stream);
6419 return;
6420 } /* if a real #line directive */
6421 } /* if #line is followed by a a number */
6422 } /* if line begins with "#line " */
6423
6424 /* If we are here, no #line directive was found. */
6425 if (discard_until_line_directive)
6426 {
6427 if (result > 0)
6428 {
6429 /* Do a tail recursion on ourselves, thus discarding the contents
6430 of the line buffer. */
6431 readline (lbp, stream);
6432 return;
6433 }
6434 /* End of file. */
6435 discard_until_line_directive = FALSE;
6436 return;
6437 }
6438 } /* if #line directives should be considered */
6439
6440 {
6441 int match;
6442 regexp *rp;
6443 char *name;
6444
6445 /* Match against relevant regexps. */
6446 if (lbp->len > 0)
6447 for (rp = p_head; rp != NULL; rp = rp->p_next)
6448 {
6449 /* Only use generic regexps or those for the current language.
6450 Also do not use multiline regexps, which is the job of
6451 regex_tag_multiline. */
6452 if ((rp->lang != NULL && rp->lang != fdhead->lang)
6453 || rp->multi_line)
6454 continue;
6455
6456 match = re_match (rp->pat, lbp->buffer, lbp->len, 0, &rp->regs);
6457 switch (match)
6458 {
6459 case -2:
6460 /* Some error. */
6461 if (!rp->error_signaled)
6462 {
6463 error ("regexp stack overflow while matching \"%s\"",
6464 rp->pattern);
6465 rp->error_signaled = TRUE;
6466 }
6467 break;
6468 case -1:
6469 /* No match. */
6470 break;
6471 case 0:
6472 /* Empty string matched. */
6473 if (!rp->error_signaled)
6474 {
6475 error ("regexp matches the empty string: \"%s\"", rp->pattern);
6476 rp->error_signaled = TRUE;
6477 }
6478 break;
6479 default:
6480 /* Match occurred. Construct a tag. */
6481 name = rp->name;
6482 if (name[0] == '\0')
6483 name = NULL;
6484 else /* make a named tag */
6485 name = substitute (lbp->buffer, rp->name, &rp->regs);
6486 if (rp->force_explicit_name)
6487 /* Force explicit tag name, if a name is there. */
6488 pfnote (name, TRUE, lbp->buffer, match, lineno, linecharno);
6489 else
6490 make_tag (name, strlen (name), TRUE,
6491 lbp->buffer, match, lineno, linecharno);
6492 break;
6493 }
6494 }
6495 }
6496 }
6497
6498 \f
6499 /*
6500 * Return a pointer to a space of size strlen(cp)+1 allocated
6501 * with xnew where the string CP has been copied.
6502 */
6503 static char *
6504 savestr (cp)
6505 char *cp;
6506 {
6507 return savenstr (cp, strlen (cp));
6508 }
6509
6510 /*
6511 * Return a pointer to a space of size LEN+1 allocated with xnew where
6512 * the string CP has been copied for at most the first LEN characters.
6513 */
6514 static char *
6515 savenstr (cp, len)
6516 char *cp;
6517 int len;
6518 {
6519 register char *dp;
6520
6521 dp = xnew (len + 1, char);
6522 strncpy (dp, cp, len);
6523 dp[len] = '\0';
6524 return dp;
6525 }
6526
6527 /*
6528 * Return the ptr in sp at which the character c last
6529 * appears; NULL if not found
6530 *
6531 * Identical to POSIX strrchr, included for portability.
6532 */
6533 static char *
6534 etags_strrchr (sp, c)
6535 register const char *sp;
6536 register int c;
6537 {
6538 register const char *r;
6539
6540 r = NULL;
6541 do
6542 {
6543 if (*sp == c)
6544 r = sp;
6545 } while (*sp++);
6546 return (char *)r;
6547 }
6548
6549 /*
6550 * Return the ptr in sp at which the character c first
6551 * appears; NULL if not found
6552 *
6553 * Identical to POSIX strchr, included for portability.
6554 */
6555 static char *
6556 etags_strchr (sp, c)
6557 register const char *sp;
6558 register int c;
6559 {
6560 do
6561 {
6562 if (*sp == c)
6563 return (char *)sp;
6564 } while (*sp++);
6565 return NULL;
6566 }
6567
6568 /*
6569 * Compare two strings, ignoring case for alphabetic characters.
6570 *
6571 * Same as BSD's strcasecmp, included for portability.
6572 */
6573 static int
6574 etags_strcasecmp (s1, s2)
6575 register const char *s1;
6576 register const char *s2;
6577 {
6578 while (*s1 != '\0'
6579 && (ISALPHA (*s1) && ISALPHA (*s2)
6580 ? lowcase (*s1) == lowcase (*s2)
6581 : *s1 == *s2))
6582 s1++, s2++;
6583
6584 return (ISALPHA (*s1) && ISALPHA (*s2)
6585 ? lowcase (*s1) - lowcase (*s2)
6586 : *s1 - *s2);
6587 }
6588
6589 /*
6590 * Compare two strings, ignoring case for alphabetic characters.
6591 * Stop after a given number of characters
6592 *
6593 * Same as BSD's strncasecmp, included for portability.
6594 */
6595 static int
6596 etags_strncasecmp (s1, s2, n)
6597 register const char *s1;
6598 register const char *s2;
6599 register int n;
6600 {
6601 while (*s1 != '\0' && n-- > 0
6602 && (ISALPHA (*s1) && ISALPHA (*s2)
6603 ? lowcase (*s1) == lowcase (*s2)
6604 : *s1 == *s2))
6605 s1++, s2++;
6606
6607 if (n < 0)
6608 return 0;
6609 else
6610 return (ISALPHA (*s1) && ISALPHA (*s2)
6611 ? lowcase (*s1) - lowcase (*s2)
6612 : *s1 - *s2);
6613 }
6614
6615 /* Skip spaces (end of string is not space), return new pointer. */
6616 static char *
6617 skip_spaces (cp)
6618 char *cp;
6619 {
6620 while (iswhite (*cp))
6621 cp++;
6622 return cp;
6623 }
6624
6625 /* Skip non spaces, except end of string, return new pointer. */
6626 static char *
6627 skip_non_spaces (cp)
6628 char *cp;
6629 {
6630 while (*cp != '\0' && !iswhite (*cp))
6631 cp++;
6632 return cp;
6633 }
6634
6635 /* Print error message and exit. */
6636 void
6637 fatal (s1, s2)
6638 char *s1, *s2;
6639 {
6640 error (s1, s2);
6641 exit (EXIT_FAILURE);
6642 }
6643
6644 static void
6645 pfatal (s1)
6646 char *s1;
6647 {
6648 perror (s1);
6649 exit (EXIT_FAILURE);
6650 }
6651
6652 static void
6653 suggest_asking_for_help ()
6654 {
6655 fprintf (stderr, "\tTry `%s %s' for a complete list of options.\n",
6656 progname, NO_LONG_OPTIONS ? "-h" : "--help");
6657 exit (EXIT_FAILURE);
6658 }
6659
6660 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
6661 static void
6662 error (s1, s2)
6663 const char *s1, *s2;
6664 {
6665 fprintf (stderr, "%s: ", progname);
6666 fprintf (stderr, s1, s2);
6667 fprintf (stderr, "\n");
6668 }
6669
6670 /* Return a newly-allocated string whose contents
6671 concatenate those of s1, s2, s3. */
6672 static char *
6673 concat (s1, s2, s3)
6674 char *s1, *s2, *s3;
6675 {
6676 int len1 = strlen (s1), len2 = strlen (s2), len3 = strlen (s3);
6677 char *result = xnew (len1 + len2 + len3 + 1, char);
6678
6679 strcpy (result, s1);
6680 strcpy (result + len1, s2);
6681 strcpy (result + len1 + len2, s3);
6682 result[len1 + len2 + len3] = '\0';
6683
6684 return result;
6685 }
6686
6687 \f
6688 /* Does the same work as the system V getcwd, but does not need to
6689 guess the buffer size in advance. */
6690 static char *
6691 etags_getcwd ()
6692 {
6693 #ifdef HAVE_GETCWD
6694 int bufsize = 200;
6695 char *path = xnew (bufsize, char);
6696
6697 while (getcwd (path, bufsize) == NULL)
6698 {
6699 if (errno != ERANGE)
6700 pfatal ("getcwd");
6701 bufsize *= 2;
6702 free (path);
6703 path = xnew (bufsize, char);
6704 }
6705
6706 canonicalize_filename (path);
6707 return path;
6708
6709 #else /* not HAVE_GETCWD */
6710 #if MSDOS
6711
6712 char *p, path[MAXPATHLEN + 1]; /* Fixed size is safe on MSDOS. */
6713
6714 getwd (path);
6715
6716 for (p = path; *p != '\0'; p++)
6717 if (*p == '\\')
6718 *p = '/';
6719 else
6720 *p = lowcase (*p);
6721
6722 return strdup (path);
6723 #else /* not MSDOS */
6724 linebuffer path;
6725 FILE *pipe;
6726
6727 linebuffer_init (&path);
6728 pipe = (FILE *) popen ("pwd 2>/dev/null", "r");
6729 if (pipe == NULL || readline_internal (&path, pipe) == 0)
6730 pfatal ("pwd");
6731 pclose (pipe);
6732
6733 return path.buffer;
6734 #endif /* not MSDOS */
6735 #endif /* not HAVE_GETCWD */
6736 }
6737
6738 /* Return a newly allocated string containing the file name of FILE
6739 relative to the absolute directory DIR (which should end with a slash). */
6740 static char *
6741 relative_filename (file, dir)
6742 char *file, *dir;
6743 {
6744 char *fp, *dp, *afn, *res;
6745 int i;
6746
6747 /* Find the common root of file and dir (with a trailing slash). */
6748 afn = absolute_filename (file, cwd);
6749 fp = afn;
6750 dp = dir;
6751 while (*fp++ == *dp++)
6752 continue;
6753 fp--, dp--; /* back to the first differing char */
6754 #ifdef DOS_NT
6755 if (fp == afn && afn[0] != '/') /* cannot build a relative name */
6756 return afn;
6757 #endif
6758 do /* look at the equal chars until '/' */
6759 fp--, dp--;
6760 while (*fp != '/');
6761
6762 /* Build a sequence of "../" strings for the resulting relative file name. */
6763 i = 0;
6764 while ((dp = etags_strchr (dp + 1, '/')) != NULL)
6765 i += 1;
6766 res = xnew (3*i + strlen (fp + 1) + 1, char);
6767 res[0] = '\0';
6768 while (i-- > 0)
6769 strcat (res, "../");
6770
6771 /* Add the file name relative to the common root of file and dir. */
6772 strcat (res, fp + 1);
6773 free (afn);
6774
6775 return res;
6776 }
6777
6778 /* Return a newly allocated string containing the absolute file name
6779 of FILE given DIR (which should end with a slash). */
6780 static char *
6781 absolute_filename (file, dir)
6782 char *file, *dir;
6783 {
6784 char *slashp, *cp, *res;
6785
6786 if (filename_is_absolute (file))
6787 res = savestr (file);
6788 #ifdef DOS_NT
6789 /* We don't support non-absolute file names with a drive
6790 letter, like `d:NAME' (it's too much hassle). */
6791 else if (file[1] == ':')
6792 fatal ("%s: relative file names with drive letters not supported", file);
6793 #endif
6794 else
6795 res = concat (dir, file, "");
6796
6797 /* Delete the "/dirname/.." and "/." substrings. */
6798 slashp = etags_strchr (res, '/');
6799 while (slashp != NULL && slashp[0] != '\0')
6800 {
6801 if (slashp[1] == '.')
6802 {
6803 if (slashp[2] == '.'
6804 && (slashp[3] == '/' || slashp[3] == '\0'))
6805 {
6806 cp = slashp;
6807 do
6808 cp--;
6809 while (cp >= res && !filename_is_absolute (cp));
6810 if (cp < res)
6811 cp = slashp; /* the absolute name begins with "/.." */
6812 #ifdef DOS_NT
6813 /* Under MSDOS and NT we get `d:/NAME' as absolute
6814 file name, so the luser could say `d:/../NAME'.
6815 We silently treat this as `d:/NAME'. */
6816 else if (cp[0] != '/')
6817 cp = slashp;
6818 #endif
6819 strcpy (cp, slashp + 3);
6820 slashp = cp;
6821 continue;
6822 }
6823 else if (slashp[2] == '/' || slashp[2] == '\0')
6824 {
6825 strcpy (slashp, slashp + 2);
6826 continue;
6827 }
6828 }
6829
6830 slashp = etags_strchr (slashp + 1, '/');
6831 }
6832
6833 if (res[0] == '\0') /* just a safety net: should never happen */
6834 {
6835 free (res);
6836 return savestr ("/");
6837 }
6838 else
6839 return res;
6840 }
6841
6842 /* Return a newly allocated string containing the absolute
6843 file name of dir where FILE resides given DIR (which should
6844 end with a slash). */
6845 static char *
6846 absolute_dirname (file, dir)
6847 char *file, *dir;
6848 {
6849 char *slashp, *res;
6850 char save;
6851
6852 canonicalize_filename (file);
6853 slashp = etags_strrchr (file, '/');
6854 if (slashp == NULL)
6855 return savestr (dir);
6856 save = slashp[1];
6857 slashp[1] = '\0';
6858 res = absolute_filename (file, dir);
6859 slashp[1] = save;
6860
6861 return res;
6862 }
6863
6864 /* Whether the argument string is an absolute file name. The argument
6865 string must have been canonicalized with canonicalize_filename. */
6866 static bool
6867 filename_is_absolute (fn)
6868 char *fn;
6869 {
6870 return (fn[0] == '/'
6871 #ifdef DOS_NT
6872 || (ISALPHA(fn[0]) && fn[1] == ':' && fn[2] == '/')
6873 #endif
6874 );
6875 }
6876
6877 /* Translate backslashes into slashes. Works in place. */
6878 static void
6879 canonicalize_filename (fn)
6880 register char *fn;
6881 {
6882 #ifdef DOS_NT
6883 /* Canonicalize drive letter case. */
6884 if (fn[0] != '\0' && fn[1] == ':' && ISLOWER (fn[0]))
6885 fn[0] = upcase (fn[0]);
6886 /* Convert backslashes to slashes. */
6887 for (; *fn != '\0'; fn++)
6888 if (*fn == '\\')
6889 *fn = '/';
6890 #else
6891 /* No action. */
6892 fn = NULL; /* shut up the compiler */
6893 #endif
6894 }
6895
6896 \f
6897 /* Initialize a linebuffer for use */
6898 static void
6899 linebuffer_init (lbp)
6900 linebuffer *lbp;
6901 {
6902 lbp->size = (DEBUG) ? 3 : 200;
6903 lbp->buffer = xnew (lbp->size, char);
6904 lbp->buffer[0] = '\0';
6905 lbp->len = 0;
6906 }
6907
6908 /* Set the minimum size of a string contained in a linebuffer. */
6909 static void
6910 linebuffer_setlen (lbp, toksize)
6911 linebuffer *lbp;
6912 int toksize;
6913 {
6914 while (lbp->size <= toksize)
6915 {
6916 lbp->size *= 2;
6917 xrnew (lbp->buffer, lbp->size, char);
6918 }
6919 lbp->len = toksize;
6920 }
6921
6922 /* Like malloc but get fatal error if memory is exhausted. */
6923 static PTR
6924 xmalloc (size)
6925 unsigned int size;
6926 {
6927 PTR result = (PTR) malloc (size);
6928 if (result == NULL)
6929 fatal ("virtual memory exhausted", (char *)NULL);
6930 return result;
6931 }
6932
6933 static PTR
6934 xrealloc (ptr, size)
6935 char *ptr;
6936 unsigned int size;
6937 {
6938 PTR result = (PTR) realloc (ptr, size);
6939 if (result == NULL)
6940 fatal ("virtual memory exhausted", (char *)NULL);
6941 return result;
6942 }
6943
6944 /*
6945 * Local Variables:
6946 * indent-tabs-mode: t
6947 * tab-width: 8
6948 * fill-column: 79
6949 * c-font-lock-extra-types: ("FILE" "bool" "language" "linebuffer" "fdesc" "node" "regexp")
6950 * c-file-style: "gnu"
6951 * End:
6952 */
6953
6954 /* arch-tag: 8a9b748d-390c-4922-99db-2eeefa921051
6955 (do not change this comment) */
6956
6957 /* etags.c ends here */