Re: [pdf-devel] Sources organization

[Aleksander Morgado]

Hi,

Even though I am not experienced in source code organization, here are
my comments.

>    2.a) One library with conditional compilation of some layers
>
>         In this scheme a single library called libgnupdf.(so|a) would
>         be constructed. The user would select the layers to be
>         included in the library using a `configure' switch like:
>         --with-pdf-level=(page|document|object|base).
>
>         Then if the `document' level is selected the library will
>         contain the code of the base, object and document layers.
>
>         In this way we would achieve flexibility: a client application
>         may want to manipulate the contents of a PDF document in order
>         to extract text or metadata (like libextractor). The `page'
>         layer is not needed in this scenario (nor the dependency with
>         libcairo, for example). That client application would want to
>         link against a `--with-pdf-level=document' compiled libgnupdf.
>
>         The libray would then distribute a single `pdf.h' file
>         granting access to the functionality of all the enabled
>         layers.
>

IMHO this approach would be better. I guess that the number of
specific user cases where there is a need for linking to a lower layer
will be low, comparing with the need for having the full set of
layers. The default configure would work at page level, including all
the lower levels, and only in specific user cases an additional
configure option would be passed to skip higher level layers. If you
really think that there will be lots of user cases where only a subset
of layers is needed, then the four-libraries approach could be better.

>
>    3.b) A directory for each layer
>
>         In this schema we would have four source directories:
>
>         - src/base
>         - src/object
>         - src/document
>         - src/page

Even in a single-library strategy, I would divide the sources in four
different directories, one for each layer. It will make easier the
understanding of the sources architecture.

>    4.b) Carry layer information in symbol names only

If sources are stored in a layer-basis directory structure, as in
option 3.b, there is no need for having layer information in the
source file name. Anyway, it is quite useful to have the layer
information within the symbol names.

Well, that's my bet: 2.a, 3.b and 4.b


Aleksander