From e6087230319851bfe140609f4b7e5fea2d1fe981 Mon Sep 17 00:00:00 2001 From: Linus Groh Date: Sun, 3 Jan 2021 18:59:36 +0100 Subject: [PATCH] LibGUI: Add GMLFormatter MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This will be useful for both the Playground app as well as for a standalone CLI tool (à la clang-format). It cannot handle comments yet (and will drop them from the formatted output), but other than that it produces valid GML that matches the formatting we have so far! :^) --- Libraries/LibGUI/CMakeLists.txt | 1 + Libraries/LibGUI/GMLFormatter.cpp | 120 ++++++++++++++++++++++++++++++ Libraries/LibGUI/GMLFormatter.h | 35 +++++++++ 3 files changed, 156 insertions(+) create mode 100644 Libraries/LibGUI/GMLFormatter.cpp create mode 100644 Libraries/LibGUI/GMLFormatter.h diff --git a/Libraries/LibGUI/CMakeLists.txt b/Libraries/LibGUI/CMakeLists.txt index e936af38db..0a1a2a4b08 100644 --- a/Libraries/LibGUI/CMakeLists.txt +++ b/Libraries/LibGUI/CMakeLists.txt @@ -36,6 +36,7 @@ set(SOURCES FontPicker.cpp FontPickerDialogGML.h Frame.cpp + GMLFormatter.cpp GMLLexer.cpp GMLParser.cpp GMLSyntaxHighlighter.cpp diff --git a/Libraries/LibGUI/GMLFormatter.cpp b/Libraries/LibGUI/GMLFormatter.cpp new file mode 100644 index 0000000000..09c263bcc9 --- /dev/null +++ b/Libraries/LibGUI/GMLFormatter.cpp @@ -0,0 +1,120 @@ +/* + * Copyright (c) 2021, Linus Groh + * 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 +#include +#include +#include +#include + +namespace GUI { + +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 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(const 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 {}; + ASSERT(ast.is_object()); + return format_gml_object(ast.as_object()); +} + +} diff --git a/Libraries/LibGUI/GMLFormatter.h b/Libraries/LibGUI/GMLFormatter.h new file mode 100644 index 0000000000..6ae32ddbe8 --- /dev/null +++ b/Libraries/LibGUI/GMLFormatter.h @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2021, Linus Groh + * 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. + */ + +#pragma once + +#include + +namespace GUI { + +String format_gml(const StringView&); + +}