ecstasy::integration::user_action::ActionBindings Class Reference

Wrapper of a std::vector of ActionBinding. More...

#include <ActionBindings.hpp>

Collaboration diagram for ecstasy::integration::user_action::ActionBindings:

Public Member Functions
	ActionBindings () noexcept=default
	Construct a new empty action binding container.
constexpr std::vector< ActionBinding > &	getBindings () noexcept
	Get the Bindings.
constexpr const std::vector< ActionBinding > &	getBindings () const noexcept
	Get the Bindings.
toml::table	dump () const noexcept
	Dump the bindings as a toml table.
bool	load (const toml::table &bindings) noexcept
	Load a given toml table representing a list of bindings.
bool	contains (ActionBinding action) const noexcept
	Check whether action is contained in the internal ActionBinding vector.

Private Attributes
std::vector< ActionBinding >	_bindings

Detailed Description

Wrapper of a std::vector of ActionBinding.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-25)

Definition at line 27 of file ActionBindings.hpp.

Constructor & Destructor Documentation

ActionBindings()

ecstasy::integration::user_action::ActionBindings::ActionBindings ( )

defaultnoexcept

Construct a new empty action binding container.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-25)

Member Function Documentation

contains()

bool ecstasy::integration::user_action::ActionBindings::contains ( ActionBinding  action ) const

noexcept

Check whether action is contained in the internal ActionBinding vector.

Parameters

[in]

action

action to search.

Returns

bool Whether the action is contained or not.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 107 of file ActionBindings.cpp.

    {
        return std::find(_bindings.cbegin(), _bindings.cend(), binding) != _bindings.cend();
    }

dump()

toml::table ecstasy::integration::user_action::ActionBindings::dump ( ) const

noexcept

Dump the bindings as a toml table.

Returns

toml::table Toml representation of the bindings.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-29)

There is no check for node type because we control the total flow of the toml nodes

The actions are named 'Action-<action_id>'

If there isn't any node for the action we create one

Definition at line 21 of file ActionBindings.cpp.

    {
        toml::table table;
 
        for (ActionBinding action : _bindings) {
            std::string key = std::string("Action-") + std::to_string(action.actionId);
            toml::node *nodePtr = table.get(key);
            std::stringstream value;
 
            if (!nodePtr)
                nodePtr = &table.emplace<toml::array>(key).first->second;
 
            toml::node &node = *nodePtr;
            value << action.type << "->";
            switch (action.type) {
                case ActionBinding::Type::MouseButton: value << action.mouseButton; break;
                case ActionBinding::Type::Key: value << action.key; break;
                case ActionBinding::Type::GamepadButton: value << action.gamepadButton; break;
                case ActionBinding::Type::GamepadAxis: value << action.gamepadAxis; break;
                default: continue;
            }
            node.as_array()->emplace_back(value.str());
        }
 
        return table;
    }

getBindings() [1/2]

constexpr const std::vector< ActionBinding > & ecstasy::integration::user_action::ActionBindings::getBindings ( ) const

inlineconstexprnoexcept

Get the Bindings.

Returns

const std::vector<ActionBinding>& A const reference to the internal container.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-25)

Definition at line 58 of file ActionBindings.hpp.

        {
            return _bindings;
        }

getBindings() [2/2]

constexpr std::vector< ActionBinding > & ecstasy::integration::user_action::ActionBindings::getBindings ( )

inlineconstexprnoexcept

Get the Bindings.

Returns

std::vector<ActionBinding>& A reference to the internal container.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-25)

Definition at line 45 of file ActionBindings.hpp.

        {
            return _bindings;
        }

load()

bool ecstasy::integration::user_action::ActionBindings::load ( const toml::table &  bindings )

noexcept

Load a given toml table representing a list of bindings.

See the format of dump().

Warning

This method clear the internal bindings.

Parameters

[in]

bindings

Input bindings.

Returns

bool Whether the load succeed or not.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-30)

Definition at line 51 of file ActionBindings.cpp.

    {
        _bindings.clear();
        const std::regex reActionName("^Action-([0-9]+)$");
        const std::regex reActionValue("^(\\w+)->(\\w+)$");
        std::cmatch match;
 
        for (auto &&[key, value] : bindings) {
            if (!std::regex_match(key.data(), match, reActionName)) [[unlikely]] {
                std::cerr << "Invalid action name." << std::endl;
                break;
            }
 
            Action::Id actionId = std::stoul(match[1].str());
            if (!value.is_array()) [[unlikely]] {
                std::cerr << "Action '" << key.data() << "' is not a valid toml array." << std::endl;
                continue;
            }
 
            value.as_array()->for_each([this, &match, &reActionValue, &actionId](auto &&input) {
                if constexpr (toml::is_string<decltype(input)>) {
                    if (!std::regex_match(input.as_string()->get().data(), match, reActionValue))
                        return;
                    ActionBinding::Type type;
 
                    std::istringstream ss(match[1].str());
                    ss >> type;
                    ss.clear();
                    ss.str(match[2].str());
 
                    switch (type) {
                        case ActionBinding::Type::MouseButton:
                            _bindings.emplace_back(
                                actionId, util::serialization::Serializer::deserialize<event::Mouse::Button>(ss));
                            break;
                        case ActionBinding::Type::Key:
                            _bindings.emplace_back(
                                actionId, util::serialization::Serializer::deserialize<event::Keyboard::Key>(ss));
                            break;
                        case ActionBinding::Type::GamepadButton:
                            _bindings.emplace_back(
                                actionId, util::serialization::Serializer::deserialize<event::Gamepad::Button>(ss));
                            break;
                        case ActionBinding::Type::GamepadAxis:
                            _bindings.emplace_back(
                                actionId, util::serialization::Serializer::deserialize<event::Gamepad::Axis>(ss));
                            break;
                        default: break;
                    }
                    // clang-format off
                }});
            // clang-format on
        }
        return true;
    }

Member Data Documentation

_bindings

std::vector<ActionBinding> ecstasy::integration::user_action::ActionBindings::_bindings

private

Definition at line 101 of file ActionBindings.hpp.

---

The documentation for this class was generated from the following files:

• src/ecstasy/integrations/user_action/ActionBindings.hpp
• src/ecstasy/integrations/user_action/ActionBindings.cpp