/home/adwe/code/actf/fld_cls.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_FLD_CLS_H
#define ACTF_FLD_CLS_H
 
#include "flags.h"
#include "fld_loc.h"
#include "mappings.h"
#include "rng.h"
#include "types.h"
 

enum actf_role {
    ACTF_ROLE_NIL = 0,
    ACTF_ROLE_DSTREAM_CLS_ID = (1 << 0),
    ACTF_ROLE_DSTREAM_ID = (1 << 1),
    ACTF_ROLE_PKT_MAGIC_NUM = (1 << 2),
    ACTF_ROLE_METADATA_STREAM_UUID = (1 << 3),
    ACTF_ROLE_DEF_CLK_TSTAMP = (1 << 4),
    ACTF_ROLE_DISC_EVENT_CNT_SNAPSHOT = (1 << 5),
    ACTF_ROLE_PKT_CONTENT_LEN  = (1 << 6),
    ACTF_ROLE_PKT_END_DEF_CLK_TSTAMP  = (1 << 7),
    ACTF_ROLE_PKT_SEQ_NUM = (1 << 8),
    ACTF_ROLE_PKT_TOT_LEN = (1 << 9),
    ACTF_ROLE_EVENT_CLS_ID = (1 << 10),
};

enum actf_fld_cls_type {
    ACTF_FLD_CLS_NIL,
    ACTF_FLD_CLS_FXD_LEN_BIT_ARR,
    ACTF_FLD_CLS_FXD_LEN_BIT_MAP,
    ACTF_FLD_CLS_FXD_LEN_UINT,
    ACTF_FLD_CLS_FXD_LEN_SINT,
    ACTF_FLD_CLS_FXD_LEN_BOOL,
    ACTF_FLD_CLS_FXD_LEN_FLOAT,
    ACTF_FLD_CLS_VAR_LEN_UINT,
    ACTF_FLD_CLS_VAR_LEN_SINT,
    ACTF_FLD_CLS_NULL_TERM_STR,
    ACTF_FLD_CLS_STATIC_LEN_STR,
    ACTF_FLD_CLS_DYN_LEN_STR,
    ACTF_FLD_CLS_STATIC_LEN_BLOB,
    ACTF_FLD_CLS_DYN_LEN_BLOB,
    ACTF_FLD_CLS_STRUCT,
    ACTF_FLD_CLS_STATIC_LEN_ARR,
    ACTF_FLD_CLS_DYN_LEN_ARR,
    ACTF_FLD_CLS_OPTIONAL,
    ACTF_FLD_CLS_VARIANT,
    ACTF_N_FLD_CLSES,
};

enum actf_fld_cls_type actf_fld_cls_type(const actf_fld_cls *fc);

size_t actf_fld_cls_len(const actf_fld_cls *fc);

enum actf_byte_order actf_fld_cls_byte_order(const actf_fld_cls *fc);

enum actf_bit_order actf_fld_cls_bit_order(const actf_fld_cls *fc);

size_t actf_fld_cls_alignment(const actf_fld_cls *fc);

const actf_flags *actf_fld_cls_bit_map_flags(const actf_fld_cls *fc);

enum actf_base actf_fld_cls_pref_display_base(const actf_fld_cls *fc);

const actf_mappings *actf_fld_cls_mappings(const actf_fld_cls *fc);

enum actf_role actf_fld_cls_roles(const actf_fld_cls *fc);

enum actf_encoding actf_fld_cls_encoding(const actf_fld_cls *fc);

const char *actf_fld_cls_media_type(const actf_fld_cls *fc);

const actf_fld_loc *actf_fld_cls_len_fld_loc(const actf_fld_cls *fc);

uint64_t actf_fld_cls_min_alignment(const actf_fld_cls *fc);

size_t actf_fld_cls_members_len(const actf_fld_cls *fc);

const char *actf_fld_cls_members_name_idx(const actf_fld_cls *fc, size_t i);

const actf_fld_cls *actf_fld_cls_members_fld_cls_idx(const actf_fld_cls *fc, size_t i);

const actf_fld *actf_fld_cls_members_attributes_idx(const actf_fld_cls *fc, size_t i);

const actf_fld *actf_fld_cls_members_extensions_idx(const actf_fld_cls *fc, size_t i);

const actf_fld_cls *actf_fld_cls_element_fld_cls(const actf_fld_cls *fc);

const actf_fld_loc *actf_fld_cls_selector_fld_loc(const actf_fld_cls *fc);

const actf_rng_set *actf_fld_cls_selector_rng_set(const actf_fld_cls *fc);

const actf_fld_cls *actf_fld_cls_optional_fld_cls(const actf_fld_cls *fc);

size_t actf_fld_cls_options_len(const actf_fld_cls *fc);

const char *actf_fld_cls_options_name_idx(const actf_fld_cls *fc, size_t i);

const actf_fld_cls *actf_fld_cls_options_fld_cls_idx(const actf_fld_cls *fc, size_t i);

const actf_rng_set *actf_fld_cls_options_selector_rng_set_idx(const actf_fld_cls *fc, size_t i);

const actf_fld *actf_fld_cls_options_attributes_idx(const actf_fld_cls *fc, size_t i);

const actf_fld *actf_fld_cls_options_extensions_idx(const actf_fld_cls *fc, size_t i);

const char *actf_fld_cls_aliased_name(const actf_fld_cls *fc);

const actf_fld *actf_fld_cls_attributes(const actf_fld_cls *fc);

const actf_fld *actf_fld_cls_extensions(const actf_fld_cls *fc);
 
#endif /* ACTF_FLD_CLS_H */