#include <workspacelibrarydb.h>

Inherits QObject.

Collaboration diagram for WorkspaceLibraryDb:

Classes
struct	Part

Signals
void	scanStarted ()

void	scanLibraryListUpdated (int libraryCount)

void	scanProgressUpdate (int percent)

void	scanSucceeded (int elementCount)

void	scanFailed (QString errorMsg)

void	scanFinished ()

Public Member Functions
	WorkspaceLibraryDb ()=delete

	WorkspaceLibraryDb (const WorkspaceLibraryDb &other)=delete

	WorkspaceLibraryDb (const FilePath &librariesPath)
	Constructor to open the library database of an existing workspace.

	~WorkspaceLibraryDb () noexcept

const FilePath &	getFilePath () const noexcept
	Get the file path of the SQLite database.

bool	isScanInProgress () const noexcept
	Check if there is currently a library scan in progress.

int	getScanProgressPercent () const noexcept
	Get the current progress of the library rescan.

template<typename ElementType >
QMultiMap< Version, FilePath >	getAll (const std::optional< Uuid > &uuid=std::nullopt, const FilePath &lib=FilePath()) const
	Get elements, optionally matching some criteria.

template<typename ElementType >
FilePath	getLatest (const Uuid &uuid) const
	Get an element of a specific UUID and the highest version.

template<typename ElementType >
QList< Uuid >	find (const QString &keyword) const
	Find elements by keyword.

QList< Uuid >	findDevicesOfParts (const QString &keyword) const
	Find parts by keyword.

QList< Part >	findPartsOfDevice (const Uuid &device, const QString &keyword) const
	Find parts of device by keyword.

template<typename ElementType >
bool	getTranslations (const FilePath &elemDir, const QStringList &localeOrder, QString name=nullptr, QString description=nullptr, QString *keywords=nullptr) const
	Get translations of a specific element.

template<typename ElementType >
bool	getMetadata (const FilePath elemDir, Uuid uuid=nullptr, Version version=nullptr, bool *deprecated=nullptr) const
	Get metadata of a specific element.

bool	getLibraryMetadata (const FilePath libDir, QPixmap icon=nullptr, QString manufacturer=nullptr) const
	Get additional metadata of a specific library.

template<typename ElementType >
bool	getCategoryMetadata (const FilePath catDir, std::optional< Uuid > *parent=nullptr) const
	Get additional metadata of a specific category.

bool	getDeviceMetadata (const FilePath &devDir, Uuid cmpUuid=nullptr, Uuid pkgUuid=nullptr) const
	Get additional metadata of a specific device.

template<typename ElementType >
QSet< Uuid >	getChilds (const std::optional< Uuid > &parent) const
	Get children categories of a specific category.

template<typename ElementType >
QSet< Uuid >	getByCategory (const std::optional< Uuid > &category, int limit=-1) const
	Get elements of a specific category.

template<typename ElementType >
QSet< Uuid >	getGenerated (const QString &generatedBy) const
	Get elements generated by a given "generated_by" identifier.

template<typename ElementType >
ResourceList	getResources (const FilePath elemDir) const
	Get resources of a specific library element.

QSet< Uuid >	getComponentDevices (const Uuid &component) const
	Get all devices of a specific component.

QList< Part >	getDeviceParts (const Uuid &device) const
	Get all parts of a specific device.

void	startLibraryRescan () noexcept
	Rescan the whole library directory and update the SQLite database.

WorkspaceLibraryDb &	operator= (const WorkspaceLibraryDb &rhs)=delete

template<>
QList< Uuid >	find (const QString &keyword) const

Private Member Functions
QMultiMap< Version, FilePath >	getAll (const QString &elementsTable, const std::optional< Uuid > &uuid, const FilePath &lib) const

FilePath	getLatestVersionFilePath (const QMultiMap< Version, FilePath > &list) const noexcept

QList< Uuid >	find (const QString &elementsTable, const QString &keyword) const

bool	getTranslations (const QString &elementsTable, const FilePath &elemDir, const QStringList &localeOrder, QString name, QString description, QString *keywords) const

