CLIST_ITERATOR Class Reference

#include <clst.h>

Public Member Functions
	CLIST_ITERATOR ()
	CLIST_ITERATOR (CLIST *list_to_iterate)
void	set_to_list (CLIST *list_to_iterate)
void	add_after_then_move (void *new_data)
void	add_after_stay_put (void *new_data)
void	add_before_then_move (void *new_data)
void	add_before_stay_put (void *new_data)
void	add_list_after (CLIST *list_to_add)
void	add_list_before (CLIST *list_to_add)
void *	data ()
void *	data_relative (int8_t offset)
void *	forward ()
void *	extract ()
void *	move_to_first ()
void *	move_to_last ()
void	mark_cycle_pt ()
bool	empty ()
bool	current_extracted ()
bool	at_first ()
bool	at_last ()
bool	cycled_list ()
void	add_to_end (void *new_data)
void	exchange (CLIST_ITERATOR *other_it)
int32_t	length ()
void	sort (int comparator(const void *, const void *))

Friends
void	CLIST::assign_to_sublist (CLIST_ITERATOR *, CLIST_ITERATOR *)

Detailed Description

Definition at line 145 of file clst.h.

Constructor & Destructor Documentation

CLIST_ITERATOR() [1/2]

CLIST_ITERATOR::CLIST_ITERATOR ( )

inline

Definition at line 166 of file clst.h.

                     {  //constructor
      list = nullptr;
    }                            //unassigned list

CLIST_ITERATOR() [2/2]

CLIST_ITERATOR::CLIST_ITERATOR ( CLIST *  list_to_iterate )

inline

Definition at line 280 of file clst.h.

                                                            {
  set_to_list(list_to_iterate);
}

Member Function Documentation

add_after_stay_put()

void CLIST_ITERATOR::add_after_stay_put ( void *  new_data )

inline

Definition at line 338 of file clst.h.

                                                               {
  CLIST_LINK *new_element;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_after_stay_put", ABORT, nullptr);
  if (!new_data)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_after_stay_put", ABORT,
      "new_data is nullptr");
  #endif

  new_element = new CLIST_LINK;
  new_element->data = new_data;

  if (list->empty ()) {
    new_element->next = new_element;
    list->last = new_element;
    prev = next = new_element;
    ex_current_was_last = false;
    current = nullptr;
  }
  else {
    new_element->next = next;

    if (current) {               //not extracted
      current->next = new_element;
      if (prev == current)
        prev = new_element;
      if (current == list->last)
        list->last = new_element;
    }
    else {                       //current extracted
      prev->next = new_element;
      if (ex_current_was_last) {
        list->last = new_element;
        ex_current_was_last = false;
      }
    }
    next = new_element;
  }
}

add_after_then_move()

void CLIST_ITERATOR::add_after_then_move ( void *  new_data )

inline

Definition at line 291 of file clst.h.

                                                                {
  CLIST_LINK *new_element;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_after_then_move", ABORT, nullptr);
  if (!new_data)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_after_then_move", ABORT,
      "new_data is nullptr");
  #endif

  new_element = new CLIST_LINK;
  new_element->data = new_data;

  if (list->empty ()) {
    new_element->next = new_element;
    list->last = new_element;
    prev = next = new_element;
  }
  else {
    new_element->next = next;

    if (current) {               //not extracted
      current->next = new_element;
      prev = current;
      if (current == list->last)
        list->last = new_element;
    }
    else {                       //current extracted
      prev->next = new_element;
      if (ex_current_was_last)
        list->last = new_element;
      if (ex_current_was_cycle_pt)
        cycle_pt = new_element;
    }
  }
  current = new_element;
}

add_before_stay_put()

void CLIST_ITERATOR::add_before_stay_put ( void *  new_data )

inline

Definition at line 432 of file clst.h.

                                                                {
  CLIST_LINK *new_element;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_before_stay_put", ABORT, nullptr);
  if (!new_data)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_before_stay_put", ABORT,
      "new_data is nullptr");
  #endif

  new_element = new CLIST_LINK;
  new_element->data = new_data;

  if (list->empty ()) {
    new_element->next = new_element;
    list->last = new_element;
    prev = next = new_element;
    ex_current_was_last = true;
    current = nullptr;
  }
  else {
    prev->next = new_element;
    if (current) {               //not extracted
      new_element->next = current;
      if (next == current)
        next = new_element;
    }
    else {                       //current extracted
      new_element->next = next;
      if (ex_current_was_last)
        list->last = new_element;
    }
    prev = new_element;
  }
}

