File: elementscollectionmodel.cpp

package info (click to toggle)
qelectrotech 1%3A0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 91,680 kB
  • sloc: cpp: 62,335; xml: 750; sh: 264; perl: 258; makefile: 6
file content (592 lines) | stat: -rw-r--r-- 18,079 bytes parent folder | download
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
/*
	Copyright 2006-2019 The QElectroTech Team
	This file is part of QElectroTech.

	QElectroTech is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	QElectroTech 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 General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#include "elementscollectionmodel.h"
#include "elementcollectionitem.h"
#include "fileelementcollectionitem.h"
#include "xmlprojectelementcollectionitem.h"
#include "qetapp.h"
#include "xmlelementcollection.h"
#include "qetproject.h"
#include "elementcollectionhandler.h"

#include <QtConcurrent>

/**
 * @brief ElementsCollectionModel::ElementsCollectionModel
 * Constructor
 * @param parent
 */
ElementsCollectionModel::ElementsCollectionModel(QObject *parent) :
	QStandardItemModel(parent)
{
}

/**
 * @brief ElementsCollectionModel::data
 * Reimplemented from QStandardItemModel
 * @param index
 * @param role
 * @return
 */
QVariant ElementsCollectionModel::data(const QModelIndex &index, int role) const
{
	if (role == Qt::DecorationRole) {
		QStandardItem *item = itemFromIndex(index);

		if (item->type() == FileElementCollectionItem::Type)
			static_cast<FileElementCollectionItem*>(item)->setUpIcon();
		else if (item->type() == XmlProjectElementCollectionItem::Type)
			static_cast<XmlProjectElementCollectionItem*>(item)->setUpIcon();
	}

	return QStandardItemModel::data(index, role);
}

/**
 * @brief ElementsCollectionModel::mimeData
 * Reimplemented from QStandardItemModel
 * @param indexes
 * @return
 */
QMimeData *ElementsCollectionModel::mimeData(const QModelIndexList &indexes) const
{
	QModelIndex index = indexes.first();
	if (index.isValid())
	{
		ElementCollectionItem *item = static_cast<ElementCollectionItem*>(itemFromIndex(index));

		QMimeData *mime_data = new QMimeData();
		mime_data->setText(item->collectionPath());

		if (item->isElement())
			mime_data->setData("application/x-qet-element-uri", item->collectionPath().toLatin1());
		else
			mime_data->setData("application/x-qet-category-uri", item->collectionPath().toLatin1());

		return mime_data;
	}
	else
		return new QMimeData();
}

/**
 * @brief ElementsCollectionModel::mimeTypes
 * Reimplemented from QStandardItemModel
 * @return
 */
QStringList ElementsCollectionModel::mimeTypes() const
{
	QStringList mime_list = QAbstractItemModel::mimeTypes();
	mime_list << "application/x-qet-element-uri" << "application/x-qet-category-uri";
	return mime_list;
}

/**
 * @brief ElementsCollectionModel::canDropMimeData
 * Reimplemented from QStandardItemModel
 * @param data
 * @param action
 * @param row
 * @param column
 * @param parent
 * @return
 */
bool ElementsCollectionModel::canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
{
	if (!(QStandardItemModel::canDropMimeData(data, action, row, column, parent) && parent.isValid()))
		return false;

	QStandardItem *qsi = itemFromIndex(parent.child(row, column));
	if (!qsi)
		qsi = itemFromIndex(parent);

		//Drop in the common collection is forbiden
	if (qsi->type() == FileElementCollectionItem::Type)
		if (static_cast<FileElementCollectionItem *>(qsi)->isCommonCollection())
			return false;

	ElementCollectionItem *eci = static_cast<ElementCollectionItem *>(qsi);

	if (data->hasFormat("application/x-qet-element-uri") || data->hasFormat("application/x-qet-category-uri"))
	{
			//Return false if user try to drop a item from a folder to the same folder
		ElementsLocation drop_location(data->text());
		for (int i=0 ; i<eci->rowCount() ; i++)
			if (static_cast<ElementCollectionItem *>(eci->child(i))->collectionPath() == drop_location.collectionPath())
				return false;

		return true;
	}
	else
		return false;
}

/**
 * @brief ElementsCollectionModel::dropMimeData
 * Reimplemented from QStandardItemModel
 * @param data
 * @param action
 * @param row
 * @param column
 * @param parent
 * @return
 */
