src/fileops/bdcffhelper.hpp

   1 /*
   2  * Copyright (c) 2007-2013, Czirkos Zoltan http://code.google.com/p/gdash/
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  19  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  20  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef BDCFFHELPER_HPP_INCLUDED
  25 #define BDCFFHELPER_HPP_INCLUDED
  26
  27 #include "config.h"
  28
  29 #include <string>
  30 #include <list>
  31 #include <sstream>
  32
  33 #define BDCFF_VERSION "0.5"
  34
  35 /**
  36  *  Functor which checks if a string has another string as its prefix.
  37  *  eg, it will return true for "SlimePermeability=0.1" begins with "SlimePermeability"
  38  *  The check is case-insensitive!
  39  */
  40 class HasAttrib {
  41     std::string attrib;
  42 public:
  43     explicit HasAttrib(const std::string &attrib_);
  44     bool operator()(const std::string &str) const;
  45 };
  46
  47
  48 /// A class which splits a BDCFF line read
  49 /// into two parts - an attribute name and parameters.
  50 /// For example, "SlimePermeability=0.1" is split into
  51 /// "SlimePermeability" (attrib) and "0.1" param.
  52 class AttribParam {
  53 public:
  54     std::string attrib;
  55     std::string param;
  56     explicit AttribParam(const std::string &str, char separator = '=');
  57 };
  58
  59 typedef std::list<std::string> BdcffSection;
  60 typedef BdcffSection::iterator BdcffSectionIterator;
  61 typedef BdcffSection::const_iterator BdcffSectionConstIterator;
  62
  63 /**
  64  * A structure, which stores the lines of text in a bdcff file; and has a list
  65  * of these strings for each section.
  66  *
  67  * The main format of the bdcff file.
  68  * Contains: bdcff section; highscore for caveset, map codes, caveset properties, and caves data.
  69  * Caves data contains: highscore for cave, cave properties, maybe map, maybe objects, maybe replays, maybe demo (=legacy replay).
  70  */
  71 struct BdcffFile {
  72     struct CaveInfo {
  73         BdcffSection highscore;
  74         BdcffSection properties;
  75         BdcffSection map;
  76         BdcffSection objects;
  77         std::list<BdcffSection> replays;
  78         BdcffSection demo;
  79     };
  80
  81     BdcffSection bdcff;
  82     BdcffSection highscore;
  83     BdcffSection mapcodes;
  84     BdcffSection caveset_properties;
  85     std::list<CaveInfo> caves;
  86 };
  87
  88
  89 /** A class which helps outputting BDCFF lines like "Point=x y z".
  90  *
  91  * It stores a name (Point), and can be fed with parameters
  92  * using a standard operator<<.
  93  * If conversion is ready, the str() member function can be
  94  * used to get the BDCFF output.
  95  */
  96 class BdcffFormat {
  97 private:
  98     std::ostringstream os;  ///< for conversion
  99     std::string name;       ///< name of parameter, eg. Size
 100     bool firstparam;        ///< used internally do determine if a space is needed
 101
 102 public:
 103     explicit BdcffFormat(const std::string &f = "");
 104     template <typename T> BdcffFormat &operator<<(const T &param);
 105     void start_new(const std::string &f);
 106     std::string str() const;
 107     /** cast to string - return the string. */
 108     operator std::string() const {
 109         return str();
 110     }
 111 };
 112
 113 /**
 114  * @brief Feed next output parameter to the formatter.
 115  * @param param The variable to write.
 116  * @return Itself, for linking << a << b << c.
 117  */
 118 template <typename T>
 119 BdcffFormat &BdcffFormat::operator<<(const T &param) {
 120     /* if this is not the first parameter, add a space */
 121     if (!firstparam)
 122         os << ' ';
 123     else
 124         firstparam = false;
 125     os << param;
 126     return *this;
 127 }
 128
 129 #endif