Utility for including binary files. More...

#include <limits.h>

Include dependency graph for incbin.h:

Macros
#define	INCBIN_ALIGNMENT_INDEX 3

#define	INCBIN_ALIGN_SHIFT_0 1

#define	INCBIN_ALIGN_SHIFT_1 2

#define	INCBIN_ALIGN_SHIFT_2 4

#define	INCBIN_ALIGN_SHIFT_3 8

#define	INCBIN_ALIGN_SHIFT_4 16

#define	INCBIN_ALIGN_SHIFT_5 32

#define	INCBIN_ALIGN_SHIFT_6 64

#define	INCBIN_ALIGNMENT

#define	INCBIN_STR(X)

#define	INCBIN_STRINGIZE(X)

#define	INCBIN_CAT(X, Y)

#define	INCBIN_CONCATENATE(X, Y)

#define	INCBIN_EVAL(X)

#define	INCBIN_INVOKE(N, ...)

#define	INCBIN_VA_ARG_COUNTER(_1, _2, _3, N, ...)

#define	INCBIN_VA_ARGC(...)

#define	INCBIN_MACRO ".incbin"

#define	INCBIN_ALIGN __attribute__((aligned(INCBIN_ALIGNMENT)))

#define	INCBIN_ALIGN_HOST ".align " INCBIN_STRINGIZE(INCBIN_ALIGNMENT) "\n"

#define	INCBIN_ALIGN_BYTE ".align 1\n"

#define	INCBIN_EXTERNAL extern

#define	INCBIN_CONST const

#define	INCBIN_OUTPUT_SECTION ".rodata"
	Optionally override the linker section into which size and data is emitted.

#define	INCBIN_OUTPUT_DATA_SECTION INCBIN_OUTPUT_SECTION
	Optionally override the linker section into which data is emitted.

#define	INCBIN_OUTPUT_SIZE_SECTION INCBIN_OUTPUT_SECTION
	Optionally override the linker section into which size is emitted.

#define	INCBIN_SECTION ".section " INCBIN_OUTPUT_SECTION "\n"

#define	INCBIN_GLOBAL(NAME)

#define	INCBIN_INT ".int "

#define	INCBIN_MANGLE ""

#define	INCBIN_TYPE(NAME)

#define	INCBIN_BYTE ".byte "

#define	INCBIN_STYLE_CAMEL 0

#define	INCBIN_STYLE_SNAKE 1

#define	INCBIN_PREFIX g
	Specify the prefix to use for symbol names.

#define	INCBIN_STYLE INCBIN_STYLE_CAMEL
	Specify the style used for symbol names.

#define	INCBIN_STYLE_0_DATA Data

#define	INCBIN_STYLE_0_END End

#define	INCBIN_STYLE_0_SIZE Size

#define	INCBIN_STYLE_1_DATA _data

#define	INCBIN_STYLE_1_END _end

#define	INCBIN_STYLE_1_SIZE _size

#define	INCBIN_STYLE_IDENT(TYPE)

#define	INCBIN_STYLE_STRING(TYPE)

#define	INCBIN_GLOBAL_LABELS(NAME, TYPE)

#define	INCBIN_EXTERN(...)
	Externally reference binary data included in another translation unit.

#define	INCBIN_EXTERN_1(NAME, ...)

#define	INCBIN_EXTERN_2(TYPE, NAME)

#define	INCTXT_EXTERN(NAME)
	Externally reference textual data included in another translation unit.

#define	INCBIN(...)
	Include a binary file into the current translation unit.

#define	INCBIN_1(...)

#define	INCBIN_2(NAME, FILENAME)

#define	INCBIN_3(TYPE, NAME, FILENAME)

#define	INCBIN_COMMON(TYPE, NAME, FILENAME, TERMINATOR)

#define	INCTXT(NAME, FILENAME)
	Include a textual file into the current translation unit.

Detailed Description

Author: Dale Weiler

Facilities for including binary files into the current translation unit and making use from them externally in other translation units.

From https://github.com/graphitemaster/incbin licenced in public domain

