Revert "revert delete of macro body"
[scilab.git] / scilab / modules / ast / src / cpp / types / macro.cpp
1 /*
2 *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 *  Copyright (C) 2009-2009 - DIGITEO - 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 #include <sstream>
14 #include <cstdio>
15
16 #include "macro.hxx"
17 #include "list.hxx"
18 #include "context.hxx"
19 #include "symbol.hxx"
20 #include "scilabWrite.hxx"
21 #include "scilabexception.hxx"
22 #include "configvariable.hxx"
23 #include "mutevisitor.hxx"
24 #include "serializervisitor.hxx"
25
26 extern "C"
27 {
28 #include "localization.h"
29 #include "Scierror.h"
30 #include "sciprint.h"
31 #include "sci_malloc.h"
32 #include "os_swprintf.h"
33 }
34
35 namespace types
36 {
37 Macro::Macro(const std::wstring& _stName, std::list<symbol::Variable*>& _inputArgs, std::list<symbol::Variable*>& _outputArgs, ast::SeqExp &_body, const std::wstring& _stModule):
38     Callable(),
39     m_inputArgs(&_inputArgs), m_outputArgs(&_outputArgs), m_body(&_body),
40     m_Nargin(symbol::Context::getInstance()->getOrCreate(symbol::Symbol(L"nargin"))),
41     m_Nargout(symbol::Context::getInstance()->getOrCreate(symbol::Symbol(L"nargout"))),
42     m_Varargin(symbol::Context::getInstance()->getOrCreate(symbol::Symbol(L"varargin"))),
43     m_Varargout(symbol::Context::getInstance()->getOrCreate(symbol::Symbol(L"varargout")))
44 {
45     setName(_stName);
46     setModule(_stModule);
47     bAutoAlloc = false;
48     m_pDblArgIn = new Double(1);
49     m_pDblArgIn->IncreaseRef(); //never delete
50     m_pDblArgOut = new Double(1);
51     m_pDblArgOut->IncreaseRef(); //never delete
52
53 }
54
55 Macro::~Macro()
56 {
57     delete m_body;
58     m_pDblArgIn->DecreaseRef();
59     m_pDblArgIn->killMe();
60     m_pDblArgOut->DecreaseRef();
61     m_pDblArgOut->killMe();
62
63     if (m_inputArgs)
64     {
65         delete m_inputArgs;
66     }
67
68     if (m_outputArgs)
69     {
70         delete m_outputArgs;
71     }
72 }
73
74 void Macro::cleanCall(symbol::Context * pContext, int oldPromptMode)
75 {
76     //restore previous prompt mode
77     ConfigVariable::setPromptMode(oldPromptMode);
78     //close the current scope
79     pContext->scope_end();
80     ConfigVariable::macroFirstLine_end();
81 }
82
83 InternalType* Macro::clone()
84 {
85     IncreaseRef();
86     return this;
87 }
88
89 void Macro::whoAmI()
90 {
91     std::cout << "types::Macro";
92 }
93
94 ast::SeqExp* Macro::getBody(void)
95 {
96     return m_body;
97 }
98
99 bool Macro::toString(std::wostringstream& ostr)
100 {
101     ostr << L"FIXME : Implement Macro::toString" << std::endl;
102     return true;
103 }
104
105 Callable::ReturnValue Macro::call(typed_list &in, optional_list &opt, int _iRetCount, typed_list &out, ast::ConstVisitor* execFunc)
106 {
107     bool bVarargout = false;
108     ReturnValue RetVal = Callable::OK;
109     symbol::Context *pContext = symbol::Context::getInstance();
110
111     //open a new scope
112     pContext->scope_begin();
113     //store the line number where is stored this macro in file.
114     ConfigVariable::macroFirstLine_begin(getFirstLine());
115
116     //add optional paramter in current scope
117     optional_list::const_iterator it;
118     for (it = opt.begin() ; it != opt.end() ; it++)
119     {
120         pContext->put(symbol::Symbol(it->first), it->second);
121     }
122     //check excepted and input/output parameters numbers
123     // Scilab Macro can be called with less than prototyped arguments,
124     // but not more execpts with varargin
125
126     // varargin management
127     if (m_inputArgs->size() > 0 && m_inputArgs->back()->name_get().name_get() == L"varargin")
128     {
129         int iVarPos = static_cast<int>(in.size());
130         if (iVarPos > static_cast<int>(m_inputArgs->size()) - 1)
131         {
132             iVarPos = static_cast<int>(m_inputArgs->size()) - 1;
133         }
134
135         //add all standard variable in function context but not varargin
136         std::list<symbol::Variable*>::iterator itName = m_inputArgs->begin();
137         typed_list::const_iterator itValue = in.begin();
138         while (iVarPos > 0)
139         {
140             pContext->put(*itName, *itValue);
141             iVarPos--;
142             ++itName;
143             ++itValue;
144         }
145
146         //create varargin only if previous variable are assigned
147         if (in.size() >= m_inputArgs->size() - 1)
148         {
149             //create and fill varargin
150             List* pL = new List();
151             while (itValue != in.end())
152             {
153                 pL->append(*itValue);
154                 itValue++;
155             }
156             pContext->put(m_Varargin, pL);
157         }
158     }
159     else if (in.size() > m_inputArgs->size())
160     {
161         if (m_inputArgs->size() == 0)
162         {
163             Scierror(999, _("Wrong number of input arguments: This function has no input argument.\n"));
164         }
165         else
166         {
167             Scierror(999, _("Wrong number of input arguments."));
168         }
169
170         pContext->scope_end();
171         ConfigVariable::macroFirstLine_end();
172         return Callable::Error;
173     }
174     else
175     {
176         //assign value to variable in the new context
177         std::list<symbol::Variable*>::iterator i;
178         typed_list::const_iterator j;
179
180         for (i = m_inputArgs->begin(), j = in.begin(); j != in.end (); ++j, ++i)
181         {
182             if (*j)
183             {
184                 //prevent assignation of NULL value
185                 pContext->put(*i, *j);
186             }
187         }
188     }
189
190     // varargout management
191     //rules :
192     // varargout must be alone
193     // varargout is a list
194     // varargout can containt more items than caller need
195     // varargout must containt at leat caller needs
196     if (m_outputArgs->size() == 1 && m_outputArgs->back()->name_get().name_get() == L"varargout")
197     {
198         bVarargout = true;
199         List* pL = new List();
200         pContext->put(m_Varargout, pL);
201     }
202
203     //common part with or without varargin/varargout
204
205     // Declare nargin & nargout in function context.
206     if (m_pDblArgIn->getRef() > 1)
207     {
208         m_pDblArgIn->DecreaseRef();
209         m_pDblArgIn = (Double*)m_pDblArgIn->clone();
210         m_pDblArgIn->IncreaseRef();
211     }
212     m_pDblArgIn->set(0, static_cast<double>(in.size()));
213
214     if (m_pDblArgOut->getRef() > 1)
215     {
216         m_pDblArgOut->DecreaseRef();
217         m_pDblArgOut = (Double*)m_pDblArgOut->clone();
218         m_pDblArgOut->IncreaseRef();
219     }
220     m_pDblArgOut->set(0, _iRetCount);
221
222     pContext->put(m_Nargin, m_pDblArgIn);
223     pContext->put(m_Nargout, m_pDblArgOut);
224
225     //save current prompt mode
226     int oldVal = ConfigVariable::getPromptMode();
227     try
228     {
229         //m_body->mute();
230         //MuteVisitor mute;
231         //m_body->accept(mute);
232
233         ConfigVariable::setPromptMode(-1);
234         m_body->returnable_set();
235         m_body->accept(*execFunc);
236         //restore previous prompt mode
237         ConfigVariable::setPromptMode(oldVal);
238         if (m_body->is_return())
239         {
240             m_body->returnable_set();
241         }
242     }
243     catch (ast::ScilabMessage & sm)
244     {
245         cleanCall(pContext, oldVal);
246         throw sm;
247     }
248     catch (ast::InternalAbort & ia)
249     {
250         cleanCall(pContext, oldVal);
251         throw ia;
252     }
253     // Normally, seqexp throws only SM so no need to catch SErr
254
255     //varargout management
256     if (bVarargout)
257     {
258         InternalType* pOut = pContext->get(m_Varargout);
259         if (pOut == NULL)
260         {
261             cleanCall(pContext, oldVal);
262             Scierror(999, _("Invalid index.\n"));
263             return Callable::Error;
264         }
265
266         if (pOut->isList() == false || pOut->getAs<List>()->getSize() == 0)
267         {
268             cleanCall(pContext, oldVal);
269             Scierror(999, _("Invalid index.\n"));
270             return Callable::Error;
271         }
272
273         List* pVarOut = pOut->getAs<List>();
274         const int size = std::max(pVarOut->getSize(), _iRetCount);
275         for (int i = 0 ; i < size ; ++i)
276         {
277             InternalType* pIT = pVarOut->get(i);
278             if (pIT->isListUndefined())
279             {
280                 for (int j = 0; j < i; ++j)
281                 {
282                     out[j]->DecreaseRef();
283                     out[j]->killMe();
284                 }
285                 out.clear();
286                 cleanCall(pContext, oldVal);
287
288                 Scierror(999, _("List element number %d is Undefined.\n"), i + 1);
289                 return Callable::Error;
290             }
291
292             out.push_back(pIT->clone());
293         }
294     }
295     else
296     {
297         //normal output management
298         for (std::list<symbol::Variable*>::iterator i = m_outputArgs->begin(); i != m_outputArgs->end() && _iRetCount; ++i, --_iRetCount)
299         {
300             InternalType * pIT = pContext->get(*i);
301             if (pIT)
302             {
303                 out.push_back(pIT);
304                 pIT->IncreaseRef();
305             }
306             else
307             {
308                 const int size = (const int)out.size();
309                 for (int j = 0; j < size; ++j)
310                 {
311                     out[j]->DecreaseRef();
312                     out[j]->killMe();
313                 }
314                 out.clear();
315                 cleanCall(pContext, oldVal);
316
317                 char* pst = wide_string_to_UTF8((*i)->name_get().name_get().c_str());
318                 Scierror(999, _("Undefined variable %s.\n"), pst);
319                 FREE(pst);
320                 return Callable::Error;
321             }
322         }
323     }
324
325     //close the current scope
326     cleanCall(pContext, oldVal);
327
328     for (typed_list::iterator i = out.begin(), end = out.end(); i != end; ++i)
329     {
330         (*i)->DecreaseRef();
331     }
332
333     return RetVal;
334 }
335
336 std::list<symbol::Variable*>* Macro::inputs_get()
337 {
338     return m_inputArgs;
339 }
340
341 std::list<symbol::Variable*>* Macro::outputs_get()
342 {
343     return m_outputArgs;
344 }
345
346 int Macro::getNbInputArgument(void)
347 {
348     return (int)m_inputArgs->size();
349 }
350
351 int Macro::getNbOutputArgument(void)
352 {
353     if (m_outputArgs->size() == 1 && m_outputArgs->back()->name_get().name_get() == L"varargout")
354     {
355         return -1;
356     }
357
358     return (int)m_outputArgs->size();
359 }
360
361 bool Macro::operator==(const InternalType& it)
362 {
363     if (const_cast<InternalType &>(it).isMacro() == false)
364     {
365         return false;
366     }
367
368     std::list<symbol::Variable*>* pInput = NULL;
369     std::list<symbol::Variable*>* pOutput = NULL;
370     types::Macro* pRight = const_cast<InternalType &>(it).getAs<types::Macro>();
371
372     //check inputs
373     pInput = pRight->inputs_get();
374     if (pInput->size() != m_inputArgs->size())
375     {
376         return false;
377     }
378
379     std::list<symbol::Variable*>::iterator itOld = pInput->begin();
380     std::list<symbol::Variable*>::iterator itEndOld = pInput->end();
381     std::list<symbol::Variable*>::iterator itMacro = m_inputArgs->begin();
382
383     for (; itOld != itEndOld ; ++itOld, ++itMacro)
384     {
385         if ((*itOld)->name_get() != (*itMacro)->name_get())
386         {
387             return false;
388         }
389     }
390
391     //check outputs
392     pOutput = pRight->outputs_get();
393     itOld = pOutput->begin();
394     itEndOld = pOutput->end();
395     itMacro = m_outputArgs->begin();
396
397     for (; itOld != itEndOld ; ++itOld, ++itMacro)
398     {
399         if ((*itOld)->name_get() != (*itMacro)->name_get())
400         {
401             return false;
402         }
403     }
404
405     ast::Exp* pExp = pRight->getBody();
406     ast::SerializeVisitor serialOld(pExp);
407     unsigned char* oldSerial = serialOld.serialize(false);
408     ast::SerializeVisitor serialMacro(m_body);
409     unsigned char* macroSerial = serialMacro.serialize(false);
410
411     //check buffer length
412     unsigned int oldSize = ((unsigned int*)oldSerial)[0] + sizeof(unsigned int);
413     unsigned int macroSize = ((unsigned int*)macroSerial)[0] + sizeof(unsigned int);
414     if (oldSize != macroSize)
415     {
416         free(oldSerial);
417         free(macroSerial);
418         return false;
419     }
420
421     bool ret = (memcmp(oldSerial, macroSerial, oldSize + sizeof(unsigned int)) == 0);
422
423     free(oldSerial);
424     free(macroSerial);
425
426     return ret;
427 }
428 }