ellipsis-str8.h File Reference

#include <uchar.h>
#include <stdio.h>
#include <string.h>
#include "ellipsis-error.h"
#include <stddef.h>
#include <stdlib.h>
#include <stdint.h>

Include dependency graph for ellipsis-str8.h:

Go to the source code of this file.

Data Structures
struct	ellipsis‿str8
	A structure with a flexible array member of base type ellipsis‿str8‿base. More...

Macros
#define	ELLIPSIS_CONTRACT(COUNT, COND, ACTION, VERB, CSTR, CTYPE, ...)
#define	ELLIPSIS_CONTRACT_CHECK_STATIC(CTYPE, COND, CSTR, ...)
#define	ELLIPSIS_CONTRACT_ICE_OR_TRUE(...)
#define	ELLIPSIS_CONTRACT_IMPL(COUNT, COND, ACTION, VERB, CSTR, CTYPE, ...)
#define	ELLIPSIS_CONTRACT_VIOLATION(COUNT, VERB, CTYPE, CSTR, ...)
#define	ELLIPSIS_STR8_CONSTRUCT(S)
	Construct a ellipsis‿str8 from a string literal and return a pointer to it.
#define	ELLIPSIS_STR8_LITERAL   ELLIPSIS_STR8_LITERAL_LOCAL
#define	ELLIPSIS_STR8_LITERAL_GLOBAL(N, ...)
#define	ELLIPSIS_STR8_LITERAL_LOCAL(N, ...)
	Create a literal of type ellipsis‿str8, where the array component is initialized with the arguments.
#define	ELLIPSIS_STR8_OVERLAY(N)
#define	ELLIPSIS_STR8_STATIC(N, ...)
#define	ELLIPSIS_STR8_STRING_LITERAL(S)
	Construct a ellipsis‿str8 const from a string literal.
#define	ELLIPSIS_TEST_ICE(...)   (false ? ELLIPSIS_TO_VOIDS(__VA_ARGS__) : (ellipsis‿contracts‿is_ice*)nullptr)
#define	ELLIPSIS_TO_VOIDS(...)   ((void*)((uintptr_t)((__VA_ARGS__)-(__VA_ARGS__))))
#define	STRINGIFY(...)   STRINGIFY_(__VA_ARGS__)
#define	STRINGIFY_(...)   #__VA_ARGS__

Typedefs
typedef struct ellipsis‿contracts‿is_ice	ellipsis‿contracts‿is_ice

Variables
thread_local bool volatile	ellipsis‿contracts‿ignore‿dynamic
thread_local bool volatile	ellipsis‿contracts‿proceed‿dynamic
thread_local bool volatile	ellipsis‿contracts‿verbose‿dynamic

Macro Definition Documentation

ELLIPSIS_CONTRACT

#define ELLIPSIS_CONTRACT	(		COUNT,
			COND,
			ACTION,
			VERB,
			CSTR,
			CTYPE,
			...
	)

Value:

 \
 do { \
 _Generic( \
 ELLIPSIS_TEST_ICE(COND), \
 ellipsis‿contracts‿is_ice*: ELLIPSIS_CONTRACT_CHECK_STATIC(CTYPE, COND, CSTR __VA_OPT__(,) __VA_ARGS__), \
 default: ELLIPSIS_CONTRACT_IMPL(COUNT, COND, ACTION, VERB, CSTR, CTYPE __VA_OPT__(,) __VA_ARGS__));\
 } while(false)

ELLIPSIS_CONTRACT_CHECK_STATIC

#define ELLIPSIS_CONTRACT_CHECK_STATIC	(		CTYPE,
			COND,
			CSTR,
			...
	)

Value:

 ({\
 static_assert(ELLIPSIS_CONTRACT_ICE_OR_TRUE(COND), \
 "compile time violation of " CTYPE " " CSTR \
 __VA_OPT__(", ") __VA_ARGS__ );\
 })

ELLIPSIS_CONTRACT_ICE_OR_TRUE

#define ELLIPSIS_CONTRACT_ICE_OR_TRUE

(

...

)

Value:

 _Generic( \
 ELLIPSIS_TEST_ICE(__VA_ARGS__), \
 ellipsis‿contracts‿is_ice*: (__VA_ARGS__), \
 default: true)

ELLIPSIS_CONTRACT_IMPL

#define ELLIPSIS_CONTRACT_IMPL	(		COUNT,
			COND,
			ACTION,
			VERB,
			CSTR,
			CTYPE,
			...
	)

Value:

(((false) || (COND)) \
 ? (void)0 \
 : (ELLIPSIS_CONTRACT_VIOLATION(COUNT, VERB, CTYPE, CSTR __VA_OPT__(,) __VA_ARGS__) \
 , ((false) \
 ? (void)0 \
 : ACTION())))

ELLIPSIS_CONTRACT_VIOLATION

