Skip to content
Browse files

* docs/manual/announce_pfff_ocaml_list.txt:

  • Loading branch information...
1 parent de0499f commit 54f5697084d67a2815e1498680eedbeabad18746 @aryx aryx committed Nov 26, 2013
View
0 docs/manual/announce_pfff_visual.txt → docs/manual/announce_codemap_efyi.txt
File renamed without changes.
View
50 docs/manual/announce_codemap_ocaml_list.txt
@@ -0,0 +1,50 @@
+[ANN] pfff_visual, a fancy code visualizer/navigator for OCaml, and more
+
+Hi list,
+
+It is my pleasure to announce pfff_visual, a code visualizer/navigator
+for OCaml. Note that this is not a replacement for Emacs, but more a
+companion that works with Emacs.
+
+A demo is available here:
+ part1: http://www.youtube.com/watch?v=HRZjBGD3osw
+ part2: http://www.youtube.com/watch?v=993pmNLY_VU
+
+pfff_visual is using pfff, which is mainly an OCaml API to write
+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, and C++ code.
+There is also preliminary support for OCaml code so that the infrastructure
+can be used on the code of pfff itself.
+
+You can get the source of pfff and pfff_visual here:
+ http://github.com/facebook/pfff
+
+Here is how to install it:
+ $ git clone git@github.com:facebook/pfff.git
+ $ ./configure
+ $ make depend; make; make opt
+ $ ./pfff_visual /path/to/project/using/supported/languages
+
+pfff has been tested on MacOS and Linux and is licensed under the LGPL.
+
+Thanks to
+ - Lex Stein for ocamlbdb/
+ - Olivier Andrieu for ocamlcairo
+ - Jacques Garrigue for ocamlgtk
+ - Martin Jambon, Mika Illouz and Gert Stolpmann for lib-json
+ - Nicolas Canasse for lib-xml
+ - Jane Street for lib-sexp
+ - Thomas Gazagnaire for dynType
+ - Maas-Maarten Zeeman for OUnit.ml
+ - Thorsten Ohl for xHTML.ml
+ - Sylvain Conchon, Jean-Christophe Filli�tre and Julien Signoles for
+ ocamlgraph
+ - Xavier Leroy for ocamlmpi
+ - Markus Mottl for ocamlpcre
+ - Iain Proctor for ocamlthrift
+ - Guillaume Cottenceau for pleac
+
+
+Enjoy.
View
101 docs/manual/announce_pfff_ocaml_list.txt
@@ -1,50 +1,51 @@
-[ANN] pfff_visual, a fancy code visualizer/navigator for OCaml, and more
-
-Hi list,
-
-It is my pleasure to announce pfff_visual, a code visualizer/navigator
-for OCaml. Note that this is not a replacement for Emacs, but more a
-companion that works with Emacs.
-
-A demo is available here:
- part1: http://www.youtube.com/watch?v=HRZjBGD3osw
- part2: http://www.youtube.com/watch?v=993pmNLY_VU
-
-pfff_visual is using pfff, which is mainly an OCaml API to write
-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, and C++ code.
-There is also preliminary support for OCaml code so that the infrastructure
-can be used on the code of pfff itself.
-
-You can get the source of pfff and pfff_visual here:
- http://github.com/facebook/pfff
-
-Here is how to install it:
- $ git clone git@github.com:facebook/pfff.git
- $ ./configure
- $ make depend; make; make opt
- $ ./pfff_visual /path/to/project/using/supported/languages
-
-pfff has been tested on MacOS and Linux and is licensed under the LGPL.
-
-Thanks to
- - Lex Stein for ocamlbdb/
- - Olivier Andrieu for ocamlcairo
- - Jacques Garrigue for ocamlgtk
- - Martin Jambon, Mika Illouz and Gert Stolpmann for lib-json
- - Nicolas Canasse for lib-xml
- - Jane Street for lib-sexp
- - Thomas Gazagnaire for dynType
- - Maas-Maarten Zeeman for OUnit.ml
- - Thorsten Ohl for xHTML.ml
- - Sylvain Conchon, Jean-Christophe Filli�tre and Julien Signoles for
- ocamlgraph
- - Xavier Leroy for ocamlmpi
- - Markus Mottl for ocamlpcre
- - Iain Proctor for ocamlthrift
- - Guillaume Cottenceau for pleac
-
-
-Enjoy.
+[ANN] pfff 0.25, tools and APIs for program analysis of PHP/Java/JS/C/ML/PHP/...
+
+Hello,
+
+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 has focused mainly on PHP but there
+is also good support for C, C++, Java, HTML, JavaScript, and CSS.
+There is also very good support for OCaml and noweb (literate
+programming) so that pfff can be used on the code of pfff itself.
+
+For more information see the pfff wiki at:
+https://github.com/facebook/pfff/wiki/Main
+
+The current release source code is accessible from:
+https://github.com/facebook/pfff/releases/tag/v0.25.1
+
+There is now also an OPAM package for pfff. It contains though just
+the parsers, visitors, and AST dumpers (for C, Java, Javascript, PHP,
+ML, HTML and CSS). To install it just do:
+
+ $ opam install pfff
+
+Once installed you should have access to the different libraries
+in ~/.opam/.../lib/pfff-lang_yyy.
+
+The AST dumpers are useful to get familiar with the constructors.
+Here is an example:
+
+ $ cd pfff
+ $ cat demos/foo.js
+ function foo() {
+ return 1;
+ }
+ $ ./pfff -dump_js demos/foo.js
+ [FunDecl(
+ {f_tok=Some(()); f_name=Some(("foo", ())); f_params=[];
+ f_return_type=None;
+ f_body=[St(Return((), Some(L(Num(("1", ())))), Some(())))]; });
+ FinalDef(())]
+
+In the next few weeks I'll make OPAM packages for the other components
+of pfff: sgrep, spatch, stags, codemap, codegraph, the treemap
+library, etc.
+
+Thanks to:
+ - Eric Cooper for the initial version of the java parser
+ - Patrick Doane and Gerd Stolpmann for their html parser
+ - Dario Teixeira for his css parser
+ - Facebook

0 comments on commit 54f5697

Please sign in to comment.
Something went wrong with that request. Please try again.