dead lock fixed when the parser fails to open file
[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 * 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 #include "functions_gw.hxx"
14
15 #include "parser.hxx"
16 #include "funcmanager.hxx"
17 #include "context.hxx"
18 #include "printvisitor.hxx"
19 #include "visitor_common.hxx"
20 #include "scilabWrite.hxx"
21 #include "configvariable.hxx"
22 #include "types_tools.hxx"
23 #include "runner.hxx"
24 #include "threadmanagement.hxx"
25 #include "macro.hxx"
26 #include "macrofile.hxx"
27 #include "filemanager.hxx"
28
29 #include <memory>
30 #include <iostream>
31 #include <fstream>
32 #include <string>
33
34 extern "C"
35 {
36 #include "os_string.h"
37 #include "expandPathVariable.h"
38 #include "prompt.h"
39 #include "Scierror.h"
40 #include "localization.h"
41 #include "os_string.h"
42 #include "mopen.h"
43 #include "mclose.h"
44 #include "fullpath.h"
45 #include "PATH_MAX.h"
46 }
47
48 void closeFile(std::ifstream* file, int fileId, const std::wstring& wstFile, ast::Exp* pExp)
49 {
50     if (file)
51     {
52         file->close();
53         delete file;
54
55         if (pExp)
56         {
57             delete pExp;
58         }
59
60         // Check if file has not already been closed (for ex mclose('all') in function)
61         if (FileManager::isOpened(wstFile))
62         {
63             mclose(fileId);
64         }
65     }
66 }
67 /*--------------------------------------------------------------------------*/
68 types::Function::ReturnValue sci_exec(types::typed_list &in, int _iRetCount, types::typed_list &out)
69 {
70     int promptMode      = 0;//default value at startup, overthise 3 or verbose ";"
71     bool bPromptMode    = false;
72     int iErr            = 0;
73     bool bErrCatch      = false;
74     ast::Exp* pExp      = NULL;
75     int iID             = 0;
76     types::Macro* pMacro = NULL;
77     Parser parser;
78
79     wchar_t* pwstFile = NULL;
80     char* pstFile = NULL;
81
82     std::string stFile;
83     std::ifstream* file = NULL;
84     std::wstring wstFile;
85
86     if (ConfigVariable::getStartProcessing() == false)
87     {
88         if (ConfigVariable::getVerbose())
89         {
90             promptMode = 3;
91         }
92         else
93         {
94             promptMode = 0;
95         }
96     }
97
98     if (in.size() < 1 || in.size() > 3)
99     {
100         Scierror(999, _("%s: Wrong number of input arguments: %d to %d expected.\n"), "exec" , 1, 3);
101         return types::Function::Error;
102     }
103
104     // get mode and errcatch
105     if (in.size() > 1)
106     {
107         //errcatch or mode
108         if (in[1]->isString() && in[1]->getAs<types::String>()->isScalar())
109         {
110             //errcatch
111             types::String* pS = in[1]->getAs<types::String>();
112             if (os_wcsicmp(pS->get(0), L"errcatch") == 0)
113             {
114                 bErrCatch = true;
115             }
116             else
117             {
118                 Scierror(999, _("%s: Wrong value for input argument #%d: 'errcatch' expected.\n"), "exec", 2);
119                 return types::Function::Error;
120             }
121
122             if (in.size() > 2)
123             {
124
125                 if (in[2]->isDouble() == false || in[2]->getAs<types::Double>()->isScalar() == false)
126                 {
127                     //mode
128                     Scierror(999, _("%s: Wrong type for input argument #%d: A integer expected.\n"), "exec", 3);
129                     return types::Function::Error;
130                 }
131
132                 promptMode = (int)in[2]->getAs<types::Double>()->getReal()[0];
133                 bPromptMode = true;
134             }
135         }
136         else if (in[1]->isDouble() && in[1]->getAs<types::Double>()->isScalar())
137         {
138             if (in.size() > 2)
139             {
140                 Scierror(999, _("%s: Wrong value for input argument #%d: 'errcatch' expected.\n"), "exec", 2);
141                 return types::Function::Error;
142             }
143             //mode
144             promptMode = (int)in[1]->getAs<types::Double>()->getReal()[0];
145             bPromptMode = true;
146         }
147         else
148         {
149             //not managed
150             Scierror(999, _("%s: Wrong type for input argument #%d: A integer or string expected.\n"), "exec", 2);
151             return types::Function::Error;
152         }
153     }
154
155     if (in[0]->isString() && in[0]->getAs<types::String>()->isScalar())
156     {
157         //1st argument is a path, parse file and execute it
158         int iParsePathLen = 0;
159         types::String* pS = in[0]->getAs<types::String>();
160
161         pwstFile = expandPathVariableW(pS->get(0));
162         pstFile = wide_string_to_UTF8(pwstFile);
163         stFile = pstFile;
164         file = new std::ifstream(pstFile);
165
166         FREE(pstFile);
167
168         wchar_t* pwstTemp = (wchar_t*)MALLOC(sizeof(wchar_t) * (PATH_MAX * 2));
169         get_full_pathW(pwstTemp, pwstFile, PATH_MAX * 2);
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.data());
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::setExecutedFileID(iID);
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     std::unique_ptr<ast::ConstVisitor> exec(ConfigVariable::getDefaultVisitor());
296
297     try
298     {
299         symbol::Context* pCtx = symbol::Context::getInstance();
300         int scope = pCtx->getScopeLevel();
301         int level = ConfigVariable::getRecursionLevel();
302         try
303         {
304             pSeqExp->accept(*exec);
305         }
306         catch (const ast::RecursionException& /* re */)
307         {
308             //close opened scope during try
309             while (pCtx->getScopeLevel() > scope)
310             {
311                 pCtx->scope_end();
312             }
313
314             //decrease recursion to init value
315             while (ConfigVariable::getRecursionLevel() > level)
316             {
317                 ConfigVariable::where_end();
318                 ConfigVariable::decreaseRecursion();
319             }
320
321             //print msg about recursion limit and trigger an error
322             wchar_t sz[1024];
323             os_swprintf(sz, 1024, _W("Recursion limit reached (%d).\n").data(), ConfigVariable::getRecursionLimit());
324             throw ast::InternalError(sz);
325         }
326     }
327     catch (const ast::InternalAbort& ia)
328     {
329         closeFile(file, iID, wstFile, pExp);
330         throw ia;
331     }
332     catch (const ast::InternalError& ie)
333     {
334         if (bErrCatch == false)
335         {
336             closeFile(file, iID, wstFile, pExp);
337             ConfigVariable::setPromptMode(oldVal);
338             ConfigVariable::setExecutedFileID(0);
339             throw ie;
340         }
341
342         ConfigVariable::resetWhereError();
343         iErr = ConfigVariable::getLastErrorNumber();
344     }
345
346     //restore previous prompt mode
347     ConfigVariable::setPromptMode(oldVal);
348     if (bErrCatch)
349     {
350         out.push_back(new types::Double(iErr));
351         //to lock last error information
352         ConfigVariable::setLastErrorCall();
353     }
354
355     closeFile(file, iID, wstFile, pExp);
356     return types::Function::OK;
357 }