Expression parser improvements #7663

jordan-woyak · 2018-12-30T19:38:42Z

Demonstrations (note: syntax has changed. function names used to be prefixed with !)
https://i.imgur.com/9wCT3sH.gif
https://i.imgur.com/codD9p2.gif
https://i.imgur.com/PbeGoKl.gif

Added syntax highlighting and parse result display:
https://giant.gfycat.com/GlaringOddballGenet.webm
https://giant.gfycat.com/BasicScaredBarracuda.webm

When a function is inserted with the improper number of arguments the expected arguments are shown in the parse-result textbox.

Literals are now supported, e.g. `Trigger R`+0.25
This is useful for:

Holding Wiimote "Tilt" or IR "Forward/Backward" to a certain neutral value.
Modifying dirty input values on troublesome gamepads.
Math in advanced configurations

Additional binary and unary operators have been added for advanced configurations:

, * - / % < > sin if etc.

Added a toggle function whose state toggles on/off when its inner expression is activated.
This allows for any mapped input in Dolphin to be toggled on and off rather than held without needing separate "toggle" settings.

This was wanted for Wiimote IR Hide, Speed-limiter, etc.

Added special function named timer which increases from 0.0 to 1.0 every N seconds.

e.g. timer(1/2) for a 2Hz timer.
This can be used for creating auto-fire buttons.

Added named variables and assignment operator, e.g. $my_var=`Button 1`

Each ControllerEmu has its own set of variables.
Variables default to 0.0
Useful to transfer state between different mappings.

Outputs and Inputs can now be used in the same expression.

E.g. `Motor R`=`Button 1` will set rumble motor on when pressing a button.

Added comma operator which behaves like it does in c++ to string together expressions.

Lhs is evaluated and discarded. Expression takes value of Rhs.

C++-style operator precedence is now followed.

Yes, this may break some existing expressions, but I think it's worth it.

FYI, multi-line expressions fail to save because of our ini-file code.

This will fix (or at least alleviate) these issues:
https://bugs.dolphin-emu.org/issues/5531
https://bugs.dolphin-emu.org/issues/6513
https://bugs.dolphin-emu.org/issues/6827
https://bugs.dolphin-emu.org/issues/7636
https://bugs.dolphin-emu.org/issues/11187

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp

Source/Core/InputCommon/ControlReference/FunctionExpression.cpp

BhaaLseN · 2019-01-27T16:50:17Z

Source/Core/DolphinQt/Config/Mapping/IOWindow.cpp

+
+  connect(m_expression_text, &QPlainTextEdit::textChanged, [this] {
+    m_apply_button->setText(m_apply_button->text().remove(QStringLiteral("*")));
+    m_apply_button->setText(m_apply_button->text() + QStringLiteral("*"));


This looks...weird. Why does it have to be done this way (not to mention: why at all?)
Is this trying to add an asterisk as "hey, something changed!" indicator at the end of the apply text?

Yes. That is what it's doing. :)

Kinda gets the job done, but feels a little roundabout...but I cannot really think of a better way to do this though other than moving it to a method (or providing a shown/hidden text instead of changing the button text)

Source/Core/DolphinQt/Config/Mapping/IOWindow.cpp

iwubcode · 2019-04-04T01:55:46Z

The !hold(...) syntax will be fantastic for games like Boom Blox when paired with configurable shakes/swings. This is great work @jordan-woyak !

iwubcode · 2019-04-04T01:59:36Z

Source/Core/DolphinQt/Config/Mapping/IOWindow.cpp

+  }
+
+  m_functions_combo = new QComboBox();
+  m_functions_combo->addItem(tr("Functions"));


Not needed in this PR but even with documentation available it might be helpful to have some sort of description box. Many of these are self explanatory but a couple aren't as obvious.

We could have a wiki page with documentation on the functions.

…er file.

…clears state.

…ld for N seconds.

… to 2) taps within Y seconds.

…onds for each press.

…g comments.

…unctions so people are semi-aware of them. Fixed the "Apply" button. Display an error message on expression parse error.

