OpenAllegroParser

https://github.com/werni2a/openallegroparser
Admin
OpenAllegroParser is a C++17 library for parsing Cadence Allegro binary file formats and exporting...
Tokens:13,314
Snippets:84
Trust Score:6.5
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example output from OpenAllegroParser with -p flag

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Example output showing the opening of the pad file and its size. The output is truncated with '...' to indicate omitted debug and pad information.

```text

./build/OpenAllegroParser -i simple_example.pad --numUserLayers 5 --bool1 -p

Opening file: "simple_example.pad"
File contains 5020 byte.
File found at 0x00000ed8: simple_example.zip

...
```

--------------------------------

### OpenAllegroParser CLI Extract Example

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Example command to extract files from an Allegro binary. The output shows the extraction process, including the ZIP file found and the extracted file path.

```bash
./build/cli/OpenAllegroParser-cli --input file.pad --extract --output out/
Opening file: file.pad
File contains 4960 byte.
File found at 0x00000abc: file.zip
Extract ZIP file: file.pad/file.zip
Extract from ZIP, 4200 Byte file: out/file.pad/Users/%USERNAME%/AppData/Local/Temp/#Taaaaaa00765.tmp
Closing file: file.pad

```

--------------------------------

### Example valid parameter set output

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Example output from find_parameter_set.py showing a valid parameter set. The command includes the -i flag for input file and flags like --numUserLayers and --bool1.

```text
./build/OpenAllegroParser -i simple_example.pad --numUserLayers 5 --bool1
```

--------------------------------

### Build with CMake and vcpkg

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Builds the project using CMake with a vcpkg toolchain file, then compiles the build directory. Requires CMake >= 3.5 and a C++17 compiler.

```bash
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=../vcpkg/scripts/buildsystems/vcpkg.cmake
cmake --build build
```

--------------------------------

### OpenAllegroParser CLI Help Output

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Shows the command-line options available for OpenAllegroParser-cli. Use this to understand the flags for printing, extracting, exporting, and controlling verbosity.

```bash
./build/cli/OpenAllegroParser-cli --help
Allowed options:
  -h [ --help ]         produce help message
  -p [ --print ]        print file content to terminal
  -e [ --extract ]      extract files from within the binary
  -i [ --input ] arg    input file to parse
  -o [ --output ] arg   output path (required iff extract is set)
  -x [ --export ]       export XML file
  -v [ --verbose ]      verbose output
  --export-version arg  Version of padstack_editor.exe used for pxml export
  --bool0               bool0
  --bool1               bool1
  --bool2               bool2
  --int0 arg            int0
  --numUserLayers arg   number of user layers
  --additionalStr2 arg  number of additional strings e.g. symbol names

```

--------------------------------

### Run find_parameter_set.py to find valid parameter set

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Modify the path to your pad file in find_parameter_set.py and run it with python3. The script brute-forces parameter combinations to find a working set for the pad file. On success, it prints a valid parameter set command.

```text
python3 find_parameter_set.py
```

--------------------------------

### Run OpenAllegroParser with -p flag to show pad info

Source: https://github.com/werni2a/openallegroparser/blob/main/README.md

Add the -p flag to the command to print all pad information. The output includes debug output and pad details.

```text
./build/OpenAllegroParser -i simple_example.pad --numUserLayers 5 --bool1 -p
```

--------------------------------

### Recover incomplete padstack ZIP with zip -FF

Source: https://github.com/werni2a/openallegroparser/blob/main/doc/pad.md

Use this command to recover an incomplete padstack ZIP file. The file is recognized as a ZIP but has a trailing block of zeros, so the -FF flag is needed. Confirm the single-disk archive prompt with 'Y' and then unzip the recovered file.

```bash
zip -FF \#Taaaaaa00765.tmp --out recovered_zip
# Confirm 'Is this a single-disk archive?' with 'Y'.
unzip recovered_zip.zip
```

--------------------------------

### Extract embedded ZIP from .pad file using dd

Source: https://github.com/werni2a/openallegroparser/blob/main/doc/pad.md

Use this dd command to extract the ZIP archive embedded in a .pad file. The skip option is the hexadecimal offset and count is the hexadecimal byte length of the ZIP. The beginning of the ZIP is identified by the magic bytes PK\x03\x04. After extraction, the ZIP can be opened with any standard archive viewer.

```bash
dd if=my_pad.pad bs=1 status=none skip=$((0xabc)) count=$((0x123)) of=my_pad.zip
```

--------------------------------

### Regular expression to match temporary JSON files

Source: https://github.com/werni2a/openallegroparser/blob/main/doc/pad.md

This regular expression matches the temporary file names inside the extracted ZIP, such as #Taaaaaa00765.tmp. It matches a hash, six lowercase letters, five digits, and the .tmp extension.

```text
#T[a-z]{6}\d{5}\.tmp
```

--------------------------------

### Padstack JSON with trailing comma issue

Source: https://github.com/werni2a/openallegroparser/blob/main/doc/pad.md

This JSON snippet shows a padstack definition with a syntax error: the 'subclass_name' property is followed by a comma with no following data. This is invalid JSON and can cause parsing failures in strict parsers. Preprocess the JSON to remove illegal commas before parsing.

```json
"padDesign" : {
	"pad" : [
	{
		"shape" : "Circle",
		"subclass_name" : "BEGIN LAYER",
	}
	]
}
```
Tokens:
Raw