wildcards_and_files_ext.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2007-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright (C) 1992-2023 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef INCLUDE_WILDCARDS_AND_FILES_EXT_H_
#define INCLUDE_WILDCARDS_AND_FILES_EXT_H_
 
#include <kicommon.h>
#include <string>
#include <vector>
#include <wx/string.h>
 
KICOMMON_API bool compareFileExtensions( const std::string& aExtension,
 const std::vector<std::string>& aReference, bool aCaseSensitive = false );
 
KICOMMON_API wxString AddFileExtListToFilter( const std::vector<std::string>& aExts );
 
KICOMMON_API wxString formatWildcardExt( const wxString& aWildcard );
 
 
class KICOMMON_API FILEEXT
{
public:
 FILEEXT() = delete;
 
 static const std::string BackupFileSuffix;
 static const std::string LockFilePrefix;
 static const std::string LockFileExtension;
 static const std::string AutoSaveFilePrefix;
 
 static const std::string SchematicSymbolFileExtension;
 static const std::string LegacySymbolLibFileExtension;
 static const std::string LegacySymbolDocumentFileExtension;
 static const std::string SchematicBackupFileExtension;
 
 static const std::string VrmlFileExtension;
 static const std::string ProjectFileExtension;
 static const std::string LegacyProjectFileExtension;
 static const std::string ProjectLocalSettingsFileExtension;
 static const std::string LegacySchematicFileExtension;
 static const std::string CadstarSchematicFileExtension;
 static const std::string CadstarPartsLibraryFileExtension;
 static const std::string KiCadSchematicFileExtension;
 static const std::string SpiceFileExtension;
 static const std::string CadstarNetlistFileExtension;
 static const std::string OrCadPcb2NetlistFileExtension;
 static const std::string NetlistFileExtension;
 static const std::string AllegroNetlistFileExtension;
 static const std::string PADSNetlistFileExtension;
 static const std::string GerberFileExtension;
 static const std::string GerberJobFileExtension;
 static const std::string HtmlFileExtension;
 static const std::string EquFileExtension;
 static const std::string HotkeyFileExtension;
 static const std::string DatabaseLibraryFileExtension;
 static const std::string HTTPLibraryFileExtension;
 
 static const std::string ArchiveFileExtension;
 
 static const std::string LegacyPcbFileExtension;
 static const std::string EaglePcbFileExtension;
 static const std::string CadstarPcbFileExtension;
 static const std::string KiCadPcbFileExtension;
 #define PcbFileExtension KiCadPcbFileExtension // symlink choice
 static const std::string KiCadSymbolLibFileExtension;
 static const std::string DrawingSheetFileExtension;
 static const std::string DesignRulesFileExtension;
 
 static const std::string LegacyFootprintLibPathExtension;
 static const std::string PdfFileExtension;
 static const std::string MacrosFileExtension;
 static const std::string FootprintAssignmentFileExtension;
 static const std::string DrillFileExtension;
 static const std::string SVGFileExtension;
 static const std::string ReportFileExtension;
 static const std::string FootprintPlaceFileExtension;
 static const std::string KiCadFootprintFileExtension;
 static const std::string KiCadFootprintLibPathExtension;
 static const std::string AltiumFootprintLibPathExtension;
 static const std::string CadstarFootprintLibPathExtension;
 static const std::string GedaPcbFootprintLibFileExtension;
 static const std::string EagleFootprintLibPathExtension;
 static const std::string SpecctraDsnFileExtension;
 static const std::string SpecctraSessionFileExtension;
 static const std::string IpcD356FileExtension;
 static const std::string Ipc2581FileExtension;
 static const std::string WorkbookFileExtension;
 
 static const std::string PngFileExtension;
 static const std::string JpegFileExtension;
 static const std::string TextFileExtension;
 static const std::string MarkdownFileExtension;
 static const std::string CsvFileExtension;
 static const std::string XmlFileExtension;
 static const std::string JsonFileExtension;
 
 static const std::string StepFileExtension;
 static const std::string StepFileAbrvExtension;
 static const std::string GltfBinaryFileExtension;
 static const std::string BrepFileExtension;
 
 static const wxString GerberFileExtensionsRegex;
 
 static bool IsGerberFileExtension( const wxString& ext );
 static wxString AllFilesWildcard();
 
 static wxString FootprintAssignmentFileWildcard();
 static wxString DrawingSheetFileWildcard();
 static wxString KiCadSymbolLibFileWildcard();
 static wxString ProjectFileWildcard();
 static wxString LegacyProjectFileWildcard();
 static wxString AllProjectFilesWildcard();
 static wxString AllSchematicFilesWildcard();
 static wxString KiCadSchematicFileWildcard();
 static wxString LegacySchematicFileWildcard();
 static wxString BoardFileWildcard();
 static wxString OrCadPcb2NetlistFileWildcard();
 static wxString NetlistFileWildcard();
 static wxString AllegroNetlistFileWildcard();
 static wxString PADSNetlistFileWildcard();
 static wxString HtmlFileWildcard();
 static wxString CsvFileWildcard();
 static wxString PcbFileWildcard();
 static wxString CadstarArchiveFilesWildcard();
 static wxString EagleFilesWildcard();
 static wxString EasyEdaArchiveWildcard();
 static wxString EasyEdaProFileWildcard();
 static wxString PdfFileWildcard();
 static wxString PSFileWildcard();
 static wxString MacrosFileWildcard();
 static wxString DrillFileWildcard();
 static wxString SVGFileWildcard();
 static wxString JsonFileWildcard();
 static wxString ReportFileWildcard();
 static wxString FootprintPlaceFileWildcard();
 static wxString Shapes3DFileWildcard();
 static wxString IDF3DFileWildcard();
 static wxString DocModulesFileName();
 static wxString KiCadFootprintLibFileWildcard();
 static wxString KiCadFootprintLibPathWildcard();
 static wxString TextFileWildcard();
 static wxString ModLegacyExportFileWildcard();
 static wxString ErcFileWildcard();
 static wxString SpiceLibraryFileWildcard();
 static wxString SpiceNetlistFileWildcard();
 static wxString CadstarNetlistFileWildcard();
 static wxString EquFileWildcard();
 static wxString ZipFileWildcard();
 static wxString GencadFileWildcard();
 static wxString DxfFileWildcard();
 static wxString GerberJobFileWildcard();
 static wxString SpecctraDsnFileWildcard();
 static wxString SpecctraSessionFileWildcard();
 static wxString IpcD356FileWildcard();
 static wxString WorkbookFileWildcard();
 static wxString PngFileWildcard();
 static wxString JpegFileWildcard();
 static wxString HotkeyFileWildcard();
 
};
 
 
#endif // INCLUDE_WILDCARDS_AND_FILES_EXT_H_