sch_screen.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009 Jean-Pierre Charras, [email protected]
 * 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 SCREEN_H
#define SCREEN_H
 
#include <cstdint>
#include <memory>
#include <optional>
#include <stddef.h>
#include <unordered_map>
#include <unordered_set>
#include <vector>
#include <wx/arrstr.h>
#include <wx/chartype.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
 
#include <base_screen.h>
#include <core/typeinfo.h>
#include <kiid.h>
#include <kiway_holder.h>
#include <layer_ids.h>
#include <marker_base.h>
#include <page_info.h>
#include <template_fieldnames.h>
#include <title_block.h>
 
#include <lib_id.h>
#include <sch_reference_list.h>
#include <sch_rtree.h>
#include <sch_sheet.h>
#include <sch_label.h>
#include <sch_sheet_path.h>     // SCH_SYMBOL_INSTANCE
 
class BUS_ALIAS;
class EDA_ITEM;
class LIB_SYMBOL;
class LEGACY_SYMBOL_LIBS;
class SYMBOL_LIBRARY_ADAPTER;
class SCH_COMMIT;
class SCH_PIN;
class SCH_SYMBOL;
class SCH_LINE;
class SCH_LABEL_BASE;
class PLOTTER;
class REPORTER;
class SCH_IO_ALTIUM;
class SCH_IO_PADS;
class SCH_EDIT_FRAME;
class SCH_SHEET_LIST;
class SCH_IO_KICAD_SEXPR_PARSER;
class SCH_IO_KICAD_SEXPR;
class SCHEMATIC;
class TEST_SCH_SCREEN_FIXTURE;
 
enum SCH_LINE_TEST_T
{
    ENTIRE_LENGTH_T,
    END_POINTS_ONLY_T,
    EXCLUDE_END_POINTS_T
};
 
 
struct PICKED_SYMBOL
{
    LIB_ID LibId;
    int    Unit;
    int    BodyStyle;
 
    bool   KeepSymbol;
    bool   PlaceAllUnits;
 
    std::vector<std::pair<FIELD_T, wxString>> Fields;
 
    PICKED_SYMBOL() :
            Unit( 1 ),
            BodyStyle( 1 ),
            KeepSymbol( false ),
            PlaceAllUnits( false )
    {
    }
};
 
class SCH_SCREEN : public BASE_SCREEN
{
public:
    SCH_SCREEN( EDA_ITEM* aParent = nullptr );
    SCH_SCREEN( const SCH_SCREEN& ) = delete;
 
    ~SCH_SCREEN();
 
    SCHEMATIC* Schematic() const;

    EE_RTREE& Items() { return m_rtree; }
    const EE_RTREE& Items() const { return m_rtree; }
 
    bool IsEmpty() const
    {
        return m_rtree.empty();
    }
 
    bool HasItems( KICAD_T aItemType ) const;
 
    bool HasSheets() const { return HasItems( SCH_SHEET_T ); }
 
    static bool ClassOf( const EDA_ITEM* aItem );
 
    virtual wxString GetClass() const override
    {
        return wxT( "SCH_SCREEN" );
    }
 
    void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
    int GetFileFormatVersionAtLoad()  const { return m_fileFormatVersionAtLoad; }
 
    const PAGE_INFO& GetPageSettings() const                { return m_paper; }
    void SetPageSettings( const PAGE_INFO& aPageSettings )  { m_paper = aPageSettings; }

    void SetFileName( const wxString& aFileName );
 
    const wxString& GetFileName() const                     { return m_fileName; }
 
    void SetFileReadOnly( bool aIsReadOnly )                { m_isReadOnly = aIsReadOnly; }
    bool IsReadOnly() const                                 { return m_isReadOnly; }
 
    void SetFileExists( bool aFileExists )                  { m_fileExists = aFileExists; }
    bool FileExists() const                                 { return m_fileExists; }
 
    const VECTOR2I& GetAuxOrigin() const                    { return m_aux_origin; }
    void SetAuxOrigin( const VECTOR2I& aPosition )          { m_aux_origin = aPosition; }
 
    TITLE_BLOCK& GetTitleBlock()                            { return m_titles; }
    const TITLE_BLOCK& GetTitleBlock() const                { return m_titles; }
 