bool ElementsCollectionModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
{
	Q_UNUSED(action);

	QStandardItem *qsi = itemFromIndex(parent.child(row, column));
	if (!qsi)
		qsi = itemFromIndex(parent);

	if (qsi->type() == FileElementCollectionItem::Type)
	{
		FileElementCollectionItem *feci = static_cast<FileElementCollectionItem *>(qsi);

		if (feci->isCommonCollection())
			return false;

		if (feci->isElement() && feci->parent() && feci->parent()->type() == FileElementCollectionItem::Type)
			feci = static_cast<FileElementCollectionItem *>(feci->parent());

		ElementCollectionHandler ech;

		ElementsLocation source(data->text());
		ElementsLocation destination(feci->fileSystemPath());
		ElementsLocation location = ech.copy(source, destination);

		if (location.exist())
		{
				//If feci have a child with the same path of location,
				//we remove the existing child befor insert new child
			for (int i=0 ; i<feci->rowCount() ; i++) {
				if (static_cast<FileElementCollectionItem *>(feci->child(i))->collectionPath() == location.collectionPath())
					feci->removeRow(i);
			}
			feci->addChildAtPath(location.fileName());
			return true;
		}

		return false;
	}
	else if (qsi->type() == XmlProjectElementCollectionItem::Type) {
		XmlProjectElementCollectionItem *xpeci = static_cast<XmlProjectElementCollectionItem*>(qsi);

		if (xpeci->isElement() && xpeci->parent() && xpeci->parent()->type() == XmlProjectElementCollectionItem::Type)
			xpeci = static_cast<XmlProjectElementCollectionItem *>(xpeci->parent());

			//before do the copy, we get all collection path of xpeci child,
			//for remove it if the copied item have the same path of an existing child.
			//We can't do this after the copy, because at the copy if the xml collection have a DomElement with the same path,
			//he was removed before the new xml DomElement is inserted
			//So the existing child of this will return a null QString when call collectionPath(), because the item
			//doesn't exist anymore in the xml collection.
		QList <QString> child_path_list;
		for (int i=0 ; i<xpeci->rowCount() ; i++)
			child_path_list.append(static_cast<XmlProjectElementCollectionItem *>(xpeci->child(i, 0))->collectionPath());

		ElementCollectionHandler ech;

		ElementsLocation source(data->text());
		ElementsLocation destination(xpeci->collectionPath());
		ElementsLocation location = ech.copy(source, destination);

		return location.exist();
	}

	return false;
}

/**
 * @brief ElementsCollectionModel::loadCollections
 * Load the several collections in this model.
 * Prefer use this method instead of addCommonCollection, addCustomCollection and addProject,
 * because it use multithreading to speed up the loading.
 * This method emit loadingMaxValue(int) for know the maximum progress value
 * This method emit loadingProgressValue(int) for know the current progress value
 * @param common_collection : true for load the common collection
 * @param custom_collection : true for load the custom collection
 * @param projects : list of projects to load
 */
void ElementsCollectionModel::loadCollections(bool common_collection, bool custom_collection, QList<QETProject *> projects)
{
	QList <ElementCollectionItem *> list;

	if (common_collection)
		addCommonCollection(false);
	if (custom_collection)
		addCustomCollection(false);

	if (common_collection || custom_collection)
		list.append(items());


	foreach (QETProject *project, projects) {
		addProject(project, false);
		list.append(projectItems(project));
	}

	QFuture<void> futur = QtConcurrent::map(list, setUpData);
	emit loadingMaxValue(futur.progressMaximum());
	while (futur.isRunning()) {
		emit loadingProgressValue(futur.progressValue());
	}
}

/**
 * @brief ElementsCollectionModel::addCommonCollection
 * Add the common elements collection to this model
 */
void ElementsCollectionModel::addCommonCollection(bool set_data)
{
	FileElementCollectionItem *feci = new FileElementCollectionItem();
	if (feci->setRootPath(QETApp::commonElementsDirN(), set_data, m_hide_element)) {
		invisibleRootItem()->appendRow(feci);
		if (set_data)
			feci->setUpData();
	}
	else
		delete feci;
}

/**
 * @brief ElementsCollectionModel::addCustomCollection
 * Add the custom elements collection to this model
 */
void ElementsCollectionModel::addCustomCollection(bool set_data)
{
	FileElementCollectionItem *feci = new FileElementCollectionItem();
	if (feci->setRootPath(QETApp::customElementsDirN(), set_data, m_hide_element)) {
		invisibleRootItem()->appendRow(feci);
		if (set_data)
			feci->setUpData();
	}
	else
		delete feci;
}

/**
 * @brief ElementsCollectionModel::addLocation
 * Add the element or directory to this model.
 * If the location is already managed by this model, do nothing.
 * @param location
 */
