more free SWEET software

new/make-dir-lib-source-test-data.sh

@@ -56,6 +56,28 @@ PIN2="
         (padname A24 (font (size 0.9 1.1) italic bold) (visible yes))
     )"
 
+PIN3="
+    (pin (padname A25))"
+
+PINS="
+    (pin (padname Z12))(pin (padname Y14))(pin (padname Z13))(pin (padname Y15))"
+
+
+PIN_SWAP="
+    (pin_swap A23 A24)"
+
+PIN_RENUM="
+    (pin_renum A24 B24)"
+
+PIN_RENAME="
+    (pin_rename #WE LED)"
+
+PIN_DELETE="
+    (pin_del B24)"
+
+PIN_MERGE="(pin_merge A23 (hide Z12 Y14))(pin_merge A25 (hide Z13 Y15))"
+
+
 PROP1="
     (property mWatts 12
         (effects (at 1 34 270)(font (size .5 1) italic bold)(visible no))
@@ -64,6 +86,10 @@ PROP1="
 KEYWORDS="
     (keywords varistor batcave einstein)"
 
+ALTERNATES="
+    (alternates 7400/7400_b 7400/7400_c)"
+
+
 
 for C in ${CATEGORIES}; do
 
@@ -81,8 +107,16 @@ for C in ${CATEGORIES}; do
                 $TEXT
                 $PIN1
                 $PIN2
+                $PIN3
+                $PINS
                 $PROP1
                 $KEYWORDS
+                $ALTERNATES
+                $PIN_SWAP
+                $PIN_RENUM
+                $PIN_RENAME
+                $PIN_DELETE
+                $PIN_MERGE
                 )" > $BASEDIR/$C/$P.part.$R
         done
         # also make the part without a rev:
@@ -96,8 +130,16 @@ for C in ${CATEGORIES}; do
             $TEXT
             $PIN1
             $PIN2
+            $PIN3
+            $PINS
             $PROP1
             $KEYWORDS
+            $ALTERNATES
+            $PIN_SWAP
+            $PIN_RENUM
+            $PIN_RENAME
+            $PIN_DELETE
+            $PIN_MERGE
             )" > $BASEDIR/$C/$P.part
     done
 done

new/sch_lpid.cpp

@@ -123,13 +123,19 @@ static int okRevision( const STRING& aField )
 //----</Policy and field test functions>-------------------------------------
 
 
-int LPID::Parse( const STRING& aLPID )
+void LPID::clear()
 {
     logical.clear();
     category.clear();
     baseName.clear();
     partName.clear();
     revision.clear();
+}
+
+
+int LPID::Parse( const STRING& aLPID )
+{
+    clear();
 
     const char* rev = EndsWithRev( aLPID );
     size_t      revNdx;

new/sch_lpid.h

@@ -30,6 +30,7 @@
 
 namespace SCH {
 
+
 /**
  * Class LPID
  * (aka GUID) is a Logical Part ID and consists of various portions much like a URI.
@@ -196,6 +197,7 @@ public:
     static STRING Format( const STRING& aLogicalLib, const STRING& aPartName, const STRING& aRevision="" )
         throw( PARSE_ERROR );
 
+    void clear();
 
 #if defined(DEBUG)
     static void Test();

new/sch_part.cpp

@@ -34,7 +34,7 @@
 
 /**
  * Function formatAt
- * returns a formatted "(at X Y [ANGLE])" s-expression
+ * outputs a formatted "(at X Y [ANGLE])" s-expression
  */
 static void formatAt( OUTPUTFORMATTER* out, const POINT& aPos, ANGLE aAngle, int indent=0 )
     throw( IO_ERROR )
@@ -72,6 +72,18 @@ void PART::clear()
         extends = 0;
     }
 
+    // clear the mandatory fields
+    for( int ndx = REFERENCE;  ndx < END;  ++ndx )
+    {
+        delete mandatory[ndx];
+        mandatory[ndx] = 0;
+    }
+
+    // delete properties I own, since their container will not destroy them:
+    for( PROPERTIES::iterator it = properties.begin();  it != properties.end();  ++it )
+        delete *it;
+    properties.clear();
+
     // delete graphics I own, since their container will not destroy them:
     for( GRAPHICS::iterator it = graphics.begin();  it != graphics.end();  ++it )
         delete *it;
@@ -82,21 +94,13 @@ void PART::clear()
         delete *it;
     pins.clear();
 
-    // delete properties I own, since their container will not destroy them:
-    for( PROPERTIES::iterator it = properties.begin();  it != properties.end();  ++it )
-        delete *it;
-    properties.clear();
+    alternates.clear();
 
     keywords.clear();
 
-    contains = 0;
+    pin_merges.clear();
 
-    // clear the mandatory fields
-    for( int ndx = REFERENCE;  ndx < END;  ++ndx )
-    {
-        delete mandatory[ndx];
-        mandatory[ndx] = 0;
-    }
+    contains = 0;
 }
 
 
