serialization/preprocessor.hpp

Go to the documentation of this file.

/* $Id: preprocessor.hpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2003 by David White <dave@whitevine.net>
   Copyright (C) 2005 - 2012 by Guillaume Melquiond <guillaume.melquiond@gmail.com>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 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.

   See the COPYING file for more details.
*/

/** @file */

#ifndef SERIALIZATION_PREPROCESSOR_HPP_INCLUDED
#define SERIALIZATION_PREPROCESSOR_HPP_INCLUDED

#include <iosfwd>
#include <map>
#include <vector>

#include "game_errors.hpp"

class config_writer;
class config;

struct preproc_define;
typedef std::map< std::string, preproc_define > preproc_map;

struct preproc_define
{
    preproc_define() : value(), arguments(), textdomain(), linenum(0), location() {}
    explicit preproc_define(std::string const &val) : value(val), arguments(), textdomain(), linenum(0), location() {}
    preproc_define(std::string const &val, std::vector< std::string > const &args,
                   std::string const &domain, int line, std::string const &loc)
        : value(val), arguments(args), textdomain(domain), linenum(line), location(loc) {}
    std::string value;
    std::vector< std::string > arguments;
    std::string textdomain;
    int linenum;
    std::string location;
    void write(config_writer&, const std::string&) const;
    void write_argument(config_writer&, const std::string&) const;
    void read(const config&);
    void read_argument(const config &);
    static preproc_map::value_type read_pair(const config &);
    bool operator==(preproc_define const &) const;
    bool operator<(preproc_define const &) const;
    bool operator!=(preproc_define const &v) const { return !operator==(v); }
};

std::ostream& operator<<(std::ostream& stream, const preproc_define& def);

struct preproc_config {
    struct error : public game::error {
        error(const std::string& message) : game::error(message) {}
    };
};

std::string lineno_string(const std::string &lineno);

std::ostream& operator<<(std::ostream& stream, const preproc_map::value_type& def);

/**
 * Function to use the WML preprocessor on a file.
 *
 * @param defines                 A map of symbols defined.
 *
 * @returns                       The resulting preprocessed file data.
 */
std::istream *preprocess_file(std::string const &fname, preproc_map *defines = NULL);

void preprocess_resource(const std::string& res_name, preproc_map *defines_map,
            bool write_cfg=false, bool write_plain_cfg=false, std::string target_directory="");

#endif