From ef04b30d66196d2a2e682b42fadd885a4d19d7d8 Mon Sep 17 00:00:00 2001 From: Vitor Santos Costa Date: Tue, 1 May 2018 23:25:58 +0100 Subject: [PATCH] doc --- C/arrays.c | 8 +- C/atomic.c | 18 +- C/attvar.c | 9 + C/bb.c | 11 + C/bignum.c | 11 + C/cmppreds.c | 12 + C/dbase.c | 14 + C/eval.c | 15 +- C/exec.c | 20 +- C/flags.c | 4 + C/stack.c | 16 +- C/utilpreds.c | 5 +- H/YapGFlagInfo.h | 4 +- H/YapLFlagInfo.h | 5 +- OPTYap/opt.preds.c | 2 +- docs/CMakeLists.txt | 31 +- docs/Doxyfile.in | 28 +- docs/custom/customdoxygen.css | 220 +-- docs/custom/doxy-boot.js | 184 +-- docs/custom/footer.html | 23 +- docs/custom/header.html | 99 +- docs/md/INSTALL.md | 28 +- docs/md/attributes.md | 18 +- docs/md/builtins.md | 49 +- docs/md/c | 24 - docs/md/library.md | 56 +- docs/md/load_files.md | 3 +- docs/md/modules.md | 6 +- docs/md/run.md | 24 +- docs/md/swi.md | 9 +- include/YapErrors.h | 3 +- library/apply.yap | 49 +- library/apply_macros.yap | 4 +- library/lists.yap | 26 +- library/maplist.yap | 109 +- library/regex/cclass.h | 58 +- library/regex/cname.h | 207 +-- library/regex/engine.c | 8 + library/regex/regcomp.c | 2354 ++++++++++++++++----------------- library/regex/regerror.c | 150 ++- library/regex/regexp.c | 177 ++- library/regexp.yap | 32 +- library/rltree.yap | 57 +- library/rltree/range_list.c | 9 + library/rltree/range_list.h | 178 +-- library/sockets.yap | 41 +- library/timeout.yap | 4 +- library/trees.yap | 145 +- library/undgraphs.yap | 53 +- pl/builtins.yap | 2 +- pl/consult.yap | 11 +- pl/error.yap | 2 +- pl/listing.yap | 2 +- pl/newmod.yap | 10 +- pl/preds.yap | 2 +- pl/save.yap | 2 +- 56 files changed, 2229 insertions(+), 2422 deletions(-) delete mode 100644 docs/md/c diff --git a/C/arrays.c b/C/arrays.c index 635f1b3ec..7bb7aa43f 100644 --- a/C/arrays.c +++ b/C/arrays.c @@ -15,7 +15,13 @@ * * *************************************************************************/ -/** @defgroup YAPArrays Named Arrays +/** + +@file arrays.c + +@namespace prolog + +@addtogroup YAPArrays Named Arrays @ingroup extensions @{ diff --git a/C/atomic.c b/C/atomic.c index fdc89aefa..50eeee09b 100755 --- a/C/atomic.c +++ b/C/atomic.c @@ -1,4 +1,3 @@ - /************************************************************************* * * * YAP Prolog * @@ -22,15 +21,20 @@ static char SccsId[] = "%W% %G%"; /** * @file atomic.c * + * @namespace prolog + * +/ + +/** * @defgroup Predicates_on_Atoms Predicates on Atoms and Strings * @ingroup builtins * @{ - - @brief The following predicates are used to manipulate atoms, strings, lists of - codes and lists of chars: - - \toc - + * + * @brief The following predicates are used to manipulate atoms, strings, lists of + * codes and lists of chars: + * + * \toc + * */ #define HAS_CACHE_REGS 1 diff --git a/C/attvar.c b/C/attvar.c index 85b5ab0a8..19882b9a4 100644 --- a/C/attvar.c +++ b/C/attvar.c @@ -18,6 +18,15 @@ static char SccsId[] = "%W% %G%"; #endif +/** + * @file attvar.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:31:59 2018 + * + * @brief attributed variables + * @namespace prolog + * + */ #include "Yap.h" #include "Yatom.h" diff --git a/C/bb.c b/C/bb.c index 37ca03b72..18a8b8fb2 100644 --- a/C/bb.c +++ b/C/bb.c @@ -18,6 +18,17 @@ static char SccsId[] = "%W% %G%"; #endif +/** + * @file bb.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:32:54 2018 + * + * @brief blackboard + * + * @namespace prolog + * + */ + /** @defgroup BlackBoard The Blackboard @ingroup builtins diff --git a/C/bignum.c b/C/bignum.c index b9a3a46ef..2b51b408a 100644 --- a/C/bignum.c +++ b/C/bignum.c @@ -17,6 +17,17 @@ #ifdef SCCS static char SccsId[] = "%W% %G%"; #endif +/** + * @file bignum.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:34:59 2018 + * + * @brief BigNums and More + * @namespace prolog + * + * + * + */ #include "Yap.h" #include "Yatom.h" diff --git a/C/cmppreds.c b/C/cmppreds.c index 00dbee65b..7baa09762 100644 --- a/C/cmppreds.c +++ b/C/cmppreds.c @@ -16,6 +16,18 @@ * * *************************************************************************/ +/** + * @file cmppreds.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:35:58 2018 + * + * @brief comparison + * + * @namespace prolog + * + * + * + */ /// @file cmppreds.c /** diff --git a/C/dbase.c b/C/dbase.c index c01154760..9bbc370fa 100644 --- a/C/dbase.c +++ b/C/dbase.c @@ -18,6 +18,20 @@ static char SccsId[] = "%W% %G%"; #endif +/** + * @file dbase.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:36:46 2018 + * + * @brief record and other forms of storing terms. + * + * @namespace prolog + * + * + * + */ + + /** @defgroup Internal_Database Internal Data Base @ingroup builtins @{ diff --git a/C/eval.c b/C/eval.c index 9760112e8..cab3f1ce4 100644 --- a/C/eval.c +++ b/C/eval.c @@ -17,8 +17,19 @@ #ifdef SCCS static char SccsId[] = "%W% %G%"; #endif - -//! @file eval.c +/** + * @file eval.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 09:37:59 2018 + * + * @brief is/2 + * + * + * @namespace prolog + * + * + * + */ //! @{ diff --git a/C/exec.c b/C/exec.c index 7f3e22419..4b2ace0a7 100755 --- a/C/exec.c +++ b/C/exec.c @@ -18,6 +18,19 @@ static char SccsId[] = "@(#)cdmgr.c 1.1 05/02/98"; #endif +/** + * @file exec.c + * @author VITOR SANTOS COSTA + * @date Mon Apr 30 13:48:35 2018 + * + * @brief meta-call + * + * @namespace prolog + * + * + * + */ + #include "absmi.h" #include "attvar.h" #include "cut_c.h" @@ -121,7 +134,8 @@ inline static bool CallMetaCall(Term t, Term mod USES_REGS) { /** * Transfer control to a meta-call in ARG1, cut up to B. - * @method Yap_ExecuteCallMetaCall + * + * @param g goal * @param mod current module * @return su */ @@ -1574,8 +1588,8 @@ bool Yap_exec_absmi(bool top, yap_reset_t has_reset) { /** * Fails computation up to choice-point bb - * @method Yap_fail_all - * @param USES_REGS [description] + * + * @param USES_REGS thread support */ void Yap_fail_all(choiceptr bb USES_REGS) { yamop *saved_p, *saved_cp; diff --git a/C/flags.c b/C/flags.c index acdda6114..1838c1e3a 100644 --- a/C/flags.c +++ b/C/flags.c @@ -30,6 +30,10 @@ */ +/* + * @namespace prolog + * / + // this is where we define flags #define INIT_FLAGS 1 diff --git a/C/stack.c b/C/stack.c index fd7185d95..bd94e882a 100644 --- a/C/stack.c +++ b/C/stack.c @@ -1260,19 +1260,21 @@ static Term all_calls(bool internal USES_REGS) { return Yap_MkApplTerm(f, 6, ts); } -/** - * report the current status of the stacks up to level $N$ - * - * @param depth - * - * @return data on the current program counter - */ Term Yap_all_calls(void) { CACHE_REGS return all_calls(true PASS_REGS); } +/** + * @pred current_stack( +Depth ) + * + * report the current status of the stacks up to level $N$ + * + * @param Depth + * + * @return data on the current Prolog stack. + */ static Int current_stack(USES_REGS1) { Term t; while ((t = all_calls(false PASS_REGS)) == 0L) { diff --git a/C/utilpreds.c b/C/utilpreds.c index a681f6da0..add64e55d 100644 --- a/C/utilpreds.c +++ b/C/utilpreds.c @@ -1617,8 +1617,9 @@ p_term_variables( USES_REGS1 ) /* variables in term t */ /** * Exports a nil-terminated list with all the variables in a term. - * @param[in] the term - * @param[in] the arity of the calling predicate (required for exact garbage collection). + * @param[t] the term + * @param[arity] the arity of the calling predicate (required for exact garbage collection). + * @param[USES_REGS] threading */ Term Yap_TermVariables( Term t, UInt arity USES_REGS ) /* variables in term t */ diff --git a/H/YapGFlagInfo.h b/H/YapGFlagInfo.h index f6b3dcd86..9afd361e7 100644 --- a/H/YapGFlagInfo.h +++ b/H/YapGFlagInfo.h @@ -47,11 +47,11 @@ YAP_FLAG(ALLOW_ASSERT_FOR_STATIC_PREDICATES, NULL), /**< `allow_variable_name_as_functor` boolean flag allows constructs such as - ~~~~~~~~~~~~ +~~~ Tree(Node(L,node,R)) :- Tree(L), Tree(R). -~~~~~~~~~~~~ +~~~ */ YAP_FLAG( ALLOW_VARIABLE_NAME_AS_FUNCTOR_FLAG, "allow_variable_name_as_functor", false, booleanFlag, "false", NULL), diff --git a/H/YapLFlagInfo.h b/H/YapLFlagInfo.h index e05ad48bc..b657bbec9 100644 --- a/H/YapLFlagInfo.h +++ b/H/YapLFlagInfo.h @@ -24,11 +24,10 @@ @{ -@enum LocalFlags local Flags supported by YAP - @brief local flag: +@enum local_flags flag: */ -typedef enum { +typedef enum local_flags_enum { /** + `autoload`: set the system to look for undefined procedures */ YAP_FLAG( AUTOLOAD_FLAG, "autoload", true, booleanFlag, "false" , NULL ), diff --git a/OPTYap/opt.preds.c b/OPTYap/opt.preds.c index 8f07d9acb..8a9db543a 100644 --- a/OPTYap/opt.preds.c +++ b/OPTYap/opt.preds.c @@ -241,7 +241,7 @@ void Yap_init_optyap_preds(void) { SafePredFlag | SyncPredFlag); Yap_InitCPred("abolish_all_tables", 0, p_abolish_all_tables, SafePredFlag | SyncPredFlag); - /** @pred abolish_all_tables/0 + /** @pred abolish_all_tables Removes all the entries from the table space for all tabled diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 17c5c8012..467f41be3 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -8,7 +8,9 @@ if (WITH_DOCS) set(DOCS_SOURCE_DIR ${CMAKE_SOURCE_DIR}/docs) -SET (CMAKE_HTML_EXTRA_ +SET (CMAKE_HTML_EXTRA_) + +SET( EXT ${DOCS_SOURCE_DIR}/custom/application.js ${DOCS_SOURCE_DIR}/custom/assets ${DOCS_SOURCE_DIR}/custom/bootstrap.min.css @@ -84,21 +86,18 @@ endforeach(i ${DOCS_EXCLUDE_}) add_subdirectory(../packages/raptor/doc ${CMAKE_BINARY_DIR}/packages/raptor/doc) - - - -SET(DOC_INPUT_FILES_ ${CMAKE_SOURCE_DIR}/INSTALL.md - ${CMAKE_SOURCE_DIR}/pl - ${CMAKE_SOURCE_DIR}/CXX - ${CMAKE_SOURCE_DIR}/OPTYap - ${CMAKE_SOURCE_DIR}/C - ${CMAKE_SOURCE_DIR}/H - ${CMAKE_SOURCE_DIR}/include - ${CMAKE_SOURCE_DIR}/os - ${CMAKE_SOURCE_DIR}/library - ${CMAKE_SOURCE_DIR}/swi/library - ${CMAKE_SOURCE_DIR}/docs/md -) + SET(DOC_INPUT_FILES_ + ${CMAKE_SOURCE_DIR}/pl + ${CMAKE_SOURCE_DIR}/docs/md + ${CMAKE_SOURCE_DIR}/CXX + ${CMAKE_SOURCE_DIR}/OPTYap + ${CMAKE_SOURCE_DIR}/C + ${CMAKE_SOURCE_DIR}/H + ${CMAKE_SOURCE_DIR}/include + ${CMAKE_SOURCE_DIR}/os + ${CMAKE_SOURCE_DIR}/library + ${CMAKE_SOURCE_DIR}/swi/library + ) foreach(i ${DOC_INPUT_FILES_}) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 5d21b56df..cd85cf6e6 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/docs # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = YES +CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII @@ -98,7 +98,7 @@ OUTPUT_LANGUAGE = English # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. -BRIEF_MEMBER_DESC = YES +BRIEF_MEMBER_DESC = NO # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description @@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC = YES # brief descriptions will be completely suppressed. # The default value is: YES. -REPEAT_BRIEF = YES +REPEAT_BRIEF = NO # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found @@ -204,7 +204,7 @@ MULTILINE_CPP_IS_BRIEF = NO # documentation from any documented member that it re-implements. # The default value is: YES. -INHERIT_DOCS = YES +INHERIT_DOCS = NO # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part @@ -277,7 +277,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # Prolog sources. Doxygen will then generate output that is tailored for Prolog. # The default value is: NO. -OPTIMIZE_OUTPUT_FOR_PROLOG = YES +OPTIMIZE_OUTPUT_FOR_PROLOG = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given @@ -318,7 +318,7 @@ MARKDOWN_SUPPORT = YES # Minimum value: 0, maximum value: 99, default value: 0. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. -TOC_INCLUDE_HEADINGS = 0 +TOC_INCLUDE_HEADINGS = 99 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can @@ -711,7 +711,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = @CMAKE_SOURCE_DIR@/docs/custom/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -748,7 +748,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters @@ -1097,7 +1097,7 @@ VERBATIM_HEADERS = YES # classes, structs, unions or interfaces. # The default value is: YES. -ALPHABETICAL_INDEX = YES +ALPHABETICAL_INDEX = NO # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. @@ -1156,7 +1156,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = @CMAKE_SOURCE_DIR@/docs/custom/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1166,7 +1166,7 @@ HTML_HEADER = # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = @CMAKE_SOURCE_DIR@/docs/custom/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style @@ -1192,7 +1192,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/docs/custom/customdoxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or @@ -1203,7 +1203,7 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = @CMAKE_SOURCE_DIR@/docs/custom/doxy-boot.js # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1958,7 +1958,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = YES +GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/custom/customdoxygen.css b/docs/custom/customdoxygen.css index c20bd11ba..92bc395cd 100644 --- a/docs/custom/customdoxygen.css +++ b/docs/custom/customdoxygen.css @@ -1,104 +1,17 @@ -h1, .h1, h2, .h2, h3, .h3{ - font-weight: 200 !important; -} - +/* Custom Look and feel - Can be edited +----------------------------------- */ #navrow1, #navrow2, #navrow3, #navrow4, #navrow5{ border-bottom: 1px solid #EEEEEE; } .adjust-right { -margin-left: 30px !important; -font-size: 1.15em !important; -} -.navbar{ - border: 0px solid #222 !important; -} -table{ - white-space:pre-wrap !important; -} -/* - =========================== - */ - - -/* Sticky footer styles --------------------------------------------------- */ -html, -body { - height: 100%; - /* The html and body elements cannot have any padding or margin. */ + margin-left: 30px !important; + font-size: 1.15em !important; } -/* Wrapper for page content to push down footer */ -#wrap { - min-height: 100%; - height: auto; - /* Negative indent footer by its height */ - margin: 0 auto -60px; - /* Pad bottom by footer height */ - padding: 0 0 60px; -} - -/* Set the fixed height of the footer here */ -#footer { - font-size: 0.9em; - padding: 8px 0px; - background-color: #f5f5f5; -} - -.footer-row { - line-height: 44px; -} - -#footer > .container { - padding-left: 15px; - padding-right: 15px; -} - -.footer-follow-icon { - margin-left: 3px; - text-decoration: none !important; -} - -.footer-follow-icon img { - width: 20px; -} - -.footer-link { - padding-top: 5px; - display: inline-block; - color: #999999; - text-decoration: none; -} - -.footer-copyright { - text-align: center; -} - - -@media (min-width: 992px) { - .footer-row { - text-align: left; - } - - .footer-icons { - text-align: right; - } -} -@media (max-width: 991px) { - .footer-row { - text-align: center; - } - - .footer-icons { - text-align: center; - } -} - -/* DOXYGEN Code Styles +/* DOXYGEN Code Styles - These are from doxygen but can be changed to fit the theme ----------------------------------- */ - a.qindex { font-weight: bold; } @@ -148,8 +61,8 @@ div.fragment { } div.line { - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; - font-size: 12px; + font-family: monospace, fixed; + font-size: 13px; min-height: 13px; line-height: 1.0; text-wrap: unrestricted; @@ -157,7 +70,7 @@ div.line { white-space: -pre-wrap; /* Opera 4-6 */ white-space: -o-pre-wrap; /* Opera 7 */ white-space: pre-wrap; /* CSS3 */ - word-wrap: normal; /* IE 5.5+ */ + word-wrap: break-word; /* IE 5.5+ */ text-indent: -53px; padding-left: 53px; padding-bottom: 0px; @@ -173,9 +86,6 @@ div.line { transition-property: background-color, box-shadow; transition-duration: 0.5s; } -div.line:hover{ - background-color: #FBFF00; -} div.line.glow { background-color: cyan; @@ -186,21 +96,16 @@ div.line.glow { span.lineno { padding-right: 4px; text-align: right; - color:rgba(0,0,0,0.3); - border-right: 1px solid #EEE; - border-left: 1px solid #EEE; - background-color: #FFF; + border-right: 2px solid #0F0; + background-color: #E8E8E8; white-space: pre; - font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace ; } span.lineno a { - background-color: #FAFAFA; - cursor:pointer; + background-color: #D8D8D8; } span.lineno a:hover { - background-color: #EFE200; - color: #1e1e1e; + background-color: #C8C8C8; } div.groupHeader { @@ -267,104 +172,3 @@ blockquote { padding: 0 12px 0 16px; } -/*---------------- Search Box */ - -#search-box { - margin: 10px 0px; -} -#search-box .close { - display: none; - position: absolute; - right: 0px; - padding: 6px 12px; - z-index: 5; -} - -/*---------------- Search results window */ - -#search-results-window { - display: none; -} - -iframe#MSearchResults { - width: 100%; - height: 15em; -} - -.SRChildren { - padding-left: 3ex; padding-bottom: .5em -} -.SRPage .SRChildren { - display: none; -} -a.SRScope { - display: block; -} -a.SRSymbol:focus, a.SRSymbol:active, -a.SRScope:focus, a.SRScope:active { - text-decoration: underline; -} -span.SRScope { - padding-left: 4px; -} -.SRResult { - display: none; -} - -/* class and file list */ -.directory .icona, -.directory .arrow { - height: auto; -} -.directory .icona .icon { - height: 16px; -} -.directory .icondoc { - background-position: 0px 0px; - height: 20px; -} -.directory .iconfopen { - background-position: 0px 0px; -} -.directory td.entry { - padding: 7px 8px 6px 8px; -} - -.table > tbody > tr > td.memSeparator { - line-height: 0; - .table-hover; - -} - -.memItemLeft, .memTemplItemLeft { - white-space: normal; -} - -/* enumerations */ -.panel-body thead > tr { - background-color: #e0e0e0; -} - -/* todo lists */ -.todoname, -.todoname a { - font-weight: bold; -} - -/* Class title */ -.summary { - margin-top: 25px; -} -.page-header { - margin: 20px 0px !important; -} -.page-header .title { - display: inline-block; -} -.page-header .pull-right { - margin-top: 0.3em; - margin-left: 0.5em; -} -.page-header .label { - font-size: 50%; -} diff --git a/docs/custom/doxy-boot.js b/docs/custom/doxy-boot.js index ac0b41f49..a48c7c46e 100644 --- a/docs/custom/doxy-boot.js +++ b/docs/custom/doxy-boot.js @@ -4,6 +4,7 @@ $( document ).ready(function() { $("div.title").addClass("h1"); $('li > a[href="index.html"] > span').before(" "); + $('li > a[href="index.html"] > span').text("YAP"); $('li > a[href="modules.html"] > span').before(" "); $('li > a[href="namespaces.html"] > span').before(" "); $('li > a[href="annotated.html"] > span').before(" "); @@ -26,7 +27,7 @@ $( document ).ready(function() { $("#nav-path > ul").addClass("breadcrumb"); $("table.params").addClass("table"); - $("div.ingroups").wrapInner(""); + $("div.ingroups").wrapInner(""); $("div.levels").css("margin", "0.5em"); $("div.levels > span").addClass("btn btn-default btn-xs"); $("div.levels > span").css("margin-right", "0.25em"); @@ -53,19 +54,21 @@ $( document ).ready(function() { $("div.ttname a").css("color", 'white'); $("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body"); - $('div.fragment.well div.line:first').css('margin-top', '2px'); - $('div.fragment.well div.line:last').css('margin-bottom', '2px'); + $('#MSearchBox').parent().remove(); + $('div.fragment.well div.line:first').css('margin-top', '15px'); + $('div.fragment.well div.line:last').css('margin-bottom', '15px'); + $('table.doxtable').removeClass('doxtable').addClass('table table-striped table-bordered').each(function(){ $(this).prepend(''); $(this).find('tbody > tr:first').prependTo($(this).find('thead')); - + $(this).find('td > span.success').parent().addClass('success'); $(this).find('td > span.warning').parent().addClass('warning'); $(this).find('td > span.danger').parent().addClass('danger'); }); - - + + if($('div.fragment.well div.ttc').length > 0) { @@ -76,164 +79,18 @@ $( document ).ready(function() { $(this).contents().appendTo($(this).siblings('.memItemLeft')); $(this).siblings('.memItemLeft').attr('align', 'left'); }); - - $('table.memberdecls').find('.memTemplItemRight').each(function(){ - $(this).contents().appendTo($(this).siblings('.memTemplItemLeft')); - $(this).siblings('.memTemplItemLeft').attr('align', 'left'); - }); - + function getOriginalWidthOfImg(img_element) { var t = new Image(); t.src = (img_element.getAttribute ? img_element.getAttribute("src") : false) || img_element.src; return t.width; } - + $('div.dyncontent').find('img').each(function(){ if(getOriginalWidthOfImg($(this)[0]) > $('#content>div.container').width()) $(this).css('width', '100%'); }); - - - /* responsive search box */ - $('#MSearchBox').parent().remove(); - - var nav_container = $('
'); - $('#navrow1').parent().prepend(nav_container); - - var left_nav = $('
'); - for (i = 0; i < 6; i++) { - var navrow = $('#navrow' + i + ' > ul.tablist').detach(); - left_nav.append(navrow); - $('#navrow' + i).remove(); - } - var right_nav = $('
').append('\ - '); - $(nav_container).append(left_nav); - $(nav_container).append(right_nav); - - $('#MSearchSelectWindow .SelectionMark').remove(); - var search_selectors = $('#MSearchSelectWindow .SelectItem'); - for (var i = 0; i < search_selectors.length; i += 1) { - var element_a = $('').text($(search_selectors[i]).text()); - - element_a.click(function(){ - $('#search-box .dropdown-menu li').removeClass('active'); - $(this).parent().addClass('active'); - searchBox.OnSelectItem($('#search-box li a').index(this)); - searchBox.Search(); - return false; - }); - - var element = $('
  • ').append(element_a); - $('#search-box .dropdown-menu').append(element); - } - $('#MSearchSelectWindow').remove(); - - $('#search-box .close').click(function (){ - searchBox.CloseResultsWindow(); - }); - - $('body').append('
    '); - $('body').append('
    '); - $('body').append('
    '); - - searchBox.searchLabel = ''; - searchBox.DOMSearchField = function() { - return document.getElementById("search-field"); - } - searchBox.DOMSearchClose = function(){ - return document.getElementById("search-close"); - } - - - /* search results */ - var results_iframe = $('#MSearchResults').detach(); - $('#MSearchResultsWindow') - .attr('id', 'search-results-window') - .addClass('panel panel-default') - .append( - '
    \ -

    Search Results

    \ -
    \ -
    ' - ); - $('#search-results-window .panel-body').append(results_iframe); - - searchBox.DOMPopupSearchResultsWindow = function() { - return document.getElementById("search-results-window"); - } - - function update_search_results_window() { - $('#search-results-window').removeClass('panel-default panel-success panel-warning panel-danger') - var status = $('#MSearchResults').contents().find('.SRStatus:visible'); - if (status.length > 0) { - switch(status.attr('id')) { - case 'Loading': - case 'Searching': - $('#search-results-window').addClass('panel-warning'); - break; - case 'NoMatches': - $('#search-results-window').addClass('panel-danger'); - break; - default: - $('#search-results-window').addClass('panel-default'); - } - } else { - $('#search-results-window').addClass('panel-success'); - } - } - $('#MSearchResults').load(function() { - $('#MSearchResults').contents().find('link[href="search.css"]').attr('href','../doxygen.css'); - $('#MSearchResults').contents().find('head').append( - ''); - - update_search_results_window(); - - // detect status changes (only for search with external search backend) - var observer = new MutationObserver(function(mutations) { - update_search_results_window(); - }); - var config = { attributes: true}; - - var targets = $('#MSearchResults').contents().find('.SRStatus'); - for (i = 0; i < targets.length; i++) { - observer.observe(targets[i], config); - } - }); - - - /* enumerations */ - $('table.fieldtable').removeClass('fieldtable').addClass('table table-striped table-bordered').each(function(){ - $(this).prepend(''); - $(this).find('tbody > tr:first').prependTo($(this).find('thead')); - - $(this).find('td > span.success').parent().addClass('success'); - $(this).find('td > span.warning').parent().addClass('warning'); - $(this).find('td > span.danger').parent().addClass('danger'); - }); - - /* todo list */ - var todoelements = $('.contents > .textblock > dl.reflist > dt, .contents > .textblock > dl.reflist > dd'); - for (var i = 0; i < todoelements.length; i += 2) { - $('.contents > .textblock').append( - '
    ' - + "
    " + $(todoelements[i]).html() + "
    " - + "
    " + $(todoelements[i+1]).html() + "
    " - + '
    '); - } - $('.contents > .textblock > dl').remove(); - - + $(".memitem").removeClass('memitem'); $(".memproto").removeClass('memproto'); $(".memdoc").removeClass('memdoc'); @@ -248,24 +105,17 @@ $( document ).ready(function() { $("a.el").removeClass('el'); $("div.ah").removeClass('ah'); $("div.header").removeClass("header"); - + $('.mdescLeft').each(function(){ if($(this).html()==" ") { $(this).siblings('.mdescRight').attr('colspan', 2); $(this).remove(); } }); - $('td.memItemLeft').each(function(){ - if($(this).siblings('.memItemRight').html()=="") { - $(this).attr('colspan', 2); - $(this).siblings('.memItemRight').remove(); - } - }); - $('td.memTemplItemLeft').each(function(){ - if($(this).siblings('.memTemplItemRight').html()=="") { + $('td.memItemLeft').each(function(){ + if($(this).siblings('.memItemRight').html()=="") { $(this).attr('colspan', 2); - $(this).siblings('.memTemplItemRight').remove(); + $(this).siblings('.memItemRight').remove(); } }); - searchBox.CloseResultsWindow(); -}); +}); \ No newline at end of file diff --git a/docs/custom/footer.html b/docs/custom/footer.html index 694845591..152fb77ff 100644 --- a/docs/custom/footer.html +++ b/docs/custom/footer.html @@ -1,20 +1,15 @@ - + - - - - - - - - + - - - - -
    $generatedby   diff --git a/docs/custom/header.html b/docs/custom/header.html index 777cc6c9c..60fd49ce5 100644 --- a/docs/custom/header.html +++ b/docs/custom/header.html @@ -1,72 +1,39 @@ - + - - - - - + + + + + + + + - - - - + $projectname: $title +$title + + + $treeview + $search +$mathjax + + + +$extrastylesheet + + - - + + + + + +
    - $projectname: $title - $title - - $extrastylesheet - - - $mathjax - - - - - - -
    - -
    - + + @@ -90,12 +57,12 @@ - + - +`` -
    + diff --git a/docs/md/INSTALL.md b/docs/md/INSTALL.md index 6300410d5..5992e347a 100644 --- a/docs/md/INSTALL.md +++ b/docs/md/INSTALL.md @@ -1,7 +1,9 @@ - +Downloading and Installing YAP {#INSTALL} +=========================== -Installing YAP {#INSTALL} -++++++++ +This text includes instructions to download and install YAP. + +[TOC] ### Downloading YAP {#Download} @@ -24,7 +26,7 @@ The first argument is the repository, the last argument is the (optional) target There are a variety of graphical interfaces to `git`, including GitHub's own [GitHub Desktop](https://desktop.github.com/) that supports Microsoft Windows and Apple OSX. A list with GUI applications, editor integration, and much more can be found at the [git Wiki](https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools), -#### Download Options +### Download Options It may be useful to know: @@ -40,7 +42,6 @@ It may be useful to know: these documents. ### Compiling YAP {#CompilingYAP} -------------- YAP-6.3.4 is a [cmake](www.cmake.org) based system. We use `cmake` because it supports mosts popular software, can @@ -48,7 +49,7 @@ generate Makefiles, Ninja, Apple's XCode, VisualStudio and ANdroid Studio, and because it includes packaging suppport, The steps required to install core YAP under `cmake`: -##### `C/C++` compiler +#### The compiler *Status as of early 2017* @@ -65,7 +66,7 @@ to install core YAP under `cmake`: YAP compiles cleanly under cross-compilers, and we have used the crosss-compilation system [mxe](http://mxe.cc/) system with good results. -##### `cmake` +### cmake All Linux and BSD distributions include `cmake`, so does [Homebrew](https://brew.sh/) @@ -80,7 +81,7 @@ the [CMake site](https://www.cmake.org). If you have an older Linux you may need to compile from source, available at GitHub. -##### Ensure that you have other necessary packages installed: +### Ensure that you have other necessary packages installed: + YAP requires [gmp]{https://gmplib.org/} for infinite precision integer and rational. Please ensure the development pacakage @@ -101,7 +102,7 @@ available at GitHub. + make sure to install Python-3, and not Python-2, -##### Compile and Install +### Compile and Install 1: Create a directory, say `Build` and `cd` to the directory (`cd Build`). *YAP should not be compiled at its rootxo directory, some packages do not allow for that. @@ -115,15 +116,14 @@ available at GitHub. 5: If you feel satisfied with the result, do `make install`. * In most systems you will need to be superuser in order to do `make install` and `make info` on the standard directories. -Tuning the Functionality of YAP -------------------------------- +### Tuning the Functionality of YAP By default, YAP supports tabling, depth first search, and most features found in modern Prologs. In some cases, you may want to suport extra features, or reduce system size. `cmake`provides an graphical interface for doing so. From the commmand line, a typical example could be: ~~~~~ -cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~ /users/vsc/src/yap +Cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~ /users/vsc/src/yap ~~~~~ The first argument says that this is a release, compiled with full optimisation. The second argument says YAP should install under the ~ drectory. In this case, YAP will add the binaries to /users/vsc/bin, include files to `/users/vsc/include/Yap`, Prolog files to `/users/vsc/share/Yap`, and ay DLL to `/users/vsc/lib/Yap`. @@ -177,7 +177,7 @@ You can also use `xcodebuild` from the command line. Bext follow instructions to fully compile YAP: -#### Compilation Notes for OSX/Brew +### Compilation Notes for OSX/Brew Next follows a detailed description of a full install of YAP, including all the packages that YAP can use: @@ -210,7 +210,7 @@ brew install cudd cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl .. ~~~~~ - #### Compilation Notes for Android +### Compilation Notes for Android Next we present the compilation process for Android. The environment is an OSX, but steps should be similar for Linux machines. We assume you have downloaded both the Android NDK and the Android SDK. diff --git a/docs/md/attributes.md b/docs/md/attributes.md index 4579adc0e..056010d46 100644 --- a/docs/md/attributes.md +++ b/docs/md/attributes.md @@ -1,5 +1,5 @@ - Attributed Variables and Co-Routining {#attributes} -======================================= +### Attributed Variables and Co-Routining {#attributes} + @ingroup extensions @@ -26,15 +26,9 @@ work with. Most packages included in YAP that use attributed variables, such as CHR, CLP(FD), and CLP(QR), rely on the SWI-Prolog awi interface. -+ @ref SICS_attributes -+ @ref sicsatts -+ @ref New_Style_Attribute_Declarations -+ @ref CohYroutining -+ @ref AttributeVariables_Builtins +[TOC] - - -### SICStus Style attribute declarations. {#SICS_attributes} +#### SICStus Style attribute declarations. {#SICS_attributes} The YAP library `atts` implements attribute variables in the style of SICStus Prolog. Attributed variables work as follows: @@ -279,7 +273,7 @@ Module:get_atts/2`. @} @{ -### hProlog and SWI-Prolog style Attribute Declarations {#New_Style_Attribute_Declarations} +#### hProlog and SWI-Prolog style Attribute Declarations {#New_Style_Attribute_Declarations} The following documentation is taken from the SWI-Prolog manual. @@ -351,7 +345,7 @@ v put_attr(Y, domain, Domain), @{ -### Co-routining {#CohYroutining} +#### Co-routining {#CohYroutining} Prolog uses a simple left-to-right flow of control. It is sometimes convenient to change this control so that goals will only execute when diff --git a/docs/md/builtins.md b/docs/md/builtins.md index bdc9c0efb..aca08511b 100644 --- a/docs/md/builtins.md +++ b/docs/md/builtins.md @@ -1,4 +1,5 @@ -@defgroup builtins YAP Core Built-ins +YAP Core Built-ins {#builtins} +================== @brief This chapter describes the core built-in predicates that control the execution of Prolog programs, provide fundamental functionality such as termm manipulation or arithmetic, and support interaction with external @@ -13,3 +14,49 @@ notation will be used: argument" - the argument is read, not written, and it cannot be a free variable at the time of the call; + a preceding minus sign will denote an "output argument"; + an argument with no preceding symbol can be used in both ways. + ++ @ref AbsoluteFileName ++ @ref CompilerAnalysis ++ @ref New_Style_Attribute_Declarations ++ @ref YAPControl ++ @ref Profiling ++ @ref Call_Counting ++ @ref YAPConsulting ++ @ref YAPReadFiles ++ @ref ModPreds ++ @ref Conditional_Compilation ++ @ref YAPBigLoad ++ @ref Deb_Interaction ++ @ref DepthLimited ++ @ref Dialects ++ @ref Directives ++ @ref EAM ++ @ref SWI-error ++ @ref YAPErrorHandler ++ @ref CompiledExpression ++ @ref YAPFlags ++ @ref Grammars ++ @ref Hacks ++ @ref Listing ++ @ref LoadForeign ++ @ref Messages ++ @ref YAPMetaPredicates ++ @ref ModuleBuiltins ++ @ref YAPOS ++ @ref pathconf ++ @ref YAPPredDecls ++ @ref Database ++ @ref The_Count_Profiler ++ @ref QLY ++ @ref Sets ++ @ref Deb_Preds ++ @ref Statistics ++ @ref Tabling ++ @ref Threads ++ @ref TopLevel ++ @ref Undefined_Procedures ++ @ref MixBag ++ @ref InputOutput ++ @ref IO_Sockets ++ @ref ypp + diff --git a/docs/md/c b/docs/md/c deleted file mode 100644 index b20ba3188..000000000 --- a/docs/md/c +++ /dev/null @@ -1,24 +0,0 @@ -YAP Core Built-ins {#core} -================= - -This chapter describes the core predicates that control the execution of -Prolog programs, provide fundamental functionality such as termm manipulation or arithmetic, and support interaction with external -resources, Many of the predicates described here have been standardised by the ISO. The standartised subset of Prolog also known as ISO-Prolog. - -In the description of the arguments of predicates the following -notation will be used: - -+ a preceding plus sign will denote an argument as an "input -argument" - it cannot be a free variable at the time of the call; -+ a preceding minus sign will denote an "output argument"; -+ an argument with no preceding symbol can be used in both ways. - - -@copydoc builtins - - -@{ -@defgroup builtins YAP Core Builtins: - -@} - diff --git a/docs/md/library.md b/docs/md/library.md index 5b989656d..de043a9fe 100644 --- a/docs/md/library.md +++ b/docs/md/library.md @@ -1,8 +1,62 @@ -@page Library YAP Library +YAP Prolog Library {#library} +=================== the library_directory path (set by the `LIBDIR` variable in the Makefile for YAP). Several files in the library are originally from the public-domain Edinburgh Prolog library. +@tableofcontents + + ++ @ref apply_stub ++ @ref apply_macros ++ @ref args ++ @ref Association_Lists ++ @ref sicsatts ++ @ref avl ++ @ref bhash ++ @ref block_diagram ++ @ref c_alarms ++ @ref charsio ++ @ref clauses ++ @ref cleanup ++ @ref dbqueues ++ @ref dbusage ++ @ref dgraphs ++ @ref exo_interval ++ @ref flags ++ @ref gensym ++ @ref yap_hacks ++ @ref heaps ++ @ref lam_mpi ++ @ref line_utils ++ @ref swi_listing ++ @ref Log2MD ++ @ref mapargs ++ @ref maplist ++ @ref matlab ++ @ref matrix ++ @ref nb ++ @ref ordsets ++ @ref parameters ++ @ref queues ++ @ref random ++ @ref Pseudo_Random ++ @ref rbtrees ++ @ref readutil ++ @ref regexp ++ @ref rltrees ++ @ref Splay_Trees ++ @ref operating_system_support ++ @ref Terms ++ @ref timeout ++ @ref trees ++ @ref tries ++ @ref ugraphs ++ @ref undgraphs ++ @ref varnumbers ++ @ref wdgraphs ++ @ref wgraphs ++ @ref wundgraphs diff --git a/docs/md/load_files.md b/docs/md/load_files.md index b52a6cd62..6f6766fef 100644 --- a/docs/md/load_files.md +++ b/docs/md/load_files.md @@ -1,4 +1,5 @@ -@defgroup load_files Loading and Organising YAP Programs +Loading and Organising YAP Programs {#load_files} +==================================== @brief Next, we present the main predicates and directives available to load files and to control the Prolog environment. diff --git a/docs/md/modules.md b/docs/md/modules.md index 6477e57bc..e53bd8f67 100644 --- a/docs/md/modules.md +++ b/docs/md/modules.md @@ -1,5 +1,5 @@ -### The YAP Module system {#YAPModules} - +The YAP Module system {#YAPModules} +======================= The YAP module system is based on the Quintus/SISCtus module system ˜\cite quintus . In this design, modules are named collections of predicates, @@ -38,6 +38,8 @@ the module/2 declaration.This declaration sets the source module when it starts consulting a file, and resets it at the end. One can set the type-in module permanently by using the built-in `module/1`. +[TOC] + #### Explicit Naming {#ExplicitNaming} The module system allows one to _explicitly_ specify the source mode for diff --git a/docs/md/run.md b/docs/md/run.md index 8a921e091..168154750 100644 --- a/docs/md/run.md +++ b/docs/md/run.md @@ -1,13 +1,13 @@ -#### Running YAP {#run} +## Running YAP {#run} We next describe how to invoke YAP in Unix systems. [TOC] -##### Running YAP Interactively {#Running_YAP_Interactively} +### Running YAP Interactively {#Running_YAP_Interactively} Most often you will want to use YAP in interactive mode. Assuming that @@ -104,7 +104,7 @@ YAP can also be used to run Prolog files as scripts, at least in Unix-like environments. A simple example is shown next (do not forget that the shell comments are very important): -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ #!/usr/local/bin/yap -L -- # # Hello World script file using YAP @@ -113,7 +113,7 @@ that the shell comments are very important): :- write('Hello World'), nl. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ The `#!` characters specify that the script should call the binary file YAP. Notice that many systems will require the complete path to the @@ -147,7 +147,7 @@ Notice that the `--` is required so that the shell passes the extra arguments to YAP. As an example, consider the following script `dump_args`: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ #!/usr/bin/yap -L -- #. @@ -158,13 +158,13 @@ main( [H|T] ) :- :- unix( argv(AllArgs) ), main( AllArgs ). -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ If you this run this script with the arguments: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ ./dump_args -s 10000 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ the script will start an YAP process with stack size `10MB`, and the list of arguments to the process will be empty. @@ -172,7 +172,7 @@ Often one wants to run the script as any other program, and for this it is convenient to ignore arguments to YAP. This is possible by using `L --` as in the next version of `dump_args`: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ #!/usr/bin/yap -L -- main( [] ). @@ -182,13 +182,13 @@ main( [H|T] ) :- :- unix( argv(AllArgs) ), main( AllArgs ). -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ The `--` indicates the next arguments are not for YAP. Instead, they must be sent directly to the argv built-in. Hence, running -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ ./dump_args test -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~ will write `test` on the standard output. diff --git a/docs/md/swi.md b/docs/md/swi.md index 1d560e579..c4d81dcbe 100644 --- a/docs/md/swi.md +++ b/docs/md/swi.md @@ -67,9 +67,9 @@ assert/1, clause/1 and retract/1 are used. First predicates which will change during execution should be declared as `dynamic` by using commands like: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~ :- dynamic f/n. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~ where `f` is the predicate name and n is the arity of the predicate. Note that several such predicates can be declared in a @@ -174,12 +174,9 @@ standard. The following incompatibilities between YAP and the ISO standard are known to still exist (please check Ulrich Neumerkel's page for more details): -
      - -
    • Currently, YAP does not handle overflow errors in integer + + Currently, YAP does not handle overflow errors in integer operations, and handles floating-point errors only in some architectures. Otherwise, YAP follows IEEE arithmetic. -
        Please inform the authors on other incompatibilities that may still exist. diff --git a/include/YapErrors.h b/include/YapErrors.h index f2cdf62a2..2f8beebfe 100644 --- a/include/YapErrors.h +++ b/include/YapErrors.h @@ -1,6 +1,7 @@ /// /// @file YapErrors.h -/// /// @adddtogroup YapError +/// +/// @addtogroup YapError /// /// The file YapErrors.h contains a list with all the error classes known /// internally to the YAP system. diff --git a/library/apply.yap b/library/apply.yap index 92127969b..72a63e4ea 100644 --- a/library/apply.yap +++ b/library/apply.yap @@ -11,30 +11,6 @@ :- module(apply_stub,[]). -/** -* @file apply.yap -* @defgroup apply_stub Apply Predicates -* -* @ingroup library -* -* @{ - -This library provides a SWI-compatible set of utilities for applying a -predicate to all elements of a list. - -The apply library is a _stub_, it just forwards definitions to the -@ref maplist library. The predicates forwarded are: - - - maplist/2, - - maplist/3, - - maplist/4, - - maplist/5, - - include/3, - - exclude/3, - - partition/4, - - partition/5 - - */ :- reexport(library(maplist), [maplist/2, @@ -47,6 +23,31 @@ The apply library is a _stub_, it just forwards definitions to the partition/5 ]). +/** +* @defgroup apply_stub Apply Predicates +* +* @ingroup library +* + +* @{ + +This library provides a SWI-compatible set of utilities for applying a +predicate to all elements of a list. + +The apply library is a _stub_, it just forwards definitions to the +@ref maplist library. The predicates forwarded are: + + - @ref maplist/2, + - @ref maplist/3, + - @ref maplist/4, + - @ref maplist/5, + - @ref include/3, + - @ref exclude/3, + - @ref partition/4, + - @ref partition/5 + + */ + %% @} diff --git a/library/apply_macros.yap b/library/apply_macros.yap index 3302a3849..4299bcdda 100644 --- a/library/apply_macros.yap +++ b/library/apply_macros.yap @@ -2,8 +2,8 @@ %% @file apply_macros.yap %% @author E. Alphonse from code by Joachim Schimpf %% @date 15 June 2002 -%% @nrief Purpose: Macros to apply a predicate to all elements -% of a list or to all sub-terms of a term. +%% @brief Purpose: Macros to apply a predicate to all elements +%% of a list or to all sub-terms of a term. :- module(apply_macros, []). diff --git a/library/lists.yap b/library/lists.yap index ce1569f27..37696c0a8 100644 --- a/library/lists.yap +++ b/library/lists.yap @@ -2,15 +2,8 @@ * @file library/lists.yap * @author Bob Welham, Lawrence Byrd, and R. A. O'Keefe. Contributions from Vitor Santos Costa, Jan Wielemaker and others. * @date 1999 - * - * @{ - * -x * @addtogroup library The Prolog Library - * - * @brief List Manipulation Predicates - * - * */ + % This file has been included as an YAP library by Vitor Santos Costa, 1999 :- module(lists, @@ -52,15 +45,18 @@ x * @addtogroup library The Prolog Library ]). -/** @defgroup lists List Manipulation -@ingroup library -@{ - -The following list manipulation routines are available once included -with the `use_module(library(lists))` command. - +/** + * @{ + * + * @addtogroup library The Prolog Library + * + * @brief List Manipulation Predicates + * + * The following list manipulation routines are available once included + with the `use_module(library(lists))` command. */ + /** @pred list_concat(+ _Lists_,? _List_) diff --git a/library/maplist.yap b/library/maplist.yap index 289b14176..ae7e990ab 100644 --- a/library/maplist.yap +++ b/library/maplist.yap @@ -47,6 +47,7 @@ /** * @defgroup maplist Map List and Term Operations * @ingroup library + * @{ * * This library provides a set of utilities for applying a predicate to * all elements of a list. They allow one to easily perform the most common do-loop constructs in Prolog. @@ -56,20 +57,20 @@ * by Joachim Schimpf and on code from SWI-Prolog, and it is also inspired by the GHC * libraries. * - * The following routines are available once included with the + * The routines are available once included with the * `use_module(library(apply_macros))` command. - * @author : Lawrence Byrd - * @author Richard A. O'Keefe - * @author Joachim Schimpf - * @author Jan Wielemaker - * @author E. Alphonse - * @author Vitor Santos Costa +*/ + + /* Examples: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog} -%given +~~~~ + +given the progran: + +~~~~ plus(X,Y,Z) :- Z is X + Y. plus_if_pos(X,Y,Z) :- Y > 0, Z is X + Y. @@ -82,7 +83,7 @@ trans(TermIn, TermOut) :- TermIn =.. [p|Args], TermOut =..[q|Args], !. trans(X,X). - +~~~~ %success ?- maplist(plus(1), [1,2,3,4], [2,3,4,5]). @@ -96,15 +97,13 @@ trans(X,X). ?- sumlist(plus, [1,2,3,4], 1, 11). ?- maplist(mapargs(number_atom),[c(1),s(1,2,3)],[c('1'),s('1','2','3')]). -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - @{ +~~~~ */ -/** @pred maplist(+ _Pred_,+ _List1_,+ _List2_) +/** @pred maplist( 2:Pred, + _List1_,+ _List2_) Apply _Pred_ on all successive pairs of elements from _List1_ and @@ -113,7 +112,8 @@ pair. See the example above. */ -/** @pred maplist(+ _Pred_,+ _List1_,+ _List2_,+ _List4_) + +/** @pred maplist(3:Pred,+ List1,+ List2,+ List4) Apply _Pred_ on all successive triples of elements from _List1_, _List2_ and _List3_. Fails if _Pred_ can not be applied to a @@ -167,13 +167,17 @@ triple. See the example above. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%% -/** include(+ _Pred_, + _ListIn_, ? _ListOut_) +/** + @pred include( 2:Pred, + ListIn, ? ListOut) + Same as selectlist/3. */ include(G,In,Out) :- selectlist(G, In, Out). -/** selectlist(: _Pred_, + _ListIn_, ? _ListOut_)) +/** + @pred selectlist(1:Pred, + ListIn, ? ListOut)) + Creates _ListOut_ of all list elements of _ListIn_ that pass a given test */ selectlist(_, [], []). @@ -185,7 +189,9 @@ selectlist(Pred, [In|ListIn], ListOut) :- ), selectlist(Pred, ListIn, NewListOut). -/** selectlist(: _Pred_, + _ListIn_, + _ListInAux_, ? _ListOut_, ? _ListOutAux_) +/** + @pred selectlist( 2:Pred, + ListIn, + ListInAux, ? ListOut, ? ListOutAux) + Creates _ListOut_ and _ListOutAux_ of all list elements of _ListIn_ and _ListInAux_ that pass the given test _Pred_. */ @@ -200,7 +206,8 @@ selectlists(Pred, [In|ListIn], [In1|ListIn1], ListOut, ListOut1) :- ), selectlist(Pred, ListIn, ListIn1, NewListOut, NewListOut1). -/** selectlist(: _Pred_, + _ListIn_, + _ListInAux_, ? _ListOut_) +/** @pred selectlist( 2:Pred, + ListIn, + ListInAux, ? ListOut) + Creates _ListOut_ of all list elements of _ListIn_ that pass the given test _Pred_ using + _ListInAux_ as an auxiliary element. @@ -214,7 +221,9 @@ selectlist(Pred, [In|ListIn], [In1|ListIn1], ListOut) :- ), selectlist(Pred, ListIn, ListIn1, NewListOut). -/** exclude(+ _Goal_, + _List1_, ? _List2_) +/** + @pred exclude( 2:Goal, + List1, ? List2) + Filter elements for which _Goal_ fails. True if _List2_ contains those elements _Xi_ of _List1_ for which `call(Goal, Xi)` fails. */ @@ -227,11 +236,13 @@ exclude(Pred, [In|ListIn], ListOut) :- ), exclude(Pred, ListIn, NewListOut). -/** partition(+ _Pred_, + _List1_, ? _Included_, ? _Excluded_) - Filter elements of _List_ according to _Pred_. True if +/** + @pred partition(1:Pred, + List1, ? Included, ? Excluded) + + Filter elements of _List1_ according to _Pred_. True if _Included_ contains all elements for which `call(Pred, X)` succeeds and _Excluded_ contains the remaining elements. -*/ + */ partition(_, [], [], []). partition(Pred, [In|ListIn], List1, List2) :- (call(Pred, In) -> @@ -243,7 +254,8 @@ partition(Pred, [In|ListIn], List1, List2) :- ), partition(Pred, ListIn, RList1, RList2). -/** partition(+ _Pred_, + _List1_, ? _Lesser_, ? _Equal_, ? _Greater_) +/** + @pred partition(2:Pred, + List1, ? Lesser, ? Equal, ? Greater) Filter list according to _Pred_ in three sets. For each element _Xi_ of _List_, its destination is determined by @@ -274,7 +286,9 @@ partition(Pred, [In|ListIn], List1, List2, List3) :- ), partition(Pred, ListIn, RList1, RList2, RList3). -/** checklist(: _Pred_, + _List_) +/** + @pred checklist( 1:Pred, + List) + Succeeds if the predicate _Pred_ succeeds on all elements of _List_. */ checklist(_, []). @@ -282,7 +296,8 @@ checklist(Pred, [In|ListIn]) :- call(Pred, In), checklist(Pred, ListIn). -/** maplist(: _Pred_, ? _ListIn_) +/** + @pred maplist(: Pred, ? ListIn) Applies predicate _Pred_( _El_ ) to all elements _El_ of _ListIn_. @@ -294,7 +309,8 @@ maplist(Pred, [In|ListIn]) :- maplist(Pred, ListIn). -/** maplist(: _Pred_, ? _L1_, ? _L2_ ) +/** + @pred maplist(: Pred, ? L1, ? L2 ) _L1_ and _L2_ are such that `call( _Pred_, _A1_, _A2_)` holds for every corresponding element in lists _L1_, _L2_. @@ -308,7 +324,8 @@ maplist(Pred, [In|ListIn], [Out|ListOut]) :- call(Pred, In, Out), maplist(Pred, ListIn, ListOut). -/** maplist(: _Pred_, ? _L1_, ? _L2_, ? _L3_) +/** + @pred maplist(: Pred, ? L1, ? L2, ? L3) _L1_, _L2_, and _L3_ are such that `call( _Pred_, _A1_, _A2_, _A3_)` holds for every corresponding element in lists _L1_, _L2_, and _L3_. @@ -319,7 +336,9 @@ maplist(Pred, [A1|L1], [A2|L2], [A3|L3]) :- call(Pred, A1, A2, A3), maplist(Pred, L1, L2, L3). -/** maplist(: _Pred_, ? _L1_, ? _L2_, ? _L3_, ? _L4_) +/** + @pred maplist(: Pred, ? L1, ? L2, ? L3, ? L4) + _L1_, _L2_, _L3_, and _L4_ are such that `call( _Pred_, _A1_, _A2_, _A3_, _A4_)` holds for every corresponding element in lists _L1_, _L2_, _L3_, and @@ -331,7 +350,7 @@ maplist(Pred, [A1|L1], [A2|L2], [A3|L3], [A4|L4]) :- maplist(Pred, L1, L2, L3, L4). /** - convlist(: _Pred_, + _ListIn_, ? _ListOut_) @anchor convlist3 + @pred convlist(: Pred, + ListIn, ? ListOut) A combination of maplist/3 and selectlist/3: creates _ListOut_ by applying the predicate _Pred_ to all list elements on which @@ -355,7 +374,7 @@ convlist(Pred, [_|Olds], News) :- convlist(Pred, Olds, News). /** - convlist(: Pred, ? ListIn, ?ExtraList, ? ListOut) @anchor convlist5 + @pred convlist(: Pred, ? ListIn, ?ExtraList, ? ListOut) A combination of maplist/4 and selectlist/3: _ListIn_, _ListExtra_, and _ListOut_ are the sublists so that the predicate _Pred_ succeeds. @@ -378,7 +397,7 @@ convlist(Pred, [_|Olds], News) :- convlist(Pred, Olds, News). /** - mapnodes(+ _Pred_, + _TermIn_, ? _TermOut_) + @pred mapnodes(+ _Pred_, + _TermIn_, ? _TermOut_) Creates _TermOut_ by applying the predicate _Pred_ to all sub-terms of _TermIn_ (depth-first and left-to-right order). @@ -398,7 +417,7 @@ mapnodes_list(Pred, [TermIn|ArgsIn], [TermOut|ArgsOut]) :- mapnodes_list(Pred, ArgsIn, ArgsOut). /** - checknodes(+ _Pred_, + _Term_) @anchor checknodes + @pred checknodes(+ _Pred_, + _Term_) Succeeds if the predicate _Pred_ succeeds on all sub-terms of _Term_ (depth-first and left-to-right order) @@ -416,8 +435,8 @@ checknodes_list(Pred, [Term|Args]) :- checknodes_body(Pred, Term), checknodes_list(Pred, Args). -/** - sumlist(: _Pred_, + _List_, ? _AccIn_, ? _AccOut_) +/** + @pred sumlist(: _Pred_, + _List_, ? _AccIn_, ? _AccOut_) Calls _Pred_ on all elements of List and collects a result in _Accumulator_. Same as fold/4. @@ -428,7 +447,7 @@ sumlist(Pred, [H|T], AccIn, AccOut) :- sumlist(Pred, T, A1, AccOut). /** - sumnodes(+ _Pred_, + _Term_, ? _AccIn_, ? _AccOut_) @anchor sumnodes + @pred sumnodes(+ _Pred_, + _Term_, ? _AccIn_, ? _AccOut_) Calls the predicate _Pred_ on all sub-terms of _Term_ and collect a result in _Accumulator_ (depth-first and left-to-right @@ -457,11 +476,12 @@ sumnodes_body(Pred, Term, A1, A3, N0, Ar) :- * FOLDL * *******************************/ -%% foldl(:Goal, +List, +V0, -V, +W0, -WN). +%% +%% @pred foldl(:Goal, +List, +V0, -V, +W0, -WN). % /** - foldl(: _Pred_, + _List1_, + _List2_, ? _AccIn_, ? _AccOut_) + @pred oldl(: _Pred_, + _List1_, + _List2_, ? _AccIn_, ? _AccOut_) Calls _Pred_ on all elements of `List1` and collects a result in _Accumulator_. Same as foldr/3. @@ -475,7 +495,7 @@ foldl_([H|T], Goal, V0, V) :- foldl_(T, Goal, V1, V). /** - foldl(: _Pred_, + _List1_, + _List2_, ? _AccIn_, ? _AccOut_) + @pred foldl(: _Pred_, + _List1_, + _List2_, ? _AccIn_, ? _AccOut_) Calls _Pred_ on all elements of _List1_ and _List2_ and collects a result in _Accumulator_. Same as @@ -522,7 +542,7 @@ foldl_([H1|T1], [H2|T2], [H3|T3], [H4|T4], Goal, V0, V) :- /** - foldl2(: _Pred_, + _List_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) + @pred foldl2(: _Pred_, + _List_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) Calls _Pred_ on all elements of `List` and collects a result in _X_ and _Y_. @@ -537,7 +557,7 @@ foldl2_([H|T], Goal, V0, V, W0, W) :- foldl2_(T, Goal, V1, V, W1, W). /** - foldl2(: _Pred_, + _List_, ? _List1_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) +v @pred foldl2(: _Pred_, + _List_, ? _List1_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) Calls _Pred_ on all elements of _List_ and _List1_ and collects a result in _X_ and _Y_. @@ -551,7 +571,7 @@ foldl2_([H1|T1], [H2|T2], Goal, V0, V, W0, W) :- foldl2_(T1, T2, Goal, V1, V, W1, W). /** - foldl2(: _Pred_, + _List_, ? _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) + @pred foldl2(: _Pred_, + _List_, ? _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_) Calls _Pred_ on all elements of _List_, _List1_ and _List2_ and collects a result in _X_ and _Y_. @@ -567,7 +587,7 @@ foldl2_([H1|T1], [H2|T2], [H3|T3], Goal, V0, V, W0, W) :- /** - foldl3(: _Pred_, + _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_, ? _Z0_, ? _Z_) + @pred foldl3(: _Pred_, + _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_, ? _Z0_, ? _Z_) Calls _Pred_ on all elements of `List` and collects a @@ -582,7 +602,7 @@ foldl3_([H|T], Goal, V0, V, W0, W, X0, X) :- fold3_(T, Goal, V1, V, W1, W, X1, X). /** - foldl4(: _Pred_, + _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_, ? _Z0_, ? _Z_, ? _W0_, ? _W_) + @pred foldl4(: _Pred_, + _List1_, ? _List2_, ? _X0_, ? _X_, ? _Y0_, ? _Y_, ? _Z0_, ? _Z_, ? _W0_, ? _W_) Calls _Pred_ on all elements of `List` and collects a @@ -618,7 +638,6 @@ foldl4_([H|T], Goal, V0, V, W0, W, X0, X, Y0, Y) :- % == /** - scanl(: _Pred_, + _List_, + _V0_, ? _Values_) Left scan of list. The scanl family of higher order list diff --git a/library/regex/cclass.h b/library/regex/cclass.h index f73276d8b..803b7c617 100644 --- a/library/regex/cclass.h +++ b/library/regex/cclass.h @@ -37,26 +37,46 @@ * @(#)cclass.h 8.3 (Berkeley) 3/20/94 */ +/** + * @file cclass.h + * + * @brief Regexp character classes. + * + * @namespace regexp + * + */ -typedef enum {CALNUM, CALPHA, CBLANK, CCNTRL, CDIGIT, CGRAPH, - CLOWER, CPRINT, CPUNCT, CSPACE, CUPPER, CXDIGIT} citype; +typedef enum { + CALNUM, + CALPHA, + CBLANK, + CCNTRL, + CDIGIT, + CGRAPH, + CLOWER, + CPRINT, + CPUNCT, + CSPACE, + CUPPER, + CXDIGIT +} citype; /* character-class table */ static struct cclass { - char *name; - citype fidx; -} cclasses[] = { - {"alnum", CALNUM}, - {"alpha", CALPHA}, - {"blank", CBLANK}, - {"cntrl", CCNTRL}, - {"digit", CDIGIT}, - {"graph", CGRAPH}, - {"lower", CLOWER}, - {"print", CPRINT}, - {"punct", CPUNCT}, - {"space", CSPACE}, - {"upper", CUPPER}, - {"xdigit", CXDIGIT}, - {NULL, } -}; + char *name; + citype fidx; +} cclasses[] = {{"alnum", CALNUM}, + {"alpha", CALPHA}, + {"blank", CBLANK}, + {"cntrl", CCNTRL}, + {"digit", CDIGIT}, + {"graph", CGRAPH}, + {"lower", CLOWER}, + {"print", CPRINT}, + {"punct", CPUNCT}, + {"space", CSPACE}, + {"upper", CUPPER}, + {"xdigit", CXDIGIT}, + { + NULL, + }}; diff --git a/library/regex/cname.h b/library/regex/cname.h index 0cf4916e8..6531c3606 100644 --- a/library/regex/cname.h +++ b/library/regex/cname.h @@ -37,105 +37,112 @@ * @(#)cname.h 8.3 (Berkeley) 3/20/94 */ +/** + * @file cname.h + * + * Vharacter names. + * + * @namespace regexp + * + */ + /* character-name table */ static struct cname { - char *name; - char code; -} cnames[] = { - {"NUL", '\0'}, - {"SOH", '\001'}, - {"STX", '\002'}, - {"ETX", '\003'}, - {"EOT", '\004'}, - {"ENQ", '\005'}, - {"ACK", '\006'}, - {"BEL", '\007'}, - {"alert", '\007'}, - {"BS", '\010'}, - {"backspace", '\b'}, - {"HT", '\011'}, - {"tab", '\t'}, - {"LF", '\012'}, - {"newline", '\n'}, - {"VT", '\013'}, - {"vertical-tab", '\v'}, - {"FF", '\014'}, - {"form-feed", '\f'}, - {"CR", '\015'}, - {"carriage-return", '\r'}, - {"SO", '\016'}, - {"SI", '\017'}, - {"DLE", '\020'}, - {"DC1", '\021'}, - {"DC2", '\022'}, - {"DC3", '\023'}, - {"DC4", '\024'}, - {"NAK", '\025'}, - {"SYN", '\026'}, - {"ETB", '\027'}, - {"CAN", '\030'}, - {"EM", '\031'}, - {"SUB", '\032'}, - {"ESC", '\033'}, - {"IS4", '\034'}, - {"FS", '\034'}, - {"IS3", '\035'}, - {"GS", '\035'}, - {"IS2", '\036'}, - {"RS", '\036'}, - {"IS1", '\037'}, - {"US", '\037'}, - {"space", ' '}, - {"exclamation-mark", '!'}, - {"quotation-mark", '"'}, - {"number-sign", '#'}, - {"dollar-sign", '$'}, - {"percent-sign", '%'}, - {"ampersand", '&'}, - {"apostrophe", '\''}, - {"left-parenthesis", '('}, - {"right-parenthesis", ')'}, - {"asterisk", '*'}, - {"plus-sign", '+'}, - {"comma", ','}, - {"hyphen", '-'}, - {"hyphen-minus", '-'}, - {"period", '.'}, - {"full-stop", '.'}, - {"slash", '/'}, - {"solidus", '/'}, - {"zero", '0'}, - {"one", '1'}, - {"two", '2'}, - {"three", '3'}, - {"four", '4'}, - {"five", '5'}, - {"six", '6'}, - {"seven", '7'}, - {"eight", '8'}, - {"nine", '9'}, - {"colon", ':'}, - {"semicolon", ';'}, - {"less-than-sign", '<'}, - {"equals-sign", '='}, - {"greater-than-sign", '>'}, - {"question-mark", '?'}, - {"commercial-at", '@'}, - {"left-square-bracket", '['}, - {"backslash", '\\'}, - {"reverse-solidus", '\\'}, - {"right-square-bracket",']'}, - {"circumflex", '^'}, - {"circumflex-accent", '^'}, - {"underscore", '_'}, - {"low-line", '_'}, - {"grave-accent", '`'}, - {"left-brace", '{'}, - {"left-curly-bracket", '{'}, - {"vertical-line", '|'}, - {"right-brace", '}'}, - {"right-curly-bracket", '}'}, - {"tilde", '~'}, - {"DEL", '\177'}, - {NULL, 0} -}; + char *name; + char code; +} cnames[] = {{"NUL", '\0'}, + {"SOH", '\001'}, + {"STX", '\002'}, + {"ETX", '\003'}, + {"EOT", '\004'}, + {"ENQ", '\005'}, + {"ACK", '\006'}, + {"BEL", '\007'}, + {"alert", '\007'}, + {"BS", '\010'}, + {"backspace", '\b'}, + {"HT", '\011'}, + {"tab", '\t'}, + {"LF", '\012'}, + {"newline", '\n'}, + {"VT", '\013'}, + {"vertical-tab", '\v'}, + {"FF", '\014'}, + {"form-feed", '\f'}, + {"CR", '\015'}, + {"carriage-return", '\r'}, + {"SO", '\016'}, + {"SI", '\017'}, + {"DLE", '\020'}, + {"DC1", '\021'}, + {"DC2", '\022'}, + {"DC3", '\023'}, + {"DC4", '\024'}, + {"NAK", '\025'}, + {"SYN", '\026'}, + {"ETB", '\027'}, + {"CAN", '\030'}, + {"EM", '\031'}, + {"SUB", '\032'}, + {"ESC", '\033'}, + {"IS4", '\034'}, + {"FS", '\034'}, + {"IS3", '\035'}, + {"GS", '\035'}, + {"IS2", '\036'}, + {"RS", '\036'}, + {"IS1", '\037'}, + {"US", '\037'}, + {"space", ' '}, + {"exclamation-mark", '!'}, + {"quotation-mark", '"'}, + {"number-sign", '#'}, + {"dollar-sign", '$'}, + {"percent-sign", '%'}, + {"ampersand", '&'}, + {"apostrophe", '\''}, + {"left-parenthesis", '('}, + {"right-parenthesis", ')'}, + {"asterisk", '*'}, + {"plus-sign", '+'}, + {"comma", ','}, + {"hyphen", '-'}, + {"hyphen-minus", '-'}, + {"period", '.'}, + {"full-stop", '.'}, + {"slash", '/'}, + {"solidus", '/'}, + {"zero", '0'}, + {"one", '1'}, + {"two", '2'}, + {"three", '3'}, + {"four", '4'}, + {"five", '5'}, + {"six", '6'}, + {"seven", '7'}, + {"eight", '8'}, + {"nine", '9'}, + {"colon", ':'}, + {"semicolon", ';'}, + {"less-than-sign", '<'}, + {"equals-sign", '='}, + {"greater-than-sign", '>'}, + {"question-mark", '?'}, + {"commercial-at", '@'}, + {"left-square-bracket", '['}, + {"backslash", '\\'}, + {"reverse-solidus", '\\'}, + {"right-square-bracket", ']'}, + {"circumflex", '^'}, + {"circumflex-accent", '^'}, + {"underscore", '_'}, + {"low-line", '_'}, + {"grave-accent", '`'}, + {"left-brace", '{'}, + {"left-curly-bracket", '{'}, + {"vertical-line", '|'}, + {"right-brace", '}'}, + {"right-curly-bracket", '}'}, + {"tilde", '~'}, + {"DEL", '\177'}, + {NULL, 0}}; diff --git a/library/regex/engine.c b/library/regex/engine.c index 33b1745de..f52cf5635 100644 --- a/library/regex/engine.c +++ b/library/regex/engine.c @@ -44,6 +44,14 @@ * of code. */ +/** + * @file engine.c + * + * regex interpeter. + * + * @namespace regexp + */ + #include "config.h" #ifndef HAVE_REGEXEC diff --git a/library/regex/regcomp.c b/library/regex/regcomp.c index 062508d6f..de7719c2f 100644 --- a/library/regex/regcomp.c +++ b/library/regex/regcomp.c @@ -37,17 +37,25 @@ * @(#)regcomp.c 8.5 (Berkeley) 3/20/94 */ +/** + * @file regcomp.c + * + * Regular expression compiler + * + * @namespace regexp + * + */ #if defined(LIBC_SCCS) && !defined(lint) static char sccsid[] = "@(#)regcomp.c 8.5 (Berkeley) 3/20/94"; #endif /* LIBC_SCCS and not lint */ -#include "config.h" #include "YapInterface.h" +#include "config.h" #if HAVE_SYS_TYPES_H #include #endif -#include #include +#include #if HAVE_STRING_H #include #endif @@ -64,8 +72,8 @@ static char sccsid[] = "@(#)regcomp.c 8.5 (Berkeley) 3/20/94"; #include "collate.h" -#include "utils.h" #include "regex2.h" +#include "utils.h" #include "cclass.h" #include "cname.h" @@ -89,46 +97,45 @@ struct collate_st_chain_pri collate_chain_pri_table[TABLE_SIZE]; * into ASCII-compatible range, it allows to handle * "[a-z]"-type ranges with national characters. */ -static int collate_range_cmp (int c1, int c2) -{ - static char s1[2], s2[2]; - int ret; +static int collate_range_cmp(int c1, int c2) { + static char s1[2], s2[2]; + int ret; #ifndef ASCII_COMPATIBLE_COLLATE - int as1, as2, al1, al2; + int as1, as2, al1, al2; #endif - c1 &= UCHAR_MAX; - c2 &= UCHAR_MAX; - if (c1 == c2) - return (0); + c1 &= UCHAR_MAX; + c2 &= UCHAR_MAX; + if (c1 == c2) + return (0); #ifndef ASCII_COMPATIBLE_COLLATE - as1 = isascii(c1); - as2 = isascii(c2); - al1 = isalpha(c1); - al2 = isalpha(c2); + as1 = isascii(c1); + as2 = isascii(c2); + al1 = isalpha(c1); + al2 = isalpha(c2); - if (as1 || as2 || al1 || al2) { - if ((as1 && as2) || (!al1 && !al2)) - return (c1 - c2); - if (al1 && !al2) { - if (isupper(c1)) - return ('A' - c2); - else - return ('a' - c2); - } else if (al2 && !al1) { - if (isupper(c2)) - return (c1 - 'A'); - else - return (c1 - 'a'); - } - } + if (as1 || as2 || al1 || al2) { + if ((as1 && as2) || (!al1 && !al2)) + return (c1 - c2); + if (al1 && !al2) { + if (isupper(c1)) + return ('A' - c2); + else + return ('a' - c2); + } else if (al2 && !al1) { + if (isupper(c2)) + return (c1 - 'A'); + else + return (c1 - 'a'); + } + } #endif - s1[0] = c1; - s2[0] = c2; - if ((ret = strcoll(s1, s2)) != 0) - return (ret); - return (c1 - c2); + s1[0] = c1; + s2[0] = c2; + if ((ret = strcoll(s1, s2)) != 0) + return (ret); + return (c1 - c2); } /* @@ -136,17 +143,17 @@ static int collate_range_cmp (int c1, int c2) * other clumsinesses */ struct parse { - char *next; /* next character in RE */ - char *end; /* end of string (-> NUL normally) */ - int error; /* has an error been seen? */ - sop *strip; /* malloced strip */ - sopno ssize; /* malloced strip size (allocated) */ - sopno slen; /* malloced strip length (used) */ - int ncsalloc; /* number of csets allocated */ - struct re_guts *g; -# define NPAREN 10 /* we need to remember () 1-9 for back refs */ - sopno pbegin[NPAREN]; /* -> ( ([0] unused) */ - sopno pend[NPAREN]; /* -> ) ([0] unused) */ + char *next; /* next character in RE */ + char *end; /* end of string (-> NUL normally) */ + int error; /* has an error been seen? */ + sop *strip; /* malloced strip */ + sopno ssize; /* malloced strip size (allocated) */ + sopno slen; /* malloced strip length (used) */ + int ncsalloc; /* number of csets allocated */ + struct re_guts *g; +#define NPAREN 10 /* we need to remember () 1-9 for back refs */ + sopno pbegin[NPAREN]; /* -> ( ([0] unused) */ + sopno pend[NPAREN]; /* -> ) ([0] unused) */ }; /* ========= begin header generated by ./mkh ========= */ @@ -205,42 +212,42 @@ static sopno pluscount(struct parse *p, struct re_guts *g); #endif /* ========= end header generated by ./mkh ========= */ -static char nuls[10]; /* place to point scanner in event of error */ +static char nuls[10]; /* place to point scanner in event of error */ /* * macros for use with parse structure * BEWARE: these know that the parse structure is named `p' !!! */ -#define PEEK() (*p->next) -#define PEEK2() (*(p->next+1)) -#define MORE() (p->next < p->end) -#define MORE2() (p->next+1 < p->end) -#define SEE(c) (MORE() && PEEK() == (c)) -#define SEETWO(a, b) (MORE() && MORE2() && PEEK() == (a) && PEEK2() == (b)) -#define EAT(c) ((SEE(c)) ? (NEXT(), 1) : 0) -#define EATTWO(a, b) ((SEETWO(a, b)) ? (NEXT2(), 1) : 0) -#define NEXT() (p->next++) -#define NEXT2() (p->next += 2) -#define NEXTn(n) (p->next += (n)) -#define GETNEXT() (*p->next++) -#define SETERROR(e) seterr(p, (e)) -#define REQUIRE(co, e) ((co) || SETERROR(e)) -#define MUSTSEE(c, e) (REQUIRE(MORE() && PEEK() == (c), e)) -#define MUSTEAT(c, e) (REQUIRE(MORE() && GETNEXT() == (c), e)) -#define MUSTNOTSEE(c, e) (REQUIRE(!MORE() || PEEK() != (c), e)) -#define EMIT(op, sopnd) doemit(p, (sop)(op), (size_t)(sopnd)) -#define INSERT(op, pos) doinsert(p, (sop)(op), HERE()-(pos)+1, pos) -#define AHEAD(pos) dofwd(p, pos, HERE()-(pos)) -#define ASTERN(sop, pos) EMIT(sop, HERE()-pos) -#define HERE() (p->slen) -#define THERE() (p->slen - 1) -#define THERETHERE() (p->slen - 2) -#define DROP(n) (p->slen -= (n)) +#define PEEK() (*p->next) +#define PEEK2() (*(p->next + 1)) +#define MORE() (p->next < p->end) +#define MORE2() (p->next + 1 < p->end) +#define SEE(c) (MORE() && PEEK() == (c)) +#define SEETWO(a, b) (MORE() && MORE2() && PEEK() == (a) && PEEK2() == (b)) +#define EAT(c) ((SEE(c)) ? (NEXT(), 1) : 0) +#define EATTWO(a, b) ((SEETWO(a, b)) ? (NEXT2(), 1) : 0) +#define NEXT() (p->next++) +#define NEXT2() (p->next += 2) +#define NEXTn(n) (p->next += (n)) +#define GETNEXT() (*p->next++) +#define SETERROR(e) seterr(p, (e)) +#define REQUIRE(co, e) ((co) || SETERROR(e)) +#define MUSTSEE(c, e) (REQUIRE(MORE() && PEEK() == (c), e)) +#define MUSTEAT(c, e) (REQUIRE(MORE() && GETNEXT() == (c), e)) +#define MUSTNOTSEE(c, e) (REQUIRE(!MORE() || PEEK() != (c), e)) +#define EMIT(op, sopnd) doemit(p, (sop)(op), (size_t)(sopnd)) +#define INSERT(op, pos) doinsert(p, (sop)(op), HERE() - (pos) + 1, pos) +#define AHEAD(pos) dofwd(p, pos, HERE() - (pos)) +#define ASTERN(sop, pos) EMIT(sop, HERE() - pos) +#define HERE() (p->slen) +#define THERE() (p->slen - 1) +#define THERETHERE() (p->slen - 2) +#define DROP(n) (p->slen -= (n)) #ifndef NDEBUG -static int never = 0; /* for use in asserts; shuts lint up */ +static int never = 0; /* for use in asserts; shuts lint up */ #else -#define never 0 /* some s have bugs too */ +#define never 0 /* some s have bugs too */ #endif /* @@ -255,312 +262,305 @@ static int never = 0; /* for use in asserts; shuts lint up */ = #define REG_PEND 0040 = #define REG_DUMP 0200 */ -int /* 0 success, otherwise REG_something */ -yap_regcomp(preg, pattern, cflags) -regex_t *preg; +int /* 0 success, otherwise REG_something */ + yap_regcomp(preg, pattern, cflags) regex_t *preg; const char *pattern; int cflags; { - struct parse pa; - register struct re_guts *g; - register struct parse *p = &pa; - register int i; - register size_t len; + struct parse pa; + register struct re_guts *g; + register struct parse *p = &pa; + register int i; + register size_t len; #ifdef REDEBUG -# define GOODFLAGS(f) (f) +#define GOODFLAGS(f) (f) #else -# define GOODFLAGS(f) ((f)&~REG_DUMP) +#define GOODFLAGS(f) ((f) & ~REG_DUMP) #endif - cflags = GOODFLAGS(cflags); - if ((cflags®_EXTENDED) && (cflags®_NOSPEC)) - return(REG_INVARG); + cflags = GOODFLAGS(cflags); + if ((cflags & REG_EXTENDED) && (cflags & REG_NOSPEC)) + return (REG_INVARG); - if (cflags®_PEND) { - if (preg->re_endp < pattern) - return(REG_INVARG); - len = preg->re_endp - pattern; - } else - len = strlen((char *)pattern); + if (cflags & REG_PEND) { + if (preg->re_endp < pattern) + return (REG_INVARG); + len = preg->re_endp - pattern; + } else + len = strlen((char *)pattern); - /* do the mallocs early so failure handling is easy */ - g = (struct re_guts *)malloc(sizeof(struct re_guts) + - (NC-1)*sizeof(cat_t)); - if (g == NULL) - return(REG_ESPACE); - p->ssize = len/(size_t)2*(size_t)3 + (size_t)1; /* ugh */ - p->strip = (sop *)malloc(p->ssize * sizeof(sop)); - p->slen = 0; - if (p->strip == NULL) { - free((char *)g); - return(REG_ESPACE); - } + /* do the mallocs early so failure handling is easy */ + g = (struct re_guts *)malloc(sizeof(struct re_guts) + + (NC - 1) * sizeof(cat_t)); + if (g == NULL) + return (REG_ESPACE); + p->ssize = len / (size_t)2 * (size_t)3 + (size_t)1; /* ugh */ + p->strip = (sop *)malloc(p->ssize * sizeof(sop)); + p->slen = 0; + if (p->strip == NULL) { + free((char *)g); + return (REG_ESPACE); + } - /* set things up */ - p->g = g; - p->next = (char *)pattern; /* convenience; we do not modify it */ - p->end = p->next + len; - p->error = 0; - p->ncsalloc = 0; - for (i = 0; i < NPAREN; i++) { - p->pbegin[i] = 0; - p->pend[i] = 0; - } - g->csetsize = NC; - g->sets = NULL; - g->setbits = NULL; - g->ncsets = 0; - g->cflags = cflags; - g->iflags = 0; - g->nbol = 0; - g->neol = 0; - g->must = NULL; - g->mlen = 0; - g->nsub = 0; - g->ncategories = 1; /* category 0 is "everything else" */ - g->categories = &g->catspace[-(CHAR_MIN)]; - (void) memset((char *)g->catspace, 0, NC*sizeof(cat_t)); - g->backrefs = 0; + /* set things up */ + p->g = g; + p->next = (char *)pattern; /* convenience; we do not modify it */ + p->end = p->next + len; + p->error = 0; + p->ncsalloc = 0; + for (i = 0; i < NPAREN; i++) { + p->pbegin[i] = 0; + p->pend[i] = 0; + } + g->csetsize = NC; + g->sets = NULL; + g->setbits = NULL; + g->ncsets = 0; + g->cflags = cflags; + g->iflags = 0; + g->nbol = 0; + g->neol = 0; + g->must = NULL; + g->mlen = 0; + g->nsub = 0; + g->ncategories = 1; /* category 0 is "everything else" */ + g->categories = &g->catspace[-(CHAR_MIN)]; + (void)memset((char *)g->catspace, 0, NC * sizeof(cat_t)); + g->backrefs = 0; - /* do it */ - EMIT(OEND, 0); - g->firststate = THERE(); - if (cflags®_EXTENDED) - p_ere(p, OUT); - else if (cflags®_NOSPEC) - p_str(p); - else - p_bre(p, OUT, OUT); - EMIT(OEND, 0); - g->laststate = THERE(); + /* do it */ + EMIT(OEND, 0); + g->firststate = THERE(); + if (cflags & REG_EXTENDED) + p_ere(p, OUT); + else if (cflags & REG_NOSPEC) + p_str(p); + else + p_bre(p, OUT, OUT); + EMIT(OEND, 0); + g->laststate = THERE(); - /* tidy up loose ends and fill things in */ - categorize(p, g); - stripsnug(p, g); - findmust(p, g); - g->nplus = pluscount(p, g); - g->magic = MAGIC2; - preg->re_nsub = g->nsub; - preg->re_g = g; - preg->re_magic = MAGIC1; + /* tidy up loose ends and fill things in */ + categorize(p, g); + stripsnug(p, g); + findmust(p, g); + g->nplus = pluscount(p, g); + g->magic = MAGIC2; + preg->re_nsub = g->nsub; + preg->re_g = g; + preg->re_magic = MAGIC1; #ifndef REDEBUG - /* not debugging, so can't rely on the assert() in regexec() */ - if (g->iflags&BAD) - SETERROR(REG_ASSERT); + /* not debugging, so can't rely on the assert() in regexec() */ + if (g->iflags & BAD) + SETERROR(REG_ASSERT); #endif - /* win or lose, we're done */ - if (p->error != 0) /* lose */ - yap_regfree(preg); - return(p->error); + /* win or lose, we're done */ + if (p->error != 0) /* lose */ + yap_regfree(preg); + return (p->error); } /* - p_ere - ERE parser top level, concatenation and alternation == static void p_ere(register struct parse *p, int stop); */ -static void -p_ere(p, stop) -register struct parse *p; -int stop; /* character this ERE should end at */ +static void p_ere(p, stop) register struct parse *p; +int stop; /* character this ERE should end at */ { - register char c; - register sopno prevback = 0; - register sopno prevfwd = 0; - register sopno conc; - register int first = 1; /* is this the first alternative? */ + register char c; + register sopno prevback = 0; + register sopno prevfwd = 0; + register sopno conc; + register int first = 1; /* is this the first alternative? */ - for (;;) { - /* do a bunch of concatenated expressions */ - conc = HERE(); - while (MORE() && (c = PEEK()) != '|' && c != stop) - p_ere_exp(p); - (void)REQUIRE(HERE() != conc, REG_EMPTY); /* require nonempty */ + for (;;) { + /* do a bunch of concatenated expressions */ + conc = HERE(); + while (MORE() && (c = PEEK()) != '|' && c != stop) + p_ere_exp(p); + (void)REQUIRE(HERE() != conc, REG_EMPTY); /* require nonempty */ - if (!EAT('|')) - break; /* NOTE BREAK OUT */ + if (!EAT('|')) + break; /* NOTE BREAK OUT */ - if (first) { - INSERT(OCH_, conc); /* offset is wrong */ - prevfwd = conc; - prevback = conc; - first = 0; - } - ASTERN(OOR1, prevback); - prevback = THERE(); - AHEAD(prevfwd); /* fix previous offset */ - prevfwd = HERE(); - EMIT(OOR2, 0); /* offset is very wrong */ - } + if (first) { + INSERT(OCH_, conc); /* offset is wrong */ + prevfwd = conc; + prevback = conc; + first = 0; + } + ASTERN(OOR1, prevback); + prevback = THERE(); + AHEAD(prevfwd); /* fix previous offset */ + prevfwd = HERE(); + EMIT(OOR2, 0); /* offset is very wrong */ + } - if (!first) { /* tail-end fixups */ - AHEAD(prevfwd); - ASTERN(O_CH, prevback); - } + if (!first) { /* tail-end fixups */ + AHEAD(prevfwd); + ASTERN(O_CH, prevback); + } - assert(!MORE() || SEE(stop)); + assert(!MORE() || SEE(stop)); } /* - p_ere_exp - parse one subERE, an atom possibly followed by a repetition op == static void p_ere_exp(register struct parse *p); */ -static void -p_ere_exp(p) -register struct parse *p; +static void p_ere_exp(p) register struct parse *p; { - register char c; - register sopno pos; - register int count; - register int count2; - register sopno subno; - int wascaret = 0; + register char c; + register sopno pos; + register int count; + register int count2; + register sopno subno; + int wascaret = 0; - assert(MORE()); /* caller should have ensured this */ - c = GETNEXT(); + assert(MORE()); /* caller should have ensured this */ + c = GETNEXT(); - pos = HERE(); - switch (c) { - case '(': - (void)REQUIRE(MORE(), REG_EPAREN); - p->g->nsub++; - subno = p->g->nsub; - if (subno < NPAREN) - p->pbegin[subno] = HERE(); - EMIT(OLPAREN, subno); - if (!SEE(')')) - p_ere(p, ')'); - if (subno < NPAREN) { - p->pend[subno] = HERE(); - assert(p->pend[subno] != 0); - } - EMIT(ORPAREN, subno); - (void)MUSTEAT(')', REG_EPAREN); - break; + pos = HERE(); + switch (c) { + case '(': + (void)REQUIRE(MORE(), REG_EPAREN); + p->g->nsub++; + subno = p->g->nsub; + if (subno < NPAREN) + p->pbegin[subno] = HERE(); + EMIT(OLPAREN, subno); + if (!SEE(')')) + p_ere(p, ')'); + if (subno < NPAREN) { + p->pend[subno] = HERE(); + assert(p->pend[subno] != 0); + } + EMIT(ORPAREN, subno); + (void)MUSTEAT(')', REG_EPAREN); + break; #ifndef POSIX_MISTAKE - case ')': /* happens only if no current unmatched ( */ - /* - * You may ask, why the ifndef? Because I didn't notice - * this until slightly too late for 1003.2, and none of the - * other 1003.2 regular-expression reviewers noticed it at - * all. So an unmatched ) is legal POSIX, at least until - * we can get it fixed. - */ - SETERROR(REG_EPAREN); - break; + case ')': /* happens only if no current unmatched ( */ + /* + * You may ask, why the ifndef? Because I didn't notice + * this until slightly too late for 1003.2, and none of the + * other 1003.2 regular-expression reviewers noticed it at + * all. So an unmatched ) is legal POSIX, at least until + * we can get it fixed. + */ + SETERROR(REG_EPAREN); + break; #endif - case '^': - EMIT(OBOL, 0); - p->g->iflags |= USEBOL; - p->g->nbol++; - wascaret = 1; - break; - case '$': - EMIT(OEOL, 0); - p->g->iflags |= USEEOL; - p->g->neol++; - break; - case '|': - SETERROR(REG_EMPTY); - break; - case '*': - case '+': - case '?': - SETERROR(REG_BADRPT); - break; - case '.': - if (p->g->cflags®_NEWLINE) - nonnewline(p); - else - EMIT(OANY, 0); - break; - case '[': - p_bracket(p); - break; - case '\\': - (void)REQUIRE(MORE(), REG_EESCAPE); - c = GETNEXT(); - ordinary(p, c); - break; - case '{': /* okay as ordinary except if digit follows */ - (void)REQUIRE(!MORE() || !isdigit((uch)PEEK()), REG_BADRPT); - /* FALLTHROUGH */ - default: - ordinary(p, c); - break; - } + case '^': + EMIT(OBOL, 0); + p->g->iflags |= USEBOL; + p->g->nbol++; + wascaret = 1; + break; + case '$': + EMIT(OEOL, 0); + p->g->iflags |= USEEOL; + p->g->neol++; + break; + case '|': + SETERROR(REG_EMPTY); + break; + case '*': + case '+': + case '?': + SETERROR(REG_BADRPT); + break; + case '.': + if (p->g->cflags & REG_NEWLINE) + nonnewline(p); + else + EMIT(OANY, 0); + break; + case '[': + p_bracket(p); + break; + case '\\': + (void)REQUIRE(MORE(), REG_EESCAPE); + c = GETNEXT(); + ordinary(p, c); + break; + case '{': /* okay as ordinary except if digit follows */ + (void)REQUIRE(!MORE() || !isdigit((uch)PEEK()), REG_BADRPT); + /* FALLTHROUGH */ + default: + ordinary(p, c); + break; + } - if (!MORE()) - return; - c = PEEK(); - /* we call { a repetition if followed by a digit */ - if (!( c == '*' || c == '+' || c == '?' || - (c == '{' && MORE2() && isdigit((uch)PEEK2())) )) - return; /* no repetition, we're done */ - NEXT(); + if (!MORE()) + return; + c = PEEK(); + /* we call { a repetition if followed by a digit */ + if (!(c == '*' || c == '+' || c == '?' || + (c == '{' && MORE2() && isdigit((uch)PEEK2())))) + return; /* no repetition, we're done */ + NEXT(); - (void)REQUIRE(!wascaret, REG_BADRPT); - switch (c) { - case '*': /* implemented as +? */ - /* this case does not require the (y|) trick, noKLUDGE */ - INSERT(OPLUS_, pos); - ASTERN(O_PLUS, pos); - INSERT(OQUEST_, pos); - ASTERN(O_QUEST, pos); - break; - case '+': - INSERT(OPLUS_, pos); - ASTERN(O_PLUS, pos); - break; - case '?': - /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ - INSERT(OCH_, pos); /* offset slightly wrong */ - ASTERN(OOR1, pos); /* this one's right */ - AHEAD(pos); /* fix the OCH_ */ - EMIT(OOR2, 0); /* offset very wrong... */ - AHEAD(THERE()); /* ...so fix it */ - ASTERN(O_CH, THERETHERE()); - break; - case '{': - count = p_count(p); - if (EAT(',')) { - if (isdigit((uch)PEEK())) { - count2 = p_count(p); - (void)REQUIRE(count <= count2, REG_BADBR); - } else /* single number with comma */ - count2 = INFINITY; - } else /* just a single number */ - count2 = count; - repeat(p, pos, count, count2); - if (!EAT('}')) { /* error heuristics */ - while (MORE() && PEEK() != '}') - NEXT(); - (void)REQUIRE(MORE(), REG_EBRACE); - SETERROR(REG_BADBR); - } - break; - } + (void)REQUIRE(!wascaret, REG_BADRPT); + switch (c) { + case '*': /* implemented as +? */ + /* this case does not require the (y|) trick, noKLUDGE */ + INSERT(OPLUS_, pos); + ASTERN(O_PLUS, pos); + INSERT(OQUEST_, pos); + ASTERN(O_QUEST, pos); + break; + case '+': + INSERT(OPLUS_, pos); + ASTERN(O_PLUS, pos); + break; + case '?': + /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ + INSERT(OCH_, pos); /* offset slightly wrong */ + ASTERN(OOR1, pos); /* this one's right */ + AHEAD(pos); /* fix the OCH_ */ + EMIT(OOR2, 0); /* offset very wrong... */ + AHEAD(THERE()); /* ...so fix it */ + ASTERN(O_CH, THERETHERE()); + break; + case '{': + count = p_count(p); + if (EAT(',')) { + if (isdigit((uch)PEEK())) { + count2 = p_count(p); + (void)REQUIRE(count <= count2, REG_BADBR); + } else /* single number with comma */ + count2 = INFINITY; + } else /* just a single number */ + count2 = count; + repeat(p, pos, count, count2); + if (!EAT('}')) { /* error heuristics */ + while (MORE() && PEEK() != '}') + NEXT(); + (void)REQUIRE(MORE(), REG_EBRACE); + SETERROR(REG_BADBR); + } + break; + } - if (!MORE()) - return; - c = PEEK(); - if (!( c == '*' || c == '+' || c == '?' || - (c == '{' && MORE2() && isdigit((uch)PEEK2())) ) ) - return; - SETERROR(REG_BADRPT); + if (!MORE()) + return; + c = PEEK(); + if (!(c == '*' || c == '+' || c == '?' || + (c == '{' && MORE2() && isdigit((uch)PEEK2())))) + return; + SETERROR(REG_BADRPT); } /* - p_str - string (no metacharacters) "parser" == static void p_str(register struct parse *p); */ -static void -p_str(p) -register struct parse *p; +static void p_str(p) register struct parse *p; { - (void)REQUIRE(MORE(), REG_EMPTY); - while (MORE()) - ordinary(p, GETNEXT()); + (void)REQUIRE(MORE(), REG_EMPTY); + while (MORE()) + ordinary(p, GETNEXT()); } /* @@ -575,171 +575,167 @@ register struct parse *p; * category in such cases. This is fairly harmless; not worth fixing. * The amount of lookahead needed to avoid this kludge is excessive. */ -static void -p_bre(p, end1, end2) -register struct parse *p; -register int end1; /* first terminating character */ -register int end2; /* second terminating character */ +static void p_bre(p, end1, end2) register struct parse *p; +register int end1; /* first terminating character */ +register int end2; /* second terminating character */ { - register sopno start = HERE(); - register int first = 1; /* first subexpression? */ - register int wasdollar = 0; + register sopno start = HERE(); + register int first = 1; /* first subexpression? */ + register int wasdollar = 0; - if (EAT('^')) { - EMIT(OBOL, 0); - p->g->iflags |= USEBOL; - p->g->nbol++; - } - while (MORE() && !SEETWO(end1, end2)) { - wasdollar = p_simp_re(p, first); - first = 0; - } - if (wasdollar) { /* oops, that was a trailing anchor */ - DROP(1); - EMIT(OEOL, 0); - p->g->iflags |= USEEOL; - p->g->neol++; - } + if (EAT('^')) { + EMIT(OBOL, 0); + p->g->iflags |= USEBOL; + p->g->nbol++; + } + while (MORE() && !SEETWO(end1, end2)) { + wasdollar = p_simp_re(p, first); + first = 0; + } + if (wasdollar) { /* oops, that was a trailing anchor */ + DROP(1); + EMIT(OEOL, 0); + p->g->iflags |= USEEOL; + p->g->neol++; + } - (void)REQUIRE(HERE() != start, REG_EMPTY); /* require nonempty */ + (void)REQUIRE(HERE() != start, REG_EMPTY); /* require nonempty */ } /* - p_simp_re - parse a simple RE, an atom possibly followed by a repetition == static int p_simp_re(register struct parse *p, int starordinary); */ -static int /* was the simple RE an unbackslashed $? */ -p_simp_re(p, starordinary) -register struct parse *p; -int starordinary; /* is a leading * an ordinary character? */ +static int /* was the simple RE an unbackslashed $? */ + p_simp_re(p, starordinary) register struct parse *p; +int starordinary; /* is a leading * an ordinary character? */ { - register int c; - register int count; - register int count2; - register sopno pos; - register int i; - register sopno subno; -# define BACKSL (1<g->cflags®_NEWLINE) - nonnewline(p); - else - EMIT(OANY, 0); - break; - case '[': - p_bracket(p); - break; - case BACKSL|'{': - SETERROR(REG_BADRPT); - break; - case BACKSL|'(': - p->g->nsub++; - subno = p->g->nsub; - if (subno < NPAREN) - p->pbegin[subno] = HERE(); - EMIT(OLPAREN, subno); - /* the MORE here is an error heuristic */ - if (MORE() && !SEETWO('\\', ')')) - p_bre(p, '\\', ')'); - if (subno < NPAREN) { - p->pend[subno] = HERE(); - assert(p->pend[subno] != 0); - } - EMIT(ORPAREN, subno); - (void)REQUIRE(EATTWO('\\', ')'), REG_EPAREN); - break; - case BACKSL|')': /* should not get here -- must be user */ - case BACKSL|'}': - SETERROR(REG_EPAREN); - break; - case BACKSL|'1': - case BACKSL|'2': - case BACKSL|'3': - case BACKSL|'4': - case BACKSL|'5': - case BACKSL|'6': - case BACKSL|'7': - case BACKSL|'8': - case BACKSL|'9': - i = (c&~BACKSL) - '0'; - assert(i < NPAREN); - if (p->pend[i] != 0) { - assert(i <= p->g->nsub); - EMIT(OBACK_, i); - assert(p->pbegin[i] != 0); - assert(OP(p->strip[p->pbegin[i]]) == OLPAREN); - assert(OP(p->strip[p->pend[i]]) == ORPAREN); - (void) dupl(p, p->pbegin[i]+1, p->pend[i]); - EMIT(O_BACK, i); - } else - SETERROR(REG_ESUBREG); - p->g->backrefs = 1; - break; - case '*': - (void)REQUIRE(starordinary, REG_BADRPT); - /* FALLTHROUGH */ - default: - ordinary(p, (char)c); - break; - } + assert(MORE()); /* caller should have ensured this */ + c = GETNEXT(); + if (c == '\\') { + (void)REQUIRE(MORE(), REG_EESCAPE); + c = BACKSL | GETNEXT(); + } + switch (c) { + case '.': + if (p->g->cflags & REG_NEWLINE) + nonnewline(p); + else + EMIT(OANY, 0); + break; + case '[': + p_bracket(p); + break; + case BACKSL | '{': + SETERROR(REG_BADRPT); + break; + case BACKSL | '(': + p->g->nsub++; + subno = p->g->nsub; + if (subno < NPAREN) + p->pbegin[subno] = HERE(); + EMIT(OLPAREN, subno); + /* the MORE here is an error heuristic */ + if (MORE() && !SEETWO('\\', ')')) + p_bre(p, '\\', ')'); + if (subno < NPAREN) { + p->pend[subno] = HERE(); + assert(p->pend[subno] != 0); + } + EMIT(ORPAREN, subno); + (void)REQUIRE(EATTWO('\\', ')'), REG_EPAREN); + break; + case BACKSL | ')': /* should not get here -- must be user */ + case BACKSL | '}': + SETERROR(REG_EPAREN); + break; + case BACKSL | '1': + case BACKSL | '2': + case BACKSL | '3': + case BACKSL | '4': + case BACKSL | '5': + case BACKSL | '6': + case BACKSL | '7': + case BACKSL | '8': + case BACKSL | '9': + i = (c & ~BACKSL) - '0'; + assert(i < NPAREN); + if (p->pend[i] != 0) { + assert(i <= p->g->nsub); + EMIT(OBACK_, i); + assert(p->pbegin[i] != 0); + assert(OP(p->strip[p->pbegin[i]]) == OLPAREN); + assert(OP(p->strip[p->pend[i]]) == ORPAREN); + (void)dupl(p, p->pbegin[i] + 1, p->pend[i]); + EMIT(O_BACK, i); + } else + SETERROR(REG_ESUBREG); + p->g->backrefs = 1; + break; + case '*': + (void)REQUIRE(starordinary, REG_BADRPT); + /* FALLTHROUGH */ + default: + ordinary(p, (char)c); + break; + } - if (EAT('*')) { /* implemented as +? */ - /* this case does not require the (y|) trick, noKLUDGE */ - INSERT(OPLUS_, pos); - ASTERN(O_PLUS, pos); - INSERT(OQUEST_, pos); - ASTERN(O_QUEST, pos); - } else if (EATTWO('\\', '{')) { - count = p_count(p); - if (EAT(',')) { - if (MORE() && isdigit((uch)PEEK())) { - count2 = p_count(p); - (void)REQUIRE(count <= count2, REG_BADBR); - } else /* single number with comma */ - count2 = INFINITY; - } else /* just a single number */ - count2 = count; - repeat(p, pos, count, count2); - if (!EATTWO('\\', '}')) { /* error heuristics */ - while (MORE() && !SEETWO('\\', '}')) - NEXT(); - (void)REQUIRE(MORE(), REG_EBRACE); - SETERROR(REG_BADBR); - } - } else if (c == '$') /* $ (but not \$) ends it */ - return(1); + if (EAT('*')) { /* implemented as +? */ + /* this case does not require the (y|) trick, noKLUDGE */ + INSERT(OPLUS_, pos); + ASTERN(O_PLUS, pos); + INSERT(OQUEST_, pos); + ASTERN(O_QUEST, pos); + } else if (EATTWO('\\', '{')) { + count = p_count(p); + if (EAT(',')) { + if (MORE() && isdigit((uch)PEEK())) { + count2 = p_count(p); + (void)REQUIRE(count <= count2, REG_BADBR); + } else /* single number with comma */ + count2 = INFINITY; + } else /* just a single number */ + count2 = count; + repeat(p, pos, count, count2); + if (!EATTWO('\\', '}')) { /* error heuristics */ + while (MORE() && !SEETWO('\\', '}')) + NEXT(); + (void)REQUIRE(MORE(), REG_EBRACE); + SETERROR(REG_BADBR); + } + } else if (c == '$') /* $ (but not \$) ends it */ + return (1); - return(0); + return (0); } /* - p_count - parse a repetition count == static int p_count(register struct parse *p); */ -static int /* the value */ -p_count(p) -register struct parse *p; +static int /* the value */ + p_count(p) register struct parse *p; { - register int count = 0; - register int ndigits = 0; + register int count = 0; + register int ndigits = 0; - while (MORE() && isdigit((uch)PEEK()) && count <= DUPMAX) { - count = count*10 + (GETNEXT() - '0'); - ndigits++; - } + while (MORE() && isdigit((uch)PEEK()) && count <= DUPMAX) { + count = count * 10 + (GETNEXT() - '0'); + ndigits++; + } - (void)REQUIRE(ndigits > 0 && count <= DUPMAX, REG_BADBR); - return(count); + (void)REQUIRE(ndigits > 0 && count <= DUPMAX, REG_BADBR); + return (count); } /* @@ -749,243 +745,236 @@ register struct parse *p; * Note a significant property of this code: if the allocset() did SETERROR, * no set operations are done. */ -static void -p_bracket(p) -register struct parse *p; +static void p_bracket(p) register struct parse *p; { - register cset *cs = allocset(p); - register int invert = 0; + register cset *cs = allocset(p); + register int invert = 0; - /* Dept of Truly Sickening Special-Case Kludges */ - if (p->next + 5 < p->end && strncmp(p->next, "[:<:]]", 6) == 0) { - EMIT(OBOW, 0); - NEXTn(6); - return; - } - if (p->next + 5 < p->end && strncmp(p->next, "[:>:]]", 6) == 0) { - EMIT(OEOW, 0); - NEXTn(6); - return; - } + /* Dept of Truly Sickening Special-Case Kludges */ + if (p->next + 5 < p->end && strncmp(p->next, "[:<:]]", 6) == 0) { + EMIT(OBOW, 0); + NEXTn(6); + return; + } + if (p->next + 5 < p->end && strncmp(p->next, "[:>:]]", 6) == 0) { + EMIT(OEOW, 0); + NEXTn(6); + return; + } - if (EAT('^')) - invert++; /* make note to invert set at end */ - if (EAT(']')) - CHadd(cs, ']'); - else if (EAT('-')) - CHadd(cs, '-'); - while (MORE() && PEEK() != ']' && !SEETWO('-', ']')) - p_b_term(p, cs); - if (EAT('-')) - CHadd(cs, '-'); - (void)MUSTEAT(']', REG_EBRACK); + if (EAT('^')) + invert++; /* make note to invert set at end */ + if (EAT(']')) + CHadd(cs, ']'); + else if (EAT('-')) + CHadd(cs, '-'); + while (MORE() && PEEK() != ']' && !SEETWO('-', ']')) + p_b_term(p, cs); + if (EAT('-')) + CHadd(cs, '-'); + (void)MUSTEAT(']', REG_EBRACK); - if (p->error != 0) /* don't mess things up further */ - return; + if (p->error != 0) /* don't mess things up further */ + return; - if (p->g->cflags®_ICASE) { - register int i; - register int ci; + if (p->g->cflags & REG_ICASE) { + register int i; + register int ci; - for (i = p->g->csetsize - 1; i >= 0; i--) - if (CHIN(cs, i) && isalpha(i)) { - ci = othercase(i); - if (ci != i) - CHadd(cs, ci); - } - if (cs->multis != NULL) - mccase(p, cs); - } - if (invert) { - register int i; + for (i = p->g->csetsize - 1; i >= 0; i--) + if (CHIN(cs, i) && isalpha(i)) { + ci = othercase(i); + if (ci != i) + CHadd(cs, ci); + } + if (cs->multis != NULL) + mccase(p, cs); + } + if (invert) { + register int i; - for (i = p->g->csetsize - 1; i >= 0; i--) - if (CHIN(cs, i)) - CHsub(cs, i); - else - CHadd(cs, i); - if (p->g->cflags®_NEWLINE) - CHsub(cs, '\n'); - if (cs->multis != NULL) - mcinvert(p, cs); - } + for (i = p->g->csetsize - 1; i >= 0; i--) + if (CHIN(cs, i)) + CHsub(cs, i); + else + CHadd(cs, i); + if (p->g->cflags & REG_NEWLINE) + CHsub(cs, '\n'); + if (cs->multis != NULL) + mcinvert(p, cs); + } - assert(cs->multis == NULL); /* xxx */ + assert(cs->multis == NULL); /* xxx */ - if (nch(p, cs) == 1) { /* optimize singleton sets */ - ordinary(p, firstch(p, cs)); - freeset(p, cs); - } else - EMIT(OANYOF, freezeset(p, cs)); + if (nch(p, cs) == 1) { /* optimize singleton sets */ + ordinary(p, firstch(p, cs)); + freeset(p, cs); + } else + EMIT(OANYOF, freezeset(p, cs)); } /* - p_b_term - parse one term of a bracketed character list == static void p_b_term(register struct parse *p, register cset *cs); */ -static void -p_b_term(p, cs) -register struct parse *p; +static void p_b_term(p, cs) register struct parse *p; register cset *cs; { - register char c; - register char start, finish; - register int i; + register char c; + register char start, finish; + register int i; - /* classify what we've got */ - switch ((MORE()) ? PEEK() : '\0') { - case '[': - c = (MORE2()) ? PEEK2() : '\0'; - break; - case '-': - SETERROR(REG_ERANGE); - return; /* NOTE RETURN */ - break; - default: - c = '\0'; - break; - } + /* classify what we've got */ + switch ((MORE()) ? PEEK() : '\0') { + case '[': + c = (MORE2()) ? PEEK2() : '\0'; + break; + case '-': + SETERROR(REG_ERANGE); + return; /* NOTE RETURN */ + break; + default: + c = '\0'; + break; + } - switch (c) { - case ':': /* character class */ - NEXT2(); - (void)REQUIRE(MORE(), REG_EBRACK); - c = PEEK(); - (void)REQUIRE(c != '-' && c != ']', REG_ECTYPE); - p_b_cclass(p, cs); - (void)REQUIRE(MORE(), REG_EBRACK); - (void)REQUIRE(EATTWO(':', ']'), REG_ECTYPE); - break; - case '=': /* equivalence class */ - NEXT2(); - (void)REQUIRE(MORE(), REG_EBRACK); - c = PEEK(); - (void)REQUIRE(c != '-' && c != ']', REG_ECOLLATE); - p_b_eclass(p, cs); - (void)REQUIRE(MORE(), REG_EBRACK); - (void)REQUIRE(EATTWO('=', ']'), REG_ECOLLATE); - break; - default: /* symbol, ordinary character, or range */ -/* xxx revision needed for multichar stuff */ - start = p_b_symbol(p); - if (SEE('-') && MORE2() && PEEK2() != ']') { - /* range */ - NEXT(); - if (EAT('-')) - finish = '-'; - else - finish = p_b_symbol(p); - } else - finish = start; - if (start == finish) - CHadd(cs, start); - else { - if (collate_load_error) { - (void)REQUIRE((uch)start <= (uch)finish, REG_ERANGE); - for (i = (uch)start; i <= (uch)finish; i++) - CHadd(cs, i); - } else { - (void)REQUIRE(collate_range_cmp(start, finish) <= 0, REG_ERANGE); - for (i = CHAR_MIN; i <= CHAR_MAX; i++) { - if ( collate_range_cmp(start, i) <= 0 - && collate_range_cmp(i, finish) <= 0 - ) - CHadd(cs, i); - } - } - } - break; - } + switch (c) { + case ':': /* character class */ + NEXT2(); + (void)REQUIRE(MORE(), REG_EBRACK); + c = PEEK(); + (void)REQUIRE(c != '-' && c != ']', REG_ECTYPE); + p_b_cclass(p, cs); + (void)REQUIRE(MORE(), REG_EBRACK); + (void)REQUIRE(EATTWO(':', ']'), REG_ECTYPE); + break; + case '=': /* equivalence class */ + NEXT2(); + (void)REQUIRE(MORE(), REG_EBRACK); + c = PEEK(); + (void)REQUIRE(c != '-' && c != ']', REG_ECOLLATE); + p_b_eclass(p, cs); + (void)REQUIRE(MORE(), REG_EBRACK); + (void)REQUIRE(EATTWO('=', ']'), REG_ECOLLATE); + break; + default: /* symbol, ordinary character, or range */ + /* xxx revision needed for multichar stuff */ + start = p_b_symbol(p); + if (SEE('-') && MORE2() && PEEK2() != ']') { + /* range */ + NEXT(); + if (EAT('-')) + finish = '-'; + else + finish = p_b_symbol(p); + } else + finish = start; + if (start == finish) + CHadd(cs, start); + else { + if (collate_load_error) { + (void)REQUIRE((uch)start <= (uch)finish, REG_ERANGE); + for (i = (uch)start; i <= (uch)finish; i++) + CHadd(cs, i); + } else { + (void)REQUIRE(collate_range_cmp(start, finish) <= 0, REG_ERANGE); + for (i = CHAR_MIN; i <= CHAR_MAX; i++) { + if (collate_range_cmp(start, i) <= 0 && + collate_range_cmp(i, finish) <= 0) + CHadd(cs, i); + } + } + } + break; + } } /* - p_b_cclass - parse a character-class name and deal with it == static void p_b_cclass(register struct parse *p, register cset *cs); */ -static void -p_b_cclass(p, cs) -register struct parse *p; +static void p_b_cclass(p, cs) register struct parse *p; register cset *cs; { - register int c; - register char *sp = p->next; - register struct cclass *cp; - register size_t len; + register int c; + register char *sp = p->next; + register struct cclass *cp; + register size_t len; - while (MORE() && isalpha((uch)PEEK())) - NEXT(); - len = p->next - sp; - for (cp = cclasses; cp->name != NULL; cp++) - if (strncmp(cp->name, sp, len) == 0 && cp->name[len] == '\0') - break; - if (cp->name == NULL) { - /* oops, didn't find it */ - SETERROR(REG_ECTYPE); - return; - } + while (MORE() && isalpha((uch)PEEK())) + NEXT(); + len = p->next - sp; + for (cp = cclasses; cp->name != NULL; cp++) + if (strncmp(cp->name, sp, len) == 0 && cp->name[len] == '\0') + break; + if (cp->name == NULL) { + /* oops, didn't find it */ + SETERROR(REG_ECTYPE); + return; + } - switch (cp->fidx) { - case CALNUM: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isalpha((uch)c) || isdigit((uch)c)) - CHadd(cs, c); - break; - case CALPHA: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isalpha((uch)c)) - CHadd(cs, c); - break; - case CBLANK: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (((uch)c) == ' ' || ((uch)c) == '\t') - CHadd(cs, c); - break; - case CCNTRL: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (iscntrl((uch)c)) - CHadd(cs, c); - break; - case CDIGIT: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isdigit((uch)c)) - CHadd(cs, c); - break; - case CGRAPH: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isgraph((uch)c)) - CHadd(cs, c); - break; - case CLOWER: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (islower((uch)c)) - CHadd(cs, c); - break; - case CPRINT: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isprint((uch)c)) - CHadd(cs, c); - break; - case CPUNCT: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (ispunct((uch)c)) - CHadd(cs, c); - break; - case CSPACE: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isspace((uch)c)) - CHadd(cs, c); - break; - case CUPPER: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isupper((uch)c)) - CHadd(cs, c); - break; - case CXDIGIT: - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (isxdigit((uch)c)) - CHadd(cs, c); - break; - } + switch (cp->fidx) { + case CALNUM: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isalpha((uch)c) || isdigit((uch)c)) + CHadd(cs, c); + break; + case CALPHA: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isalpha((uch)c)) + CHadd(cs, c); + break; + case CBLANK: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (((uch)c) == ' ' || ((uch)c) == '\t') + CHadd(cs, c); + break; + case CCNTRL: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (iscntrl((uch)c)) + CHadd(cs, c); + break; + case CDIGIT: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isdigit((uch)c)) + CHadd(cs, c); + break; + case CGRAPH: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isgraph((uch)c)) + CHadd(cs, c); + break; + case CLOWER: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (islower((uch)c)) + CHadd(cs, c); + break; + case CPRINT: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isprint((uch)c)) + CHadd(cs, c); + break; + case CPUNCT: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (ispunct((uch)c)) + CHadd(cs, c); + break; + case CSPACE: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isspace((uch)c)) + CHadd(cs, c); + break; + case CUPPER: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isupper((uch)c)) + CHadd(cs, c); + break; + case CXDIGIT: + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (isxdigit((uch)c)) + CHadd(cs, c); + break; + } #if 0 for (u = cp->multis; *u != '\0'; u += strlen(u) + 1) MCadd(p, cs, u); @@ -998,82 +987,77 @@ register cset *cs; * * This implementation is incomplete. xxx */ -static void -p_b_eclass(p, cs) -register struct parse *p; +static void p_b_eclass(p, cs) register struct parse *p; register cset *cs; { - register char c; + register char c; - c = p_b_coll_elem(p, '='); - CHadd(cs, c); + c = p_b_coll_elem(p, '='); + CHadd(cs, c); } /* - p_b_symbol - parse a character or [..]ed multicharacter collating symbol == static char p_b_symbol(register struct parse *p); */ -static char /* value of symbol */ -p_b_symbol(p) -register struct parse *p; +static char /* value of symbol */ + p_b_symbol(p) register struct parse *p; { - register char value; + register char value; - (void)REQUIRE(MORE(), REG_EBRACK); - if (!EATTWO('[', '.')) - return(GETNEXT()); + (void)REQUIRE(MORE(), REG_EBRACK); + if (!EATTWO('[', '.')) + return (GETNEXT()); - /* collating symbol */ - value = p_b_coll_elem(p, '.'); - (void)REQUIRE(EATTWO('.', ']'), REG_ECOLLATE); - return(value); + /* collating symbol */ + value = p_b_coll_elem(p, '.'); + (void)REQUIRE(EATTWO('.', ']'), REG_ECOLLATE); + return (value); } /* - p_b_coll_elem - parse a collating-element name and look it up == static char p_b_coll_elem(register struct parse *p, int endc); */ -static char /* value of collating element */ -p_b_coll_elem(p, endc) -register struct parse *p; -int endc; /* name ended by endc,']' */ +static char /* value of collating element */ + p_b_coll_elem(p, endc) register struct parse *p; +int endc; /* name ended by endc,']' */ { - register char *sp = p->next; - register struct cname *cp; - register int len; + register char *sp = p->next; + register struct cname *cp; + register int len; - while (MORE() && !SEETWO(endc, ']')) - NEXT(); - if (!MORE()) { - SETERROR(REG_EBRACK); - return(0); - } - len = p->next - sp; - for (cp = cnames; cp->name != NULL; cp++) - if (strncmp(cp->name, sp, len) == 0 && cp->name[len] == '\0') - return(cp->code); /* known name */ - if (len == 1) - return(*sp); /* single character */ - SETERROR(REG_ECOLLATE); /* neither */ - return(0); + while (MORE() && !SEETWO(endc, ']')) + NEXT(); + if (!MORE()) { + SETERROR(REG_EBRACK); + return (0); + } + len = p->next - sp; + for (cp = cnames; cp->name != NULL; cp++) + if (strncmp(cp->name, sp, len) == 0 && cp->name[len] == '\0') + return (cp->code); /* known name */ + if (len == 1) + return (*sp); /* single character */ + SETERROR(REG_ECOLLATE); /* neither */ + return (0); } /* - othercase - return the case counterpart of an alphabetic == static char othercase(int ch); */ -static char /* if no counterpart, return ch */ -othercase(ch) -int ch; +static char /* if no counterpart, return ch */ + othercase(ch) int ch; { - ch = (uch)ch; - assert(isalpha(ch)); - if (isupper(ch)) - return(tolower(ch)); - else if (islower(ch)) - return(toupper(ch)); - else /* peculiar, but could happen */ - return(ch); + ch = (uch)ch; + assert(isalpha(ch)); + if (isupper(ch)) + return (tolower(ch)); + else if (islower(ch)) + return (toupper(ch)); + else /* peculiar, but could happen */ + return (ch); } /* @@ -1082,46 +1066,42 @@ int ch; * * Boy, is this implementation ever a kludge... */ -static void -bothcases(p, ch) -register struct parse *p; +static void bothcases(p, ch) register struct parse *p; int ch; { - register char *oldnext = p->next; - register char *oldend = p->end; - char bracket[3]; + register char *oldnext = p->next; + register char *oldend = p->end; + char bracket[3]; - ch = (uch)ch; - assert(othercase(ch) != ch); /* p_bracket() would recurse */ - p->next = bracket; - p->end = bracket+2; - bracket[0] = ch; - bracket[1] = ']'; - bracket[2] = '\0'; - p_bracket(p); - assert(p->next == bracket+2); - p->next = oldnext; - p->end = oldend; + ch = (uch)ch; + assert(othercase(ch) != ch); /* p_bracket() would recurse */ + p->next = bracket; + p->end = bracket + 2; + bracket[0] = ch; + bracket[1] = ']'; + bracket[2] = '\0'; + p_bracket(p); + assert(p->next == bracket + 2); + p->next = oldnext; + p->end = oldend; } /* - ordinary - emit an ordinary character == static void ordinary(register struct parse *p, register int ch); */ -static void -ordinary(p, ch) -register struct parse *p; +static void ordinary(p, ch) register struct parse *p; register int ch; { - register cat_t *cap = p->g->categories; + register cat_t *cap = p->g->categories; - if ((p->g->cflags®_ICASE) && isalpha((uch)ch) && othercase(ch) != ch) - bothcases(p, ch); - else { - EMIT(OCHAR, (uch)ch); - if (cap[ch] == 0) - cap[ch] = p->g->ncategories++; - } + if ((p->g->cflags & REG_ICASE) && isalpha((uch)ch) && othercase(ch) != ch) + bothcases(p, ch); + else { + EMIT(OCHAR, (uch)ch); + if (cap[ch] == 0) + cap[ch] = p->g->ncategories++; + } } /* @@ -1130,186 +1110,174 @@ register int ch; * * Boy, is this implementation ever a kludge... */ -static void -nonnewline(p) -register struct parse *p; +static void nonnewline(p) register struct parse *p; { - register char *oldnext = p->next; - register char *oldend = p->end; - char bracket[4]; + register char *oldnext = p->next; + register char *oldend = p->end; + char bracket[4]; - p->next = bracket; - p->end = bracket+3; - bracket[0] = '^'; - bracket[1] = '\n'; - bracket[2] = ']'; - bracket[3] = '\0'; - p_bracket(p); - assert(p->next == bracket+3); - p->next = oldnext; - p->end = oldend; + p->next = bracket; + p->end = bracket + 3; + bracket[0] = '^'; + bracket[1] = '\n'; + bracket[2] = ']'; + bracket[3] = '\0'; + p_bracket(p); + assert(p->next == bracket + 3); + p->next = oldnext; + p->end = oldend; } /* - repeat - generate code for a bounded repetition, recursively if needed == static void repeat(register struct parse *p, sopno start, int from, int to); */ -static void -repeat(p, start, from, to) -register struct parse *p; -sopno start; /* operand from here to end of strip */ -int from; /* repeated from this number */ -int to; /* to this number of times (maybe INFINITY) */ +static void repeat(p, start, from, to) register struct parse *p; +sopno start; /* operand from here to end of strip */ +int from; /* repeated from this number */ +int to; /* to this number of times (maybe INFINITY) */ { - register sopno finish = HERE(); -# define N 2 -# define INF 3 -# define REP(f, t) ((f)*8 + (t)) -# define MAP(n) (((n) <= 1) ? (n) : ((n) == INFINITY) ? INF : N) - register sopno copy; + register sopno finish = HERE(); +#define N 2 +#define INF 3 +#define REP(f, t) ((f)*8 + (t)) +#define MAP(n) (((n) <= 1) ? (n) : ((n) == INFINITY) ? INF : N) + register sopno copy; - if (p->error != 0) /* head off possible runaway recursion */ - return; + if (p->error != 0) /* head off possible runaway recursion */ + return; - assert(from <= to); + assert(from <= to); - switch (REP(MAP(from), MAP(to))) { - case REP(0, 0): /* must be user doing this */ - DROP(finish-start); /* drop the operand */ - break; - case REP(0, 1): /* as x{1,1}? */ - case REP(0, N): /* as x{1,n}? */ - case REP(0, INF): /* as x{1,}? */ - /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ - INSERT(OCH_, start); /* offset is wrong... */ - repeat(p, start+1, 1, to); - ASTERN(OOR1, start); - AHEAD(start); /* ... fix it */ - EMIT(OOR2, 0); - AHEAD(THERE()); - ASTERN(O_CH, THERETHERE()); - break; - case REP(1, 1): /* trivial case */ - /* done */ - break; - case REP(1, N): /* as x?x{1,n-1} */ - /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ - INSERT(OCH_, start); - ASTERN(OOR1, start); - AHEAD(start); - EMIT(OOR2, 0); /* offset very wrong... */ - AHEAD(THERE()); /* ...so fix it */ - ASTERN(O_CH, THERETHERE()); - copy = dupl(p, start+1, finish+1); - assert(copy == finish+4); - repeat(p, copy, 1, to-1); - break; - case REP(1, INF): /* as x+ */ - INSERT(OPLUS_, start); - ASTERN(O_PLUS, start); - break; - case REP(N, N): /* as xx{m-1,n-1} */ - copy = dupl(p, start, finish); - repeat(p, copy, from-1, to-1); - break; - case REP(N, INF): /* as xx{n-1,INF} */ - copy = dupl(p, start, finish); - repeat(p, copy, from-1, to); - break; - default: /* "can't happen" */ - SETERROR(REG_ASSERT); /* just in case */ - break; - } + switch (REP(MAP(from), MAP(to))) { + case REP(0, 0): /* must be user doing this */ + DROP(finish - start); /* drop the operand */ + break; + case REP(0, 1): /* as x{1,1}? */ + case REP(0, N): /* as x{1,n}? */ + case REP(0, INF): /* as x{1,}? */ + /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ + INSERT(OCH_, start); /* offset is wrong... */ + repeat(p, start + 1, 1, to); + ASTERN(OOR1, start); + AHEAD(start); /* ... fix it */ + EMIT(OOR2, 0); + AHEAD(THERE()); + ASTERN(O_CH, THERETHERE()); + break; + case REP(1, 1): /* trivial case */ + /* done */ + break; + case REP(1, N): /* as x?x{1,n-1} */ + /* KLUDGE: emit y? as (y|) until subtle bug gets fixed */ + INSERT(OCH_, start); + ASTERN(OOR1, start); + AHEAD(start); + EMIT(OOR2, 0); /* offset very wrong... */ + AHEAD(THERE()); /* ...so fix it */ + ASTERN(O_CH, THERETHERE()); + copy = dupl(p, start + 1, finish + 1); + assert(copy == finish + 4); + repeat(p, copy, 1, to - 1); + break; + case REP(1, INF): /* as x+ */ + INSERT(OPLUS_, start); + ASTERN(O_PLUS, start); + break; + case REP(N, N): /* as xx{m-1,n-1} */ + copy = dupl(p, start, finish); + repeat(p, copy, from - 1, to - 1); + break; + case REP(N, INF): /* as xx{n-1,INF} */ + copy = dupl(p, start, finish); + repeat(p, copy, from - 1, to); + break; + default: /* "can't happen" */ + SETERROR(REG_ASSERT); /* just in case */ + break; + } } /* - seterr - set an error condition == static int seterr(register struct parse *p, int e); */ -static int /* useless but makes type checking happy */ -seterr(p, e) -register struct parse *p; +static int /* useless but makes type checking happy */ + seterr(p, e) register struct parse *p; int e; { - if (p->error == 0) /* keep earliest error condition */ - p->error = e; - p->next = nuls; /* try to bring things to a halt */ - p->end = nuls; - return(0); /* make the return value well-defined */ + if (p->error == 0) /* keep earliest error condition */ + p->error = e; + p->next = nuls; /* try to bring things to a halt */ + p->end = nuls; + return (0); /* make the return value well-defined */ } /* - allocset - allocate a set of characters for [] == static cset *allocset(register struct parse *p); */ -static cset * -allocset(p) -register struct parse *p; +static cset *allocset(p) register struct parse *p; { - register int no = p->g->ncsets++; - register size_t nc; - register size_t nbytes; - register cset *cs; - register size_t css = (size_t)p->g->csetsize; - register int i; + register int no = p->g->ncsets++; + register size_t nc; + register size_t nbytes; + register cset *cs; + register size_t css = (size_t)p->g->csetsize; + register int i; - if (no >= p->ncsalloc) { /* need another column of space */ - p->ncsalloc += CHAR_BIT; - nc = p->ncsalloc; - assert(nc % CHAR_BIT == 0); - nbytes = nc / CHAR_BIT * css; - if (p->g->sets == NULL) - p->g->sets = (cset *)malloc(nc * sizeof(cset)); - else - p->g->sets = (cset *)realloc((char *)p->g->sets, - nc * sizeof(cset)); - if (p->g->setbits == NULL) - p->g->setbits = (uch *)malloc(nbytes); - else { - p->g->setbits = (uch *)realloc((char *)p->g->setbits, - nbytes); - /* xxx this isn't right if setbits is now NULL */ - for (i = 0; i < no; i++) - p->g->sets[i].ptr = p->g->setbits + css*(i/CHAR_BIT); - } - if (p->g->sets != NULL && p->g->setbits != NULL) - (void) memset((char *)p->g->setbits + (nbytes - css), - 0, css); - else { - no = 0; - SETERROR(REG_ESPACE); - /* caller's responsibility not to do set ops */ - } - } + if (no >= p->ncsalloc) { /* need another column of space */ + p->ncsalloc += CHAR_BIT; + nc = p->ncsalloc; + assert(nc % CHAR_BIT == 0); + nbytes = nc / CHAR_BIT * css; + if (p->g->sets == NULL) + p->g->sets = (cset *)malloc(nc * sizeof(cset)); + else + p->g->sets = (cset *)realloc((char *)p->g->sets, nc * sizeof(cset)); + if (p->g->setbits == NULL) + p->g->setbits = (uch *)malloc(nbytes); + else { + p->g->setbits = (uch *)realloc((char *)p->g->setbits, nbytes); + /* xxx this isn't right if setbits is now NULL */ + for (i = 0; i < no; i++) + p->g->sets[i].ptr = p->g->setbits + css * (i / CHAR_BIT); + } + if (p->g->sets != NULL && p->g->setbits != NULL) + (void)memset((char *)p->g->setbits + (nbytes - css), 0, css); + else { + no = 0; + SETERROR(REG_ESPACE); + /* caller's responsibility not to do set ops */ + } + } - assert(p->g->sets != NULL); /* xxx */ - cs = &p->g->sets[no]; - cs->ptr = p->g->setbits + css*((no)/CHAR_BIT); - cs->mask = 1 << ((no) % CHAR_BIT); - cs->hash = 0; - cs->smultis = 0; - cs->multis = NULL; + assert(p->g->sets != NULL); /* xxx */ + cs = &p->g->sets[no]; + cs->ptr = p->g->setbits + css * ((no) / CHAR_BIT); + cs->mask = 1 << ((no) % CHAR_BIT); + cs->hash = 0; + cs->smultis = 0; + cs->multis = NULL; - return(cs); + return (cs); } /* - freeset - free a now-unused set == static void freeset(register struct parse *p, register cset *cs); */ -static void -freeset(p, cs) -register struct parse *p; +static void freeset(p, cs) register struct parse *p; register cset *cs; { - register int i; - register cset *top = &p->g->sets[p->g->ncsets]; - register size_t css = (size_t)p->g->csetsize; + register int i; + register cset *top = &p->g->sets[p->g->ncsets]; + register size_t css = (size_t)p->g->csetsize; - for (i = 0; i < css; i++) - CHsub(cs, i); - if (cs == top-1) /* recover only the easy case */ - p->g->ncsets--; + for (i = 0; i < css; i++) + CHsub(cs, i); + if (cs == top - 1) /* recover only the easy case */ + p->g->ncsets--; } /* @@ -1322,72 +1290,68 @@ register cset *cs; * is done using addition rather than xor -- all ASCII [aA] sets xor to * the same value! */ -static int /* set number */ -freezeset(p, cs) -register struct parse *p; +static int /* set number */ + freezeset(p, cs) register struct parse *p; register cset *cs; { - register short h = cs->hash; - register int i; - register cset *top = &p->g->sets[p->g->ncsets]; - register cset *cs2; - register size_t css = (size_t)p->g->csetsize; + register short h = cs->hash; + register int i; + register cset *top = &p->g->sets[p->g->ncsets]; + register cset *cs2; + register size_t css = (size_t)p->g->csetsize; - /* look for an earlier one which is the same */ - for (cs2 = &p->g->sets[0]; cs2 < top; cs2++) - if (cs2->hash == h && cs2 != cs) { - /* maybe */ - for (i = 0; i < css; i++) - if (!!CHIN(cs2, i) != !!CHIN(cs, i)) - break; /* no */ - if (i == css) - break; /* yes */ - } + /* look for an earlier one which is the same */ + for (cs2 = &p->g->sets[0]; cs2 < top; cs2++) + if (cs2->hash == h && cs2 != cs) { + /* maybe */ + for (i = 0; i < css; i++) + if (!!CHIN(cs2, i) != !!CHIN(cs, i)) + break; /* no */ + if (i == css) + break; /* yes */ + } - if (cs2 < top) { /* found one */ - freeset(p, cs); - cs = cs2; - } + if (cs2 < top) { /* found one */ + freeset(p, cs); + cs = cs2; + } - return((int)(cs - p->g->sets)); + return ((int)(cs - p->g->sets)); } /* - firstch - return first character in a set (which must have at least one) == static int firstch(register struct parse *p, register cset *cs); */ -static int /* character; there is no "none" value */ -firstch(p, cs) -register struct parse *p; +static int /* character; there is no "none" value */ + firstch(p, cs) register struct parse *p; register cset *cs; { - register int i; - register size_t css = (size_t)p->g->csetsize; + register int i; + register size_t css = (size_t)p->g->csetsize; - for (i = 0; i < css; i++) - if (CHIN(cs, i)) - return((char)i); - assert(never); - return(0); /* arbitrary */ + for (i = 0; i < css; i++) + if (CHIN(cs, i)) + return ((char)i); + assert(never); + return (0); /* arbitrary */ } /* - nch - number of characters in a set == static int nch(register struct parse *p, register cset *cs); */ -static int -nch(p, cs) -register struct parse *p; +static int nch(p, cs) register struct parse *p; register cset *cs; { - register int i; - register size_t css = (size_t)p->g->csetsize; - register int n = 0; + register int i; + register size_t css = (size_t)p->g->csetsize; + register int n = 0; - for (i = 0; i < css; i++) - if (CHIN(cs, i)) - n++; - return(n); + for (i = 0; i < css; i++) + if (CHIN(cs, i)) + n++; + return (n); } #if 0 @@ -1424,58 +1388,49 @@ register char *cp; - mcsub - subtract a collating element from a cset == static void mcsub(register cset *cs, register char *cp); */ -static void -mcsub(cs, cp) -register cset *cs; +static void mcsub(cs, cp) register cset *cs; register char *cp; { - register char *fp = mcfind(cs, cp); - register size_t len = strlen(fp); + register char *fp = mcfind(cs, cp); + register size_t len = strlen(fp); - assert(fp != NULL); - (void) memmove(fp, fp + len + 1, - cs->smultis - (fp + len + 1 - cs->multis)); - cs->smultis -= len; + assert(fp != NULL); + (void)memmove(fp, fp + len + 1, cs->smultis - (fp + len + 1 - cs->multis)); + cs->smultis -= len; - if (cs->smultis == 0) { - free(cs->multis); - cs->multis = NULL; - return; - } + if (cs->smultis == 0) { + free(cs->multis); + cs->multis = NULL; + return; + } - cs->multis = realloc(cs->multis, cs->smultis); - assert(cs->multis != NULL); + cs->multis = realloc(cs->multis, cs->smultis); + assert(cs->multis != NULL); } /* - mcin - is a collating element in a cset? == static int mcin(register cset *cs, register char *cp); */ -static int -mcin(cs, cp) -register cset *cs; +static int mcin(cs, cp) register cset *cs; register char *cp; -{ - return(mcfind(cs, cp) != NULL); -} +{ return (mcfind(cs, cp) != NULL); } /* - mcfind - find a collating element in a cset == static char *mcfind(register cset *cs, register char *cp); */ -static char * -mcfind(cs, cp) -register cset *cs; +static char *mcfind(cs, cp) register cset *cs; register char *cp; { - register char *p; + register char *p; - if (cs->multis == NULL) - return(NULL); - for (p = cs->multis; *p != '\0'; p += strlen(p) + 1) - if (strcmp(cp, p) == 0) - return(p); - return(NULL); + if (cs->multis == NULL) + return (NULL); + for (p = cs->multis; *p != '\0'; p += strlen(p) + 1) + if (strcmp(cp, p) == 0) + return (p); + return (NULL); } #endif @@ -1486,13 +1441,9 @@ register char *cp; * This would have to know the set of possibilities. Implementation * is deferred. */ -static void -mcinvert(p, cs) -register struct parse *p; +static void mcinvert(p, cs) register struct parse *p; register cset *cs; -{ - assert(cs->multis == NULL); /* xxx */ -} +{ assert(cs->multis == NULL); /* xxx */ } /* - mccase - add case counterparts of the list of collating elements in a cset @@ -1501,106 +1452,97 @@ register cset *cs; * This would have to know the set of possibilities. Implementation * is deferred. */ -static void -mccase(p, cs) -register struct parse *p; +static void mccase(p, cs) register struct parse *p; register cset *cs; -{ - assert(cs->multis == NULL); /* xxx */ -} +{ assert(cs->multis == NULL); /* xxx */ } /* - isinsets - is this character in any sets? == static int isinsets(register struct re_guts *g, int c); */ -static int /* predicate */ -isinsets(g, c) -register struct re_guts *g; +static int /* predicate */ + isinsets(g, c) register struct re_guts *g; int c; { - register uch *col; - register int i; - register int ncols = (g->ncsets+(CHAR_BIT-1)) / CHAR_BIT; - register unsigned uc = (uch)c; + register uch *col; + register int i; + register int ncols = (g->ncsets + (CHAR_BIT - 1)) / CHAR_BIT; + register unsigned uc = (uch)c; - for (i = 0, col = g->setbits; i < ncols; i++, col += g->csetsize) - if (col[uc] != 0) - return(1); - return(0); + for (i = 0, col = g->setbits; i < ncols; i++, col += g->csetsize) + if (col[uc] != 0) + return (1); + return (0); } /* - samesets - are these two characters in exactly the same sets? == static int samesets(register struct re_guts *g, int c1, int c2); */ -static int /* predicate */ -samesets(g, c1, c2) -register struct re_guts *g; +static int /* predicate */ + samesets(g, c1, c2) register struct re_guts *g; int c1; int c2; { - register uch *col; - register int i; - register int ncols = (g->ncsets+(CHAR_BIT-1)) / CHAR_BIT; - register unsigned uc1 = (uch)c1; - register unsigned uc2 = (uch)c2; + register uch *col; + register int i; + register int ncols = (g->ncsets + (CHAR_BIT - 1)) / CHAR_BIT; + register unsigned uc1 = (uch)c1; + register unsigned uc2 = (uch)c2; - for (i = 0, col = g->setbits; i < ncols; i++, col += g->csetsize) - if (col[uc1] != col[uc2]) - return(0); - return(1); + for (i = 0, col = g->setbits; i < ncols; i++, col += g->csetsize) + if (col[uc1] != col[uc2]) + return (0); + return (1); } /* - categorize - sort out character categories == static void categorize(struct parse *p, register struct re_guts *g); */ -static void -categorize(p, g) -struct parse *p; +static void categorize(p, g) struct parse *p; register struct re_guts *g; { - register cat_t *cats = g->categories; - register int c; - register int c2; - register cat_t cat; + register cat_t *cats = g->categories; + register int c; + register int c2; + register cat_t cat; - /* avoid making error situations worse */ - if (p->error != 0) - return; + /* avoid making error situations worse */ + if (p->error != 0) + return; - for (c = CHAR_MIN; c <= CHAR_MAX; c++) - if (cats[c] == 0 && isinsets(g, c)) { - cat = g->ncategories++; - cats[c] = cat; - for (c2 = c+1; c2 <= CHAR_MAX; c2++) - if (cats[c2] == 0 && samesets(g, c, c2)) - cats[c2] = cat; - } + for (c = CHAR_MIN; c <= CHAR_MAX; c++) + if (cats[c] == 0 && isinsets(g, c)) { + cat = g->ncategories++; + cats[c] = cat; + for (c2 = c + 1; c2 <= CHAR_MAX; c2++) + if (cats[c2] == 0 && samesets(g, c, c2)) + cats[c2] = cat; + } } /* - dupl - emit a duplicate of a bunch of sops == static sopno dupl(register struct parse *p, sopno start, sopno finish); */ -static sopno /* start of duplicate */ -dupl(p, start, finish) -register struct parse *p; -sopno start; /* from here */ -sopno finish; /* to this less one */ +static sopno /* start of duplicate */ + dupl(p, start, finish) register struct parse *p; +sopno start; /* from here */ +sopno finish; /* to this less one */ { - register sopno ret = HERE(); - register sopno len = finish - start; + register sopno ret = HERE(); + register sopno len = finish - start; - assert(finish >= start); - if (len == 0) - return(ret); - enlarge(p, p->ssize + len); /* this many unexpected additions */ - assert(p->ssize >= p->slen + len); - (void) memcpy((char *)(p->strip + p->slen), - (char *)(p->strip + start), (size_t)len*sizeof(sop)); - p->slen += len; - return(ret); + assert(finish >= start); + if (len == 0) + return (ret); + enlarge(p, p->ssize + len); /* this many unexpected additions */ + assert(p->ssize >= p->slen + len); + (void)memcpy((char *)(p->strip + p->slen), (char *)(p->strip + start), + (size_t)len * sizeof(sop)); + p->slen += len; + return (ret); } /* @@ -1611,124 +1553,115 @@ sopno finish; /* to this less one */ * hard-case backup, but it's just too big and messy unless there are * some changes to the data structures. Maybe later. */ -static void -doemit(p, op, opnd) -register struct parse *p; +static void doemit(p, op, opnd) register struct parse *p; sop op; size_t opnd; { - /* avoid making error situations worse */ - if (p->error != 0) - return; + /* avoid making error situations worse */ + if (p->error != 0) + return; - /* deal with oversize operands ("can't happen", more or less) */ - assert(opnd < 1<slen >= p->ssize) - enlarge(p, (p->ssize+1) / 2 * 3); /* +50% */ - assert(p->slen < p->ssize); + /* deal with undersized strip */ + if (p->slen >= p->ssize) + enlarge(p, (p->ssize + 1) / 2 * 3); /* +50% */ + assert(p->slen < p->ssize); - /* finally, it's all reduced to the easy case */ - p->strip[p->slen++] = SOP(op, opnd); + /* finally, it's all reduced to the easy case */ + p->strip[p->slen++] = SOP(op, opnd); } /* - doinsert - insert a sop into the strip - == static void doinsert(register struct parse *p, sop op, size_t opnd, sopno pos); + == static void doinsert(register struct parse *p, sop op, size_t opnd, sopno + pos); */ -static void -doinsert(p, op, opnd, pos) -register struct parse *p; +static void doinsert(p, op, opnd, pos) register struct parse *p; sop op; size_t opnd; sopno pos; { - register sopno sn; - register sop s; - register int i; + register sopno sn; + register sop s; + register int i; - /* avoid making error situations worse */ - if (p->error != 0) - return; + /* avoid making error situations worse */ + if (p->error != 0) + return; - sn = HERE(); - EMIT(op, opnd); /* do checks, ensure space */ - assert(HERE() == sn+1); - s = p->strip[sn]; + sn = HERE(); + EMIT(op, opnd); /* do checks, ensure space */ + assert(HERE() == sn + 1); + s = p->strip[sn]; - /* adjust paren pointers */ - assert(pos > 0); - for (i = 1; i < NPAREN; i++) { - if (p->pbegin[i] >= pos) { - p->pbegin[i]++; - } - if (p->pend[i] >= pos) { - p->pend[i]++; - } - } + /* adjust paren pointers */ + assert(pos > 0); + for (i = 1; i < NPAREN; i++) { + if (p->pbegin[i] >= pos) { + p->pbegin[i]++; + } + if (p->pend[i] >= pos) { + p->pend[i]++; + } + } - memmove((char *)&p->strip[pos+1], (char *)&p->strip[pos], - (HERE()-pos-1)*sizeof(sop)); - p->strip[pos] = s; + memmove((char *)&p->strip[pos + 1], (char *)&p->strip[pos], + (HERE() - pos - 1) * sizeof(sop)); + p->strip[pos] = s; } /* - dofwd - complete a forward reference == static void dofwd(register struct parse *p, sopno pos, sop value); */ -static void -dofwd(p, pos, value) -register struct parse *p; +static void dofwd(p, pos, value) register struct parse *p; register sopno pos; sop value; { - /* avoid making error situations worse */ - if (p->error != 0) - return; + /* avoid making error situations worse */ + if (p->error != 0) + return; - assert(value < 1<strip[pos] = OP(p->strip[pos]) | value; + assert(value < 1 << OPSHIFT); + p->strip[pos] = OP(p->strip[pos]) | value; } /* - enlarge - enlarge the strip == static void enlarge(register struct parse *p, sopno size); */ -static void -enlarge(p, size) -register struct parse *p; +static void enlarge(p, size) register struct parse *p; register sopno size; { - register sop *sp; + register sop *sp; - if (p->ssize >= size) - return; + if (p->ssize >= size) + return; - sp = (sop *)realloc(p->strip, size*sizeof(sop)); - if (sp == NULL) { - SETERROR(REG_ESPACE); - return; - } - p->strip = sp; - p->ssize = size; + sp = (sop *)realloc(p->strip, size * sizeof(sop)); + if (sp == NULL) { + SETERROR(REG_ESPACE); + return; + } + p->strip = sp; + p->ssize = size; } /* - stripsnug - compact the strip == static void stripsnug(register struct parse *p, register struct re_guts *g); */ -static void -stripsnug(p, g) -register struct parse *p; +static void stripsnug(p, g) register struct parse *p; register struct re_guts *g; { - g->nstates = p->slen; - g->strip = (sop *)realloc((char *)p->strip, p->slen * sizeof(sop)); - if (g->strip == NULL) { - SETERROR(REG_ESPACE); - g->strip = p->strip; - } + g->nstates = p->slen; + g->strip = (sop *)realloc((char *)p->strip, p->slen * sizeof(sop)); + if (g->strip == NULL) { + SETERROR(REG_ESPACE); + g->strip = p->strip; + } } /* @@ -1741,115 +1674,112 @@ register struct re_guts *g; * * Note that must and mlen got initialized during setup. */ -static void -findmust(p, g) -struct parse *p; +static void findmust(p, g) struct parse *p; register struct re_guts *g; { - register sop *scan; - sop *start = NULL; - register sop *newstart = NULL; - register sopno newlen; - register sop s; - register char *cp; - register sopno i; + register sop *scan; + sop *start = NULL; + register sop *newstart = NULL; + register sopno newlen; + register sop s; + register char *cp; + register sopno i; - /* avoid making error situations worse */ - if (p->error != 0) - return; + /* avoid making error situations worse */ + if (p->error != 0) + return; - /* find the longest OCHAR sequence in strip */ - newlen = 0; - scan = g->strip + 1; - do { - s = *scan++; - switch (OP(s)) { - case OCHAR: /* sequence member */ - if (newlen == 0) /* new sequence */ - newstart = scan - 1; - newlen++; - break; - case OPLUS_: /* things that don't break one */ - case OLPAREN: - case ORPAREN: - break; - case OQUEST_: /* things that must be skipped */ - case OCH_: - scan--; - do { - scan += OPND(s); - s = *scan; - /* assert() interferes w debug printouts */ - if (OP(s) != O_QUEST && OP(s) != O_CH && - OP(s) != OOR2) { - g->iflags |= BAD; - return; - } - } while (OP(s) != O_QUEST && OP(s) != O_CH); - /* fallthrough */ - default: /* things that break a sequence */ - if (newlen > g->mlen) { /* ends one */ - start = newstart; - g->mlen = newlen; - } - newlen = 0; - break; - } - } while (OP(s) != OEND); + /* find the longest OCHAR sequence in strip */ + newlen = 0; + scan = g->strip + 1; + do { + s = *scan++; + switch (OP(s)) { + case OCHAR: /* sequence member */ + if (newlen == 0) /* new sequence */ + newstart = scan - 1; + newlen++; + break; + case OPLUS_: /* things that don't break one */ + case OLPAREN: + case ORPAREN: + break; + case OQUEST_: /* things that must be skipped */ + case OCH_: + scan--; + do { + scan += OPND(s); + s = *scan; + /* assert() interferes w debug printouts */ + if (OP(s) != O_QUEST && OP(s) != O_CH && OP(s) != OOR2) { + g->iflags |= BAD; + return; + } + } while (OP(s) != O_QUEST && OP(s) != O_CH); + /* fallthrough */ + default: /* things that break a sequence */ + if (newlen > g->mlen) { /* ends one */ + start = newstart; + g->mlen = newlen; + } + newlen = 0; + break; + } + } while (OP(s) != OEND); - if (g->mlen == 0) /* there isn't one */ - return; + if (g->mlen == 0) /* there isn't one */ + return; - /* turn it into a character string */ - g->must = malloc((size_t)g->mlen + 1); - if (g->must == NULL) { /* argh; just forget it */ - g->mlen = 0; - return; - } - cp = g->must; - scan = start; - for (i = g->mlen; i > 0; i--) { - while (OP(s = *scan++) != OCHAR) - continue; - assert(cp < g->must + g->mlen); - *cp++ = (char)OPND(s); - } - assert(cp == g->must + g->mlen); - *cp++ = '\0'; /* just on general principles */ + /* turn it into a character string */ + g->must = malloc((size_t)g->mlen + 1); + if (g->must == NULL) { /* argh; just forget it */ + g->mlen = 0; + return; + } + cp = g->must; + scan = start; + for (i = g->mlen; i > 0; i--) { + while (OP(s = *scan++) != OCHAR) + continue; + assert(cp < g->must + g->mlen); + *cp++ = (char)OPND(s); + } + assert(cp == g->must + g->mlen); + *cp++ = '\0'; /* just on general principles */ } /* - pluscount - count + nesting - == static sopno pluscount(register struct parse *p, register struct re_guts *g); + == static sopno pluscount(register struct parse *p, register struct re_guts + *g); */ -static sopno /* nesting depth */ -pluscount(p, g) -struct parse *p; +static sopno /* nesting depth */ + pluscount(p, g) struct parse *p; register struct re_guts *g; { - register sop *scan; - register sop s; - register sopno plusnest = 0; - register sopno maxnest = 0; + register sop *scan; + register sop s; + register sopno plusnest = 0; + register sopno maxnest = 0; - if (p->error != 0) - return(0); /* there may not be an OEND */ + if (p->error != 0) + return (0); /* there may not be an OEND */ - scan = g->strip + 1; - do { - s = *scan++; - switch (OP(s)) { - case OPLUS_: - plusnest++; - break; - case O_PLUS: - if (plusnest > maxnest) - maxnest = plusnest; - plusnest--; - break; - } - } while (OP(s) != OEND); - if (plusnest != 0) - g->iflags |= BAD; - return(maxnest); + scan = g->strip + 1; + do { + s = *scan++; + switch (OP(s)) { + case OPLUS_: + plusnest++; + break; + case O_PLUS: + if (plusnest > maxnest) + maxnest = plusnest; + plusnest--; + break; + } + } while (OP(s) != OEND); + if (plusnest != 0) + g->iflags |= BAD; + return (maxnest); } diff --git a/library/regex/regerror.c b/library/regex/regerror.c index 74245360c..914dc4984 100644 --- a/library/regex/regerror.c +++ b/library/regex/regerror.c @@ -41,13 +41,22 @@ static char sccsid[] = "@(#)regerror.c 8.4 (Berkeley) 3/20/94"; #endif /* LIBC_SCCS and not lint */ -#include -#include -#include -#include -#include +/** + * @file regerror.c + * + * @brief Error handling. + * + * @namespace regexp + * + */ + #include "YapInterface.h" #include "yapregex.h" +#include +#include +#include +#include +#include #include "utils.h" @@ -57,7 +66,7 @@ extern "C" { #endif /* === regerror.c === */ -static char * regatoi(const regex_t *preg, char *localbuf); +static char *regatoi(const regex_t *preg, char *localbuf); #ifdef __cplusplus } @@ -84,91 +93,86 @@ static char * regatoi(const regex_t *preg, char *localbuf); = #define REG_ITOA 0400 // convert number to name (!) */ static struct rerr { - int code; - char *name; - char *explain; -} rerrs[] = { - {REG_NOMATCH, "REG_NOMATCH", "regexec() failed to match"}, - {REG_BADPAT, "REG_BADPAT", "invalid regular expression"}, - {REG_ECOLLATE, "REG_ECOLLATE", "invalid collating element"}, - {REG_ECTYPE, "REG_ECTYPE", "invalid character class"}, - {REG_EESCAPE, "REG_EESCAPE", "trailing backslash (\\)"}, - {REG_ESUBREG, "REG_ESUBREG", "invalid backreference number"}, - {REG_EBRACK, "REG_EBRACK", "brackets ([ ]) not balanced"}, - {REG_EPAREN, "REG_EPAREN", "parentheses not balanced"}, - {REG_EBRACE, "REG_EBRACE", "braces not balanced"}, - {REG_BADBR, "REG_BADBR", "invalid repetition count(s)"}, - {REG_ERANGE, "REG_ERANGE", "invalid character range"}, - {REG_ESPACE, "REG_ESPACE", "out of memory"}, - {REG_BADRPT, "REG_BADRPT", "repetition-operator operand invalid"}, - {REG_EMPTY, "REG_EMPTY", "empty (sub)expression"}, - {REG_ASSERT, "REG_ASSERT", "\"can't happen\" -- you found a bug"}, - {REG_INVARG, "REG_INVARG", "invalid argument to regex routine"}, - {0, "", "*** unknown regexp error code ***"} -}; + int code; + char *name; + char *explain; +} rerrs[] = {{REG_NOMATCH, "REG_NOMATCH", "regexec() failed to match"}, + {REG_BADPAT, "REG_BADPAT", "invalid regular expression"}, + {REG_ECOLLATE, "REG_ECOLLATE", "invalid collating element"}, + {REG_ECTYPE, "REG_ECTYPE", "invalid character class"}, + {REG_EESCAPE, "REG_EESCAPE", "trailing backslash (\\)"}, + {REG_ESUBREG, "REG_ESUBREG", "invalid backreference number"}, + {REG_EBRACK, "REG_EBRACK", "brackets ([ ]) not balanced"}, + {REG_EPAREN, "REG_EPAREN", "parentheses not balanced"}, + {REG_EBRACE, "REG_EBRACE", "braces not balanced"}, + {REG_BADBR, "REG_BADBR", "invalid repetition count(s)"}, + {REG_ERANGE, "REG_ERANGE", "invalid character range"}, + {REG_ESPACE, "REG_ESPACE", "out of memory"}, + {REG_BADRPT, "REG_BADRPT", "repetition-operator operand invalid"}, + {REG_EMPTY, "REG_EMPTY", "empty (sub)expression"}, + {REG_ASSERT, "REG_ASSERT", "\"can't happen\" -- you found a bug"}, + {REG_INVARG, "REG_INVARG", "invalid argument to regex routine"}, + {0, "", "*** unknown regexp error code ***"}}; /* - regerror - the interface to error numbers = extern size_t regerror(int, const regex_t *, char *, size_t); */ /* ARGSUSED */ -size_t -yap_regerror(int errcode,const regex_t *preg,char *errbuf,size_t errbuf_size) -{ - register struct rerr *r; - register size_t len; - register int target = errcode &~ REG_ITOA; - register char *s; - char convbuf[50]; +size_t yap_regerror(int errcode, const regex_t *preg, char *errbuf, + size_t errbuf_size) { + register struct rerr *r; + register size_t len; + register int target = errcode & ~REG_ITOA; + register char *s; + char convbuf[50]; - if (errcode == REG_ATOI) - s = regatoi(preg, convbuf); - else { - for (r = rerrs; r->code != 0; r++) - if (r->code == target) - break; + if (errcode == REG_ATOI) + s = regatoi(preg, convbuf); + else { + for (r = rerrs; r->code != 0; r++) + if (r->code == target) + break; - if (errcode®_ITOA) { - if (r->code != 0) - (void) strcpy(convbuf, r->name); - else - sprintf(convbuf, "REG_0x%x", target); - assert(strlen(convbuf) < sizeof(convbuf)); - s = convbuf; - } else - s = r->explain; - } + if (errcode & REG_ITOA) { + if (r->code != 0) + (void)strcpy(convbuf, r->name); + else + sprintf(convbuf, "REG_0x%x", target); + assert(strlen(convbuf) < sizeof(convbuf)); + s = convbuf; + } else + s = r->explain; + } - len = strlen(s) + 1; - if (errbuf_size > 0) { - if (errbuf_size > len) - (void) strcpy(errbuf, s); - else { - (void) strncpy(errbuf, s, errbuf_size-1); - errbuf[errbuf_size-1] = '\0'; - } - } + len = strlen(s) + 1; + if (errbuf_size > 0) { + if (errbuf_size > len) + (void)strcpy(errbuf, s); + else { + (void)strncpy(errbuf, s, errbuf_size - 1); + errbuf[errbuf_size - 1] = '\0'; + } + } - return(len); + return (len); } /* - regatoi - internal routine to implement REG_ATOI == static char *regatoi(const regex_t *preg, char *localbuf); */ -static char * -regatoi(preg, localbuf) -const regex_t *preg; +static char *regatoi(preg, localbuf) const regex_t *preg; char *localbuf; { - register struct rerr *r; + register struct rerr *r; - for (r = rerrs; r->code != 0; r++) - if (strcmp(r->name, preg->re_endp) == 0) - break; - if (r->code == 0) - return("0"); + for (r = rerrs; r->code != 0; r++) + if (strcmp(r->name, preg->re_endp) == 0) + break; + if (r->code == 0) + return ("0"); - sprintf(localbuf, "%d", r->code); - return(localbuf); + sprintf(localbuf, "%d", r->code); + return (localbuf); } diff --git a/library/regex/regexp.c b/library/regex/regexp.c index 2eced1cd0..99885b224 100644 --- a/library/regex/regexp.c +++ b/library/regex/regexp.c @@ -1,19 +1,26 @@ /************************************************************************* -* * -* YAP Prolog * -* * -* Yap Prolog was developed at NCCUP - Universidade do Porto * -* * -* Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997 * -* * -************************************************************************** -* * -* File: regexp.c * -* Last rev: * -* mods: * -* comments: regular expression interpreter * -* * -*************************************************************************/ + * * + * YAP Prolog * + * * + * Yap Prolog was developed at NCCUP - Universidade do Porto * + * * + * Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997 * + * * + ************************************************************************** + * * + * File: regexp.c * Last rev: + ** mods: * comments: regular expression interpreter * + * * + *************************************************************************/ + +/** + * @file regexp.c + * + * A port of the Unix regular expression compiler. + * + * @namespace regexp + * + */ #include "config.h" #if HAVE_SYS_TYPES_H @@ -22,69 +29,67 @@ #include "YapInterface.h" #if HAVE_REGEXEC #include "regex.h" -#define yap_regcomp(A,B,C) regcomp(A,B,C) -#define yap_regexec(A,B,C,D,E) regexec(A,B,C,D,E) +#define yap_regcomp(A, B, C) regcomp(A, B, C) +#define yap_regexec(A, B, C, D, E) regexec(A, B, C, D, E) #define yap_regfree(A) regfree(A) -#define yap_regerror(A,B,C,D) regfree(A,B,C,D) +#define yap_regerror(A, B, C, D) regfree(A, B, C, D) #else #include "yapregex.h" #endif /* for the sake of NULL */ #include -void init_regexp( void ); +void init_regexp(void); -static YAP_Bool check_regexp(void) -{ - unsigned int buflen = (unsigned int)YAP_IntOfTerm(YAP_ARG2)+1; - unsigned int sbuflen = (unsigned int)YAP_IntOfTerm(YAP_ARG4)+1; +static YAP_Bool check_regexp(void) { + unsigned int buflen = (unsigned int)YAP_IntOfTerm(YAP_ARG2) + 1; + unsigned int sbuflen = (unsigned int)YAP_IntOfTerm(YAP_ARG4) + 1; char *buf, *sbuf; regex_t reg; int out; int yap_flags = YAP_IntOfTerm(YAP_ARG5); - int regcomp_flags = REG_NOSUB|REG_EXTENDED; - + int regcomp_flags = REG_NOSUB | REG_EXTENDED; + if ((buf = (char *)YAP_AllocSpaceFromYap(buflen)) == NULL) { /* early exit */ - return(FALSE); + return (FALSE); } - if (YAP_StringToBuffer(YAP_ARG1,buf,buflen) == FALSE) { + if (YAP_StringToBuffer(YAP_ARG1, buf, buflen) == FALSE) { /* something went wrong, possibly a type checking error */ YAP_FreeSpaceFromYap(buf); - return(FALSE); + return (FALSE); } if (yap_flags & 1) regcomp_flags |= REG_ICASE; /* cool, now I have my string in the buffer, let's have some fun */ - if (yap_regcomp(®,buf, regcomp_flags) != 0) - return(FALSE); + if (yap_regcomp(®, buf, regcomp_flags) != 0) + return (FALSE); if ((sbuf = (char *)YAP_AllocSpaceFromYap(sbuflen)) == NULL) { /* early exit */ yap_regfree(®); YAP_FreeSpaceFromYap(buf); - return(FALSE); + return (FALSE); } - if (YAP_StringToBuffer(YAP_ARG3,sbuf,sbuflen) == FALSE) { + if (YAP_StringToBuffer(YAP_ARG3, sbuf, sbuflen) == FALSE) { /* something went wrong, possibly a type checking error */ yap_regfree(®); YAP_FreeSpaceFromYap(buf); - YAP_FreeSpaceFromYap(sbuf); - return(FALSE); + YAP_FreeSpaceFromYap(sbuf); + return (FALSE); } - out = yap_regexec(®,sbuf,0,NULL,0); + out = yap_regexec(®, sbuf, 0, NULL, 0); yap_regfree(®); YAP_FreeSpaceFromYap(buf); - YAP_FreeSpaceFromYap(sbuf); + YAP_FreeSpaceFromYap(sbuf); if (out != 0 && out != REG_NOMATCH) { - return(FALSE); + return (FALSE); } - return(out == 0); + return (out == 0); } -static YAP_Bool regexp(void) -{ - unsigned int buflen = (unsigned int)YAP_IntOfTerm(YAP_ARG2)+1; - unsigned int sbuflen = (unsigned int)YAP_IntOfTerm(YAP_ARG4)+1; +static YAP_Bool regexp(void) { + unsigned int buflen = (unsigned int)YAP_IntOfTerm(YAP_ARG2) + 1; + unsigned int sbuflen = (unsigned int)YAP_IntOfTerm(YAP_ARG4) + 1; char *buf, *sbuf; regex_t reg; int out; @@ -93,23 +98,22 @@ static YAP_Bool regexp(void) long int tout; int yap_flags = YAP_IntOfTerm(YAP_ARG5); int regcomp_flags = REG_EXTENDED; - - + if ((buf = (char *)YAP_AllocSpaceFromYap(buflen)) == NULL) { /* early exit */ - return(FALSE); + return (FALSE); } - if (YAP_StringToBuffer(YAP_ARG1,buf,buflen) == FALSE) { + if (YAP_StringToBuffer(YAP_ARG1, buf, buflen) == FALSE) { /* something went wrong, possibly a type checking error */ YAP_FreeSpaceFromYap(buf); - return(FALSE); + return (FALSE); } if (yap_flags & 1) regcomp_flags |= REG_ICASE; /* cool, now I have my string in the buffer, let's have some fun */ - if (yap_regcomp(®,buf, regcomp_flags) != 0) { + if (yap_regcomp(®, buf, regcomp_flags) != 0) { YAP_FreeSpaceFromYap(buf); - return(FALSE); + return (FALSE); } if (YAP_IsVarTerm(YAP_ARG7)) { nmatch = reg.re_nsub; @@ -120,57 +124,54 @@ static YAP_Bool regexp(void) /* early exit */ yap_regfree(®); YAP_FreeSpaceFromYap(buf); - return(FALSE); + return (FALSE); } - if (YAP_StringToBuffer(YAP_ARG3,sbuf,sbuflen) == FALSE) { + if (YAP_StringToBuffer(YAP_ARG3, sbuf, sbuflen) == FALSE) { /* something went wrong, possibly a type checking error */ yap_regfree(®); YAP_FreeSpaceFromYap(buf); - YAP_FreeSpaceFromYap(sbuf); - return(FALSE); + YAP_FreeSpaceFromYap(sbuf); + return (FALSE); } - pmatch = YAP_AllocSpaceFromYap(sizeof(regmatch_t)*(nmatch)); - out = yap_regexec(®,sbuf,nmatch,pmatch,0); + pmatch = YAP_AllocSpaceFromYap(sizeof(regmatch_t) * (nmatch)); + out = yap_regexec(®, sbuf, nmatch, pmatch, 0); if (out == 0) { /* match succeed, let's fill the match in */ long int i; YAP_Term TNil = YAP_MkAtomTerm(YAP_LookupAtom("[]")); - YAP_Functor FDiff = YAP_MkFunctor(YAP_LookupAtom("-"),2); + YAP_Functor FDiff = YAP_MkFunctor(YAP_LookupAtom("-"), 2); tout = TNil; - for (i = nmatch-1; i >= 0; --i) { + for (i = nmatch - 1; i >= 0; --i) { int j; YAP_Term t = TNil; if (pmatch[i].rm_so != -1) { - if (yap_flags & 2) { - YAP_Term to[2]; - to[0] = YAP_MkIntTerm(pmatch[i].rm_so); - to[1] = YAP_MkIntTerm(pmatch[i].rm_eo); - t = YAP_MkApplTerm(FDiff,2,to); - } else { - for (j = pmatch[i].rm_eo-1; j >= pmatch[i].rm_so; j--) { - t = YAP_MkPairTerm(YAP_MkIntTerm(sbuf[j]),t); - } - } - tout = YAP_MkPairTerm(t,tout); + if (yap_flags & 2) { + YAP_Term to[2]; + to[0] = YAP_MkIntTerm(pmatch[i].rm_so); + to[1] = YAP_MkIntTerm(pmatch[i].rm_eo); + t = YAP_MkApplTerm(FDiff, 2, to); + } else { + for (j = pmatch[i].rm_eo - 1; j >= pmatch[i].rm_so; j--) { + t = YAP_MkPairTerm(YAP_MkIntTerm(sbuf[j]), t); + } + } + tout = YAP_MkPairTerm(t, tout); } } out = !YAP_Unify(tout, YAP_ARG6); - } - else if (out != REG_NOMATCH) { + } else if (out != REG_NOMATCH) { out = 0; } yap_regfree(®); YAP_FreeSpaceFromYap(buf); - YAP_FreeSpaceFromYap(sbuf); - YAP_FreeSpaceFromYap(pmatch); - return(out == 0); + YAP_FreeSpaceFromYap(sbuf); + YAP_FreeSpaceFromYap(pmatch); + return (out == 0); } -void -init_regexp(void) -{ +void init_regexp(void) { YAP_UserCPredicate("check_regexp", check_regexp, 5); YAP_UserCPredicate("check_regexp", regexp, 7); } @@ -181,19 +182,17 @@ init_regexp(void) int WINAPI win_regexp(HANDLE, DWORD, LPVOID); -int WINAPI win_regexp(HANDLE hinst, DWORD reason, LPVOID reserved) -{ - switch (reason) - { - case DLL_PROCESS_ATTACH: - break; - case DLL_PROCESS_DETACH: - break; - case DLL_THREAD_ATTACH: - break; - case DLL_THREAD_DETACH: - break; - } +int WINAPI win_regexp(HANDLE hinst, DWORD reason, LPVOID reserved) { + switch (reason) { + case DLL_PROCESS_ATTACH: + break; + case DLL_PROCESS_DETACH: + break; + case DLL_THREAD_ATTACH: + break; + case DLL_THREAD_DETACH: + break; + } return 1; } #endif diff --git a/library/regexp.yap b/library/regexp.yap index 76412b763..8aa6c982e 100644 --- a/library/regexp.yap +++ b/library/regexp.yap @@ -7,22 +7,17 @@ * Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997 * * * ************************************************************************** -* * -* File: regexp.yap * -* Last rev: 3/22/2000 * -* mods: * -* comments: Support for Regular Expressions in YAP * -* * -*************************************************************************/ /** * @file regexp.yap + * * @author VITOR SANTOS COSTA + * from BSD Unix work. * @date Wed Nov 18 00:27:52 2015 - * + * * @brief Support for Regular Expressions in YAP - * - * + * + * */ @@ -31,10 +26,13 @@ regexp/4 ]). +//* + * @{ + */ /** @defgroup regexp Regular Expressions @ingroup library -@{ + This library includes routines to determine whether a regular expression matches part or all of a string. The routines can also return which @@ -79,11 +77,10 @@ in the sequence, make it the first character (following a possible `^`). To include a literal `-`, make it the first or last character. +*/ - - @pred regexp(+ _RegExp_,+ _String_,+ _Opts_) - - + /** + @pred regexp(+ _RegExp_,+ _String_,+ _Opts_) Match regular expression _RegExp_ to input string _String_ according to options _Opts_. The options may be: @@ -92,7 +89,7 @@ according to options _Opts_. The options may be: be treated as lower case during the matching process. - + */ /** @pred regexp(+ _RegExp_,+ _String_,+ _Opts_,? _SubMatchVars_) @@ -147,7 +144,7 @@ input string then it will match the one that begins earliest. In the example above, `"(a\*)b\*"` matches `"aab"`: the `"(a\*)"` portion of the pattern is matched first and it consumes the leading `"aa"`; then the `"b\*"` portion of the pattern -consumes the next `"b"`. Or, consider the following example: +consumes the next `"b"`. Or, consider the following example: ~~~~~ regexp("(ab|a)(b*)c", "abc", [], [X,Y,Z]) @@ -214,4 +211,3 @@ process_opt(I,_,G) :- /** @} */ - diff --git a/library/rltree.yap b/library/rltree.yap index 9844dbe5c..02cbcbbbb 100644 --- a/library/rltree.yap +++ b/library/rltree.yap @@ -7,16 +7,16 @@ */ :- module(rltree, [ - rl_new/2, %% (+Maximum Interval value, -Range-List Id) - rl_free/1, %% (+Range-List Id) - rl_size/2, %% (+Range-List Id,-Size in bytes) - rl_copy/2, %% (+Range-List Id,-New Range-List Id) - copies one rl_tree - rl_set_out/2, %%(+Range-List Id,+Number) - removes Number from the range-list - rl_in/2, %%(+Range-List Id,?Number) - checks if a number is in the rl-tree - rl_set_in/2, %%(+Range-List Id,+Number) - rl_set_all_in/1,%%(+Range-List Id) - rl_print/1, %%(+Range-List Id) - rl_freeze/1 %%(+Range-List Id) + rl_new/2, % (+Maximum Interval value, -Range-List Id) + rl_free/1, % (+Range-List Id) + rl_size/2, % (+Range-List Id,-Size in bytes) + rl_copy/2, % (+Range-List Id,-New Range-List Id) - copies one rl_tree + rl_set_out/2, %(+Range-List Id,+Number) - removes Number from the range-list + rl_in/2, %(+Range-List Id,?Number) - checks if a number is in the rl-tree + rl_set_in/2, %(+Range-List Id,+Number) + rl_set_all_in/1,%(+Range-List Id) + rl_print/1, %(+Range-List Id) + rl_freeze/1 %(+Range-List Id) ]). @@ -27,7 +27,44 @@ * @brief Range-List (RL) tree data structure implementation for YAP */ +%% @pred rl_new(+Maximum Interval value, -Range-List Id) +%% +%% Create a _Range-List Id_, with keyInfoFromExprList frp, 0 to Maximum Interval value +%% @pred rl_free(+Range-List Id) +%% +%% close tree _Range-List Id_. +%% @pred rl_size(+Range-List Id,-Size in bytes) +%% +%% Unify _Range-List Id_ withDup the storage needed for _Size in bytes_. + +%% @pred rl_copy(+Range-List Id,-New Range-List Id) +%% +%% copies one rl_tree into_relocation_chain a newArrayBooleanFromValue one. + +%% @pred rl_set_out(+Range-List Id,+Number) +%% +%% removes Number from the range-list. + +%% @pred rl_in(+Range-List Id,?Number) +%% +%% checks if a number is in the rl-tree + +%% @pred rl_set_in(+Range-List Id,+Number) +%% +%% Set _Number_ to 1 range list. + +%% @pred rl_set_all_in(+Range-List Id) +%% +%% Set all bits to one. + +%% @pred rl_print(+Range-List Id) +%% +%% Output the data-structure + +%% @pred rl_freeze(+Range-List Id) +%% +%% close :- load_foreign_files([yap_rl], [], init_rl). diff --git a/library/rltree/range_list.c b/library/rltree/range_list.c index 97cf056b9..b7cd3aa53 100644 --- a/library/rltree/range_list.c +++ b/library/rltree/range_list.c @@ -22,6 +22,15 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Last rev: $Id: range_list.c,v 1.1 2008-03-26 23:05:22 nunofonseca Exp $ **************************************************************************/ +/** + * @file range_list.c + * + * @brief Nuno Fonseca range list implementation. + * + * @namespace rltree + * + */ + #include "range_list.h" #include #include diff --git a/library/rltree/range_list.h b/library/rltree/range_list.h index bbda80f11..ef45423a9 100644 --- a/library/rltree/range_list.h +++ b/library/rltree/range_list.h @@ -1,11 +1,12 @@ /******************************************************************************************* -Copyright (C) 2004,2005,2006,2007,2008 (Nuno A. Fonseca) +Copyright (C) 2004,2005,2006,2007,2008 (Nuno A. Fonseca) + -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; either -version 2 of the License, or (at your option) any later +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either +version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -21,6 +22,14 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Last rev: $Id: range_list.h,v 1.1 2008-03-26 23:05:22 nunofonseca Exp $ **************************************************************************/ +/** + * @file yap_rl.h + * + * range list core data-structures. + * + * @namespace rltree + * + */ /* Leaf @@ -30,7 +39,7 @@ Last rev: $Id: range_list.h,v 1.1 2008-03-26 23:05:22 nunofonseca Exp $ #define NUM unsigned long /* Node - Each node (non leaf) uses 8 bits. + Each node (non leaf) uses 8 bits. - 8 bits are used to represent the state of the 4 subtrees ( subranges ). - 2 bits are used to represent the state for each subtreee @@ -38,129 +47,142 @@ Last rev: $Id: range_list.h,v 1.1 2008-03-26 23:05:22 nunofonseca Exp $ 00 (0) - range not in interval 11 (3)- all range in interval 10 (2)- range parcially in interval - + An extra byte is used to keep the number of nodes in the subtrees. */ struct s_node { - //short quadrant; - unsigned short int quadrant_1: 2; // - unsigned short int quadrant_2: 2; - unsigned short int quadrant_3: 2; - unsigned short int quadrant_4: 2; - unsigned short int num_subnodes: 8; + // short quadrant; + unsigned short int quadrant_1 : 2; // + unsigned short int quadrant_2 : 2; + unsigned short int quadrant_3 : 2; + unsigned short int quadrant_4 : 2; + unsigned short int num_subnodes : 8; }; -typedef enum { R_TOTALLY_IN_INTERVAL=3, R_PARCIALLY_IN_INTERVAL=2, R_NOT_IN_INTERVAL=0, R_IGNORE=1} QUADRANT_STATUS; +typedef enum { + R_TOTALLY_IN_INTERVAL = 3, + R_PARCIALLY_IN_INTERVAL = 2, + R_NOT_IN_INTERVAL = 0, + R_IGNORE = 1 +} QUADRANT_STATUS; - -#define BRANCH_FACTOR 4 /* factor of division of the range */ -#define LEAF_SIZE 16 /* how many numbers are represented by a leaf */ +#define BRANCH_FACTOR 4 /* factor of division of the range */ +#define LEAF_SIZE 16 /* how many numbers are represented by a leaf */ #define NODE_SIZE sizeof(RL_Node) -#define NODE(tree,idx) (RL_Node*)&tree->root[idx] +#define NODE(tree, idx) (RL_Node *)&tree->root[idx] #define ROOT(tree) 0 -#define IS_ROOT(tree,interval) (tree->range_max<=interval) -#define ROOT_INTERVAL(tree) (tree->root_i*BRANCH_FACTOR) +#define IS_ROOT(tree, interval) (tree->range_max <= interval) +#define ROOT_INTERVAL(tree) (tree->root_i * BRANCH_FACTOR) -#define MIN(a,b) ((a LEAF_SIZE) ? 1 : 0) +#define REALLOC_MEM(tree) (tree->mem_alloc < (tree->size + 1) * NODE_SIZE) +#define MEM_SIZE(tree) (tree->size + 2) * NODE_SIZE -#define IS_LEAF(interval) ((interval<=LEAF_SIZE)?1:0) // check if a interval of type Leaf -#define LAST_LEVEL_INODE(interval) ((interval<=LEAF_SIZE*BRANCH_FACTOR && interval>LEAF_SIZE)?1:0) - -#define REALLOC_MEM(tree) (tree->mem_alloc < (tree->size+1)*NODE_SIZE) -#define MEM_SIZE(tree) (tree->size+2)*NODE_SIZE - - -#define TREE_SIZE(tree) tree->mem_alloc+sizeof(RL_Tree) - +#define TREE_SIZE(tree) tree->mem_alloc + sizeof(RL_Tree) typedef union { struct s_node i_node; unsigned short int leaf; -} RL_Node; /* A node is a internal node (inode) or a leaf depending on their depth in the tree */ - +} RL_Node; /* A node is a internal node (inode) or a leaf depending on their + depth in the tree */ /* Range_List Contains the root node, max range size, */ struct rl_struct { - RL_Node* root; - NUM size; // number of nodes - NUM mem_alloc; // memory allocated for *root - NUM range_max; // maximum value of the interval - NUM root_i; // root interval + RL_Node *root; + NUM size; // number of nodes + NUM mem_alloc; // memory allocated for *root + NUM range_max; // maximum value of the interval + NUM root_i; // root interval }; typedef struct rl_struct RL_Tree; - /* Buffer */ struct s_buffer { - RL_Node* root_node; + RL_Node *root_node; unsigned long size; // memory (in bytes) allocated for root_node }; typedef struct s_buffer RL_Buffer; //---------------------------------------------------------------- // Bits operations -#define BITMAP_empty(b) ((b) == 0) -#define BITMAP_member(b,n) (((b) & (1<<(n))) != 0) -#define BITMAP_alone(b,n) ((b) == (1<<(n))) -#define BITMAP_subset(b1,b2) (((b1) & (b2)) == b2) -#define BITMAP_same(b1,b2) ((b1) == (b2)) +#define BITMAP_empty(b) ((b) == 0) +#define BITMAP_member(b, n) (((b) & (1 << (n))) != 0) +#define BITMAP_alone(b, n) ((b) == (1 << (n))) +#define BITMAP_subset(b1, b2) (((b1) & (b2)) == b2) +#define BITMAP_same(b1, b2) ((b1) == (b2)) -#define BITMAP_on_all(b) ((b) = 255) +#define BITMAP_on_all(b) ((b) = 255) -#define BITMAP_clear(b) ((b) = 0) -#define BITMAP_and(b1,b2) ((b1) &= (b2)) -#define BITMAP_minus(b1,b2) ((b1) &= ~(b2)) -#define BITMAP_insert(b,n) ((b) |= (1<<(n))) -#define BITMAP_delete(b,n) ((b) &= (~(1<<(n)))) -#define BITMAP_copy(b1,b2) ((b1) = (b2)) -#define BITMAP_intersection(b1,b2,b3) ((b1) = ((b2) & (b3))) -#define BITMAP_difference(b1,b2,b3) ((b1) = ((b2) & (~(b3)))) +#define BITMAP_clear(b) ((b) = 0) +#define BITMAP_and(b1, b2) ((b1) &= (b2)) +#define BITMAP_minus(b1, b2) ((b1) &= ~(b2)) +#define BITMAP_insert(b, n) ((b) |= (1 << (n))) +#define BITMAP_delete(b, n) ((b) &= (~(1 << (n)))) +#define BITMAP_copy(b1, b2) ((b1) = (b2)) +#define BITMAP_intersection(b1, b2, b3) ((b1) = ((b2) & (b3))) +#define BITMAP_difference(b1, b2, b3) ((b1) = ((b2) & (~(b3)))) # //---------------------------------------------------------------- -typedef enum { TRUE=1, FALSE=0} BOOLEAN; -typedef enum { IN=1, OUT=0} STATUS; +typedef enum { TRUE = 1, FALSE = 0 } BOOLEAN; +typedef enum { IN = 1, OUT = 0 } STATUS; // #define BUFFER_SIZE 1000 -/* ********************************************************************************** */ -/* API */ -RL_Tree* new_rl(NUM max_size); -RL_Tree* copy_rl(RL_Tree *tree); -void free_rl(RL_Tree* range); +/* ********************************************************************************** + */ +/* API */ +extern RL_Tree *new_rl(NUM max_size); +extern RL_Tree *copy_rl(RL_Tree *tree); +extern void free_rl(RL_Tree *range); -void rl_all(RL_Tree* tree,STATUS status); -void display_tree(RL_Tree *tree); -RL_Tree* set_in_rl(RL_Tree* tree,NUM number,STATUS status); -BOOLEAN in_rl(RL_Tree* range,NUM number); -BOOLEAN freeze_rl(RL_Tree* tree); /* write operations on the range are finishe */ -RL_Tree* intersect_rl(RL_Tree* range1,RL_Tree* range2); +extern void rl_all(RL_Tree *tree, STATUS status); +extern void display_tree(RL_Tree *tree); +extern RL_Tree *set_in_rl(RL_Tree *tree, NUM number, STATUS status); +extern BOOLEAN in_rl(RL_Tree *range, NUM number); +extern BOOLEAN +freeze_rl(RL_Tree *tree); /* write operations on the range are finishe */ +extern RL_Tree *intersect_rl(RL_Tree *range1, RL_Tree *range2); -NUM rl_next_in_bigger(RL_Tree *tree,NUM min); /* Returns next number in tree bigger than min */ - -#define IS_FREEZED(tree) (tree->mem_alloc!=0) +extern NUM +rl_next_in_bigger(RL_Tree *tree, + NUM min); /* Returns next number in tree bigger than min */ +#define IS_FREEZED(tree) (tree->mem_alloc != 0) diff --git a/library/sockets.yap b/library/sockets.yap index 17e68845e..d52bdc22e 100644 --- a/library/sockets.yap +++ b/library/sockets.yap @@ -1,6 +1,28 @@ +/** + * @fileChunkSize library/sockets.yap +*/ + +:- module(yap_sockets, + [ ip_socket/2, % +Domain, -Socket + ip_socket/4, % +Domain, +Type, +Protocol, -Socket + socket_close/1, % +Socket + socket_bind/2, % +Socket, 'AF_INET'(+Host,+Port) + tcp_socket_connect/3, % +Socket, 'AF_INET'(+Host,+Port), -Stream + socket_listen/2, % +Socket, +Length + socket_accept/2, % +Socket, -Stream + socket_accept/3, % +Socket, -Client, -Stream +% socket_select/5, % +TermsSockets, -NewTermsStreams, + % +TimeOut, +Streams, -ReadStreams + current_host/1, % ?HostName + hostname_address/2 % ?HostName, ?HostAddress + ]). +:- use_module(library(socket)). +:- use_module(library(error)). +:- use_module(library(apply)). + /** uses SWI code - SICStus compatible socket library +@aaddtogroup SICStus compatible socket library @ingroup builtins @@ -97,23 +119,6 @@ must be of type `SOCK_STREAM` or `SOCK_SEQPACKET`. */ -:- module(yap_sockets, - [ ip_socket/2, % +Domain, -Socket - ip_socket/4, % +Domain, +Type, +Protocol, -Socket - socket_close/1, % +Socket - socket_bind/2, % +Socket, 'AF_INET'(+Host,+Port) - tcp_socket_connect/3, % +Socket, 'AF_INET'(+Host,+Port), -Stream - socket_listen/2, % +Socket, +Length - socket_accept/2, % +Socket, -Stream - socket_accept/3, % +Socket, -Client, -Stream -% socket_select/5, % +TermsSockets, -NewTermsStreams, - % +TimeOut, +Streams, -ReadStreams - current_host/1, % ?HostName - hostname_address/2 % ?HostName, ?HostAddress - ]). -:- use_module(library(socket)). -:- use_module(library(error)). -:- use_module(library(apply)). %socket(+@var{DOMAIN},+@var{TYPE},+@var{PROTOCOL},-@var{SOCKET}) diff --git a/library/timeout.yap b/library/timeout.yap index b09bc72c4..f7e349cf0 100644 --- a/library/timeout.yap +++ b/library/timeout.yap @@ -39,8 +39,10 @@ The time_out/3 command relies on the alarm/3 built-in to implement a call with a maximum time of execution. The command is available with the `use_module(library(timeout))` command. + */ - +/* + @pred time_out(+ _Goal_, + _Timeout_, - _Result_) diff --git a/library/trees.yap b/library/trees.yap index d409e6cb4..e0127529c 100644 --- a/library/trees.yap +++ b/library/trees.yap @@ -1,11 +1,10 @@ /** * @file trees.yap - * @author R.A.O'Keefe -This file has been included as an YAP library by Vitor Santos Costa, 1999 - + * @author R.A.O'Keefe, This file has been included as an YAP library by Vitor Santos Costa, 1999 + * * @date Wed Nov 18 01:30:42 2015 * - * @brief + * @brief Updatable binary trees. * * */ @@ -19,12 +18,6 @@ This file has been included as an YAP library by Vitor Santos Costa, 1999 tree_to_list/2 ]). -:- meta_predicate - map_tree(2, ?, ?). - - - - % % File : TREES.PL @@ -34,8 +27,8 @@ This file has been included as an YAP library by Vitor Santos Costa, 1999 /** @defgroup trees Updatable Binary Trees -@ingroup library @{ +@ingroup library The following queue manipulation routines are available once included with the `use_module(library(trees))` command. @@ -58,55 +51,9 @@ These are the routines I meant to describe in DAI-WP-150, but the to match the old tree and a pattern to match the new tree. */ -/** @pred get_label(+ _Index_, + _Tree_, ? _Label_) +:- meta_predicate + map_tree(2, ?, ?). - -Treats the tree as an array of _N_ elements and returns the - _Index_-th. - - -*/ - -/** @pred list_to_tree(+ _List_, - _Tree_) - - -Takes a given _List_ of _N_ elements and constructs a binary - _Tree_. - - -*/ -/** @pred map_tree(+ _Pred_, + _OldTree_, - _NewTree_) - - -Holds when _OldTree_ and _NewTree_ are binary trees of the same shape -and `Pred(Old,New)` is true for corresponding elements of the two trees. - - -*/ -/** @pred put_label(+ _Index_, + _OldTree_, + _Label_, - _NewTree_) - - -constructs a new tree the same shape as the old which moreover has the -same elements except that the _Index_-th one is _Label_. - - -*/ -/** @pred tree_size(+ _Tree_, - _Size_) - - -Calculates the number of elements in the _Tree_. - - -*/ -/** @pred tree_to_list(+ _Tree_, - _List_) - - -Is the converse operation to list_to_tree. - - - - - */ /* :- mode get_label(+, +, ?), @@ -124,10 +71,12 @@ Is the converse operation to list_to_tree. */ -% get_label(Index, Tree, Label) -% treats the tree as an array of N elements and returns the Index-th. -% If Index < 1 or > N it simply fails, there is no such element. +/** @pred get_label(+ _Index_, + _Tree_, ? _Label_) +Treats the tree as an array of _N_ elements and returns the + _Index_-th. + +*/ get_label(N, Tree, Label) :- find_node(N, Tree, t(Label,_,_)). @@ -146,10 +95,14 @@ get_label(N, Tree, Label) :- -% list_to_tree(List, Tree) -% takes a given List of N elements and constructs a binary Tree -% where get_label(K, Tree, Lab) <=> Lab is the Kth element of List. +/** @pred list_to_tree(+ _List_, - _Tree_) + +Takes a given _List_ of _N_ elements and constructs a binary + _Tree_. + + +*/ list_to_tree(List, Tree) :- list_to_tree(List, [Tree|Tail], Tail). @@ -166,27 +119,37 @@ list_to_tree(List, Tree) :- -% map_tree(Pred, OldTree, NewTree) -% is true when OldTree and NewTree are binary trees of the same shape -% and Pred(Old,New) is true for corresponding elements of the two trees. -% In fact this routine is perfectly happy constructing either tree given -% the other, I have given it the mode I have for that bogus reason -% "efficiency" and because it is normally used this way round. This is -% really meant more as an illustration of how to map over trees than as -% a tool for everyday use. +/** @pred map_tree(+ _Pred_, + _OldTree_, - _NewTree_) + +Holds when _OldTree_ and _NewTree_ are binary trees of the same shape +and `Pred(Old,New)` is true for corresponding elements of the two trees. + + is true when OldTree and NewTree are binary trees of the same shape + and Pred(Old,New) is true for corresponding elements of the two trees. + In fact this routine is perfectly happy constructing either tree given + the other, I have given it the mode I have for that bogus reason + "efficiency" and because it is normally used this way round. This is + really meant more as an illustration of how to map over trees than as + a tool for everyday use. +*/ map_tree(Pred, t(Old,OLeft,ORight), t(New,NLeft,NRight)) :- once(call(Pred, Old, New)), map_tree(Pred, OLeft, NLeft), map_tree(Pred, ORight, NRight). map_tree(_, t, t). -% put_label(Index, OldTree, Label, NewTree) -% constructs a new tree the same shape as the old which moreover has the -% same elements except that the Index-th one is Label. Unlike the -% "arrays" of Arrays.Pl, OldTree is not modified and you can hang on to -% it as long as you please. Note that O(lg N) new space is needed. +/** @pred put_label(+ _Index_, + _OldTree_, + _Label_, - _NewTree_) + +constructs a new tree the same shape as the old which moreover has the +same elements except that the _Index_-th one is _Label_. + + It constructs a new tree the same shape as the old which moreover has the + same elements except that the Index-th one is Label. Unlike the + "arrays" of Arrays.Pl, OldTree is not modified and you can hang on to + it as long as you please. Note that O(lg N) new space is needed. +*/ put_label(N, Old, Label, New) :- find_node(N, Old, t(_,Left,Right), New, t(Label,Left,Right)). @@ -205,10 +168,12 @@ put_label(N, Old, Label, New) :- -% tree_size(Tree, Size) -% calculates the number of elements in the Tree. All trees made by -% list_to_tree that are the same size have the same shape. +/** @pred tree_size(+ _Tree_, - _Size_) + Calculates the number of elements in the _Tree_. + + All trees made by list_to_tree that are the same size have the same shape. +*/ tree_size(Tree, Size) :- tree_size(Tree, 0, Total), !, Size = Total. @@ -222,13 +187,15 @@ tree_size(Tree, Size) :- -% tree_to_list(Tree, List) -% is the converse operation to list_to_tree. Any mapping or checking -% operation can be done by converting the tree to a list, mapping or -% checking the list, and converting the result, if any, back to a tree. -% It is also easier for a human to read a list than a tree, as the -% order in the tree goes all over the place. +/** @pred tree_to_list(+ _Tree_, - _List_) + + Is the converse operation to list_to_tree.. Any mapping or checking + operation can be done by converting the tree to a list, mapping or + checking the list, and converting the result, if any, back to a tree. + It is also easier for a human to read a list than a tree, as the + order in the tree goes all over the place. + */ tree_to_list(Tree, List) :- tree_to_list([Tree|Tail], Tail, List). @@ -243,5 +210,7 @@ tree_to_list(Tree, List) :- list(0, []). list(N, [N|L]) :- M is N-1, list(M, L). -%% @}/** @} */ +%% @} + + diff --git a/library/undgraphs.yap b/library/undgraphs.yap index 9d2869c4d..563cf9606 100644 --- a/library/undgraphs.yap +++ b/library/undgraphs.yap @@ -3,14 +3,10 @@ * @author VITOR SANTOS COSTA * @date 2006 * - * @brief Directed Graph Processing Utilities. + * @brief Undirected Graph Processing Utilities. * * */ -% File : dgraphs.yap -% Author : Vitor Santos Costa -% Updated: 2006 -% Purpose: :- module( undgraphs, [ @@ -35,33 +31,8 @@ The following graph manipulation routines use the red-black tree graph library to implement undirected graphs. Mostly, this is done by having two directed edges per undirected edge. - - - @pred undgraph_new(+ _Graph_) - - -Create a new directed graph. This operation must be performed before -trying to use the graph. - - */ - -/** @pred undgraph_complement(+ _Graph_, - _NewGraph_) - - -Unify _NewGraph_ with the graph complementary to _Graph_. - - -*/ -/** @pred undgraph_vertices(+ _Graph_, - _Vertices_) - - -Unify _Vertices_ with all vertices appearing in graph - _Graph_. - - -*/ :- reexport( library(dgraphs), [ dgraph_new/1 as undgraph_new, @@ -106,6 +77,28 @@ Unify _Vertices_ with all vertices appearing in graph rb_partial_map/4 ]). +/** + + @pred undgraph_new(+ _Graph_) + +Create a new directed graph. This operation must be performed before +trying to use the graph. + +*/ + +/** @pred undgraph_complement(+ _Graph_, - _NewGraph_) + +Unify _NewGraph_ with the graph complementary to _Graph_. + +*/ + +/** @pred undgraph_vertices(+ _Graph_, - _Vertices_) + +Unify _Vertices_ with all vertices appearing in graph + _Graph_. + + */ + undgraph_add_edge(Vs0,V1,V2,Vs2) :- dgraphs:dgraph_new_edge(V1,V2,Vs0,Vs1), dgraphs:dgraph_new_edge(V2,V1,Vs1,Vs2). diff --git a/pl/builtins.yap b/pl/builtins.yap index 5723cb9c7..2994f3dd1 100644 --- a/pl/builtins.yap +++ b/pl/builtins.yap @@ -19,7 +19,7 @@ @file boot.yap @brief YAP bootstrap - @addtogroupg YAPControl Control Predicates + @addtogroup YAPControl Control Predicates @ingroup builtins @{ diff --git a/pl/consult.yap b/pl/consult.yap index 4178741b5..8fb9fdd4b 100644 --- a/pl/consult.yap +++ b/pl/consult.yap @@ -1312,19 +1312,18 @@ account the following observations:
          -
        • The `reexport` declarations must be the first declarations to + + The `reexport` declarations must be the first declarations to follow the `module` declaration.
          • -
        • It is possible to use both `reexport` and `use_module`, but all + + It is possible to use both `reexport` and `use_module`, but all predicates reexported are automatically available for use in the - current module.
          • + current module. -
        • In order to obtain efficient execution, YAP compiles + + In order to obtain efficient execution, YAP compiles dependencies between re-exported predicates. In practice, this means that changing a `reexport` declaration and then *just* recompiling - the file may result in incorrect execution.
          • + the file may result in incorrect execution. -
        */ '$reexport'( TOpts, File, Reexport, Imports, OldF ) :- ( Reexport == false -> true ; diff --git a/pl/error.yap b/pl/error.yap index 97c5c310a..0191fd557 100644 --- a/pl/error.yap +++ b/pl/error.yap @@ -146,7 +146,7 @@ must_bind_to_type(Type, X) :- ; is_not(Type, X) ). -%% @predicate is_not(+Type, @Term) +%% @predicate is_not(+Type, +Term) % % Throws appropriate error. It is _known_ that Term is not of type % Type. diff --git a/pl/listing.yap b/pl/listing.yap index 1662e9213..cd62e85d4 100644 --- a/pl/listing.yap +++ b/pl/listing.yap @@ -16,7 +16,7 @@ *************************************************************************/ /** - * @file listing.yap + * @file pl/listing.yap * @author VITOR SANTOS COSTA * @date Thu Oct 19 12:05:19 2017 * diff --git a/pl/newmod.yap b/pl/newmod.yap index 8bf3f9763..f07ab404e 100644 --- a/pl/newmod.yap +++ b/pl/newmod.yap @@ -1,11 +1,17 @@ /** @file newmod.yap - @short support for creating a new module. + @brief support for creating a new module. @ingroup ModuleBuiltins + + */ + + + /** @pred module(+M) is det - set the type-in module + + set the type-in module Defines _M_ to be the current working or type-in module. All files diff --git a/pl/preds.yap b/pl/preds.yap index 21ad8282b..65ff8b6fb 100644 --- a/pl/preds.yap +++ b/pl/preds.yap @@ -417,7 +417,7 @@ abolish(X0) :- '$purge_clauses'(G, M), fail. '$abolishs'(_, _). -/** @pred stash_predicate(+ _Pred_) @anchor stash_predicate +/** @pred stash_predicate(+ _Pred_) Make predicate _Pred_ invisible to new code, and to `current_predicate/2`, `listing`, and friends. New predicates with the same name and functor can be declared. diff --git a/pl/save.yap b/pl/save.yap index b681cf2de..f568ef2e1 100644 --- a/pl/save.yap +++ b/pl/save.yap @@ -22,7 +22,7 @@ * * @brief Old Style save * - * @addtòxgroup QLY + * @addtogroup QLY * */