-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
ObjectIdentifier.cpp
2020 lines (1765 loc) · 62.7 KB
/
ObjectIdentifier.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
* Copyright (c) 2015 Eivind Kvedalen <eivind@kvedalen.name> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
# include <cassert>
#endif
#include <boost/algorithm/string/predicate.hpp>
#include <App/DocumentObjectPy.h>
#include <Base/GeometryPyCXX.h>
#include <Base/Tools.h>
#include <Base/Interpreter.h>
#include <Base/QuantityPy.h>
#include <Base/Console.h>
#include <Base/Reader.h>
#include <CXX/Objects.hxx>
#include "ObjectIdentifier.h"
#include "Application.h"
#include "Document.h"
#include "ExpressionParser.h"
#include "Link.h"
#include "Property.h"
FC_LOG_LEVEL_INIT("Expression",true,true)
using namespace App;
using namespace Base;
// Path class
/**
* @brief Quote input string according to quoting rules for an expression: because " and ' are
* used to designate inch and foot units, strings are quoted as <<string>>.
*
* @param input
* @return
*/
std::string App::quote(const std::string &input, bool toPython)
{
std::stringstream output;
std::string::const_iterator cur = input.begin();
std::string::const_iterator end = input.end();
output << (toPython?"'":"<<");
while (cur != end) {
switch (*cur) {
case '\t':
output << "\\t";
break;
case '\n':
output << "\\n";
break;
case '\r':
output << "\\r";
break;
case '\\':
output << "\\\\";
break;
case '\'':
output << "\\'";
break;
case '"':
output << "\\\"";
break;
case '>':
output << (toPython?">":"\\>");
break;
default:
output << *cur;
}
++cur;
}
output << (toPython?"'":">>");
return output.str();
}
/**
* @brief Construct an ObjectIdentifier object, given an owner and a single-value property.
* @param _owner Owner of property.
* @param property Name of property.
*/
ObjectIdentifier::ObjectIdentifier(const App::PropertyContainer * _owner,
const std::string & property, int index)
: owner(nullptr)
, documentNameSet(false)
, documentObjectNameSet(false)
, localProperty(false)
, _hash(0)
{
if (_owner) {
const DocumentObject * docObj = freecad_dynamic_cast<const DocumentObject>(_owner);
if (!docObj)
FC_THROWM(Base::RuntimeError,"Property must be owned by a document object.");
owner = const_cast<DocumentObject*>(docObj);
if (!property.empty()) {
setDocumentObjectName(docObj);
}
}
if (!property.empty()) {
addComponent(SimpleComponent(property));
if(index!=INT_MAX)
addComponent(ArrayComponent(index));
}
}
ObjectIdentifier::ObjectIdentifier(const App::PropertyContainer * _owner, bool localProperty)
: owner(nullptr)
, documentNameSet(false)
, documentObjectNameSet(false)
, localProperty(localProperty)
, _hash(0)
{
if (_owner) {
const DocumentObject * docObj = freecad_dynamic_cast<const DocumentObject>(_owner);
if (!docObj)
FC_THROWM(Base::RuntimeError,"Property must be owned by a document object.");
owner = const_cast<DocumentObject*>(docObj);
}
}
/**
* @brief Construct an ObjectIdentifier object given a property. The property is assumed to be single-valued.
* @param prop Property to construct object identifier for.
*/
ObjectIdentifier::ObjectIdentifier(const Property &prop, int index)
: owner(nullptr)
, documentNameSet(false)
, documentObjectNameSet(false)
, localProperty(false)
, _hash(0)
{
DocumentObject * docObj = freecad_dynamic_cast<DocumentObject>(prop.getContainer());
if (!docObj)
FC_THROWM(Base::TypeError, "Property must be owned by a document object.");
if (!prop.hasName())
FC_THROWM(Base::RuntimeError, "Property must have a name.");
owner = const_cast<DocumentObject*>(docObj);
setDocumentObjectName(docObj);
addComponent(SimpleComponent(String(prop.getName())));
if(index!=INT_MAX)
addComponent(ArrayComponent(index));
}
/**
* @brief Get the name of the property.
* @return Name
*/
std::string App::ObjectIdentifier::getPropertyName() const
{
ResolveResults result(*this);
assert(result.propertyIndex >=0 && static_cast<std::size_t>(result.propertyIndex) < components.size());
return components[result.propertyIndex].getName();
}
/**
* @brief Get Component at given index \a i.
* @param i: Index to get
* @param idx: optional return of adjusted component index
* @return A component.
*/
const App::ObjectIdentifier::Component &App::ObjectIdentifier::getPropertyComponent(int i, int *idx) const
{
ResolveResults result(*this);
i += result.propertyIndex;
if (i < 0 || i >= static_cast<int>(components.size()))
FC_THROWM(Base::ValueError, "Invalid property component index");
if (idx)
*idx = i;
return components[i];
}
void App::ObjectIdentifier::setComponent(int idx, Component &&comp)
{
if (idx < 0 || idx >= static_cast<int>(components.size()))
FC_THROWM(Base::ValueError, "Invalid component index");
components[idx] = std::move(comp);
_cache.clear();
}
void App::ObjectIdentifier::setComponent(int idx, const Component &comp)
{
setComponent(idx, Component(comp));
}
std::vector<ObjectIdentifier::Component> ObjectIdentifier::getPropertyComponents() const {
if(components.size()<=1 || documentObjectName.getString().empty())
return components;
ResolveResults result(*this);
if(result.propertyIndex==0)
return components;
std::vector<ObjectIdentifier::Component> res;
res.insert(res.end(),components.begin()+result.propertyIndex,components.end());
return res;
}
/**
* @brief Compare object identifier with \a other.
* @param other Other object identifier.
* @return true if they are equal.
*/
bool ObjectIdentifier::operator ==(const ObjectIdentifier &other) const
{
return owner==other.owner && toString() == other.toString();
}
/**
* @brief Compare object identifier with \a other.
* @param other Other object identifier
* @return true if they differ from each other.
*/
bool ObjectIdentifier::operator !=(const ObjectIdentifier &other) const
{
return !(operator==)(other);
}
/**
* @brief Compare object identifier with other.
* @param other Other object identifier.
* @return true if this object is less than the other.
*/
bool ObjectIdentifier::operator <(const ObjectIdentifier &other) const
{
if(owner < other.owner)
return true;
if(owner > other.owner)
return false;
return toString() < other.toString();
}
/**
* @brief Return number of components.
* @return Number of components in this identifier.
*/
int ObjectIdentifier::numComponents() const
{
return components.size();
}
/**
* @brief Compute number of sub components, i.e excluding the property.
* @return Number of components.
*/
int ObjectIdentifier::numSubComponents() const
{
ResolveResults result(*this);
return components.size() - result.propertyIndex;
}
bool ObjectIdentifier::verify(const App::Property &prop, bool silent) const {
ResolveResults result(*this);
if(components.size() - result.propertyIndex != 1) {
if(silent)
return false;
FC_THROWM(Base::ValueError,"Invalid property path: single component expected");
}
if(!components[result.propertyIndex].isSimple()) {
if(silent)
return false;
FC_THROWM(Base::ValueError,"Invalid property path: simple component expected");
}
const std::string &name = components[result.propertyIndex].getName();
CellAddress addr;
bool isAddress = addr.parseAbsoluteAddress(name.c_str());
if((isAddress && addr.toString(CellAddress::Cell::ShowRowColumn) != prop.getName()) ||
(!isAddress && name!=prop.getName()))
{
if(silent)
return false;
FC_THROWM(Base::ValueError,"Invalid property path: name mismatch");
}
return true;
}
/**
* @brief Create a string representation of this object identifier.
*
* An identifier is written as document#documentobject.property.subproperty1...subpropertyN
* document# may be dropped; it is assumed to be within owner's document. If documentobject is dropped,
* the property is assumed to be owned by the owner specified in the object identifiers constructor.
*
* @return A string
*/
const std::string &ObjectIdentifier::toString() const
{
if(!_cache.empty() || !owner)
return _cache;
std::ostringstream s;
ResolveResults result(*this);
if(result.propertyIndex >= (int)components.size())
return _cache;
if(localProperty ||
(result.resolvedProperty &&
result.resolvedDocumentObject==owner &&
components.size()>1 &&
components[1].isSimple() &&
result.propertyIndex==0))
{
s << '.';
}else if (documentNameSet && !documentName.getString().empty()) {
if(documentObjectNameSet && !documentObjectName.getString().empty())
s << documentName.toString() << "#"
<< documentObjectName.toString() << '.';
else if(!result.resolvedDocumentObjectName.getString().empty())
s << documentName.toString() << "#"
<< result.resolvedDocumentObjectName.toString() << '.';
} else if (documentObjectNameSet && !documentObjectName.getString().empty()) {
s << documentObjectName.toString() << '.';
} else if (result.propertyIndex > 0) {
components[0].toString(s);
s << '.';
}
if(!subObjectName.getString().empty())
s << subObjectName.toString() << '.';
s << components[result.propertyIndex].getName();
getSubPathStr(s,result);
const_cast<ObjectIdentifier*>(this)->_cache = s.str();
return _cache;
}
std::string ObjectIdentifier::toPersistentString() const {
if(!owner)
return std::string();
std::ostringstream s;
ResolveResults result(*this);
if(result.propertyIndex >= (int)components.size())
return std::string();
if(localProperty ||
(result.resolvedProperty &&
result.resolvedDocumentObject==owner &&
components.size()>1 &&
components[1].isSimple() &&
result.propertyIndex==0))
{
s << '.';
}else if(result.resolvedDocumentObject &&
result.resolvedDocumentObject!=owner &&
result.resolvedDocumentObject->isExporting())
{
s << result.resolvedDocumentObject->getExportName(true);
if(documentObjectName.isRealString())
s << '@';
s << '.';
} else if (documentNameSet && !documentName.getString().empty()) {
if(documentObjectNameSet && !documentObjectName.getString().empty())
s << documentName.toString() << "#"
<< documentObjectName.toString() << '.';
else if(!result.resolvedDocumentObjectName.getString().empty())
s << documentName.toString() << "#"
<< result.resolvedDocumentObjectName.toString() << '.';
} else if (documentObjectNameSet && !documentObjectName.getString().empty()) {
s << documentObjectName.toString() << '.';
} else if (result.propertyIndex > 0) {
components[0].toString(s);
s << '.';
}
if(!subObjectName.getString().empty()) {
const char *subname = subObjectName.getString().c_str();
std::string exportName;
s << String(PropertyLinkBase::exportSubName(exportName,
result.resolvedDocumentObject,subname),true).toString() << '.';
}
s << components[result.propertyIndex].getName();
getSubPathStr(s,result);
return s.str();
}
std::size_t ObjectIdentifier::hash() const
{
if(_hash && !_cache.empty())
return _hash;
const_cast<ObjectIdentifier*>(this)->_hash = boost::hash_value(toString());
return _hash;
}
bool ObjectIdentifier::replaceObject(ObjectIdentifier &res, const App::DocumentObject *parent,
App::DocumentObject *oldObj, App::DocumentObject *newObj) const
{
ResolveResults result(*this);
if(!result.resolvedDocumentObject)
return false;
auto r = PropertyLinkBase::tryReplaceLink(owner, result.resolvedDocumentObject,
parent, oldObj, newObj, subObjectName.getString().c_str());
if(!r.first)
return false;
res = *this;
if(r.first != result.resolvedDocumentObject) {
if(r.first->getDocument()!=owner->getDocument()) {
auto doc = r.first->getDocument();
bool useLabel = res.documentName.isRealString();
const char *name = useLabel?doc->Label.getValue():doc->getName();
res.setDocumentName(String(name, useLabel), true);
}
if(documentObjectName.isRealString())
res.documentObjectName = String(r.first->Label.getValue(),true);
else
res.documentObjectName = String(r.first->getNameInDocument(),false,true);
}
res.subObjectName = String(r.second,true);
res._cache.clear();
res.shadowSub.first.clear();
res.shadowSub.second.clear();
return true;
}
/**
* @brief Escape toString representation so it is suitable for being embedded in a python command.
* @return Escaped string.
*/
std::string ObjectIdentifier::toEscapedString() const
{
return Base::Tools::escapedUnicodeFromUtf8(toString().c_str());
}
bool ObjectIdentifier::updateLabelReference(
App::DocumentObject *obj, const std::string &ref, const char *newLabel)
{
if(!owner)
return false;
ResolveResults result(*this);
if(!subObjectName.getString().empty() && result.resolvedDocumentObject) {
std::string sub = PropertyLinkBase::updateLabelReference(
result.resolvedDocumentObject, subObjectName.getString().c_str(), obj,ref,newLabel);
if(!sub.empty()) {
subObjectName = String(sub,true);
_cache.clear();
return true;
}
}
if(result.resolvedDocument != obj->getDocument())
return false;
if(!documentObjectName.getString().empty()) {
if(documentObjectName.isForceIdentifier())
return false;
if(!documentObjectName.isRealString() &&
documentObjectName.getString()==obj->getNameInDocument())
return false;
if(documentObjectName.getString()!=obj->Label.getValue())
return false;
documentObjectName = ObjectIdentifier::String(newLabel, true);
_cache.clear();
return true;
}
if (result.resolvedDocumentObject==obj &&
result.propertyIndex == 1 &&
result.resolvedDocumentObjectName.isRealString() &&
result.resolvedDocumentObjectName.getString()==obj->Label.getValue())
{
components[0].name = ObjectIdentifier::String(newLabel, true);
_cache.clear();
return true;
}
// If object identifier uses the label then resolving the document object will fail.
// So, it must be checked if using the new label will succeed
if (components.size()>1 && components[0].getName()==obj->Label.getValue()) {
ObjectIdentifier id(*this);
id.components[0].name.str = newLabel;
ResolveResults result(id);
if (result.propertyIndex == 1 && result.resolvedDocumentObject == obj) {
components[0].name = id.components[0].name;
_cache.clear();
return true;
}
}
return false;
}
bool ObjectIdentifier::relabeledDocument(ExpressionVisitor &v,
const std::string &oldLabel, const std::string &newLabel)
{
if (documentNameSet && documentName.isRealString() && documentName.getString()==oldLabel) {
v.aboutToChange();
documentName = String(newLabel,true);
_cache.clear();
return true;
}
return false;
}
/**
* @brief Get sub field part of a property as a string.
* @return String representation of path.
*/
void ObjectIdentifier::getSubPathStr(std::ostream &s, const ResolveResults &result, bool toPython) const
{
std::vector<Component>::const_iterator i = components.begin() + result.propertyIndex + 1;
while (i != components.end()) {
if(i->isSimple())
s << '.';
i->toString(s,toPython);
++i;
}
}
std::string ObjectIdentifier::getSubPathStr(bool toPython) const {
std::ostringstream ss;
getSubPathStr(ss,ResolveResults(*this),toPython);
return ss.str();
}
/**
* @brief Construct a Component part
* @param _name Name of component
* @param _type Type; simple, array, range or map
* @param _begin Array index or beginning of a Range, or INT_MAX for other type.
* @param _end ending of a Range, or INT_MAX for other type.
*/
ObjectIdentifier::Component::Component(const String &_name,
ObjectIdentifier::Component::typeEnum _type, int _begin, int _end, int _step)
: name(_name)
, type(_type)
, begin(_begin)
, end(_end)
, step(_step)
{
}
ObjectIdentifier::Component::Component(String &&_name,
ObjectIdentifier::Component::typeEnum _type, int _begin, int _end, int _step)
: name(std::move(_name))
, type(_type)
, begin(_begin)
, end(_end)
, step(_step)
{
}
size_t ObjectIdentifier::Component::getIndex(size_t count) const {
if(begin>=0) {
if(begin<(int)count)
return begin;
}else {
int idx = begin + (int)count;
if(idx >= 0)
return idx;
}
FC_THROWM(Base::IndexError, "Array out of bound: " << begin << ", " << count);
}
Py::Object ObjectIdentifier::Component::get(const Py::Object &pyobj) const {
Py::Object res;
if(isSimple()) {
if(!pyobj.hasAttr(getName()))
FC_THROWM(Base::AttributeError, "No attribute named '" << getName() << "'");
res = pyobj.getAttr(getName());
} else if(isArray()) {
if(pyobj.isMapping())
res = Py::Mapping(pyobj).getItem(Py::Int(begin));
else
res = Py::Sequence(pyobj).getItem(begin);
}else if(isMap())
res = Py::Mapping(pyobj).getItem(getName());
else {
assert(isRange());
Py::Object slice(PySlice_New(Py::Int(begin).ptr(),
end!=INT_MAX?Py::Int(end).ptr():nullptr,
step!=1?Py::Int(step).ptr():nullptr),true);
PyObject *r = PyObject_GetItem(pyobj.ptr(),slice.ptr());
if(!r)
Base::PyException::ThrowException();
res = Py::asObject(r);
}
if(!res.ptr())
Base::PyException::ThrowException();
if(PyModule_Check(res.ptr()) && !ExpressionParser::isModuleImported(res.ptr()))
FC_THROWM(Base::RuntimeError, "Module '" << getName() << "' access denied.");
return res;
}
void ObjectIdentifier::Component::set(Py::Object &pyobj, const Py::Object &value) const {
if(isSimple()) {
if(PyObject_SetAttrString(*pyobj, getName().c_str(), *value ) == -1)
Base::PyException::ThrowException();
} else if(isArray()) {
if(pyobj.isMapping())
Py::Mapping(pyobj).setItem(Py::Int(begin),value);
else
Py::Sequence(pyobj).setItem(begin,value);
}else if(isMap())
Py::Mapping(pyobj).setItem(getName(),value);
else {
assert(isRange());
Py::Object slice(PySlice_New(Py::Int(begin).ptr(),
end!=INT_MAX?Py::Int(end).ptr():nullptr,
step!=1?Py::Int(step).ptr():nullptr),true);
if(PyObject_SetItem(pyobj.ptr(),slice.ptr(),value.ptr())<0)
Base::PyException::ThrowException();
}
}
void ObjectIdentifier::Component::del(Py::Object &pyobj) const {
if(isSimple())
pyobj.delAttr(getName());
else if(isArray()) {
if(pyobj.isMapping())
Py::Mapping(pyobj).delItem(Py::Int(begin));
else
PySequence_DelItem(pyobj.ptr(),begin);
} else if(isMap())
Py::Mapping(pyobj).delItem(getName());
else {
assert(isRange());
Py::Object slice(PySlice_New(Py::Int(begin).ptr(),
end!=INT_MAX?Py::Int(end).ptr():nullptr,
step!=1?Py::Int(step).ptr():nullptr),true);
if(PyObject_DelItem(pyobj.ptr(),slice.ptr())<0)
Base::PyException::ThrowException();
}
}
/**
* @brief Create a simple component part with the given name
* @param _component Name of component.
* @return A new Component object.
*/
ObjectIdentifier::Component ObjectIdentifier::Component::SimpleComponent(const char *_component)
{
return Component(String(_component));
}
/**
* @brief Create a simple component part with the given name
* @param _component Name of component.
* @return A new Component object.
*/
ObjectIdentifier::Component ObjectIdentifier::Component::SimpleComponent(const ObjectIdentifier::String &_component)
{
return Component(_component);
}
ObjectIdentifier::Component ObjectIdentifier::Component::SimpleComponent(ObjectIdentifier::String &&_component)
{
return Component(std::move(_component));
}
/**
* @brief Create an array component with given name and index.
* @param _component Name of component
* @param _index Index of component
* @return A new Component object.
*/
ObjectIdentifier::Component ObjectIdentifier::Component::ArrayComponent(int _index)
{
return Component(String(), Component::ARRAY, _index);
}
/**
* @brief Create a map component with given name and key.
* @param _component Name of component
* @param _key Key of component
* @return A new Component object.
*/
ObjectIdentifier::Component ObjectIdentifier::Component::MapComponent(const String & _key)
{
return Component(_key, Component::MAP);
}
ObjectIdentifier::Component ObjectIdentifier::Component::MapComponent(String &&_key)
{
return Component(std::move(_key), Component::MAP);
}
/**
* @brief Create a range component with given begin and end.
* @param _begin beginning index of the range
* @param _end ending index of the range
* @return A new Component object.
*/
ObjectIdentifier::Component ObjectIdentifier::Component::RangeComponent(int _begin, int _end, int _step)
{
return Component(String(), Component::RANGE, _begin, _end, _step);
}
/**
* @brief Comparison operator for Component objects.
* @param other The object we want to compare to.
* @return true if they are equal, false if not.
*/
bool ObjectIdentifier::Component::operator ==(const ObjectIdentifier::Component &other) const
{
if (type != other.type)
return false;
switch (type) {
case SIMPLE:
case MAP:
return name == other.name;
case ARRAY:
return begin == other.begin;
case RANGE:
return begin == other.begin && end == other.end && step==other.step;
default:
assert(0);
return false;
}
}
/**
* @brief Create a string representation of a component.
* @return A string representing the component.
*/
void ObjectIdentifier::Component::toString(std::ostream &ss, bool toPython) const
{
switch (type) {
case Component::SIMPLE:
ss << name.getString();
break;
case Component::MAP:
ss << "[" << name.toString(toPython) << "]";
break;
case Component::ARRAY:
ss << "[" << begin << "]";
break;
case Component::RANGE:
ss << '[';
if(begin!=INT_MAX)
ss << begin;
ss << ':';
if(end!=INT_MAX)
ss << end;
if(step!=1)
ss << ':' << step;
ss << ']';
break;
default:
assert(0);
}
}
enum ResolveFlags {
ResolveByIdentifier,
ResolveByLabel,
ResolveAmbiguous,
};
/**
* @brief Search for the document object given by name in doc.
*
* Name might be the internal name or a label. In any case, it must uniquely define
* the document object.
*
* @param doc Document to search
* @param name Name to search for.
* @return Pointer to document object if a unique pointer is found, 0 otherwise.
*/
App::DocumentObject * ObjectIdentifier::getDocumentObject(const App::Document * doc,
const String & name, std::bitset<32> &flags)
{
DocumentObject * objectById = nullptr;
DocumentObject * objectByLabel = nullptr;
if(!name.isRealString()) {
// No object found with matching label, try using name directly
objectById = doc->getObject(static_cast<const char*>(name));
if (objectById) {
flags.set(ResolveByIdentifier);
return objectById;
}
if(name.isForceIdentifier())
return nullptr;
}
std::vector<DocumentObject*> docObjects = doc->getObjects();
for (std::vector<DocumentObject*>::iterator j = docObjects.begin(); j != docObjects.end(); ++j) {
if (strcmp((*j)->Label.getValue(), static_cast<const char*>(name)) == 0) {
// Found object with matching label
if (objectByLabel) {
FC_WARN("duplicate object label " << doc->getName() << '#' << static_cast<const char*>(name));
return nullptr;
}
objectByLabel = *j;
}
}
if (!objectByLabel && !objectById) // Not found at all
return nullptr;
else if (!objectByLabel) { // Found by name
flags.set(ResolveByIdentifier);
return objectById;
}
else if (!objectById) { // Found by label
flags.set(ResolveByLabel);
return objectByLabel;
}
else if (objectByLabel == objectById) { // Found by both name and label, same object
flags.set(ResolveByIdentifier);
flags.set(ResolveByLabel);
return objectByLabel;
}
else {
flags.set(ResolveAmbiguous);
return nullptr; // Found by both name and label, two different objects
}
}
/**
* @brief Resolve the object identifier to a concrete document, documentobject, and property.
*
* This method is a helper method that fills out data in the given ResolveResults object.
*
*/
void ObjectIdentifier::resolve(ResolveResults &results) const
{
if(!owner)
return;
bool docAmbiguous = false;
/* Document name specified? */
if (!documentName.getString().empty()) {
results.resolvedDocument = getDocument(documentName,&docAmbiguous);
results.resolvedDocumentName = documentName;
}
else {
results.resolvedDocument = owner->getDocument();
results.resolvedDocumentName = String(results.resolvedDocument->getName(), false, true);
}
results.subObjectName = subObjectName;
results.propertyName = "";
results.propertyIndex = 0;
// Assume document name and object name from owner if not found
if (!results.resolvedDocument) {
if (!documentName.getString().empty()) {
if(docAmbiguous)
results.flags.set(ResolveAmbiguous);
return;
}
results.resolvedDocument = owner->getDocument();
if (!results.resolvedDocument)
return;
}
results.resolvedDocumentName = String(results.resolvedDocument->getName(), false, true);
/* Document object name specified? */
if (!documentObjectName.getString().empty()) {
results.resolvedDocumentObjectName = documentObjectName;
results.resolvedDocumentObject = getDocumentObject(
results.resolvedDocument, documentObjectName, results.flags);
if (!results.resolvedDocumentObject)
return;
if (components.empty())
return;
results.propertyName = components[ 0 ].name.getString();
results.propertyIndex = 0;
results.getProperty( *this );
}
else {
/* Document object name not specified, resolve from path */
/* One component? */
if (components.size() == 1 || (components.size()>1 && !components[0].isSimple())) {
/* Yes -- then this must be a property, so we get the document object's name from the owner */
results.resolvedDocumentObjectName = String(owner->getNameInDocument(), false, true);
results.resolvedDocumentObject = owner;
results.propertyName = components[0].name.getString();
results.propertyIndex = 0;
results.getProperty(*this);
}
else if (components.size() >= 2) {
/* No -- */
if (!components[0].isSimple())
return;
results.resolvedDocumentObject = getDocumentObject(
results.resolvedDocument, components[0].name, results.flags);
/* Possible to resolve component to a document object? */
if (results.resolvedDocumentObject) {
/* Yes */
results.resolvedDocumentObjectName = String {
components[0].name.getString(),
false,
results.flags.test(ResolveByIdentifier)};
results.propertyName = components[1].name.getString();
results.propertyIndex = 1;
results.getProperty(*this);
if(!results.resolvedProperty) {
// If the second component is not a property name, try to
// interpret the first component as the property name.
DocumentObject *sobj = nullptr;
results.resolvedProperty = resolveProperty(
owner,
components[0].name.toString().c_str(),
sobj,
results.propertyType);
if(results.resolvedProperty) {
results.propertyName = components[0].name.getString();
results.resolvedDocument = owner->getDocument();
results.resolvedDocumentName = String(results.resolvedDocument->getName(), false, true);
results.resolvedDocumentObjectName = String(owner->getNameInDocument(), false, true);
results.resolvedDocumentObject = owner;
results.resolvedSubObject = sobj;
results.propertyIndex = 0;
}
}
}
else if (documentName.getString().empty()) {
/* No, assume component is a property, and get document object's name from owner */
results.resolvedDocument = owner->getDocument();
results.resolvedDocumentName = String(results.resolvedDocument->getName(), false, true);
results.resolvedDocumentObjectName = String(owner->getNameInDocument(), false, true);
results.resolvedDocumentObject = owner->getDocument()->getObject(owner->getNameInDocument());