CIIterator.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
 * July 7, 2016
 */
#ifndef UTIL_CIITERATOR_H_
#define UTIL_CIITERATOR_H_

#include <Class.h>

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

struct CIIterator_VTable
{
    CBool (*hasNext)( struct CIIterator* );
    void (*next)( struct CIIterator*, void* );
    CBool (*hasPrevious)( struct CIIterator* );
    void (*previous)( struct CIIterator*, void* );
    CBool (*set)( struct CIIterator*, void* );
    CBool (*remove)( struct CIIterator* );
    size_t (*index)( struct CIIterator* );
};


/************************************************************************/
/* Method declarations.                         */
/************************************************************************/
CBool CIIterator_HasNext( struct CIIterator* self );

void CIIterator_Next( struct CIIterator* self, void* element );

CBool CIIterator_HasPrevious( struct CIIterator* self );

void CIIterator_Previous( struct CIIterator* self, void* element );

CBool CIIterator_Set( struct CIIterator* self, void* element );

CBool CIIterator_Remove( struct CIIterator* self );

size_t CIIterator_Index( struct CIIterator* self );


#endif /* UTIL_CIITERATOR_H_ */