polar-iterator.h

/* Internal API: root iterator type for polar-objc.
   Copyright (C) 2022-2025 Michael Malicoat <[email protected]>
 
   This file is part of polar-objc.
 
   polar-objc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
 
   polar-objc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
   details.
 
   You should have received a copy of the GNU General Public License along with this program; see the file LICENSE.  If
   not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef POLAR_ITERATOR_H
#define POLAR_ITERATOR_H
// polar_iterator ******************************************************************************************************
 
typedef struct polar_iterator polar_iterator;
typedef struct polar_iterator_class polar_iterator_class;
 
struct polar_iterator
{
  polar_runtime_object data_inherited;
};
 
struct polar_iterator_class
{
  polar_runtime_object_class data_inherited;
 
  // Virtual methods
 
  BOOL
  (*get_next)( polar_iterator *self, void **out_next_element ) POLAR_FUNCTION_INTERNAL;
};
 
#define POLAR_TYPE_ITERATOR ( polar_iterator_get_type() )
 
#define POLAR_ITERATOR(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_CAST((inst), POLAR_TYPE_ITERATOR, polar_iterator) )
#define POLAR_IS_ITERATOR(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_TYPE((inst), POLAR_TYPE_ITERATOR) )
#define POLAR_ITERATOR_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_CAST((klass), POLAR_TYPE_ITERATOR, polar_iterator_class) )
#define POLAR_IS_ITERATOR_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_TYPE((klass), POLAR_TYPE_ITERATOR) )
#define POLAR_ITERATOR_GET_CLASS(inst) ( POLAR_INTERNAL_TYPE_INSTANCE_GET_CLASS((inst), POLAR_TYPE_ITERATOR, polar_iterator_class) )
 
POLAR_FUNCTION_INTERNAL OBJC_FUNCTION_CONSTANT polar_internal_type
polar_iterator_get_type( void );
 
static inline BOOL
polar_iterator_get_next( polar_iterator *self, void **out_next_element )
{
  assert( POLAR_IS_ITERATOR(self) );
 
  return POLAR_ITERATOR_GET_CLASS(self)->get_next(self, out_next_element);
}
 
#endif // POLAR_ITERATOR_H