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