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.\" $FreeBSD$ 34.\" 35.Dd June 6, 1993 36.Dt VGRINDEFS 5 37.Os 38.Sh NAME 39.Nm vgrindefs 40.Nd language definition data base for 41.Xr vgrind 1 42.Sh SYNOPSIS 43.Nm 44.Sh DESCRIPTION 45The 46.Nm 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.It 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. 78A typical example for this can be found in Perl, where 79comments are normally starting with 80.Ql # , 81while the string 82.Ql $# 83is an operator on an array. 84.Sh REGULAR EXPRESSIONS 85.Nm Vgrindefs 86uses regular expression which are very similar to those of 87.Xr ex 1 88and 89.Xr lex 1 . 90The characters `^', `$', `:' and `\e' 91are reserved characters and must be 92"quoted" with a preceding 93.Ql \e 94if they 95are to be included as normal characters. 96The metasymbols and their meanings are: 97.Bl -tag -width indent 98.It $ 99the end of a line 100.It \&^ 101the beginning of a line 102.It \ed 103a delimiter (space, tab, newline, start of line) 104.It \ea 105matches any string of symbols (like .* in lex) 106.It \ep 107matches any alphanumeric name. 108In a procedure definition (pb) the string 109that matches this symbol is used as the procedure name. 110.It () 111grouping 112.It \&| 113alternation 114.It ? 115last item is optional 116.It \ee 117preceding any string means that the string will not match an 118input string if the input string is preceded by an escape character (\e). 119This is typically used for languages (like C) which can include the 120string delimiter in a string by escaping it. 121.El 122.Pp 123Unlike other regular expressions in the system, these match words 124and not characters. 125Hence something like "(tramp|steamer)flies?" 126would match "tramp", "steamer", "trampflies", or "steamerflies". 127.Sh KEYWORD LIST 128The keyword list is just a list of keywords in the language separated 129by spaces. 130If the "oc" boolean is specified, indicating that upper 131and lower case are equivalent, then all the keywords should be 132specified in lower case. 133.Sh FILES 134.Bl -tag -width /usr/share/misc/vgrindefs -compact 135.It Pa /usr/share/misc/vgrindefs 136File containing terminal descriptions. 137.El 138.Sh EXAMPLES 139The following entry, which describes the C language, is 140typical of a language entry. 141.Bd -literal 142C|c:\ 143:pb=^\ed?*?\ed?\ep\ed?\e(\ea?\e):bb={:be=}:cb=/*:ce=*/:sb=":se=\ee":\e 144:lb=':le=\ee':tl:\e 145:kw=asm auto break case char continue default do double else enum\e 146extern float for fortran goto if int long register return short\e 147sizeof static struct switch typedef union unsigned while #define\e 148#else #endif #if #ifdef #ifndef #include #undef # define else endif\e 149if ifdef ifndef include undef: 150.Ed 151.Pp 152Note that the first field is just the language name (and any variants 153of it). 154Thus the C language could be specified to 155.Xr vgrind 1 156as "c" or "C". 157.Pp 158Entries may continue onto multiple lines by giving a \e as the last 159character of a line. 160Capabilities in 161.Nm 162are of two types: 163Boolean capabilities which indicate that the language has 164some particular feature 165and string 166capabilities which give a regular expression or 167keyword list. 168.Sh SEE ALSO 169.Xr troff 1 , 170.Xr vgrind 1 171.Sh HISTORY 172The 173.Nm 174file format appeared in 175.Bx 4.2 . 176