LibrePCB Developers Documentation
Loading...
Searching...
No Matches
workspacelibrarydb.h
Go to the documentation of this file.
1/*
2 * LibrePCB - Professional EDA for everyone!
3 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4 * https://librepcb.org/
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef LIBREPCB_CORE_WORKSPACELIBRARYDB_H
21#define LIBREPCB_CORE_WORKSPACELIBRARYDB_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "../attribute/attribute.h"
27#include "../attribute/attributetype.h"
28#include "../fileio/filepath.h"
29#include "../library/resource.h"
30#include "../types/uuid.h"
31#include "../types/version.h"
32
33#include <QtCore>
34
35/*******************************************************************************
36 * Namespace / Forward Declarations
37 ******************************************************************************/
38class QSqlQuery;
39
40namespace librepcb {
41
42class Component;
43class ComponentCategory;
44class Device;
45class Package;
46class PackageCategory;
47class SQLiteDatabase;
48class Symbol;
49class WorkspaceLibraryScanner;
50
51/*******************************************************************************
52 * Class WorkspaceLibraryDb
53 ******************************************************************************/
54
58class WorkspaceLibraryDb final : public QObject {
59 Q_OBJECT
60
61public:
62 struct Part {
63 QString mpn;
64 QString manufacturer;
66
67 bool operator==(const Part& rhs) const noexcept {
68 return (mpn == rhs.mpn) && (manufacturer == rhs.manufacturer) &&
69 (attributes == rhs.attributes);
70 }
71 bool operator<(const Part& rhs) const noexcept {
72 if (mpn.isEmpty() != rhs.mpn.isEmpty()) {
73 return mpn.count() < rhs.mpn.count();
74 }
75 if (mpn != rhs.mpn) {
76 return mpn < rhs.mpn;
77 }
78 if (manufacturer != rhs.manufacturer) {
79 return manufacturer < rhs.manufacturer;
80 }
81 QCollator collator;
82 collator.setNumericMode(true);
83 collator.setCaseSensitivity(Qt::CaseInsensitive);
84 collator.setIgnorePunctuation(false);
85 for (int i = 0; i < std::max(attributes.count(), rhs.attributes.count());
86 ++i) {
87 auto a = attributes.value(i);
88 auto b = rhs.attributes.value(i);
89 if (a && (!b)) {
90 return false;
91 } else if ((!a) && b) {
92 return true;
93 } else if (a->getKey() != b->getKey()) {
94 return a->getKey() < b->getKey();
95 } else if (&a->getType() != &b->getType()) {
96 return a->getType().getName() < b->getType().getName();
97 } else if (a->getValueTr(true) != b->getValueTr(true)) {
98 return collator(a->getValueTr(true), b->getValueTr(true));
99 }
100 }
101 return false;
102 }
103 };
104
105 // Constructors / Destructor
108
117 explicit WorkspaceLibraryDb(const FilePath& librariesPath);
118 ~WorkspaceLibraryDb() noexcept;
119
120 // Getters
121
127 const FilePath& getFilePath() const noexcept { return mFilePath; }
128
134 bool isScanInProgress() const noexcept {
135 return getScanProgressPercent() < 100;
136 }
137
143 int getScanProgressPercent() const noexcept;
144
156 template <typename ElementType>
158 const std::optional<Uuid>& uuid = std::nullopt,
159 const FilePath& lib = FilePath()) const {
160 return getAll(getTable<ElementType>(), uuid, lib);
161 }
162
172 template <typename ElementType>
173 FilePath getLatest(const Uuid& uuid) const {
174 return getLatestVersionFilePath(getAll<ElementType>(uuid));
175 }
176
186 template <typename ElementType>
187 QList<Uuid> find(const QString& keyword) const;
188
198 QList<Uuid> findDevicesOfParts(const QString& keyword) const;
199
210 QList<Part> findPartsOfDevice(const Uuid& device,
211 const QString& keyword) const;
212
233 template <typename ElementType>
234 bool getTranslations(const FilePath& elemDir, const QStringList& localeOrder,
235 QString* name = nullptr, QString* description = nullptr,
236 QString* keywords = nullptr) const {
237 return getTranslations(getTable<ElementType>(), elemDir, localeOrder, name,
238 description, keywords);
239 }
240
257 template <typename ElementType>
258 bool getMetadata(const FilePath elemDir, Uuid* uuid = nullptr,
259 Version* version = nullptr,
260 bool* deprecated = nullptr) const {
261 return getMetadata(getTable<ElementType>(), elemDir, uuid, version,
262 deprecated);
263 }
264
278 bool getLibraryMetadata(const FilePath libDir, QPixmap* icon = nullptr,
279 QString* manufacturer = nullptr) const;
280
293 template <typename ElementType>
294 bool getCategoryMetadata(const FilePath catDir,
295 std::optional<Uuid>* parent = nullptr) const {
296 static_assert(std::is_same<ElementType, ComponentCategory>::value ||
297 std::is_same<ElementType, PackageCategory>::value,
298 "Unsupported ElementType");
299 return getCategoryMetadata(getTable<ElementType>(), catDir, parent);
300 }
301
314 bool getDeviceMetadata(const FilePath& devDir, Uuid* cmpUuid = nullptr,
315 Uuid* pkgUuid = nullptr) const;
316
330 template <typename ElementType>
331 QSet<Uuid> getChilds(const std::optional<Uuid>& parent) const {
332 static_assert(std::is_same<ElementType, ComponentCategory>::value ||
333 std::is_same<ElementType, PackageCategory>::value,
334 "Unsupported ElementType");
335 return getChilds(getTable<ElementType>(), parent);
336 }
337
355 template <typename ElementType>
356 QSet<Uuid> getByCategory(const std::optional<Uuid>& category,
357 int limit = -1) const {
358 static_assert(std::is_same<ElementType, Symbol>::value ||
359 std::is_same<ElementType, Package>::value ||
360 std::is_same<ElementType, Component>::value ||
361 std::is_same<ElementType, Device>::value,
362 "Unsupported ElementType");
363 return getByCategory(getTable<ElementType>(),
364 getCategoryTable<ElementType>(), category, limit);
365 }
366
377 template <typename ElementType>
378 QSet<Uuid> getGenerated(const QString& generatedBy) const {
379 static_assert(std::is_same<ElementType, Symbol>::value ||
380 std::is_same<ElementType, Package>::value ||
381 std::is_same<ElementType, Component>::value ||
382 std::is_same<ElementType, Device>::value,
383 "Unsupported ElementType");
384 return getGenerated(getTable<ElementType>(), generatedBy);
385 }
386
396 template <typename ElementType>
397 ResourceList getResources(const FilePath elemDir) const {
398 static_assert(std::is_same<ElementType, Component>::value ||
399 std::is_same<ElementType, Device>::value,
400 "Unsupported ElementType");
401 return getResources(getTable<ElementType>(), elemDir);
402 }
403
411 QSet<Uuid> getComponentDevices(const Uuid& component) const;
412
420 QList<Part> getDeviceParts(const Uuid& device) const;
421
422 // General Methods
423
427 void startLibraryRescan() noexcept;
428
429 // Operator Overloadings
430 WorkspaceLibraryDb& operator=(const WorkspaceLibraryDb& rhs) = delete;
431
432signals:
434 void scanLibraryListUpdated(int libraryCount);
435 void scanProgressUpdate(int percent);
436 void scanSucceeded(int elementCount);
437 void scanFailed(QString errorMsg);
439
440private:
441 // Private Methods
442 QMultiMap<Version, FilePath> getAll(const QString& elementsTable,
443 const std::optional<Uuid>& uuid,
444 const FilePath& lib) const;
446 const QMultiMap<Version, FilePath>& list) const noexcept;
447 QList<Uuid> find(const QString& elementsTable, const QString& keyword) const;
448 bool getTranslations(const QString& elementsTable, const FilePath& elemDir,
449 const QStringList& localeOrder, QString* name,
450 QString* description, QString* keywords) const;
451 bool getMetadata(const QString& elementsTable, const FilePath elemDir,
452 Uuid* uuid, Version* version, bool* deprecated) const;
453 bool getCategoryMetadata(const QString& categoriesTable,
454 const FilePath catDir,
455 std::optional<Uuid>* parent) const;
456 AttributeList getPartAttributes(int partId) const;
457 QSet<Uuid> getChilds(const QString& categoriesTable,
458 const std::optional<Uuid>& categoryUuid) const;
459 QSet<Uuid> getByCategory(const QString& elementsTable,
460 const QString& categoryTable,
461 const std::optional<Uuid>& category,
462 int limit) const;
463 QSet<Uuid> getGenerated(const QString& elementsTable,
464 const QString& generatedBy) const;
465 ResourceList getResources(const QString& elementsTable,
466 const FilePath& elemDir) const;
467 static QSet<Uuid> getUuidSet(QSqlQuery& query);
468 int getDbVersion() const noexcept;
469 template <typename ElementType>
470 static QString getTable() noexcept;
471 template <typename ElementType>
472 static QString getCategoryTable() noexcept;
473
474 // Attributes
477 QScopedPointer<SQLiteDatabase> mDb;
479
480 // Constants
481 static const int sCurrentDbVersion = 7;
482};
483
484/*******************************************************************************
485 * End of File
486 ******************************************************************************/
487
488} // namespace librepcb
489
490#endif
This class represents absolute, well-formatted paths to files or directories.
Definition filepath.h:127
The SQLiteDatabase class.
Definition sqlitedatabase.h:43
int count() const noexcept
Definition serializableobjectlist.h:199
std::shared_ptr< T > value(int index) noexcept
Definition serializableobjectlist.h:254
The Uuid class is a replacement for QUuid to get UUID strings without {} braces.
Definition uuid.h:56
The Version class represents a version number in the format "1.42.7".
Definition version.h:58
The WorkspaceLibraryDb class.
Definition workspacelibrarydb.h:58
ResourceList getResources(const FilePath elemDir) const
Get resources of a specific library element.
Definition workspacelibrarydb.h:397
WorkspaceLibraryDb(const WorkspaceLibraryDb &other)=delete
QSet< Uuid > getGenerated(const QString &generatedBy) const
Get elements generated by a given "generated_by" identifier.
Definition workspacelibrarydb.h:378
bool getLibraryMetadata(const FilePath libDir, QPixmap *icon=nullptr, QString *manufacturer=nullptr) const
Get additional metadata of a specific library.
Definition workspacelibrarydb.cpp:198
void scanProgressUpdate(int percent)
static const int sCurrentDbVersion
Definition workspacelibrarydb.h:481
~WorkspaceLibraryDb() noexcept
Definition workspacelibrarydb.cpp:103
QMultiMap< Version, FilePath > getAll(const std::optional< Uuid > &uuid=std::nullopt, const FilePath &lib=FilePath()) const
Get elements, optionally matching some criteria.
Definition workspacelibrarydb.h:157
FilePath getLatestVersionFilePath(const QMultiMap< Version, FilePath > &list) const noexcept
Definition workspacelibrarydb.cpp:340
bool getDeviceMetadata(const FilePath &devDir, Uuid *cmpUuid=nullptr, Uuid *pkgUuid=nullptr) const
Get additional metadata of a specific device.
Definition workspacelibrarydb.cpp:222
void scanFailed(QString errorMsg)
QList< Uuid > find(const QString &keyword) const
Find elements by keyword.
Definition workspacelibrarydb.cpp:115
QScopedPointer< SQLiteDatabase > mDb
The SQLite database.
Definition workspacelibrarydb.h:477
void scanSucceeded(int elementCount)
const FilePath & getFilePath() const noexcept
Get the file path of the SQLite database.
Definition workspacelibrarydb.h:127
AttributeList getPartAttributes(int partId) const
Definition workspacelibrarydb.cpp:467
void scanLibraryListUpdated(int libraryCount)
FilePath getLatest(const Uuid &uuid) const
Get an element of a specific UUID and the highest version.
Definition workspacelibrarydb.h:173
QSet< Uuid > getChilds(const std::optional< Uuid > &parent) const
Get children categories of a specific category.
Definition workspacelibrarydb.h:331
bool getMetadata(const FilePath elemDir, Uuid *uuid=nullptr, Version *version=nullptr, bool *deprecated=nullptr) const
Get metadata of a specific element.
Definition workspacelibrarydb.h:258
static QString getTable() noexcept
Definition workspacelibrarydb.cpp:620
QList< Part > getDeviceParts(const Uuid &device) const
Get all parts of a specific device.
Definition workspacelibrarydb.cpp:260
QSet< Uuid > getByCategory(const std::optional< Uuid > &category, int limit=-1) const
Get elements of a specific category.
Definition workspacelibrarydb.h:356
void startLibraryRescan() noexcept
Rescan the whole library directory and update the SQLite database.
Definition workspacelibrarydb.cpp:283
bool getCategoryMetadata(const FilePath catDir, std::optional< Uuid > *parent=nullptr) const
Get additional metadata of a specific category.
Definition workspacelibrarydb.h:294
bool isScanInProgress() const noexcept
Check if there is currently a library scan in progress.
Definition workspacelibrarydb.h:134
static QString getCategoryTable() noexcept
Definition workspacelibrarydb.cpp:634
QScopedPointer< WorkspaceLibraryScanner > mLibraryScanner
Definition workspacelibrarydb.h:478
bool getTranslations(const FilePath &elemDir, const QStringList &localeOrder, QString *name=nullptr, QString *description=nullptr, QString *keywords=nullptr) const
Get translations of a specific element.
Definition workspacelibrarydb.h:234
int getScanProgressPercent() const noexcept
Get the current progress of the library rescan.
Definition workspacelibrarydb.cpp:110
static QSet< Uuid > getUuidSet(QSqlQuery &query)
Definition workspacelibrarydb.cpp:592
int getDbVersion() const noexcept
Definition workspacelibrarydb.cpp:600
QSet< Uuid > getComponentDevices(const Uuid &component) const
Get all devices of a specific component.
Definition workspacelibrarydb.cpp:249
const FilePath mLibrariesPath
Path to workspace libraries directory.
Definition workspacelibrarydb.h:475
const FilePath mFilePath
Path to the SQLite database file.
Definition workspacelibrarydb.h:476
QList< Uuid > findDevicesOfParts(const QString &keyword) const
Find parts by keyword.
Definition workspacelibrarydb.cpp:154
QList< Part > findPartsOfDevice(const Uuid &device, const QString &keyword) const
Find parts of device by keyword.
Definition workspacelibrarydb.cpp:176
The WorkspaceLibraryScanner class.
Definition workspacelibraryscanner.h:52
Definition occmodel.cpp:76
Definition uuid.h:186
Definition workspacelibrarydb.h:62
QString mpn
Definition workspacelibrarydb.h:63
bool operator==(const Part &rhs) const noexcept
Definition workspacelibrarydb.h:67
QString manufacturer
Definition workspacelibrarydb.h:64
bool operator<(const Part &rhs) const noexcept
Definition workspacelibrarydb.h:71
AttributeList attributes
Definition workspacelibrarydb.h:65