CIList.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_CILIST_H_
#define UTIL_CILIST_H_

#include <Class.h>
#include <stdlib.h>
#include <CIIterator.h>


/************************************************************************/
/* Error codes                              */
/************************************************************************/
typedef enum
{
    CILIST_OK = 0,
    CILIST_ERR_FULL = 1,
    CILIST_ERR_EMPTY = 2,
    CILIST_ERR_INDEX = 3
} CIListError;

/************************************************************************/
/* Interface declaration.                       */
/************************************************************************/
struct CIList
{
    /* CInterface must always be first member of */
    /* an interface's struct .*/
    struct CInterface interface;
};

struct CIList_VTable
{
    CIListError (*add)( struct CIList*, void* );
    CIListError (*addAt)( struct CIList*, void*, size_t );
    CIListError (*get)( struct CIList*, void*, size_t );
    CIListError (*remove)( struct CIList*, void*, size_t );
    void (*clear)( struct CIList* );
    size_t (*size)( struct CIList* );
    size_t (*maxSize)( struct CIList* );
};


/************************************************************************/
/* Member functions.                            */
/************************************************************************/
CIListError CIList_Add( struct CIList* self, void* element );

CIListError CIList_AddAt( struct CIList* self, void* element, size_t index );

CIListError CIList_Get( struct CIList* self, void* element, size_t index );

CIListError CIList_Remove( struct CIList* self, void* element, size_t index );

void CIList_Clear( struct CIList* self);

size_t CIList_Size( struct CIList* self );

size_t CIList_MaxSize( struct CIList* self );

#endif /* UTIL_CILIST_H_ */