param_value.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_PARAM_VALUE_H
#define SET_PARAM_VALUE_H

#include <stddef.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct PARAM_VAL_st PARAM_VAL;

enum PST_PRIORITY_enum {
        PST_PRIORITY_NOTDEFINED = -4,

        PST_PRIORITY_HIGHEST = -3,

        PST_PRIORITY_LOWEST = -2,

        PST_PRIORITY_NONE = -1,

        PST_PRIORITY_COUNT = 0xffff,

        PST_PRIORITY_VALID_BASE = 0,

        PST_PRIORITY_VALID_ROOF = PST_PRIORITY_VALID_BASE + PST_PRIORITY_COUNT - 1 ,

        PST_PRIORITY_HIGHER_THAN = PST_PRIORITY_VALID_ROOF + 1,

        PST_PRIORITY_LOWER_THAN = PST_PRIORITY_HIGHER_THAN + PST_PRIORITY_COUNT,

        PST_PRIORITY_FIELD_OUT_OF_RANGE = PST_PRIORITY_LOWER_THAN + PST_PRIORITY_COUNT
};

enum PST_INDEX_enum {
        PST_INDEX_LAST = -1,

        PST_INDEX_FIRST = 0,
};

int PARAM_VAL_new(const char *value, const char* source, int priority, PARAM_VAL **newObj);

int PARAM_VAL_insert(PARAM_VAL *target, const char* source, int priority, int at, PARAM_VAL *obj);

void PARAM_VAL_free(PARAM_VAL *rootValue);

int PARAM_VAL_getElement(PARAM_VAL *rootValue, const char* source, int priority, int at, PARAM_VAL** val);

int PARAM_VAL_popElement(PARAM_VAL **rootValue, const char* source, int priority, int at, PARAM_VAL** val);

int PARAM_VAL_extract(PARAM_VAL *rootValue, const char **value, const char **source, int *priority);

int PARAM_VAL_getElementCount(PARAM_VAL *rootValue, const char *source, int prio, int *count);

int PARAM_VAL_getInvalidCount(PARAM_VAL *rootValue, const char *source, int prio, int *count);

int PARAM_VAL_getPriority(PARAM_VAL *rootValue, int current, int *nextPrio);

int PARAM_VAL_getErrors(PARAM_VAL *rootValue, int *format, int* content);

int PARAM_VAL_getInvalid(PARAM_VAL *rootValue, const char* source, int priority, int at, PARAM_VAL** val);

char* PARAM_VAL_toString(const PARAM_VAL *value, char *buf, size_t buf_len);



#ifdef  __cplusplus
}
#endif

#endif  /* SET_PARAM_VALUE_H */