KiCad PCB EDA Suite
Loading...
Searching...
No Matches
io_base.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20
21#ifndef IO_BASE_H_
22#define IO_BASE_H_
23
24#include <map>
25#include <vector>
26#include <string>
27
28#include <kicommon.h>
29#include <core/utf8.h>
30#include <wx/string.h>
32
33class REPORTER;
35
37{
38public:
43 {
44 wxString m_Description;
45 std::vector<std::string> m_FileExtensions;
46 std::vector<std::string> m_ExtensionsInDir;
47 bool m_IsFile;
48 bool m_CanRead;
50
51 IO_FILE_DESC( const wxString& aDescription, const std::vector<std::string>& aFileExtensions,
52 const std::vector<std::string>& aExtsInFolder = {}, bool aIsFile = true,
53 bool aCanRead = true, bool aCanWrite = true ) :
54 m_Description( aDescription ),
55 m_FileExtensions( aFileExtensions ), m_ExtensionsInDir( aExtsInFolder ),
56 m_IsFile( aIsFile ), m_CanRead( aCanRead ), m_CanWrite( aCanWrite )
57 {
58 }
59
60 IO_FILE_DESC() : IO_FILE_DESC( wxEmptyString, {} ) {}
61
65 wxString FileFilter() const;
66
67 operator bool() const { return !m_Description.empty(); }
68 };
69
70 virtual ~IO_BASE() = default;
71
75 const wxString& GetName() const { return m_name; }
76
80 virtual void SetReporter( REPORTER* aReporter ) { m_reporter = aReporter; }
81
85 virtual void SetProgressReporter( PROGRESS_REPORTER* aReporter ) { m_progressReporter = aReporter; }
86
87
89 // Library-related functions
91
97 virtual const IO_FILE_DESC GetLibraryDesc() const = 0;
98
106 virtual const IO_FILE_DESC GetLibraryFileDesc() const { return GetLibraryDesc(); }
107
115 virtual bool CanReadLibrary( const wxString& aFileName ) const;
116
133 virtual void CreateLibrary( const wxString& aLibraryPath,
134 const std::map<std::string, UTF8>* aProperties = nullptr );
135
153 virtual bool DeleteLibrary( const wxString& aLibraryPath,
154 const std::map<std::string, UTF8>* aProperties = nullptr );
155
166 virtual bool IsLibraryWritable( const wxString& aLibraryPath );
167
192 virtual void GetLibraryOptions( std::map<std::string, UTF8>* aListToAppendTo ) const;
193
194 virtual void Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED );
195
196 virtual void AdvanceProgressPhase();
197
198protected:
199 // Delete the zero-argument base constructor to force proper construction
200 IO_BASE() = delete;
201
206 IO_BASE( const wxString& aName ) :
207 m_name( aName ),
208 m_reporter( nullptr ),
209 m_progressReporter( nullptr )
210 {
211 }
212
213
215 wxString m_name;
216
219
222};
223
224#endif // IO_BASE_H_
IO_BASE()=delete
const wxString & GetName() const
Return a brief hard coded name for this IO interface.
Definition: io_base.h:75
REPORTER * m_reporter
Reporter to log errors/warnings to, may be nullptr.
Definition: io_base.h:218
wxString m_name
Name of the IO loader.
Definition: io_base.h:215
virtual const IO_FILE_DESC GetLibraryFileDesc() const
Get the descriptor for the individual library elements that this IO plugin operates on.
Definition: io_base.h:106
IO_BASE(const wxString &aName)
Definition: io_base.h:206
virtual ~IO_BASE()=default
virtual const IO_FILE_DESC GetLibraryDesc() const =0
Get the descriptor for the library container that this IO plugin operates on.
virtual void SetReporter(REPORTER *aReporter)
Set an optional reporter for warnings/errors.
Definition: io_base.h:80
virtual void SetProgressReporter(PROGRESS_REPORTER *aReporter)
Set an optional progress reporter.
Definition: io_base.h:85
PROGRESS_REPORTER * m_progressReporter
Progress reporter to track the progress of the operation, may be nullptr.
Definition: io_base.h:221
A progress reporter interface for use in multi-threaded environments.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:72
#define KICOMMON_API
Definition: kicommon.h:28
SEVERITY
@ RPT_SEVERITY_UNDEFINED
Container that describes file type info.
Definition: io_base.h:43
std::vector< std::string > m_ExtensionsInDir
In case of folders: extensions of files inside.
Definition: io_base.h:46
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)
Definition: io_base.h:51
bool m_IsFile
Whether the library is a folder or a file.
Definition: io_base.h:47
wxString m_Description
Description shown in the file picker dialog.
Definition: io_base.h:44
bool m_CanWrite
Whether the IO can write this file type.
Definition: io_base.h:49
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
Definition: io_base.h:45
bool m_CanRead
Whether the IO can read this file type.
Definition: io_base.h:48