game_errors.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2003 by David White <[email protected]>
   Copyright (C) 2005 - 2016 by Yann Dirson <[email protected]>
   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.
*/
#ifndef GAME_ERRORS_HPP_INCLUDED
#define GAME_ERRORS_HPP_INCLUDED

#include "exceptions.hpp"
#include "lua_jailbreak_exception.hpp"

namespace game {

struct mp_server_error : public error {
    mp_server_error(const std::string& msg) : error("MP server error: " + msg) {}
};

/**
 * Error used when game loading fails.
 */
struct load_game_failed : public error {
    load_game_failed() {}
    load_game_failed(const std::string& msg) : error("load_game_failed: " + msg) {}
};

/**
 * Error used when game saving fails.
 */
struct save_game_failed : public error {
    save_game_failed() {}
    save_game_failed(const std::string& msg) : error("save_game_failed: " + msg) {}
};

/**
 * Error used for any general game error, e.g. data files are corrupt.
 */
struct game_error : public error {
    game_error(const std::string& msg) : error("game_error: " + msg) {}
};

/**
 * Error used to report an error in a lua script or in the lua interpreter.
 */
struct lua_error : public error {
    lua_error(const std::string& msg) : error("lua_error: " + msg) {}
    lua_error(const std::string& msg, const std::string& context) : error(context + ":\n  " + msg) {}
};

/**
 * Exception used to signal that the user has decided to abort a game,
 * and to load another game instead.
 */
class load_game_exception
    : public tlua_jailbreak_exception
{
public:

    load_game_exception()
        : tlua_jailbreak_exception()
    {
    }

    load_game_exception(
              const std::string& game_
            , const bool show_replay_
            , const bool cancel_orders_
            , const bool select_difficulty_
            , const std::string& difficulty_
            , bool skip_version_check_ = false)
        : tlua_jailbreak_exception()
    {
        game = game_;
        show_replay = show_replay_;
        cancel_orders = cancel_orders_;
        select_difficulty = select_difficulty_;
        difficulty = difficulty_;
        skip_version_check = skip_version_check_;
    }

    static std::string game;
    static bool show_replay;
    static bool cancel_orders;
    static bool select_difficulty;
    static std::string difficulty;
    static bool skip_version_check;

private:

    IMPLEMENT_LUA_JAILBREAK_EXCEPTION(load_game_exception)
};

}

#endif