parameter.h

Go to the documentation of this file.

/*
 * Copyright 2013-2017 Guardtime, Inc.
 *
 * This file is part of the Guardtime client SDK.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES, CONDITIONS, OR OTHER LICENSES OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 * "Guardtime" and "KSI" are trademarks or registered trademarks of
 * Guardtime, Inc., and no license to trademarks is granted; Guardtime
 * reserves and retains all trademark rights.
 */

#ifndef SET_PARAMETER_H
#define SET_PARAMETER_H

#include "param_value.h"


#ifdef  __cplusplus
extern "C" {
#endif

typedef struct PARAM_st PARAM;

typedef enum PARAM_PARSE_OPTIONS_enum PARAM_PARSE_OPTIONS;

typedef enum PARAM_CONSTRAINTS_enum PARAM_CONSTRAINTS;

typedef struct PARAM_ATR_st PARAM_ATR;


enum PARAM_CONSTRAINTS_enum {
        PARAM_SINGLE_VALUE = 0x0002,

        PARAM_SINGLE_VALUE_FOR_PRIORITY_LEVEL = 0x0004,

        PARAM_INVALID_CONSTRAINT = 0x8000,
};

struct PARAM_ATR_st {
        char *name;

        char *alias;

        char *cstr_value;

        char *source;

        int priority;

        int formatStatus;

        int contentStatus;
};

enum PARAM_PARSE_OPTIONS_enum {
        PST_PRSCMD_NONE = 0x0000,

        PST_PRSCMD_HAS_NO_VALUE = 0x0002,

        PST_PRSCMD_HAS_VALUE = 0x0004,

        PST_PRSCMD_HAS_VALUE_SEQUENCE = 0x0008,

        PST_PRSCMD_BREAK_WITH_POTENTIAL_PARAMETER = 0x0010,

        PST_PRSCMD_BREAK_WITH_EXISTING_PARAMETER_MATCH = 0x0020,


        PST_PRSCMD_DEFAULT = 0x0001 | PST_PRSCMD_BREAK_WITH_POTENTIAL_PARAMETER,

        PST_PRSCMD_COLLECT_LOOSE_VALUES = 0x0040,

        PST_PRSCMD_COLLECT_LOOSE_FLAGS = 0x0080,

        PST_PRSCMD_COLLECT_WHEN_PARSING_IS_CLOSED = 0x0100,


        PST_PRSCMD_CLOSE_PARSING = 0x0200,

        PST_PRSCMD_COLLECT_HAS_LOWER_PRIORITY = 0x0400,

        PST_PRSCMD_HAS_NO_FLAG = 0x0800,

        PST_PRSCMD_NO_TYPOS = 0x1000,

        PST_PRSCMD_FORMAT_CONTROL_ONLY_FOR_LAST_HIGHST_PRIORITY_VALUE = 0x2000,

        PST_PRSCMD_EXPAND_WILDCARD = 0x4000,

        PST_PRSCMD_COLLECT_LIMITER_BREAK_ON       = 0x00008000,

        PST_PRSCMD_COLLECT_LIMITER_1X       = 0x00010000,

        PST_PRSCMD_COLLECT_LIMITER_MAX_MASK = 0xffff0000
};

int PARAM_new(const char *flagName, const char *flagAlias, int constraint, int pars_opt, PARAM **newObj);

void PARAM_free(PARAM *param);

int PARAM_addControl(PARAM *param, int (*controlFormat)(const char *), int (*controlContent)(const char *), int (*convert)(const char*, char*, unsigned));

int PARAM_isParseOptionSet(PARAM *param, int state);


int PARAM_setParseOption(PARAM *param, int option);

int PARAM_setObjectExtractor(PARAM *param, int (*extractObject)(void **, const char *, void**));

int PARAM_addValue(PARAM *param, const char *value, const char* source, int prio);

int PARAM_getValue(PARAM *param, const char *source, int prio, int at, PARAM_VAL **value);

int PARAM_getAtr(PARAM *param, const char *source, int prio, int at, PARAM_ATR *atr);

int PARAM_getName(PARAM *param, const char **name, const char **alias);

int PARAM_getObject(PARAM *param, const char *source, int prio, int at, void **extra, void **value);

int PARAM_getInvalid(PARAM *param, const char *source, int prio, int at, PARAM_VAL **value);

int PARAM_getValueCount(PARAM *param, const char *source, int prio, int *count);

int PARAM_getInvalidCount(PARAM *param, const char *source, int prio, int *count);

int PARAM_setPrintName(PARAM *param, const char *constv, const char* (*getPrintName)(PARAM *param, char *buf, unsigned buf_len));

int PARAM_setPrintNameAlias(PARAM *param, const char *constv, const char* (*getPrintNameAlias)(PARAM *param, char *buf, unsigned buf_len));

const char* PARAM_getPrintName(PARAM *obj);

const char* PARAM_getPrintNameAlias(PARAM *obj);
int PARAM_setHelpText(PARAM *param, const char *txt);

const char* PARAM_getHelpText(PARAM *obj);

int PARAM_checkConstraints(const PARAM *param, int constraints);

int PARAM_clearAll(PARAM *param);

int PARAM_clearValue(PARAM *param, const char *source, int prio, int at);

int PARAM_setWildcardExpander(PARAM *param, const char* charList, void *ctx, void (*ctx_free)(void*), int (*expand_wildcard)(PARAM_VAL *param_value, void *ctx, int *value_shift));

int PARAM_expandWildcard(PARAM *param, int *count);

char* PARAM_toString(const PARAM *param, char *buf, size_t buf_len);

char* PARAM_constraintErrorToString(PARAM *param, const char *prefix, char *buf, size_t buf_len);

#ifdef  __cplusplus
}
#endif

#endif  /* SET_PARAMETER_H */