cli_progress_reporter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef CLI_PROGRESS_REPORTER_H
#define CLI_PROGRESS_REPORTER_H
 
#include <wx/string.h>
#include <progress_reporter.h>
#include <kicommon.h>

class KICOMMON_API CLI_PROGRESS_REPORTER : public PROGRESS_REPORTER
{
public:
    CLI_PROGRESS_REPORTER() :
            m_verbose( false )
    { }
 
    virtual ~CLI_PROGRESS_REPORTER() { }
 
    static CLI_PROGRESS_REPORTER& GetInstance();

    void SetVerbose( bool aVerbose ) { m_verbose = aVerbose; }
 
    bool GetVerbose() const { return m_verbose; }

    virtual void SetNumPhases( int aNumPhases ) override {}
    virtual void AddPhases( int aNumPhases ) override {};

    virtual void BeginPhase( int aPhase ) override {}

    virtual void AdvancePhase() override {}

    virtual void AdvancePhase( const wxString& aMessage ) override;

    virtual void Report( const wxString& aMessage ) override;

    virtual void SetCurrentProgress( double aProgress ) override {}

    virtual void SetMaxProgress( int aMaxProgress ) override {}

    virtual void AdvanceProgress() override {}

    virtual bool KeepRefreshing( bool aWait = false ) override { return false; }

    virtual void SetTitle( const wxString& aTitle ) override {}
 
    virtual bool IsCancelled() const override { return false; }
 
 
private:
    void printLine( const wxString& aMessage );
 
    bool m_verbose;
};
 
#endif