void ElementsCollectionModel::addLocation(const ElementsLocation& location)
{
	QModelIndex index = indexFromLocation(location);
	if (index.isValid())
		return;

	ElementCollectionItem *last_item = nullptr;
	QString collection_name;

	if (location.isProject()) {
		QETProject *project = location.project();

		if (project) {
			XmlProjectElementCollectionItem *xpeci = m_project_hash.value(project);

			last_item = xpeci->lastItemForPath(location.collectionPath(false), collection_name);
		}
	}
	else if (location.isCustomCollection()) {
		QList <ElementCollectionItem *> child_list;

		for (int i=0 ; i<rowCount() ; i++)
			child_list.append(static_cast<ElementCollectionItem *>(item(i)));

		foreach(ElementCollectionItem *eci, child_list) {

			if (eci->type() == FileElementCollectionItem::Type) {
				FileElementCollectionItem *feci = static_cast<FileElementCollectionItem *>(eci);

				if (feci->isCustomCollection()) {
					last_item = feci->lastItemForPath(location.collectionPath(false), collection_name);
					if(last_item)
						break;
				}
			}
		}
	}

	if (last_item)
		last_item->addChildAtPath(collection_name);
}

/**
 * @brief ElementsCollectionModel::addProject
 * Add project to this model
 * @param project : project to add.
 * @param set_data : if true, setUpData is called for every ElementCollectionItem of project
 */
void ElementsCollectionModel::addProject(QETProject *project, bool set_data)
{
	if (m_project_list.contains(project))
		return;

	m_project_list.append(project);
	int row = m_project_list.indexOf(project);
	XmlProjectElementCollectionItem *xpeci = new XmlProjectElementCollectionItem();
	m_project_hash.insert(project, xpeci);

	xpeci->setProject(project, set_data);
	insertRow(row, xpeci);
	if (set_data)
		xpeci->setUpData();
	connect(project->embeddedElementCollection(), &XmlElementCollection::elementAdded, this, &ElementsCollectionModel::elementIntegratedToCollection);
	connect(project->embeddedElementCollection(), &XmlElementCollection::elementChanged, this, &ElementsCollectionModel::updateItem);
	connect(project->embeddedElementCollection(), &XmlElementCollection::elementRemoved, this, &ElementsCollectionModel::itemRemovedFromCollection);
	connect(project->embeddedElementCollection(), &XmlElementCollection::directoryRemoved, this, &ElementsCollectionModel::itemRemovedFromCollection);
}

/**
 * @brief ElementsCollectionModel::removeProject
 * Remove project from this model
 * @param project
 */
void ElementsCollectionModel::removeProject(QETProject *project)
{
	if (!m_project_list.contains(project))
		return;

	int row = m_project_list.indexOf(project);
	if (removeRows(row, 1, QModelIndex())) {
		m_project_list.removeOne(project);
		m_project_hash.remove(project);
		disconnect(project->embeddedElementCollection(), &XmlElementCollection::elementAdded, this, &ElementsCollectionModel::elementIntegratedToCollection);
		disconnect(project->embeddedElementCollection(), &XmlElementCollection::elementChanged, this, &ElementsCollectionModel::updateItem);
		disconnect(project->embeddedElementCollection(), &XmlElementCollection::elementRemoved, this, &ElementsCollectionModel::itemRemovedFromCollection);
		disconnect(project->embeddedElementCollection(), &XmlElementCollection::directoryRemoved, this, &ElementsCollectionModel::itemRemovedFromCollection);
	}
}

/**
 * @brief ElementsCollectionModel::project
 * @return every project added to this model
 */
QList<QETProject *> ElementsCollectionModel::project() const
{
	return m_project_list;
}

/**
 * @brief ElementsCollectionModel::highlightUnusedElement
 * Highlight every unused element of managed project.
 * @See QETProject::unusedElements()
 */
void ElementsCollectionModel::highlightUnusedElement()
{
	QList <ElementsLocation> unused;

	foreach (QETProject *project, m_project_list)
		unused.append(project->unusedElements());

	QBrush brush;
	brush.setStyle(Qt::Dense4Pattern);
	brush.setColor(Qt::red);

	foreach (ElementsLocation location, unused) {
		QModelIndex index = indexFromLocation(location);
		if (index.isValid()) {
			QStandardItem *qsi = itemFromIndex(index);
			if (qsi)
				qsi->setBackground(brush);
		}
	}
}

/**
 * @brief ElementsCollectionModel::items
 * @return every ElementCollectionItem owned by this model
 */
QList <ElementCollectionItem *> ElementsCollectionModel::items() const
{
	QList <ElementCollectionItem *> list;

	for (int i=0 ; i<rowCount() ; i++) {
		ElementCollectionItem *eci = static_cast<ElementCollectionItem *>(item(i));
		list.append(eci);
		list.append(eci->items());
	}

	return list;
}

