usr.bin/vgrind/vgrindefs.5

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