Tokenizes an SBML formula string. More...

Include dependency graph for FormulaTokenizer.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	FormulaTokenizer_t

struct	Token_t

Enumerations
enum	TokenType_t { TT_PLUS = '+' , TT_MINUS = '-' , TT_TIMES = '*' , TT_DIVIDE = '/' , TT_POWER = '^' , TT_LPAREN = '(' , TT_RPAREN = ')' , TT_COMMA = ',' , TT_END = '\0' , TT_NAME = 256 , TT_INTEGER , TT_REAL , TT_REAL_E , TT_UNKNOWN }
	Enumeration of possible token types. More...

Functions
FormulaTokenizer_t *	FormulaTokenizer_createFromFormula (const char *formula)
	Creates a new FormulaTokenizer_t structure for the given `formula` string and returns a pointer to the structure. More...

void	FormulaTokenizer_free (FormulaTokenizer_t *ft)
	Frees the given FormulaTokenizer_t structure `ft`. More...

Token_t *	FormulaTokenizer_nextToken (FormulaTokenizer_t *ft)
	Returns the next token in the formula string. More...

Detailed Description

Tokenizes an SBML formula string.

Author: Ben Bornstein

Enumeration Type Documentation

◆ TokenType_t

enum TokenType_t

Enumeration of possible token types.

"TT" is short for "TokenType".

See also: Token_t

Enumerator
TT_PLUS	The '+' token
TT_MINUS	The '-' token
TT_TIMES	The '*' token
TT_DIVIDE	The '/' token
TT_POWER	The '^' token
TT_LPAREN	The '(' token
TT_RPAREN	The ')' token
TT_COMMA	The ',' token
TT_END	The end-of-input token
TT_NAME	The token for a name
TT_INTEGER	The token for an integer
TT_REAL	The token for a real number (number with a decimal point)
TT_REAL_E	The token for a real number using e-notation
TT_UNKNOWN	An unknown token

Function Documentation

◆ FormulaTokenizer_createFromFormula()

FormulaTokenizer_t* FormulaTokenizer_createFromFormula ( const char * formula )

Creates a new FormulaTokenizer_t structure for the given formula string and returns a pointer to the structure.

SBML Level 1 uses a simple text-string representation of mathematical formulas, rather than the MathML-based representation used in SBML Levels 2 and 3. LibSBML implements a parser and converter to translate formulas between this text-string representation and MathML. The first entry point is the function FormulaTokenizer_createFromFormula(), which returns a FormulaTokenizer_t structure. The structure tracks the current position in the string to be tokenized, and can be handed to other functions such as FormulaTokenizer_nextToken(). Tokens are returned as Token_t structures.

Parameters

formula the text string that contains the mathematical formula to be tokenized.

Returns: a FormulaTokenizer_t structure that tracks the state of tokenizing the string.

See also: FormulaTokenizer_nextToken(); FormulaTokenizer_free()

Note: We urge developers to keep in mind that the text-string formula syntax is specific to libSBML. Neither MathML nor SBML define a text-string format for mathematical formulas. LibSBML's particular syntax should not be considered to be a canonical or standard general-purpose mathematical expression syntax. LibSBML provides methods for parsing and transforming text-string math formulas back and forth from AST structures for the convenience of calling applications, but it is important to keep the system's limitations in mind.

◆ FormulaTokenizer_free()

void FormulaTokenizer_free ( FormulaTokenizer_t * ft )

Frees the given FormulaTokenizer_t structure ft.

◆ FormulaTokenizer_nextToken()

Token_t* FormulaTokenizer_nextToken ( FormulaTokenizer_t * ft )

Returns the next token in the formula string.

SBML Level 1 uses a simple text-string representation of mathematical formulas, rather than the MathML-based representation used in SBML Levels 2 and 3. LibSBML implements a parser and converter to translate formulas between this text-string representation and MathML. The first entry point is the function FormulaTokenizer_createFromFormula(), which returns a FormulaTokenizer_t structure. The structure tracks the current position in the string to be tokenized, and can be handed to other functions such as FormulaTokenizer_nextToken(). Tokens are returned as Token_t structures.

An instance of a FormulaTokenizer_t maintains its own internal copy of the formula being tokenized and the current position within the formula string. Callers do not need to manipulate the fields of a FormulaTokenizer_t structure themselves; instances of FormulaTokenizer_t are only meant to be passed around between the functions of the formula tokenizer system, such as FormulaTokenizer_createFromFormula() and FormulaTokenizer_getName().