mod_configuration.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2013-22 celeron55, Perttu Ahola <celeron55@gmail.com>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include "mods.h"
 
 
class ModConfiguration
{
public:
    inline bool isConsistent() const { return m_unsatisfied_mods.empty(); }
 
    inline const std::vector<ModSpec> &getUnsatisfiedMods() const
    {
        return m_unsatisfied_mods;
    }
 
    const std::vector<ModSpec> &getMods() const { return m_sorted_mods; }
 
    std::string getUnsatisfiedModsError() const;
 
    void addModsInPath(const std::string &path, const std::string &virtual_path);
 
    void addMods(const std::vector<ModSpec> &new_mods);
 
    void addGameMods(const SubgameSpec &gamespec);
 
    void addModsFromConfig(const std::string &settings_path,
            const std::unordered_map<std::string, std::string> &modPaths);
 
    void checkConflictsAndDeps();
 
private:
    std::vector<ModSpec> m_sorted_mods;
 
    void resolveDependencies();
 
    // mods with unmet dependencies. Before dependencies are resolved,
    // this is where all mods are stored. Afterwards this contains
    // only the ones with really unsatisfied dependencies.
    std::vector<ModSpec> m_unsatisfied_mods;
 
    // set of mod names for which an unresolved name conflict
    // exists. A name conflict happens when two or more mods
    // at the same level have the same name but different paths.
    // Levels (mods in higher levels override mods in lower levels):
    // 1. game mod in modpack; 2. game mod;
    // 3. world mod in modpack; 4. world mod;
    // 5. addon mod in modpack; 6. addon mod.
    std::unordered_set<std::string> m_name_conflicts;
};