kicad-source/gerbview/select_layers_to_pcb.cpp

/*******************************************************/
/* Dialog frame to choose gerber layers and pcb layers */
/*******************************************************/

/**
 * @file select_layers_to_pcb.cpp
 */

#include "fctsys.h"
#include "common.h"
#include "appl_wxstruct.h"
#include "gerbview.h"
#include "class_board_design_settings.h"
#include "class_GERBER.h"
#include "wx/statline.h"

#include "dialogs/dialog_layers_select_to_pcb_base.h"

#define LAYER_UNSELECTED NB_LAYERS

static int    ButtonTable[32];          // Indexes buttons to Gerber layers
static int    LayerLookUpTable[32];     // Indexes Gerber layers to PCB file layers
wxStaticText* layer_list[32];           // Indexes text strings to buttons

enum swap_layer_id {
    ID_LAYERS_TABLE_DIALOG = 1800,
    ID_BUTTON_0,
    ID_TEXT_0 = ID_BUTTON_0 + 32
};


class LAYERS_TABLE_DIALOG : public LAYERS_TABLE_DIALOG_BASE
{
private:
    GERBVIEW_FRAME* m_Parent;
    int m_itemsCount;

public: LAYERS_TABLE_DIALOG( GERBVIEW_FRAME* parent );
    ~LAYERS_TABLE_DIALOG() {};

private:
    void initDialog();
    void OnSelectLayer( wxCommandEvent& event );
    void OnOkClick( wxCommandEvent& event );
    void OnCancelClick( wxCommandEvent& event );

    void OnStoreSetup( wxCommandEvent& event );
    void OnGetSetup( wxCommandEvent& event );
	void OnResetClick( wxCommandEvent& event );

    DECLARE_EVENT_TABLE()
};


BEGIN_EVENT_TABLE( LAYERS_TABLE_DIALOG, LAYERS_TABLE_DIALOG_BASE )
EVT_COMMAND_RANGE( ID_BUTTON_0, ID_BUTTON_0 + 31,
                   wxEVT_COMMAND_BUTTON_CLICKED,
                   LAYERS_TABLE_DIALOG::OnSelectLayer )
END_EVENT_TABLE()


/* Install a dialog frame to choose the equivalence
 * between gerber layers and pcbnew layers
 * return the "lookup table" if ok, or NULL
 */
int* GERBVIEW_FRAME::InstallDialogLayerPairChoice() {
    LAYERS_TABLE_DIALOG* frame = new LAYERS_TABLE_DIALOG( this );

    int ii = frame->ShowModal();

    frame->Destroy();
    if( ii == wxID_OK )
        return LayerLookUpTable;
    else
        return NULL;
}


LAYERS_TABLE_DIALOG::LAYERS_TABLE_DIALOG( GERBVIEW_FRAME* parent ) :
    LAYERS_TABLE_DIALOG_BASE( parent )
{
    m_Parent = parent;
    initDialog();

    // Resize the dialog
    GetSizer()->SetSizeHints( this );
    Centre();
}


