Copyright (c) 1989, 1991, 1993
The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)vgrindefs.5 8.1 (Berkeley) 6/6/93
.Dd June 6, 1993 .Dt VGRINDEFS 5 .Os .Sh NAME .Nm vgrindefs .Nd language definition data base for .Xr vgrind 1 .Sh SYNOPSIS .Nm .Sh DESCRIPTION The .Nm file contains all language definitions for .Xr vgrind 1 . The data base is very similar to .Xr termcap 5 . .Sh FIELDS The following table names and describes each field.
p l -column Namexxx Tpexxx t Sy Name Type Description t "pb str regular expression for start of a procedure" t "bb str regular expression for start of a lexical block" t "be str regular expression for the end of a lexical block" t "cb str regular expression for the start of a comment" t "ce str regular expression for the end of a comment" t "sb str regular expression for the start of a string" t "se str regular expression for the end of a string" t "lb str regular expression for the start of a character constant" t "le str regular expression for the end of a character constant" t "tl bool present means procedures are only defined at the top lexical level" t "oc bool present means upper and lower case are equivalent" t "kw str a list of keywords separated by spaces" .El .Sh EXAMPLES The following entry, which describes the C language, is typical of a language entry. d -literal C|c:\ :pb=^\ed?*?\ed?\ep\ed?\e(\ea?\e):bb={:be=}:cb=/*:ce=*/:sb=":se=\ee":\e :lb=':le=\ee':tl:\e :kw=asm auto break case char continue default do double else enum\e extern float for fortran goto if int long register return short\e sizeof static struct switch typedef union unsigned while #define\e #else #endif #if #ifdef #ifndef #include #undef # define else endif\e if ifdef ifndef include undef: .Ed
p Note that the first field is just the language name (and any variants of it). Thus the C language could be specified to .Xr vgrind 1 as "c" or "C".
p Entries may continue onto multiple lines by giving a \e as the last character of a line. Capabilities in .Nm are of two types: Boolean capabilities which indicate that the language has some particular feature and string capabilities which give a regular expression or keyword list. .Sh REGULAR EXPRESSIONS .Nm uses regular expression which are very similar to those of .Xr ex 1 and .Xr lex 1 . The characters `^', `$', `:' and `\e' are reserved characters and must be "quoted" with a preceding .Ql \e if they are to be included as normal characters. The metasymbols and their meanings are: l -tag -width indent t $ the end of a line t ^ the beginning of a line t \ed a delimiter (space, tab, newline, start of line) t \ea matches any string of symbols (like .* in lex) t \ep matches any alphanumeric name. In a procedure definition (pb) the string that matches this symbol is used as the procedure name. t () grouping t | alternation t ? last item is optional t \ee preceding any string means that the string will not match an input string if the input string is preceded by an escape character (\e). This is typically used for languages (like C) which can include the string delimiter in a string by escaping it. .El
p Unlike other regular expressions in the system, these match words and not characters. Hence something like "(tramp|steamer)flies?" would match "tramp", "steamer", "trampflies", or "steamerflies". .Sh KEYWORD LIST The keyword list is just a list of keywords in the language separated by spaces. If the "oc" boolean is specified, indicating that upper and lower case are equivalent, then all the keywords should be specified in lower case. .Sh FILES l -tag -width /usr/share/misc/vgrindefs -compact t Pa /usr/share/misc/vgrindefs File containing terminal descriptions. .El .Sh SEE ALSO .Xr troff 1 , .Xr vgrind 1 .Sh HISTORY The .Nm file format appeared in x 4.2 .