Piles

Go to the documentation of this file.

#ifndef GUARD_PROGRESS_H_INCLUDE
#define GUARD_PROGRESS_H_INCLUDE

#include <progress/progress-config.h>
#include <QList>
#include <QString>
#include <stdint.h>

class PROGRESS_EXPORT Progress {
    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */

    struct Portion {
        int64_t offset_in_parent_;
        int64_t size_in_parent_;

        int64_t tot_size_;
        int64_t progress_;

        void * user_data_;

        QString current_status_;
    };

    typedef bool (*KbSignal) (
            int64_t total_size,
            int64_t progress,
            const QString & status,
            void * level_data,
            void * global_data);

    typedef bool (*KbSignalSimple) (
            int64_t total_size,
            int64_t progress);

public:

    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:

    QList<Portion> stack_; 
    int cutoff_level_; 
    int64_t granularity_; 
    int64_t prev_prog_; 
    bool b_should_stop_;
    QString current_status_;
    void * user_data_;

    KbSignalSimple kb_simple_signal_;
    KbSignal kb_full_signal_;

    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */


public:

    explicit Progress ();

    virtual
    ~Progress ();


    bool
    init (
            const QString & title = QString (),
            int64_t total_size = 100);

    void
    end ();

    inline bool
    isInitialized () const {
        return !stack_.isEmpty ();
    }


    void
    enter (
            int64_t parent_size,
            const QString &label = QString (),
            int64_t total_size = 100,
            int64_t parent_offset = -1,
            void * portion_data = NULL);


    void
    finish (
            bool update_parent = true);


    inline const QString &
    currentStatus () const {
        return current_status_;
    }


    inline int
    cutoffLevel () const {
        return cutoff_level_;
    }

    inline void
    setCutoffLevel (
            int value) {
        cutoff_level_ = value;
    }


    inline int64_t
    granularity () const {
        return granularity_;
    }

    inline void
    setGranularity (int64_t value) {
        granularity_ = value;
    }


    inline void *
    userData () const {
        return user_data_;
    }

    inline void
    setUserData (void * value) {
        user_data_ = value;
    }


    inline KbSignalSimple
    simpleCallback () const {
        return kb_simple_signal_;
    }

    inline void
    setSimpleCallback (KbSignalSimple value) {
        kb_simple_signal_ = value;
    }


    inline KbSignal
    callback () const {
        return kb_full_signal_;
    }

    inline void
    setCallback (KbSignal value) {
        kb_full_signal_ = value;
    }


    bool
    step (
            int64_t chunk_size = 1,
            int64_t offset = -1);

    inline void
    setStop () {
        b_should_stop_ = true;
    }

    inline void
    resetStop () {
        b_should_stop_ = false;
    }

    inline bool
    shouldStop () const {
        return b_should_stop_;
    }

    inline bool
    emitSigal ();

    inline void
    setLevelCharact (
            int64_t total_size,
            int64_t progress = 0);


private:

    QString
    searchCurrentLabel ();

    void
    signalChange (
            bool b_bypass_checks = false);


}; // class Progress


#endif // GUARD_PROGRESS_H_INCLUDE