#define ELLIPSIS_CONTRACT_VIOLATION	(		COUNT,
			VERB,
			CTYPE,
			CSTR,
			...
	)

Value:

({\
 static char const contract_format_ ## COUNT[]  = \
 __FILE__ ":" STRINGIFY(__LINE__) ": violation of " CTYPE " `" CSTR "`" __VA_OPT__(", ") __VA_ARGS__ "\n";\
 (VERB \
 ? fputs(contract_format_ ## COUNT, stderr) \
 : 0);\
 })

ELLIPSIS_STR8_CONSTRUCT

#define ELLIPSIS_STR8_CONSTRUCT (   S )

related

Construct a ellipsis‿str8 from a string literal and return a pointer to it.

ELLIPSIS_STR8_LITERAL

#define ELLIPSIS_STR8_LITERAL   ELLIPSIS_STR8_LITERAL_LOCAL

ELLIPSIS_STR8_LITERAL_GLOBAL

#define ELLIPSIS_STR8_LITERAL_GLOBAL	(		N,
			...
	)

Value:

 ((const ELLIPSIS_STR8_OVERLAY( \
 sizeof((ellipsis‿str8‿base[]){__VA_ARGS__ }) \
 /sizeof(ellipsis‿str8‿base))) \
 {\
 .length  = (N), \
 .array = {__VA_ARGS__ }, \
 }.fa)

ELLIPSIS_STR8_LITERAL_LOCAL

#define ELLIPSIS_STR8_LITERAL_LOCAL (   N,   ...  )

related

Create a literal of type ellipsis‿str8, where the array component is initialized with the arguments.

This results in an lvalue of type ellipsis‿str8 for an object that has static storage duration and that is const-qualified.

Most functions that are provided for ellipsis‿str8 need to be able to reallocate the structure, so they will produce an error on a literal that is created with this macro. A notable exception of this is ellipsis‿str8‿delete which will just do nothing on such an object.

Remarks

Because of current restrictions in C23 that constexpr compound literals may not be of union type, this is not yet provided as constexpr.

ELLIPSIS_STR8_OVERLAY

#define ELLIPSIS_STR8_OVERLAY

(

N

)

Value:

 union {\
 struct {\
 size_t const length;\
 size_t const padding;\
 unsigned const :(offsetof(ellipsis‿str8, array)-2*sizeof(size_t));\
 ellipsis‿str8‿base array[N];\
 };\
 ellipsis‿str8 fa;\
 }

ELLIPSIS_STR8_STATIC

#define ELLIPSIS_STR8_STATIC	(		N,
			...
	)

Value:

 (({\
 static const ELLIPSIS_STR8_OVERLAY( \
 sizeof((ellipsis‿str8‿base[]){__VA_ARGS__ }) \
 /sizeof(ellipsis‿str8‿base)) \
 __LOC_ID_1_1 = {\
 .length  = (N), \
 .array = {__VA_ARGS__ }, \
 };&__LOC_ID_1_1;})->fa)

ELLIPSIS_STR8_STRING_LITERAL

#define ELLIPSIS_STR8_STRING_LITERAL (   S )

related

Construct a ellipsis‿str8 const from a string literal.

Use this as in

ellipsis‿str8 const* always  = &ELLIPSIS_STR8_STRING_LITERAL("always");

or

ellipsis‿str8 const* ulways  = &ELLIPSIS_STR8_STRING_LITERAL(u8"ulways");

Remarks

Other than for ELLIPSIS_STR8_CONSTRUCT() the resulting lvalue has static storage duration and is const-qualified.

The argument should be an ordinary or UTF-8 string literal.

ELLIPSIS_TEST_ICE

#define ELLIPSIS_TEST_ICE

(

...

)

(false ? ELLIPSIS_TO_VOIDS(__VA_ARGS__) : (ellipsis‿contracts‿is_ice*)nullptr)

ELLIPSIS_TO_VOIDS

#define ELLIPSIS_TO_VOIDS

(

...

)

((void*)((uintptr_t)((__VA_ARGS__)-(__VA_ARGS__))))

STRINGIFY

#define STRINGIFY

(

...

)

STRINGIFY_(__VA_ARGS__)

STRINGIFY_

#define STRINGIFY_

(

...

)

#__VA_ARGS__

Typedef Documentation

ellipsis‿contracts‿is_ice

typedef struct ellipsis‿contracts‿is_ice ellipsis‿contracts‿is_ice

Variable Documentation

ellipsis‿contracts‿ignore‿dynamic

thread_local bool volatile ellipsis‿contracts‿ignore‿dynamic

extern

ellipsis‿contracts‿proceed‿dynamic

thread_local bool volatile ellipsis‿contracts‿proceed‿dynamic

extern

ellipsis‿contracts‿verbose‿dynamic

thread_local bool volatile ellipsis‿contracts‿verbose‿dynamic

extern