param_set.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 PARAM_SET_H
#define PARAM_SET_H

#ifdef  __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include "param_value.h"
#include "parameter.h"

#ifndef PARAM_SET_ERROR_BASE
#       define PARAM_SET_ERROR_BASE 0x30001
#endif

enum PARAM_SET_ERR_enum {
        PST_OK = 0,

        PST_INVALID_ARGUMENT = PARAM_SET_ERROR_BASE,

        PST_INVALID_FORMAT,

        PST_INDEX_OVF,

        PST_PARAMETER_NOT_FOUND,

        PST_PARAMETER_VALUE_NOT_FOUND,

        PST_PARAMETER_EMPTY,

        PST_PARAMETER_IS_TYPO,

        PST_PARAMETER_IS_UNKNOWN,

        PST_PARAMETER_UNIMPLEMENTED_OBJ,

        PST_PARAMETER_UNIMPLEMENTED_WILDCARD,

        PST_OUT_OF_MEMORY,

        PST_IO_ERROR,

        PST_PRIORITY_NEGATIVE,

        PST_PRIORITY_TOO_LARGE,

        PST_PARAMETER_INVALID_FORMAT,

        PST_TASK_ZERO_CONSISTENT_TASKS,

        PST_TASK_MULTIPLE_CONSISTENT_TASKS,

        PST_TASK_SET_HAS_NO_DEFINITIONS,

        PST_TASK_SET_NOT_ANALYZED,

        PST_TASK_UNABLE_TO_ANALYZE_PARAM_SET_CHANGED,

        PST_WILDCARD_ERROR,

        PST_UNDEFINED_BEHAVIOUR,

        PST_PRSCMD_INVALID_COMBINATION,

        PST_PARAM_CONVERT_NOT_PERFORMED,

        PST_ALIAS_NOT_SPECIFIED,

        PST_UNKNOWN_ERROR,
};

typedef struct PARAM_SET_st PARAM_SET;

const char *PST_getVersion(void);

int PARAM_SET_new(const char *names, PARAM_SET **set);

void PARAM_SET_free(PARAM_SET *set);

int PARAM_SET_addControl(PARAM_SET *set, const char *names,
                int (*controlFormat)(const char *),
                int (*controlContent)(const char *),
                int (*convert)(const char*, char*, unsigned),
                int (*extractObject)(void **, const char *, void**));

int PARAM_SET_setPrintName(PARAM_SET *set, const char *names,
                                                        const char *constv, const char* (*getPrintName)(PARAM *param, char *buf, unsigned buf_len));

int PARAM_SET_setPrintNameAlias(PARAM_SET *set, const char *names,
                                                        const char *constv, const char* (*getPrintName)(PARAM *param, char *buf, unsigned buf_len));

int PARAM_SET_setHelpText(PARAM_SET *set, const char *names, const char *txt);

char* PARAM_SET_helpToString(const PARAM_SET *set, const char *names, int indent, int header, int rowWidth, char *buf, size_t buf_len);

int PARAM_SET_add(PARAM_SET *set, const char *name, const char *value, const char *source, int priority);

int PARAM_SET_getStr(PARAM_SET *set, const char *name, const char *source, int priority, int at, char **value);

int PARAM_SET_getObj(PARAM_SET *set, const char *name, const char *source, int priority, int at, void **obj);

int PARAM_SET_getObjExtended(PARAM_SET *set, const char *name, const char *source, int priority, int at, void *ctx, void **obj);

int PARAM_SET_getAtr(PARAM_SET *set, const char *name, const char *source, int priority, int at, PARAM_ATR *atr);

int PARAM_SET_getPrintName(PARAM_SET *set, const char *name, const char **print_name);

int PARAM_SET_getPrintNameAlias(PARAM_SET *set, const char *name, const char **print_name);

int PARAM_SET_clearParameter(PARAM_SET *set, const char *names);

int PARAM_SET_clearValue(PARAM_SET *set, const char *names, const char *source, int priority, int at);

int PARAM_SET_getValueCount(PARAM_SET *set, const char *names, const char *source, int priority, int *count);

int PARAM_SET_isSetByName(const PARAM_SET *set, const char *names);

int PARAM_SET_isOneOfSetByName(const PARAM_SET *set, const char *names);

int PARAM_SET_isFormatOK(const PARAM_SET *set);

int PARAM_SET_isConstraintViolation(const PARAM_SET *set);

int PARAM_SET_isTypoFailure(const PARAM_SET *set);

int PARAM_SET_isSyntaxError(const PARAM_SET *set);

int PARAM_SET_isUnknown(const PARAM_SET *set);

int PARAM_SET_readFromFile(PARAM_SET *set, const char *fname, const char* source, int priority);

int PARAM_SET_readFromCMD(PARAM_SET *set, int argc, char **argv, const char *source, int priority);


int PARAM_SET_parseCMD(PARAM_SET *set, int argc, char **argv, const char *source, int priority);

int PARAM_SET_setParseOptions(PARAM_SET *set, const char *names, int options);

int PARAM_SET_IncludeSet(PARAM_SET *target, PARAM_SET *src);

char* PARAM_SET_toString(PARAM_SET *set, char *buf, size_t buf_len);

char* PARAM_SET_typosToString(PARAM_SET *set, const char *prefix, char *buf, size_t buf_len);

char* PARAM_SET_unknownsToString(const PARAM_SET *set, const char *prefix, char *buf, size_t buf_len);

char* PARAM_SET_invalidParametersToString(const PARAM_SET *set, const char *prefix, const char* (*getErrString)(int), char *buf, size_t buf_len);

char* PARAM_SET_constraintErrorToString(const PARAM_SET *set, const char *prefix, char *buf, size_t buf_len);

const char* PARAM_SET_errorToString(int err);

char* PARAM_SET_syntaxErrorsToString(const PARAM_SET *set, const char *prefix, char *buf, size_t buf_len);

const char* extract_next_name(const char* name_string, int (*isValidNameChar)(int), char *buf, short len, int *flags);

int parse_key_value_pair(const char *line, char *key, char *value, size_t buf_len);

int read_line(FILE *file, char *buf, size_t len, size_t *row_pointer, size_t *read_count);


int PARAM_SET_setWildcardExpander(PARAM_SET *set, const char *names,
                const char* charList,
                void *ctx,
                void (*ctx_free)(void*),
                int (*expand_wildcard)(PARAM_VAL *param_value, void *ctx, int *value_shift));

#ifdef  __cplusplus
}
#endif

#endif