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	BackupFileSuffix
const std::string	SchematicSymbolFileExtension
const std::string	LegacySymbolLibFileExtension
const std::string	LegacySymbolDocumentFileExtension
const std::string	SchematicBackupFileExtension
const std::string	VrmlFileExtension
const std::string	ProjectFileExtension
const std::string	LegacyProjectFileExtension
const std::string	ProjectLocalSettingsFileExtension
const std::string	LegacySchematicFileExtension
const std::string	KiCadSchematicFileExtension
const std::string	NetlistFileExtension
const std::string	GerberFileExtension
const std::string	GerberJobFileExtension
const std::string	HtmlFileExtension
const std::string	EquFileExtension
const std::string	ArchiveFileExtension
const std::string	LegacyPcbFileExtension
const std::string	KiCadPcbFileExtension
const std::string	KiCadSymbolLibFileExtension
const std::string	PageLayoutDescrFileExtension
const std::string	DesignRulesFileExtension
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	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 135 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

aExts

is 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.

{
    if( aExts.size() == 0 )
    {
        // The "all files" wildcard is different on different systems
        wxString filter;
        filter << " (" << wxFileSelectorDefaultWildcardStr << ")|"
               << wxFileSelectorDefaultWildcardStr;
        return filter;
    }

    wxString files_filter = " (";

    // Add extensions to the info message:
    for( const std::string& ext : aExts )
    {
        if( files_filter.length() > 2 )
            files_filter << "; ";

        files_filter << "*." << ext;
    }

    files_filter << ")|*.";

    // Add extensions to the filter list, using a formated string (GTK specific):
    bool first = true;
    for( const auto& ext : aExts )
    {
        if( !first )
            files_filter << ";*.";

        first = false;

        files_filter << formatWildcardExt( ext );
    }

    return files_filter;
}

References formatWildcardExt().

Referenced by AllFilesWildcard(), AllProjectFilesWildcard(), AllSymbolLibFilesWildcard(), AltiumCircuitMakerPcbFileWildcard(), AltiumCircuitStudioPcbFileWildcard(), AltiumDesignerPcbFileWildcard(), AltiumSchematicFileWildcard(), AskLoadBoardFileName(), BOOST_AUTO_TEST_CASE(), CadstarArchiveFilesWildcard(), CadstarNetlistFileWildcard(), CadstarPcbArchiveFileWildcard(), CadstarSchematicArchiveFileWildcard(), ComponentFileWildcard(), CsvFileWildcard(), DrillFileWildcard(), DxfFileWildcard(), EagleFilesWildcard(), EagleFootprintLibPathWildcard(), EaglePcbFileWildcard(), EagleSchematicFileWildcard(), EquFileWildcard(), ErcFileWildcard(), FabmasterPcbFileWildcard(), FootprintPlaceFileWildcard(), GedaPcbFootprintLibFileWildcard(), GencadFileWildcard(), GerberFileWildcard(), GerberJobFileWildcard(), HtmlFileWildcard(), IDF3DFileWildcard(), FIELDS_GRID_TABLE< SCH_FIELD >::initGrid(), IpcD356FileWildcard(), JpegFileWildcard(), KiCadFootprintLibFileWildcard(), KiCadFootprintLibPathWildcard(), KiCadSchematicFileWildcard(), KiCadSymbolLibFileWildcard(), LegacyFootprintLibPathWildcard(), LegacyPcbFileWildcard(), LegacyProjectFileWildcard(), LegacySchematicFileWildcard(), LegacySymbolLibFileWildcard(), ModLegacyExportFileWildcard(), NetlistFileWildcard(), DIALOG_IMPORT_GFX::onBrowseFiles(), DIALOG_NET_INSPECTOR::onReport(), PageLayoutDescrFileWildcard(), PCadPcbFileWildcard(), PcbFileWildcard(), PdfFileWildcard(), PngFileWildcard(), ProjectFileWildcard(), PSFileWildcard(), ReportFileWildcard(), 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

aExtension	is the extension to test
aReference	is a vector containing the extensions to test against
aCaseSensitive	says 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.

