nm_trace_gen.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2014-2025 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
 
#ifndef NM_TRACE_GEN_H
#define NM_TRACE_GEN_H
 
#include <stdint.h>
#include "nm_trace.h"
 
/* ********************************************************* */
 
struct nm_trace_gen_rgb_s
{
  uint8_t r;
  uint8_t g;
  uint8_t b;
};
#define NM_TRACE_GEN_RGB(R, G, B) ((struct nm_trace_gen_rgb_s){ .r = R, .g = G, .b = B})
#define NM_TRACE_GEN_BLACK      NM_TRACE_GEN_RGB(0, 0, 0)
#define NM_TRACE_GEN_GREY       NM_TRACE_GEN_RGB(85, 85, 85)
#define NM_TRACE_GEN_WHITE      NM_TRACE_GEN_RGB(255, 255, 255)
#define NM_TRACE_GEN_RED        NM_TRACE_GEN_RGB(255, 0, 0)
#define NM_TRACE_GEN_GREEN      NM_TRACE_GEN_RGB(0, 255, 0)
#define NM_TRACE_GEN_BLUE       NM_TRACE_GEN_RGB(0, 0, 255)
#define NM_TRACE_GEN_LIGHTBROWN NM_TRACE_GEN_RGB(170, 130, 130)
#define NM_TRACE_GEN_PINK       NM_TRACE_GEN_RGB(255, 0, 255)
#define NM_TRACE_GEN_ORANGE     NM_TRACE_GEN_RGB(255, 160, 0)
#define NM_TRACE_GEN_YELLOW     NM_TRACE_GEN_RGB(255, 255, 0)
#define NM_TRACE_GEN_TEAL       NM_TRACE_GEN_RGB(0, 255, 255)
#define NM_TRACE_GEN_PURPLE     NM_TRACE_GEN_RGB(153, 25, 230)
 
/* ********************************************************* */
 
__PUK_SYM_INTERNAL
void nm_trace_gen_init(const char*trace_name);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_end(double end_time);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_comment(const char*p_text);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_container_type(const char*p_name, const char*p_short_name, const char*p_parent_type);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_container_add(double t, const char*p_name, const char*p_short_name, const char*p_type,
                                const char*p_parent, int leaf);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_container_add_string(double t, padico_string_t name, padico_string_t short_name,
                                       padico_string_t parent, const char*p_type, int leaf);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_link_type(const char*p_name, const char*p_short_name,
                            const char*p_cont_type, const char*p_src_type, const char*p_dest_type);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_link_start(double t, const char*p_link_type, const char*p_container,
                             const char*p_src, const char*p_dest, const char*p_value, padico_string_t p_key);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_link_end(double t, const char*p_link_type, const char*p_container,
                           const char*p_src, const char*p_dest, const char*p_value, padico_string_t p_key);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_state_type(const char*p_name, const char*p_short_name, const char*p_cont_type);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_state_set(double t, const char*p_state_type, const char*p_cont_name, const char*p_state_name);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_entity_declare(const char*p_name, const char*p_short_name, const char*p_cont_type, struct nm_trace_gen_rgb_s rgb);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_var_type(const char*p_name, const char*p_short_name, const char*p_cont_type);
 
__PUK_SYM_INTERNAL
void nm_trace_gen_var_set(double t, const char*p_var_name, const char*p_cont_name, int value);
 
 
#endif /* NM_TRACE_GEN_H */