xref: /aosp_15_r20/external/clang/examples/clang-interpreter/README.txt (revision 67e74705e28f6214e480b399dd47ea732279e315)
1*67e74705SXin LiThis is an example of Clang based interpreter, for executing standalone C
2*67e74705SXin Liprograms.
3*67e74705SXin Li
4*67e74705SXin LiIt demonstrates the following features:
5*67e74705SXin Li 1. Parsing standard compiler command line arguments using the Driver library.
6*67e74705SXin Li
7*67e74705SXin Li 2. Constructing a Clang compiler instance, using the appropriate arguments
8*67e74705SXin Li    derived in step #1.
9*67e74705SXin Li
10*67e74705SXin Li 3. Invoking the Clang compiler to lex, parse, syntax check, and then generate
11*67e74705SXin Li    LLVM code.
12*67e74705SXin Li
13*67e74705SXin Li 4. Use the LLVM JIT functionality to execute the final module.
14*67e74705SXin Li
15*67e74705SXin LiThe implementation has many limitations and is not designed to be a full fledged
16*67e74705SXin LiC interpreter. It is designed to demonstrate a simple but functional use of the
17*67e74705SXin LiClang compiler libraries.
18