26#ifndef _LIB_TABLE_BASE_H_
27#define _LIB_TABLE_BASE_H_
30#include <boost/ptr_container/ptr_vector.hpp>
33#include <shared_mutex>
81 LIB_TABLE_ROW(
const wxString& aNick,
const wxString& aURI,
const wxString& aOptions,
82 const wxString& aDescr = wxEmptyString,
LIB_TABLE* aParent =
nullptr ) :
84 description( aDescr ),
91 SetOptions( aOptions );
107 void SetNickName(
const wxString& aNickName ) { nickName = aNickName; }
127 void SetEnabled(
bool aEnabled =
true ) { enabled = aEnabled; }
131 void SetVisible(
bool aVisible =
true ) { visible = aVisible; }
144 virtual void SetType(
const wxString& aType ) = 0;
156 const wxString GetFullURI(
bool aSubstituted =
false )
const;
161 void SetFullURI(
const wxString& aFullURI );
172 void SetOptions(
const wxString& aOptions );
177 const wxString&
GetDescr()
const {
return description; }
182 void SetDescr(
const wxString& aDescr ) { description = aDescr; }
213 nickName( aRow.nickName ),
214 uri_user( aRow.uri_user ),
215 options( aRow.options ),
216 description( aRow.description ),
217 enabled( aRow.enabled ),
218 visible( aRow.visible ),
219 m_loaded( aRow.m_loaded ),
220 m_parent( aRow.m_parent )
223 properties = std::make_unique<STRING_UTF8_MAP>( *aRow.
properties.get() );
242 bool m_loaded =
false;
311 virtual void Parse( LIB_TABLE_LEXER* aLexer ) = 0;
348 if( m_rows.size() == r.
m_rows.size() )
352 for( i = 0; i < m_rows.size() && m_rows[i] == r.
m_rows[i]; ++i )
355 if( i == m_rows.size() )
369 return m_rows.size();
379 return m_rows[aIndex];
387 return m_rows[aIndex];
398 bool IsEmpty(
bool aIncludeFallback =
true );
404 const wxString GetDescription(
const wxString& aNickname );
412 bool HasLibrary(
const wxString& aNickname,
bool aCheckEnabled =
false )
const;
420 bool HasLibraryWithPath(
const wxString& aPath )
const;
426 std::vector<wxString> GetLogicalLibs();
431 wxString GetFullURI(
const wxString& aLibNickname,
bool aExpandEnvVars =
true )
const;
445 bool InsertRow(
LIB_TABLE_ROW* aRow,
bool doReplace =
false );
466 bool ChangeRowOrder(
size_t aIndex,
int aOffset );
487 void Load(
const wxString& aFileName );
494 void Save(
const wxString& aFileName )
const;
508 static STRING_UTF8_MAP* ParseOptions(
const std::string& aOptionsList );
541 LIB_TABLE_ROW* findRow(
const wxString& aNickname,
bool aCheckIfEnabled =
false )
const;
KICAD_PLUGIN_EXPORT SCENEGRAPH * Load(char const *aFileName)
reads a model file and creates a generic display structure
bool operator==(const wxAuiPaneInfo &aLhs, const wxAuiPaneInfo &aRhs)
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
A logical library item identifier and consists of various portions much like a URI.
This abstract base class mixes any object derived from LIB_TABLE into wxGridTableBase so the result c...
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
const wxString & GetDescr() const
Return the description of the library referenced by this row.
virtual LIB_TABLE_ROW * do_clone() const =0
std::unique_ptr< STRING_UTF8_MAP > properties
void SetVisible(bool aVisible=true)
void operator=(const LIB_TABLE_ROW &aRow)
void SetNickName(const wxString &aNickName)
Change the logical name of this library, useful for an editor.
wxString uri_user
what user entered from UI or loaded from disk
LIB_TABLE * GetParent() const
bool operator!=(const LIB_TABLE_ROW &r) const
virtual const wxString GetType() const =0
Return the type of library represented by this row.
void SetEnabled(bool aEnabled=true)
Change the enabled status of this library.
void SetDescr(const wxString &aDescr)
Change the description of the library referenced by this row.
virtual void ShowSettingsDialog(wxWindow *aParent) const
void SetParent(LIB_TABLE *aParent)
LIB_TABLE_ROW(const LIB_TABLE_ROW &aRow)
void SetLoaded(bool aLoaded)
Mark the row as being a loaded library.
LIB_TABLE * m_parent
Pointer to the table this row lives in (maybe null)
virtual void SetType(const wxString &aType)=0
Change the type of library represented by this row that must be implemented in the derived object to ...
const wxString & GetNickName() const
LIB_TABLE_ROW(const wxString &aNick, const wxString &aURI, const wxString &aOptions, const wxString &aDescr=wxEmptyString, LIB_TABLE *aParent=nullptr)
LIB_TABLE_ROW * clone() const
bool GetIsEnabled() const
const STRING_UTF8_MAP * GetProperties() const
Return the constant #PROPERTIES for this library (LIB_TABLE_ROW).
virtual bool SupportsSettingsDialog() const
bool GetIsVisible() const
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.
std::shared_mutex m_mutex
Mutex to protect access to the rows vector.
std::map< wxString, LIB_TABLE_ROWS_ITER > m_rowsMap
this is a non-owning index into the LIB_TABLE_ROWS table
int m_version
Versioning to handle importing old tables.
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
bool operator==(const LIB_TABLE &r) const
Compares this table against another.
LIB_TABLE_ROWS m_rows
Owning set of rows.
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.
unsigned GetCount() const
Get the number of rows contained in the table.
virtual void Parse(LIB_TABLE_LEXER *aLexer)=0
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...
bool operator!=(const LIB_TABLE &r) const
const LIB_TABLE_ROW & At(unsigned aIndex) const
Get the 'n'th LIB_TABLE_ROW object.
int GetVersion() const
Returns the version number (0 if unset)
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
A name/value tuple with unique names and optional values.
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
boost::ptr_vector< LIB_TABLE_ROW > LIB_TABLE_ROWS
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
KICOMMON_API LIB_TABLE_ROW * new_clone(const LIB_TABLE_ROW &aRow)
Allows boost pointer containers to make clones of the data stored in them.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.