stack_frame.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include <vector>
#include "../iequatable.h"
#include "../object.h"
#include "../string.h"
 
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(size_t skip_frame);
      explicit stack_frame(bool need_file_info);
      stack_frame(size_t skip_frame, bool need_file_info);
      stack_frame(const xtd::string& file_name, uint32 line_number);
      stack_frame(const xtd::string& file_name, uint32 line_number, const xtd::string& method_name);
      stack_frame(const xtd::string& file_name, uint32 line_number, const xtd::string& method_name, uint32 column_number);
      stack_frame(const xtd::string& file_name, uint32 line_number, uint32 column_number);
      stack_frame(const xtd::string& file_name, uint32 line_number, const xtd::string& method_name, uint32 column_number, uint32 offset);
      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 uint32 OFFSET_UNKNOWN = 4294967295u;
      
      
      using object::equals;
      bool equals(const stack_frame& sf) const noexcept override;
      
      virtual uint32 get_file_column_number() const noexcept;
      
      virtual uint32 get_file_line_number() const noexcept;
      
      virtual const xtd::string& get_file_name() const noexcept;
      
      virtual const xtd::string& get_method() const noexcept;
      
      virtual uint32 get_offset() const noexcept;
      
      xtd::string to_string() const noexcept override;
      
    private:
      friend class stack_trace;
      // Do not use xtd::collections::generic::list because xtd::diagnostics::stack_frame is use by xtd::system_exception and
      // xtd::collections::generic::list use xtd::argument_exception.
      static std::vector<stack_frame> get_stack_frames(const xtd::string& str, size_t skip_frames, bool need_file_info) noexcept;
      
      xtd::string file_name_;
      uint32 file_line_number_ = 0;
      xtd::string method_name_;
      uint32 file_column_number_ = 0;
      uint32 offset_ = OFFSET_UNKNOWN;
    };
  }
}
 
#include "current_stack_frame.h"