src/tile_set.cpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2008 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 #include <config.h>
  21 #include <stdexcept>
  22
  23 #include "tile_set.hpp"
  24 #include "log.hpp"
  25 #include "file_system.hpp"
  26 #include "lisp/parser.hpp"
  27 #include "lisp/lisp.hpp"
  28 #include "lisp/list_iterator.hpp"
  29
  30 TileSet::TileSet()
  31   : tiles_path(""), tiles_loaded(false)
  32 {
  33   tiles.resize(1, 0);
  34   tiles[0] = new Tile(this);
  35 }
  36
  37 TileSet::TileSet(const std::string& filename)
  38   : tiles_path(""), tiles_loaded(true)
  39 {
  40   tiles_path = FileSystem::dirname(filename);
  41
  42   tiles.resize(1, 0);
  43   tiles[0] = new Tile(this);
  44
  45   lisp::Parser parser;
  46   const lisp::Lisp* root = parser.parse(filename);
  47
  48   const lisp::Lisp* tiles_lisp = root->get_lisp("supertux-tiles");
  49   if(!tiles_lisp)
  50     throw std::runtime_error("file is not a supertux tiles file.");
  51
  52   lisp::ListIterator iter(tiles_lisp);
  53   while(iter.next()) {
  54     if(iter.item() == "tile") {
  55       Tile* tile = new Tile(this);
  56       uint32_t id = tile->parse(*(iter.lisp()));
  57
  58       if(id >= tiles.size())
  59         tiles.resize(id+1, 0);
  60
  61       if(tiles[id] != 0) {
  62         log_warning << "Tile with ID " << id << " redefined" << std::endl;
  63         delete tile;
  64       } else {
  65         tiles[id] = tile;
  66       }
  67     } else if(iter.item() == "tilegroup") {
  68       /* tilegroups are only interesting for the editor */
  69     } else if (iter.item() == "tiles") {
  70       // List of ids (use 0 if the tile should be ignored)
  71       std::vector<uint32_t> ids;
  72       // List of attributes of the tile
  73       std::vector<uint32_t> attributes;
  74       // List of data for the tiles
  75       std::vector<uint32_t> datas;
  76       //List of frames that the tiles come in
  77       std::vector<std::string> images;
  78
  79       // width and height of the image in tile units, this is used for two
  80       // purposes:
  81       //  a) so we don't have to load the image here to know its dimensions
  82       //  b) so that the resulting 'tiles' entry is more robust,
  83       //  ie. enlarging the image won't break the tile id mapping
  84       // FIXME: height is actually not used, since width might be enough for
  85       // all purposes, still feels somewhat more natural this way
  86       unsigned int width  = 0;
  87       unsigned int height = 0;
  88
  89       iter.lisp()->get("ids",        ids);
  90       bool has_attributes = iter.lisp()->get("attributes", attributes);
  91       bool has_datas = iter.lisp()->get("datas", datas);
  92
  93       if(!iter.lisp()->get("image",      images))
  94         iter.lisp()->get( "images",      images);
  95
  96       iter.lisp()->get("width",      width);
  97       iter.lisp()->get("height",     height);
  98
  99       float animfps = 10;
 100       iter.lisp()->get("anim-fps",     animfps);
 101
 102       if(images.size() <= 0) {
 103         throw std::runtime_error("No images in tile.");
 104       }
 105       if(animfps < 0) {
 106         throw std::runtime_error("Negative fps.");
 107       }
 108       if (ids.size() != width*height) {
 109         std::ostringstream err;
 110         err << "Number of ids (" << ids.size() <<  ") and size of image (" << width*height
 111           << ") mismatch for image '" << images[0] << "', but must be equal";
 112         throw std::runtime_error(err.str());
 113       }
 114
 115       if (has_attributes && ids.size() != attributes.size()) {
 116         std::ostringstream err;
 117         err << "Number of ids (" << ids.size() <<  ") and attributes (" << attributes.size()
 118           << ") mismatch for image '" << images[0] << "', but must be equal";
 119         throw std::runtime_error(err.str());
 120       }
 121
 122       if (has_datas && ids.size() != datas.size()) {
 123         std::ostringstream err;
 124         err << "Number of ids (" << ids.size() <<  ") and datas (" << datas.size()
 125           << ") mismatch for image '" << images[0] << "', but must be equal";
 126         throw std::runtime_error(err.str());
 127       }
 128
 129       for(std::vector<uint32_t>::size_type i = 0; i < ids.size() && i < width*height; ++i) {
 130         if (ids[i] == 0)
 131           continue;
 132
 133         if(ids[i] >= tiles.size())
 134           tiles.resize(ids[i]+1, 0);
 135
 136         int x = 32*(i % width);
 137         int y = 32*(i / width);
 138         Tile* tile = new Tile(this, images, Rect(x, y, x + 32, y + 32),
 139               (has_attributes ? attributes[i] : 0), (has_datas ? datas[i] : 0), animfps);
 140         if (tiles[ids[i]] == 0) {
 141           tiles[ids[i]] = tile;
 142         } else {
 143           log_warning << "Tile with ID " << ids[i] << " redefined" << std::endl;
 144           delete tile;
 145         }
 146       }
 147     } else if(iter.item() == "properties") {
 148       // deprecated
 149     } else {
 150       log_warning << "Unknown symbol '" << iter.item() << "' in tileset file" << std::endl;
 151     }
 152   }
 153   if (0)
 154     { // enable this if you want to see a list of free tiles
 155       log_info << "Last Tile ID is " << tiles.size()-1 << std::endl;
 156       int last = -1;
 157       for(int i = 0; i < int(tiles.size()); ++i)
 158         {
 159           if (tiles[i] == 0 && last == -1)
 160             {
 161               last = i;
 162             }
 163           else if (tiles[i] && last != -1)
 164             {
 165               log_info << "Free Tile IDs (" << i - last << "): " << last << " - " << i-1 << std::endl;
 166               last = -1;
 167             }
 168         }
 169     }
 170   if (0)
 171     { // enable this to dump the (large) list of tiles to log_debug
 172       // Two dumps are identical iff the tilesets specify identical tiles
 173       log_debug << "Tileset in " << filename << std::endl;
 174       for(int i = 0; i < int(tiles.size()); ++i)
 175         {
 176           if(tiles[i] == 0)
 177             continue;
 178           Tile* t = tiles[i];
 179           log_debug << " Tile: id " << i << ", data " << t->data << ", attributes " << t->attributes << ":" << std::endl;
 180           for(std::vector<Tile::ImageSpec>::iterator im = t->imagespecs.begin(); im !=
 181                 t->imagespecs.end(); ++im) {
 182             log_debug << "  Imagespec: file " << im->file << "; rect " << im->rect << std::endl;
 183           }
 184         }
 185     }
 186 }
 187
 188 TileSet::~TileSet()
 189 {
 190   if(tiles_loaded) {
 191     for(Tiles::iterator i = tiles.begin(); i != tiles.end(); ++i)
 192       delete *i;
 193   }
 194 }
 195
 196 void TileSet::merge(const TileSet *tileset, uint32_t start, uint32_t end,
 197                     uint32_t offset)
 198 {
 199   for(uint32_t id = start; id <= end && id < tileset->tiles.size(); ++id) {
 200     uint32_t dest_id = id - start + offset;
 201
 202     if(dest_id >= tiles.size())
 203       tiles.resize(dest_id + 1, 0);
 204
 205     if(dest_id == 0)
 206       continue;
 207
 208     Tile *tile = tileset->tiles[id];
 209     if(tile == NULL)
 210         continue;
 211
 212     if(tiles[dest_id] != NULL) {
 213       log_warning << "tileset merge resulted in multiple definitions for id "
 214                   << dest_id << "(originally " << id << ")" << std::endl;
 215     }
 216     tiles[dest_id] = tile;
 217   }
 218 }