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