114 lines
3.4 KiB
C++
114 lines
3.4 KiB
C++
/*
|
|
* This program source code file is part of KICAD, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
|
|
#ifndef SCH_PART_H_
|
|
#define SCH_PART_H_
|
|
|
|
#include <sch_lib.h>
|
|
|
|
|
|
namespace SCH {
|
|
|
|
/**
|
|
* Class PART
|
|
* will have to be unified with what Wayne is doing. I want a separate copy
|
|
|
|
* here until I can get the state management correct. Since a PART only lives
|
|
* within a cache called a LIB, its constructor is private (only a LIB
|
|
* can instantiate one), and it exists in various states of freshness and
|
|
* completeness relative to the LIB_SOURCE within the LIB.
|
|
*/
|
|
class PART
|
|
{
|
|
/// LIB class has great license to modify what's in here, nobody else does.
|
|
/// Modification is done through the LIB so it can track the state of the
|
|
/// PART and take action as needed. Actually most of the modification will
|
|
/// be done by PARTS_LIST, a class derived from LIB.
|
|
friend class LIB;
|
|
|
|
|
|
/// a private constructor, only a LIB can instantiate a PART.
|
|
PART() {}
|
|
|
|
|
|
protected: // not likely to have C++ descendants, but protected none-the-less.
|
|
|
|
bool parsed; ///< true if the body as been parsed already.
|
|
|
|
LIB* owner; ///< which LIB am I a part of (pun if you want)
|
|
STRING extends; ///< LPID of base part
|
|
|
|
STRING name; ///< example "passives/R", immutable.
|
|
|
|
/// s-expression text for the part, initially empty, and read in as this part
|
|
/// actually becomes cached in RAM.
|
|
STRING body;
|
|
|
|
// 3 separate lists for speed:
|
|
|
|
/// A property list.
|
|
//PROPERTIES properties;
|
|
|
|
/// A drawing list for graphics
|
|
//DRAWINGS drawings;
|
|
|
|
/// A pin list
|
|
//PINS pins;
|
|
|
|
/// Alternate body forms.
|
|
//ALTERNATES alternates;
|
|
|
|
// lots of other stuff, like the mandatory properties.
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
* Function Inherit
|
|
* is a specialized assignment function that copies a specific subset, enough
|
|
* to fulfill the requirements of the Sweet s-expression language.
|
|
*/
|
|
void Inherit( const PART& aBasePart );
|
|
|
|
|
|
/**
|
|
* Function Owner
|
|
* returns the LIB* owner of this part.
|
|
*/
|
|
LIB* Owner() { return owner; }
|
|
|
|
/**
|
|
* Function Parse
|
|
* translates the \a body string into a binary form that is represented
|
|
* by the normal fields of this class. Parse is expected to call Inherit()
|
|
* if this part extends any other.
|
|
*/
|
|
void Parse( LIB* aLexer ) throw( PARSE_ERROR );
|
|
|
|
};
|
|
|
|
} // namespace PART
|
|
|
|
#endif // SCH_PART_
|