src/subgame.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef SUBGAME_HEADER
  21 #define SUBGAME_HEADER
  22
  23 #include <string>
  24 #include <set>
  25 #include <vector>
  26
  27 #define WORLDNAME_BLACKLISTED_CHARS "/\\"
  28
  29 struct SubgameSpec
  30 {
  31         std::string id; // "" = game does not exist
  32         std::string path;
  33         std::set<std::string> mods_paths;
  34         std::string name;
  35
  36         SubgameSpec(const std::string &id_="",
  37                         const std::string &path_="",
  38                         const std::set<std::string> &mods_paths_=std::set<std::string>(),
  39                         const std::string &name_=""):
  40                 id(id_),
  41                 path(path_),
  42                 mods_paths(mods_paths_),
  43                 name(name_)
  44         {}
  45
  46         bool isValid() const
  47         {
  48                 return (id != "" && path != "");
  49         }
  50 };
  51
  52 std::string getGameName(const std::string &game_path);
  53
  54 SubgameSpec findSubgame(const std::string &id);
  55 SubgameSpec findWorldSubgame(const std::string &world_path);
  56
  57 std::set<std::string> getAvailableGameIds();
  58 std::vector<SubgameSpec> getAvailableGames();
  59
  60 bool getWorldExists(const std::string &world_path);
  61 std::string getWorldGameId(const std::string &world_path,
  62                 bool can_be_legacy=false);
  63
  64 struct WorldSpec
  65 {
  66         std::string path;
  67         std::string name;
  68         std::string gameid;
  69
  70         WorldSpec(
  71                 const std::string &path_="",
  72                 const std::string &name_="",
  73                 const std::string &gameid_=""
  74         ):
  75                 path(path_),
  76                 name(name_),
  77                 gameid(gameid_)
  78         {}
  79
  80         bool isValid() const
  81         {
  82                 return (name != "" && path != "" && gameid != "");
  83         }
  84 };
  85
  86 std::vector<WorldSpec> getAvailableWorlds();
  87
  88 // Create world directory and world.mt if they don't exist
  89 bool initializeWorld(const std::string &path, const std::string &gameid);
  90
  91 #endif
  92