{
    // Form the regular expression string by placing all possible extensions into it as alternatives
    std::string regexString = "(";
    bool        first = true;
    for( const auto& ext : aReference )
    {
        // The | separate goes between the extensions
        if( !first )
            regexString += "|";
        else
            first = false;

        regexString += ext;
    }
    regexString += ")";

    // Create the regex and see if it matches
    std::regex extRegex( regexString, aCaseSensitive ? std::regex::ECMAScript : std::regex::icase );
    return std::regex_match( aExtension, extRegex );
}

Referenced by BOOST_AUTO_TEST_CASE(), and 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

aWildcard

is 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.

{
    wxString wc;
#if defined( __WXGTK__ )

    for( auto ch : aWildcard )
    {
        if( wxIsalpha( ch ) )
            wc += wxString::Format( "[%c%c]", wxTolower( ch ), wxToupper( ch ) );
        else
            wc += ch;
    }

    return wc;
#else
    wc = aWildcard;

    return wc;
#endif
}

References Format().

Referenced by AddFileExtListToFilter(), AskLoadBoardFileName(), GRAPHICS_IMPORT_PLUGIN::GetWildcards(), and SCH_EDIT_FRAME::OnImportProject().

IsProtelExtension()

bool IsProtelExtension

(

const wxString &

ext

)

Definition at line 167 of file wildcards_and_files_ext.cpp.

{
    static wxRegEx protelRE( wxT( "(gm1)|(g[tb][lapos])|(g\\d\\d*)" ), wxRE_ICASE );

    return protelRE.Matches( ext );
}

Referenced by SAVE_AS_TRAVERSER::OnFile().

Variable Documentation

ArchiveFileExtension

const std::string ArchiveFileExtension

Referenced by SETTINGS_MANAGER::BackupProject(), KICAD_MANAGER_FRAME::OnArchiveFiles(), and KICAD_MANAGER_FRAME::OnUnarchiveFiles().

BackupFileSuffix

const std::string BackupFileSuffix

Referenced by SAVE_AS_TRAVERSER::OnFile(), and SCH::IFACE::SaveFileAs().

ComponentFileExtension

const std::string ComponentFileExtension

Definition at line 152 of file wildcards_and_files_ext.h.

Referenced by PROJECT_TREE_PANE::GetFileExt(), SAVE_AS_TRAVERSER::OnFile(), and PCB_EDIT_FRAME::RecreateCmpFileFromBoard().

DesignRulesFileExtension

const std::string DesignRulesFileExtension

Referenced by PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), PROJECT_TREE_PANE::GetFileExt(), LoadBoard(), loadKicadProject(), and WriteDRCReport().

DrillFileExtension

const std::string DrillFileExtension

Referenced by EXCELLON_WRITER::EXCELLON_WRITER(), PROJECT_TREE_PANE::GetFileExt(), SAVE_AS_TRAVERSER::OnFile(), and GERBVIEW_FRAME::OpenProjectFiles().

EagleFootprintLibPathExtension

const std::string EagleFootprintLibPathExtension

Referenced by IO_MGR::GuessPluginTypeFromLibPath().

EquFileExtension

const std::string EquFileExtension

FootprintPlaceFileExtension

const std::string FootprintPlaceFileExtension

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), and PROJECT_TREE_PANE::GetFileExt().

GedaPcbFootprintLibFileExtension

const std::string GedaPcbFootprintLibFileExtension

Referenced by fileTypes(), GPCB_FPL_CACHE::GetTimestamp(), IO_MGR::GuessPluginTypeFromLibPath(), and GPCB_FPL_CACHE::Load().

GerberFileExtension

const std::string GerberFileExtension

Referenced by PLACEFILE_GERBER_WRITER::GetPlaceFileName(), and SAVE_AS_TRAVERSER::OnFile().

GerberJobFileExtension

const std::string GerberJobFileExtension

Referenced by PROJECT_TREE_PANE::GetFileExt(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), SAVE_AS_TRAVERSER::OnFile(), GERBVIEW_FRAME::OpenProjectFiles(), DIALOG_PLOT::Plot(), and GERBVIEW_FRAME::unarchiveFiles().

HtmlFileExtension