void LAYERS_TABLE_DIALOG::initDialog()
{
    wxStaticText* label;
    wxStaticText* text;
    int           item_ID, ii;
    wxString      msg;
    wxSize        goodSize;

    // Experimentation has shown that buttons in the Windows version can be 20
    // pixels wide and 20 pixels high, but that they need to be 26 pixels wide
    // and 26 pixels high in the Linux version. (And although the dimensions
    // of those buttons could be set to 26 pixels wide and 26 pixels high in
    // both of those versions, that would result in a dialog box which would
    // be excessively high in the Windows version.)
#ifdef __WINDOWS__
    int w = 20;
    int h = 20;
#else
    int w = 26;
    int h = 26;
#endif

    // As currently implemented, the dimensions of the buttons in the Mac
    // version are also 26 pixels wide and 26 pixels high. If appropriate,
    // the above code should be modified as required in the event that those
    // buttons should be some other size in that version.

    // Compute a reasonable number of copper layers
    int pcb_copper_layer_count = 0;
    for( ii = 0; ii < 32; ii++ )
    {
        if( g_GERBER_List[ii] != NULL )
            pcb_copper_layer_count++;

        // Specify the default value for each member of these arrays.
        ButtonTable[ii] = -1;
        LayerLookUpTable[ii] = LAYER_UNSELECTED;
    }

    // Ensure we have at least 2 copper layers and NB_COPPER_LAYERS copper layers max
    if( pcb_copper_layer_count < 2 )
        pcb_copper_layer_count = 2;
    if( pcb_copper_layer_count > NB_COPPER_LAYERS )
        pcb_copper_layer_count = NB_COPPER_LAYERS;
    m_Parent->GetBoard()->SetCopperLayerCount( pcb_copper_layer_count );

    int pcb_layer_num = 0;
    m_itemsCount = 0;
    for( ii = 0; ii < 32; ii++ )
    {
        if( g_GERBER_List[ii] == NULL )
            continue;

        if( (pcb_layer_num == m_Parent->GetBoard()->GetCopperLayerCount() - 1)
           && (m_Parent->GetBoard()->GetCopperLayerCount() > 1) )
            pcb_layer_num = LAYER_N_FRONT;

        ButtonTable[m_itemsCount] = ii;
        LayerLookUpTable[ii]  = pcb_layer_num;
        m_itemsCount++;
        pcb_layer_num++;
    }

    if( m_itemsCount <= 16 )    // Only one list is enough
    {
        m_staticlineSep->Hide();
    }

    wxFlexGridSizer* flexColumnBoxSizer = m_flexLeftColumnBoxSizer;
    for( ii = 0; ii < m_itemsCount; ii++ )
    {
        // Each Gerber layer has an associated static text string (to
        // identify that layer), a button (for invoking a child dialog
        // box to change which pcbnew layer that the Gerber layer is
        // mapped to), and a second static text string (to depict which
        // pcbnew layer that the Gerber layer has been mapped to). Each
        // of those items are placed into the left hand column, middle
        // column, and right hand column (respectively) of the Flexgrid
        // sizer, and the color of the second text string is set to
        // fuchsia or blue (to respectively indicate whether the Gerber
        // layer has been mapped to a pcbnew layer or is not being
        // exported at all).  (Experimentation has shown that if a text
        // control is used to depict which pcbnew layer that each Gerber
        // layer is mapped to (instead of a static text string), then
        // those controls do not behave in a fully satisfactory manner
        // in the Linux version. Even when the read-only attribute is
        // specified for all of those controls, they can still be selected
        // when the arrow keys or Tab key is used to step through all of
        // the controls within the dialog box, and directives to set the
        // foreground color of the text of each such control to blue (to
        // indicate that the text is of a read-only nature) are disregarded.
        // Specify a FlexGrid sizer with an appropriate number of rows
        // and three columns.  If nb_items < 16, then the number of rows
        // is nb_items; otherwise, the number of rows is 16 (with two
        // separate columns of controls being used if nb_items > 16).

        if( ii == 16 )
            flexColumnBoxSizer = m_flexRightColumnBoxSizer;

        // Provide a text string to identify the Gerber layer
        msg.Printf( _( "Layer %d" ), ButtonTable[ii] + 1 );

        label = new wxStaticText( this, wxID_STATIC, msg, wxDefaultPosition,
                                  wxDefaultSize, wxALIGN_RIGHT );
        flexColumnBoxSizer->Add( label, 0,
                                 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL |
                                 wxRIGHT | wxLEFT, 5 );

        /* Add file name and extension without path. */
        wxFileName fn( g_GERBER_List[ii]->m_FileName );
        label = new wxStaticText( this, wxID_STATIC, fn.GetFullName(),
                                  wxDefaultPosition, wxDefaultSize );
        flexColumnBoxSizer->Add( label, 0,
                                 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL |
                                 wxRIGHT | wxLEFT, 5 );

        // Provide a button for this layer (which will invoke a child dialog box)
        item_ID = ID_BUTTON_0 + ii;
        wxButton * Button = new wxButton( this, item_ID, wxT( "..." ),
                                        wxDefaultPosition, wxSize( w, h ), 0 );

        flexColumnBoxSizer->Add( Button, 0,
                                 wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL );

        // Provide another text string to specify which pcbnew layer that this
        // Gerber layer is initially mapped to, and set the initial text to
        // specify the appropriate pcbnew layer, and set the foreground color
        // of the text to fuchsia (to indicate that the layer is being exported).
        item_ID = ID_TEXT_0 + ii;

        // When the first of these text strings is being added, determine what
        // size is necessary to to be able to display any possible string
        // without it being truncated. Then specify that size as the minimum
        // size for all of these text strings. (If this minimum size is not
        // determined in this fashion, then it is possible for the display of
        // one or more of these strings to be truncated after different pcbnew
        // layers are selected.)
        if( ii == 0 )
        {
            msg  = _( "Do not export" );
            text = new wxStaticText( this, item_ID, msg, wxDefaultPosition,
                                     wxDefaultSize, 0 );
            goodSize = text->GetSize();

            for( int jj = 0; jj < NB_LAYERS; jj++ )
            {
                text->SetLabel( BOARD::GetDefaultLayerName( jj ) );
                if( goodSize.x < text->GetSize().x )
                    goodSize.x = text->GetSize().x;
            }

            msg = BOARD::GetDefaultLayerName( LayerLookUpTable[ButtonTable[ii]] );
            text->SetLabel( msg );
        }
        else
        {
            msg  = BOARD::GetDefaultLayerName( LayerLookUpTable[ButtonTable[ii]] );
            text = new wxStaticText( this, item_ID, msg, wxDefaultPosition,
                                     wxDefaultSize, 0 );
        }
        text->SetMinSize( goodSize );
        flexColumnBoxSizer->Add( text, 1,
                                 wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL | wxRIGHT | wxLEFT,
                                 5 );

        layer_list[ii] = text;
    }
}


/*
 * reset pcb layers selection to the default value
 */
