stack_frame.hpp

Go to the documentation of this file.

#pragma once
 
#include "source_location.hpp"
#include "../core_export.hpp"
#include "../iequatable.hpp"
#include "../null_ptr.hpp"
#include "../object.hpp"
#include "../ptr.hpp"
#include "../usize.hpp"
#define __XTD_CORE_INTERNAL__
#include "../internal/__string_definitions.hpp"
#undef __XTD_CORE_INTERNAL__
#include <limits>

namespace xtd {
  namespace diagnostics {
    class stack_trace;
    
    class core_export_ stack_frame : public xtd::object, public xtd::iequatable<stack_frame> {
    public:
    
      
      stack_frame();
      explicit stack_frame(xtd::usize skip_frame);
      explicit stack_frame(bool need_file_info);
      stack_frame(xtd::usize skip_frame, bool need_file_info);
      stack_frame(const xtd::string& file_name, xtd::usize line_number);
      stack_frame(const xtd::string& file_name, xtd::usize line_number, const xtd::string& method_name);
      stack_frame(const xtd::string& file_name, xtd::usize line_number, const xtd::string& method_name, xtd::usize column_number);
      stack_frame(const xtd::string& file_name, xtd::usize line_number, xtd::usize column_number);
      stack_frame(const xtd::string& file_name, xtd::usize line_number, const xtd::string& method_name, xtd::usize column_number, xtd::usize offset);
      stack_frame(const xtd::diagnostics::source_location& source_location); // Not explicit by design.
      stack_frame(const xtd::diagnostics::source_location& source_location, xtd::usize offset);
      stack_frame(xtd::null_ptr frame); // Not explicit by design.
      stack_frame(const xtd::diagnostics::stack_frame&) = default;
      stack_frame(xtd::diagnostics::stack_frame&&) = default;
      auto operator =(const xtd::diagnostics::stack_frame&) -> stack_frame& = default;
      auto operator =(xtd::diagnostics::stack_frame&&) -> stack_frame& = default;
      
      
      [[nodiscard]] static auto empty() noexcept -> xtd::diagnostics::stack_frame;
      
      static constexpr xtd::usize OFFSET_UNKNOWN = std::numeric_limits<xtd::usize>::max();
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const xtd::diagnostics::stack_frame& other) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::usize override;
      
      [[nodiscard]] virtual auto get_file_column_number() const noexcept -> xtd::usize;
      
      [[nodiscard]] virtual auto get_file_line_number() const noexcept -> xtd::usize;
      
      [[nodiscard]] virtual auto get_file_name() const noexcept -> const xtd::string&;
      
      [[nodiscard]] virtual auto get_method() const noexcept -> const xtd::string&;
      
      [[nodiscard]] virtual auto get_native_offset() const noexcept -> xtd::usize;
      
      [[nodiscard]] virtual auto get_offset() const noexcept -> xtd::usize;
      
      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
      
      
      [[nodiscard]] static auto current(const xtd::diagnostics::source_location& value = xtd::diagnostics::source_location::current()) noexcept -> xtd::diagnostics::stack_frame;
      
    private:
      friend class stack_trace;
      static auto get_stack_frames(const xtd::string& str, xtd::usize skip_frames, bool need_file_info) noexcept;
      
      struct data;
      xtd::ptr<data> data_;
    };
  }
}