tesseract::ELIST_ITERATOR Class Reference

#include <elst.h>

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

Friends
void	ELIST::assign_to_sublist (ELIST_ITERATOR *, ELIST_ITERATOR *)

Detailed Description

Definition at line 188 of file elst.h.

Constructor & Destructor Documentation

ELIST_ITERATOR() [1/2]

tesseract::ELIST_ITERATOR::ELIST_ITERATOR ( )

inline

Definition at line 204 of file elst.h.

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

ELIST_ITERATOR() [2/2]

tesseract::ELIST_ITERATOR::ELIST_ITERATOR ( ELIST *  list_to_iterate )

inlineexplicit

Definition at line 322 of file elst.h.

                                                            {
  set_to_list(list_to_iterate);
}

Member Function Documentation

add_after_stay_put()

void tesseract::ELIST_ITERATOR::add_after_stay_put ( ELIST_LINK *  new_link )

inline

Definition at line 380 of file elst.h.

                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_after_stay_put", ABORT);
  }
  if (!new_element) {
    BAD_PARAMETER.error("ELIST_ITERATOR::add_after_stay_put", ABORT, "new_element is nullptr");
  }
  if (new_element->next) {
    STILL_LINKED.error("ELIST_ITERATOR::add_after_stay_put", ABORT);
  }
#endif
 
  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 tesseract::ELIST_ITERATOR::add_after_then_move ( ELIST_LINK *  new_link )

inline

Definition at line 333 of file elst.h.

                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_after_then_move", ABORT);
  }
  if (!new_element) {
    BAD_PARAMETER.error("ELIST_ITERATOR::add_after_then_move", ABORT, "new_element is nullptr");
  }
  if (new_element->next) {
    STILL_LINKED.error("ELIST_ITERATOR::add_after_then_move", ABORT);
  }
#endif
 
  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 tesseract::ELIST_ITERATOR::add_before_stay_put ( ELIST_LINK *  new_link )

inline

Definition at line 472 of file elst.h.

                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_before_stay_put", ABORT);
  }
  if (!new_element) {
    BAD_PARAMETER.error("ELIST_ITERATOR::add_before_stay_put", ABORT, "new_element is nullptr");
  }
  if (new_element->next) {
    STILL_LINKED.error("ELIST_ITERATOR::add_before_stay_put", ABORT);
  }
#endif
 
  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 tesseract::ELIST_ITERATOR::add_before_then_move ( ELIST_LINK *  new_link )

inline

Definition at line 429 of file elst.h.

                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_before_then_move", ABORT);
  }
  if (!new_element) {
    BAD_PARAMETER.error("ELIST_ITERATOR::add_before_then_move", ABORT, "new_element is nullptr");
  }
  if (new_element->next) {
    STILL_LINKED.error("ELIST_ITERATOR::add_before_then_move", ABORT);
  }
#endif
 
  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 tesseract::ELIST_ITERATOR::add_list_after ( ELIST *  list_to_add )

inline