Definition in file incbin.h.

Macro Definition Documentation

◆ INCBIN

#define INCBIN ( ... )

Value:

INCBIN_CONCATENATE(INCBIN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)

INCBIN_VA_ARGC

#define INCBIN_VA_ARGC(...)

Definition incbin.h:73

INCBIN_CONCATENATE

#define INCBIN_CONCATENATE(X, Y)

Definition incbin.h:64

Includes a binary file into the current translation unit, producing three symbols for objects that encode the data and size respectively.

The symbol names are a concatenation of ‘INCBIN_PREFIX’ before NAME; with "Data", as well as "End" and "Size" after. An example is provided below.

Parameters

TYPE	Optional array type. Omitting this picks a default of `unsigned char`.
NAME	The name to associate with this binary data (as an identifier.)
FILENAME	The file to include (as a string literal.)

INCBIN(Icon, "icon.png");
 
// Now you have the following symbols:
// const unsigned char <prefix>Icon<data>[];
// const unsigned char *const <prefix>Icon<end>;
// const unsigned int <prefix>Icon<size>;

You may specify a custom optional data type as well as the first argument. These macros are specialized by arity.

INCBIN(custom_type, Icon, "icon.png");
 
// Now you have the following symbols:
// const custom_type <prefix>Icon<data>[];
// const custom_type *const <prefix>Icon<end>;
// const unsigned int <prefix>Icon<size>;

Warning: This must be used in global scope; The identifiers may be different if INCBIN_STYLE is not default

To externally reference the data included by this in another translation unit please

See also: INCBIN_EXTERN.

Definition at line 405 of file incbin.h.

405# define INCBIN(...) \

406 INCBIN_CONCATENATE(INCBIN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)

◆ INCBIN_1

#define INCBIN_1 ( ... )

Value:

/* Cannot do anything here */

Definition at line 412 of file incbin.h.

◆ INCBIN_2

#define INCBIN_2	(		NAME,
			FILENAME )

Value:

INCBIN_3(unsigned char, NAME, FILENAME)

INCBIN_3

#define INCBIN_3(TYPE, NAME, FILENAME)

Definition incbin.h:416

NAME

#define NAME(s)

Definition pointertest.cpp:447

Definition at line 414 of file incbin.h.

414# define INCBIN_2(NAME, FILENAME) \

415 INCBIN_3(unsigned char, NAME, FILENAME)

◆ INCBIN_3

#define INCBIN_3	(	TYPE,
		NAME,
		FILENAME )

Value:

INCBIN_COMMON(TYPE, NAME, FILENAME, /* No terminator for binary data */)

INCBIN_COMMON

#define INCBIN_COMMON(TYPE, NAME, FILENAME, TERMINATOR)

Definition incbin.h:417

Definition at line 416 of file incbin.h.

◆ INCBIN_ALIGN

#define INCBIN_ALIGN __attribute__((aligned(INCBIN_ALIGNMENT)))

Definition at line 88 of file incbin.h.

88# define INCBIN_ALIGN \

89 __attribute__((aligned(INCBIN_ALIGNMENT)))

◆ INCBIN_ALIGN_BYTE

#define INCBIN_ALIGN_BYTE ".align 1\n"

Definition at line 114 of file incbin.h.

◆ INCBIN_ALIGN_HOST

#define INCBIN_ALIGN_HOST ".align " INCBIN_STRINGIZE(INCBIN_ALIGNMENT) "\n"

Definition at line 113 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_0

#define INCBIN_ALIGN_SHIFT_0 1

Definition at line 42 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_1

#define INCBIN_ALIGN_SHIFT_1 2

Definition at line 43 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_2

#define INCBIN_ALIGN_SHIFT_2 4

Definition at line 44 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_3

#define INCBIN_ALIGN_SHIFT_3 8

Definition at line 45 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_4

#define INCBIN_ALIGN_SHIFT_4 16

Definition at line 46 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_5

#define INCBIN_ALIGN_SHIFT_5 32

Definition at line 47 of file incbin.h.

◆ INCBIN_ALIGN_SHIFT_6

