annotate doc/misc/semantic.texi @ 106856:5fc7644b0c5f

Merge from trunk
author Jan D. <jan.h.d@swipnet.se>
date Fri, 15 Jan 2010 18:01:51 +0100
parents 1d1d5d9bd884
children a50b302b7928
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
1 \input texinfo
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
2 @setfilename ../../info/semantic
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
3 @set TITLE Semantic Manual
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
4 @set AUTHOR Eric M. Ludlam and David Ponce
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
5 @settitle @value{TITLE}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
6
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
7 @c *************************************************************************
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
8 @c @ Header
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
9 @c *************************************************************************
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
10
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
11 @c Merge all indexes into a single index for now.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
12 @c We can always separate them later into two or more as needed.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
13 @syncodeindex vr cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
14 @syncodeindex fn cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
15 @syncodeindex ky cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
16 @syncodeindex pg cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
17 @syncodeindex tp cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
18
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
19 @c @footnotestyle separate
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
20 @c @paragraphindent 2
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
21 @c @@smallbook
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
22 @c %**end of header
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
23
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
24 @copying
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
25 This manual documents the Semantic library and utilities.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
26
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
27 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007,
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106567
diff changeset
28 2009, 2010 Free Software Foundation, Inc.
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
29
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
30 @quotation
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
31 Permission is granted to copy, distribute and/or modify this document
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
32 under the terms of the GNU Free Documentation License, Version 1.3 or
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
33 any later version published by the Free Software Foundation; with no
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
34 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
35 and with the Back-Cover Texts as in (a) below. A copy of the license
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
36 is included in the section entitled ``GNU Free Documentation License.''
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
37
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
38 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
39 modify this GNU manual. Buying copies from the FSF supports it in
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
40 developing GNU and promoting software freedom.''
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
41 @end quotation
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
42 @end copying
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
43
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
44 @ifinfo
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
45 @format
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
46 START-INFO-DIR-ENTRY
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
47 * Semantic: (semantic). Source code parser library and utilities.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
48 END-INFO-DIR-ENTRY
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
49 @end format
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
50 @end ifinfo
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
51
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
52 @titlepage
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
53 @center @titlefont{Semantic}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
54 @sp 4
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
55 @center by @value{AUTHOR}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
56 @end titlepage
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
57 @page
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
58
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
59 @macro semantic{}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
60 @i{Semantic}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
61 @end macro
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
62
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
63 @macro keyword{kw}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
64 @anchor{\kw\}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
65 @b{\kw\}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
66 @end macro
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
67
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
68 @macro obsolete{old,new}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
69 @sp 1
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
70 @strong{Compatibility}:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
71 @code{\new\} introduced in @semantic{} version 2.0 supercedes
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
72 @code{\old\} which is now obsolete.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
73 @end macro
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
74
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
75 @c *************************************************************************
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
76 @c @ Document
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
77 @c *************************************************************************
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
78 @contents
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
79
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
80 @node top
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
81 @top @value{TITLE}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
82
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
83 @semantic{} is a suite of Emacs libraries and utilities for parsing
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
84 source code. At its core is a lexical analyzer and two parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
85 generators (@code{bovinator} and @code{wisent}) written in Emacs Lisp.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
86 @semantic{} provides a variety of tools for making use of the parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
87 output, including user commands for code navigation and completion, as
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
88 well as enhancements for imenu, speedbar, whichfunc, eldoc,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
89 hippie-expand, and several other parts of Emacs.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
90
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
91 To send bug reports, or participate in discussions about semantic,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
92 use the mailing list cedet-semantic@@sourceforge.net via the URL:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
93 @url{http://lists.sourceforge.net/lists/listinfo/cedet-semantic}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
94
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
95 @ifnottex
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
96 @insertcopying
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
97 @end ifnottex
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
98
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
99 @menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
100 * Introduction::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
101 * Using Semantic::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
102 * Semantic Internals::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
103 * Glossary::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
104 * GNU Free Documentation License::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
105 * Index::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
106 @end menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
107
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
108 @node Introduction
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
109 @chapter Introduction
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
110
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
111 This chapter gives an overview of @semantic{} and its goals.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
112
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
113 Ordinarily, Emacs uses regular expressions (and syntax tables) to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
114 analyze source code for purposes such as syntax highlighting. This
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
115 approach, though simple and efficient, has its limitations: roughly
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
116 speaking, it only ``guesses'' the meaning of each piece of source code
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
117 in the context of the programming language, instead of rigorously
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
118 ``understanding'' it.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
119
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
120 @semantic{} provides a new infrastructure to analyze source code using
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
121 @dfn{parsers} instead of regular expressions. It contains two
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
122 built-in parser generators (an @acronym{LL} generator named
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
123 @code{Bovine} and an @acronym{LALR} generator named @code{Wisent},
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
124 both written in Emacs Lisp), and parsers for several common
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
125 programming languages. It can also make use of @dfn{external
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
126 parsers}---programs such as GNU Global and GNU IDUtils.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
127
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
128 @semantic{} provides a uniform, language-independent @acronym{API} for
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
129 accessing the parser output. This output can be used by other Emacs
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
130 Lisp programs to implement ``syntax-aware'' behavior. @semantic{}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
131 itself includes several such utilities, including user-level Emacs
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
132 commands for navigating, searching, and completing source code.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
133
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
134 The following diagram illustrates the structure of the @semantic{}
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
135 package:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
136
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
137 @table @strong
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
138 @item Please Note:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
139 The words in all-capital are those that @semantic{} itself provides.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
140 Others are current or future languages or applications that are not
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
141 distributed along with @semantic{}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
142 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
143
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
144 @example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
145 Applications
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
146 and
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
147 Utilities
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
148 -------
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
149 / \
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
150 +---------------+ +--------+ +--------+
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
151 C --->| C PARSER |--->| | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
152 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
153 +---------------+ | COMMON | | COMMON |<--- SPEEDBAR
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
154 Java --->| JAVA PARSER |--->| PARSE | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
155 +---------------+ | TREE | | PARSE |<--- SEMANTICDB
106567
c59fc4a754cc * sem-user.texi (Semantic mode, Idle Scheduler, Smart Completion)
Chong Yidong <cyd@stupidchicken.com>
parents: 106352
diff changeset
156 +---------------+ | FORMAT | | API |
c59fc4a754cc * sem-user.texi (Semantic mode, Idle Scheduler, Smart Completion)
Chong Yidong <cyd@stupidchicken.com>
parents: 106352
diff changeset
157 Scheme --->| SCHEME PARSER |--->| | | |<--- ecb
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
158 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
159 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
160 Texinfo --->| TEXI. PARSER |--->| | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
161 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
162
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
163 ... ... ... ...
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
164
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
165 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
166 Lang. Y --->| Y Parser |--->| | | |<--- app. ?
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
167 +---------------+ | | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
168 +---------------+ | | | |<--- app. ?
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
169 Lang. Z --->| Z Parser |--->| | | |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
170 +---------------+ +--------+ +--------+
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
171 @end example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
172
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
173 @menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
174 * Semantic Components::
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
175 @end menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
176
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
177 @node Semantic Components
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
178 @section Semantic Components
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
179
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
180 In this section, we provide a more detailed description of the major
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
181 components of @semantic{}, and how they interact with one another.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
182
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
183 The first step in parsing a source code file is to break it up into
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
184 its fundamental components. This step is called lexical analysis:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
185
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
186 @example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
187 syntax table, keywords list, and options
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
188 |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
189 |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
190 v
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
191 input file ----> Lexer ----> token stream
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
192 @end example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
193
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
194 @noindent
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
195 The output of the lexical analyzer is a list of tokens that make up
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
196 the file. The next step is the actual parsing, shown below:
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
197
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
198 @example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
199 parser tables
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
200 |
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
201 v
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
202 token stream ---> Parser ----> parse tree
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
203 @end example
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
204
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
205 @noindent
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
206 The end result, the parse tree, is @semantic{}'s internal
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
207 representation of the language grammar. @semantic{} provides an
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
208 @acronym{API} for Emacs Lisp programs to access the parse tree.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
209
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
210 Parsing large files can take several seconds or more. By default,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
211 @semantic{} automatically caches parse trees by saving them in your
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
212 @file{.emacs.d} directory. When you revisit a previously-parsed file,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
213 the parse tree is automatically reloaded from this cache, to save
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
214 time. @xref{SemanticDB}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
215
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
216 @node Using Semantic
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
217 @chapter Using Semantic
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
218
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
219 @include sem-user.texi
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
220
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
221 @node Semantic Internals
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
222 @chapter Semantic Internals
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
223
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
224 This chapter provides an overview of the internals of @semantic{}.
106567
c59fc4a754cc * sem-user.texi (Semantic mode, Idle Scheduler, Smart Completion)
Chong Yidong <cyd@stupidchicken.com>
parents: 106352
diff changeset
225 This information is usually not needed by application developers or
c59fc4a754cc * sem-user.texi (Semantic mode, Idle Scheduler, Smart Completion)
Chong Yidong <cyd@stupidchicken.com>
parents: 106352
diff changeset
226 grammar developers; it is useful mostly for the hackers who would like
c59fc4a754cc * sem-user.texi (Semantic mode, Idle Scheduler, Smart Completion)
Chong Yidong <cyd@stupidchicken.com>
parents: 106352
diff changeset
227 to learn more about how @semantic{} works.
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
228
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
229 @menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
230 * Parser code :: Code used for the parsers
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
231 * Tag handling :: Code used for manipulating tags
106305
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
232 * Semanticdb Internals :: Code used in the semantic database
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
233 * Analyzer Internals :: Code used in the code analyzer
106076
e142b685cd90 * semantic.texi (Semantic Internals, Glossary):
Juanma Barranquero <lekktu@gmail.com>
parents: 106061
diff changeset
234 * Tools :: Code used in user tools
e142b685cd90 * semantic.texi (Semantic Internals, Glossary):
Juanma Barranquero <lekktu@gmail.com>
parents: 106061
diff changeset
235 * Tests :: Code used for testing
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
236 @end menu
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
237
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
238 @node Parser code
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
239 @section Parser code
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
240
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
241 @semantic{} parsing code is spread across a range of files.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
242
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
243 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
244 @item semantic.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
245 The core infrastructure sets up buffers for parsing, and has all the
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
246 core parsing routines. Most parsing routines are overloadable, so the
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
247 actual implementation may be somewhere else.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
248
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
249 @item semantic-edit.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
250 Incremental reparse based on user edits.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
251
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
252 @item semantic-grammar.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
253 @itemx semantic-grammar.wy
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
254 Parser for the different grammar languages, and a major mode for
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
255 editing grammars in Emacs.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
256
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
257 @item semantic-lex.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
258 Infrastructure for implementing lexical analyzers. Provides macros
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
259 for creating individual analyzers for specific features, and a way to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
260 combine them together.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
261
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
262 @item semantic-lex-spp.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
263 Infrastructure for a lexical symbolic preprocessor. This was written
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
264 to implement the C preprocessor, but could be used for other lexical
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
265 preprocessors.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
266
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
267 @item bovine/bovine-grammar.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
268 @itemx bovine/bovine-grammar-macros.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
269 @itemx bovine/semantic-bovine.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
270 The ``bovine'' grammar. This is the first grammar mode written for
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
271 @semantic{} and is useful for simple creating simple parsers.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
272
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
273 @item wisent/wisent.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
274 @itemx wisent/bison-wisent.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
275 @itemx wisent/semantic-wisent.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
276 @itemx wisent/semantic-debug-grammar.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
277 A port of bison to Emacs. This infrastructure lets you create LALR
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
278 based parsers for @semantic{}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
279
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
280 @item semantic-ast.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
281 Manage Abstract Syntax Trees for parsers.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
282
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
283 @item semantic-debug.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
284 Infrastructure for debugging grammars.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
285
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
286 @item semantic-util.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
287 Various utilities for manipulating tags, such as describing the tag
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
288 under point, adding labels, and the all important
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
289 @code{semantic-something-to-tag-table}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
290
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
291 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
292
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
293 @node Tag handling
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
294 @section Tag handling
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
295
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
296 A tag represents an individual item found in a buffer, such as a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
297 function or variable. Tag handling is handled in several source
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
298 files.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
299
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
300 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
301 @item semantic-tag.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
302 Basic tag creation, queries, cloning, binding, and unbinding.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
303
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
304 @item semantic-tag-write.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
305 Write a tag or tag list to a stream. These routines are used by
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
306 @file{semanticdb-file.el} when saving a list of tags.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
307
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
308 @item semantic-tag-file.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
309 Files associated with tags. Goto-tag, file for include, and file for
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
310 a prototype.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
311
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
312 @item semantic-tag-ls.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
313 Language dependant features of a tag, such as parent calculation, slot
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
314 protection, and other states like abstract, virtual, static, and leaf.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
315
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
316 @item semantic-dep.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
317 Include file handling. Contains the include path concepts, and
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
318 routines for looking up file names in the include path.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
319
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
320 @item semantic-format.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
321 Convert a tag into a nicely formatted and colored string. Use
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
322 @code{semantic-test-all-format-tag-functions} to test different output
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
323 options.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
324
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
325 @item semantic-find.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
326 Find tags matching different conditions in a tag table.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
327 These routines are used by @file{semanticdb-find.el} once the database
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
328 has been converted into a simpler tag table.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
329
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
330 @item semantic-sort.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
331 Sorting lists of tags in different ways. Includes sorting a plain
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
332 list of tags forward or backward. Includes binning tags based on
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
333 attributes (bucketize), and tag adoption for multiple references to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
334 the same thing.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
335
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
336 @item semantic-doc.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
337 Capture documentation comments from near a tag.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
338
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
339 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
340
106305
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
341 @node Semanticdb Internals
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
342 @section Semanticdb Internals
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
343
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
344 @acronym{Semanticdb} complexity is certainly an issue. It is a rather
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
345 hairy problem to try and solve.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
346
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
347 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
348 @item semanticdb.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
349 Defines a @dfn{database} and a @dfn{table} base class. You can
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
350 instantiate these classes, and use them, but they are not persistent.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
351
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
352 This file also provides support for @code{semanticdb-minor-mode},
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
353 which automatically associates files with tables in databases so that
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
354 tags are @emph{saved} while a buffer is not in memory.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
355
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
356 The database and tables both also provide applicate cache information,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
357 and cache flushing system. The semanticdb search routines use caches
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
358 to save datastructures that are complex to calculate.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
359
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
360 Lastly, it provides the concept of @dfn{project root}. It is a system
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
361 by which a file can be associated with the root of a project, so if
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
362 you have a tree of directories and source files, it can find the root,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
363 and allow a tag-search to span all available databases in that
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
364 directory hierarchy.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
365
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
366 @item semanticdb-file.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
367 Provides a subclass of the basic table so that it can be saved to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
368 disk. Implements all the code needed to unbind/rebind tags to a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
369 buffer and writing them to a file.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
370
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
371 @item semanticdb-el.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
372 Implements a special kind of @dfn{system} database that uses Emacs
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
373 internals to perform queries.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
374
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
375 @item semanticdb-ebrowse.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
376 Implements a system database that uses Ebrowse to parse files into a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
377 table that can be queried for tag names. Successful tag hits during a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
378 find causes @semantic{} to pick up and parse the reference files to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
379 get the full details.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
380
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
381 @item semanticdb-find.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
382 Infrastructure for searching groups @semantic{} databases, and dealing
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
383 with the search results format.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
384
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
385 @item semanticdb-ref.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
386 Tracks crossreferences. Cross references are needed when buffer is
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
387 reparsed, and must alert other tables that any dependant caches may
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
388 need to be flushed. References are in the form of include files.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
389
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
390 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
391
106305
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
392 @node Analyzer Internals
0b797c8cfed8 * semantic.texi (Analyzer Internals): Rename from Analyzer.
Chong Yidong <cyd@stupidchicken.com>
parents: 106076
diff changeset
393 @section Analyzer Internals
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
394
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
395 The @semantic{} analyzer is a complex engine which has been broken
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
396 down across several modules. When the @semantic{} analyzer fails,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
397 start with @code{semantic-analyze-debug-assist}, then dive into some
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
398 of these files.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
399
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
400 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
401 @item semantic-analyze.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
402 The core analyzer for defining the @dfn{current context}. The
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
403 current context is an object that contains references to aspects of
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
404 the local context including the current prefix, and a tag list
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
405 defining what the prefix means.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
406
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
407 @item semantic-analyze-complete.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
408 Provides @code{semantic-analyze-possible-completions}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
409
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
410 @item semantic-analyze-debug.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
411 The analyzer debugger. Useful when attempting to get everything
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
412 configured.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
413
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
414 @item semantic-analyze-fcn.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
415 Various support functions needed by the analyzer.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
416
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
417 @item semantic-ctxt.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
418 Local context parser. Contains overloadable functions used to move
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
419 around through different scopes, get local variables, and collect the
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
420 current prefix used when doing completion.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
421
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
422 @item semantic-scope.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
423 Calculate @dfn{scope} for a location in a buffer. The scope includes
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
424 local variables, and tag lists in scope for various reasons, such as
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
425 C++ using statements.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
426
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
427 @item semanticdb-typecache.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
428 The typecache is part of @code{semanticdb}, but is used primarilly by
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
429 the analyzer to look up datatypes and complex names. The typecache is
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
430 bound across source files and builds a master lookup table for data
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
431 type names.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
432
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
433 @item semantic-ia.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
434 Interactive Analyzer functions. Simple routines that do completion or
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
435 lookups based on the results from the Analyzer. These routines are
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
436 meant as examples for application writers, but are quite useful as
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
437 they are.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
438
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
439 @item semantic-ia-sb.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
440 Speedbar support for the analyzer, displaying context info, and
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
441 completion lists.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
442
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
443 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
444
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
445 @node Tools
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
446 @section Tools
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
447
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
448 These files contain various tools a user can use.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
449
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
450 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
451 @item semantic-idle.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
452 Idle scheduler for @semantic{}. Manages reparsing buffers after
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
453 edits, and large work tasks in idle time. Includes modes for showing
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
454 summary help and pop-up completion.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
455
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
456 @item senator.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
457 The @semantic{} navigator. Provides many ways to move through a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
458 buffer based on the active tag table.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
459
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
460 @item semantic-decorate.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
461 A minor mode for decorating tags based on details from the parser.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
462 Includes overlines for functions, or coloring class fields based on
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
463 protection.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
464
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
465 @item semantic-decorate-include.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
466 A decoration mode for include files, which assists users in setting up
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
467 parsing for their includes.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
468
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
469 @item semantic-complete.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
470 Advanced completion prompts for reading tag names in the minibuffer, or
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
471 inline in a buffer.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
472
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
473 @item semantic-imenu.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
474 Imenu support for using @semantic{} tags in imenu.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
475
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
476 @item semantic-mru-bookmark.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
477 Automatic bookmarking based on tags. Jump to locations you've been
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
478 before based on tag name.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
479
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
480 @item semantic-sb.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
481 Support for @semantic{} tag usage in Speedbar.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
482
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
483 @item semantic-util-modes.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
484 A bunch of small minor-modes that exposes aspects of the semantic
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
485 parser state. Includes @code{semantic-stickyfunc-mode}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
486
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
487 @item document.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
488 @itemx document-vars.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
489 Create an update comments for tags.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
490
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
491 @item semantic-adebug.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
492 Extensions of @file{data-debug.el} for @semantic{}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
493
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
494 @item semantic-chart.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
495 Draw some charts from stats generated from parsing.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
496
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
497
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
498 @item semantic-elp.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
499 Profiler for helping to optimize the @semantic{} analyzer.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
500
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
501
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
502 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
503
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
504 @node Tests
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
505 @section Tests
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
506
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
507 @table @file
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
508
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
509 @item semantic-utest.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
510 Basic testing of parsing and incremental parsing for most supported
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
511 languages.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
512
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
513 @item semantic-ia-utest.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
514 Test the semantic analyzer's ability to provide smart completions.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
515
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
516 @item semantic-utest-c.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
517 Tests for the C parser's lexical pre-processor.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
518
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
519 @item semantic-regtest.el
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
520 Regression tests from the older Semantic 1.x API.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
521
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
522 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
523
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
524 @node Glossary
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
525 @appendix Glossary
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
526
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
527 @table @keyword
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
528 @item BNF
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
529 In semantic 1.4, a BNF file represented ``Bovine Normal Form'', the
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
530 grammar file used for the 1.4 parser generator. This was a play on
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
531 Backus-Naur Form which proved too confusing.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
532
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
533 @item bovinate
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
534 A verb representing what happens when a bovine parser parses a file.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
535
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
536 @item bovine lambda
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
537 In a bovine, or LL parser, the bovine lambda is a function to execute
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
538 when a specific set of match rules has succeeded in matching text from
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
539 the buffer.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
540
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
541 @item bovine parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
542 A parser using the bovine parser generator. It is an LL parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
543 suitible for small simple languages.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
544
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
545 @item context
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
546
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
547 @item LALR
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
548
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
549 @item lexer
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
550 A program which converts text into a stream of tokens by analyzing
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
551 them lexically. Lexers will commonly create strings, symbols,
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
552 keywords and punctuation, and strip whitespaces and comments.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
553
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
554 @item LL
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
555
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
556 @item nonterminal
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
557 A nonterminal symbol or simply a nonterminal stands for a class of
106076
e142b685cd90 * semantic.texi (Semantic Internals, Glossary):
Juanma Barranquero <lekktu@gmail.com>
parents: 106061
diff changeset
558 syntactically equivalent groupings. A nonterminal symbol name is used
106061
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
559 in writing grammar rules.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
560
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
561 @item overloadable
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
562 Some functions are defined via @code{define-overload}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
563 These can be overloaded via ....
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
564
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
565 @item parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
566 A program that converts @b{tokens} to @b{tags}.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
567
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
568 @item tag
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
569 A tag is a representation of some entity in a language file, such as a
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
570 function, variable, or include statement. In semantic, the word tag is
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
571 used the same way it is used for the etags or ctags tools.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
572
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
573 A tag is usually bound to a buffer region via overlay, or it just
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
574 specifies character locations in a file.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
575
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
576 @item token
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
577 A single atomic item returned from a lexer. It represents some set
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
578 of characters found in a buffer.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
579
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
580 @item token stream
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
581 The output of the lexer as well as the input to the parser.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
582
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
583 @item wisent parser
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
584 A parser using the wisent parser generator. It is a port of bison to
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
585 Emacs Lisp. It is an LALR parser suitable for complex languages.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
586 @end table
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
587
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
588
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
589 @node GNU Free Documentation License
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
590 @appendix GNU Free Documentation License
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
591 @include doclicense.texi
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
592
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
593 @node Index
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
594 @unnumbered Index
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
595 @printindex cp
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
596
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
597 @iftex
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
598 @contents
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
599 @summarycontents
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
600 @end iftex
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
601
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
602 @bye
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
603
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
604 @c Following comments are for the benefit of ispell.
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
605
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
606 @c LocalWords: alist API APIs arg argc args argv asis assoc autoload Wisent
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
607 @c LocalWords: backquote bnf bovinate bovinates LALR
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
608 @c LocalWords: bovinating bovination bovinator bucketize
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
609 @c LocalWords: cb cdr charquote checkcache cindex CLOS
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
610 @c LocalWords: concat concocting const constantness ctxt Decl defcustom
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
611 @c LocalWords: deffn deffnx defun defvar destructor's dfn diff dir
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
612 @c LocalWords: doc docstring EDE EIEIO elisp emacsman emph enum
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
613 @c LocalWords: eq Exp EXPANDFULL expresssion fn foo func funcall
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
614 @c LocalWords: ia ids iff ifinfo imenu imenus init int isearch itemx java kbd
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
615 @c LocalWords: keymap keywordtable lang languagemode lexer lexing Ludlam
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
616 @c LocalWords: menubar metaparent metaparents min minibuffer Misc mode's
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
617 @c LocalWords: multitable NAvigaTOR noindent nomedian nonterm noselect
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
618 @c LocalWords: nosnarf obarray OLE OO outputfile paren parsetable POINT's
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
619 @c LocalWords: popup positionalonly positiononly positionormarker pre
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
620 @c LocalWords: printf printindex Programmatically pt punctuations quotemode
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
621 @c LocalWords: ref regex regexp Regexps reparse resetfile samp sb
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
622 @c LocalWords: scopestart SEmantic semanticdb setfilename setq
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
623 @c LocalWords: settitle setupfunction sexp sp SPC speedbar speedbar's
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
624 @c LocalWords: streamorbuffer struct subalist submenu submenus
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
625 @c LocalWords: subsubsection sw sym texi texinfo titlefont titlepage
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
626 @c LocalWords: tok TOKEN's toplevel typemodifiers uml unset untar
014672c3a25f * Makefile.in: Build the Semantic manual.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
627 @c LocalWords: uref usedb var vskip xref yak
106352
3b90f039f42b Add arch tagline
Miles Bader <miles@gnu.org>
parents: 106305
diff changeset
628
3b90f039f42b Add arch tagline
Miles Bader <miles@gnu.org>
parents: 106305
diff changeset
629 @ignore
3b90f039f42b Add arch tagline
Miles Bader <miles@gnu.org>
parents: 106305
diff changeset
630 arch-tag: cbc6e78c-4ff1-410e-9fc7-936487e39bbf
3b90f039f42b Add arch tagline
Miles Bader <miles@gnu.org>
parents: 106305
diff changeset
631 @end ignore