std::basic_stacktrace

来自cppreference.com
< cpp‎ | utility
 
C++
 
诊断库
 
std::basic_stacktrace
 
在标头 <stacktrace> 定义
template<class Allocator >
class basic_stacktrace;
 (1) (C++23 起)
using stacktrace =
    std::basic_stacktrace<std::allocator<std::stacktrace_entry>>;
 (2) (C++23 起)
namespace pmr {

using stacktrace =
    std::basic_stacktrace<std::pmr::polymorphic_allocator<std::stacktrace_entry>>;

}
 (3) (C++23 起)
1)basic_stacktrace 类模板表示整个栈踪迹或其给定部分的快照。它满足知分配器容器(AllocatorAwareContainer) 、序列容器(SequenceContainer) 及可逆容器(ReversibleContainer) 的要求，但仅支持移动、复制、交换和 const 限定的顺序容器上的操作，并且比较函数的语义不同于对容器所要求的语义。
2) 使用默认 std::allocator 的 basic_stacktrace 的便利类型别名。
3) 使用多态分配器的 basic_stacktrace 的便利类型别名。

当前执行线程中的当前求值 x0 的调用序列，是求值的序列 (x0, ..., xn)，它使得对于 i≥0，xi 在函数调用 xi+1 之内。

栈踪迹 是调用序列的近似表示，由栈踪迹条目组成。

每个栈踪迹条目 表示栈踪迹中的一项求值。它由 C++ 标准库中的 std::stacktrace_entry 表示。

目录

[编辑]模板形参

Allocator - 用于获取/释放内存及构造/销毁该内存中的元素的分配器。此类型必须符合分配器(Allocator) 的要求。若 Allocator::value_type 不是 std::stacktrace_entry 则程序非良构。

[编辑]成员类型

成员类型 定义
value_typestd::stacktrace_entry
const_referenceconst value_type&
referencevalue_type&
const_iterator 实现定义的常量老式随机访问迭代器(LegacyRandomAccessIterator) 类型，实现 random_access_iterator
iteratorconst_iterator
reverse_iteratorstd::reverse_iterator<iterator>
reverse_const_iteratorstd::reverse_iterator<const_iterator>
difference_type 实现定义的有符号整数类型
size_type 实现定义的无符号整数类型
allocator_typeAllocator

[编辑]成员函数

 创建新的 basic_stacktrace
(公开成员函数)[编辑]
 销毁 basic_stacktrace
(公开成员函数)[编辑]
 赋值给 basic_stacktrace
(公开成员函数)[编辑]
[静态]
 获得当前栈踪迹或其给定部分
(公开静态成员函数)[编辑]
 返回关联的分配器
(公开成员函数)[编辑]
迭代器
返回指向起始的迭代器
(公开成员函数)[编辑]
 返回指向末尾的迭代器
(公开成员函数)[编辑]
 返回指向起始的逆向迭代器
(公开成员函数)[编辑]
 返回指向末尾的逆向迭代器
(公开成员函数)[编辑]
容量
检查 basic_stacktrace 是否为空
(公开成员函数)[编辑]
 返回栈踪迹条目的数量
(公开成员函数)[编辑]
 返回栈踪迹条目的最大可能数量
(公开成员函数)[编辑]
元素访问
访问指定的栈踪迹条目
(公开成员函数)[编辑]
 访问指定的栈踪迹条目，带边界检查
(公开成员函数)[编辑]
修改器
交换内容
(公开成员函数)[编辑]

[编辑]非成员函数

(C++23)
 比较两个 basic_stacktrace 值的大小与内容
(函数模板)
(C++23)
 特化 std::swap 算法
(函数模板)[编辑]
(C++23)
 返回拥有 basic_stacktrace 的描述的字符串
(函数模板)[编辑]
(C++23)
 进行 basic_stacktrace 的流输出
(函数模板)[编辑]

[编辑]辅助类

(C++23)
std::basic_stacktrace 的散列支持
(类模板特化)[编辑]
(C++23)
basic_stacktrace 的格式化支持
(类模板特化)[编辑]

[编辑]注解

提供了对自定义分配器的支持，以便在热路径上或嵌入式环境中使用 basic_stacktrace。用户可以在栈上或其他适合的位置分配 stacktrace_entry 对象。

std::basic_stacktrace 所拥有的 std::stacktrace_entry 对象序列是不可变的，而且要么为空，要么表示整个栈踪迹的一个连续区间。

当 std::basic_stacktrace 不可用时可以代之以使用 boost::stacktrace::basic_stacktrace（于 Boost.Stacktrace 中可用）。

功能特性测试宏 值标准功能特性
__cpp_lib_stacktrace202011L(C++23)栈踪迹库
__cpp_lib_formatters202302L(C++23)格式化 std::thread::id 和 std::stacktrace

[编辑]示例

使用 Compiler Explorer 获得的输出结果：msvc 和 gcc。

运行此代码
#include <iostream>#include <stacktrace>   int nested_func(int c){std::cout<< std::stacktrace::current()<<'\n';return c +1;}   int func(int b){return nested_func(b +1);}   int main(){std::cout<< func(777);}

可能的输出： 

// msvc 输出（以 '⤶' 箭头结尾的行被切分以适应宽度）： 0> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶ 31624-2ja1sf.8ytzw\example.cpp(6): output_s!nested_func+0x1F 1> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶ 31624-2ja1sf.8ytzw\example.cpp(12): output_s!func+0x15 2> C:\Users\ContainerAdministrator\AppData\Local\Temp\compiler-explorer-compiler20221122-⤶ 31624-2ja1sf.8ytzw\example.cpp(15): output_s!main+0xE 3> D:\a\_work\1\s\src\vctools\crt\vcstartup\src\startup\exe_common.inl(288): output_s!⤶ __scrt_common_main_seh+0x10C 4> KERNEL32!BaseThreadInitThunk+0x14 5> ntdll!RtlUserThreadStart+0x21 779   gcc output: 0# nested_func(int) at /app/example.cpp:7 1# func(int) at /app/example.cpp:13 2# at /app/example.cpp:18 3# at :0 4# at :0 5#   779

[编辑]参阅

(C++23)
 表示栈踪迹中求值的项
(类)[编辑]
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/utility/basic_stacktrace&oldid=99701”
close