ref.h File Reference

#include <derive-c/core/namespace.h>
#include <derive-c/core/panic.h>
#include <derive-c/core/std/reflect.h>

Go to the source code of this file.

Macros
#define	DC_TRAIT_REFERENCABLE(SELF)
	The reference trait. For some objects references do not need to be the size of pointers.
#define	DC_TRAIT_REFERENCABLE_BY_PTR(SELF)
#define	DC_TRAIT_REFERENCABLE_SINGLETON(SELF, INSTANCE)

Macro Definition Documentation

DC_TRAIT_REFERENCABLE

#define DC_TRAIT_REFERENCABLE

(

SELF

)

Value:

    DC_REQUIRE_TYPE(SELF, ref);                                                                    \
    DC_STATIC_ASSERT(sizeof(NS(SELF, ref)) <= sizeof(SELF*),                                       \
                     "Reference type must be at most pointer sized");                              \
    DC_REQUIRE_METHOD(SELF*, NS(SELF, ref), deref, (NS(SELF, ref)))

The reference trait. For some objects references do not need to be the size of pointers.

• For singletons an empty struct is sufficient
• For a small (global) pool of objects, a smaller index can be used.

These are convertable to pointers for ease of use, but use less storage when stored.

Definition at line 13 of file ref.h.

#define DC_TRAIT_REFERENCABLE(SELF)                                                                \
    DC_REQUIRE_TYPE(SELF, ref);                                                                    \
    DC_STATIC_ASSERT(sizeof(NS(SELF, ref)) <= sizeof(SELF*),                                       \
                     "Reference type must be at most pointer sized");                              \
    DC_REQUIRE_METHOD(SELF*, NS(SELF, ref), deref, (NS(SELF, ref)))

DC_TRAIT_REFERENCABLE_BY_PTR

#define DC_TRAIT_REFERENCABLE_BY_PTR

(

SELF

)

Value:

    typedef SELF* NS(SELF, ref);                                                                   \
    DC_PUBLIC static SELF* NS(NS(SELF, ref), deref)(NS(SELF, ref) ref) { return ref; }             \
    DC_TRAIT_REFERENCABLE(SELF)

Definition at line 19 of file ref.h.

#define DC_TRAIT_REFERENCABLE_BY_PTR(SELF)                                                         \
    typedef SELF* NS(SELF, ref);                                                                   \
    DC_PUBLIC static SELF* NS(NS(SELF, ref), deref)(NS(SELF, ref) ref) { return ref; }             \
    DC_TRAIT_REFERENCABLE(SELF)

DC_TRAIT_REFERENCABLE_SINGLETON

#define DC_TRAIT_REFERENCABLE_SINGLETON	(		SELF,
			INSTANCE )

Value:

    DC_ZERO_SIZED(NS(SELF, ref));                                                                  \
    DC_PUBLIC static NS(SELF, ref) NS(SELF, get_ref)() { return (NS(SELF, ref)){}; }               \
    DC_PUBLIC static SELF* NS(NS(SELF, ref), deref)(NS(SELF, ref) /*ref*/) { return &INSTANCE; }   \
    DC_TRAIT_REFERENCABLE(SELF)

Definition at line 24 of file ref.h.

#define DC_TRAIT_REFERENCABLE_SINGLETON(SELF, INSTANCE)                                            \
    DC_ZERO_SIZED(NS(SELF, ref));                                                                  \
    DC_PUBLIC static NS(SELF, ref) NS(SELF, get_ref)() { return (NS(SELF, ref)){}; }               \
    DC_PUBLIC static SELF* NS(NS(SELF, ref), deref)(NS(SELF, ref) /*ref*/) { return &INSTANCE; }   \
    DC_TRAIT_REFERENCABLE(SELF)