    void SetTitleBlock( const TITLE_BLOCK& aTitleBlock )    { m_titles = aTitleBlock; }
 
    void DecRefCount();
    void IncRefCount();
    int GetRefCount() const                                 { return m_refCount; }

    uint64_t ConnectivityRevision() const { return m_connectivityRevision; }

    uint64_t ConnectivitySymbolRevision() const { return m_connectivitySymbolRevision; }

    void BumpConnectivityRevision( KICAD_T aChangedType = TYPE_NOT_INIT );

    static bool IsConnectivitySource( const SCH_ITEM* aItem );

    uint64_t ConnectivityId() const { return m_connectivityId; }
 
    struct CONNECTIVITY_SOURCE
    {
        SCH_SCREEN* screen = nullptr;
    };
 
    std::weak_ptr<const CONNECTIVITY_SOURCE> ConnectivitySource() const { return m_connectivitySource; }

    SCH_ITEM* GetConnectivityItem( const KIID& aId ) const;

    std::vector<SCH_SHEET_PATH>& GetClientSheetPaths()
    {
        return m_clientSheetPathList;
    }
 
    void Append( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );

    void Append( SCH_SCREEN* aScreen );

    void Clear( bool aFree = true );

    void FreeDrawList();

    SCH_ITEM* GetItem( const VECTOR2I& aPosition, int aAccuracy = 0,
                       KICAD_T aType = SCH_LOCATE_ANY_T ) const;

    void UpdateSymbolLinks( REPORTER* aReporter = nullptr, LEGACY_SYMBOL_LIBS* aLegacyLibs = nullptr,
                            SYMBOL_LIBRARY_ADAPTER* aLibraries = nullptr );

    void UpdateLocalLibSymbolLinks();

    void Plot( PLOTTER* aPlotter, const SCH_PLOT_OPTS& aPlotOpts ) const;

    void Plot( PLOTTER* aPlotter, const SCH_PLOT_OPTS& aPlotOpts,
               const std::vector<SCH_ITEM*>& aItems ) const;

    bool Remove( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );

    void Update( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );

    void UpdateDisplayBounds( SCH_ITEM* aItem );

    bool PruneUnusedLibSymbol( const wxString& aName );

    void DeleteItem( SCH_ITEM* aItem );
 
    bool CheckIfOnDrawList( const SCH_ITEM* aItem ) const;

    void TestDanglingEnds( const SCH_SHEET_PATH* aPath = nullptr,
                           std::function<void( SCH_ITEM* )>* aChangedHandler = nullptr ) const;

    std::set<SCH_ITEM*> MarkConnections( SCH_ITEM* aItem, bool aSecondPass );

    void ClearDrawingState();
 
    size_t CountConnectedItems( const VECTOR2I& aPos, bool aTestJunctions ) const;

    bool IsJunction( const VECTOR2I& aPosition ) const;

    bool IsExplicitJunction( const VECTOR2I& aPosition ) const;

    bool IsExplicitJunctionNeeded( const VECTOR2I& aPosition ) const;
 
    SPIN_STYLE GetLabelOrientationForPoint( const VECTOR2I&       aPosition,
                                            SPIN_STYLE            aDefaultOrientation,
                                            const SCH_SHEET_PATH* aSheet ) const;
    bool IsExplicitJunctionAllowed( const VECTOR2I& aPosition ) const;

    bool IsTerminalPoint( const VECTOR2I& aPosition, int aLayer ) const;

    SCH_PIN* GetPin( const VECTOR2I& aPosition, SCH_SYMBOL** aSymbol = nullptr,
                     bool aEndPointOnly = false ) const;

    SCH_SHEET_PIN* GetSheetPin( const VECTOR2I& aPosition ) const;

    void ClearAnnotation( SCH_SHEET_PATH* aSheetPath, bool aResetPrefix );

    void EnsureAlternateReferencesExist();

    void GetHierarchicalItems( std::vector<SCH_ITEM*>* aItems ) const;

    void GetSheets( std::vector<SCH_ITEM*>* aItems ) const;

