Sequencer.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2004 Werner Mayer <wmayer[at]users.sourceforge.net>     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  is distributed in the hope that it will be useful,      *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef BASE_SEQUENCER_H
#define BASE_SEQUENCER_H

#include <vector>
#include <memory>
#include <CXX/Extensions.hxx>

#include "Exception.h"

namespace Base
{

class AbortException;
class SequencerLauncher;

class BaseExport SequencerBase
{
    friend class SequencerLauncher;

public:
    static SequencerBase& Instance();
    virtual bool isBlocking() const;
    bool setLocked(bool bLock);
    bool isLocked() const;
    bool isRunning() const;
    bool wasCanceled() const;

protected:
    bool start(const char* pszStr, size_t steps);
    size_t numberOfSteps() const;
    int progressInPercent() const;
    bool next(bool canAbort = false);
    bool stop();
    virtual void pause();
    virtual void resume();
    void tryToCancel();
    void rejectCancel();

protected:
    SequencerBase();
    virtual ~SequencerBase();
    virtual void setText (const char* pszTxt);
    virtual void startStep();
    virtual void nextStep(bool canAbort);
    virtual void setProgress(size_t);
    virtual void resetData();

protected:
    size_t nProgress; 
    size_t nTotalSteps; 
private:
    bool _bLocked; 
    bool _bCanceled; 
    int _nLastPercentage; 
};

class BaseExport EmptySequencer : public Base::SequencerBase
{
public:
    EmptySequencer();
    ~EmptySequencer();
};

class BaseExport ConsoleSequencer : public SequencerBase
{
public:
    ConsoleSequencer ();
    ~ConsoleSequencer ();

protected:
    void startStep();
    void nextStep(bool canAbort);

private:
    void setText (const char* pszTxt);
    void resetData();
};

class BaseExport SequencerLauncher
{
public:
    SequencerLauncher(const char* pszStr, size_t steps);
    ~SequencerLauncher();
    size_t numberOfSteps() const;
    void setText (const char* pszTxt);
    bool next(bool canAbort = false);
    void setProgress(size_t);
    bool wasCanceled() const;
};

inline SequencerBase& Sequencer ()
{
    return SequencerBase::Instance();
}

class BaseExport ProgressIndicatorPy : public Py::PythonExtension<ProgressIndicatorPy>
{
public:
    static void init_type(void);    // announce properties and methods

    ProgressIndicatorPy();
    ~ProgressIndicatorPy();

    Py::Object repr();

    Py::Object start(const Py::Tuple&);
    Py::Object next(const Py::Tuple&);
    Py::Object stop(const Py::Tuple&);

private:
    static PyObject *PyMake(struct _typeobject *, PyObject *, PyObject *);

private:
    std::auto_ptr<SequencerLauncher> _seq;
};

} // namespace Base

#endif // BASE_SEQUENCER_H