#define INCBIN_ALIGN_SHIFT_6 64

Definition at line 48 of file incbin.h.

◆ INCBIN_ALIGNMENT

#define INCBIN_ALIGNMENT

Value:

    INCBIN_CONCATENATE( \
        INCBIN_CONCATENATE(INCBIN_ALIGN_SHIFT, _), \
        INCBIN_ALIGNMENT_INDEX)

Definition at line 51 of file incbin.h.

#define INCBIN_ALIGNMENT \
    INCBIN_CONCATENATE( \
        INCBIN_CONCATENATE(INCBIN_ALIGN_SHIFT, _), \
        INCBIN_ALIGNMENT_INDEX)

◆ INCBIN_ALIGNMENT_INDEX

#define INCBIN_ALIGNMENT_INDEX 3

Definition at line 36 of file incbin.h.

◆ INCBIN_BYTE

#define INCBIN_BYTE ".byte "

Definition at line 200 of file incbin.h.

◆ INCBIN_CAT

#define INCBIN_CAT	(		X,
			Y )

Value:

X ## Y

XT

Definition lib.h:43

Definition at line 62 of file incbin.h.

62#define INCBIN_CAT(X, Y) \

63 X ## Y

◆ INCBIN_COMMON

#define INCBIN_COMMON	(	TYPE,
		NAME,
		FILENAME,
		TERMINATOR )

Value:

    __asm__(INCBIN_SECTION \
            INCBIN_GLOBAL_LABELS(NAME, DATA) \
            INCBIN_ALIGN_HOST \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(DATA) ":\n" \
            INCBIN_MACRO " \"" FILENAME "\"\n" \
                TERMINATOR \
            INCBIN_GLOBAL_LABELS(NAME, END) \
            INCBIN_ALIGN_BYTE \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(END) ":\n" \
                INCBIN_BYTE "1\n" \
            INCBIN_GLOBAL_LABELS(NAME, SIZE) \
            INCBIN_ALIGN_HOST \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(SIZE) ":\n" \
                INCBIN_INT INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(END) " - " \
                           INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(DATA) "\n" \
            INCBIN_ALIGN_HOST \
            ".text\n" \
    ); \
    INCBIN_EXTERN(TYPE, NAME)

Definition at line 417 of file incbin.h.

#  define INCBIN_COMMON(TYPE, NAME, FILENAME, TERMINATOR) \
    __asm__(INCBIN_SECTION \
            INCBIN_GLOBAL_LABELS(NAME, DATA) \
            INCBIN_ALIGN_HOST \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(DATA) ":\n" \
            INCBIN_MACRO " \"" FILENAME "\"\n" \
                TERMINATOR \
            INCBIN_GLOBAL_LABELS(NAME, END) \
            INCBIN_ALIGN_BYTE \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(END) ":\n" \
                INCBIN_BYTE "1\n" \
            INCBIN_GLOBAL_LABELS(NAME, SIZE) \
            INCBIN_ALIGN_HOST \
            INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(SIZE) ":\n" \
                INCBIN_INT INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(END) " - " \
                           INCBIN_MANGLE INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME INCBIN_STYLE_STRING(DATA) "\n" \
            INCBIN_ALIGN_HOST \
            ".text\n" \
    ); \
    INCBIN_EXTERN(TYPE, NAME)

◆ INCBIN_CONCATENATE

#define INCBIN_CONCATENATE	(		X,
			Y )

Value:

INCBIN_CAT(X, Y)

INCBIN_CAT

#define INCBIN_CAT(X, Y)

Definition incbin.h:62

Definition at line 64 of file incbin.h.

64#define INCBIN_CONCATENATE(X, Y) \

65 INCBIN_CAT(X, Y)

◆ INCBIN_CONST

#define INCBIN_CONST const

Definition at line 123 of file incbin.h.

◆ INCBIN_EVAL

#define INCBIN_EVAL ( X )

Value:

X

Definition at line 67 of file incbin.h.

67#define INCBIN_EVAL(X) \

68 X

