/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com * Copyright (C) 2008-2011 Wayne Stambaugh * Copyright (C) 1992-2011 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 */ /** * @file appl_wxstruct.h * @brief Base class implementation for all KiCad applications. */ #ifndef APPL_WXSTRUCT_H #define APPL_WXSTRUCT_H /* Use wxFileHistory for most recently used file handling. */ #include #include #include #include enum EDA_APP_T { APP_UNKNOWN_T, APP_EESCHEMA_T, APP_PCBNEW_T, APP_CVPCB_T, APP_GERBVIEW_T, APP_KICAD_T, APP_PL_EDITOR_T }; class wxConfigBase; class wxFileConfig; class wxSingleInstanceChecker; class wxHtmlHelpController; /** * Class EDA_APP * is the base class representing all of KiCad applications. */ class EDA_APP : public wxApp { protected: /// Used mainly to handle default paths libs m_Id = APP_EESCHEMA_T, APP_PCBNEW_T ... EDA_APP_T m_Id; /// Used to prevent multiple instances of an application from being run at the same time. wxSingleInstanceChecker* m_Checker; /// Used to prevent opening the same file multiple times. wxSingleInstanceChecker* m_oneInstancePerFileChecker; wxString m_Project; /// The application specific configuration settings. wxConfig* m_settings; /// The configuration settings common to all KiCad applications. wxConfig* m_commonSettings; /// The current project specific settings. wxFileConfig* m_projectSettings; /// KiCad executable path. wxString m_BinDir; /// The KICAD system environment variable. wxString m_KicadEnv; /// The current locale. wxLocale* m_Locale; /// The current language setting. int m_LanguageId; void setLanguageId( int aId ) { m_LanguageId = aId; } /// The file name of the the program selected for browsing pdf files. wxString m_PdfBrowser; /// true to use the selected PDF browser, if exists, or false to use the default bool m_useSystemPdfBrowser; wxPathList m_searchPaths; wxFileHistory m_fileHistory; wxString m_HelpFileName; wxString m_EditorName; wxString m_CurrentOptionFile; wxString m_CurrentOptionFileDateAndTime; wxPoint m_HelpPos; wxSize m_HelpSize; wxString m_Title; wxPathList m_libSearchPaths; wxFileName m_projectFileName; wxString m_LastVisitedLibPath; /// last visited module library in the module editor or viewer wxString m_module_nickname; wxHtmlHelpController* m_HtmlCtrl; public: EDA_APP(); ~EDA_APP(); /** * Function OnInit * this is the first executed function (like main() ) * @return true if the application can be started. */ bool OnInit(); // should this be virtual wxHtmlHelpController* GetHtmlHelpController() { return m_HtmlCtrl; } void SetHtmlHelpController( wxHtmlHelpController* aController ); wxString GetHelpFileName() const { return m_HelpFileName; } void SetHelpFileName( const wxString& aFileName ) { m_HelpFileName = aFileName; } wxConfig* GetSettings() { return m_settings; } wxConfig* GetCommonSettings() { return m_commonSettings; } wxString GetEditorName() const { return m_EditorName; } void SetEditorName( const wxString& aFileName ) { m_EditorName = aFileName; } wxString GetCurrentOptionFile() const { return m_CurrentOptionFile; } bool IsKicadEnvVariableDefined() const { return !m_KicadEnv.IsEmpty(); } wxString GetKicadEnvVariable() const { return m_KicadEnv; } wxString GetExecutablePath() const { return m_BinDir; } wxLocale* GetLocale() { return m_Locale; } /** * @return the full file name of the prefered PDF browser * ( the file name is empty if no prefered there is no PDF browser selected */ wxString GetPdfBrowserFileName() const { return m_PdfBrowser; } /** * Set the name of a prefered PDF browser, which could be an alternate browser * to the system PDF browser. */ void SetPdfBrowserFileName( const wxString& aFileName ) { m_PdfBrowser = aFileName; } /** * @return true if the PDF browser is the default (system) PDF browser * and false if the PDF browser is the prefered (selected) browser * returns false if there is no selected browser */ bool UseSystemPdfBrowser() const { return m_useSystemPdfBrowser || m_PdfBrowser.IsEmpty(); } /** * force the use of system PDF browser, even if a preferend PDF browser is set */ void ForceSystemPdfBrowser( bool aFlg ) { m_useSystemPdfBrowser = aFlg; } wxFileHistory& GetFileHistory() { return m_fileHistory; } /** * Function SetBinDir * finds the path to the executable and store it in EDA_APP::m_BinDir * * @return TODO */ bool SetBinDir(); /** * Function SetDefaultSearchPaths * sets search paths for libraries, modules, internationalization files, etc. */ void SetDefaultSearchPaths( void ); /** * Function MacOpenFile * Specific to MacOSX. Not used under Linux or Windows * MacOSX: Needed for file association * http://wiki.wxwidgets.org/WxMac-specific_topics */ virtual void MacOpenFile( const wxString& aFileName ); /** * Function InitEDA_Appl * initialize some general parameters * - Default paths (help, libs, bin)and configuration files names * - Language and locale * - fonts * @param aName : used as paths in configuration files * @param aId = flag : LIBRARY_TYPE_EESCHEMA or LIBRARY_TYPE_PCBNEW * used to choose what default library path must be used */ void InitEDA_Appl( const wxString& aName, EDA_APP_T aId = APP_UNKNOWN_T ); /** * Function SetLanguage * sets the dictionary file name for internationalization. *

