Scilab debugger updates
[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         for (auto b : breakpoints)
87         {
88             delete b;
89         }
90
91         clearCallStack();
92     }
93
94     static DebuggerManager* getInstance();
95
96     //debuggers functions
97     void addDebugger(const std::string& _name, AbstractDebugger* _debug);
98     void removeDebugger(const std::string& _name);
99     AbstractDebugger* getDebugger(const std::string& _name);
100     int getDebuggerCount();
101     Debuggers& getAllDebugger();
102
103     void setExp(const ast::Exp* _pExp)
104     {
105         pExp = const_cast<ast::Exp*>(_pExp);
106     }
107     void clearExp()
108     {
109         pExp = NULL;
110     }
111     ast::Exp* getExp()
112     {
113         return pExp;
114     }
115
116     bool isInterrupted()
117     {
118         return interrupted;
119     }
120
121     Breakpoint* getCurrentBreakPoint()
122     {
123         if (currentBreakPoint != -1)
124         {
125             return getBreakPoint(currentBreakPoint);
126         }
127
128         return nullptr;
129     }
130
131     void generateCallStack();
132     inline void clearCallStack()
133     {
134         callstack.exp.clear();
135         callstack.stack.clear();
136     }
137
138     CallStack getCallStack()
139     {
140         return callstack;
141     }
142
143     //send information to debuggers
144     void sendStop(int index);
145     void sendExecution();
146     void sendExecutionReleased();
147     void sendPrint(const std::string& variable);
148     void sendShow(int bp);
149     void sendResume();
150     void sendAbort();
151     void sendErrorInFile(const std::wstring& filename) const;
152     void sendErrorInScript(const std::wstring& funcname) const;
153     void sendQuit();
154     void sendUpdate() const;
155
156     void stop(const ast::Exp* pExp, int index);
157     void errorInFile(const std::wstring filename, const ast::Exp* pExp);
158     void errorInScript(const std::wstring funcname, const ast::Exp* pExp);
159
160     //breakpoints functions
161     void addBreakPoint(Breakpoint* bp);
162     void removeBreakPoint(int _iBreakPoint);
163     void setAllBreakPoints(Breakpoints& _bps);
164     void removeAllBreakPoints();
165     void disableAllBreakPoints();
166     void disableBreakPoint(int _iBreakPoint);
167     void enableAllBreakPoints();
168     void enableBreakPoint(int _iBreakPoint);
169     bool isEnableBreakPoint(int _iBreakPoint);
170     Breakpoint* getBreakPoint(int _iBreakPoint);
171     int getBreakPointCount();
172     Breakpoints& getAllBreakPoint();
173
174     //watches functions
175     void setWatches(Watches _w);
176     void removeWatches();
177     void updateWatches(int _iScopeLvl = -1);
178     Watches& getWatches();
179
180     //actions called by debuggers
181     inline void setStepIn() //enter macro
182     {
183         action = StepIn;
184         level = symbol::Context::getInstance()->getScopeLevel();
185     }
186     inline bool isStepIn()
187     {
188         int l = symbol::Context::getInstance()->getScopeLevel();
189         //if stepIn failed ( not a macro ), stepIn become a stepNext
190         if(action != StepIn)
191         {
192             return false;
193         }
194
195         if(l < level)
196         {
197             action = StepNext;
198             return false;
199         }
200
201         return true;
202     }
203     inline void resetStepIn()
204     {
205         if (isStepIn())
206         {
207             action = Continue;
208         }
209     }
210
211     inline void setStepOut() //exit macro
212     {
213         action = StepOut;
214         level = ConfigVariable::getWhere().size();
215     }
216     inline bool isStepOut()
217     {
218         int l = ConfigVariable::getWhere().size();
219         return action == StepOut && l < level;
220     }
221     inline void resetStepOut()
222     {
223         if (isStepOut())
224         {
225             action = Continue;
226         }
227     }
228
229     inline void setAborted() //next statement
230     {
231         action = Aborted;
232     }
233     inline bool isAborted()
234     {
235         return action == Aborted;
236     }
237     inline void resetAborted()
238     {
239         if (isAborted())
240         {
241             action = Continue;
242         }
243     }
244
245     inline void setStepNext() //next statement
246     {
247         action = StepNext;
248         level = symbol::Context::getInstance()->getScopeLevel();
249     }
250     inline bool isStepNext()
251     {
252         int l = symbol::Context::getInstance()->getScopeLevel();
253         //if stepNext failed ( end of macro ), stepNext become a stepOut
254         return action == StepNext && l <= level;
255     }
256     inline void resetStepNext()
257     {
258         if (isStepNext())
259         {
260             action = Continue;
261         }
262     }
263
264     inline void resetStep()
265     {
266         if (isInterrupted() == false)
267         {
268             action = Continue;
269         }
270     }
271
272     char* execute(const std::string& command); //execute a command
273     void print(const std::string& variable); //print a variable
274     void show(int bp); //print the breakpoint bp or all breakpoints (bp = -1)
275     void resume(); //resume execution
276     void abort(); //abort execution
277 };
278
279 }
280 #endif /* !__DEBUGGER_MANAGER_HXX__ */