kicad-source/kicad/pcm/dialogs/dialog_manage_repositories.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Andrew Lutsenko, anlutsenko at gmail dot com
 * 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 "dialog_manage_repositories.h"
#include <bitmaps/bitmap_types.h>
#include <bitmaps/bitmaps_list.h>
#include <grid_tricks.h>
#include <settings/kicad_settings.h>
#include <widgets/wx_grid.h>
#include <widgets/std_bitmap_button.h>


#define GRID_CELL_MARGIN 4


DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(
        wxWindow* parent, std::shared_ptr<PLUGIN_CONTENT_MANAGER> pcm ) :
        DIALOG_MANAGE_REPOSITORIES_BASE( parent ),
        m_pcm( pcm )
{
    m_buttonAdd->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
    m_buttonRemove->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
    m_buttonMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
    m_buttonMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );

    // For aesthetic reasons, we must set the size of m_buttonAdd to match the other bitmaps
    // manually (for instance m_buttonRemove)
    Layout(); // Needed at least on MSW to compute the actual buttons sizes, after initializing
              // their bitmaps
    m_buttonAdd->SetWidthPadding( 4 );
    m_buttonAdd->SetMinSize( m_buttonRemove->GetSize() );

    m_buttonAdd->Bind( wxEVT_BUTTON, &DIALOG_MANAGE_REPOSITORIES::OnAdd, this );

    wxMenu*     addMenu = m_buttonAdd->GetSplitButtonMenu();
    wxMenuItem* menuItem = addMenu->Append( wxID_ANY, _( "Add Default Repository" ) );

    addMenu->Bind( wxEVT_COMMAND_MENU_SELECTED, &DIALOG_MANAGE_REPOSITORIES::OnAddDefault, this,
                   menuItem->GetId() );

    m_grid->PushEventHandler( new GRID_TRICKS( m_grid, [this]( wxCommandEvent& aEvent )
                                                       {
                                                           OnAdd( aEvent );
                                                       } ) );

    for( int col = 0; col < m_grid->GetNumberCols(); col++ )
    {
        const wxString& heading = m_grid->GetColLabelValue( col );
        int             headingWidth = GetTextExtent( heading ).x + 2 * GRID_CELL_MARGIN;

        // Set the minimal width to the column label size.
        m_grid->SetColMinimalWidth( col, headingWidth );
    }

    // fix sizers now widgets are set.
    finishDialogSettings();
}


DIALOG_MANAGE_REPOSITORIES::~DIALOG_MANAGE_REPOSITORIES()
{
    // Delete the GRID_TRICKS.
    m_grid->PopEventHandler( true );
}


void DIALOG_MANAGE_REPOSITORIES::setColumnWidths()
{
    for( int col = 0; col < m_grid->GetNumberCols(); col++ )
    {
        // Set the width to see the full contents
        m_grid->SetColSize( col, m_grid->GetVisibleWidth( col, true, true ) );
    }
}


void DIALOG_MANAGE_REPOSITORIES::OnAdd( wxCommandEvent& event )
{
    wxTextEntryDialog entry_dialog( this, _( "Fully qualified repository url:" ),
                                    _( "Add Repository" ) );

    if( entry_dialog.ShowModal() == wxID_OK )
    {
        wxString url = entry_dialog.GetValue();
        addRepository( url );
    }
}


int DIALOG_MANAGE_REPOSITORIES::findRow( int aCol, const wxString& aVal )
{
    for( int row = 0; row < m_grid->GetNumberRows(); row++ )
    {
        if( m_grid->GetCellValue( row, aCol ) == aVal )
            return row;
    }

    return -1;
}


void DIALOG_MANAGE_REPOSITORIES::addRepository( const wxString& aUrl )
{
    int matching_row;

    if( ( matching_row = findRow( 1, aUrl ) ) >= 0 )
    {
        selectRow( matching_row );
        return;
    }

    PCM_REPOSITORY       repository;
    WX_PROGRESS_REPORTER reporter( GetParent(), wxT( "" ), 1, PR_CAN_ABORT );

    if( m_pcm->FetchRepository( aUrl, repository, &reporter ) )
    {
        wxString name = repository.name;
        int      increment = 1;

        while( findRow( 0, name ) >= 0 )
            name = wxString::Format( "%s (%d)", repository.name, increment++ );

        m_grid->Freeze();

        m_grid->AppendRows();
        int row = m_grid->GetNumberRows() - 1;

        m_grid->SetCellValue( row, 0, name );
        m_grid->SetCellValue( row, 1, aUrl );

        setColumnWidths();
        m_grid->Thaw();

        selectRow( row );
    }
}


void DIALOG_MANAGE_REPOSITORIES::OnAddDefault( wxCommandEvent& event )
{
    addRepository( PCM_DEFAULT_REPOSITORY_URL );
}


void DIALOG_MANAGE_REPOSITORIES::OnRemoveButtonClicked( wxCommandEvent& event )
{
    m_grid->OnDeleteRows(
            [&]( int row )
            {
                m_grid->DeleteRows( row );
                setColumnWidths();
            } );
}


void DIALOG_MANAGE_REPOSITORIES::OnMoveUpButtonClicked( wxCommandEvent& event )
{
    m_grid->OnMoveRowUp(
            [&]( int row )
            {
                m_grid->SwapRows( row, row - 1 );
            } );
}


void DIALOG_MANAGE_REPOSITORIES::OnMoveDownButtonClicked( wxCommandEvent& event )
{
    m_grid->OnMoveRowDown(
            [&]( int row )
            {
                m_grid->SwapRows( row, row + 1 );
            } );
}


void DIALOG_MANAGE_REPOSITORIES::OnGridCellClicked( wxGridEvent& event )
{
    selectRow( event.GetRow() );
}


void DIALOG_MANAGE_REPOSITORIES::selectRow( int aRow )
{
    m_grid->ClearSelection();
    m_grid->SelectRow( aRow );
}


void DIALOG_MANAGE_REPOSITORIES::SetData( const std::vector<std::pair<wxString, wxString>>& aData )
{
    m_grid->Freeze();
    m_grid->ClearRows();
    m_grid->AppendRows( aData.size() );

    for( size_t i = 0; i < aData.size(); i++ )
    {
        m_grid->SetCellValue( i, 0, aData[i].first );
        m_grid->SetCellValue( i, 1, aData[i].second );
    }

    setColumnWidths();

    m_grid->Thaw();
}


std::vector<std::pair<wxString, wxString>> DIALOG_MANAGE_REPOSITORIES::GetData()
{
    std::vector<std::pair<wxString, wxString>> result;

    for( int i = 0; i < m_grid->GetNumberRows(); i++ )
    {
        result.push_back(
                std::make_pair( m_grid->GetCellValue( i, 0 ), m_grid->GetCellValue( i, 1 ) ) );
    }

    return result;
}


void DIALOG_MANAGE_REPOSITORIES::OnSaveClicked( wxCommandEvent& event )
{
    EndModal( wxID_SAVE );
}