Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Tools for code analysis, visualizations, or style-preserving source transformation.
OCaml Java PHP Makefile TeX JavaScript Other
tree: 0e7ad7c825

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.arc
code_graph
code_map
commons
data
demos
docs
editors/emacs
external
globals
graph_code
h_files-format
h_program-lang
h_program-visual
h_version-control
h_visualization
lang_bytecode
lang_c
lang_clang
lang_cmt
lang_cpp
lang_csharp
lang_css
lang_erlang
lang_haskell
lang_html
lang_java
lang_js
lang_lisp
lang_ml
lang_nw
lang_objc
lang_opa
lang_php
lang_python
lang_sql/parsing
lang_text
lang_web
matcher
opa
scripts
tests
web
.arcconfig
.gitignore
.travis.yml
META
Makefile
Makefile.common
authors.txt
bugs.txt
changes.txt
configure
copyright.txt
credits.txt
env.csh
env.sh
find_source.ml
find_source.mli
install.txt
install_linux.txt
install_macos.txt
license.txt
main.ml
main_codegraph.ml
main_codemap.ml
main_codequery.ml
main_db.ml
main_scheck.ml
main_sgrep.ml
main_spatch.ml
main_stags.ml
main_test.ml
project.el
readme.txt
skip_list.txt
syncweb.txt
travis-ci.sh

readme.txt

                              pfff

pfff is a set of tools and APIs to perform some static analysis, dynamic
analysis, code visualizations, code navigations, or style-preserving
source-to-source transformations such as refactorings on source code.
For now the effort is focused on PHP but there is preliminary support
for Javascript, C, C++, Java, and other languages. There is also
preliminary support for OCaml code so that the framework can be used
on the code of pfff itself.

For each languages there are mainly 2 libraries, for instance
parsing_php.cma and analysis_php.cma, that you can
embed in your own application if you need to process PHP code. See the
demos/ directory for example of use of the pfff API. See also
docs/manual/Parsing_xxx.pdf and docs/manual/Analyzis_xxx.pdf for 
more documentation on how to use or extend pfff.

pfff is also made of few tools:
 - pfff, which allows to test the different parsers on a single file
 - scheck, a bug finder
 - stags, an Emacs tag generator
 - sgrep, a syntactical grep
 - spatch, a syntactical patch
 - codemap, which is a gtk and cairo based source code
   visualizer/navigator/searcher leveraging
   the information computed previously by pfff_db and codegraph.
 - codegraph, a package/module/class dependency visualizer
 - codequery, an interactive tool a la SQL to query information
   about the structure of a codebase using Prolog as the query engine
 - pfff_db, which does some global analysis on a set of source files and
   store the data in a marshalled form in a file somewhere (e.g. /tmp/db.json)

For more information, look at the pfff wiki here:
 http://github.com/facebook/pfff/wiki/Main
as well as the docs/manual/ directory.

Usage for pfff:
-----------------

   $ ./pfff -parse_php demos/foo.php 

or

   $ ./pfff -dump_php demos/foo.php 

You can also look at ./pfff --help

Usage for pfff_db:
-------------------

   $ ./pfff_db -lang ml -o /tmp/pfff.json ~/pfff

to analyze all the .ml and .mli files under ~/pfff and store metadata
information (the database) in /tmp/pfff.json

Usage for codemap:
------------------------

  $ ./codemap ~/pfff

This should launch a gtk-based GUI that allows you to visualize
source code and perform some code search.

Usage for codegraph:
------------------------

  $ ./codegraph -lang cmt -build ~/pfff

to generate a graph_code.marshall file in ~/pfff containing
all dependency information about the pfff codebase using the
typed bytecode .cmt files generated during the compilation of pfff.

  $ ./codegraph ~/pfff

This should launch a gtk-based GUI that allows you to visualize
source code dependencies.

More information
----------------------

Look at the pfff wiki here: http://github.com/facebook/pfff/wiki/Main
Something went wrong with that request. Please try again.