Skip to content

Add support for named function parameters #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amitchone merged 1 commit into from
Jul 31, 2026
Merged

Add support for named function parameters #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 57 additions & 5 deletions include/thingset++/ThingSetFunction.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,39 @@ static bool invoke(std::function<void(Args...)> &function, std::tuple<Values...>
return encoder.encodeNull();
}

/// @brief Carries optional human-friendly names for a function's parameters.
/// Pass as the ParamNames argument of ThingSetFunction (or use one of the
/// ThingSetNamed*Function aliases). An empty list means every parameter
/// name is auto-generated from the function name, argument type and
/// position (e.g. "xOnu16_1"); a non-empty list must name every argument.
/// Names travel in the node metadata
template <StringLiteral... Names>
struct ThingSetParameterNames
{
static constexpr size_t count = sizeof...(Names);

template <size_t Index>
static constexpr auto get()
{
return std::get<Index>(std::tuple{ Names... });
}
};

/// @brief Represents an executable function.
/// @tparam Id The unique integer ID of the ThingSet node.
/// @tparam ParentId The integer ID of the parent node.
/// @tparam Name The name of the node.
/// @tparam Access Access control flags.
/// @tparam ParamNames A ThingSetParameterNames<...> naming each argument,
/// or ThingSetParameterNames<> to auto-generate names.
/// @tparam Result The return type of the function.
/// @tparam ...Args The argument types of the function, if any.
template <uint16_t Id, uint16_t ParentId, StringLiteral Name, ThingSetAccess Access, uint16_t FirstArgumentId, typename Result, typename... Args>
template <uint16_t Id, uint16_t ParentId, StringLiteral Name, ThingSetAccess Access, uint16_t FirstArgumentId, typename ParamNames, typename Result, typename... Args>
class ThingSetFunction : public IdentifiableThingSetParentNode<Id, ParentId, Name>, public ThingSetInvocable
{
static_assert(ParamNames::count == 0 || ParamNames::count == sizeof...(Args),
"ThingSetParameterNames must either be empty or name every argument");

private:
template <uint16_t ChildId, StringLiteral ArgName, typename T>
class ThingSetFunctionParameter : public IdentifiableThingSetNode<ChildId, Id, ArgName>
Expand Down Expand Up @@ -82,7 +105,18 @@ class ThingSetFunction : public IdentifiableThingSetParentNode<Id, ParentId, Nam
{
using Tuple = std::tuple<Args...>;
using ParameterType = std::tuple_element_t<Index, Tuple>;
typedef ThingSetFunctionParameter<FirstArgumentId + 0 + Index, Name + ThingSetType<std::remove_cvref_t<ParameterType>>::name + "_" + to_string_t<1 + Index>(), ParameterType> type;

static constexpr auto argName()
{
if constexpr (ParamNames::count != 0) {
return ParamNames::template get<Index>();
}
else {
return Name + ThingSetType<std::remove_cvref_t<ParameterType>>::name + "_" + to_string_t<1 + Index>();
}
}

typedef ThingSetFunctionParameter<FirstArgumentId + 0 + Index, argName(), ParameterType> type;
};

/// @brief The exposed function.
Expand Down Expand Up @@ -133,13 +167,31 @@ class ThingSetFunction : public IdentifiableThingSetParentNode<Id, ParentId, Nam
};

template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename Result, typename... Args>
using ThingSetUserFunction = ThingSetFunction<Id, ParentId, Name, ThingSetAccess::anyWrite, Id + 1, Result, Args...>;
using ThingSetUserFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::anyWrite, Id + 1, ThingSetParameterNames<>, Result, Args...>;

template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename Result, typename... Args>
using ThingSetAdvancedFunction = ThingSetFunction<Id, ParentId, Name, ThingSetAccess::expertWrite, Id + 1, Result, Args...>;
using ThingSetAdvancedFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::expertWrite, Id + 1, ThingSetParameterNames<>, Result, Args...>;

template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename Result, typename... Args>
using ThingSetManufacturerFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::manufacturerWrite, Id + 1, Result, Args...>;
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::manufacturerWrite, Id + 1, ThingSetParameterNames<>, Result,
Args...>;

// Named variants: identical to the above but with human-friendly parameter
// names, e.g.
// ThingSetNamedUserFunction<0x710, 0x07, "xOn", ThingSetParameterNames<"uSwitchMode">, int, uint16_t>
template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename ParamNames, typename Result, typename... Args>
using ThingSetNamedUserFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::anyWrite, Id + 1, ParamNames, Result, Args...>;

template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename ParamNames, typename Result, typename... Args>
using ThingSetNamedAdvancedFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::expertWrite, Id + 1, ParamNames, Result, Args...>;

template <uint16_t Id, uint16_t ParentId, StringLiteral Name, typename ParamNames, typename Result, typename... Args>
using ThingSetNamedManufacturerFunction =
ThingSetFunction<Id, ParentId, Name, ThingSetAccess::manufacturerWrite, Id + 1, ParamNames, Result, Args...>;

} // namespace ThingSet
21 changes: 20 additions & 1 deletion tests/TestFunctions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,12 @@ ThingSetUserFunction<0x430, 0x0, "xMap", std::map<std::string, float>> xGetMap([
map.insert_or_assign("world", 2.0f);
return map;
});
ThingSetFunction<0x440, 0x0, "xTestCustom", ThingSetAccess::anyWrite, 0x4401, void, int, float> xTestCustomFunc(test);
ThingSetFunction<0x440, 0x0, "xTestCustom", ThingSetAccess::anyWrite, 0x4401, ThingSetParameterNames<>, void, int,
float>
xTestCustomFunc(test);
ThingSetUserFunction<0x450, 0x0, "xString", int, std::string &> xString([](std::string &) { return 0; });
ThingSetNamedUserFunction<0x470, 0x0, "xNamed", ThingSetParameterNames<"uAlpha", "uBeta">, int, uint16_t, float>
xNamed([](uint16_t, float) { return 0; });

TEST(Functions, FunctionTypes)
{
Expand Down Expand Up @@ -62,6 +66,21 @@ TEST(Functions, FunctionParameters)
ASSERT_EQ("string", node->getType());
}

TEST(Functions, NamedFunctionParameters)
{
ThingSetNode *node;
ASSERT_TRUE(ThingSetRegistry::findById(0x471, &node));
ASSERT_EQ(0x470, node->getParentId());
ASSERT_EQ("uAlpha", node->getName());
ASSERT_EQ("u16", node->getType());
ASSERT_TRUE(ThingSetRegistry::findById(0x472, &node));
ASSERT_EQ(0x470, node->getParentId());
ASSERT_EQ("uBeta", node->getName());
ASSERT_EQ("f32", node->getType());
// Names are metadata only: the function's type signature is unchanged.
ASSERT_EQ("(u16,f32)->(i32)", xNamed.getType());
}

TEST(Functions, FunctionParametersWithCustomId)
{
ThingSetNode *node;
Expand Down
Loading