gcc/jit/docs/cp/index.rst

   1 .. Copyright (C) 2014-2015 Free Software Foundation, Inc.
   2    Originally contributed by David Malcolm <dmalcolm@redhat.com>
   3
   4    This is free software: you can redistribute it and/or modify it
   5    under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see
  16    <http://www.gnu.org/licenses/>.
  17
  18 C++ bindings for libgccjit
  19 ==========================
  20
  21 This document describes the C++ bindings to
  22 `libgccjit <http://gcc.gnu.org/wiki/JIT>`_, an API for embedding GCC
  23 inside programs and libraries.
  24
  25 The C++ bindings consist of a single header file ``libgccjit++.h``.
  26
  27 This is a collection of "thin" wrapper classes around the C API.
  28 Everything is an inline function, implemented in terms of the C API,
  29 so there is nothing extra to link against.
  30
  31 Note that libgccjit is currently of "Alpha" quality;
  32 the APIs are not yet set in stone, and they shouldn't be used in
  33 production yet.
  34
  35 Contents:
  36
  37 .. toctree::
  38    :maxdepth: 2
  39
  40    intro/index.rst
  41    topics/index.rst