queue.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_QUEUE_H
#define CDCONTAINERS_INCLUDE_CDCONTAINERS_QUEUE_H

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

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

struct cdc_queue {
  void *container;
  const struct cdc_sequence_table *table;
};

enum cdc_stat cdc_queue_ctor(const struct cdc_sequence_table *table,
                             struct cdc_queue **q, struct cdc_data_info *info);

enum cdc_stat cdc_queue_ctorl(const struct cdc_sequence_table *table,
                              struct cdc_queue **q, struct cdc_data_info *info,
                              ...);

enum cdc_stat cdc_queue_ctorv(const struct cdc_sequence_table *table,
                              struct cdc_queue **q, struct cdc_data_info *info,
                              va_list args);

void cdc_queue_dtor(struct cdc_queue *q);

// Element access
static inline void *cdc_queue_front(struct cdc_queue *q)
{
  assert(q != NULL);

  return q->table->front(q->container);
}

static inline void *cdc_queue_back(struct cdc_queue *q)
{
  assert(q != NULL);

  return q->table->back(q->container);
}

// Capacity
static inline bool cdc_queue_empty(struct cdc_queue *q)
{
  assert(q != NULL);

  return q->table->empty(q->container);
}

static inline size_t cdc_queue_size(struct cdc_queue *q)
{
  assert(q != NULL);

  return q->table->size(q->container);
}

// Modifiers
static inline enum cdc_stat cdc_queue_push(struct cdc_queue *q, void *elem)
{
  assert(q != NULL);

  return q->table->push_back(q->container, elem);
}

static void cdc_queue_pop(struct cdc_queue *q)
{
  assert(q != NULL);

  q->table->pop_front(q->container);
}

void cdc_queue_swap(struct cdc_queue *a, struct cdc_queue *b);

// Short names
#ifdef CDC_USE_SHORT_NAMES
typedef struct cdc_queue queue_t;

#define queue_ctor(...) cdc_queue_ctor(__VA_ARGS__)
#define queue_ctorl(...) cdc_queue_ctorl(__VA_ARGS__)
#define queue_ctorv(...) cdc_queue_ctorv(__VA_ARGS__)
#define queue_dtor(...) cdc_queue_dtor(__VA_ARGS__)

// Element access
#define queue_front(...) cdc_queue_front(__VA_ARGS__)
#define queue_back(...) cdc_queue_back(__VA_ARGS__)

// Capacity
#define queue_empty(...) cdc_queue_empty(__VA_ARGS__)
#define queue_size(...) cdc_queue_size(__VA_ARGS__)

// Modifiers
#define queue_push(...) cdc_queue_push(__VA_ARGS__)
#define queue_pop(...) cdc_queue_pop(__VA_ARGS__)
#define queue_swap(...) cdc_queue_swap(__VA_ARGS__)
#endif

#endif  // CDCONTAINERS_INCLUDE_CDCONTAINERS_QUEUE_H