/usr/include/sbml/math/L3Parser.h is in libsbml5-dev 5.16.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | /**
* @file L3Parser.h
* @brief Definition of the level 3 infix-to-mathml parser C functions.
* @author Lucian Smith
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2017 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution and
* also available online as http://sbml.org/software/libsbml/license.html
* ---------------------------------------------------------------------- -->*/
#ifndef L3Parser_h
#define L3Parser_h
#include <sbml/common/extern.h>
#include <sbml/math/ASTNode.h>
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Parses a text string as a mathematical formula and returns an AST
* representation of it.
*
* @copydetails doc_summary_of_string_math_l3
*
* @param formula the text-string formula expression to be parsed.
*
* @return the root node of an AST representing the mathematical formula, or
* @c NULL if an error occurred while parsing the formula. When @c NULL is
* returned, an error is recorded internally; information about the error can
* be retrieved using @sbmlfunction{getLastParseL3Error,}.
*
* @see @sbmlfunction{parseL3FormulaWithSettings, String\, L3ParserSettings}
* @see @sbmlfunction{parseL3FormulaWithModel, String\, Model}
* @see @sbmlfunction{parseFormula, String}
* @see @sbmlfunction{formulaToL3StringWithSettings, ASTNode\, L3ParserSettings}
* @see @sbmlfunction{formulaToL3String, ASTNode}
* @see @sbmlfunction{formulaToString, ASTNode}
* @see L3ParserSettings
* @see @sbmlfunction{getDefaultL3ParserSettings,}
* @see @sbmlfunction{getLastParseL3Error,}
*
* @copydetails doc_note_math_string_syntax
*
* @if conly
* @memberof ASTNode_t
* @endif
*/
LIBSBML_EXTERN
ASTNode_t *
SBML_parseL3Formula (const char *formula);
/**
* Parses a text string as a mathematical formula using a Model to resolve
* symbols, and returns an AST representation of the result.
*
* This is identical to @sbmlfunction{parseL3Formula, String}, except
* that this function uses the given model in the argument @p model to check
* against identifiers that appear in the @p formula. For more information
* about the parser, please see the definition of L3ParserSettings and
* the function @sbmlfunction{parseL3Formula, String}.
*
* @param formula the mathematical formula expression to be parsed.
*
* @param model the Model object to use for checking identifiers.
*
* @return the root node of an AST representing the mathematical formula,
* or @c NULL if an error occurred while parsing the formula. When @c NULL
* is returned, an error is recorded internally; information about the
* error can be retrieved using @sbmlfunction{getLastParseL3Error,}.
*
* @see @sbmlfunction{parseL3Formula, String}
* @see @sbmlfunction{parseL3FormulaWithSettings, String\, L3ParserSettings}
* @see @sbmlfunction{parseL3FormulaWithModel, String\, Model}
* @see @sbmlfunction{parseFormula, String}
* @see @sbmlfunction{getLastParseL3Error,}
* @see L3ParserSettings
*
* @if conly
* @memberof ASTNode_t
* @endif
*/
LIBSBML_EXTERN
ASTNode_t *
SBML_parseL3FormulaWithModel (const char *formula, const Model_t * model);
/**
* Parses a text string as a mathematical formula using specific parser
* settings and returns an AST representation of the result.
*
* This is identical to @sbmlfunction{parseL3Formula, String}, except
* that this function uses the parser settings given in the argument @p
* settings. The settings override the default parsing behavior. The
* following parsing behaviors can be configured:
*
* @copydetails doc_l3_parser_configuration_options
*
* For more details about the parser, please see the definition of
* L3ParserSettings and @sbmlfunction{parseL3FormulaWithSettings, String\,
* L3ParserSettings}.
*
* @param formula the mathematical formula expression to be parsed.
*
* @param settings the settings to be used for this parser invocation.
*
* @return the root node of an AST representing the mathematical formula,
* or @c NULL if an error occurred while parsing the formula. When @c NULL
* is returned, an error is recorded internally; information about the
* error can be retrieved using @sbmlfunction{getLastParseL3Error,}.
*
* @see @sbmlfunction{parseL3Formula, String}
* @see @sbmlfunction{parseL3FormulaWithSettings, String\, L3ParserSettings}
* @see @sbmlfunction{parseL3FormulaWithModel, String\, Model}
* @see @sbmlfunction{parseFormula, String}
* @see @sbmlfunction{getLastParseL3Error,}
* @see L3ParserSettings
*
* @if conly
* @memberof ASTNode_t
* @endif
*/
LIBSBML_EXTERN
ASTNode_t *
SBML_parseL3FormulaWithSettings (const char *formula, const L3ParserSettings_t *settings);
/**
* Returns a copy of the default Level 3 ("L3") formula parser settings.
*
* The data structure storing the settings allows callers to change the
* following parsing behaviors:
*
* @copydetails doc_summary_of_string_math_l3
*
* For more details about the parser, please see the definition of
* L3ParserSettings and @sbmlfunction{parseL3Formula, String}.
*
* @see @sbmlfunction{parseL3Formula, String}
* @see @sbmlfunction{parseL3FormulaWithSettings, String\, L3ParserSettings}
* @see @sbmlfunction{formulaToL3StringWithSettings, ASTNode\, L3ParserSettings}
* @see L3ParserSettings
*
* @if conly
* @memberof L3ParserSettings_t
* @endif
*/
LIBSBML_EXTERN
L3ParserSettings_t*
SBML_getDefaultL3ParserSettings ();
/**
* Returns the last error reported by the "L3" mathematical formula parser.
*
* If the functions @sbmlfunction{parseL3Formula, String},
* @sbmlfunction{parseL3FormulaWithSettings, String\,
* L3ParserSettings}, or @sbmlfunction{parseL3FormulaWithModel,
* String\, Model} return @c NULL, an error is set internally.
* This function allows callers to retrieve information about the error.
*
* @return a string describing the error that occurred. This will contain
* the input string the parser was trying to parse, the character it had
* parsed when it encountered the error, and a description of the error.
*
* @see @sbmlfunction{parseL3Formula, String}
* @see @sbmlfunction{parseL3FormulaWithSettings, String\, L3ParserSettings}
* @see @sbmlfunction{parseL3FormulaWithModel, String\, Model}
* @see @sbmlfunction{getDefaultL3ParserSettings,}
*
* @if conly
* @memberof ASTNode_t
* @endif
*/
LIBSBML_EXTERN
char*
SBML_getLastParseL3Error();
/** @cond doxygenLibsbmlInternal */
LIBSBML_EXTERN
void
SBML_deleteL3Parser();
/** @endcond */
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* L3Parser_h */
|