const std::string HtmlFileExtension

Referenced by PROJECT_TREE_PANE::GetFileExt().

IpcD356FileExtension

const std::string IpcD356FileExtension

Referenced by PCB_EDIT_FRAME::GenD356File().

JpegFileExtension

const std::string JpegFileExtension

Referenced by EDA_3D_VIEWER::takeScreenshot().

KiCadFootprintFileExtension

const std::string KiCadFootprintFileExtension

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint(), BM2CMP_FRAME::exportPcbnewFormat(), fileTypes(), PCB_IO::FootprintExists(), GPCB_PLUGIN::FootprintLibDelete(), PCB_IO::FootprintLibDelete(), PCB_IO::FootprintSave(), PROJECT_TREE_PANE::GetFileExt(), FP_CACHE::GetTimestamp(), FP_CACHE::Load(), and SAVE_AS_TRAVERSER::OnFile().

KiCadFootprintLibPathExtension

const std::string KiCadFootprintLibPathExtension

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), and IO_MGR::GuessPluginTypeFromLibPath().

KiCadPcbFileExtension

const std::string KiCadPcbFileExtension

Referenced by AskSaveBoardFileName(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PROJECT_TREE_PANE::GetFileExt(), LoadBoard(), loadKicadProject(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnIdle(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

KiCadSchematicFileExtension

const std::string KiCadSchematicFileExtension

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), SCH_DRAWING_TOOLS::DrawSheet(), PROJECT_TREE_PANE::GetFileExt(), getSchematicFile(), SCH_IO_MGR::GuessPluginTypeFromSchPath(), SCH_EDIT_FRAME::importFile(), FIELDS_GRID_TABLE< SCH_FIELD >::initGrid(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), loadKicadProject(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_EDIT_FRAME::NewProject(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_SHEET_PROPERTIES::OnGridCellChanging(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseFileName(), PCB_EDIT_FRAME::RunEeschema(), SCH_EDIT_FRAME::SaveEEFile(), SCH::IFACE::SaveFileAs(), SCH_EDIT_FRAME::SaveProject(), KICAD_MANAGER_FRAME::SchFileName(), PCB_EDIT_FRAME::TestStandalone(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

KiCadSymbolLibFileExtension

const std::string KiCadSymbolLibFileExtension

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDIT_FRAME::ExportPart(), PROJECT_TREE_PANE::GetFileExt(), SCH_ALTIUM_PLUGIN::getLibFileName(), SCH_EAGLE_PLUGIN::getLibFileName(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SYMBOL_EDIT_FRAME::ImportPart(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SAVE_AS_TRAVERSER::OnFile(), SCH::IFACE::SaveFileAs(), and SYMBOL_EDIT_FRAME::saveLibrary().

LegacyFootprintLibPathExtension

const std::string LegacyFootprintLibPathExtension

Referenced by IO_MGR::GuessPluginTypeFromLibPath(), and SAVE_AS_TRAVERSER::OnFile().

LegacyPcbFileExtension

const std::string LegacyPcbFileExtension

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), PROJECT_TREE_PANE::GetFileExt(), LoadBoard(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnIdle(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), SCH_EDIT_FRAME::OnOpenPcbnew(), KICAD_MANAGER_FRAME::PcbLegacyFileName(), and PCB_EDIT_FRAME::SavePcbFile().

LegacyProjectFileExtension

const std::string LegacyProjectFileExtension

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), PROJECT_TEMPLATE::CreateProject(), PROJECT_TEMPLATE::GetDestinationFiles(), PROJECT_TREE_PANE::GetFileExt(), PROJECT_FILE::getLegacyFileExt(), getProjects(), SETTINGS_MANAGER::LoadProject(), PGM_KICAD::OnPgmInit(), SCH_EDIT_FRAME::OpenProjectFiles(), and PROJECT_TREE_PANE::ReCreateTreePrj().

LegacySchematicFileExtension

const std::string LegacySchematicFileExtension

Referenced by PROJECT_TREE_PANE::GetFileExt(), SCH_IO_MGR::GuessPluginTypeFromSchPath(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnIdle(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), PCB_EDIT_FRAME::RunEeschema(), SCH_EDIT_FRAME::Save_File(), SCH::IFACE::SaveFileAs(), KICAD_MANAGER_FRAME::SchLegacyFileName(), and PCB_EDIT_FRAME::TestStandalone().

LegacySymbolDocumentFileExtension

const std::string LegacySymbolDocumentFileExtension

Referenced by DIALOG_SYMBOL_REMAP::backupProject(), SAVE_AS_TRAVERSER::OnFile(), and SCH::IFACE::SaveFileAs().

LegacySymbolLibFileExtension

const std::string LegacySymbolLibFileExtension

Referenced by DIALOG_SYMBOL_REMAP::backupProject(), PART_LIBS::CacheName(), SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), BM2CMP_FRAME::exportEeschemaFormat(), PROJECT_TREE_PANE::GetFileExt(), GetRescueLibraryFileName(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SYMBOL_EDIT_FRAME::ImportPart(), PART_LIBS::LoadAllLibraries(), SAVE_AS_TRAVERSER::OnFile(), and SCH::IFACE::SaveFileAs().

MacrosFileExtension

const std::string MacrosFileExtension

NetlistFileExtension

const std::string NetlistFileExtension

Referenced by NETLIST_DIALOG::FilenamePrms(), PROJECT_TREE_PANE::GetFileExt(), TEST_NETLISTS_FIXTURE::getNetlistFileName(), SAVE_AS_TRAVERSER::OnFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), and SCH::IFACE::SaveFileAs().

PageLayoutDescrFileExtension

const std::string PageLayoutDescrFileExtension

Definition at line 153 of file wildcards_and_files_ext.h.

Referenced by PL_EDITOR_FRAME::Files_io(), PROJECT_TREE_PANE::GetFileExt(), BM2CMP_FRAME::OnExportLogo(), and SAVE_AS_TRAVERSER::OnFile().

PdfFileExtension

const std::string PdfFileExtension

Referenced by PROJECT_TREE_PANE::GetFileExt().

PngFileExtension

const std::string PngFileExtension

Referenced by EDA_3D_VIEWER::takeScreenshot().

ProjectFileExtension

const std::string ProjectFileExtension

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), PROJECT_TEMPLATE::CreateProject(), PROJECT_TEMPLATE::GetDestinationFiles(), PROJECT_TREE_PANE::GetFileExt(), PROJECT_FILE::getFileExt(), getProjects(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), LoadBoard(), loadKicadProject(), SETTINGS_MANAGER::LoadProject(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), TEST_NETLISTS_FIXTURE::loadSchematic(), KICAD_MANAGER_CONTROL::NewFromTemplate(), KICAD_MANAGER_CONTROL::NewProject(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), DIALOG_SCH_IMPORT_SETTINGS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), PGM_KICAD::OnPgmInit(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_TREE_PANE::ReCreateTreePrj(), SCH_EDIT_FRAME::Save_File(), SaveBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PROJECT_FILE::SaveToFile(), and PROJECT::setProjectFullName().

ProjectLocalSettingsFileExtension

const std::string ProjectLocalSettingsFileExtension

Referenced by PROJECT_LOCAL_SETTINGS::getFileExt(), and PROJECT_LOCAL_SETTINGS::SaveToFile().

ReportFileExtension

const std::string ReportFileExtension

Referenced by PROJECT_TREE_PANE::GetFileExt(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_ERC::OnSaveReport(), and DIALOG_DRC::OnSaveReport().

SchematicBackupFileExtension

const std::string SchematicBackupFileExtension

SchematicSymbolFileExtension

const std::string SchematicSymbolFileExtension

Referenced by SAVE_AS_TRAVERSER::OnFile(), and SCH::IFACE::SaveFileAs().

SpecctraDsnFileExtension

const std::string SpecctraDsnFileExtension

Referenced by BOARD_EDITOR_CONTROL::ExportSpecctraDSN().

SVGFileExtension

const std::string SVGFileExtension

Referenced by DIALOG_EXPORT_SVG::ExportSVGFile(), and PROJECT_TREE_PANE::GetFileExt().

VrmlFileExtension

const std::string VrmlFileExtension