1 /************************************************************************
2 **
3 ** @file vcontainer.h
4 ** @author Roman Telezhynskyi <dismine(at)gmail.com>
5 ** @date November 15, 2013
6 **
7 ** @brief
8 ** @copyright
9 ** This source code is part of the Valentina project, a pattern making
10 ** program, whose allow create and modeling patterns of clothing.
11 ** Copyright (C) 2013-2015 Valentina project
12 ** <https://gitlab.com/smart-pattern/valentina> All Rights Reserved.
13 **
14 ** Valentina is free software: you can redistribute it and/or modify
15 ** it under the terms of the GNU General Public License as published by
16 ** the Free Software Foundation, either version 3 of the License, or
17 ** (at your option) any later version.
18 **
19 ** Valentina is distributed in the hope that it will be useful,
20 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ** GNU General Public License for more details.
23 **
24 ** You should have received a copy of the GNU General Public License
25 ** along with Valentina. If not, see <http://www.gnu.org/licenses/>.
26 **
27 *************************************************************************/
28
29 #ifndef VCONTAINER_H
30 #define VCONTAINER_H
31
32 #include <qcompilerdetection.h>
33 #include <QCoreApplication>
34 #include <QHash>
35 #include <QMap>
36 #include <QMessageLogger>
37 #include <QSet>
38 #include <QSharedPointer>
39 #include <QSharedData>
40 #include <QSharedDataPointer>
41 #include <QString>
42 #include <QStringList>
43 #include <QTypeInfo>
44 #include <QtGlobal>
45 #include <new>
46
47 #include "../vmisc/def.h"
48 #include "../ifc/exception/vexceptionbadid.h"
49 #include "../ifc/ifcdef.h"
50 #include "../vgeometry/vabstractcubicbezierpath.h"
51 #include "../vgeometry/vabstractcurve.h"
52 #include "../vgeometry/vgobject.h"
53 #include "../vmisc/diagnostic.h"
54 #include "variables.h"
55 #include "variables/vinternalvariable.h"
56 #include "vpiece.h"
57 #include "vpiecepath.h"
58 #include "vtranslatevars.h"
59
60 class VEllipticalArc;
61
62 QT_WARNING_PUSH
63 QT_WARNING_DISABLE_GCC("-Weffc++")
64 QT_WARNING_DISABLE_INTEL(2021)
65 QT_WARNING_DISABLE_GCC("-Wnon-virtual-dtor")
66
67 class VContainerData : public QSharedData //-V690
68 {
69 public:
70
VContainerData(const VTranslateVars * trVars,const Unit * patternUnit,const QString & nspace)71 VContainerData(const VTranslateVars *trVars, const Unit *patternUnit, const QString &nspace)
72 : calculationObjects(QHash<quint32, QSharedPointer<VGObject> >()),
73 modelingObjects(QSharedPointer<QHash<quint32, QSharedPointer<VGObject>>>::create()),
74 variables(QHash<QString, QSharedPointer<VInternalVariable> > ()),
75 pieces(QSharedPointer<QHash<quint32, VPiece>>::create()),
76 piecePaths(QSharedPointer<QHash<quint32, VPiecePath>>::create()),
77 trVars(trVars),
78 patternUnit(patternUnit),
79 nspace(nspace)
80 {}
81
VContainerData(const VContainerData & data)82 VContainerData(const VContainerData &data)
83 : QSharedData(data),
84 calculationObjects(data.calculationObjects),
85 modelingObjects(data.modelingObjects),
86 variables(data.variables),
87 pieces(data.pieces),
88 piecePaths(data.piecePaths),
89 trVars(data.trVars),
90 patternUnit(data.patternUnit),
91 nspace(data.nspace)
92 {}
93
94 virtual ~VContainerData();
95
96 QHash<quint32, QSharedPointer<VGObject> > calculationObjects;
97 QSharedPointer<QHash<quint32, QSharedPointer<VGObject>>> modelingObjects;
98
99 /**
100 * @brief variables container for measurements, increments, lines lengths, lines angles, arcs lengths, curve lengths
101 */
102 QHash<QString, QSharedPointer<VInternalVariable>> variables;
103
104 QSharedPointer<QHash<quint32, VPiece>> pieces;
105 QSharedPointer<QHash<quint32, VPiecePath>> piecePaths;
106
107 const VTranslateVars *trVars;
108 const Unit *patternUnit;
109
110 /** @brief nspace namespace for static variables */
111 QString nspace;
112
113 private:
114 Q_DISABLE_ASSIGN(VContainerData)
115 };
116
117 QT_WARNING_POP
118
119 /**
120 * @brief The VContainer class container of all variables.
121 */
122 class VContainer
123 {
124 Q_DECLARE_TR_FUNCTIONS(VContainer)
125 public:
126 VContainer(const VTranslateVars *trVars, const Unit *patternUnit, const QString &nspace);
127 VContainer(const VContainer &data);
128 ~VContainer();
129
130 friend class VContainerData;
131
132 VContainer &operator=(const VContainer &data);
133 #ifdef Q_COMPILER_RVALUE_REFS
134 VContainer(const VContainer &&data) Q_DECL_NOTHROW;
135 VContainer &operator=(VContainer &&data) Q_DECL_NOTHROW;
136 #endif
137
138 static QString UniqueNamespace();
139
140 template <typename T>
141 const QSharedPointer<T> GeometricObject(const quint32 &id) const;
142 const QSharedPointer<VGObject> GetGObject(quint32 id) const;
143 static const QSharedPointer<VGObject> GetFakeGObject(quint32 id);
144 VPiece GetPiece(quint32 id) const;
145 VPiecePath GetPiecePath(quint32 id) const;
146 quint32 GetPieceForPiecePath(quint32 id) const;
147 template <typename T>
148 QSharedPointer<T> GetVariable(const QString &name) const;
149 quint32 getId() const;
150 quint32 getNextId() const;
151 void UpdateId(quint32 newId) const;
152 static void UpdateId(quint32 newId, const QString &nspace);
153
154 void RegisterUniqueName(VGObject *obj) const;
155 void RegisterUniqueName(const QSharedPointer<VGObject> &obj) const;
156
157 quint32 AddGObject(VGObject *obj);
158 quint32 AddGObject(const QSharedPointer<VGObject> &obj);
159 quint32 AddPiece(const VPiece &detail);
160 quint32 AddPiecePath(const VPiecePath &path);
161 void AddLine(const quint32 &firstPointId, const quint32 &secondPointId);
162 void AddArc(const QSharedPointer<VAbstractCurve> &arc, const quint32 &id,
163 const quint32 &parentId = NULL_ID);
164 void AddSpline(const QSharedPointer<VAbstractBezier> &curve, quint32 id, quint32 parentId = NULL_ID);
165 void AddCurveWithSegments(const QSharedPointer<VAbstractCubicBezierPath> &curve, const quint32 &id,
166 quint32 parentId = NULL_ID);
167
168 template <typename T>
169 void AddUniqueVariable(T *var);
170 template <typename T>
171 void AddUniqueVariable(const QSharedPointer<T> &var);
172 template <typename T>
173 void AddVariable(T *var);
174 template <typename T>
175 void AddVariable(const QSharedPointer<T> &var);
176 void RemoveVariable(const QString& name);
177 void RemovePiece(quint32 id);
178
179 template <class T>
180 void UpdateGObject(quint32 id, T* obj);
181 template <class T>
182 void UpdateGObject(quint32 id, const QSharedPointer<T> &obj);
183 void UpdatePiece(quint32 id, const VPiece &detail);
184 void UpdatePiecePath(quint32 id, const VPiecePath &path);
185
186 void Clear();
187 void ClearForFullParse();
188 void ClearGObjects();
189 void ClearCalculationGObjects();
190 void ClearVariables(const VarType &type = VarType::Unknown);
191 void ClearVariables(const QVector<VarType> &types);
192 void ClearUniqueNames() const;
193 void ClearUniqueIncrementNames() const;
194 void ClearExceptUniqueIncrementNames() const;
195
196 void RemoveIncrement(const QString& name);
197
198 const QHash<quint32, QSharedPointer<VGObject> > *CalculationGObjects() const;
199 const QHash<quint32, VPiece> *DataPieces() const;
200 const QHash<QString, QSharedPointer<VInternalVariable>> *DataVariables() const;
201
202 const QMap<QString, QSharedPointer<VMeasurement> > DataMeasurements() const;
203 const QMap<QString, QSharedPointer<VIncrement> > DataIncrements() const;
204 const QMap<QString, QSharedPointer<VIncrement> > DataIncrementsWithSeparators() const;
205 const QMap<QString, QSharedPointer<VLengthLine> > DataLengthLines() const;
206 const QMap<QString, QSharedPointer<VCurveLength> > DataLengthCurves() const;
207 const QMap<QString, QSharedPointer<VCurveCLength> > DataCurvesCLength() const;
208 const QMap<QString, QSharedPointer<VLineAngle> > DataAngleLines() const;
209 const QMap<QString, QSharedPointer<VArcRadius> > DataRadiusesArcs() const;
210 const QMap<QString, QSharedPointer<VCurveAngle> > DataAnglesCurves() const;
211
212 bool IsUnique(const QString &name) const;
213 static bool IsUnique(const QString &name, const QString &nspace);
214
215 QStringList AllUniqueNames() const;
216 static QStringList AllUniqueNames(const QString &nspace);
217
218 const Unit *GetPatternUnit() const;
219 const VTranslateVars *GetTrVars() const;
220
221 private:
222 /**
223 * @brief _id current id. New object will have value +1. For empty class equal 0.
224 */
225 static QMap<QString, quint32> _id;
226 static QMap<QString, QSet<QString>> uniqueNames;
227 static QMap<QString, quint32> copyCounter;
228
229 QSharedDataPointer<VContainerData> d;
230
231 void AddCurve(const QSharedPointer<VAbstractCurve> &curve, const quint32 &id, quint32 parentId = NULL_ID);
232
233 template <typename T>
234 void AddVariable(const QSharedPointer<T> &var, const QString &name);
235
236 template <class T>
237 uint qHash( const QSharedPointer<T> &p );
238
239 template <typename T>
240 void UpdateObject(const quint32 &id, const QSharedPointer<T> &point);
241
242 template <typename T>
243 const QMap<QString, QSharedPointer<T> > DataVar(const VarType &type) const;
244
245 static void ClearNamespace(const QString &nspace);
246 };
247
248 Q_DECLARE_TYPEINFO(VContainer, Q_MOVABLE_TYPE);
249
250 /*
251 * Defintion of templated member functions of VContainer
252 */
253
254 //---------------------------------------------------------------------------------------------------------------------
255 template <typename T>
GeometricObject(const quint32 & id)256 const QSharedPointer<T> VContainer::GeometricObject(const quint32 &id) const
257 {
258 if (id == NULL_ID)
259 {
260 throw VExceptionBadId(tr("Can't find object"), id);
261 }
262
263 QSharedPointer<VGObject> gObj;
264 if (d->calculationObjects.contains(id))
265 {
266 gObj = d->calculationObjects.value(id);
267 }
268 else if (d->modelingObjects->contains(id))
269 {
270 gObj = d->modelingObjects->value(id);
271 }
272 else
273 {
274 throw VExceptionBadId(tr("Can't find object"), id);
275 }
276
277 QSharedPointer<T> obj = qSharedPointerDynamicCast<T>(gObj);
278 SCASSERT(obj.isNull() == false)
279 return obj;
280 }
281
282
283 //---------------------------------------------------------------------------------------------------------------------
284 /**
285 * @brief GetVariable return varible by name
286 * @param name variable's name
287 * @return variable
288 */
289 template <typename T>
GetVariable(const QString & name)290 QSharedPointer<T> VContainer::GetVariable(const QString &name) const
291 {
292 SCASSERT(name.isEmpty()==false)
293 if (d->variables.contains(name))
294 {
295 try
296 {
297 QSharedPointer<T> value = qSharedPointerDynamicCast<T>(d->variables.value(name));
298 SCASSERT(value.isNull() == false)
299 return value;
300 }
301 catch (const std::bad_alloc &)
302 {
303 throw VExceptionBadId(tr("Can't cast object"), name);
304 }
305 }
306 else
307 {
308 throw VExceptionBadId(tr("Can't find object"), name);
309 }
310 }
311
312 //---------------------------------------------------------------------------------------------------------------------
313 template <typename T>
AddUniqueVariable(T * var)314 void VContainer::AddUniqueVariable(T *var)
315 {
316 AddUniqueVariable(QSharedPointer<T>(var));
317 }
318
319 //---------------------------------------------------------------------------------------------------------------------
320 template <typename T>
AddUniqueVariable(const QSharedPointer<T> & var)321 void VContainer::AddUniqueVariable(const QSharedPointer<T> &var)
322 {
323 AddVariable(var);
324
325 if (d->variables.contains(var->GetName()))
326 {
327 uniqueNames[d->nspace].insert(var->GetName());
328 }
329 }
330
331 //---------------------------------------------------------------------------------------------------------------------
332 template <typename T>
AddVariable(T * var)333 void VContainer::AddVariable(T *var)
334 {
335 AddVariable(QSharedPointer<T>(var));
336 }
337
338 //---------------------------------------------------------------------------------------------------------------------
339 template <typename T>
AddVariable(const QSharedPointer<T> & var)340 void VContainer::AddVariable(const QSharedPointer<T> &var)
341 {
342 SCASSERT(not var->GetName().isEmpty())
343 AddVariable(var, var->GetName());
344
345 if (not var->GetAlias().isEmpty())
346 {
347 AddVariable(var, var->GetAlias());
348 }
349 }
350
351 //---------------------------------------------------------------------------------------------------------------------
352 template <typename T>
AddVariable(const QSharedPointer<T> & var,const QString & name)353 void VContainer::AddVariable(const QSharedPointer<T> &var, const QString &name)
354 {
355 if (name.isEmpty())
356 {
357 return;
358 }
359
360 if (d->variables.contains(name))
361 {
362 if (d->variables.value(name)->GetType() == var->GetType())
363 {
364 QSharedPointer<T> v = qSharedPointerDynamicCast<T>(d->variables.value(name));
365 if (v.isNull())
366 {
367 throw VExceptionBadId(tr("Can't cast object."), name);
368 }
369 *v = *var;
370 }
371 else
372 {
373 throw VExceptionBadId(tr("Can't find object. Type mismatch."), name);
374 }
375 }
376 else
377 {
378 d->variables.insert(name, var);
379 }
380 }
381
382 //---------------------------------------------------------------------------------------------------------------------
383 template <class T>
qHash(const QSharedPointer<T> & p)384 uint VContainer::qHash( const QSharedPointer<T> &p )
385 {
386 return qHash( p.data() );
387 }
388
389 //---------------------------------------------------------------------------------------------------------------------
390 /**
391 * @brief UpdateGObject update GObject by id
392 * @param id id of existing GObject
393 * @param obj object
394 */
395 template <class T>
UpdateGObject(quint32 id,T * obj)396 void VContainer::UpdateGObject(quint32 id, T* obj)
397 {
398 SCASSERT(obj != nullptr)
399 UpdateGObject(id, QSharedPointer<T>(obj));
400 }
401
402 //---------------------------------------------------------------------------------------------------------------------
403 template <class T>
UpdateGObject(quint32 id,const QSharedPointer<T> & obj)404 void VContainer::UpdateGObject(quint32 id, const QSharedPointer<T> &obj)
405 {
406 SCASSERT(not obj.isNull())
407 UpdateObject(id, obj);
408 RegisterUniqueName(obj);
409 }
410
411 //---------------------------------------------------------------------------------------------------------------------
412 /**
413 * @brief UpdateObject update object in container
414 * @param id id of existing object
415 * @param point object
416 */
417 template <typename T>
UpdateObject(const quint32 & id,const QSharedPointer<T> & point)418 void VContainer::UpdateObject(const quint32 &id, const QSharedPointer<T> &point)
419 {
420 Q_ASSERT_X(id != NULL_ID, Q_FUNC_INFO, "id == 0"); //-V654 //-V712
421 SCASSERT(point.isNull() == false)
422 point->setId(id);
423
424 if (d->calculationObjects.contains(id) && point->getMode() == Draw::Calculation)
425 {
426 QSharedPointer<T> obj = qSharedPointerDynamicCast<T>(d->calculationObjects.value(id));
427 if (obj.isNull())
428 {
429 throw VExceptionBadId(tr("Can't cast object"), id);
430 }
431 *obj = *point;
432 }
433 else if (d->modelingObjects->contains(id) && point->getMode() == Draw::Modeling)
434 {
435 QSharedPointer<T> obj = qSharedPointerDynamicCast<T>(d->modelingObjects->value(id));
436 if (obj.isNull())
437 {
438 throw VExceptionBadId(tr("Can't cast object"), id);
439 }
440 *obj = *point;
441 }
442 else if (point->getMode() == Draw::Calculation)
443 {
444 d->calculationObjects.insert(id, point);
445 }
446 else if (point->getMode() == Draw::Modeling)
447 {
448 d->modelingObjects->insert(id, point);
449 }
450 else
451 {
452 qWarning("Can't update an object with mode 'Layout'");
453 return;
454 }
455
456 UpdateId(id);
457 }
458 #endif // VCONTAINER_H
459