Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / pdfium / ff56efa51fe5e607788f747a7b3717d6a1df038a
commitff56efa51fe5e607788f747a7b3717d6a1df038a[log] [tgz]
authorJungshik Shin <jungshik@google.com>Tue May 10 00:31:36 2016 +0000
committerandroid-build-merger <android-build-merger@google.com>Tue May 10 00:31:36 2016 +0000
tree704a440fea6805a491e9fca546a036428bc85612
parentbba9fd47b7fa702dd6df2459b1f3a2d9228478b0 [diff]
parentf3b6ecc46eb8f13c5cc1f018fa6d26a6fa48ee15 [diff]
[DO NOT MERGE] Fix the way FreeType headers are incldued. am: 5022fbe8a4 am: 73ff57d02c am: 5ee8e0cdc1 am: 4f87508a47  -s ours am: 64aaa625fb am: 20d72bb21b
am: f3b6ecc46e  -s ours

* commit 'f3b6ecc46eb8f13c5cc1f018fa6d26a6fa48ee15':
  [DO NOT MERGE] Fix the way FreeType headers are incldued.

Change-Id: I42d9972657dc33ba5452054c72bbe6a357cda0ee
tree: 704a440fea6805a491e9fca546a036428bc85612
  1. build/
  2. core/
  3. docs/
  4. fpdfsdk/
  5. public/
  6. samples/
  7. test/
  8. testing/
  9. third_party/
  10. tools/
  11. xfa/
  12. .clang-format
  13. AUTHORS
  14. BUILD.gn
  15. codereview.settings
  16. DEPS
  17. LICENSE
  18. MODULE_LICENSE_BSD
  19. NOTICE
  20. OWNERS
  21. pdfium.gni
  22. pdfium.gyp
  23. PRESUBMIT.py
  24. README.md
  25. update_pdfium.py
  26. xfa.gyp
README.md

PDFium

Prerequisites

Get the chromium depot tools via the instructions at http://www.chromium.org/developers/how-tos/install-depot-tools (this provides the gclient utilty needed below).

Also install Python, Subversion, and Git and make sure they're in your path.

Get the code

The name of the top-level directory does not matter. In our examples, we use "repo". This directory must not have been used before by gclient config as each directory can only house a single gclient configuration.

mkdir repo
cd repo
gclient config --unmanaged https://pdfium.googlesource.com/pdfium.git
gclient sync
cd pdfium

Generate the build files

We use the GYP library to generate the build files.

At this point, you have two options. The first option is to use the [Ninja] (http://martine.github.io/ninja/) build system (also included with the depot_tools checkout). This is the default as of mid-September, 2015. Previously, the second option (platform-specific build files) was the default. Most PDFium developers use Ninja, as does our [continuous build system] (http://build.chromium.org/p/client.pdfium/).

  • On Windows: build\gyp_pdfium
  • For all other platforms: build/gyp_pdfium

The second option is to generate platform-specific build files, i.e. Makefiles on Linux, sln files on Windows, and xcodeproj files on Mac. To do so, set the GYP_GENERATORS environment variable appropriately (e.g. "make", "msvs", or "xcode") before running the above command.

Using goma (Googlers only)

If you would like to build using goma, pass use_goma=1 to gyp_pdfium. If you installed goma in a non-standard location, you will also need to set gomadir. e.g.

build/gyp_pdfium -D use_goma=1 -D gomadir=path/to/goma

Building the code

If you used Ninja, you can build the sample program by: ninja -C out/Debug pdfium_test You can build the entire product (which includes a few unit tests) by: ninja -C out/Debug.

If you're not using Ninja, then building is platform-specific.

  • On Linux: make pdfium_test
  • On Mac: open build/all.xcodeproj
  • On Windows: open build\all.sln

Running the sample program

The pdfium_test program supports reading, parsing, and rasterizing the pages of a .pdf file to .ppm or .png output image files (windows supports two other formats). For example: out/Debug/pdfium_test --ppm path/to/myfile.pdf. Note that this will write output images to path/to/myfile.pdf.<n>.ppm.

Testing

There are currently several test suites that can be run:

  • pdfium_unittests
  • pdfium_embeddertests
  • testing/tools/run_corpus_tests.py
  • testing/tools/run_javascript_tests.py
  • testing/tools/run_pixel_tests.py

It is possible the tests in the testing directory can fail due to font differences on the various platforms. These tests are reliable on the bots. If you see failures, it can be a good idea to run the tests on the tip-of-tree checkout to see if the same failures appear.

Waterfall

The current health of the source tree can be found at http://build.chromium.org/p/client.pdfium/console

Community

There are several mailing lists that are setup:

Note, the Reviews and Bugs lists are typically read-only.

Bugs

We will be using this bug tracker, but for security bugs, please use [Chromium's security bug template] (https://code.google.com/p/chromium/issues/entry?template=Security%20Bug) and add the "Cr-Internals-Plugins-PDF" label.

Contributing code

For contributing code, we will follow Chromium's process as much as possible. The main exceptions are:

  1. Code has to conform to the existing style and not Chromium/Google style.
  2. There is no commit queue, approved committers can land their changes via git cl land
  3. Changes must be merged to the XFA branch as well (see below).

Branches

There is a branch for a forthcoming feature called XFA that you can get by following the steps above, then:

git checkout origin/xfa
build/gyp_pdfium
ninja -C out/Debug

Merging to XFA requires:

git checkout origin/xfa
git checkout -b merge_branch
git branch --set-upstream-to=origin/xfa
git cherry-pick -x <commit hash>
git commit --amend # add Merge to XFA
git cl upload

Then wait for approval, and git cl land