@@ -141,6 +145,49 @@ PROPERTY* PART::FieldLookup( PROP_ID aPropertyId )
     return p;
 }
 
+PINS::iterator PART::pinFindByPadName( const wxString& aPadName )
+{
+    PINS::iterator it;
+
+    for( it = pins.begin();  it != pins.end();  ++it )
+    {
+        if( (*it)->padname.text == aPadName )
+            break;
+    }
+
+    return it;
+}
+
+
+PINS::iterator PART::pinFindBySignal( const wxString& aSignal )
+{
+    PINS::iterator it;
+
+    for( it = pins.begin();  it != pins.end();  ++it )
+    {
+        if( (*it)->signal.text == aSignal )
+            break;
+    }
+
+    return it;
+}
+
+
+bool PART::PinDelete( const wxString& aPadName )
+{
+    PINS::iterator it = pinFindByPadName( aPadName );
+    if( it != pins.end() )
+    {
+        delete *it;
+        pins.erase( it );
+        return true;
+    }
+
+    // there is only one reason this can fail: not found:
+    return false;
+}
+
+
 
 PART::~PART()
 {
@@ -185,19 +232,17 @@ void PART::Parse( SWEET_PARSER* aParser , LIB_TABLE* aTable ) throw( IO_ERROR, P
 }
 
 
-void PART::PropertyDelete( const wxString& aPropertyName ) throw( IO_ERROR )
+bool PART::PropertyDelete( const wxString& aPropertyName )
 {
     PROPERTIES::iterator it = propertyFind( aPropertyName );
-    if( it == properties.end() )
+    if( it != properties.end() )
     {
-        wxString    msg;
-        msg.Printf( _( "Unable to find property: %s" ), aPropertyName.GetData() );
-        THROW_IO_ERROR( msg );
+        delete *it;
+        properties.erase( it );
+        return true;
     }
 
-    delete *it;
-    properties.erase( it );
-    return;
+    return false;
 }
 
 
@@ -258,6 +303,26 @@ void PART::Format( OUTPUTFORMATTER* out, int indent, int ctl ) const
         (*it)->Format( out, indent+1, ctl );
     }
 
+    if( alternates.size() )
+    {
+        out->Print( indent+1, "(alternates" );
+        for( PART_REFS::const_iterator it = alternates.begin();  it!=alternates.end();  ++it )
+            out->Print( 0, " %s", out->Quotes( it->Format() ).c_str() );
+        out->Print( 0, ")\n" );
+    }
+
+    for( MERGE_SETS::const_iterator mit = pin_merges.begin();  mit != pin_merges.end();  ++mit )
+    {
+        out->Print( indent+1, "(pin_merge %s (hide", out->Quotew( mit->first ).c_str() );
+
+        const MERGE_SET& mset = *mit->second;
+        for( MERGE_SET::const_iterator pit = mset.begin();  pit != mset.end();  ++pit )
+        {
+            out->Print( 0, " %s", out->Quotew( *pit ).c_str() );
+        }
+        out->Print( 0, "))\n" );
+    }
+
     out->Print( indent, ")\n" );
 }
 
@@ -349,18 +414,30 @@ void FONT::Format( OUTPUTFORMATTER* out, int indent, int ctl ) const
 void PIN::Format( OUTPUTFORMATTER* out, int indent, int ctl ) const
     throw( IO_ERROR )
 {
+    bool    hasSignal  = !signal.text.IsEmpty();
+    bool    hasPadName = !padname.text.IsEmpty();
+
     out->Print( indent, "(pin %s %s ", ShowType(), ShowShape() );
 
     formatAt( out, pos, angle );
     out->Print( 0, "(length %.6g)", InternalToLogical( length ) );
     out->Print( 0, "(visible %s)\n", isVisible ? "yes" : "no" );
 
-    signal.Format(  out, "signal",  indent+1, 0 );
-    padname.Format( out, "padname", indent+1, CTL_OMIT_NL );
+    if( hasSignal )
+        signal.Format(  out, "signal",  indent+1, hasPadName ? 0 : CTL_OMIT_NL );
+
+    if( hasPadName )
+        padname.Format( out, "padname", indent+1, CTL_OMIT_NL );
+
     out->Print( 0, ")\n" );
 }
 
 
