Skip to content

Commit

Permalink
ExpressionParser: Show error message with expected arguments.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jordan-woyak
jordan-woyak committed Oct 12, 2019
1 parent b57178d commit 4d41bd6
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 34 deletions.
20 changes: 13 additions & 7 deletions Source/Core/InputCommon/ControlReference/ExpressionParser.cpp
View file
Expand Up @@ -469,7 +469,8 @@ class Parser
return tok.type == type;
}

ParseResult ParseFunctionArguments(std::unique_ptr<FunctionExpression>&& func,
ParseResult ParseFunctionArguments(const std::string_view& func_name,
std::unique_ptr<FunctionExpression>&& func,
const Token& func_tok)
{
std::vector<std::unique_ptr<Expression>> args;
Expand Down Expand Up @@ -518,10 +519,15 @@ class Parser
}
}

if (!func->SetArguments(std::move(args)))
const auto argument_validation = func->SetArguments(std::move(args));

if (std::holds_alternative<FunctionExpression::ExpectedArguments>(argument_validation))
{
// TODO: It would be nice to output how many arguments are expected.
return ParseResult::MakeErrorResult(func_tok, _trans("Wrong number of arguments."));
const auto text = std::string(func_name) + '(' +
std::get<FunctionExpression::ExpectedArguments>(argument_validation).text +
')';

return ParseResult::MakeErrorResult(func_tok, _trans("Expected arguments: " + text));
}

return ParseResult::MakeSuccessfulResult(std::move(func));
Expand All @@ -543,7 +549,7 @@ class Parser
return ParseAtom(control_tok);
}

return ParseFunctionArguments(std::move(func), tok);
return ParseFunctionArguments(tok.data, std::move(func), tok);
}
case TOK_CONTROL:
{
Expand All @@ -553,7 +559,7 @@ class Parser
}
case TOK_NOT:
{
return ParseFunctionArguments(MakeFunctionExpression("not"), tok);
return ParseFunctionArguments("not", MakeFunctionExpression("not"), tok);
}
case TOK_LITERAL:
{
Expand All @@ -571,7 +577,7 @@ class Parser
{
// An atom was expected but we got a subtraction symbol.
// Interpret it as a unary minus function.
return ParseFunctionArguments(MakeFunctionExpression("minus"), tok);
return ParseFunctionArguments("minus", MakeFunctionExpression("minus"), tok);
}
default:
{
Expand Down
99 changes: 74 additions & 25 deletions Source/Core/InputCommon/ControlReference/FunctionExpression.cpp
View file
Expand Up @@ -21,10 +21,14 @@ using FSec = std::chrono::duration<ControlState>;
class ToggleExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
// Optional 2nd argument for clearing state:
return 1 == args.size() || 2 == args.size();
if (1 == args.size() || 2 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"toggle_state_input, [clear_state_input]"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -57,9 +61,13 @@ class ToggleExpression : public FunctionExpression
class NotExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 1 == args.size();
if (1 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"expression"};
}

ControlState GetValue() const override { return 1.0 - GetArg(0).GetValue(); }
Expand All @@ -70,9 +78,13 @@ class NotExpression : public FunctionExpression
class SinExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 1 == args.size();
if (1 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"expression"};
}

ControlState GetValue() const override { return std::sin(GetArg(0).GetValue()); }
Expand All @@ -82,9 +94,13 @@ class SinExpression : public FunctionExpression
class TimerExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 1 == args.size();
if (1 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"seconds"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -121,9 +137,13 @@ class TimerExpression : public FunctionExpression
class IfExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 3 == args.size();
if (3 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"condition, true_expression, false_expression"};
}

ControlState GetValue() const override
Expand All @@ -137,9 +157,13 @@ class IfExpression : public FunctionExpression
class UnaryMinusExpression : public FunctionExpression
{
private:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 1 == args.size();
if (1 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"expression"};
}

ControlState GetValue() const override
Expand All @@ -152,9 +176,13 @@ class UnaryMinusExpression : public FunctionExpression
// usage: deadzone(input, amount)
class DeadzoneExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 2 == args.size();
if (2 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, amount"};
}

ControlState GetValue() const override
Expand All @@ -169,9 +197,13 @@ class DeadzoneExpression : public FunctionExpression
// seconds is seconds to change from 0.0 to 1.0
class SmoothExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 2 == args.size() || 3 == args.size();
if (2 == args.size() || 3 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, seconds_up, seconds_down = seconds_up"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -209,9 +241,13 @@ class SmoothExpression : public FunctionExpression
// usage: hold(input, seconds)
class HoldExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 2 == args.size();
if (2 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, seconds"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -244,9 +280,13 @@ class HoldExpression : public FunctionExpression
// usage: tap(input, seconds, taps=2)
class TapExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 2 == args.size() || 3 == args.size();
if (2 == args.size() || 3 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, seconds, taps = 2"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -300,9 +340,13 @@ class TapExpression : public FunctionExpression
// speed is max movement per second
class RelativeExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return args.size() >= 2 && args.size() <= 4;
if (args.size() >= 2 && args.size() <= 4)
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, speed, [max_abs_value, [shared_state]]"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -355,9 +399,13 @@ class RelativeExpression : public FunctionExpression
// usage: pulse(input, seconds)
class PulseExpression : public FunctionExpression
{
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) override
{
return 2 == args.size();
if (2 == args.size())
return ArgumentsAreValid{};
else
return ExpectedArguments{"input, seconds"};
}

ControlState GetValue() const override
Expand Down Expand Up @@ -447,7 +495,8 @@ void FunctionExpression::UpdateReferences(ControlEnvironment& env)
arg->UpdateReferences(env);
}

bool FunctionExpression::SetArguments(std::vector<std::unique_ptr<Expression>>&& args)
FunctionExpression::ArgumentValidation
FunctionExpression::SetArguments(std::vector<std::unique_ptr<Expression>>&& args)
{
m_args = std::move(args);

Expand Down
17 changes: 15 additions & 2 deletions Source/Core/InputCommon/ControlReference/FunctionExpression.h
View file
Expand Up @@ -6,6 +6,7 @@

#include <memory>
#include <string>
#include <variant>
#include <vector>

#include "InputCommon/ControlReference/ExpressionParser.h"
Expand All @@ -18,15 +19,27 @@ namespace ExpressionParser
class FunctionExpression : public Expression
{
public:
struct ArgumentsAreValid
{
};

struct ExpectedArguments
{
std::string text;
};

using ArgumentValidation = std::variant<ArgumentsAreValid, ExpectedArguments>;

int CountNumControls() const override;
void UpdateReferences(ControlEnvironment& env) override;

bool SetArguments(std::vector<std::unique_ptr<Expression>>&& args);
ArgumentValidation SetArguments(std::vector<std::unique_ptr<Expression>>&& args);

void SetValue(ControlState value) override;

protected:
virtual bool ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) = 0;
virtual ArgumentValidation
ValidateArguments(const std::vector<std::unique_ptr<Expression>>& args) = 0;

Expression& GetArg(u32 number);
const Expression& GetArg(u32 number) const;
Expand Down

0 comments on commit 4d41bd6

Please sign in to comment.