vanillapdf/c__text__string__encoding_8h_source.html

#ifndef _C_TEXT_STRING_ENCODING_H

#define _C_TEXT_STRING_ENCODING_H


#include "vanillapdf/c_export.h"

#include "vanillapdf/c_values.h"


#ifdef __cplusplus

extern "C"

{

#endif


    typedef enum {

        TextStringEncodingType_Undefined = 0,


        TextStringEncodingType_PDFDocEncoding,


        TextStringEncodingType_UTF16BE,


        TextStringEncodingType_UTF8

    } TextStringEncodingType;


    VANILLAPDF_API error_type CALLING_CONVENTION TextStringEncoding_Detect(string_type data, size_type size, TextStringEncodingType* result);


    VANILLAPDF_API error_type CALLING_CONVENTION TextStringEncoding_PDFDocEncodingByteToUnicode(uint8_t byte, uint32_t* codepoint);


#ifdef __cplusplus

};

#endif


#endif /* _C_TEXT_STRING_ENCODING_H */

c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.

TextStringEncodingType
TextStringEncodingType
Encoding types for PDF text strings (PDF spec 7.9.2.2).
Definition c_text_string_encoding.h:23

TextStringEncodingType_UTF16BE
@ TextStringEncodingType_UTF16BE
UTF-16 big-endian encoding. Indicated by byte order mark 0xFEFF at the start of the string.
Definition c_text_string_encoding.h:36

TextStringEncodingType_PDFDocEncoding
@ TextStringEncodingType_PDFDocEncoding
Single-byte encoding defined in PDF spec Table D.2. No byte order mark is present.
Definition c_text_string_encoding.h:30

TextStringEncodingType_UTF8
@ TextStringEncodingType_UTF8
UTF-8 encoding (PDF 2.0). Indicated by byte order mark 0xEFBBBF at the start of the string.
Definition c_text_string_encoding.h:42

c_values.h
This file contains types and constants used as parameters or return values.

error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25

size_type
uint32_t size_type
Size type defined in standard library.
Definition c_types.h:62

string_type
const char * string_type
C-Style string.
Definition c_types.h:82

TextStringEncoding_PDFDocEncodingByteToUnicode
error_type CALLING_CONVENTION TextStringEncoding_PDFDocEncodingByteToUnicode(uint8_t byte, uint32_t *codepoint)
Map a single PDFDocEncoding byte to its Unicode code point.

TextStringEncoding_Detect
error_type CALLING_CONVENTION TextStringEncoding_Detect(string_type data, size_type size, TextStringEncodingType *result)
Detect the encoding of a PDF text string from its raw bytes.