KiCad PCB EDA Suite
symbol_library.h File Reference

Definition for symbol library class. More...

#include <map>
#include <mutex>
#include <boost/ptr_container/ptr_vector.hpp>
#include <wx/filename.h>
#include <sch_io_mgr.h>
#include <project.h>

Go to the source code of this file.

Classes

class  SCHLIB_FILTER
 
struct  LibSymbolMapSort
 LIB_SYMBOL map sorting. More...
 
class  SYMBOL_LIBS
 A collection of SYMBOL_LIB objects. More...
 
class  SYMBOL_LIB
 Object used to load, save, search, and otherwise manipulate symbol library files. More...
 

Macros

#define DOC_EXT   "dcm"
 
#define LIB_VERSION_MAJOR   2
 
#define LIB_VERSION_MINOR   4
 
#define LIBFILE_IDENT   "EESchema-LIBRARY Version"
 
#define LIB_VERSION(major, minor)   ( major * 100 + minor )
 
#define IS_LIB_CURRENT_VERSION(major, minor)
 
#define USE_OLD_DOC_FILE_FORMAT(major, minor)   ( LIB_VERSION( major, minor ) <= LIB_VERSION( 2, 4 ) )
 

Typedefs

typedef std::map< wxString, LIB_SYMBOL *, LibSymbolMapSortLIB_SYMBOL_MAP
 Symbol map used by symbol library object. More...
 
typedef boost::ptr_vector< SYMBOL_LIBSYMBOL_LIBS_BASE
 

Enumerations

enum  SCH_LIB_TYPE { SCH_LIB_TYPE::LT_EESCHEMA, SCH_LIB_TYPE::LT_SYMBOL }
 

Functions

bool operator== (const SYMBOL_LIB &aLibrary, const wxString &aName)
 Case insensitive library name comparison. More...
 
bool operator!= (const SYMBOL_LIB &aLibrary, const wxString &aName)
 

Detailed Description

Definition for symbol library class.

Definition in file symbol_library.h.

Macro Definition Documentation

◆ DOC_EXT

#define DOC_EXT   "dcm"

Definition at line 50 of file symbol_library.h.

◆ IS_LIB_CURRENT_VERSION

#define IS_LIB_CURRENT_VERSION (   major,
  minor 
)
Value:
( \
LIB_VERSION( major1, minor1 ) == \
)
#define LIB_VERSION_MINOR
#define LIB_VERSION_MAJOR

Definition at line 63 of file symbol_library.h.

◆ LIB_VERSION

#define LIB_VERSION (   major,
  minor 
)    ( major * 100 + minor )

Definition at line 61 of file symbol_library.h.

◆ LIB_VERSION_MAJOR

#define LIB_VERSION_MAJOR   2

Definition at line 55 of file symbol_library.h.

◆ LIB_VERSION_MINOR

#define LIB_VERSION_MINOR   4

Definition at line 56 of file symbol_library.h.

◆ LIBFILE_IDENT

#define LIBFILE_IDENT   "EESchema-LIBRARY Version"

Definition at line 59 of file symbol_library.h.

◆ USE_OLD_DOC_FILE_FORMAT

#define USE_OLD_DOC_FILE_FORMAT (   major,
  minor 
)    ( LIB_VERSION( major, minor ) <= LIB_VERSION( 2, 4 ) )

Definition at line 75 of file symbol_library.h.

Typedef Documentation

◆ LIB_SYMBOL_MAP

typedef std::map< wxString, LIB_SYMBOL*, LibSymbolMapSort > LIB_SYMBOL_MAP

Symbol map used by symbol library object.

Definition at line 185 of file symbol_library.h.

◆ SYMBOL_LIBS_BASE

typedef boost::ptr_vector< SYMBOL_LIB > SYMBOL_LIBS_BASE

Definition at line 186 of file symbol_library.h.

Enumeration Type Documentation

◆ SCH_LIB_TYPE

enum SCH_LIB_TYPE
strong
Enumerator
LT_EESCHEMA 
LT_SYMBOL 

Definition at line 78 of file symbol_library.h.

Function Documentation

◆ operator!=()

bool operator!= ( const SYMBOL_LIB aLibrary,
const wxString &  aName 
)

◆ operator==()

bool operator== ( const SYMBOL_LIB aLibrary,
const wxString &  aName 
)

Case insensitive library name comparison.

Referenced by unfracture(), and SHAPE_POLY_SET::unfractureSingle().