src/keyval_array.h

   1 /*
   2  * Copyright (c) 2000 - 2016 Samsung Electronics Co., Ltd. All rights reserved.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __KEYVAL_ARRAY_H__
  18 #define __kEYVAL_ARRAY_H__
  19
  20 /**
  21  * keyval_array.h
  22  *
  23  * keyval_array object
  24  */
  25
  26 #include "keyval.h"
  27
  28 typedef struct keyval_array_t {
  29         struct keyval_t kv; /* Inherits keyval_t */
  30         unsigned int len; /* length of array_val */
  31         size_t  *array_element_size; /* Array of size of each element */
  32         void **array_val; /* Array */
  33 } keyval_array_t;
  34
  35 keyval_array_t *keyval_array_new(keyval_array_t *kva, const char *key,
  36                 const int type, const void **array_val, const unsigned int len);
  37 void keyval_array_free(keyval_array_t *kva, int do_free_object);
  38 int keyval_array_compare(keyval_array_t *kva1, keyval_array_t *kva2);
  39 size_t keyval_array_get_encoded_size(keyval_array_t *kva);
  40 size_t keyval_array_encode(keyval_array_t *kva, void **byte, size_t *byte_len);
  41 size_t keyval_array_decode(void *byte, keyval_array_t **kva);
  42 int keyval_array_copy_array(keyval_array_t *kva, void **array_val,
  43                 unsigned int array_len, size_t (*measure_val_len)(void * val));
  44 int keyval_array_get_data(keyval_array_t *kva, int *type, void ***array_val,
  45                 unsigned int *len, size_t **array_element_size);
  46 int keyval_array_set_element(keyval_array_t *kva,
  47                 int idx, void *val, size_t size);
  48 int keyval_array_is_idx_valid(keyval_array_t *kva, int idx);
  49
  50 #endif /* __KEYVAL_ARRAY_H__ */