Пользовательские литералы (начиная с C++11)

Позволяют целочисленным, литералам с плавающей точкой, символьным и строковым литералам создавать объекты пользовательского типа посредством определения пользовательского суффикса.

Синтаксис

Пользовательский литерал представляет собой выражение одной из следующих форм

Если токен соответствует синтаксису пользовательского литерала и синтаксису обычного литерала, он считается обычным литералом (то есть перегрузить LL в 123LL невозможно).

Когда компилятор встречает пользовательский литерал с суффиксом ud-suffix X, он выполняет поиск неквалифицированного имени, разыскивая функцию с именем operator""X. Если поиск не находит объявления, программа некорректна. В противном случае:

long double operator ""_w(long double);
std::string operator ""_w(const char16_t*, size_t);
unsigned    operator ""_w(const char*);

int main()
{
    1.2_w;    // calls operator ""_w(1.2L)
    u"one"_w; // calls operator ""_w(u"one", 3)
    12_w;     // calls operator ""_w("12")
    "two"_w;  // error: no applicable literal operator
}

При конкатенации строковых литералов на этапе трансляции 6 пользовательские строковые литералы также конкатенируются, а их суффиксы ud-suffix игнорируются при конкатенации, за исключением того, что для всех конкатенируемых литералов может быть указан только один суффикс:

int main()
{
    L"A" "B" "C"_x;  // OK: same as L"ABC"_x
    "P"_x "Q" "R"_y; // error: two different ud-suffixes (_x and _y)
}

Операторы литералов

Функция, вызываемая пользовательским литералом, называется оператором литерала (или, если это шаблон, шаблоном оператора литерала). Она объявляется так же, как любая другая функция или шаблон функции в пространстве имен (это также может быть функция-друг, явное инстанцирование или специализация шаблона функции либо объявление с помощью using), за исключением следующих ограничений:

Имя этой функции может иметь одну из двух форм:

ud-suffix должен начинаться с символа подчёркивания _: суффиксы, не начинающиеся с подчёркивания, зарезервированы для операторов литералов стандартной библиотеки. Он также не может содержать двойное подчёркивание __: такие суффиксы также зарезервированы.

Если оператор литерала является шаблоном, он должен иметь пустой список параметров и может иметь только один параметр шаблона, который должен быть пакетом нетиповых параметров шаблона с типом элемента char (в этом случае он называется шаблоном числового оператора литерала):

template<char...>
double operator ""_x();

struct A { constexpr A(const char*); };

template<A a>
A operator ""_a();

Для операторов литералов допускаются только следующие списки параметров:

Аргументы по умолчанию не допускаются.

Связывание языка C не допускается.

За исключением перечисленных выше ограничений, операторы литералов и шаблоны операторов литералов являются обычными функциями (и шаблонами функций): их можно объявлять как inline или constexpr, они могут иметь внутреннее или внешнее связывание, их можно вызывать явно, получать их адреса и т. д.

#include <string>

void        operator ""_km(long double); // OK, will be called for 1.0_km
void        operator "" _km(long double); // same as above, deprecated
std::string operator ""_i18n(const char*, std::size_t); // OK

template<char...>
double operator ""_pi(); // OK
float  operator ""_e(const char*); // OK
 
// error: suffix must begin with underscore
float operator ""Z(const char*);

// error: all names that begin with underscore followed by uppercase
// letter are reserved (NOTE: a space between "" and _).
double operator"" _Z(long double);

// OK. NOTE: no space between "" and _.
double operator""_Z(long double);

// OK: literal operators can be overloaded
double operator ""_Z(const char* args);

int main() {}

Примечания

С появлением пользовательских литералов код, в котором макроконстанты форматирования для целочисленных типов фиксированной ширины использовались без пробела после предшествующего строкового литерала, стал некорректным: std::printf("%"PRId64"\n",INT64_MIN); необходимо заменить на std::printf("%" PRId64"\n",INT64_MIN);.

Из-за правила максимального совпадения пользовательские целочисленные литералы и литералы с плавающей точкой, оканчивающиеся на p, P,(начиная с C++17) e и E, при наличии после них операторов + или - должны отделяться от оператора пробелом или скобками в исходном коде:

long double operator""_E(long double);
long double operator""_a(long double);
int operator""_p(unsigned long long);

auto x = 1.0_E+2.0;   // error
auto y = 1.0_a+2.0;   // OK
auto z = 1.0_E +2.0;  // OK
auto q = (1.0_E)+2.0; // OK
auto w = 1_p+2;       // error
auto u = 1_p +2;      // OK

То же относится к оператору точки, следующему за пользовательским целочисленным литералом или литералом с плавающей точкой:

#include <chrono>

using namespace std::literals;

auto a = 4s.count();   // Error
auto b = 4s .count();  // OK
auto c = (4s).count(); // OK

В противном случае образуется единый некорректный токен числа препроцессора (например, 1.0_E+2.0 или 4s.count), из-за которого компиляция завершается ошибкой.

Ключевые слова

operator

Примеры

#include <algorithm>
#include <cstddef>
#include <iostream>
#include <numbers>
#include <string>

// used as conversion from degrees (input param) to radians (returned output)
constexpr long double operator""_deg_to_rad(long double deg)
{
    long double radians = deg * std::numbers::pi_v<long double> / 180;
    return radians;
}

// used with custom type
struct mytype
{
    unsigned long long m;
};

constexpr mytype operator""_mytype(unsigned long long n)
{
    return mytype{n};
}

// used for side-effects
void operator""_print(const char* str)
{
    std::cout << str << '\n';
}

#if __cpp_nontype_template_args < 201911

std::string operator""_x2 (const char* str, std::size_t)
{
    return std::string{str} + str;
}

#else // C++20 string literal operator template

template<std::size_t N>
struct DoubleString
{
    char p[N + N - 1]{};
    
    constexpr DoubleString(char const(&pp)[N])
    {
        std::ranges::copy(pp, p);
        std::ranges::copy(pp, p + N - 1);
    }
};

template<DoubleString A>
constexpr auto operator""_x2()
{
    return A.p;
}

#endif // C++20

int main()
{
    double x_rad = 90.0_deg_to_rad;
    std::cout << std::fixed << x_rad << '\n';
    
    mytype y = 123_mytype;
    std::cout << y.m << '\n';
    
    0x123ABC_print;
    std::cout << "abc"_x2 << '\n';
}

1.570796
123
0x123ABC
abcabc

Стандартная библиотека

В стандартной библиотеке определены следующие операторы литералов:

Отчеты об ошибках

Следующие отчеты об ошибках, изменяющие поведение, были ретроспективно применены к ранее опубликованным стандартам C++.