Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-25 04:55:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Cleanup for doxygen

Browse source
This commit is contained in:
Justin Ethier 2017-02-23 17:48:43 -05:00
parent 6859cd2c2b
commit 0acd61e9be
1 changed files with 32 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
include/cyclone/types.h
View file

@ -70,11 +70,20 @@
// General constants // General constants
#define NANOSECONDS_PER_MILLISECOND 1000000 #define NANOSECONDS_PER_MILLISECOND 1000000
// Generic object type #define CYC_FIXNUM_MAX 1073741823
#define CYC_FIXNUM_MIN -1073741824
/**
* Generic object type
* \ingroup objects
*/
typedef void *object; typedef void *object;
// Define a tag for each possible type of object. /**
// Remember to update tag_names in runtime.c when adding new tags * Define a tag for each possible type of object.
* Remember to update tag_names in runtime.c when adding new tags
*\ingroup objects
*/
enum object_tag { enum object_tag {
boolean_tag = 0 // 0 boolean_tag = 0 // 0
, bytevector_tag // 1 , bytevector_tag // 1
@ -102,7 +111,10 @@ enum object_tag {
#define type_is_pair_prim(clo) \ #define type_is_pair_prim(clo) \
(type_of(clo) >= pair_tag) (type_of(clo) >= pair_tag)
// Define the size of object tags /**
* Defines the size of object tags
* \ingroup objects
*/
typedef unsigned char tag_type; typedef unsigned char tag_type;
/* GC data structures */ /* GC data structures */
@ -246,6 +258,11 @@ struct gc_thread_data_t {
#define type_of(obj) (((pair_type *) obj)->tag) #define type_of(obj) (((pair_type *) obj)->tag)
#define forward(obj) (((pair_type *) obj)->pair_car) #define forward(obj) (((pair_type *) obj)->pair_car)
/**
* \defgroup immediates Value Types
*/
/**@{*/
/** Define value types. /** Define value types.
* Depending on the underlying architecture, compiler, etc these types * Depending on the underlying architecture, compiler, etc these types
* have extra least significant bits that can be used to mark them as * have extra least significant bits that can be used to mark them as
@ -270,8 +287,12 @@ struct gc_thread_data_t {
#define is_value_type(x) ((unsigned long)(x) & (unsigned long)3) #define is_value_type(x) ((unsigned long)(x) & (unsigned long)3)
#define is_object_type(x) (x && !is_value_type(x)) #define is_object_type(x) (x && !is_value_type(x))
#define CYC_FIXNUM_MAX 1073741823 /**@}*/
#define CYC_FIXNUM_MIN -1073741824
/**
* \defgroup objects Object Types
*/
/**@{*/
/* Function type */ /* Function type */
@ -492,8 +513,9 @@ typedef bytevector_type *bytevector;
v.len = 0; \ v.len = 0; \
v.data = NULL; v.data = NULL;
/* Pair (cons) type */ /**
* Pair (cons) type
*/
typedef struct { typedef struct {
gc_header_type hdr; gc_header_type hdr;
tag_type tag; tag_type tag;
@ -669,6 +691,8 @@ typedef union {
bignum_type bignum_t; bignum_type bignum_t;
} common_type; } common_type;
/**@}*/
/* Utility functions */ /* Utility functions */
void **vpbuffer_realloc(void **buf, int *len); void **vpbuffer_realloc(void **buf, int *len);
void **vpbuffer_add(void **buf, int *len, int i, void *obj); void **vpbuffer_add(void **buf, int *len, int i, void *obj);