* Bug 16290: %sn() set obsolete
[scilab.git] / scilab / modules / slint / src / cpp / DeprecatedChecker.cpp
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2015 - Scilab Enterprises - Calixte DENIZET
4  *  Copyright (C) 2017, 2018 - Samuel GOUGEON
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  */
16
17 #include "checkers/DeprecatedChecker.hxx"
18
19 namespace slint
20 {
21
22 std::unordered_map<std::wstring, std::wstring> DeprecatedChecker::deprecated = initDep();
23 std::unordered_map<std::wstring, std::shared_ptr<SLintChecker>> DeprecatedChecker::partiallyDeprecated = initPartDep();
24
25 void DeprecatedChecker::preCheckNode(const ast::Exp & e, SLintContext & context, SLintResult & result)
26 {
27     const ast::CallExp & ce = static_cast<const ast::CallExp &>(e);
28     if (ce.getName().isSimpleVar())
29     {
30         const std::wstring & name = static_cast<const ast::SimpleVar &>(ce.getName()).getSymbol().getName();
31         const auto i = deprecated.find(name);
32         if (i != deprecated.end())
33         {
34             if (i->second.empty())
35             {
36                 result.report(context, e.getLocation(), *this, _("Deprecated function: %s."), name);
37             }
38             else
39             {
40                 result.report(context, e.getLocation(), *this, _("Deprecated function %s: use %s instead."), name, i->second);
41             }
42         }
43         else
44         {
45             const auto i = partiallyDeprecated.find(name);
46             if (i != partiallyDeprecated.end())
47             {
48                 i->second->preCheckNode(e, context, result);
49             }
50         }
51     }
52 }
53
54 void DeprecatedChecker::postCheckNode(const ast::Exp & e, SLintContext & context, SLintResult & result)
55 {
56 }
57
58 const std::string DeprecatedChecker::getName() const
59 {
60     return "DeprecatedChecker";
61 }
62
63 void DeprecatedChecker::__Svd::preCheckNode(const ast::Exp & e, SLintContext & context, SLintResult & result)
64 {
65     const ast::CallExp & ce = static_cast<const ast::CallExp &>(e);
66     const ast::exps_t args = ce.getArgs();
67     if (args.size() == 2)
68     {
69         const ast::Exp & second = *args.back();
70         if (second.isDoubleExp() && static_cast<const ast::DoubleExp &>(second).getValue() == 0)
71         {
72             result.report(context, e.getLocation(), *this, _("svd(..., 0) is deprecated."));
73         }
74     }
75 }
76
77 void DeprecatedChecker::__Mfprintf::preCheckNode(const ast::Exp & e, SLintContext & context, SLintResult & result)
78 {
79     const ast::CallExp & ce = static_cast<const ast::CallExp &>(e);
80     const ast::exps_t args = ce.getArgs();
81     if (args.size() != 0)
82     {
83         const ast::Exp & first = *args.front();
84         if (first.isDoubleExp() && static_cast<const ast::DoubleExp &>(first).getValue() == -1)
85         {
86             result.report(context, e.getLocation(), *this, _("mfprintf(-1, ...) is deprecated."));
87         }
88     }
89 }
90
91 std::unordered_map<std::wstring, std::wstring> DeprecatedChecker::initDep()
92 {
93     // TODO: get this list from a conf file
94     std::unordered_map<std::wstring, std::wstring> map;
95
96     // Scilab 6.1.0 => 6.1.x
97     map.emplace(L"setPreferencesValue", L"xmlSetValues");
98
99     // Scilab 6.0.x => 6.1.0
100     map.emplace(L"champ1", L"champ.colored");
101     map.emplace(L"%sn", L"ellipj");
102     map.emplace(L"dirname", L"fileparts");
103     map.emplace(L"_d", L"_");
104     map.emplace(L"dgettext", L"gettext");
105     map.emplace(L"datatipToggle", L"datatipManagerMode");
106     map.emplace(L"denom", L".den");
107     map.emplace(L"frexp", L"log2");
108     map.emplace(L"getPreferencesValue", L"xmlGetValues");
109     map.emplace(L"hypermat", L"zeros|matrix");
110     map.emplace(L"lstsize", L"size");
111     map.emplace(L"nanmin", L"min");
112     map.emplace(L"nanmax", L"max");
113     map.emplace(L"numer", L".num");
114     map.emplace(L"square", L"replot");
115     map.emplace(L"with_tk", L"with_module('tclsci')");
116     map.emplace(L"xgetech", L"gca");
117     map.emplace(L"xinfo", L"gcf().info_message");
118
119     // Scilab 5.5.2 => 6.0.0
120     map.emplace(L"fort", L"call");
121     map.emplace(L"znaupd", L"eigs");
122     map.emplace(L"zneupd", L"eigs");
123     map.emplace(L"dseupd", L"eigs");
124     map.emplace(L"dneupd", L"eigs");
125     map.emplace(L"dnaupd", L"eigs");
126     map.emplace(L"dsaupd", L"eigs");
127
128     map.emplace(L"m_circle", L"hallchart");
129     map.emplace(L"plot2d1", L"plot2d");
130     map.emplace(L"xclear", L"clf");
131     map.emplace(L"datatipSetStruct", L"");
132     map.emplace(L"datatipGetStruct", L"");
133     map.emplace(L"fcontour2d", L"contour2d");
134     map.emplace(L"fcontour", L"contour");
135     map.emplace(L"fac3d", L"plot3d");
136     map.emplace(L"eval3d", L"ndgrid");
137
138     map.emplace(L"gspec", L"spec");
139     map.emplace(L"gschur", L"schur");
140     map.emplace(L"rafiter", L"taucs_chsolve");
141     map.emplace(L"numdiff", L"numderivative");
142     map.emplace(L"derivative", L"numderivative");
143     map.emplace(L"mvvacov", L"cov");
144
145     map.emplace(L"perl", L"");
146     map.emplace(L"lex_sort", L"gsort");
147     map.emplace(L"strcmpi", L"strcmp");
148     map.emplace(L"jconvMatrixMethod", L"jautoTranspose");
149     map.emplace(L"havewindow", L"getscilabmode");
150     map.emplace(L"xpause", L"sleep");
151     map.emplace(L"curblockc", L"curblock");
152     map.emplace(L"extract_help_examples", L"");
153     map.emplace(L"mtlb_mode", L"oldEmptyBehaviour");
154
155     map.emplace(L"addf", L"");
156     map.emplace(L"subf", L"");
157     map.emplace(L"mulf", L"");
158     map.emplace(L"ldivf", L"");
159     map.emplace(L"rdivf", L"");
160     map.emplace(L"cmb_lin", L"");
161     map.emplace(L"solve", L"");
162     map.emplace(L"trianfml", L"");
163     map.emplace(L"trisolve", L"");
164     map.emplace(L"bloc2exp", L"");
165
166     map.emplace(L"comp", L"exec");
167     map.emplace(L"errcatch", L"");
168     map.emplace(L"iserror", L"");
169     map.emplace(L"str2code", L"ascii");
170     map.emplace(L"code2str", L"ascii");
171     map.emplace(L"fun2string", L"string");
172     map.emplace(L"getvariablesonstack", L"who");
173     map.emplace(L"gstacksize", L"");
174     map.emplace(L"stacksize", L"");
175     map.emplace(L"macr2lst", L"");
176     map.emplace(L"readgateway", L"");
177
178     // Scilab 5.5.1 => 5.5.2
179     map.emplace(L"%asn", L"delip");
180     map.emplace(L"chart", L"nicholschart");
181     map.emplace(L"IsAScalar", L"isscalar");
182     map.emplace(L"jmat", L"flipdim");
183     map.emplace(L"mfft", L"ftt");
184     map.emplace(L"milk_drop", L"");
185     map.emplace(L"msd", L"stdev");
186     map.emplace(L"nfreq", L"tabul");
187     map.emplace(L"pcg", L"conjgrad");
188     map.emplace(L"regress", L"reglin");
189     map.emplace(L"relocate_handle", L"");
190     map.emplace(L"st_deviation", L"stdev");
191     map.emplace(L"xmltochm", L"");
192     map.emplace(L"xsetm", L"");
193
194     // Scilab 5.5.0 => 5.5.1
195     map.emplace(L"datatipContextMenu", L"");
196     map.emplace(L"datatipEventHandler", L"");
197
198     // SCilab 5.4.1 => 5.5.0
199     map.emplace(L"dft", L"fft");
200     map.emplace(L"sscanf", L"msscanf");
201     map.emplace(L"fscanf", L"mfscanf");
202     map.emplace(L"printf", L"mprintf");
203     map.emplace(L"fprintf", L"mfprintf");
204     map.emplace(L"sprintf", L"msprintf");
205     map.emplace(L"demo_message", L"");
206     map.emplace(L"demo_mdialog", L"");
207     map.emplace(L"draw", L"");
208     map.emplace(L"clear_pixmap", L"");
209     map.emplace(L"show_pixmap", L"");
210     map.emplace(L"winclose", L"close");
211     map.emplace(L"datatipInitStruct", L"");
212     map.emplace(L"datatipRedraw", L"");
213     map.emplace(L"getfont", L"");
214     map.emplace(L"getmark", L"");
215     map.emplace(L"getlinestyle", L"");
216     map.emplace(L"getsymbol", L"");
217     map.emplace(L"with_embedded_jre", L"");
218     map.emplace(L"fit_dat", L"datafit");
219     map.emplace(L"create_palette", L"");
220
221     // Scilab 5.4.0 => 5.4.1
222     map.emplace(L"chartoeom", L"");
223     map.emplace(L"eomtochar", L"");
224     map.emplace(L"config", L"preferences");
225     map.emplace(L"createpopup", L"uicontextmenu");
226     map.emplace(L"mtlb_conv", L"conv");
227     map.emplace(L"mtlb_repmat", L"repmat");
228     map.emplace(L"neldermead_display", L"disp");
229     map.emplace(L"nmplot_display", L"disp");
230     map.emplace(L"optimbase_display", L"disp");
231     map.emplace(L"optimsimplex_print", L"disp");
232     map.emplace(L"iptim_simplex_tostring", L"string");
233     map.emplace(L"ricc_old", L"ricc");
234     map.emplace(L"showalluimenushandles", L"set(get(0), \"ShowHiddenHandles\", \"on\")");
235     map.emplace(L"with_pvm", L"getversion");
236     map.emplace(L"with_texmacs", L"");
237     map.emplace(L"xbasr", L"");
238     map.emplace(L"xselect", L"show_window");
239
240     // Scilab 5.3.3 => 5.4.0
241     map.emplace(L"MSDOS", L"getos");
242     map.emplace(L"sd2sci", L"");
243     map.emplace(L"oldplot", L"");
244
245     // Scilab 5.3.0 => 5.3.3: nothing removed
246
247     // Scilab 5.2.X => 5.3.0
248     map.emplace(L"maxi", L"max");
249     map.emplace(L"mini", L"min");
250     map.emplace(L"oldbesseli", L"besseli");
251     map.emplace(L"oldbesselj", L"besselj");
252     map.emplace(L"oldbesselk", L"besselk");
253     map.emplace(L"oldbessely", L"bessely");
254     map.emplace(L"textprint", L"prettyprint");
255     map.emplace(L"pol2tex", L"prettyprint");
256     map.emplace(L"xgetfile", L"uigetfile");
257     map.emplace(L"tk_getfile", L"uigetfile");
258     map.emplace(L"tk_savefile", L"uiputfile");
259     map.emplace(L"tk_getdir", L"uigetdir");
260     map.emplace(L"tk_choose", L"x_choose");
261     map.emplace(L"sci2excel", L"csvWrite");
262     map.emplace(L"excel2sci", L"csvRead");
263     map.emplace(L"x_message_modeless", L"messagebox");
264     map.emplace(L"sethomedirectory", L"SCIHOME,home");
265     map.emplace(L"getcwd", L"pwd");
266     map.emplace(L"xbasc", L"clf");
267     map.emplace(L"getf", L"exec");
268     map.emplace(L"NumTokens", L"tokens");
269     map.emplace(L"sort", L"gsort");
270     map.emplace(L"scilab_demos", L"demo_gui");
271     map.emplace(L"with_gtk", L"getversion");
272     map.emplace(L"readc_", L"input");
273
274     // Scilab 5.2.1 => 5.2.2
275     map.emplace(L"oldsave", L"save");
276     map.emplace(L"oldload", L"load");
277
278     // Scilab 5.2.0 => 5.2.1: nothing removed
279
280     // Scilab 5.1.1 => 5.2.0
281     map.emplace(L"lgfft", L"");
282
283     // Scilab 5.1.0 => 5.1.1: nothing removed
284
285     // Scilab 5.0.X => 5.1.0
286     map.emplace(L"mtlb_load", L"loadmatfile");
287     map.emplace(L"mtlb_save", L"savematfile");
288     map.emplace(L"xbasimp", L"toprint,xs2ps");
289     map.emplace(L"xg2ps", L"xs2ps");
290     map.emplace(L"hidetoolbar", L"toolbar(,\'off\')");
291     map.emplace(L"browsehelp", L"helpbrowser");
292     map.emplace(L"quapro", L"qpsolve");
293     map.emplace(L"%sp_eye", L"speye");
294     map.emplace(L"TCL_gcf", L"gcf");
295     map.emplace(L"TCL_scf", L"scf");
296     map.emplace(L"TK_EvalStr", L"TCL_EvalStr");
297     map.emplace(L"TK_GetVar", L"TCL_GetVar");
298     map.emplace(L"TK_SetVar", L"TCL_SetVar");
299     map.emplace(L"sciGUIhelp", L"help");
300     map.emplace(L"demoplay", L"demo_gui");
301     map.emplace(L"buttondialog", L"messagebox");
302     map.emplace(L"tk_getvalue", L"getvalue");
303
304     // Scilab 5.0.1 => 5.0.3: nothing removed
305
306     // Scilab 4.1.2 => 5.0
307     map.emplace(L"xclea", L"xfrect");
308     map.emplace(L"xaxis", L"drawaxis");
309     map.emplace(L"loadplots", L"");
310     map.emplace(L"xtape", L"");
311     map.emplace(L"loaddefaultbrowser", L"");
312     map.emplace(L"%browsehelp", L"");
313
314     return map;
315 }
316
317 std::unordered_map<std::wstring, std::shared_ptr<SLintChecker>> DeprecatedChecker::initPartDep()
318 {
319     std::unordered_map<std::wstring, std::shared_ptr<SLintChecker>> map;
320     map.emplace(L"svd", std::shared_ptr<SLintChecker>(new __Svd()));
321     map.emplace(L"mfprintf", std::shared_ptr<SLintChecker>(new __Mfprintf()));
322
323     return map;
324 }
325 }