io_base.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 3 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 <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef IO_BASE_H_
#define IO_BASE_H_
 
#include <map>
#include <vector>
#include <string>
 
#include <kicommon.h>
#include <core/utf8.h>
#include <wx/string.h>
#include <widgets/report_severity.h>
 
class REPORTER;
class PROGRESS_REPORTER;
class DIALOG_SHIM;
class wxWindow;
 
class KICOMMON_API IO_BASE
{
public:
    struct KICOMMON_API IO_FILE_DESC
    {
        wxString                 m_Description;    

        std::vector<std::string> m_FileExtensions;

        std::vector<std::string> m_ExtensionsInDir;
        bool                     m_IsFile;          
        bool                     m_CanRead;         
        bool                     m_CanWrite;        
 
        IO_FILE_DESC( const wxString& aDescription, const std::vector<std::string>& aFileExtensions,
                      const std::vector<std::string>& aExtsInFolder = {}, bool aIsFile = true,
                      bool aCanRead = true, bool aCanWrite = true ) :
                m_Description( aDescription ),
                m_FileExtensions( aFileExtensions ), m_ExtensionsInDir( aExtsInFolder ),
                m_IsFile( aIsFile ), m_CanRead( aCanRead ), m_CanWrite( aCanWrite )
        {
        }
 
        IO_FILE_DESC() : IO_FILE_DESC( wxEmptyString, {} ) {}

        wxString FileFilter() const;
 
        operator bool() const { return !m_Description.empty(); }
    };
 
    virtual ~IO_BASE() = default;

    const wxString& GetName() const { return m_name; }

    virtual void SetReporter( REPORTER* aReporter ) { m_reporter = aReporter; }

    virtual void SetProgressReporter( PROGRESS_REPORTER* aReporter )
    {
        m_progressReporter = aReporter;
    }

    // Library-related functions

    virtual const IO_FILE_DESC GetLibraryDesc() const = 0;

    virtual const IO_FILE_DESC GetLibraryFileDesc() const { return GetLibraryDesc(); }

    virtual bool CanReadLibrary( const wxString& aFileName ) const;

    virtual void CreateLibrary( const wxString& aLibraryPath,
                                const std::map<std::string, UTF8>* aProperties = nullptr );

    virtual bool DeleteLibrary( const wxString& aLibraryPath,
                                const std::map<std::string, UTF8>* aProperties = nullptr );

    virtual bool IsLibraryWritable( const wxString& aLibraryPath );

    virtual void GetLibraryOptions( std::map<std::string, UTF8>* aListToAppendTo ) const;
 

    virtual bool SupportsConfigurationDialog() const { return false; }

    virtual DIALOG_SHIM* CreateConfigurationDialog( wxWindow* aParent ) { return nullptr; }
 
    virtual void Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED );
 
    virtual void AdvanceProgressPhase();
 
protected:
    // Delete the zero-argument base constructor to force proper construction
    IO_BASE() = delete;

    IO_BASE( const wxString& aName ) :
        m_name( aName ),
        m_reporter( nullptr ),
        m_progressReporter( nullptr )
    {
    }
 

    wxString m_name;

    REPORTER* m_reporter;

    PROGRESS_REPORTER* m_progressReporter;
};
 
#endif // IO_BASE_H_