afw_object_options.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Object Processing Options
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_OBJECT_OPTIONS_H__
#define __AFW_OBJECT_OPTIONS_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
struct afw_object_options_s {
 
    /*
     * @brief Object processing options mask.
     * 
     * See AFW_OBJECT_OPTION_* for values.
     */
    afw_uint32_t mask;
};
 
 
#define AFW_OBJECT_OPTION_checkRequired          (1 << 0)
 
 
 
#define AFW_OBJECT_OPTION_composite              (1 << 1)
 
 
 
#define AFW_OBJECT_OPTION_includeDefaultValues   (1 << 3)
 
 
 
#define AFW_OBJECT_OPTION_includeDescendentObjectTypes (1 << 4)
 
 
 
#define AFW_OBJECT_OPTION_inheritedFrom          (1 << 5)
 
 
 
#define AFW_OBJECT_OPTION_integersAsString       (1 << 6)
 
 
 
#define AFW_OBJECT_OPTION_largeIntegersAsString  (1 << 7)
 
 
 
#define AFW_OBJECT_OPTION_metaFull              (1 << 8)
 
 
 
#define AFW_OBJECT_OPTION_metaLimited            (1 << 9)
 
 
 
#define AFW_OBJECT_OPTION_normalize              (1 << 10)
 
 
 
#define AFW_OBJECT_OPTION_objectId               (1 << 11)
 
 
 
#define AFW_OBJECT_OPTION_objectType             (1 << 12)
 
 
 
#define AFW_OBJECT_OPTION_objectTypes            (1 << 13)
 
 
 
#define AFW_OBJECT_OPTION_path                   (1 << 14)
 
 
 
#define AFW_OBJECT_OPTION_pathEmbedded           (1 << 15)
 
 
#define AFW_OBJECT_OPTION_reconcilable           (1 << 16)
 
 
 
#define AFW_OBJECT_OPTION_resolvedParentPaths    (1 << 17)
 
 
 
#define AFW_OBJECT_OPTION_typedValues            (1 << 18)
 
 
 
#define AFW_OBJECT_OPTION_whitespace             (1 << 19)
 
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_none;
 
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_objectType;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_composite;
 
/*
 * @brief Object processing options -
 *    checkRequired + composite + includeDefaultValues + normalize.
 */
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_composite_normalize_defaults_required;
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_composite_and_defaults;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_essential;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_essential_with_whitespace;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_reconcilable_meta_property;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_composite_inheritedFrom_resolvedParentPaths;
 
 
AFW_DECLARE_CONST_DATA(afw_object_options_t)
afw_object_options_whitespace;
 
 
#define AFW_OBJECT_OPTION_IS(_options, _option) \
((_options) && (((((_options)->mask) & (AFW_OBJECT_OPTION_ ## _option))) != 0))
 
 
#define AFW_OBJECT_OPTION_SET_ON(_options, _option) \
    (_options)->mask |= AFW_OBJECT_OPTION_ ## _option
 
 
#define AFW_OBJECT_OPTION_SET_OFF(_options, _option) \
    (_options)->mask &= ~(AFW_OBJECT_OPTION_ ## _option)
 
 
#define AFW_OBJECT_OPTION_SET(_options, _option, _bool_value) \
do { \
    if (_bool_value) { \
        AFW_OBJECT_OPTION_SET_ON(_options, _option); \
    } \
    else { \
        AFW_OBJECT_OPTION_SET_OFF(_options, _option); \
    } \
} while (0)
 
 
AFW_DECLARE(const afw_object_options_t *)
afw_object_options_set_from_object(
    const afw_object_options_t *initial_options,
    const afw_object_t *options_object,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_options_t *)
afw_object_options_create(
    const afw_object_options_t *initial_options,
    const afw_object_options_t *options,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_OBJECT_OPTIONS_H__ */