| 1 |
## Source layout |
| 2 |
|
| 3 |
### Root directory |
| 4 |
|
| 5 |
- `3rdparty`: 3rd party headers and sources needed to compile PoDoFo; |
| 6 |
- `cmake`: [CMake](https://cmake.org/) scripts and includes needed to compile PoDoFo; |
| 7 |
- `examples`: Samples that use the PoDoFo API; |
| 8 |
- `extern`: external git submodules. No one is currently needed to |
| 9 |
compile PoDoFo library, but they may be needed to build the playground or tests; |
| 10 |
- `src`: the main source directory; |
| 11 |
- `test`: test suite; |
| 12 |
- `tools`: the PoDoFo tools suite; |
| 13 |
- `staging`: directory with immature PoDoFo API extensions classes, |
| 14 |
or with unclear ownership/maintenance. May be promoted to |
| 15 |
main API or removed at any time. |
| 16 |
|
| 17 |
### Source directory |
| 18 |
The `src` directory contains only a single `podofo` folder. |
| 19 |
In this way it's easy to just include `src` when using PoDoFo |
| 20 |
externally of the source tree, simulating the layout of prefixed |
| 21 |
`include` after installation. The content of `podofo` is: |
| 22 |
|
| 23 |
- `podofo.h`: The main include file that pulls in all recommended |
| 24 |
public API types |
| 25 |
- `main`: source directory with most of the library classes; |
| 26 |
- `auxiliary`: directory with general purpose types/commodities |
| 27 |
that are not specific to handling of the PDF specification. |
| 28 |
Headers here are deployed as part of the public API; |
| 29 |
- `optional`: directory with PDF specific types/commodities |
| 30 |
that are not generally included by `podofo.h`. They may |
| 31 |
be used during PoDoFo compilation. Headers here are deployed |
| 32 |
as part of the public API; |
| 33 |
- `staging`: directory with components with unstable API being |
| 34 |
developed. They may end up (or not) in the public API |
| 35 |
- `private`: directory with private commodities/data needed to |
| 36 |
compile PoDoFo library, and can be called by tools and tests |
| 37 |
as well by means of a `podofo_private` static library target. |
| 38 |
Headers here are not deployed as part of the public API; |