stack_frame.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include <vector>
#include "source_location.hpp"
#include "../core_export.hpp"
#include "../iequatable.hpp"
#include "../object.hpp"
#include "../ptr.hpp"
#include "../size.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::size skip_frame);
      explicit stack_frame(bool need_file_info);
      stack_frame(xtd::size skip_frame, bool need_file_info);
      stack_frame(const xtd::string& file_name, xtd::size line_number);
      stack_frame(const xtd::string& file_name, xtd::size line_number, const xtd::string& method_name);
      stack_frame(const xtd::string& file_name, xtd::size line_number, const xtd::string& method_name, xtd::size column_number);
      stack_frame(const xtd::string& file_name, xtd::size line_number, xtd::size column_number);
      stack_frame(const xtd::string& file_name, xtd::size line_number, const xtd::string& method_name, xtd::size column_number, xtd::size offset);
      stack_frame(const xtd::source_location& source_location); // Not explicit by design.
      stack_frame(const xtd::source_location& source_location, xtd::size offset);
      stack_frame(xtd::null_ptr frame); // Not explicit by design.
      stack_frame(const stack_frame&) = default;
      stack_frame(stack_frame&&) = default;
      stack_frame& operator =(const stack_frame&) = default;
      stack_frame& operator =(stack_frame&&) = default;
      
      
      static stack_frame empty() noexcept;
      
      static constexpr xtd::size OFFSET_UNKNOWN = std::numeric_limits<xtd::size>::max();
      
      
      using object::equals;
      bool equals(const stack_frame& sf) const noexcept override;
      
      virtual xtd::size get_file_column_number() const noexcept;
      
      virtual xtd::size get_file_line_number() const noexcept;
      
      virtual const xtd::string& get_file_name() const noexcept;
      
      virtual const xtd::string& get_method() const noexcept;
      
      virtual xtd::size get_native_offset() const noexcept;
      
      virtual xtd::size get_offset() const noexcept;
      
      xtd::string to_string() const noexcept override;
      
      
      static stack_frame current(const xtd::source_location& value = xtd::source_location::current()) noexcept;
      
    private:
      friend class stack_trace;
      // Do not use xtd::collections::generic::list because xtd::diagnostics::stack_frame is use by xtd::exception and
      // xtd::collections::generic::list use xtd::argument_exception.
      static std::vector<stack_frame> get_stack_frames(const xtd::string& str, xtd::size skip_frames, bool need_file_info) noexcept;
      
      struct data;
      ptr<data> data_;      
    };
  }
}