cpptrace/include/ctrace/ctrace.h

#ifndef CTRACE_H
#define CTRACE_H

#include <stddef.h>
#include <stdint.h>
#include <stdio.h>

#ifdef _WIN32
#define CPPTRACE_EXPORT_ATTR __declspec(dllexport)
#define CPPTRACE_IMPORT_ATTR __declspec(dllimport)
#else
#define CPPTRACE_EXPORT_ATTR __attribute__((visibility("default")))
#define CPPTRACE_IMPORT_ATTR __attribute__((visibility("default")))
#endif

#ifdef CPPTRACE_STATIC_DEFINE
#  define CPPTRACE_EXPORT
#  define CPPTRACE_NO_EXPORT
#else
#  ifndef CPPTRACE_EXPORT
#    ifdef cpptrace_lib_EXPORTS
        /* We are building this library */
#      define CPPTRACE_EXPORT CPPTRACE_EXPORT_ATTR
#    else
        /* We are using this library */
#      define CPPTRACE_EXPORT CPPTRACE_IMPORT_ATTR
#    endif
#  endif
#endif

#if defined(__cplusplus)
 #define CTRACE_BEGIN_DEFINITIONS extern "C" {
 #define CTRACE_END_DEFINITIONS }
#else
 #define CTRACE_BEGIN_DEFINITIONS
 #define CTRACE_END_DEFINITIONS
#endif

#ifdef _MSC_VER
 #define CTRACE_FORCE_NO_INLINE __declspec(noinline)
#else
 #define CTRACE_FORCE_NO_INLINE __attribute__((noinline))
#endif

#ifdef _MSC_VER
 #define CTRACE_FORCE_INLINE __forceinline
#elif defined(__clang__) || defined(__GNUC__)
 #define CTRACE_FORCE_INLINE __attribute__((always_inline)) inline
#else
 #define CTRACE_FORCE_INLINE inline
#endif

/* See `CPPTRACE_PATH_MAX` for more info. */
#define CTRACE_PATH_MAX 4096

CTRACE_BEGIN_DEFINITIONS

    typedef struct ctrace_raw_trace    ctrace_raw_trace;
    typedef struct ctrace_object_trace ctrace_object_trace;
    typedef struct ctrace_stacktrace   ctrace_stacktrace;

    /* Represents a boolean value, ensures a consistent ABI. */
    typedef int8_t ctrace_bool;
    /* A type that can represent a pointer, alias for `uintptr_t`. */
    typedef uintptr_t ctrace_frame_ptr;
    typedef struct ctrace_object_frame      ctrace_object_frame;
    typedef struct ctrace_stacktrace_frame  ctrace_stacktrace_frame;
    typedef struct ctrace_safe_object_frame ctrace_safe_object_frame;

    /* Type-safe null-terminated string wrapper */
    typedef struct {
        const char* data;
    } ctrace_owning_string;

    struct ctrace_object_frame {
        ctrace_frame_ptr raw_address;
        ctrace_frame_ptr obj_address;
        const char* obj_path;
    };

    struct ctrace_stacktrace_frame {
        ctrace_frame_ptr raw_address;
        ctrace_frame_ptr object_address;
        uint32_t line;
        uint32_t column;
        const char* filename;
        const char* symbol;
        ctrace_bool is_inline;
    };

    struct ctrace_safe_object_frame {
        ctrace_frame_ptr raw_address;
        ctrace_frame_ptr relative_obj_address;
        char object_path[CTRACE_PATH_MAX + 1];
    };

    struct ctrace_raw_trace {
        ctrace_frame_ptr* frames;
        size_t count;
    };

    struct ctrace_object_trace {
        ctrace_object_frame* frames;
        size_t count;
    };

    struct ctrace_stacktrace {
        ctrace_stacktrace_frame* frames;
        size_t count;
    };

    /* ctrace::string: */
    CPPTRACE_EXPORT ctrace_owning_string ctrace_generate_owning_string(const char* raw_string);
    CPPTRACE_EXPORT void ctrace_free_owning_string(ctrace_owning_string* string);

    /* ctrace::generation: */
    CPPTRACE_EXPORT ctrace_raw_trace    ctrace_generate_raw_trace(size_t skip, size_t max_depth);
    CPPTRACE_EXPORT ctrace_object_trace ctrace_generate_object_trace(size_t skip, size_t max_depth);
    CPPTRACE_EXPORT ctrace_stacktrace   ctrace_generate_trace(size_t skip, size_t max_depth);

    /* ctrace::freeing: */
    CPPTRACE_EXPORT void ctrace_free_raw_trace(ctrace_raw_trace* trace);
    CPPTRACE_EXPORT void ctrace_free_object_trace(ctrace_object_trace* trace);
    CPPTRACE_EXPORT void ctrace_free_stacktrace(ctrace_stacktrace* trace);

    /* ctrace::resolve: */
    CPPTRACE_EXPORT ctrace_stacktrace   ctrace_resolve_raw_trace(const ctrace_raw_trace* trace);
    CPPTRACE_EXPORT ctrace_object_trace ctrace_resolve_raw_trace_to_object_trace(const ctrace_raw_trace* trace);
    CPPTRACE_EXPORT ctrace_stacktrace   ctrace_resolve_object_trace(const ctrace_object_trace* trace);

    /* ctrace::safe: */
    CPPTRACE_EXPORT size_t ctrace_safe_generate_raw_trace(ctrace_frame_ptr* buffer, size_t size, size_t skip, size_t max_depth);
    CPPTRACE_EXPORT void ctrace_get_safe_object_frame(ctrace_frame_ptr address, ctrace_safe_object_frame* out);
    CPPTRACE_EXPORT ctrace_bool ctrace_can_signal_safe_unwind(void);
    CPPTRACE_EXPORT ctrace_bool ctrace_can_get_safe_object_frame(void);

    /* ctrace::io: */
    CPPTRACE_EXPORT ctrace_owning_string ctrace_stacktrace_to_string(const ctrace_stacktrace* trace, ctrace_bool use_color);
    CPPTRACE_EXPORT void ctrace_print_stacktrace(const ctrace_stacktrace* trace, FILE* to, ctrace_bool use_color);

    /* ctrace::utility: */
    CPPTRACE_EXPORT ctrace_owning_string ctrace_demangle(const char* mangled);
    CPPTRACE_EXPORT int ctrace_stdin_fileno(void);
    CPPTRACE_EXPORT int ctrace_stderr_fileno(void);
    CPPTRACE_EXPORT int ctrace_stdout_fileno(void);
    CPPTRACE_EXPORT ctrace_bool ctrace_isatty(int fd);

    CPPTRACE_EXPORT ctrace_object_frame ctrace_get_object_info(const ctrace_stacktrace_frame* frame);

    /* ctrace::config: */
    typedef enum {
        /* Only minimal lookup tables */
        ctrace_prioritize_memory = 0,
        /* Build lookup tables but don't keep them around between trace calls */
        ctrace_hybrid = 1,
        /* Build lookup tables as needed */
        ctrace_prioritize_speed = 2
    } ctrace_cache_mode;
    CPPTRACE_EXPORT void ctrace_set_cache_mode(ctrace_cache_mode mode);
    CPPTRACE_EXPORT void ctrace_enable_inlined_call_resolution(ctrace_bool enable);

CTRACE_END_DEFINITIONS

#endif