0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...
[occt.git] / src / Interface / Interface_Graph.cxx
1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
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.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14
15 #include <Interface_BitMap.hxx>
16 #include <Interface_EntityIterator.hxx>
17 #include <Interface_GeneralLib.hxx>
18 #include <Interface_GeneralModule.hxx>
19 #include <Interface_Graph.hxx>
20 #include <Interface_GTool.hxx>
21 #include <Interface_InterfaceModel.hxx>
22 #include <Interface_Protocol.hxx>
23 #include <Interface_ReportEntity.hxx>
24 #include <Interface_ShareTool.hxx>
25 #include <Standard_DomainError.hxx>
26 #include <Standard_Transient.hxx>
27 #include <TCollection_HAsciiString.hxx>
28 #include <TColStd_Array1OfInteger.hxx>
29 #include <TColStd_HSequenceOfTransient.hxx>
30 #include <TColStd_ListIteratorOfListOfInteger.hxx>
31
32 // Flags : 0 = Presence, 1 = Sharing Error
33 #define Graph_Present 0
34 #define Graph_ShareError 1
35
36
37 //  ###########################################################################
38
39 //  ....                           CONSTRUCTEURS                           ....
40
41 //  ....       Construction a partir de la connaissance des Entites        ....
42
43
44 Interface_Graph::Interface_Graph
45 (const Handle(Interface_InterfaceModel)& amodel,
46  const Interface_GeneralLib& /*lib*/,
47  Standard_Boolean theModeStat)
48  : themodel   (amodel), thepresents ("") 
49 {
50   if(theModeStat)
51     InitStats();
52   Evaluate();
53 }
54
55 Interface_Graph::Interface_Graph
56 (const Handle(Interface_InterfaceModel)& amodel,
57  const Handle(Interface_Protocol)& /*protocol*/,
58  Standard_Boolean theModeStat)
59  : themodel   (amodel) , thepresents ("")    
60
61 {
62  if(theModeStat)
63     InitStats();  
64   Evaluate();
65 }
66
67 Interface_Graph::Interface_Graph
68 (const Handle(Interface_InterfaceModel)& amodel,
69  const Handle(Interface_GTool)& /*gtool*/,
70  Standard_Boolean theModeStat)
71  : themodel   (amodel) , thepresents ("") 
72 {
73   if(theModeStat)
74     InitStats();
75   Evaluate();
76 }
77
78 Interface_Graph::Interface_Graph
79 (const Handle(Interface_InterfaceModel)& amodel,
80  Standard_Boolean theModeStat)
81 : themodel   (amodel) , thepresents ("")  
82 {
83   if(theModeStat)
84     InitStats();
85   Evaluate ();
86 }
87
88 //  ....                Construction depuis un autre Graph                ....
89
90 Interface_Graph::Interface_Graph
91 (const Interface_Graph& agraph, const Standard_Boolean /*copied*/)
92 : themodel   (agraph.Model()), thepresents ("") 
93 {
94   thesharings = agraph.SharingTable();
95   Standard_Integer nb = agraph.NbStatuses();
96   if(!nb)
97     return;
98   if(thestats.IsNull())
99     thestats = new TColStd_HArray1OfInteger(1,nb);
100   for (Standard_Integer i = 1; i <= nb; i ++)
101     thestats->SetValue (i,agraph.Status(i));
102   theflags.Initialize(agraph.BitMap(),Standard_True);
103 }
104
105 void Interface_Graph::InitStats()
106 {
107   thestats = new TColStd_HArray1OfInteger(1,themodel->NbEntities()) , 
108     theflags.Initialize(themodel->NbEntities(),2);
109   theflags.AddFlag ("ShareError");
110 }
111
112 Standard_Integer Interface_Graph::NbStatuses() const
113 {
114   return (thestats.IsNull() ? 0 : thestats->Length());
115 }
116
117 const Handle(TColStd_HArray1OfListOfInteger)& Interface_Graph::SharingTable () const
118 {  return thesharings;  }
119
120 void Interface_Graph::Evaluate()
121 {
122   //  Evaluation d un Graphe de dependances : sur chaque Entite, on prend sa
123   //  liste "Shared". On en deduit les "Sharing"  directement
124   Standard_Integer n = Size();
125   thesharings = new TColStd_HArray1OfListOfInteger(1,n);//TColStd_HArray1OfTransient(1,n);//Clear();
126   if(themodel->GTool().IsNull())
127     return;
128   
129
130   Standard_Integer i; // svv Jan11 2000 : porting on DEC
131   for (i = 1; i <= n; i ++) {
132      //    ATTENTION : Si Entite non chargee donc illisible, basculer sur son
133     //    "Contenu" equivalent
134     Handle(Standard_Transient) ent = themodel->Value(i);
135   
136
137     //    Resultat obtenu via GeneralLib
138     Interface_EntityIterator iter = GetShareds(ent);
139
140     //    Mise en forme : liste d entiers
141     for (iter.Start(); iter.More(); iter.Next()) {
142       //    num = 0 -> on sort du Model de depart, le noter "Error" et passer
143       Handle(Standard_Transient) entshare = iter.Value();
144       if(entshare == ent)
145         continue;
146
147       Standard_Integer num = EntityNumber(entshare);
148
149       if (!num )  
150       {
151         if(!thestats.IsNull())
152           theflags.SetTrue (i,Graph_ShareError);
153         continue;
154       }
155       thesharings->ChangeValue(num).Append(i);
156     }
157   }
158 }
159
160 //  ....                Construction depuis un autre Graph                ....
161
162
163 //  ###########################################################################
164
165 //  ....                ACCES UNITAIRES AUX DONNEES DE BASE                ....
166
167 void  Interface_Graph::Reset ()
168 {
169   if(!thestats.IsNull())
170   {
171     thestats.Nullify();
172     theflags.Init (Standard_False, Graph_Present);
173   }
174
175 }
176
177 void  Interface_Graph::ResetStatus ()
178
179   if(!thestats.IsNull())
180   {
181     thestats->Init(0);  
182     theflags.Init (Standard_False, Graph_Present);
183   }
184 }
185
186
187 Standard_Integer  Interface_Graph::Size () const 
188 {  return themodel->NbEntities(); }//thestats.Upper();  }
189
190 Standard_Integer  Interface_Graph::EntityNumber
191 (const Handle(Standard_Transient)& ent) const 
192 {  return themodel->Number(ent);  }
193
194 Standard_Boolean  Interface_Graph::IsPresent
195 (const Standard_Integer num) const 
196 {
197   if (num <= 0 || num > Size()) 
198     return Standard_False;
199   return (!thestats.IsNull() ? theflags.Value (num,Graph_Present) : Standard_False);
200 }
201
202 Standard_Boolean  Interface_Graph::IsPresent
203 (const Handle(Standard_Transient)& ent) const 
204 {  return IsPresent(EntityNumber(ent));  }
205
206 const Handle(Standard_Transient)&  Interface_Graph::Entity
207 (const Standard_Integer num) const 
208 {  
209   return themodel->Value(num);  
210 }
211
212
213 Standard_Integer  Interface_Graph::Status (const Standard_Integer num) const
214 {  
215   return (!thestats.IsNull() ? thestats->Value(num) : 0);  
216 }
217
218 void  Interface_Graph::SetStatus
219 (const Standard_Integer num, const Standard_Integer stat)
220 {  
221   if(!thestats.IsNull())
222     thestats->SetValue(num,stat);  
223 }
224
225 void  Interface_Graph::RemoveItem(const Standard_Integer num)
226 {
227   if(!thestats.IsNull())
228   {
229     thestats->SetValue(num,0);  
230     theflags.SetFalse (num,Graph_Present);
231   }
232 }
233
234 void  Interface_Graph::ChangeStatus
235 (const Standard_Integer oldstat, const Standard_Integer newstat)
236 {
237   if(thestats.IsNull())
238     return;
239   Standard_Integer nb = thestats->Upper();
240   for (Standard_Integer i = 1; i <= nb; i ++) {
241     if (thestats->Value(i) == oldstat) 
242       thestats->SetValue(i,newstat);
243   }
244 }
245
246 void  Interface_Graph::RemoveStatus(const Standard_Integer stat)
247 {
248   if(thestats.IsNull())
249     return;
250   Standard_Integer nb = thestats->Upper();
251   for (Standard_Integer i = 1; i <= nb; i ++) {
252     if (thestats->Value(i) == stat) RemoveItem(i);
253   }
254 }
255
256 const Interface_BitMap&  Interface_Graph::BitMap () const
257 {  return theflags;  }
258
259 Interface_BitMap&  Interface_Graph::CBitMap ()
260 {  return theflags;  }
261
262 //  ###########################################################################
263
264 //  ....      Chargements Elementaires avec Propagation de "Share"      .... //
265
266 const Handle(Interface_InterfaceModel)&  Interface_Graph::Model() const 
267 {  return themodel;  }
268
269 void  Interface_Graph::GetFromModel ()
270 {
271   if (themodel.IsNull() || thestats.IsNull()) 
272     return;    // no model ... (-> on n ira pas loin)
273   theflags.Init (Standard_True,Graph_Present);
274   thestats->Init (0);
275 }
276
277 void  Interface_Graph::GetFromEntity
278 (const Handle(Standard_Transient)& ent, const Standard_Boolean shared,
279  const Standard_Integer newstat)
280 {
281   if(thestats.IsNull())
282     return;
283   Standard_Integer num = EntityNumber(ent);
284   if (!num ) 
285     return;
286   if (theflags.CTrue(num,Graph_Present)) return;  // deja pris : on passe
287   thestats->SetValue(num,newstat);
288   if (!shared) return;
289   //  Attention a la redefinition !
290   Interface_EntityIterator aIter = GetShareds(ent);
291
292   for ( ; aIter.More() ; aIter.Next())    
293     GetFromEntity(aIter.Value(),Standard_True,newstat);
294 }
295
296 void  Interface_Graph::GetFromEntity
297 (const Handle(Standard_Transient)& ent, const Standard_Boolean shared,
298  const Standard_Integer newstat, const Standard_Integer overlapstat,
299  const Standard_Boolean cumul)
300 {
301   if(thestats.IsNull())
302     return;
303   Standard_Integer num   = EntityNumber(ent);
304   if (!num ) return;
305   Standard_Boolean pasla = !theflags.CTrue (num,Graph_Present);
306   Standard_Integer stat  = thestats->Value(num); 
307
308   if (pasla) {
309     ///    theflags.SetTrue (num, Graph_Present);   // nouveau : noter avec newstat
310     thestats->SetValue(num,newstat);
311   } else {
312     Standard_Integer overstat = stat;
313     if (stat != newstat) {                   // deja pris, meme statut : passer
314       if (cumul) overstat += overlapstat;    // nouveau statut : avec cumul ...
315       else       overstat  = overlapstat;    // ... ou sans (statut force)
316       if (stat != overstat)                  // si repasse deja faite, passer
317         thestats->SetValue(num,overstat);
318     }
319   }
320   if (!shared) return;
321   //  Attention a la redefinition !
322   Interface_EntityIterator aIter = GetShareds(ent);
323
324   for ( ; aIter.More() ; aIter.Next())    
325     GetFromEntity(aIter.Value(),Standard_True,newstat);
326 }
327
328 void  Interface_Graph::GetFromIter
329 (const Interface_EntityIterator& iter, const Standard_Integer newstat)
330 {
331    if(thestats.IsNull())
332     return;
333   for (iter.Start(); iter.More(); iter.Next()) {
334     Handle(Standard_Transient) ent = iter.Value();
335     Standard_Integer num = EntityNumber(ent);
336     if (!num) 
337       continue;
338     if (theflags.CTrue(num,Graph_Present)) 
339       continue;
340     thestats->SetValue(num,newstat);
341   }
342 }
343
344
345 void  Interface_Graph::GetFromIter
346 (const Interface_EntityIterator& iter,
347  const Standard_Integer newstat, const Standard_Integer overlapstat,
348  const Standard_Boolean cumul)
349 {
350   if(thestats.IsNull())
351     return;
352   for (iter.Start(); iter.More(); iter.Next()) {
353     Handle(Standard_Transient) ent = iter.Value();
354     Standard_Integer num   = EntityNumber(ent);
355     if (!num) 
356       continue;
357     /*Standard_Boolean pasla = !*/theflags.Value(num,Graph_Present);
358     /*Standard_Integer stat  = */thestats->Value(num); 
359     GetFromEntity (ent,Standard_False,newstat,overlapstat,cumul);
360   }
361 }
362
363
364 void Interface_Graph::GetFromGraph (const Interface_Graph& agraph)
365 {
366   if (Model() != agraph.Model()) throw Standard_DomainError("Graph from Interface : GetFromGraph");
367   Standard_Integer nb = Size();
368   for (Standard_Integer i = 1; i <= nb; i ++) {
369     if (agraph.IsPresent(i))
370       GetFromEntity (agraph.Entity(i),Standard_False,agraph.Status(i));
371   }
372 }
373
374 void Interface_Graph::GetFromGraph
375 (const Interface_Graph& agraph, const Standard_Integer stat)
376 {
377   if (Model() != agraph.Model()) throw Standard_DomainError("Graph from Interface : GetFromGraph");
378   Standard_Integer nb = Size();
379   for (Standard_Integer i = 1; i <= nb; i ++) {
380     if (agraph.IsPresent(i) && agraph.Status(i) == stat)
381       GetFromEntity (agraph.Entity(i),Standard_False,stat);
382   }
383 }
384
385 //  #####################################################################
386
387 //  ....                Listage des Entites Partagees                ....
388
389 Standard_Boolean Interface_Graph::HasShareErrors
390 (const Handle(Standard_Transient)& ent) const
391 {
392   if(thestats.IsNull())
393     return Standard_False;
394   Standard_Integer num   = EntityNumber(ent);
395   if (num == 0) return Standard_True;
396   return theflags.Value (num,Graph_ShareError);
397 }
398
399 Interface_EntityIterator Interface_Graph::Shareds
400 (const Handle(Standard_Transient)& ent) const
401 {
402   Interface_EntityIterator iter;
403   Standard_Integer num   = EntityNumber(ent);
404   if(!num)
405     return iter;
406
407   Handle(Standard_Transient) aCurEnt =  ent;
408   if (themodel->IsRedefinedContent(num)) 
409      aCurEnt = themodel->ReportEntity(num)->Content();
410
411   //if (num == 0)  throw Standard_DomainError("Interface : Shareds");
412   Handle(Interface_GeneralModule) module;
413   Standard_Integer CN;
414   if (themodel->GTool()->Select(aCurEnt,module,CN))  
415     module->FillShared(themodel,CN,aCurEnt,iter);
416   return iter;
417 }
418
419 Handle(TColStd_HSequenceOfTransient) Interface_Graph::GetShareds(const Handle(Standard_Transient)& ent) const
420 {
421   Handle(TColStd_HSequenceOfTransient) aseq = new TColStd_HSequenceOfTransient;
422   Interface_EntityIterator iter = Shareds(ent);
423   for( ; iter.More(); iter.Next())
424     aseq->Append(iter.Value());
425   return aseq;
426 }
427
428 Handle(TColStd_HSequenceOfTransient) Interface_Graph::GetSharings(const Handle(Standard_Transient)& ent) const
429 {
430   Standard_Integer num   = EntityNumber(ent);
431   if(!num)
432     return 0;
433   //return Handle(TColStd_HSequenceOfTransient)::DownCast(thesharings->Value(num));
434   const TColStd_ListOfInteger& alist = thesharings->Value(num);
435   Handle(TColStd_HSequenceOfTransient) aSharings = new TColStd_HSequenceOfTransient;
436   TColStd_ListIteratorOfListOfInteger aIt(alist);
437   for( ; aIt.More() ; aIt.Next())
438     aSharings->Append(Entity(aIt.Value()));
439   return aSharings;
440 }
441
442 Interface_EntityIterator Interface_Graph::Sharings
443 (const Handle(Standard_Transient)& ent) const
444 {
445   Interface_EntityIterator iter;
446   iter.AddList(GetSharings(ent));
447   return iter;
448
449 }
450
451 static void AddTypedSharings
452 (const Handle(Standard_Transient)& ent, const Handle(Standard_Type)& type,
453  Interface_EntityIterator& iter, const Standard_Integer n,
454  const Interface_Graph& G)
455 {
456   if (ent.IsNull()) return;
457   if (ent->IsKind(type))  {  iter.AddItem (ent);  return;  }
458   if (iter.NbEntities() > n) return;
459
460   Handle(TColStd_HSequenceOfTransient) list = G.GetSharings(ent);
461   if(list.IsNull())
462     return;
463
464   Standard_Integer nb = list->Length();
465   for (Standard_Integer i = 1; i <= nb; i ++)
466     AddTypedSharings (list->Value(i) ,type,iter,nb,G);
467 }
468
469 Interface_EntityIterator Interface_Graph::TypedSharings
470 (const Handle(Standard_Transient)& ent, const Handle(Standard_Type)& type) const
471 {
472   Interface_EntityIterator iter;
473   Standard_Integer n = Size();
474   AddTypedSharings (ent,type,iter,n,*this);
475   return iter;
476 }
477
478
479 Interface_EntityIterator Interface_Graph::RootEntities () const
480 {
481   Interface_EntityIterator iter;
482   Standard_Integer nb = thesharings->Length();
483   for (Standard_Integer i = 1; i <= nb; i ++) {
484     if(!thesharings->Value(i).IsEmpty())
485       continue;
486     iter.AddItem(Entity(i));
487   }
488   return iter;
489 }
490
491 Handle(TCollection_HAsciiString)  Interface_Graph::Name(const Handle(Standard_Transient)& ent) const
492 {
493   Handle(TCollection_HAsciiString) str;
494   if (themodel.IsNull()) return str;
495   if (themodel->Number(ent)) return str;
496
497   Handle(Interface_GTool) gtool = themodel->GTool();
498   if (gtool.IsNull()) return str;
499
500   Handle(Interface_GeneralModule) module;
501   Standard_Integer CN;
502   if (!gtool->Select(ent,module,CN)) return str;
503
504   Interface_ShareTool sht (*this);
505   return module->Name (CN,ent,sht);
506 }
507
508 Standard_Boolean Interface_Graph::ModeStat() const
509 {
510   return (!thestats.IsNull());
511 }