eeschema_config.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#include <mutex>
#include <wx/ffile.h>
 
#include <confirm.h>
#include <dialogs/dialog_schematic_setup.h>
#include <kiway.h>
#include <symbol_edit_frame.h>
#include <dialogs/panel_base_display_options.h>
#include <filename_resolver.h>
#include <pgm_base.h>
#include <project/project_file.h>
#include <project/project_local_settings.h>
#include <project/net_settings.h>
#include <sch_edit_frame.h>
#include <settings/color_settings.h>
#include <sch_painter.h>
#include <connection_graph.h>
#include <schematic.h>
#include <schematic_text_var_adapter.h>
#include <text_var_dependency.h>
#include <widgets/hierarchy_pane.h>
#include <widgets/sch_design_block_pane.h>
#include <widgets/sch_search_pane.h>
#include <widgets/panel_remote_symbol.h>
#include <widgets/panel_sch_selection_filter.h>
#include <widgets/properties_panel.h>
#include <settings/app_settings.h>
#include <settings/settings_manager.h>
#include <wildcards_and_files_ext.h>
#include <drawing_sheet/ds_data_model.h>
#include <sim/spice_settings.h>
#include <tool/tool_manager.h>
#include <tools/sch_selection_tool.h>
 

COLOR4D GetLayerColor( SCH_LAYER_ID aLayer )
{
    return ::GetColorSettings( DEFAULT_THEME )->GetColor( aLayer );
}
 
 
bool SCH_EDIT_FRAME::LoadProjectSettings()
{
    SCHEMATIC_SETTINGS& settings = Schematic().Settings();
 
    GetRenderSettings()->SetDefaultPenWidth( settings.m_DefaultLineWidth );
    GetRenderSettings()->m_LabelSizeRatio  = settings.m_LabelSizeRatio;
    GetRenderSettings()->m_TextOffsetRatio = settings.m_TextOffsetRatio;
    GetRenderSettings()->m_PinSymbolSize   = settings.m_PinSymbolSize;
    GetRenderSettings()->m_SymbolLineWidth = settings.m_DefaultLineWidth;
    GetRenderSettings()->SetDashLengthRatio( settings.m_DashedLineDashRatio );
    GetRenderSettings()->SetGapLengthRatio( settings.m_DashedLineGapRatio );
 
    BASE_SCREEN::m_DrawingSheetFileName = settings.m_SchDrawingSheetFileName;
 
    PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
 
    SCH_SELECTION_TOOL* selTool = GetToolManager()->GetTool<SCH_SELECTION_TOOL>();
    selTool->GetFilter() = localSettings.m_SchSelectionFilter;
    m_selectionFilterPanel->SetCheckboxesFromFilter( localSettings.m_SchSelectionFilter );
 
    return true;
}
 
 
void SCH_EDIT_FRAME::LoadDrawingSheet()
{
    // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
    // If empty, or not existing, the default drawing sheet is loaded.
 
    SCHEMATIC_SETTINGS& settings = Schematic().Settings();
    FILENAME_RESOLVER resolver;
    resolver.SetProject( &Prj() );
    resolver.SetProgramBase( &Pgm() );
 
    wxString filename = resolver.ResolvePath( settings.m_SchDrawingSheetFileName,
                                              Prj().GetProjectPath(),
                                              { Schematic().GetEmbeddedFiles() } );
    wxString msg;
 
    if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
        ShowInfoBarError( msg, true );
}
 
 
void SCH_EDIT_FRAME::ShowSchematicSetupDialog( const wxString& aInitialPage )
{
    static std::mutex dialogMutex; // Local static mutex
 
    std::unique_lock<std::mutex> dialogLock( dialogMutex, std::try_to_lock );
 
    // One dialog at a time.
    if( !dialogLock.owns_lock() )
    {
        if( m_schematicSetupDialog && m_schematicSetupDialog->IsShown() )
            m_schematicSetupDialog->Raise(); // Brings the existing dialog to the front
 
        return;
    }
 
    std::map<wxString, std::vector<wxString>> oldAliases = Prj().GetProjectFile().m_BusAliases;
 
    DIALOG_SCHEMATIC_SETUP dlg( this );
 
    if( !aInitialPage.IsEmpty() )
        dlg.SetInitialPage( aInitialPage, wxEmptyString );
 
    // Assign dlg to the m_schematicSetupDialog pointer to track its status.
    // No, this does not escape the function context.
    NULLER raii_nuller( (void*&) m_schematicSetupDialog ); m_schematicSetupDialog = &dlg;
 
    if( dlg.ShowModal() == wxID_OK )
    {
        // Mark document as modified so that project settings can be saved as part of doc save
        OnModify();
 
        Kiway().CommonSettingsChanged( TEXTVARS_CHANGED );
 
        Prj().IncrementTextVarsTicker();
        Prj().IncrementNetclassesTicker();
 
        // CROSS_REF keys deliberately excluded — those are driven by per-item
        // SCH_COMMIT changes.
        if( SCHEMATIC_TEXT_VAR_ADAPTER* adapter = Schematic().GetTextVarAdapter() )
            adapter->Tracker().InvalidateProjectScoped();
 
        Pgm().GetSettingsManager().SaveProject();
 
        GetRenderSettings()->SetDefaultPenWidth( Schematic().Settings().m_DefaultLineWidth );
        GetRenderSettings()->m_LabelSizeRatio  = Schematic().Settings().m_LabelSizeRatio;
        GetRenderSettings()->m_TextOffsetRatio = Schematic().Settings().m_TextOffsetRatio;
        GetRenderSettings()->m_PinSymbolSize   = Schematic().Settings().m_PinSymbolSize;
        GetRenderSettings()->m_SymbolLineWidth = Schematic().Settings().m_DefaultLineWidth;
 
        GetRenderSettings()->SetDashLengthRatio( Schematic().Settings().m_DashedLineDashRatio );
        GetRenderSettings()->SetGapLengthRatio( Schematic().Settings().m_DashedLineGapRatio );
 
        GetCanvas()->GetView()->MarkDirty();
        GetCanvas()->GetView()->UpdateAllItems( KIGFX::REPAINT );
 
        std::map<wxString, std::vector<wxString>> newAliases = Prj().GetProjectFile().m_BusAliases;
 
        if( oldAliases != newAliases )
        {
            RecalculateConnections( nullptr, GLOBAL_CLEANUP );
        }
        else if( CONNECTION_GRAPH* graph = Schematic().ConnectionGraph() )
        {
            // No connectivity rebuild ran, so a net-chain netclass override or a deleted/renamed
            // netclass would otherwise leave the chain-derived assignments stale.  Re-derive them
            // directly; chain membership is unaffected by the setup dialog.
            graph->ApplyNetChainNetclasses();
        }
 
        RefreshOperatingPointDisplay();
        GetCanvas()->Refresh();
    }
}
 
 
void SCH_EDIT_FRAME::saveProjectSettings()
{
    wxFileName fn = Schematic().RootScreen()->GetFileName();  //ConfigFileName
 
    fn.SetExt( FILEEXT::ProjectFileExtension );
 
    if( !fn.HasName() || !IsWritable( fn, false ) )
        return;
 
    Schematic().RecordERCExclusions();
 
    if( Kiway().Player( FRAME_SIMULATOR, false ) )
        Prj().GetProjectFile().m_SchematicSettings->m_NgspiceSettings->SaveToFile();
 
    // Save the page layout file if doesn't exist yet (e.g. if we opened a non-kicad schematic)
 
    // TODO: We need to remove dependence on BASE_SCREEN
    Prj().GetProjectFile().m_SchematicSettings->m_SchDrawingSheetFileName = BASE_SCREEN::m_DrawingSheetFileName;
 
    if( !BASE_SCREEN::m_DrawingSheetFileName.IsEmpty() )
    {
        FILENAME_RESOLVER resolve;
        resolve.SetProject( &Prj() );
        resolve.SetProgramBase( &Pgm() );
 
        wxFileName layoutfn( resolve.ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
                                                  Prj().GetProjectPath(),
                                                  { Schematic().GetEmbeddedFiles() } ) );
 
        bool success = true;
 
        if( !layoutfn.IsAbsolute() )
            success = layoutfn.MakeAbsolute( Prj().GetProjectPath() );
 
        if( success && layoutfn.IsOk() && !layoutfn.FileExists() && layoutfn.HasName() )
        {
            if( layoutfn.DirExists() && layoutfn.IsDirWritable() )
            {
                try
                {
                    DS_DATA_MODEL::GetTheInstance().Save( layoutfn.GetFullPath() );
                }
                catch( const IO_ERROR& ioe )
                {
                    wxLogError( _( "Failed to save drawing sheet '%s': %s" ),
                                layoutfn.GetFullPath(), ioe.What() );
                }
            }
        }
    }
 
    // Propagate the root schematic revision to the project file for IPC-2581 BOM export
    if( Schematic().RootScreen() )
    {
        Prj().GetProjectFile().m_IP2581Bom.schRevision =
                Schematic().RootScreen()->GetTitleBlock().GetRevision();
    }
 
    // Update top-level sheets information in the project file
    const std::vector<SCH_SHEET*>& topLevelSheets = Schematic().GetTopLevelSheets();
 
    if( !topLevelSheets.empty() )
    {
        std::vector<TOP_LEVEL_SHEET_INFO>& projectSheets = Prj().GetProjectFile().GetTopLevelSheets();
        projectSheets.clear();
 
        wxString projectPath = Prj().GetProjectPath();
 
        for( SCH_SHEET* sheet : topLevelSheets )
        {
            TOP_LEVEL_SHEET_INFO info;
            info.uuid = sheet->m_Uuid;
            info.name = sheet->GetName();
 
            // For top-level sheets, get the filename from the screen, not from the sheet's
            // SHEET_FILENAME field (which is only used for sheet instances on parent sheets)
            wxString filename;
 
            if( sheet->GetScreen() )
                filename = sheet->GetScreen()->GetFileName();
 
            // Make the filename relative to the project path
            wxFileName sheetFn( filename );
 
            if( sheetFn.IsAbsolute() )
                sheetFn.MakeRelativeTo( projectPath );
 
            info.filename = sheetFn.GetFullPath();
 
            projectSheets.push_back( std::move( info ) );
        }
    }
 
    GetSettingsManager()->SaveProject( fn.GetFullPath() );
}
 
 
void SCH_EDIT_FRAME::SaveProjectLocalSettings()
{
    PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
 
    if( TOOL_MANAGER* toolMgr = GetToolManager() )
    {
        if( SCH_SELECTION_TOOL* selTool = toolMgr->GetTool<SCH_SELECTION_TOOL>() )
            localSettings.m_SchSelectionFilter = selTool->GetFilter();
    }
 
    localSettings.m_SchHierarchyCollapsed = m_hierarchy->GetCollapsedPaths();
}
 
 
void SCH_EDIT_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg )
{
    // For now, axes are forced off in Eeschema even if turned on in config
    EESCHEMA_SETTINGS* cfg = eeconfig();
    cfg->m_Window.grid.axes_enabled = false;
 
    SCH_BASE_FRAME::LoadSettings( cfg );
 
    SCH_SEARCH_DATA* searchData = dynamic_cast<SCH_SEARCH_DATA*>( m_findReplaceData.get() );
 
    if( searchData )
    {
        searchData->replaceReferences = cfg->m_FindReplaceExtra.replace_references;
        searchData->searchAllFields = cfg->m_FindReplaceExtra.search_all_fields;
        searchData->searchMetadata = cfg->m_FindReplaceExtra.search_metadata;
        searchData->searchAllPins = cfg->m_FindReplaceExtra.search_all_pins;
        searchData->searchCurrentSheetOnly = cfg->m_FindReplaceExtra.search_current_sheet_only;
        searchData->searchSelectedOnly = cfg->m_FindReplaceExtra.search_selected_only;
    }
 
    m_show_search = cfg->m_AuiPanels.show_search;
 
    GetRenderSettings()->m_ShowPinsElectricalType = false;
    GetRenderSettings()->m_ShowPinNumbers = false;
    GetRenderSettings()->m_ShowPinAltIcons = cfg->m_Appearance.show_pin_alt_icons;
    GetRenderSettings()->SetDefaultFont( cfg->m_Appearance.default_font );
}
 
 
void SCH_EDIT_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg )
{
    EESCHEMA_SETTINGS* cfg = eeconfig();
    SCH_BASE_FRAME::SaveSettings( cfg );
    wxAuiPaneInfo& hierarchy_pane = m_auimgr.GetPane( SchematicHierarchyPaneName() );
 
    if( cfg )
    {
        cfg->m_System.units = static_cast<int>( GetUserUnits() );
        cfg->m_AuiPanels.show_schematic_hierarchy = hierarchy_pane.IsShown();
        cfg->m_AuiPanels.schematic_hierarchy_float = hierarchy_pane.IsFloating();
 
        // Other parameters (hierarchy_panel_float_width, hierarchy_panel_float_height,
        // and hierarchy_panel_docked_width should have been updated when resizing the
        // hierarchy panel
 
        SCH_SEARCH_DATA* searchData = dynamic_cast<SCH_SEARCH_DATA*>( m_findReplaceData.get() );
 
        if( searchData )
        {
            cfg->m_FindReplaceExtra.replace_references = searchData->replaceReferences;
            cfg->m_FindReplaceExtra.search_all_fields = searchData->searchAllFields;
            cfg->m_FindReplaceExtra.search_metadata = searchData->searchMetadata;
            cfg->m_FindReplaceExtra.search_all_pins = searchData->searchAllPins;
            cfg->m_FindReplaceExtra.search_current_sheet_only = searchData->searchCurrentSheetOnly;
            cfg->m_FindReplaceExtra.search_selected_only = searchData->searchSelectedOnly;
        }
 
        wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
        m_show_search = searchPaneInfo.IsShown();
        cfg->m_AuiPanels.show_search = m_show_search;
        cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
        cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
        cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
 
        wxAuiPaneInfo& propertiesPane = m_auimgr.GetPane( PropertiesPaneName() );
        cfg->m_AuiPanels.show_properties = propertiesPane.IsShown();
        cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
        cfg->m_AuiPanels.properties_panel_width = m_propertiesPanel->GetSize().x;
 
        wxAuiPaneInfo& netNavigatorPane = m_auimgr.GetPane( NetNavigatorPaneName() );
        cfg->m_AuiPanels.show_net_nav_panel = netNavigatorPane.IsShown();
        cfg->m_AuiPanels.float_net_nav_panel = netNavigatorPane.IsFloating();
 
        if( netNavigatorPane.IsDocked() )
        {
            cfg->m_AuiPanels.net_nav_panel_docked_size = m_netNavigator->GetSize();
        }
        else
        {
            cfg->m_AuiPanels.net_nav_panel_float_pos = netNavigatorPane.floating_pos;
            cfg->m_AuiPanels.net_nav_panel_float_size = netNavigatorPane.floating_size;
        }
 
        wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
        cfg->m_AuiPanels.design_blocks_show = designBlocksPane.IsShown();
 
        if( designBlocksPane.IsDocked() )
        {
            cfg->m_AuiPanels.design_blocks_panel_docked_width = m_designBlocksPane->GetSize().x;
        }
        else
        {
            cfg->m_AuiPanels.design_blocks_panel_float_height = designBlocksPane.floating_size.y;
            cfg->m_AuiPanels.design_blocks_panel_float_width = designBlocksPane.floating_size.x;
        }
 
        m_designBlocksPane->SaveSettings();
 
        wxAuiPaneInfo& remoteSymbolPane = m_auimgr.GetPane( RemoteSymbolPaneName() );
        cfg->m_AuiPanels.remote_symbol_show = remoteSymbolPane.IsShown();
 
        if( remoteSymbolPane.IsDocked() )
        {
            cfg->m_AuiPanels.remote_symbol_panel_docked_width = m_remoteSymbolPane->GetSize().x;
        }
        else
        {
            cfg->m_AuiPanels.remote_symbol_panel_float_height = remoteSymbolPane.floating_size.y;
            cfg->m_AuiPanels.remote_symbol_panel_float_width = remoteSymbolPane.floating_size.x;
        }
    }
}
 
 
void SCH_BASE_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg )
{
    wxCHECK_RET( aCfg, "Call to SCH_BASE_FRAME::LoadSettings with null settings" );
 
    EDA_DRAW_FRAME::LoadSettings( aCfg );
 
    // Move legacy user grids to grid list
    if( !aCfg->m_Window.grid.user_grid_x.empty() )
    {
        aCfg->m_Window.grid.grids.emplace_back( GRID{ "User Grid",
                                                      aCfg->m_Window.grid.user_grid_x,
                                                      aCfg->m_Window.grid.user_grid_y } );
        aCfg->m_Window.grid.user_grid_x = wxEmptyString;
        aCfg->m_Window.grid.user_grid_y = wxEmptyString;
    }
 
    if( aCfg->m_Window.grid.last_size_idx > (int) aCfg->m_Window.grid.grids.size() )
        aCfg->m_Window.grid.last_size_idx = 1;
 
    if( aCfg->m_Window.grid.fast_grid_1 > (int) aCfg->m_Window.grid.grids.size() )
        aCfg->m_Window.grid.fast_grid_1 = 1;
 
    if( aCfg->m_Window.grid.fast_grid_2 > (int) aCfg->m_Window.grid.grids.size() )
        aCfg->m_Window.grid.fast_grid_2 = 2;
}
 
 
void SCH_BASE_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg )
{
    wxCHECK_RET( aCfg, wxS( "Call to SCH_BASE_FRAME::SaveSettings with null settings" ) );
 
    EDA_DRAW_FRAME::SaveSettings( aCfg );
}