std::stackt...source_file(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

✨ NAME ✨

std::stacktrace_entry::source_file - std::stacktrace_entry::source_file

This is the page for the source_file member of std::stacktrace_entry, bestie β€” and the manual name up top is std::stackt...source_file(3) from the C++ Standard Libary manual. (Yes, that spelling is straight from the header. 😭) We're folding it in here instead of copy-pasting the header line, because we're cute like that. πŸ’…

🌸 Synopsis 🌸

std::string source_file() const;  (since C++23)

Okay so it returns the presumed or actual name of the source file that lexically contains the expression or statement whose evaluation is represented by *this, or an empty string on failure other than allocation failure, e.g. when *this is empty. 🫢

Either source_file returns the presumed source file name and source_line returns the presumed line number, or source_file returns the actual source file name and source_line returns the actual line number. periodt.

πŸŽ€ Parameters πŸŽ€

(none) β€” literally none, bestie. Cute and low-maintenance. πŸ’–

πŸ¦‹ Return value πŸ¦‹

The name of the source file specified above on success, an empty string on failure other than allocation failure. Slay.

😭 Exceptions 😭

Throws std::bad_alloc if memory for the internal data structures or the resulting string cannot be allocated. So if allocation says no, it's giving std::bad_alloc. πŸ’€

πŸ”₯ Notes πŸ”₯

The presumed name of the source file is what the predefined macro __FILE__ expands to, and it can be changed by the #line directive. iykyk.

This section is incomplete Reason: definition of "actual name" is missing (LWG issue 3507)

Custom allocators support for this function is not provided, because the implementations usually require platform specific allocations, system calls and a lot of CPU intensive work, while a custom allocator does not provide benefits for this function as the platform specific operations take an order of magnitude more time than the allocation. No cap, that's the whole note. ✨

🧚 Example 🧚

This section is incomplete Reason: no example

No example bestie, the example section is literally incomplete. 😭

πŸ‘‘ See also πŸ‘‘

  • file_name β€” return the file name represented by this object (public member function of std::source_location)

🌈 Categories 🌈

  • Todo with reason
  • Todo no example

xoxo, your Unix bestie πŸ’– β€” footer source/version/date, folded into this cute sign-off: http://cppreference.com, 2024.06.10, and page std::stackt...source_file(3). Bye bestie, go read your stack traces responsibly. 🌸

πŸ“¦ where this page comes from