46#include <wx/clipbrd.h>
47#include <wx/filedlg.h>
66 title += wxS(
" " ) +
_(
"[from schematic]" );
76 title += wxS(
" " ) +
_(
"[Read Only Library]" );
80 title =
_(
"[no symbol loaded]" );
83 title += wxT(
" \u2014 " ) +
_(
"Symbol Editor" );
90 wxString selectedLib = aLibrary;
92 if( selectedLib.empty() )
93 selectedLib =
SelectLibrary(
_(
"Select Symbol Library" ),
_(
"Library:" ) );
95 if( !selectedLib.empty() )
128 wxString msg = wxString::Format(
_(
"Symbol library '%s' is not writable." ),
130 wxString msg2 =
_(
"You must save to a different location." );
153 if( lib->SchLibType() == SCH_IO_MGR::SCH_DATABASE
154 || lib->SchLibType() == SCH_IO_MGR::SCH_CADSTAR_ARCHIVE
155 || lib->SchLibType() == SCH_IO_MGR::SCH_HTTP )
169 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ),
235 msg.Printf(
_(
"Error loading symbol %s from library '%s'." ),
260 int aUnit,
int aBodyStyle )
262 bool rebuildMenuAndToolbar =
false;
264 if( !aEntry || aLibrary.empty() )
267 if( aEntry->
GetName().IsEmpty() )
269 wxLogWarning(
"Symbol in library '%s' has empty name field.", aLibrary );
285 rebuildMenuAndToolbar =
true;
289 wxCHECK( lib_symbol,
false );
291 m_unit = aUnit > 0 ? aUnit : 1;
301 if( rebuildMenuAndToolbar )
350 lib =
SelectLibrary(
_(
"New Symbol" ),
_(
"Create symbol in library:" ) );
356 const auto validator =
357 [&]( wxString newName ) ->
bool
359 if( newName.IsEmpty() )
361 wxMessageBox(
_(
"Symbol must have a name." ) );
369 msg.Printf(
_(
"Symbol '%s' already exists in library '%s'." ),
373 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ),
374 wxOK | wxCANCEL | wxICON_WARNING );
376 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
384 wxArrayString symbolNamesInLib;
389 dlg.SetMinSize( dlg.GetSize() );
400 if( parentSymbolName.IsEmpty() )
444 *field = *parentField;
448 case FIELD_T::REFERENCE:
457 case FIELD_T::FOOTPRINT:
459 field->
SetText( wxEmptyString );
462 case FIELD_T::DATASHEET:
467 field->
SetText( wxEmptyString );
479 std::vector<SCH_FIELD*> listFields;
484 if( field->GetId() == FIELD_T::USER )
489 new_field->
SetText( wxEmptyString );
519 if( libName.empty() )
525 wxString msg = wxString::Format(
_(
"Symbol library '%s' is not writable." ),
527 wxString msg2 =
_(
"You must save to a different location." );
548 if( !libName.IsEmpty() )
574 while(
chain.back()->IsDerived() )
577 chain.push_back( parent );
595 const wxString& aNewSymbolName,
596 const wxString& aNewLibraryName )
601 if( aNewLibraryName != oldLibraryName )
602 return {
false,
false };
606 return {
false,
false };
608 bool inAncestry =
false;
609 bool inDescendents =
false;
612 const std::vector<LIB_SYMBOL_SPTR> parentChainFromUs =
GetParentChain( aSymbol );
615 for(
size_t i = 1; i < parentChainFromUs.size(); ++i )
618 if( parentChainFromUs[i]->GetName() == aNewSymbolName )
628 const std::vector<LIB_SYMBOL_SPTR> parentChainFromTarget =
GetParentChain( *targetSymbol );
629 const wxString oldSymbolName = aSymbol.
GetName();
633 for(
size_t i = 1; i < parentChainFromTarget.size(); ++i )
635 if( parentChainFromTarget[i]->GetName() == oldSymbolName )
637 inDescendents =
true;
643 return { inAncestry, inDescendents };
656 const wxString& newSymbolName,
657 const wxString& newLibraryName )
659 std::vector<wxString> conflicts;
662 if( newLibraryName == oldLibraryName )
666 conflicts.push_back( newSymbolName );
671 const std::vector<LIB_SYMBOL_SPTR> parentChain =
GetParentChain( aSymbol );
673 for(
size_t i = 0; i < parentChain.size(); ++i )
679 conflicts.push_back( newSymbolName );
685 if( aLibMgr.
SymbolNameInUse( chainSymbol->GetName(), newLibraryName ) )
686 conflicts.push_back( chainSymbol->GetName() );
716 bool aValueFollowsName ) :
723 bool DoSave(
LIB_SYMBOL& symbol,
const wxString& aNewSymName,
const wxString& aNewLibName )
725 std::vector<LIB_SYMBOL_SPTR> parentChain;
729 parentChain.push_back( symbol.
SharedPtr() );
733 std::vector<wxString> newNames;
736 for(
int i = (
int) parentChain.size() - 1; i >= 0; --i )
746 newName = aNewSymName;
751 newName = oldSymbol->GetName();
760 if( i == (
int) parentChain.size() - 1 )
771 wxASSERT( newParent );
775 newNames.push_back( newName );
783 wxString
resolveConflict(
const wxString& proposed,
const wxString& aNewLibName )
const
799 wxString newName = wxString::Format(
"%s_%d", proposed, suffix );
811 wxFAIL_MSG(
"Invalid conflict strategy" );
843 wxArrayString headers;
844 std::vector<wxArrayString> itemsToDisplay;
847 initDialog( headers, itemsToDisplay, aLibraryPreselect );
852 wxBoxSizer* bNameSizer =
new wxBoxSizer( wxHORIZONTAL );
854 wxStaticText* label =
new wxStaticText(
this, wxID_ANY,
_(
"Name:" ) );
855 bNameSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL|wxTOP|wxBOTTOM|wxLEFT, 5 );
862 m_ButtonsSizer->Prepend( newLibraryButton, 0, wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT, 10 );
864 GetSizer()->Prepend( bNameSizer, 0, wxEXPAND|wxTOP|wxLEFT|wxRIGHT, 5 );
867 [
this]( wxCommandEvent& )
881 GetSizer()->Fit(
this );
889 symbolName.Trim(
true );
890 symbolName.Trim(
false );
891 symbolName.Replace(
" ",
"_" );
900 if( ret == wxID_CANCEL )
934 const auto dialogValidatorFunc =
935 [&](
const wxString& newLib,
const wxString& newName ) ->
int
937 if( newLib.IsEmpty() )
939 wxMessageBox(
_(
"A library must be specified." ) );
943 if( newName.IsEmpty() )
945 wxMessageBox(
_(
"Symbol must have a name." ) );
951 msg = wxString::Format(
_(
"Library '%s' is read-only. Choose a "
952 "different library to save the symbol '%s' to." ),
968 msg = wxString::Format(
_(
"Symbol '%s' cannot replace another symbol '%s' "
969 "that it descends from" ),
978 msg = wxString::Format(
_(
"Symbol '%s' cannot replace another symbol '%s' "
979 "that is a descendent of it." ),
989 if( conflicts.size() == 1 && conflicts.front() == newName )
992 msg = wxString::Format(
_(
"Symbol '%s' already exists in library '%s'. "
993 "Do you want to overwrite it?" ),
997 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
998 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
1002 else if( !conflicts.empty() )
1008 msg = wxString::Format(
_(
"The following symbols in the inheritance chain of "
1009 "'%s' already exist in library '%s':\n" ),
1013 for(
const wxString& conflict : conflicts )
1014 msg += wxString::Format(
" %s\n", conflict );
1016 msg +=
_(
"\nDo you want to overwrite all of them, or rename the new symbols?" );
1018 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxYES_NO | wxCANCEL | wxICON_WARNING );
1019 errorDlg.SetYesNoCancelLabels(
_(
"Overwrite All" ),
_(
"Rename All" ),
_(
"Cancel" ) );
1025 default:
return wxID_CANCEL;
1061 libraryName = newLibrary.GetName();
1072 saver.
DoSave( *symbol, symbolName, libraryName );
1094 fn.SetName( symbol->
GetName().Lower() );
1097 wxFileDialog dlg(
this,
_(
"Export Symbol" ),
m_mruPath, fn.GetFullName(),
1100 if( dlg.ShowModal() == wxID_CANCEL )
1108 wxString libraryName;
1109 std::unique_ptr<LIB_SYMBOL> flattenedSymbol = symbol->
Flatten();
1114 libraryName = candidate;
1117 if( !libraryName.IsEmpty() )
1123 msg = wxString::Format(
_(
"Library '%s' is read-only." ), libraryName );
1130 msg = wxString::Format(
_(
"Symbol '%s' already exists in library '%s'." ),
1131 symbol->
GetName(), libraryName );
1133 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
1134 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
1137 if( errorDlg.
ShowModal() == wxID_CANCEL )
1141 saver.
DoSave( *flattenedSymbol, symbol->
GetName(), libraryName );
1150 if( pluginType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
1151 pluginType = SCH_IO_MGR::SCH_KICAD;
1155 if( fn.FileExists() )
1159 old_symbol = pi->LoadSymbol( fn.GetFullPath(), symbol->
GetName() );
1163 msg.Printf(
_(
"Error occurred attempting to load symbol library file '%s'." ),
1171 msg.Printf(
_(
"Symbol %s already exists in library '%s'." ),
1175 KIDIALOG errorDlg(
this, msg,
_(
"Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
1176 errorDlg.SetOKLabel(
_(
"Overwrite" ) );
1179 if( errorDlg.
ShowModal() == wxID_CANCEL )
1184 if( !fn.IsDirWritable() )
1186 msg.Printf(
_(
"Insufficient permissions to save library '%s'." ), fn.GetFullPath() );
1193 if( !fn.FileExists() )
1194 pi->CreateLibrary( fn.GetFullPath() );
1199 pi->SaveSymbol( fn.GetFullPath(), flattenedSymbol.release() );
1203 msg.Printf(
_(
"Failed to create symbol library file '%s'." ), fn.GetFullPath() );
1205 msg.Printf(
_(
"Error creating symbol library '%s'." ), fn.GetFullName() );
1206 SetStatusText( msg );
1212 msg.Printf(
_(
"Symbol %s saved to library '%s'." ),
1215 SetStatusText( msg );
1230 wxString msg = wxString::Format(
_(
"Symbol name '%s' already in use." ),
1262 if( toDelete.empty() )
1265 for(
LIB_ID& libId : toDelete )
1268 && !
IsOK(
this, wxString::Format(
_(
"The symbol '%s' has been modified.\n"
1269 "Do you want to remove it from the library?" ),
1270 libId.GetUniStringLibItemName() ) ) )
1280 _(
"The symbol %s is used to derive other symbols.\n"
1281 "Deleting this symbol will delete all of the symbols derived from it.\n\n"
1282 "Do you wish to delete this symbol and all of its derivatives?" ),
1283 libId.GetLibItemName().wx_str() );
1285 wxMessageDialog::ButtonLabel yesButtonLabel(
_(
"Delete Symbol" ) );
1286 wxMessageDialog::ButtonLabel noButtonLabel(
_(
"Keep Symbol" ) );
1288 wxMessageDialog dlg(
this, msg,
_(
"Warning" ),
1289 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
1290 dlg.SetYesNoLabels( yesButtonLabel, noButtonLabel );
1292 if( dlg.ShowModal() == wxID_NO )
1308 std::vector<LIB_ID> symbols;
1315 for(
LIB_ID& libId : symbols )
1318 libId.GetLibNickname() );
1323 std::unique_ptr<LIB_SYMBOL> tmp = symbol->
Flatten();
1327 std::string prettyData = formatter.
GetString();
1332 auto clipboard = wxTheClipboard;
1333 wxClipboardLocker clipboardLock( clipboard );
1335 if( !clipboardLock || !clipboard->IsOpened() )
1338 auto data =
new wxTextDataObject( wxString( prettyData.c_str(), wxConvUTF8 ) );
1339 clipboard->SetData( data );
1353 std::vector<LIB_SYMBOL*> newSymbols;
1355 if( aFromClipboard )
1365 wxLogMessage( wxS(
"Can not paste: %s" ), e.
Problem() );
1370 newSymbols.emplace_back(
new LIB_SYMBOL( *srcSymbol ) );
1373 if( srcSymbol->IsDerived() )
1375 if( std::shared_ptr<LIB_SYMBOL> srcParent = srcSymbol->GetParent().lock() )
1376 newSymbols.back()->SetParent( srcParent.get() );
1380 if( newSymbols.empty() )
1404 wxString newName = aSymbol->
GetName();
1408 newName.Printf(
"%s_%d", aSymbol->
GetName(), i++ );
1423 wxString msg = wxString::Format(
_(
"Revert '%s' to last version saved?" ),
1424 symbolName.IsEmpty() ? libName : symbolName );
1429 bool reload_currentSymbol =
false;
1430 wxString curr_symbolName = symbolName;
1436 if( symbolName.IsEmpty() )
1441 if( reload_currentSymbol )
1452 if( reload_currentSymbol )
1455 if( symbolName.IsEmpty() )
1468 LoadSymbol( curr_symbolName, libName, unit );
1476 wxCHECK_RET(
m_libMgr,
"Library manager object not created." );
1501 DisplayError(
this, wxString::Format(
_(
"Symbol %s not found in library '%s'." ),
1523 SCH_IO_MGR::SCH_FILE_T
fileType = SCH_IO_MGR::SCH_FILE_T::SCH_KICAD;
1544 fn.SetName( aLibrary );
1549 wxFileDialog dlg(
this, wxString::Format(
_(
"Save Library '%s' As..." ), aLibrary ), default_path,
1550 fn.GetFullName(), wildcards, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1553 dlg.SetCustomizeHook( saveAsHook );
1555 if( dlg.ShowModal() == wxID_CANCEL )
1562 if( fn.GetExt().IsEmpty() )
1572 if(
fileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
1588 msg.Printf(
_(
"Failed to save changes to symbol library file '%s'." ),
1604 bool resyncLibTree =
false;
1606 wxString forceRefresh;
1610 case SYMBOL_SAVEAS_TYPE::REPLACE_TABLE_ENTRY:
1612 forceRefresh = originalLibNickname;
1615 case SYMBOL_SAVEAS_TYPE::ADD_GLOBAL_TABLE_ENTRY:
1619 case SYMBOL_SAVEAS_TYPE::ADD_PROJECT_TABLE_ENTRY:
1636 msg.Printf(
_(
"Symbol library file '%s' saved." ), fn.GetFullPath() );
1648 bool applyToAll =
false;
1661 if( aRequireConfirmation && !applyToAll )
1663 msg.Printf(
_(
"Save changes to '%s' before closing?" ), libNickname );
1667 case wxID_YES: doSave =
true;
break;
1668 case wxID_NO: doSave =
false;
break;
1670 case wxID_CANCEL:
return false;
1680 msg.Printf(
_(
"Symbol library '%s' is not writable." ), libNickname );
1681 msg2 =
_(
"You must save to a different location." );
1683 if( dirtyCount == 1 )
1695 2000, wxICON_EXCLAMATION );
1735 msg = parent ? parent->GetName() :
_(
"Undefined!" );
1740 msg =
_(
"Power Symbol" );
1742 msg =
_(
"Power Symbol (Local)" );
1744 msg =
_(
"Symbol" );
static TOOL_ACTION cancelInteractive
static TOOL_ACTION zoomFitScreen
void SetContentModified(bool aModified=true)
wxString GetParentSymbolName() const
bool GetIncludeOnBoard() const
wxString GetName() const override
bool GetUnitsInterchangeable()
bool GetTransferUserFields()
bool GetKeepContentUserFields()
bool GetAlternateBodyStyle()
bool GetIncludeInBom() const
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
void SetupStandardButtons(std::map< int, wxString > aLabels={})
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
virtual void RecreateToolbars()
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
void ReCreateMenuBar()
Recreate the menu bar.
WX_INFOBAR * GetInfoBar()
virtual void ClearMsgPanel()
Clear all messages from the message panel.
void AppendMsgPanel(const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
Append a message to the message panel.
virtual void SetParent(EDA_ITEM *aParent)
wxBoxSizer * m_ButtonsSizer
void SetOKLabel(const wxString &aLabel)
void initDialog(const wxArrayString &aItemHeaders, const std::vector< wxArrayString > &aItemList, const wxString &aPreselectText)
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
void SetListLabel(const wxString &aLabel)
virtual const wxString & GetText() const
Return the string associated with the text object.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
A logical library item identifier and consists of various portions much like a URI.
bool IsValid() const
Check if this LID_ID is valid.
wxString GetUniStringLibId() const
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
const wxString GetUniStringLibNickname() const
const UTF8 & GetLibItemName() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Symbol library management helper that is specific to the symbol library editor frame.
Define a library symbol object.
wxString GetDescription() const override
const LIB_ID & GetLibId() const override
wxString GetKeyWords() const override
bool IsMulti() const override
void GetFields(std::vector< SCH_FIELD * > &aList, bool aVisibleOnly=false) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
bool IsPower() const override
void SetUnitCount(int aCount, bool aDuplicateDrawItems=true)
Set the units per symbol count.
bool UnitsLocked() const
Check whether symbol units are interchangeable.
SCH_FIELD & GetDatasheetField()
Return reference to the datasheet field.
LIB_ID GetSourceLibId() const
SCH_FIELD * GetField(const wxString &aFieldName)
Find a field within this symbol matching aFieldName; return nullptr if not found.
bool HasAlternateBodyStyle() const override
Test if symbol has more than one body conversion type (DeMorgan).
void LockUnits(bool aLockUnits)
Set interchangeable the property for symbol units.
void SetParent(LIB_SYMBOL *aParent=nullptr)
wxString GetName() const override
SCH_FIELD & GetValueField()
Return reference to the value field.
bool IsLocalPower() const override
LIB_SYMBOL_SPTR SharedPtr() const
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared.
void SetHasAlternateBodyStyle(bool aHasAlternate, bool aDuplicatePins=true)
Set or clear the alternate body style (DeMorgan) for the symbol.
bool IsGlobalPower() const override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
void AddField(SCH_FIELD *aField)
Add a field.
LIB_SYMBOL_REF & GetParent()
virtual void SetName(const wxString &aName)
SCH_FIELD & GetReferenceField()
Return reference to the reference designator field.
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
void RefreshLibTree()
Refresh the tree (mainly to update highlighting and asterisking)
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
static SEARCH_STACK * SchSearchS(PROJECT *aProject)
Accessor for Eeschema search stack.
Container for project specific data.
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
bool TransferDataFromWindow() override
SYMBOL_SAVE_AS_HANDLER::CONFLICT_STRATEGY & m_conflictStrategy
std::function< int(const wxString &libName, const wxString &symbolName)> SymLibNameValidator
SAVE_SYMBOL_AS_DIALOG(SYMBOL_EDIT_FRAME *aParent, const wxString &aSymbolName, const wxString &aLibraryPreselect, SymLibNameValidator aValidator, SYMBOL_SAVE_AS_HANDLER::CONFLICT_STRATEGY &aConflictStrategy)
SymLibNameValidator m_validator
wxTextCtrl * m_symbolNameCtrl
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void GetLibraryItemsForListDialog(wxArrayString &aHeaders, std::vector< wxArrayString > &aItemsToDisplay)
wxString SelectLibrary(const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
Display a list of loaded libraries and allows the user to select a library.
void SetSymModificationTime(const wxDateTime &aTime)
Set the modification time of the symbol library table file.
void setSymWatcher(const LIB_ID *aSymbol)
Creates (or removes) a watcher on the specified symbol library.
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Schematic editor (Eeschema) main window.
void SaveSymbolToSchematic(const LIB_SYMBOL &aSymbol, const KIID &aSchematicSymbolUUID)
Update a schematic symbol from a LIB_SYMBOL.
void SetText(const wxString &aText) override
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
static std::vector< LIB_SYMBOL * > ParseLibSymbols(std::string &aSymbolText, std::string aSource, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a symbol library using the file extension of aLibPath.
Look for files in a number of paths.
const wxString LastVisitedPath(const wxString &aSubPathToSearch=wxEmptyString)
A quirky function inherited from old code that seems to serve particular needs in the UI.
The symbol library editor main window.
bool m_isSymbolFromSchematic
void ClearMsgPanel() override
Clear all messages from the message panel.
void UpdateAfterSymbolProperties(wxString *aOldName=nullptr)
void SaveAll()
Save all modified symbols and libraries.
void DeleteSymbolFromLibrary()
bool addLibTableEntry(const wxString &aLibFile, TABLE_SCOPE aScope=GLOBAL_LIB_TABLE)
Add aLibFile to the symbol library table defined by aScope.
bool IsLibraryTreeShown() const override
wxString getTargetLib() const
bool IsCurrentSymbol(const LIB_ID &aLibId) const
Restore the empty editor screen, without any symbol or library selected.
bool backupFile(const wxFileName &aOriginalFile, const wxString &aBackupExt)
Return currently edited symbol.
int GetTreeLIBIDs(std::vector< LIB_ID > &aSelection) const
LIB_ID GetTreeLIBID(int *aUnit=nullptr) const
Return the LIB_ID of the library or symbol selected in the symbol tree.
LIB_SYMBOL_LIBRARY_MANAGER * m_libMgr
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
void Save()
Save the selected symbol or library.
void LoadSymbol(const wxString &aLibrary, const wxString &aSymbol, int Unit)
bool m_SyncPinEdit
Set to true to synchronize pins at the same position when editing symbols with multiple units or mult...
void RebuildSymbolUnitsList()
void Revert(bool aConfirm=true)
Revert unsaved changes in a symbol, restoring to the last saved state.
void centerItemIdleHandler(wxIdleEvent &aEvent)
bool replaceLibTableEntry(const wxString &aLibNickname, const wxString &aLibFile)
Replace the file path of the symbol library table entry aLibNickname with aLibFile.
bool IsSymbolFromSchematic() const
void SetScreen(BASE_SCREEN *aScreen) override
void DuplicateSymbol(bool aFromClipboard)
Insert a duplicate symbol.
SCH_SCREEN * m_dummyScreen
< Helper screen used when no symbol is loaded
LIB_ID m_centerItemOnIdle
void saveSymbolCopyAs(bool aOpenCopy)
void SetCurSymbol(LIB_SYMBOL *aSymbol, bool aUpdateZoom)
Take ownership of aSymbol and notes that it is the one currently being edited.
KIID m_schematicSymbolUUID
RefDes of the symbol (only valid if symbol was loaded from schematic)
std::vector< LIB_ID > GetSelectedLibIds() const
void SyncLibraries(bool aShowProgress, bool aPreloadCancelled=false, const wxString &aForceRefresh=wxEmptyString)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
LIB_SYMBOL * GetCurSymbol() const
Return the current symbol being edited or NULL if none selected.
void UpdateSymbolMsgPanelInfo()
Display the documentation of the selected symbol.
LIB_ID GetTargetLibId() const override
Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the...
bool saveLibrary(const wxString &aLibrary, bool aNewFile)
Save the changes to the current library.
void SelectActiveLibrary(const wxString &aLibrary=wxEmptyString)
Set the current active library to aLibrary.
int m_bodyStyle
Flag if the symbol being edited was loaded directly from a schematic.
bool saveAllLibraries(bool aRequireConfirmation)
Save the current symbol.
void UpdateMsgPanel() override
Redraw the message panel.
void CreateNewSymbol(const wxString &newName=wxEmptyString)
Create a new symbol in the selected library.
wxString SetCurLib(const wxString &aLibNickname)
Set the current library nickname and returns the old library nickname.
void UpdateTitle()
Update the main window title bar with the current library name and read only status of the library.
bool LoadSymbolFromCurrentLib(const wxString &aSymbolName, int aUnit=0, int aBodyStyle=0)
Load a symbol from the current active library, optionally setting the selected unit and convert.
SYMBOL_TREE_PANE * m_treePane
bool LoadOneLibrarySymbolAux(LIB_SYMBOL *aLibEntry, const wxString &aLibrary, int aUnit, int aBodyStyle)
Create a copy of aLibEntry into memory.
bool saveCurrentSymbol()
Store the currently modified symbol in the library manager buffer.
void CopySymbolToClipboard()
void SaveSymbolCopyAs(bool aOpenCopy)
Save the currently selected symbol to a new name and/or location.
wxString AddLibraryFile(bool aCreateNew)
Create or add an existing library to the symbol library table.
void ensureUniqueName(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
void SetShowDeMorgan(bool show)
void SaveLibraryAs()
Save the currently selected library to a new file.
bool IsContentModified() const override
Get if any symbols or libraries have been modified but not saved.
LIB_SYMBOL * getTargetSymbol() const
Return either the library selected in the symbol tree, if context menu is active or the library that ...
bool IsLibraryReadOnly(const wxString &aLibrary) const
Return true if the library is stored in a read-only file.
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Return true if library exists.
bool ClearLibraryModified(const wxString &aLibrary) const
Clear the modified flag for all symbols in a library.
LIB_SYMBOL * GetBufferedSymbol(const wxString &aSymbolName, const wxString &aLibrary)
Return the symbol copy from the buffer.
bool ClearSymbolModified(const wxString &aSymbolName, const wxString &aLibrary) const
Clear the modified flag for a symbol.
SCH_SCREEN * GetScreen(const wxString &aSymbolName, const wxString &aLibrary)
Return the screen used to edit a specific symbol.
bool SymbolNameInUse(const wxString &aName, const wxString &aLibrary)
Return true if the symbol name is already in use in the specified library.
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
LIB_SYMBOL * GetSymbol(const wxString &aSymbolName, const wxString &aLibrary) const
Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no w...
bool RemoveSymbol(const wxString &aSymbolName, const wxString &aLibrary)
Remove the symbol from the symbol buffer.
wxArrayString GetLibraryNames() const
Return the array of library names.
bool UpdateSymbolAfterRename(LIB_SYMBOL *aSymbol, const wxString &aOldSymbolName, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol when the name has changed.
bool IsSymbolModified(const wxString &aSymbolName, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
bool RevertLibrary(const wxString &aLibrary)
Revert unsaved changes for a symbol library.
LIB_ID RevertSymbol(const wxString &aSymbolName, const wxString &aLibrary)
Revert unsaved changes for a symbol.
void GetSymbolNames(const wxString &aLibName, wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)
bool RevertAll()
Revert all pending changes.
bool SymbolExists(const wxString &aSymbolName, const wxString &aLibrary) const
Return true if symbol with a specific alias exists in library (either original one or buffered).
SYMBOL_LIB_TABLE_ROW * GetLibrary(const wxString &aLibrary) const
Find a single library within the (aggregate) library table.
bool UpdateSymbol(LIB_SYMBOL *aSymbol, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol.
bool SaveLibrary(const wxString &aLibrary, const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFileType=SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY)
Save library to a file, including unsaved changes.
bool HasDerivedSymbols(const wxString &aSymbolName, const wxString &aLibraryName)
Check if symbol aSymbolName in library aLibraryName is a root symbol that has derived symbols.
SYMBOL_SAVEAS_TYPE GetOption() const
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
This is a class that handles state involved in saving a symbol copy as a new symbol.
CONFLICT_STRATEGY m_strategy
wxString resolveConflict(const wxString &proposed, const wxString &aNewLibName) const
SYMBOL_SAVE_AS_HANDLER(LIB_SYMBOL_LIBRARY_MANAGER &aLibMgr, CONFLICT_STRATEGY aStrategy, bool aValueFollowsName)
LIB_SYMBOL_LIBRARY_MANAGER & m_libMgr
bool DoSave(LIB_SYMBOL &symbol, const wxString &aNewSymName, const wxString &aNewLibName)
LIB_TREE * GetLibTree() const
void SetExcludedFromBoard(bool aExcludeFromBoard) override
Set or clear exclude from board netlist flag.
virtual void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
int GetPinNameOffset() const
virtual void SetShowPinNames(bool aShow)
Set or clear the pin name visibility flag.
void SetExcludedFromBOM(bool aExcludeFromBOM) override
Set or clear the exclude from schematic bill of materials flag.
void SetPinNameOffset(int aOffset)
Set the offset in mils of the pin name text from the pin symbol.
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
std::string GetClipboardUTF8()
Return the information currently stored in the system clipboard.
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
int UnsavedChangesDialog(wxWindow *parent, const wxString &aMessage, bool *aApplyToAll)
A specialized version of HandleUnsavedChanges which handles an apply-to-all checkbox.
bool ConfirmRevertDialog(wxWindow *parent, const wxString &aMessage)
Display a confirmation dialog for a revert action.
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
This file is part of the common library.
static const std::string KiCadSymbolLibFileExtension
static wxString KiCadSymbolLibFileWildcard()
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
This file is part of the common library.
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
@ ALL
All except INITIAL_ADD.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
KIWAY Kiway(KFCTL_STANDALONE)
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
static std::vector< LIB_SYMBOL_SPTR > GetParentChain(const LIB_SYMBOL &aSymbol)
Get a list of all the symbols in the parental chain of a symbol, with the "leaf" symbol at the start ...
static std::vector< wxString > CheckForParentalChainConflicts(LIB_SYMBOL_LIBRARY_MANAGER &aLibMgr, LIB_SYMBOL &aSymbol, const wxString &newSymbolName, const wxString &newLibraryName)
Get a list of all the symbols in the parental chain of a symbol that have conflicts when transposed t...
static std::pair< bool, bool > CheckSavingIntoOwnInheritance(LIB_SYMBOL_LIBRARY_MANAGER &aLibMgr, LIB_SYMBOL &aSymbol, const wxString &aNewSymbolName, const wxString &aNewLibraryName)
Check if a planned overwrite would put a symbol into it's own inheritance chain.
Definition for symbol library class.
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
const SHAPE_LINE_CHAIN chain
Definition of file extensions used in Kicad.