array.h

Go to the documentation of this file.

// The MIT License (MIT)
// Copyright (c) 2017 Maksim Andrianov
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
#ifndef CDCONTAINERS_INCLUDE_CDCONTAINERS_VECTOR_H
#define CDCONTAINERS_INCLUDE_CDCONTAINERS_VECTOR_H

#include <cdcontainers/common.h>
#include <cdcontainers/status.h>

#include <assert.h>
#include <stdarg.h>
#include <stdbool.h>

struct cdc_array {
  size_t size;
  size_t capacity;
  void **buffer;
  struct cdc_data_info *dinfo;
};
// Base
enum cdc_stat cdc_array_ctor(struct cdc_array **v, struct cdc_data_info *info);

enum cdc_stat cdc_array_ctorl(struct cdc_array **v, struct cdc_data_info *info,
                              ...);

enum cdc_stat cdc_array_ctorv(struct cdc_array **v, struct cdc_data_info *info,
                              va_list args);

void cdc_array_dtor(struct cdc_array *v);
// Element access
static inline void *cdc_array_get(struct cdc_array *v, size_t index)
{
  assert(v != NULL);
  assert(index < v->size);

  return v->buffer[index];
}

enum cdc_stat cdc_array_at(struct cdc_array *v, size_t index, void **elem);

static inline void *cdc_array_front(struct cdc_array *v)
{
  assert(v != NULL);
  assert(v->size > 0);

  return v->buffer[0];
}

static inline void *cdc_array_back(struct cdc_array *v)
{
  assert(v != NULL);
  assert(v->size > 0);

  return v->buffer[v->size - 1];
}

static inline void **cdc_array_data(struct cdc_array *v)
{
  assert(v != NULL);

  return v->buffer;
}
// Capacity
enum cdc_stat cdc_array_reserve(struct cdc_array *v, size_t capacity);

static inline bool cdc_array_empty(struct cdc_array *v)
{
  assert(v != NULL);

  return v->size == 0;
}

static inline size_t cdc_array_size(struct cdc_array *v)
{
  assert(v != NULL);

  return v->size;
}

static inline size_t cdc_array_capacity(struct cdc_array *v)
{
  assert(v != NULL);

  return v->capacity;
}

enum cdc_stat cdc_array_shrink_to_fit(struct cdc_array *v);
// Modifiers
static inline void cdc_array_set(struct cdc_array *v, size_t index, void *value)
{
  assert(v != NULL);
  assert(index < v->size);

  v->buffer[index] = value;
}

enum cdc_stat cdc_array_insert(struct cdc_array *v, size_t index, void *value);

void cdc_array_erase(struct cdc_array *v, size_t index);

void cdc_array_clear(struct cdc_array *v);

enum cdc_stat cdc_array_push_back(struct cdc_array *v, void *value);

static inline void cdc_array_pop_back(struct cdc_array *v)
{
  assert(v != NULL);
  assert(v->size > 0);

  cdc_array_erase(v, v->size - 1);
}

enum cdc_stat cdc_array_append(struct cdc_array *v, void **data, size_t len);

enum cdc_stat cdc_array_append_move(struct cdc_array *v,
                                    struct cdc_array *other);

void cdc_array_swap(struct cdc_array *a, struct cdc_array *b);
// Short names
#ifdef CDC_USE_SHORT_NAMES
typedef struct cdc_array array_t;

// Base
#define array_ctor(...) cdc_array_ctor(__VA_ARGS__)
#define array_ctorl(...) cdc_array_ctorl(__VA_ARGS__)
#define array_ctorv(...) cdc_array_ctorv(__VA_ARGS__)
#define array_dtor(...) cdc_array_dtor(__VA_ARGS__)

// Element access
#define array_get(...) cdc_array_get(__VA_ARGS__)
#define array_at(...) cdc_array_at(__VA_ARGS__)
#define array_front(...) cdc_array_front(__VA_ARGS__)
#define array_back(...) cdc_array_back(__VA_ARGS__)
#define array_data(...) cdc_array_data(__VA_ARGS__)

// Capacity
#define array_reserve(...) cdc_array_reserve(__VA_ARGS__)
#define array_empty(...) cdc_array_empty(__VA_ARGS__)
#define array_size(...) cdc_array_size(__VA_ARGS__)
#define array_capacity(...) cdc_array_capacity(__VA_ARGS__)
#define array_cap_exp(...) cdc_array_cap_exp(__VA_ARGS__)
#define array_shrink_to_fit(...) cdc_array_shrink_to_fit(__VA_ARGS__)

// Modifiers
#define array_set(...) cdc_array_set(__VA_ARGS__)
#define array_insert(...) cdc_array_insert(__VA_ARGS__)
#define array_erase(...) cdc_array_erase(__VA_ARGS__)
#define array_clear(...) cdc_array_clear(__VA_ARGS__)
#define array_push_back(...) cdc_array_push_back(__VA_ARGS__)
#define array_pop_back(...) cdc_array_pop_back(__VA_ARGS__)
#define array_append(...) cdc_array_append(__VA_ARGS__)
#define array_append_move(...) cdc_array_append_move(__VA_ARGS__)
#define array_swap(...) cdc_array_swap(__VA_ARGS__)
#endif

#endif  // CDSTRUCTURES_INCLUDE_CDCONTAINERS_VECTOR_H