ユーザ定義リテラル (C++11以上)

ユーザ定義の接尾辞を定義することによって、整数、浮動小数点、文字、文字列リテラルがユーザ定義型のオブジェクトを生成できるようにします。

[編集] 構文

ユーザ定義リテラルは以下の形式のいずれかの式です。

あるトークンがユーザ定義リテラルの構文にも普通のリテラルの構文にもマッチする場合、それは普通のリテラルであると仮定されます (つまり 123LL の LL をオーバーロードすることはできません)。

コンパイラがユーザ定義接尾辞 X を持つユーザ定義リテラルに遭遇したとき、 operator "" X という名前の関数を探して非修飾名の名前探索が行われます。 この探索で宣言が見付からない場合、プログラムは ill-formed です。 そうでなければ、

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; // operator "" _w(1.2L) を呼びます。
    u"one"_w; // operator "" _w(u"one", 3) を呼びます。
    12_w; // operator "" _w("12") を呼びます。
    "two"_w; // エラー。 適用可能なリテラル演算子がありません。
}

翻訳フェーズ6で文字列リテラルの連結が行われるとき、ユーザ定義リテラルも同様に連結されます。 ud-suffix は連結の目的に対しては無視されます。 ただし連結されたすべてのリテラルに対して現れてよい接尾辞はひとつだけです。

int main() {
    L"A" "B" "C"_x; // OK。 L"ABC"_x と同じ。
    "P"_x "Q" "R"_y;// エラー。 2つの異なる ud-suffix (_x と _y)。
}

[編集] リテラル演算子

ユーザ定義リテラルによって呼ばれる関数はリテラル演算子 (またはそれがテンプレートの場合はリテラル演算子テンプレート) と言います。 これは名前空間スコープの他の関数または関数テンプレートとまったく同様に宣言されます (フレンド関数や関数テンプレートの明示的実体化または特殊化であってもよく、または using 宣言によって導入されても構いません)。 ただし以下の制限があります。

この関数の名前は以下の2つの形式のいずれかです。

リテラル演算子がテンプレートの場合は、空の引数リストを持たなければならず、テンプレート引数をひとつだけ持つことができます。 このテンプレート引数は、以下のような要素型が char の非型テンプレートパラメータパック (この場合は数値リテラル演算子テンプレートと言います)

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

struct A { A(const char *); auto operator<=>(const A&) const = default; };
 
template<A a> A operator ""_a();

でなければなりません。

リテラル演算子には以下の引数リストのみが許されます。

デフォルト引数は使用できません。

C 言語リンケージは使用できません。

上記の制限以外は、リテラル演算子およびリテラル演算子テンプレートは通常の関数 (および関数テンプレート) であり、 inline または constexpr として宣言したり、内部または外部リンケージを持たせたり、アドレスを取ったりできます。

void operator "" _km(long double); // OK。 1.0_km に対して呼ばれます。
std::string operator "" _i18n(const char*, std::size_t); // OK
template <char...> double operator "" _π(); // OK
float operator ""_e(const char*); // OK
 
float operator ""Z(const char*); // エラー。 接尾辞はアンダースコアで始まらなければなりません。
double operator"" _Z(long double); // エラー。 アンダースコアと大文字で始まる名前はすべて
                                   // 予約されています。
double operator""_Z(long double); // OK。 _Z が予約されていても ""_Z は使用できます。

[編集] ノート

ユーザ定義リテラルが導入されたため、先行する文字列リテラルの後に空白がない固定幅の整数型のためのマクロ定数を使用するコードは無効になります。 例えば std::printf("%"PRId64"\n",INT64_MIN); は std::printf("%" PRId64"\n",INT64_MIN); に置き換える必要があります。

最長一致のために、 e、 E、 p および P (C++17以上) で終わるユーザ定義の整数および浮動小数点リテラルは、演算子 + または - が続くときは、ソースコード上でホワイトスペースまたは括弧で演算子を分離しなければなりません。

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;   // エラー
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;       // エラー
auto u = 1_p +2;      // OK

同じことが整数または浮動小数点ユーザ定義リテラルに続くドット演算子にも適用されます。

#include <chrono>
using namespace std::literals;
auto a = 4s.count();   // エラー
auto b = 4s .count();  // OK
auto c = (4s).count(); // OK

さもなければ、単一の無効なプリプロセッサ数値トークン (1.0_E+2.0 や 4s.count など) が形成され、コンパイルが失敗する原因になります。

[編集] 例

#include <iostream>
 
// 変換のために使用します
constexpr long double operator"" _deg ( long double deg )
{
    return deg * 3.14159265358979323846264L / 180;
}
 
// カスタム型のために使用します
struct mytype
{
    unsigned long long m;
};
constexpr mytype operator"" _mytype ( unsigned long long n )
{
    return mytype{n};
}
 
// 副作用のために使用します
void operator"" _print ( const char* str )
{
    std::cout << str;
}
 
int main(){
    double x = 90.0_deg;
    std::cout << std::fixed << x << '\n';
    mytype y = 123_mytype;
    std::cout << y.m << '\n';
    0x123ABC_print;
}

1.570796
123
0x123ABC

[編集] 標準ライブラリ

以下のリテラル演算子が標準ライブラリで定義されています。