Parsers for the DSN 'Cache' stream and the 'Packages/<name>' streams: symbol definitions with graphics and pins, plus package/device pin-number maps. More...

#include <cstdint>
#include <map>
#include <optional>
#include <string>
#include <vector>
#include <sch_io/orcad/orcad_records.h>
#include <sch_io/orcad/orcad_stream.h>
#include <sch_io/orcad/orcad_structures.h>

Functions
std::optional< ORCAD_PRIMITIVE >	OrcadReadPrimitive (ORCAD_STRUCT_READER &aReader)
	Consumes one primitive and its optional preamble.

std::optional< ORCAD_SYMBOL_PIN >	OrcadReadSymbolPin (ORCAD_STRUCT_READER &aReader)
	A zero byte marks an empty pin slot and returns nullopt.

ORCAD_SYMBOL_DEF	OrcadReadSymbolDef (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes, bool aWithPins)
	Read a symbol definition body (LibraryPart / GlobalSymbol / PortSymbol / OffPageSymbol / TitleBlockSymbol / ERCSymbol / BookmarkSymbol / PinShapeSymbol).

ORCAD_DRAWN_INSTANCE	OrcadReadDrawnInstance (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)

std::vector< ORCAD_BLOCK_PIN >	OrcadResolveBlockPins (int aOrient, int aX1, int aY1, const ORCAD_SYMBOL_DEF &aDefinition, const std::vector< ORCAD_PIN_INST > &aPlaced)
	Pair placed pin records with the inline definition by pin index.

ORCAD_DEVICE	OrcadReadDevice (ORCAD_STRUCT_READER &aReader)

ORCAD_PACKAGE	OrcadReadPackage (ORCAD_STRUCT_READER &aReader, const ORCAD_PREFIXES &aPrefixes)

void	OrcadParseCache (const std::vector< char > &aData, const std::vector< std::string > &aStrings, const ORCAD_WARN_FN &aWarn, std::map< std::string, ORCAD_SYMBOL_DEF > &aSymbols, std::map< std::string, ORCAD_PACKAGE > &aPackages, ORCAD_DIALECT aDialect={})
	The first entry is the default; later entries become variants.

void	OrcadParseSymbolStream (const std::vector< char > &aData, const std::vector< std::string > &aStrings, std::map< std::string, ORCAD_SYMBOL_DEF > &aSymbols, ORCAD_DIALECT aDialect={})
	Throws IO_ERROR for invalid framing or trailing bytes.

void	OrcadParsePackageStream (const std::vector< char > &aData, const std::vector< std::string > &aStrings, std::map< std::string, ORCAD_SYMBOL_DEF > &aSymbols, std::map< std::string, ORCAD_PACKAGE > &aPackages, ORCAD_DIALECT aDialect={})
	Package streams contain counted PartCells and LibraryParts, followed by one Package.

void	OrcadMergeCacheStreams (std::map< std::string, ORCAD_SYMBOL_DEF > &aSymbols, std::map< std::string, ORCAD_PACKAGE > &aPackages, std::map< std::string, ORCAD_SYMBOL_DEF > &&aExtraSymbols, std::map< std::string, ORCAD_PACKAGE > &&aExtraPackages)
	Merge the results of a 'Packages/<name>' stream (locally modified parts) into the main cache maps: a symbol name already present gains the extra entries as variants (the main cache definition stays the default); a new name is inserted as-is.

void	OrcadMergeSymbolGeneralProperties (std::map< std::string, ORCAD_SYMBOL_DEF > &aSymbols, const std::map< std::string, ORCAD_SYMBOL_DEF > &aMetadataSymbols)

Detailed Description

Parsers for the DSN 'Cache' stream and the 'Packages/<name>' streams: symbol definitions with graphics and pins, plus package/device pin-number maps.

The cache stream holds four counted sections (loose symbols, LibraryParts, PartCells and Packages). Each group carries a name and a variant count, and each variant its source library and dates, followed by one prefix-framed structure read through ORCAD_STRUCT_READER. The legacy dialect uses the same walk with short prefixes.

Implemented in orcad_cache.cpp.

Definition in file orcad_cache.h.

Function Documentation

◆ OrcadMergeCacheStreams()

void OrcadMergeCacheStreams	(	std::map< std::string, ORCAD_SYMBOL_DEF > &	aSymbols,
		std::map< std::string, ORCAD_PACKAGE > &	aPackages,
		std::map< std::string, ORCAD_SYMBOL_DEF > &&	aExtraSymbols,
		std::map< std::string, ORCAD_PACKAGE > &&	aExtraPackages )

