The Workspace class represents a workspace with all its data (library, projects, settings, ...) More...

#include <workspace.h>

Inherits QObject.

Collaboration diagram for Workspace:

Public Member Functions
	Workspace ()=delete

	Workspace (const Workspace &other)=delete

	Workspace (const FilePath &wsPath, DirectoryLock::LockHandlerCallback lockCallback=nullptr)
	Constructor to open an existing workspace. More...

	~Workspace () noexcept

const FilePath &	getPath () const
	Get the filepath to the workspace directory. More...

const FilePath &	getProjectsPath () const
	Get the filepath to the "projects" directory in the workspace. More...

const FilePath &	getMetadataPath () const
	Get the filepath to the version directory (v#) in the workspace. More...

const FilePath &	getLibrariesPath () const
	Get the filepath to the "v#/libraries" directory in the workspace. More...

FilePath	getLocalLibrariesPath () const
	Get the filepath to the "v#/libraries/local" directory. More...

FilePath	getRemoteLibrariesPath () const
	Get the filepath to the "v#/libraries/remote" directory. More...

ProjectTreeModel &	getProjectTreeModel () const noexcept

RecentProjectsModel &	getRecentProjectsModel () const noexcept

FavoriteProjectsModel &	getFavoriteProjectsModel () const noexcept

WorkspaceSettings &	getSettings () const
	Get the workspace settings. More...

WorkspaceLibraryDb &	getLibraryDb () const
	Get the workspace library database. More...

void	setLastRecentlyUsedProject (const FilePath &filepath) noexcept
	setLastRecentlyUsedProject More...

bool	isFavoriteProject (const FilePath &filepath) const noexcept
	Check whether a project is in the favorite project list or not. More...

void	addFavoriteProject (const FilePath &filepath) noexcept
	Add a project to the favorite projects list. More...

void	removeFavoriteProject (const FilePath &filepath) noexcept
	Remove a project from the favorite projects list. More...

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

Static Public Member Functions
static bool	isValidWorkspacePath (const FilePath &path) noexcept
	Check whether a filepath points to a valid workspace directory or not. More...

static QList< Version >	getFileFormatVersionsOfWorkspace (const FilePath &path) noexcept
	getFileFormatVersionsOfWorkspace More...

static tl::optional< Version >	getHighestFileFormatVersionOfWorkspace (const FilePath &path) noexcept
	getHighestFileFormatVersionOfWorkspace More...

static void	createNewWorkspace (const FilePath &path)
	Create a new workspace. More...

static FilePath	getMostRecentlyUsedWorkspacePath () noexcept
	Get the most recently used workspace path. More...

static void	setMostRecentlyUsedWorkspacePath (const FilePath &path) noexcept
	Set the most recently used workspace path. More...

static Version	FILE_FORMAT_VERSION () noexcept
	Current workspace file format version (constant) More...

Private Attributes
FilePath	mPath
	a FilePath object which represents the workspace directory More...

FilePath	mProjectsPath
	the directory "projects" More...

FilePath	mMetadataPath
	the subdirectory of the current file format version More...

FilePath	mLibrariesPath
	the directory "v#/libraries" More...

DirectoryLock	mLock
	to lock the version directory (mMetadataPath) More...

QScopedPointer< WorkspaceSettings >	mWorkspaceSettings
	the WorkspaceSettings object More...

QScopedPointer< WorkspaceLibraryDb >	mLibraryDb
	the library database More...

QScopedPointer< ProjectTreeModel >	mProjectTreeModel
	a tree model for the whole projects directory More...

QScopedPointer< RecentProjectsModel >	mRecentProjectsModel
	a list model of all recent projects More...

QScopedPointer< FavoriteProjectsModel >	mFavoriteProjectsModel
	a list model of all favorite projects More...

Detailed Description

The Workspace class represents a workspace with all its data (library, projects, settings, ...)

To access the settings of the workspace, use the method getSettings().

Constructor & Destructor Documentation

◆ Workspace() [1/3]

Workspace ( )

delete

◆ Workspace() [2/3]

Workspace ( const Workspace & other )

delete

◆ Workspace() [3/3]

Workspace	(	const FilePath &	wsPath,
		DirectoryLock::LockHandlerCallback	lockCallback = `nullptr`
	)

explicit

Constructor to open an existing workspace.

Parameters

wsPath	The filepath to the workspace directory
lockCallback	A callback which gets called if the workspace directory is locked, to decide what to do in this case.

Exceptions

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

Here is the call graph for this function:

◆ ~Workspace()

~Workspace ( )

noexcept

The destructor

Member Function Documentation

◆ getPath()

const FilePath& getPath ( ) const

inline

Get the filepath to the workspace directory.

Here is the caller graph for this function:

◆ getProjectsPath()

const FilePath& getProjectsPath ( ) const

inline

Get the filepath to the "projects" directory in the workspace.

Here is the caller graph for this function:

◆ getMetadataPath()

const FilePath& getMetadataPath ( ) const

inline

Get the filepath to the version directory (v#) in the workspace.

◆ getLibrariesPath()

const FilePath& getLibrariesPath ( ) const

inline

Get the filepath to the "v#/libraries" directory in the workspace.

Here is the caller graph for this function:

◆ getLocalLibrariesPath()

FilePath getLocalLibrariesPath ( ) const

inline

Get the filepath to the "v#/libraries/local" directory.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoteLibrariesPath()

FilePath getRemoteLibrariesPath ( ) const

inline

Get the filepath to the "v#/libraries/remote" directory.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProjectTreeModel()

ProjectTreeModel & getProjectTreeModel ( ) const

noexcept

Here is the caller graph for this function:

◆ getRecentProjectsModel()

RecentProjectsModel & getRecentProjectsModel ( ) const

noexcept

Here is the caller graph for this function:

◆ getFavoriteProjectsModel()

FavoriteProjectsModel & getFavoriteProjectsModel ( ) const

noexcept

Here is the caller graph for this function:

◆ getSettings()

WorkspaceSettings& getSettings ( ) const

inline

Get the workspace settings.

Here is the caller graph for this function:

◆ getLibraryDb()

WorkspaceLibraryDb& getLibraryDb ( ) const

inline

Get the workspace library database.

Here is the caller graph for this function:

◆ setLastRecentlyUsedProject()

void setLastRecentlyUsedProject ( const FilePath & filepath )

noexcept

setLastRecentlyUsedProject

Parameters

filepath

Here is the caller graph for this function:

◆ isFavoriteProject()

bool isFavoriteProject ( const FilePath & filepath ) const

noexcept

Check whether a project is in the favorite project list or not.

Parameters

filepath The filepath to a *.lpp project file

Returns: True if the specified project is in the favorites list, false otherwise

Here is the caller graph for this function:

◆ addFavoriteProject()

void addFavoriteProject ( const FilePath & filepath )

noexcept

Add a project to the favorite projects list.

Parameters

filepath The filepath to a *.lpp project file

Here is the caller graph for this function:

◆ removeFavoriteProject()

void removeFavoriteProject ( const FilePath & filepath )

noexcept

Remove a project from the favorite projects list.

Parameters

filepath The filepath to a *.lpp project file

Here is the caller graph for this function:

◆ operator=()

Workspace& operator= ( const Workspace & rhs )

delete

◆ isValidWorkspacePath()

bool isValidWorkspacePath ( const FilePath & path )

staticnoexcept

Check whether a filepath points to a valid workspace directory or not.

Parameters

path	A path to a directory

Returns: True if the path is a valid workspace directory, false otherwise

Here is the caller graph for this function:

◆ getFileFormatVersionsOfWorkspace()

QList< Version > getFileFormatVersionsOfWorkspace ( const FilePath & path )

staticnoexcept

getFileFormatVersionsOfWorkspace

Parameters

path

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHighestFileFormatVersionOfWorkspace()

tl::optional< Version > getHighestFileFormatVersionOfWorkspace ( const FilePath & path )

staticnoexcept

getHighestFileFormatVersionOfWorkspace

Parameters

path

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNewWorkspace()

void createNewWorkspace ( const FilePath & path )

static

Create a new workspace.

Parameters

path	A path to a directory where to create the new workspace

Exceptions

Exception on error.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMostRecentlyUsedWorkspacePath()

FilePath getMostRecentlyUsedWorkspacePath ( )

staticnoexcept

Get the most recently used workspace path.

Returns: The filepath to the last recently used workspace (may be invalid)

Here is the caller graph for this function:

◆ setMostRecentlyUsedWorkspacePath()

void setMostRecentlyUsedWorkspacePath ( const FilePath & path )

staticnoexcept

Set the most recently used workspace path.

Parameters

path	The filepath to the workspace directory

Here is the caller graph for this function:

◆ FILE_FORMAT_VERSION()

static Version FILE_FORMAT_VERSION ( )

inlinestaticnoexcept

Current workspace file format version (constant)

Warning: Don't change this value unless you know exactly what you're doing!

Returns: File format version

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mPath

FilePath mPath

private

a FilePath object which represents the workspace directory

◆ mProjectsPath

FilePath mProjectsPath

private

the directory "projects"

◆ mMetadataPath

FilePath mMetadataPath

private

the subdirectory of the current file format version

◆ mLibrariesPath

FilePath mLibrariesPath

private

the directory "v#/libraries"

◆ mLock

DirectoryLock mLock

private

to lock the version directory (mMetadataPath)

◆ mWorkspaceSettings

QScopedPointer<WorkspaceSettings> mWorkspaceSettings

private

the WorkspaceSettings object

◆ mLibraryDb

QScopedPointer<WorkspaceLibraryDb> mLibraryDb

private

the library database

◆ mProjectTreeModel

QScopedPointer<ProjectTreeModel> mProjectTreeModel

private

a tree model for the whole projects directory

◆ mRecentProjectsModel

QScopedPointer<RecentProjectsModel> mRecentProjectsModel

private

a list model of all recent projects

◆ mFavoriteProjectsModel

QScopedPointer<FavoriteProjectsModel> mFavoriteProjectsModel

private

a list model of all favorite projects

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Workspace() [1/3]

◆ Workspace() [2/3]

◆ Workspace() [3/3]

◆ ~Workspace()

Member Function Documentation

◆ getPath()

◆ getProjectsPath()

◆ getMetadataPath()

◆ getLibrariesPath()

◆ getLocalLibrariesPath()

◆ getRemoteLibrariesPath()

◆ getProjectTreeModel()

◆ getRecentProjectsModel()

◆ getFavoriteProjectsModel()

◆ getSettings()

◆ getLibraryDb()

◆ setLastRecentlyUsedProject()

◆ isFavoriteProject()

◆ addFavoriteProject()

◆ removeFavoriteProject()

◆ operator=()

◆ isValidWorkspacePath()

◆ getFileFormatVersionsOfWorkspace()

◆ getHighestFileFormatVersionOfWorkspace()

◆ createNewWorkspace()

◆ getMostRecentlyUsedWorkspacePath()

◆ setMostRecentlyUsedWorkspacePath()

◆ FILE_FORMAT_VERSION()

Member Data Documentation

◆ mPath

◆ mProjectsPath

◆ mMetadataPath

◆ mLibrariesPath

◆ mLock

◆ mWorkspaceSettings

◆ mLibraryDb

◆ mProjectTreeModel

◆ mRecentProjectsModel

◆ mFavoriteProjectsModel