KiCad PCB EDA Suite
Loading...
Searching...
No Matches
wildcards_and_files_ext.cpp
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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
30#include <regex>
32#include <wx/filedlg.h>
33#include <wx/regex.h>
34#include <wx/translation.h>
35#include <regex>
36
37bool compareFileExtensions( const std::string& aExtension,
38 const std::vector<std::string>& aReference, bool aCaseSensitive )
39{
40 // Form the regular expression string by placing all possible extensions into it as alternatives
41 std::string regexString = "(";
42 bool first = true;
43
44 for( const std::string& ext : aReference )
45 {
46 // The | separate goes between the extensions
47 if( !first )
48 regexString += "|";
49 else
50 first = false;
51
52 regexString += ext;
53 }
54
55 regexString += ")";
56
57 // Create the regex and see if it matches
58 std::regex extRegex( regexString, aCaseSensitive ? std::regex::ECMAScript : std::regex::icase );
59 return std::regex_match( aExtension, extRegex );
60}
61
62
63wxString formatWildcardExt( const wxString& aWildcard )
64{
65 wxString wc;
66#if defined( __WXGTK__ )
67
68 for( const auto& ch : aWildcard )
69 {
70 if( wxIsalpha( ch ) )
71 wc += wxString::Format( "[%c%c]", wxTolower( ch ), wxToupper( ch ) );
72 else
73 wc += ch;
74 }
75
76 return wc;
77#else
78 wc = aWildcard;
79
80 return wc;
81#endif
82}
83
84
85wxString AddFileExtListToFilter( const std::vector<std::string>& aExts )
86{
87 if( aExts.size() == 0 )
88 {
89 // The "all files" wildcard is different on different systems
90 wxString filter;
91 filter << wxS( " (" ) << wxFileSelectorDefaultWildcardStr << wxS( ")|" )
92 << wxFileSelectorDefaultWildcardStr;
93 return filter;
94 }
95
96 wxString files_filter = wxS( " (" );
97
98 // Add extensions to the info message:
99 for( const std::string& ext : aExts )
100 {
101 if( files_filter.length() > 2 )
102 files_filter << wxS( "; " );
103
104 files_filter << "*." << ext;
105 }
106
107 files_filter << wxS( ")|*." );
108
109 // Add extensions to the filter list, using a formatted string (GTK specific):
110 bool first = true;
111
112 for( const std::string& ext : aExts )
113 {
114 if( !first )
115 files_filter << wxS( ";*." );
116
117 first = false;
118
119 files_filter << formatWildcardExt( ext );
120 }
121
122 return files_filter;
123}
124
125const std::string FILEEXT::BackupFileSuffix( "-bak" );
126const std::string FILEEXT::LockFilePrefix( "~" );
127const std::string FILEEXT::LockFileExtension( "lck" );
128const std::string FILEEXT::AutoSaveFilePrefix( "_autosave-" );
129
130const std::string FILEEXT::KiCadSymbolLibFileExtension( "kicad_sym" );
131const std::string FILEEXT::SchematicSymbolFileExtension( "sym" );
132const std::string FILEEXT::LegacySymbolLibFileExtension( "lib" );
133const std::string FILEEXT::LegacySymbolDocumentFileExtension( "dcm" );
134
135const std::string FILEEXT::VrmlFileExtension( "wrl" );
136
137const std::string FILEEXT::ProjectFileExtension( "kicad_pro" );
138const std::string FILEEXT::LegacyProjectFileExtension( "pro" );
139const std::string FILEEXT::ProjectLocalSettingsFileExtension( "kicad_prl" );
140const std::string FILEEXT::LegacySchematicFileExtension( "sch" );
141const std::string FILEEXT::CadstarSchematicFileExtension( "csa" );
142const std::string FILEEXT::CadstarPartsLibraryFileExtension( "lib" );
143const std::string FILEEXT::KiCadSchematicFileExtension( "kicad_sch" );
144const std::string FILEEXT::SpiceFileExtension( "cir" );
145const std::string FILEEXT::SpiceModelFileExtension( "model" );
146const std::string FILEEXT::SpiceSubcircuitFileExtension( "sub" );
147const std::string FILEEXT::IbisFileExtension( "ibs" );
148const std::string FILEEXT::CadstarNetlistFileExtension( "frp" );
149const std::string FILEEXT::OrCadPcb2NetlistFileExtension( "net" );
150const std::string FILEEXT::NetlistFileExtension( "net" );
151const std::string FILEEXT::AllegroNetlistFileExtension( "txt" );
152const std::string FILEEXT::PADSNetlistFileExtension( "asc" );
153const std::string FILEEXT::FootprintAssignmentFileExtension( "cmp" );
154const std::string FILEEXT::GerberFileExtension( "gbr" );
155const std::string FILEEXT::GerberJobFileExtension( "gbrjob" );
156const std::string FILEEXT::HtmlFileExtension( "html" );
157const std::string FILEEXT::EquFileExtension( "equ" );
158const std::string FILEEXT::HotkeyFileExtension( "hotkeys" );
159const std::string FILEEXT::DatabaseLibraryFileExtension( "kicad_dbl" );
160const std::string FILEEXT::HTTPLibraryFileExtension( "kicad_httplib" );
161const std::string FILEEXT::KiCadJobSetFileExtension( "kicad_jobset" );
162
163const std::string FILEEXT::ArchiveFileExtension( "zip" );
164
165const std::string FILEEXT::LegacyPcbFileExtension( "brd" );
166const std::string FILEEXT::EaglePcbFileExtension( "brd" );
167const std::string FILEEXT::CadstarPcbFileExtension( "cpa" );
168const std::string FILEEXT::KiCadPcbFileExtension( "kicad_pcb" );
169const std::string FILEEXT::DrawingSheetFileExtension( "kicad_wks" );
170const std::string FILEEXT::DesignRulesFileExtension( "kicad_dru" );
171
172const std::string FILEEXT::PdfFileExtension( "pdf" );
173const std::string FILEEXT::MacrosFileExtension( "mcr" );
174const std::string FILEEXT::DrillFileExtension( "drl" );
175const std::string FILEEXT::SVGFileExtension( "svg" );
176const std::string FILEEXT::ReportFileExtension( "rpt" );
177const std::string FILEEXT::FootprintPlaceFileExtension( "pos" );
178
179const std::string FILEEXT::KiCadFootprintLibPathExtension( "pretty" ); // this is a directory
180const std::string FILEEXT::LegacyFootprintLibPathExtension( "mod" ); // this is a file
181const std::string FILEEXT::AltiumFootprintLibPathExtension( "PcbLib" ); // this is a file
182const std::string FILEEXT::CadstarFootprintLibPathExtension( "cpa" ); // this is a file
183const std::string FILEEXT::EagleFootprintLibPathExtension( "lbr" ); // this is a file
184const std::string FILEEXT::GedaPcbFootprintLibFileExtension( "fp" ); // this is a file
185
186const std::string FILEEXT::KiCadFootprintFileExtension( "kicad_mod" );
187const std::string FILEEXT::SpecctraDsnFileExtension( "dsn" );
188const std::string FILEEXT::SpecctraSessionFileExtension( "ses" );
189const std::string FILEEXT::IpcD356FileExtension( "d356" );
190const std::string FILEEXT::Ipc2581FileExtension( "xml" );
191const std::string FILEEXT::WorkbookFileExtension( "wbk" );
192
193const std::string FILEEXT::KiCadDesignBlockLibPathExtension( "kicad_blocks" ); // this is a directory
194const std::string FILEEXT::KiCadDesignBlockPathExtension( "kicad_block" ); // this is a directory
195
196const std::string FILEEXT::PngFileExtension( "png" );
197const std::string FILEEXT::JpegFileExtension( "jpg" );
198const std::string FILEEXT::TextFileExtension( "txt" );
199const std::string FILEEXT::MarkdownFileExtension( "md" );
200const std::string FILEEXT::CsvFileExtension( "csv" );
201const std::string FILEEXT::TsvFileExtension( "tsv" );
202const std::string FILEEXT::XmlFileExtension( "xml" );
203const std::string FILEEXT::JsonFileExtension( "json" );
204const std::string FILEEXT::PythonFileExtension( "py" );
205
206const std::string FILEEXT::StepFileExtension( "step" );
207const std::string FILEEXT::StepFileAbrvExtension( "stp" );
208const std::string FILEEXT::GltfBinaryFileExtension( "glb" );
209const std::string FILEEXT::BrepFileExtension( "brep" );
210const std::string FILEEXT::XaoFileExtension( "xao" );
211const std::string FILEEXT::PlyFileExtension( "ply" );
212const std::string FILEEXT::StlFileExtension( "stl" );
213const std::string FILEEXT::U3DFileExtension( "u3d" );
214
215const std::string FILEEXT::GencadFileExtension( "cad" );
216
217const wxString
218 FILEEXT::GerberFileExtensionsRegex( "(gbr|gko|pho|(g[tb][alops])|(gm?\\d\\d*)|(gp[tb]))" );
219
220const std::string FILEEXT::FootprintLibraryTableFileName( "fp-lib-table" );
221const std::string FILEEXT::SymbolLibraryTableFileName( "sym-lib-table" );
222const std::string FILEEXT::DesignBlockLibraryTableFileName( "design-block-lib-table" );
223
224const std::string FILEEXT::KiCadUriPrefix( "kicad-embed" );
225
226
227bool FILEEXT::IsGerberFileExtension( const wxString& ext )
228{
229 static wxRegEx gerberRE( GerberFileExtensionsRegex, wxRE_ICASE );
230
231 return gerberRE.Matches( ext );
232}
233
234
236{
237 return _( "All files" ) + AddFileExtListToFilter( {} );
238}
239
240
242{
243 return _( "KiCad symbol library files" )
245}
246
247
249{
250 return _( "KiCad project files" ) + AddFileExtListToFilter( { ProjectFileExtension } );
251}
252
253
255{
256 return _( "KiCad legacy project files" )
258}
259
260
262{
263 return _( "All KiCad project files" )
265}
266
267
269{
270 return _( "All KiCad schematic files" )
272}
273
274
276{
277 return _( "KiCad legacy schematic files" )
279}
280
281
283{
284 return _( "KiCad s-expression schematic files" )
286}
287
288
290{
291 return _( "Altium Project files" ) + AddFileExtListToFilter( { "PrjPcb" } );
292}
293
294
296{
297 return _( "CADSTAR Archive files" ) + AddFileExtListToFilter( { "csa", "cpa" } );
298}
299
300
302{
303 return _( "Eagle XML files" ) + AddFileExtListToFilter( { "sch", "brd" } );
304}
305
306
308{
309 return _( "OrcadPCB2 netlist files" )
311}
312
313
315{
316 return _( "KiCad netlist files" ) + AddFileExtListToFilter( { "net" } );
317}
318
319
321{
322 return _( "Allegro netlist files" )
324}
325
326
328{
329 return _( "PADS netlist files" ) + AddFileExtListToFilter( { PADSNetlistFileExtension } );
330}
331
332
334{
335 return _( "EasyEDA (JLCEDA) Std backup archive" ) + AddFileExtListToFilter( { "zip" } );
336}
337
338
340{
341 return _( "EasyEDA (JLCEDA) Pro files" ) + AddFileExtListToFilter( { "epro", "zip" } );
342}
343
344
346{
347 return _( "KiCad printed circuit board files" )
349}
350
351
353{
354 return _( "KiCad footprint files" ) + AddFileExtListToFilter( { KiCadFootprintFileExtension } );
355}
356
357
359{
360 return _( "KiCad footprint library paths" )
362}
363
364
366{
367 return _( "KiCad design block path" )
369}
370
371
373{
374 return _( "KiCad design block library paths" )
376}
377
378
380{
381 return _( "Drawing sheet files" )
383}
384
385
386// Wildcard for cvpcb symbol to footprint link file
388{
389 return _( "KiCad symbol footprint link files" )
391}
392
393
394// Wildcard for reports and fabrication documents
396{
397 return _( "Drill files" )
398 + AddFileExtListToFilter( { DrillFileExtension, "nc", "xnc", "txt" } );
399}
400
401
403{
404 return _( "SVG files" ) + AddFileExtListToFilter( { SVGFileExtension } );
405}
406
407
409{
410 return _( "HTML files" ) + AddFileExtListToFilter( { "htm", "html" } );
411}
412
413
415{
416 return _( "CSV Files" ) + AddFileExtListToFilter( { CsvFileExtension } );
417}
418
419
421{
422 return _( "CSV/TSV Files" ) + AddFileExtListToFilter( { CsvFileExtension, TsvFileExtension } );
423}
424
425
427{
428 return _( "Portable document format files" ) + AddFileExtListToFilter( { "pdf" } );
429}
430
431
433{
434 return _( "PostScript files" ) + AddFileExtListToFilter( { "ps" } );
435}
436
437
439{
440 return _( "Json files" ) + AddFileExtListToFilter( { JsonFileExtension } );
441}
442
443
445{
446 return _( "Report files" ) + AddFileExtListToFilter( { ReportFileExtension } );
447}
448
449
451{
452 return _( "Component placement files" ) + AddFileExtListToFilter( { "pos" } );
453}
454
455
457{
458 return _( "VRML and X3D files" ) + AddFileExtListToFilter( { "wrl", "x3d" } );
459}
460
461
463{
464 return _( "IDFv3 footprint files" ) + AddFileExtListToFilter( { "idf" } );
465}
466
467
469{
470 return _( "Text files" ) + AddFileExtListToFilter( { "txt" } );
471}
472
473
475{
476 return _( "Legacy footprint export files" ) + AddFileExtListToFilter( { "emp" } );
477}
478
479
481{
482 return _( "Electrical rule check file" ) + AddFileExtListToFilter( { "erc" } );
483}
484
485
487{
488 return _( "SPICE library file" ) + AddFileExtListToFilter( { "lib", "mod" } );
489}
490
491
493{
494 return _( "SPICE netlist file" ) + AddFileExtListToFilter( { "cir" } );
495}
496
497
499{
500 return _( "CadStar netlist file" ) + AddFileExtListToFilter( { "frp" } );
501}
502
503
505{
506 return _( "Symbol footprint association files" ) + AddFileExtListToFilter( { "equ" } );
507}
508
509
511{
512 return _( "Zip file" ) + AddFileExtListToFilter( { "zip" } );
513}
514
515
517{
518 return _( "GenCAD 1.4 board files" ) + AddFileExtListToFilter( { GencadFileExtension } );
519}
520
521
523{
524 return _( "DXF Files" ) + AddFileExtListToFilter( { "dxf" } );
525}
526
527
529{
530 return _( "Gerber job file" ) + AddFileExtListToFilter( { GerberJobFileExtension } );
531}
532
533
535{
536 return _( "Specctra DSN file" )
538}
539
540
542{
543 return _( "Specctra Session file" )
545}
546
547
549{
550 return _( "IPC-D-356 Test Files" )
552}
553
554
556{
557 return _( "Workbook file" )
559}
560
561
563{
564 return _( "PNG file" ) + AddFileExtListToFilter( { "png" } );
565}
566
567
569{
570 return _( "Jpeg file" ) + AddFileExtListToFilter( { "jpg", "jpeg" } );
571}
572
573
575{
576 return _( "Hotkey file" ) + AddFileExtListToFilter( { HotkeyFileExtension } );
577}
578
579
581{
582 return _( "KiCad jobset files" ) + AddFileExtListToFilter( { KiCadJobSetFileExtension } );
583}
#define _(s)
static const std::string CadstarNetlistFileExtension
static const std::string LegacySchematicFileExtension
static const std::string KiCadDesignBlockLibPathExtension
static const std::string HtmlFileExtension
static const wxString GerberFileExtensionsRegex
static const std::string BrepFileExtension
static const std::string CadstarPartsLibraryFileExtension
static const std::string NetlistFileExtension
static const std::string KiCadDesignBlockPathExtension
static const std::string SymbolLibraryTableFileName
static const std::string JpegFileExtension
static const std::string GerberJobFileExtension
static const std::string StepFileAbrvExtension
static const std::string GerberFileExtension
static const std::string XaoFileExtension
static const std::string WorkbookFileExtension
static const std::string ReportFileExtension
static const std::string GltfBinaryFileExtension
static const std::string EquFileExtension
static const std::string LockFileExtension
static const std::string ProjectFileExtension
static const std::string PngFileExtension
static const std::string FootprintPlaceFileExtension
static const std::string JsonFileExtension
static const std::string AltiumFootprintLibPathExtension
static const std::string LegacyPcbFileExtension
static const std::string SchematicSymbolFileExtension
static const std::string XmlFileExtension
static const std::string LegacyProjectFileExtension
static const std::string ProjectLocalSettingsFileExtension
static const std::string EagleFootprintLibPathExtension
static const std::string KiCadSchematicFileExtension
static const std::string OrCadPcb2NetlistFileExtension
static const std::string LegacySymbolLibFileExtension
static const std::string KiCadUriPrefix
static const std::string DesignBlockLibraryTableFileName
static const std::string LockFilePrefix
static const std::string CsvFileExtension
static const std::string KiCadSymbolLibFileExtension
static const std::string U3DFileExtension
static const std::string TsvFileExtension
static const std::string SpiceFileExtension
static const std::string PdfFileExtension
static const std::string TextFileExtension
static const std::string Ipc2581FileExtension
static const std::string FootprintLibraryTableFileName
static const std::string PADSNetlistFileExtension
static const std::string GencadFileExtension
static const std::string StlFileExtension
static const std::string DrawingSheetFileExtension
static const std::string BackupFileSuffix
static const std::string AutoSaveFilePrefix
static const std::string IbisFileExtension
static const std::string IpcD356FileExtension
static const std::string KiCadJobSetFileExtension
static const std::string CadstarFootprintLibPathExtension
static const std::string GedaPcbFootprintLibFileExtension
static const std::string DatabaseLibraryFileExtension
static const std::string LegacyFootprintLibPathExtension
static const std::string CadstarSchematicFileExtension
static const std::string PlyFileExtension
static const std::string PythonFileExtension
static const std::string SpecctraDsnFileExtension
static const std::string StepFileExtension
static const std::string LegacySymbolDocumentFileExtension
static const std::string KiCadFootprintLibPathExtension
static const std::string FootprintAssignmentFileExtension
static const std::string SVGFileExtension
static const std::string EaglePcbFileExtension
static const std::string SpecctraSessionFileExtension
static const std::string HTTPLibraryFileExtension
static const std::string DrillFileExtension
static const std::string SpiceSubcircuitFileExtension
static const std::string MacrosFileExtension
static const std::string HotkeyFileExtension
static const std::string CadstarPcbFileExtension
static const std::string SpiceModelFileExtension
static const std::string DesignRulesFileExtension
static const std::string VrmlFileExtension
static const std::string MarkdownFileExtension
static const std::string KiCadFootprintFileExtension
static const std::string ArchiveFileExtension
static const std::string AllegroNetlistFileExtension
static const std::string KiCadPcbFileExtension
static wxString ProjectFileWildcard()
static wxString SpiceNetlistFileWildcard()
static wxString PngFileWildcard()
static wxString HotkeyFileWildcard()
static wxString EasyEdaArchiveWildcard()
static wxString ModLegacyExportFileWildcard()
static wxString FootprintPlaceFileWildcard()
static wxString ErcFileWildcard()
static wxString JpegFileWildcard()
static wxString OrCadPcb2NetlistFileWildcard()
static wxString AllFilesWildcard()
static wxString AllegroNetlistFileWildcard()
static wxString CadstarArchiveFilesWildcard()
static wxString SpecctraSessionFileWildcard()
static wxString TextFileWildcard()
static wxString CadstarNetlistFileWildcard()
static wxString KiCadDesignBlockLibPathWildcard()
static wxString EasyEdaProFileWildcard()
static wxString LegacySchematicFileWildcard()
static wxString DxfFileWildcard()
static wxString PdfFileWildcard()
static wxString KiCadDesignBlockPathWildcard()
static wxString SVGFileWildcard()
static wxString PADSNetlistFileWildcard()
static bool IsGerberFileExtension(const wxString &ext)
static wxString SpiceLibraryFileWildcard()
static wxString GerberJobFileWildcard()
static wxString JsonFileWildcard()
static wxString PcbFileWildcard()
static wxString KiCadSymbolLibFileWildcard()
static wxString KiCadFootprintLibFileWildcard()
static wxString KiCadFootprintLibPathWildcard()
static wxString NetlistFileWildcard()
static wxString PSFileWildcard()
static wxString EquFileWildcard()
static wxString AllSchematicFilesWildcard()
static wxString IDF3DFileWildcard()
static wxString HtmlFileWildcard()
static wxString SpecctraDsnFileWildcard()
static wxString DrawingSheetFileWildcard()
static wxString DrillFileWildcard()
static wxString FootprintAssignmentFileWildcard()
static wxString AltiumProjectFilesWildcard()
static wxString CsvTsvFileWildcard()
static wxString Shapes3DFileWildcard()
static wxString EagleFilesWildcard()
static wxString JobsetFileWildcard()
static wxString LegacyProjectFileWildcard()
static wxString IpcD356FileWildcard()
static wxString CsvFileWildcard()
static wxString AllProjectFilesWildcard()
static wxString KiCadSchematicFileWildcard()
static wxString GencadFileWildcard()
static wxString ReportFileWildcard()
static wxString ZipFileWildcard()
static wxString WorkbookFileWildcard()
wxString AddFileExtListToFilter(const std::vector< std::string > &aExts)
Build the wildcard extension file dialog wildcard filter to add to the base message dialog.
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.
bool compareFileExtensions(const std::string &aExtension, const std::vector< std::string > &aReference, bool aCaseSensitive)
Compare the given extension against the reference extensions to see if it matches any of the referenc...
Definition of file extensions used in Kicad.
KICOMMON_API wxString AddFileExtListToFilter(const std::vector< std::string > &aExts)
Build the wildcard extension file dialog wildcard filter to add to the base message dialog.