add_before_then_move()

void CLIST_ITERATOR::add_before_then_move ( void *  new_data )

inline

Definition at line 388 of file clst.h.

                                                                 {
  CLIST_LINK *new_element;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_before_then_move", ABORT, nullptr);
  if (!new_data)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_before_then_move", ABORT,
      "new_data is nullptr");
  #endif

  new_element = new CLIST_LINK;
  new_element->data = new_data;

  if (list->empty ()) {
    new_element->next = new_element;
    list->last = new_element;
    prev = next = new_element;
  }
  else {
    prev->next = new_element;
    if (current) {               //not extracted
      new_element->next = current;
      next = current;
    }
    else {                       //current extracted
      new_element->next = next;
      if (ex_current_was_last)
        list->last = new_element;
      if (ex_current_was_cycle_pt)
        cycle_pt = new_element;
    }
  }
  current = new_element;
}

add_list_after()

void CLIST_ITERATOR::add_list_after ( CLIST *  list_to_add )

inline

Definition at line 478 of file clst.h.

                                                             {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_list_after", ABORT, nullptr);
  if (!list_to_add)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_list_after", ABORT,
      "list_to_add is nullptr");
  #endif

  if (!list_to_add->empty ()) {
    if (list->empty ()) {
      list->last = list_to_add->last;
      prev = list->last;
      next = list->First ();
      ex_current_was_last = true;
      current = nullptr;
    }
    else {
      if (current) {             //not extracted
        current->next = list_to_add->First ();
        if (current == list->last)
          list->last = list_to_add->last;
        list_to_add->last->next = next;
        next = current->next;
      }
      else {                     //current extracted
        prev->next = list_to_add->First ();
        if (ex_current_was_last) {
          list->last = list_to_add->last;
          ex_current_was_last = false;
        }
        list_to_add->last->next = next;
        next = prev->next;
      }
    }
    list_to_add->last = nullptr;
  }
}

add_list_before()

void CLIST_ITERATOR::add_list_before ( CLIST *  list_to_add )

inline

Definition at line 525 of file clst.h.

                                                              {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_list_before", ABORT, nullptr);
  if (!list_to_add)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_list_before", ABORT,
      "list_to_add is nullptr");
  #endif

  if (!list_to_add->empty ()) {
    if (list->empty ()) {
      list->last = list_to_add->last;
      prev = list->last;
      current = list->First ();
      next = current->next;
      ex_current_was_last = false;
    }
    else {
      prev->next = list_to_add->First ();
      if (current) {             //not extracted
        list_to_add->last->next = current;
      }
      else {                     //current extracted
        list_to_add->last->next = next;
        if (ex_current_was_last)
          list->last = list_to_add->last;
        if (ex_current_was_cycle_pt)
          cycle_pt = prev->next;
      }
      current = prev->next;
      next = current->next;
    }
    list_to_add->last = nullptr;
  }
}

add_to_end()

void CLIST_ITERATOR::add_to_end ( void *  new_data )

inline

Definition at line 747 of file clst.h.

                                                       {
  CLIST_LINK *new_element;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::add_to_end", ABORT, nullptr);
  if (!new_data)
    BAD_PARAMETER.error ("CLIST_ITERATOR::add_to_end", ABORT,
      "new_data is nullptr");
  #endif

  if (this->at_last ()) {
    this->add_after_stay_put (new_data);
  }
  else {
    if (this->at_first ()) {
      this->add_before_stay_put (new_data);
      list->last = prev;
    }
    else {                       //Iteratr is elsewhere
      new_element = new CLIST_LINK;
      new_element->data = new_data;

      new_element->next = list->last->next;
      list->last->next = new_element;
      list->last = new_element;
    }
  }
}

at_first()

bool CLIST_ITERATOR::at_first ( )

inline

Definition at line 653 of file clst.h.

                                     {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::at_first", ABORT, nullptr);
  #endif

                                 //we're at a deleted
  return ((list->empty ()) || (current == list->First ()) || ((current == nullptr) &&
    (prev == list->last) &&      //NON-last pt between
    !ex_current_was_last));      //first and last
}

at_last()

bool CLIST_ITERATOR::at_last ( )

inline

Definition at line 672 of file clst.h.

                                    {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::at_last", ABORT, nullptr);
  #endif

                                 //we're at a deleted
  return ((list->empty ()) || (current == list->last) || ((current == nullptr) &&
    (prev == list->last) &&      //last point between
    ex_current_was_last));       //first and last
}

current_extracted()

bool CLIST_ITERATOR::current_extracted ( )

