KiCad PCB EDA Suite
LIB_TABLE_ROW Class Referenceabstract

Class LIB_TABLE_ROW. More...

#include <lib_table_base.h>

Inheritance diagram for LIB_TABLE_ROW:
FP_LIB_TABLE_ROW SYMBOL_LIB_TABLE_ROW

Public Member Functions

 LIB_TABLE_ROW ()
 
virtual ~LIB_TABLE_ROW ()
 
 LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aOptions, const wxString &aDescr=wxEmptyString)
 
bool operator== (const LIB_TABLE_ROW &r) const
 
bool operator!= (const LIB_TABLE_ROW &r) const
 
const wxString & GetNickName () const
 Function GetNickName. More...
 
void SetNickName (const wxString &aNickName)
 Function SetNickName. More...
 
virtual const wxString GetType () const =0
 Function GetType. More...
 
virtual void SetType (const wxString &aType)=0
 Function SetType. More...
 
const wxString GetFullURI (bool aSubstituted=false) const
 Function GetFullURI. More...
 
void SetFullURI (const wxString &aFullURI)
 Function SetFullURI. More...
 
const wxString & GetOptions () const
 Function GetOptions. More...
 
void SetOptions (const wxString &aOptions)
 Function SetOptions. More...
 
const wxString & GetDescr () const
 Function GetDescr. More...
 
void SetDescr (const wxString &aDescr)
 Function SetDescr. More...
 
const PROPERTIESGetProperties () const
 Function GetProperties. More...
 
void Format (OUTPUTFORMATTER *out, int nestLevel) const
 Function Format. More...
 
LIB_TABLE_ROWclone () const
 

Static Public Member Functions

static void Parse (std::unique_ptr< LIB_TABLE_ROW > &aRow, LIB_TABLE_LEXER *in)
 

Protected Member Functions

 LIB_TABLE_ROW (const LIB_TABLE_ROW &aRow)
 
void operator= (const LIB_TABLE_ROW &aRow)
 

Private Member Functions

virtual LIB_TABLE_ROWdo_clone () const =0
 
void setProperties (PROPERTIES *aProperties)
 

Private Attributes

wxString nickName
 
wxString uri_user
 what user entered from UI or loaded from disk More...
 
wxString options
 
wxString description
 
std::unique_ptr< PROPERTIESproperties
 

Detailed Description

Class LIB_TABLE_ROW.

holds a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE. This is an abstract base class from which to derive library specific rows.

Definition at line 71 of file lib_table_base.h.

Constructor & Destructor Documentation

LIB_TABLE_ROW::LIB_TABLE_ROW ( )
inline

Definition at line 74 of file lib_table_base.h.

75  {
76  }
virtual LIB_TABLE_ROW::~LIB_TABLE_ROW ( )
inlinevirtual

Definition at line 78 of file lib_table_base.h.

79  {
80  }
LIB_TABLE_ROW::LIB_TABLE_ROW ( const wxString &  aNick,
const wxString &  aURI,
const wxString &  aOptions,
const wxString &  aDescr = wxEmptyString 
)
inline

Definition at line 82 of file lib_table_base.h.

References properties, SetFullURI(), and SetOptions().

83  :
84  nickName( aNick ),
85  description( aDescr )
86  {
87  properties.reset();
88  SetOptions( aOptions );
89  SetFullURI( aURI );
90  }
std::unique_ptr< PROPERTIES > properties
wxString description
void SetFullURI(const wxString &aFullURI)
Function SetFullURI.
void SetOptions(const wxString &aOptions)
Function SetOptions.
wxString nickName
LIB_TABLE_ROW::LIB_TABLE_ROW ( const LIB_TABLE_ROW aRow)
inlineprotected

Definition at line 197 of file lib_table_base.h.

References properties.

197  :
198  nickName( aRow.nickName ),
199  uri_user( aRow.uri_user ),
200 #if !FP_LATE_ENVVAR
201  uri_expanded( aRow.uri_expanded ),
202 #endif
203  options( aRow.options ),
204  description( aRow.description )
205  {
206  if( aRow.properties )
207  properties.reset( new PROPERTIES( *aRow.properties.get() ) );
208  else
209  properties.reset();
210  }
std::vector< PROPERTY > PROPERTIES
Definition: specctra.h:184
std::unique_ptr< PROPERTIES > properties
wxString description
wxString options
wxString nickName
wxString uri_user
what user entered from UI or loaded from disk

Member Function Documentation

LIB_TABLE_ROW* LIB_TABLE_ROW::clone ( ) const
inline

Definition at line 191 of file lib_table_base.h.

References do_clone().

