path: root/include/winapi/debug/call_stack.hpp

// Copyright (c) 2020 Egor Tensin <Egor.Tensin@gmail.com>
// This file is part of the "winapi-debug" project.
// For details, see https://github.com/egor-tensin/winapi-debug.
// Distributed under the MIT License.

#pragma once

#include "address.hpp"
#include "dbghelp.hpp"

#include <windows.h>

#include <array>
#include <cstddef>
#include <functional>
#include <ostream>
#include <string>

namespace winapi {

class CallStack {
public:
    static constexpr std::size_t frames_to_skip = 0;
    static constexpr std::size_t frames_to_capture = 62;

    // Imposed by CaptureStackBackTrace:
    static constexpr std::size_t max_length = 62;

    static_assert(frames_to_skip + frames_to_capture <= max_length,
                  "Call stack length is too large");

    static CallStack capture();

    using AddressCallback = std::function<bool(Address)>;
    bool for_each_address(const AddressCallback& callback) const;

    static std::string pretty_print_address(const DbgHelp& dbghelp, Address addr);

    void dump(std::ostream& os, const DbgHelp&) const;

    const std::array<Address, max_length> frames;
    const std::size_t length;

    const Address* begin() const { return frames.data(); }
    const Address* cbegin() const { return begin(); }
    const Address* end() const { return begin() + length; }
    const Address* cend() const { return end(); }

private:
    CallStack() = default;
};

} // namespace winapi