sequence.h

#ifndef FILESEQ_SEQUENCE_H_
#define FILESEQ_SEQUENCE_H_
 
#include "frameset.h"
#include "pad.h"
 
#include <ostream>
#include <memory>
#include <vector>
 
namespace fileseq {
 
class FileSequence;
 
 
// Fwd Decl
namespace internal {
 
class FileSequenceData;
 
} // internal
 
 
// typedefs
typedef std::vector<FileSequence> FileSequences;
 
 
 
class FileSequence {
 
public:
    FileSequence();
 
    explicit FileSequence(const std::string &path, Status* ok=nullptr);
 
    FileSequence(const std::string &path, PadStyle padStyle, Status* ok=nullptr);
 
    virtual ~FileSequence();
 
    // Copy constructor
    FileSequence(const FileSequence& rhs);
 
    // Assignment
    FileSequence& operator=(FileSequence rhs);
 
    // Swap functionality
    friend void swap(FileSequence &first, FileSequence &second);
 
    bool isValid() const;
 
    operator bool() const { return isValid(); }; // NOLINT(*-explicit-constructor)
 
    std::string string() const;
 
    operator std::string() const { return string(); } // NOLINT(*-explicit-constructor)
 
    friend std::ostream& operator<< (std::ostream& stream, const FileSequence& fs) {
        stream << fs.string();
        return stream;
    }
 
    size_t length() const;
 
    Frame start() const;
 
    Frame end() const;
 
    int zfill() const;
 
    std::string format(const std::string &fmt, Status* ok=nullptr) const;
 
    const std::string& dirname() const;
 
    void setDirname(const std::string &dirname);
 
    const std::string& basename() const;
 
    void setBasename(const std::string &basename);
 
    const std::string& ext() const;
 
    void setExt(const std::string &ext);
 
    const std::string& padding() const;
 
    void setPadding(const std::string &padChars);
 
    PadStyle paddingStyle() const;
 
    void setPaddingStyle(PadStyle style);
 
    std::string frameRange(bool padded=false) const;
 
    void setFrameRange(const std::string &frange, Status* ok=nullptr);
 
    std::string invertedFrameRange(bool padded=false) const;
 
    std::string index(size_t idx) const;
 
    std::string frame(Frame frame) const;
 
    std::string frame(const std::string &fillPattern) const;
 
    const FrameSet& frameSet() const;
 
    void setFrameSet(const FrameSet &frameSet);
 
private:
    bool init(const std::string &frange, PadStyle padStyle, Status* ok=nullptr);
 
    friend FileSequence findSequenceOnDisk(const std::string &pattern, Status* ok);
    friend FileSequence findSequenceOnDisk(const std::string &pattern, PadStyle style, Status* ok);
 
    friend Status findSequencesOnDisk(FileSequences &seqs,
                                      const std::string &path,
                                      bool hiddenFiles,
                                      bool singleFiles,
                                      PadStyle style);
private:
    std::unique_ptr<internal::FileSequenceData> m_seqData;
    FrameSet m_frameSet;
 
};
 
} // fileseq
 
#endif // FILESEQ_SEQUENCE_H_