Add the following Clang plugins:...

ppapi/tests/clang/README

+This is a directory for Clang plugins that are designed to do analysis and/or manipulation of PPAPI code.  Clang is an open-source C front-end that allows you to parse C, C++, or Objective-C code in to an abstract syntax tree (or AST) for processing.

[David Springer, 2010/12/13 21:23:08]

Nit: I don't know of any Style Guide for READMEs, but would you consider making
lines 80-cols?

Mention that you need a chromium checkout to run this stuff (lift the last
comment up here)?

+
+To use these plugins, you will need to get Clang.  Clang is rapidly changing, so you may want to download and build it yourself.  See the instructions here:
+- http://clang.llvm.org/get_started.html
+
+To build the plugins, use the Makefile in this directory.  If you want the provided Makefile to work out-of-the-box, in step 2 of the instructions at the above URL, you should do the following:
+> mkdir ~/llvm
+> cd ~/llvm
+Now continue with the svn co command to check out llvm in ~/llvm/llvm.
+
+To run a plugin, use clang with the -cc1 -load and -plugin flags and an otherwise normal build line.  For example, to run liBPrintNamesAndSizes.so, if you currently build like this:
+g++ (build_options)
+Run this from the command-line instead:
+clang -cc1 -load ppapi/tests/clang/libPrintNamesAndSizes.so -plugin PrintNamesAndSizes (build_options)
+
+Plugins:
+PrintNamesAndSizes : print_names_and_sizes.cc

[David Springer, 2010/12/13 21:23:08]

Suggestion: offset the individual plugin description sections with indentation.
E.g.:
Plugins:
  PrintNamesAndSizes:
  ...

+Print information about all top-level type definitions.  You probably won't need to run it by itself;  instead see generate_ppapi_size_checks.py, which uses the plugin.

[David Springer, 2010/12/13 21:23:08]

What information do I get?  Example output?

+
+Example command-line:
+  python generate_ppapi_size_checks.py --ppapi-root=/usr/local/google/chrome_build/src/ppapi
+  python generate_ppapi_size_checks.py --help

[David Springer, 2010/12/13 21:23:08]

Example output?  Why would I use this particular plugin?  Do I need to run it
when I trigger the compile-time assertions in the PPAPI structs?

+
+
+FindAffectedInterfaces : find_affected_interfaces.cc
+Given typenames as parameters, print out all types that are affected (including function pointer types and structs containing affected function pointer types) if the given type(s) change.  This is meant to be used for determining what interfaces are affected by a change to a struct.
+
+Example command-line:
+  clang -cc1 -load ppapi/tests/clang/libFindAffectedInterfaces.so -plugin FindAffectedInterfaces -I. ppapi/tests/all_includes.h -plugin-arg-FindAffectedInterfaces "struct PP_VideoCompressedDataBuffer_Dev"
+  clang -cc1 -load tests/clang/libFindAffectedInterfaces.so -plugin FindAffectedInterfaces -I../ tests/all_c_includes.h -plugin-arg-FindAffectedInterfaces "struct PP_VideoCompressedDataBuffer_Dev,struct PP_Var"
+
+(This assumes that clang is in your path and you are running the plugin from the ppapi subdirectory in a chrome checkout).

[David Springer, 2010/12/13 21:23:08]

"in a chrome checkout" - this fact is important enough that it deserves top
billing.  I realize that devs probably have a chrome checkout already (otherwise
how are they reading this file?), but someone browsing the source on the web
might need to know this fact.