diff options
Diffstat (limited to 'src/modinfo.h')
| -rw-r--r-- | src/modinfo.h | 826 |
1 files changed, 502 insertions, 324 deletions
diff --git a/src/modinfo.h b/src/modinfo.h index df47ef95..5602531d 100644 --- a/src/modinfo.h +++ b/src/modinfo.h @@ -48,13 +48,13 @@ namespace MOShared { class DirectoryEntry; } * Represents meta information about a single mod. The class interface is used * to manage the mod collection * - **/ + */ class ModInfo : public QObject, public MOBase::IModInterface { Q_OBJECT -public: +public: // Type definitions: typedef QSharedPointer<ModInfo> Ptr; @@ -102,11 +102,11 @@ public: }; -public: +public: // Static functions: /** - * @brief read the mod directory and Mod ModInfo objects for all subdirectories - **/ + * @brief Read the mod directory and Mod ModInfo objects for all subdirectories. + */ static void updateFromDisc(const QString &modDirectory, MOShared::DirectoryEntry **directoryStructure, PluginContainer *pluginContainer, @@ -117,388 +117,556 @@ public: static void clear() { s_Collection.clear(); s_ModsByName.clear(); s_ModsByModID.clear(); } /** - * @brief retrieve the number of mods + * @brief Retrieve the number of mods. * - * @return number of mods - **/ + * @return the number of mods. + */ static unsigned int getNumMods(); /** - * @brief retrieve a ModInfo object based on its index + * @brief Retrieve a ModInfo object based on its index. + * + * @param index The index to look up. The maximum value is getNumMods() - 1. * - * @param index the index to look up. the maximum is getNumMods() - 1 * @return a reference counting pointer to the mod info. - * @note since the pointer is reference counting, the pointer remains valid even if the collection is refreshed in a different thread - **/ + * + * @note since the pointer is reference counting, the pointer remains valid even if the + * collection is refreshed in a different thread. + */ static ModInfo::Ptr getByIndex(unsigned int index); /** - * @brief retrieve a ModInfo object based on its nexus mod id + * @brief Retrieve ModInfo objects based on mod id. * - * @param modID the nexus mod id to look up - * @return a reference counting pointer to the mod info - * @todo in its current form, this function is broken! There may be multiple mods with the same nexus id, - * this function will return only one of them - **/ + * @param modID The mod id to look up. + * + * @return a vector of reference counting pointer to the mod info objects with the given mod ID. + */ static std::vector<ModInfo::Ptr> getByModID(QString game, int modID); /** - * @brief retrieve a ModInfo object based on its name + * @brief Retrieve a ModInfo object based on its name. + * + * @param name The name to look up. + * + * @return a reference counting pointer to the mod info. * - * @param name the name to look up - * @return a reference counting pointer to the mod info - * @note since the pointer is reference counter, the pointer remains valid even if the collection is refreshed in a different thread - **/ + * @note Since the pointer is reference counter, the pointer remains valid even if the + * collection is refreshed in a different thread. + */ static ModInfo::Ptr getByName(const QString &name); /** - * @brief remove a mod by index + * @brief Remove a mod by index. + * + * This physically deletes the specified mod from the disc and updates the ModInfo collection + * but not other structures that reference mods. + * + * @param index Index of the mod to delete. * - * this physically deletes the specified mod from the disc and updates the ModInfo collection - * but not other structures that reference mods - * @param index index of the mod to delete - * @return true if removal was successful, fals otherwise - **/ + * @return true if removal was successful, false otherwise. + */ static bool removeMod(unsigned int index); /** - * @brief retrieve the mod index by the mod name + * @brief Retrieve the mod index by the mod name. + * + * @param name Name of the mod to look up. * - * @param name name of the mod to look up - * @return the index of the mod. If the mod doesn't exist, UINT_MAX is returned - **/ + * @return The index of the mod. If the mod doesn't exist, UINT_MAX is returned. + */ static unsigned int getIndex(const QString &name); /** - * @brief find the first mod that fulfills the filter function (after no particular order) - * @param filter a function to filter by. should return true for a match - * @return index of the matching mod or UINT_MAX if there wasn't a match + * @brief Find the first mod that fulfills the filter function (after no particular order). + * + * @param filter A function to filter mods by. Should return true for a match. + * + * @return index of the matching mod or UINT_MAX if there was no match. */ static unsigned int findMod(const boost::function<bool (ModInfo::Ptr)> &filter); /** - * @brief run a limited batch of mod update checks for "newest version" information + * @brief Run a limited batch of mod update checks for "newest version" information. + * */ - static void manualUpdateCheck(PluginContainer *pluginContainer, QObject *receiver, std::multimap<QString, int> IDs); + static void manualUpdateCheck( + PluginContainer *pluginContainer, QObject *receiver, std::multimap<QString, int> IDs); /** - * @brief query nexus information for every mod and update the "newest version" information - * @return true if any mods are checked for update - **/ + * @brief Query nexus information for every mod and update the "newest version" information. + * + * @return true if any mods are checked for update. + */ static bool checkAllForUpdate(PluginContainer *pluginContainer, QObject *receiver); - static std::set<QSharedPointer<ModInfo>> filteredMods(QString gameName, QVariantList updateData, bool addOldMods = false, bool markUpdated = false); + /** + * + */ + static std::set<ModInfo::Ptr> filteredMods( + QString gameName, QVariantList updateData, bool addOldMods = false, bool markUpdated = false); /** - * @brief create a new mod from the specified directory and add it to the collection - * @param dir directory to create from - * @return pointer to the info-structure of the newly created/added mod + * @brief Create a new mod from the specified directory and add it to the collection. + * + * @param dir Directory to create from. + * + * @return pointer to the info-structure of the newly created/added mod. */ - static ModInfo::Ptr createFrom(PluginContainer *pluginContainer, const MOBase::IPluginGame *game, const QDir &dir, MOShared::DirectoryEntry **directoryStructure); + static ModInfo::Ptr createFrom( + PluginContainer *pluginContainer, const MOBase::IPluginGame *game, + const QDir &dir, MOShared::DirectoryEntry **directoryStructure); /** - * @brief create a new "foreign-managed" mod from a tuple of plugin and archives - * @param espName name of the plugin - * @param bsaNames names of archives - * @return a new mod + * @brief Create a new "foreign-managed" mod from a tuple of plugin and archives. + * + * @param espName Name of the plugin. + * @param bsaNames Names of archives. + * + * @return a new mod. */ - static ModInfo::Ptr createFromPlugin(const QString &modName, const QString &espName, const QStringList &bsaNames, ModInfo::EModType modType, - const MOBase::IPluginGame* game, MOShared::DirectoryEntry **directoryStructure, PluginContainer *pluginContainer); + static ModInfo::Ptr createFromPlugin( + const QString &modName, const QString &espName, const QStringList &bsaNames, + ModInfo::EModType modType, const MOBase::IPluginGame* game, + MOShared::DirectoryEntry **directoryStructure, PluginContainer *pluginContainer); - // whether the given name is used for separators - // + /** + * @brief Check wheter a name corresponds to a separator or not, + * + * @return whether the given name is used for separators. + */ static bool isSeparatorName(const QString& name); - // whether the given name is used for backups - // + /** + * @brief Check wheter a name corresponds to a backup or not, + * + * @return whether the given name is used for backups. + */ static bool isBackupName(const QString& name); - // whether the given name is used for regular mods - // + /** + * @brief Check wheter a name corresponds to a regular mod or not, + * + * @return whether the given name corresponds to a regular mod. + */ static bool isRegularName(const QString& name); - virtual bool isRegular() const { return false; } +public: // IModInterface implementations / Re-declaration - virtual bool isEmpty() const { return false; } + // Note: This section contains default-implementation for some of the virtual methods from + // IModInterface, but also redeclaration of all the pure-virtual methods to centralize all + // of them in a single place. /** - * @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 - **/ - virtual bool updateAvailable() const = 0; + * @return the name of the mod. + */ + virtual QString name() const = 0; /** - * @return true if the update currently available is ignored + * @return the absolute path to the mod to be used in file system operations. */ - virtual bool updateIgnored() const = 0; + virtual QString absolutePath() const = 0; /** - * @brief test if the "newest" version of the mod is older than the installed version + * @return the comments for this mod, if any. + */ + virtual QString comments() const = 0; + + /** + * @return the notes for this mod, if any. + */ + virtual QString notes() const = 0; + + /** + * @brief Retrieve the short name of the game associated with this mod. This may differ + * from the current game plugin (e.g. you can install a Skyrim LE game in a SSE + * installation). * - * 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 the name of the game associated with this mod. + */ + virtual QString gameName() const = 0; + + /** + * @return the name of the repository from which this mod was installed. + */ + virtual QString repository() const override { return ""; } + + /** + * @return the ID of this mod on the repository. * - * @return true if the newest version is older than the installed one - **/ - virtual bool downgradeAvailable() const = 0; + * @note For Nexus, this is the Nexus ID of the mod. + */ + virtual int modId() const = 0; + + /** + * @return the current version of this mod. + */ + virtual MOBase::VersionInfo version() const override { return m_Version; } + + /** + * @return the newest version of thid mod (as known by MO2). If this matches version(), + * then the mod is up-to-date. + */ + virtual MOBase::VersionInfo newestVersion() const = 0; /** - * @brief request an update of nexus description for this mod. + * @return the ignored version of this mod (for update), or an invalid version if the user + * did not ignore version for this mod. + */ + virtual MOBase::VersionInfo ignoredVersion() const = 0; + + /** + * @return the absolute path to the file that was used to install this mod. + */ + virtual QString installationFile() const = 0; + + virtual std::set<std::pair<int, int>> installedFiles() const = 0; + + /** + * @return true if this mod was marked as converted by the user. * - * This requests mod information from the nexus. This is an asynchronous request, - * so there is no immediate effect of this call. - * Right now, Mod Organizer interprets the "newest version" and "description" from the - * response, though the description is only stored in memory + * @note When a mod is for a different game, a flag is shown to users to warn them, but + * they can mark mods as converted to remove this flag. + */ + virtual bool converted() const = 0; + + /** + * @return true if th is mod was marked as containing valid game data. * - **/ - virtual bool updateNXMInfo() = 0; + * @note MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in + * which case mods are incorrectly marked as 'not containing valid games data'. Users can + * choose to mark these mods as valid to hide the warning / flag. + */ + virtual bool validated() const = 0; + + /** + * @return the color of the 'Notes' column chosen by the user. + */ + virtual QColor color() const override { return QColor(); } + + /** + * @return the URL of this mod, or an empty QString() if no URL is associated + * with this mod. + */ + virtual QString url() const override { return ""; } + + /** + * @return the ID of the primary category of this mod. + */ + int primaryCategory() const override { return m_PrimaryCategory; } + + /** + * @return the list of categories this mod belongs to. + */ + virtual QStringList categories() const override; + + /** + * @return the tracked state of this mod. + */ + virtual MOBase::TrackedState trackedState() const override { return MOBase::TrackedState::TRACKED_FALSE; } + + /** + * @return the endorsement state of this mod. + */ + virtual MOBase::EndorsedState endorsedState() const override { return MOBase::EndorsedState::ENDORSED_NEVER; } + +public: // Mutable operations: /** - * @brief assign or unassign the specified category + * @brief Sets or changes the version of this mod. * - * Every mod can have an arbitrary number of categories assigned to it + * @param version New version of the mod. + */ + virtual void setVersion(const MOBase::VersionInfo& version) override; + + /** + * @brief Sets the installation file for this mod. * - * @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 - **/ - virtual void setCategory(int categoryID, bool active) = 0; + * @param fileName archive file name. + */ + virtual void setInstallationFile(const QString& fileName) = 0; /** - * @brief changes the comments (manually set information displayed in the mod list) for this mod - * @param comments new comments + * @brief Sets or changes the latest known version of this mod. + * + * @param version Newest known version of the mod. */ - virtual void setComments(const QString &comments) = 0; + virtual void setNewestVersion(const MOBase::VersionInfo& version) = 0; /** - * @brief change the notes (manually set information) for this mod - * @param notes new notes + * @brief Sets endorsement state of the mod. + * + * @param endorsed New endorsement state. */ - virtual void setNotes(const QString ¬es) = 0; + virtual void setIsEndorsed(bool endorsed) = 0; /** - * @brief set/change the source game of this mod + * @brief Sets the mod id on nexus for this mod. * - * @param gameName the source game shortName + * @param nexusID The new Nexus id to set. */ - virtual void setGameName(const QString& gameName) = 0; + virtual void setNexusID(int nexusID) = 0; /** - * @brief set the name of this mod + * @brief Sets the category id from a nexus category id. Conversion to MO id happens + * internally. * - * set the name of this mod. This will also update the name of the - * directory that contains this mod + * @param categoryID The nexus category id. * - * @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) - **/ - virtual bool setName(const QString& name) = 0; + * @note If a mapping is not possible, the category is set to the default value. + */ + virtual void addNexusCategory(int categoryID) = 0; /** - * @brief set/change the nexus mod id of this mod + * @brief Assigns a category to the mod. If the named category does not exist it is created. * - * @param modID the nexus mod id - **/ - virtual void setNexusID(int modID) = 0; + * @param categoryName Name of the new category. + */ + virtual void addCategory(const QString& categoryName) override; /** - * @brief set/change the version of this mod - * @param version new version of the mod + * @brief Unassigns a category from this mod. + * + * @param categoryName Name of the category to be removed. + * + * @return true if the category was removed successfully, false if no such category + * was assigned. */ - virtual void setVersion(const MOBase::VersionInfo &version) override; + virtual bool removeCategory(const QString& categoryName) override; /** - * @brief Controls if mod should be highlighted based on plugin selection - * @param isSelected whether or not the plugin has a selected mod - **/ - virtual void setPluginSelected(const bool &isSelected); + * @brief Sets or changes the source game of this mod. + * + * @param gameName The source game short name. + */ + virtual void setGameName(const QString& gameName) = 0; /** - * @brief set the newest version of this mod on the nexus + * @brief Sets the name of this mod. * - * this can be used to overwrite the version of a mod without actually - * updating the mod + * This will also update the name of the directory that contains this 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 - **/ - virtual void setNewestVersion(const MOBase::VersionInfo &version) = 0; + * @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). + */ + virtual bool setName(const QString& name) = 0; /** - * @brief sets the repository that was used to download the mod + * @brief Deletes the mod from the disc. This does not update the global ModInfo structure or + * indices. + * + * @return true on success, false otherwise. */ - virtual void setRepository(const QString &) {} + virtual bool remove() = 0; + +public: // Methods after this do not come from IModInterface: /** - * @brief changes/updates the nexus description text - * @param description the current description text + * @return true if this mod is a regular mod, false otherwise. */ - virtual void setNexusDescription(const QString &description) = 0; + virtual bool isRegular() const { return false; } /** - * @brief sets the file this mod was installed from - * @param fileName name of the file + * @return true if this mod is empty, false otherwise. */ - virtual void setInstallationFile(const QString &fileName) = 0; + virtual bool isEmpty() const { return false; } /** - * @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 + * @brief Check if there is a newer version of the mod. + * + * Check 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, false otherwise. */ - virtual void addNexusCategory(int categoryID) = 0; - - virtual void addCategory(const QString &categoryName) override; - virtual bool removeCategory(const QString &categoryName) override; + virtual bool updateAvailable() const = 0; - virtual QStringList categories() const override; + /** + * @return true if the update currently available is ignored. + */ + virtual bool updateIgnored() const = 0; /** - * 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 + * @brief Check if the "newest" version of the mod is older than the installed version. + * + * Check 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 the newest version is older than the installed one. */ - virtual void setIsEndorsed(bool endorsed) = 0; + virtual bool downgradeAvailable() const = 0; /** - * set the mod to "i don't intend to endorse". The mod will not show as unendorsed but can still be endorsed + * @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. Right now, Mod Organizer interprets the + * "newest version" and "description" from the response, though the description is only + * stored in memory. + * */ - virtual void setNeverEndorse() = 0; + virtual bool updateNXMInfo() = 0; /** - * update the tracked state for the mod. This only changes the - * buffered state, it does not sync with Nexus - * @param tracked the new tracked state + * @brief Assigns or unassigns 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 whether the category is assigned or unassigned. + * + * @note This function does not test whether categoryID actually identifies a valid category. */ - virtual void setIsTracked(bool tracked) = 0; + virtual void setCategory(int categoryID, bool active) = 0; /** - * @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 - **/ - virtual bool remove() = 0; + * @brief Changes the comments (manually set information displayed in the mod list) for this mod. + * + * @param comments The new comments. + */ + virtual void setComments(const QString &comments) = 0; /** - * @brief endorse or un-endorse the mod. This will sync with nexus! - * @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. + * @brief Change the notes (manually set information) for this mod. + * + * @param notes The new notes. */ - virtual void endorse(bool doEndorse) = 0; + virtual void setNotes(const QString ¬es) = 0; + + /** + * @brief Controls if mod should be highlighted based on plugin selection. + * + * @param isSelected Whether or not the plugin has a selected mod. + */ + virtual void setPluginSelected(const bool &isSelected); /** - * @brief track or untrack the mod. This will sync with nexus! - * @param doTrack if true, the mod is tracked, if false, it's untracked. - * @note if doTrack doesn't differ from the current value, nothing happens. + * @brief Sets the repository that was used to download the mod. */ - virtual void track(bool doTrack) = 0; + virtual void setRepository(const QString &) {} /** - * @brief clear all caches held for this mod + * @brief Set the mod to "I do not intend to endorse.". The mod will not show as unendorsed + * but can still be endorsed. */ - virtual void clearCaches() {} + virtual void setNeverEndorse() = 0; /** - * @brief getter for the mod name + * @brief Updates the tracked state for the mod. This only changes the buffered state, + * it does not sync with Nexus. * - * @return the mod name - **/ - virtual QString name() const = 0; + * @param tracked The new tracked state. + * + * @see track(bool) + */ + virtual void setIsTracked(bool tracked) = 0; /** - * @brief getter for an internal name. This is usually the same as the regular name, but with special mod types it might be - * this is used to distinguish between mods that have the same visible name - * @return internal mod name + * @brief Endorses or un-endorses the mod. This will sync with nexus! + * + * @param doEndorse If true, the mod is endorsed, if false, it's un-endorsed. + * + * @note If doEndorse does not differ from the current value, nothing happens. */ - virtual QString internalName() const { return name(); } + virtual void endorse(bool doEndorse) = 0; /** - * @brief getter for the mod path + * @brief Tracks or untracks the mod. This will sync with nexus! * - * @return the (absolute) path to the mod - **/ - virtual QString absolutePath() const = 0; + * @param doTrack If true, the mod is tracked, if false, it's untracked. + * + * @note If doTrack does not differ from the current value, nothing happens. + */ + virtual void track(bool doTrack) = 0; /** - * @return version object for machine based comparisons - **/ - virtual MOBase::VersionInfo version() const { return m_Version; } + * @brief Clear all caches held for this mod. + */ + virtual void clearCaches() {} /** - * @return the repository from which the file was downloaded. Only relevant regular mods + * @brief Retrieve the internal name of the mod. This is usually the same as the regular name, + * but with special mod types it might be used to distinguish between mods that have the same + * visible name. + * + * @return the internal mod name. */ - virtual QString repository() const override { return ""; } + virtual QString internalName() const { return name(); } /** - * @brief ignore the newest version for updates + * @brief Ignores the newest version for updates. */ virtual void ignoreUpdate(bool ignore) = 0; /** * @return the fixed priority of mods of this type or INT_MIN if the priority of mods - * needs to be user-modifiable. Can be < 0 to force a priority below user-modifable mods - * or INT_MAX to force priority above all user-modifiables + * needs to be user-modifiable. Can be < 0 to force a priority below user-modifable mods + * or INT_MAX to force priority above all user-modifiables. */ virtual int getFixedPriority() const = 0; /** - * @return true if the mod is always enabled + * @return true if the mod is always enabled. */ virtual bool alwaysEnabled() const { return false; } /** - * @return true if the mod can be updated + * @return true if the mod can be updated. */ virtual bool canBeUpdated() const { return false; } /** - * @return the mod update check expiration date + * @return the mod update check expiration date. */ virtual QDateTime getExpires() const = 0; /** - * @return true if the mod can be enabled/disabled + * @return true if the mod can be enabled/disabled. */ virtual bool canBeEnabled() const { return false; } /** - * @return a list of flags for this mod + * @return a list of flags for this mod. */ virtual std::vector<EFlag> getFlags() const = 0; /** - * @return a list of conflict flags for this mod + * @return a list of conflict flags for this mod. */ virtual std::vector<EConflictFlag> getConflictFlags() const = 0; /** - * @return a list of content types contained in a mod + * @return a list of content types contained in a mod. + * + * @note The IDs of the content are game-dependent. See the ModDataContent game feature + * for more details on this. */ virtual const std::set<int>& getContents() const = 0; /** - * @brief test if the specified flag is set for this mod - * @param flag the flag to test - * @return true if the flag is set, false otherwise + * @brief Check if the specified flag is set for this mod. + * + * @param flag The flag to test. + * + * @return true if the flag is set, false otherwise. */ bool hasFlag(EFlag flag) const; /** - * @brief test if any of the provided flags are set for this mod - * @param flags the flags to test - * @return true if any of the flags are set, false otherwise + * @brief Check if any of the provided flags are set for this mod. + * + * @param flags The flags to test. + * + * @return true if any of the flags are set, false otherwise. */ bool hasAnyOfTheseFlags(std::vector<ModInfo::EFlag> flags) const; /** - * @brief Test if the mod contains the specified content. + * @brief Check if this mod contains the specified content. * * @param content ID of the content to test. * @@ -507,222 +675,232 @@ public: virtual bool hasContent(int content) const = 0; /** - * @return an indicator if and how this mod should be highlighted by the UI + * @return an indicator if and how this mod should be highlighted in the UI. */ virtual int getHighlight() const { return HIGHLIGHT_NONE; } /** - * @return list of names of ini tweaks - **/ + * @return the list of INI tweaks in this mod. + */ virtual std::vector<QString> getIniTweaks() const = 0; /** - * @return a description about the mod, to be displayed in the ui + * @return the description of the mod, to display in the UI. */ virtual QString getDescription() const = 0; /** - * @return the nexus file status (aka category ID) - */ - virtual int getNexusFileStatus() const = 0; - - - /** - * @brief sets the file status (category ID) from Nexus - * @param status the status id of the installed file - */ - virtual void setNexusFileStatus(int status) = 0; - - /** - * @return creation time of this mod + * @return the creation time of this mod. */ virtual QDateTime creationTime() const = 0; /** - * @return nexus description of the mod (html) + * @return the list of files that, if they exist in the data directory are treated as files in + * THIS mod. */ - virtual QString getNexusDescription() const = 0; + virtual QStringList stealFiles() const { return QStringList(); } /** - * @brief get the last time nexus was checked for file updates on this mod + * @return the list of archives belonging to this mod (as absolute file paths). */ - virtual QDateTime getLastNexusUpdate() const = 0; + virtual QStringList archives(bool checkOnDisk = false) = 0; /** - * @brief set the last time nexus was checked for file updates on this mod + * @brief Set the color of this mod for display. + * + * @param color New color of this mod. + * + * @note Currently, this changes the color of the cell under the "Notes" column. */ - virtual void setLastNexusUpdate(QDateTime time) = 0; + virtual void setColor(QColor color) { } /** - * @return last time nexus was queried for infos on this mod + * @brief Adds the information that a file has been installed into this mod. + * + * @param modId ID of the mod installed. + * @param fileId ID of the file installed. */ - virtual QDateTime getLastNexusQuery() const = 0; + virtual void addInstalledFile(int modId, int fileId) = 0; /** - * @brief set the last time nexus was queried for info on this mod + * @brief Check if the mod belongs to the specified category. + * + * @param categoryID ID of the category to test for. + * + * @return true if the mod belongs to the specified category. + * + * @note This does not verify the id actually identifies a category. */ - virtual void setLastNexusQuery(QDateTime time) = 0; + bool categorySet(int categoryID) const; /** - * @return last time the mod was updated on Nexus + * @brief Retrieves the whole list of categories (as ids) this mod belongs to. + * + * @return the IDs of categories this mod belongs to. */ - virtual QDateTime getNexusLastModified() const = 0; + const std::set<int> &getCategories() const { return m_Categories; } /** - * @brief set the last time the mod was updated on Nexus + * @brief Sets the new primary category of the mod. + * + * @param categoryID ID of the primary category to set. */ - virtual void setNexusLastModified(QDateTime time) = 0; + virtual void setPrimaryCategory(int categoryID) { m_PrimaryCategory = categoryID; } /** - * @return a list of files that, if they exist in the data directory are treated as files in THIS mod + * @return true if this mod is considered "valid", that is it contains data used by the game. */ - virtual QStringList stealFiles() const { return QStringList(); } + virtual bool isValid() const = 0; /** - * @return a list of archives belonging to this mod (as absolute file paths) + * @brief Updates the mod to flag it as converted in order to ignore the alternate game + * warning. */ - virtual QStringList archives(bool checkOnDisk = false) = 0; + virtual void markConverted(bool) {} /** - * @return the color choosen by the user for the mod/separator - */ - virtual QColor color() const override { return QColor(); } + * @brief Updates the mod to flag it as valid in order to ignore the invalid game data + * flag. + */ + virtual void markValidated(bool) {} /** - * + * @brief Reads meta information from disk. */ - virtual void setColor(QColor) { } + virtual void readMeta() {} /** - * @brief adds the information that a file has been installed into this mod - * @param modId id of the mod installed - * @param fileId id of the file installed + * @brief Stores meta information back to disk. */ - virtual void addInstalledFile(int modId, int fileId) = 0; + virtual void saveMeta() {} /** - * @brief test if the mod belongs to the specified category - * - * @param categoryID the category to test for. - * @return true if the mod belongs to the specified category - * @note this does not verify the id actually identifies a category - **/ - bool categorySet(int categoryID) const; + * @brief Sets whether this mod uses a custom url. + */ + virtual void setHasCustomURL(bool) {} /** - * @brief retrive the whole list of categories (as ids) this mod belongs to + * @brief Check whether this mod uses a custom url. * - * @return list of categories - **/ - const std::set<int> &getCategories() const { return m_Categories; } + * @return true if this mod has a custom URL, false otherwise. + */ + virtual bool hasCustomURL() const { return false; } /** - * @return id of the primary category of this mod + * @brief Sets the custom url. */ - int primaryCategory() const override { return m_PrimaryCategory; } + virtual void setCustomURL(QString const&) {} /** - * @brief sets the new primary category of the mod - * @param categoryID the category to set + * If hasCustomURL() is true and getCustomURL() is not empty, tries to parse + * the url using QUrl::fromUserInput() and returns it. Otherwise, returns an + * empty QUrl. */ - virtual void setPrimaryCategory(int categoryID) { m_PrimaryCategory = categoryID; } + QUrl parseCustomURL() const; - /** - * @return true if this mod is considered "valid", that is: it contains data used by the game - **/ - virtual bool isValid() const = 0; +public: // Nexus stuff /** - * @return true if the file has been endorsed on nexus + * @brief Changes the nexus description text. + * + * @param description The current description text. */ - virtual MOBase::EndorsedState endorsedState() const override { return MOBase::EndorsedState::ENDORSED_NEVER; } + virtual void setNexusDescription(const QString& description) = 0; /** - * @return true if the file is being tracked on nexus + * @return the nexus file status (aka category ID). */ - virtual MOBase::TrackedState trackedState() const override { return MOBase::TrackedState::TRACKED_FALSE; } + virtual int getNexusFileStatus() const = 0; /** - * @brief updates the mod to flag it as converted in order to ignore the alternate game warning + * @brief Sets the file status (category ID) from Nexus. + * + * @param status The status id of the installed file. */ - virtual void markConverted(bool) {} + virtual void setNexusFileStatus(int status) = 0; /** - * @brief updates the mod to flag it as valid in order to ignore the invalid game data flag - */ - virtual void markValidated(bool) {} + * @return the nexus description of the mod (html). + */ + virtual QString getNexusDescription() const = 0; /** - * @brief reads meta information from disk + * @brief Get the last time nexus was checked for file updates on this mod. */ - virtual void readMeta() {} + virtual QDateTime getLastNexusUpdate() const = 0; /** - * @brief stores meta information back to disk + * @brief Sets the last time nexus was checked for file updates on this mod. */ - virtual void saveMeta() {} + virtual void setLastNexusUpdate(QDateTime time) = 0; /** - * @return retrieve list of mods (as mod index) that are overwritten by this one. Updates may be delayed + * @return the last time nexus was queried for infos on this mod. */ - virtual std::set<unsigned int> getModOverwrite() const { return std::set<unsigned int>(); } + virtual QDateTime getLastNexusQuery() const = 0; /** - * @return list of mods (as mod index) that overwrite this one. Updates may be delayed + * @brief Sets the last time nexus was queried for info on this mod. */ - virtual std::set<unsigned int> getModOverwritten() const { return std::set<unsigned int>(); } + virtual void setLastNexusQuery(QDateTime time) = 0; /** - * @return retrieve list of mods (as mod index) with archives that are overwritten by this one. Updates may be delayed - */ - virtual std::set<unsigned int> getModArchiveOverwrite() const { return std::set<unsigned int>(); } + * @return the last time the mod was updated on Nexus. + */ + virtual QDateTime getNexusLastModified() const = 0; /** - * @return list of mods (as mod index) with archives that overwrite this one. Updates may be delayed - */ - virtual std::set<unsigned int> getModArchiveOverwritten() const { return std::set<unsigned int>(); } + * @brief Set the last time the mod was updated on Nexus. + */ + virtual void setNexusLastModified(QDateTime time) = 0; - /** - * @return retrieve list of mods (as mod index) with archives that are overwritten by thos mod's loose files. Updates may be delayed - */ - virtual std::set<unsigned int> getModArchiveLooseOverwrite() const { return std::set<unsigned int>(); } +public: // Conflicts /** - * @return list of mods (as mod index) with loose files that overwrite this one's archive files. Updates may be delayed - */ - virtual std::set<unsigned int> getModArchiveLooseOverwritten() const { return std::set<unsigned int>(); } + * @return retrieve list of mods (as mod index) that are overwritten by this one. + * Updates may be delayed. + */ + virtual std::set<unsigned int> getModOverwrite() const { + return std::set<unsigned int>(); } /** - * @brief update conflict information + * @return list of mods (as mod index) that overwrite this one. Updates may be delayed. */ - virtual void doConflictCheck() const {} + virtual std::set<unsigned int> getModOverwritten() const { + return std::set<unsigned int>(); } /** - * @brief sets whether this mod uses a custom url - **/ - virtual void setHasCustomURL(bool) {} + * @return retrieve list of mods (as mod index) with archives that are overwritten by + * this one. Updates may be delayed + */ + virtual std::set<unsigned int> getModArchiveOverwrite() const { + return std::set<unsigned int>(); } /** - * @brief returns whether this mod uses a custom url - **/ - virtual bool hasCustomURL() const { return false; } + * @return list of mods (as mod index) with archives that overwrite this one. Updates + * may be delayed. + */ + virtual std::set<unsigned int> getModArchiveOverwritten() const { + return std::set<unsigned int>(); } /** - * @brief sets the custom url - **/ - virtual void setCustomURL(QString const &) {} + * @return the list of mods (as mod index) with archives that are overwritten by loose + * files of this mod. Updates may be delayed. + */ + virtual std::set<unsigned int> getModArchiveLooseOverwrite() const { + return std::set<unsigned int>(); } /** - * @brief returns the custom url - **/ - virtual QString url() const override { return ""; } + * @return the list of mods (as mod index) with loose files that overwrite this one's + * archive files. Updates may be delayed. + */ + virtual std::set<unsigned int> getModArchiveLooseOverwritten() const { + return std::set<unsigned int>(); } /** - * If hasCustomURL() is true and getCustomURL() is not empty, tries to parse - * the url using QUrl::fromUserInput() and returns it. Otherwise, returns an - * empty QUrl. - **/ - QUrl parseCustomURL() const; + * @brief Update conflict information. + */ + virtual void doConflictCheck() const {} public slots: @@ -734,10 +912,10 @@ public slots: signals: /** - * @brief emitted whenever the information of a mod changes + * @brief Emitted whenever the information of a mod changes. * - * @param success true if the mod details were updated successfully, false if not - **/ + * @param success true if the mod details were updated successfully, false if not. + */ void modDetailsUpdated(bool success); protected: @@ -759,12 +937,6 @@ protected: static void updateIndices(); static bool ByName(const ModInfo::Ptr &LHS, const ModInfo::Ptr &RHS); -private: - - static void createFromOverwrite(PluginContainer *pluginContainer, - const MOBase::IPluginGame* game, - MOShared::DirectoryEntry **directoryStructure); - protected: static std::vector<ModInfo::Ptr> s_Collection; @@ -779,6 +951,12 @@ protected: private: + static void createFromOverwrite(PluginContainer* pluginContainer, + const MOBase::IPluginGame* game, + MOShared::DirectoryEntry** directoryStructure); + +private: + static QMutex s_Mutex; static std::map<std::pair<QString, int>, std::vector<unsigned int> > s_ModsByModID; static int s_NextID; |