modal_dialog.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2023
    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.
*/
 
#pragma once
 
#include "gui/auxiliary/field-fwd.hpp"
#include "gui/core/static_registry.hpp"
#include "gui/widgets/window.hpp"
 
#include <functional>
#include <string>
#include <vector>
 
namespace gui2::dialogs
{
/**
 * Registers a window.
 *
 * This function registers a window. The registration is used to validate
 * whether the config for the window exists when starting Wesnoth.
 *
 * @note Most of the time you want to call @ref REGISTER_DIALOG instead of this
 * function. It also directly adds the code for the dialog's id function.
 *
 * @param id                      Id of the window, multiple dialogs can use
 *                                the same window so the id doesn't need to be
 *                                unique.
 */
#define REGISTER_WINDOW(id)                                                  \
    namespace                                                                \
    {                                                                        \
    namespace ns_##id                                                        \
    {                                                                        \
        struct register_helper                                               \
        {                                                                    \
            register_helper()                                                \
            {                                                                \
                register_window(#id);                                        \
            }                                                                \
        };                                                                   \
                                                                             \
        struct register_helper register_helper;                              \
    }                                                                        \
    }
 
/**
 * Registers a window for a dialog.
 *
 * Call this function to register a window. In the header of the class it adds
 * the following code:
 *@code
 *  virtual const std::string& id() const;
 *@endcode
 * Then use this macro in the implementation, inside the gui2 namespace.
 *
 * @note When the @p id is "foo" and the type tfoo it's easier to use
 * REGISTER_DIALOG(foo).
 *
 * @param type                    Class type of the window to register.
 * @param id                      Id of the window, multiple dialogs can use
 *                                the same window so the id doesn't need to be
 *                                unique.
 */
#define REGISTER_DIALOG2(type, id)                                           \
    REGISTER_WINDOW(id)                                                      \
    const std::string& type::window_id() const                               \
    {                                                                        \
        static const std::string result(#id);                                \
        return result;                                                       \
    }
 
/**
 * Wrapper for REGISTER_DIALOG2.
 *
 * "Calls" REGISTER_DIALOG2(window_id, window_id)
 */
#define REGISTER_DIALOG(window_id) REGISTER_DIALOG2(window_id, window_id)
 
/**
 * Adds a bare-bones static `display` function to a dialog class that immediately
 * invokes the dialogs's modal_dialog::show function. If more complex behavior
 * is desired, the function should be defined manually.
 *
 * See the modal_dialog documentation (below) for more info.
 */
#define DEFINE_SIMPLE_DISPLAY_WRAPPER(dialog)                                \
    template<typename... T>                                                  \
    static void display(T&&... args)                                         \
    {                                                                        \
        dialog(std::forward<T>(args)...).show();                             \
    }
 
/**
 * Adds a bare-bonesstatic `execute` function to a dialog class that immediately
 * invokes and return the result of the dialogs's modal_dialog::show function.
 * If more complex behavior is desired, the function should be defined manually.
 *
 * See the modal_dialog documentation (below) for more info.
 */
#define DEFINE_SIMPLE_EXECUTE_WRAPPER(dialog)                                \
    template<typename... T>                                                  \
    static bool execute(T&&... args)                                         \
    {                                                                        \
        return dialog(std::forward<T>(args)...).show();                      \
    }
 
/**
 * Abstract base class for all modal dialogs.
 *
 * A dialog shows a certain window instance to the user. The subclasses of this
 * class will hold the parameters used for a certain window, eg a server
 * connection dialog will hold the name of the selected server as parameter that
 * way the caller doesn't need to know about the 'contents' of the window.
 *
 * @par Usage
 *
 * Simple dialogs that are shown to query user information it is recommended to
 * add a static member called @p execute. The parameters to the function are:
 * - references to in + out parameters by reference
 * - references to the in parameters
 * - the parameters for @ref modal_dialog::show.
 *
 * The 'in + out parameters' are used as initial value and final value when the
 * OK button is pressed. The 'in parameters' are just extra parameters for
 * showing.
 *
 * When a function only has 'in parameters' it should return a void value and
 * the function should be called @p display, if it has 'in + out parameters' it
 * must return a bool value. This value indicates whether or not the OK button
 * was pressed to close the dialog. See editor_new_map::execute for an
 * example.
 */
class modal_dialog : public window
{
    /**
     * Special helper function to get the id of the window.
     *
     * This is used in the unit tests, but these implementation details
     * shouldn't be used in the normal code.
     */
    friend std::string get_modal_dialog_id(const modal_dialog& dialog);
 
public:
    explicit modal_dialog(const std::string& window_id);
 
    virtual ~modal_dialog();
 
    /**
     * Shows the window.
     *
     * @param auto_close_time     The time in ms after which the dialog will
     *                            automatically close, if 0 it doesn't close.
     *                            @note the timeout is a minimum time and
     *                            there's no guarantee about how fast it closes
     *                            after the minimum.
     *
     * @returns                   Whether the final retval_ == retval::OK
     */
    bool show(const unsigned auto_close_time = 0);
 
    /***** ***** ***** setters / getters for members ***** ****** *****/
 
    // TODO: this is now completely redundant, as a modal dialog is a window
    /** Returns a pointer to the dialog's window. Will be null if it hasn't been built yet. */
    window* get_window()
    {
        return this;
    }
    const window* get_window() const
    {
        return this;
    }
 
    /** Returns the cached window exit code. */
    int get_retval() const
    {
        return retval_;
    }
 
    void set_always_save_fields(const bool always_save_fields)
    {
        always_save_fields_ = always_save_fields;
    }
 
    void set_allow_plugin_skip(const bool allow_plugin_skip)
    {
        allow_plugin_skip_ = allow_plugin_skip;
    }
 
    void set_show_even_without_video(const bool show_even_without_video)
    {
        show_even_without_video_ = show_even_without_video;
    }
 
protected:
    /**
     * Creates a new field of given type with given arguments.
     *
     * The field created is owned by modal_dialog, the returned pointer can be used
     * in the child classes as access to a field.
     *
     * @param args                Arguments to forward to the field constructor.
     */
    template<typename T, typename... Args>
    T* register_field(Args&&... args);
 
    /**
     * Creates a new boolean field.
     *
     * The field created is owned by modal_dialog, the returned pointer can be used
     * in the child classes as access to a field.
     *
     * @param id                  Id of the widget, same value as in WML.
     * @param mandatory            Is the widget mandatory or mandatory.
     * @param callback_load_value The callback function to set the initial value
     *                            of the widget.
     * @param callback_save_value The callback function to write the resulting
     *                            value of the widget. Saving will only happen
     *                            if the widget is enabled and the window closed
     *                            with ok.
     * @param callback_change     When the value of the widget changes this
     *                            callback is called.
     * @param initial_fire
     *
     * @returns                   Pointer to the created widget.
     */
    field_bool*
    register_bool(const std::string& id,
                  const bool mandatory,
                  const std::function<bool()> callback_load_value = nullptr,
                  const std::function<void(bool)> callback_save_value = nullptr,
                  const std::function<void(widget&)> callback_change = nullptr,
                  const bool initial_fire = false);
 
    /**
     * Creates a new boolean field.
     *
     * The field created is owned by modal_dialog, the returned pointer can be used
     * in the child classes as access to a field.
     *
     * @param id                  Id of the widget, same value as in WML.
     * @param mandatory            Is the widget mandatory or mandatory.
     * @param linked_variable     The variable the widget is linked to. See
     *                            @ref field::field for more information.
     * @param callback_change     When the value of the widget changes this
     *                            callback is called.
     * @param initial_fire
     *
     * @returns                   Pointer to the created widget.
     */
    field_bool*
    register_bool(const std::string& id,
                  const bool mandatory,
                  bool& linked_variable,
                  const std::function<void(widget&)> callback_change = nullptr,
                  const bool initial_fire = false);
 
    /**
     * Creates a new integer field.
     *
     * See @ref register_bool for more info.
     */
    field_integer*
    register_integer(const std::string& id,
                     const bool mandatory,
                     const std::function<int()> callback_load_value = nullptr,
                     const std::function<void(int)> callback_save_value = nullptr);
 
    /**
     * Creates a new integer field.
     *
     * See @ref register_bool for more info.
     */
    field_integer* register_integer(const std::string& id,
                                     const bool mandatory,
                                     int& linked_variable);
    /**
     * Creates a new text field.
     *
     * See @ref register_bool for more info.
     */
    field_text* register_text(
            const std::string& id,
            const bool mandatory,
            const std::function<std::string()> callback_load_value = nullptr,
            const std::function<void(const std::string&)> callback_save_value = nullptr,
            const bool capture_focus = false);
 
    /**
     * Creates a new text field.
     *
     * See @ref register_bool for more info.
     */
    field_text* register_text(const std::string& id,
                               const bool mandatory,
                               std::string& linked_variable,
                               const bool capture_focus = false);
 
    /**
     * Registers a new styled_widget as a label.
     *
     * The label is used for a styled_widget to set the 'label' since it calls the
     * @ref styled_widget::set_label it can also be used for the @ref image since
     * there this sets the filename. (The @p use_markup makes no sense in an
     * image but that's a detail.)
     *
     * @note In general it's preferred a widget sets its markup flag in WML, but
     * some generic windows (like messages) may need different versions
     * depending on where used.
     *
     * @param id                  Id of the widget, same value as in WML.
     * @param mandatory           Is the widget mandatory or optional.
     * @param text                The text for the label.
     * @param use_markup          Whether or not use markup for the label.
     */
    field_label* register_label(const std::string& id,
                                 const bool mandatory,
                                 const std::string& text,
                                 const bool use_markup = false);
 
    /** Registers a new styled_widget as image. */
    field_label* register_image(const std::string& id,
                                 const bool mandatory,
                                 const std::string& filename)
    {
        return register_label(id, mandatory, filename);
    }
 
private:
    /**
     * The window's exit code (return value).
     *
     * We keep a copy here so it may be accessed even after the dialog is closed and
     * the window object is destroyed.
     *
     * This value is initially set to 0 (retval::NONE) meaning the dialog was not
     * shown. After @ref show returns, it will hold the most recent retval of the
     * window object, including any modifications made in @ref post_show.
     */
    int retval_;
 
    /**
     * Always save the fields upon closing.
     *
     * Normally fields are only saved when the retval::OK button is pressed.
     * With this flag set is always saves. Be careful with the flag since it
     * also updates upon canceling, which can be a problem when the field sets
     * a preference.
     */
    bool always_save_fields_;
 
    /**
     * Contains the automatically managed fields.
     *
     * Since the fields are automatically managed and there are no search
     * functions defined we don't offer access to the vector. If access is
     * needed the creator should store a copy of the pointer.
     */
    std::vector<std::unique_ptr<class field_base>> fields_;
 
    /**
     * Contains the widget that should get the focus when the window is shown.
     */
    std::string focus_;
 
    /**
     * Allow plugins to skip through the dialog?
     * Most dialogs install a plugins context to allow plugins to accept whatever the dialog is offering
     * and continue. Some dialogs, especially those that install their own plugins context, may want to
     * disable this.
     */
    bool allow_plugin_skip_;
 
    /**
     * Show the dialog even with --nogui?
     * Some dialogs need to be shown even when --nogui is specified if the game is being driven by a plugin.
     * Those dialogs allow the plugin to styled_widget them by creating a plugin context in pre_show().
     */
    bool show_even_without_video_;
 
    /** The ID of the window to build. Usually set by REGISTER_DIALOG. */
    virtual const std::string& window_id() const = 0;
 
    /**
     * Actions to be taken before showing the window.
     *
     * At this point the registered fields are registered and initialized with
     * their initial values.
     *
     * @param window              The window to be shown.
     */
    virtual void pre_show(window& window);
    // TODO: this window parameter is now redundant
 
    /**
     * Actions to be taken after the window has been shown.
     *
     * At this point the registered fields already stored their values (if the
     * OK has been pressed).
     *
     * @param window              The window which has been shown.
     */
    virtual void post_show(window& window);
    // TODO: this window parameter is now redundant
 
    /**
     * Initializes all fields in the dialog and set the keyboard focus.
     *
     * @param window              The window which has been shown.
     */
    virtual void init_fields();
    // TODO: Nothing else uses this. Why is it virtual?
 
    /**
     * When the dialog is closed with the OK status saves all fields.
     *
     * Saving only happens if a callback handler is installed.
     *
     * @param save_fields         Does the value in the fields need to be saved?
     */
    virtual void finalize_fields(const bool save_fields);
    // TODO: Nothing else uses this. Why is it virtual?
};
 
} // namespace dialogs