inline

Definition at line 225 of file clst.h.

                             {  //current extracted?
      return !current;
    }

cycled_list()

bool CLIST_ITERATOR::cycled_list ( )

inline

Definition at line 691 of file clst.h.

                                        {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::cycled_list", ABORT, nullptr);
  #endif

  return ((list->empty ()) || ((current == cycle_pt) && started_cycling));

}

data()

void* CLIST_ITERATOR::data ( )

inline

Definition at line 194 of file clst.h.

                 {  //get current data
    #ifndef NDEBUG
      if (!list)
        NO_LIST.error ("CLIST_ITERATOR::data", ABORT, nullptr);
      if (!current)
        NULL_DATA.error ("CLIST_ITERATOR::data", ABORT, nullptr);
    #endif
      return current->data;
    }

data_relative()

void * CLIST_ITERATOR::data_relative

(

int8_t

offset

)

Definition at line 285 of file clst.cpp.

                                                   {  //offset from current
  CLIST_LINK *ptr;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::data_relative", ABORT, nullptr);
  if (list->empty ())
    EMPTY_LIST.error ("CLIST_ITERATOR::data_relative", ABORT, nullptr);
  if (offset < -1)
    BAD_PARAMETER.error ("CLIST_ITERATOR::data_relative", ABORT,
      "offset < -l");
  #endif

  if (offset == -1)
    ptr = prev;
  else
    for (ptr = current ? current : prev; offset-- > 0; ptr = ptr->next);

  #ifndef NDEBUG
  if (!ptr)
    NULL_DATA.error ("CLIST_ITERATOR::data_relative", ABORT, nullptr);
  #endif

  return ptr->data;
}

empty()

bool CLIST_ITERATOR::empty ( )

inline

Definition at line 217 of file clst.h.

                 {  //is list empty?
    #ifndef NDEBUG
      if (!list)
        NO_LIST.error ("CLIST_ITERATOR::empty", ABORT, nullptr);
    #endif
      return list->empty ();
    }

exchange()

void CLIST_ITERATOR::exchange

(

CLIST_ITERATOR *

other_it

)

Definition at line 345 of file clst.cpp.

                                                        {  //other iterator
  const ERRCODE DONT_EXCHANGE_DELETED =
    "Can't exchange deleted elements of lists";

  CLIST_LINK *old_current;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::exchange", ABORT, nullptr);
  if (!other_it)
    BAD_PARAMETER.error ("CLIST_ITERATOR::exchange", ABORT, "other_it nullptr");
  if (!(other_it->list))
    NO_LIST.error ("CLIST_ITERATOR::exchange", ABORT, "other_it");
  #endif

  /* Do nothing if either list is empty or if both iterators reference the same
  link */

  if ((list->empty ()) ||
    (other_it->list->empty ()) || (current == other_it->current))
    return;

  /* Error if either current element is deleted */

  if (!current || !other_it->current)
    DONT_EXCHANGE_DELETED.error ("CLIST_ITERATOR.exchange", ABORT, nullptr);

  /* Now handle the 4 cases: doubleton list; non-doubleton adjacent elements
  (other before this); non-doubleton adjacent elements (this before other);
  non-adjacent elements. */

                                 //adjacent links
  if ((next == other_it->current) ||
  (other_it->next == current)) {
                                 //doubleton list
    if ((next == other_it->current) &&
    (other_it->next == current)) {
      prev = next = current;
      other_it->prev = other_it->next = other_it->current;
    }
    else {                       //non-doubleton with
                                 //adjacent links
                                 //other before this
      if (other_it->next == current) {
        other_it->prev->next = current;
        other_it->current->next = next;
        current->next = other_it->current;
        other_it->next = other_it->current;
        prev = current;
      }
      else {                     //this before other
        prev->next = other_it->current;
        current->next = other_it->next;
        other_it->current->next = current;
        next = current;
        other_it->prev = other_it->current;
      }
    }
  }
  else {                         //no overlap
    prev->next = other_it->current;
    current->next = other_it->next;
    other_it->prev->next = current;
    other_it->current->next = next;
  }

  /* update end of list pointer when necessary (remember that the 2 iterators
    may iterate over different lists!) */

  if (list->last == current)
    list->last = other_it->current;
  if (other_it->list->last == other_it->current)
    other_it->list->last = current;

  if (current == cycle_pt)
    cycle_pt = other_it->cycle_pt;
  if (other_it->current == other_it->cycle_pt)
    other_it->cycle_pt = cycle_pt;

  /* The actual exchange - in all cases*/

  old_current = current;
  current = other_it->current;
  other_it->current = old_current;
}