◆ INCBIN_EXTERN

#define INCBIN_EXTERN ( ... )

Value:

INCBIN_CONCATENATE(INCBIN_EXTERN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)

Produces three external symbols that reference the binary data included in another translation unit.

The symbol names are a concatenation of ‘INCBIN_PREFIX’ before NAME; with "Data", as well as "End" and "Size" after. An example is provided below.

Parameters

TYPE	Optional array type. Omitting this picks a default of `unsigned char`.
NAME	The name given for the binary data

INCBIN_EXTERN(Foo);
 
// Now you have the following symbols:
// extern const unsigned char <prefix>Foo<data>[];
// extern const unsigned char *const <prefix>Foo<end>;
// extern const unsigned int <prefix>Foo<size>;

You may specify a custom optional data type as well as the first argument.

INCBIN_EXTERN(custom_type, Foo);
 
// Now you have the following symbols:
// extern const custom_type <prefix>Foo<data>[];
// extern const custom_type *const <prefix>Foo<end>;
// extern const unsigned int <prefix>Foo<size>;

Definition at line 321 of file incbin.h.

321#define INCBIN_EXTERN(...) \

322 INCBIN_CONCATENATE(INCBIN_EXTERN_, INCBIN_VA_ARGC(__VA_ARGS__))(__VA_ARGS__)

◆ INCBIN_EXTERN_1

#define INCBIN_EXTERN_1	(		NAME,
			... )

Value:

INCBIN_EXTERN_2(unsigned char, NAME)

INCBIN_EXTERN_2

#define INCBIN_EXTERN_2(TYPE, NAME)

Definition incbin.h:325

Definition at line 323 of file incbin.h.

323#define INCBIN_EXTERN_1(NAME, ...) \

324 INCBIN_EXTERN_2(unsigned char, NAME)

◆ INCBIN_EXTERN_2

#define INCBIN_EXTERN_2	(		TYPE,
			NAME )

Value:

    INCBIN_EXTERNAL const INCBIN_ALIGN TYPE \
        INCBIN_CONCATENATE( \
            INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
            INCBIN_STYLE_IDENT(DATA))[]; \
    INCBIN_EXTERNAL const INCBIN_ALIGN TYPE *const \
    INCBIN_CONCATENATE( \
        INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
        INCBIN_STYLE_IDENT(END)); \
    INCBIN_EXTERNAL const unsigned int \
        INCBIN_CONCATENATE( \
            INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
            INCBIN_STYLE_IDENT(SIZE))

Definition at line 325 of file incbin.h.

#define INCBIN_EXTERN_2(TYPE, NAME) \
    INCBIN_EXTERNAL const INCBIN_ALIGN TYPE \
        INCBIN_CONCATENATE( \
            INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
            INCBIN_STYLE_IDENT(DATA))[]; \
    INCBIN_EXTERNAL const INCBIN_ALIGN TYPE *const \
    INCBIN_CONCATENATE( \
        INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
        INCBIN_STYLE_IDENT(END)); \
    INCBIN_EXTERNAL const unsigned int \
        INCBIN_CONCATENATE( \
            INCBIN_CONCATENATE(INCBIN_PREFIX, NAME), \
            INCBIN_STYLE_IDENT(SIZE))

◆ INCBIN_EXTERNAL

#define INCBIN_EXTERNAL extern

Definition at line 122 of file incbin.h.

◆ INCBIN_GLOBAL

#define INCBIN_GLOBAL ( NAME )

Value:

".global " INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME "\n"

Definition at line 179 of file incbin.h.

◆ INCBIN_GLOBAL_LABELS

#define INCBIN_GLOBAL_LABELS	(		NAME,
			TYPE )

Value:

    INCBIN_INVOKE( \
        INCBIN_GLOBAL, \
        INCBIN_CONCATENATE( \
            NAME, \
            INCBIN_INVOKE( \
                INCBIN_STYLE_IDENT, \
                TYPE))) \
    INCBIN_INVOKE( \
        INCBIN_TYPE, \
        INCBIN_CONCATENATE( \
            NAME, \
            INCBIN_INVOKE( \
                INCBIN_STYLE_IDENT, \
                TYPE)))

