debugger: error in try/catch and errcatch fixed
[scilab.git] / scilab / modules / functions / sci_gateway / cpp / sci_exec.cpp
1 /*
2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 * Copyright (C) 2006 - INRIA - 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 #include "functions_gw.hxx"
17
18 #include "parser.hxx"
19 #include "funcmanager.hxx"
20 #include "context.hxx"
21 #include "printvisitor.hxx"
22 #include "visitor_common.hxx"
23 #include "scilabWrite.hxx"
24 #include "configvariable.hxx"
25 #include "types_tools.hxx"
26 #include "runner.hxx"
27 #include "threadmanagement.hxx"
28 #include "macro.hxx"
29 #include "macrofile.hxx"
30 #include "filemanager.hxx"
31
32 #include <memory>
33 #include <iostream>
34 #include <fstream>
35 #include <string>
36
37 extern "C"
38 {
39 #include "os_string.h"
40 #include "expandPathVariable.h"
41 #include "prompt.h"
42 #include "Scierror.h"
43 #include "localization.h"
44 #include "os_string.h"
45 #include "mopen.h"
46 #include "mclose.h"
47 #include "fullpath.h"
48 #include "PATH_MAX.h"
49 }
50
51 void closeFile(std::ifstream* file, int fileId, const std::wstring& wstFile, ast::Exp* pExp)
52 {
53     if (file)
54     {
55         file->close();
56         delete file;
57
58         if (pExp)
59         {
60             delete pExp;
61         }
62
63         // Check if file has not already been closed (for ex mclose('all') in function)
64         if (FileManager::isOpened(wstFile))
65         {
66             mclose(fileId);
67         }
68     }
69 }
70 /*--------------------------------------------------------------------------*/
71 types::Function::ReturnValue sci_exec(types::typed_list &in, int _iRetCount, types::typed_list &out)
72 {
73     int promptMode      = 0;//default value at startup, overthise 3 or verbose ";"
74     int iErr            = 0;
75     bool bErrCatch      = false;
76     ast::Exp* pExp      = NULL;
77     int iID             = 0;
78     types::Macro* pMacro = NULL;
79     bool bSilentError   = ConfigVariable::isSilentError();
80     Parser parser;
81
82     wchar_t* pwstFile = NULL;
83     char* pstFile = NULL;
84
85     std::string stFile;
86     std::ifstream* file = NULL;
87     std::wstring wstFile;
88
89     if (ConfigVariable::getStartProcessing() == false)
90     {
91         if (ConfigVariable::getVerbose())
92         {
93             promptMode = 3;
94         }
95         else
96         {
97             promptMode = 0;
98         }
99     }
100
101     if (in.size() < 1 || in.size() > 3)
102     {
103         Scierror(999, _("%s: Wrong number of input arguments: %d to %d expected.\n"), "exec" , 1, 3);
104         return types::Function::Error;
105     }
106
107     // get mode and errcatch
108     if (in.size() > 1)
109     {
110         //errcatch or mode
111         if (in[1]->isString() && in[1]->getAs<types::String>()->isScalar())
112         {
113             //errcatch
114             types::String* pS = in[1]->getAs<types::String>();
115             if (os_wcsicmp(pS->get(0), L"errcatch") == 0)
116             {
117                 bErrCatch = true;
118             }
119             else
120             {
121                 Scierror(999, _("%s: Wrong value for input argument #%d: 'errcatch' expected.\n"), "exec", 2);
122                 return types::Function::Error;
123             }
124
125             if (in.size() > 2)
126             {
127
128                 if (in[2]->isDouble() == false || in[2]->getAs<types::Double>()->isScalar() == false)
129                 {
130                     //mode
131                     Scierror(999, _("%s: Wrong type for input argument #%d: A integer expected.\n"), "exec", 3);
132                     return types::Function::Error;
133                 }
134
135                 promptMode = (int)in[2]->getAs<types::Double>()->getReal()[0];
136             }
137         }
138         else if (in[1]->isDouble() && in[1]->getAs<types::Double>()->isScalar())
139         {
140             if (in.size() > 2)
141             {
142                 Scierror(999, _("%s: Wrong value for input argument #%d: 'errcatch' expected.\n"), "exec", 2);
143                 return types::Function::Error;
144             }
145             //mode
146             promptMode = (int)in[1]->getAs<types::Double>()->getReal()[0];
147         }
148         else
149         {
150             //not managed
151             Scierror(999, _("%s: Wrong type for input argument #%d: A integer or string expected.\n"), "exec", 2);
152             return types::Function::Error;
153         }
154     }
155
156     if (in[0]->isString() && in[0]->getAs<types::String>()->isScalar())
157     {
158         //1st argument is a path, parse file and execute it
159         int iParsePathLen = 0;
160         types::String* pS = in[0]->getAs<types::String>();
161
162         pwstFile = expandPathVariableW(pS->get(0));
163         pstFile = wide_string_to_UTF8(pwstFile);
164         stFile = pstFile;
165         file = new std::ifstream(pstFile);
166
167         FREE(pstFile);
168
169         wchar_t* pwstTemp = get_full_pathW(pwstFile);
170         wstFile = pwstTemp;
171
172         FREE(pwstFile);
173         /*fake call to mopen to show file within file()*/
174         if (mopen(pwstTemp, L"r", 0, &iID) != MOPEN_NO_ERROR)
175         {
176             closeFile(file, iID, wstFile, pExp);
177             FREE(pwstTemp);
178             Scierror(999, _("%s: Cannot open file %s.\n"), "exec", stFile.data());
179             return types::Function::Error;
180         }
181
182         // update where to set the name of the executed file.
183         ConfigVariable::setFileNameToLastWhere(&wstFile);
184
185         ThreadManagement::LockParser();
186         parser.parseFile(pwstTemp, L"exec");
187         FREE(pwstTemp);
188         if (parser.getExitStatus() !=  Parser::Succeded)
189         {
190             closeFile(file, iID, wstFile, pExp);
191             if (bErrCatch)
192             {
193                 out.push_back(new types::Double(999));
194                 //to lock last error information
195                 ConfigVariable::setLastErrorCall();
196                 // when the parser can not open file the error is already set in lasterror.
197                 if (wcscmp(parser.getErrorMessage(), L""))
198                 {
199                     ConfigVariable::setLastErrorMessage(parser.getErrorMessage());
200                     ConfigVariable::setLastErrorNumber(999);
201                 }
202                 delete parser.getTree();
203                 ThreadManagement::UnlockParser();
204                 return types::Function::OK;
205             }
206
207             char* pst = wide_string_to_UTF8(parser.getErrorMessage());
208             Scierror(999, "%s", pst);
209             FREE(pst);
210
211             delete parser.getTree();
212             ThreadManagement::UnlockParser();
213             return types::Function::Error;
214         }
215
216         if (ConfigVariable::getSerialize())
217         {
218             ast::Exp* temp = parser.getTree();
219             if (ConfigVariable::getTimed())
220             {
221                 pExp = callTyper(temp, L"exec");
222             }
223             else
224             {
225                 pExp = callTyper(temp);
226             }
227
228             delete temp;
229         }
230         else
231         {
232             pExp = parser.getTree();
233         }
234
235         ThreadManagement::UnlockParser();
236
237         ConfigVariable::setExecutedFile(wstFile);
238     }
239     else if (in[0]->isMacro() || in[0]->isMacroFile())
240     {
241         if (in[0]->isMacroFile())
242         {
243             //1st argument is a macro name, parse and execute it in the current environnement
244             if (in[0]->getAs<types::MacroFile>()->parse() == false)
245             {
246                 char* pstMacro = wide_string_to_UTF8(in[0]->getAs<types::MacroFile>()->getName().c_str());
247                 Scierror(999, _("%s: Unable to parse macro '%s'"), "exec", pstMacro);
248                 FREE(pstMacro);
249                 return types::Function::Error;
250             }
251             pMacro = in[0]->getAs<types::MacroFile>()->getMacro();
252         }
253         else //1st argument is a macro name, execute it in the current environnement
254         {
255             pMacro = in[0]->getAs<types::Macro>();
256         }
257
258         // unable for macro with varargin or varargout
259         auto inputs = pMacro->getInputs();
260         auto outputs = pMacro->getOutputs();
261         if ((inputs->size() != 0 && (inputs->back()->getSymbol().getName() == L"varargin")) ||
262                 (outputs->size() != 0 && (outputs->back()->getSymbol().getName() == L"varargout")))
263         {
264             Scierror(999, _("%s: Wrong type for input argument #%d: A macro without varargin and varargout expected.\n"), "exec", 1);
265             return types::Function::Error;
266         }
267
268         pExp = pMacro->getBody();
269
270         // update where to set the name of the executed macro instead of "exec"
271         ConfigVariable::WhereEntry lastWhere = ConfigVariable::getWhere().back();
272         int iLine = lastWhere.m_line;
273         int iAbsLine = lastWhere.m_absolute_line;
274         ConfigVariable::where_end();
275         ConfigVariable::where_begin(iLine, iAbsLine, pMacro);
276     }
277     else
278     {
279         Scierror(999, _("%s: Wrong type for input argument #%d: string expected.\n"), "exec", 1);
280         return types::Function::Error;
281     }
282
283     if (pMacro)
284     {
285         //store the line number where is stored this macro in file.
286         ConfigVariable::macroFirstLine_begin(pMacro->getFirstLine());
287     }
288
289     //save current prompt mode
290     int oldVal = ConfigVariable::getPromptMode();
291     ConfigVariable::setPromptMode(promptMode);
292
293     ast::SeqExp* pSeqExp = pExp->getAs<ast::SeqExp>();
294     pSeqExp->setExecFrom(ast::SeqExp::EXEC);
295     pSeqExp->setReturnable();
296     std::unique_ptr<ast::ConstVisitor> exec(ConfigVariable::getDefaultVisitor());
297     ConfigVariable::setSilentError(bErrCatch);
298
299     try
300     {
301         symbol::Context* pCtx = symbol::Context::getInstance();
302         int scope = pCtx->getScopeLevel();
303         int level = ConfigVariable::getRecursionLevel();
304         try
305         {
306             pSeqExp->accept(*exec);
307         }
308         catch (const ast::RecursionException& /* re */)
309         {
310             ConfigVariable::setSilentError(bSilentError);
311
312             //close opened scope during try
313             while (pCtx->getScopeLevel() > scope)
314             {
315                 pCtx->scope_end();
316             }
317
318             //decrease recursion to init value
319             while (ConfigVariable::getRecursionLevel() > level)
320             {
321                 ConfigVariable::where_end();
322                 ConfigVariable::decreaseRecursion();
323             }
324
325             //print msg about recursion limit and trigger an error
326             wchar_t sz[1024];
327             os_swprintf(sz, 1024, _W("Recursion limit reached (%d).\n").data(), ConfigVariable::getRecursionLimit());
328             throw ast::InternalError(sz);
329         }
330     }
331     catch (const ast::InternalAbort& ia)
332     {
333         closeFile(file, iID, wstFile, pExp);
334         ConfigVariable::setPromptMode(oldVal);
335         ConfigVariable::setSilentError(bSilentError);
336         throw ia;
337     }
338     catch (const ast::InternalError& ie)
339     {
340         if (pMacro && ConfigVariable::getLastErrorFunction() == L"")
341         {
342             ConfigVariable::setLastErrorFunction(pMacro->getName());
343         }
344
345         if (bErrCatch == false)
346         {
347             closeFile(file, iID, wstFile, pExp);
348             ConfigVariable::setPromptMode(oldVal);
349             ConfigVariable::setExecutedFile(L"");
350             ConfigVariable::setSilentError(bSilentError);
351             throw ie;
352         }
353
354         ConfigVariable::resetWhereError();
355         iErr = ConfigVariable::getLastErrorNumber();
356     }
357
358     //restore previous prompt mode
359     ConfigVariable::setPromptMode(oldVal);
360     ConfigVariable::setSilentError(bSilentError);
361     if (bErrCatch)
362     {
363         out.push_back(new types::Double(iErr));
364         //to lock last error information
365         ConfigVariable::setLastErrorCall();
366     }
367
368     closeFile(file, iID, wstFile, pExp);
369     return types::Function::OK;
370 }