kicad/menubar.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2009 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2019 CERN
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#include <settings/common_settings.h>
#include <advanced_config.h>
#include <bitmaps.h>
#include <file_history.h>
#include <kiplatform/policy.h>
#include <kiway.h>
#include <local_history.h>
#include <paths.h>
#include <policy_keys.h>
#include <tool/action_manager.h>
#include <tool/action_toolbar.h>
#include <tool/tool_manager.h>
#include <tool/selection.h>
#include <tools/kicad_manager_control.h>
#include <tools/kicad_manager_actions.h>
#include "kicad_manager_frame.h"
#include "pgm_kicad.h"
#include "kicad_id.h"
#include <widgets/wx_menubar.h>
#include <wx/dir.h>
#include <wx/utils.h>
#include <local_history.h>
 
 
void KICAD_MANAGER_FRAME::doReCreateMenuBar()
{
    KICAD_MANAGER_CONTROL* controlTool = m_toolManager->GetTool<KICAD_MANAGER_CONTROL>();
    // wxWidgets handles the Mac Application menu behind the scenes, but that means
    // we always have to start from scratch with a new wxMenuBar.
    wxMenuBar*  oldMenuBar = GetMenuBar();
    WX_MENUBAR* menuBar    = new WX_MENUBAR();
 
    //-- File menu -----------------------------------------------------------
    //
    ACTION_MENU*  fileMenu    = new ACTION_MENU( false, controlTool );
    FILE_HISTORY& fileHistory = GetFileHistory();
 
    fileHistory.SetClearText( _( "Clear Recent Projects" ) );
 
    static ACTION_MENU* openRecentMenu;
 
    // Create the menu if it does not exist. Adding a file to/from the history
    // will automatically refresh the menu.
    if( !openRecentMenu )
    {
        openRecentMenu = new ACTION_MENU( false, controlTool );
        openRecentMenu->SetIcon( BITMAPS::recent );
 
        fileHistory.UseMenu( openRecentMenu );
        fileHistory.AddFilesToMenu();
    }
 
    // Ensure the title is up to date after changing language
    openRecentMenu->SetTitle( _( "Open Recent" ) );
 
    fileMenu->Add( KICAD_MANAGER_ACTIONS::newProject );
 
    if( Pgm().GetCommonSettings() && Pgm().GetCommonSettings()->m_Git.enableGit )
        fileMenu->Add( KICAD_MANAGER_ACTIONS::newFromRepository );
 
    if( wxDir::Exists( PATHS::GetStockDemosPath() ) )
        fileMenu->Add( KICAD_MANAGER_ACTIONS::openDemoProject );
 
    fileMenu->Add( KICAD_MANAGER_ACTIONS::openProject );
 
    wxMenuItem* item = fileMenu->Add( openRecentMenu->Clone() );
 
    fileMenu->AppendSeparator();
    fileMenu->Add( KICAD_MANAGER_ACTIONS::newJobsetFile );
    fileMenu->Add( KICAD_MANAGER_ACTIONS::openJobsetFile );
 
    // Add the file menu condition here since it needs the item ID for the submenu
    ACTION_CONDITIONS cond;
    cond.Enable( FILE_HISTORY::FileHistoryNotEmpty( fileHistory ) );
    RegisterUIUpdateHandler( item->GetId(), cond );
 
    fileMenu->AppendSeparator();
    fileMenu->Add( KICAD_MANAGER_ACTIONS::closeProject );
 
    fileMenu->AppendSeparator();
    wxMenuItem* restoreItem = fileMenu->Add( KICAD_MANAGER_ACTIONS::restoreLocalHistory );
    ACTION_CONDITIONS historyCond;
    historyCond.Enable( [&]( const SELECTION& )
    {
        return Pgm().GetCommonSettings()->AutosaveUsesLocalHistory()
               && Kiway().LocalHistory().HistoryExists( Prj().GetProjectPath() );
    } );
    RegisterUIUpdateHandler( restoreItem->GetId(), historyCond );
 
    fileMenu->AppendSeparator();
    fileMenu->Add( ACTIONS::saveAs );
 
    fileMenu->AppendSeparator();
 
    //Import Sub-menu
    ACTION_MENU* importMenu = new ACTION_MENU( false, controlTool );
    importMenu->SetTitle( _( "Import Non-KiCad Project..." ) );
    importMenu->SetIcon( BITMAPS::import_project );
 
    importMenu->Add( _( "Altium Project..." ),
                     _( "Import Altium Schematic and PCB (*.PrjPcb)" ),
                     ID_IMPORT_ALTIUM_PROJECT,
                     BITMAPS::import_project );
    importMenu->Add( _( "CADSTAR Project..." ),
                     _( "Import CADSTAR Archive Schematic and PCB (*.csa, *.cpa)" ),
                     ID_IMPORT_CADSTAR_ARCHIVE_PROJECT,
                     BITMAPS::import_project );
 
    importMenu->Add( _( "EAGLE Project..." ),
                     _( "Import EAGLE CAD XML schematic and board" ),
                     ID_IMPORT_EAGLE_PROJECT,
                     BITMAPS::import_project );
 
    importMenu->Add( _( "EasyEDA (JLCEDA) Std Backup..." ),
                     _( "Import EasyEDA (JLCEDA) Standard schematic and board" ),
                     ID_IMPORT_EASYEDA_PROJECT,
                     BITMAPS::import_project );
 
    importMenu->Add( _( "EasyEDA (JLCEDA) Pro Project..." ),
                     _( "Import EasyEDA (JLCEDA) Professional schematic and board" ),
                     ID_IMPORT_EASYEDAPRO_PROJECT, BITMAPS::import_project );
 
    importMenu->Add( _( "PADS Project..." ),
                     _( "Import PADS Logic schematic and PADS ASCII PCB (*.asc, *.txt)" ),
                     ID_IMPORT_PADS_PROJECT, BITMAPS::import_project );
 
    importMenu->Add( _( "P-CAD Project..." ),
                     _( "Import P-CAD ASCII schematic and board" ),
                     ID_IMPORT_PCAD_PROJECT, BITMAPS::import_project );
 
    importMenu->Add( _( "gEDA / Lepton EDA Project..." ),
                     _( "Import gEDA or Lepton EDA schematic and PCB layout" ),
                     ID_IMPORT_GEDA_PROJECT,
                     BITMAPS::import_project );
 
    importMenu->Add( _( "DipTrace Project..." ),
                     _( "Import DipTrace schematic and PCB (*.dch, *.dip)" ),
                     ID_IMPORT_DIPTRACE_PROJECT,
                     BITMAPS::import_project );
 
    importMenu->Add( _( "OrCAD Project..." ),
                     _( "Import OrCAD schematic (*.dsn) and optional Allegro board (*.brd)" ),
                     ID_IMPORT_ORCAD_PROJECT,
                     BITMAPS::import_project );
 
    fileMenu->Add( importMenu );
 
    fileMenu->AppendSeparator();
    fileMenu->Add( KICAD_MANAGER_ACTIONS::archiveProject );
    fileMenu->Add( KICAD_MANAGER_ACTIONS::unarchiveProject );
 
    fileMenu->AppendSeparator();
    fileMenu->AddQuitOrClose( nullptr, wxS( "KiCad" ) );
 
    //-- Edit menu -----------------------------------------------------------
    //
 
    ACTION_MENU* editMenu = new ACTION_MENU( false, controlTool );
 
    /*
     * While we don't presently use these, they need to be here so that cut/copy/paste work
     * in things like search boxes in file open dialogs.
     */
    editMenu->Add( ACTIONS::cut );
    editMenu->Add( ACTIONS::copy );
    editMenu->Add( ACTIONS::paste );
 
    wxString editCfgEnv;
    if( wxGetEnv( wxS( "KICAD_EDIT_ADVANCED_CFG" ), &editCfgEnv ); editCfgEnv == wxS( "1" ) )
    {
        editMenu->Add( _( "Edit Advanced Config..." ),
                        _( "Edit advanced settings" ),
                        ID_EDIT_ADVANCED_CFG,
                        BITMAPS::editor );
    }
 
    //-- View menu -----------------------------------------------------------
    //
    ACTION_MENU* viewMenu = new ACTION_MENU( false, controlTool );
 
    ACTION_MENU* panelsMenu = new ACTION_MENU( false, controlTool );
    panelsMenu->SetTitle( _( "Panels" ) );
    panelsMenu->Add( KICAD_MANAGER_ACTIONS::showLocalHistory, ACTION_MENU::CHECK );
    viewMenu->Add( panelsMenu );
 
    viewMenu->AppendSeparator();
    viewMenu->Add( ACTIONS::zoomRedraw );
 
    viewMenu->AppendSeparator();
    viewMenu->Add( KICAD_MANAGER_ACTIONS::openTextEditor );
    viewMenu->Add( KICAD_MANAGER_ACTIONS::openProjectDirectory );
 
#ifdef __APPLE__
    // Add a separator only on macOS because the OS adds menu items to the view menu after ours
    viewMenu->AppendSeparator();
#endif
 
    //-- Tools menu -----------------------------------------------
    //
    ACTION_MENU* toolsMenu = new ACTION_MENU( false, controlTool );
 
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::editSchematic );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::editSymbols );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::editPCB );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::editFootprints );
 
    toolsMenu->AppendSeparator();
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::viewGerbers );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::convertImage );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::showCalculator );
    toolsMenu->Add( KICAD_MANAGER_ACTIONS::editDrawingSheet );
 
    wxMenuItem* pcmMenuItem = toolsMenu->Add( KICAD_MANAGER_ACTIONS::showPluginManager );
 
    if( KIPLATFORM::POLICY::GetPolicyBool( POLICY_KEY_PCM )
        == KIPLATFORM::POLICY::PBOOL::DISABLED )
    {
        pcmMenuItem->Enable( false );
    }
 
    toolsMenu->AppendSeparator();
    toolsMenu->Add( _( "Compare Project Branches..." ),
                    _( "Review the file changes between two git refs in the "
                       "current project" ),
                    ID_COMPARE_PROJECT_BRANCHES,
                    BITMAPS::change_entry_orient );
 
    toolsMenu->Add( _( "Edit Local File..." ),
                    _( "Edit local file in text editor" ),
                    ID_EDIT_LOCAL_FILE_IN_TEXT_EDITOR,
                    BITMAPS::editor );
 
    //-- Preferences menu -----------------------------------------------
    //
    ACTION_MENU* prefsMenu = new ACTION_MENU( false, controlTool );
 
    prefsMenu->Add( ACTIONS::configurePaths );
    prefsMenu->Add( ACTIONS::showSymbolLibTable );
    prefsMenu->Add( ACTIONS::showFootprintLibTable );
    prefsMenu->Add( ACTIONS::showDesignBlockLibTable );
    prefsMenu->Add( ACTIONS::openPreferences );
 
    prefsMenu->AppendSeparator();
    AddMenuLanguageList( prefsMenu, controlTool );
 
 
    //-- Menubar -------------------------------------------------------------
    //
    menuBar->Append( fileMenu,  _( "&File" ) );
    menuBar->Append( editMenu,  _( "&Edit" ) );
    menuBar->Append( viewMenu,  _( "&View" ) );
    menuBar->Append( toolsMenu, _( "&Tools" ) );
    menuBar->Append( prefsMenu, _( "&Preferences" ) );
    AddStandardHelpMenu( menuBar );
 
    SetMenuBar( menuBar );
    delete oldMenuBar;
}