KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Typedefs | Functions
orcad_structures.h File Reference
#include <cstdint>
#include <map>
#include <optional>
#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>

Go to the source code of this file.

Classes

struct  ORCAD_PREFIXES
 Prefix lengths supply structure bounds. More...
 
struct  ORCAD_READ_RESULT
 
class  ORCAD_STRUCT_READER
 ReadStructure can recover from a body error when the prefix supplies a valid end offset. More...
 

Typedefs

using ORCAD_RECORD_VARIANT
 A skipped or unreadable body produces monostate.
 

Functions

std::optional< size_t > OrcadLongPrefixCount (int aTypeId)
 Registered number of long prefixes for a modern framed structure type.
 
ORCAD_DISPLAY_PROP OrcadReadDisplayProp (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 Body readers start after the prefixes.
 
ORCAD_ALIAS OrcadReadAlias (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 
ORCAD_WIRE OrcadReadWire (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 Types 20 (wire) and 21 (bus); isBus is set from the prefix type.
 
ORCAD_PLACED_INSTANCE OrcadReadPlacedInstance (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 
ORCAD_GRAPHIC_INST OrcadReadGraphicInst (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 Common body of Port/Global/OffPageConnector/TitleBlock/ERCObject/Graphic*Inst.
 
ORCAD_GRAPHIC_INST OrcadReadPort (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 GraphicInst body followed by a 9-byte trailer.
 
ORCAD_GRAPHIC_INST OrcadReadTitleBlock (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 GraphicInst body followed by a 12-byte trailer.
 
ORCAD_GRAPHIC_INST OrcadReadErcObject (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 GraphicInst body followed by 3 lzt strings.
 
ORCAD_PIN_INST OrcadReadPinInst (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 
ORCAD_BUS_ENTRY OrcadReadBusEntryBody (ORCAD_STREAM &aStream)
 
ORCAD_BUS_ENTRY OrcadReadBusEntry (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)
 
std::vector< ORCAD_DISPLAY_PROP > OrcadReadDisplayPropList (ORCAD_STRUCT_READER &aReader)
 Keep only display properties that ReadStructure decodes.
 
ORCAD_NET_GROUP OrcadReadT0x34Raw (ORCAD_STREAM &aStream)
 T0x34 records have no prefixes; consume their fixed layout to preserve alignment.
 
ORCAD_NET_GROUP OrcadReadT0x35Raw (ORCAD_STREAM &aStream)
 T0x35 = the T0x34 raw layout followed by u16 n and 4 * n bytes.
 

Typedef Documentation

◆ ORCAD_RECORD_VARIANT

using ORCAD_RECORD_VARIANT
Initial value:
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>
ORCAD_ALIAS
The owning wire defines the connection.
Definition orcad_records.h:180
ORCAD_BUS_ENTRY
Definition orcad_records.h:388
ORCAD_DISPLAY_PROP
Display positions use symbol coordinates; rotFont combines the font index and quarter turns.
Definition orcad_records.h:166
ORCAD_DRAWN_INSTANCE
The inline LibraryPart defines the block interface; placed pin records supply absolute positions.
Definition orcad_records.h:372
ORCAD_GRAPHIC_INST
Free graphics use nested primitive coordinates.
Definition orcad_records.h:250
ORCAD_PIN_INST
Pin positions are absolute page connection points.
Definition orcad_records.h:209
ORCAD_PLACED_INSTANCE
The placed box includes displayed text.
Definition orcad_records.h:223
ORCAD_SYMBOL_DEF
The bounding box occupies the final eight bytes before the next prefix stop.
Definition orcad_records.h:313
ORCAD_WIRE
The wire ID refers to the page net table.
Definition orcad_records.h:192

A skipped or unreadable body produces monostate.

Definition at line 58 of file orcad_structures.h.

Function Documentation

◆ OrcadLongPrefixCount()

std::optional< size_t > OrcadLongPrefixCount ( int aTypeId)

Registered number of long prefixes for a modern framed structure type.

Definition at line 51 of file orcad_structures.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and ORCAD_STRUCT_READER::ReadPrefixes().

◆ OrcadReadAlias()

ORCAD_ALIAS OrcadReadAlias ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Definition at line 332 of file orcad_structures.cpp.

References ORCAD_ALIAS::color, ORCAD_ALIAS::fontIdx, ORCAD_ALIAS::name, ORCAD_STREAM::ReadI32(), ORCAD_STREAM::ReadLzt(), ORCAD_STREAM::ReadU32(), ORCAD_ALIAS::rotation, ORCAD_STRUCT_READER::Stream(), ORCAD_ALIAS::x, and ORCAD_ALIAS::y.

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadBusEntry()

ORCAD_BUS_ENTRY OrcadReadBusEntry ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Definition at line 565 of file orcad_structures.cpp.

References OrcadReadBusEntryBody(), and ORCAD_STRUCT_READER::Stream().

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadBusEntryBody()

ORCAD_BUS_ENTRY OrcadReadBusEntryBody ( ORCAD_STREAM & aStream)

Definition at line 550 of file orcad_structures.cpp.

References ORCAD_BUS_ENTRY::color, ORCAD_STREAM::ReadI32(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::Skip(), ORCAD_BUS_ENTRY::x1, ORCAD_BUS_ENTRY::x2, ORCAD_BUS_ENTRY::y1, and ORCAD_BUS_ENTRY::y2.

Referenced by BOOST_AUTO_TEST_CASE(), OrcadParsePageV2(), and OrcadReadBusEntry().

◆ OrcadReadDisplayProp()

ORCAD_DISPLAY_PROP OrcadReadDisplayProp ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Body readers start after the prefixes.

ReadStructure handles recovery from IO_ERROR.

Definition at line 309 of file orcad_structures.cpp.

References ORCAD_DISPLAY_PROP::color, ORCAD_DISPLAY_PROP::dispMode, ORCAD_STREAM::ExpectByte(), ORCAD_DISPLAY_PROP::fontIdx, ORCAD_DISPLAY_PROP::name, ORCAD_DISPLAY_PROP::nameIdx, ORCAD_STREAM::ReadI16(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::ReadU8(), ORCAD_STRUCT_READER::Resolve(), ORCAD_DISPLAY_PROP::rotation, ORCAD_STRUCT_READER::Stream(), ORCAD_DISPLAY_PROP::x, and ORCAD_DISPLAY_PROP::y.

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadDisplayPropList()

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

Keep only display properties that ReadStructure decodes.

Definition at line 571 of file orcad_structures.cpp.

References ORCAD_STRUCT_READER::ReadStructure(), ORCAD_STREAM::ReadU16(), ORCAD_READ_RESULT::record, and ORCAD_STRUCT_READER::Stream().

Referenced by OrcadReadDrawnInstance(), OrcadReadGraphicInst(), OrcadReadPinInst(), OrcadReadPlacedInstance(), and OrcadReadSymbolPin().

◆ OrcadReadErcObject()

ORCAD_GRAPHIC_INST OrcadReadErcObject ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

GraphicInst body followed by 3 lzt strings.

Definition at line 518 of file orcad_structures.cpp.

References OrcadReadGraphicInst(), ORCAD_STREAM::ReadLzt(), and ORCAD_STRUCT_READER::Stream().

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadGraphicInst()

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

Common body of Port/Global/OffPageConnector/TitleBlock/ERCObject/Graphic*Inst.

Definition at line 448 of file orcad_structures.cpp.

References ORCAD_GRAPHIC_INST::bbox, ORCAD_GRAPHIC_INST::color, ORCAD_GRAPHIC_INST::dbId, ORCAD_GRAPHIC_INST::displayProps, flag, ORCAD_GRAPHIC_INST::logicalName, ORCAD_GRAPHIC_INST::mirror, ORCAD_GRAPHIC_INST::name, ORCAD_GRAPHIC_INST::nested, OrcadReadDisplayPropList(), ORCAD_GRAPHIC_INST::props, ORCAD_STRUCT_READER::PropsDict(), ORCAD_STREAM::ReadI16(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadStructure(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::ReadU8(), ORCAD_READ_RESULT::record, ORCAD_STRUCT_READER::Resolve(), ORCAD_GRAPHIC_INST::rotation, ORCAD_STREAM::Skip(), ORCAD_STRUCT_READER::Stream(), ORCAD_GRAPHIC_INST::typeId, ORCAD_PREFIXES::typeId, ORCAD_GRAPHIC_INST::x, ORCAD_BBOX::x1, ORCAD_BBOX::x2, ORCAD_GRAPHIC_INST::y, ORCAD_BBOX::y1, and ORCAD_BBOX::y2.

Referenced by OrcadReadErcObject(), OrcadReadPort(), OrcadReadTitleBlock(), and ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadPinInst()

ORCAD_PIN_INST OrcadReadPinInst ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Definition at line 530 of file orcad_structures.cpp.

References ORCAD_PREFIXES::end, ORCAD_STREAM::GetOffset(), OrcadReadDisplayPropList(), pin, ORCAD_STREAM::ReadI16(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::Seek(), and ORCAD_STRUCT_READER::Stream().

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadPlacedInstance()

ORCAD_PLACED_INSTANCE OrcadReadPlacedInstance ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Definition at line 386 of file orcad_structures.cpp.

References ORCAD_PLACED_INSTANCE::bbox, ORCAD_PLACED_INSTANCE::color, ORCAD_PLACED_INSTANCE::dbId, ORCAD_PLACED_INSTANCE::displayProps, ORCAD_PLACED_INSTANCE::mirror, OrcadReadDisplayPropList(), ORCAD_PLACED_INSTANCE::partByte, ORCAD_PLACED_INSTANCE::partIndex, pin, ORCAD_PLACED_INSTANCE::pins, ORCAD_PLACED_INSTANCE::pkgName, ORCAD_PLACED_INSTANCE::props, ORCAD_STRUCT_READER::PropsDict(), ORCAD_STREAM::ReadI16(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadStructure(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::ReadU8(), ORCAD_READ_RESULT::record, ORCAD_PLACED_INSTANCE::reference, ORCAD_STRUCT_READER::Resolve(), ORCAD_PLACED_INSTANCE::rotation, ORCAD_STREAM::Skip(), ORCAD_PLACED_INSTANCE::sourceLibrary, ORCAD_PLACED_INSTANCE::sourcePackage, ORCAD_STRUCT_READER::Stream(), ORCAD_PLACED_INSTANCE::unitIndex, ORCAD_PLACED_INSTANCE::value, ORCAD_PLACED_INSTANCE::x, ORCAD_BBOX::x1, ORCAD_BBOX::x2, ORCAD_PLACED_INSTANCE::y, ORCAD_BBOX::y1, and ORCAD_BBOX::y2.

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadPort()

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

GraphicInst body followed by a 9-byte trailer.

Definition at line 500 of file orcad_structures.cpp.

References OrcadReadGraphicInst(), ORCAD_STREAM::Skip(), and ORCAD_STRUCT_READER::Stream().

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadT0x34Raw()

ORCAD_NET_GROUP OrcadReadT0x34Raw ( ORCAD_STREAM & aStream)

T0x34 records have no prefixes; consume their fixed layout to preserve alignment.

Definition at line 589 of file orcad_structures.cpp.

References ORCAD_NET_GROUP::id, ORCAD_NET_GROUP::name, ORCAD_STREAM::ReadLzt(), ORCAD_STREAM::ReadU32(), and ORCAD_STREAM::Skip().

Referenced by OrcadParsePage(), and OrcadReadT0x35Raw().

◆ OrcadReadT0x35Raw()

ORCAD_NET_GROUP OrcadReadT0x35Raw ( ORCAD_STREAM & aStream)

T0x35 = the T0x34 raw layout followed by u16 n and 4 * n bytes.

Definition at line 605 of file orcad_structures.cpp.

References ORCAD_NET_GROUP::members, OrcadReadT0x34Raw(), ORCAD_STREAM::ReadU16(), and ORCAD_STREAM::ReadU32().

Referenced by OrcadParsePage().

◆ OrcadReadTitleBlock()

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

GraphicInst body followed by a 12-byte trailer.

Definition at line 509 of file orcad_structures.cpp.

References OrcadReadGraphicInst(), ORCAD_STREAM::Skip(), and ORCAD_STRUCT_READER::Stream().

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadWire()

ORCAD_WIRE OrcadReadWire ( ORCAD_STRUCT_READER & aReader,
const ORCAD_PREFIXES & aPrefixes )

Types 20 (wire) and 21 (bus); isBus is set from the prefix type.

Definition at line 348 of file orcad_structures.cpp.

References ORCAD_WIRE::aliases, ORCAD_WIRE::color, ORCAD_WIRE::dbId, ORCAD_WIRE::id, ORCAD_WIRE::isBus, ORCAD_WIRE::lineStyle, ORCAD_WIRE::lineWidth, ORCAD_ST_WIRE_BUS, ORCAD_STREAM::ReadI32(), ORCAD_STRUCT_READER::ReadStructure(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), ORCAD_READ_RESULT::record, ORCAD_STREAM::Skip(), ORCAD_STRUCT_READER::Stream(), ORCAD_PREFIXES::typeId, ORCAD_WIRE::x1, ORCAD_WIRE::x2, ORCAD_WIRE::y1, and ORCAD_WIRE::y2.

Referenced by ORCAD_STRUCT_READER::ReadStructure().