Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-03-27 22:36:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

HTMLTemplate template processing part 1.

Browse Source
This commit is contained in:
Relintai 2024-02-26 11:36:13 +01:00
parent a6eb8377a6
commit af492fc79e
3 changed files with 263 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
modules/web/doc_classes/HTMLTemplate.xml
View File

@ -48,10 +48,9 @@
<method name="get_and_render_template">
<return type="String" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="request" type="WebServerRequest" />
<argument index="2" name="data" type="Dictionary" />
<argument index="1" name="data" type="Dictionary" />
<description>
Gets a template string using [method get_template] and does variable substitutions on it.
Gets a template string using [method get_template] and does method substitutions on it.
</description>
</method>
<method name="get_template">
@ -156,22 +155,6 @@
Sets a template override value.
</description>
</method>
<method name="substitute_data_variables">
<return type="String" />
<argument index="0" name="text" type="String" />
<argument index="1" name="data" type="Dictionary" />
<description>
Helper method that does data variable substitutions on a given text.
</description>
</method>
<method name="substitute_request_variables">
<return type="String" />
<argument index="0" name="text" type="String" />
<argument index="1" name="request" type="WebServerRequest" />
<description>
Helper method that does request variable substitutions on a given text.
</description>
</method>
</methods>
<members>
<member name="template_defaults" type="Dictionary" setter="set_template_defaults" getter="get_template_defaults" default="{}">

263
modules/web/html/html_template.cpp
View File

