sch_connection.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 CERN
 * @author Jon Evans <jon@craftyjon.com>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

#ifndef _SCH_CONNECTION_H
#define _SCH_CONNECTION_H

#include <memory>
#include <unordered_set>

#include <boost/optional.hpp>
#include <wx/regex.h>

#include <bus_alias.h>
#include <widgets/msgpanel.h>
#include <sch_sheet_path.h>


class CONNECTION_GRAPH;
class SCH_ITEM;
class SCH_SHEET_PATH;


enum class CONNECTION_TYPE
{
    NONE,      
    NET,       
    BUS,       
    BUS_GROUP, 
};

class SCH_CONNECTION
{
public:
    SCH_CONNECTION( SCH_ITEM* aParent = nullptr, SCH_SHEET_PATH aPath = SCH_SHEET_PATH() );

    SCH_CONNECTION( CONNECTION_GRAPH* aGraph );

    ~SCH_CONNECTION()
    {}

    bool operator==( const SCH_CONNECTION& aOther ) const;

    bool operator!=( const SCH_CONNECTION& aOther ) const;

    void SetGraph( CONNECTION_GRAPH* aGraph )
    {
        m_graph = aGraph;
    }

    void ConfigureFromLabel( const wxString& aLabel );

    void Reset();

    void Clone( SCH_CONNECTION& aOther );

    SCH_ITEM* Parent() const { return m_parent; }

    SCH_ITEM* Driver() const { return m_driver; }
    void SetDriver( SCH_ITEM* aItem );

    SCH_SHEET_PATH Sheet() const { return m_sheet; }
    void SetSheet( SCH_SHEET_PATH aSheet );

    bool IsDriver() const;

    bool IsBus() const
    {
        return ( m_type == CONNECTION_TYPE::BUS || m_type == CONNECTION_TYPE::BUS_GROUP );
    }

    bool IsNet() const
    {
        return ( m_type == CONNECTION_TYPE::NET );
    }

    bool IsUnconnected() const { return ( m_type == CONNECTION_TYPE::NONE ); }

    bool IsDirty() const { return m_dirty; }
    void SetDirty() { m_dirty = true; }
    void ClearDirty() { m_dirty = false; }

    bool HasDriverChanged() const;
    void ClearDriverChanged();
    void* GetLastDriver() const { return m_lastDriver; }

    wxString Name( bool aIgnoreSheet = false ) const;

    wxString LocalName() const { return m_local_name; }

    wxString FullLocalName() const
    {
        return m_prefix + m_local_name + m_suffix;
    }

    void SetName( const wxString& aName )
    {
        m_name = aName;
        recacheName();
    }

    wxString Prefix() const { return m_prefix; }
    void SetPrefix( const wxString& aPrefix );

    wxString BusPrefix() const { return m_bus_prefix; }

    wxString Suffix() const { return m_suffix; }
    void SetSuffix( const wxString& aSuffix );

    CONNECTION_TYPE Type() const { return m_type; }

    void SetType( CONNECTION_TYPE aType )
    {
        m_type = aType;
        recacheName();
    }

    int NetCode() const { return m_net_code; }
    void SetNetCode( int aCode ) { m_net_code = aCode; }

    int BusCode() const { return m_bus_code; }
    void SetBusCode( int aCode ) { m_bus_code = aCode; }

    int SubgraphCode() const { return m_subgraph_code; }
    void SetSubgraphCode( int aCode ) { m_subgraph_code = aCode; }

    long VectorStart() const { return m_vector_start; }
    long VectorEnd() const { return m_vector_end; }

    long VectorIndex() const { return m_vector_index; }

    wxString VectorPrefix() const { return m_vector_prefix; }

    std::vector< std::shared_ptr< SCH_CONNECTION > >& Members()
    {
        return m_members;
    }

    const std::vector< std::shared_ptr< SCH_CONNECTION > >& Members() const
    {
        return m_members;
    }

    const std::vector< std::shared_ptr< SCH_CONNECTION > > AllMembers() const;

    static wxString PrintBusForUI( const wxString& aString );

    bool IsSubsetOf( SCH_CONNECTION* aOther ) const;

    bool IsMemberOfBus( SCH_CONNECTION* aOther ) const;

    void AppendInfoToMsgPanel( MSG_PANEL_ITEMS& aList ) const;

    static bool IsBusLabel( const wxString& aLabel );

    static bool MightBeBusLabel( const wxString& aLabel );

private:
    void recacheName();

    bool m_dirty;

    SCH_SHEET_PATH m_sheet; 

    SCH_ITEM* m_parent;     

    void*     m_lastDriver; 

    SCH_ITEM* m_driver;     

    CONNECTION_TYPE m_type; 

    wxString m_name;        

    wxString m_cached_name; 

    wxString m_cached_name_with_path; 

    wxString m_local_name;

    wxString m_prefix;

    wxString m_bus_prefix;

    wxString m_suffix;      

    int m_net_code;         // TODO(JE) remove if unused

    int m_bus_code;         // TODO(JE) remove if unused

    int m_subgraph_code;    

    long m_vector_index;    

    long m_vector_start;    

    long m_vector_end;      

    wxString m_vector_prefix;

    std::vector< std::shared_ptr< SCH_CONNECTION > > m_members;

    CONNECTION_GRAPH* m_graph;

};

#endif