FLEX.1
上传用户:datang2001
上传日期:2007-02-01
资源大小:53269k
文件大小:25k
源码类别:

操作系统开发

开发平台:

C/C++

  1. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  2. NAME
  3.      flex, lex - fast lexical analyzer generator
  4. SYNOPSIS
  5.      flex [-bcdfinpstvFILT8 -C[efmF] -Sskeleton] [filename ...]
  6. DESCRIPTION
  7.      flex is a tool for generating scanners: programs which recognized lexical
  8.      patterns  in  text.   flex  reads  the given input files, or its standard
  9.      input if no file names are given, for  a  description  of  a  scanner  to
  10.      generate.  The description is in the form of pairs of regular expressions
  11.      and C code, called rules. flex generates  as  output  a  C  source  file,
  12.      lex.yy.c,  which  defines  a  routine  yylex(). This file is compiled and
  13.      linked with  the  -lfl  library  to  produce  an  executable.   When  the
  14.      executable  is  run, it analyzes its input for occurrences of the regular
  15.      expressions.  Whenever it finds one,  it  executes  the  corresponding  C
  16.      code.
  17.      For full documentation, see flexdoc(1). This manual entry is intended for
  18.      use as a quick reference.
  19. OPTIONS
  20.      flex has the following options:
  21.      -b   Generate backtracking information to lex.backtrack. This is  a  list
  22.           of   scanner   states  which  require  backtracking  and  the  input
  23.           characters on which they do so.  By  adding  rules  one  can  remove
  24.           backtracking  states.  If all backtracking states are eliminated and
  25.           -f or -F is used, the generated scanner will run faster.
  26.      -c   is a do-nothing, deprecated option included for POSIX compliance.
  27.           NOTE: in previous releases of flex  -c  specified  table-compression
  28.           options.   This  functionality is now given by the -C flag.  To ease
  29.           the the impact of this change, when flex encounters -c, it currently
  30.           issues  a  warning  message and assumes that -C was desired instead.
  31.           In the future this "promotion" of -c to -C will go away in the  name
  32.           of  full  POSIX  compliance  (unless  the  POSIX  meaning is removed
  33.           first).
  34.      -d   makes the generated scanner run in debug mode.  Whenever  a  pattern
  35.           is recognized and the global yy_flex_debug is non-zero (which is the
  36.           default), the scanner will write to stderr a line of the form:
  37.               --accepting rule at line 53 ("the matched text")
  38.           The line number refers to the location  of  the  rule  in  the  file
  39.           defining  the  scanner  (i.e.,  the  file  that  was  fed  to flex).
  40.           Messages are also generated when the scanner backtracks, accepts the
  41.           default  rule,  reaches the end of its input buffer (or encounters a
  42.                                  26 May 1990                                 1
  43. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  44.           NUL; the two look the same as far as the  scanner's  concerned),  or
  45.           reaches an end-of-file.
  46.      -f   specifies (take your pick) full table  or  fast  scanner.  No  table
  47.           compression  is done.  The result is large but fast.  This option is
  48.           equivalent to -Cf (see below).
  49.      -i   instructs flex to generate a case-insensitive scanner.  The case  of
  50.           letters given in the flex input patterns will be ignored, and tokens
  51.           in the input will be matched regardless of case.  The  matched  text
  52.           given  in  yytext will have the preserved case (i.e., it will not be
  53.           folded).
  54.      -n   is another do-nothing, deprecated option  included  only  for  POSIX
  55.           compliance.
  56.      -p   generates a performance report to stderr.  The  report  consists  of
  57.           comments  regarding features of the flex input file which will cause
  58.           a loss of performance in the resulting scanner.
  59.      -s   causes the default rule (that unmatched scanner input is  echoed  to
  60.           stdout) to be suppressed.  If the scanner encounters input that does
  61.           not match any of its rules, it aborts with an error.
  62.      -t   instructs flex to write the scanner it generates to standard  output
  63.           instead of lex.yy.c.
  64.      -v   specifies that flex should write to stderr a summary  of  statistics
  65.           regarding the scanner it generates.
  66.      -F   specifies that the fast scanner table representation should be used.
  67.           This   representation   is   about   as   fast  as  the  full  table
  68.           representation  (-f),  and  for  some  sets  of  patterns  will   be
  69.           considerably  smaller  (and for others, larger).  See flexdoc(1) for
  70.           details.
  71.           This option is equivalent to -CF (see below).
  72.      -I   instructs flex to  generate  an  interactive  scanner,  that  is,  a
  73.           scanner  which  stops  immediately  rather  than looking ahead if it
  74.           knows that the currently scanned text cannot be  part  of  a  longer
  75.           rule's match.  Again, see flexdoc(1) for details.
  76.           Note, -I cannot be used in conjunction with  full  or  fast  tables,
  77.           i.e., the -f, -F, -Cf, or -CF flags.
  78.      -L   instructs flex not to generate #line  directives  in  lex.yy.c.  The
  79.           default  is  to  generate  such  directives so error messages in the
  80.           actions will be correctly located with respect to the original  flex
  81.           input  file,  and  not  to  the  fairly  meaningless line numbers of
  82.                                  26 May 1990                                 2
  83. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  84.           lex.yy.c.
  85.      -T   makes flex run in trace mode.  It will generate a lot of messages to
  86.           stdout  concerning  the  form  of  the  input and the resultant non-
  87.           deterministic and deterministic finite  automata.   This  option  is
  88.           mostly for use in maintaining flex.
  89.      -8   instructs flex to generate an 8-bit scanner.  On some sites, this is
  90.           the  default.   On  others, the default is 7-bit characters.  To see
  91.           which is the case, check the verbose (-v)  output  for  "equivalence
  92.           classes  created".   If  the denominator of the number shown is 128,
  93.           then by default flex is generating 7-bit characters.  If it is  256,
  94.           then the default is 8-bit characters.
  95.      -C[efmF]
  96.           controls the degree of table compression.
  97.           -Ce directs flex to construct equivalence  classes,  i.e.,  sets  of
  98.           characters  which  have  identical  lexical properties.  Equivalence
  99.           classes usually give dramatic reductions in the  final  table/object
  100.           file  sizes  (typically  a  factor  of  2-5)  and  are  pretty cheap
  101.           performance-wise (one array look-up per character scanned).
  102.           -Cf specifies that the full scanner tables  should  be  generated  -
  103.           flex  should not compress the tables by taking advantages of similar
  104.           transition functions for different states.
  105.           -CF  specifies  that  the  alternate  fast  scanner   representation
  106.           (described in flexdoc(1)) should be used.
  107.           -Cm directs flex to construct meta-equivalence  classes,  which  are
  108.           sets  of  equivalence classes (or characters, if equivalence classes
  109.           are  not  being  used)  that  are  commonly  used  together.   Meta-
  110.           equivalence  classes  are  often  a  big  win  when using compressed
  111.           tables, but they have a moderate performance impact (one or two "if"
  112.           tests and one array look-up per character scanned).
  113.           A lone -C specifies that the scanner tables should be compressed but
  114.           neither  equivalence  classes nor meta-equivalence classes should be
  115.           used.
  116.           The options -Cf or -CF and -Cm do not make sense together - there is
  117.           no  opportunity  for  meta-equivalence  classes  if the table is not
  118.           being compressed.  Otherwise the options may be freely mixed.
  119.           The default setting  is  -Cem,  which  specifies  that  flex  should
  120.           generate  equivalence  classes  and  meta-equivalence classes.  This
  121.           setting provides the highest degree of table compression.   You  can
  122.           trade  off  faster-executing  scanners  at the cost of larger tables
  123.           with the following generally being true:
  124.                                  26 May 1990                                 3
  125. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  126.               slowest & smallest
  127.                     -Cem
  128.                     -Cm
  129.                     -Ce
  130.                     -C
  131.                     -C{f,F}e
  132.                     -C{f,F}
  133.               fastest & largest
  134.           -C options are not cumulative; whenever the flag is encountered, the
  135.           previous -C settings are forgotten.
  136.      -Sskeleton_file
  137.           overrides the default skeleton file from which flex  constructs  its
  138.           scanners.   You'll  never need this option unless you are doing flex
  139.           maintenance or development.
  140. SUMMARY OF FLEX REGULAR EXPRESSIONS
  141.      The patterns in the input are written using an extended  set  of  regular
  142.      expressions.  These are:
  143.          x          match the character 'x'
  144.          .          any character except newline
  145.          [xyz]      a "character class"; in this case, the pattern
  146.                       matches either an 'x', a 'y', or a 'z'
  147.          [abj-oZ]   a "character class" with a range in it; matches
  148.                       an 'a', a 'b', any letter from 'j' through 'o',
  149.                       or a 'Z'
  150.          [^A-Z]     a "negated character class", i.e., any character
  151.                       but those in the class.  In this case, any
  152.                       character EXCEPT an uppercase letter.
  153.          [^A-Zn]   any character EXCEPT an uppercase letter or
  154.                       a newline
  155.          r*         zero or more r's, where r is any regular expression
  156.          r+         one or more r's
  157.          r?         zero or one r's (that is, "an optional r")
  158.          r{2,5}     anywhere from two to five r's
  159.          r{2,}      two or more r's
  160.          r{4}       exactly 4 r's
  161.          {name}     the expansion of the "name" definition
  162.                     (see above)
  163.          "[xyz]"foo"
  164.                     the literal string: [xyz]"foo
  165.          X         if X is an 'a', 'b', 'f', 'n', 'r', 't', or 'v',
  166.                       then the ANSI-C interpretation of x.
  167.                       Otherwise, a literal 'X' (used to escape
  168.                       operators such as '*')
  169.          123       the character with octal value 123
  170.          x2a       the character with hexadecimal value 2a
  171.                                  26 May 1990                                 4
  172. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  173.          (r)        match an r; parentheses are used to override
  174.                       precedence (see below)
  175.          rs         the regular expression r followed by the
  176.                       regular expression s; called "concatenation"
  177.          r|s        either an r or an s
  178.          r/s        an r but only if it is followed by an s.  The
  179.                       s is not part of the matched text.  This type
  180.                       of pattern is called as "trailing context".
  181.          ^r         an r, but only at the beginning of a line
  182.          r$         an r, but only at the end of a line.  Equivalent
  183.                       to "r/n".
  184.          <s>r       an r, but only in start condition s (see
  185.                     below for discussion of start conditions)
  186.          <s1,s2,s3>r
  187.                     same, but in any of start conditions s1,
  188.                     s2, or s3
  189.          <<EOF>>    an end-of-file
  190.          <s1,s2><<EOF>>
  191.                     an end-of-file when in start condition s1 or s2
  192.      The regular expressions listed above are grouped according to precedence,
  193.      from  highest  precedence  at  the  top  to  lowest at the bottom.  Those
  194.      grouped together have equal precedence.
  195.      Some notes on patterns:
  196.      -    Negated  character  classes  match  newlines  unless  "n"  (or   an
  197.           equivalent  escape  sequence)  is  one  of the characters explicitly
  198.           present in the negated character class (e.g., "[^A-Zn]").
  199.      -    A rule can have at most one instance of trailing  context  (the  '/'
  200.           operator  or  the  '$'  operator).   The  start  condition, '^', and
  201.           "<<EOF>>" patterns can only occur at the  beginning  of  a  pattern,
  202.           and,  as  well  as  with  '/'  and  '$',  cannot  be  grouped inside
  203.           parentheses.  The following are all illegal:
  204.               foo/bar$
  205.               foo|(bar$)
  206.               foo|^bar
  207.               <sc1>foo<sc2>bar
  208.                                  26 May 1990                                 5
  209. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  210. SUMMARY OF SPECIAL ACTIONS
  211.      In addition to arbitrary C code, the following can appear in actions:
  212.      -    ECHO copies yytext to the scanner's output.
  213.      -    BEGIN followed by the name of a start condition places  the  scanner
  214.           in the corresponding start condition.
  215.      -    REJECT directs the scanner to proceed on to the "second  best"  rule
  216.           which  matched  the  input  (or  a prefix of the input).  yytext and
  217.           yyleng are set up appropriately.  Note that REJECT is a particularly
  218.           expensive feature in terms scanner performance; if it is used in any
  219.           of the scanner's actions it will slow  down  all  of  the  scanner's
  220.           matching.   Furthermore,  REJECT  cannot  be  used with the -f or -F
  221.           options.
  222.           Note also that unlike the other special actions, REJECT is a branch;
  223.           code immediately following it in the action will not be executed.
  224.      -    yymore() tells the scanner that the next time it matches a rule, the
  225.           corresponding  token  should  be  appended onto the current value of
  226.           yytext rather than replacing it.
  227.      -    yyless(n) returns all but the first  n  characters  of  the  current
  228.           token  back  to  the input stream, where they will be rescanned when
  229.           the scanner looks  for  the  next  match.   yytext  and  yyleng  are
  230.           adjusted appropriately (e.g., yyleng will now be equal to n ).
  231.      -    unput(c) puts the character c back onto the input stream.   It  will
  232.           be the next character scanned.
  233.      -    input() reads the next character from the input stream (this routine
  234.           is called yyinput() if the scanner is compiled using C++).
  235.      -    yyterminate() can be used in  lieu  of  a  return  statement  in  an
  236.           action.   It terminates the scanner and returns a 0 to the scanner's
  237.           caller, indicating "all done".
  238.           By default, yyterminate() is also  called  when  an  end-of-file  is
  239.           encountered.  It is a macro and may be redefined.
  240.      -    YY_NEW_FILE is an action available only in <<EOF>> rules.  It  means
  241.           "Okay, I've set up a new input file, continue scanning".
  242.      -    yy_create_buffer( file, size ) takes a FILE pointer and  an  integer
  243.           size.  It  returns  a  YY_BUFFER_STATE  handle to a new input buffer
  244.           large enough to accomodate size characters and associated  with  the
  245.           given file.  When in doubt, use YY_BUF_SIZE for the size.
  246.                                  26 May 1990                                 6
  247. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  248.      -    yy_switch_to_buffer( new_buffer ) switches the scanner's  processing
  249.           to  scan  for  tokens  from  the  given  buffer,  which  must  be  a
  250.           YY_BUFFER_STATE.
  251.      -    yy_delete_buffer( buffer ) deletes the given buffer.
  252. VALUES AVAILABLE TO THE USER
  253.      -    char *yytext holds the text of the current token.   It  may  not  be
  254.           modified.
  255.      -    int yyleng holds the length of the current token.   It  may  not  be
  256.           modified.
  257.      -    FILE *yyin is the file which by default flex reads from.  It may  be
  258.           redefined  but  doing  so  only  makes sense before scanning begins.
  259.           Changing it in the middle of scanning will have  unexpected  results
  260.           since  flex  buffers its input.  Once scanning terminates because an
  261.           end-of-file has been seen, void yyrestart( FILE *new_file )  may  be
  262.           called to point yyin at the new input file.
  263.      -    FILE *yyout is the file to which ECHO actions are done.  It  can  be
  264.           reassigned by the user.
  265.      -    YY_CURRENT_BUFFER returns a YY_BUFFER_STATE handle  to  the  current
  266.           buffer.
  267. MACROS THE USER CAN REDEFINE
  268.      -    YY_DECL controls how the scanning routine is declared.  By  default,
  269.           it  is  "int  yylex()",  or,  if  prototypes  are  being  used, "int
  270.           yylex(void)".  This definition may  be  changed  by  redefining  the
  271.           "YY_DECL"  macro.   Note  that if you give arguments to the scanning
  272.           routine using a K&R-style/non-prototyped function  declaration,  you
  273.           must terminate the definition with a semi-colon (;).
  274.      -    The nature of how the scanner gets its input can  be  controlled  by
  275.           redefining  the  YY_INPUT  macro.   YY_INPUT's  calling  sequence is
  276.           "YY_INPUT(buf,result,max_size)".  Its  action  is  to  place  up  to
  277.           max_size  characters  in  the  character array buf and return in the
  278.           integer variable result either the number of characters read or  the
  279.           constant  YY_NULL  (0 on Unix systems) to indicate EOF.  The default
  280.           YY_INPUT reads  from  the  global  file-pointer  "yyin".   A  sample
  281.           redefinition  of  YY_INPUT  (in the definitions section of the input
  282.           file):
  283.               %{
  284.               #undef YY_INPUT
  285.               #define YY_INPUT(buf,result,max_size) 
  286.                   { 
  287.                                  26 May 1990                                 7
  288. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  289.                   int c = getchar(); 
  290.                   result = (c == EOF) ? YY_NULL : (buf[0] = c, 1); 
  291.                   }
  292.               %}
  293.      -    When the scanner receives an end-of-file indication  from  YY_INPUT,
  294.           it  then  checks  the  yywrap() function.  If yywrap() returns false
  295.           (zero), then it is assumed that the function has gone ahead and  set
  296.           up  yyin to point to another input file, and scanning continues.  If
  297.           it returns true (non-zero), then the scanner terminates, returning 0
  298.           to its caller.
  299.           The default yywrap() always returns 1.  Presently,  to  redefine  it
  300.           you  must first "#undef yywrap", as it is currently implemented as a
  301.           macro.  It is likely that yywrap() will soon  be  defined  to  be  a
  302.           function rather than a macro.
  303.      -    YY_USER_ACTION can be redefined to provide an action which is always
  304.           executed prior to the matched rule's action.
  305.      -    The macro YY_USER_INIT may be redefined to provide an  action  which
  306.           is always executed before the first scan.
  307.      -    In the generated scanner, the actions are all gathered in one  large
  308.           switch   statement  and  separated  using  YY_BREAK,  which  may  be
  309.           redefined.  By default, it is simply a  "break",  to  separate  each
  310.           rule's action from the following rule's.
  311. FILES
  312.      flex.skel
  313.           skeleton scanner.
  314.      lex.yy.c
  315.           generated scanner (called lexyy.c on some systems).
  316.      lex.backtrack
  317.           backtracking  information  for  -b  flag  (called  lex.bck  on  some
  318.           systems).
  319.      -lfl library with which to link the scanners.
  320. SEE ALSO
  321.      flexdoc(1), lex(1), yacc(1), sed(1), awk(1).
  322.      M. E. Lesk and E. Schmidt, LEX - Lexical Analyzer Generator
  323.                                  26 May 1990                                 8
  324. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  325. DIAGNOSTICS
  326.      reject_used_but_not_detected undefined or
  327.      yymore_used_but_not_detected  undefined  -  These  errors  can  occur  at
  328.      compile time.  They indicate that the scanner uses REJECT or yymore() but
  329.      that flex failed to notice the fact, meaning that flex scanned the  first
  330.      two  sections looking for occurrences of these actions and failed to find
  331.      any, but somehow you snuck some in (via a #include  file,  for  example).
  332.      Make  an explicit reference to the action in your flex input file.  (Note
  333.      that previously flex supported a %used/%unused mechanism for dealing with
  334.      this  problem;  this  feature  is still supported but now deprecated, and
  335.      will go away soon unless the author  hears  from  people  who  can  argue
  336.      compellingly that they need it.)
  337.      flex scanner jammed - a scanner compiled with -s has encountered an input
  338.      string which wasn't matched by any of its rules.
  339.      flex input buffer overflowed - a  scanner  rule  matched  a  string  long
  340.      enough  to  overflow  the  scanner's  internal  input buffer (16K bytes -
  341.      controlled by YY_BUF_MAX in "flex.skel").
  342.      scanner  requires  -8  flag  -  Your   scanner   specification   includes
  343.      recognizing  8-bit  characters  and  you did not specify the -8 flag (and
  344.      your site has not installed flex with -8 as the default).
  345.      fatal flex scanner internal error--end of buffer missed - This can  occur
  346.      in  an  scanner  which  is reentered after a long-jump has jumped out (or
  347.      over) the scanner's activation frame.   Before  reentering  the  scanner,
  348.      use:
  349.          yyrestart( yyin );
  350.      too many %t classes! - You managed to put every single character into its
  351.      own  %t  class.   flex  requires  that  at least one of the classes share
  352.      characters.
  353. AUTHOR
  354.      Vern Paxson, with the help of many ideas and much  inspiration  from  Van
  355.      Jacobson.  Original version by Jef Poskanzer.
  356.      See flexdoc(1) for additional credits and the address  to  send  comments
  357.      to.
  358. DEFICIENCIES / BUGS
  359.      Some trailing context patterns cannot be properly  matched  and  generate
  360.      warning  messages  ("Dangerous  trailing  context").   These are patterns
  361.      where the ending of the first part of the rule matches the  beginning  of
  362.      the second part, such as "zx*/xy*", where the 'x*' matches the 'x' at the
  363.                                  26 May 1990                                 9
  364. FLEX(1)                   Minix Programmer's Manual                    FLEX(1)
  365.      beginning of the trailing context.  (Note that  the  POSIX  draft  states
  366.      that the text matched by such patterns is undefined.)
  367.      For some trailing context rules, parts which  are  actually  fixed-length
  368.      are  not  recognized  as  such, leading to the abovementioned performance
  369.      loss.  In particular, parts using '|'  or  {n}  (such  as  "foo{3}")  are
  370.      always considered variable-length.
  371.      Combining trailing context with the special  '|'  action  can  result  in
  372.      fixed  trailing  context  being  turned  into the more expensive variable
  373.      trailing context.  For example, this happens in the following example:
  374.          %%
  375.          abc      |
  376.          xyz/def
  377.      Use of unput() invalidates yytext and yyleng.
  378.      Use of unput() to push back more text than was matched can result in  the
  379.      pushed-back  text  matching a beginning-of-line ('^') rule even though it
  380.      didn't come at the beginning of the line (though this is rare!).
  381.      Pattern-matching of NUL's is substantially  slower  than  matching  other
  382.      characters.
  383.      flex does not generate correct #line directives for code internal to  the
  384.      scanner; thus, bugs in flex.skel yield bogus line numbers.
  385.      Due to both buffering of input and read-ahead, you cannot intermix  calls
  386.      to  <stdio.h>  routines, such as, for example, getchar(), with flex rules
  387.      and expect it to work.  Call input() instead.
  388.      The total table entries listed by the -v  flag  excludes  the  number  of
  389.      table entries needed to determine what rule has been matched.  The number
  390.      of entries is equal to the number of DFA states if the scanner  does  not
  391.      use REJECT, and somewhat greater than the number of states if it does.
  392.      REJECT cannot be used with the -f or -F options.
  393.      Some of the macros, such as yywrap(), may in the future become  functions
  394.      which live in the -lfl library.  This will doubtless break a lot of code,
  395.      but may be required for POSIX-compliance.
  396.      The flex internal algorithms need documentation.
  397.                                 26 May 1990                                 10