0ct0pu5/ladybird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

LibGUI: Enforce new GML newline and ordering guidelines

Browse source 
Specifically:
 * Properties must precede sub-object declarations.
 * There shouldn't be any newlines in-between properties.
 * There should be a newline in-between each sub-object.
 * Object declarations must include the curly braces.
 * There should be a newline between the properties of an object and
   it's sub-objects.
This commit is contained in:
Idan Horowitz 2022-02-12 18:41:07 +02:00
parent c52dc87a42
commit d4f08b3096
Notes: sideshowbarker 2024-07-17 18:57:15 +09:00
2 changed files with 51 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
Userland/Libraries/LibGUI/GML/AST.h
View file

@ -153,8 +153,9 @@ public:
class Object : public ValueNode {
public:
Object() = default;
Object(String name, NonnullRefPtrVector<Node> children)
: m_children(move(children))
Object(String name, NonnullRefPtrVector<Node> properties, NonnullRefPtrVector<Node> sub_objects)
: m_properties(move(properties))
, m_sub_objects(move(sub_objects))
, m_name(move(name))
{
}
@ -163,18 +164,24 @@ public:
StringView name() const { return m_name; }
void set_name(String name) { m_name = move(name); }
NonnullRefPtrVector<Node> children() const { return m_children; }
ErrorOr<void> add_child(NonnullRefPtr<Node> child)
ErrorOr<void> add_sub_object_child(NonnullRefPtr<Node> child)
{
return m_children.try_append(move(child));
VERIFY(is<Object>(child.ptr()) || is<Comment>(child.ptr()));
return m_sub_objects.try_append(move(child));
}
ErrorOr<void> add_property_child(NonnullRefPtr<Node> child)
{
VERIFY(is<KeyValuePair>(child.ptr()) || is<Comment>(child.ptr()));
return m_properties.try_append(move(child));
}
// Does not return key-value pair `layout: ...`!
template<typename Callback>
void for_each_property(Callback callback)
{
for (auto const& child : m_children) {
for (auto const& child : m_properties) {
if (is<KeyValuePair>(child)) {
auto const& property = static_cast<KeyValuePair const&>(child);
if (property.key() != "layout" && is<JsonValueNode>(property.value().ptr()))
@ -186,7 +193,7 @@ public:
template<typename Callback>
void for_each_child_object(Callback callback)
{
for (NonnullRefPtr<Node> child : m_children) {
for (NonnullRefPtr<Node> child : m_sub_objects) {
// doesn't capture layout as intended, as that's behind a kv-pair
if (is<Object>(child.ptr())) {
auto object = static_ptr_cast<Object>(child);
@ -199,7 +206,7 @@ public:
template<IteratorFunction<NonnullRefPtr<Object>> Callback>
void for_each_child_object_interruptible(Callback callback)
{
for (NonnullRefPtr<Node> child : m_children) {
for (NonnullRefPtr<Node> child : m_sub_objects) {
// doesn't capture layout as intended, as that's behind a kv-pair
if (is<Object>(child.ptr())) {
auto object = static_ptr_cast<Object>(child);
@ -211,7 +218,7 @@ public:
RefPtr<Object> layout_object() const
{
for (NonnullRefPtr<Node> child : m_children) {
for (NonnullRefPtr<Node> child : m_properties) {
if (is<KeyValuePair>(child.ptr())) {
auto property = static_ptr_cast<KeyValuePair>(child);
if (property->key() == "layout") {
@ -225,7 +232,7 @@ public:
RefPtr<ValueNode> get_property(StringView property_name)
{
for (NonnullRefPtr<Node> child : m_children) {
for (NonnullRefPtr<Node> child : m_properties) {
if (is<KeyValuePair>(child.ptr())) {
auto property = static_ptr_cast<KeyValuePair>(child);
if (property->key() == property_name)
@ -241,28 +248,37 @@ public:
indent(builder, indentation);
builder.append('@');
builder.append(m_name);
builder.append(" {");
if (!m_properties.is_empty() || !m_sub_objects.is_empty()) {
builder.append('\n');
if (!m_children.is_empty()) {
builder.append(" {\n");
for (auto const& property : m_properties)
property.format(builder, indentation + 1, false);
if (!m_properties.is_empty() && !m_sub_objects.is_empty())
builder.append('\n');
// This loop is necessary as we need to know what the last child is.
for (size_t i = 0; i < m_children.size(); ++i) {
auto const& child = m_children[i];
for (size_t i = 0; i < m_sub_objects.size(); ++i) {
auto const& child = m_sub_objects[i];
child.format(builder, indentation + 1, false);
if (is<Object>(child) && i != m_children.size() - 1)
if (is<Object>(child) && i != m_sub_objects.size() - 1)
builder.append('\n');
}
indent(builder, indentation);
builder.append('}');
}
builder.append('\n');
builder.append('}');
if (!is_inline)
builder.append('\n');
}
private:
// Any node contained in the object body, i.e. properties, comments and subobjects.
NonnullRefPtrVector<Node> m_children;
// Properties and comments
NonnullRefPtrVector<Node> m_properties;
// Sub objects and comments
NonnullRefPtrVector<Node> m_sub_objects;
String m_name {};
};

25
Userland/Libraries/LibGUI/GML/Parser.cpp
View file

@ -29,7 +29,7 @@ static ErrorOr<NonnullRefPtr<Object>> parse_gml_object(Queue<Token>& tokens)
while (peek() == Token::Type::Comment) {
dbgln("found comment {}", tokens.head().m_view);
TRY(object->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
TRY(object->add_property_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
}
if (peek() != Token::Type::ClassMarker)
@ -43,12 +43,12 @@ static ErrorOr<NonnullRefPtr<Object>> parse_gml_object(Queue<Token>& tokens)
auto class_name = tokens.dequeue();
object->set_name(class_name.m_view);
if (peek() != Token::Type::LeftCurly) {
// Empty object
return object;
}
if (peek() != Token::Type::LeftCurly)
return Error::from_string_literal("Expected {{"sv);
tokens.dequeue();
NonnullRefPtrVector<Comment> pending_comments;
for (;;) {
if (peek() == Token::Type::RightCurly) {
// End of object
@ -57,9 +57,17 @@ static ErrorOr<NonnullRefPtr<Object>> parse_gml_object(Queue<Token>& tokens)
if (peek() == Token::Type::ClassMarker) {
// It's a child object.
TRY(object->add_child(TRY(parse_gml_object(tokens))));
while (!pending_comments.is_empty())
TRY(object->add_sub_object_child(pending_comments.take_last()));
TRY(object->add_sub_object_child(TRY(parse_gml_object(tokens))));
} else if (peek() == Token::Type::Identifier) {
// It's a property.
while (!pending_comments.is_empty())
TRY(object->add_property_child(pending_comments.take_last()));
auto property_name = tokens.dequeue();
if (property_name.m_view.is_empty())
@ -77,10 +85,9 @@ static ErrorOr<NonnullRefPtr<Object>> parse_gml_object(Queue<Token>& tokens)
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));
TRY(object->add_property_child(property));
} else if (peek() == Token::Type::Comment) {
TRY(object->add_child(TRY(Node::from_token<Comment>(tokens.dequeue()))));
pending_comments.append(TRY(Node::from_token<Comment>(tokens.dequeue())));
} else {
return Error::from_string_literal("Expected child, property, comment, or }}"sv);
}