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