src/supertux/tile_set_parser.cpp

   1 //  SuperTux
   2 //  Copyright (C) 2008 Matthias Braun <matze@braunis.de>
   3 //                     Ingo Ruhnke <grumbel@gmx.de>
   4 //
   5 //  This program is free software: you can redistribute it and/or modify
   6 //  it under the terms of the GNU General Public License as published by
   7 //  the Free Software Foundation, either version 3 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 General Public License for more details.
  14 //
  15 //  You should have received a copy of the GNU General Public License
  16 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 #include "supertux/tile_set_parser.hpp"
  19
  20 #include <stdexcept>
  21 #include <sstream>
  22
  23 #include "lisp/list_iterator.hpp"
  24 #include "lisp/parser.hpp"
  25 #include "supertux/tile_set.hpp"
  26 #include "util/file_system.hpp"
  27
  28 TileSetParser::TileSetParser(TileSet& tileset, const std::string& filename) :
  29   m_tileset(tileset),
  30   m_filename(filename),
  31   m_tiles_path()
  32 {
  33 }
  34
  35 void
  36 TileSetParser::parse()
  37 {
  38   m_tiles_path = FileSystem::dirname(m_filename);
  39
  40   m_tileset.tiles.resize(1, 0);
  41   m_tileset.tiles[0] = new Tile(m_tileset);
  42
  43   lisp::Parser parser;
  44   const lisp::Lisp* root = parser.parse(m_filename);
  45
  46   const lisp::Lisp* tiles_lisp = root->get_lisp("supertux-tiles");
  47   if(!tiles_lisp)
  48     throw std::runtime_error("file is not a supertux tiles file.");
  49
  50   lisp::ListIterator iter(tiles_lisp);
  51   while(iter.next())
  52   {
  53     if (iter.item() == "tile")
  54     {
  55       parse_tile(*iter.lisp());
  56     }
  57     else if (iter.item() == "tilegroup")
  58     {
  59       /* tilegroups are only interesting for the editor */
  60     }
  61     else if (iter.item() == "tiles")
  62     {
  63       parse_tiles(*iter.lisp());
  64     }
  65     else
  66     {
  67       log_warning << "Unknown symbol '" << iter.item() << "' in tileset file" << std::endl;
  68     }
  69   }
  70 }
  71
  72 void
  73 TileSetParser::parse_tile(const Reader& reader)
  74 {
  75   uint32_t id;
  76   if (!reader.get("id", id))
  77   {
  78     throw std::runtime_error("Missing tile-id.");
  79   }
  80
  81   uint32_t attributes = 0;
  82   uint32_t data = 0;
  83   std::vector<Tile::ImageSpec> imagespecs;
  84
  85   float fps = 10;
  86
  87   bool value = false;
  88   if(reader.get("solid", value) && value)
  89     attributes |= Tile::SOLID;
  90   if(reader.get("unisolid", value) && value)
  91     attributes |= Tile::UNISOLID | Tile::SOLID;
  92   if(reader.get("brick", value) && value)
  93     attributes |= Tile::BRICK;
  94   if(reader.get("ice", value) && value)
  95     attributes |= Tile::ICE;
  96   if(reader.get("water", value) && value)
  97     attributes |= Tile::WATER;
  98   if(reader.get("hurts", value) && value)
  99     attributes |= Tile::HURTS;
 100   if(reader.get("fire", value) && value)
 101     attributes |= Tile::FIRE;
 102   if(reader.get("fullbox", value) && value)
 103     attributes |= Tile::FULLBOX;
 104   if(reader.get("coin", value) && value)
 105     attributes |= Tile::COIN;
 106   if(reader.get("goal", value) && value)
 107     attributes |= Tile::GOAL;
 108
 109   if(reader.get("north", value) && value)
 110     data |= Tile::WORLDMAP_NORTH;
 111   if(reader.get("south", value) && value)
 112     data |= Tile::WORLDMAP_SOUTH;
 113   if(reader.get("west", value) && value)
 114     data |= Tile::WORLDMAP_WEST;
 115   if(reader.get("east", value) && value)
 116     data |= Tile::WORLDMAP_EAST;
 117   if(reader.get("stop", value) && value)
 118     data |= Tile::WORLDMAP_STOP;
 119
 120   reader.get("data", data);
 121   reader.get("fps", fps);
 122
 123   if(reader.get("slope-type", data))
 124   {
 125     attributes |= Tile::SOLID | Tile::SLOPE;
 126   }
 127
 128   const lisp::Lisp* images;
 129 #ifndef NDEBUG
 130   images = reader.get_lisp("editor-images");
 131   if(images)
 132     imagespecs = parse_tile_images(*images);
 133   else {
 134 #endif
 135     images = reader.get_lisp("images");
 136     if(images)
 137       imagespecs = parse_tile_images(*images);
 138 #ifndef NDEBUG
 139   }
 140 #endif
 141
 142   std::auto_ptr<Tile> tile(new Tile(m_tileset, imagespecs, attributes, data, fps));
 143
 144   if (id >= m_tileset.tiles.size())
 145     m_tileset.tiles.resize(id+1, 0);
 146
 147   if (m_tileset.tiles[id] != 0)
 148   {
 149     log_warning << "Tile with ID " << id << " redefined" << std::endl;
 150   }
 151   else
 152   {
 153     m_tileset.tiles[id] = tile.release();
 154   }
 155 }
 156
 157 std::vector<Tile::ImageSpec>
 158 TileSetParser::parse_tile_images(const Reader& images_lisp)
 159 {
 160   std::vector<Tile::ImageSpec> imagespecs;
 161
 162   const lisp::Lisp* list = &images_lisp;
 163   while(list)
 164   {
 165     const lisp::Lisp* cur = list->get_car();
 166
 167     if(cur->get_type() == lisp::Lisp::TYPE_STRING)
 168     {
 169       std::string file;
 170       cur->get(file);
 171       imagespecs.push_back(Tile::ImageSpec(m_tiles_path + file, Rectf(0, 0, 0, 0)));
 172     }
 173     else if(cur->get_type() == lisp::Lisp::TYPE_CONS &&
 174             cur->get_car()->get_type() == lisp::Lisp::TYPE_SYMBOL &&
 175             cur->get_car()->get_symbol() == "region")
 176     {
 177       const lisp::Lisp* ptr = cur->get_cdr();
 178
 179       std::string file;
 180       float x = 0;
 181       float y = 0;
 182       float w = 0;
 183       float h = 0;
 184       ptr->get_car()->get(file); ptr = ptr->get_cdr();
 185       ptr->get_car()->get(x); ptr = ptr->get_cdr();
 186       ptr->get_car()->get(y); ptr = ptr->get_cdr();
 187       ptr->get_car()->get(w); ptr = ptr->get_cdr();
 188       ptr->get_car()->get(h);
 189       imagespecs.push_back(Tile::ImageSpec(m_tiles_path + file, Rectf(x, y, x+w, y+h)));
 190     }
 191     else
 192     {
 193       log_warning << "Expected string or list in images tag" << std::endl;
 194     }
 195
 196     list = list->get_cdr();
 197   }
 198
 199   return imagespecs;
 200 }
 201
 202 void
 203 TileSetParser::parse_tiles(const Reader& reader)
 204 {
 205   // List of ids (use 0 if the tile should be ignored)
 206   std::vector<uint32_t> ids;
 207   // List of attributes of the tile
 208   std::vector<uint32_t> attributes;
 209   // List of data for the tiles
 210   std::vector<uint32_t> datas;
 211   //List of frames that the tiles come in
 212   std::vector<std::string> images;
 213
 214   // width and height of the image in tile units, this is used for two
 215   // purposes:
 216   //  a) so we don't have to load the image here to know its dimensions
 217   //  b) so that the resulting 'tiles' entry is more robust,
 218   //  ie. enlarging the image won't break the tile id mapping
 219   // FIXME: height is actually not used, since width might be enough for
 220   // all purposes, still feels somewhat more natural this way
 221   unsigned int width  = 0;
 222   unsigned int height = 0;
 223
 224   reader.get("ids",        ids);
 225   bool has_attributes = reader.get("attributes", attributes);
 226   bool has_datas = reader.get("datas", datas);
 227
 228   reader.get("image", images) || reader.get("images", images);
 229
 230   reader.get("width",      width);
 231   reader.get("height",     height);
 232
 233   float fps = 10;
 234   reader.get("fps",     fps);
 235
 236   if (images.size() <= 0)
 237   {
 238     throw std::runtime_error("No images in tile.");
 239   }
 240   else if (fps < 0)
 241   {
 242     throw std::runtime_error("Negative fps.");
 243   }
 244   else if (ids.size() != width*height)
 245   {
 246     std::ostringstream err;
 247     err << "Number of ids (" << ids.size() <<  ") and size of image (" << width*height
 248         << ") mismatch for image '" << images[0] << "', but must be equal";
 249     throw std::runtime_error(err.str());
 250   }
 251   else if (has_attributes && ids.size() != attributes.size())
 252   {
 253     std::ostringstream err;
 254     err << "Number of ids (" << ids.size() <<  ") and attributes (" << attributes.size()
 255         << ") mismatch for image '" << images[0] << "', but must be equal";
 256     throw std::runtime_error(err.str());
 257   }
 258   else if (has_datas && ids.size() != datas.size())
 259   {
 260     std::ostringstream err;
 261     err << "Number of ids (" << ids.size() <<  ") and datas (" << datas.size()
 262         << ") mismatch for image '" << images[0] << "', but must be equal";
 263     throw std::runtime_error(err.str());
 264   }
 265   else
 266   {
 267     for(std::vector<uint32_t>::size_type i = 0; i < ids.size() && i < width*height; ++i)
 268     {
 269       if (ids[i] != 0)
 270       {
 271         if (ids[i] >= m_tileset.tiles.size())
 272           m_tileset.tiles.resize(ids[i]+1, 0);
 273
 274         int x = 32*(i % width);
 275         int y = 32*(i / width);
 276
 277         std::vector<Tile::ImageSpec> imagespecs;
 278         for(std::vector<std::string>::const_iterator j = images.begin(); j != images.end(); ++j)
 279         {
 280           imagespecs.push_back(Tile::ImageSpec(m_tiles_path + *j, Rectf(x, y, x + 32, y + 32)));
 281         }
 282
 283         std::auto_ptr<Tile> tile(new Tile(m_tileset, imagespecs,
 284                                           (has_attributes ? attributes[i] : 0), (has_datas ? datas[i] : 0), fps));
 285         if (m_tileset.tiles[ids[i]] == 0) {
 286           m_tileset.tiles[ids[i]] = tile.release();
 287         } else {
 288           log_warning << "Tile with ID " << ids[i] << " redefined" << std::endl;
 289         }
 290       }
 291     }
 292   }
 293 }
 294
 295 /* EOF */