Document libgccjit++.h

gcc/jit/ChangeLog:
	* docs/cp/index.rst: New file.
	* docs/cp/intro/index.rst: New file.
	* docs/cp/intro/tutorial01.rst: New file.
	* docs/cp/intro/tutorial02.rst: New file.
	* docs/cp/intro/tutorial03.rst: New file.
	* docs/cp/intro/tutorial04.rst: New file.
	* docs/cp/topics/contexts.rst: New file.
	* docs/cp/topics/expressions.rst: New file.
	* docs/cp/topics/functions.rst: New file.
	* docs/cp/topics/index.rst: New file.
	* docs/cp/topics/locations.rst: New file.
	* docs/cp/topics/objects.rst: New file.
	* docs/cp/topics/results.rst: New file.
	* docs/cp/topics/types.rst: New file.
	* docs/examples/tut01-hello-world.cc: New file.
	* docs/examples/tut02-square.c: Fix missing newline in output.
	* docs/examples/tut02-square.cc: New file.
	* docs/examples/tut03-sum-of-squares.cc: New file.
	* docs/examples/tut04-toyvm/toyvm.cc: New file.
	* docs/index.rst: Move summary to above the table of contents.
	Add text about the C vs C++ APIs.
	* docs/topics/contexts.rst: Fix a typo.

	* docs/_build/texinfo/libgccjit.texi: Regenerate.
	* docs/_build/texinfo/factorial1.png: New file.
	* docs/_build/texinfo/sum-of-squares1.png: New file.

From-SVN: r218588

1 files changed, 107 insertions, 0 deletions

diff --git a/gcc/jit/docs/examples/tut01-hello-world.cc b/gcc/jit/docs/examples/tut01-hello-world.cc
new file mode 100644
index 0000000..d70fe67
--- /dev/null
+++ b/gcc/jit/docs/examples/tut01-hello-world.cc
@@ -0,0 +1,107 @@
+/* Smoketest example for libgccjit.so C++ API
+   Copyright (C) 2014 Free Software Foundation, Inc.
+
+This file is part of GCC.
+
+GCC is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3, or (at your option)
+any later version.
+
+GCC is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GCC; see the file COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
+
+#include <libgccjit++.h>
+
+#include <stdlib.h>
+#include <stdio.h>
+
+static void
+create_code (gccjit::context ctxt)
+{
+  /* Let's try to inject the equivalent of this C code:
+     void
+     greet (const char *name)
+     {
+        printf ("hello %s\n", name);
+     }
+  */
+  gccjit::type void_type = ctxt.get_type (GCC_JIT_TYPE_VOID);
+  gccjit::type const_char_ptr_type =
+    ctxt.get_type (GCC_JIT_TYPE_CONST_CHAR_PTR);
+  gccjit::param param_name =
+    ctxt.new_param (const_char_ptr_type, "name");
+  std::vector<gccjit::param> func_params;
+  func_params.push_back (param_name);
+  gccjit::function func =
+    ctxt.new_function (GCC_JIT_FUNCTION_EXPORTED,
+                       void_type,
+                       "greet",
+                       func_params, 0);
+
+  gccjit::param param_format =
+    ctxt.new_param (const_char_ptr_type, "format");
+  std::vector<gccjit::param> printf_params;
+  printf_params.push_back (param_format);
+  gccjit::function printf_func =
+    ctxt.new_function (GCC_JIT_FUNCTION_IMPORTED,
+                       ctxt.get_type (GCC_JIT_TYPE_INT),
+                       "printf",
+                       printf_params, 1);
+
+  gccjit::block block = func.new_block ();
+  block.add_eval (ctxt.new_call (printf_func,
+                                 ctxt.new_rvalue ("hello %s\n"),
+                                 param_name));
+  block.end_with_return ();
+}
+
+int
+main (int argc, char **argv)
+{
+  gccjit::context ctxt;
+  gcc_jit_result *result;
+
+  /* Get a "context" object for working with the library.  */
+  ctxt = gccjit::context::acquire ();
+
+  /* Set some options on the context.
+     Turn this on to see the code being generated, in assembler form.  */
+  ctxt.set_bool_option (GCC_JIT_BOOL_OPTION_DUMP_GENERATED_CODE, 0);
+
+  /* Populate the context.  */
+  create_code (ctxt);
+
+  /* Compile the code.  */
+  result = ctxt.compile ();
+  if (!result)
+    {
+      fprintf (stderr, "NULL result");
+      exit (1);
+    }
+
+  ctxt.release ();
+
+  /* Extract the generated code from "result".  */
+  typedef void (*fn_type) (const char *);
+  fn_type greet =
+    (fn_type)gcc_jit_result_get_code (result, "greet");
+  if (!greet)
+    {
+      fprintf (stderr, "NULL greet");
+      exit (1);
+    }
+
+  /* Now call the generated function: */
+  greet ("world");
+  fflush (stdout);
+
+  gcc_jit_result_release (result);
+  return 0;
+}