started Doxygen documentation

# Output

build/

Makefile.deps

html

latex

# GENERAL

/** @file

 *

 */

#ifndef PDF_SIGIL_ACROFORM_H

#define PDF_SIGIL_ACROFORM_H

/** @file

 *

 */

#ifndef PDF_SIGIL_AUXILIARY_H

#define PDF_SIGIL_AUXILIARY_H

#include <stdio.h> // size_t, FILE

#include "types.h"

/** @brief Find minimum of two values

 *

 */

#define MIN(x, y) (((x) < (y)) ? (x) : (y))

/** @brief Find maximum of two values

 *

 */

#define MAX(x, y) (((x) > (y)) ? (x) : (y))

// Shouldn't be optimized out by the compiler

/** @brief Fills content with zeros, shouldn't be optimized out by the compiler

 *

 * @param a starting address

 * @param bytes number of bytes

 */

void sigil_zeroize(void *a, size_t bytes);

/** @brief Decide whether the character is a digit

 *

 * @param c character provided for comparison

 * @return 1 if true, 0 otherwise

 */

int is_digit(const char c);

/** @brief Decide whether the character is a whitespace according to PDF standard

 *

 * @param c character provided for comparison

 * @return 1 if true, 0 otherwise

 */

int is_whitespace(const char c);

/** @brief Reads *size* bytes from PDF to *result* and adds a terminating null.

 *         Does move the position in PDF.

 *

 * @param sgl context

 * @param size number of bytes

 * @param result output buffer

 * @param res_size output number of bytes read, doesn't include terminating null

 * @return ERR_NONE if success

 */

sigil_err_t pdf_read(sigil_t *sgl, size_t size, char *result, size_t *res_size);

/** @brief Reads one character from PDF and moves the position in PDF.

 *

 * @param sgl context

 * @param result output character

 * @return ERR_NONE if success

 */

sigil_err_t pdf_get_char(sigil_t *sgl, char *result);

/** @brief Reads one character from PDF and **does not** move the position in PDF

 *

 * @param sgl context

 * @param result output character

 * @return ERR_NONE if success

 */

sigil_err_t pdf_peek_char(sigil_t *sgl, char *result);

/** @brief Moves position in the PDF relatively to the current position

 *

 * @param sgl context

 * @param shift_bytes number of bytes (positive or negative)

 * @return ERR_NONE if success

 */

sigil_err_t pdf_move_pos_rel(sigil_t *sgl, ssize_t shift_bytes);

/** @brief Moves position in the PDF to the specified value

 *

 * @param sgl context

 * @param position final position in the PDF

 * @return ERR_NONE if success

 */

sigil_err_t pdf_move_pos_abs(sigil_t *sgl, size_t position);

/** @brief Moves position to the object specified as an indirect reference.

 *         Skips leading object identifiers (X Y obj)

 *

 * @param sgl context

 * @param ref object indirect reference

 * @return ERR_NONE if success

 */

sigil_err_t pdf_goto_obj(sigil_t *sgl, reference_t *ref);

/** @brief Gets the current position inside the PDF

 *

 * @param sgl context

 * @param result output - the current position in the PDF

 * @return ERR_NONE if success

 */

sigil_err_t get_curr_position(sigil_t *sgl, size_t *result);

sigil_err_t skip_leading_whitespaces(sigil_t *sgl);

/** @file

 *

 */

#ifndef PDF_SIGIL_CATALOG_DICT_H

#define PDF_SIGIL_CATALOG_DICT_H