KiCad PCB EDA Suite
File Extension Definitions

Macros

#define PcbFileExtension   KiCadPcbFileExtension
 

Functions

bool compareFileExtensions (const std::string &aExtension, const std::vector< std::string > &aReference, bool aCaseSensitive=false)
 Compare the given extension against the reference extensions to see if it matches any of the reference extensions. More...
 
wxString AddFileExtListToFilter (const std::vector< std::string > &aExts)
 Build the wildcard extension file dialog wildcard filter to add to the base message dialog. More...
 
wxString formatWildcardExt (const wxString &aWildcard)
 Format wildcard extension to support case sensitive file dialogs. More...
 
bool IsProtelExtension (const wxString &ext)
 

Variables

const std::string SchematicSymbolFileExtension
 
const std::string SchematicLibraryFileExtension
 
const std::string SchematicBackupFileExtension
 
const std::string VrmlFileExtension
 
const std::string ProjectFileExtension
 
const std::string SchematicFileExtension
 
const std::string NetlistFileExtension
 
const std::string GerberFileExtension
 
const std::string GerberJobFileExtension
 
const std::string HtmlFileExtension
 
const std::string EquFileExtension
 
const std::string LegacyPcbFileExtension
 
const std::string KiCadPcbFileExtension
 
const std::string PageLayoutDescrFileExtension
 
const std::string LegacyFootprintLibPathExtension
 
const std::string PdfFileExtension
 
const std::string MacrosFileExtension
 
const std::string ComponentFileExtension
 
const std::string DrillFileExtension
 
const std::string SVGFileExtension
 
const std::string ReportFileExtension
 
const std::string FootprintPlaceFileExtension
 
const std::string KiCadFootprintFileExtension
 
const std::string KiCadFootprintLibPathExtension
 
const std::string GedaPcbFootprintLibFileExtension
 
const std::string EagleFootprintLibPathExtension
 
const std::string KiCadLib3DShapesPathExtension
 
const std::string SpecctraDsnFileExtension
 
const std::string IpcD356FileExtension
 
const std::string PngFileExtension
 
const std::string JpegFileExtension
 

Detailed Description

Note
Please do not changes these. If a different file extension is needed, create a new definition in here. If you create a extension definition in another file, make sure to add it to the Doxygen group "file_extensions" using the "addtogroup" tag. Also note, just because they are defined as const doesn't guarantee that they cannot be changed.

Macro Definition Documentation

◆ PcbFileExtension

#define PcbFileExtension   KiCadPcbFileExtension

Definition at line 127 of file wildcards_and_files_ext.h.

Function Documentation

◆ AddFileExtListToFilter()

wxString AddFileExtListToFilter ( const std::vector< std::string > &  aExts)

Build the wildcard extension file dialog wildcard filter to add to the base message dialog.

For instance, to open .txt files in a file dialog: the base message is for instance "Text files" the ext list is " (*.txt)|*.txt" and the returned string to add to the base message is " (*.txt)|*.txt" the message to display in the dialog is "Text files (*.txt)|*.txt"

This function produces a case-insensitive filter (so .txt, .TXT and .tXT are all match if you pass "txt" into the function).

Parameters
aExtsis the list of exts to add to the filter. Do not include the leading dot. Empty means "allow all files".
Returns
the appropriate file dialog wildcard filter list.

Definition at line 80 of file wildcards_and_files_ext.cpp.

81 {
82  if( aExts.size() == 0 )
83  {
84  // The "all files" wildcard is different on different systems
85  wxString filter;
86  filter << " (" << wxFileSelectorDefaultWildcardStr << ")|"
87  << wxFileSelectorDefaultWildcardStr;
88  return filter;
89  }
90 
91  wxString files_filter = " (";
92 
93  // Add extensions to the info message:
94  for( const auto& ext : aExts )
95  {
96  files_filter << " *." << ext;
97  }
98 
99  files_filter << ")|*.";
100 
101  // Add extensions to the filter list, using a formated string (GTK specific):
102  bool first = true;
103  for( const auto& ext : aExts )
104  {
105  if( !first )
106  files_filter << ";*.";
107 
108  first = false;
109 
110  files_filter << formatWildcardExt( ext );
111  }
112 
113  return files_filter;
114 }
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.

References formatWildcardExt().

Referenced by AllFilesWildcard(), CadstarNetlistFileWildcard(), ComponentFileWildcard(), CsvFileWildcard(), DrillFileWildcard(), DxfFileWildcard(), EagleFilesWildcard(), EagleFootprintLibPathWildcard(), EaglePcbFileWildcard(), EagleSchematicFileWildcard(), EquFileWildcard(), ErcFileWildcard(), FootprintPlaceFileWildcard(), GedaPcbFootprintLibFileWildcard(), GencadFileWildcard(), GerberFileWildcard(), GerberJobFileWildcard(), HtmlFileWildcard(), IDF3DFileWildcard(), IpcD356FileWildcard(), JpegFileWildcard(), KiCadFootprintLibFileWildcard(), KiCadFootprintLibPathWildcard(), LegacyFootprintLibPathWildcard(), LegacyPcbFileWildcard(), ModLegacyExportFileWildcard(), NetlistFileWildcard(), DIALOG_IMPORT_GFX::onBrowseFiles(), DIALOG_SELECT_NET_FROM_LIST::onReport(), PageLayoutDescrFileWildcard(), PCadPcbFileWildcard(), PcbFileWildcard(), PdfFileWildcard(), PngFileWildcard(), ProjectFileWildcard(), PSFileWildcard(), ReportFileWildcard(), SchematicFileWildcard(), SchematicLibraryFileWildcard(), SchematicSymbolFileWildcard(), Shapes3DFileWildcard(), SpecctraDsnFileWildcard(), SpiceLibraryFileWildcard(), SpiceNetlistFileWildcard(), SVGFileWildcard(), TextFileWildcard(), WorkbookFileWildcard(), and ZipFileWildcard().