…oth.

…sed serialization functions.

… Hotplug would make that problematic.

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp

Source/Core/InputCommon/ControlReference/ExpressionParser.h

BhaaLseN

Code seems good, untested.

JMC47 · 2019-10-17T21:34:55Z

I've tested this a bit and it seems to work. I'm nervous about how it'll end up with people who do more complex things than I do, but it's the middle of the month and if there are any major issues, they should be sorted out before the monthly build.

mbc07 · 2019-10-17T21:58:34Z

It would be wise having a wiki page or something detailing everything the Expression Parser supports now before the next Progress Report. Also, does it break anything configured on the "older" syntax?

JMC47 · 2019-10-17T22:04:25Z

Trial by fire I guess? We do need a wiki page (and maybe a help page somewhere in the controller configuration that links to that wiki page?)

Dolphin's controller configuration is awesome, but it's really complicated to use some of these features. It took me a long time.

jordan-woyak · 2019-10-18T00:51:31Z

@mbc07 The only thing that should be broken is that a typical order of operations is now obeyed.
Previously everything was left to right. This shouldn't break much.

jordan-woyak force-pushed the expression-parser-improve branch from 0aed2d4 to 0a3f023 Compare December 30, 2018 20:00

lioncash reviewed Dec 30, 2018

View reviewed changes

jordan-woyak force-pushed the expression-parser-improve branch from 7063eae to e0ac877 Compare December 30, 2018 22:47

lioncash reviewed Dec 31, 2018

View reviewed changes

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Outdated Show resolved Hide resolved

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Outdated Show resolved Hide resolved

BhaaLseN reviewed Dec 31, 2018

View reviewed changes

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Outdated Show resolved Hide resolved

BhaaLseN reviewed Dec 31, 2018

View reviewed changes

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Outdated Show resolved Hide resolved

jordan-woyak force-pushed the expression-parser-improve branch 4 times, most recently from d58fb6d to 3e11b4c Compare January 6, 2019 15:09

BhaaLseN reviewed Jan 6, 2019

View reviewed changes

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Outdated Show resolved Hide resolved

jordan-woyak force-pushed the expression-parser-improve branch 2 times, most recently from 6a06f9b to b51642b Compare January 6, 2019 17:18

jordan-woyak force-pushed the expression-parser-improve branch 2 times, most recently from 08f4e43 to 35d02f8 Compare January 26, 2019 18:44

BhaaLseN reviewed Jan 27, 2019

View reviewed changes

Source/Core/InputCommon/ControlReference/FunctionExpression.cpp Show resolved Hide resolved

Source/Core/InputCommon/ControlReference/FunctionExpression.cpp Outdated Show resolved Hide resolved

Source/Core/InputCommon/ControlReference/FunctionExpression.cpp Outdated Show resolved Hide resolved

jordan-woyak force-pushed the expression-parser-improve branch from 848ed64 to dbfeada Compare January 27, 2019 15:14

BhaaLseN reviewed Jan 27, 2019

View reviewed changes

jordan-woyak force-pushed the expression-parser-improve branch from 15d1ff9 to f9a4ddd Compare January 27, 2019 17:12

jordan-woyak mentioned this pull request Feb 17, 2019

WiimoteEmu: Reimplement tilt/swing/camera/orientation data using matrix math. #7806

Merged

jordan-woyak force-pushed the expression-parser-improve branch 5 times, most recently from d6d6e83 to 87f8166 Compare March 2, 2019 21:44

jordan-woyak force-pushed the expression-parser-improve branch 2 times, most recently from 0e89e2b to 4dc4bab Compare April 4, 2019 00:50

iwubcode reviewed Apr 4, 2019

View reviewed changes

jordan-woyak changed the title ~~Expression parser improvements~~ WIP - Expression parser improvements Apr 6, 2019

jordan-woyak added 17 commits October 11, 2019 18:12

ExpressionParser: Move FunctionExpression type definitions into anoth…

fd07ae8

…er file.

ExpressionParser: Add optional 2nd argument to toggle function which …

