44 const wxString& aSearchText )
52 if( !aSearchHierarchy )
71 found = ( *aPath ==
path );
75 found = ( aReference && aReference->CmpNoCase( candidate->
GetRef( &sheet ) ) == 0 );
81 sheetWithSymbolFound = &sheet;
90 int unit =
pin->GetLibPin()->GetUnit();
92 if( unit != 0 && unit != symbol->
GetUnit() )
146 displayRef = *aReference;
155 msg.Printf(
_(
"%s pin %s found" ), displayRef, aSearchText );
157 msg.Printf(
_(
"%s found but pin %s not found" ), displayRef, aSearchText );
161 msg.Printf(
_(
"%s found" ), displayRef );
166 msg.Printf(
_(
"%s not found" ), displayRef );
195 strncpy( line, cmdline,
sizeof( line ) - 1 );
196 line[
sizeof( line ) - 1 ] =
'\0';
198 char* idcmd = strtok( line,
" \n\r" );
199 char*
text = strtok(
nullptr,
"\"\n\r" );
201 if( idcmd ==
nullptr )
206 if( strcmp( idcmd,
"$CONFIG" ) == 0 )
211 else if( strcmp( idcmd,
"$ERC" ) == 0 )
216 else if( strcmp( idcmd,
"$NET:" ) == 0 )
223 if(
auto sg =
Schematic().ConnectionGraph()->FindFirstSubgraphByName( netName ) )
230 SetStatusText(
_(
"Selected net:" ) + wxS(
" " ) +
UnescapeString( netName ) );
233 else if( strcmp( idcmd,
"$CLEAR:" ) == 0 )
242 if(
text ==
nullptr )
245 if( strcmp( idcmd,
"$PART:" ) != 0 )
251 idcmd = strtok(
nullptr,
" \n\r" );
253 if( idcmd ==
nullptr )
260 text = strtok(
nullptr,
"\"\n\r" );
262 if(
text ==
nullptr )
267 if( strcmp( idcmd,
"$REF:" ) == 0 )
273 else if( strcmp( idcmd,
"$VAL:" ) == 0 )
279 else if( strcmp( idcmd,
"$PAD:" ) == 0 )
292 std::vector<wxString> parts;
296 switch( item->Type() )
313 parts.push_back( wxT(
"S" ) + full_path );
336 std::string command =
"$SELECT: 0,";
338 for( wxString part : parts )
367 if( !packet.empty() )
392 if( aConnection->
IsNet() )
398 if( aConnection->
Members().empty() )
403 wxString nets = all_members[0]->Name();
405 if( all_members.size() == 1 )
415 for(
size_t i = 1; i < all_members.size(); i++ )
416 nets <<
"," << all_members[i]->Name();
420 if( !packet.empty() )
437 std::string packet =
"$CLEAR\n";
455 std::unordered_map<wxString, std::vector<SCH_REFERENCE>>& aSyncSymMap,
456 std::unordered_map<wxString, std::unordered_map<wxString, SCH_PIN*>>& aSyncPinMap,
457 bool aRecursive =
false )
473 aSheetPath.
GetSymbols( references,
false,
true );
475 for(
unsigned ii = 0; ii < references.
GetCount(); ii++ )
484 wxString fullRef = schRef.
GetRef() + refNum;
487 if( fullRef.StartsWith( wxS(
"#" ) ) )
491 if( refNum.compare( wxS(
"?" ) ) == 0 )
495 auto symMatchIt = aSyncSymMap.find( fullRef );
497 if( symMatchIt != aSyncSymMap.end() )
499 symMatchIt->second.emplace_back( schRef );
506 auto symPinMatchIt = aSyncPinMap.find( fullRef );
508 if( symPinMatchIt != aSyncPinMap.end() )
510 std::unordered_map<wxString, SCH_PIN*>& pinMap = symPinMatchIt->second;
511 std::vector<SCH_PIN*> pinsOnSheet = symbol->
GetPins( &aSheetPath );
515 int pinUnit =
pin->GetLibPin()->GetUnit();
517 if( pinUnit > 0 && pinUnit != schRef.
GetUnit() )
520 auto pinIt = pinMap.find(
pin->GetNumber() );
522 if( pinIt != pinMap.end() )
534 std::unordered_map<wxString, std::vector<SCH_REFERENCE>>& aSyncSymMap,
535 std::unordered_map<wxString, std::unordered_map<wxString, SCH_PIN*>>& aSyncPinMap,
536 std::unordered_map<SCH_SHEET_PATH, bool>& aCache )
538 auto cacheIt = aCache.find( aSheetPath );
540 if( cacheIt != aCache.end() )
541 return cacheIt->second;
550 aSyncPinMap, aCache );
554 aCache.emplace( aSheetPath,
false );
560 aSheetPath.
GetSymbols( references,
false,
true );
564 aCache.emplace( aSheetPath,
false );
568 for(
unsigned ii = 0; ii < references.
GetCount(); ii++ )
576 wxString fullRef = schRef.
GetRef() + refNum;
579 if( fullRef.StartsWith( wxS(
"#" ) ) )
583 if( refNum.compare( wxS(
"?" ) ) == 0 )
586 if( aSyncSymMap.find( fullRef ) == aSyncSymMap.end() )
588 aCache.emplace( aSheetPath,
false );
592 if( aSyncPinMap.find( fullRef ) != aSyncPinMap.end() )
594 aCache.emplace( aSheetPath,
false );
599 aCache.emplace( aSheetPath,
true );
604std::optional<std::tuple<SCH_SHEET_PATH, SCH_ITEM*, std::vector<SCH_ITEM*>>>
608 wxArrayString syncArray = wxStringTokenize( aSyncStr, wxS(
"," ) );
610 std::unordered_map<wxString, std::vector<SCH_REFERENCE>> syncSymMap;
611 std::unordered_map<wxString, std::unordered_map<wxString, SCH_PIN*>> syncPinMap;
612 std::unordered_map<SCH_SHEET_PATH, double> symScores;
613 std::unordered_map<SCH_SHEET_PATH, bool> fullyWantedCache;
615 std::optional<wxString> focusSymbol;
616 std::optional<std::pair<wxString, wxString>> focusPin;
617 std::unordered_map<SCH_SHEET_PATH, std::vector<SCH_ITEM*>> focusItemResults;
623 orderedSheets.reserve( allSheetsList.size() );
629 orderedSheets.push_back( sheetPath );
633 for(
size_t i = 0; i < syncArray.size(); i++ )
635 wxString syncEntry = syncArray[i];
637 if( syncEntry.empty() )
640 wxString syncData = syncEntry.substr( 1 );
642 switch( syncEntry.GetChar( 0 ).GetValue() )
648 if( aFocusOnFirst && ( i == 0 ) )
649 focusSymbol = symRef;
651 syncSymMap[symRef] = std::vector<SCH_REFERENCE>();
659 if( aFocusOnFirst && ( i == 0 ) )
660 focusPin = std::make_pair( symRef, padNum );
662 syncPinMap[symRef][padNum] =
nullptr;
670 auto flattenSyncMaps = [&syncSymMap, &syncPinMap]() -> std::vector<SCH_ITEM*>
672 std::vector<SCH_ITEM*> allVec;
674 for(
auto const& pairSym : syncSymMap )
682 for(
auto const& pairSym : syncPinMap )
684 for(
auto const& pairPin : pairSym.second )
687 allVec.push_back( pairPin.second );
694 auto clearSyncMaps = [&syncSymMap, &syncPinMap]()
696 for(
auto& pairSym : syncSymMap )
698 pairSym.second.clear();
701 for(
auto& pairSym : syncPinMap )
703 for(
auto& pairPin : pairSym.second )
705 pairPin.second =
nullptr;
710 auto syncMapsValuesEmpty = [&syncSymMap, &syncPinMap]() ->
bool
712 for(
auto const& pairSym : syncSymMap )
714 if( pairSym.second.size() > 0 )
718 for(
auto const& pairSym : syncPinMap )
720 for(
auto const& pairPin : pairSym.second )
734 auto findIt = syncSymMap.find( *focusSymbol );
735 if( findIt != syncSymMap.end() )
737 if( findIt->second.size() > 0 )
739 focusItemResults[aSheetPath].push_back( findIt->second.front().GetSymbol() );
745 auto findIt = syncPinMap.find( focusPin->first );
746 if( findIt != syncPinMap.end() )
748 if( findIt->second[focusPin->second] )
750 focusItemResults[aSheetPath].push_back( findIt->second[focusPin->second] );
762 std::vector<SCH_ITEM*> itemsVector = flattenSyncMaps();
768 kiidPath.push_back( item->m_Uuid );
770 std::optional<SCH_SHEET_PATH> subsheetPath =
779 itemsVector.push_back( item );
783 return std::make_tuple( aSheet, aFocusItem, itemsVector );
794 checkFocusItems( sheetPath );
797 if( focusItemResults.size() > 0 )
801 auto vec = focusItemResults[sheetPath];
804 return makeRetForSheet( sheetPath, vec.front() );
816 if( !syncMapsValuesEmpty() )
819 return makeRetForSheet( sheetPath,
nullptr );
839 if( !
eeconfig()->m_CrossProbing.on_selection )
852 std::string prefix =
"$SELECT: ";
854 std::string paramStr = payload.substr( prefix.size() );
856 if( paramStr.size() < 2 )
859 std::string syncStr = paramStr.substr( 2 );
861 bool focusOnFirst = ( paramStr[0] ==
'1' );
863 std::optional<std::tuple<SCH_SHEET_PATH, SCH_ITEM*, std::vector<SCH_ITEM*>>> findRet =
868 auto& [sheetPath, focusItem, items] = *findRet;
883 if( !payload.empty() )
885 wxString annotationMessage( payload );
906 KIID uuid( payload );
912 payload =
static_cast<SCH_SHEET*
>( item )->GetShownName(
false );
916 payload = item->GetFriendlyName();
945 std::stringstream ss( payload );
948 std::string formatStr;
949 wxCHECK( std::getline( ss, formatStr, delim ), );
951 std::string fnameStr;
952 wxCHECK( std::getline( ss, fnameStr, delim ), );
953 wxASSERT( !fnameStr.empty() );
959 importFormat = std::stoi( formatStr );
961 catch( std::invalid_argument& )
971 std::string key, value;
973 if( !std::getline( ss, key, delim ) )
976 std::getline( ss, value, delim );
978 props.emplace( key, value );
982 if( importFormat >= 0 )
983 importFile( fnameStr, importFormat, props.empty() ?
nullptr : &props );
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION showSymbolLibTable
static TOOL_ACTION updateSchematicFromPcb
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
CROSS_PROBING_SETTINGS m_CrossProbing
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
A base class for most all the KiCad significant classes used in schematics and boards.
virtual const wxString & GetText() const
Return the string associated with the text object.
static TOOL_ACTION runERC
static TOOL_ACTION updateNetHighlighting
EE_TYPE OfType(KICAD_T aType) const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
bool IsSingle() const
Is this KIFACE running under single_top?
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
wxString AsString() const
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
std::string & GetPayload()
Return the payload, which can be any text but it typically self identifying s-expression.
MAIL_T Command()
Returns the MAIL_T associated with this mail.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Generate the KiCad netlist format supported by Pcbnew.
void Format(OUTPUTFORMATTER *aOutputFormatter, int aCtl)
Output this s-expression netlist into aOutputFormatter.
Holds all the data relating to one schematic.
SCH_SHEET_PATH & CurrentSheet() const override
void SetCurrentSheet(const SCH_SHEET_PATH &aPath) override
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SyncView()
Mark all items for refresh.
EESCHEMA_SETTINGS * eeconfig() const
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
const std::vector< std::shared_ptr< SCH_CONNECTION > > AllMembers() const
wxString Name(bool aIgnoreSheet=false) const
const std::vector< std::shared_ptr< SCH_CONNECTION > > & Members() const
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Handle actions specific to the schematic editor.
void AssignFootprints(const std::string &aChangedSetOfReferences)
SCH_ITEM * FindSymbolAndItem(const wxString *aPath, const wxString *aReference, bool aSearchHierarchy, SCH_SEARCH_T aSearchType, const wxString &aSearchText)
Find a symbol in the schematic and an item in this symbol and select it.
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
bool m_syncingPcbToSchSelection
bool importFile(const wxString &aFileName, int aFileType, const STRING_UTF8_MAP *aProperties=nullptr)
Load the given filename but sets the path to the current project path.
void SendSelectItemsToPcb(const std::vector< EDA_ITEM * > &aItems, bool aForce)
Send items to board editor for selection.
void SendCrossProbeClearHighlight()
Tell Pcbnew to clear the existing highlighted net, if one exists.
SCHEMATIC * m_schematic
The currently loaded schematic.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void ExecuteRemoteCommand(const char *cmdline) override
Execute a remote command sent via a socket on port KICAD_SCH_PORT_SERVICE_NUMBER (which defaults to 4...
void SendCrossProbeNetName(const wxString &aNetName)
Send a net name to Pcbnew for highlighting.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
void DisplayCurrentSheet()
Draw the current sheet on the display.
wxString m_highlightedConn
The highlighted net or bus or empty string.
void SetCrossProbeConnection(const SCH_CONNECTION *aConnection)
Send a connection (net or bus) to Pcbnew for highlighting.
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
void FocusOnItem(SCH_ITEM *aItem)
void KiwayMailIn(KIWAY_EXPRESS &aEvent) override
Receive KIWAY_EXPRESS messages from other players.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
A helper to define a symbol's reference designator in a schematic.
void Split()
Attempt to split the reference designator into a name (U) and number (1).
bool IsSplitNeeded()
Determine if this reference needs to be split or if it likely already has been.
SCH_SYMBOL * GetSymbol() const
wxString GetRefNumber() const
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
std::optional< SCH_SHEET_PATH > GetSheetPathByKIIDPath(const KIID_PATH &aPath, bool aIncludeLastSheet=true) const
Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr) const
Fetch a SCH_ITEM by ID.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_SCREEN * LastScreen()
bool IsContainedWithin(const SCH_SHEET_PATH &aSheetPathToTest) const
Check if this path is contained inside aSheetPathToTest.
wxString PathAsString() const
Return the path of time stamps which do not changes even when editing sheet parameters.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve a list of the SCH_PINs for the given sheet path.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
SCH_PIN * GetPin(const wxString &number) const
Find a symbol pin by number.
A name/value tuple with unique names and optional values.
bool SendCommand(int aService, const std::string &aMessage)
Used by a client to sent (by a socket connection) a data to a server.
bool findSymbolsAndPins(const SCHEMATIC &aSchematic, const SCH_SHEET_PATH &aSheetPath, std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &aSyncSymMap, std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &aSyncPinMap, bool aRecursive=false)
std::optional< std::tuple< SCH_SHEET_PATH, SCH_ITEM *, std::vector< SCH_ITEM * > > > findItemsFromSyncSelection(const SCHEMATIC &aSchematic, const std::string aSyncStr, bool aFocusOnFirst)
bool sheetContainsOnlyWantedItems(const SCHEMATIC &aSchematic, const SCH_SHEET_PATH &aSheetPath, std::unordered_map< wxString, std::vector< SCH_REFERENCE > > &aSyncSymMap, std::unordered_map< wxString, std::unordered_map< wxString, SCH_PIN * > > &aSyncPinMap, std::unordered_map< SCH_SHEET_PATH, bool > &aCache)
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
@ ALL
All except INITIAL_ADD.
int StrPrintf(std::string *result, const char *format,...)
This is like sprintf() but the output is appended to a std::string instead of to a character array.
SCH_SEARCH_T
Schematic search type used by the socket link with Pcbnew.
std::vector< SCH_SHEET_PATH > SCH_SHEET_PATHS
wxString UnescapeString(const wxString &aSource)
wxString From_UTF8(const char *cstring)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
bool on_selection
Synchronize the selection for multiple items too.
bool zoom_to_fit
Zoom to fit items (ignored if center_on_items is off)
bool center_on_items
Automatically pan to cross-probed items.
bool auto_highlight
Automatically turn on highlight mode in the target frame.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".