* Bug #14582: gettext or _ were applied to broken literal strings
[scilab.git] / scilab / modules / graphics / macros / edit_curv.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 1993 - INRIA - Serge Steer
3 // Copyright (C) 1993 - INRIA - Habib Jreij
4 // Copyright (C) 2012 - 2016 - Scilab Enterprises
5 //
6 // This file is hereby licensed under the terms of the GNU GPL v2.0,
7 // pursuant to article 5.3.4 of the CeCILL v.2.1.
8 // This file was originally licensed under the terms of the CeCILL v2.1,
9 // and continues to be available under such terms.
10 // For more information, see the COPYING file which you should have received
11 // along with this program.
12
13 function [x,y,ok,gc] = edit_curv(x,y,job,tit,gc)
14     //   mod_curv  - Edition  de courbe interactive
15     //%Syntaxe
16     //  [x,y,ok]=mod_curv(xd,yd,job,tit)
17     //%Parametres
18     //  xd    :  vecteur des abscisses donnees (eventuellement [])
19     //  yd    :  vecteur des ordonnees donnees (eventuellement [])
20     //  job   :  chaine de 3 caracteres  specifiant les operations
21     //           permises:
22     //            - Si la chaine contient le caractere 'a', il est
23     //              possible d'ajouter des points aux donnees, sinon
24     //              il est seulement possible de les deplacer
25     //            - Si la chaine contient le caractere 'x', il est
26     //              possible de deplacer les points horizontalement
27     //            - Si la chaine contient le caractere 'y', il est
28     //              possible de deplacer les points verticalement
29     //  tit   : liste de trois chaines de caracteres
30     //          tit(1) : titre de la courbe (peut etre un vecteur colonne)
31     //          tit(2) : label de l'axe des abscisses
32     //          tit(3) : label de l'axe des ordonnees
33     //  x     : vecteur des abscisses resultat
34     //  y     : vecteur des ordonnees resultat
35     //  ok    : vaut %t si la sortie as ete demandee par le menu Ok
36     //           et  %f si la sortie as ete demandee par le menu Abort
37     //%menus
38     //  Ok    : sortie de l'editeur et retour de la courbe editee
39     //  Abort : sortie de l'editeur et retour au donnes initiales
40     //  Undo  : annulation de la derniere modification
41     //  Size  : changement des bornes du graphique
42     //  Grids : changement des graduations du graphique
43     //  Clear : effacement de la courbe (x=[] et y=[]) (sans quitter l'editeur)
44     //  Read  : lecture de la courbe a partir d'un fichier d'extension .xy
45     //  Save  : sauvegarde binaire (sur un fichier d'extension .xy) de
46     //          la courbe
47     //!
48     [lhs,rhs]=argn(0)
49
50     ok = %t;
51     if rhs==0 then x=[]; y=[],end;
52     if rhs==1 then y=x;x=(1:size(y,"*"))',end
53     if rhs<3  then job="axy",end
54     if rhs<4 then tit=[" "," "," "],end
55     if size(tit,"*")<3 then tit(3)=" ",end
56     //
57
58     [mx,nx] = size(x); x=x(:)
59     [my,ny] = size(y); y=y(:)
60     n = min(mx*nx,my*ny)
61     x= x(1:n);y=y(1:n);
62     xsav=x; ysav=y; xs=x; ys=y;
63     //
64     lj = length(job)
65     add=0;modx=0;mody=0
66     for k=1:lj
67         jk = part(job,k)
68         select jk
69         case "a" then add = 1,
70         case "x" then modx= 1
71         case "y" then mody= 1
72         else error(msprintf(gettext("%s: Wrong value for input argument #%d: Must be in the set {%s}.\n"), "edit_curv", 3, "a, x, y"));
73         end
74     end
75     eps = 0.03
76     symbsiz = 0.2
77     // bornes initiales du graphique
78     if rhs<5 then
79         if mx<>0 then
80             xmx = max(x); xmn = min(x)
81             ymx = max(y); ymn = min(y)
82             dx = xmx-xmn;  dy = ymx-ymn
83             if dx==0 then dx=max(xmx/2,1),end
84             xmn=xmn-dx/10;xmx=xmx+dx/10
85             if dy==0 then dy=max(ymx/2,1),end;
86             ymn=ymn-dy/10;ymx=ymx+dy/10;
87         else
88             xmn=0;ymn=0;xmx=1;ymx=1;dx=1;dy=1
89         end
90         rect=[xmn,ymn,xmx,ymx];
91         axisdata=[2 10 2 10];
92         gc = list(rect,axisdata);
93     else //** rhs=5 as in Scicos ;)
94         [rect,axisdata] = gc(1:2)
95         xmn = rect(1);
96         ymn = rect(2);
97         xmx = rect(3);
98         ymx = rect(4);
99         dx  = xmx-xmn;
100         dy  = ymx-ymn;
101     end
102
103     // Set menus and callbacks
104     menu_d = ["Read","Save","Clear"]
105     menu_e = ["Undo","Size","Replot","Ok","Abort"]
106     menus  = list(["Edit","Data"],menu_e,menu_d)
107     w="menus(2)(";rpar=")"
108     Edit=w(ones(menu_e))+string(1:size(menu_e,"*"))+rpar(ones(menu_e))
109     w="menus(3)(";rpar=")"
110     Data=w(ones(menu_d))+string(1:size(menu_d,"*"))+rpar(ones(menu_d))
111
112     curwin = scf().figure_id
113
114     // Disable the menus and toolbars
115     toolbar(curwin,"off");
116     delmenu(curwin,gettext("File"));
117     delmenu(curwin,gettext("Tools"));
118     delmenu(curwin,gettext("Edit"));;
119     delmenu(curwin,"?");
120
121     execstr("Edit_"+string(curwin)+"=Edit");
122     execstr("Data_"+string(curwin)+"=Data");
123     menubar(curwin,menus)
124     //
125     edit_curv_figure = gcf();
126     edit_curv_figure.figure_name = "edit_curv";
127
128     edit_curv_axes = gca();
129     edit_curv_axes.data_bounds = [rect(1),rect(2);rect(3),rect(4)]
130     edit_curv_axes.axes_visible="on";
131     edit_curv_axes.grid=[4 4];
132     if x<>[] then
133         xpolys(x*[1 1],y*[1 1],[1,-1])
134         hdl=edit_curv_axes.children.children
135     else
136         hdl=[]
137     end
138
139     xtitle(tit(1),tit(2),tit(3));
140
141
142     // -- boucle principale
143     while %t then
144         [n1,n2] = size(x);
145         npt = n1*n2 ;
146
147         [btn,xc,yc,win,Cmenu] = get_click();
148
149         //** disp([btn,xc,yc,win]); //** DEBUG only
150
151         c1 = [xc,yc];
152
153         if Cmenu=="Quit" then Cmenu="Abort",end
154         if Cmenu==[]     then Cmenu="edit",end
155         if Cmenu=="Exit" then Cmenu="Ok",end
156
157         select Cmenu
158         case [] then
159             // ce n est pas un menu
160             break
161
162         case "Ok" then    //    -- ok menu
163             rect = matrix(edit_curv_axes.data_bounds',1,4);
164             gc   = list(rect,axisdata);
165             delete(edit_curv_figure)
166             return;
167
168         case "Abort" then //    -- abort menu
169             x = xsav
170             y = ysav
171             delete(edit_curv_figure)
172             ok = %f;
173             return
174
175         case "XClose" then //** the user manually close the win
176             x = xsav
177             y = ysav
178             ok = %f;
179             return
180
181         case "Undo" then
182             x=xs;y=ys
183             if x<>[] then hdl.data=[x y]; end
184
185         case "Size" then
186             while %t
187                 [ok,xmn,xmx,ymn,ymx]=getvalue("Please input new limits",..
188                 ["xmin";"xmax";"ymin";"ymax"],..
189                 list("vec",1,"vec",1,"vec",1,"vec",1),..
190                 string([xmn;xmx;ymn;ymx]))
191                 if ~ok then break,end
192                 if xmn>xmx|ymn>ymx then
193                     messagebox("Limits are not accettable","modal");
194                 else
195                     break
196                 end
197             end
198             if ok then
199                 dx=xmx-xmn;dy=ymx-ymn
200                 if dx==0 then dx=max(xmx/2,1),xmn=xmn-dx/10;xmx=xmx+dx/10;end
201                 if dy==0 then dy=max(ymx/2,1),ymn=ymn-dy/5;ymx=ymx+dy/10;end
202                 rect=[xmn,ymn,xmx,ymx];
203                 edit_curv_axes.data_bounds=[rect(1),rect(2);rect(3),rect(4)]
204             end
205
206         case "Clear" then
207             if hdl<>[] then delete(hdl),hdl=[];end
208             x=[];y=[];
209
210         case "Read" then
211             [x,y]=readxy()
212             mx=min(prod(size(x)),prod(size(y)))
213             if mx<>0 then
214                 xmx=max(x);xmn=min(x)
215                 ymx=max(y);ymn=min(y)
216                 dx=xmx-xmn;dy=ymx-ymn
217                 if dx==0 then dx=max(xmx/2,1),xmn=xmn-dx/10;xmx=xmx+dx/10;end
218                 if dy==0 then dy=max(ymx/2,1),ymn=ymn-dy/5;ymx=ymx+dy/10;end
219             else
220                 xmn=0;ymn=0;xmx=1;ymx=1;dx=1;dy=1
221             end
222             rect=[xmn,ymn,xmx,ymx];
223             edit_curv_axes.data_bounds=[rect(1),rect(2);rect(3),rect(4)]
224             if x<>[]&y<>[] then
225                 if hdl==[] then
226                     xpolys(x(1)*[1 1],y(1)*[1 1],[1,-1])
227                     hdl=gce();hdl=hdl.children
228                 end
229                 hdl.data=[x y];
230             else
231                 if hdl<>[] then delete(hdl),end
232                 x=[];y=[];
233             end
234
235         case "Save" then
236             savexy(x,y)
237
238         case "Replot" then
239             // for compatibility only, perform nothing on purpose
240
241         case "edit" then
242             npt=prod(size(x))
243             if npt<>0 then
244                 dist=((x-ones(npt,1)*c1(1))/dx).^2+((y-ones(npt,1)*c1(2))/dy).^2
245                 [m,k]=min(dist);m=sqrt(m)
246             else
247                 m=3*eps
248             end
249             if m<eps then                 //on deplace le point
250                 xs=x;ys=y
251                 [x,y]=movept(x,y)
252             else
253                 if add==1 then
254                     xs=x;ys=y                  //on rajoute un point de cassure
255                     [x,y]=addpt(c1,x,y)
256                 end
257             end
258         end
259     end
260 endfunction
261
262
263 function [btn,xc,yc,win,Cmenu] = get_click(flag)
264     //** 05/01/09 : update for Scilab 5.1: (close code is now -1000)
265
266     if ~or(winsid()==curwin) then
267         Cmenu = "Quit";
268         return        ;
269     end
270
271     if argn(2) == 1 then
272         [btn, xc, yc, win, str] = xclick(flag);
273     else
274         [btn, xc, yc, win, str] = xclick();
275     end
276
277     if btn == -1000 then //** user close the window [X]
278         if win == curwin then
279             Cmenu = "XClose";
280         else
281             Cmenu = "Open/Set";
282         end
283         return ;
284     end
285
286     if btn == -2 then //** user select a dynamic menu
287         xc = 0; yc = 0;
288         execstr("Cmenu=" + part(str, 9:length(str) - 1) );
289         execstr("Cmenu=" + Cmenu);
290         return;
291     end
292
293     Cmenu = [];
294
295 endfunction
296
297
298 function [x,y] = addpt(c1,x,y)
299     // permet de rajouter un point de cassure
300     npt = prod(size(x))
301     c1 = c1'
302     if hdl==[] then
303         x = c1(1);
304         y = c1(2);
305         xpolys(x*[1 1],y*[1 1],[1,-1]);
306         hdl = resume(edit_curv_axes.children(1).children)
307     end
308     //recherche des intervalles en x contenant l'abscisse designee
309     kk=[]
310     if npt>1 then
311         kk=find((x(1:npt-1)-c1(1)*ones(x(1:npt-1)))..
312         .*(x(2:npt)-c1(1)*ones(x(2:npt)))<=0)
313     end
314     if  kk<>[] then
315         //    recherche du segment sur le quel on a designe un point
316         pp=[];d=[];i=0
317         for k=kk
318             i=i+1
319             pr=projaff(x(k:k+1),y(k:k+1),c1)
320             if (x(k)-pr(1))*(x(k+1)-pr(1))<=0 then
321                 pp=[pp pr]
322                 d1=rect(3)-rect(1)
323                 d2=rect(4)-rect(2)
324                 d=[d norm([d1;d2].\(pr-c1))]
325             end
326         end
327         if d<>[] then
328             [m,i]=min(d)
329             if m<eps
330                 k=kk(i)
331                 pp=pp(:,i)
332                 x=x([1:k k:npt]);x(k+1)=pp(1);
333                 y=y([1:k k:npt]);y(k+1)=pp(2);
334                 hdl.data=[x y];
335                 return
336             end
337         end
338     end
339     d1=rect(3)-rect(1)
340     d2=rect(4)-rect(2)
341     if norm([d1;d2].\([x(1);y(1)]-c1))<norm([d1;d2].\([x(npt);y(npt)]-c1)) then
342         //  -- mise a jour de x et y
343         x(2:npt+1)=x;x(1)=c1(1)
344         y(2:npt+1)=y;y(1)=c1(2)
345     else
346         //  -- mise a jour de x et y
347         x(npt+1)=c1(1)
348         y(npt+1)=c1(2)
349     end
350     hdl.data=[x y];
351 endfunction
352
353 function [x,y]=movept(x,y)
354     //on bouge un point existant
355     hdl;
356     rep(3)=-1
357     while rep(3)==-1 do
358         rep = xgetmouse();
359         xc=rep(1);yc=rep(2);c2=[xc;yc]
360         if modx==0 then c2(1)=x(k);end
361         if mody==0 then c2(2)=y(k);end
362         x(k)=c2(1);y(k)=c2(2)
363         hdl.data=[x,y];
364     end
365 endfunction
366
367
368 function [x,y] = readxy()
369
370     function xy = findPolyline(children)
371         xy = [];
372         for i = 1:length(children)
373             select children(i).type,
374             case "Polyline" then
375                 xy = children(i).data;
376                 return
377             case "Axes" then
378                 xy = findPolyline(children(i).children);
379                 return
380             case "Compound" then
381                 xy = findPolyline(children(i).children);
382                 return
383             end
384         end
385     endfunction
386
387     fn=uigetfile(["*.scg";"*.sod";"*.xy"], "", _("Select a file to load"));
388     if fn <> "" then
389         [pth, fnm, ext] = fileparts(fn);
390         flname = fnm + ext;
391
392         select ext
393         case ".scg" then
394             loaded_figure=figure("visible", "off");
395             if execstr("xload(fn, loaded_figure.figure_id)","errcatch") == 0 then
396                 loaded_figure.visible = "off";
397                 scf(edit_curv_figure);
398                 xy = findPolyline(loaded_figure.children);
399                 delete(loaded_figure);
400                 if xy <> [] then
401                     x=xy(:,1);y=xy(:,2);
402                 else
403                     msg = _("%s: The file "'%s"' does not contains any "'Polyline"' graphic entity.\n")
404                     messagebox(msprintf(msg, "edit_curve", flname));
405                     return
406                 end
407             else
408                 msg = _("%s: Cannot open file "'%s"' for reading.\n")
409                 messagebox(msprintf(msg, "edit_curv", flname), "modal");
410                 return
411             end
412         case ".xy" then
413             if execstr("xy = read(fn,-1,2)","errcatch") == 0 then
414                 x=xy(:,1);y=xy(:,2);
415             else
416                 msg = _("%s: Cannot open file "'%s"' for reading.\n")
417                 messagebox(msprintf(msg, "edit_curv", flname), "modal");
418                 return
419             end
420         case ".sod" then
421             if execstr("load(fn)","errcatch") == 0 then
422                 x=xy(:,1);y=xy(:,2);
423             else
424                 msg = _("%s: Cannot open file "'%s"' for reading.\n")
425                 messagebox(msprintf(msg, "edit_curv", flname), "modal");
426                 return
427             end
428         else
429             messagebox(_("Error in file format."), "modal");
430             return
431         end
432     else
433         x=x
434         y=y
435     end
436 endfunction
437
438
439 function savexy(x,y)
440     fn=uiputfile(["*.sod";"*.xy"], "", _("Select a file to write"));
441     if fn <> "" then
442         [pth, fnm, ext] = fileparts(fn);
443         flname = fnm + ext;
444         xy = [x y];
445         fil = fn;
446
447         select ext
448         case "" then
449             fil = fil + ".xy";
450             ext = ".xy";
451         case ".xy" then
452             // empty case fil = fn
453         case ".sod" then
454             // empty case fil = fn
455         else
456             fil = pth + fnm + ".xy";
457             ext = ".xy";
458         end
459
460         select ext
461         case ".sod" then
462             if execstr("save(fil,""xy"")","errcatch")<>0 then
463                 msg = _("%s: The file "'%s"' cannot be written.\n")
464                 messagebox(msprintf(msg, "edit_curv", flname), "modal");
465                 return
466             end
467         case ".xy" then
468             isErr = execstr("write(fil,xy)","errcatch")
469             if isErr == 240 then
470                 mdelete(fil); // write cannot overwrite an existing file
471                 isErr = execstr("write(fil,xy)","errcatch");
472             end
473             if isErr <> 0 then
474                 msg = _("%s: The file "'%s"' cannot be written.\n")
475                 messagebox(msprintf(msg, "edit_curv", flname), "modal");
476                 return
477             end
478         end
479     end
480 endfunction