mirror of
https://github.com/RGBCube/serenity
synced 2025-07-26 17:37:35 +00:00
LibGUI: Move GML parsing and formatting to new AST
This commit introduces a couple of connected changes that are hard to untangle, unfortunately: - Parse GML into the AST instead of JSON - Change the load_from_json API on Widget to load_from_gml_ast - Remove this same API from Core::Object as it isn't used outside of LibGUI and was a workaround for the object registration detection; by verifying the objects we're getting and casting we can remove this constraint. - Format GML by calling the formating APIs on the AST itself; remove GMLFormatter.cpp as it's not needed anymore. After this change, GML formatting already respects comments :^)
This commit is contained in:
kleines Filmröllchen
Andreas Kling
parent
1806b297b6
commit
41ef4f11dc
10 changed files with 127 additions and 236 deletions
|
|
@ -1,101 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2021, Linus Groh <linusg@serenityos.org>
|
||||
* Copyright (c) 2022, kleines Filmröllchen <filmroellchen@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include "Formatter.h"
|
||||
#include "Parser.h"
|
||||
#include <AK/JsonObject.h>
|
||||
#include <AK/JsonValue.h>
|
||||
#include <AK/StringBuilder.h>
|
||||
|
||||
namespace GUI::GML {
|
||||
|
||||
static String format_gml_object(const JsonObject& node, size_t indentation = 0, bool is_inline = false)
|
||||
{
|
||||
StringBuilder builder;
|
||||
|
||||
auto indent = [&builder](size_t indentation) {
|
||||
for (size_t i = 0; i < indentation; ++i)
|
||||
builder.append(" ");
|
||||
};
|
||||
|
||||
struct Property {
|
||||
String key;
|
||||
JsonValue value;
|
||||
};
|
||||
Vector<Property> properties;
|
||||
node.for_each_member([&](auto& key, auto& value) {
|
||||
if (key != "class" && key != "layout" && key != "children")
|
||||
properties.append({ key, value });
|
||||
return IterationDecision::Continue;
|
||||
});
|
||||
|
||||
if (!is_inline)
|
||||
indent(indentation);
|
||||
builder.append('@');
|
||||
builder.append(node.get("class").as_string());
|
||||
builder.append(" {\n");
|
||||
|
||||
for (auto& property : properties) {
|
||||
indent(indentation + 1);
|
||||
builder.append(property.key);
|
||||
builder.append(": ");
|
||||
if (property.value.is_array()) {
|
||||
// custom array serialization as AK's doesn't pretty-print
|
||||
// objects and arrays (we only care about arrays (for now))
|
||||
builder.append("[");
|
||||
auto first = true;
|
||||
property.value.as_array().for_each([&](auto& value) {
|
||||
if (!first)
|
||||
builder.append(", ");
|
||||
first = false;
|
||||
value.serialize(builder);
|
||||
});
|
||||
builder.append("]");
|
||||
} else {
|
||||
property.value.serialize(builder);
|
||||
}
|
||||
builder.append("\n");
|
||||
}
|
||||
|
||||
if (node.has("layout")) {
|
||||
auto layout = node.get("layout").as_object();
|
||||
if (!properties.is_empty())
|
||||
builder.append("\n");
|
||||
indent(indentation + 1);
|
||||
builder.append("layout: ");
|
||||
builder.append(format_gml_object(move(layout), indentation + 1, true));
|
||||
}
|
||||
|
||||
if (node.has("children")) {
|
||||
auto children = node.get("children").as_array();
|
||||
auto first = properties.is_empty() && !node.has("layout");
|
||||
children.for_each([&](auto& value) {
|
||||
if (!first)
|
||||
builder.append("\n");
|
||||
first = false;
|
||||
builder.append(format_gml_object(value.as_object(), indentation + 1));
|
||||
});
|
||||
}
|
||||
|
||||
indent(indentation);
|
||||
builder.append("}\n");
|
||||
|
||||
return builder.to_string();
|
||||
}
|
||||
|
||||
String format_gml(StringView string)
|
||||
{
|
||||
// FIXME: Preserve comments somehow, they're not contained
|
||||
// in the JSON object returned by parse_gml()
|
||||
auto ast = parse_gml(string);
|
||||
if (ast.is_null())
|
||||
return {};
|
||||
VERIFY(ast.is_object());
|
||||
return format_gml_object(ast.as_object());
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -7,9 +7,18 @@
|
|||
#pragma once
|
||||
|
||||
#include <AK/Forward.h>
|
||||
#include <AK/String.h>
|
||||
#include <LibGUI/GML/AST.h>
|
||||
#include <LibGUI/GML/Parser.h>
|
||||
|
||||
namespace GUI::GML {
|
||||
|
||||
String format_gml(StringView);
|
||||
inline String format_gml(StringView string)
|
||||
{
|
||||
auto ast = parse_gml(string);
|
||||
if (ast.is_error())
|
||||
return {};
|
||||
return ast.value()->to_string();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,18 +6,20 @@
|
|||
*/
|
||||
|
||||
#include "Parser.h"
|
||||
#include "AST.h"
|
||||
#include "Lexer.h"
|
||||
#include <AK/Error.h>
|
||||
#include <AK/GenericLexer.h>
|
||||
#include <AK/JsonObject.h>
|
||||
#include <AK/JsonValue.h>
|
||||
#include <AK/Queue.h>
|
||||
#include <AK/RefPtr.h>
|
||||
|
||||
namespace GUI::GML {
|
||||
|
||||
static Optional<JsonValue> parse_core_object(Queue<Token>& tokens)
|
||||
static ErrorOr<NonnullRefPtr<Object>> parse_gml_object(Queue<Token>& tokens)
|
||||
{
|
||||
JsonObject object;
|
||||
JsonArray children;
|
||||
auto object = TRY(try_make_ref_counted<Object>());
|
||||
|
||||
auto peek = [&] {
|
||||
if (tokens.is_empty())
|
||||
|
|
@ -25,23 +27,21 @@ static Optional<JsonValue> parse_core_object(Queue<Token>& tokens)
|
|||
return tokens.head().m_type;
|
||||
};
|
||||
|
||||
while (peek() == Token::Type::Comment)
|
||||
tokens.dequeue();
|
||||
|
||||
if (peek() != Token::Type::ClassMarker) {
|
||||
dbgln("Expected class marker");
|
||||
return {};
|
||||
while (peek() == Token::Type::Comment) {
|
||||
dbgln("found comment {}", tokens.head().m_view);
|
||||
TRY(object->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
|
||||
}
|
||||
|
||||
if (peek() != Token::Type::ClassMarker)
|
||||
return Error::from_string_literal("Expected class marker"sv);
|
||||
|
||||
tokens.dequeue();
|
||||
|
||||
if (peek() != Token::Type::ClassName) {
|
||||
dbgln("Expected class name");
|
||||
return {};
|
||||
}
|
||||
if (peek() != Token::Type::ClassName)
|
||||
return Error::from_string_literal("Expected class name"sv);
|
||||
|
||||
auto class_name = tokens.dequeue();
|
||||
object.set("class", JsonValue(class_name.m_view));
|
||||
object->set_name(class_name.m_view);
|
||||
|
||||
if (peek() != Token::Type::LeftCurly) {
|
||||
// Empty object
|
||||
|
|
@ -57,72 +57,44 @@ static Optional<JsonValue> parse_core_object(Queue<Token>& tokens)
|
|||
|
||||
if (peek() == Token::Type::ClassMarker) {
|
||||
// It's a child object.
|
||||
auto value = parse_core_object(tokens);
|
||||
if (!value.has_value()) {
|
||||
dbgln("Parsing child object failed");
|
||||
return {};
|
||||
}
|
||||
if (!value.value().is_object()) {
|
||||
dbgln("Expected child to be Core::Object");
|
||||
return {};
|
||||
}
|
||||
children.append(value.release_value());
|
||||
TRY(object->add_child(TRY(parse_gml_object(tokens))));
|
||||
} else if (peek() == Token::Type::Identifier) {
|
||||
// It's a property.
|
||||
auto property_name = tokens.dequeue();
|
||||
|
||||
if (property_name.m_view.is_empty()) {
|
||||
dbgln("Expected non-empty property name");
|
||||
return {};
|
||||
}
|
||||
if (property_name.m_view.is_empty())
|
||||
return Error::from_string_literal("Expected non-empty property name"sv);
|
||||
|
||||
if (peek() != Token::Type::Colon)
|
||||
return Error::from_string_literal("Expected ':'"sv);
|
||||
|
||||
if (peek() != Token::Type::Colon) {
|
||||
dbgln("Expected ':'");
|
||||
return {};
|
||||
}
|
||||
tokens.dequeue();
|
||||
|
||||
JsonValue value;
|
||||
if (peek() == Token::Type::ClassMarker) {
|
||||
auto parsed_value = parse_core_object(tokens);
|
||||
if (!parsed_value.has_value())
|
||||
return {};
|
||||
if (!parsed_value.value().is_object()) {
|
||||
dbgln("Expected property to be Core::Object");
|
||||
return {};
|
||||
}
|
||||
value = parsed_value.release_value();
|
||||
} else if (peek() == Token::Type::JsonValue) {
|
||||
auto value_string = tokens.dequeue();
|
||||
auto parsed_value = JsonValue::from_string(value_string.m_view);
|
||||
if (parsed_value.is_error()) {
|
||||
dbgln("Expected property to be JSON value");
|
||||
return {};
|
||||
}
|
||||
value = parsed_value.release_value();
|
||||
}
|
||||
object.set(property_name.m_view, move(value));
|
||||
RefPtr<ValueNode> value;
|
||||
if (peek() == Token::Type::ClassMarker)
|
||||
value = TRY(parse_gml_object(tokens));
|
||||
else if (peek() == Token::Type::JsonValue)
|
||||
value = TRY(try_make_ref_counted<JsonValueNode>(TRY(JsonValueNode::from_string(tokens.dequeue().m_view))));
|
||||
|
||||
auto property = TRY(try_make_ref_counted<KeyValuePair>(property_name.m_view, value.release_nonnull()));
|
||||
TRY(object->add_child(property));
|
||||
|
||||
} else if (peek() == Token::Type::Comment) {
|
||||
tokens.dequeue();
|
||||
TRY(object->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
|
||||
} else {
|
||||
dbgln("Expected child, property, comment, or }}");
|
||||
return {};
|
||||
return Error::from_string_literal("Expected child, property, comment, or }}"sv);
|
||||
}
|
||||
}
|
||||
|
||||
if (peek() != Token::Type::RightCurly) {
|
||||
dbgln("Expected }}");
|
||||
return {};
|
||||
}
|
||||
tokens.dequeue();
|
||||
if (peek() != Token::Type::RightCurly)
|
||||
return Error::from_string_literal("Expected }}"sv);
|
||||
|
||||
if (!children.is_empty())
|
||||
object.set("children", move(children));
|
||||
tokens.dequeue();
|
||||
|
||||
return object;
|
||||
}
|
||||
|
||||
JsonValue parse_gml(StringView string)
|
||||
ErrorOr<NonnullRefPtr<GMLFile>> parse_gml(StringView string)
|
||||
{
|
||||
auto lexer = Lexer(string);
|
||||
|
||||
|
|
@ -130,12 +102,23 @@ JsonValue parse_gml(StringView string)
|
|||
for (auto& token : lexer.lex())
|
||||
tokens.enqueue(token);
|
||||
|
||||
auto root = parse_core_object(tokens);
|
||||
auto file = TRY(try_make_ref_counted<GMLFile>());
|
||||
|
||||
if (!root.has_value())
|
||||
return JsonValue();
|
||||
auto peek = [&] {
|
||||
if (tokens.is_empty())
|
||||
return Token::Type::Unknown;
|
||||
return tokens.head().m_type;
|
||||
};
|
||||
|
||||
return root.release_value();
|
||||
while (peek() == Token::Type::Comment)
|
||||
TRY(file->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
|
||||
|
||||
TRY(file->add_child(TRY(parse_gml_object(tokens))));
|
||||
|
||||
while (!tokens.is_empty())
|
||||
TRY(file->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
|
||||
|
||||
return file;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,9 +8,10 @@
|
|||
#pragma once
|
||||
|
||||
#include <AK/Forward.h>
|
||||
#include <LibGUI/GML/AST.h>
|
||||
|
||||
namespace GUI::GML {
|
||||
|
||||
JsonValue parse_gml(StringView);
|
||||
ErrorOr<NonnullRefPtr<GMLFile>> parse_gml(StringView);
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue