1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 // This file is part of Open CASCADE Technology software library.
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
15 #include <IFSelect_Act.hxx>
16 #include <IFSelect_CheckCounter.hxx>
17 #include <IFSelect_Functions.hxx>
18 #include <IFSelect_SessionPilot.hxx>
19 #include <Interface_CheckIterator.hxx>
20 #include <Interface_InterfaceModel.hxx>
21 #include <Interface_Macros.hxx>
22 #include <Interface_Static.hxx>
23 #include <Message.hxx>
24 #include <Message_Messenger.hxx>
25 #include <TColStd_HSequenceOfHAsciiString.hxx>
26 #include <TColStd_HSequenceOfTransient.hxx>
27 #include <Transfer_Binder.hxx>
28 #include <Transfer_FinderProcess.hxx>
29 #include <Transfer_IteratorOfProcessForTransient.hxx>
30 #include <Transfer_ResultFromModel.hxx>
31 #include <Transfer_TransferIterator.hxx>
32 #include <Transfer_TransientProcess.hxx>
33 #include <XSControl.hxx>
34 #include <XSControl_Controller.hxx>
35 #include <XSControl_Functions.hxx>
36 #include <XSControl_SelectForTransfer.hxx>
37 #include <XSControl_TransferReader.hxx>
38 #include <XSControl_TransferWriter.hxx>
39 #include <XSControl_WorkSession.hxx>
41 // #######################################################################
47 // #######################################################################
48 //=======================================================================
50 //=======================================================================
51 static IFSelect_ReturnStatus XSControl_xinit(const Handle(IFSelect_SessionPilot)& pilot)
53 Standard_Integer argc = pilot->NbWords();
54 const Standard_CString arg1 = pilot->Arg(1);
56 if (argc > 1) return (XSControl::Session(pilot)->SelectNorm(arg1) ?
57 IFSelect_RetDone : IFSelect_RetFail);
58 Handle(Message_Messenger) sout = Message::DefaultMessenger();
59 sout<<"Selected Norm:"<<XSControl::Session(pilot)->SelectedNorm()<<endl;
60 return IFSelect_RetVoid;
64 //=======================================================================
66 //=======================================================================
67 static IFSelect_ReturnStatus XSControl_xnorm(const Handle(IFSelect_SessionPilot)& pilot)
69 Standard_Integer argc = pilot->NbWords();
70 const Standard_CString arg1 = pilot->Arg(1);
72 Handle(XSControl_WorkSession) WS = XSControl::Session(pilot);
73 Handle(XSControl_Controller) control = WS->NormAdaptor();
74 Handle(Message_Messenger) sout = Message::DefaultMessenger();
76 sout<<"Current Norm. xnorm newnorm to change"<<endl;
77 else sout<<"Current Norm :"<<endl;
78 if (control.IsNull()) sout<<"no norm currently defined"<<endl;
80 sout<<" Long Name (complete) : "<<control->Name(Standard_False)<<endl
81 << " Short name (resource) : "<<control->Name(Standard_True)<<endl;
82 if (argc == 1) return IFSelect_RetVoid;
84 control = XSControl_Controller::Recorded(arg1);
85 if (control.IsNull()) {
86 sout<<" No norm named : "<<arg1<<endl;
87 return IFSelect_RetError;
90 WS->SetController(control);
91 sout<<"new norm : "<<control->Name()<<endl;
92 return IFSelect_RetDone;
96 //=======================================================================
98 //=======================================================================
99 static IFSelect_ReturnStatus XSControl_newmodel(const Handle(IFSelect_SessionPilot)& pilot)
101 // **** newmodel ****
102 if (!XSControl::Session(pilot)->NewModel().IsNull()) return IFSelect_RetDone;
103 Handle(Message_Messenger) sout = Message::DefaultMessenger();
104 sout<<"No new Model produced"<<endl;
105 return IFSelect_RetFail;
109 //=======================================================================
111 //=======================================================================
112 static IFSelect_ReturnStatus XSControl_tpclear(const Handle(IFSelect_SessionPilot)& pilot)
114 // **** tpclear/twclear ****
115 const Standard_Boolean modew = (pilot->Word(0).Value(2) == 'w');
116 const Handle(Transfer_FinderProcess) &FP = XSControl::Session(pilot)->TransferWriter()->FinderProcess();
117 const Handle(Transfer_TransientProcess) &TP = XSControl::Session(pilot)->TransferReader()->TransientProcess();
118 Handle(Message_Messenger) sout = Message::DefaultMessenger();
119 if (modew) { if(!FP.IsNull()) FP->Clear(); else sout<<"No Transfer Write"<<endl; }
120 else { if(!TP.IsNull()) TP->Clear(); else sout<<"No Transfer Read"<<endl; }
121 return IFSelect_RetDone;
125 //=======================================================================
127 //=======================================================================
128 static IFSelect_ReturnStatus XSControl_tpstat(const Handle(IFSelect_SessionPilot)& pilot)
130 Standard_Integer argc = pilot->NbWords();
131 const Standard_CString arg1 = pilot->Arg(1);
132 //const Standard_CString arg2 = pilot->Arg(2);
133 const Handle(Transfer_TransientProcess) &TP = XSControl::Session(pilot)->TransferReader()->TransientProcess();
134 Handle(Message_Messenger) sout = Message::DefaultMessenger();
135 if (TP.IsNull()) { sout<<"No Transfer Read"<<endl; return IFSelect_RetError;}
138 Standard_Integer mod1 = -1;
139 Standard_Integer mod2 = 0;
140 // g : general c : check (compte) C (liste) f : fails(compte) F (liste)
141 // resultats racines : n : n0s entites s : status b : binders
142 // t : compte par type r : compte par resultat l : liste(type-resultat)
143 // *n *s *b *t *r *l : idem sur tout
144 // ?n etc.. : idem sur resultats anormaux
145 // ? tout court pour help
148 char a2 = arg1[1]; if (a2 == '\0') a2 = '!';
150 case 'g' : mod1 = 0; break;
151 case 'c' : mod1 = 4; mod2 = 4; break;
152 case 'C' : mod1 = 4; mod2 = 2; break;
153 case 'f' : mod1 = 5; mod2 = 4; break;
154 case 'F' : mod1 = 5; mod2 = 2; break;
155 case '*' : mod1 = 2; break;
156 case '?' : mod1 = 3; break;
157 default : mod1 = 1; if (argc > 2) mod1 = 2; a2 = arg1[0]; break;
159 if (mod1 < 1 || mod1 > 3) a2 = '!';
161 case 'n' : mod2 = 0; break;
162 case 's' : mod2 = 1; break;
163 case 'b' : mod2 = 2; break;
164 case 't' : mod2 = 3; break;
165 case 'r' : mod2 = 4; break;
166 case 'l' : mod2 = 5; break;
167 case 'L' : mod2 = 6; break;
169 case '?' : mod1 = -1; break;
170 default : mod1 = -2; break;
173 // A present help eventuel
174 if (mod1 < -1) sout<<"Unknown Mode"<<endl;
176 sout<<"Modes available :\n"
177 <<"g : general c : checks (count) C (list)\n"
178 <<" f : fails (count) F (list)\n"
179 <<" n : numbers of transferred entities (on TRANSFER ROOTS)\n"
180 <<" s : their status (type entity-result , presence checks)\n"
181 <<" b : detail of binders\n"
182 <<" t : count per entity type r : per type/status result\n"
183 <<" l : count per couple type entity/result\n"
184 <<" L : list per couple type entity/result\n"
185 <<" *n *s *b *t *r *l *L : idem on ALL recorded items\n"
186 <<" ?n ?s ?b ?t ... : idem on abnormal items\n"
187 <<" n select : n applied on a selection idem for s b t r l"<<endl;
188 if (mod1 < -1) return IFSelect_RetError;
189 return IFSelect_RetVoid;
193 sout<<"TransferRead :";
194 if (TP->Model() != pilot->Session()->Model()) sout<<"Model differs from the session";
195 Handle(TColStd_HSequenceOfTransient) list =
196 IFSelect_Functions::GiveList(pilot->Session(),pilot->CommandPart(2));
197 XSControl_TransferReader::PrintStatsOnList (TP,list,mod1,mod2);
198 // TP->PrintStats (1,sout);
200 else sout<<"TransferRead : not defined"<<endl;
201 return IFSelect_RetVoid;
205 //=======================================================================
207 //=======================================================================
208 static IFSelect_ReturnStatus XSControl_tpent(const Handle(IFSelect_SessionPilot)& pilot)
210 Standard_Integer argc = pilot->NbWords();
211 const Standard_CString arg1 = pilot->Arg(1);
212 const Handle(Transfer_TransientProcess) &TP = XSControl::Session(pilot)->TransferReader()->TransientProcess();
214 Handle(Message_Messenger) sout = Message::DefaultMessenger();
215 if (TP.IsNull()) { sout<<"No Transfer Read"<<endl; return IFSelect_RetError;}
216 Handle(Interface_InterfaceModel) model = TP->Model();
217 if (model.IsNull()) return IFSelect_RetFail;
219 if (argc < 2) { sout<<"Give ENTITY NUMBER (IN MODEL TransferProcess)"<<endl; return IFSelect_RetError; }
220 Standard_Integer num = atoi(arg1);
221 if (num <= 0 || num > model->NbEntities()) { sout<<"Number not in [1 - "<<model->NbEntities()<<"]"<<endl; return IFSelect_RetError; }
222 Handle(Standard_Transient) ent = model->Value(num);
223 Standard_Integer index = TP->MapIndex (ent);
224 if (index == 0) sout<<"Entity "<<num<<" not recorded in transfer"<<endl;
225 else XSControl::Session(pilot)->PrintTransferStatus (index,Standard_False,sout);
226 return IFSelect_RetVoid;
230 //=======================================================================
232 //=======================================================================
233 static IFSelect_ReturnStatus XSControl_tpitem(const Handle(IFSelect_SessionPilot)& pilot)
235 Standard_Integer argc = pilot->NbWords();
236 const Standard_CString arg1 = pilot->Arg(1);
237 // **** tpitem/tproot/twitem/twroot ****
238 Handle(Message_Messenger) sout = Message::DefaultMessenger();
239 if (argc < 2) { sout<<"Give ITEM NUMBER (in TransferProcess)"<<endl; return IFSelect_RetError; }
240 Standard_Integer num = atoi(arg1);
241 if (pilot->Word(0).Value(3) == 'r') num = -num;
242 Standard_Boolean modew = Standard_False;
243 if (pilot->Word(0).Value(2) == 'w') modew = Standard_True;
244 Handle(Transfer_Binder) binder;
245 Handle(Transfer_Finder) finder;
246 Handle(Standard_Transient) ent;
247 if (!XSControl::Session(pilot)->PrintTransferStatus(num,modew,sout))
248 sout<<" - Num="<<num<<" incorrect"<<endl;
249 return IFSelect_RetVoid;
253 //=======================================================================
255 //=======================================================================
256 static IFSelect_ReturnStatus XSControl_trecord(const Handle(IFSelect_SessionPilot)& pilot)
258 Standard_Integer argc = pilot->NbWords();
259 const Standard_CString arg1 = pilot->Arg(1);
260 const Handle(Transfer_TransientProcess) &TP = XSControl::Session(pilot)->TransferReader()->TransientProcess();
261 // **** trecord : TransferReader ****
262 Standard_Boolean tous = (argc == 1);
263 Standard_Integer num = -1;
264 const Handle(Interface_InterfaceModel) &mdl = XSControl::Session(pilot)->Model();
265 const Handle(XSControl_TransferReader) &TR = XSControl::Session(pilot)->TransferReader();
266 Handle(Standard_Transient) ent;
267 Handle(Message_Messenger) sout = Message::DefaultMessenger();
268 if (mdl.IsNull() || TR.IsNull() || TP.IsNull())
269 { sout<<" init not done"<<endl; return IFSelect_RetError; }
270 if (!tous) num = atoi(arg1);
271 // Enregistrer les racines
273 Standard_Integer nb = TP->NbRoots();
274 sout<<" Recording "<<nb<<" Roots"<<endl;
275 for (Standard_Integer i = 1; i <= nb; i ++) {
277 if (TR->RecordResult (ent)) sout<<" Root n0."<<i<<endl;
278 else sout<<" Root n0."<<i<<" not recorded"<<endl;
281 if (num < 1 || num > mdl->NbEntities()) sout<<"incorrect number:"<<num<<endl;
282 else if (TR->RecordResult(mdl->Value(num))) sout<<" Entity n0."<<num<<endl;
283 else sout<<" Entity n0."<<num<<" not recorded"<<endl;
285 return IFSelect_RetDone;
289 //=======================================================================
291 //=======================================================================
292 static IFSelect_ReturnStatus XSControl_trstat(const Handle(IFSelect_SessionPilot)& pilot)
294 Standard_Integer argc = pilot->NbWords();
295 const Standard_CString arg1 = pilot->Arg(1);
296 Handle(Message_Messenger) sout = Message::DefaultMessenger();
297 // **** trstat : TransferReader ****
298 const Handle(XSControl_TransferReader) &TR = XSControl::Session(pilot)->TransferReader();
299 if (TR.IsNull()) { sout<<" init not done"<<endl; return IFSelect_RetError; }
300 Handle(Interface_InterfaceModel) mdl = TR->Model();
301 if (mdl.IsNull()) { sout<<" No model"<<endl; return IFSelect_RetError; }
302 sout<<" Statistics : FileName : "<<TR->FileName()<<endl;
305 TR->PrintStats(10,0);
308 Standard_Integer num = atoi(arg1);
309 if (num < 1 || num > mdl->NbEntities()) { sout<<" incorrect number:"<<arg1<<endl; return IFSelect_RetError; }
310 Handle(Standard_Transient) ent = mdl->Value(num);
311 if (!TR->IsRecorded(ent)) { sout<<" Entity "<<num<<" not recorded"<<endl; return IFSelect_RetError; }
312 Handle(Transfer_ResultFromModel) RM = TR->FinalResult(ent);
313 Handle(TColStd_HSequenceOfTransient) list = TR->CheckedList(ent);
314 Standard_Integer i, nb = list->Length();
315 if (nb > 0) sout<<" Entities implied by Check/Result :"<<nb<<" i.e.:";
316 for (i = 1; i <= nb; i ++) { sout<<" "; mdl->Print(list->Value(i),sout); }
318 if (RM.IsNull()) { sout<<" no other info"<<endl; return IFSelect_RetVoid; }
319 Interface_CheckIterator chl = RM->CheckList(Standard_False);
320 pilot->Session()->PrintCheckList(chl,Standard_False,IFSelect_EntitiesByItem);
322 return IFSelect_RetVoid;
326 //=======================================================================
328 //=======================================================================
329 static IFSelect_ReturnStatus XSControl_trbegin(const Handle(IFSelect_SessionPilot)& pilot)
331 // **** trbegin : TransferReader ****
332 Handle(XSControl_TransferReader) TR = XSControl::Session(pilot)->TransferReader();
333 Standard_Boolean init = TR.IsNull();
334 if (pilot->NbWords() > 1) { if (pilot->Arg(1)[0] == 'i') init = Standard_True; }
336 XSControl::Session(pilot)->InitTransferReader (0);
337 TR = XSControl::Session(pilot)->TransferReader();
339 Handle(Message_Messenger) sout = Message::DefaultMessenger();
340 sout<<" init not done or failed"<<endl;
341 return IFSelect_RetError;
345 return IFSelect_RetDone;
349 //=======================================================================
351 //=======================================================================
352 static IFSelect_ReturnStatus XSControl_tread(const Handle(IFSelect_SessionPilot)& pilot)
354 Standard_Integer argc = pilot->NbWords();
355 //const Standard_CString arg1 = pilot->Arg(1);
356 // **** tread : TransferReader ****
357 Handle(Message_Messenger) sout = Message::DefaultMessenger();
358 const Handle(XSControl_TransferReader) &TR = XSControl::Session(pilot)->TransferReader();
359 if (TR.IsNull()) { sout<<" init not done"<<endl; return IFSelect_RetError; }
360 const Handle(Interface_InterfaceModel) &mdl = TR->Model();
361 if (mdl.IsNull()) { sout<<" No model"<<endl; return IFSelect_RetError; }
363 // DeclareAndCast(IFSelect_Selection,sel,pilot->Session()->NamedItem("xst-model-roots"));
364 Handle(Standard_Transient) sel = pilot->Session()->NamedItem("xst-model-roots");
365 if (sel.IsNull()) { sout<<"Select Roots absent"<<endl; return IFSelect_RetError; }
366 Handle(TColStd_HSequenceOfTransient) list = pilot->Session()->GiveList(sel);
367 sout<<" Transferring all roots i.e. : "<<TR->TransferList(list)<<endl;
369 Handle(TColStd_HSequenceOfTransient) list =
370 IFSelect_Functions::GiveList(pilot->Session(),pilot->CommandPart(1));
371 sout<<" Transfer of "<<list->Length()<<" entities"<<endl;
372 Standard_Integer nb = TR->TransferList(list);
373 sout<<" Gives "<<nb<<" results"<<endl;
375 return IFSelect_RetDone;
379 //=======================================================================
381 //=======================================================================
382 static IFSelect_ReturnStatus XSControl_trtp(const Handle(IFSelect_SessionPilot)& pilot)
384 // **** TReader -> TProcess ****
385 const Handle(XSControl_TransferReader) &TR = XSControl::Session(pilot)->TransferReader();
386 Handle(Message_Messenger) sout = Message::DefaultMessenger();
387 if (TR.IsNull()) sout<<" No TransferReader"<<endl;
388 else if (TR->TransientProcess().IsNull()) sout<<" Transfer Reader without Process"<<endl;
389 return IFSelect_RetVoid;
393 //=======================================================================
395 //=======================================================================
396 static IFSelect_ReturnStatus XSControl_tptr(const Handle(IFSelect_SessionPilot)& pilot)
398 // **** TProcess -> TReader ****
399 XSControl::Session(pilot)->InitTransferReader (3);
400 return IFSelect_RetDone;
404 //=======================================================================
406 //=======================================================================
407 static IFSelect_ReturnStatus XSControl_twmode(const Handle(IFSelect_SessionPilot)& pilot)
409 Standard_Integer argc = pilot->NbWords();
410 const Standard_CString arg1 = pilot->Arg(1);
412 Handle(XSControl_TransferWriter) TW = XSControl::Session(pilot)->TransferWriter();
413 Handle(XSControl_Controller) control = XSControl::Session(pilot)->NormAdaptor();
414 Standard_Integer modemin,modemax;
415 Handle(Message_Messenger) sout = Message::DefaultMessenger();
416 if (control->ModeWriteBounds (modemin,modemax)) {
417 sout<<"Write Mode : allowed values "<<modemin<<" to "<<modemax<<endl;
418 for (Standard_Integer modd = modemin; modd <= modemax; modd ++) {
419 sout<<modd<<" : "<<control->ModeWriteHelp (modd)<<endl;;
422 sout<<"Write Mode : actual = "<<TW->TransferMode()<<endl;
423 if (argc <= 1) return IFSelect_RetVoid;
424 Standard_Integer mod = atoi(arg1);
425 sout<<"New value -> "<<arg1<<endl;
426 TW->SetTransferMode(mod);
427 if (!control->IsModeWrite (mod)) sout<<"Warning : this new value is not supported"<<endl;
428 return IFSelect_RetDone;
432 //=======================================================================
434 //=======================================================================
435 static IFSelect_ReturnStatus XSControl_twstat(const Handle(IFSelect_SessionPilot)& pilot)
437 //Standard_Integer argc = pilot->NbWords();
438 //const Standard_CString arg1 = pilot->Arg(1);
439 //const Standard_CString arg2 = pilot->Arg(2);
440 const Handle(Transfer_FinderProcess) &FP = XSControl::Session(pilot)->TransferWriter()->FinderProcess();
443 Handle(Message_Messenger) sout = Message::DefaultMessenger();
445 sout<<"TransferWrite:";
446 // XSControl_TransferWriter::PrintStatsProcess (FP,mod1,mod2);
447 FP->PrintStats (1,sout);
449 else sout<<"TransferWrite: not defined"<<endl;
450 return IFSelect_RetVoid;
454 //=======================================================================
455 //function : settransfert
456 //=======================================================================
457 static IFSelect_ReturnStatus XSControl_settransfert(const Handle(IFSelect_SessionPilot)& pilot)
459 // **** SelectForTransfer ****
460 return pilot->RecordItem(new XSControl_SelectForTransfer(XSControl::Session(pilot)->TransferReader()));
465 static int THE_XSControl_Functions_initactor = 0;
467 //=======================================================================
470 //=======================================================================
472 void XSControl_Functions::Init ()
474 if (THE_XSControl_Functions_initactor)
479 THE_XSControl_Functions_initactor = 1;
480 IFSelect_Act::SetGroup("DE: General");
482 IFSelect_Act::AddFunc ("xinit","[norm:string to change norme] reinitialises according to the norm",XSControl_xinit);
483 IFSelect_Act::AddFunc ("xnorm","displays current norm +norm : changes it",XSControl_xnorm);
485 IFSelect_Act::AddFunc ("newmodel","produces a new empty model, for the session",XSControl_newmodel);
487 IFSelect_Act::AddFunc ("tpclear","Clears TransferProcess (READ)",XSControl_tpclear);
488 IFSelect_Act::AddFunc ("twclear","Clears TransferProcess (WRITE)",XSControl_tpclear);
490 IFSelect_Act::AddFunc ("tpstat","Statistics on TransferProcess (READ)",XSControl_tpstat);
492 IFSelect_Act::AddFunc ("tpent","[num:integer] Statistics on an entity of the model (READ)",XSControl_tpent);
494 IFSelect_Act::AddFunc ("tpitem","[num:integer] Statistics on ITEM of transfer (READ)" ,XSControl_tpitem);
495 IFSelect_Act::AddFunc ("tproot","[num:integer] Statistics on a ROOT of transfert (READ)" ,XSControl_tpitem);
496 IFSelect_Act::AddFunc ("twitem","[num:integer] Statistics on an ITEM of transfer (WRITE)" ,XSControl_tpitem);
497 IFSelect_Act::AddFunc ("twroot","[num:integer] Statistics on a ROOT of transfer (WRITE)",XSControl_tpitem);
499 IFSelect_Act::AddFunc ("trecord","record : all root results; or num : for entity n0.num",XSControl_trecord);
500 IFSelect_Act::AddFunc ("trstat","general statistics; or num : stats on entity n0 num",XSControl_trstat);
501 IFSelect_Act::AddFunc ("trbegin","begin-transfer-reader [init]",XSControl_trbegin);
502 IFSelect_Act::AddFunc ("tread","transfers all roots, or num|sel|sel num : entity list, by transfer-reader",XSControl_tread);
504 IFSelect_Act::AddFunc ("trtp","feeds commands tp... with results from tr...",XSControl_trtp);
505 IFSelect_Act::AddFunc ("tptr","feeds tr... from tp... (may be incomplete)",XSControl_tptr);
507 IFSelect_Act::AddFunc ("twmode","displays mode transfer write, + num changes it",XSControl_twmode);
508 IFSelect_Act::AddFunc ("twstat","Statistics on TransferProcess (WRITE)",XSControl_twstat);
510 IFSelect_Act::AddFSet ("selecttransfer","selection (recognize from transfer actor)",XSControl_settransfert);