source_location.md

source_location

• source_location[meta header]
• class[meta id-type]
• std[meta namespace]
• cpp20[meta cpp]

namespace std {
  struct source_location {
    static consteval source_location current() noexcept;
    constexpr source_location() noexcept;

    constexpr uint_least32_t line() const noexcept;
    constexpr uint_least32_t column() const noexcept;
    constexpr const char* file_name() const noexcept;
    constexpr const char* function_name() const noexcept;

  private:
    uint_least32_t line_;          // exposition only
    uint_least32_t column_;        // exposition only
    const char* file_name_;        // exposition only
    const char* function_name_;    // exposition only
  };
}

• consteval[link /lang/cpp20/immediate_functions.md]
• uint_least32_t[link /reference/cstdint/uint_least32_t.md]

概要

source_location は、ソースコード上の位置を表す。

この型は要件Cpp17DefaultConstructible、Cpp17CopyConstructible、 Cpp17CopyAssignable、Cpp17Destructibleを満たす。

メンバ関数

名前	説明	対応バージョン
(constructor)	コンストラクタ	C++20
line	行番号を返す	C++20
column	列番号を返す	C++20
file_name	ファイル名を返す	C++20
function_name	関数名を返す	C++20

静的メンバ関数

名前	説明	対応バージョン
current	この関数の呼び出し元のソースコード上の位置を返す	C++20

例

#include <iostream>
#include <source_location>

int main()
{
  const std::source_location location = std::source_location::current();
  std::cout << location.line() << std::endl;
  std::cout << location.column() << std::endl;
  std::cout << location.file_name() << std::endl;
  std::cout << location.function_name() << std::endl;
}

• current()[link source_location/current.md]
• location.line()[link source_location/line.md]
• location.column()[link source_location/column.md]
• location.file_name()[link source_location/file_name.md]
• location.function_name()[link source_location/function_name.md]

出力例

6
71
prog.cc
int main()

この機能が必要になった背景・経緯

ソースコード上の位置情報はデバッグにおいて重要である。

C言語から引き継いだ定義済みマクロ__LINE__、__FILE__や事前定義識別子__func__で ソースコード上の位置情報を取得できるが、それらをまとめて取得し、格納しておく方法は標準では提供されていなかったため、 source_locationが導入された。

バージョン

言語

• C++20

処理系

• Clang: ??
• GCC: 11.1 [mark verified]
• Visual C++: ??

関連項目

• C++11 事前定義識別子__func__
• C++20 常に定数式評価するconsteval

参照

• P1208R6 Adopt source_location for C++20