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 <stambaughw@gmail.com>
 * Copyright (C) 1992-2021 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef CLASS_DRAWSHEET_PATH_H
#define CLASS_DRAWSHEET_PATH_H

#include <map>

#include <kiid.h>

struct SYMBOL_INSTANCE_REFERENCE
{
    KIID_PATH m_Path;

    // Things that can be annotated:
    wxString  m_Reference;
    int       m_Unit;

    // Things that can be back-annotated:
    wxString  m_Value;
    wxString  m_Footprint;
};


struct SCH_SHEET_INSTANCE
{
    KIID_PATH m_Path;

    wxString  m_PageNumber;
};


class wxFindReplaceData;
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 );

    ~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(); }

    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;

    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;

    int ComparePageNumAndName( 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;

    wxString PathAsString() const;

    KIID_PATH Path() const;

    KIID_PATH PathWithoutRootUuid() const;

    wxString PathHumanReadable( bool aUseShortRootName = true ) const;

    void UpdateAllScreenReferences();

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

    void GetSymbols( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols = true,
                     bool aForceIncludeOrphanSymbols = false ) const;

    void AppendMultiUnitSymbol( SCH_MULTI_UNIT_REFERENCE_MAP& aRefList, SCH_SYMBOL* aSymbol,
                                bool aIncludePowerSymbols = true ) const;

    void GetMultiUnitSymbols( SCH_MULTI_UNIT_REFERENCE_MAP &aRefList,
                              bool aIncludePowerSymbols = true ) const;

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

    void MakeFilePathRelativeToParentSheet();

    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;

    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;
    };
}


typedef std::vector< SCH_SHEET_PATH >            SCH_SHEET_PATHS;
typedef SCH_SHEET_PATHS::iterator                SCH_SHEET_PATHS_ITER;


class SCH_SHEET_LIST : public SCH_SHEET_PATHS
{
public:
    SCH_SHEET_LIST( SCH_SHEET* aSheet = nullptr, bool aCheckIntegrity = false );

    ~SCH_SHEET_LIST() {}

    bool IsModified() const;

    void ClearModifyStatus();

    SCH_ITEM* GetItem( const KIID& aID, SCH_SHEET_PATH* aPathOut = nullptr ) const;

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

    void AnnotatePowerSymbols();

    void GetSymbols( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols = true,
                     bool aForceIncludeOrphanSymbols = false ) const;

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

    void GetSheetsWithinPath( SCH_SHEET_PATHS& aSheets, const SCH_SHEET_PATH& aSheetPath ) const;

    void GetMultiUnitSymbols( SCH_MULTI_UNIT_REFERENCE_MAP &aRefList,
                              bool aIncludePowerSymbols = true ) const;

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

    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 );

    bool NameExists( const wxString& aSheetName ) const;

    bool PageNumberExists( const wxString& aPageNumber ) const;

    void UpdateSymbolInstances( const std::vector<SYMBOL_INSTANCE_REFERENCE>& aSymbolInstances );

    void UpdateSheetInstances( 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();

private:
    SCH_SHEET_PATH  m_currentSheetPath;
};

#endif // CLASS_DRAWSHEET_PATH_H