DataExpression.cpp 27 KB

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