reduce overhead of debugger and improve output of functions
[scilab.git] / scilab / modules / ast / includes / ast / debugmanager.hxx
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2015 - Scilab Enterprises - Antoine ELIAS
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  */
15
16 #ifndef __DEBUGGER_MANAGER_HXX__
17 #define __DEBUGGER_MANAGER_HXX__
18
19 #include <memory>
20
21 #include "abstractdebugger.hxx"
22 #include "configvariable.hxx"
23 #include "breakpoint.hxx"
24 #include "dynlib_ast.h"
25
26 namespace debugger
27 {
28 class EXTERN_AST DebuggerManager
29 {
30 public:
31     enum DebugAction
32     {
33         Continue,
34         Aborted,
35         StepNext,
36         StepIn,
37         StepOut
38     };
39
40     struct StackRow
41     {
42         std::string functionName;
43         std::string fileName;
44         int functionLine;
45         int fileLine;
46         int scope;
47         bool hasFile = false;
48     };
49
50     typedef std::vector<StackRow> Stack;
51     struct CallStack
52     {
53         std::string exp;
54         Stack stack;
55     };
56
57 private:
58     static std::unique_ptr<DebuggerManager> me;
59     DebuggerManager() :
60         breakpoints(),
61         debuggers(),
62         callstack(), pExp(nullptr), interrupted(false), currentBreakPoint(-1), action(Continue), level(0) {}
63
64     Breakpoints breakpoints;
65     Watches watches;
66     CallStack callstack;
67     Debuggers debuggers;
68
69     ast::Exp* pExp;
70     bool interrupted;
71     int currentBreakPoint;
72     DebugAction action;
73     int level;
74
75     void internal_execution_released();
76     void internal_stop();
77     bool callstackAddFile(StackRow* _row, const std::wstring& _fileName);
78
79 public:
80     ~DebuggerManager()
81     {
82         for (auto d : debuggers)
83         {
84             delete d.second;
85         }
86
87         for (auto b : breakpoints)
88         {
89             delete b;
90         }
91
92         clearCallStack();
93     }
94
95     static DebuggerManager* getInstance();
96
97     //debuggers functions
98     void addDebugger(const std::string& _name, AbstractDebugger* _debug);
99     void removeDebugger(const std::string& _name);
100     AbstractDebugger* getDebugger(const std::string& _name);
101     int getDebuggerCount();
102     Debuggers& getAllDebugger();
103
104     void setExp(const ast::Exp* _pExp)
105     {
106         pExp = const_cast<ast::Exp*>(_pExp);
107     }
108     void clearExp()
109     {
110         pExp = NULL;
111     }
112     ast::Exp* getExp()
113     {
114         return pExp;
115     }
116
117     bool isInterrupted()
118     {
119         return interrupted;
120     }
121
122     Breakpoint* getCurrentBreakPoint()
123     {
124         if (currentBreakPoint != -1)
125         {
126             return getBreakPoint(currentBreakPoint);
127         }
128
129         return nullptr;
130     }
131
132     void generateCallStack();
133     inline void clearCallStack()
134     {
135         callstack.exp.clear();
136         callstack.stack.clear();
137     }
138
139     CallStack& getCallStack()
140     {
141         return callstack;
142     }
143
144     //send information to debuggers
145     void sendStop(int index);
146     void sendExecution();
147     void sendExecutionReleased();
148     void sendPrint(const std::string& variable);
149     void sendShow(int bp);
150     void sendResume();
151     void sendAbort();
152     void sendErrorInFile(const std::wstring& filename) const;
153     void sendErrorInScript(const std::wstring& funcname) const;
154     void sendQuit();
155     void sendUpdate() const;
156
157     void stop(const ast::Exp* pExp, int index);
158     void errorInFile(const std::wstring filename, const ast::Exp* pExp);
159     void errorInScript(const std::wstring funcname, const ast::Exp* pExp);
160
161     //breakpoints functions
162     void addBreakPoint(Breakpoint* bp);
163     void removeBreakPoint(int _iBreakPoint);
164     void setAllBreakPoints(Breakpoints& _bps);
165     void removeAllBreakPoints();
166     void disableAllBreakPoints();
167     void disableBreakPoint(int _iBreakPoint);
168     void enableAllBreakPoints();
169     void enableBreakPoint(int _iBreakPoint);
170     bool isEnableBreakPoint(int _iBreakPoint);
171     Breakpoint* getBreakPoint(int _iBreakPoint);
172     int getBreakPointCount();
173     Breakpoints& getAllBreakPoint();
174
175     //watches functions
176     void setWatches(const Watches& _w);
177     void removeWatches();
178     void updateWatches(int _iScopeLvl = -1);
179     Watches& getWatches();
180
181     //actions called by debuggers
182     inline void setStepIn() //enter macro
183     {
184         action = StepIn;
185         level = symbol::Context::getInstance()->getScopeLevel();
186     }
187
188     inline bool isStepIn()
189     {
190         int l = symbol::Context::getInstance()->getScopeLevel();
191         //if stepIn failed ( not a macro ), stepIn become a stepNext
192         if(action != StepIn)
193         {
194             return false;
195         }
196
197         if(l < level)
198         {
199             action = StepNext;
200             return false;
201         }
202
203         return true;
204     }
205
206     inline void resetStepIn()
207     {
208         if (isStepIn())
209         {
210             action = Continue;
211         }
212     }
213
214     inline void setStepOut() //exit macro
215     {
216         action = StepOut;
217         level = ConfigVariable::getWhere().size();
218     }
219
220     inline bool isStepOut()
221     {
222         int l = ConfigVariable::getWhere().size();
223         return action == StepOut && l < level;
224     }
225
226     inline void resetStepOut()
227     {
228         if (isStepOut())
229         {
230             action = Continue;
231         }
232     }
233
234     inline void setAborted() //next statement
235     {
236         action = Aborted;
237     }
238
239     inline bool isAborted()
240     {
241         return action == Aborted;
242     }
243
244     inline void resetAborted()
245     {
246         if (isAborted())
247         {
248             action = Continue;
249         }
250     }
251
252     inline void setStepNext() //next statement
253     {
254         action = StepNext;
255         level = symbol::Context::getInstance()->getScopeLevel();
256     }
257
258     inline bool isStepNext()
259     {
260         int l = symbol::Context::getInstance()->getScopeLevel();
261         //if stepNext failed ( end of macro ), stepNext become a stepOut
262         return action == StepNext && l <= level;
263     }
264
265     inline void resetStepNext()
266     {
267         if (isStepNext())
268         {
269             action = Continue;
270         }
271     }
272
273     inline void resetStep()
274     {
275         if (isInterrupted() == false)
276         {
277             action = Continue;
278         }
279     }
280
281     char* execute(const std::string& command); //execute a command
282     void print(const std::string& variable); //print a variable
283     void show(int bp); //print the breakpoint bp or all breakpoints (bp = -1)
284     void resume(); //resume execution
285     void abort(); //abort execution
286 };
287
288 }
289 #endif /* !__DEBUGGER_MANAGER_HXX__ */