6a2096c

…clears state.

ExpressionParser: Add deadzone function.

bbd6b18

ExpressionParser: Add function to smooth inputs.

9e53638

ExpressionParser: Add !hold function that activates after input is he…

f2e499d

…ld for N seconds.

ExpressionParser: Add !tap function which activates after X (defaults…

18b5120

… to 2) taps within Y seconds.

ExpressionParser: Fix timer function with negative values.

08b291b

ExpressionParser: Add relative input function.

b5b43f8

ExpressionParser: Add !pulse function that evaluates to 1.0 for N sec…

fae8b15

…onds for each press.

ExpressionParser: Clean up some redundant using-declarations and wron…

5cb1248

…g comments.

DolphinQT/IOWindow: Add combo boxes to insert the new operators and f…

e3cf2ae

…unctions so people are semi-aware of them. Fixed the "Apply" button. Display an error message on expression parse error.

DolphinQT: Add syntax highlighting from tokenizer data.

c8b2188

ExpressionParser/DolphinQt: Added parse results to UI.

ca7ce67

ExpressionParser: Remove !while and add optional 2nd argument to !smo…

7912dc5

…oth.

ExpressionParser: Remove ! character from function syntax. Remove unu…

b57178d

…sed serialization functions.

ExpressionParser: Show error message with expected arguments.

4d41bd6

ControllerEmu: Don't clear expression variables on references update.…

b4e2b3c

… Hotplug would make that problematic.

jordan-woyak force-pushed the expression-parser-improve branch from d586213 to b4e2b3c Compare October 12, 2019 00:48

ExpressionParser: Add support for /* */ style comments.

72302d9

jordan-woyak changed the title ~~WIP - Expression parser improvements~~ Expression parser improvements Oct 12, 2019

BhaaLseN reviewed Oct 12, 2019

View reviewed changes

Source/Core/InputCommon/ControlReference/ExpressionParser.cpp Show resolved Hide resolved

Source/Core/InputCommon/ControlReference/ExpressionParser.h Outdated Show resolved Hide resolved

ExpressionParser: Make Lexer ctor explicit and move argument.

7295458

BhaaLseN approved these changes Oct 12, 2019

View reviewed changes

JMC47 merged commit 8bc0a92 into dolphin-emu:master Oct 17, 2019

jordan-woyak deleted the expression-parser-improve branch October 18, 2019 00:51

jordan-woyak mentioned this pull request Oct 19, 2019

InputCommon: Allow controller settings specified with input expresions. #8417

Merged

Expression parser improvements #7663

Expression parser improvements #7663

jordan-woyak commented Dec 30, 2018 •

edited

BhaaLseN Jan 27, 2019

jordan-woyak Jan 27, 2019

BhaaLseN Jan 27, 2019

iwubcode commented Apr 4, 2019

iwubcode Apr 4, 2019 •

edited

jordan-woyak Oct 12, 2019

BhaaLseN left a comment

JMC47 commented Oct 17, 2019

mbc07 commented Oct 17, 2019

JMC47 commented Oct 17, 2019

jordan-woyak commented Oct 18, 2019

Expression parser improvements #7663

Expression parser improvements #7663

Conversation

jordan-woyak commented Dec 30, 2018 • edited

BhaaLseN Jan 27, 2019

Choose a reason for hiding this comment

jordan-woyak Jan 27, 2019

Choose a reason for hiding this comment

BhaaLseN Jan 27, 2019

Choose a reason for hiding this comment

iwubcode commented Apr 4, 2019

iwubcode Apr 4, 2019 • edited

Choose a reason for hiding this comment

jordan-woyak Oct 12, 2019

Choose a reason for hiding this comment

BhaaLseN left a comment

Choose a reason for hiding this comment

JMC47 commented Oct 17, 2019

mbc07 commented Oct 17, 2019

JMC47 commented Oct 17, 2019

jordan-woyak commented Oct 18, 2019

jordan-woyak commented Dec 30, 2018 •

edited

iwubcode Apr 4, 2019 •

edited