diff options
Diffstat (limited to 'src/modinforegular.h')
| -rw-r--r-- | src/modinforegular.h | 530 |
1 files changed, 267 insertions, 263 deletions
diff --git a/src/modinforegular.h b/src/modinforegular.h index 616e2fbe..a94d0363 100644 --- a/src/modinforegular.h +++ b/src/modinforegular.h @@ -12,334 +12,338 @@ * to manage the mod collection * **/ -class ModInfoRegular : public ModInfoWithConflictInfo { +class ModInfoRegular : public ModInfoWithConflictInfo +{ - Q_OBJECT + Q_OBJECT - friend class ModInfo; + friend class ModInfo; public: - ~ModInfoRegular(); - virtual bool isRegular() const { return true; } + ~ModInfoRegular(); - virtual bool isEmpty() const; + virtual bool isRegular() const { return true; } - /** - * @brief test if there is a newer version of the mod - * - * test if there is a newer version of the mod. This does NOT cause - * information to be retrieved from the nexus, it will only test version information already - * available locally. Use checkAllForUpdate() to update this version information - * - * @return true if there is a newer version - **/ - bool updateAvailable() const; + virtual bool isEmpty() const; - /** - * @return true if the current update is being ignored - */ - virtual bool updateIgnored() const { return m_IgnoredVersion == m_NewestVersion; } + /** + * @brief test if there is a newer version of the mod + * + * test if there is a newer version of the mod. This does NOT cause + * information to be retrieved from the nexus, it will only test version information already + * available locally. Use checkAllForUpdate() to update this version information + * + * @return true if there is a newer version + **/ + bool updateAvailable() const; - /** - * @brief test if there is a newer version of the mod - * - * test if there is a newer version of the mod. This does NOT cause - * information to be retrieved from the nexus, it will only test version information already - * available locally. Use checkAllForUpdate() to update this version information - * - * @return true if there is a newer version - **/ - bool downgradeAvailable() const; + /** + * @return true if the current update is being ignored + */ + virtual bool updateIgnored() const { return m_IgnoredVersion == m_NewestVersion; } - /** - * @brief request an update of nexus description for this mod. - * - * This requests mod information from the nexus. This is an asynchronous request, - * so there is no immediate effect of this call. - * - * @return returns true if information for this mod will be updated, false if there is no nexus mod id to use - **/ - bool updateNXMInfo(); + /** + * @brief test if there is a newer version of the mod + * + * test if there is a newer version of the mod. This does NOT cause + * information to be retrieved from the nexus, it will only test version information already + * available locally. Use checkAllForUpdate() to update this version information + * + * @return true if there is a newer version + **/ + bool downgradeAvailable() const; - /** - * @brief assign or unassign the specified category - * - * Every mod can have an arbitrary number of categories assigned to it - * - * @param categoryID id of the category to set - * @param active determines wheter the category is assigned or unassigned - * @note this function does not test whether categoryID actually identifies a valid category - **/ - void setCategory(int categoryID, bool active); + /** + * @brief request an update of nexus description for this mod. + * + * This requests mod information from the nexus. This is an asynchronous request, + * so there is no immediate effect of this call. + * + * @return returns true if information for this mod will be updated, false if there is no nexus mod id to use + **/ + bool updateNXMInfo(); - /** - * @brief set the name of this mod - * - * set the name of this mod. This will also update the name of the - * directory that contains this mod - * - * @param name new name of the mod - * @return true on success, false if the new name can't be used (i.e. because the new - * directory name wouldn't be valid) - **/ - bool setName(const QString& name); + /** + * @brief assign or unassign the specified category + * + * Every mod can have an arbitrary number of categories assigned to it + * + * @param categoryID id of the category to set + * @param active determines wheter the category is assigned or unassigned + * @note this function does not test whether categoryID actually identifies a valid category + **/ + void setCategory(int categoryID, bool active); - /** - * @brief change the notes (manually set information) for this mod - * @param notes new notes - */ - void setNotes(const QString& notes); + /** + * @brief set the name of this mod + * + * set the name of this mod. This will also update the name of the + * directory that contains this mod + * + * @param name new name of the mod + * @return true on success, false if the new name can't be used (i.e. because the new + * directory name wouldn't be valid) + **/ + bool setName(const QString &name); - /** - * @brief set/change the nexus mod id of this mod - * - * @param modID the nexus mod id - **/ - void setNexusID(int modID); + /** + * @brief change the notes (manually set information) for this mod + * @param notes new notes + */ + void setNotes(const QString ¬es); - /** - * @brief set the version of this mod - * - * this can be used to overwrite the version of a mod without actually - * updating the mod - * - * @param version the new version to use - **/ - void setVersion(const MOBase::VersionInfo& version); + /** + * @brief set/change the nexus mod id of this mod + * + * @param modID the nexus mod id + **/ + void setNexusID(int modID); - /** - * @brief set the newest version of this mod on the nexus - * - * this can be used to overwrite the version of a mod without actually - * updating the mod - * - * @param version the new version to use - * @todo this function should be made obsolete. All queries for mod information should go through - * this class so no public function for this change is required - **/ - void setNewestVersion(const MOBase::VersionInfo& version); + /** + * @brief set the version of this mod + * + * this can be used to overwrite the version of a mod without actually + * updating the mod + * + * @param version the new version to use + **/ + void setVersion(const MOBase::VersionInfo &version); - /** - * @brief changes/updates the nexus description text - * @param description the current description text - */ - virtual void setNexusDescription(const QString& description); + /** + * @brief set the newest version of this mod on the nexus + * + * this can be used to overwrite the version of a mod without actually + * updating the mod + * + * @param version the new version to use + * @todo this function should be made obsolete. All queries for mod information should go through + * this class so no public function for this change is required + **/ + void setNewestVersion(const MOBase::VersionInfo &version); - virtual void setInstallationFile(const QString& fileName); + /** + * @brief changes/updates the nexus description text + * @param description the current description text + */ + virtual void setNexusDescription(const QString &description); - /** - * @brief sets the category id from a nexus category id. Conversion to MO id happens internally - * @param categoryID the nexus category id - * @note if a mapping is not possible, the category is set to the default value - */ - virtual void addNexusCategory(int categoryID); + virtual void setInstallationFile(const QString &fileName); - /** - * @brief sets the new primary category of the mod - * @param categoryID the category to set - */ - virtual void setPrimaryCategory(int categoryID) { - m_PrimaryCategory = categoryID; - m_MetaInfoChanged = true; - } + /** + * @brief sets the category id from a nexus category id. Conversion to MO id happens internally + * @param categoryID the nexus category id + * @note if a mapping is not possible, the category is set to the default value + */ + virtual void addNexusCategory(int categoryID); - /** - * @brief sets the download repository - * @param repository - */ - virtual void setRepository(const QString& repository) { m_Repository = repository; } + /** + * @brief sets the new primary category of the mod + * @param categoryID the category to set + */ + virtual void setPrimaryCategory(int categoryID) { m_PrimaryCategory = categoryID; m_MetaInfoChanged = true; } - /** - * update the endorsement state for the mod. This only changes the - * buffered state, it does not sync with Nexus - * @param endorsed the new endorsement state - */ - virtual void setIsEndorsed(bool endorsed); + /** + * @brief sets the download repository + * @param repository + */ + virtual void setRepository(const QString &repository) { m_Repository = repository; } - /** - * set the mod to "i don't intend to endorse". The mod will not show as unendorsed but can still be endorsed - */ - virtual void setNeverEndorse(); + /** + * update the endorsement state for the mod. This only changes the + * buffered state, it does not sync with Nexus + * @param endorsed the new endorsement state + */ + virtual void setIsEndorsed(bool endorsed); - /** - * @brief delete the mod from the disc. This does not update the global ModInfo structure or indices - * @return true if the mod was successfully removed - **/ - bool remove(); + /** + * set the mod to "i don't intend to endorse". The mod will not show as unendorsed but can still be endorsed + */ + virtual void setNeverEndorse(); - /** - * @brief endorse or un-endorse the mod - * @param doEndorse if true, the mod is endorsed, if false, it's un-endorsed. - * @note if doEndorse doesn't differ from the current value, nothing happens. - */ - virtual void endorse(bool doEndorse); + /** + * @brief delete the mod from the disc. This does not update the global ModInfo structure or indices + * @return true if the mod was successfully removed + **/ + bool remove(); - /** - * @brief getter for the mod name - * - * @return the mod name - **/ - QString name() const { return m_Name; } + /** + * @brief endorse or un-endorse the mod + * @param doEndorse if true, the mod is endorsed, if false, it's un-endorsed. + * @note if doEndorse doesn't differ from the current value, nothing happens. + */ + virtual void endorse(bool doEndorse); - /** - * @brief getter for the mod path - * - * @return the (absolute) path to the mod - **/ - QString absolutePath() const; + /** + * @brief getter for the mod name + * + * @return the mod name + **/ + QString name() const { return m_Name; } - /** - * @brief getter for the newest version number of this mod - * - * @return newest version of the mod - **/ - MOBase::VersionInfo getNewestVersion() const { return m_NewestVersion; } + /** + * @brief getter for the mod path + * + * @return the (absolute) path to the mod + **/ + QString absolutePath() const; - /** - * @brief ignore the newest version for updates - */ - void ignoreUpdate(bool ignore); + /** + * @brief getter for the newest version number of this mod + * + * @return newest version of the mod + **/ + MOBase::VersionInfo getNewestVersion() const { return m_NewestVersion; } - /** - * @brief getter for the installation file - * - * @return file used to install this mod from - */ - virtual QString getInstallationFile() const { return m_InstallationFile; } - /** - * @brief getter for the nexus mod id - * - * @return the nexus mod id. may be 0 if the mod id isn't known or doesn't exist - **/ - int getNexusID() const { return m_NexusID; } + /** + * @brief ignore the newest version for updates + */ + void ignoreUpdate(bool ignore); - /** - * @return the fixed priority of mods of this type or INT_MIN if the priority of mods - * needs to be user-modifiable - */ - virtual int getFixedPriority() const { return INT_MIN; } + /** + * @brief getter for the installation file + * + * @return file used to install this mod from + */ + virtual QString getInstallationFile() const { return m_InstallationFile; } + /** + * @brief getter for the nexus mod id + * + * @return the nexus mod id. may be 0 if the mod id isn't known or doesn't exist + **/ + int getNexusID() const { return m_NexusID; } - /** - * @return true if the mod can be updated - */ - virtual bool canBeUpdated() const { return m_NexusID > 0; } + /** + * @return the fixed priority of mods of this type or INT_MIN if the priority of mods + * needs to be user-modifiable + */ + virtual int getFixedPriority() const { return INT_MIN; } - /** - * @return true if the mod can be enabled/disabled - */ - virtual bool canBeEnabled() const { return true; } + /** + * @return true if the mod can be updated + */ + virtual bool canBeUpdated() const { return m_NexusID > 0; } - /** - * @return a list of flags for this mod - */ - virtual std::vector<EFlag> getFlags() const; + /** + * @return true if the mod can be enabled/disabled + */ + virtual bool canBeEnabled() const { return true; } - virtual std::vector<EContent> getContents() const; + /** + * @return a list of flags for this mod + */ + virtual std::vector<EFlag> getFlags() const; - /** - * @return an indicator if and how this mod should be highlighted by the UI - */ - virtual int getHighlight() const; + virtual std::vector<EContent> getContents() const; - /** - * @return list of names of ini tweaks - **/ - std::vector<QString> getIniTweaks() const; + /** + * @return an indicator if and how this mod should be highlighted by the UI + */ + virtual int getHighlight() const; - /** - * @return a description about the mod, to be displayed in the ui - */ - virtual QString getDescription() const; + /** + * @return list of names of ini tweaks + **/ + std::vector<QString> getIniTweaks() const; - /** - * @return manually set notes for this mod - */ - virtual QString notes() const; + /** + * @return a description about the mod, to be displayed in the ui + */ + virtual QString getDescription() const; - /** - * @return time this mod was created (file time of the directory) - */ - virtual QDateTime creationTime() const; + /** + * @return manually set notes for this mod + */ + virtual QString notes() const; - /** - * @return nexus description of the mod (html) - */ - QString getNexusDescription() const; + /** + * @return time this mod was created (file time of the directory) + */ + virtual QDateTime creationTime() const; - /** - * @return repository from which the file was downloaded - */ - virtual QString repository() const; + /** + * @return nexus description of the mod (html) + */ + QString getNexusDescription() const; - /** - * @return true if the file has been endorsed on nexus - */ - virtual EEndorsedState endorsedState() const; + /** + * @return repository from which the file was downloaded + */ + virtual QString repository() const; - /** - * @return last time nexus was queried for infos on this mod - */ - virtual QDateTime getLastNexusQuery() const; + /** + * @return true if the file has been endorsed on nexus + */ + virtual EEndorsedState endorsedState() const; - virtual QStringList archives() const; + /** + * @return last time nexus was queried for infos on this mod + */ + virtual QDateTime getLastNexusQuery() const; - virtual void addInstalledFile(int modId, int fileId); + virtual QStringList archives() const; - /** - * @brief stores meta information back to disk - */ - virtual void saveMeta(); + virtual void addInstalledFile(int modId, int fileId); - void readMeta(); + /** + * @brief stores meta information back to disk + */ + virtual void saveMeta(); - /** - * @brief set the URL for a mod - */ - virtual void setURL(QString const&); + void readMeta(); - /** - * @returns the URL for a mod - */ - virtual QString getURL() const; + /** + * @brief set the URL for a mod + */ + virtual void setURL(QString const &); + + /** + * @returns the URL for a mod + */ + virtual QString getURL() const; private: - void setEndorsedState(EEndorsedState endorsedState); + + void setEndorsedState(EEndorsedState endorsedState); private slots: - void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData); - void nxmEndorsementToggled(int, QVariant userData, QVariant resultData); - void nxmRequestFailed(int modID, int fileID, QVariant userData, const QString& errorMessage); + void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData); + void nxmEndorsementToggled(int, QVariant userData, QVariant resultData); + void nxmRequestFailed(int modID, int fileID, QVariant userData, const QString &errorMessage); protected: - ModInfoRegular(const QDir& path, MOShared::DirectoryEntry** directoryStructure); + + ModInfoRegular(const QDir &path, MOShared::DirectoryEntry **directoryStructure); private: - QString m_Name; - QString m_Path; - QString m_InstallationFile; - QString m_Notes; - QString m_NexusDescription; - QString m_Repository; - QString m_URL; - QDateTime m_CreationTime; - QDateTime m_LastNexusQuery; + QString m_Name; + QString m_Path; + QString m_InstallationFile; + QString m_Notes; + QString m_NexusDescription; + QString m_Repository; + QString m_URL; - int m_NexusID; - std::set<std::pair<int, int>> m_InstalledFileIDs; + QDateTime m_CreationTime; + QDateTime m_LastNexusQuery; - bool m_MetaInfoChanged; - MOBase::VersionInfo m_NewestVersion; - MOBase::VersionInfo m_IgnoredVersion; + int m_NexusID; + std::set<std::pair<int, int>> m_InstalledFileIDs; - EEndorsedState m_EndorsedState; + bool m_MetaInfoChanged; + MOBase::VersionInfo m_NewestVersion; + MOBase::VersionInfo m_IgnoredVersion; - NexusBridge m_NexusBridge; + EEndorsedState m_EndorsedState; + + NexusBridge m_NexusBridge; + + mutable std::vector<ModInfo::EContent> m_CachedContent; + mutable QTime m_LastContentCheck; - mutable std::vector<ModInfo::EContent> m_CachedContent; - mutable QTime m_LastContentCheck; }; + #endif // MODINFOREGULAR_H |