Manpages - types.h.3

#define BROTLI_BOOL int
A portable /=bool= replacement. /

#define *BROTLI_FALSE*= 0=
Portable /=false= replacement. /

#define *BROTLI_TRUE*= 1=
Portable /=true= replacement. /

#define *TO_BROTLI_BOOL*=(X) (!!(X) ? *BROTLI_TRUE* : *BROTLI_FALSE*)=
=bool=/ to BROTLI_BOOL conversion macros. /

typedef void ( brotli_alloc_func) (void *opaque, size_t size)
/Allocating function pointer type. /

typedef void(* brotli_free_func) (void *opaque, void *address)
/Deallocating function pointer type. /

A portable =bool=* replacement. BROTLI_BOOL is a ’documentation’ type: actually it is int, but in API it denotes a type, whose only values are BROTLI_TRUE and BROTLI_FALSE.*

BROTLI_BOOL values passed to Brotli should either be BROTLI_TRUE or BROTLI_FALSE, or be a result of TO_BROTLI_BOOL macros.

BROTLI_BOOL values returned by Brotli should not be tested for equality with *=true=, false, BROTLI_TRUE, BROTLI_FALSE, but rather should be evaluated, for example:*

  if (SomeBrotliFunction(encoder, BROTLI_TRUE) &&
      !OtherBrotliFunction(decoder, BROTLI_FALSE)) {
    bool x = !!YetAnotherBrotliFunction(encoder, TO_BROLTI_BOOL(2 * 2 == 4));
    DoSomething(x);
  }

Portable =false=* replacement. *

Portable =true=* replacement. *

=bool=* to BROTLI_BOOL conversion macros. *

Allocating function pointer type.

Parameters:

/opaque/* custom memory manager handle provided by client
size requested memory region size; can not be 0 *

Returns:

=0=* in the case of failure *

a valid pointer to a memory region of at least =size=* bytes long otherwise *

Deallocating function pointer type. This function SHOULD do nothing if *=address= is 0.*

Parameters:

/opaque/* custom memory manager handle provided by client
address memory region pointer returned by brotli_alloc_func, or 0 *