kicad/pcbnew/dialogs/panel_fp_lib_table.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018-2023 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/>.
 */

#ifndef PANEL_FP_LIB_TABLE_H
#define PANEL_FP_LIB_TABLE_H

#include <panel_fp_lib_table_base.h>
#include <widgets/wx_grid.h>
#include <pcb_io/pcb_io_mgr.h>

class FP_LIB_TABLE;
class FP_LIB_TABLE_GRID;
class PROJECT;


/**
 * Dialog to show and edit symbol library tables.
 */
class PANEL_FP_LIB_TABLE : public PANEL_FP_LIB_TABLE_BASE
{

public:
    PANEL_FP_LIB_TABLE( DIALOG_EDIT_LIBRARY_TABLES* aParent, PROJECT* aProject,
                        FP_LIB_TABLE* aGlobalTable, const wxString& aGlobalTblPath,
                        FP_LIB_TABLE* aProjectTable, const wxString& aProjectTblPath,
                        const wxString& aProjectBasePath );
    ~PANEL_FP_LIB_TABLE() override;

private:
    bool TransferDataFromWindow() override;

    /**
     * Trim important fields, removes blank row entries, and checks for duplicates.
     *
     * @return bool - true if tables are OK, else false.
     */
    bool verifyTables();

    void OnUpdateUI( wxUpdateUIEvent& event ) override;
    void appendRowHandler( wxCommandEvent& event ) override;
    void browseLibrariesHandler( wxCommandEvent& event );
    void deleteRowHandler( wxCommandEvent& event ) override;
    void moveUpHandler( wxCommandEvent& event ) override;
    void moveDownHandler( wxCommandEvent& event ) override;
    void onMigrateLibraries( wxCommandEvent& event ) override;
    void onSizeGrid( wxSizeEvent& event ) override;

    void onPageChange( wxBookCtrlEvent& event ) override;
    void onReset( wxCommandEvent& event ) override;

    void setupGrid( WX_GRID* aGrid );

    void adjustPathSubsGridColumns( int aWidth );

    /// Populate the readonly environment variable table with names and values
    /// by examining all the full_uri columns.
    void populateEnvironReadOnlyTable();
    void populatePluginList();

    FP_LIB_TABLE_GRID* global_model() const
    {
        return (FP_LIB_TABLE_GRID*) m_global_grid->GetTable();
    }

    FP_LIB_TABLE_GRID* project_model() const
    {
        return m_project_grid ? (FP_LIB_TABLE_GRID*) m_project_grid->GetTable() : nullptr;
    }

    FP_LIB_TABLE_GRID* cur_model() const
    {
        return (FP_LIB_TABLE_GRID*) m_cur_grid->GetTable();
    }

    // caller's tables are modified only on OK button and successful verification.
    FP_LIB_TABLE*    m_globalTable;
    FP_LIB_TABLE*    m_projectTable;
    PROJECT*         m_project;
    wxString         m_projectBasePath;

    DIALOG_EDIT_LIBRARY_TABLES* m_parent;
    wxArrayString               m_pluginChoices;

    WX_GRID*         m_cur_grid;      // changed based on tab choice
    static size_t    m_pageNdx;       // Remember last notebook page selected during a session

    //< Transient (unsaved) last browsed folder when adding a project level library.
    wxString         m_lastProjectLibDir;

    std::map<PCB_IO_MGR::PCB_FILE_T, IO_BASE::IO_FILE_DESC> m_supportedFpFiles;
};

#endif    // PANEL_FP_LIB_TABLE_H