debug.h File Reference

Provides macros and functions for debugging output in Gama. More...

#include "3d/position.h"
#include "color.h"
#include "position.h"
#include <stdio.h>
#include "3d/mesh.h"

Go to the source code of this file.

Macros
#define	gmdi(fn, obj)
	Macro to print debug information for an object without a newline.
#define	gmdn(fn, obj)
	Macro to print debug information for an object with a newline.
#define	gmd(fn, obj, e)
	Generic macro to print debug information for an object.

Functions
int	gmd_color (char *s, size_t n, gmColor c)
	Formats a gmColor into a human-readable string for debugging.
int	gmd_pos3 (char *s, size_t n, gm3Pos p)
	Formats a gm3Pos (3D position) into a human-readable string for debugging.
int	gmd_pos2 (char *s, size_t n, gmPos p)
	Formats a gmPos (2D position) into a human-readable string for debugging.
int	gmd_mesh (char *s, size_t n, gm3Mesh m)
	Formats a gm3Mesh into a human-readable string for debugging.

Detailed Description

Provides macros and functions for debugging output in Gama.

This file offers utilities to print the state of various Gama data structures to the console, aiding in debugging and development.

Macro Definition Documentation

gmd

#define gmd	(		fn,
			obj,
			e )

Value:

  do {                                                                         \
    char __gmd_str[200];                                                       \
    /* Use sizeof the buffer, not sizeof the number 200 */                     \
    gmd_##fn(__gmd_str, sizeof(__gmd_str), obj);                               \
    printf("<%s>%s", __gmd_str, e);                                            \
  } while (0)

Generic macro to print debug information for an object.

This macro calls a specific gmd_ formatting function, prints the result to stdout, and appends an optional end string.

Parameters

fn	The debug formatting function to use (e.g., color, pos2, pos3, mesh).
obj	The object to print debug information for.
e	An optional string to append after the debug output (e.g., "\n").

gmdi

#define gmdi	(		fn,
			obj )

Value:

gmd(fn, obj, "")

Macro to print debug information for an object without a newline.

Parameters

fn	The debug formatting function (e.g., color, pos2, pos3, mesh).
obj	The object to print.

gmdn

#define gmdn	(		fn,
			obj )

Value:

gmd(fn, obj, "\n")

Macro to print debug information for an object with a newline.

Parameters

fn	The debug formatting function (e.g., color, pos2, pos3, mesh).
obj	The object to print.

Function Documentation

gmd_color()

int gmd_color	(	char *	s,
		size_t	n,
		gmColor	c )

Formats a gmColor into a human-readable string for debugging.

Parameters

s	The buffer to write the formatted string into.
n	The size of the buffer.
c	The gmColor to format.

Returns

The number of characters written to the buffer.

gmd_mesh()

int gmd_mesh	(	char *	s,
		size_t	n,
		gm3Mesh	m )

Formats a gm3Mesh into a human-readable string for debugging.

Parameters

s	The buffer to write the formatted string into.
n	The size of the buffer.
m	The gm3Mesh to format.

Returns

The number of characters written to the buffer.

gmd_pos2()

int gmd_pos2	(	char *	s,
		size_t	n,
		gmPos	p )

Formats a gmPos (2D position) into a human-readable string for debugging.

Parameters

s	The buffer to write the formatted string into.
n	The size of the buffer.
p	The gmPos to format.

Returns

The number of characters written to the buffer.

gmd_pos3()

int gmd_pos3	(	char *	s,
		size_t	n,
		gm3Pos	p )

Formats a gm3Pos (3D position) into a human-readable string for debugging.

Parameters

s	The buffer to write the formatted string into.
n	The size of the buffer.
p	The gm3Pos to format.

Returns

The number of characters written to the buffer.