AStacktrace.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2024 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include <AUI/Common/AString.h>
#include <AUI/Common/AVector.h>
#include <variant>
#include <optional>
 
 
class API_AUI_CORE AStacktrace {
public:
    class Entry {
        friend class AStacktrace;
    private:
        void* mPtr;
        AOptional<AString> mFunctionName;
        AOptional<AString> mFileName;
        AOptional<unsigned> mLineNumber;
 
    public:
        explicit Entry(void* ptr) : mPtr(ptr), mFunctionName(std::nullopt) {}
 
        const AOptional<AString>& functionName() const noexcept {
            return mFunctionName;
        }
 
        const AOptional<AString>& fileName() const noexcept {
            return mFileName;
        }
 
        AOptional<unsigned> lineNumber() const noexcept {
            return mLineNumber;
        }
 
        void* ptr() const noexcept {
            return mPtr;
        }
    };
 
    using iterator = AVector<Entry>::iterator;
 
    AStacktrace(aui::range<iterator> range): mEntries(range.begin(), range.end()) {}
 
    aui::range<iterator> stripBeforeFunctionCall(void* pFunction, int maxAllowedOffsetInBytes = 50);
 
    AStacktrace(const AStacktrace&) = default;
    AStacktrace(AStacktrace&&) noexcept = default;
 
    void resolveSymbolsIfNeeded() const noexcept;
 
    [[nodiscard]]
    const AVector<Entry>& entries() const noexcept {
        return mEntries;
    }
 
    [[nodiscard]]
    auto begin() const noexcept {
        return mEntries.begin();
    }
 
    [[nodiscard]]
    auto end() const noexcept {
        return mEntries.end();
    }
 
    [[nodiscard]]
    auto rbegin() const noexcept {
        return mEntries.rbegin();
    }
 
    [[nodiscard]]
    auto rend() const noexcept {
        return mEntries.rend();
    }
 
    static AStacktrace capture(unsigned skipFrames = 0, unsigned maxFrames = 128) noexcept;
 
private:
    mutable AVector<Entry> mEntries;
    mutable bool mSymbolNamesResolved = false;
 
    explicit AStacktrace(AVector<Entry> entries) : mEntries(std::move(entries)) {}
};
 
inline std::ostream& operator<<(std::ostream& o, const AStacktrace& stacktrace) noexcept {
    stacktrace.resolveSymbolsIfNeeded();
    for (const auto& entry : stacktrace) {
        o << " - at " << entry.ptr();
        if (auto name = entry.functionName()) {
            o << " " << *name;
        }
        o << "(";
 
        if (auto filename = entry.fileName()) {
            o << *filename;
        } else {
            o << "?";
        }
        o << ":";
        if (auto line = entry.lineNumber()) {
            o << *line;
        } else {
            o << "?";
        }
 
        o << ")" << std::endl;
    }
    return o;
}