Definition at line 517 of file elst.h.

                                                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_list_after", ABORT);
  }
  if (!list_to_add) {
    BAD_PARAMETER.error("ELIST_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 tesseract::ELIST_ITERATOR::add_list_before ( ELIST *  list_to_add )

inline

Definition at line 564 of file elst.h.

                                                              {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_list_before", ABORT);
  }
  if (!list_to_add) {
    BAD_PARAMETER.error("ELIST_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 tesseract::ELIST_ITERATOR::add_to_end ( ELIST_LINK *  new_link )

inline

Definition at line 775 of file elst.h.

                             {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::add_to_end", ABORT);
  }
  if (!new_element) {
    BAD_PARAMETER.error("ELIST_ITERATOR::add_to_end", ABORT, "new_element is nullptr");
  }
  if (new_element->next) {
    STILL_LINKED.error("ELIST_ITERATOR::add_to_end", ABORT);
  }
#endif
 
  if (this->at_last()) {
    this->add_after_stay_put(new_element);
  } else {
    if (this->at_first()) {
      this->add_before_stay_put(new_element);
      list->last = new_element;
    } else { // Iteratr is elsewhere
      new_element->next = list->last->next;
      list->last->next = new_element;
      list->last = new_element;
    }
  }
}

at_first()

bool tesseract::ELIST_ITERATOR::at_first ( ) const

inline

Definition at line 695 of file elst.h.

                                           {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::at_first", ABORT);
  }
#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 tesseract::ELIST_ITERATOR::at_last ( ) const

inline

Definition at line 715 of file elst.h.

                                          {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::at_last", ABORT);
  }
#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 tesseract::ELIST_ITERATOR::current_extracted ( ) const

inline

Definition at line 265 of file elst.h.

                                 { // current extracted?
    return !current;
  }

cycled_list()

bool tesseract::ELIST_ITERATOR::cycled_list ( ) const

inline

Definition at line 735 of file elst.h.

                                              {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::cycled_list", ABORT);
  }
#endif
 
  return ((list->empty()) || ((current == cycle_pt) && started_cycling));
}

data()

ELIST_LINK * tesseract::ELIST_ITERATOR::data ( )

inline

Definition at line 231 of file elst.h.

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

data_relative()

ELIST_LINK * tesseract::ELIST_ITERATOR::data_relative

(

int8_t

offset

)

Definition at line 215 of file elst.cpp.

                   {                       // offset from current
  ELIST_LINK *ptr;
 
#ifndef NDEBUG
  if (!list)
    NO_LIST.error("ELIST_ITERATOR::data_relative", ABORT);
  if (list->empty())
    EMPTY_LIST.error("ELIST_ITERATOR::data_relative", ABORT);
  if (offset < -1)
    BAD_PARAMETER.error("ELIST_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("ELIST_ITERATOR::data_relative", ABORT);
#endif
 
  return ptr;
}

empty()

bool tesseract::ELIST_ITERATOR::empty ( ) const

inline

Definition at line 256 of file elst.h.

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

exchange()

void tesseract::ELIST_ITERATOR::exchange

(

ELIST_ITERATOR *

other_it

)

Definition at line 275 of file elst.cpp.

                              { // other iterator
  constexpr ERRCODE DONT_EXCHANGE_DELETED("Can't exchange deleted elements of lists");
 
  ELIST_LINK *old_current;
 
#ifndef NDEBUG
  if (!list)
    NO_LIST.error("ELIST_ITERATOR::exchange", ABORT);
  if (!other_it)
    BAD_PARAMETER.error("ELIST_ITERATOR::exchange", ABORT, "other_it nullptr");
  if (!(other_it->list))
    NO_LIST.error("ELIST_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("ELIST_ITERATOR.exchange", ABORT);
  }
 
  /* 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()

ELIST_LINK * tesseract::ELIST_ITERATOR::extract ( )

inline

Definition at line 610 of file elst.h.

                                           {
  ELIST_LINK *extracted_link;
 
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::extract", ABORT);
  }
  if (!current) { // list empty or
                  // element extracted
    NULL_CURRENT.error("ELIST_ITERATOR::extract", ABORT);
  }
#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
 
    ex_current_was_last = (current == list->last);
    if (ex_current_was_last) {
      list->last = prev;
    }
  }
  // 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_link = current;
  extracted_link->next = nullptr; // for safety
  current = nullptr;
  return extracted_link;
}

forward()

ELIST_LINK * tesseract::ELIST_ITERATOR::forward

(

)

Definition at line 169 of file elst.cpp.

                                    {
#ifndef NDEBUG
  if (!list)
    NO_LIST.error("ELIST_ITERATOR::forward", ABORT);
#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("ELIST_ITERATOR::forward", ABORT);
#endif
  next = current->next;
 
#ifndef NDEBUG
  if (!next) {
    NULL_NEXT.error("ELIST_ITERATOR::forward", ABORT,
                    "This is: %p  Current is: %p",
                    static_cast<void *>(this),
                    static_cast<void *>(current));
  }
#endif
  return current;
}

length()

int32_t tesseract::ELIST_ITERATOR::length ( ) const

inline

Definition at line 282 of file elst.h.

                         {
    return list->length();
  }

mark_cycle_pt()

void tesseract::ELIST_ITERATOR::mark_cycle_pt ( )

inline

Definition at line 673 of file elst.h.

                                          {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::mark_cycle_pt", ABORT);
  }
#endif
 
  if (current) {
    cycle_pt = current;
  } else {
    ex_current_was_cycle_pt = true;
  }
  started_cycling = false;
}

move_to_first()

ELIST_LINK * tesseract::ELIST_ITERATOR::move_to_first ( )

inline

Definition at line 649 of file elst.h.

                                                 {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::move_to_first", ABORT);
  }
#endif
 
  current = list->First();
  prev = list->last;
  next = current ? current->next : nullptr;
  return current;
}

move_to_last()

ELIST_LINK * tesseract::ELIST_ITERATOR::move_to_last

(

)

Definition at line 252 of file elst.cpp.

                                         {
#ifndef NDEBUG
  if (!list)
    NO_LIST.error("ELIST_ITERATOR::move_to_last", ABORT);
#endif
 
  while (current != list->last) {
    forward();
  }
 
  return current;
}

set_to_list()

void tesseract::ELIST_ITERATOR::set_to_list ( ELIST *  list_to_iterate )

inline

Definition at line 298 of file elst.h.

                            {
#ifndef NDEBUG
  if (!list_to_iterate) {
    BAD_PARAMETER.error("ELIST_ITERATOR::set_to_list", ABORT, "list_to_iterate is nullptr");
  }
#endif
 
  list = list_to_iterate;
  prev = list->last;
  current = list->First();
  next = current ? 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 tesseract::ELIST_ITERATOR::sort ( int   comparator const void *, const void * )

inline

Definition at line 752 of file elst.h.

                                     {
#ifndef NDEBUG
  if (!list) {
    NO_LIST.error("ELIST_ITERATOR::sort", ABORT);
  }
#endif
 
  list->sort(comparator);
  move_to_first();
}

Friends And Related Function Documentation

ELIST::assign_to_sublist

void ELIST::assign_to_sublist ( ELIST_ITERATOR *  , ELIST_ITERATOR *    )

friend

---

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

• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/elst.h
• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/elst.cpp