sch_tool_utils.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/>.
 */
 
#pragma once
 
#include <optional>
#include <set>
 
#include <sch_item.h>
#include <tool/selection.h>
 
class SCHEMATIC;
class SCH_REFERENCE;
class SCH_REFERENCE_LIST;
class SCH_SCREEN;
class SCH_SHEET;
class SCH_HIERLABEL;
class SCH_SYMBOL;
class SCH_PIN;
class SCHEMATIC;
class LIB_ID;
 
wxString GetSchItemAsText( const SCH_ITEM& aItem );
 
wxString GetSelectedItemsAsText( const SELECTION& aSel );

std::vector<SCH_ITEM*> FlattenGroups( const EDA_ITEMS& aItems );
std::vector<SCH_ITEM*> FlattenGroups( const std::deque<EDA_ITEM*>& aItems );

std::set<int> GetUnplacedUnitsForSymbol( const SCH_SYMBOL& aSym );

bool IsUnannotatedUnitOccupied( const SCH_REFERENCE_LIST& aRefs, const wxString& aRef,
                                const LIB_ID& aLibId, int aUnit );

std::optional<SCH_REFERENCE> FindSymbolByRefAndUnit( const SCHEMATIC& aSheet, const wxString& aRef,
                                                     int aUnit );

std::vector<SCH_SYMBOL*> GetSameSymbolMultiUnitSelection( const SELECTION& aSel );

bool SwapPinGeometry( SCH_PIN* aFirst, SCH_PIN* aSecond );

bool SymbolHasSheetInstances( const SCH_SYMBOL& aSymbol, const wxString& aCurrentProject,
                              std::set<wxString>* aSheetPaths = nullptr, std::set<wxString>* aProjectNames = nullptr );

std::set<wxString> GetSheetNamesFromPaths( const std::set<wxString>& aSheetPaths, const SCHEMATIC& aSchematic );

wxString UniqueSheetName( SCH_SCREEN* aScreen, const wxString& aBaseName );

std::vector<SCH_HIERLABEL*> GetUnplacedSheetPinLabels( const SCH_SHEET& aSheet );

void AutoPlaceSheetPins( SCH_SHEET* aSheet, const std::vector<SCH_HIERLABEL*>& aLabels );

wxString UniqueGroupName( SCH_SCREEN* aScreen, const wxString& aBaseName );

void PrunePastedSymbolInstances( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSchematic );