1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)vgrindefs.5 8.1 (Berkeley) 6/6/93 33.\" $Id$ 34.\" 35.Dd June 6, 1993 36.Dt VGRINDEFS 5 37.Os BSD 4.2 38.Sh NAME 39.Nm vgrindefs 40.Nd language definition data base for 41.Xr vgrind 1 42.Sh SYNOPSIS 43.Nm vgrindefs 44.Sh DESCRIPTION 45The 46.Nm vgrindefs 47file 48contains all language definitions for 49.Xr vgrind 1 . 50The data base is 51very similar to 52.Xr termcap 5 . 53.Sh FIELDS 54The following table names and describes each field. 55.Pp 56.Bl -column Namexxx Tpexxx 57.Sy Name Type Description 58.It "ab str regular expression for the start of an alternate comment" 59.It "ae str regular expression for the end of an alternate comment" 60.It "pb str regular expression for start of a procedure" 61.It "bb str regular expression for start of a lexical block" 62.It "be str regular expression for the end of a lexical block" 63.It "cb str regular expression for the start of a comment" 64.It "ce str regular expression for the end of a comment" 65.It "sb str regular expression for the start of a string" 66.It "se str regular expression for the end of a string" 67.It "lb str regular expression for the start of a character constant" 68.It "le str regular expression for the end of a character constant" 69.It "nc str regular expression for a non-comment (see below)" 70.It "tl bool present means procedures are only defined at the top lexical level" 71.It "oc bool present means upper and lower case are equivalent" 72.It "kw str a list of keywords separated by spaces" 73.El 74.Pp 75Non-comments are required to describe a certain context where a 76sequence that would normally start a comment loses its special 77meaning. A typical example for this can be found in Perl, where 78comments are normally starting with 79.Ql # , 80while the string 81.Ql $# 82is an operator on an array. 83.Sh EXAMPLES 84The following entry, which describes the C language, is 85typical of a language entry. 86.Bd -literal 87C|c:\ 88:pb=^\ed?*?\ed?\ep\ed?\e(\ea?\e):bb={:be=}:cb=/*:ce=*/:sb=":se=\ee":\e 89:lb=':le=\ee':tl:\e 90:kw=asm auto break case char continue default do double else enum\e 91extern float for fortran goto if int long register return short\e 92sizeof static struct switch typedef union unsigned while #define\e 93#else #endif #if #ifdef #ifndef #include #undef # define else endif\e 94if ifdef ifndef include undef: 95.Ed 96.Pp 97Note that the first field is just the language name (and any variants 98of it). Thus the C language could be specified to 99.Xr vgrind 1 100as "c" or "C". 101.Pp 102Entries may continue onto multiple lines by giving a \e as the last 103character of a line. 104Capabilities in 105.Nm vgrindefs 106are of two types: 107Boolean capabilities which indicate that the language has 108some particular feature 109and string 110capabilities which give a regular expression or 111keyword list. 112.Sh REGULAR EXPRESSIONS 113.Nm Vgrindefs 114uses regular expression which are very similar to those of 115.Xr ex 1 116and 117.Xr lex 1 . 118The characters `^', `$', `:' and `\e' 119are reserved characters and must be 120"quoted" with a preceding 121.Ql \e 122if they 123are to be included as normal characters. 124The metasymbols and their meanings are: 125.Bl -tag -width indent 126.It $ 127the end of a line 128.It \&^ 129the beginning of a line 130.It \ed 131a delimiter (space, tab, newline, start of line) 132.It \ea 133matches any string of symbols (like .* in lex) 134.It \ep 135matches any alphanumeric name. In a procedure definition (pb) the string 136that matches this symbol is used as the procedure name. 137.It () 138grouping 139.It \&| 140alternation 141.It ? 142last item is optional 143.It \ee 144preceding any string means that the string will not match an 145input string if the input string is preceded by an escape character (\e). 146This is typically used for languages (like C) which can include the 147string delimiter in a string by escaping it. 148.El 149.Pp 150Unlike other regular expressions in the system, these match words 151and not characters. Hence something like "(tramp|steamer)flies?" 152would match "tramp", "steamer", "trampflies", or "steamerflies". 153.Sh KEYWORD LIST 154The keyword list is just a list of keywords in the language separated 155by spaces. If the "oc" boolean is specified, indicating that upper 156and lower case are equivalent, then all the keywords should be 157specified in lower case. 158.Sh FILES 159.Bl -tag -width /usr/share/misc/vgrindefs -compact 160.It Pa /usr/share/misc/vgrindefs 161File containing terminal descriptions. 162.El 163.Sh SEE ALSO 164.Xr troff 1 , 165.Xr vgrind 1 166.Sh HISTORY 167The 168.Nm 169file format appeared in 170.Bx 4.2 . 171