usr/src/man/man5/vgrindefs.5

   1 '\" te
   2 .\" Copyright (c) 1994, Sun Microsystems, Inc. All Rights Reserved.
   3 .\"  Copyright (c) 1983 Regents of the University of California.  All rights reserved.  The Berkeley software License Agreement specifies the terms and conditions for redistribution.
   4 .TH VGRINDEFS 5 "Aug 10, 1994"
   5 .SH NAME
   6 vgrindefs \- vgrind's language definition data base
   7 .SH SYNOPSIS
   8 .LP
   9 .nf
  10 \fB/usr/lib/vgrindefs\fR
  11 .fi
  12
  13 .SH DESCRIPTION
  14 .sp
  15 .LP
  16 \fBvgrindefs\fR contains all language definitions for \fBvgrind\fR(1).
  17 Capabilities in \fBvgrindefs\fR are of two types: Boolean capabilities which
  18 indicate that the language has some particular feature and string capabilities
  19 which give a regular expression or keyword list. Entries may continue onto
  20 multiple lines by giving a \e as the last character of a line. Lines starting
  21 with # are comments.
  22 .SS "Capabilities"
  23 .sp
  24 .LP
  25 The following table names and describes each capability.
  26 .sp
  27
  28 .sp
  29 .TS
  30 box;
  31 c | c | c
  32 l | l | l .
  33 Name    Type    Description
  34 _
  35 \fBab\fR        \fBstr\fR       T{
  36 Regular expression for the start of an alternate form comment
  37 T}
  38 _
  39 \fBae\fR        \fBstr\fR       T{
  40 Regular expression for the end of an alternate form comment
  41 T}
  42 _
  43 \fBbb\fR        \fBstr\fR       T{
  44 Regular expression for the start of a block
  45 T}
  46 _
  47 \fBbe\fR        \fBstr\fR       T{
  48 Regular expression for the end of a lexical block
  49 T}
  50 _
  51 \fBcb\fR        \fBstr\fR       T{
  52 Regular expression for the start of a comment
  53 T}
  54 _
  55 \fBce\fR        \fBstr\fR       T{
  56 Regular expression for the end of a comment
  57 T}
  58 _
  59 \fBid\fR        \fBstr\fR       T{
  60 String giving characters other than letters and digits that may legally occur in identifiers (default `_')
  61 T}
  62 _
  63 \fBkw\fR        \fBstr\fR       A list of keywords separated by spaces
  64 _
  65 \fBlb\fR        \fBstr\fR       T{
  66 Regular expression for the start of a character constant
  67 T}
  68 _
  69 \fBle\fR        \fBstr\fR       T{
  70 Regular expression for the end of a character constant
  71 T}
  72 _
  73 \fBoc\fR        \fBbool\fR      T{
  74 Present means upper and lower case are equivalent
  75 T}
  76 _
  77 \fBpb\fR        \fBstr\fR       T{
  78 Regular expression for start of a procedure
  79 T}
  80 _
  81 \fBpl\fR        \fBbool\fR      T{
  82 Procedure definitions are constrained to the lexical level matched by the `px' capability
  83 T}
  84 _
  85 \fBpx\fR        \fBstr\fR       T{
  86 A match for this regular expression indicates that procedure definitions may occur at the next lexical level. Useful for lisp-like languages in which procedure definitions occur as subexpressions of defuns.
  87 T}
  88 _
  89 \fBsb\fR        \fBstr\fR       T{
  90 Regular expression for the start of a string
  91 T}
  92 _
  93 \fBse\fR        \fBstr\fR       T{
  94 Regular expression for the end of a string
  95 T}
  96 _
  97 \fBtc\fR        \fBstr\fR       T{
  98 Use the named entry as a continuation of this one
  99 T}
 100 _
 101 \fBtl\fR        \fBbool\fR      T{
 102 Present means procedures are only defined at the top lexical level
 103 T}
 104 .TE
 105
 106 .SS "Regular Expressions"
 107 .sp
 108 .LP
 109 \fBvgrindefs\fR uses regular expressions similar to those of \fBex\fR(1) and
 110 \fBlex\fR(1). The characters `^', `$', `:', and `\e' are reserved characters
 111 and must be `quoted' with a preceding \e if they are to be included as normal
 112 characters. The metasymbols and their meanings are:
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB$\fR\fR
 117 .ad
 118 .RS 7n
 119 The end of a line
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fB^\fR\fR
 126 .ad
 127 .RS 7n
 128 The beginning of a line
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fB\ed\fR\fR
 135 .ad
 136 .RS 7n
 137 A delimiter (space, tab, newline, start of line)
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB\ea\fR\fR
 144 .ad
 145 .RS 7n
 146 Matches any string of symbols (like `.*' in lex)
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB\ep\fR\fR
 153 .ad
 154 .RS 7n
 155 Matches any identifier. In a procedure definition (the `pb' capability) the
 156 string that matches this symbol is used as the procedure name.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB()\fR\fR
 163 .ad
 164 .RS 7n
 165 Grouping
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB|\fR\fR
 172 .ad
 173 .RS 7n
 174 Alternation
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB?\fR\fR
 181 .ad
 182 .RS 7n
 183 Last item is optional
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fB\ee\fR\fR
 190 .ad
 191 .RS 7n
 192 Preceding any string means that the string will not match an input string if
 193 the input string is preceded by an escape character (\e). This is typically
 194 used for languages (like C) that can include the string delimiter in a string
 195 by escaping it.
 196 .RE
 197
 198 .sp
 199 .LP
 200 Unlike other regular expressions in the system, these match words and not
 201 characters. Hence something like `(tramp|steamer)flies?' would match `tramp',
 202 `steamer', `trampflies', or `steamerflies'. Contrary to some forms of regular
 203 expressions, \fBvgrindef\fR alternation binds very tightly. Grouping
 204 parentheses are likely to be necessary in expressions involving alternation.
 205 .SS "Keyword List"
 206 .sp
 207 .LP
 208 The keyword list is just a list of keywords in the language separated by
 209 spaces. If the `oc' boolean is specified, indicating that upper and lower case
 210 are equivalent, then all the keywords should be specified in lower case.
 211 .SH EXAMPLES
 212 .LP
 213 \fBExample 1 \fRA sample program.
 214 .sp
 215 .LP
 216 The following entry, which describes the C language, is typical of a language
 217 entry.
 218
 219 .sp
 220 .in +2
 221 .nf
 222 C|c|the C programming language:\e
 223     :pb=^\ed?*?\ed?\ep\ed?(\ea?\e)(\ed|{):bb={:be=}:cb=/*:ce=*/:sb=":se=\ee":\e
 224     :le=\ee':tl:\e
 225     :kw=asm auto break case char continue default do double else enum\e
 226     extern float for fortran goto if int long register return short\e
 227     sizeof static struct switch typedef union unsigned void while #define\e
 228     #else #endif #if #ifdef #ifndef #include #undef # define endif\e
 229     ifdef ifndef include undef defined:
 230 .fi
 231 .in -2
 232 .sp
 233
 234 .sp
 235 .LP
 236 Note that the first field is just the language name (and any variants of it).
 237 Thus the C language could be specified to \fBvgrind\fR(1) as `c' or `C'.
 238
 239 .SH FILES
 240 .sp
 241 .ne 2
 242 .na
 243 \fB\fB/usr/lib/vgrindefs\fR\fR
 244 .ad
 245 .RS 22n
 246 file containing vgrind descriptions
 247 .RE
 248
 249 .SH SEE ALSO
 250 .sp
 251 .LP
 252 \fBex\fR(1), \fBlex\fR(1), \fBtroff\fR(1), \fBvgrind\fR(1)