symbol_editor_settings.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 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 <json_common.h>
 
#include <settings/common_settings.h>
#include <settings/parameters.h>
#include <settings/settings_manager.h>
#include <settings/snap_settings_params.h>
#include "symbol_editor_settings.h"
#include <default_values.h>
 

const int libeditSchemaVersion = 1;
 
 
SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS() :
        APP_SETTINGS_BASE( "symbol_editor", libeditSchemaVersion ),
        m_Defaults(),
        m_Repeat(),
        m_ShowPinElectricalType( true ),
        m_LibWidth(),
        m_ArcEditMode( ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS )
{
    // Make Coverity happy
    m_UseEeschemaColorSettings = true;;
 
    // Init settings:
    SetLegacyFilename( wxS( "eeschema" ) );
 
    m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
            &m_AuiPanels.show_properties, true ) );
 
    m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
            &m_AuiPanels.properties_panel_width, -1 ) );
 
    m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
            &m_AuiPanels.properties_splitter, 0.5f ) );
 
    m_params.emplace_back( new PARAM<int>( "defaults.line_width",
            &m_Defaults.line_width, 0 ) );
 
    m_params.emplace_back( new PARAM<int>( "defaults.text_size",
            &m_Defaults.text_size, DEFAULT_TEXT_SIZE ) );
 
    m_params.emplace_back( new PARAM<int>( "defaults.pin_length",
            &m_Defaults.pin_length, DEFAULT_PIN_LENGTH ) );
 
    m_params.emplace_back( new PARAM<int>( "defaults.pin_name_size",
            &m_Defaults.pin_name_size, DEFAULT_PINNAME_SIZE ) );
 
    m_params.emplace_back( new PARAM<int>( "defaults.pin_num_size",
            &m_Defaults.pin_num_size, DEFAULT_PINNUM_SIZE ) );
 
    m_params.emplace_back( new PARAM<int>( "repeat.label_delta",
            &m_Repeat.label_delta, 1 ) );
 
    m_params.emplace_back( new PARAM<int>( "repeat.pin_step",
            &m_Repeat.pin_step, 100 ) );
 
    m_params.emplace_back( new PARAM<bool>( "show_pin_electrical_type",
            &m_ShowPinElectricalType, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "show_pin_alt_icons",
            &m_ShowPinAltIcons, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "show_hidden_lib_fields",
            &m_ShowHiddenFields, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "show_hidden_lib_pins",
            &m_ShowHiddenPins, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "drag_pins_along_with_edges",
            &m_dragPinsAlongWithEdges, true ) );
 
    m_params.emplace_back( new PARAM<int>( "lib_table_width",
            &m_LibWidth, 250 ) );
 
    m_params.emplace_back( new PARAM<int>( "library.sort_mode",
            &m_LibrarySortMode, 0 ) );
 
    m_params.emplace_back( new PARAM<bool>( "use_eeschema_color_settings",
            &m_UseEeschemaColorSettings, true ) );
 
    m_params.emplace_back( new PARAM<int>( "editing.arc_edit_mode",
            reinterpret_cast<int*>( &m_ArcEditMode ),
            static_cast<int>( ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS ) ) );
 
    AddSnapInferenceParams( m_params, m_SnapInference );
 
    m_params.emplace_back( new PARAM_MAP<int>( "lib_field_editor.field_widths",
            &m_LibFieldEditor.field_widths, {} ) );
 
    m_params.emplace_back( new PARAM<int>( "lib_field_editor.sash_pos",
            &m_LibFieldEditor.sash_pos, 400 ) );
 
    m_params.emplace_back( new PARAM<bool>( "lib_field_editor.sidebar_collapsed",
            &m_LibFieldEditor.sidebar_collapsed, false ) );
 
    m_params.emplace_back( new PARAM<bool>( "pin_table.crossprobe_on_selection",
            &m_PinTable.crossprobe_on_selection, true ) );
 
    m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "selection_filter",
            [&]() -> nlohmann::json
            {
                nlohmann::json ret;
 
                ret["lockedItems"] = m_SelectionFilter.lockedItems;
                ret["symbols"]     = m_SelectionFilter.symbols;
                ret["text"]        = m_SelectionFilter.text;
                ret["wires"]       = m_SelectionFilter.wires;
                ret["labels"]      = m_SelectionFilter.labels;
                ret["pins"]        = m_SelectionFilter.pins;
                ret["graphics"]    = m_SelectionFilter.graphics;
                ret["images"]      = m_SelectionFilter.images;
                ret["otherItems"]  = m_SelectionFilter.otherItems;
 
                return ret;
            },
            [&]( const nlohmann::json& aVal )
            {
                if( aVal.empty() || !aVal.is_object() )
                    return;
 
                SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
                SetIfPresent( aVal, "symbols", m_SelectionFilter.symbols );
                SetIfPresent( aVal, "text", m_SelectionFilter.text );
                SetIfPresent( aVal, "wires", m_SelectionFilter.wires );
                SetIfPresent( aVal, "labels", m_SelectionFilter.labels );
                SetIfPresent( aVal, "pins", m_SelectionFilter.pins );
                SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
                SetIfPresent( aVal, "images", m_SelectionFilter.images );
                SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
            },
            {
                { "lockedItems", false },
                { "symbols", true },
                { "text", true },
                { "wires", true },
                { "labels", true },
                { "pins", true },
                { "graphics", true },
                { "images", true },
                { "otherItems", true }
            } ) );
 
    m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "open_tabs",
            [&]() -> nlohmann::json
            {
                nlohmann::json ret = nlohmann::json::array();
 
                for( const OPEN_TAB& tab : m_OpenTabs )
                {
                    nlohmann::json entry;
 
                    entry["lib"]        = tab.lib.ToUTF8();
                    entry["name"]       = tab.name.ToUTF8();
                    entry["unit"]       = tab.unit;
                    entry["body_style"] = tab.bodyStyle;
                    entry["preview"] = tab.preview;
 
                    ret.push_back( entry );
                }
 
                return ret;
            },
            [&]( const nlohmann::json& aVal )
            {
                m_OpenTabs.clear();
 
                if( !aVal.is_array() )
                    return;
 
                for( const nlohmann::json& entry : aVal )
                {
                    if( !entry.is_object() || !entry.contains( "lib" ) || !entry.contains( "name" ) )
                        continue;
 
                    OPEN_TAB tab;
 
                    tab.lib  = wxString::FromUTF8( entry["lib"].get<std::string>() );
                    tab.name = wxString::FromUTF8( entry["name"].get<std::string>() );
 
                    if( entry.contains( "unit" ) )
                        tab.unit = entry["unit"].get<int>();
 
                    if( entry.contains( "body_style" ) )
                        tab.bodyStyle = entry["body_style"].get<int>();
 
                    if( entry.contains( "preview" ) )
                        tab.preview = entry["preview"].get<bool>();
 
                    m_OpenTabs.push_back( tab );
                }
            },
            nlohmann::json::array() ) );
 
    m_params.emplace_back( new PARAM<wxString>( "active_tab", &m_ActiveTabKey, wxEmptyString ) );
 
    registerMigration( 0, 1,
                       [&]() -> bool
                       {
                           // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
                           return migrateLibTreeWidth();
                       } );
}
 
 
bool SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
{
    bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
 
    // Now modify the loaded grid selection, because in earlier versions the grids index was shared
    // between all applications and started at 1000 mils.  There is a 4-position offset between
    // this index and the possible eeschema grids list that we have to subtract.
    std::string gridSizePtr = "window.grid.last_size";
 
    if( std::optional<int> currentSize = Get<int>( gridSizePtr ) )
    {
        Set( gridSizePtr, *currentSize - 4 );
    }
    else
    {
        // Otherwise, default grid size should be 50 mils; index 1
        Set( gridSizePtr,  1 );
    }
 
    ret &= fromLegacy<int>( aCfg, "DefaultWireWidth",              "defaults.line_width" );
    ret &= fromLegacy<int>( aCfg, "DefaultPinLength",              "defaults.pin_length" );
    ret &= fromLegacy<int>( aCfg, "LibeditPinNameSize",            "defaults.pin_name_size" );
    ret &= fromLegacy<int>( aCfg, "LibeditPinNumSize",             "defaults.pin_num_size" );
 
    ret &= fromLegacy<int>( aCfg, "LibeditRepeatLabelInc",         "repeat.label_delta" );
    ret &= fromLegacy<int>( aCfg, "LibeditPinRepeatStep",          "repeat.pin_step" );
    ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepX",            "repeat.x_step" );
    ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepY",            "repeat.y_step" );
 
    ret &= fromLegacy<int>(  aCfg, "LibeditLibWidth",              "lib_table_width" );
    ret &= fromLegacy<bool>( aCfg, "LibeditShowPinElectricalType", "show_pin_electrical_type" );
 
    return ret;
}