diff options
Diffstat (limited to 'libs/installer_bsplugins/src/TESData/PluginList.h')
| -rw-r--r-- | libs/installer_bsplugins/src/TESData/PluginList.h | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/libs/installer_bsplugins/src/TESData/PluginList.h b/libs/installer_bsplugins/src/TESData/PluginList.h new file mode 100644 index 0000000..b263ffb --- /dev/null +++ b/libs/installer_bsplugins/src/TESData/PluginList.h @@ -0,0 +1,200 @@ +#ifndef TESDATA_PLUGINLIST_H +#define TESDATA_PLUGINLIST_H + +#include "AssociatedEntry.h" +#include "FileEntry.h" +#include "FileInfo.h" +#include "MOTools/ILootCache.h" +#include "TESFile/Type.h" + +#include <gameplugins.h> +#include <ifiletree.h> +#include <imoinfo.h> +#include <iplugingame.h> +#include <ipluginlist.h> +#include <memoizedlock.h> + +#include <boost/signals2.hpp> + +#include <QObject> + +#include <atomic> +#include <map> +#include <memory> +#include <set> +#include <shared_mutex> +#include <string> +#include <vector> + +namespace TESData +{ + +class PluginList final : public QObject, + public MOBase::IPluginList, + public MOTools::ILootCache +{ + Q_OBJECT + +public: + using SignalRefreshed = boost::signals2::signal<void()>; + using SignalPluginMoved = boost::signals2::signal<void(const QString&, int, int)>; + using SignalPluginStateChanged = + boost::signals2::signal<void(const std::map<QString, PluginStates>&)>; + + explicit PluginList(const MOBase::IOrganizer* moInfo); + + PluginList(const PluginList&) = delete; + PluginList(PluginList&&) = delete; + + ~PluginList() noexcept; + + PluginList& operator=(const PluginList&) = delete; + PluginList& operator=(PluginList&&) = delete; + + [[nodiscard]] int pluginCount() const; + + [[nodiscard]] const FileInfo* getPlugin(int index) const; + [[nodiscard]] const FileInfo* getPluginByName(const QString& name) const; + [[nodiscard]] const FileInfo* getPluginByPriority(int priority) const; + [[nodiscard]] int getIndex(const QString& pluginName) const; + [[nodiscard]] int getIndexAtPriority(int priority) const; + [[nodiscard]] QString getOriginName(int index) const; + + [[nodiscard]] FileEntry* findEntryByName(const std::string& pluginName) const; + [[nodiscard]] FileEntry* findEntryByHandle(TESFileHandle handle) const; + [[nodiscard]] AssociatedEntry* findArchive(const QString& name) const; + + FileEntry* createEntry(const std::string& name); + void addRecordConflict(const std::string& pluginName, const RecordPath& path, + TESFile::Type type, const std::string& name); + void addGroupPlaceholder(const std::string& pluginName, const RecordPath& path); + + void refresh(bool invalidate = false); + + void setEnabled(int id, bool enable); + void setEnabled(const std::vector<int>& ids, bool enable); + void toggleState(const std::vector<int>& ids); + + [[nodiscard]] bool canMoveToPriority(const std::vector<int>& ids, + int newPriority) const; + void moveToPriority(std::vector<int> ids, int destination, bool disjoint = false); + void shiftPriority(const std::vector<int>& ids, int offset); + + void setGroup(const std::vector<int>& ids, const QString& group); + + [[nodiscard]] QStringList loadOrder() const; + + [[nodiscard]] bool isRefreshing() const { return m_Refreshing; } + + void notifyPendingState(const QString& mod, MOBase::IModList::ModStates state); + void flushPendingStates(); + + // IPluginList + + [[nodiscard]] QStringList pluginNames() const override; + [[nodiscard]] PluginStates state(const QString& name) const override; + void setState(const QString& name, PluginStates state) override; + [[nodiscard]] int priority(const QString& name) const override; + bool setPriority(const QString& name, int newPriority) override; + [[nodiscard]] int loadOrder(const QString& name) const override; + void setLoadOrder(const QStringList& pluginList) override; + [[deprecated]] bool isMaster(const QString& name) const override; + [[nodiscard]] QStringList masters(const QString& name) const override; + [[nodiscard]] QString origin(const QString& name) const override; + + bool onRefreshed(const std::function<void()>& callback) override; + bool + onPluginMoved(const std::function<void(const QString&, int, int)>& func) override; + bool onPluginStateChanged( + const std::function<void(const std::map<QString, PluginStates>&)>& func) override; + + [[nodiscard]] bool hasMasterExtension(const QString& name) const override; + [[nodiscard]] bool hasLightExtension(const QString& name) const override; + [[nodiscard]] bool isMasterFlagged(const QString& name) const override; + [[nodiscard]] bool isMediumFlagged(const QString& name) const override; + [[nodiscard]] bool isLightFlagged(const QString& name) const override; + [[nodiscard]] bool isBlueprintFlagged(const QString& name) const override; + [[nodiscard]] bool hasNoRecords(const QString& name) const override; + [[nodiscard]] int formVersion(const QString& name) const override; + [[nodiscard]] float headerVersion(const QString& name) const override; + + [[nodiscard]] QString author(const QString& name) const override; + [[nodiscard]] QString description(const QString& name) const override; + + // ILootCache + + void clearAdditionalInformation() override; + void addLootReport(const QString& name, MOTools::Loot::Plugin plugin) override; + [[nodiscard]] const MOTools::Loot::Plugin* getLootReport(const QString& name) const; + +public slots: + void writePluginLists() const; + +signals: + void pluginsListChanged(); + +private: + [[nodiscard]] FileInfo* findPlugin(const QString& name); + [[nodiscard]] const FileInfo* findPlugin(const QString& name) const; + + void scanDataFiles(bool invalidate); + void readPluginLists(); + void checkBsa(TESData::FileInfo& info, + const std::shared_ptr<const MOBase::IFileTree>& fileTree); + void associateArchive(const TESData::FileInfo& info, const QString& archiveName); + + [[nodiscard]] QString groupsPath() const; + [[nodiscard]] QString lockedOrderPath() const; + void clearGroups(); + void readGroups(const QString& fileName); + void writeEmptyTextFile(const QString& fileName) const; + void writeGroups(const QString& fileName) const; + [[nodiscard]] QString destinationGroup( + int oldPriority, int newPriority, const QString& originalGroup, bool isESM, + const boost::container::flat_set<QString, MOBase::FileNameComparator>& + exclusions); + + void queuePluginStateChange(const QString& pluginName, PluginStates state); + void dispatchPluginStateChanges(); + void pluginStatesChanged(const QStringList& pluginNames, PluginStates state) const; + void enforcePluginRelationships(); + void testMasters(); + void updateCache(); + void computeCompileIndices(); + void refreshLoadOrder(); + + const MOBase::IOrganizer* m_Organizer; + + std::vector<std::shared_ptr<FileInfo>> m_Plugins; + + std::map<QString, int, MOBase::FileNameComparator> m_PluginsByName; + std::vector<int> m_PluginsByPriority; + + std::map<QString, MOTools::Loot::Plugin, MOBase::FileNameComparator> m_LootInfo; + + std::atomic<TESFileHandle> m_NextHandle = 0; + std::map<std::string, std::shared_ptr<FileEntry>, TESFile::less> m_EntriesByName; + boost::container::flat_map<TESFileHandle, std::shared_ptr<FileEntry>> + m_EntriesByHandle; + std::map<std::string, std::shared_ptr<Record>> m_Settings; + std::map<TESFile::Type, std::shared_ptr<Record>> m_DefaultObjects; + + std::shared_ptr<AssociatedEntry> m_MasterArchiveEntry; + std::map<QString, std::shared_ptr<AssociatedEntry>, MOBase::FileNameComparator> + m_Archives; + + mutable std::shared_mutex m_FileEntryMutex; + mutable std::shared_mutex m_ArchiveEntryMutex; + + bool m_Refreshing = true; + std::map<QString, PluginStates> m_QueuedStateChanges; + std::set<QString> m_PendingActive; + + SignalRefreshed m_Refreshed; + SignalPluginMoved m_PluginMoved; + SignalPluginStateChanged m_PluginStateChanged; +}; + +} // namespace TESData + +#endif // TESDATA_PLUGINLIST_H |
