WaveTrackUtilities::AllClipsIterator Class Reference

#include <WaveTrackUtilities.h>

Inheritance diagram for WaveTrackUtilities::AllClipsIterator:

Collaboration diagram for WaveTrackUtilities::AllClipsIterator:

Public Member Functions
	AllClipsIterator ()
	AllClipsIterator (WaveTrack &track)
value_type	operator* () const
AllClipsIterator &	operator++ ()

Private Types
using	Stack = std::vector< std::pair< IntervalHolders, size_t > >

Private Member Functions
void	Push (IntervalHolders clips)

Private Attributes
WaveTrack *	mpTrack {}
Stack	mStack

Friends
bool	operator== (const AllClipsIterator &a, const AllClipsIterator &b)
	Define == well enough to serve for loop termination test. More...
bool	operator!= (const AllClipsIterator &a, const AllClipsIterator &b)

Additional Inherited Members
Public Types inherited from ValueIterator< IntervalHolder >
using	iterator_category = std::forward_iterator_tag
using	value_type = IntervalHolder
using	difference_type = ptrdiff_t
using	pointer = void
using	reference = const IntervalHolder

Detailed Description

Get mutative access to all clips (in some unspecified sequence), including those hidden in cutlines.

If clips are added to the track during the visit, not all may be visited. If a clip is removed from the track during the visit, there will not be dangling pointers, but a clip not in the track may be visited.

Definition at line 51 of file WaveTrackUtilities.h.

Member Typedef Documentation

Stack

using WaveTrackUtilities::AllClipsIterator::Stack = std::vector<std::pair<IntervalHolders, size_t> >

private

Definition at line 74 of file WaveTrackUtilities.h.

Constructor & Destructor Documentation

AllClipsIterator() [1/2]

WaveTrackUtilities::AllClipsIterator::AllClipsIterator ( )

inline

Definition at line 55 of file WaveTrackUtilities.h.

{}

AllClipsIterator() [2/2]

WaveTrackUtilities::AllClipsIterator::AllClipsIterator ( WaveTrack &  track )

explicit

---

Audacity: A Digital Audio Editor

WaveTrackUtilities.cpp

Paul Licameli

Definition at line 17 of file WaveTrackUtilities.cpp.

   : mpTrack(&track)
{
   if (mpTrack) {
      auto &&clips = mpTrack->Intervals();
      Push({ clips.begin(), clips.end() });
   }
}

References WaveTrack::Intervals(), mpTrack, and Push().

Here is the call graph for this function:

Member Function Documentation

operator*()

auto WaveTrackUtilities::AllClipsIterator::operator*

(

)

const

Definition at line 27 of file WaveTrackUtilities.cpp.

{
   if (mStack.empty())
      return nullptr;
   else {
      auto &[intervals, ii] = mStack.back();
      return intervals[ii];
   }
}

operator++()

auto WaveTrackUtilities::AllClipsIterator::operator++

(

)

Definition at line 37 of file WaveTrackUtilities.cpp.

{
   // The unspecified sequence is a post-order, but there is no
   // promise whether sister nodes are ordered in time.
   if (mpTrack && !mStack.empty()) {
      auto &[intervals, ii] = mStack.back();
      if (++ii == intervals.size())
         mStack.pop_back();
      else
         Push(intervals[ii]->GetCutLines());
   }
 
   return *this;
}

Push()

void WaveTrackUtilities::AllClipsIterator::Push ( IntervalHolders  clips )

private

Definition at line 52 of file WaveTrackUtilities.cpp.

{
   if (!mpTrack)
      return;
 
   // Go depth first while there are cutlines
   while (!clips.empty()) {
      auto nextClips = clips[0]->GetCutLines();
      mStack.push_back({ move(clips), 0 });
      clips = move(nextClips);
   }
}

Referenced by AllClipsIterator().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator!=

bool operator!= ( const AllClipsIterator &  a, const AllClipsIterator &  b  )

friend

Definition at line 69 of file WaveTrackUtilities.h.

   { return !(a == b); }

operator==

bool operator== ( const AllClipsIterator &  a, const AllClipsIterator &  b  )

friend

Define == well enough to serve for loop termination test.

Definition at line 65 of file WaveTrackUtilities.h.

   { return a.mStack.empty() == b.mStack.empty(); }

Member Data Documentation

mpTrack

WaveTrack* WaveTrackUtilities::AllClipsIterator::mpTrack {}

private

Definition at line 77 of file WaveTrackUtilities.h.

Referenced by AllClipsIterator().

mStack

Stack WaveTrackUtilities::AllClipsIterator::mStack

private

Definition at line 78 of file WaveTrackUtilities.h.

---

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

• WaveTrackUtilities.h
• WaveTrackUtilities.cpp