orcad_structures.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.
 *
 * Based on the dsn2kicad reference implementation and on OrCAD file format
 * documentation from the OpenOrCadParser project (MIT licensed).
 *
 * 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 3 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 ORCAD_STRUCTURES_H_
#define ORCAD_STRUCTURES_H_
 
#include <cstdint>
#include <map>
#include <string>
#include <utility>
#include <variant>
#include <vector>
 
#include <wx/string.h>
 
#include <sch_io/orcad/orcad_records.h>
#include <sch_io/orcad/orcad_stream.h>
 

struct ORCAD_PREFIXES
{
    int                                        typeId = 0;   
    std::vector<uint32_t>                      bodyLens;     
    std::vector<std::pair<uint32_t, uint32_t>> props;        
    size_t                                     start = 0;    
    size_t                                     bodyStart = 0; 
    size_t                                     end = 0;      
    std::vector<size_t>                        stops;        
};
 

using ORCAD_RECORD_VARIANT =
        std::variant<std::monostate, ORCAD_DISPLAY_PROP, ORCAD_ALIAS, ORCAD_WIRE, ORCAD_PIN_INST,
                     ORCAD_BUS_ENTRY, ORCAD_PLACED_INSTANCE, ORCAD_GRAPHIC_INST,
                     ORCAD_DRAWN_INSTANCE, ORCAD_SYMBOL_DEF>;
 
struct ORCAD_READ_RESULT
{
    int                  typeId = 0;
    ORCAD_RECORD_VARIANT record;
};
 

class ORCAD_STRUCT_READER
{
public:
    ORCAD_STRUCT_READER( ORCAD_STREAM& aStream, const std::vector<std::string>* aStrings = nullptr,
                         ORCAD_WARN_FN aWarn = nullptr );
 
    ORCAD_STREAM& Stream() { return m_stream; }

    ORCAD_PREFIXES TryReadPrefixes( int aCount );

    ORCAD_PREFIXES ReadPrefixes();

    std::string Resolve( uint32_t aIndex ) const;

    std::map<std::string, std::string> PropsDict( const ORCAD_PREFIXES& aPrefixes ) const;

    void SkipStructure( const ORCAD_PREFIXES& aPrefixes, const wxString& aWhat );

    ORCAD_READ_RESULT ReadStructure();

    void Warn( const wxString& aMsg ) const;
 
private:
    ORCAD_STREAM&                   m_stream;
    const std::vector<std::string>* m_strings;
    ORCAD_WARN_FN                   m_warn;
};
 
 
// -- per-type body readers ----------------------------------------------------------------
//
// Each reader is entered with the stream positioned at the structure body (right
// after ReadPrefixes()) and must leave the cursor at the end of everything it
// consumed.  All throw IO_ERROR on malformed data; recovery is ReadStructure()'s
// job.  Byte layouts are documented on the corresponding structs in
// orcad_records.h.
 
ORCAD_DISPLAY_PROP OrcadReadDisplayProp( ORCAD_STRUCT_READER& aReader,
                                         const ORCAD_PREFIXES& aPrefixes );
 
ORCAD_ALIAS OrcadReadAlias( ORCAD_STRUCT_READER& aReader, const ORCAD_PREFIXES& aPrefixes );

ORCAD_WIRE OrcadReadWire( ORCAD_STRUCT_READER& aReader, const ORCAD_PREFIXES& aPrefixes );
 
ORCAD_PLACED_INSTANCE OrcadReadPlacedInstance( ORCAD_STRUCT_READER& aReader,
                                               const ORCAD_PREFIXES& aPrefixes );

ORCAD_GRAPHIC_INST OrcadReadGraphicInst( ORCAD_STRUCT_READER& aReader,
                                         const ORCAD_PREFIXES& aPrefixes );

ORCAD_GRAPHIC_INST OrcadReadPort( ORCAD_STRUCT_READER& aReader, const ORCAD_PREFIXES& aPrefixes );

ORCAD_GRAPHIC_INST OrcadReadTitleBlock( ORCAD_STRUCT_READER& aReader,
                                        const ORCAD_PREFIXES& aPrefixes );

ORCAD_GRAPHIC_INST OrcadReadErcObject( ORCAD_STRUCT_READER& aReader,
                                       const ORCAD_PREFIXES& aPrefixes );
 
ORCAD_PIN_INST OrcadReadPinInst( ORCAD_STRUCT_READER& aReader, const ORCAD_PREFIXES& aPrefixes );
 
ORCAD_BUS_ENTRY OrcadReadBusEntry( ORCAD_STRUCT_READER& aReader, const ORCAD_PREFIXES& aPrefixes );

std::vector<ORCAD_DISPLAY_PROP> OrcadReadDisplayPropList( ORCAD_STRUCT_READER& aReader );

void OrcadReadT0x34Raw( ORCAD_STREAM& aStream );

void OrcadReadT0x35Raw( ORCAD_STREAM& aStream );
 
#endif // ORCAD_STRUCTURES_H_