haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/include/wildcards_and_files_ext.h

226 lines
9.0 KiB
C
Raw Normal View History

Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
* Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
* Copyright (C) 2007-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
pcbnew: Clean up extension handling in graphics plugins * Fix wildcard display in the file selector dialog (on GTK it would show the regex to the user) * Move the file extension comparison into a common function (cherry picked from commit b33c3a5ad8794027b8e7c627b303a5449a137e78)
2019-09-26 20:09:09 +00:00
* Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
*
* 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
*/
/**
* @file wildcards_and_files_ext.h
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
* Definition of file extensions used in Kicad.
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
*/
#ifndef INCLUDE_WILDCARDS_AND_FILES_EXT_H_
#define INCLUDE_WILDCARDS_AND_FILES_EXT_H_
#include <wx/wx.h>
Wildcards: use vectors instead of varargs + tests Varargs make it very hard to pass strings in flexibly when they (and the number of them) are not known at compile time. For example, this allows up to now amalgamate the "single ext" and "multiple ext" unit tests.
2019-01-05 23:55:14 +00:00
#include <string>
#include <vector>
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
/**
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
* \defgroup file_extensions File Extension Definitions
*
* @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.
*
* @{
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
*/
Eeschema: code cleanup, remove dead code and some global and useless variables
2012-09-28 17:47:41 +00:00
pcbnew: Clean up extension handling in graphics plugins * Fix wildcard display in the file selector dialog (on GTK it would show the regex to the user) * Move the file extension comparison into a common function (cherry picked from commit b33c3a5ad8794027b8e7c627b303a5449a137e78)
2019-09-26 20:09:09 +00:00
/**
* 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.*) ).
*
* @param aExtension is the extension to test
* @param aReference is a vector containing the extensions to test against
* @param aCaseSensitive says if the comparison should be case sensitive or not
*
* @return if the extension matches any reference extensions
*/
bool compareFileExtensions( const std::string& aExtension,
const std::vector<std::string>& aReference, bool aCaseSensitive = false );
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
/**
Wildcards: use vectors instead of varargs + tests Varargs make it very hard to pass strings in flexibly when they (and the number of them) are not known at compile time. For example, this allows up to now amalgamate the "single ext" and "multiple ext" unit tests.
2019-01-05 23:55:14 +00:00
* 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:
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
* 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"
*
Wildcards: use vectors instead of varargs + tests Varargs make it very hard to pass strings in flexibly when they (and the number of them) are not known at compile time. For example, this allows up to now amalgamate the "single ext" and "multiple ext" unit tests.
2019-01-05 23:55:14 +00:00
* This function produces a case-insensitive filter (so .txt, .TXT and .tXT
* are all match if you pass "txt" into the function).
*
* @param aExts is the list of exts to add to the filter. Do not include the
Wildcards: unify handling of all files wildcards Use the AddFileExtListToFilter() to also generate the wildcard for "all files". This is because: * Users can use AddFileExtListToFilter for the all files WC with the same interface as for any other extensions. * Users do not need to worry about wxGetTranslation, as the _() is applied in the same way as the other *Wildcard() helpers, and it is a function just like the others, so it is consistent * There is a testable interface to document the expected result. The test is added.
2019-01-08 11:57:39 +00:00
* leading dot. Empty means "allow all files".
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
*
* @return the appropriate file dialog wildcard filter list.
*/
Wildcards: use vectors instead of varargs + tests Varargs make it very hard to pass strings in flexibly when they (and the number of them) are not known at compile time. For example, this allows up to now amalgamate the "single ext" and "multiple ext" unit tests.
2019-01-05 23:55:14 +00:00
wxString AddFileExtListToFilter( const std::vector<std::string>& aExts );
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
Fix case-sensitive import using KiCad std Fixes: lp:1832853 * https://bugs.launchpad.net/kicad/+bug/1832853 (cherry picked from commit 79e2000af41abd536937be3ad1eea3685a97420d)
2019-06-15 03:27:36 +00:00
/**
* 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.
*
* @param aWildcard is the extension part of the wild card.
*
* @return the build appropriate file dialog wildcard filter.
*/
wxString formatWildcardExt( const wxString& aWildcard );
Add a helper function FileExtListToFilter() to build the wildcard filter used in File Dialog. It avoid including these extensions in a translatable string, thus avoid breaking filter if the translation is incorrect (It happens sometimes). See wildcards_and_files_ext.cpp for use.
2019-01-01 14:38:57 +00:00
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
// Do NOT use wxString for these. wxStrings are not thread-safe, even when const. (For the
// curious the UTF8 cacheing strategy puts iterators in a linked list. Insertion and removal
// from the linked list is not thread-safe.)
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
extern const std::string SchematicSymbolFileExtension;
extern const std::string SchematicLibraryFileExtension;
extern const std::string SchematicBackupFileExtension;
Eeschema: code cleanup, remove dead code and some global and useless variables
2012-09-28 17:47:41 +00:00
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
extern const std::string VrmlFileExtension;
extern const std::string ProjectFileExtension;
extern const std::string SchematicFileExtension;
extern const std::string NetlistFileExtension;
extern const std::string GerberFileExtension;
extern const std::string GerberJobFileExtension;
extern const std::string HtmlFileExtension;
Switch over to *.kicad_pcb format as the default BOARD format. Add KiCadPcbFileExt global.
2012-12-14 16:54:54 +00:00
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
extern const std::string LegacyPcbFileExtension;
extern const std::string KiCadPcbFileExtension;
Switch over to *.kicad_pcb format as the default BOARD format. Add KiCadPcbFileExt global.
2012-12-14 16:54:54 +00:00
#define PcbFileExtension KiCadPcbFileExtension // symlink choice
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
extern const std::string PageLayoutDescrFileExtension;
Switch over to *.kicad_pcb format as the default BOARD format. Add KiCadPcbFileExt global.
2012-12-14 16:54:54 +00:00
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
extern const std::string LegacyFootprintLibPathExtension;
extern const std::string PdfFileExtension;
extern const std::string MacrosFileExtension;
extern const std::string ComponentFileExtension;
extern const std::string DrillFileExtension;
extern const std::string SVGFileExtension;
extern const std::string ReportFileExtension;
extern const std::string FootprintPlaceFileExtension;
extern const std::string KiCadFootprintFileExtension;
extern const std::string KiCadFootprintLibPathExtension;
extern const std::string GedaPcbFootprintLibFileExtension;
extern const std::string EagleFootprintLibPathExtension;
extern const std::string ComponentFileExtension;
extern const std::string PageLayoutDescrFileExtension;
extern const std::string KiCadLib3DShapesPathExtension;
extern const std::string SpecctraDsnFileExtension;
extern const std::string IpcD356FileExtension;
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
3D Viewer: fix screenshot file extension bug with GTK+ Append the appropriate file extension to the file name if the file name does not have a file extension. This is a know issue with the GTK+ file dialog. Make the last 3D viewer screenshot last file used code more coherent. Add the 3D viewer main frame trace string to the trace environment variables doxygen group. Doxygen comment and other minor code cleaning. Fixes lp:1804980 https://bugs.launchpad.net/bugs/1804980
2018-12-08 13:20:32 +00:00
extern const std::string PngFileExtension;
extern const std::string JpegFileExtension;
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
/**
* @}
*/
add eagle *.lbr lib path extension for future use
2013-01-03 16:33:22 +00:00
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
/**
* \defgroup file_wildcards File Wildcard Definitions
*
* @note Please do not changes these. If a different file wildcard is needed, create a new
* definition in here. If you create a wildcard definition in another file, make sure
* to add it to the Doxygen group "file_extensions" using the "addtogroup" tag and
* correct handle the GTK+ file dialog case sensitivity issue.
* @{
*/
Wildcards: unify handling of all files wildcards Use the AddFileExtListToFilter() to also generate the wildcard for "all files". This is because: * Users can use AddFileExtListToFilter for the all files WC with the same interface as for any other extensions. * Users do not need to worry about wxGetTranslation, as the _() is applied in the same way as the other *Wildcard() helpers, and it is a function just like the others, so it is consistent * There is a testable interface to document the expected result. The test is added.
2019-01-08 11:57:39 +00:00
extern wxString AllFilesWildcard();
Fix thread-safety issue with some global wxStrings. These cause intermittent crashes in footprint loading. See comments in code.
2018-08-02 22:15:01 +00:00
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
extern wxString ComponentFileWildcard();
extern wxString PageLayoutDescrFileWildcard();
extern wxString SchematicSymbolFileWildcard();
extern wxString SchematicLibraryFileWildcard();
extern wxString ProjectFileWildcard();
extern wxString SchematicFileWildcard();
extern wxString BoardFileWildcard();
extern wxString NetlistFileWildcard();
extern wxString GerberFileWildcard();
extern wxString HtmlFileWildcard();
extern wxString CsvFileWildcard();
extern wxString LegacyPcbFileWildcard();
extern wxString PcbFileWildcard();
extern wxString EaglePcbFileWildcard();
extern wxString EagleSchematicFileWildcard();
extern wxString EagleFilesWildcard();
extern wxString PCadPcbFileWildcard();
extern wxString PdfFileWildcard();
extern wxString PSFileWildcard();
extern wxString MacrosFileWildcard();
extern wxString ComponentFileWildcard();
extern wxString DrillFileWildcard();
extern wxString SVGFileWildcard();
extern wxString ReportFileWildcard();
extern wxString FootprintPlaceFileWildcard();
extern wxString Shapes3DFileWildcard();
extern wxString IDF3DFileWildcard();
extern wxString DocModulesFileName();
extern wxString LegacyFootprintLibPathWildcard();
extern wxString KiCadFootprintLibFileWildcard();
extern wxString KiCadFootprintLibPathWildcard();
extern wxString GedaPcbFootprintLibFileWildcard();
extern wxString EagleFootprintLibPathWildcard();
extern wxString TextFileWildcard();
extern wxString ModLegacyExportFileWildcard();
extern wxString ErcFileWildcard();
extern wxString SpiceLibraryFileWildcard();
extern wxString SpiceNetlistFileWildcard();
extern wxString CadstarNetlistFileWildcard();
extern wxString EquFileWildcard();
extern wxString ZipFileWildcard();
extern wxString GencadFileWildcard();
extern wxString DxfFileWildcard();
extern wxString GerberJobFileWildcard();
extern wxString SpecctraDsnFileWildcard();
extern wxString IpcD356FileWildcard();
extern wxString WorkbookFileWildcard();
extern wxString PngFileWildcard();
3D Viewer: fix screenshot file extension bug with GTK+ Append the appropriate file extension to the file name if the file name does not have a file extension. This is a know issue with the GTK+ file dialog. Make the last 3D viewer screenshot last file used code more coherent. Add the 3D viewer main frame trace string to the trace environment variables doxygen group. Doxygen comment and other minor code cleaning. Fixes lp:1804980 https://bugs.launchpad.net/bugs/1804980
2018-12-08 13:20:32 +00:00
extern wxString JpegFileWildcard();
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
/**
* @}
*/
Kicad project manager: add .cmp, .drl .pos and .rpt files management. Code cleaning and other minor fixes.
2012-02-16 20:03:33 +00:00
#endif // INCLUDE_WILDCARDS_AND_FILES_EXT_H_