uninttp

A universal type for non-type template parameters for C++20 or later.

Installation:

uninttp (Universal Non-Type Template Parameters) is a header-only library. Simply clone this repository and you're ready to go.

Once that's done, you can include the necessary header(s) and start using uninttp in your project:

#include <uninttp/uni_auto.hpp>

uninttp also has a C++ module version, so, if your compiler supports C++20 modules, you can do something like this instead of including the whole header file into your project:

import uninttp.uni_auto; // Improves compilation speed

// Uncomment the lines below for fmtlib support
// import fmt;
// import uninttp.fmt_support;

Usage:

Using uninttp's uninttp::uni_auto is pretty straightforward and is synonymous to auto in most of the cases: Demo

#include <uninttp/uni_auto.hpp>

using namespace uninttp;

template <uni_auto Value>
constexpr auto add20() {
    return Value + 20;
}

int main() {
    static_assert(add20<20>() == 40); // OK
}

And if you thought, "Can't I just use something like template <auto Value> instead?", then you'd be absolutely correct. One can safely replace uni_auto with auto, at least for this example.

However, a template parameter declared with uni_auto can do much more than a template parameter declared with auto in the sense that you can also pass string literals, constexpr-marked arrays, arrays of static storage duration, etc., through it: Demo

#include <uninttp/uni_auto.hpp>
#include <string_view>
#include <iostream>
#include <cstddef>
#include <array>

using namespace uninttp;

template <uni_auto Value, std::size_t X>
constexpr auto shift() {
    return Value + X;
}

template <uni_auto Array>
void print_array() {
    // Using a range-based `for`-loop
    for (const auto& elem : Array)
        std::cout << elem << ' ';

    std::cout << '\n';

    // Using iterators
    for (auto it = std::begin(Array); it != std::end(Array); ++it)
        std::cout << *it << ' ';

    std::cout << '\n';

    // Using an index-based `for`-loop
    for (std::size_t i = 0; i < std::size(Array); i++)
        std::cout << Array[i] << ' ';

    std::cout << '\n';
}

int main() {
    // Passing a string literal
    static_assert(std::string_view(shift<"foobar", 3>()) == "bar"); // OK

    // Passing an array marked as `constexpr`
    constexpr int arr1[] { 1, 8, 9, 20 };
    print_array<arr1>();                                            // 1 8 9 20

    // Passing an array of static storage duration
    static int arr2[] { 1, 2, 4, 8 };
    // `promote_to_ref` tells the compiler to pass `arr2` by reference
    print_array<promote_to_ref<arr2>>();                            // 1 2 4 8

    // Passing a `constexpr` array of static storage duration
    static constexpr int arr3[] { 1, 6, 10, 23 };
    // Passing `arr3` by value
    print_array<arr3>();                                            // 1 6 10 23
    // Passing `arr3` by reference
    print_array<promote_to_ref<arr3>>();                            // 1 6 10 23

    // Passing a `const` array of static storage duration
    static const int arr4[] { 1, 2, 8, 9 };
    // `arr4` can only be passed by reference
    print_array<promote_to_ref<arr4>>();                            // 1 2 8 9

    // Passing an `std::array` object
    print_array<std::array { 1, 4, 6, 9 }>();                       // 1 4 6 9
}

You can also use it with parameter packs, obviously: Demo

#include <uninttp/uni_auto.hpp>
#include <iostream>

using namespace uninttp;

template <uni_auto... Values>
void print() {
    ((std::cout << Values << ' '), ...) << '\n';
}

int main() {
    print<1, 3.14159, 6.3f, "foo">(); // 1 3.14159 6.3 foo
}

You can also enforce a type by adding a constraint: Demo

#include <uninttp/uni_auto.hpp>
#include <concepts>

using namespace uninttp;

template <uni_auto Value>
    // `uni_auto_simplify_t<Value>` gives you the simplified type for type-checking convenience
    requires std::same_as<uni_auto_simplify_t<Value>, const char*>
