panel_assign_component_classes.h

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/>.
 */
 
 
#ifndef PANEL_ASSIGN_COMPONENT_CLASSES_H
#define PANEL_ASSIGN_COMPONENT_CLASSES_H
 
 
#include <panel_assign_component_classes_base.h>
 
#include <unordered_set>
#include <vector>
 
#include <dialog_shim.h>
#include <pcb_edit_frame.h>
#include <project/component_class_settings.h>
 
 
/**************************************************************************************************
 *
 * PANEL_ASSIGN_COMPONENT_CLASSES
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_ASSIGNMENT;
 
class PANEL_ASSIGN_COMPONENT_CLASSES : public PANEL_ASSIGN_COMPONENT_CLASSES_BASE
{
public:
    PANEL_ASSIGN_COMPONENT_CLASSES( wxWindow* aParentWindow, PCB_EDIT_FRAME* aFrame,
                                    std::shared_ptr<COMPONENT_CLASS_SETTINGS> aSettings,
                                    DIALOG_SHIM*                              aDlg );
 
    ~PANEL_ASSIGN_COMPONENT_CLASSES() override;

    bool TransferDataToWindow() override;

    bool TransferDataFromWindow() override;

    void ImportSettingsFrom( const std::shared_ptr<COMPONENT_CLASS_SETTINGS>& aOtherSettings );

    void OnAddAssignmentClick( wxCommandEvent& event ) override;

    void RemoveAssignment( PANEL_COMPONENT_CLASS_ASSIGNMENT* aPanel );

    const std::vector<wxString>& GetSelectionRefs() const { return m_selectionRefs; }

    const std::vector<wxString>& GetFieldNames() const { return m_fieldNames; }

    const std::vector<wxString>& GetSheetNames() const { return m_sheetNames; }

    PCB_EDIT_FRAME* GetFrame() const { return m_frame; }

    bool Validate() override;
 
private:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* addAssignment();

    void scrollToAssignment( const PANEL_COMPONENT_CLASS_ASSIGNMENT* aAssignment ) const;

    DIALOG_SHIM* m_dlg;

    PCB_EDIT_FRAME* m_frame;

    std::vector<PANEL_COMPONENT_CLASS_ASSIGNMENT*> m_assignments;

    std::shared_ptr<COMPONENT_CLASS_SETTINGS> m_componentClassSettings;

    std::vector<wxString> m_selectionRefs;

    std::vector<wxString> m_fieldNames;

    std::vector<wxString> m_sheetNames;

    wxBoxSizer* m_assignmentsList;
};
 
 
/**************************************************************************************************
 *
 * CONDITION_DATA
 *
 *************************************************************************************************/

class CONDITION_DATA
{
public:
    CONDITION_DATA( const COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITION_TYPE aCondition,
                    wxTextEntry* aPrimary, wxTextEntry* aSecondary = nullptr ) :
            m_conditionType( aCondition ), m_primaryCtrl( aPrimary ), m_secondaryCtrl( aSecondary )
    {
    }
 
    virtual ~CONDITION_DATA() {};

    virtual COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITION_TYPE GetConditionType() const
    {
        return m_conditionType;
    }

    virtual wxString GetPrimaryField() const;

    virtual void SetPrimaryField( const wxString& aVal );

    virtual wxString GetSecondaryField() const;

    virtual void SetSecondaryField( const wxString& aVal );
 
private:
    COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITION_TYPE m_conditionType;

    wxTextEntry* m_primaryCtrl;

