CIQueue.h

Go to the documentation of this file.

/*
 * Copyright 2015 Brendan Bruner
 *
 * 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 OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * bbruner@ualberta.ca
 * Jun 24, 2016
 */
#ifndef UTIL_CIQUEUE_H_
#define UTIL_CIQUEUE_H_

#include <Class.h>


/************************************************************************/
/* Error codes.                             */
/************************************************************************/
typedef enum
{
    CIQUEUE_OK = 0,
    CIQUEUE_ERR_OVERFLOW = 1,
    CIQUEUE_ERR_UNDERFLOW = 2
} CIQueueError;


/************************************************************************/
/* Declare interface and vtable.                    */
/************************************************************************/
struct CIQueue
{
    /* CInterface must always be first member of */
    /* an interfaces struct .*/
    struct CInterface interface;
};

struct CIQueue_VTable
{
    CIQueueError (*insert)( struct CIQueue*, const void* );
    CIQueueError (*remove)( struct CIQueue*, void* );
    CIQueueError (*peek)( struct CIQueue*, void* );
    size_t (*size)( struct CIQueue* );
    size_t (*maxSize)( struct CIQueue* );
    void (*clear)( struct CIQueue* );
};


/************************************************************************/
/* Class methods.                           */
/************************************************************************/
CIQueueError CIQueue_Insert( struct CIQueue* self, const void* element );

CIQueueError CIQueue_Remove( struct CIQueue* self, void* element );

CIQueueError CIQueue_Peek( struct CIQueue* self, void* element );

size_t CIQueue_Size( struct CIQueue* self );

size_t CIQueue_MaxSize( struct CIQueue* self );

/*
 * TODO: clear method should allow user to enter a clean up function.
 */
void CIQueue_Clear( struct CIQueue* self );


#endif /* UTIL_CIQUEUE_H_ */