void only_accepts_strings() {}

int main() {
    only_accepts_strings<"foobar">(); // OK
    // only_accepts_strings<123>();   // Error! Constraint not satisfied!
}

Note: One can also use the above combination of constraints and uni_auto to achieve a sort of "function overloading through template parameters" mechanism: Demo

#include <uninttp/uni_auto.hpp>
#include <concepts>
#include <iostream>

using namespace uninttp;

template <uni_auto Value>
    requires std::same_as<uni_auto_simplify_t<Value>, const char*>
void do_something() {
    std::cout << "A string was passed\n";
}

template <uni_auto Value>
    requires std::same_as<uni_auto_simplify_t<Value>, int>
void do_something() {
    std::cout << "An integer was passed\n";
}

int main() {
    do_something<"foobar">(); // A string was passed
    do_something<123>();      // An integer was passed
    // do_something<12.3>();  // Error!
}

Example using class types: Demo

#include <uninttp/uni_auto.hpp>

using namespace uninttp;

struct X {
    int val = 6;
};

struct Y {
    int val = 7;
};

template <uni_auto A, uni_auto B>
constexpr auto mul() {
    return A.val * B.val;
}

int main() {
    static_assert(mul<X{}, Y{}>() == 42); // OK
}

Example using lambdas and functors: Demo

#include <uninttp/uni_auto.hpp>

using namespace uninttp;

template <uni_auto F>
constexpr auto call() {
    return F();
}

struct Funct {
    constexpr auto operator()() const {
        return 86;
    }
};

int main() {
    static_assert(call<[] { return 69; }>() == 69); // OK
    static_assert(call<Funct{}>() == 86);           // OK
}

Example using pointers to objects: Demo

#include <uninttp/uni_auto.hpp>
#include <iostream>

using namespace uninttp;

template <uni_auto P>
void modify_pointer_value() {
    *P = 42;
}

template <uni_auto P>
void print_pointer_value() {
    std::cout << *P << '\n';
}

int main() {
    static constexpr int x = 2;
    static int y = 3;
    print_pointer_value<&x>();  // 2
    modify_pointer_value<&y>(); // Modifies the value of `y` indirectly through pointer access
    print_pointer_value<&y>();  // 42
}

Example using function pointers: Demo

#include <uninttp/uni_auto.hpp>

using namespace uninttp;

constexpr auto some_fun() {
    return 42;
}

template <uni_auto Func>
constexpr auto call_fun() {
    return Func();
}

int main() {
    // Passing `some_fun` by reference
    static_assert(call_fun<promote_to_ref<some_fun>>() == 42);  // OK
    // Passing `some_fun` as a function pointer
    static_assert(call_fun<&some_fun>() == 42);                 // OK
}

Example using pointers to members: Demo

#include <uninttp/uni_auto.hpp>
#include <iostream>

using namespace uninttp;

struct some_class {
    int some_member_var = 0;
    void some_member_fun(int& p) const {
        p = 2;
    }
};

template <uni_auto MemFun>
void call_member_fun(const some_class& x, int& y) {
    // `uni_auto_v` is used to extract the underlying value out of a `uni_auto` object
    (x.*uni_auto_v<MemFun>)(y);
}

template <uni_auto MemVar>
void modify_member_var(some_class& x, const int new_val) {
    x.*uni_auto_v<MemVar> = new_val;
}

int main() {
    static some_class x;
    int y;

    // Calling a member function
    call_member_fun<&some_class::some_member_fun>(x, y);
    std::cout << y << '\n';                 // 2

    // Modifying a member variable
    modify_member_var<&some_class::some_member_var>(x, 3);
    std::cout << x.some_member_var << '\n'; // 3
}

Example using lvalue references: Demo

#include <uninttp/uni_auto.hpp>
#include <concepts>
#include <iostream>

using namespace uninttp;

struct X {
    int n = 0;

    friend void swap(X& a, X& b) {
        std::cout << "`swap(X&, X&)` was called\n";
        std::ranges::swap(a.n, b.n);
    }

