ladybird/Libraries/LibHTML/Dump.cpp

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <AK/Utf8View.h>
#include <LibHTML/CSS/PropertyID.h>
#include <LibHTML/CSS/StyleSheet.h>
#include <LibHTML/DOM/Comment.h>
#include <LibHTML/DOM/Document.h>
#include <LibHTML/DOM/DocumentType.h>
#include <LibHTML/DOM/Element.h>
#include <LibHTML/DOM/Text.h>
#include <LibHTML/Dump.h>
#include <LibHTML/Layout/LayoutBlock.h>
#include <LibHTML/Layout/LayoutNode.h>
#include <LibHTML/Layout/LayoutText.h>
#include <stdio.h>

void dump_tree(const Node& node)
{
    static int indent = 0;
    for (int i = 0; i < indent; ++i)
        dbgprintf("  ");
    if (is<Document>(node)) {
        dbgprintf("*Document*\n");
    } else if (is<Element>(node)) {
        dbgprintf("<%s", to<Element>(node).tag_name().characters());
        to<Element>(node).for_each_attribute([](auto& name, auto& value) {
            dbgprintf(" %s=%s", name.characters(), value.characters());
        });
        dbgprintf(">\n");
    } else if (is<Text>(node)) {
        dbgprintf("\"%s\"\n", static_cast<const Text&>(node).data().characters());
    } else if (is<DocumentType>(node)) {
        dbgprintf("<!DOCTYPE>\n");
    } else if (is<Comment>(node)) {
        dbgprintf("<!--%s-->\n", to<Comment>(node).data().characters());
    }
    ++indent;
    if (is<ParentNode>(node)) {
        static_cast<const ParentNode&>(node).for_each_child([](auto& child) {
            dump_tree(child);
        });
    }
    --indent;
}

void dump_tree(const LayoutNode& layout_node)
{
    static size_t indent = 0;
    for (size_t i = 0; i < indent; ++i)
        dbgprintf("    ");

    String tag_name;
    if (layout_node.is_anonymous())
        tag_name = "(anonymous)";
    else if (is<Text>(layout_node.node()))
        tag_name = "#text";
    else if (is<Document>(layout_node.node()))
        tag_name = "#document";
    else if (is<Element>(layout_node.node()))
        tag_name = to<Element>(*layout_node.node()).tag_name();
    else
        tag_name = "???";

    if (!layout_node.is_box()) {
        dbgprintf("%s {%s}\n", layout_node.class_name(), tag_name.characters());
    } else {
        auto& layout_box = to<LayoutBox>(layout_node);
        dbgprintf("%s {%s} at (%g,%g) size %gx%g",
            layout_box.class_name(),
            tag_name.characters(),
            layout_box.x(),
            layout_box.y(),
            layout_box.width(),
            layout_box.height());

        // Dump the horizontal box properties
        dbgprintf(" [%g+%g+%g %g %g+%g+%g]",
            layout_box.box_model().margin().left.to_px(),
            layout_box.box_model().border().left.to_px(),
            layout_box.box_model().padding().left.to_px(),
            layout_box.width(),
            layout_box.box_model().padding().right.to_px(),
            layout_box.box_model().border().right.to_px(),
            layout_box.box_model().margin().right.to_px());

        // And the vertical box properties
        dbgprintf(" [%g+%g+%g %g %g+%g+%g]",
            layout_box.box_model().margin().top.to_px(),
            layout_box.box_model().border().top.to_px(),
            layout_box.box_model().padding().top.to_px(),
            layout_box.height(),
            layout_box.box_model().padding().bottom.to_px(),
            layout_box.box_model().border().bottom.to_px(),
            layout_box.box_model().margin().bottom.to_px());

        dbgprintf("\n");
    }

    if (layout_node.is_block() && static_cast<const LayoutBlock&>(layout_node).children_are_inline()) {
        auto& block = static_cast<const LayoutBlock&>(layout_node);
        for (size_t i = 0; i < indent; ++i)
            dbgprintf("    ");
        dbgprintf("  Line boxes (%d):\n", block.line_boxes().size());
        for (size_t line_box_index = 0; line_box_index < block.line_boxes().size(); ++line_box_index) {
            auto& line_box = block.line_boxes()[line_box_index];
            for (size_t i = 0; i < indent; ++i)
                dbgprintf("    ");
            dbgprintf("    [%d] width: %g\n", line_box_index, line_box.width());
            for (size_t fragment_index = 0; fragment_index < line_box.fragments().size(); ++fragment_index) {
                auto& fragment = line_box.fragments()[fragment_index];
                for (size_t i = 0; i < indent; ++i)
                    dbgprintf("    ");
                dbgprintf("      [%d] layout_node: %s{%p}, start: %d, length: %d, rect: %s\n",
                    fragment_index,
                    fragment.layout_node().class_name(),
                    &fragment.layout_node(),
                    fragment.start(),
                    fragment.length(),
                    fragment.rect().to_string().characters());
                if (fragment.layout_node().is_text()) {
                    for (size_t i = 0; i < indent; ++i)
                        dbgprintf("    ");
                    auto& layout_text = static_cast<const LayoutText&>(fragment.layout_node());
                    auto fragment_text = layout_text.text_for_rendering().substring(fragment.start(), fragment.length());
                    dbgprintf("        text: \"%s\"\n", fragment_text.characters());
                }
            }
        }
    }

    layout_node.style().for_each_property([&](auto property_id, auto& value) {
        for (size_t i = 0; i < indent; ++i)
            dbgprintf("    ");
        dbgprintf("  (%s: %s)\n", CSS::string_from_property_id(property_id), value.to_string().characters());
    });

    ++indent;
    layout_node.for_each_child([](auto& child) {
        dump_tree(child);
    });
    --indent;
}

