d1edf515165bebe6665c87e8b467f80764a8ae85
[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 "variables.hxx"
23 #include "libraries.hxx"
24
25 extern "C"
26 {
27 #include "dynlib_ast.h"
28 }
29
30 namespace symbol
31 {
32
33 /** \brief Define class Context.
34 */
35 class EXTERN_AST Context
36 {
37 public:
38     typedef std::map<Symbol, Variable*> VarList;
39     typedef std::stack<VarList*> VarStack;
40
41     static Context* getInstance(void);
42
43     static void destroyInstance(void);
44
45     /** Open a context scope i.e
46     ** open the heap table one
47     ** and the env table too. */
48     void scope_begin();
49
50     /** Close a context scope i.e
51     ** close the heap table one
52     ** and the env table too. */
53     void scope_end();
54
55     /** If key was associated to some Entry_T in the open scopes, return the
56     ** most recent insertion. Otherwise return the empty pointer. */
57     types::InternalType* get(const Symbol& key);
58     types::InternalType* get(const Variable* _var);
59     Variable* getOrCreate(const Symbol& _key);
60     int getLevel(const Symbol & _key) const;
61
62     /** If key was associated to some Entry_T in the last opened scope, return it.
63     ** Otherwise return the empty pointer. */
64     types::InternalType* getCurrentLevel(const Symbol& key);
65     types::InternalType* getCurrentLevel(Variable* _var);
66
67     /** If key was associated to some Entry_T in the open scopes, return the
68     ** most recent insertion DESPITE the current/last one. Otherwise return the empty pointer. */
69     types::InternalType* getAllButCurrentLevel(const Symbol& key);
70
71     /** If key was associated to some Entry_T in the open scopes, return the
72     ** most recent insertion. Otherwise return the empty pointer. */
73     types::InternalType* getFunction(const Symbol& key);
74
75     /*return function list in the module _stModuleName*/
76     int getFunctionList(std::list<Symbol>& lst, std::wstring _stModuleName);
77
78     int getVarsName(std::list<std::wstring>& lst);
79     int getMacrosName(std::list<std::wstring>& lst);
80     int getFunctionsName(std::list<std::wstring>& lst);
81     int getVarsNameForWho(std::list<std::wstring>& lst, bool sorted);
82     int getGlobalNameForWho(std::list<std::wstring>& lst, bool sorted);
83     int getWhereIs(std::list<std::wstring>& lst, const std::wstring& _str);
84     int getLibrariesList(std::list<std::wstring>& lst);
85     int getVarsToVariableBrowser(std::list<Variable*>& lst);
86     int getLibsToVariableBrowser(std::list<Library*>& lst);
87     /* global functions */
88
89     /*return global variable visibility status*/
90     bool isGlobalVisible(const Symbol& key);
91
92     /*return global variable existance status*/
93     bool isGlobal(const Symbol& key);
94
95     /*remove global variable and all visibility references */
96     //clearglobal("a")
97     void removeGlobal(const Symbol& key);
98
99     /*remove all global variables and references */
100     //clearglobal
101     void removeGlobalAll();
102     void clearAll();
103
104     //predef
105     void protect();
106     void unprotect();
107     bool isprotected(const Symbol& key);
108     bool isprotected(Variable* _var);
109     int protectedVars(std::list<std::wstring>& lst);
110
111     /*set variable visible/hidden in current global scope*/
112     void setGlobalVisible(const Symbol& key, bool bVisible);
113     void setGlobal(const Symbol& key);
114
115     types::InternalType* getGlobalValue(const Symbol& _key);
116
117     /*add symbol and value in the stack*/
118     void put(const Symbol& _key, types::InternalType* _pIT);
119     void put(Variable* _var, types::InternalType* _pIT);
120     /*add symbol and value in the previous scope*/
121     bool putInPreviousScope(Variable* _var, types::InternalType* _pIT);
122
123     /* remove symbol/value association */
124     //clear("a")
125     bool remove(const Symbol& key);
126     //clear();
127     bool removeAll();
128
129     bool addFunction(types::Function *_info);
130     bool addMacro(types::Macro *_info);
131     bool addMacroFile(types::MacroFile *_info);
132     void print(std::wostream& ostr, bool bSorted = false) const;
133     int getScopeLevel();
134     bool isValidVariableName(const wchar_t*);
135     bool isValidVariableName(const char*);
136
137     inline bool isOriginalSymbol(const symbol::Symbol & sym) const
138     {
139         return getLevel(sym) == 0;
140     }
141
142 private:
143
144     types::InternalType* get(const Symbol& key, int _iLevel);
145     bool clearCurrentScope(bool _bClose);
146     void updateProtection(bool protect);
147
148     std::list<Symbol>* globals;
149     VarStack varStack;
150     Variables variables;
151     Libraries libraries;
152     int m_iLevel;
153
154     Context();
155     ~Context();
156
157     static Context* me;
158 };
159
160 inline std::wostream& operator<< (std::wostream& ostr, const Context &ctx)
161 {
162     ctx.print(ostr);
163     return ostr;
164 }
165
166 }
167 #endif /* !__CONTEXT_HXX__ */