megaco_flex_scanner(3erl) [linux man page]
megaco_flex_scanner(3erl) Erlang Module Definition megaco_flex_scanner(3erl) NAME
megaco_flex_scanner - Interface module to the flex scanner linked in driver. DESCRIPTION
This module contains the public interface to the flex scanner linked in driver. The flex scanner performs the scanning phase of text mes- sage decoding. The flex scanner is written using a tool called flex . In order to be able to compile the flex scanner driver, this tool has to be avail- able. By default the flex scanner reports line-number of an error. But it can be built without line-number reporting. Instead token number is used. This will speed up the scanning some 5-10%. Use --disable-megaco-flex-scanner-lineno when configuring the application. The scanner will, by default, be built as a reentrant scanner if the flex utility supports this (it depends on the version of flex). It is possible to explicitly disable this even when flex support this. Use --disable-megaco-reentrant-flex-scanner when configuring the applica- tion. DATA TYPES
megaco_ports() = term() megaco_version() = integer() >= 1 EXPORTS
start() -> {ok, PortOrPorts} | {error, Reason} Types PortOrPorts = megaco_ports() Reason = term() This function is used to start the flex scanner. It locates the library and loads the linked in driver. On a single core system or if it's a non-reentrant scanner, a single port is created. On a multi-core system with a reentrant scan- ner, several ports will be created (one for each scheduler). Note that the process that calls this function must be permanent. If it dies, the port(s) will exit and the driver unload. stop(PortOrPorts) -> stopped Types PortOrPorts = megaco_ports() This function is used to stop the flex scanner. It also unloads the driver. is_reentrant_enabled() -> Boolean Types Boolean = boolean() Is the flex scanner reentrant or not. is_scanner_port(Port, PortOrPorts) -> Boolean Types Port = port() PortOrPorts = megaco_ports() Boolean = boolean() Checks if a port is a flex scanner port or not (useful when if a port exits). scan(Binary, PortOrPorts) -> {ok, Tokens, Version, LatestLine} | {error, Reason, LatestLine} Types Binary = binary() PortOrPorts = megaco_ports() Tokens = list() Version = megaco_version() LatestLine = integer() Reason = term() Scans a megaco message and generates a token list to be passed on the parser. Ericsson AB megaco 3.15.1 megaco_flex_scanner(3erl)
Check Out this Related Man Page
FLEX(1) User Commands FLEX(1) NAME
flex - the fast lexical analyser generator SYNOPSIS
flex [OPTIONS] [FILE]... DESCRIPTION
Generates programs that perform pattern-matching on text. Table Compression: -Ca, --align trade off larger tables for better memory alignment -Ce, --ecs construct equivalence classes -Cf do not compress tables; use -f representation -CF do not compress tables; use -F representation -Cm, --meta-ecs construct meta-equivalence classes -Cr, --read use read() instead of stdio for scanner input -f, --full generate fast, large scanner. Same as -Cfr -F, --fast use alternate table representation. Same as -CFr -Cem default compression (same as --ecs --meta-ecs) Debugging: -d, --debug enable debug mode in scanner -b, --backup write backing-up information to lex.backup -p, --perf-report write performance report to stderr -s, --nodefault suppress default rule to ECHO unmatched text -T, --trace flex should run in trace mode -w, --nowarn do not generate warnings -v, --verbose write summary of scanner statistics to stdout Files: -o, --outfile=FILE specify output filename -S, --skel=FILE specify skeleton file -t, --stdout write scanner on stdout instead of lex.yy.c --yyclass=NAME name of C++ class --header-file=FILE create a C header file in addition to the scanner --tables-file[=FILE] write tables to FILE Scanner behavior: -7, --7bit generate 7-bit scanner -8, --8bit generate 8-bit scanner -B, --batch generate batch scanner (opposite of -I) -i, --case-insensitive ignore case in patterns -l, --lex-compat maximal compatibility with original lex -X, --posix-compat maximal compatibility with POSIX lex -I, --interactive generate interactive scanner (opposite of -B) --yylineno track line count in yylineno Generated code: -+, --c++ generate C++ scanner class -Dmacro[=defn] #define macro defn (default defn is '1') -L, --noline suppress #line directives in scanner -P, --prefix=STRING use STRING as prefix instead of "yy" -R, --reentrant generate a reentrant C scanner --bison-bridge scanner for bison pure parser. --bison-locations include yylloc support. --stdinit initialize yyin/yyout to stdin/stdout --noansi-definitions old-style function definitions --noansi-prototypes empty parameter list in prototypes --nounistd do not include <unistd.h> --noFUNCTION do not generate a particular FUNCTION Miscellaneous: -c do-nothing POSIX option -n do-nothing POSIX option -? -h, --help produce this help message -V, --version report flex version SEE ALSO
The full documentation for flex is maintained as a Texinfo manual. If the info and flex programs are properly installed at your site, the command info flex should give you access to the complete manual. flex 2.5.35 February 2008 FLEX(1)