stack_frame.h

Go to the documentation of this file.

#pragma once
#include <cstdint>
#include <limits>
#include "../object.h"
#include "../ustring.h"
 
namespace xtd {
  namespace diagnostics {
    class stack_trace;
    
    class stack_frame : public object {
    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::ustring& file_name, uint32_t line_number);
      stack_frame(const xtd::ustring& file_name, uint32_t line_number, const xtd::ustring& method_name);
      stack_frame(const xtd::ustring& file_name, uint32_t line_number, const xtd::ustring& method_name, uint32_t column_number);
      stack_frame(const xtd::ustring& file_name, uint32_t line_number, uint32_t column_number);
      stack_frame(const xtd::ustring& file_name, uint32_t line_number, const xtd::ustring& method_name, uint32_t column_number, uint32_t offset);
      stack_frame(const stack_frame&) = default;
      stack_frame(stack_frame&&) = default;
      stack_frame& operator=(const stack_frame&) = default;
      bool operator==(const stack_frame& sf) const {return file_name_ == sf.file_name_ && file_line_number_ == sf.file_line_number_ && method_name_ == sf.method_name_ && file_column_number_ == sf.file_column_number_ && offset_ == sf.offset_;}
      bool operator!=(const stack_frame& sf) const {return !operator==(sf);}
      
      static stack_frame empty() noexcept;
 
      virtual uint32_t get_file_column_number() const;
      
      virtual uint32_t get_file_line_number() const;
      
      virtual const xtd::ustring& get_file_name() const;
      
      virtual const xtd::ustring& get_method() const;
      
      virtual uint32_t get_offset() const;
      
      xtd::ustring to_string() const noexcept override;
 
      friend std::ostream& operator<<(std::ostream& os, const xtd::diagnostics::stack_frame& stack_frame) noexcept {return os << stack_frame.to_string();}
 
      static constexpr const uint32_t OFFSET_UNKNOWN = std::numeric_limits<uint32_t>::max();
      
    private:
      friend class stack_trace;
      static std::vector<stack_frame> get_stack_frames(const xtd::ustring& str, size_t skip_frames, bool need_file_info);
 
      xtd::ustring file_name_;
      uint32_t file_line_number_ = 0;
      xtd::ustring method_name_;
      uint32_t file_column_number_ = 0;
      uint32_t offset_ = OFFSET_UNKNOWN;
    };
  }
}
 
#define current_stack_frame_ \
xtd::diagnostics::stack_frame {__FILE__, __LINE__, __func__}
 
#define csf_ current_stack_frame_
 
#define add_current_stack_frame_(...) \
__VA_ARGS__ __VA_ARGS_COMMA__(__VA_ARGS__) current_stack_frame_