easypc_classes_library.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.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, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef EASYPC_CLASSES_LIBRARY_H
#define EASYPC_CLASSES_LIBRARY_H
 
#include <memory>
#include <vector>
 
#include <wx/string.h>
#include <wx/arrstr.h> // for MSVC to see std::vector<wxString> is exported from wx
 
#include <io/easypc/easypc_classes_geometry.h>
 
 
namespace EASYPC
{

struct SELF_VERSIONED
{
    int Format = NEWEST_ITEM_FORMAT;
};
 

struct SOURCE_SYMBOL : SOURCE_DESIGN_ITEM, SELF_VERSIONED
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
    int       ItemFormat( const ARCHIVE& aAr ) const override { return Format; }
 
    wxString Name;
    OBJECT*  Shapes = nullptr; 
    OBJECT*  Pads = nullptr;   
    OBJECT*  Texts = nullptr;  
    OBJECT*  ValuePositions = nullptr;
    int32_t  OriginX = 0;
    int32_t  OriginY = 0;
    int32_t  Timestamp = 0;
    wxString Library;

    std::unique_ptr<OBJECT>                NameOrigin;
    std::unique_ptr<SOURCE_DESIGN_LIST>    DerivedValuePositions;
    std::unique_ptr<SOURCE_VALUE_POSITION> DerivedNamePosition;
};
 

struct SOURCE_PIN_NAME : SOURCE_TEXT_POSITION
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    bool Visible = true;
};
 

struct SOURCE_PIN_NAME_INSTANCE : SOURCE_DESIGN_ITEM
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    OBJECT* Definition = nullptr; 
    bool    Visible = true;
};
 

struct SOURCE_GATE : SOURCE_DESIGN_ITEM
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    wxString              Symbol;
    std::vector<wxString> PinNames; 
    wxString              Library;
};
 

struct SOURCE_DESIGN_ARRAY : OBJECT
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    OBJECT*              Parent = nullptr;
    std::vector<OBJECT*> Items;
};
 

const std::vector<OBJECT*>& ListItems( const OBJECT* aList );
 

template <typename T>
std::vector<T*> TypedItems( const OBJECT* aList )
{
    std::vector<T*> out;
 
    for( OBJECT* obj : ListItems( aList ) )
    {
        if( T* typed = dynamic_cast<T*>( obj ) )
            out.push_back( typed );
    }
 
    return out;
}
 

struct SOURCE_GATE_MAP : SOURCE_DESIGN_ITEM
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    OBJECT*              Pins = nullptr; 
    std::vector<int32_t> PcbSymbolPins;  
};
 
 
struct SOURCE_GATE_PIN : SOURCE_DESIGN_ITEM
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    bool IsNoConnect() const { return PinType & 0x1; }
 
    wxString PcbSymbolPin = wxS( "-1" ); 
    wxString PinNumber;
    wxString NetName; 
    uint32_t PinType = 0;
};
 
 
struct SOURCE_SCM_COMPONENT : SOURCE_DESIGN_ITEM, SELF_VERSIONED
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
    int       ItemFormat( const ARCHIVE& aAr ) const override { return Format; }
 
    wxString Name;
    wxString Package;
    OBJECT*  Gates = nullptr;
    wxString DefaultReference;
    wxString Description;
    wxString Library;
    uint32_t SuppressionFlags = 0;
};
 

struct SOURCE_PCB_COMPONENT : SOURCE_DESIGN_ITEM, SELF_VERSIONED
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
    int       ItemFormat( const ARCHIVE& aAr ) const override { return Format; }
 
    wxString Package;
    wxString Symbol;             
    OBJECT*  GateMaps = nullptr; 
    wxString Library;
};
 
 
struct SOURCE_COMPONENT : SOURCE_DESIGN_ITEM
{
    LOAD_TASK Load( ARCHIVE& aAr ) override;
 
    SOURCE_PCB_COMPONENT* Board = nullptr;
    SOURCE_SCM_COMPONENT* Schematic = nullptr;
};
 

std::vector<wxString> ExpandPinNumberList( const wxString& aList, wxString* aDisplay = nullptr );
 

bool IsPadList( const wxString& aPcbSymbolPin );
 
} // namespace EASYPC
 
#endif // EASYPC_CLASSES_LIBRARY_H