@@ -1,4 +1,4 @@ -Copyright (c) 2008 Robert Virding. All rights reserved. +Copyright (c) 2008,2009 Robert Virding. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions COPYRIGHT @@ -24,29 +24,61 @@ EXPORTS file(FileName) -> ok | error file(FileName, Options) -> ok | error + Generate a lexical analyzer from the definition in the input + file. The input file has the extension .xrl. This is added to + the filename if it is not given. The resulting module is the + Xrl filename without the .xrl extension. + The current options are: + dfa_graph + generate a .dot file which contains a desciption of + the DFA in a format which can be viewd with Graphviz, + www.graphviz.com + {includefile,File} Use a specific or customised prologue file instead of default leex/include/leexinc.hrl which is otherwise included. - {outdir,Dir} - generate the scanner file in directory Dir + {report_errors, bool()} + Causes errors to be printed as they occur. Default is + true. - dfa_graph - generate a .dot file which contains a desciption of - the DFA in a format which can be viewd with Graphviz, - www.graphviz.com + {report_warnings, bool()} + Causes warnings to be printed as they occur. Default + is true. + + {report, bool()} + This is a short form for both report_errors and + report_warnings. + + {return_errors, bool()} + If this flag is set, {error, Errors, Warnings} is + returned when there are errors. Default is false. + + {return_warnings, bool()} + If this flag is set, an extra field containing + Warnings is added to the tuple returned upon + success. Default is false. + + {return, bool()} + This is a short form for both return_errors and + return_warnings. - verbose - Output information from parsing the input file and + {scannerfile, ScannerFile} + ScannerFile is the name of the file that will contain + the Erlang scanner code that is generated. The default + ("") is to add the extension .erl to FileName stripped + of the .xrl extension. + + {verbose,bool()} + Outputs information from parsing the input file and generating the internal tables. - Generate a lexical analyzer from the definition in the input - file. The input file has the extension .xrl. This is added to - the filename if it is not given. The resulting module is the - Xrl filename without the .xrl extension. + Any of the Boolean options can be set to true by stating the + name of the option. For example, verbose is equivalent to + {verbose, true}. GENERATED SCANNER EXPORTS @@ -262,6 +294,10 @@ Regular Expressions delete \ddd the octal value ddd + \xhh + the hexadecimal value hh + \x{h...} + the hexadecimal value h... \c any other character literally, for example \\ for backslash, \" for ") @@ -276,9 +312,9 @@ Regular Expressions N.B. Anchoring a regular expression with ^ and $ is not implemented in the current version of leex and just generates - a nasty error. + a parse error. AUTHORS Robert Virding - rvirding@gmail.com - Copyright © 2008 Robert Virding + Copyright © 2008,2009 Robert Virding doc/leex.txt @@ -8,7 +8,7 @@ <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> - Copyright (c) 2008 Robert Virding. All rights reserved. + Copyright (c) 2008,2009 Robert Virding. All rights reserved. </legalnotice> <title>leex</title> @@ -450,6 +450,6 @@ Floats (\\+|-)?[0-9]+\\.[0-9]+((E|e)(\\+|-)?[0-9]+)?</code> <note><p>Anchoring a regular expression with <c>^</c> and <c>$</c> is not implemented in the current version of Leex and just - generates an error.</p></note> + generates a parse error.</p></note> </section> </erlref> doc/src/leex.xml ebin/leex.beam @@ -1,4 +1,4 @@ -%% Copyright (c) 2008 Robert Virding. All rights reserved. +%% Copyright (c) 2008,2009 Robert Virding. All rights reserved. %% %% Redistribution and use in source and binary forms, with or without %% modification, are permitted provided that the following conditions src/leex.erl 16403a853a7c92872c3c28dc3e9419bb7233982a Robert Virding rvirding@gmail.com http://github.com/rvirding/leex/commit/5b716f43e534551234a8accb0369e10948813a64 5b716f43e534551234a8accb0369e10948813a64 2009-09-12T07:49:49-07:00 2009-09-12T07:49:49-07:00 Minor fixes to documentation and copyright dates. 4b68f20e8d257150fd0b4c4e8e7e1a8b618a5765 Robert Virding rvirding@gmail.com