# OpenOrCadParser

**Repository Path**: whh5118/OpenOrCadParser

## Basic Information

- **Project Name**: OpenOrCadParser
- **Description**: No description available
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-18
- **Last Updated**: 2021-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# OpenOrCadParser

Purpose of this project is to provide a C++17 library for parsing [Cadence](https://en.wikipedia.org/wiki/Cadence_Design_Systems)'s OrCAD Capture binary file formats. This library can be linked to other software for reading/modifying?/writing? OrCAD binary files.

**See also the complementary project [OpenAllegroParser](https://github.com/Werni2A/OpenAllegroParser).**

The focus lies on schematics (`*.DSN`/`*.DBK`) and symbol libraries (`*.OLB`/`*.OBK`), the second file format is just the extension for its corresponding backup file. Backups should be identical, just with a different file extension.

OrCAD allows exporting its designs to XML files which are easy to read and verify the interpretation of bytes in the `DSN`/`OLB`-files. E.g. enums are stored as a numeric value which should be the same that is used in the binary formats. However, it seems like not all information is stored in the XML.

The following two XSD files provide a good overview of the `XML` file structure, types and much more. They can be used as a reference what features are actually stored in the binary file and which we do already parse and which not.

`C:\Cadence\SPB_17.4\tools\capture\tclscripts\capDB\dsn.xsd`

`C:\Cadence\SPB_17.4\tools\capture\tclscripts\capDB\olb.xsd`

---

# Documentation

1. [File Container](doc/file_container.md)
   1. [Container Structure](doc/container_structure.md)
2. [File Format Changes](doc/file_format_changes.md)

---

# Current State — October 2021

- Working on parsing library symbols.

---

# Build

```bash
# Get build dependency
mkdir thirdparty
cd thirdparty
git clone https://github.com/microsoft/compoundfilereader.git
cd ..

# Build
mkdir build
cd build
cmake ..
make
cd ..
```

## Dependencies

- Compiler with C++17 Support
- [CMake](https://cmake.org/) >= 2.8.12
- [Boost](https://www.boost.org/) - Program Options
- [compoundfilereader](https://github.com/Microsoft/compoundfilereader)

---

# Usage

```bash
./OpenOrCadParser --help
Allowed options:
  -h [ --help ]         produce help message
  -t [ --print_tree ]   print container tree
  -e [ --extract ]      extract binary files from CFBF container
  -i [ --input ] arg    input file to parse
  -o [ --output ] arg   output path (required iff extract is set)

./OpenOrCadParser --input file.DSN --extract --output out/
./OpenOrCadParser --input file.DSN --print_tree
```

---

# Related Projects

[orlib2ki](https://github.com/fjullien/orlib2ki) (C based OrCAD XML Library to KiCad Converter)

[pyorlib2ki](https://github.com/fjullien/pyorlib2ki) (Python based OrCAD XML Library to KiCad Converter)

---

# How to Contribute?

There are different ways to help this project forward. Some are

- provide test files (manually created or automated via Tcl/Tk),
- help reverse engineering/documenting the file format, or
- implement some unit tests.

In case you don't have access to OrCAD you can get
- [OrCAD Viewer](https://www.orcad.com/downloads/orcad-viewer) free of charge,
- [OrCAD Trial](https://dev.orcad.com/orcad-free-trial) with all its functionality for a trial period of 30 days or
- [OrCAD Academic Program](https://www.orcad.com/orcad-academic-program) with all functionality for one semester.

What about OrCAD Lite? It was was replaced with OrCAD Viewer/Trial [[1]](https://www.orcad.com/resources/download-orcad-lite).

---

# Cadence Terms and Conditions

[Terms and Conditions](https://www.cadence.com/content/dam/cadence-www/global/en_US/documents/terms-and-conditions/cadence-orcad.pdf)

[Terms of Use Agreement](https://www.cadence.com/en_US/home/terms-of-use-agreement.html)