bool	getMetadata (const QString &elementsTable, const FilePath elemDir, Uuid uuid, Version version, bool *deprecated) const

bool	getCategoryMetadata (const QString &categoriesTable, const FilePath catDir, std::optional< Uuid > *parent) const

AttributeList	getPartAttributes (int partId) const

QSet< Uuid >	getChilds (const QString &categoriesTable, const std::optional< Uuid > &categoryUuid) const

QSet< Uuid >	getByCategory (const QString &elementsTable, const QString &categoryTable, const std::optional< Uuid > &category, int limit) const

QSet< Uuid >	getGenerated (const QString &elementsTable, const QString &generatedBy) const

ResourceList	getResources (const QString &elementsTable, const FilePath &elemDir) const

int	getDbVersion () const noexcept

Static Private Member Functions
static QSet< Uuid >	getUuidSet (QSqlQuery &query)

template<typename ElementType >
static QString	getTable () noexcept

template<typename ElementType >
static QString	getCategoryTable () noexcept

Private Attributes
const FilePath	mLibrariesPath
	Path to workspace libraries directory.

const FilePath	mFilePath
	Path to the SQLite database file.

QScopedPointer< SQLiteDatabase >	mDb
	The SQLite database.

QScopedPointer< WorkspaceLibraryScanner >	mLibraryScanner

Static Private Attributes
static const int	sCurrentDbVersion = 7

Detailed Description

The WorkspaceLibraryDb class.

Constructor & Destructor Documentation

◆ WorkspaceLibraryDb() [1/3]

WorkspaceLibraryDb ( )

delete

◆ WorkspaceLibraryDb() [2/3]

WorkspaceLibraryDb ( const WorkspaceLibraryDb & other )

delete

◆ WorkspaceLibraryDb() [3/3]

WorkspaceLibraryDb ( const FilePath & librariesPath )

explicit

Constructor to open the library database of an existing workspace.

Parameters

librariesPath Path to the workspace libraries directory.

Exceptions

Exception If the library could not be opened, this constructor throws an exception.

Here is the call graph for this function:

◆ ~WorkspaceLibraryDb()

~WorkspaceLibraryDb ( )

noexcept

Member Function Documentation

◆ getFilePath()

const FilePath & getFilePath ( ) const

inlinenoexcept

Get the file path of the SQLite database.

Returns: Path to the *.sqlite file

◆ isScanInProgress()

bool isScanInProgress ( ) const

inlinenoexcept

Check if there is currently a library scan in progress.

Returns: Whether a scan is in progress or not.

Here is the call graph for this function:

◆ getScanProgressPercent()

int getScanProgressPercent ( ) const

noexcept

Get the current progress of the library rescan.

Returns: Progress in percent (100 = finished).

Here is the caller graph for this function:

◆ getAll() [1/2]

template<typename ElementType >

QMultiMap< Version, FilePath > getAll	(	const std::optional< Uuid > &	uuid = `std::nullopt`,
		const FilePath &	lib = `FilePath()`
	)		const

inline

Get elements, optionally matching some criteria.

Template Parameters

ElementType Type of the library element.

Parameters

uuid	If not nullopt, only elements with this UUID are returned.
lib	If valid, only elements from this library are returned. Attention: Must not be used when ElementType is Library!

Returns: Version and filepath of all elements matching the criteria.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLatest()

template<typename ElementType >

FilePath getLatest ( const Uuid & uuid ) const

inline

Get an element of a specific UUID and the highest version.

Parameters

uuid	The UUID of the element to get.

Returns: Filepath of the element with the highest version number and the specified UUID. If no element is found, an invalid filepath will be returned.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find() [1/3]

template<typename ElementType >

template QList< Uuid > find< Device > ( const QString & keyword ) const

Find elements by keyword.

Parameters

keyword Keyword to search for. Note that the translations for all languages will be taken into account.

Returns: UUIDs of elements matching the filter, sorted alphabetically and without duplicates. Empty if no elements were found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findDevicesOfParts()

QList< Uuid > findDevicesOfParts ( const QString & keyword ) const

