From fe2879ccc95f40db7a57f3395a811093092e68f2 Mon Sep 17 00:00:00 2001 From: CoolSpy3 <55305038+CoolSpy3@users.noreply.github.com> Date: Mon, 12 Aug 2024 13:05:58 -0700 Subject: [PATCH] Allow Indirect Field Accesses in Proto Templates (#6614) * allow indirectly referencing proto fields * update other regular expression * add test * fix test worlds * update changelog * use spaces for indentation * update proto headers * run clang-format * enable fields variable with a tag * update regex tests * update docs * update changelog * run clang-format * add curly brackets * fix comment indentation * fix proto name * fix controller name * update the changelog * fix indentation Co-authored-by: Olivier Michel --------- Co-authored-by: Olivier Michel --- docs/reference/changelog-r2024.md | 1 + docs/reference/javascript-procedural-proto.md | 10 +++ docs/reference/lua-procedural-proto.md | 10 +++ src/webots/vrml/WbProtoModel.cpp | 64 +++++++++++-------- src/webots/vrml/WbProtoModel.hpp | 3 +- .../template_indirect_field_access/.gitignore | 1 + .../template_indirect_field_access/Makefile | 19 ++++++ .../template_indirect_field_access.c | 19 ++++++ .../protos/TemplateIndirectFieldAccess.proto | 18 ++++++ .../TemplateIndirectFieldAccessLua.proto | 17 +++++ .../worlds/template_indirect_field_access.wbt | 39 +++++++++++ .../template_indirect_field_access_lua.wbt | 39 +++++++++++ 12 files changed, 213 insertions(+), 27 deletions(-) create mode 100644 tests/protos/controllers/template_indirect_field_access/.gitignore create mode 100644 tests/protos/controllers/template_indirect_field_access/Makefile create mode 100644 tests/protos/controllers/template_indirect_field_access/template_indirect_field_access.c create mode 100644 tests/protos/protos/TemplateIndirectFieldAccess.proto create mode 100644 tests/protos/protos/TemplateIndirectFieldAccessLua.proto create mode 100644 tests/protos/worlds/template_indirect_field_access.wbt create mode 100644 tests/protos/worlds/template_indirect_field_access_lua.wbt diff --git a/docs/reference/changelog-r2024.md b/docs/reference/changelog-r2024.md index 880c9f724b7..10f032d6647 100644 --- a/docs/reference/changelog-r2024.md +++ b/docs/reference/changelog-r2024.md @@ -5,6 +5,7 @@ Released on December **th, 2023. - New Features - **Change the name of the web scene format from `X3D` to `W3D` ([#6280](https://github.com/cyberbotics/webots/pull/6280)).** - Removed support for macOS 11 "Big Sur" and added support for macOS 14 "Sonoma" ([#6580](https://github.com/cyberbotics/webots/pull/6580)). + - Added the `indirectFieldAccess` tag to allow the `fields` variable to be used in proto templates without referencing a specific field ([#6614](https://github.com/cyberbotics/webots/pull/6614)). - Enhancements - Improved the image range of the rotating [Lidar](lidar.md) ([#6324](https://github.com/cyberbotics/webots/pull/6324)). - Cleanup diff --git a/docs/reference/javascript-procedural-proto.md b/docs/reference/javascript-procedural-proto.md index d10426701cd..9bf26da048b 100644 --- a/docs/reference/javascript-procedural-proto.md +++ b/docs/reference/javascript-procedural-proto.md @@ -27,6 +27,8 @@ The first represents the effective value of the field (for instance the one defi - As shown in [this table](#vrml97-type-to-javascript-type-conversion), the conversion of a VRML97 node is an object. This object contains the following keys: "node\_name" containing the VRML97 node name and "fields" which is in turn an object containing the JavaScript representation of the VRML97 node fields. This object is equal to `undefined` if the VRML97 node is not defined (`NULL`). +- By default, the parser only detects fields that are accessed directly in the template statements (i.e. `fields.appearance`). +If you would like to access the `fields` object without referencing a specific field, you can add the following line at the beginning of the PROTO file: `# tags: indirectFieldAccess`. - Objects that are part of [ECMA-262](http://www.ecma-international.org/publications/standards/Ecma-262.htm) are built-in and globally accessible, such as `Math`, `Date` and `String`. - The `context` object provides contextual information about the PROTO. Table [this table](#content-of-the-context-object) shows the available information and the corresponding keys. @@ -823,6 +825,14 @@ The location of this path can be retrieved from the `context` field object, see %end +### PROTO Regeneration +When a field used in a template statement is modified, the PROTO node is regenerated. +This means that the template statements are re-evaluated and the PROTO node is reloaded in the world. +For most nodes, this behavior should not affect the simulation. +However, special care should be taken when using PROTOs that have side effects (e.g. writing to a file). +Additionally, Robot nodes will restart their controllers when regenerated. +Using `tags: indirectFieldAccess` in the PROTO file will cause the PROTO to be regenerated whenever any field is modified, even if it is not used in a template statement. + ### Optimization By default, PROTO files are considered to be deterministic. diff --git a/docs/reference/lua-procedural-proto.md b/docs/reference/lua-procedural-proto.md index 04cbf5ed519..2f1f9aea87a 100644 --- a/docs/reference/lua-procedural-proto.md +++ b/docs/reference/lua-procedural-proto.md @@ -24,6 +24,8 @@ The conversion between the VRML97 types and the Lua types is detailed in [this t This dictionary contains the following keys: "node\_name" containing the VRML97 node name and "fields" which is a dictionary containing the Lua representation of the VRML97 node fields. This dictionary is equal to `nil` if the VRML97 node is not defined (`NULL`). For example, in the SimpleStairs example below, the `fields.appearance.node_name` key contains the `'Appearance'` string. +- By default, the parser only detects fields that are accessed directly in the template statements (i.e. `fields.appearance`). +If you would like to access the `fields` object without referencing a specific field, you can add the following line at the beginning of the PROTO file: `# tags: indirectFieldAccess`. - The `context` dictionary provides contextual information about the PROTO. Table [this table](#content-of-the-context-dictionary) shows the available information and its corresponding keys. - The VRML97 comment ("#") prevails over the Lua statements. @@ -88,6 +90,14 @@ The following standard fonts are available to write on the texture: In addition to these fonts, it is possible to add other TrueType fonts file in your `PROJECT_HOME/fonts` directory. +### PROTO Regeneration +When a field used in a template statement is modified, the PROTO node is regenerated. +This means that the template statements are re-evaluated and the PROTO node is reloaded in the world. +For most nodes, this behavior should not affect the simulation. +However, special care should be taken when using PROTOs that have side effects (e.g. writing to a file). +Additionally, Robot nodes will restart their controllers when regenerated. +Using `tags: indirectFieldAccess` in the PROTO file will cause the PROTO to be regenerated whenever any field is modified, even if it is not used in a template statement. + ### Optimization By default, PROTO files are considered to be deterministic. diff --git a/src/webots/vrml/WbProtoModel.cpp b/src/webots/vrml/WbProtoModel.cpp index 4a2a13cccc8..07de98d3812 100644 --- a/src/webots/vrml/WbProtoModel.cpp +++ b/src/webots/vrml/WbProtoModel.cpp @@ -69,6 +69,7 @@ WbProtoModel::WbProtoModel(WbTokenizer *tokenizer, const QString &worldPath, con mDocumentationUrl = tokenizer->documentationUrl(); mTemplateLanguage = tokenizer->templateLanguage(); mIsDeterministic = !mTags.contains("nonDeterministic"); + mHasIndirectFieldAccess = mTags.contains("indirectFieldAccess"); WbParser parser(tokenizer); while (tokenizer->peekWord() == "EXTERNPROTO" || tokenizer->peekWord() == "IMPORTABLE") // consume EXTERNPROTO declarations @@ -209,15 +210,23 @@ WbProtoModel::WbProtoModel(WbTokenizer *tokenizer, const QString &worldPath, con previousToken = token; token = tokenizer->nextToken(); + if (mHasIndirectFieldAccess) { + foreach (WbFieldModel *model, mFieldModels) + model->setTemplateRegenerator(true); + } + if (token->isTemplateStatement()) { mTemplate = true; - foreach (WbFieldModel *model, mFieldModels) { - // condition explanation: if (token contains modelName and not a Lua identifier containing modelName such as - // "my_awesome_modelName") - if (token->word().contains(QRegularExpression( - QString("(^|[^a-zA-Z0-9_])fields\\.%1($|[^a-zA-Z0-9_])").arg(QRegularExpression::escape(model->name()))))) { - model->setTemplateRegenerator(true); + if (!mHasIndirectFieldAccess) { // If the proto has indirect field access, we've already set the fields as template + // regenerators + foreach (WbFieldModel *model, mFieldModels) { + // condition explanation: if (token contains modelName and not a Lua identifier containing modelName such as + // "my_awesome_modelName") or (token contains fields and not a Lua identifier containing fields such as "my_fields") + if (token->word().contains( + QRegularExpression(QString("(^|\\W)fields\\.%1($|\\W)").arg(QRegularExpression::escape(model->name()))))) { + model->setTemplateRegenerator(true); + } } } } else if (readBaseType) { @@ -274,26 +283,29 @@ WbProtoModel::WbProtoModel(WbTokenizer *tokenizer, const QString &worldPath, con throw 0; } } else if (token->isString()) { - // check which parameter need to regenerate the template instance from inside a string - foreach (WbFieldModel *model, mFieldModels) { - // regex test cases: - // "You know nothing, John Snow." => false - // "%{=fields.model->name()}%" => false - // "%{= fields.model->name().value.x }% %{= fields.model->name().value.y }%" => true - // "abc %{= fields.model->name().value.y }% def" => true - // "%{= 17 % fields.model->name().value.y * 88 }%" => true - // "fields.model->name().value.y" => false - // "%{}% fields.model->name().value.y %{}%" => false - // "%{ a = \"fields.model->name().value.y\" }%" => false - // "%{= \"fields.model->name().value.y\" }%" => false - // "%{= fields.model->name().value.y }%" => true - if (token->word().contains(QRegularExpression(QString("%1(?:(?!%2|\").)*fields\\.%3(?:(?!%4|\").)*%5") - .arg(open) - .arg(close) - .arg(QRegularExpression::escape(model->name())) - .arg(close) - .arg(close)))) - model->setTemplateRegenerator(true); + if (!mHasIndirectFieldAccess) { // If the proto has indirect field access, we've already set the fields as template + // regenerators + // check which parameter need to regenerate the template instance from inside a string + foreach (WbFieldModel *model, mFieldModels) { + // regex test cases: + // "You know nothing, John Snow." => false + // "%{=fields.model->name()}%" => true + // "%{= fields.model->name().value.x }% %{= fields.model->name().value.y }%" => true + // "abc %{= fields.model->name().value.y }% def" => true + // "%{= 17 % fields.model->name().value.y * 88 }%" => true + // "fields.model->name().value.y" => false + // "%{}% fields.model->name().value.y %{}%" => false + // "%{ a = \"fields.model->name().value.y\" }%" => false + // "%{= \"fields.model->name().value.y\" }%" => false + // "%{= fields.model->name().value.y }%" => true + if (token->word().contains(QRegularExpression(QString("%1(?:(?!%2|\").)*fields\\.%3(?:(?!%4|\").)*%5") + .arg(open) + .arg(close) + .arg(QRegularExpression::escape(model->name())) + .arg(close) + .arg(close)))) + model->setTemplateRegenerator(true); + } } } diff --git a/src/webots/vrml/WbProtoModel.hpp b/src/webots/vrml/WbProtoModel.hpp index dccf030bd97..49fca7c8971 100644 --- a/src/webots/vrml/WbProtoModel.hpp +++ b/src/webots/vrml/WbProtoModel.hpp @@ -125,7 +125,8 @@ class WbProtoModel : public QObject { WbVersion mFileVersion; QString mName; QString mInfo; - bool mIsDeterministic; // i.e doesn't have the 'nonDeterministic' tag + bool mIsDeterministic; // i.e doesn't have the 'nonDeterministic' tag + bool mHasIndirectFieldAccess; // i.e. has the 'indirectFieldAccess' tag QList mFieldModels; QString mUrl; // how the PROTO is referenced diff --git a/tests/protos/controllers/template_indirect_field_access/.gitignore b/tests/protos/controllers/template_indirect_field_access/.gitignore new file mode 100644 index 00000000000..7abe0a8a413 --- /dev/null +++ b/tests/protos/controllers/template_indirect_field_access/.gitignore @@ -0,0 +1 @@ +/template_indirect_field_access diff --git a/tests/protos/controllers/template_indirect_field_access/Makefile b/tests/protos/controllers/template_indirect_field_access/Makefile new file mode 100644 index 00000000000..9734e04d8e9 --- /dev/null +++ b/tests/protos/controllers/template_indirect_field_access/Makefile @@ -0,0 +1,19 @@ +# Copyright 1996-2023 Cyberbotics Ltd. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +### Do not modify: this includes Webots global Makefile.include +null := +space := $(null) $(null) +WEBOTS_HOME_PATH?=$(subst $(space),\ ,$(strip $(subst \,/,$(WEBOTS_HOME)))) +include $(WEBOTS_HOME_PATH)/resources/Makefile.include diff --git a/tests/protos/controllers/template_indirect_field_access/template_indirect_field_access.c b/tests/protos/controllers/template_indirect_field_access/template_indirect_field_access.c new file mode 100644 index 00000000000..6a5605d5473 --- /dev/null +++ b/tests/protos/controllers/template_indirect_field_access/template_indirect_field_access.c @@ -0,0 +1,19 @@ +#include +#include +#include + +#include "../../../lib/ts_assertion.h" +#include "../../../lib/ts_utils.h" + +#define TIME_STEP 32 + +int main(int argc, char **argv) { + ts_setup(argv[1]); // give the controller args + WbNodeRef proto = wb_supervisor_node_get_from_def("PROTO_template_indirect_field_access"); + WbFieldRef radarCrossSection = wb_supervisor_node_get_proto_field(proto, "radarCrossSection"); + ts_assert_double_in_delta(wb_supervisor_field_get_sf_float(radarCrossSection), 6.0, 0.0001, + "radarCrossSection should be 6.0"); + ts_send_success(); + + return EXIT_SUCCESS; +} diff --git a/tests/protos/protos/TemplateIndirectFieldAccess.proto b/tests/protos/protos/TemplateIndirectFieldAccess.proto new file mode 100644 index 00000000000..b115bed1463 --- /dev/null +++ b/tests/protos/protos/TemplateIndirectFieldAccess.proto @@ -0,0 +1,18 @@ +#VRML_SIM R2024a utf8 +# tags: indirectFieldAccess +# template language: javascript + +PROTO TemplateIndirectFieldAccess [ + unconnectedField SFFloat field1 1 + unconnectedField SFFloat field2 5 +] +{ + Solid { + %< + function sum(fieldsObj) { + return fieldsObj.field1.value + fieldsObj.field2.value; + } + >% + radarCrossSection %<= sum(fields) >% + } +} diff --git a/tests/protos/protos/TemplateIndirectFieldAccessLua.proto b/tests/protos/protos/TemplateIndirectFieldAccessLua.proto new file mode 100644 index 00000000000..d6b9a0c20e3 --- /dev/null +++ b/tests/protos/protos/TemplateIndirectFieldAccessLua.proto @@ -0,0 +1,17 @@ +#VRML_SIM R2024a utf8 +# tags: indirectFieldAccess + +PROTO TemplateIndirectFieldAccessLua [ + unconnectedField SFFloat field1 1 + unconnectedField SFFloat field2 5 +] +{ + Solid { + %{ + function sum(fieldsObj) + return fieldsObj.field1.value + fieldsObj.field2.value; + end + }% + radarCrossSection %{= sum(fields) }% + } +} diff --git a/tests/protos/worlds/template_indirect_field_access.wbt b/tests/protos/worlds/template_indirect_field_access.wbt new file mode 100644 index 00000000000..1d79b67a155 --- /dev/null +++ b/tests/protos/worlds/template_indirect_field_access.wbt @@ -0,0 +1,39 @@ +#VRML_SIM R2024a utf8 + +EXTERNPROTO "webots://tests/protos/protos/TemplateIndirectFieldAccess.proto" +EXTERNPROTO "webots://tests/default/protos/TestSuiteEmitter.proto" +EXTERNPROTO "webots://tests/default/protos/TestSuiteSupervisor.proto" + +WorldInfo { + coordinateSystem "NUE" + lineScale 1 +} +Viewpoint { + orientation -0.8999515417256047 0.42450878383113183 0.0993957493855782 0.509061 + position 0.303563 0.46348 0.936228 +} +Background { + skyColor [ + 0 0.811765 0.992157 + ] +} +DirectionalLight { + direction 0 0.5 -1 +} +Robot { + translation 0.1 0 0.15 + rotation 0 1 0 1.5708 + children [ + DEF PROTO_template_indirect_field_access TemplateIndirectFieldAccess { + } + TestSuiteEmitter { + } + ] + controller "template_indirect_field_access" + controllerArgs [ + "template_indirect_field_access" + ] + supervisor TRUE +} +TestSuiteSupervisor { +} diff --git a/tests/protos/worlds/template_indirect_field_access_lua.wbt b/tests/protos/worlds/template_indirect_field_access_lua.wbt new file mode 100644 index 00000000000..b16b039f496 --- /dev/null +++ b/tests/protos/worlds/template_indirect_field_access_lua.wbt @@ -0,0 +1,39 @@ +#VRML_SIM R2024a utf8 + +EXTERNPROTO "webots://tests/protos/protos/TemplateIndirectFieldAccessLua.proto" +EXTERNPROTO "webots://tests/default/protos/TestSuiteEmitter.proto" +EXTERNPROTO "webots://tests/default/protos/TestSuiteSupervisor.proto" + +WorldInfo { + coordinateSystem "NUE" + lineScale 1 +} +Viewpoint { + orientation -0.8999515417256047 0.42450878383113183 0.0993957493855782 0.509061 + position 0.303563 0.46348 0.936228 +} +Background { + skyColor [ + 0 0.811765 0.992157 + ] +} +DirectionalLight { + direction 0 0.5 -1 +} +Robot { + translation 0.1 0 0.15 + rotation 0 1 0 1.5708 + children [ + DEF PROTO_template_indirect_field_access TemplateIndirectFieldAccessLua { + } + TestSuiteEmitter { + } + ] + controller "template_indirect_field_access" + controllerArgs [ + "template_indirect_field_access (lua)" + ] + supervisor TRUE +} +TestSuiteSupervisor { +}