    friend std::ostream& operator<<(std::ostream& os, const X& x) {
        return os << x.n;
    }
};

template <uni_auto A, uni_auto B>
void swap_vars() {
    std::ranges::swap(A, B);
    /* Alternatives: `uninttp::swap(A, B);`,
                     `A.swap(B);` */
}

int main() {
    {
        static X x{ 42 }, y{ 69 };

        std::cout << x << ' ' << y << '\n';                // 42 69
        swap_vars<promote_to_ref<x>, promote_to_ref<y>>(); // `swap(X&, X&)` was called
        std::cout << x << ' ' << y << '\n';                // 69 42
    }

    /////////////////////////////////////////

    {
        static int x = 86, y = 420;

        std::cout << x << ' ' << y << '\n';                // 86 420
        swap_vars<promote_to_ref<x>, promote_to_ref<y>>(); // Swaps the values of `x` and `y`
        std::cout << x << ' ' << y << '\n';                // 420 86
    }
}

Formatting using std::format()/fmt::format() is also supported: Demo

// All the fmtlib headers have to be included BEFORE including `uni_auto.hpp`!
#include <fmt/core.h>
#include <uninttp/uni_auto.hpp>

#include <iostream>
#include <format>

using namespace uninttp;

template <uni_auto Value>
void print() {
    std::cout << std::format("{}\n", Value); // Using `std::format()`
    std::cout << fmt::format("{}\n", Value); // Using `fmt::format()`
}

int main() {
    print<"foo">(); // foo
}

All the examples shown above have used function templates to demonstrate the capability of uni_auto. However, it can readily be used in any context.

Test suite:

An exhaustive test on uninttp's uninttp::uni_auto has been done to ensure that it consistently works for almost every non-type template argument allowed.

The test suite can be found here.

(P.S.: For reference, one can look up this link.)

Cheat sheet:

	Description
uninttp::uni_auto_t<uni_auto Value>	Gives the type of the underlying value held by Value.
uninttp::uni_auto_simplify_t<uni_auto Value>	Gives the simplified type of the underlying value held by Value. If Value holds an array or a reference to a function, it condenses it into a pointer and returns the pointer as the type. It also removes any references from the type returned. This feature is often useful for doing compile-time type-checking, SFINAE and/or for defining certain constraints on the types held by Value.
uninttp::uni_auto_v<uni_auto Value>	Extracts the underlying value held by Value.
uninttp::uni_auto_simplify_v<uni_auto Value>	Converts the underlying value of Value into its simplest form. If Value holds an array or a reference to a function, it converts it into a pointer and also casts away any and all references.
uninttp::promote_to_ref<auto& Value>	Pre-constructs a uni_auto object after binding an lvalue to a reference. In simple terms, it's used to tell the compiler to pass by reference through uni_auto. Here you can find a live example to see this feature in action.
uninttp::promote_to_cref<const auto& Value>	Pre-constructs a uni_auto object after binding an lvalue to a const reference.

Limitations:

1. The datatype of the value held by a uni_auto object cannot be fetched using decltype(X) as is done with auto-template parameters. Instead, one would have to use uni_auto_t or uni_auto_simplify_t to fetch the type: Demo

   #include <uninttp/uni_auto.hpp>
   #include <type_traits>
   
   using namespace uninttp;
   
   template <uni_auto X>
   void fun() {
       // This doesn't work for obvious reasons:
       // static_assert(std::same_as<decltype(X), double>);                              // Error
   
       // Using `uni_auto_t`:
       static_assert(std::is_same_v<uni_auto_t<X>, double>);                             // OK
   
       /* Using `uni_auto_v` and then using `decltype()` and then removing the `const`
        * specifier from the type returned: */
       static_assert(
           std::is_same_v<std::remove_const_t<decltype(uni_auto_v<X>)>, double>
       );                                                                                // OK
   
       // Using `uni_auto_simplify_t`:
       static_assert(std::is_same_v<uni_auto_simplify_t<X>, double>);                    // OK
   
       /* Using `uni_auto_simplify_v` and then using `decltype()` and then removing the
        * `const` specifier from the type returned: */
       static_assert(
           std::is_same_v<std::remove_const_t<decltype(uni_auto_simplify_v<X>)>, double>
       );                                                                                // OK
   }
   
   int main() {
       fun<1.89>();
   }

