https://github.com/itext/pdfcop
An interpretation of the content stream structure as described by ISO 32000
https://github.com/itext/pdfcop
Last synced: about 1 year ago
JSON representation
An interpretation of the content stream structure as described by ISO 32000
- Host: GitHub
- URL: https://github.com/itext/pdfcop
- Owner: itext
- License: agpl-3.0
- Created: 2023-01-19T10:30:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-31T14:56:16.000Z (over 3 years ago)
- Last Synced: 2025-04-12T01:02:57.745Z (about 1 year ago)
- Language: Java
- Size: 2.86 MB
- Stars: 11
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pdfCop
## Summary
pdfCop is a compiled/to-be-compiled Java project based on an ANTLR4 grammar file that describes how Content Streams are structured as per the PDF specification. pdfCop can tell you whether a content stream, a PDF file, or a snippet follows the specification or not and it will let you know where the provided syntax did go wrong.
## Building
This project is built using maven. After cloning, run the following command:
```bash
mvn package
```
After a successful build, your target folder should contain a `pdfCop-x.y.z.jar` which you can then use in your projects!
You can also use `mvn install` so that the artifact is automatically installed into your local maven repository!
## Usage
Add the pdfCop dependency to your project and you can start using the tool as a high level tool:
```java
new PdfCop().isDocumentFollowingTheRules(inputPdf)
```
`inputPdf` is a path to your input PDF file. It will return a boolean letting you know whether the provided document's content streams follow the specification or not.
You can also access the specific objects and their children through the generated API. Feel free to check some of the tests to look for more exhaustive examples. This is an area where we can add more convenience for the user.
## Troubleshooting
Some versions of IntelliJ IDEA might not be able to find the generated sources after a build. To remediate this, right-click on the root in the Project View, open the `Maven` submenu and click `Generate Sources and Update Folders`
## Disclaimer
This is an experimental tool, not an iText product. It is provided to the
community under the terms of the AGPL (see [LICENSE](LICENSE.md)) on an as-is
basis.