Merge the results of a 'Packages/<name>' stream (locally modified parts) into the main cache maps: a symbol name already present gains the extra entries as variants (the main cache definition stays the default); a new name is inserted as-is.

Packages are inserted only when the name is not already present.

Definition at line 1081 of file orcad_cache.cpp.

References name.

Referenced by SCH_IO_ORCAD::loadOlbSymbols(), and SCH_IO_ORCAD::LoadSchematicFile().

◆ OrcadMergeSymbolGeneralProperties()

void OrcadMergeSymbolGeneralProperties	(	std::map< std::string, ORCAD_SYMBOL_DEF > &	aSymbols,
		const std::map< std::string, ORCAD_SYMBOL_DEF > &	aMetadataSymbols )

Definition at line 1131 of file orcad_cache.cpp.

References name.

Referenced by SCH_IO_ORCAD::LoadSchematicFile().

◆ OrcadParseCache()

void OrcadParseCache	(	const std::vector< char > &	aData,
		const std::vector< std::string > &	aStrings,
		const ORCAD_WARN_FN &	aWarn,
		std::map< std::string, ORCAD_SYMBOL_DEF > &	aSymbols,
		std::map< std::string, ORCAD_PACKAGE > &	aPackages,
		ORCAD_DIALECT	aDialect = {} )

The first entry is the default; later entries become variants.

A modern body error preserves earlier entries and resumes at the declared structure end; a legacy one ends the walk.

Definition at line 878 of file orcad_cache.cpp.