Definition at line 274 of file incbin.h.

#define INCBIN_GLOBAL_LABELS(NAME, TYPE) \
    INCBIN_INVOKE( \
        INCBIN_GLOBAL, \
        INCBIN_CONCATENATE( \
            NAME, \
            INCBIN_INVOKE( \
                INCBIN_STYLE_IDENT, \
                TYPE))) \
    INCBIN_INVOKE( \
        INCBIN_TYPE, \
        INCBIN_CONCATENATE( \
            NAME, \
            INCBIN_INVOKE( \
                INCBIN_STYLE_IDENT, \
                TYPE)))

◆ INCBIN_INT

#define INCBIN_INT ".int "

Definition at line 183 of file incbin.h.

◆ INCBIN_INVOKE

#define INCBIN_INVOKE	(		N,
			... )

Value:

INCBIN_EVAL(N(__VA_ARGS__))

INCBIN_EVAL

#define INCBIN_EVAL(X)

Definition incbin.h:67

N

const int N

Definition quantize.cpp:54

Definition at line 69 of file incbin.h.

69#define INCBIN_INVOKE(N, ...) \

70 INCBIN_EVAL(N(__VA_ARGS__))

◆ INCBIN_MACRO

#define INCBIN_MACRO ".incbin"

Definition at line 84 of file incbin.h.

◆ INCBIN_MANGLE

#define INCBIN_MANGLE ""

Definition at line 188 of file incbin.h.

◆ INCBIN_OUTPUT_DATA_SECTION

#define INCBIN_OUTPUT_DATA_SECTION INCBIN_OUTPUT_SECTION

Warning: If you use this facility, you might have to deal with platform-specific linker output section naming on your own.

Definition at line 148 of file incbin.h.

◆ INCBIN_OUTPUT_SECTION

#define INCBIN_OUTPUT_SECTION ".rodata"

Warning: If you use this facility, you might have to deal with platform-specific linker output section naming on your own.

Definition at line 137 of file incbin.h.

◆ INCBIN_OUTPUT_SIZE_SECTION

#define INCBIN_OUTPUT_SIZE_SECTION INCBIN_OUTPUT_SECTION

Warning: If you use this facility, you might have to deal with platform-specific linker output section naming on your own.

Note: This is useful for Harvard architectures where program memory cannot be directly read from the program without special instructions. With this you can chose to put the size variable in RAM rather than ROM.

Definition at line 162 of file incbin.h.

◆ INCBIN_PREFIX

#define INCBIN_PREFIX g

Note: By default this is "g".

#define INCBIN_PREFIX incbin
#include "incbin.h"
INCBIN(Foo, "foo.txt");
 
// Now you have the following symbols instead:
// const unsigned char incbinFoo<data>[];
// const unsigned char *const incbinFoo<end>;
// const unsigned int incbinFoo<size>;

Definition at line 224 of file incbin.h.

◆ INCBIN_SECTION

#define INCBIN_SECTION ".section " INCBIN_OUTPUT_SECTION "\n"

Definition at line 178 of file incbin.h.

◆ INCBIN_STR

#define INCBIN_STR ( X )

Value:

#X

Definition at line 57 of file incbin.h.

57#define INCBIN_STR(X) \

58 #X

◆ INCBIN_STRINGIZE

#define INCBIN_STRINGIZE ( X )

Value:

INCBIN_STR(X)

INCBIN_STR

#define INCBIN_STR(X)

Definition incbin.h:57

Definition at line 59 of file incbin.h.

59#define INCBIN_STRINGIZE(X) \

60 INCBIN_STR(X)

◆ INCBIN_STYLE

#define INCBIN_STYLE INCBIN_STYLE_CAMEL

Possible options are

INCBIN_STYLE_CAMEL "CamelCase"
INCBIN_STYLE_SNAKE "snake_case"

Note: By default this is INCBIN_STYLE_CAMEL

