LibrePCB Developers Documentation
Loading...
Searching...
No Matches
librariesmodel.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_EDITOR_LIBRARIESMODEL_H
21#define LIBREPCB_EDITOR_LIBRARIESMODEL_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "appwindow.h"
27
30
31#include <QtCore>
32
33#include <vector>
34
35/*******************************************************************************
36 * Namespace / Forward Declarations
37 ******************************************************************************/
38namespace librepcb {
39
40class ApiEndpoint;
41class Workspace;
42
43namespace editor {
44
45class LibraryDownload;
46
47/*******************************************************************************
48 * Class LibrariesModel
49 ******************************************************************************/
50
54class LibrariesModel : public QObject,
55 public slint::Model<ui::LibraryInfoData> {
56 Q_OBJECT
57
58public:
59 // Types
60 enum class Mode { LocalLibs, RemoteLibs };
61
62 // Constructors / Destructor
63 LibrariesModel() = delete;
64 LibrariesModel(const LibrariesModel& other) = delete;
65 explicit LibrariesModel(Workspace& ws, Mode mode,
66 QObject* parent = nullptr) noexcept;
67 virtual ~LibrariesModel() noexcept;
68
69 // General Methods
70 ui::LibraryListData getUiData() const noexcept;
71 void setOnlineVersions(const QHash<Uuid, Version>& versions) noexcept;
72 void ensurePopulated(bool withIcons) noexcept;
73 void highlightLibraryOnNextRescan(const FilePath& fp) noexcept;
74 void applyChanges() noexcept;
75 void cancel() noexcept;
76
77 // Implementations
78 std::size_t row_count() const override;
79 std::optional<ui::LibraryInfoData> row_data(std::size_t i) const override;
80 void set_row_data(std::size_t i,
81 const ui::LibraryInfoData& data) noexcept override;
82
83 // Operator Overloadings
84 LibrariesModel& operator=(const LibrariesModel& rhs) = delete;
85
86signals:
87 void uiDataChanged(ui::LibraryListData data);
88 void onlineVersionsAvailable(const QHash<Uuid, Version>& versions);
90
91private:
92 void updateLibraries(bool resetHighlight = true) noexcept;
93 void requestOnlineLibraries() noexcept;
94 void onlineLibraryListReceived(QList<ApiEndpoint::Library> libs) noexcept;
95 void requestMissingOnlineIcons() noexcept;
96 void onlineIconReceived(const Uuid& uuid, const QByteArray& data) noexcept;
97 void errorWhileFetchingLibraryList(QString errorMsg) noexcept;
98 void apiEndpointOperationFinished() noexcept;
99 void updateMergedLibraries() noexcept;
100 void updateCheckStates(bool notify) noexcept;
101 void checkMissingDependenciesOfLibs() noexcept;
102 void uncheckLibsWithUnmetDependencies() noexcept;
103 bool isLibraryChecked(const ui::LibraryInfoData& lib) const noexcept;
104 static bool isMarkedForInstall(const ui::LibraryInfoData& lib) noexcept;
105 static bool isMarkedForUpdate(const ui::LibraryInfoData& lib) noexcept;
106 static bool isMarkedForUninstall(const ui::LibraryInfoData& lib) noexcept;
107 std::optional<std::size_t> indexOf(const Uuid& uuid) noexcept;
108
110 const Mode mMode;
111 std::vector<ui::LibraryInfoData> mInstalledLibs;
114 QStringList mOnlineLibsErrors;
115 std::vector<ui::LibraryInfoData> mMergedLibs;
116 QHash<Uuid, bool> mCheckStates;
117
119 QHash<Uuid, QPixmap> mIcons;
120 QHash<slint::SharedString, slint::SharedString> mOnlineVersions;
122
125};
126
127/*******************************************************************************
128 * End of File
129 ******************************************************************************/
130
131} // namespace editor
132} // namespace librepcb
133
134#endif
Access to a LibrePCB API endpoint.
Definition apiendpoint.h:45
This class represents absolute, well-formatted paths to files or directories.
Definition filepath.h:127
The Library class represents a library directory.
Definition library.h:46
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 Workspace class represents a workspace with all its data (library, projects, settings,...
Definition workspace.h:54
The LibrariesModel class.
Definition librariesmodel.h:55
QStringList mInstalledLibsErrors
Either local or remote.
Definition librariesmodel.h:112
void checkMissingDependenciesOfLibs() noexcept
Definition librariesmodel.cpp:485
QHash< Uuid, ApiEndpoint::Library > mOnlineLibs
Definition librariesmodel.h:113
void aboutToUninstallLibrary(const FilePath &fp)
QList< std::shared_ptr< LibraryDownload > > mDownloadsInProgress
Definition librariesmodel.h:124
void highlightLibraryOnNextRescan(const FilePath &fp) noexcept
Definition librariesmodel.cpp:140
void cancel() noexcept
Definition librariesmodel.cpp:220
static bool isMarkedForUpdate(const ui::LibraryInfoData &lib) noexcept
Definition librariesmodel.cpp:548
void uiDataChanged(ui::LibraryListData data)
QHash< Uuid, bool > mCheckStates
Definition librariesmodel.h:116
std::vector< ui::LibraryInfoData > mMergedLibs
Definition librariesmodel.h:115
void onlineIconReceived(const Uuid &uuid, const QByteArray &data) noexcept
Definition librariesmodel.cpp:391
void requestMissingOnlineIcons() noexcept
Definition librariesmodel.cpp:375
Mode
Definition librariesmodel.h:60
bool isLibraryChecked(const ui::LibraryInfoData &lib) const noexcept
Definition librariesmodel.cpp:537
void errorWhileFetchingLibraryList(QString errorMsg) noexcept
Definition librariesmodel.cpp:405
void ensurePopulated(bool withIcons) noexcept
Definition librariesmodel.cpp:123
void apiEndpointOperationFinished() noexcept
Definition librariesmodel.cpp:415
void uncheckLibsWithUnmetDependencies() noexcept
Definition librariesmodel.cpp:511
void updateLibraries(bool resetHighlight=true) noexcept
Definition librariesmodel.cpp:272
bool mRequestIcons
Definition librariesmodel.h:118
void updateCheckStates(bool notify) noexcept
Definition librariesmodel.cpp:472
QStringList mOnlineLibsErrors
Definition librariesmodel.h:114
QHash< Uuid, QPixmap > mIcons
Definition librariesmodel.h:119
void onlineLibraryListReceived(QList< ApiEndpoint::Library > libs) noexcept
Definition librariesmodel.cpp:358
std::size_t row_count() const override
Definition librariesmodel.cpp:237
ui::LibraryListData getUiData() const noexcept
Definition librariesmodel.cpp:68
std::vector< ui::LibraryInfoData > mInstalledLibs
Definition librariesmodel.h:111
LibrariesModel(const LibrariesModel &other)=delete
void applyChanges() noexcept
Definition librariesmodel.cpp:144
std::optional< ui::LibraryInfoData > row_data(std::size_t i) const override
Definition librariesmodel.cpp:241
Workspace & mWorkspace
Definition librariesmodel.h:109
static bool isMarkedForUninstall(const ui::LibraryInfoData &lib) noexcept
Definition librariesmodel.cpp:553
std::optional< std::size_t > indexOf(const Uuid &uuid) noexcept
Definition librariesmodel.cpp:558
void onlineVersionsAvailable(const QHash< Uuid, Version > &versions)
void set_row_data(std::size_t i, const ui::LibraryInfoData &data) noexcept override
Definition librariesmodel.cpp:247
void setOnlineVersions(const QHash< Uuid, Version > &versions) noexcept
Definition librariesmodel.cpp:97
const Mode mMode
Definition librariesmodel.h:110
void updateMergedLibraries() noexcept
Definition librariesmodel.cpp:426
QHash< slint::SharedString, slint::SharedString > mOnlineVersions
Definition librariesmodel.h:120
static bool isMarkedForInstall(const ui::LibraryInfoData &lib) noexcept
Definition librariesmodel.cpp:543
void requestOnlineLibraries() noexcept
Definition librariesmodel.cpp:340
std::optional< FilePath > mHighlightedLib
Definition librariesmodel.h:121
QList< std::shared_ptr< ApiEndpoint > > mApiEndpointsInProgress
Definition librariesmodel.h:123
The LibraryDownload class.
Definition librarydownload.h:48
Definition occmodel.cpp:77
Definition uuid.h:186