footprint_editor_tab_context.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 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef FOOTPRINT_EDITOR_TAB_CONTEXT_H
#define FOOTPRINT_EDITOR_TAB_CONTEXT_H
 
#include <map>
#include <memory>
 
#include <wx/string.h>
 
#include <kiid.h>
#include <widgets/editor_tab_context.h>
 
class BOARD;
class FOOTPRINT;
 

class FOOTPRINT_EDITOR_TAB_CONTEXT : public EDITOR_TAB_CONTEXT
{
public:
    enum class KIND
    {
        LIBRARY,        
        BOARD_INSTANCE, 
        UNSAVED         
    };
 
    FOOTPRINT_EDITOR_TAB_CONTEXT( const wxString& aLibNickname, const wxString& aFootprintName,
                                  std::unique_ptr<BOARD> aBoard );

    FOOTPRINT_EDITOR_TAB_CONTEXT( const KIID& aSourceUuid, const wxString& aReference,
                                  std::unique_ptr<BOARD> aBoard );
 
    ~FOOTPRINT_EDITOR_TAB_CONTEXT() override;

    static std::unique_ptr<FOOTPRINT_EDITOR_TAB_CONTEXT> MakeUnsaved( std::unique_ptr<BOARD> aBoard );

    static wxString MakeInstanceTabKey( const KIID& aSourceUuid )
    {
        return wxString( wxT( "\x01@fp:" ) ) + aSourceUuid.AsString();
    }

    static wxString MakeUnsavedTabKey( const KIID& aSessionId )
    {
        return wxString( wxT( "\x01@import:" ) ) + aSessionId.AsString();
    }
 
    wxString GetTabKey() const override
    {
        switch( m_kind )
        {
        case KIND::BOARD_INSTANCE: return MakeInstanceTabKey( m_sourceUuid );
        case KIND::UNSAVED:        return MakeUnsavedTabKey( m_sessionId );
        default:                   return m_libNickname + wxT( ":" ) + m_footprintName;
        }
    }
 
    wxString GetDisplayName( bool aShortForm = false ) const override;

    void PromoteToLibrary( const wxString& aLibNickname, const wxString& aFootprintName );

    bool IsTransient() const { return m_kind != KIND::LIBRARY; }
 
    bool        IsFromBoard() const            { return m_kind == KIND::BOARD_INSTANCE; }
    bool        IsUnsaved() const              { return m_kind == KIND::UNSAVED; }
    const KIID& GetSourceUuid() const          { return m_sourceUuid; }
    const wxString& GetReference() const       { return m_reference; }

    std::map<KIID, KIID>& BoardFootprintUuids() { return m_boardFootprintUuids; }

    bool IsModified() const override;
 
    void SetModified( bool aModified ) { m_modified = aModified; }

    BOARD* GetBoard() const { return m_board.get(); }
 
    const wxString& GetLibNickname() const  { return m_libNickname; }
    void SetLibNickname( const wxString& aNickname ) { m_libNickname = aNickname; }
 
    const wxString& GetFootprintName() const { return m_footprintName; }
    void SetFootprintName( const wxString& aFootprintName ) { m_footprintName = aFootprintName; }

    FOOTPRINT* GetOriginalFootprintCopy() const { return m_originalFootprintCopy.get(); }
    void       SetOriginalFootprintCopy( std::unique_ptr<FOOTPRINT> aCopy );
 
    const wxString& GetFootprintNameWhenLoaded() const { return m_footprintNameWhenLoaded; }
    void SetFootprintNameWhenLoaded( const wxString& aName ) { m_footprintNameWhenLoaded = aName; }
 
private:
    FOOTPRINT_EDITOR_TAB_CONTEXT( KIND aKind, std::unique_ptr<BOARD> aBoard );
 
    wxString                   m_libNickname;
    wxString                   m_footprintName;
    std::unique_ptr<BOARD>     m_board;
    std::unique_ptr<FOOTPRINT> m_originalFootprintCopy;
    wxString                   m_footprintNameWhenLoaded;
    bool                       m_modified = false;
 
    KIND                       m_kind = KIND::LIBRARY;

    KIID                       m_sourceUuid;

    KIID                       m_sessionId;

    wxString                   m_reference;

    std::map<KIID, KIID>       m_boardFootprintUuids;
};
 
#endif // FOOTPRINT_EDITOR_TAB_CONTEXT_H