editor_common.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2024
    by Tomasz Sniatowski <kailoran@gmail.com>
    Part of the Battle for Wesnoth Project https://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
 * Main (common) editor header. Contains forward declarations for most classes,
 * logging macro definitions and base exception declarations
 */
 
#pragma once
 
#include "exceptions.hpp"
#include "log.hpp"
 
#include <deque>
#include <memory>
 
extern lg::log_domain log_editor;
#define DBG_ED LOG_STREAM_INDENT(debug, log_editor)
#define LOG_ED LOG_STREAM_INDENT(info, log_editor)
#define WRN_ED LOG_STREAM_INDENT(warn, log_editor)
#define ERR_ED LOG_STREAM_INDENT(err, log_editor)
#define SCOPE_ED log_scope2(log_editor, __func__)
 
class display;
 
namespace editor {
 
struct editor_exception : public game::error
{
    editor_exception(const std::string& msg)
    : game::error(msg)
    {
    }
};
 
struct editor_logic_exception : public editor_exception
{
    editor_logic_exception(const std::string& msg)
    : editor_exception(msg)
    {
    }
};
 
// forward declarations
class brush;
class editor_action;
class editor_controller;
class editor_display;
class editor_map;
class editor_mouse_handler;
class map_context;
class map_fragment;
class mouse_action;
 
/** Action stack typedef. */
using action_stack = std::deque<std::unique_ptr<editor_action>>;
 
} //end namespace editor