References _, ORCAD_STREAM::AtEnd(), cacheSectionAcceptsType(), ORCAD_PREFIXES::end, ORCAD_STREAM::ExpectByte(), ORCAD_STREAM::GetOffset(), group, ORCAD_DIALECT::legacy, IO_ERROR::Problem(), ORCAD_STRUCT_READER::ReadCount(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadPrefixes(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::ReadU8(), ORCAD_STREAM::Remaining(), ORCAD_STREAM::Seek(), ORCAD_STREAM::Size(), ORCAD_PREFIXES::start, storeFramedRecord(), storeLegacyCacheRecord(), THROW_IO_ERROR, THROW_IO_ERRORF, and IO_ERROR::What().

Referenced by SCH_IO_ORCAD::loadOlbSymbols(), and SCH_IO_ORCAD::LoadSchematicFile().

◆ OrcadParsePackageStream()

void OrcadParsePackageStream	(	const std::vector< char > &	aData,
		const std::vector< std::string > &	aStrings,
		std::map< std::string, ORCAD_SYMBOL_DEF > &	aSymbols,
		std::map< std::string, ORCAD_PACKAGE > &	aPackages,
		ORCAD_DIALECT	aDialect = {} )

Package streams contain counted PartCells and LibraryParts, followed by one Package.

Definition at line 1004 of file orcad_cache.cpp.

References ORCAD_PREFIXES::end, ORCAD_STREAM::GetOffset(), ORCAD_DIALECT::legacy, name, ORCAD_SYMBOL_DEF::name, ORCAD_ST_LIBRARY_PART, ORCAD_ST_PACKAGE, ORCAD_ST_PART_CELL, OrcadAddOrVariant(), OrcadReadSymbolDef(), ORCAD_SYMBOL_DEF::props, ORCAD_STRUCT_READER::PropsDict(), ORCAD_STRUCT_READER::ReadCount(), readLegacyLibraryPartTail(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadPrefixes(), ORCAD_STREAM::Remaining(), ORCAD_STREAM::Seek(), and THROW_IO_ERROR.

Referenced by SCH_IO_ORCAD::loadOlbSymbols(), and SCH_IO_ORCAD::LoadSchematicFile().

◆ OrcadParseSymbolStream()

void OrcadParseSymbolStream	(	const std::vector< char > &	aData,
		const std::vector< std::string > &	aStrings,
		std::map< std::string, ORCAD_SYMBOL_DEF > &	aSymbols,
		ORCAD_DIALECT	aDialect = {} )

Throws IO_ERROR for invalid framing or trailing bytes.

Definition at line 970 of file orcad_cache.cpp.

References ORCAD_STREAM::AtEnd(), ORCAD_DIALECT::legacy, ORCAD_SYMBOL_DEF::name, ORCAD_ST_LIBRARY_PART, OrcadAddOrVariant(), OrcadReadSymbolDef(), readLegacyLibraryPartTail(), ORCAD_STRUCT_READER::ReadPrefixes(), ORCAD_STREAM::Remaining(), storeFramedRecord(), THROW_IO_ERROR, THROW_IO_ERRORF, ORCAD_PREFIXES::typeId, and ORCAD_SYMBOL_DEF::typeId.

Referenced by SCH_IO_ORCAD::loadOlbSymbols().

◆ OrcadReadDevice()

ORCAD_DEVICE OrcadReadDevice ( ORCAD_STRUCT_READER & aReader )

Definition at line 719 of file orcad_cache.cpp.

References config, ORCAD_PREFIXES::end, ORCAD_STREAM::GetOffset(), ORCAD_ST_DEVICE, ORCAD_STREAM::PeekMatches(), ORCAD_DEVICE::pinIgnore, ORCAD_DEVICE::pinNumbers, ORCAD_STRUCT_READER::ReadCount(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadPrefixes(), ORCAD_STREAM::ReadU8(), ORCAD_DEVICE::refDes, ORCAD_STREAM::Seek(), ORCAD_STREAM::Skip(), ORCAD_STRUCT_READER::Stream(), and ORCAD_DEVICE::unitRef.

Referenced by OrcadReadPackage().

◆ OrcadReadDrawnInstance()

ORCAD_DRAWN_INSTANCE OrcadReadDrawnInstance	(	ORCAD_STRUCT_READER &	aReader,
		const ORCAD_PREFIXES &	aPrefixes )

Definition at line 566 of file orcad_cache.cpp.

Referenced by ORCAD_STRUCT_READER::ReadStructure().

◆ OrcadReadPackage()

ORCAD_PACKAGE OrcadReadPackage	(	ORCAD_STRUCT_READER &	aReader,
		const ORCAD_PREFIXES &	aPrefixes )

Definition at line 756 of file orcad_cache.cpp.

References ORCAD_PACKAGE::devices, ORCAD_PREFIXES::end, ORCAD_STREAM::GetOffset(), ORCAD_PACKAGE::name, OrcadReadDevice(), ORCAD_PACKAGE::pcbFootprint, ORCAD_PACKAGE::props, ORCAD_STRUCT_READER::PropsDict(), ORCAD_STRUCT_READER::ReadCount(), ORCAD_STREAM::ReadLzt(), ORCAD_PACKAGE::refDes, ORCAD_STREAM::Seek(), ORCAD_PACKAGE::sourceLib, and ORCAD_STRUCT_READER::Stream().

Referenced by storeFramedRecord(), and storeLegacyCacheRecord().

◆ OrcadReadPrimitive()

std::optional< ORCAD_PRIMITIVE > OrcadReadPrimitive ( ORCAD_STRUCT_READER & aReader )

Consumes one primitive and its optional preamble.

Throws IO_ERROR for invalid framing or length. Returns nullopt for a recognized body that is not supported.

Definition at line 363 of file orcad_cache.cpp.

References ORCAD_STRUCT_READER::Dialect(), ORCAD_STREAM::GetOffset(), ORCAD_DIALECT::legacy, ORCAD_PRIM_SYMBOL_VECTOR, ORCAD_STREAM::ReadU8(), ORCAD_STRUCT_READER::Stream(), and THROW_IO_ERRORF.

Referenced by OrcadReadSymbolDef().

◆ OrcadReadSymbolDef()

ORCAD_SYMBOL_DEF OrcadReadSymbolDef	(	ORCAD_STRUCT_READER &	aReader,
		const ORCAD_PREFIXES &	aPrefixes,
		bool	aWithPins )

Read a symbol definition body (LibraryPart / GlobalSymbol / PortSymbol / OffPageSymbol / TitleBlockSymbol / ERCSymbol / BookmarkSymbol / PinShapeSymbol).

Layout documented on ORCAD_SYMBOL_DEF, including the bbox rule: the box is the LAST 8 bytes before the next prefix stop (as 4 x i16), accepted only when x1 <= x2, y1 <= y2 and both spans are <= 4000 DBU.

Parameters

aReader	is the structure reader positioned at the body.
aPrefixes	are the prefixes already read for this structure.
aWithPins	read the trailing u16 pin-count pin list and u16 property list (true for cache symbols, false for nested SthInPages0 bodies).

Definition at line 430 of file orcad_cache.cpp.

References ORCAD_SYMBOL_DEF::bbox, ORCAD_SYMBOL_DEF::color, ORCAD_STRUCT_READER::Dialect(), ORCAD_PREFIXES::end, ORCAD_SYMBOL_DEF::generalFlags, ORCAD_STREAM::GetOffset(), ORCAD_DIALECT::legacy, ORCAD_SYMBOL_DEF::name, ORCAD_ST_LIBRARY_PART, OrcadReadPrimitive(), OrcadReadSymbolPin(), ORCAD_STREAM::PeekMatches(), pin, ORCAD_SYMBOL_DEF::pins, ORCAD_SYMBOL_DEF::primitives, ORCAD_SYMBOL_DEF::props, ORCAD_STRUCT_READER::PropsDict(), ORCAD_STRUCT_READER::ReadCount(), ORCAD_STREAM::ReadI16(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadStructure(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), save, ORCAD_STREAM::Seek(), ORCAD_DIALECT::shortDisplayProp, ORCAD_STREAM::Skip(), ORCAD_SYMBOL_DEF::sourceLib, ORCAD_PREFIXES::stops, ORCAD_STRUCT_READER::Stream(), ORCAD_PREFIXES::typeId, ORCAD_SYMBOL_DEF::typeId, ORCAD_BBOX::x1, ORCAD_BBOX::x2, ORCAD_BBOX::y1, and ORCAD_BBOX::y2.

Referenced by OrcadParsePackageStream(), OrcadParseSymbolStream(), OrcadReadDrawnInstance(), ORCAD_STRUCT_READER::ReadStructure(), storeFramedRecord(), and storeLegacyCacheRecord().

◆ OrcadReadSymbolPin()

std::optional< ORCAD_SYMBOL_PIN > OrcadReadSymbolPin ( ORCAD_STRUCT_READER & aReader )

A zero byte marks an empty pin slot and returns nullopt.

Definition at line 386 of file orcad_cache.cpp.

References ORCAD_STRUCT_READER::Dialect(), ORCAD_PREFIXES::end, ORCAD_STREAM::ExpectByte(), ORCAD_STREAM::GetOffset(), ORCAD_DIALECT::legacy, ORCAD_ST_SYMBOL_PIN_BUS, ORCAD_ST_SYMBOL_PIN_SCALAR, OrcadReadDisplayPropList(), PASSIVE, ORCAD_STREAM::PeekU8(), pin, ORCAD_STREAM::ReadI32(), ORCAD_STREAM::ReadLzt(), ORCAD_STRUCT_READER::ReadPrefixes(), ORCAD_STREAM::ReadU16(), ORCAD_STREAM::ReadU32(), ORCAD_STREAM::Seek(), ORCAD_STREAM::Skip(), ORCAD_STRUCT_READER::Stream(), THROW_IO_ERRORF, and ORCAD_PREFIXES::typeId.

Referenced by OrcadReadSymbolDef().

◆ OrcadResolveBlockPins()

std::vector< ORCAD_BLOCK_PIN > OrcadResolveBlockPins	(	int	aOrient,
		int	aX1,
		int	aY1,
		const ORCAD_SYMBOL_DEF &	aDefinition,
		const std::vector< ORCAD_PIN_INST > &	aPlaced )

Pair placed pin records with the inline definition by pin index.

When every placed pin sits on one point, the definition pins are placed through the block orientation instead.

Definition at line 665 of file orcad_cache.cpp.

References std::abs(), ORCAD_SYMBOL_DEF::bbox, ORCAD_PIN_INST::IsNoConnect(), OrcadTransformPoint(), pin, ORCAD_PIN_INST::pinIndex, ORCAD_SYMBOL_DEF::pins, ORCAD_PIN_INST::x, VECTOR2< T >::x, ORCAD_BBOX::x1, ORCAD_BBOX::x2, ORCAD_PIN_INST::y, VECTOR2< T >::y, ORCAD_BBOX::y1, and ORCAD_BBOX::y2.

Referenced by OrcadReadDrawnInstance().

Functions

Detailed Description

Function Documentation

◆ OrcadMergeCacheStreams()

◆ OrcadMergeSymbolGeneralProperties()

◆ OrcadParseCache()

◆ OrcadParsePackageStream()

◆ OrcadParseSymbolStream()

◆ OrcadReadDevice()

◆ OrcadReadDrawnInstance()

◆ OrcadReadPackage()

◆ OrcadReadPrimitive()

◆ OrcadReadSymbolDef()

◆ OrcadReadSymbolPin()

◆ OrcadResolveBlockPins()