sopc_array.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you 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 OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_ARRAY_H_
#define SOPC_ARRAY_H_
 
#include <stdbool.h>
#include <stddef.h>
 
typedef struct _SOPC_Array SOPC_Array;
 
typedef void SOPC_Array_Free_Func(void* data);
 
typedef int SOPC_Array_Compare_Func(const void* a, const void* b);
 
SOPC_Array* SOPC_Array_Create(size_t element_size, size_t initial_capacity, SOPC_Array_Free_Func* free_func);
 
SOPC_Array* SOPC_Array_Copy(const SOPC_Array* array);
 
void SOPC_Array_Delete(SOPC_Array* array);
 
#define SOPC_Array_Append(array, val) SOPC_Array_Append_Values((array), &(val), 1)
 
bool SOPC_Array_Append_Values(SOPC_Array* array, const void* data, size_t n_elements);
 
#define SOPC_Array_Get(array, ty, index) (*((ty*) SOPC_Array_Get_Ptr((array), (index))))
 
void* SOPC_Array_Get_Ptr(const SOPC_Array* array, size_t index);
 
size_t SOPC_Array_Size(const SOPC_Array* array);
 
void SOPC_Array_Sort(SOPC_Array* array, SOPC_Array_Compare_Func* compare_func);
 
void* SOPC_Array_Into_Raw(SOPC_Array* array);
 
SOPC_Array_Free_Func* SOPC_Array_Get_Free_Func(SOPC_Array* array);
 
void SOPC_Array_Set_Free_Func(SOPC_Array* array, SOPC_Array_Free_Func* func);
 
#endif /* SOPC_ARRAY_H_ */