Referenced by new_clone().

192  {
193  return do_clone();
194  }
virtual LIB_TABLE_ROW * do_clone() const =0
virtual LIB_TABLE_ROW* LIB_TABLE_ROW::do_clone ( ) const
privatepure virtual

Implemented in FP_LIB_TABLE_ROW, and SYMBOL_LIB_TABLE_ROW.

Referenced by clone().

void LIB_TABLE_ROW::Format ( OUTPUTFORMATTER out,
int  nestLevel 
) const

Function Format.

serializes this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.

Parameters
outis an OUTPUTFORMATTER
nestLevelis the indentation level to base all lines of the output. Actual indentation will be 2 spaces for each nestLevel.

Definition at line 83 of file lib_table_base.cpp.

References OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

84 {
85  // In Kicad, we save path and file names using the Unix notation (separator = '/')
86  // So ensure separator is always '/' is saved URI string
87  wxString uri = GetFullURI();
88  uri.Replace( '\\', '/' );
89 
90  out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s))\n",
91  out->Quotew( GetNickName() ).c_str(),
92  out->Quotew( GetType() ).c_str(),
93  out->Quotew( uri ).c_str(),
94  out->Quotew( GetOptions() ).c_str(),
95  out->Quotew( GetDescr() ).c_str()
96  );
97 }
const wxString & GetOptions() const
Function GetOptions.
virtual const wxString GetType() const =0
Function GetType.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:486
const wxString & GetDescr() const
Function GetDescr.
const wxString & GetNickName() const
Function GetNickName.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
const wxString& LIB_TABLE_ROW::GetDescr ( ) const
inline

Function GetDescr.

returns the description of the library referenced by this row.

Definition at line 160 of file lib_table_base.h.

References description.

Referenced by LIB_TABLE::GetDescription(), and LIB_TABLE_GRID::GetValue().

160 { return description; }
wxString description
const wxString LIB_TABLE_ROW::GetFullURI ( bool  aSubstituted = false) const

Function GetFullURI.

returns the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.

Parameters
aSubstitutedTells if caller wanted the substituted form, else not.

Definition at line 67 of file lib_table_base.cpp.

