kc3-lang/brotli/docs/types.h.3
Tag
-
Show log
Commit
-
Hash : 0e42caf3
Author :
Date : 2021-08-31T14:07:17
Migrate to github actions (#920) Not all combinations are migrated to the initial configuration; corresponding TODOs added. Drive-by: additional combinations uncovered minor portability problems -> fixed Drive-by: remove no-longer used "script" files. Co-authored-by: Eugene Kliuchnikov <eustas@chromium.org>
-
docs/types.h.3
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
.TH "types.h" 3 "August 2021" "Brotli" \" -*- nroff -*- .ad l .nh .SH NAME types.h \- Common types used in decoder and encoder API\&. .SH SYNOPSIS .br .PP .SS "Macros" .in +1c .ti -1c .RI "#define \fBBROTLI_BOOL\fP int" .br .RI "\fIA portable \fCbool\fP replacement\&. \fP" .ti -1c .RI "#define \fBBROTLI_FALSE\fP 0" .br .RI "\fIPortable \fCfalse\fP replacement\&. \fP" .ti -1c .RI "#define \fBBROTLI_TRUE\fP 1" .br .RI "\fIPortable \fCtrue\fP replacement\&. \fP" .ti -1c .RI "#define \fBTO_BROTLI_BOOL\fP(X) (!!(X) ? \fBBROTLI_TRUE\fP : \fBBROTLI_FALSE\fP)" .br .RI "\fI\fCbool\fP to \fBBROTLI_BOOL\fP conversion macros\&. \fP" .in -1c .SS "Typedefs" .in +1c .ti -1c .RI "typedef void *(* \fBbrotli_alloc_func\fP) (void *opaque, size_t size)" .br .RI "\fIAllocating function pointer type\&. \fP" .ti -1c .RI "typedef void(* \fBbrotli_free_func\fP) (void *opaque, void *address)" .br .RI "\fIDeallocating function pointer type\&. \fP" .in -1c .SH "Detailed Description" .PP Common types used in decoder and encoder API\&. .SH "Macro Definition Documentation" .PP .SS "#define BROTLI_BOOL int" .PP A portable \fCbool\fP replacement\&. \fBBROTLI_BOOL\fP is a 'documentation' type: actually it is \fCint\fP, but in API it denotes a type, whose only values are \fBBROTLI_TRUE\fP and \fBBROTLI_FALSE\fP\&. .PP \fBBROTLI_BOOL\fP values passed to Brotli should either be \fBBROTLI_TRUE\fP or \fBBROTLI_FALSE\fP, or be a result of \fBTO_BROTLI_BOOL\fP macros\&. .PP \fBBROTLI_BOOL\fP values returned by Brotli should not be tested for equality with \fCtrue\fP, \fCfalse\fP, \fBBROTLI_TRUE\fP, \fBBROTLI_FALSE\fP, but rather should be evaluated, for example: .PP .nf if (SomeBrotliFunction(encoder, BROTLI_TRUE) && !OtherBrotliFunction(decoder, BROTLI_FALSE)) { bool x = !!YetAnotherBrotliFunction(encoder, TO_BROLTI_BOOL(2 * 2 == 4)); DoSomething(x); } .fi .PP .SS "#define BROTLI_FALSE 0" .PP Portable \fCfalse\fP replacement\&. .SS "#define BROTLI_TRUE 1" .PP Portable \fCtrue\fP replacement\&. .SS "#define TO_BROTLI_BOOL(X) (!!(X) ? \fBBROTLI_TRUE\fP : \fBBROTLI_FALSE\fP)" .PP \fCbool\fP to \fBBROTLI_BOOL\fP conversion macros\&. .SH "Typedef Documentation" .PP .SS "typedef void*(* brotli_alloc_func) (void *opaque, size_t size)" .PP Allocating function pointer type\&. .PP \fBParameters:\fP .RS 4 \fIopaque\fP custom memory manager handle provided by client .br \fIsize\fP requested memory region size; can not be \fC0\fP .RE .PP \fBReturns:\fP .RS 4 \fC0\fP in the case of failure .PP a valid pointer to a memory region of at least \fCsize\fP bytes long otherwise .RE .PP .SS "typedef void(* brotli_free_func) (void *opaque, void *address)" .PP Deallocating function pointer type\&. This function \fBSHOULD\fP do nothing if \fCaddress\fP is \fC0\fP\&. .PP \fBParameters:\fP .RS 4 \fIopaque\fP custom memory manager handle provided by client .br \fIaddress\fP memory region pointer returned by \fBbrotli_alloc_func\fP, or \fC0\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for Brotli from the source code\&.