symbol_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 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 SYMBOL_EDITOR_TAB_CONTEXT_H
#define SYMBOL_EDITOR_TAB_CONTEXT_H
 
#include <wx/string.h>
#include <wx/translation.h>
 
#include <kiid.h>
#include <widgets/editor_tab_context.h>
 
class LIB_SYMBOL;
class SCH_SCREEN;
class SYMBOL_BUFFER;
 

class SYMBOL_EDITOR_TAB_CONTEXT : public EDITOR_TAB_CONTEXT
{
public:
    enum class KIND
    {
        LIBRARY,            
        SCHEMATIC_INSTANCE, 
        UNSAVED             
    };
 

    SYMBOL_EDITOR_TAB_CONTEXT( const wxString& aLib, const wxString& aName, SYMBOL_BUFFER* aBuffer );

    SYMBOL_EDITOR_TAB_CONTEXT( LIB_SYMBOL* aSymbol, SCH_SCREEN* aScreen );

    SYMBOL_EDITOR_TAB_CONTEXT( LIB_SYMBOL* aSymbol, SCH_SCREEN* aScreen,
                               const KIID& aSchematicSymbolUUID, const wxString& aReference );
 
    ~SYMBOL_EDITOR_TAB_CONTEXT() override;

    static wxString MakeTabKey( const wxString& aLib, const wxString& aName )
    {
        return aLib + wxT( ":" ) + aName;
    }

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

    static wxString MakeUnsavedTabKey( const KIID& aSessionId )
    {
        return wxString( wxT( "\x01@unsaved:" ) ) + aSessionId.AsString();
    }
 
    wxString GetTabKey() const override
    {
        switch( m_kind )
        {
        case KIND::SCHEMATIC_INSTANCE: return MakeInstanceTabKey( m_schematicSymbolUUID );
        case KIND::UNSAVED:            return MakeUnsavedTabKey( m_sessionId );
        default:                       return MakeTabKey( m_lib, m_name );
        }
    }
 
    wxString GetDisplayName( bool aShortForm = false ) const override
    {
        switch( m_kind )
        {
        case KIND::SCHEMATIC_INSTANCE:
            if( aShortForm )
                return m_reference;
            else
                return m_reference + wxS( " " ) + _( "[from schematic]" );
 
        case KIND::UNSAVED:
            return _( "<unnamed>" );
 
        default:
            return m_name;
        }
    }

    bool IsTransient() const { return m_kind != KIND::LIBRARY; }
 
    bool        IsFromSchematic() const          { return m_kind == KIND::SCHEMATIC_INSTANCE; }
    bool        IsUnsaved() const                { return m_kind == KIND::UNSAVED; }
    const KIID& GetSchematicSymbolUUID() const   { return m_schematicSymbolUUID; }
    const wxString& GetReference() const         { return m_reference; }

    bool     IsModified() const override;
 
    const wxString& GetLibrary() const { return m_lib; }
    const wxString& GetName() const    { return m_name; }
    void            SetName( const wxString& aName ) { m_name = aName; }

    void PromoteToLibrary( const wxString& aLib, const wxString& aName );

    LIB_SYMBOL* GetSymbol() const { return m_symbol; }
    SCH_SCREEN* GetScreen() const { return m_screen; }

    void ReleaseToFrame() { m_frameOwns = true; }

    void AdoptWorkingObjects( LIB_SYMBOL* aSymbol, SCH_SCREEN* aScreen )
    {
        m_symbol = aSymbol;
        m_screen = aScreen;
        m_frameOwns = false;
    }

    void RefreshFrameOwnedObjects( LIB_SYMBOL* aSymbol, SCH_SCREEN* aScreen )
    {
        m_symbol = aSymbol;
        m_screen = aScreen;
    }
 
    int  GetUnit() const      { return m_unit; }
    void SetUnit( int aUnit ) { m_unit = aUnit; }
 
    int  GetBodyStyle() const           { return m_bodyStyle; }
    void SetBodyStyle( int aBodyStyle ) { m_bodyStyle = aBodyStyle; }
 
private:
    wxString    m_lib;
    wxString    m_name;
    LIB_SYMBOL* m_symbol;     
    SCH_SCREEN* m_screen;     
    bool        m_frameOwns;  
    int         m_unit;
    int         m_bodyStyle;
 
    KIND        m_kind = KIND::LIBRARY;

    KIID        m_schematicSymbolUUID;

    wxString    m_reference;

    KIID        m_sessionId;
};
 
#endif // SYMBOL_EDITOR_TAB_CONTEXT_H