Find parts by keyword.

Parameters

keyword Keyword to search for.

Returns: All devices which contain parts matching the filter, sorted alphabetically and without duplicates. Empty if no elements were found.

Here is the call graph for this function:

◆ findPartsOfDevice()

QList< WorkspaceLibraryDb::Part > findPartsOfDevice	(	const Uuid &	device,
		const QString &	keyword
	)		const

Find parts of device by keyword.

Parameters

device	Device to search for parts.
keyword	Keyword to search for.

Returns: All parts of the passed device matching the filter, sorted alphabetically and without duplicates. Empty if no elements were found or the device doesn't exist.

Here is the call graph for this function:

◆ getTranslations() [1/2]

template<typename ElementType >

bool getTranslations	(	const FilePath &	elemDir,
		const QStringList &	localeOrder,
		QString *	name = `nullptr`,
		QString *	description = `nullptr`,
		QString *	keywords = `nullptr`
	)		const

inline

Get translations of a specific element.

Template Parameters

ElementType Type of the library element.

Parameters

elemDir	Library element directory. If it does not exist, all translations will be set to an empty string.
localeOrder	Locale order (highest priority first).
name	If not nullptr, name will be written here. Set to an empty string if the requested data does not exist.
description	If not nullptr, desc. will be written here. Set to an empty string if the requested data does not exist.
keywords	If not nullptr, keywords will be written here. Set to an empty string if the requested data does not exist.

Return values

true	If the element and corresponding translations were found in the database.
false	If the element was not found or contains no translations ar all.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMetadata() [1/2]

template<typename ElementType >

bool getMetadata	(	const FilePath	elemDir,
		Uuid *	uuid = `nullptr`,
		Version *	version = `nullptr`,
		bool *	deprecated = `nullptr`
	)		const

inline

Get metadata of a specific element.

Template Parameters

ElementType Type of the library element.

Parameters

elemDir	Library element directory.
uuid	If not nullptr and the element was found, its UUID will be written here.
version	If not nullptr and the element was found, its version will be written here.
deprecated	If not nullptr and the element was found, its deprecation flag will be written here.

Return values

true	If the element was found in the database.
false	If the element was not found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLibraryMetadata()

bool getLibraryMetadata	(	const FilePath	libDir,
		QPixmap *	icon = `nullptr`,
		QString *	manufacturer = `nullptr`
	)		const

Get additional metadata of a specific library.

Parameters

libDir	Library directory.
icon	If not nullptr and the library was found, its icon will be written here.
manufacturer	If not nullptr and the library was found, its manufacturer name will be written here (may be empty).

Return values

true	If the library was found in the database.
false	If the library was not found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCategoryMetadata() [1/2]

template<typename ElementType >

bool getCategoryMetadata	(	const FilePath	catDir,
		std::optional< Uuid > *	parent = `nullptr`
	)		const

inline

Get additional metadata of a specific category.

Template Parameters

ElementType Type of the library element.

Parameters

catDir	Category directory.
parent	If not nullptr and the category was found, its parent will be written here.

Return values

true	If the category was found in the database.
false	If the category was not found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeviceMetadata()

bool getDeviceMetadata	(	const FilePath &	devDir,
		Uuid *	cmpUuid = `nullptr`,
		Uuid *	pkgUuid = `nullptr`
	)		const

Get additional metadata of a specific device.

Parameters

devDir	Device directory.
pkgUuid	If not nullptr and the device was found, its package UUID will be written here.
cmpUuid	If not nullptr and the device was found, its component UUID will be written here.

Return values

true	If the device was found in the database.
false	If the device was not found.

Here is the call graph for this function:

◆ getChilds() [1/2]

template<typename ElementType >

QSet< Uuid > getChilds ( const std::optional< Uuid > & parent ) const

inline

Get children categories of a specific category.

Template Parameters

ElementType Type of the category.

Parameters

parent Category to get the children of. If nullopt, all root categories, and categories with inexistent parent will be returned (this ensures that all elements are discoverable by getByCategory()).

Returns: UUIDs of children categories. Empty if the passed category doesn't exist.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getByCategory() [1/2]