@ -190,21 +190,6 @@ void HTMLTemplate::set_template_defaults_map(const HashMap<StringName, String> &
// Use
String HTMLTemplate::substitute_data_variables(const String &p_text, const Dictionary &p_data) {
//TODO
return p_text;
}
String HTMLTemplate::substitute_request_variables(const String &p_text, const Ref<WebServerRequest> &p_request) {
if (!p_request.is_valid()) {
return p_text;
}
//TODO
return p_text;
}
String HTMLTemplate::get_template_text(const StringName &p_name) {
// First try overrides
String *sptr = _template_overrides.getptr(p_name);
@ -240,18 +225,252 @@ String HTMLTemplate::get_template_text(const StringName &p_name) {
return String();
}
String HTMLTemplate::render_template(const String &p_text, const Ref<WebServerRequest> &p_request, const Dictionary &p_data) {
String res = substitute_data_variables(p_text, p_data);
String HTMLTemplate::process_template_expression(const String &p_expression, const Dictionary &p_data) {
//TODO
return String();
}
res = substitute_request_variables(p_text, p_request);
String HTMLTemplate::render_template(const String &p_text, const Dictionary &p_data) {
// {\{ Escaped {{
// {\\{ -> {\{ etc
// {{ p(var) }} // print, escaped, also includes to string cast
// {{ pr(var) }} // print_raw, not escaped, also includes to string
// {{ pb(var) }} // print_newline_to_br, escaped, turns newlines into <br>, also includes to string cast
// {{ prb(var) }} // print_raw_newline_to_br, not escaped, turns newlines into <br>, also includes to string cast
// {{ vf("%d %d", var1, var2) }} // vformat
return res;
String result;
int text_length = p_text.length();
if (text_length == 0) {
return result;
}
int i = 0;
int last_section_start = 0;
bool in_string = false;
CharType current_string_type = '"';
int current_state = RENDER_TEMPLATE_STATE_NORMAL_TEXT;
bool escape_next = false;
while (i < text_length) {
CharType current_token = p_text[i];
switch (current_state) {
case RENDER_TEMPLATE_STATE_NORMAL_TEXT: {
if (escape_next) {
escape_next = false;
continue;
}
switch (current_token) {
case '{': {
// A { is encountered, might be an expression.
current_state = RENDER_TEMPLATE_STATE_EXPRESSION_POTENTIAL_START;
} break;
}
} break;
case RENDER_TEMPLATE_STATE_EXPRESSION_POTENTIAL_START: {
switch (current_token) {
case '\\': {
// The last token was {, The current token is \.
// Just set escape_next to true
// If the next token is {, it will be handled properly in "case '{':"
// If it's something else "default:" will reset state back to proper
// In case of {\\\\{ We need to turn it to {\\\{
// This will go through all \'s
escape_next = true;
} break;
case '{': {
if (escape_next) {
// i points to: v
// In case of {\\\\{ We need to turn it to {\\\{
// cut here: ^
// We should have {\\\ .
// We cut
result += p_text.substr_index(last_section_start, i - 2);
// Don't append the now missing {, it will be appended on the next normal text cut
// Go back to normal state
current_state = RENDER_TEMPLATE_STATE_NORMAL_TEXT;
// ... {\\\\{
// last_section_start: ^
last_section_start = i;
break;
}
// No escape happened, we had a {{. We are in an expression now.
current_state = RENDER_TEMPLATE_STATE_EXPRESSION;
// Cut text
// i points to: v
// ... {{
// cut up to here: ^ (Don't include {{ )
result += p_text.substr_index(last_section_start, i - 2);
// i points to: v
// ... {{
// last_section_start: ^ (Crop {{ so later it doesn't have to be handled. Having more { should result in an error.)
last_section_start = i + 1;
} break;
default: {
// Some other token encountered, just go back to normal
current_state = RENDER_TEMPLATE_STATE_NORMAL_TEXT;
escape_next = false;
} break;
}
}
case RENDER_TEMPLATE_STATE_EXPRESSION: {
switch (current_token) {
case '}': {
// We only need to worry about being in a string here, the syntax does not use }-s for anything else.
if (in_string) {
break;
}
// i points to: v
// ... }}
// Expression has to end at next token.
current_state = RENDER_TEMPLATE_STATE_EXPRESSION_END_NEXT;
} break;
case '\'': {
// Previous token was \.
if (escape_next) {
escape_next = false;
break;
}
if (in_string) {
// Only end string with the correct , so "'", or '"' will work
if (current_string_type == '\'') {
in_string = false;
break;
}
break;
}
// Start string, and remember string type
current_string_type = '\'';
in_string = true;
} break;
case '"': {
// Previous token was \.
if (escape_next) {
escape_next = false;
break;
}
if (in_string) {
// Only end string with the correct , so "'", or '"' will work
if (current_string_type == '"') {
in_string = false;
break;
}
break;
}
// Start string, and remember string type
current_string_type = '"';
in_string = true;
} break;
case '\\': {
// Previous token was a \.
if (escape_next) {
escape_next = false;
break;
}
// If we are in a string escape next character.
// Otherwise it doesn't matters.
if (in_string) {
escape_next = true;
break;
}
} break;
default: {
// Just set back escape_next
// Could have been a \n in vformat for example.
escape_next = false;
} break;
}
} break;
case RENDER_TEMPLATE_STATE_EXPRESSION_END_NEXT: {
switch (current_token) {
case '}': {
// i points to: v
// ... }}
// Expression has ended
// Grab expression
// last_section_start: v
// ... {{ ... }}
// i: ^
// We want everything between {{ }} -s
String expression = p_text.substr_index(last_section_start, i - 2);
result += process_template_expression(expression, p_data);
// i points to: v
// ... {{
// last_section_start: ^
last_section_start = i + 1;
} break;
default: {
// Some other token encountered, error in template
result += p_text.substr_index(last_section_start, i);
// Don't return half-rendered templates.
ERR_FAIL_V_MSG(String(), "Error in template! One missing closing bracket encountered. Generated html so far:\n\n" + result);
} break;
}
} break;
}
}
// Unterminated expression in template
if (current_state != RENDER_TEMPLATE_STATE_NORMAL_TEXT) {
if (in_string) {
String c;
c += current_string_type;
ERR_FAIL_V_MSG(String(), "Error in template! Unterminated string of type " + c + " encountered. Generated html so far:\n\n" + result);
}
if (current_state == RENDER_TEMPLATE_STATE_EXPRESSION || current_state == RENDER_TEMPLATE_STATE_EXPRESSION_END_NEXT) {
ERR_FAIL_V_MSG(String(), "Error in template! Unterminated expression encountered. Generated html so far:\n\n" + result);
}
// if current_state is RENDER_TEMPLATE_STATE_EXPRESSION_POTENTIAL_START, that is actually fine. Template just ends in {
}
// Get the last bit of text
// If the template closes with }}, last_section_start should be == to text_length
// If template closes like }}X last_section_start should be == to text_length - 1, in that case we still need to get the last character
if (last_section_start <= text_length - 1) {
result += p_text.substr_index(last_section_start, text_length);
}
return result;
}
String HTMLTemplate::get_and_render_template(const StringName &p_name, const Ref<WebServerRequest> &p_request, const Dictionary &p_data) {
String text = get_template_text(p_name);
return render_template(text, p_request, p_data);
return render_template(text, p_data);
}
String HTMLTemplate::render(const Ref<WebServerRequest> &p_request, const Dictionary &p_data) {
@ -505,11 +724,9 @@ void HTMLTemplate::_bind_methods() {
// Use
ClassDB::bind_method(D_METHOD("substitute_data_variables", "text", "data"), &HTMLTemplate::substitute_data_variables);
ClassDB::bind_method(D_METHOD("substitute_request_variables", "text", "request"), &HTMLTemplate::substitute_request_variables);
ClassDB::bind_method(D_METHOD("get_template_text", "name"), &HTMLTemplate::get_template_text);
ClassDB::bind_method(D_METHOD("process_template_expression", "expression", "data"), &HTMLTemplate::process_template_expression);
ClassDB::bind_method(D_METHOD("render_template", "text", "request", "data"), &HTMLTemplate::render_template);
ClassDB::bind_method(D_METHOD("get_and_render_template", "name", "request", "data"), &HTMLTemplate::get_and_render_template);

37
modules/web/html/html_template.h
View File

@ -34,10 +34,10 @@
#include "core/object/resource.h"
#include "core/containers/vector.h"
#include "core/containers/hash_map.h"
#include "core/string/ustring.h"
#include "core/containers/vector.h"
#include "core/string/string_name.h"
#include "core/string/ustring.h"
class HTMLTemplateData;
class WebServerRequest;
@ -51,7 +51,7 @@ public:
Ref<HTMLTemplateData> get_template(const int p_index);
void add_template(const Ref<HTMLTemplateData> &p_template);
void remove_template(const int p_index);
void clear_templates();
Vector<Variant> get_templates();
@ -62,7 +62,7 @@ public:
String get_template_override(const StringName &p_name) const;
void set_template_override(const StringName &p_name, const String &p_value);
void remove_template_override(const StringName &p_name);
void clear_template_overrides();
Dictionary get_template_overrides() const;
@ -70,13 +70,13 @@ public:
HashMap<StringName, String> get_template_overrides_map() const;
void set_template_overrides_map(const HashMap<StringName, String> &p_map);
// Defaults
bool has_template_default(const StringName &p_name) const;
String get_template_default(const StringName &p_name) const;
void set_template_default(const StringName &p_name, const String &p_value);
void remove_template_default(const StringName &p_name);
void clear_template_defaults();
Dictionary get_template_defaults() const;
@ -84,16 +84,14 @@ public:
HashMap<StringName, String> get_template_defaults_map() const;
void set_template_defaults_map(const HashMap<StringName, String> &p_map);
// Use
String substitute_data_variables(const String &p_text, const Dictionary &p_data);
String substitute_request_variables(const String &p_text, const Ref<WebServerRequest> &p_request);
String get_template_text(const StringName &p_name);
String render_template(const String &p_text, const Ref<WebServerRequest> &p_request, const Dictionary &p_data);
String process_template_expression(const String &p_expression, const Dictionary &p_data);
String render_template(const String &p_text, const Dictionary &p_data);
String get_and_render_template(const StringName &p_name, const Ref<WebServerRequest> &p_request, const Dictionary &p_data);
String render(const Ref<WebServerRequest> &p_request, const Dictionary &p_data);
@ -103,19 +101,26 @@ public:
~HTMLTemplate();
protected:
enum RenderTemplateState {
RENDER_TEMPLATE_STATE_NORMAL_TEXT = 0,
RENDER_TEMPLATE_STATE_EXPRESSION_POTENTIAL_START,
RENDER_TEMPLATE_STATE_EXPRESSION,
RENDER_TEMPLATE_STATE_EXPRESSION_END_NEXT,
};
void _on_editor_template_button_pressed(const StringName &p_property);
bool _set(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _get_property_list(List<PropertyInfo> *p_list) const;
static void _bind_methods();
Vector<Ref<HTMLTemplateData>> _templates;
HashMap<StringName, String> _template_overrides;
HashMap<StringName, String> _template_defaults;
String _editor_new_template_override_key;
String _editor_new_template_default_key;
};