sch_sheet_path.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2011 Wayne Stambaugh <[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 CLASS_DRAWSHEET_PATH_H
#define CLASS_DRAWSHEET_PATH_H
 
#include <map>
#include <memory>
#include <optional>
 
#include <kiid.h>
#include <lib_id.h>
#include <pin_map.h>
#include <wx/string.h>
 
class SCH_SYMBOL;
class SCH_SHEET;
 
enum SYMBOL_FILTER
{
    SYMBOL_FILTER_NON_POWER,
    SYMBOL_FILTER_POWER,
    SYMBOL_FILTER_ALL
};

class VARIANT
{
public:
    VARIANT( const wxString& aName = wxEmptyString ) :
        m_Name( aName ),
        m_ExcludedFromSim( false ),
        m_ExcludedFromBOM( false ),
        m_ExcludedFromBoard( false ),
        m_ExcludedFromPosFiles( false ),
        m_DNP( false )
    {
    }
 
    virtual ~VARIANT() = default;
 
    wxString                     m_Name;
    wxString                     m_Description;
    bool                         m_ExcludedFromSim;
    bool                         m_ExcludedFromBOM;
    bool                         m_ExcludedFromBoard;
    bool                         m_ExcludedFromPosFiles;
    bool                         m_DNP;
    std::map<wxString, wxString> m_Fields;
};
 

class SCH_SYMBOL_VARIANT : public VARIANT
{
public:
    SCH_SYMBOL_VARIANT( const wxString& aName = wxEmptyString ) :
        VARIANT( aName )
    {}
 
    void InitializeAttributes( const SCH_SYMBOL& aSymbol );

    bool HasDifferentials( const SCH_SYMBOL& aSymbol ) const;
 
    virtual ~SCH_SYMBOL_VARIANT() = default;

    PIN_MAP_INSTANCE_OVERRIDE m_PinMapOverride;

    std::optional<LIB_ID> m_SymbolOverride;
};
 

struct SCH_SYMBOL_INSTANCE
{
    KIID_PATH m_Path;
 
    // Things that can be annotated:
    wxString  m_Reference;
    int       m_Unit = 1;
 
    // Do not use.  This is left over from the dubious decision to instantiate symbol value
    // and footprint fields.  This is now handle by variants.
    wxString  m_Value;
    wxString  m_Footprint;
 
    // The project name associated with this instance.
    wxString  m_ProjectName;
 
    bool m_DNP = false;
    bool m_ExcludedFromBOM = false;
    bool m_ExcludedFromSim = false;
    bool m_ExcludedFromBoard = false;
    bool m_ExcludedFromPosFiles = false;

    std::map<wxString, SCH_SYMBOL_VARIANT> m_Variants;
};
 

class SCH_SHEET_VARIANT : public VARIANT
{
public:
    SCH_SHEET_VARIANT( const wxString& aName = wxEmptyString ) :
        VARIANT( aName )
    {}
 
    virtual ~SCH_SHEET_VARIANT() = default;
 
    void InitializeAttributes( const SCH_SHEET& aSheet );

    bool HasDifferentials( const SCH_SHEET& aSheet ) const;
};
 

struct SCH_SHEET_INSTANCE
{
    KIID_PATH m_Path;
 
    wxString  m_PageNumber;
 
    // The project name associated with this instance.
    wxString  m_ProjectName;
 
    bool m_DNP = false;
    bool m_ExcludedFromBOM = false;
    bool m_ExcludedFromSim = false;
    bool m_ExcludedFromBoard = false;
    bool m_ExcludedFromPosFiles = false;

    std::map<wxString, SCH_SHEET_VARIANT> m_Variants;
};
 

 
 
class EDA_ITEM;
class SCH_SHEET;
class SCH_SCREEN;
class SCH_MARKER;
class SCH_ITEM;
class SCH_SYMBOL;
class SCH_REFERENCE_LIST;
 

typedef std::map<wxString, SCH_REFERENCE_LIST> SCH_MULTI_UNIT_REFERENCE_MAP;

class SCH_SHEET_PATH
{
public:
    SCH_SHEET_PATH();
 
    SCH_SHEET_PATH( const SCH_SHEET_PATH& aOther );
 
    SCH_SHEET_PATH& operator=( const SCH_SHEET_PATH& aOther );
 
    // Move assignment operator
    SCH_SHEET_PATH& operator=( SCH_SHEET_PATH&& aOther );
 
    SCH_SHEET_PATH operator+( const SCH_SHEET_PATH& aOther );
 
    ~SCH_SHEET_PATH() = default;

    SCH_SHEET* at( size_t aIndex ) const { return m_sheets.at( aIndex ); }

    void clear()
    {
        m_sheets.clear();
        Rehash();
    }

    bool empty() const { return m_sheets.empty(); }

    void pop_back()
    {
        m_sheets.pop_back();
        Rehash();
    }

    void push_back( SCH_SHEET* aSheet )
    {
        m_sheets.push_back( aSheet );
        Rehash();
    }

    size_t size() const { return m_sheets.size(); }
 
    std::vector<SCH_SHEET*>::iterator erase( std::vector<SCH_SHEET*>::const_iterator aPosition )
    {
        std::vector<SCH_SHEET*>::iterator ret = m_sheets.erase( aPosition );
 
        // Rehash to keep m_current_hash and the cached path consistent with the shortened list.
        Rehash();
 
        return ret;
    }
 
    void Rehash();
 
    size_t GetCurrentHash() const { return m_current_hash; }

    void SetVirtualPageNumber( int aPageNumber ) { m_virtualPageNumber = aPageNumber; }
 
    int GetVirtualPageNumber() const { return m_virtualPageNumber; }

    void SetPageNumber( const wxString& aPageNumber );
 
    wxString GetPageNumber() const;
 
    int GetPageNumberAsInt() const;
 
    const SCH_SHEET* GetSheet( unsigned aIndex ) const
    {
        SCH_SHEET* retv = nullptr;
 
        if( aIndex < size() )
            retv = at( aIndex );
 
        return retv;
    }

    int Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;
 
    void CachePageNumber() const { m_cached_page_number = GetPageNumber(); }
    wxString GetCachedPageNumber() const { return m_cached_page_number; }

    int ComparePageNum( const SCH_SHEET_PATH& aSheetPathToTest ) const;

    bool IsContainedWithin( const SCH_SHEET_PATH& aSheetPathToTest ) const;

    SCH_SHEET* Last() const;

    SCH_SCREEN* LastScreen();
 

    SCH_SCREEN* LastScreen() const;
 
    bool GetExcludedFromSim() const;
    bool GetExcludedFromSim( const wxString& aVariantName ) const;
    bool GetExcludedFromBOM() const;
    bool GetExcludedFromBOM( const wxString& aVariantName ) const;
    bool GetExcludedFromBoard() const;
    bool GetExcludedFromBoard( const wxString& aVariantName ) const;
    bool GetDNP() const;
    bool GetDNP( const wxString& aVariantName ) const;

    SCH_ITEM* ResolveItem( const KIID& aID ) const;

    wxString PathAsString() const;

    KIID_PATH Path() const;

    wxString PathHumanReadable( bool aUseShortRootName = true,
                                bool aStripTrailingSeparator = false,
                                bool aEscapeSheetNames = false ) const;

    void UpdateAllScreenReferences() const;

    void AppendSymbol( SCH_REFERENCE_LIST& aReferences, SCH_SYMBOL* aSymbol,
                       SYMBOL_FILTER aSymbolFilter, bool aForceIncludeOrphanSymbols = false ) const;

    void GetSymbols( SCH_REFERENCE_LIST& aReferences, SYMBOL_FILTER aSymbolFilter,
                     bool aForceIncludeOrphanSymbols = false ) const;

    void AppendMultiUnitSymbol( SCH_MULTI_UNIT_REFERENCE_MAP& aRefList, SCH_SYMBOL* aSymbol,
                                SYMBOL_FILTER aSymbolFilter ) const;

    void GetMultiUnitSymbols( SCH_MULTI_UNIT_REFERENCE_MAP& aRefList,
                              SYMBOL_FILTER                 aSymbolFilter ) const;

    bool TestForRecursion( const wxString& aSrcFileName, const wxString& aDestFileName );

    void MakeFilePathRelativeToParentSheet();

    void AddNewSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
                                const wxString& aProjectName );
 
    void RemoveSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath );
 
    void CheckForMissingSymbolInstances( const wxString& aProjectName );

    bool IsSharedPath() const;
 
    bool operator==( const SCH_SHEET_PATH& d1 ) const;
 
    bool operator!=( const SCH_SHEET_PATH& d1 ) const { return !( *this == d1 ) ; }
 
    bool operator<( const SCH_SHEET_PATH& d1 ) const { return m_sheets < d1.m_sheets; }
 