template<typename ElementType >

QSet< Uuid > getByCategory	(	const std::optional< Uuid > &	category,
		int	limit = `-1`
	)		const

inline

Get elements of a specific category.

Template Parameters

ElementType Type of the library element.

Parameters

category	Category to get the elements of. If nullopt, all elements with no category at all, or with only inexistent categories are returned.
limit	If not -1, the number of results is limited to this value. This can be used for performance reasons, for example if you only want to know if there are any elements in the given category, the limit can be set to 1, which is much faster than retrieving all results.

Returns: UUIDs of elements. Empty if the passed category doesn't exist.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGenerated() [1/2]

template<typename ElementType >

QSet< Uuid > getGenerated ( const QString & generatedBy ) const

inline

Get elements generated by a given "generated_by" identifier.

Template Parameters

ElementType Type of the library element.

Parameters

generatedBy The "generated_by" identifier. Must be non-empty, otherwise no results are returned.

Returns: UUIDs of elements. Empty if none found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResources() [1/2]

template<typename ElementType >

ResourceList getResources ( const FilePath elemDir ) const

inline

Get resources of a specific library element.

Template Parameters

ElementType Type of the library element.

Parameters

elemDir Library element directory.

Returns: Element resources (empty if element doesn't exist).

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentDevices()

QSet< Uuid > getComponentDevices ( const Uuid & component ) const

Get all devices of a specific component.

Parameters

component Component UUID to get the devices of.

Returns: UUIDs of devices. Empty if the passed component doesn't exist.

Here is the call graph for this function:

◆ getDeviceParts()

QList< WorkspaceLibraryDb::Part > getDeviceParts ( const Uuid & device ) const

Get all parts of a specific device.

Parameters

device Device UUID to get the parts of.

Returns: All parts. Empty if the passed device doesn't exist.

Here is the call graph for this function:

◆ startLibraryRescan()

void startLibraryRescan ( )

noexcept

Rescan the whole library directory and update the SQLite database.

Here is the caller graph for this function:

◆ operator=()

WorkspaceLibraryDb & operator= ( const WorkspaceLibraryDb & rhs )

delete

◆ scanStarted

void scanStarted ( )

signal

Here is the caller graph for this function:

◆ scanLibraryListUpdated

void scanLibraryListUpdated ( int libraryCount )

signal

Here is the caller graph for this function:

◆ scanProgressUpdate

void scanProgressUpdate ( int percent )

signal

Here is the caller graph for this function:

◆ scanSucceeded

void scanSucceeded ( int elementCount )

signal

Here is the caller graph for this function:

◆ scanFailed

void scanFailed ( QString errorMsg )

signal

Here is the caller graph for this function:

◆ scanFinished

void scanFinished ( )

signal

Here is the caller graph for this function:

◆ getAll() [2/2]

QMultiMap< Version, FilePath > getAll	(	const QString &	elementsTable,
		const std::optional< Uuid > &	uuid,
		const FilePath &	lib
	)		const

private

Here is the call graph for this function:

◆ getLatestVersionFilePath()

FilePath getLatestVersionFilePath ( const QMultiMap< Version, FilePath > & list ) const

privatenoexcept

Here is the caller graph for this function:

◆ find() [2/3]

QList< Uuid > find	(	const QString &	elementsTable,
		const QString &	keyword
	)		const

private

Here is the call graph for this function:

◆ getTranslations() [2/2]

bool getTranslations	(	const QString &	elementsTable,
		const FilePath &	elemDir,
		const QStringList &	localeOrder,
		QString *	name,
		QString *	description,
		QString *	keywords
	)		const

private

Here is the call graph for this function:

◆ getMetadata() [2/2]

bool getMetadata	(	const QString &	elementsTable,
		const FilePath	elemDir,
		Uuid *	uuid,
		Version *	version,
		bool *	deprecated
	)		const

private

Here is the call graph for this function:

◆ getCategoryMetadata() [2/2]

bool getCategoryMetadata	(	const QString &	categoriesTable,
		const FilePath	catDir,
		std::optional< Uuid > *	parent
	)		const

private

Here is the call graph for this function:

◆ getPartAttributes()

AttributeList getPartAttributes ( int partId ) const

private

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChilds() [2/2]

QSet< Uuid > getChilds	(	const QString &	categoriesTable,
		const std::optional< Uuid > &	categoryUuid
	)		const

private

Here is the call graph for this function:

◆ getByCategory() [2/2]

QSet< Uuid > getByCategory	(	const QString &	elementsTable,
		const QString &	categoryTable,
		const std::optional< Uuid > &	category,
		int	limit
	)		const

private

Here is the call graph for this function:

◆ getGenerated() [2/2]

QSet< Uuid > getGenerated	(	const QString &	elementsTable,
		const QString &	generatedBy
	)		const

private

Here is the call graph for this function:

◆ getResources() [2/2]

ResourceList getResources	(	const QString &	elementsTable,
		const FilePath &	elemDir
	)		const

private

Here is the call graph for this function:

◆ getUuidSet()

QSet< Uuid > getUuidSet ( QSqlQuery & query )

staticprivate

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDbVersion()

int getDbVersion ( ) const

privatenoexcept

Here is the caller graph for this function:

◆ getTable()

template<typename ElementType >

template QString getTable< Device > ( )

staticprivatenoexcept

◆ getCategoryTable()

template<typename ElementType >

template QString getCategoryTable< Device > ( )

staticprivatenoexcept

◆ find() [3/3]

template<>

QList< Uuid > find ( const QString & keyword ) const

Member Data Documentation

◆ mLibrariesPath

const FilePath mLibrariesPath

private

Path to workspace libraries directory.

◆ mFilePath

const FilePath mFilePath

private

Path to the SQLite database file.

◆ mDb

QScopedPointer<SQLiteDatabase> mDb

private

The SQLite database.

◆ mLibraryScanner

QScopedPointer<WorkspaceLibraryScanner> mLibraryScanner

private

◆ sCurrentDbVersion

const int sCurrentDbVersion = 7

staticprivate

The documentation for this class was generated from the following files:

/__w/1/s/libs/librepcb/core/workspace/workspacelibrarydb.h
/__w/1/s/libs/librepcb/core/workspace/workspacelibrarydb.cpp

Classes

Signals

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WorkspaceLibraryDb() [1/3]

◆ WorkspaceLibraryDb() [2/3]

◆ WorkspaceLibraryDb() [3/3]

◆ ~WorkspaceLibraryDb()

Member Function Documentation

◆ getFilePath()

◆ isScanInProgress()

◆ getScanProgressPercent()

◆ getAll() [1/2]

◆ getLatest()

◆ find() [1/3]

◆ findDevicesOfParts()

◆ findPartsOfDevice()

◆ getTranslations() [1/2]

◆ getMetadata() [1/2]

◆ getLibraryMetadata()

◆ getCategoryMetadata() [1/2]

◆ getDeviceMetadata()

◆ getChilds() [1/2]

◆ getByCategory() [1/2]

◆ getGenerated() [1/2]

◆ getResources() [1/2]

◆ getComponentDevices()

◆ getDeviceParts()

◆ startLibraryRescan()

◆ operator=()

◆ scanStarted

◆ scanLibraryListUpdated

◆ scanProgressUpdate

◆ scanSucceeded

◆ scanFailed

◆ scanFinished

◆ getAll() [2/2]

◆ getLatestVersionFilePath()

◆ find() [2/3]

◆ getTranslations() [2/2]

◆ getMetadata() [2/2]

◆ getCategoryMetadata() [2/2]

◆ getPartAttributes()

◆ getChilds() [2/2]

◆ getByCategory() [2/2]

◆ getGenerated() [2/2]

◆ getResources() [2/2]

◆ getUuidSet()

◆ getDbVersion()

◆ getTable()

◆ getCategoryTable()

◆ find() [3/3]

Member Data Documentation

◆ mLibrariesPath

◆ mFilePath

◆ mDb

◆ mLibraryScanner

◆ sCurrentDbVersion