0b487656513f90b1abdd0b21e69f2cec6d9dda31
[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     typedef std::map<Symbol, Variable*> VarList;
40     typedef std::stack<VarList*> VarStack;
41
42     static Context* getInstance(void);
43
44     static void destroyInstance(void);
45
46     /** Open a context scope i.e
47     ** open the heap table one
48     ** and the env table too. */
49     void scope_begin();
50
51     /** Close a context scope i.e
52     ** close the heap table one
53     ** and the env table too. */
54     void scope_end();
55
56     /** If key was associated to some Entry_T in the open scopes, return the
57     ** most recent insertion. Otherwise return the empty pointer. */
58     types::InternalType* get(const Symbol& key);
59     types::InternalType* get(const Variable* _var);
60     Variable* getOrCreate(const Symbol& _key);
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
66     /** If key was associated to some Entry_T in the open scopes, return the
67     ** most recent insertion DESPITE the current/last one. Otherwise return the empty pointer. */
68     types::InternalType* getAllButCurrentLevel(const Symbol& key);
69
70     /** If key was associated to some Entry_T in the open scopes, return the
71     ** most recent insertion. Otherwise return the empty pointer. */
72     types::InternalType* getFunction(const Symbol& key);
73
74     /*return function list in the module _stModuleName*/
75     std::list<Symbol>* getFunctionList(std::wstring _stModuleName);
76
77     std::list<std::wstring>* getVarsName();
78     std::list<std::wstring>* getMacrosName();
79     std::list<std::wstring>* getFunctionsName();
80     std::list<std::wstring>* getVarsNameForWho(bool sorted);
81     std::list<std::wstring>* getGlobalNameForWho(bool sorted);
82     std::list<std::wstring>* getWhereIs(const std::wstring& _str);
83
84     /* global functions */
85
86     /*return global variable visibility status*/
87     bool isGlobalVisible(const Symbol& key);
88
89     /*return global variable existance status*/
90     bool isGlobal(const Symbol& key);
91
92     /*remove global variable and all visibility references */
93     //clearglobal("a")
94     void removeGlobal(const Symbol& key);
95
96     /*remove all global variables and references */
97     //clearglobal
98     void removeGlobalAll();
99
100     void clearAll();
101
102     /*set variable visible/hidden in current global scope*/
103     void setGlobalVisible(const Symbol& key, bool bVisible);
104     void setGlobal(const Symbol& key);
105
106     types::InternalType* getGlobalValue(const Symbol& _key);
107
108     /*add symbol and value in the stack*/
109     void put(const Symbol& _key, types::InternalType* _pIT);
110     void put(Variable* _var, types::InternalType* _pIT);
111     /*add symbol and value in the previous scope*/
112     bool putInPreviousScope(Variable* _var, types::InternalType* _pIT);
113
114     /* remove symbol/value association */
115     //clear("a")
116     bool remove(const Symbol& key);
117     //clear();
118     bool removeAll();
119
120     bool addFunction(types::Function *_info);
121     bool addMacro(types::Macro *_info);
122     bool addMacroFile(types::MacroFile *_info);
123     void print(std::wostream& ostr, bool bSorted = false) const;
124     int getScopeLevel();
125     bool isValidVariableName(const wchar_t*);
126     bool isValidVariableName(const char*);
127 private:
128
129     types::InternalType* get(const Symbol& key, int _iLevel);
130     bool clearCurrentScope(bool _bClose);
131
132     std::list<Symbol>* globals;
133     VarStack varStack;
134     Variables variables;
135     Libraries libraries;
136     int m_iLevel;
137
138     Context();
139     ~Context();
140
141     static Context* me;
142 };
143
144 inline std::wostream& operator<< (std::wostream& ostr, const Context &ctx)
145 {
146     ctx.print(ostr);
147     return ostr;
148 }
149
150 }
151 #endif /* !__CONTEXT_HXX__ */