frameset.h

#ifndef FILESEQ_FRAMESET_H_
#define FILESEQ_FRAMESET_H_
 
#include "ranges/ranges.h"
 
#include <algorithm>
#include <inttypes.h>
#include <ostream>
#include <string>
#include <vector>
 
 
namespace fileseq {
 
// Forward decl
class Status;
class FileSequence;
 
 
namespace internal {
 
// Forward decl
class FrameSetData;
struct RangePatternMatch;
 
} // internal
 
 
// typedefs
typedef long Frame;
typedef std::vector<Frame> Frames;
 
 
class FrameSet {
 
public:
 explicit FrameSet(const std::string &frange, Status* ok=nullptr);
 
 FrameSet();
 
 // Destructor
 virtual ~FrameSet();
 
 // Copy constructor
 FrameSet(const FrameSet& rhs);
 
 // Assignment
 FrameSet& operator=(FrameSet rhs) {
 // Swap with copied arg
 swap(*this, rhs);
 return *this;
 }
 
 // Swap functionality
 friend void swap(FrameSet &first, FrameSet &second) {
 using std::swap;
 
 swap(first.m_frameData, second.m_frameData);
 }
 
 bool isValid() const;
 
 std::string string() const;
 
 operator std::string() const { return string(); }
 
 friend std::ostream& operator<< (std::ostream& stream, const FrameSet& fs) {
 stream << fs.string();
 return stream;
 }
 
 size_t length() const;
 
 size_t index(Frame frame) const;
 
 Frame frame(size_t index, Status* ok=nullptr) const;
 
 void frames(Frames &frames) const;
 
 RangesIterator iterFrames() const;
 
 bool hasFrame(Frame frame) const;
 
 Frame start() const;
 
 Frame end() const;
 
 std::string frameRange(int pad=0) const;
 
 FrameSet inverted() const;
 
 std::string invertedFrameRange(int pad) const;
 
 FrameSet normalized() const;
 
private:
 // Process a rangePattern match group
 void handleMatch(const internal::RangePatternMatch* match, Status* ok);
 
 // Reset the FrameSet to an invalid state;
 void setInvalid();
 
 internal::FrameSetData* m_frameData;
 
private:
 friend class FileSequence;
};
 
} // FILESEQ_FRAMESET_H_
 
#endif