KiCad PCB EDA Suite
project_archiver.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) 2020 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 #ifndef KICAD_PROJECT_ARCHIVER_H
21 #define KICAD_PROJECT_ARCHIVER_H
22 
23 #include <wx/string.h>
24 
25 
26 class PROJECT;
27 class REPORTER;
28 class SETTINGS_MANAGER;
29 
30 
32 {
33 public:
35 
36  ~PROJECT_ARCHIVER() = default;
37 
46  bool Archive( const wxString& aSrcDir, const wxString& aDestFile, REPORTER& aReporter,
47  bool aVerbose = true );
48 
58  bool Unarchive( const wxString& aSrcFile, const wxString& aDestDir, REPORTER& aReporter );
59 };
60 
61 #endif // KICAD_PROJECT_ARCHIVER_H
PROJECT holds project specific data.
Definition: project.h:61
bool Archive(const wxString &aSrcDir, const wxString &aDestFile, REPORTER &aReporter, bool aVerbose=true)
Creates an archive of the project.
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
~PROJECT_ARCHIVER()=default
bool Unarchive(const wxString &aSrcFile, const wxString &aDestDir, REPORTER &aReporter)
Extracts an archive of the current project over existing files Warning: this will overwrite files in ...