/**
 * @brief ElementsCollectionModel::projectItems
 * @param project
 * @return return all items for project @project. the list can be empty
 */
QList<ElementCollectionItem *> ElementsCollectionModel::projectItems(QETProject *project) const
{
	QList <ElementCollectionItem *> list;

	if (m_project_list.contains(project)) {
		ElementCollectionItem *eci = m_project_hash.value(project);
		list.append(eci);
		list.append(eci->items());
	}

	return list;
}

/**
 * @brief ElementsCollectionModel::hideElement
 * Hide element in this model, only directory is managed
 */
void ElementsCollectionModel::hideElement()
{
	m_hide_element = true;
	foreach(ElementCollectionItem *eci, items()) {
		if (eci->isElement()) {
			removeRow(eci->row(), indexFromItem(eci).parent());
		}
	}
}

/**
 * @brief ElementsCollectionModel::indexFromLocation
 * Return the index who represent @location.
 * Index can be non valid
 * @param location
 * @return
 */
QModelIndex ElementsCollectionModel::indexFromLocation(const ElementsLocation &location)
{
	QList <ElementCollectionItem *> child_list;

	for (int i=0 ; i<rowCount() ; i++)
		child_list.append(static_cast<ElementCollectionItem *>(item(i)));

		foreach(ElementCollectionItem *eci, child_list) {

			ElementCollectionItem *match_eci = nullptr;

			if (eci->type() == FileElementCollectionItem::Type) {
				if (FileElementCollectionItem *feci = static_cast<FileElementCollectionItem *>(eci)) {
					if ( (location.isCommonCollection() && feci->isCommonCollection()) ||
						 (location.isCustomCollection() && !feci->isCommonCollection()) ) {
						match_eci = feci->itemAtPath(location.collectionPath(false));
					}
				}
			}
			else if (eci->type() == XmlProjectElementCollectionItem::Type) {
				if (XmlProjectElementCollectionItem *xpeci = static_cast<XmlProjectElementCollectionItem *>(eci)) {
					match_eci = xpeci->itemAtPath(location.collectionPath(false));
				}
			}

			if (match_eci)
				return indexFromItem(match_eci);
		}

		return QModelIndex();
}

/**
 * @brief ElementsCollectionModel::elementIntegratedToCollection
 * When an element is added to embedded collection of a project,
 * this method create and display the new element
 * @param path -The path of the new element in the embedded collection of a project
 */
void ElementsCollectionModel::elementIntegratedToCollection(const QString& path)
{
	QObject *object = sender();
	XmlElementCollection *collection = static_cast<XmlElementCollection *> (object);
	if (!collection)
		return;

	QETProject *project = nullptr;

		//Get the owner project of the collection
	foreach (QETProject *prj, m_project_list) {
		if (prj->embeddedElementCollection() == collection) {
			project = prj;
		}
	}

	if (project) {
		XmlProjectElementCollectionItem *xpeci = m_project_hash.value(project);

		QString collection_name;
		ElementCollectionItem *eci = xpeci->lastItemForPath(path, collection_name);
		if (!eci)
			return;

		eci->addChildAtPath(collection_name);
	}
}

/**
 * @brief ElementsCollectionModel::itemRemovedFromCollection
 * This method must be called by a signal, to get a sender.
 * @param path
 */
void ElementsCollectionModel::itemRemovedFromCollection(const QString& path)
{
	QObject *object = sender();
	XmlElementCollection *collection = static_cast<XmlElementCollection *> (object);
	if (!collection)
		return;

	QETProject *project = nullptr;

		//Get the owner project of the collection
	foreach (QETProject *prj, m_project_list) {
		if (prj->embeddedElementCollection() == collection) {
			project = prj;
		}
	}

	if (project) {
		QModelIndex index = indexFromLocation(ElementsLocation(path, project));
		if (index.isValid())
			removeRow(index.row(), index.parent());
	}
}

/**
 * @brief ElementsCollectionModel::updateItem
 * Update the item at path
 * @param path
 */
void ElementsCollectionModel::updateItem(const QString& path)
{
	QObject *object = sender();
	XmlElementCollection *collection = static_cast<XmlElementCollection *> (object);
	if (!collection)
		return;

	QETProject *project = nullptr;

		//Get the owner project of the collection
	foreach (QETProject *prj, m_project_list) {
		if (prj->embeddedElementCollection() == collection) {
			project = prj;
		}
	}

	if (project) {
		ElementCollectionItem *eci = m_project_hash.value(project)->itemAtPath(path);
		if (!eci)
			return;

		eci->clearData();
		eci->setUpData();
	}
}