DataExpression.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "DataExpression.h"
  29. #include "../../Include/RmlUi/Core/DataModelHandle.h"
  30. #include "../../Include/RmlUi/Core/Event.h"
  31. #include "../../Include/RmlUi/Core/Variant.h"
  32. #include "DataModel.h"
  33. #include <stack>
  34. #ifdef _MSC_VER
  35. #pragma warning(default : 4061)
  36. #pragma warning(default : 4062)
  37. #endif
  38. namespace Rml {
  39. class DataParser;
  40. /*
  41. The abstract machine for RmlUi data expressions.
  42. The machine can execute a program which contains a list of instructions listed below.
  43. The abstract machine has three registers:
  44. R Typically results and right-hand side arguments.
  45. L Typically left-hand side arguments.
  46. C Typically center arguments (eg. in ternary operator).
  47. And two stacks:
  48. S The main program stack.
  49. A The arguments stack, only used to pass arguments to an external transform function.
  50. In addition, each instruction has an optional payload:
  51. D Instruction data (payload).
  52. Notation used in the instruction list below:
  53. S+ Push to stack S.
  54. S- Pop stack S (returns the popped value).
  55. */
  56. enum class Instruction {
  57. // Assignment (register/stack) = Read (register R/L/C, instruction data D, or stack)
  58. Push = 'P', // S+ = R
  59. Pop = 'o', // <R/L/C> = S- (D determines R/L/C)
  60. Literal = 'D', // R = D
  61. Variable = 'V', // R = DataModel.GetVariable(D) (D is an index into the variable address list)
  62. Add = '+', // R = L + R
  63. Subtract = '-', // R = L - R
  64. Multiply = '*', // R = L * R
  65. Divide = '/', // R = L / R
  66. Not = '!', // R = !R
  67. And = '&', // R = L && R
  68. Or = '|', // R = L || R
  69. Less = '<', // R = L < R
  70. LessEq = 'L', // R = L <= R
  71. Greater = '>', // R = L > R
  72. GreaterEq = 'G', // R = L >= R
  73. Equal = '=', // R = L == R
  74. NotEqual = 'N', // R = L != R
  75. Ternary = '?', // R = L ? C : R
  76. Arguments = 'a', // A+ = S- (Repeated D times, where D gives the num. arguments)
  77. TransformFnc = 'T', // R = DataModel.Execute( D, R, A ); A.Clear(); (D determines function name, R the input value, A the arguments)
  78. EventFnc = 'E', // DataModel.EventCallback(D, A); A.Clear();
  79. Assign = 'A', // DataModel.SetVariable(D, R)
  80. };
  81. enum class Register {
  82. R,
  83. L,
  84. C
  85. };
  86. struct InstructionData {
  87. Instruction instruction;
  88. Variant data;
  89. };
  90. namespace Parse {
  91. static void Assignment(DataParser& parser);
  92. static void Expression(DataParser& parser);
  93. }
  94. class DataParser {
  95. public:
  96. DataParser(String expression, DataExpressionInterface expression_interface) : expression(std::move(expression)), expression_interface(expression_interface) {}
  97. char Look() {
  98. if (reached_end)
  99. return '\0';
  100. return expression[index];
  101. }
  102. bool Match(char c, bool skip_whitespace = true) {
  103. if (c == Look()) {
  104. Next();
  105. if (skip_whitespace)
  106. SkipWhitespace();
  107. return true;
  108. }
  109. Expected(c);
  110. return false;
  111. }
  112. char Next() {
  113. ++index;
  114. if (index >= expression.size())
  115. reached_end = true;
  116. return Look();
  117. }
  118. void SkipWhitespace() {
  119. char c = Look();
  120. while (StringUtilities::IsWhitespace(c))
  121. c = Next();
  122. }
  123. void Error(const String message)
  124. {
  125. parse_error = true;
  126. Log::Message(Log::LT_WARNING, "Error in data expression at %d. %s", index, message.c_str());
  127. Log::Message(Log::LT_WARNING, " \"%s\"", expression.c_str());
  128. const size_t cursor_offset = size_t(index) + 3;
  129. const String cursor_string = String(cursor_offset, ' ') + '^';
  130. Log::Message(Log::LT_WARNING, cursor_string.c_str());
  131. }
  132. void Expected(String expected_symbols) {
  133. const char c = Look();
  134. if (c == '\0')
  135. Error(CreateString(expected_symbols.size() + 50, "Expected %s but found end of string.", expected_symbols.c_str()));
  136. else
  137. Error(CreateString(expected_symbols.size() + 50, "Expected %s but found character '%c'.", expected_symbols.c_str(), c));
  138. }
  139. void Expected(char expected) {
  140. Expected(String(1, '\'') + expected + '\'');
  141. }
  142. bool Parse(bool is_assignment_expression)
  143. {
  144. program.clear();
  145. variable_addresses.clear();
  146. index = 0;
  147. reached_end = false;
  148. parse_error = false;
  149. if (expression.empty())
  150. reached_end = true;
  151. SkipWhitespace();
  152. if (is_assignment_expression)
  153. Parse::Assignment(*this);
  154. else
  155. Parse::Expression(*this);
  156. if (!reached_end) {
  157. parse_error = true;
  158. Error(CreateString(50, "Unexpected character '%c' encountered.", Look()));
  159. }
  160. if (!parse_error && program_stack_size != 0) {
  161. parse_error = true;
  162. Error(CreateString(120, "Internal parser error, inconsistent stack operations. Stack size is %d at parse end.", program_stack_size));
  163. }
  164. return !parse_error;
  165. }
  166. Program ReleaseProgram() {
  167. RMLUI_ASSERT(!parse_error);
  168. return std::move(program);
  169. }
  170. AddressList ReleaseAddresses() {
  171. RMLUI_ASSERT(!parse_error);
  172. return std::move(variable_addresses);
  173. }
  174. void Emit(Instruction instruction, Variant data = Variant())
  175. {
  176. RMLUI_ASSERTMSG(instruction != Instruction::Push && instruction != Instruction::Pop &&
  177. instruction != Instruction::Arguments && instruction != Instruction::Variable && instruction != Instruction::Assign,
  178. "Use the Push(), Pop(), Arguments(), Variable(), and Assign() procedures for stack manipulation and variable instructions.");
  179. program.push_back(InstructionData{ instruction, std::move(data) });
  180. }
  181. void Push() {
  182. program_stack_size += 1;
  183. program.push_back(InstructionData{ Instruction::Push, Variant() });
  184. }
  185. void Pop(Register destination) {
  186. if (program_stack_size <= 0) {
  187. Error("Internal parser error: Tried to pop an empty stack.");
  188. return;
  189. }
  190. program_stack_size -= 1;
  191. program.push_back(InstructionData{ Instruction::Pop, Variant(int(destination)) });
  192. }
  193. void Arguments(int num_arguments) {
  194. if (program_stack_size < num_arguments) {
  195. Error(CreateString(128, "Internal parser error: Popping %d arguments, but the stack contains only %d elements.", num_arguments, program_stack_size));
  196. return;
  197. }
  198. program_stack_size -= num_arguments;
  199. program.push_back(InstructionData{ Instruction::Arguments, Variant(int(num_arguments)) });
  200. }
  201. void Variable(const String& name) {
  202. VariableGetSet(name, false);
  203. }
  204. void Assign(const String& name) {
  205. VariableGetSet(name, true);
  206. }
  207. private:
  208. void VariableGetSet(const String& name, bool is_assignment)
  209. {
  210. DataAddress address = expression_interface.ParseAddress(name);
  211. if (address.empty()) {
  212. Error(CreateString(name.size() + 50, "Could not find data variable with name '%s'.", name.c_str()));
  213. return;
  214. }
  215. int index = int(variable_addresses.size());
  216. variable_addresses.push_back(std::move(address));
  217. program.push_back(InstructionData{ is_assignment ? Instruction::Assign : Instruction::Variable, Variant(int(index)) });
  218. }
  219. const String expression;
  220. DataExpressionInterface expression_interface;
  221. size_t index = 0;
  222. bool reached_end = false;
  223. bool parse_error = true;
  224. int program_stack_size = 0;
  225. Program program;
  226. AddressList variable_addresses;
  227. };
  228. namespace Parse {
  229. // Forward declare all parse functions.
  230. static void Assignment(DataParser& parser);
  231. // The following in order of precedence.
  232. static void Expression(DataParser& parser);
  233. static void Relational(DataParser& parser);
  234. static void Additive(DataParser& parser);
  235. static void Term(DataParser& parser);
  236. static void Factor(DataParser& parser);
  237. static void NumberLiteral(DataParser& parser);
  238. static void StringLiteral(DataParser& parser);
  239. static void Variable(DataParser& parser);
  240. static void Add(DataParser& parser);
  241. static void Subtract(DataParser& parser);
  242. static void Multiply(DataParser& parser);
  243. static void Divide(DataParser& parser);
  244. static void Not(DataParser& parser);
  245. static void And(DataParser& parser);
  246. static void Or(DataParser& parser);
  247. static void Less(DataParser& parser);
  248. static void Greater(DataParser& parser);
  249. static void Equal(DataParser& parser);
  250. static void NotEqual(DataParser& parser);
  251. static void Ternary(DataParser& parser);
  252. static void Function(DataParser& parser, Instruction function_type, const String& name);
  253. // Helper functions
  254. static bool IsVariableCharacter(char c, bool is_first_character)
  255. {
  256. const bool is_alpha = (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
  257. if (is_first_character)
  258. return is_alpha;
  259. if (is_alpha || (c >= '0' && c <= '9'))
  260. return true;
  261. for (char valid_char : "_.[] ")
  262. {
  263. if (c == valid_char && valid_char != '\0')
  264. return true;
  265. }
  266. return false;
  267. }
  268. static String VariableName(DataParser& parser)
  269. {
  270. String name;
  271. bool is_first_character = true;
  272. char c = parser.Look();
  273. while (IsVariableCharacter(c, is_first_character))
  274. {
  275. name += c;
  276. c = parser.Next();
  277. is_first_character = false;
  278. }
  279. // Right trim spaces in name
  280. size_t new_size = String::npos;
  281. for (int i = int(name.size()) - 1; i >= 1; i--)
  282. {
  283. if (name[i] == ' ')
  284. new_size = size_t(i);
  285. else
  286. break;
  287. }
  288. if (new_size != String::npos)
  289. name.resize(new_size);
  290. return name;
  291. }
  292. // Parser functions
  293. static void Assignment(DataParser& parser)
  294. {
  295. bool looping = true;
  296. while (looping)
  297. {
  298. if (parser.Look() != '\0')
  299. {
  300. const String variable_name = VariableName(parser);
  301. if (variable_name.empty()) {
  302. parser.Error("Expected a variable for assignment but got an empty name.");
  303. return;
  304. }
  305. const char c = parser.Look();
  306. if (c == '=')
  307. {
  308. parser.Match('=');
  309. Expression(parser);
  310. parser.Assign(variable_name);
  311. }
  312. else if (c == '(' || c == ';' || c == '\0')
  313. {
  314. Function(parser, Instruction::EventFnc, variable_name);
  315. }
  316. else
  317. {
  318. parser.Expected("one of = ; ( or end of string");
  319. return;
  320. }
  321. }
  322. const char c = parser.Look();
  323. if (c == ';')
  324. parser.Match(';');
  325. else if (c == '\0')
  326. looping = false;
  327. else
  328. {
  329. parser.Expected("';' or end of string");
  330. looping = false;
  331. }
  332. }
  333. }
  334. static void Expression(DataParser& parser)
  335. {
  336. Relational(parser);
  337. bool looping = true;
  338. while (looping)
  339. {
  340. switch (parser.Look())
  341. {
  342. case '&': And(parser); break;
  343. case '|':
  344. {
  345. parser.Match('|', false);
  346. if (parser.Look() == '|')
  347. Or(parser);
  348. else
  349. {
  350. parser.SkipWhitespace();
  351. const String fnc_name = VariableName(parser);
  352. if (fnc_name.empty()) {
  353. parser.Error("Expected a transform function name but got an empty name.");
  354. return;
  355. }
  356. Function(parser, Instruction::TransformFnc, fnc_name);
  357. }
  358. }
  359. break;
  360. case '?': Ternary(parser); break;
  361. default:
  362. looping = false;
  363. }
  364. }
  365. }
  366. static void Relational(DataParser& parser)
  367. {
  368. Additive(parser);
  369. bool looping = true;
  370. while (looping)
  371. {
  372. switch (parser.Look())
  373. {
  374. case '=': Equal(parser); break;
  375. case '!': NotEqual(parser); break;
  376. case '<': Less(parser); break;
  377. case '>': Greater(parser); break;
  378. default:
  379. looping = false;
  380. }
  381. }
  382. }
  383. static void Additive(DataParser& parser)
  384. {
  385. Term(parser);
  386. bool looping = true;
  387. while (looping)
  388. {
  389. switch (parser.Look())
  390. {
  391. case '+': Add(parser); break;
  392. case '-': Subtract(parser); break;
  393. default:
  394. looping = false;
  395. }
  396. }
  397. }
  398. static void Term(DataParser& parser)
  399. {
  400. Factor(parser);
  401. bool looping = true;
  402. while (looping)
  403. {
  404. switch (parser.Look())
  405. {
  406. case '*': Multiply(parser); break;
  407. case '/': Divide(parser); break;
  408. default:
  409. looping = false;
  410. }
  411. }
  412. }
  413. static void Factor(DataParser& parser)
  414. {
  415. const char c = parser.Look();
  416. if (c == '(')
  417. {
  418. parser.Match('(');
  419. Expression(parser);
  420. parser.Match(')');
  421. }
  422. else if (c == '\'')
  423. {
  424. parser.Match('\'', false);
  425. StringLiteral(parser);
  426. parser.Match('\'');
  427. }
  428. else if (c == '!')
  429. {
  430. Not(parser);
  431. parser.SkipWhitespace();
  432. }
  433. else if (c == '-' || (c >= '0' && c <= '9'))
  434. {
  435. NumberLiteral(parser);
  436. parser.SkipWhitespace();
  437. }
  438. else if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'))
  439. {
  440. Variable(parser);
  441. parser.SkipWhitespace();
  442. }
  443. else
  444. parser.Expected("literal, variable name, parenthesis, or '!'");
  445. }
  446. static void NumberLiteral(DataParser& parser)
  447. {
  448. String str;
  449. bool first_match = false;
  450. bool has_dot = false;
  451. char c = parser.Look();
  452. if (c == '-')
  453. {
  454. str += c;
  455. c = parser.Next();
  456. }
  457. while ((c >= '0' && c <= '9') || (c == '.' && !has_dot))
  458. {
  459. first_match = true;
  460. str += c;
  461. if (c == '.')
  462. has_dot = true;
  463. c = parser.Next();
  464. }
  465. if (!first_match)
  466. {
  467. parser.Error(CreateString(100, "Invalid number literal. Expected '0-9' or '.' but found '%c'.", c));
  468. return;
  469. }
  470. const double number = FromString(str, 0.0);
  471. parser.Emit(Instruction::Literal, Variant(number));
  472. }
  473. static void StringLiteral(DataParser& parser)
  474. {
  475. String str;
  476. char c = parser.Look();
  477. char c_prev = '\0';
  478. while (c != '\0' && (c != '\'' || c_prev == '\\'))
  479. {
  480. if (c_prev == '\\' && (c == '\\' || c == '\'')) {
  481. str.pop_back();
  482. c_prev = '\0';
  483. }
  484. else {
  485. c_prev = c;
  486. }
  487. str += c;
  488. c = parser.Next();
  489. }
  490. parser.Emit(Instruction::Literal, Variant(str));
  491. }
  492. static void Variable(DataParser& parser)
  493. {
  494. String name = VariableName(parser);
  495. if (name.empty()) {
  496. parser.Error("Expected a variable but got an empty name.");
  497. return;
  498. }
  499. // Keywords are parsed like variables, but are really literals.
  500. // Check for them here.
  501. if (name == "true")
  502. parser.Emit(Instruction::Literal, Variant(true));
  503. else if (name == "false")
  504. parser.Emit(Instruction::Literal, Variant(false));
  505. else
  506. parser.Variable(name);
  507. }
  508. static void Add(DataParser& parser)
  509. {
  510. parser.Match('+');
  511. parser.Push();
  512. Term(parser);
  513. parser.Pop(Register::L);
  514. parser.Emit(Instruction::Add);
  515. }
  516. static void Subtract(DataParser& parser)
  517. {
  518. parser.Match('-');
  519. parser.Push();
  520. Term(parser);
  521. parser.Pop(Register::L);
  522. parser.Emit(Instruction::Subtract);
  523. }
  524. static void Multiply(DataParser& parser)
  525. {
  526. parser.Match('*');
  527. parser.Push();
  528. Factor(parser);
  529. parser.Pop(Register::L);
  530. parser.Emit(Instruction::Multiply);
  531. }
  532. static void Divide(DataParser& parser)
  533. {
  534. parser.Match('/');
  535. parser.Push();
  536. Factor(parser);
  537. parser.Pop(Register::L);
  538. parser.Emit(Instruction::Divide);
  539. }
  540. static void Not(DataParser& parser)
  541. {
  542. parser.Match('!');
  543. Factor(parser);
  544. parser.Emit(Instruction::Not);
  545. }
  546. static void Or(DataParser& parser)
  547. {
  548. // We already skipped the first '|' during expression
  549. parser.Match('|');
  550. parser.Push();
  551. Relational(parser);
  552. parser.Pop(Register::L);
  553. parser.Emit(Instruction::Or);
  554. }
  555. static void And(DataParser& parser)
  556. {
  557. parser.Match('&', false);
  558. parser.Match('&');
  559. parser.Push();
  560. Relational(parser);
  561. parser.Pop(Register::L);
  562. parser.Emit(Instruction::And);
  563. }
  564. static void Less(DataParser& parser)
  565. {
  566. Instruction instruction = Instruction::Less;
  567. parser.Match('<', false);
  568. if (parser.Look() == '=') {
  569. parser.Match('=');
  570. instruction = Instruction::LessEq;
  571. }
  572. else {
  573. parser.SkipWhitespace();
  574. }
  575. parser.Push();
  576. Additive(parser);
  577. parser.Pop(Register::L);
  578. parser.Emit(instruction);
  579. }
  580. static void Greater(DataParser& parser)
  581. {
  582. Instruction instruction = Instruction::Greater;
  583. parser.Match('>', false);
  584. if (parser.Look() == '=') {
  585. parser.Match('=');
  586. instruction = Instruction::GreaterEq;
  587. }
  588. else {
  589. parser.SkipWhitespace();
  590. }
  591. parser.Push();
  592. Additive(parser);
  593. parser.Pop(Register::L);
  594. parser.Emit(instruction);
  595. }
  596. static void Equal(DataParser& parser)
  597. {
  598. parser.Match('=', false);
  599. parser.Match('=');
  600. parser.Push();
  601. Additive(parser);
  602. parser.Pop(Register::L);
  603. parser.Emit(Instruction::Equal);
  604. }
  605. static void NotEqual(DataParser& parser)
  606. {
  607. parser.Match('!', false);
  608. parser.Match('=');
  609. parser.Push();
  610. Additive(parser);
  611. parser.Pop(Register::L);
  612. parser.Emit(Instruction::NotEqual);
  613. }
  614. static void Ternary(DataParser& parser)
  615. {
  616. parser.Match('?');
  617. parser.Push();
  618. Expression(parser);
  619. parser.Push();
  620. parser.Match(':');
  621. Expression(parser);
  622. parser.Pop(Register::C);
  623. parser.Pop(Register::L);
  624. parser.Emit(Instruction::Ternary);
  625. }
  626. static void Function(DataParser& parser, Instruction function_type, const String& func_name)
  627. {
  628. RMLUI_ASSERT(function_type == Instruction::TransformFnc || function_type == Instruction::EventFnc);
  629. // We already matched the variable name (and '|' for transform functions)
  630. if (parser.Look() == '(')
  631. {
  632. int num_arguments = 0;
  633. bool looping = true;
  634. parser.Match('(');
  635. if (parser.Look() == ')') {
  636. parser.Match(')');
  637. looping = false;
  638. }
  639. else
  640. parser.Push();
  641. while (looping)
  642. {
  643. num_arguments += 1;
  644. Expression(parser);
  645. parser.Push();
  646. switch (parser.Look()) {
  647. case ')': parser.Match(')'); looping = false; break;
  648. case ',': parser.Match(','); break;
  649. default:
  650. parser.Expected("one of ')' or ','");
  651. looping = false;
  652. }
  653. }
  654. if (num_arguments > 0) {
  655. parser.Arguments(num_arguments);
  656. parser.Pop(Register::R);
  657. }
  658. }
  659. else {
  660. parser.SkipWhitespace();
  661. }
  662. parser.Emit(function_type, Variant(func_name));
  663. }
  664. } // </namespace Parse>
  665. class DataInterpreter {
  666. public:
  667. DataInterpreter(const Program& program, const AddressList& addresses, DataExpressionInterface expression_interface)
  668. : program(program), addresses(addresses), expression_interface(expression_interface) {}
  669. bool Error(String message) const
  670. {
  671. message = "Error during execution. " + message;
  672. Log::Message(Log::LT_WARNING, message.c_str());
  673. RMLUI_ERROR;
  674. return false;
  675. }
  676. bool Run()
  677. {
  678. bool success = true;
  679. for (size_t i = 0; i < program.size(); i++)
  680. {
  681. if (!Execute(program[i].instruction, program[i].data))
  682. {
  683. success = false;
  684. break;
  685. }
  686. }
  687. if(success && !stack.empty())
  688. Log::Message(Log::LT_WARNING, "Possible data interpreter stack corruption. Stack size is %d at end of execution (should be zero).", stack.size());
  689. if(!success)
  690. {
  691. String program_str = DumpProgram();
  692. Log::Message(Log::LT_WARNING, "Failed to execute program with %d instructions:", program.size());
  693. Log::Message(Log::LT_WARNING, program_str.c_str());
  694. }
  695. return success;
  696. }
  697. String DumpProgram() const
  698. {
  699. String str;
  700. for (size_t i = 0; i < program.size(); i++)
  701. {
  702. String instruction_str = program[i].data.Get<String>();
  703. str += CreateString(50 + instruction_str.size(), " %4zu '%c' %s\n", i, char(program[i].instruction), instruction_str.c_str());
  704. }
  705. return str;
  706. }
  707. Variant Result() const {
  708. return R;
  709. }
  710. private:
  711. Variant R, L, C;
  712. Stack<Variant> stack;
  713. Vector<Variant> arguments;
  714. const Program& program;
  715. const AddressList& addresses;
  716. DataExpressionInterface expression_interface;
  717. bool Execute(const Instruction instruction, const Variant& data)
  718. {
  719. auto AnyString = [](const Variant& v1, const Variant& v2) {
  720. return v1.GetType() == Variant::STRING || v2.GetType() == Variant::STRING;
  721. };
  722. switch (instruction)
  723. {
  724. case Instruction::Push:
  725. {
  726. stack.push(std::move(R));
  727. R.Clear();
  728. }
  729. break;
  730. case Instruction::Pop:
  731. {
  732. if (stack.empty())
  733. return Error("Cannot pop stack, it is empty.");
  734. Register reg = Register(data.Get<int>(-1));
  735. switch (reg) {
  736. case Register::R: R = stack.top(); stack.pop(); break;
  737. case Register::L: L = stack.top(); stack.pop(); break;
  738. case Register::C: C = stack.top(); stack.pop(); break;
  739. default:
  740. return Error(CreateString(50, "Invalid register %d.", int(reg)));
  741. }
  742. }
  743. break;
  744. case Instruction::Literal:
  745. {
  746. R = data;
  747. }
  748. break;
  749. case Instruction::Variable:
  750. {
  751. size_t variable_index = size_t(data.Get<int>(-1));
  752. if (variable_index < addresses.size())
  753. R = expression_interface.GetValue(addresses[variable_index]);
  754. else
  755. return Error("Variable address not found.");
  756. }
  757. break;
  758. case Instruction::Add:
  759. {
  760. if (AnyString(L, R))
  761. R = Variant(L.Get<String>() + R.Get<String>());
  762. else
  763. R = Variant(L.Get<double>() + R.Get<double>());
  764. }
  765. break;
  766. case Instruction::Subtract: R = Variant(L.Get<double>() - R.Get<double>()); break;
  767. case Instruction::Multiply: R = Variant(L.Get<double>() * R.Get<double>()); break;
  768. case Instruction::Divide: R = Variant(L.Get<double>() / R.Get<double>()); break;
  769. case Instruction::Not: R = Variant(!R.Get<bool>()); break;
  770. case Instruction::And: R = Variant(L.Get<bool>() && R.Get<bool>()); break;
  771. case Instruction::Or: R = Variant(L.Get<bool>() || R.Get<bool>()); break;
  772. case Instruction::Less: R = Variant(L.Get<double>() < R.Get<double>()); break;
  773. case Instruction::LessEq: R = Variant(L.Get<double>() <= R.Get<double>()); break;
  774. case Instruction::Greater: R = Variant(L.Get<double>() > R.Get<double>()); break;
  775. case Instruction::GreaterEq: R = Variant(L.Get<double>() >= R.Get<double>()); break;
  776. case Instruction::Equal:
  777. {
  778. if (AnyString(L, R))
  779. R = Variant(L.Get<String>() == R.Get<String>());
  780. else
  781. R = Variant(L.Get<double>() == R.Get<double>());
  782. }
  783. break;
  784. case Instruction::NotEqual:
  785. {
  786. if (AnyString(L, R))
  787. R = Variant(L.Get<String>() != R.Get<String>());
  788. else
  789. R = Variant(L.Get<double>() != R.Get<double>());
  790. }
  791. break;
  792. case Instruction::Ternary:
  793. {
  794. if (L.Get<bool>())
  795. R = C;
  796. }
  797. break;
  798. case Instruction::Arguments:
  799. {
  800. if (!arguments.empty())
  801. return Error("Argument stack is not empty.");
  802. int num_arguments = data.Get<int>(-1);
  803. if (num_arguments < 0)
  804. return Error("Invalid number of arguments.");
  805. if (stack.size() < size_t(num_arguments))
  806. return Error(CreateString(100, "Cannot pop %d arguments, stack contains only %zu elements.", num_arguments, stack.size()));
  807. arguments.resize(num_arguments);
  808. for (int i = num_arguments - 1; i >= 0; i--)
  809. {
  810. arguments[i] = std::move(stack.top());
  811. stack.pop();
  812. }
  813. }
  814. break;
  815. case Instruction::TransformFnc:
  816. {
  817. const String function_name = data.Get<String>();
  818. if (!expression_interface.CallTransform(function_name, R, arguments))
  819. {
  820. String arguments_str;
  821. for (size_t i = 0; i < arguments.size(); i++)
  822. {
  823. arguments_str += arguments[i].Get<String>();
  824. if (i < arguments.size() - 1)
  825. arguments_str += ", ";
  826. }
  827. Error(CreateString(50 + function_name.size() + arguments_str.size(), "Failed to execute data function: %s(%s)", function_name.c_str(), arguments_str.c_str()));
  828. }
  829. arguments.clear();
  830. }
  831. break;
  832. case Instruction::EventFnc:
  833. {
  834. const String function_name = data.Get<String>();
  835. if (!expression_interface.EventCallback(function_name, arguments))
  836. {
  837. String arguments_str;
  838. for (size_t i = 0; i < arguments.size(); i++)
  839. {
  840. arguments_str += arguments[i].Get<String>();
  841. if (i < arguments.size() - 1)
  842. arguments_str += ", ";
  843. }
  844. Error(CreateString(50 + function_name.size() + arguments_str.size(), "Failed to execute event callback: %s(%s)", function_name.c_str(), arguments_str.c_str()));
  845. }
  846. arguments.clear();
  847. }
  848. break;
  849. case Instruction::Assign:
  850. {
  851. size_t variable_index = size_t(data.Get<int>(-1));
  852. if (variable_index < addresses.size())
  853. {
  854. if (!expression_interface.SetValue(addresses[variable_index], R))
  855. return Error("Could not assign to variable.");
  856. }
  857. else
  858. return Error("Variable address not found.");
  859. }
  860. break;
  861. default:
  862. RMLUI_ERRORMSG("Instruction not implemented."); break;
  863. }
  864. return true;
  865. }
  866. };
  867. DataExpression::DataExpression(String expression) : expression(expression)
  868. {}
  869. DataExpression::~DataExpression()
  870. {}
  871. bool DataExpression::Parse(const DataExpressionInterface& expression_interface, bool is_assignment_expression)
  872. {
  873. DataParser parser(expression, expression_interface);
  874. if (!parser.Parse(is_assignment_expression))
  875. return false;
  876. program = parser.ReleaseProgram();
  877. addresses = parser.ReleaseAddresses();
  878. return true;
  879. }
  880. bool DataExpression::Run(const DataExpressionInterface& expression_interface, Variant& out_value)
  881. {
  882. DataInterpreter interpreter(program, addresses, expression_interface);
  883. if (!interpreter.Run())
  884. return false;
  885. out_value = interpreter.Result();
  886. return true;
  887. }
  888. StringList DataExpression::GetVariableNameList() const
  889. {
  890. StringList list;
  891. list.reserve(addresses.size());
  892. for (const DataAddress& address : addresses)
  893. {
  894. if (!address.empty())
  895. list.push_back(address[0].name);
  896. }
  897. return list;
  898. }
  899. DataExpressionInterface::DataExpressionInterface(DataModel* data_model, Element* element, Event* event) : data_model(data_model), element(element), event(event)
  900. {}
  901. DataAddress DataExpressionInterface::ParseAddress(const String& address_str) const
  902. {
  903. if (address_str.size() >= 4 && address_str[0] == 'e' && address_str[1] == 'v' && address_str[2] == '.')
  904. return DataAddress{ DataAddressEntry("ev"), DataAddressEntry(address_str.substr(3)) };
  905. return data_model ? data_model->ResolveAddress(address_str, element) : DataAddress();
  906. }
  907. Variant DataExpressionInterface::GetValue(const DataAddress& address) const
  908. {
  909. Variant result;
  910. if(event && address.size() == 2 && address.front().name == "ev")
  911. {
  912. auto& parameters = event->GetParameters();
  913. auto it = parameters.find(address.back().name);
  914. if (it != parameters.end())
  915. result = it->second;
  916. }
  917. else if (data_model)
  918. {
  919. data_model->GetVariableInto(address, result);
  920. }
  921. return result;
  922. }
  923. bool DataExpressionInterface::SetValue(const DataAddress& address, const Variant& value) const
  924. {
  925. bool result = false;
  926. if (data_model && !address.empty())
  927. {
  928. if (DataVariable variable = data_model->GetVariable(address))
  929. result = variable.Set(value);
  930. if (result)
  931. data_model->DirtyVariable(address.front().name);
  932. }
  933. return result;
  934. }
  935. bool DataExpressionInterface::CallTransform(const String& name, Variant& inout_variant, const VariantList& arguments)
  936. {
  937. return data_model ? data_model->CallTransform(name, inout_variant, arguments) : false;
  938. }
  939. bool DataExpressionInterface::EventCallback(const String& name, const VariantList& arguments)
  940. {
  941. if (!data_model || !event)
  942. return false;
  943. const DataEventFunc* func = data_model->GetEventCallback(name);
  944. if (!func || !*func)
  945. return false;
  946. DataModelHandle handle(data_model);
  947. func->operator()(handle, *event, arguments);
  948. return true;
  949. }
  950. } // namespace Rml