viewport.cpp

Go to the documentation of this file.

/*
   Copyright (C) 2012 - 2018 by Mark de Wever <koraq@xs4all.nl>
   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.
*/

#define GETTEXT_DOMAIN "wesnoth-lib"

#include "gui/widgets/viewport.hpp"

#include "gui/core/log.hpp"
#include "config.hpp"
#include "utils/const_clone.hpp"

#define LOG_SCOPE_HEADER "viewport [" + id() + "] " + __func__
#define LOG_HEADER LOG_SCOPE_HEADER + ':'

namespace gui2
{

// ------------ WIDGET -----------{

/**
 * Helper to implement private functions without modifying the header.
 *
 * The class is a helper to avoid recompilation and only has static
 * functions. It also facilitates to create duplicates of functions for a const
 * and a non-const member function.
 */
struct viewport_implementation
{
    /**
     * Implementation for the wrappers for
     * [const] widget* pane::find_at(const point&, const bool) [const].
     *
     * @tparam W                  A pointer to the pane.
     */
    template <class W>
    static utils::const_clone_ptr<widget, W>
    find_at(W viewport, point coordinate, const bool must_be_active)
    {

        /*
         * First test whether the mouse is at the pane.
         */
        if(viewport->widget::find_at(coordinate, must_be_active) != viewport) {
            return nullptr;
        }

        /*
         * The widgets are placed at coordinate 0,0 so adjust the offset to
         * that coordinate system.
         */
        coordinate.x -= viewport->get_x();
        coordinate.y -= viewport->get_y();

        return viewport->widget_.find_at(coordinate, must_be_active);
    }

    template <class W>
    static utils::const_clone_ptr<widget, W>
    find(W viewport, const std::string& id, const bool must_be_active)
    {
        if(viewport->widget::find(id, must_be_active)) {
            return viewport;
        } else {
            return viewport->widget_.find(id, must_be_active);
        }
    }
};

viewport::viewport(widget& widget) : widget_(widget), owns_widget_(false)
{
    widget_.set_parent(this);
}

viewport::viewport(const implementation::builder_viewport& builder,
                     const builder_widget::replacements_map& replacements)
    : widget(builder)
    , widget_(*builder.widget_->build(replacements))
    , owns_widget_(true)
{
    widget_.set_parent(this);
}

viewport::~viewport()
{
    if(owns_widget_) {
        delete &widget_;
    }
}

viewport* viewport::build(const implementation::builder_viewport& builder,
                            const builder_widget::replacements_map& replacements)
{
    return new viewport(builder, replacements);
}

void viewport::place(const point& origin, const point& size)
{
    widget::place(origin, size);

    widget_.place(point(), widget_.get_best_size());
}

void viewport::layout_initialize(const bool full_initialization)
{
    widget::layout_initialize(full_initialization);

    if(widget_.get_visible() != widget::visibility::invisible) {
        widget_.layout_initialize(full_initialization);
    }
}

void
viewport::impl_draw_children(surface& frame_buffer, int x_offset, int y_offset)
{
    x_offset += get_x();
    y_offset += get_y();

    if(widget_.get_visible() != widget::visibility::invisible) {
        widget_.draw_background(frame_buffer, x_offset, y_offset);
        widget_.draw_children(frame_buffer, x_offset, y_offset);
        widget_.draw_foreground(frame_buffer, x_offset, y_offset);
        widget_.set_is_dirty(false);
    }
}

void
viewport::child_populate_dirty_list(window& caller,
                                     const std::vector<widget*>& call_stack)
{
    std::vector<widget*> child_call_stack = call_stack;
    widget_.populate_dirty_list(caller, child_call_stack);
}

void viewport::request_reduce_width(const unsigned /*maximum_width*/)
{
}

widget* viewport::find_at(const point& coordinate, const bool must_be_active)
{
    return viewport_implementation::find_at(this, coordinate, must_be_active);
}

const widget* viewport::find_at(const point& coordinate,
                                  const bool must_be_active) const
{
    return viewport_implementation::find_at(this, coordinate, must_be_active);
}

widget* viewport::find(const std::string& id, const bool must_be_active)
{
    return viewport_implementation::find(this, id, must_be_active);
}

const widget* viewport::find(const std::string& id, const bool must_be_active)
        const
{
    return viewport_implementation::find(this, id, must_be_active);
}

point viewport::calculate_best_size() const
{
    return widget_.get_best_size();
}

bool viewport::disable_click_dismiss() const
{
    return false;
}

iteration::walker_base* viewport::create_walker()
{
    /**
     * @todo Implement properly.
     */
    return nullptr;
}

// }---------- BUILDER -----------{

/*WIKI_MACRO
 * @begin{macro}{viewport_description}
 *
 *        A viewport is an special widget used to view only a part of the
 *        widget it `holds'.
 * @end{macro}
 */

/*WIKI
 * @page = GUIWidgetInstanceWML
 * @order = 2_viewport
 * @begin{parent}{name="gui/window/resolution/grid/row/column/"}
 * @begin{tag}{name="viewport"}{min=0}{max=-1}{super="generic/widget_instance"}
 * @begin{tag}{name="widget"}{min="1"}{max="1"}{super="gui/window/resolution/grid/row/column"}
 * == Label ==
 *
 * @macro = viewport_description
 *
 * List with the label specific variables:
 * @begin{table}{config}
 *     widget & section & &       Holds a single widget like a grid cell.$
 * @end{table}
 * @end{tag}{name="widget"}
 * @end{tag}{name="viewport"}
 * @end{parent}{name="gui/window/resolution/grid/row/column/"}
 */

namespace implementation
{

builder_viewport::builder_viewport(const config& cfg)
    : builder_widget(cfg)
    , widget_(create_widget_builder(cfg.child("widget", "[viewport]")))
{
}

widget* builder_viewport::build() const
{
    return build(replacements_map());
}

widget* builder_viewport::build(const replacements_map& replacements) const
{
    return viewport::build(*this, replacements);
}

} // namespace implementation

// }------------ END --------------

} // namespace gui2