07496d7e8e26f0ac13fe0484f42643a2118b0ccd
[ginac.git] / ginac / parser / parse_context.h
1 /** @file parse_context.h
2  *
3  *  Interface to parser context. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2010 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_PARSE_CONTEXT_H
24 #define GINAC_PARSE_CONTEXT_H
25
26 #include "ex.h"
27 #include "symbol.h"
28
29 #include <cstddef> // for size_t
30 #include <map>
31 #include <string>
32 #include <utility>
33
34 namespace GiNaC {
35
36 /**
37  * Establishes correspondence between the strings and expressions.
38  * The parser will create missing symbols (if not instructed otherwise,
39  * in which case it fails if the expression contains unknown symbols).
40  */
41 typedef std::map<std::string, ex> symtab;
42
43 /**
44  * Find the symbol (or abbreviation) with the @a name in the symbol table @a syms.
45  *
46  * If symbol is missing and @a strict = false, insert it, otherwise
47  * throw an exception.
48  */
49 extern ex 
50 find_or_insert_symbol(const std::string& name, symtab& syms,
51                       const bool strict);
52
53 /**
54  * Function (or class ctor) prototype
55  * .first is  the name of function(or ctor),
56  * .second is the number of arguments (each of type ex)
57  */
58 typedef std::pair<std::string, std::size_t> prototype;
59
60 /**
61  * A (C++) function for reading functions and classes from the stream.
62  *
63  * The parser uses (an associative array of) such functions to construct
64  * (GiNaC) classes and functions from a sequence of characters.
65  */
66 typedef ex (*reader_func)(const exvector& args);
67
68 /**
69  * Prototype table.
70  *
71  * If parser sees an expression which looks like a function call (e.g.
72  * foo(x+y, z^2, t)), it looks up such a table to find out which
73  * function (or class) corresponds to the given name and has the given
74  * number of the arguments.
75  */
76 typedef std::map<prototype, unsigned> prototype_table;
77
78 /**
79  * Creates a default prototype table containing all defined GiNaC functions.
80  *
81  * The data referenced by the return value is only created once when this
82  * function is called for the first time. This might cause problems in very
83  * rare stituations (i.e. if functions are added after this first call). In
84  * that case, a new initialization can be forced with an "true" argument.
85  */
86 extern const prototype_table& get_default_reader(bool force_init = false);
87
88 } // namespace GiNaC
89
90 #endif // GINAC_PARSE_CONTEXT_H