#define INCBIN_STYLE INCBIN_STYLE_SNAKE
#include "incbin.h"
INCBIN(foo, "foo.txt");
 
// Now you have the following symbols:
// const unsigned char <prefix>foo_data[];
// const unsigned char *const <prefix>foo_end;
// const unsigned int <prefix>foo_size;

Definition at line 248 of file incbin.h.

◆ INCBIN_STYLE_0_DATA

#define INCBIN_STYLE_0_DATA Data

Definition at line 252 of file incbin.h.

◆ INCBIN_STYLE_0_END

#define INCBIN_STYLE_0_END End

Definition at line 253 of file incbin.h.

◆ INCBIN_STYLE_0_SIZE

#define INCBIN_STYLE_0_SIZE Size

Definition at line 254 of file incbin.h.

◆ INCBIN_STYLE_1_DATA

#define INCBIN_STYLE_1_DATA _data

Definition at line 255 of file incbin.h.

◆ INCBIN_STYLE_1_END

#define INCBIN_STYLE_1_END _end

Definition at line 256 of file incbin.h.

◆ INCBIN_STYLE_1_SIZE

#define INCBIN_STYLE_1_SIZE _size

Definition at line 257 of file incbin.h.

◆ INCBIN_STYLE_CAMEL

#define INCBIN_STYLE_CAMEL 0

Definition at line 204 of file incbin.h.

◆ INCBIN_STYLE_IDENT

#define INCBIN_STYLE_IDENT ( TYPE )

Value:

    INCBIN_CONCATENATE( \
        INCBIN_STYLE_, \
        INCBIN_CONCATENATE( \
            INCBIN_EVAL(INCBIN_STYLE), \
            INCBIN_CONCATENATE(_, TYPE)))

Definition at line 260 of file incbin.h.

#define INCBIN_STYLE_IDENT(TYPE) \
    INCBIN_CONCATENATE( \
        INCBIN_STYLE_, \
        INCBIN_CONCATENATE( \
            INCBIN_EVAL(INCBIN_STYLE), \
            INCBIN_CONCATENATE(_, TYPE)))

◆ INCBIN_STYLE_SNAKE

#define INCBIN_STYLE_SNAKE 1

Definition at line 205 of file incbin.h.

◆ INCBIN_STYLE_STRING

#define INCBIN_STYLE_STRING ( TYPE )

Value:

INCBIN_STRINGIZE( \

INCBIN_STYLE_IDENT(TYPE)) \

Definition at line 268 of file incbin.h.

#define INCBIN_STYLE_STRING(TYPE) \
    INCBIN_STRINGIZE( \
        INCBIN_STYLE_IDENT(TYPE)) \
 

◆ INCBIN_TYPE

#define INCBIN_TYPE ( NAME )

Value:

".type " INCBIN_STRINGIZE(INCBIN_PREFIX) #NAME ", @object\n"

Definition at line 198 of file incbin.h.

◆ INCBIN_VA_ARG_COUNTER

#define INCBIN_VA_ARG_COUNTER	(	_1,
		_2,
		_3,
		N,
		... )

Value:

N

Definition at line 72 of file incbin.h.

◆ INCBIN_VA_ARGC

#define INCBIN_VA_ARGC ( ... )

Value:

INCBIN_VA_ARG_COUNTER(__VA_ARGS__, 3, 2, 1, 0)

INCBIN_VA_ARG_COUNTER

#define INCBIN_VA_ARG_COUNTER(_1, _2, _3, N,...)

Definition incbin.h:72

Definition at line 73 of file incbin.h.

◆ INCTXT

#define INCTXT	(		NAME,
			FILENAME )

Value:

INCBIN_COMMON(char, NAME, FILENAME, INCBIN_BYTE "0\n")

This behaves the same as INCBIN except it produces char compatible arrays and implicitly adds a null-terminator byte, thus the size of data included by this is one byte larger than that of INCBIN.

Includes a textual file into the current translation unit, producing three symbols for objects that encode the data and size respectively.

