rich_label.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2024
    by Subhraman Sarkar (babaissarkar) <suvrax@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.
*/
 
#define GETTEXT_DOMAIN "wesnoth-lib"
 
#include "gui/widgets/rich_label.hpp"
 
#include "gui/core/log.hpp"
 
#include "gui/core/widget_definition.hpp"
#include "gui/core/register_widget.hpp"
#include "gui/dialogs/message.hpp"
#include "gui/widgets/settings.hpp"
 
#include "cursor.hpp"
#include "desktop/clipboard.hpp"
#include "desktop/open.hpp"
#include "help/help_impl.hpp"
#include "gettext.hpp"
#include "log.hpp"
#include "serialization/unicode.hpp"
#include "serialization/string_utils.hpp"
#include "sound.hpp"
#include "video.hpp"
#include "wml_exception.hpp"
 
#include <functional>
#include <string>
#include <boost/format.hpp>
 
static lg::log_domain log_rich_label("gui/widget/rich_label");
#define DBG_GUI_RL LOG_STREAM(debug, log_rich_label)
 
#define LINK_DEBUG_BORDER false
 
namespace gui2
{
namespace
{
using namespace std::string_literals;
 
/** Possible formatting tags, must be the same as those in gui2::text_shape::draw */
const std::array format_tags{ "bold"s, "b"s, "italic"s, "i"s, "underline"s, "u"s };
}
 
// ------------ WIDGET -----------{
 
REGISTER_WIDGET(rich_label)
 
rich_label::rich_label(const implementation::builder_rich_label& builder)
    : styled_widget(builder, type())
    , state_(ENABLED)
    , can_wrap_(true)
    , link_aware_(builder.link_aware)
    , link_color_(font::YELLOW_COLOR)
    , can_shrink_(true)
    , text_alpha_(ALPHA_OPAQUE)
    , unparsed_text_()
    , init_w_(builder.width(get_screen_size_variables()))
    , size_(0, 0)
    , padding_(5)
{
    connect_signal<event::LEFT_BUTTON_CLICK>(
        std::bind(&rich_label::signal_handler_left_button_click, this, std::placeholders::_3));
    connect_signal<event::MOUSE_MOTION>(
        std::bind(&rich_label::signal_handler_mouse_motion, this, std::placeholders::_3, std::placeholders::_5));
    connect_signal<event::MOUSE_LEAVE>(
        std::bind(&rich_label::signal_handler_mouse_leave, this, std::placeholders::_3));
}
 
wfl::map_formula_callable rich_label::setup_text_renderer(config text_cfg, unsigned width) const {
    // Set up fake render to calculate text position
    static wfl::action_function_symbol_table functions;
    wfl::map_formula_callable variables;
    variables.add("text", wfl::variant(text_cfg["text"].str()));
    variables.add("width", wfl::variant(width));
    variables.add("text_wrap_mode", wfl::variant(PANGO_ELLIPSIZE_NONE));
    variables.add("fake_draw", wfl::variant(true));
    gui2::text_shape{text_cfg, functions}.draw(variables);
    return variables;
}
 
point rich_label::get_text_size(config& text_cfg, unsigned width) const {
    wfl::map_formula_callable variables = setup_text_renderer(text_cfg, width);
    return {
        variables.query_value("text_width").as_int(),
        variables.query_value("text_height").as_int()
    };
}
 
point rich_label::get_image_size(config& img_cfg) const {
    static wfl::action_function_symbol_table functions;
    wfl::map_formula_callable variables;
    variables.add("fake_draw", wfl::variant(true));
    gui2::image_shape{img_cfg, functions}.draw(variables);
    return {
        variables.query_value("image_width").as_int(),
        variables.query_value("image_height").as_int()
    };
}
 
std::pair<size_t, size_t> rich_label::add_text(config& curr_item, std::string text) {
    auto& attr = curr_item["text"];
    size_t start = attr.str().size();
    attr = attr.str() + std::move(text);
    size_t end = attr.str().size();
    return { start, end };
}
 
void rich_label::add_attribute(config& curr_item, std::string attr_name, size_t start, size_t end, std::string extra_data) {
    curr_item.add_child("attribute", config{
        "name"  , attr_name,
        "start" , start,
        "end"   , end == 0 ? curr_item["text"].str().size() : end,
        "value" , std::move(extra_data)
    });
}
 
std::pair<size_t, size_t> rich_label::add_text_with_attribute(config& curr_item, std::string text, std::string attr_name, std::string extra_data) {
    const auto [start, end] = add_text(curr_item, std::move(text));
    add_attribute(curr_item, attr_name, start, end, extra_data);
    return { start, end };
}
 
void rich_label::add_image(config& curr_item, std::string name, std::string align, bool has_prev_image, bool floating) {
    // TODO: still doesn't cover the case where consecutive inline images have different heights
    curr_item["name"] = name;
 
    if (align.empty()) {
        align = "left";
    }
 
    if (align == "right") {
        curr_item["x"] = floating ? "(width - image_width - img_x)" : "(width - image_width - pos_x)";
    } else if (align == "middle" || align == "center") {
        // works for single image only
        curr_item["x"] = floating ? "(img_x + (width - image_width)/2.0)" : "(pos_x + (width - image_width)/2.0)";
    } else {
        // left aligned images are default for now
        curr_item["x"] = floating ? "(img_x)" : "(pos_x)";
    }
    curr_item["y"] = (has_prev_image && floating) ? "(img_y + pos_y)" : "(pos_y)";
    curr_item["h"] = "(image_height)";
    curr_item["w"] = "(image_width)";
 
    std::stringstream actions;
    actions << "([";
    if (floating) {
        if (align == "left") {
            actions << "set_var('pos_x', image_width + padding)";
        } else if (align == "right") {
            actions << "set_var('pos_x', 0)";
            actions << ",";
            actions << "set_var('ww', image_width + padding)";
        }
 
        actions << "," <<  "set_var('img_y', img_y + image_height + padding)";
    } else {
        actions << "set_var('pos_x', pos_x + image_width + padding)";
        // y coordinate is updated later, based on whether a linebreak follows
    }
    actions << "])";
 
    curr_item["actions"] = actions.str();
    actions.str("");
}
 
void rich_label::add_link(config& curr_item, std::string name, std::string dest, const point& origin, int img_width) {
    // TODO algorithm needs to be text_alignment independent
 
    DBG_GUI_RL << "add_link: " << name << "->" << dest;
    DBG_GUI_RL << "origin: " << origin;
    DBG_GUI_RL << "width=" << img_width;
 
    point t_start, t_end;
 
    setup_text_renderer(curr_item, init_w_ - origin.x - img_width);
    t_start = origin + get_xy_from_offset(utf8::size(curr_item["text"].str()));
    DBG_GUI_RL << "link text start:" << t_start;
 
    std::string link_text = name.empty() ? dest : name;
    add_text_with_attribute(curr_item, link_text, "color", link_color_.to_hex_string());
 
    setup_text_renderer(curr_item, init_w_ - origin.x - img_width);
    t_end.x = origin.x + get_xy_from_offset(utf8::size(curr_item["text"].str())).x;
    DBG_GUI_RL << "link text end:" << t_end;
 
    // TODO link after right aligned images
 
    // Add link
    if (t_end.x > t_start.x) {
        rect link_rect{ t_start, point{t_end.x - t_start.x, font::get_max_height(font::SIZE_NORMAL) }};
        links_.emplace_back(link_rect, dest);
 
        DBG_GUI_RL << "added link at rect: " << link_rect;
 
    } else {
        //link straddles two lines, break into two rects
        point t_size(size_.x - t_start.x - (origin.x == 0 ? img_width : 0), t_end.y - t_start.y);
        point link_start2(origin.x, t_start.y + 1.3*font::get_max_height(font::SIZE_NORMAL));
        point t_size2(t_end.x, t_end.y - t_start.y);
 
        rect link_rect{ t_start, point{ t_size.x, font::get_max_height(font::SIZE_NORMAL) } };
        rect link_rect2{ link_start2, point{ t_size2.x, font::get_max_height(font::SIZE_NORMAL) } };
 
        links_.emplace_back(link_rect, dest);
        links_.emplace_back(link_rect2, dest);
 
        DBG_GUI_RL << "added link at rect 1: " << link_rect;
        DBG_GUI_RL << "added link at rect 2: " << link_rect2;
    }
}
 
size_t rich_label::get_split_location(std::string_view text, const point& pos) {
 
    size_t len = get_offset_from_xy(pos);
    len = (len > text.size()-1) ? text.size()-1 : len;
 
    // break only at word boundary
    char c;
    while(!std::isspace(c = text[len])) {
        len--;
        if (len == 0) {
            break;
        }
    }
 
    return len;
}
 
void rich_label::set_topic(const help::topic* topic) {
    styled_widget::set_label(topic->text.parsed_text().debug());
    std::tie(text_dom_, size_) = get_parsed_text(topic->text.parsed_text(), point(0,0), init_w_, true);
}
 
void rich_label::set_label(const t_string& text) {
    styled_widget::set_label(text);
    unparsed_text_ = text;
    help::topic_text marked_up_text(text);
    std::tie(text_dom_, size_) = get_parsed_text(marked_up_text.parsed_text(), point(0,0), init_w_, true);
}
 
std::pair<config, point> rich_label::get_parsed_text(
    const config& parsed_text,
    const point& origin,
    const unsigned init_width,
    const bool finalize)
{
    // Initial width
    DBG_GUI_RL << "Initial width: " << init_width;
 
    // Initialization
    unsigned x = 0;
    unsigned prev_blk_height = origin.y;
    unsigned text_height = 0;
    unsigned h = 0;
    unsigned w = 0;
 
    if (finalize) {
        links_.clear();
    }
 
    config text_dom;
    config* curr_item = nullptr;
    config* remaining_item = nullptr;
 
    bool is_text = false;
    bool is_image = false;
    bool is_float = false;
    bool wrap_mode = false;
    bool new_text_block = false;
 
    point img_size;
    point float_size;
 
    DBG_GUI_RL << parsed_text.debug();
 
    for(const auto [key, child] : parsed_text.all_children_range()) {
        if(key == "img") {
            std::string name = child["src"];
            std::string align = child["align"];
            bool is_curr_float = child["float"].to_bool(false);
 
            curr_item = &(text_dom.add_child("image"));
            add_image(*curr_item, name, align, is_image, is_curr_float);
            const point& curr_img_size = get_image_size(*curr_item);
 
            if (is_curr_float) {
                x = (align == "left") ? float_size.x : 0;
                float_size.x = curr_img_size.x + padding_;
                float_size.y += curr_img_size.y;
            } else {
                img_size.x += curr_img_size.x + padding_;
                x = img_size.x;
                img_size.y = std::max(img_size.y, curr_img_size.y);
                if (!is_image || (is_image && is_float)) {
                    prev_blk_height += curr_img_size.y;
                    float_size.y -= curr_img_size.y;
                }
            }
 
            w = std::max(w, x);
 
            if(is_curr_float) {
                wrap_mode = true;
            }
 
            is_image = true;
            is_float = is_curr_float;
            is_text = false;
            new_text_block = true;
 
            DBG_GUI_RL << "image: src=" << name << ", size=" << curr_img_size;
            DBG_GUI_RL << "wrap mode: " << wrap_mode << ", floating: " << is_float;
 
        } else if(key == "table") {
            if (curr_item == nullptr) {
                curr_item = &(text_dom.add_child("text"));
                default_text_config(curr_item);
                new_text_block = false;
            }
 
            // table doesn't support floating images alongside
            img_size = point(0,0);
            float_size = point(0,0);
            x = origin.x;
            prev_blk_height += text_height;
            text_height = 0;
 
            // init table vars
            unsigned col_idx = 0, row_idx = 0;
            unsigned rows = child.child_count("row");
            unsigned columns = 1;
            if (rows > 0) {
                columns = child.mandatory_child("row").child_count("col");
            }
            columns = (columns == 0) ? 1 : columns;
            unsigned width = child["width"].to_int(init_width);
            unsigned col_x = 0;
            unsigned row_y = prev_blk_height;
            unsigned max_row_height = 0;
            std::vector<unsigned> col_widths(columns, 0);
 
            // start on a new line
            (*curr_item)["actions"] = boost::str(boost::format("([set_var('pos_x', 0), set_var('pos_y', %d), set_var('tw', width - pos_x - %d)])") % row_y % col_widths[col_idx]);
 
            is_text = false;
            new_text_block = true;
            is_image = false;
 
            DBG_GUI_RL << __LINE__ << "start table : " << "row= " << rows << " col=" << columns << " width=" << width;
 
            // optimal col width calculation
            for(const config& row : child.child_range("row")) {
                col_x = 0;
                col_idx = 0;
 
                for(const config& col : row.child_range("col")) {
                    config col_cfg;
                    col_cfg.append_children(col);
 
                    config& col_txt_cfg = col_cfg.add_child("text");
                    col_txt_cfg.append_attributes(col);
 
                    // attach data
                    const auto& [table_elem, size] = get_parsed_text(col_cfg, point(col_x, row_y), width/columns);
                    col_widths[col_idx] = std::max(col_widths[col_idx], static_cast<unsigned>(size.x));
                    col_widths[col_idx] = std::min(col_widths[col_idx], width/columns);
 
                    col_x += width/columns;
                    col_idx++;
                }
 
                row_idx++;
                row_y += max_row_height + padding_;
            }
 
            // table layouting
            row_y = prev_blk_height;
            row_idx = 0;
            for(const config& row : child.child_range("row")) {
                col_x = 0;
                col_idx = 0;
                max_row_height = 0;
 
                for(const config& col : row.child_range("col")) {
                    config col_cfg;
                    col_cfg.append_children(col);
 
                    config& col_txt_cfg = col_cfg.add_child("text");
                    col_txt_cfg.append_attributes(col);
 
                    // attach data
                    auto [table_elem, size] = get_parsed_text(col_cfg, point(col_x, row_y), col_widths[col_idx]);
                    text_dom.append(std::move(table_elem));
 
                    // column post-processing
                    max_row_height = std::max(max_row_height, static_cast<unsigned>(size.y));
 
                    col_x += col_widths[col_idx] + 2 * padding_;
                    config& end_cfg = text_dom.all_children_range().back().cfg;
                    end_cfg["actions"] = boost::str(boost::format("([set_var('pos_x', %d), set_var('pos_y', %d), set_var('tw', width - %d - %d)])") % col_x % row_y % col_x % (width/columns));
 
                    DBG_GUI_RL << "jump to next column";
 
                    if (!is_image) {
                        new_text_block = true;
                    }
                    is_image = false;
                    col_idx++;
                }
 
                row_y += max_row_height + padding_;
                config& end_cfg = text_dom.all_children_range().back().cfg;
                end_cfg["actions"] = boost::str(boost::format("([set_var('pos_x', 0), set_var('pos_y', %d), set_var('tw', width - %d - %d)])") % row_y % col_x % col_widths[columns-1]);
                DBG_GUI_RL << "row height: " << max_row_height;
            }
 
            prev_blk_height = row_y;
            text_height = 0;
 
            config& end_cfg = text_dom.all_children_range().back().cfg;
            end_cfg["actions"] = boost::str(boost::format("([set_var('pos_x', 0), set_var('pos_y', %d), set_var('tw', 0)])") % row_y);
 
            is_image = false;
            is_text = false;
 
            x = origin.x;
            col_x = 0;
            row_y = 0;
            max_row_height = 0;
 
        } else if(key == "break" || key == "br") {
            if (curr_item == nullptr) {
                curr_item = &(text_dom.add_child("text"));
                default_text_config(curr_item);
                new_text_block = false;
            }
 
            // TODO correct height update
            if (is_image && !is_float) {
                prev_blk_height += padding_;
                (*curr_item)["actions"] = "([set_var('pos_x', 0), set_var('pos_y', pos_y + image_height + padding)])";
            } else {
                add_text_with_attribute(*curr_item, "\n");
            }
 
            x = origin.x;
            is_image = false;
            img_size = point(0,0);
 
            DBG_GUI_RL << "linebreak";
 
            if (!is_image) {
                new_text_block = true;
            }
            is_text = false;
 
        } else {
            std::string line = child["text"];
 
            if (!finalize && line.empty()) {
                continue;
            }
 
            config part2_cfg;
            if (is_image && (!is_float)) {
                if (!line.empty() && line.at(0) == '\n') {
                    x = origin.x;
                    prev_blk_height += padding_;
                    (*curr_item)["actions"] = "([set_var('pos_x', 0), set_var('pos_y', pos_y + image_height + padding)])";
                    line = line.substr(1);
                } else if (!line.empty() && line.at(0) != '\n') {
                    std::vector<std::string> parts = help::split_in_width(line, font::SIZE_NORMAL, init_width - x);
                    // First line
                    if (!parts.front().empty()) {
                        line = parts.front();
                    }
 
                    std::string& part2 = parts.back();
                    if (!part2.empty() && parts.size() > 1) {
                        if (part2[0] == '\n') {
                            part2 = part2.substr(1);
                        }
 
                        part2_cfg.add_child("text")["text"] = parts.back();
                        part2_cfg = get_parsed_text(part2_cfg, point(0, prev_blk_height), init_width, false).first;
                        remaining_item = &part2_cfg;
                    }
 
                    if (parts.size() == 1) {
                        prev_blk_height -= img_size.y;
                    }
                } else {
                    prev_blk_height -= img_size.y;
                }
            }
 
            if (curr_item == nullptr || new_text_block) {
                if (curr_item != nullptr) {
                    // table will calculate this by itself, no need to calculate here
                    prev_blk_height += text_height;
                    text_height = 0;
                }
 
                curr_item = &(text_dom.add_child("text"));
                default_text_config(curr_item);
                new_text_block = false;
            }
 
            // }---------- TEXT TAGS -----------{
            int tmp_h = get_text_size(*curr_item, init_width - (x == 0 ? float_size.x : x)).y;
 
            if (is_text && key == "text") {
                add_text_with_attribute(*curr_item, "\n\n");
            }
            is_text = false;
 
            if(key == "ref") {
 
                add_link(*curr_item, line, child["dst"], point(x + origin.x, prev_blk_height), float_size.x);
                is_image = false;
 
                DBG_GUI_RL << "ref: dst=" << child["dst"];
 
            } else if(std::find(format_tags.begin(), format_tags.end(), key) != format_tags.end()) {
 
                add_text_with_attribute(*curr_item, line, key);
                config parsed_children = get_parsed_text(child, point(x, prev_blk_height), init_width).first;
 
                for (const auto [parsed_key, parsed_cfg] : parsed_children.all_children_range()) {
                    if (parsed_key == "text") {
                        const auto [start, end] = add_text(*curr_item, parsed_cfg["text"]);
                        for (const config& attr : parsed_cfg.child_range("attribute")) {
                            add_attribute(*curr_item, attr["name"], start + attr["start"].to_int(), start + attr["end"].to_int(), attr["value"]);
                        }
                        add_attribute(*curr_item, key, start, end);
                    } else {
                        text_dom.add_child(parsed_key, parsed_cfg);
                    }
                }
 
                is_image = false;
 
                DBG_GUI_RL << key << ": text=" << gui2::debug_truncate(line);
 
            } else if(key == "header" || key == "h") {
 
                const auto [start, end] = add_text(*curr_item, line);
                add_attribute(*curr_item, "face", start, end, "serif");
                add_attribute(*curr_item, "color", start, end, font::string_to_color("white").to_hex_string());
                add_attribute(*curr_item, "size", start, end, std::to_string(font::SIZE_TITLE - 2));
 
                is_image = false;
 
                DBG_GUI_RL << "h: text=" << line;
 
            } else if(key == "character_entity") {
                line = "&" + child["name"].str() + ";";
 
                const auto [start, end] = add_text(*curr_item, line);
                add_attribute(*curr_item, "face", start, end, "monospace");
                add_attribute(*curr_item, "color", start, end, font::string_to_color("red").to_hex_string());
 
                is_image = false;
 
                DBG_GUI_RL << "entity: text=" << line;
 
            } else if(key == "span" || key == "format") {
 
                const auto [start, end] = add_text(*curr_item, line);
                DBG_GUI_RL << "span/format: text=" << line;
                DBG_GUI_RL << "attributes:";
 
                for (const auto& [key, value] : child.attribute_range()) {
                    if (key != "text") {
                        add_attribute(*curr_item, key, start, end, value);
                        DBG_GUI_RL << key << "=" << value;
                    }
                }
 
                is_image = false;
 
            } else if (key == "text") {
 
                DBG_GUI_RL << "text: text=" << gui2::debug_truncate(line) << "...";
 
                add_text(*curr_item, line);
 
                point text_size = get_text_size(*curr_item, init_width - (x == 0 ? float_size.x : x));
                text_size.x -= x;
 
                is_text = true;
 
                if (wrap_mode && (float_size.y > 0) && (text_size.y > float_size.y)) {
                    DBG_GUI_RL << "wrap start";
 
                    size_t len = get_split_location((*curr_item)["text"].str(), point(init_width - float_size.x, float_size.y * video::get_pixel_scale()));
                    DBG_GUI_RL << "wrap around area: " << float_size;
 
                    // first part of the text
                    std::string removed_part = (*curr_item)["text"].str().substr(len+1);
                    (*curr_item)["text"] = (*curr_item)["text"].str().substr(0, len);
                    (*curr_item)["maximum_width"] = init_width - float_size.x;
                    (*curr_item)["actions"] = boost::str(boost::format("([set_var('pos_x', 0), set_var('ww', 0), set_var('pos_y', pos_y + text_height + %d)])") % (0.3*font::get_max_height(font::SIZE_NORMAL)));
 
                    // Height update
                    int ah = get_text_size(*curr_item, init_width - float_size.x).y;
                    if (tmp_h > ah) {
                        tmp_h = 0;
                    }
                    text_height += ah - tmp_h;
 
                    prev_blk_height += text_height + 0.3*font::get_max_height(font::SIZE_NORMAL);
 
                    DBG_GUI_RL << "wrap: " << prev_blk_height << "," << text_height;
                    text_height = 0;
 
                    // New text block
                    x = origin.x;
                    wrap_mode = false;
 
                    // rest of the text
                    curr_item = &(text_dom.add_child("text"));
                    default_text_config(curr_item);
                    tmp_h = get_text_size(*curr_item, init_width).y;
                    add_text_with_attribute(*curr_item, removed_part);
 
                } else if ((float_size.y > 0) && (text_size.y < float_size.y)) {
                    //TODO padding?
                    // text height less than floating image's height, don't split
                    DBG_GUI_RL << "no wrap";
                    (*curr_item)["actions"] = "([set_var('pos_y', pos_y + text_height)])";
                }
 
                if (!wrap_mode) {
                    float_size = point(0,0);
                }
 
                is_image = false;
            }
 
            point size = get_text_size(*curr_item, init_width - (x == 0 ? float_size.x : x));
            int ah = size.y;
            // update text size and widget height
            if (tmp_h > ah) {
                tmp_h = 0;
            }
            w = std::max(w, x + static_cast<unsigned>(size.x));
 
            text_height += ah - tmp_h;
 
            if (remaining_item) {
                x = origin.x;
                (*curr_item)["actions"] = "([set_var('pos_x', 0), set_var('pos_y', pos_y + " + std::to_string(img_size.y) + ")])";
                text_dom.append(*remaining_item);
                remaining_item = nullptr;
                curr_item = &text_dom.all_children_range().back().cfg;
            }
        }
 
        if (!is_image && !wrap_mode && img_size.y > 0) {
            img_size = point(0,0);
        }
 
        if (curr_item) {
            DBG_GUI_RL << "Item:\n" << curr_item->debug();
        }
        DBG_GUI_RL << "X: " << x;
        DBG_GUI_RL << "Prev block height: " << prev_blk_height << " Current text block height: " << text_height;
        DBG_GUI_RL << "Height: " << h;
        h = text_height + prev_blk_height;
        DBG_GUI_RL << "-----------";
    } // for loop ends
 
    if (w == 0) {
        w = init_width;
    }
 
    if (finalize) {
        // reset all canvas variables to zero, otherwise they grow infinitely
        config& break_cfg = text_dom.add_child("text");
        default_text_config(&break_cfg, " ");
        break_cfg["actions"] = "([set_var('pos_x', 0), set_var('pos_y', 0), set_var('img_x', 0), set_var('img_y', 0), set_var('ww', 0), set_var('tw', 0)])";
        DBG_GUI_RL << text_dom.debug();
    }
 
    // DEBUG: draw boxes around links
    #if LINK_DEBUG_BORDER
    if (finalize) {
        for (const auto& entry : links_) {
            config& link_rect_cfg = text_dom.add_child("rectangle");
            link_rect_cfg["x"] = entry.first.x;
            link_rect_cfg["y"] = entry.first.y;
            link_rect_cfg["w"] = entry.first.w;
            link_rect_cfg["h"] = entry.first.h;
            link_rect_cfg["border_thickness"] = 1;
            link_rect_cfg["border_color"] = "255, 180, 0, 255";
        }
    }
    #endif
 
    // TODO float and a mix of floats and images
    h = std::max(static_cast<unsigned>(img_size.y), h);
 
    DBG_GUI_RL << "Width: " << w << " Height: " << h << " Origin: " << origin;
    return { text_dom, point(w, h - origin.y) };
} // function ends
 
void rich_label::default_text_config(config* txt_ptr, t_string text) {
    if (txt_ptr != nullptr) {
        (*txt_ptr)["text"] = text;
        (*txt_ptr)["font_size"] = font::SIZE_NORMAL;
        (*txt_ptr)["text_alignment"] = encode_text_alignment(get_text_alignment());
        (*txt_ptr)["x"] = "(pos_x)";
        (*txt_ptr)["y"] = "(pos_y)";
        (*txt_ptr)["w"] = "(text_width)";
        (*txt_ptr)["h"] = "(text_height)";
        // tw -> table width, used for wrapping text inside table cols
        // ww -> wrap width, used for wrapping around floating image
        // max text width shouldn't go beyond the rich_label's specified width
        (*txt_ptr)["maximum_width"] = "(width - pos_x - ww - tw)";
        (*txt_ptr)["actions"] = "([set_var('pos_y', pos_y + text_height)])";
    }
}
 
void rich_label::update_canvas()
{
    for(canvas& tmp : get_canvases()) {
        tmp.set_variable("pos_x", wfl::variant(0));
        tmp.set_variable("pos_y", wfl::variant(0));
        tmp.set_variable("img_x", wfl::variant(0));
        tmp.set_variable("img_y", wfl::variant(0));
        tmp.set_variable("width", wfl::variant(init_w_));
        tmp.set_variable("tw", wfl::variant(0));
        tmp.set_variable("ww", wfl::variant(0));
        tmp.set_variable("padding", wfl::variant(padding_));
        // Disable ellipsization so that text wrapping can work
        tmp.set_variable("text_wrap_mode", wfl::variant(PANGO_ELLIPSIZE_NONE));
        tmp.set_cfg(text_dom_, true);
        tmp.set_variable("text_alpha", wfl::variant(text_alpha_));
    }
}
 
void rich_label::set_text_alpha(unsigned short alpha)
{
    if(alpha != text_alpha_) {
        text_alpha_ = alpha;
        update_canvas();
        queue_redraw();
    }
}
 
void rich_label::set_active(const bool active)
{
    if(get_active() != active) {
        set_state(active ? ENABLED : DISABLED);
    }
}
 
void rich_label::set_link_aware(bool link_aware)
{
    if(link_aware != link_aware_) {
        link_aware_ = link_aware;
        update_canvas();
        queue_redraw();
    }
}
 
void rich_label::set_link_color(const color_t& color)
{
    if(color != link_color_) {
        link_color_ = color;
        update_canvas();
        queue_redraw();
    }
}
 
void rich_label::set_state(const state_t state)
{
    if(state != state_) {
        state_ = state;
        queue_redraw();
    }
}
 
void rich_label::signal_handler_left_button_click(bool& handled)
{
    DBG_GUI_E << "rich_label click";
 
    if(!get_link_aware()) {
        return; // without marking event as "handled"
    }
 
    point mouse = get_mouse_position() - get_origin();
 
    DBG_GUI_RL << "(mouse) " << mouse;
    DBG_GUI_RL << "link count :" << links_.size();
 
    for (const auto& entry : links_) {
        DBG_GUI_RL << "link " << entry.first;
 
        if (entry.first.contains(mouse)) {
            DBG_GUI_RL << "Clicked link! dst = " << entry.second;
            sound::play_UI_sound(settings::sound_button_click);
            if (link_handler_) {
                link_handler_(entry.second);
            } else {
                DBG_GUI_RL << "No registered link handler found";
            }
 
        }
    }
 
    handled = true;
}
 
void rich_label::signal_handler_mouse_motion(bool& handled, const point& coordinate)
{
    DBG_GUI_E << "rich_label mouse motion";
 
    if(!get_link_aware()) {
        return; // without marking event as "handled"
    }
 
    point mouse = coordinate - get_origin();
 
    for (const auto& entry : links_) {
        if (entry.first.contains(mouse)) {
            update_mouse_cursor(true);
            handled = true;
            return;
        }
    }
 
    update_mouse_cursor(false);
}
 
void rich_label::signal_handler_mouse_leave(bool& handled)
{
    DBG_GUI_E << "rich_label mouse leave";
 
    if(!get_link_aware()) {
        return; // without marking event as "handled"
    }
 
    // We left the widget, so just unconditionally reset the cursor
    update_mouse_cursor(false);
 
    handled = true;
}
 
void rich_label::update_mouse_cursor(bool enable)
{
    // Someone else may set the mouse cursor for us to something unusual (e.g.
    // the WAIT cursor) so we ought to mess with that only if it's set to
    // NORMAL or HYPERLINK.
 
    if(enable && cursor::get() == cursor::NORMAL) {
        cursor::set(cursor::HYPERLINK);
    } else if(!enable && cursor::get() == cursor::HYPERLINK) {
        cursor::set(cursor::NORMAL);
    }
}
 
// }---------- DEFINITION ---------{
 
rich_label_definition::rich_label_definition(const config& cfg)
    : styled_widget_definition(cfg)
{
    DBG_GUI_P << "Parsing rich_label " << id;
 
    load_resolutions<resolution>(cfg);
}
 
rich_label_definition::resolution::resolution(const config& cfg)
    : resolution_definition(cfg)
    , link_color(cfg["link_color"].empty() ? font::YELLOW_COLOR : color_t::from_rgba_string(cfg["link_color"].str()))
{
    // Note the order should be the same as the enum state_t is rich_label.hpp.
    state.emplace_back(VALIDATE_WML_CHILD(cfg, "state_enabled", missing_mandatory_wml_tag("rich_label_definition][resolution", "state_enabled")));
    state.emplace_back(VALIDATE_WML_CHILD(cfg, "state_disabled", missing_mandatory_wml_tag("rich_label_definition][resolution", "state_disabled")));
}
 
// }---------- BUILDER -----------{
 
namespace implementation
{
 
builder_rich_label::builder_rich_label(const config& cfg)
    : builder_styled_widget(cfg)
    , text_alignment(decode_text_alignment(cfg["text_alignment"]))
    , link_aware(cfg["link_aware"].to_bool(true))
    , width(cfg["width"], 500)
{
}
 
std::unique_ptr<widget> builder_rich_label::build() const
{
    auto lbl = std::make_unique<rich_label>(*this);
 
    const auto conf = lbl->cast_config_to<rich_label_definition>();
    assert(conf);
 
    lbl->set_text_alignment(text_alignment);
    lbl->set_link_color(conf->link_color);
    lbl->set_label(lbl->get_label());
 
    DBG_GUI_G << "Window builder: placed rich_label '" << id << "' with definition '"
              << definition << "'.";
 
    return lbl;
}
 
} // namespace implementation
 
// }------------ END --------------
 
} // namespace gui2