extract()

void * CLIST_ITERATOR::extract ( )

inline

Definition at line 570 of file clst.h.

                                     {
  void *extracted_data;

  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::extract", ABORT, nullptr);
  if (!current)                  //list empty or
                                 //element extracted
    NULL_CURRENT.error ("CLIST_ITERATOR::extract",
      ABORT, nullptr);
  #endif

  if (list->singleton()) {
    // Special case where we do need to change the iterator.
    prev = next = list->last = nullptr;
  } else {
    prev->next = next;           //remove from list

    if (current == list->last) {
      list->last = prev;
      ex_current_was_last = true;
    } else {
      ex_current_was_last = false;
    }
  }
  // Always set ex_current_was_cycle_pt so an add/forward will work in a loop.
  ex_current_was_cycle_pt = (current == cycle_pt);
  extracted_data = current->data;
  delete(current);  //destroy CONS cell
  current = nullptr;
  return extracted_data;
}

forward()

void * CLIST_ITERATOR::forward

(

)

Definition at line 245 of file clst.cpp.

                              {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::forward", ABORT, nullptr);
  #endif
  if (list->empty ())
    return nullptr;

  if (current) {                 //not removed so
                                 //set previous
    prev = current;
    started_cycling = TRUE;
    // In case next is deleted by another iterator, get next from current.
    current = current->next;
  } else {
    if (ex_current_was_cycle_pt)
      cycle_pt = next;
    current = next;
  }

  #ifndef NDEBUG
  if (!current)
    NULL_DATA.error ("CLIST_ITERATOR::forward", ABORT, nullptr);
  if (!next)
    NULL_NEXT.error ("CLIST_ITERATOR::forward", ABORT,
                     "This is: %p  Current is: %p", this, current);
  #endif

  next = current->next;
  return current->data;
}

length()

int32_t CLIST_ITERATOR::length ( )

inline

Definition at line 708 of file clst.h.

                                      {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::length", ABORT, nullptr);
  #endif

  return list->length ();
}

mark_cycle_pt()

void CLIST_ITERATOR::mark_cycle_pt ( )

inline

Definition at line 633 of file clst.h.

                                          {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::mark_cycle_pt", ABORT, nullptr);
  #endif

  if (current)
    cycle_pt = current;
  else
    ex_current_was_cycle_pt = TRUE;
  started_cycling = FALSE;
}

move_to_first()

void * CLIST_ITERATOR::move_to_first ( )

inline

Definition at line 610 of file clst.h.

                                           {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::move_to_first", ABORT, nullptr);
  #endif

  current = list->First ();
  prev = list->last;
  next = current != nullptr ? current->next : nullptr;
  return current != nullptr ? current->data : nullptr;
}

move_to_last()

void * CLIST_ITERATOR::move_to_last

(

)

Definition at line 320 of file clst.cpp.

                                   {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::move_to_last", ABORT, nullptr);
  #endif

  while (current != list->last)
    forward();

  if (current == nullptr)
    return nullptr;
  else
    return current->data;
}

set_to_list()

void CLIST_ITERATOR::set_to_list ( CLIST *  list_to_iterate )

inline

Definition at line 256 of file clst.h.

                                                                {
  #ifndef NDEBUG
  if (!list_to_iterate)
    BAD_PARAMETER.error ("CLIST_ITERATOR::set_to_list", ABORT,
      "list_to_iterate is nullptr");
  #endif

  list = list_to_iterate;
  prev = list->last;
  current = list->First ();
  next = current != nullptr ? current->next : nullptr;
  cycle_pt = nullptr;               //await explicit set
  started_cycling = false;
  ex_current_was_last = false;
  ex_current_was_cycle_pt = false;
}

sort()

void CLIST_ITERATOR::sort ( int   comparator const void *, const void * )

inline

Definition at line 725 of file clst.h.

                             {
  #ifndef NDEBUG
  if (!list)
    NO_LIST.error ("CLIST_ITERATOR::sort", ABORT, nullptr);
  #endif

  list->sort (comparator);
  move_to_first();
}

Friends And Related Function Documentation

CLIST::assign_to_sublist

void CLIST::assign_to_sublist ( CLIST_ITERATOR *  , CLIST_ITERATOR *    )

friend

---

The documentation for this class was generated from the following files:

• /usr/src/tesseract-ocr.master/src/ccutil/clst.h
• /usr/src/tesseract-ocr.master/src/ccutil/clst.cpp