void dump_rule(const StyleRule& rule)
{
    dbgprintf("Rule:\n");
    for (auto& selector : rule.selectors()) {
        dbgprintf("  Selector:\n");

        for (auto& complex_selector : selector.complex_selectors()) {
            dbgprintf("    ");

            const char* relation_description = "";
            switch (complex_selector.relation) {
            case Selector::ComplexSelector::Relation::None:
                break;
            case Selector::ComplexSelector::Relation::ImmediateChild:
                relation_description = "ImmediateChild";
                break;
            case Selector::ComplexSelector::Relation::Descendant:
                relation_description = "Descendant";
                break;
            case Selector::ComplexSelector::Relation::AdjacentSibling:
                relation_description = "AdjacentSibling";
                break;
            case Selector::ComplexSelector::Relation::GeneralSibling:
                relation_description = "GeneralSibling";
                break;
            }

            if (*relation_description)
                dbgprintf("{%s} ", relation_description);

            for (size_t i = 0; i < complex_selector.compound_selector.size(); ++i) {
                auto& simple_selector = complex_selector.compound_selector[i];
                const char* type_description = "Unknown";
                switch (simple_selector.type) {
                case Selector::SimpleSelector::Type::Invalid:
                    type_description = "Invalid";
                    break;
                case Selector::SimpleSelector::Type::Universal:
                    type_description = "Universal";
                    break;
                case Selector::SimpleSelector::Type::Id:
                    type_description = "Id";
                    break;
                case Selector::SimpleSelector::Type::Class:
                    type_description = "Class";
                    break;
                case Selector::SimpleSelector::Type::TagName:
                    type_description = "TagName";
                    break;
                }
                const char* attribute_match_type_description = "";
                switch (simple_selector.attribute_match_type) {
                case Selector::SimpleSelector::AttributeMatchType::None:
                    break;
                case Selector::SimpleSelector::AttributeMatchType::HasAttribute:
                    attribute_match_type_description = "HasAttribute";
                    break;
                case Selector::SimpleSelector::AttributeMatchType::ExactValueMatch:
                    attribute_match_type_description = "ExactValueMatch";
                    break;
                }

                dbgprintf("%s:%s", type_description, simple_selector.value.characters());
                if (simple_selector.attribute_match_type != Selector::SimpleSelector::AttributeMatchType::None) {
                    dbgprintf(" [%s, name='%s', value='%s']", attribute_match_type_description, simple_selector.attribute_name.characters(), simple_selector.attribute_value.characters());
                }

                if (i != complex_selector.compound_selector.size() - 1)
                    dbgprintf(", ");
            }
            dbgprintf("\n");
        }
    }
    dbgprintf("  Declarations:\n");
    for (auto& property : rule.declaration().properties()) {
        dbgprintf("    %s: '%s'\n", CSS::string_from_property_id(property.property_id), property.value->to_string().characters());
    }
}

void dump_sheet(const StyleSheet& sheet)
{
    dbgprintf("StyleSheet{%p}: %d rule(s)\n", &sheet, sheet.rules().size());

    for (auto& rule : sheet.rules()) {
        dump_rule(rule);
    }
}