* The files are in kicad/internat/xx or kicad/internat/xx_XX and are named kicad.mo *

* @param first_time must be set to true the first time this funct is * called, false otherwise * @return true if the language can be set (i.e. if the locale is available) */ bool SetLanguage( bool first_time = false ); /** * Function AddMenuLanguageList * creates a menu list for language choice, and add it as submenu to \a MasterMenu. * * @param MasterMenu The main menu. The sub menu list will be accessible from the menu * item with id ID_LANGUAGE_CHOICE */ void AddMenuLanguageList( wxMenu* MasterMenu ); /** * Function SetLanguageIdentifier * sets in .m_LanguageId member the wxWidgets language identifier Id from * the KiCad menu id (internal menu identifier). * * @param menu_id The KiCad menuitem id (returned by Menu Event, when * clicking on a menu item) */ void SetLanguageIdentifier( int menu_id ); void SetLanguagePath( void ); /** * Function InitOnLineHelp * initializes KiCad's online help. */ void InitOnLineHelp(); /** * Function GetSettings * gets the application settings. * @param aReopenLastUsedDirectory True to switch to last opened directory, false * to use current CWD */ void GetSettings( bool aReopenLastUsedDirectory ); /** * Function SaveSettings * saves the application settings. */ void SaveSettings(); /** * Function WriteProjectConfig * Save the current "project" parameters * saved parameters are parameters that have the .m_Setup member set to false * saving file is the .pro file project */ void WriteProjectConfig( const wxString& fileName, const wxString& GroupName, const PARAM_CFG_ARRAY& params ); /** * Function SaveCurrentSetupValues * saves the current setup values in m_settings. * Saved parameters are parameters that have the .m_Setup member set to * true. * @param aList = array of PARAM_CFG_BASE pointers */ void SaveCurrentSetupValues( const PARAM_CFG_ARRAY& aList ); /** * Function ReadCurrentSetupValues * reads the current setup values previously saved, from m_settings. * Saved parameters are parameters that have the .m_Setup member set to * true. * @param aList = array of PARAM_CFG_BASE pointers */ void ReadCurrentSetupValues( const PARAM_CFG_ARRAY& aList ); /** * Function ReadProjectConfig * Read the current "project" parameters * Parameters are parameters that have the .m_Setup member set to false * read file is the .pro file project * * if Load_Only_if_New == true, this file is read only if it differs from * the current config (different dates ) * * @return true if read. * Also set: * wxGetApp().m_CurrentOptionFileDateAndTime * wxGetApp().m_CurrentOptionFile */ bool ReadProjectConfig( const wxString& local_config_filename, const wxString& GroupName, PARAM_CFG_BASE** List, bool Load_Only_if_New ); bool ReadProjectConfig( const wxString& local_config_filename, const wxString& GroupName, const PARAM_CFG_ARRAY& List, bool Load_Only_if_New ); /** * Creates or recreates the KiCad project file. (filename.pro) * Initialize: * G_Prj_Config * G_Prj_Config_LocalFilename * G_Prj_Default_Config_FullFilename * Return: * True if local config * False if default config */ bool ReCreatePrjConfig( const wxString& local_config_filename, const wxString& GroupName, bool ForceUseLocalConfig ); /** * Function ReadPdfBrowserInfos * read the PDF browser choice from the common configuration. */ void ReadPdfBrowserInfos(); /* Function WritePdfBrowserInfos * save the PDF browser choice to the common configuration. */ void WritePdfBrowserInfos(); /** * Function FindFileInSearchPaths * looks in search paths for \a filename. */ wxString FindFileInSearchPaths( const wxString& filename, const wxArrayString* subdirs = NULL ); /** * Function GetHelpFile * get the help file path. *

* Return the KiCad help file with path. The base paths defined in * m_searchPaths are tested for a valid file. The path returned can * be relative depending on the paths added to m_searchPaths. See the * documentation for wxPathList for more information. If the help file * for the current locale is not found, an attempt to find the English * version of the help file is made. * wxEmptyString is returned if help file not found. * Help file is searched in directories in this order: * help/\ like help/en_GB * help/\ like help/en * help/en *

*/ wxString GetHelpFile( void ); /** * Return the preferred editor name. */ wxString& GetEditorName(); const wxString& GetTitle() { return m_Title; } void SetTitle( const wxString& aTitle ) { m_Title = aTitle; } wxPathList& GetLibraryPathList() { return m_libSearchPaths; } wxString FindLibraryPath( const wxString& fileName ); /** * Function FindLibraryPath * KiCad saves user defined library files that are not in the standard * library search path list with the full file path. Calling the library * search path list with a user library file will fail. This helper method * solves that problem. * @param fileName * @return a wxEmptyString if library file is not found. */ wxString FindLibraryPath( const wxFileName& fileName ) { return FindLibraryPath( fileName.GetFullPath() ); } /** * Function ReturnLastVisitedLibraryPath * returns the last visited library directory, or (if void) the first * path in lib path list ( but not the CWD ) * * @param aSubPathToSearch = Preferred sub path to search in path list */ wxString ReturnLastVisitedLibraryPath( const wxString& aSubPathToSearch = wxEmptyString ); void SaveLastVisitedLibraryPath( const wxString& aPath ); /** * Function ReturnFilenameWithRelativePathInLibPath * @return a short filename (with extension) with only a relative path if * this filename can be found in library paths * @param aFullFilename The filename with path and extension. */ wxString ReturnFilenameWithRelativePathInLibPath( const wxString& aFullFilename ); /** * Function RemoveLibraryPath * Removes the given path(s) from the library path list * @param aPaths = path or path list to remove. paths must be separated by * ";" */ void RemoveLibraryPath( const wxString& aPaths ); /** * Function InsertLibraryPath * insert path(s) int lib paths list. * @param aPaths = path or path list to add. paths must be separated by ";" * @param aIndex = insertion point */ void InsertLibraryPath( const wxString& aPaths, size_t aIndex ); /** * Function LockFile * Locks the access to a file. * @param fileName = full path to the file. * @return false if the file was already locked, true otherwise. */ bool LockFile( const wxString& fileName ); /** * Function SetFootprintLibTableEnv * attempts set the KISYSMOD environment variable to the best possible path. * * The path is determined by attempting to find the path with the most footprint library * files. This may or may not be the best path but it provides the best solution for * backwards compatibility with the previous library search path implementation. If the * KISYSMOD environment variable is already set, then it left as is to respect the wishes * of the user. * * @note This must be called after #SetDefaultSearchPaths() is called. Otherwise, the * list of library search paths will be empty and KISYSMOD will be undefined making * it impossible for the footprint libraries to be loaded from the footprint library * table. * * @return false if the KISYSMOD path is not valid. */ bool SetFootprintLibTablePath(); /** * Function Set3DShapesPath * attempts set the environment variable given by aKiSys3Dmod to a valid path. * (typically "KISYS3DMOD" ) * If the environment variable is already set, * then it left as is to respect the wishes of the user. * * The path is determined by attempting to find the path modules/packages3d * files in kicad tree. * This may or may not be the best path but it provides the best solution for * backwards compatibility with the previous 3D shapes search path implementation. * * @note This must be called after #SetBinDir() is called at least on Windows. * Otherwise, the kicad path is not known (Windows specific) * * @param aKiSys3Dmod = the value of environment variable, typically "KISYS3DMOD" * @return false if the aKiSys3Dmod path is not valid. */ bool Set3DShapesPath( const wxString& aKiSys3Dmod ); const wxString& GetModuleLibraryNickname() { return m_module_nickname; } void SetModuleLibraryNickname( const wxString& aNickname ) { m_module_nickname = aNickname; } }; /* * Use wxGetApp() to access EDA_APP. It is not necessary to keep copies * of the application pointer all over the place or worse yet in a global * variable. */ DECLARE_APP( EDA_APP ) #endif // APPL_WXSTRUCT_H