kernel modules Wiedervereinigung
[scilab.git] / scilab / modules / ast / includes / symbol / context.hxx
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2007-2008 - INRIA - Bruno JOFRET
4  *
5  *  This file must be used under the terms of the CeCILL.
6  *  This source file is licensed as described in the file COPYING, which
7  *  you should have received as part of this distribution.  The terms
8  *  are also available at
9  *  http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 /**
14  ** \file symbol/context.hh
15  ** \brief Define class Context.
16  */
17
18 #ifndef __CONTEXT_HXX__
19 #define __CONTEXT_HXX__
20
21 #include "function.hxx"
22 #include "typesdecl.hxx"
23 #include "variables.hxx"
24 #include "libraries.hxx"
25
26 extern "C"
27 {
28 #include "dynlib_ast.h"
29 }
30
31 namespace symbol
32 {
33
34 /** \brief Define class Context.
35 */
36 class EXTERN_AST Context
37 {
38 public :
39     static Context* getInstance(void);
40
41     static void destroyInstance(void);
42
43     /** Open a context scope i.e
44     ** open the heap table one
45     ** and the env table too. */
46     void scope_begin();
47
48     /** Close a context scope i.e
49     ** close the heap table one
50     ** and the env table too. */
51     void scope_end();
52
53     /** If key was associated to some Entry_T in the open scopes, return the
54     ** most recent insertion. Otherwise return the empty pointer. */
55     types::InternalType* get(const Symbol& key);
56     types::InternalType* get(const Variable* _var);
57     Variable* getOrCreate(const Symbol& _key);
58
59     /** If key was associated to some Entry_T in the last opened scope, return it.
60     ** Otherwise return the empty pointer. */
61     types::InternalType* getCurrentLevel(const Symbol& key);
62
63     /** If key was associated to some Entry_T in the open scopes, return the
64     ** most recent insertion DESPITE the current/last one. Otherwise return the empty pointer. */
65     types::InternalType* getAllButCurrentLevel(const Symbol& key);
66
67     /** If key was associated to some Entry_T in the open scopes, return the
68     ** most recent insertion. Otherwise return the empty pointer. */
69     types::InternalType* getFunction(const Symbol& key);
70
71     /*return function list in the module _stModuleName*/
72     std::list<Symbol>* getFunctionList(std::wstring _stModuleName);
73
74     std::list<std::wstring>* getVarsName();
75     std::list<std::wstring>* getMacrosName();
76     std::list<std::wstring>* getFunctionsName();
77
78     /* global functions */
79
80     /*return global variable visibility status*/
81     bool isGlobalVisible(const Symbol& key);
82
83     /*return global variable existance status*/
84     bool isGlobal(const Symbol& key);
85
86     /*remove global variable and all visibility references */
87     //clearglobal("a")
88     void removeGlobal(const Symbol& key);
89
90     /*remove all global variables and references */
91     //clearglobal
92     void removeGlobalAll();
93
94     void clearAll();
95
96     /*set variable visible/hidden in current global scope*/
97     void setGlobalVisible(const Symbol& key, bool bVisible);
98     void setGlobal(const Symbol& key);
99
100     types::InternalType* getGlobalValue(const Symbol& _key);
101
102     /*add symbol and value in the stack*/
103     void put(const Symbol& _key, types::InternalType* _pIT);
104     void put(Variable* _var, types::InternalType* _pIT);
105     /*add symbol and value in the previous scope*/
106     bool putInPreviousScope(Variable* _var, types::InternalType* _pIT);
107
108     /* remove symbol/value association */
109     //clear("a")
110     bool remove(const Symbol& key);
111     //clear();
112     bool removeAll();
113
114     bool addFunction(types::Function *_info);
115     bool addMacro(types::Macro *_info);
116     bool addMacroFile(types::MacroFile *_info);
117     void print(std::wostream& ostr) const;
118 private :
119
120     types::InternalType* get(const Symbol& key, int _iLevel);
121     bool clearCurrentScope(bool _bClose);
122
123     typedef std::map<Symbol, Variable*> VarList;
124     typedef std::stack<VarList*> VarStack;
125     std::list<Symbol>* globals;
126     VarStack varStack;
127     Variables variables;
128     Libraries libraries;
129     int m_iLevel;
130
131     Context();
132     ~Context();
133
134     static Context* me;
135 };
136
137 inline std::wostream& operator<< (std::wostream& ostr, const Context &ctx)
138 {
139     ctx.print(ostr);
140     return ostr;
141 }
142
143 }
144 #endif /* !__CONTEXT_HXX__ */