The symbol names are a concatenation of ‘INCBIN_PREFIX’ before NAME; with "Data", as well as "End" and "Size" after. An example is provided below.

Parameters

NAME	The name to associate with this binary data (as an identifier.)
FILENAME	The file to include (as a string literal.)

INCTXT(Readme, "readme.txt");
 
// Now you have the following symbols:
// const char <prefix>Readme<data>[];
// const char *const <prefix>Readme<end>;
// const unsigned int <prefix>Readme<size>;

Warning: This must be used in global scope; The identifiers may be different if INCBIN_STYLE is not default

To externally reference the data included by this in another translation unit please

See also: INCBIN_EXTERN.

Definition at line 474 of file incbin.h.

474# define INCTXT(NAME, FILENAME) \

475 INCBIN_COMMON(char, NAME, FILENAME, INCBIN_BYTE "0\n")

◆ INCTXT_EXTERN

#define INCTXT_EXTERN ( NAME )

Value:

INCBIN_EXTERN_2(char, NAME)

Produces three external symbols that reference the textual data included in another translation unit.

The symbol names are a concatenation of ‘INCBIN_PREFIX’ before NAME; with "Data", as well as "End" and "Size" after. An example is provided below.

Parameters

NAME	The name given for the textual data

INCBIN_EXTERN(Foo);
 
// Now you have the following symbols:
// extern const char <prefix>Foo<data>[];
// extern const char *const <prefix>Foo<end>;
// extern const unsigned int <prefix>Foo<size>;

Definition at line 359 of file incbin.h.

359#define INCTXT_EXTERN(NAME) \

360 INCBIN_EXTERN_2(char, NAME)

Macros

Detailed Description

Macro Definition Documentation

◆ INCBIN

◆ INCBIN_1

◆ INCBIN_2

◆ INCBIN_3

◆ INCBIN_ALIGN

◆ INCBIN_ALIGN_BYTE

◆ INCBIN_ALIGN_HOST

◆ INCBIN_ALIGN_SHIFT_0

◆ INCBIN_ALIGN_SHIFT_1

◆ INCBIN_ALIGN_SHIFT_2

◆ INCBIN_ALIGN_SHIFT_3

◆ INCBIN_ALIGN_SHIFT_4

◆ INCBIN_ALIGN_SHIFT_5

◆ INCBIN_ALIGN_SHIFT_6

◆ INCBIN_ALIGNMENT

◆ INCBIN_ALIGNMENT_INDEX

◆ INCBIN_BYTE

◆ INCBIN_CAT

◆ INCBIN_COMMON

◆ INCBIN_CONCATENATE

◆ INCBIN_CONST

◆ INCBIN_EVAL

◆ INCBIN_EXTERN

◆ INCBIN_EXTERN_1

◆ INCBIN_EXTERN_2

◆ INCBIN_EXTERNAL

◆ INCBIN_GLOBAL

◆ INCBIN_GLOBAL_LABELS

◆ INCBIN_INT

◆ INCBIN_INVOKE

◆ INCBIN_MACRO

◆ INCBIN_MANGLE

◆ INCBIN_OUTPUT_DATA_SECTION

◆ INCBIN_OUTPUT_SECTION

◆ INCBIN_OUTPUT_SIZE_SECTION

◆ INCBIN_PREFIX

◆ INCBIN_SECTION

◆ INCBIN_STR

◆ INCBIN_STRINGIZE

◆ INCBIN_STYLE

◆ INCBIN_STYLE_0_DATA

◆ INCBIN_STYLE_0_END

◆ INCBIN_STYLE_0_SIZE

◆ INCBIN_STYLE_1_DATA

◆ INCBIN_STYLE_1_END

◆ INCBIN_STYLE_1_SIZE

◆ INCBIN_STYLE_CAMEL

◆ INCBIN_STYLE_IDENT

◆ INCBIN_STYLE_SNAKE

◆ INCBIN_STYLE_STRING

◆ INCBIN_TYPE

◆ INCBIN_VA_ARG_COUNTER

◆ INCBIN_VA_ARGC

◆ INCTXT

◆ INCTXT_EXTERN