    wxTextEntry* m_secondaryCtrl;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_ASSIGNMENT
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_ASSIGNMENT : public PANEL_COMPONENT_CLASS_ASSIGNMENT_BASE
{
public:
    enum ADD_MATCH_POPUP
    {
        ID_REFERENCE = wxID_HIGHEST + 1,
        ID_FOOTPRINT,
        ID_SIDE,
        ID_ROTATION,
        ID_FOOTPRINT_FIELD,
        ID_SHEET_NAME,
        ID_CUSTOM
    };
 
    PANEL_COMPONENT_CLASS_ASSIGNMENT( wxWindow*                       aParent,
                                      PANEL_ASSIGN_COMPONENT_CLASSES* aPanelParent,
                                      DIALOG_SHIM*                    aDlg );
    ~PANEL_COMPONENT_CLASS_ASSIGNMENT();

    void OnDeleteAssignmentClick( wxCommandEvent& event ) override;

    void OnAddConditionClick( wxCommandEvent& event ) override;

    void OnHighlightItemsClick( wxCommandEvent& event ) override;

    CONDITION_DATA* AddCondition( COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITION_TYPE aCondition );

    void RemoveCondition( wxPanel* aMatch );
 
    const std::vector<CONDITION_DATA*>& GetConditions() const { return m_matches; }

    void SetComponentClass( const wxString& aComponentClass ) const;

    const wxString GetComponentClass() const;

    void
    SetConditionsOperator( COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITIONS_OPERATOR aCondition ) const;

    COMPONENT_CLASS_ASSIGNMENT_DATA::CONDITIONS_OPERATOR GetConditionsOperator() const;

    COMPONENT_CLASS_ASSIGNMENT_DATA GenerateAssignmentData() const;
 
protected:
    void onMenu( wxCommandEvent& aEvent );

    PANEL_ASSIGN_COMPONENT_CLASSES* m_parentPanel;

    wxStaticBoxSizer* m_matchesList;

    DIALOG_SHIM* m_dlg;

    std::vector<CONDITION_DATA*> m_matches;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_REFERENCE
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_REFERENCE
        : public PANEL_COMPONENT_CLASS_CONDITION_REFERENCE_BASE,
          public CONDITION_DATA
{
public:
    enum IMPORT_POPUP_IDS
    {
        ID_IMPORT_REFS = wxID_HIGHEST + 1
    };
 
    explicit PANEL_COMPONENT_CLASS_CONDITION_REFERENCE( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
    void OnImportRefsClick( wxCommandEvent& event ) override;
    void SetSelectionRefs( const std::vector<wxString>& aRefs ) { m_selectionRefs = aRefs; }
 
protected:
    void onMenu( wxCommandEvent& aEvent );
 
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
    std::vector<wxString>             m_selectionRefs;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT
        : public PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT_BASE,
          public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT( wxWindow* aParent, DIALOG_SHIM* aDlg );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
    void OnShowLibraryClick( wxCommandEvent& event ) override;
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
    DIALOG_SHIM* m_dlg;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_SIDE
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_SIDE : public PANEL_COMPONENT_CLASS_CONDITION_SIDE_BASE,
                                             public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_SIDE( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_ROTATION
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_ROTATION
        : public PANEL_COMPONENT_CLASS_CONDITION_ROTATION_BASE,
          public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_ROTATION( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_FIELD
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_FIELD : public PANEL_COMPONENT_CLASS_CONDITION_FIELD_BASE,
                                              public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_FIELD( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
    void SetFieldsList( const std::vector<wxString>& aFields );
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_CONDITION_CUSTOM
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_CUSTOM : public PANEL_COMPONENT_CLASS_CONDITION_CUSTOM_BASE,
                                               public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_CUSTOM( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
};
 
 
/**************************************************************************************************
 *
 * PANEL_COMPONENT_CLASS_SHEET
 *
 *************************************************************************************************/

class PANEL_COMPONENT_CLASS_CONDITION_SHEET : public PANEL_COMPONENT_CLASS_CONDITION_SHEET_BASE,
                                              public CONDITION_DATA
{
public:
    explicit PANEL_COMPONENT_CLASS_CONDITION_SHEET( wxWindow* aParent );
 
    void OnDeleteConditionClick( wxCommandEvent& event ) override;
 
    void SetSheetsList( const std::vector<wxString>& aSheets );
 
protected:
    PANEL_COMPONENT_CLASS_ASSIGNMENT* m_panelParent;
};
 
#endif //PANEL_ASSIGN_COMPONENT_CLASSES_H