Generic module providing useful primitives
Author: David Lutterkort
| Util | Generic module providing useful primitives |
| License | This file is licensed under the LGPLv2+, like the rest of Augeas. |
| del_str | Delete a string and default to it |
| del_ws | Delete mandatory whitespace |
| del_ws_spc | Delete mandatory whitespace, default to single space |
| del_ws_tab | Delete mandatory whitespace, default to single tab |
| del_opt_ws | Delete optional whitespace |
| eol | Delete end of line, including optional trailing whitespace |
| doseol | Delete end of line with optional carriage return, including optional trailing whitespace |
| indent | Delete indentation, including leading whitespace |
| Comment | This is a general definition of comment It allows indentation for comments, removes the leading and trailing spaces of comments and stores them in nodes, except for empty comments which are ignored together with empty lines |
| comment_generic_seteol | Map comments and set default comment sign |
| comment_generic | Map comments and set default comment sign |
| comment | Map comments into “#comment” nodes |
| comment_noindent | Map comments into “#comment” nodes, without indentation |
| comment_eol | Map eol comments into “#comment” nodes Add a space before # for end of line comments |
| comment_or_eol | A comment_eol or eol, with an optional empty comment |
| comment_multiline | A C-style multiline comment |
| comment_c_style | A comment line, C-style |
| empty_generic | A generic definition of empty Map empty lines, including empty comments |
| empty_generic_re | |
| empty | Map empty lines, including empty comments |
| empty_c_style | Map empty lines, including C-style empty comment |
| empty_generic_dos | A generic definition of empty with dos newlines Map empty lines, including empty comments |
| empty_dos | |
| Split | |
| delim | |
| Exclusions | |
| stdexcl | Exclusion for files that are commonly not wanted/needed |
let comment_or_eol = comment_eol | (del /[ \t]*(#[ \t]*)?\n/ "\n")
A comment_eol or eol, with an optional empty comment
let comment_multiline = let mline_re = (/[^ \t\r\n].*[^ \t\r\n]|[^ \t\r\n]/ - /.*\*\/.*/) in let mline = [ seq "mline" . del /[ \t\r\n]*/ "\n" . store mline_re ] in [ label "#mcomment" . del /[ \t]*\/\*/ "/*" . counter "mline" . mline . (eol . mline)* . del /[ \t\r\n]*\*\/[ \t]*\r?\n/ "\n*/\n" ]
A C-style multiline comment
let empty_generic (r:regexp) = [ del r "" . del_str "\n" ]
A generic definition of empty Map empty lines, including empty comments
let empty_generic_dos (r:regexp) = [ del r "" . del /\r?\n/ "\n" ]
A generic definition of empty with dos newlines Map empty lines, including empty comments
let stdexcl = (excl "*~") . (excl "*.rpmnew") . (excl "*.rpmsave") . (excl "*.dpkg-old") . (excl "*.dpkg-new") . (excl "*.dpkg-bak") . (excl "*.dpkg-dist") . (excl "*.augsave") . (excl "*.augnew") . (excl "*.bak") . (excl "*.old") . (excl "#*#")
Exclusion for files that are commonly not wanted/needed
Delete a string and default to it
let del_str (s:string) = del s s
Delete mandatory whitespace
let del_ws = del /[ \t]+/
Delete mandatory whitespace, default to single space
let del_ws_spc = del_ws " "
Delete mandatory whitespace, default to single tab
let del_ws_tab = del_ws "\t"
Delete optional whitespace
let del_opt_ws = del /[ \t]*/
Delete end of line, including optional trailing whitespace
let eol = del /[ \t]*\n/ "\n"
Delete end of line with optional carriage return, including optional trailing whitespace
let doseol = del /[ \t]*\r?\n/ "\n"
Delete indentation, including leading whitespace
let indent = del /[ \t]*/ ""
Map comments and set default comment sign
let comment_generic_seteol (r:regexp) (d:string) (eol:lens) = [ label "#comment" . del r d . store /([^ \t\r\n].*[^ \t\r\n]|[^ \t\r\n])/ . eol ]
Map comments and set default comment sign
let comment_generic (r:regexp) (d:string) = comment_generic_seteol r d doseol
Map comments into “#comment” nodes
let comment = comment_generic /[ \t]*#[ \t]*/ "# "
Map comments into “#comment” nodes, without indentation
let comment_noindent = comment_generic /#[ \t]*/ "# "
Map eol comments into “#comment” nodes Add a space before # for end of line comments
let comment_eol = comment_generic /[ \t]*#[ \t]*/ " # "
A comment_eol or eol, with an optional empty comment
let comment_or_eol = comment_eol | (del /[ \t]*(#[ \t]*)?\n/ "\n")
A C-style multiline comment
let comment_multiline = let mline_re = (/[^ \t\r\n].*[^ \t\r\n]|[^ \t\r\n]/ - /.*\*\/.*/) in let mline = [ seq "mline" . del /[ \t\r\n]*/ "\n" . store mline_re ] in [ label "#mcomment" . del /[ \t]*\/\*/ "/*" . counter "mline" . mline . (eol . mline)* . del /[ \t\r\n]*\*\/[ \t]*\r?\n/ "\n*/\n" ]
A comment line, C-style
let comment_c_style = comment_generic /[ \t]*\/\/[ \t]*/ "// "
A generic definition of empty Map empty lines, including empty comments
let empty_generic (r:regexp) = [ del r "" . del_str "\n" ]
Map empty lines, including empty comments
let empty = empty_generic empty_generic_re
let empty_generic_re = /[ \t]*#?[ \t]*/
Map empty lines, including C-style empty comment
let empty_c_style = empty_generic /[ \t]*((\/\/)|(\/\*[ \t]*\*\/))?[ \t]*/
A generic definition of empty with dos newlines Map empty lines, including empty comments
let empty_generic_dos (r:regexp) = [ del r "" . del /\r?\n/ "\n" ]
let empty_dos = empty_generic_dos /[ \t]*#?[ \t]*/
let delim (op:string) = del (/[ \t]*/ . op . /[ \t]*/) (" " . op . " ")
Exclusion for files that are commonly not wanted/needed
let stdexcl = (excl "*~") . (excl "*.rpmnew") . (excl "*.rpmsave") . (excl "*.dpkg-old") . (excl "*.dpkg-new") . (excl "*.dpkg-bak") . (excl "*.dpkg-dist") . (excl "*.augsave") . (excl "*.augnew") . (excl "*.bak") . (excl "*.old") . (excl "#*#")