void LAYERS_TABLE_DIALOG::OnResetClick( wxCommandEvent& event )
{
    wxString msg;
    int ii, layer;
    for( ii = 0, layer = 0; ii < m_itemsCount; ii++, layer++ )
    {
        if( (layer == m_Parent->GetBoard()->GetCopperLayerCount() - 1)
           && (m_Parent->GetBoard()->GetCopperLayerCount() > 1) )
            layer = LAYER_N_FRONT;
        LayerLookUpTable[ii] = layer;
        msg = BOARD::GetDefaultLayerName( layer );
        layer_list[ii]->SetLabel( msg );
        layer_list[ii]->SetForegroundColour( wxNullColour );
        ButtonTable[ii] = ii;
    }
}


/* Stores the current mayers selection in config
 */
void LAYERS_TABLE_DIALOG::OnStoreSetup( wxCommandEvent& event )
{
    wxConfig* config = wxGetApp().m_EDA_Config;
    config->Write( wxT("BrdLayersCount"), m_itemsCount );

    wxString key;
    for( int ii = 0; ii < 32; ii++ )
    {
        key.Printf( wxT("GbrLyr%dToPcb"), ii );
        config->Write( key, LayerLookUpTable[ii] );
    }
}

void LAYERS_TABLE_DIALOG::OnGetSetup( wxCommandEvent& event )
{
    wxConfig* config = wxGetApp().m_EDA_Config;
    int lyrcnt = 0;
    config->Read( wxT("BrdLayersCount"), &lyrcnt );
    if( lyrcnt == 0 || lyrcnt != m_itemsCount )
    {
        wxString msg;
        msg.Printf( _("Previous stored setup as %d layers, and there are %d loaded layers"),
                    lyrcnt, m_itemsCount );
        wxMessageBox( msg );
        return;
    }
    wxString key;
    for( int ii = 0; ii < 32; ii++ )
    {
        key.Printf( wxT("GbrLyr%dToPcb"), ii );
        config->Read( key, &LayerLookUpTable[ii] );
    }

    for( int ii = 0; ii < m_itemsCount; ii++ )
    {
        int layer =  LayerLookUpTable[ii];
        if( layer == LAYER_UNSELECTED )
        {
            layer_list[ii]->SetLabel( _( "Do not export" ) );
            layer_list[ii]->SetForegroundColour( *wxBLUE );
        }
        else
        {
            layer_list[ii]->SetLabel( BOARD::GetDefaultLayerName( layer ) );
            layer_list[ii]->SetForegroundColour( wxColour( 255, 0, 128 ) );
        }
    }
}

void LAYERS_TABLE_DIALOG::OnSelectLayer( wxCommandEvent& event )
{
    int ii, jj;

    ii = event.GetId();

    if( ii < ID_BUTTON_0 || ii >= ID_BUTTON_0 + 32 )
        return;

    ii = event.GetId() - ID_BUTTON_0;

    jj = LayerLookUpTable[ButtonTable[ii]];
    if( ( jj < 0 ) || ( jj > LAYER_UNSELECTED ) )
        jj = 0;  // (Defaults to "Copper" layer.)
    jj = m_Parent->SelectLayer( jj, -1, -1, true );

    if( ( jj < 0 ) || ( jj > LAYER_UNSELECTED ) )
        return;

    if( jj != LayerLookUpTable[ButtonTable[ii]] )
    {
        LayerLookUpTable[ButtonTable[ii]] = jj;
        if( jj == LAYER_UNSELECTED )
        {
            layer_list[ii]->SetLabel( _( "Do not export" ) );

            // Change the text color to blue (to highlight
            // that this layer is *not* being exported)
            layer_list[ii]->SetForegroundColour( *wxBLUE );
        }
        else
        {
            layer_list[ii]->SetLabel( BOARD::GetDefaultLayerName( jj ) );

            // Change the text color to fuchsia (to highlight
            // that this layer *is* being exported)
            layer_list[ii]->SetForegroundColour( wxColour( 255, 0, 128 ) );
        }
    }
}


void LAYERS_TABLE_DIALOG::OnCancelClick( wxCommandEvent& event )
{
    EndModal( wxID_CANCEL );
}


void LAYERS_TABLE_DIALOG::OnOkClick( wxCommandEvent& event )
{
    int  ii;
    bool AsCmpLayer = false;

    /* Compute the number of copper layers
     * this is the max layer number + 1 (if some internal layers exist)
     */
    int layers_count = 1;

    for( ii = 0; ii < 32; ii++ )
    {
        if( LayerLookUpTable[ii] == LAYER_N_FRONT )
            AsCmpLayer = true;
        else
        {
            if( LayerLookUpTable[ii] >= LAST_COPPER_LAYER )
                continue;  // not a copper layer
            if( LayerLookUpTable[ii] >= layers_count )
                layers_count++;
        }
    }

    if( AsCmpLayer )
        layers_count++;

    if( layers_count > NB_COPPER_LAYERS ) // should not occur.
        layers_count = NB_COPPER_LAYERS;

    if( layers_count < 2 )
        layers_count = 2;

    m_Parent->GetBoard()->SetCopperLayerCount( layers_count );

    EndModal( wxID_OK );
}