private:
    void initFromOther( const SCH_SHEET_PATH& aOther );
 
protected:
    std::vector<SCH_SHEET*> m_sheets;
 
    size_t                  m_current_hash;
    mutable wxString        m_cached_page_number;
    mutable bool            m_cached_path_valid = false;
    mutable KIID_PATH       m_cached_path;
 
    int m_virtualPageNumber;           
 
    std::map<std::pair<wxString, wxString>, bool> m_recursion_test_cache;
};
 
 
namespace std
{
    template<> struct hash<SCH_SHEET_PATH>
    {
        size_t operator()( const SCH_SHEET_PATH& path ) const;
    };
}
 
struct SHEET_PATH_HASH
{
    size_t operator()( const SCH_SHEET_PATH& path ) const
    {
        return path.GetCurrentHash();
    }
};
 
struct SHEET_PATH_CMP
{
    bool operator()( const SCH_SHEET_PATH& lhs, const SCH_SHEET_PATH& rhs ) const
    {
        return lhs.GetCurrentHash() < rhs.GetCurrentHash();
    }
};
 

class SCH_SHEET_LIST : public std::vector<SCH_SHEET_PATH>
{
public:
    SCH_SHEET_LIST( SCH_SHEET* aSheet = nullptr );
 
    ~SCH_SHEET_LIST() {}