References LIB_TABLE::ExpandSubstitutions().

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIB_TABLE::DeleteAlias(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_TABLE_GRID::GetValue(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SYMBOL_LIB_TABLE::LoadSymbol(), FP_LIB_TABLE::PrefetchLib(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_LIB_TABLE::SaveSymbol(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and FOOTPRINT_EDIT_FRAME::updateTitle().

68 {
69  if( aSubstituted )
70  {
71 #if !FP_LATE_ENVVAR // early expansion
72  return uri_expanded;
73 
74 #else // late expansion
76 #endif
77  }
78 
79  return uri_user;
80 }
static const wxString ExpandSubstitutions(const wxString &aString)
Function ExpandSubstitutions.
wxString uri_user
what user entered from UI or loaded from disk
const wxString& LIB_TABLE_ROW::GetNickName ( ) const
inline

Function GetNickName.

Returns
the logical name of this library table row.

Definition at line 101 of file lib_table_base.h.

References nickName.

Referenced by FP_LIB_TABLE::FootprintLoad(), LIB_TABLE_GRID::GetValue(), LIB_TABLE::InsertRow(), SYMBOL_LIB_TABLE::LoadSymbol(), DIALOG_FP_LIB_TABLE::optionsEditor(), and DIALOG_SYMBOL_REMAP::remapSymbolToLibTable().

101 { return nickName; }
wxString nickName
const wxString& LIB_TABLE_ROW::GetOptions ( ) const
inline

Function GetOptions.

returns the options string, which may hold a password or anything else needed to instantiate the underlying LIB_SOURCE.

Definition at line 148 of file lib_table_base.h.

References options.

Referenced by LIB_TABLE_GRID::GetValue(), and DIALOG_FP_LIB_TABLE::optionsEditor().

148 { return options; }
wxString options
virtual const wxString LIB_TABLE_ROW::GetType ( ) const
pure virtual

Function GetType.

is a pure virtual function that returns the type of LIB represented by this row.

Implemented in FP_LIB_TABLE_ROW, and SYMBOL_LIB_TABLE_ROW.

Referenced by LIB_TABLE_GRID::GetValue(), and DIALOG_FP_LIB_TABLE::optionsEditor().

bool LIB_TABLE_ROW::operator!= ( const LIB_TABLE_ROW r) const
inline

Definition at line 94 of file lib_table_base.h.

94 { return !( *this == r ); }
void LIB_TABLE_ROW::operator= ( const LIB_TABLE_ROW aRow)
protected
bool LIB_TABLE_ROW::operator== ( const LIB_TABLE_ROW r) const

Definition at line 201 of file lib_table_base.cpp.

References description, nickName, options, and uri_user.

Referenced by FP_LIB_TABLE_ROW::operator==(), and SYMBOL_LIB_TABLE_ROW::operator==().

202 {
203  return nickName == r.nickName
204  && uri_user == r.uri_user
205  && options == r.options
206  && description == r.description;
207 }
wxString description
wxString options
wxString nickName
wxString uri_user
what user entered from UI or loaded from disk
void LIB_TABLE_ROW::Parse ( std::unique_ptr< LIB_TABLE_ROW > &  aRow,
LIB_TABLE_LEXER in 
)
static

Definition at line 100 of file lib_table_base.cpp.

References DSNLEXER::Duplicate(), DSNLEXER::Expecting(), DSNLEXER::FromUTF8(), DSNLEXER::NeedLEFT(), DSNLEXER::NeedRIGHT(), LIB_TABLE_LEXER::NeedSYMBOLorNUMBER(), LIB_TABLE_LEXER::NextTok(), LIB_TABLE_T::T_descr, LIB_TABLE_T::T_EOF, LIB_TABLE_T::T_LEFT, LIB_TABLE_T::T_lib, LIB_TABLE_T::T_name, LIB_TABLE_T::T_options, LIB_TABLE_T::T_RIGHT, LIB_TABLE_T::T_type, LIB_TABLE_T::T_uri, and DSNLEXER::Unexpected().

101 {
102  /*
103  * (lib (name NICKNAME)(descr DESCRIPTION)(type TYPE)(full_uri FULL_URI)(options OPTIONS))
104  *
105  * Elements after (name) are order independent.
106  */
107 
108  T tok = in->NextTok();
109 
110  if( tok != T_lib )
111  in->Expecting( T_lib );
112 
113  // (name NICKNAME)
114  in->NeedLEFT();
115 
116  if( ( tok = in->NextTok() ) != T_name )
117  in->Expecting( T_name );
118 
119  in->NeedSYMBOLorNUMBER();
120 
121  aRow->SetNickName( in->FromUTF8() );
122 
123  in->NeedRIGHT();
124 
125  // After (name), remaining (lib) elements are order independent, and in
126  // some cases optional.
127  bool sawType = false;
128  bool sawOpts = false;
129  bool sawDesc = false;
130  bool sawUri = false;
131 
132  while( ( tok = in->NextTok() ) != T_RIGHT )
133  {
134  if( tok == T_EOF )
135  in->Unexpected( T_EOF );
136 
137  if( tok != T_LEFT )
138  in->Expecting( T_LEFT );
139 
140  tok = in->NeedSYMBOLorNUMBER();
141 
142  switch( tok )
143  {
144  case T_uri:
145  if( sawUri )
146  in->Duplicate( tok );
147  sawUri = true;
148  in->NeedSYMBOLorNUMBER();
149  // Saved path and file names use the Unix notation (separator = '/')
150  // However old files, and files edited by hands can use the woindows
151  // separator. Force the unix notation
152  // (It works on windows, and moreover, wxFileName and wxDir takes care to that
153  // on windows)
154  // moreover, URLs use the '/' as separator
155  {
156  wxString uri = in->FromUTF8();
157  uri.Replace( '\\', '/' );
158  aRow->SetFullURI( uri );
159  }
160  break;
161 
162  case T_type:
163  if( sawType )
164  in->Duplicate( tok );
165  sawType = true;
166  in->NeedSYMBOLorNUMBER();
167  aRow->SetType( in->FromUTF8() );
168  break;
169 
170  case T_options:
171  if( sawOpts )
172  in->Duplicate( tok );
173  sawOpts = true;
174  in->NeedSYMBOLorNUMBER();
175  aRow->SetOptions( in->FromUTF8() );
176  break;
177 
178  case T_descr:
179  if( sawDesc )
180  in->Duplicate( tok );
181  sawDesc = true;
182  in->NeedSYMBOLorNUMBER();
183  aRow->SetDescr( in->FromUTF8() );
184  break;
185 
186  default:
187  in->Unexpected( tok );
188  }
189 
190  in->NeedRIGHT();
191  }
192 
193  if( !sawType )
194  in->Expecting( T_type );
195 
196  if( !sawUri )
197  in->Expecting( T_uri );
198 }
T
enum T contains all this lexer's tokens.
void Unexpected(int aTok)
Function Unexpected throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:369
wxString FromUTF8()
Function FromUTF8 returns the current token text as a wxString, assuming that the input byte stream i...
Definition: dsnlexer.h:498
void NeedLEFT()
Function NeedLEFT calls NextTok() and then verifies that the token read in is a DSN_LEFT.
Definition: dsnlexer.cpp:393
LIB_TABLE_T::T NeedSYMBOLorNUMBER()
Function NeedSYMBOLorNUMBER calls NextTok() and then verifies that the token read in satisfies bool I...
void Expecting(int aTok)
Function Expecting throws an IO_ERROR exception with an input file specific error message...
Definition: dsnlexer.cpp:353
LIB_TABLE_T::T NextTok()
Function NextTok returns the next token found in the input file or T_EOF when reaching the end of fil...
void Duplicate(int aTok)
Function Duplicate throws an IO_ERROR exception with a message saying specifically that aTok is a dup...
Definition: dsnlexer.cpp:377
void NeedRIGHT()
Function NeedRIGHT calls NextTok() and then verifies that the token read in is a DSN_RIGHT.
Definition: dsnlexer.cpp:401
void LIB_TABLE_ROW::SetDescr ( const wxString &  aDescr)
inline

Function SetDescr.

changes the description of the library referenced by this row.

Definition at line 167 of file lib_table_base.h.

References description.

Referenced by LIB_TABLE_GRID::SetValue().

167 { description = aDescr; }
wxString description
void LIB_TABLE_ROW::SetFullURI ( const wxString &  aFullURI)

Function SetFullURI.

changes the full URI for the library.

Definition at line 57 of file lib_table_base.cpp.

References LIB_TABLE::ExpandSubstitutions().

Referenced by LIB_TABLE_ROW(), and LIB_TABLE_GRID::SetValue().

58 {
59  uri_user = aFullURI;
60 
61 #if !FP_LATE_ENVVAR
62  uri_expanded = FP_LIB_TABLE::ExpandSubstitutions( aFullURI );
63 #endif
64 }
static const wxString ExpandSubstitutions(const wxString &aString)
Function ExpandSubstitutions.
wxString uri_user
what user entered from UI or loaded from disk
void LIB_TABLE_ROW::SetNickName ( const wxString &  aNickName)
inline

Function SetNickName.

changes the logical name of this library, useful for an editor.

Definition at line 108 of file lib_table_base.h.

References nickName.

Referenced by LIB_TABLE_GRID::SetValue().

108 { nickName = aNickName; }
wxString nickName
void LIB_TABLE_ROW::SetOptions ( const wxString &  aOptions)

Function SetOptions.

Definition at line 210 of file lib_table_base.cpp.

References LIB_TABLE::ParseOptions(), and TO_UTF8.

Referenced by LIB_TABLE_ROW(), DIALOG_FP_LIB_TABLE::optionsEditor(), and LIB_TABLE_GRID::SetValue().

211 {
212  options = aOptions;
213 
214  // set PROPERTIES* from options
216 }
void setProperties(PROPERTIES *aProperties)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
static PROPERTIES * ParseOptions(const std::string &aOptionsList)
Function ParseOptions.
wxString options
void LIB_TABLE_ROW::setProperties ( PROPERTIES aProperties)
private

Definition at line 51 of file lib_table_base.cpp.

52 {
53  properties.reset( aProperties );
54 }
std::unique_ptr< PROPERTIES > properties
virtual void LIB_TABLE_ROW::SetType ( const wxString &  aType)
pure virtual

Function SetType.

is a pure virtual function changes the type represented by this row that must be implemented in the derived object to provide the library table row type.

Implemented in FP_LIB_TABLE_ROW, and SYMBOL_LIB_TABLE_ROW.

Referenced by LIB_TABLE_GRID::SetValue().

Member Data Documentation

wxString LIB_TABLE_ROW::description
private

Definition at line 227 of file lib_table_base.h.

Referenced by GetDescr(), operator==(), and SetDescr().

wxString LIB_TABLE_ROW::nickName
private

Definition at line 219 of file lib_table_base.h.

Referenced by GetNickName(), operator==(), and SetNickName().

wxString LIB_TABLE_ROW::options
private

Definition at line 226 of file lib_table_base.h.

Referenced by GetOptions(), and operator==().

std::unique_ptr< PROPERTIES > LIB_TABLE_ROW::properties
private

Definition at line 229 of file lib_table_base.h.

Referenced by GetProperties(), and LIB_TABLE_ROW().

wxString LIB_TABLE_ROW::uri_user
private

what user entered from UI or loaded from disk

Definition at line 220 of file lib_table_base.h.

Referenced by operator==().


The documentation for this class was generated from the following files: