std::is_debugger_present(3)

💅 NAME 💅

std::is_debugger_present - std::is_debugger_present

okay bestie, welcome to std::is_debugger_present(3) from the C++ Standard Libary manual (yes, that spelling is literally in the header — keeping the facts exactly as they are). This page is about one function and she's lowkey iconic: she checks whether your program is running with a debugger present. 🫶

✨ Synopsis ✨

Defined in header <debugging>
bool is_debugger_present() noexcept;  (since C++26)

Attempts to determine if the program is being executed with debugger present. Like, is somebody watching? 👀

By default, the behavior of this function is completely implementation-defined. A C++ program may provide the definition of this signature to replace the behavior of this function. So the default vibe is “your implementation decides”, but you can provide your own definition of this exact signature and swap the behavior out. 💅

🌸 Return value 🌸

The default version returns true if, to the best of its knowledge, the program is executed under a debugger.

🦋 Notes 🦋

The intent of this function is allowing:

• printing out extra output to help diagnose problems
• executing extra test code
• displaying an extra user interface to help in debugging
• etc.

This function standardizes many similar existing facilities:

• under_debugger from boost.test
• IsDebuggerPresent() from Win32 API
• isDebuggerActive from Catch2
• IsDebuggerPresent from Unreal Engine
• etc.

Feature-test macro deets, and yes we're keeping every value:

• __cpp_lib_debugging — 202311L — (C++26) — Debugging support library
• __cpp_lib_debugging — 202403L — (C++26) — Replaceable std::is_debugger_present

🎀 Example 🎀

This section is incomplete

Reason: no example

no example yet, bestie — the page literally says so. 😭

👑 See also 👑

• breakpoint — pauses the running program when called (C++26) (function)
• breakpoint_if_debugging — calls std::breakpoint if std::is_debugger_present returns true (C++26) (function)

🍓 Category 🍓

• Todo no example

---

source/version + date sign-off: http://cppreference.com, 2024.06.10, page std::is_debugger_present(3) — that's the footer, and we ate. 💖✨