    bool IsModified() const;
 
    void ClearModifyStatus();

    SCH_ITEM* ResolveItem( const KIID& aID, SCH_SHEET_PATH* aPathOut = nullptr,
                           bool aAllowNullptrReturn = false ) const;

    void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );

    void AnnotatePowerSymbols();

    void GetSymbols( SCH_REFERENCE_LIST& aReferences, SYMBOL_FILTER aSymbolFilter,
                     bool aForceIncludeOrphanSymbols = false ) const;

    void GetSymbolsWithinPath( SCH_REFERENCE_LIST& aReferences, const SCH_SHEET_PATH& aSheetPath,
                               SYMBOL_FILTER aSymbolFilter,
                               bool          aForceIncludeOrphanSymbols = false ) const;

    void GetSheetsWithinPath( std::vector<SCH_SHEET_PATH>& aSheets,
                              const SCH_SHEET_PATH& aSheetPath ) const;
 

    std::optional<SCH_SHEET_PATH> GetSheetPathByKIIDPath( const KIID_PATH& aPath,
                                                          bool aIncludeLastSheet = true ) const;
 

    void GetMultiUnitSymbols( SCH_MULTI_UNIT_REFERENCE_MAP& aRefList,
                              SYMBOL_FILTER                 aSymbolFilter ) const;

    bool TestForRecursion( const SCH_SHEET_LIST& aSrcSheetHierarchy,
                           const wxString& aDestFileName );

    SCH_SHEET_PATH* FindSheetForPath( const SCH_SHEET_PATH* aPath );

    SCH_SHEET_PATH FindSheetForScreen( const SCH_SCREEN* aScreen );

    SCH_SHEET_LIST FindAllSheetsForScreen( const SCH_SCREEN* aScreen ) const;

    void BuildSheetList( SCH_SHEET* aSheet, bool aCheckIntegrity );

    void SortByPageNumbers( bool aUpdateVirtualPageNums = true );

    void SortByHierarchicalPageNumbers( bool aUpdateVirtualPageNums = true );
 
    bool NameExists( const wxString& aSheetName ) const;
 
    bool PageNumberExists( const wxString& aPageNumber ) const;

    void TrimToPageNumbers( const std::vector<wxString>& aPageInclusions );

    wxString GetNextPageNumber() const;

    void UpdateSymbolInstanceData( const std::vector<SCH_SYMBOL_INSTANCE>& aSymbolInstances );

    void UpdateSheetInstanceData( const std::vector<SCH_SHEET_INSTANCE>& aSheetInstances );
 
    std::vector<KIID_PATH> GetPaths() const;

    std::vector<SCH_SHEET_INSTANCE> GetSheetInstances() const;

    bool AllSheetPageNumbersEmpty() const;

    void SetInitialPageNumbers();

    bool RepairPageNumbers();

    void AddNewSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
                                const wxString& aProjectName );
 
    void AddNewSheetInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
                               int aLastVirtualPageNumber );
 
    int GetLastVirtualPageNumber() const;
 
    void RemoveSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath );
 
    void CheckForMissingSymbolInstances( const wxString& aProjectName );
 
    bool HasPath( const KIID_PATH& aPath ) const;
 
    bool ContainsSheet( const SCH_SHEET* aSheet ) const;

    std::optional<SCH_SHEET_PATH> GetOrdinalPath( const SCH_SCREEN* aScreen ) const;
 
private:
    SCH_SHEET_PATH  m_currentSheetPath;
};
 
#endif // CLASS_DRAWSHEET_PATH_H