2. There may be some cases where the conversion operator of the uni_auto object doesn't get invoked. In such a scenario, one would need to explicitly notify the compiler to extract the value out of the uni_auto object using uni_auto_v or uni_auto_simplify_v:
   • During type inference: Demo

     #include <uninttp/uni_auto.hpp>
     #include <type_traits>
     
     using namespace uninttp;
     
     template <uni_auto X>
     void fun() {
         // The conversion operator doesn't get invoked in this case:
         // constexpr auto a = X;
     
         // Using an explicit conversion statement:
         constexpr int b = X;
     
         // Using `uni_auto_v`:
         constexpr auto c = uni_auto_v<X>;
     
         // Using `uni_auto_simplify_v`:
         constexpr auto d = uni_auto_simplify_v<X>;
     
         // static_assert(std::is_same_v<decltype(a), const int>); // Error
         static_assert(std::is_same_v<decltype(b), const int>);    // OK
         static_assert(std::is_same_v<decltype(c), const int>);    // OK
         static_assert(std::is_same_v<decltype(d), const int>);    // OK
     }
     
     int main() {
         fun<42>();
     }

   • When accessing an object's members through a reference: Demo

     #include <uninttp/uni_auto.hpp>
     #include <iostream>
     
     using namespace uninttp;
     
     struct some_class {
         int p = 0;
         some_class& operator=(const int rhs) {
             p = rhs;
             return *this;
         }
     };
     
     template <uni_auto X>
     void fun() {
         // Assignment operator works as expected
         X = 2;
     
         // const auto a = X.p;     // This will NOT work since the C++ Standard does not allow
         // std::cout << a << '\n'; // overloading the dot operator (yet)
                                    // For more info, see the 'P0416R1' proposal
     
         /* Extract the value out of `X` beforehand and bind it to another reference which can
          * now be used to access the member `p`: */
         auto& ref = uni_auto_v<X>;
         const auto b = ref.p;
         std::cout << b << '\n';
     
         /* Or if you want to access the member `p` directly, you would have to call `uni_auto_v`
          * explicitly: */
         const auto c = uni_auto_v<X>.p;
         std::cout << c << '\n';
     }
     
     int main() {
         static some_class some_obj;
         fun<promote_to_ref<some_obj>>(); // 2
     }

   • When the function parameter is a reference to an array: Demo

     #include <uninttp/uni_auto.hpp>
     #include <iostream>
     #include <cstddef>
     
     using namespace uninttp;
     
     template <typename T, std::size_t N>
     void print_array(T(&arr)[N]) {
         for (const auto& elem : arr)
             std::cout << elem << ' ';
     
         std::cout << '\n';
     }
     
     template <uni_auto X>
     void fun() {
         // print_array(X);          // Error! `X`'s conversion operator is not invoked
                                     // during the call!
         print_array(uni_auto_v<X>); // OK
     }
     
     int main() {
         constexpr int arr[] { 1, 2, 3 };
         fun<arr>(); // 1 2 3
     }

   • When using std::to_array(): Demo

     #include <uninttp/uni_auto.hpp>
     #include <array>
     
     using namespace uninttp;
     
     template <uni_auto X>
     constexpr auto convert_to_array() {
         return uninttp::to_array(X);
         // Alternative: `return std::to_array(uni_auto_v<X>);`
     }
     
     int main() {
         constexpr int arr[] { 1, 2, 3 };
         static_assert(convert_to_array<arr>() ==  std::array { 1, 2, 3 }); // OK
     }

Playground:

If you'd like to play around with uni_auto yourself, here you go!