polar-list-node.h

/* Internal API: root linked-list node 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_LIST_NODE_H
#define POLAR_LIST_NODE_H
// polar_list_node *****************************************************************************************************
 
typedef struct polar_list_node polar_list_node;
typedef struct polar_list_node_class polar_list_node_class;
 
struct polar_list_node
{
  polar_runtime_object data_inherited;
  polar_list_node *node_next;
};
 
struct polar_list_node_class
{
  polar_runtime_object_class data_inherited;
};
 
#define POLAR_TYPE_LIST_NODE ( polar_list_node_get_type() )
 
#define POLAR_LIST_NODE(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_CAST((inst), POLAR_TYPE_LIST_NODE, polar_list_node) )
#define POLAR_IS_LIST_NODE(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_TYPE((inst), POLAR_TYPE_LIST_NODE) )
#define POLAR_LIST_NODE_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_CAST((klass), POLAR_TYPE_LIST_NODE, polar_list_node_class) )
#define POLAR_IS_LIST_NODE_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_TYPE((klass), POLAR_TYPE_LIST_NODE) )
#define POLAR_LIST_NODE_GET_CLASS(inst) ( POLAR_INTERNAL_TYPE_INSTANCE_GET_CLASS((inst), POLAR_TYPE_LIST_NODE, polar_list_node_class) )
 
POLAR_FUNCTION_INTERNAL OBJC_FUNCTION_CONSTANT polar_internal_type
polar_list_node_get_type( void );
 
POLAR_FUNCTION_INTERNAL intptr_t
polar_list_node_list_free( polar_list_node **p_node_first );
 
POLAR_FUNCTION_INTERNAL polar_list_node *
polar_list_node_list_reverse( polar_list_node **p_node_first );
 
POLAR_FUNCTION_INTERNAL polar_list_node *
polar_list_node_list_concat( polar_list_node **p_list1, polar_list_node *list2 );
 
static inline polar_list_node *
polar_list_node_list_push_first( polar_list_node **p_list, polar_list_node *node_new )
{
  assert( p_list != NULL );
  assert( POLAR_IS_LIST_NODE(node_new) );
 
  node_new->node_next = *p_list;
  *p_list = node_new;
 
  return node_new;
}
 
static inline polar_list_node *
polar_list_node_list_pop_first( polar_list_node **p_list )
{
  polar_list_node *result;
 
  assert( p_list != NULL );
 
  result = *p_list;
  if( result != NULL )
  {
    assert( POLAR_IS_LIST_NODE(result) );
 
    *p_list = result->node_next;
    result->node_next = NULL;
  }
 
  return result;
}
 
#endif // POLAR_LIST_NODE_H