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