+PIN::~PIN()
+{
+}
+
+
 void PINTEXT::Format( OUTPUTFORMATTER* out, const char* aElement, int indent, int ctl ) const
     throw( IO_ERROR )
 {

new/sch_part.h

@@ -27,6 +27,10 @@
 #define SCH_PART_H_
 
 #include <sch_lib.h>
+#include <sch_lib_table.h>
+#include <sch_lpid.h>
+//#include <boost/ptr_container/ptr_vector.hpp>
+#include <boost/ptr_container/ptr_map.hpp>
 
 
 #define INTERNAL_PER_LOGICAL        10000   ///< no. internal units per logical unit
@@ -89,6 +93,13 @@ class PROPERTY;
 
 };
 
+/// a set of pin padnames that are electrically equivalent for a PART.
+typedef std::set< wxString >            MERGE_SET;
+
+/// The key is the VISIBLE_PIN from
+/// (pin_merge VISIBLE_PIN (hide HIDDEN_PIN1 HIDDEN_PIN2...))
+typedef boost::ptr_map< wxString, MERGE_SET >  MERGE_SETS;
+
 
 class POINT : public wxPoint
 {
@@ -156,11 +167,13 @@ class BASE_GRAPHIC
     friend class SWEET_PARSER;
 
 protected:
-    PART*   owner;
+    PART*       owner;
+    PART*       birthplace;         ///< at which PART in inheritance chain was 'this' added
 
 public:
     BASE_GRAPHIC( PART* aOwner ) :
-        owner( aOwner )
+        owner( aOwner ),
+        birthplace( aOwner )
     {}
 
     virtual ~BASE_GRAPHIC() {}
@@ -342,7 +355,6 @@ class PROPERTY : public BASE_GRAPHIC
     friend class SWEET_PARSER;
 
 protected:
-    PART*           birthplace;     ///< at which PART in inheritance chain was this PROPERTY added
     wxString        name;
     wxString        text;
     TEXT_EFFECTS*   effects;
@@ -359,7 +371,6 @@ protected:
 public:
     PROPERTY( PART* aOwner, const wxChar* aName = wxT( "" ) ) :
         BASE_GRAPHIC( aOwner ),
-        birthplace( aOwner ),
         name( aName ),
         effects( 0 )
     {}
@@ -410,7 +421,6 @@ class PIN : public BASE_GRAPHIC
 public:
     PIN( PART* aOwner ) :
         BASE_GRAPHIC( aOwner ),
-        birthplace( aOwner ),
         angle( 0 ),
         connectionType( PR::T_input ),
         shape( PR::T_line ),
@@ -418,6 +428,8 @@ public:
         isVisible( true )
     {}
 
+    ~PIN();
+
     const char* ShowType() const
     {
         return SWEET_LEXER::TokenName( PR::T( connectionType ) );
@@ -432,7 +444,6 @@ public:
         throw( IO_ERROR );
 
 protected:
-    PART*       birthplace;         ///< at which PART in inheritance chain was this PIN added
     POINT       pos;
     ANGLE       angle;
 
@@ -448,8 +459,58 @@ protected:
     int         length;             ///< length of pin in internal units
     bool        isVisible;          ///< pin is visible
 
+    wxString    pin_merge;          ///< padname of (pin_merge ...) that I am a member of, else empty if none
+};
+
+
+/**
+ * Class PART_REF
+ * is an LPID with a pointer to the "looked up" PART, which is looked up lazily.
+ */
+class PART_REF : public LPID
+{
+public:
+    PART_REF() :
+        LPID(),
+        part(0)
+    {}
+
+    /**
+     * Constructor LPID
+     * takes aLPID string and parses it.  A typical LPID string uses a logical
+     * library name followed by a part name.
+     * e.g.: "kicad:passives/R/rev2", or
+     * e.g.: "mylib:R33"
+     */
+    PART_REF( const STRING& aLPID ) throw( PARSE_ERROR ) :
+        LPID( aLPID ),
+        part(0)
+    {
+    }
+
+
+    /**
+     * Function Lookup
+     * returns the PART that this LPID refers to.  Never returns NULL, because
+     * instead an exception would be thrown.
+     * @throw IO_ERROR if any problem occurs or if the part cannot be found.
+     */
+    PART* Lookup( LIB_TABLE* aLibTable, LIB* aFallBackLib ) throw( IO_ERROR )
+    {
+        if( !part )
+        {
+            part = aLibTable->LookupPart( *this, aFallBackLib );
+        }
+        return part;
+    }
+
+protected:
+    PART*   part;               ///< The looked-up PART,
+                                ///< no ownership (duh, PARTs are always owned by a LIB)
 };
 
+typedef std::vector<PART_REF>   PART_REFS;
+
 
 }  // namespace SCH
 
@@ -457,12 +518,15 @@ protected:
 //-----</temporary home for PART sub objects, move after stable>-----------------
 
 
