Class GapsIterator
Iterator class for Gaps.

Implements RandomAccessIteratorConcept
All Impl'd BidirectionalIteratorConcept, CopyConstructibleConcept, DefaultConstructibleConcept, EqualityComparableConcept, ForwardIteratorConcept, InputIteratorConcept, IteratorAssociatedTypesConcept, LessThanComparableConcept, RandomAccessIteratorConcept
Defined in  
Signature template <typename TGaps, typename TSpec> class Iter<TGaps, GapsIterator<TSpec> >;

Template Parameters

TGaps The Gaps object for the iterator.
TSpec The specializing tag.

Member Function Overview

Member Functions Inherited From EqualityComparableConcept

Member Functions Inherited From LessThanComparableConcept

Member Functions Inherited From RandomAccessIteratorConcept

Interface Function Overview

Interface Functions Inherited From BidirectionalIteratorConcept

Interface Functions Inherited From InputIteratorConcept

Interface Functions Inherited From IteratorAssociatedTypesConcept

Interface Functions Inherited From RandomAccessIteratorConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From IteratorAssociatedTypesConcept

Interface Metafunctions Inherited From RandomAccessIteratorConcept

Interface Functions Detail

TSize countCharacters(it[, dir]);

Count characters at iterator.

Parameters

it Iterator for counting characters at.
dir A tag to specify the counting direction. One of GapDirectionTags. Defaults to RightOfViewPos.

Returns

TSize Number of characters.

If the the direction tag is RightOfViewPos the current view position will be included in the count, and excluded when LeftOfViewPos is selected.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TSize countGaps(it[, dir]);

Count gaps at iterator.

Parameters

it Iterator for counting gaps at.
dir A tag to specify the counting direction. One of GapDirectionTags. Defaults to RightOfViewPos.

Returns

TSize Number of gaps.

If the the direction tag is RightOfViewPos the current view position will be included in the count, and excluded when LeftOfViewPos is selected.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void insertGap(it);

Insert gap at the current position.

Parameters

it The iterator to insert gaps at.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void insertGaps(it, num);

Insert gaps at the current position.

Parameters

it Remove gap at the given position (if any).
num Number of gaps to insert.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

bool isCharacter(it);

Query an iterator for being at a character

Parameters

it Iterator to query for pointing at a character.

Returns

bool true if it is at a character and false otherwise.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

bool isGap(it);

Query an iterator for being at a gap

Parameters

it Iterator to query for pointing at a gap.

Returns

bool true if it is at a gap and false otherwise.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TSize removeGap(it);

Insert gap at the current position.

Parameters

it Remove gap at the given position (if any).

Returns

TSize Number of removed gaps.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TSize removeGaps(it, num);

Remove gaps from the current position.

Parameters

it Remove gap at the given position (if any).
num Number of gaps to remove.

Returns

TSize Number of removed gaps.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.