    SCH_LINE* GetLine( const VECTOR2I& aPosition, int aAccuracy = 0, int aLayer = LAYER_NOTES,
                       SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const;
 
    SCH_LINE* GetWire( const VECTOR2I& aPosition, int aAccuracy = 0,
                       SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
    {
        return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
    }
 
    SCH_LINE* GetBus( const VECTOR2I& aPosition, int aAccuracy = 0,
                      SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
    {
        return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
    }

    std::vector<SCH_LINE*> GetBusesAndWires( const VECTOR2I& aPosition,
                                             bool aIgnoreEndpoints = false ) const;

    std::vector<VECTOR2I> GetConnections() const;

    std::vector<VECTOR2I> GetNeededJunctions( const std::deque<EDA_ITEM*>& aItems ) const;

    SCH_LABEL_BASE* GetLabel( const VECTOR2I& aPosition, int aAccuracy = 0 ) const;

    const std::map<wxString, LIB_SYMBOL*>& GetLibSymbols() const { return m_libSymbols; }

    void AddLibSymbol( LIB_SYMBOL* aLibSymbol );
 
    void AddLibSymbol( const wxString& aKey, std::unique_ptr<LIB_SYMBOL> aLibSymbol );

    void FixupEmbeddedData();

    void AddBusAlias( std::shared_ptr<BUS_ALIAS> aAlias );
 
    const std::vector<SCH_SYMBOL_INSTANCE>& GetSymbolInstances() const
    {
        return m_symbolInstances;
    }
 
    const std::vector<SCH_SHEET_INSTANCE>& GetSheetInstances() const
    {
        return m_sheetInstances;
    }
 
    const KIID& GetUuid() const { return m_uuid; }
 
    void AssignNewUuid() { m_uuid = KIID(); }

    void SetLegacySymbolInstanceData();

    void FixLegacyPowerSymbolMismatches();

    bool AllSymbolDefaultInstancesNotSet();
 
    bool HasSymbolFieldNamesWithWhiteSpace() const;

    bool InProjectPath() const;
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override;
#endif

    void MigrateSimModels();

    void PruneOrphanedSymbolInstances( const wxString& aProjectName,
                                       const SCH_SHEET_LIST& aValidSheetPaths );

    void PruneOrphanedSheetInstances( const wxString& aProjectName,
                                      const SCH_SHEET_LIST& aValidSheetPaths );

    std::set<wxString> GetSheetNames() const;

    bool HasInstanceDataFromOtherProjects() const;

    wxString GroupsSanityCheck( bool repair = false );

    wxString GroupsSanityCheckInternal( bool repair );
 
    std::set<wxString> GetVariantNames() const;
 
    void DeleteVariant( const wxString& aVariantName, SCH_COMMIT* aCommit = nullptr );
 
    void RenameVariant( const wxString& aOldName, const wxString& aNewName,
                        SCH_COMMIT* aCommit = nullptr );
 
    void CopyVariant( const wxString& aSourceVariant, const wxString& aNewVariant,
                      SCH_COMMIT* aCommit = nullptr );
 
private:
    friend SCH_EDIT_FRAME;     // Only to populate m_symbolInstances.
    friend SCH_IO_KICAD_SEXPR_PARSER;   // Only to load instance information from schematic file.
    friend SCH_IO_KICAD_SEXPR;   // Only to save the loaded instance information to schematic file.
    friend SCH_IO_ALTIUM;
    friend SCH_IO_PADS;
    friend SCHEMATIC;          // Only to adopt staged content, see SCHEMATIC::AdoptContent().
    friend TEST_SCH_SCREEN_FIXTURE;
 
    bool doIsJunction( const VECTOR2I& aPosition, bool aBreakCrossings,
                       bool* aHasExplicitJunctionDot, bool* aHasBusEntry ) const;
 
    void clearLibSymbols();

    size_t getLibSymbolNameMatches( const SCH_SYMBOL& aSymbol, std::vector<wxString>& aMatches );
 
public:
    bool IsZoomInitialized() const { return m_zoomInitialized; }

    double m_LastZoomLevel;
 
private:
    const uint64_t                                             m_connectivityId;
    std::shared_ptr<CONNECTIVITY_SOURCE>                       m_connectivitySource;
    uint64_t                                                   m_connectivityRevision = 1;
    uint64_t                                                   m_connectivitySymbolRevision = 1;
    mutable std::optional<std::unordered_map<KIID, SCH_ITEM*>> m_connectivityItems;
 
    wxString    m_fileName;                 // File used to load the screen.
    int         m_fileFormatVersionAtLoad;
    int         m_refCount;                 // Number of sheets referencing this screen.
                                            // Delete when it goes to zero.
    std::vector<SCH_SHEET_PATH> m_clientSheetPathList;
 
 
    PAGE_INFO   m_paper;                    // The size of the paper to print or plot on.
    TITLE_BLOCK m_titles;
    VECTOR2I    m_aux_origin;               // Origin used for drill & place files by Pcbnew.
    EE_RTREE    m_rtree;
 
    int         m_modification_sync;        // Inequality with SYMBOL_LIBS::GetModificationHash()
                                            // will trigger ResolveAll().
 
    bool        m_zoomInitialized;          // Set to true once the zoom value is initialized with
                                            // `InitZoom()`.
 
    bool        m_isReadOnly;               

    bool        m_fileExists;

    std::map<wxString, LIB_SYMBOL*> m_libSymbols;

    std::vector<SCH_SYMBOL_INSTANCE> m_symbolInstances;
    std::vector<SCH_SHEET_INSTANCE> m_sheetInstances;

    KIID m_uuid;
};
 

class SCH_SCREENS
{
public:
    SCH_SCREENS( SCH_SHEET* aSheet );
    SCH_SCREENS( SCH_SHEET& aSheet ) : SCH_SCREENS( &aSheet ) {}
    ~SCH_SCREENS();
    size_t GetCount() const { return m_screens.size(); }
    SCH_SCREEN* GetFirst();
    SCH_SCREEN* GetNext();
    SCH_SCREEN* GetScreen( unsigned int aIndex ) const;
    SCH_SHEET* GetSheet( unsigned int aIndex ) const;

    void ClearAnnotationOfNewSheetPaths( SCH_SHEET_LIST& aInitialSheetPathList );

    int ReplaceDuplicateTimeStamps();

    void DeleteAllMarkers( enum MARKER_BASE::MARKER_T aMarkerType, bool aIncludeExclusions );

    void DeleteMarkers( enum MARKER_BASE::MARKER_T aMarkerTyp, int aErrorCode,
                        bool aIncludeExclusions = true );

    void DeleteMarker( SCH_MARKER* aMarker );

    void UpdateSymbolLinks( REPORTER* aReporter = nullptr );
 
    void ClearEditFlags();

    bool HasNoFullyDefinedLibIds();

    size_t GetLibNicknames( wxArrayString& aLibNicknames );

    int ChangeSymbolLibNickname( const wxString& aFrom, const wxString& aTo );

    bool HasSchematic( const wxString& aSchematicFileName );

    void BuildClientSheetPathList();

    void SetLegacySymbolInstanceData();

    void FixLegacyPowerSymbolMismatches();
 
    void PruneOrphanedSymbolInstances( const wxString& aProjectName,
                                       const SCH_SHEET_LIST& aValidSheetPaths );
 
    void PruneOrphanedSheetInstances( const wxString& aProjectName,
                                      const SCH_SHEET_LIST& aValidSheetPaths );
 
    bool HasSymbolFieldNamesWithWhiteSpace() const;
 
    std::set<wxString> GetVariantNames() const;
 
    void DeleteVariant( const wxString& aVariantName, SCH_COMMIT* aCommit = nullptr );
 
    void RenameVariant( const wxString& aOldName, const wxString& aNewName,
                        SCH_COMMIT* aCommit = nullptr );
 
    void CopyVariant( const wxString& aSourceVariant, const wxString& aNewVariant,
                      SCH_COMMIT* aCommit = nullptr );
 
private:
    void addScreenToList( SCH_SCREEN* aScreen, SCH_SHEET* aSheet );
    void buildScreenList( SCH_SHEET* aSheet);
 
    std::vector< SCH_SCREEN* > m_screens;
    std::vector< SCH_SHEET* >  m_sheets;
    unsigned int               m_index;
};
 
#endif /* SCREEN_H */