+typedef std::set< wxString >            KEYWORDS;
+
 namespace SCH {
 
 typedef std::vector< BASE_GRAPHIC* >    GRAPHICS;
-typedef std::vector< PIN* >             PINS;
 typedef std::vector< PROPERTY* >        PROPERTIES;
-typedef std::set< wxString >            KEYWORDS;
+
+typedef std::vector< PIN* >             PINS;
+
 
 class LPID;
 class SWEET_PARSER;
@@ -533,7 +597,12 @@ public:
     void Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aControlBits = 0 ) const
         throw( IO_ERROR );
 
-    void PropertyDelete( const wxString& aPropertyName ) throw( IO_ERROR );
+    /**
+     * Function PropertyDelete
+     * deletes the property with aPropertyName if found and returns true, else false
+     * if not found.
+     */
+    bool PropertyDelete( const wxString& aPropertyName );
 
     /**
      * Function Field
@@ -554,6 +623,31 @@ public:
      */
     PROPERTY*   FieldLookup( PROP_ID aPropertyId );
 
+    /**
+     * Function PinFindByPadName
+     * finds a PIN based on aPadName or returns NULL if not found.
+     * @param aPadName is the pin to find
+     * @return PIN* - the found PIN or NULL if not found.
+     */
+    PIN*        PinFindByPadName( const wxString& aPadName )
+    {
+        PINS::iterator it = pinFindByPadName( aPadName );
+        return it != pins.end() ? *it : NULL;
+    }
+
+    PIN*        PinFindBySignal( const wxString& aSignal )
+    {
+        PINS::iterator it = pinFindBySignal( aSignal );
+        return it != pins.end() ? *it : NULL;
+    }
+
+    /**
+     * Function PinDelete
+     * deletes the pin with aPadName if found and returns true, else false
+     * if not found.
+     */
+    bool PinDelete( const wxString& aPadName );
+
 
 /*
     void SetValue( const wxString& aValue )
@@ -619,6 +713,15 @@ protected:      // not likely to have C++ descendants, but protected none-the-le
      */
     PROPERTIES::iterator propertyFind( const wxString& aPropertyName );
 
+    /**
+     * Function pinFindByPadName
+     * searches for a PIN with aPadName and returns a PROPERTIES::iterator which
+     * is the found item or pins.end() if not found.
+     */
+    PINS::iterator pinFindByPadName( const wxString& aPadName );
+    PINS::iterator pinFindBySignal( const wxString& aSignal );
+
+
     POINT           anchor;
 
     //PART( LIB* aOwner );
@@ -638,18 +741,9 @@ protected:      // not likely to have C++ descendants, but protected none-the-le
     /// actually becomes cached in RAM.
     STRING          body;
 
-    // mandatory properties
+    /// mandatory properties, aka fields.  Index into mandatory[] is PROP_ID.
     PROPERTY*       mandatory[END];
 
-/*
-    PROPERTY        value;
-    PROPERTY        footprint;
-    PROPERTY        model;
-    PROPERTY        datasheet;
-*/
-
-    // separate lists for speed:
-
     /**
      * Member properties
      * holds the non-mandatory properties.
@@ -669,10 +763,17 @@ protected:      // not likely to have C++ descendants, but protected none-the-le
     PINS            pins;
 
     /// Alternate body forms.
-    //ALTERNATES  alternates;
+    PART_REFS       alternates;
 
+    ///  searching aids
     KEYWORDS        keywords;
 
+    /**
+     * A pin_merge set is a set of pins that are all electrically equivalent
+     * and whose anchor pin is the only one visible.  The visible pin is the
+     * key in the MERGE_SETS boost::ptr_map::map
+     */
+    MERGE_SETS      pin_merges;
 };
 
 }   // namespace PART

new/sch_sweet_parser.h

@@ -75,14 +75,21 @@ class SWEET_PARSER : public SWEET_LEXER
     void parseCircle( CIRCLE* me );
     void parseArc( ARC* me );
     void parseText( GR_TEXT* me );
-    void parsePin( PIN* me );
     void parseAt( POINT* pos, float* angle );
     void parseBool( bool* aBool );
     void parseFont( FONT* me );
     void parsePinText( PINTEXT* me );
     void parseTextEffects( TEXT_EFFECTS* me );
     void parseKeywords( PART* me );
+    void parseAlternates( PART* me );
+    void parsePropertyDel( PART* me );
 
+    void parsePin( PIN* me );
+    void parsePinDel( PART* me );
+    void parsePinSwap( PART* me );
+    void parsePinRenum( PART* me );
+    void parsePinRename( PART* me );
+    void parsePinMerge( PART* me );
 
 public:
 

new/sweet.keywords

@@ -20,6 +20,7 @@ fill
 filled
 font
 footprint
+hide
 input
 input_low
 inverted