/home/adwe/code/actf/types.h

Go to the documentation of this file.

/*
 * This file is a part of ACTF.
 *
 * Copyright (C) 2024  Adam Wendelin <adwe live se>
 *
 * ACTF is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * ACTF is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with ACTF. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#ifndef ACTF_TYPES_H
#define ACTF_TYPES_H
 
#include <stdint.h>
 
 
/* Return codes. */
#define ACTF_OK                      0 
#define ACTF_ERROR                  -1 
#define ACTF_INTERNAL               -2 
#define ACTF_OOM                    -3 
#define ACTF_NOT_FOUND              -4 
#define ACTF_JSON_PARSE_ERROR       -5 
#define ACTF_JSON_ERROR             -6 
#define ACTF_JSON_WRONG_TYPE        -7 
#define ACTF_JSON_NOT_GTEZ          -8 
#define ACTF_JSON_NOT_GTZ           -9 
#define ACTF_INVALID_ALIGNMENT     -10 
#define ACTF_INVALID_BYTE_ORDER    -11 
#define ACTF_INVALID_BIT_ORDER     -12 
#define ACTF_INVALID_RANGE         -13 
#define ACTF_INVALID_RANGE_SET     -14 
#define ACTF_INVALID_UUID          -15 
#define ACTF_INVALID_FLD_LOC       -16 
#define ACTF_INVALID_FLD_CLS       -17 
#define ACTF_INVALID_FLAGS         -18 
#define ACTF_INVALID_ROLE          -19 
#define ACTF_INVALID_BASE          -20 
#define ACTF_UNSUPPORTED_LENGTH    -21 
#define ACTF_INVALID_ENCODING      -22 
#define ACTF_INVALID_ENVIRONMENT   -23 
#define ACTF_INVALID_VARIANT       -24 
#define ACTF_CC_GTE_FREQ_ERROR     -25 
#define ACTF_NO_SUCH_ALIAS         -26 
#define ACTF_MISSING_PROPERTY      -27 
#define ACTF_UNSUPPORTED_EXTENSION -28 
#define ACTF_NO_SUCH_ORIGIN        -29 
#define ACTF_NO_DEFAULT_CLOCK      -30 
#define ACTF_INVALID_UUID_ROLE     -31 
#define ACTF_INVALID_MAGIC_ROLE    -32 
#define ACTF_NOT_A_STRUCT          -33 
#define ACTF_DUPLICATE_ERROR       -34 
#define ACTF_NO_SUCH_ID            -35 
#define ACTF_UNSUPPORTED_VERSION   -36 
#define ACTF_NO_PREAMBLE           -37 
#define ACTF_WRONG_FLD_TYPE        -38 
#define ACTF_MISSING_FLD_LOC       -39 
#define ACTF_NOT_ENOUGH_BITS       -40 
#define ACTF_MID_BYTE_ENDIAN_SWAP  -41 
#define ACTF_INVALID_STR_LEN       -42 
#define ACTF_MAGIC_MISMATCH        -43 
#define ACTF_UUID_MISMATCH         -44 
#define ACTF_NO_SELECTOR_FLD       -45 
#define ACTF_INVALID_CONTENT_LEN   -46 
#define ACTF_INVALID_METADATA_PKT  -47 
#define ACTF_LUA_WRONG_RET_TYPE    -48 
#define ACTF_LUA_RUN_ERROR         -49 

const char *actf_errstr(int rc);

typedef struct actf_fld actf_fld;
typedef struct actf_fld_cls actf_fld_cls;

enum actf_byte_order {
    ACTF_LIL_ENDIAN,
    ACTF_BIG_ENDIAN,
};

enum actf_bit_order {
    ACTF_FIRST_TO_LAST,
    ACTF_LAST_TO_FIRST,
};

enum actf_encoding {
    ACTF_ENCODING_UTF8,
    ACTF_ENCODING_UTF16BE,
    ACTF_ENCODING_UTF16LE,
    ACTF_ENCODING_UTF32BE,
    ACTF_ENCODING_UTF32LE,
    ACTF_N_ENCODINGS,
};

enum actf_base {
    ACTF_BASE_BINARY = 2,
    ACTF_BASE_OCTAL = 8,
    ACTF_BASE_DECIMAL = 10,
    ACTF_BASE_HEXADECIMAL = 16,
};

#define ACTF_UUID_N_BYTES 16

struct actf_uuid {
    uint8_t d[ACTF_UUID_N_BYTES];
};

typedef struct actf_it {
    void *data;
} actf_it;
 
#endif /* ACTF_TYPES_H */