◆ compareFileExtensions()

bool compareFileExtensions ( const std::string &  aExtension,
const std::vector< std::string > &  aReference,
bool  aCaseSensitive = false 
)

Compare the given extension against the reference extensions to see if it matches any of the reference extensions.

This function uses the C++ regular expression functionality to perform the comparison, so the reference extensions can be regular expressions of their own right. This means that partial searches can be made, for example ^g.* can be used to see if the first character of the extension is g. The reference extensions are concatenated together as alternatives when doing the evaluation (e.g. (dxf|svg|^g.*) ).

Parameters
aExtensionis the extension to test
aReferenceis a vector containing the extensions to test against
aCaseSensitivesays if the comparison should be case sensitive or not
Returns
if the extension matches any reference extensions

Definition at line 34 of file wildcards_and_files_ext.cpp.

36 {
37  // Form the regular expression string by placing all possible extensions into it as alternatives
38  std::string regexString = "(";
39  bool first = true;
40  for( auto ext : aReference )
41  {
42  // The | separate goes between the extensions
43  if( !first )
44  regexString += "|";
45  else
46  first = false;
47 
48  regexString += ext;
49  }
50  regexString += ")";
51 
52  // Create the regex and see if it matches
53  std::regex extRegex( regexString, aCaseSensitive ? std::regex::ECMAScript : std::regex::icase );
54  return std::regex_match( aExtension, extRegex );
55 }

Referenced by GRAPHICS_IMPORT_MGR::GetPluginByExt().

◆ formatWildcardExt()

wxString formatWildcardExt ( const wxString &  aWildcard)

Format wildcard extension to support case sensitive file dialogs.

The file extension wildcards of the GTK+ file dialog are case sensitive so using all lower case characters means that only file extensions that are all lower case will show up in the file dialog. The GTK+ file dialog does support regular expressions so the file extension is converted to a regular expression ( sch -> [sS][cC][hH] ) when wxWidgets is built against GTK+. Please make sure you call this function when adding new file wildcards.

Note
When calling wxFileDialog with a default file defined, make sure you include the file extension along with the file name. Otherwise, on GTK+ builds, the file dialog will append the wildcard regular expression as the file extension which is surely not what you want.
Parameters
aWildcardis the extension part of the wild card.
Returns
the build appropriate file dialog wildcard filter.

Definition at line 58 of file wildcards_and_files_ext.cpp.

59 {
60  wxString wc;
61 #if defined( __WXGTK__ )
62 
63  for( auto ch : aWildcard )
64  {
65  if( wxIsalpha( ch ) )
66  wc += wxString::Format( "[%c%c]", wxTolower( ch ), wxToupper( ch ) );
67  else
68  wc += ch;
69  }
70 
71  return wc;
72 #else
73  wc = aWildcard;
74 
75  return wc;
76 #endif
77 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format().

Referenced by AddFileExtListToFilter(), and GRAPHICS_IMPORT_PLUGIN::GetWildcards().

◆ IsProtelExtension()

bool IsProtelExtension ( const wxString &  ext)

Definition at line 156 of file wildcards_and_files_ext.cpp.

157 {
158  static wxRegEx protelRE( wxT( "(gm1)|(g[tb][lapos])|(g\\d\\d*)" ), wxRE_ICASE );
159 
160  return protelRE.Matches( ext );
161 }

Referenced by SAVE_AS_TRAVERSER::OnFile().

Variable Documentation

◆ ComponentFileExtension

const std::string ComponentFileExtension

◆ DrillFileExtension

◆ EagleFootprintLibPathExtension

const std::string EagleFootprintLibPathExtension

◆ EquFileExtension

const std::string EquFileExtension

◆ FootprintPlaceFileExtension

const std::string FootprintPlaceFileExtension

◆ GedaPcbFootprintLibFileExtension

const std::string GedaPcbFootprintLibFileExtension

◆ GerberFileExtension

const std::string GerberFileExtension

◆ GerberJobFileExtension

const std::string GerberJobFileExtension

◆ HtmlFileExtension

const std::string HtmlFileExtension

◆ IpcD356FileExtension

const std::string IpcD356FileExtension

◆ JpegFileExtension

const std::string JpegFileExtension

◆ KiCadFootprintFileExtension

◆ KiCadFootprintLibPathExtension

◆ KiCadLib3DShapesPathExtension

const std::string KiCadLib3DShapesPathExtension

◆ KiCadPcbFileExtension

◆ LegacyFootprintLibPathExtension

const std::string LegacyFootprintLibPathExtension

◆ LegacyPcbFileExtension

◆ MacrosFileExtension

const std::string MacrosFileExtension

◆ NetlistFileExtension

const std::string NetlistFileExtension

◆ PageLayoutDescrFileExtension

const std::string PageLayoutDescrFileExtension

◆ PdfFileExtension

const std::string PdfFileExtension

◆ PngFileExtension

const std::string PngFileExtension

◆ ProjectFileExtension

◆ ReportFileExtension

◆ SchematicBackupFileExtension

const std::string SchematicBackupFileExtension

◆ SchematicFileExtension

◆ SchematicLibraryFileExtension

◆ SchematicSymbolFileExtension

const std::string SchematicSymbolFileExtension

◆ SpecctraDsnFileExtension

const std::string SpecctraDsnFileExtension

◆ SVGFileExtension

const std::string SVGFileExtension

◆ VrmlFileExtension

const std::string VrmlFileExtension