From 7ef9618369ffd71826f093077eaae3f35c15755b Mon Sep 17 00:00:00 2001 From: David Malcolm Date: Thu, 5 Mar 2015 15:38:15 +0000 Subject: [PATCH] jit documentation fixes gcc/jit/ChangeLog: * docs/cp/intro/tutorial03.rst: Add missing arguments to gccjit::block::end_with_conditional call. Add on_true/on_false comments. Tweak the wording. * docs/intro/tutorial03.rst: Add missing arguments to gcc_jit_block_end_with_conditional call. Add some clarifying comments. * docs/topics/compilation.rst: Tweak the wording to avoid an ambiguous use of "this". * docs/topics/contexts.rst: Fix a typo. * docs/topics/expressions.rst (GCC_JIT_BINARY_OP_MINUS): Remove a stray backtick. * docs/_build/texinfo/libgccjit.texi: Regenerate. From-SVN: r221218 --- gcc/jit/ChangeLog | 15 + gcc/jit/docs/_build/texinfo/libgccjit.texi | 713 +++++++++++---------- gcc/jit/docs/cp/intro/tutorial03.rst | 10 +- gcc/jit/docs/intro/tutorial03.rst | 12 +- gcc/jit/docs/topics/compilation.rst | 2 +- gcc/jit/docs/topics/contexts.rst | 2 +- gcc/jit/docs/topics/expressions.rst | 2 +- 7 files changed, 398 insertions(+), 358 deletions(-) diff --git a/gcc/jit/ChangeLog b/gcc/jit/ChangeLog index 8bf675186a8..bced8ec97a8 100644 --- a/gcc/jit/ChangeLog +++ b/gcc/jit/ChangeLog @@ -1,3 +1,18 @@ +2015-03-05 David Malcolm + + * docs/cp/intro/tutorial03.rst: Add missing arguments to + gccjit::block::end_with_conditional call. Add on_true/on_false + comments. Tweak the wording. + * docs/intro/tutorial03.rst: Add missing arguments to + gcc_jit_block_end_with_conditional call. Add some clarifying + comments. + * docs/topics/compilation.rst: Tweak the wording to avoid an + ambiguous use of "this". + * docs/topics/contexts.rst: Fix a typo. + * docs/topics/expressions.rst (GCC_JIT_BINARY_OP_MINUS): Remove + a stray backtick. + * docs/_build/texinfo/libgccjit.texi: Regenerate. + 2015-02-24 Thomas Schwinge PR libgomp/64625 diff --git a/gcc/jit/docs/_build/texinfo/libgccjit.texi b/gcc/jit/docs/_build/texinfo/libgccjit.texi index 37ff69070c9..4da623716e6 100644 --- a/gcc/jit/docs/_build/texinfo/libgccjit.texi +++ b/gcc/jit/docs/_build/texinfo/libgccjit.texi @@ -19,7 +19,7 @@ @copying @quotation -libgccjit 5.0.0 (experimental 20150204), February 04, 2015 +libgccjit 5.0.0 (experimental 20150305), March 05, 2015 David Malcolm @@ -1432,12 +1432,13 @@ one of two destination blocks depending on a boolean We build the comparison using @pxref{2c,,gcc_jit_context_new_comparison()}: @example -gcc_jit_rvalue *guard = - gcc_jit_context_new_comparison ( - ctxt, NULL, - GCC_JIT_COMPARISON_GE, - gcc_jit_lvalue_as_rvalue (i), - gcc_jit_param_as_rvalue (n)); +/* (i >= n) */ + gcc_jit_rvalue *guard = + gcc_jit_context_new_comparison ( + ctxt, NULL, + GCC_JIT_COMPARISON_GE, + gcc_jit_lvalue_as_rvalue (i), + gcc_jit_param_as_rvalue (n)); @end example @noindent @@ -1446,7 +1447,16 @@ and can then use this to add @cite{b_loop_cond}'s sole statement, via @pxref{2d,,gcc_jit_block_end_with_conditional()}: @example -gcc_jit_block_end_with_conditional (b_loop_cond, NULL, guard); +/* Equivalent to: + if (guard) + goto after_loop; + else + goto loop_body; */ +gcc_jit_block_end_with_conditional ( + b_loop_cond, NULL, + guard, + b_after_loop, /* on_true */ + b_loop_body); /* on_false */ @end example @noindent @@ -5040,7 +5050,7 @@ If no errors occurred, this will be NULL. @end deffn If you are wrapping the C API for a higher-level language that supports -exception-handling, you may instead by interested in the last error that +exception-handling, you may instead be interested in the last error that occurred on the context, so that you can embed this in an exception: @geindex gcc_jit_context_get_last_error (C function) @@ -6381,7 +6391,7 @@ C equivalent @item -@code{GCC_JIT_BINARY_OP_MINUS} +@pxref{95,,GCC_JIT_BINARY_OP_MINUS} @tab @@ -6389,7 +6399,7 @@ C equivalent @item -@pxref{95,,GCC_JIT_BINARY_OP_MULT} +@pxref{96,,GCC_JIT_BINARY_OP_MULT} @tab @@ -6397,7 +6407,7 @@ C equivalent @item -@pxref{96,,GCC_JIT_BINARY_OP_DIVIDE} +@pxref{97,,GCC_JIT_BINARY_OP_DIVIDE} @tab @@ -6405,7 +6415,7 @@ C equivalent @item -@pxref{97,,GCC_JIT_BINARY_OP_MODULO} +@pxref{98,,GCC_JIT_BINARY_OP_MODULO} @tab @@ -6413,7 +6423,7 @@ C equivalent @item -@pxref{98,,GCC_JIT_BINARY_OP_BITWISE_AND} +@pxref{99,,GCC_JIT_BINARY_OP_BITWISE_AND} @tab @@ -6421,7 +6431,7 @@ C equivalent @item -@pxref{99,,GCC_JIT_BINARY_OP_BITWISE_XOR} +@pxref{9a,,GCC_JIT_BINARY_OP_BITWISE_XOR} @tab @@ -6429,7 +6439,7 @@ C equivalent @item -@pxref{9a,,GCC_JIT_BINARY_OP_BITWISE_OR} +@pxref{9b,,GCC_JIT_BINARY_OP_BITWISE_OR} @tab @@ -6437,7 +6447,7 @@ C equivalent @item -@pxref{9b,,GCC_JIT_BINARY_OP_LOGICAL_AND} +@pxref{9c,,GCC_JIT_BINARY_OP_LOGICAL_AND} @tab @@ -6445,7 +6455,7 @@ C equivalent @item -@pxref{9c,,GCC_JIT_BINARY_OP_LOGICAL_OR} +@pxref{9d,,GCC_JIT_BINARY_OP_LOGICAL_OR} @tab @@ -6453,7 +6463,7 @@ C equivalent @item -@pxref{9d,,GCC_JIT_BINARY_OP_LSHIFT} +@pxref{9e,,GCC_JIT_BINARY_OP_LSHIFT} @tab @@ -6461,7 +6471,7 @@ C equivalent @item -@pxref{9e,,GCC_JIT_BINARY_OP_RSHIFT} +@pxref{9f,,GCC_JIT_BINARY_OP_RSHIFT} @tab @@ -6484,11 +6494,12 @@ Addition of arithmetic values; analogous to: in C. -For pointer addition, use @pxref{9f,,gcc_jit_context_new_array_access()}. +For pointer addition, use @pxref{a0,,gcc_jit_context_new_array_access()}. @end deffn - -@deffn {C Macro} GCC_JIT_BINARY_OP_MINUS` +@geindex GCC_JIT_BINARY_OP_MINUS (C macro) +@anchor{topics/expressions GCC_JIT_BINARY_OP_MINUS}@anchor{95} +@deffn {C Macro} GCC_JIT_BINARY_OP_MINUS Subtraction of arithmetic values; analogous to: @@ -6502,7 +6513,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_MULT (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_MULT}@anchor{95} +@anchor{topics/expressions GCC_JIT_BINARY_OP_MULT}@anchor{96} @deffn {C Macro} GCC_JIT_BINARY_OP_MULT Multiplication of a pair of arithmetic values; analogous to: @@ -6517,7 +6528,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_DIVIDE (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_DIVIDE}@anchor{96} +@anchor{topics/expressions GCC_JIT_BINARY_OP_DIVIDE}@anchor{97} @deffn {C Macro} GCC_JIT_BINARY_OP_DIVIDE Quotient of division of arithmetic values; analogous to: @@ -6536,7 +6547,7 @@ a floating-point result type indicates floating-point division. @end deffn @geindex GCC_JIT_BINARY_OP_MODULO (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_MODULO}@anchor{97} +@anchor{topics/expressions GCC_JIT_BINARY_OP_MODULO}@anchor{98} @deffn {C Macro} GCC_JIT_BINARY_OP_MODULO Remainder of division of arithmetic values; analogous to: @@ -6551,7 +6562,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_BITWISE_AND (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_AND}@anchor{98} +@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_AND}@anchor{99} @deffn {C Macro} GCC_JIT_BINARY_OP_BITWISE_AND Bitwise AND; analogous to: @@ -6566,7 +6577,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_BITWISE_XOR (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_XOR}@anchor{99} +@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_XOR}@anchor{9a} @deffn {C Macro} GCC_JIT_BINARY_OP_BITWISE_XOR Bitwise exclusive OR; analogous to: @@ -6581,7 +6592,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_BITWISE_OR (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_OR}@anchor{9a} +@anchor{topics/expressions GCC_JIT_BINARY_OP_BITWISE_OR}@anchor{9b} @deffn {C Macro} GCC_JIT_BINARY_OP_BITWISE_OR Bitwise inclusive OR; analogous to: @@ -6596,7 +6607,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_LOGICAL_AND (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_LOGICAL_AND}@anchor{9b} +@anchor{topics/expressions GCC_JIT_BINARY_OP_LOGICAL_AND}@anchor{9c} @deffn {C Macro} GCC_JIT_BINARY_OP_LOGICAL_AND Logical AND; analogous to: @@ -6611,7 +6622,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_LOGICAL_OR (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_LOGICAL_OR}@anchor{9c} +@anchor{topics/expressions GCC_JIT_BINARY_OP_LOGICAL_OR}@anchor{9d} @deffn {C Macro} GCC_JIT_BINARY_OP_LOGICAL_OR Logical OR; analogous to: @@ -6626,7 +6637,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_LSHIFT (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_LSHIFT}@anchor{9d} +@anchor{topics/expressions GCC_JIT_BINARY_OP_LSHIFT}@anchor{9e} @deffn {C Macro} GCC_JIT_BINARY_OP_LSHIFT Left shift; analogous to: @@ -6641,7 +6652,7 @@ in C. @end deffn @geindex GCC_JIT_BINARY_OP_RSHIFT (C macro) -@anchor{topics/expressions GCC_JIT_BINARY_OP_RSHIFT}@anchor{9e} +@anchor{topics/expressions GCC_JIT_BINARY_OP_RSHIFT}@anchor{9f} @deffn {C Macro} GCC_JIT_BINARY_OP_RSHIFT Right shift; analogous to: @@ -6656,7 +6667,7 @@ in C. @end deffn @node Comparisons,Function calls,Binary Operations,Rvalues -@anchor{topics/expressions comparisons}@anchor{a0} +@anchor{topics/expressions comparisons}@anchor{a1} @subsubsection Comparisons @@ -6668,7 +6679,7 @@ Build a boolean rvalue out of the comparison of two other rvalues. @end deffn @geindex gcc_jit_comparison (C type) -@anchor{topics/expressions gcc_jit_comparison}@anchor{a1} +@anchor{topics/expressions gcc_jit_comparison}@anchor{a2} @deffn {C Type} enum gcc_jit_comparison @end deffn @@ -6734,12 +6745,12 @@ C equivalent @node Function calls,Type-coercion,Comparisons,Rvalues -@anchor{topics/expressions function-calls}@anchor{a2} +@anchor{topics/expressions function-calls}@anchor{a3} @subsubsection Function calls @geindex gcc_jit_context_new_call (C function) -@anchor{topics/expressions gcc_jit_context_new_call}@anchor{a3} +@anchor{topics/expressions gcc_jit_context_new_call}@anchor{a4} @deffn {C Function} gcc_jit_rvalue * gcc_jit_context_new_call (gcc_jit_context@w{ }*ctxt, gcc_jit_location@w{ }*loc, gcc_jit_function@w{ }*func, int@w{ }numargs, gcc_jit_rvalue@w{ }**args) Given a function and the given table of argument rvalues, construct a @@ -6747,7 +6758,7 @@ call to the function, with the result as an rvalue. @cartouche @quotation Note -@pxref{a3,,gcc_jit_context_new_call()} merely builds a +@pxref{a4,,gcc_jit_context_new_call()} merely builds a @pxref{13,,gcc_jit_rvalue} i.e. an expression that can be evaluated, perhaps as part of a more complicated expression. The call @emph{won't} happen unless you add a statement to a function @@ -6755,7 +6766,7 @@ that evaluates the expression. For example, if you want to call a function and discard the result (or to call a function with @code{void} return type), use -@pxref{a4,,gcc_jit_block_add_eval()}: +@pxref{a5,,gcc_jit_block_add_eval()}: @example /* Add "(void)printf (arg0, arg1);". */ @@ -6774,12 +6785,12 @@ gcc_jit_block_add_eval ( @end deffn @node Type-coercion,,Function calls,Rvalues -@anchor{topics/expressions type-coercion}@anchor{a5} +@anchor{topics/expressions type-coercion}@anchor{a6} @subsubsection Type-coercion @geindex gcc_jit_context_new_cast (C function) -@anchor{topics/expressions gcc_jit_context_new_cast}@anchor{a6} +@anchor{topics/expressions gcc_jit_context_new_cast}@anchor{a7} @deffn {C Function} gcc_jit_rvalue * gcc_jit_context_new_cast (gcc_jit_context@w{ }*ctxt, gcc_jit_location@w{ }*loc, gcc_jit_rvalue@w{ }*rvalue, gcc_jit_type@w{ }*type) Given an rvalue of T, construct another rvalue of another type. @@ -6804,7 +6815,7 @@ P* <-> Q*, for pointer types P and Q @end deffn @node Lvalues,Working with pointers structs and unions,Rvalues,Expressions -@anchor{topics/expressions lvalues}@anchor{a7} +@anchor{topics/expressions lvalues}@anchor{a8} @subsection Lvalues @@ -6818,21 +6829,21 @@ a storage area (such as a variable). It is also usable as an rvalue, where the rvalue is computed by reading from the storage area. @geindex gcc_jit_lvalue_as_object (C function) -@anchor{topics/expressions gcc_jit_lvalue_as_object}@anchor{a8} +@anchor{topics/expressions gcc_jit_lvalue_as_object}@anchor{a9} @deffn {C Function} gcc_jit_object * gcc_jit_lvalue_as_object (gcc_jit_lvalue@w{ }*lvalue) Upcast an lvalue to be an object. @end deffn @geindex gcc_jit_lvalue_as_rvalue (C function) -@anchor{topics/expressions gcc_jit_lvalue_as_rvalue}@anchor{a9} +@anchor{topics/expressions gcc_jit_lvalue_as_rvalue}@anchor{aa} @deffn {C Function} gcc_jit_rvalue * gcc_jit_lvalue_as_rvalue (gcc_jit_lvalue@w{ }*lvalue) Upcast an lvalue to be an rvalue. @end deffn @geindex gcc_jit_lvalue_get_address (C function) -@anchor{topics/expressions gcc_jit_lvalue_get_address}@anchor{aa} +@anchor{topics/expressions gcc_jit_lvalue_get_address}@anchor{ab} @deffn {C Function} gcc_jit_rvalue * gcc_jit_lvalue_get_address (gcc_jit_lvalue@w{ }*lvalue, gcc_jit_location@w{ }*loc) Take the address of an lvalue; analogous to: @@ -6852,12 +6863,12 @@ in C. @end menu @node Global variables,,,Lvalues -@anchor{topics/expressions global-variables}@anchor{ab} +@anchor{topics/expressions global-variables}@anchor{ac} @subsubsection Global variables @geindex gcc_jit_context_new_global (C function) -@anchor{topics/expressions gcc_jit_context_new_global}@anchor{ac} +@anchor{topics/expressions gcc_jit_context_new_global}@anchor{ad} @deffn {C Function} gcc_jit_lvalue * gcc_jit_context_new_global (gcc_jit_context@w{ }*ctxt, gcc_jit_location@w{ }*loc, enum gcc_jit_global_kind@w{ }kind, gcc_jit_type@w{ }*type, const char@w{ }*name) Add a new global variable of the given type and name to the context. @@ -6866,22 +6877,22 @@ The "kind" parameter determines the visibility of the "global" outside of the @pxref{16,,gcc_jit_result}: @geindex gcc_jit_global_kind (C type) -@anchor{topics/expressions gcc_jit_global_kind}@anchor{ad} +@anchor{topics/expressions gcc_jit_global_kind}@anchor{ae} @deffn {C Type} enum gcc_jit_global_kind @end deffn @geindex GCC_JIT_GLOBAL_EXPORTED (C macro) -@anchor{topics/expressions GCC_JIT_GLOBAL_EXPORTED}@anchor{ae} +@anchor{topics/expressions GCC_JIT_GLOBAL_EXPORTED}@anchor{af} @deffn {C Macro} GCC_JIT_GLOBAL_EXPORTED Global is defined by the client code and is visible by name outside of this JIT context via -@pxref{af,,gcc_jit_result_get_global()} (and this value is required for +@pxref{b0,,gcc_jit_result_get_global()} (and this value is required for the global to be accessible via that entrypoint). @end deffn @geindex GCC_JIT_GLOBAL_INTERNAL (C macro) -@anchor{topics/expressions GCC_JIT_GLOBAL_INTERNAL}@anchor{b0} +@anchor{topics/expressions GCC_JIT_GLOBAL_INTERNAL}@anchor{b1} @deffn {C Macro} GCC_JIT_GLOBAL_INTERNAL Global is defined by the client code, but is invisible @@ -6891,7 +6902,7 @@ context and within child contexts. @end deffn @geindex GCC_JIT_GLOBAL_IMPORTED (C macro) -@anchor{topics/expressions GCC_JIT_GLOBAL_IMPORTED}@anchor{b1} +@anchor{topics/expressions GCC_JIT_GLOBAL_IMPORTED}@anchor{b2} @deffn {C Macro} GCC_JIT_GLOBAL_IMPORTED Global is not defined by the client code; we're merely @@ -6901,12 +6912,12 @@ header file. @end deffn @node Working with pointers structs and unions,,Lvalues,Expressions -@anchor{topics/expressions working-with-pointers-structs-and-unions}@anchor{b2} +@anchor{topics/expressions working-with-pointers-structs-and-unions}@anchor{b3} @subsection Working with pointers, structs and unions @geindex gcc_jit_rvalue_dereference (C function) -@anchor{topics/expressions gcc_jit_rvalue_dereference}@anchor{b3} +@anchor{topics/expressions gcc_jit_rvalue_dereference}@anchor{b4} @deffn {C Function} gcc_jit_lvalue * gcc_jit_rvalue_dereference (gcc_jit_rvalue@w{ }*rvalue, gcc_jit_location@w{ }*loc) Given an rvalue of pointer type @code{T *}, dereferencing the pointer, @@ -6924,7 +6935,7 @@ in C. Field access is provided separately for both lvalues and rvalues. @geindex gcc_jit_lvalue_access_field (C function) -@anchor{topics/expressions gcc_jit_lvalue_access_field}@anchor{b4} +@anchor{topics/expressions gcc_jit_lvalue_access_field}@anchor{b5} @deffn {C Function} gcc_jit_lvalue * gcc_jit_lvalue_access_field (gcc_jit_lvalue@w{ }*struct_, gcc_jit_location@w{ }*loc, gcc_jit_field@w{ }*field) Given an lvalue of struct or union type, access the given field, @@ -6940,7 +6951,7 @@ in C. @end deffn @geindex gcc_jit_rvalue_access_field (C function) -@anchor{topics/expressions gcc_jit_rvalue_access_field}@anchor{b5} +@anchor{topics/expressions gcc_jit_rvalue_access_field}@anchor{b6} @deffn {C Function} gcc_jit_rvalue * gcc_jit_rvalue_access_field (gcc_jit_rvalue@w{ }*struct_, gcc_jit_location@w{ }*loc, gcc_jit_field@w{ }*field) Given an rvalue of struct or union type, access the given field @@ -6956,7 +6967,7 @@ in C. @end deffn @geindex gcc_jit_rvalue_dereference_field (C function) -@anchor{topics/expressions gcc_jit_rvalue_dereference_field}@anchor{b6} +@anchor{topics/expressions gcc_jit_rvalue_dereference_field}@anchor{b7} @deffn {C Function} gcc_jit_lvalue * gcc_jit_rvalue_dereference_field (gcc_jit_rvalue@w{ }*ptr, gcc_jit_location@w{ }*loc, gcc_jit_field@w{ }*field) Given an rvalue of pointer type @code{T *} where T is of struct or union @@ -6972,7 +6983,7 @@ in C, itself equivalent to @code{(*EXPR).FIELD}. @end deffn @geindex gcc_jit_context_new_array_access (C function) -@anchor{topics/expressions gcc_jit_context_new_array_access}@anchor{9f} +@anchor{topics/expressions gcc_jit_context_new_array_access}@anchor{a0} @deffn {C Function} gcc_jit_lvalue * gcc_jit_context_new_array_access (gcc_jit_context@w{ }*ctxt, gcc_jit_location@w{ }*loc, gcc_jit_rvalue@w{ }*ptr, gcc_jit_rvalue@w{ }*index) Given an rvalue of pointer type @code{T *}, get at the element @cite{T} at @@ -7007,7 +7018,7 @@ in C (or, indeed, to @code{PTR + INDEX}). @c . @node Creating and using functions,Source Locations,Expressions,Topic Reference -@anchor{topics/functions doc}@anchor{b7}@anchor{topics/functions creating-and-using-functions}@anchor{b8} +@anchor{topics/functions doc}@anchor{b8}@anchor{topics/functions creating-and-using-functions}@anchor{b9} @section Creating and using functions @@ -7020,7 +7031,7 @@ in C (or, indeed, to @code{PTR + INDEX}). @end menu @node Params,Functions,,Creating and using functions -@anchor{topics/functions params}@anchor{b9} +@anchor{topics/functions params}@anchor{ba} @subsection Params @@ -7043,28 +7054,28 @@ Parameters are lvalues, and thus are also rvalues (and objects), so the following upcasts are available: @geindex gcc_jit_param_as_lvalue (C function) -@anchor{topics/functions gcc_jit_param_as_lvalue}@anchor{ba} +@anchor{topics/functions gcc_jit_param_as_lvalue}@anchor{bb} @deffn {C Function} gcc_jit_lvalue * gcc_jit_param_as_lvalue (gcc_jit_param@w{ }*param) Upcasting from param to lvalue. @end deffn @geindex gcc_jit_param_as_rvalue (C function) -@anchor{topics/functions gcc_jit_param_as_rvalue}@anchor{bb} +@anchor{topics/functions gcc_jit_param_as_rvalue}@anchor{bc} @deffn {C Function} gcc_jit_rvalue * gcc_jit_param_as_rvalue (gcc_jit_param@w{ }*param) Upcasting from param to rvalue. @end deffn @geindex gcc_jit_param_as_object (C function) -@anchor{topics/functions gcc_jit_param_as_object}@anchor{bc} +@anchor{topics/functions gcc_jit_param_as_object}@anchor{bd} @deffn {C Function} gcc_jit_object * gcc_jit_param_as_object (gcc_jit_param@w{ }*param) Upcasting from param to object. @end deffn @node Functions,Blocks,Params,Creating and using functions -@anchor{topics/functions functions}@anchor{bd} +@anchor{topics/functions functions}@anchor{be} @subsection Functions @@ -7083,7 +7094,7 @@ creating ourselves, or one that we're referencing. Create a gcc_jit_function with the given name and parameters. @geindex gcc_jit_function_kind (C type) -@anchor{topics/functions gcc_jit_function_kind}@anchor{be} +@anchor{topics/functions gcc_jit_function_kind}@anchor{bf} @deffn {C Type} enum gcc_jit_function_kind @end deffn @@ -7093,7 +7104,7 @@ values: @quotation @geindex GCC_JIT_FUNCTION_EXPORTED (C macro) -@anchor{topics/functions GCC_JIT_FUNCTION_EXPORTED}@anchor{bf} +@anchor{topics/functions GCC_JIT_FUNCTION_EXPORTED}@anchor{c0} @deffn {C Macro} GCC_JIT_FUNCTION_EXPORTED Function is defined by the client code and visible @@ -7105,7 +7116,7 @@ for this function from a @pxref{16,,gcc_jit_result} via @end deffn @geindex GCC_JIT_FUNCTION_INTERNAL (C macro) -@anchor{topics/functions GCC_JIT_FUNCTION_INTERNAL}@anchor{c0} +@anchor{topics/functions GCC_JIT_FUNCTION_INTERNAL}@anchor{c1} @deffn {C Macro} GCC_JIT_FUNCTION_INTERNAL Function is defined by the client code, but is invisible @@ -7113,7 +7124,7 @@ outside of the JIT. Analogous to a "static" function. @end deffn @geindex GCC_JIT_FUNCTION_IMPORTED (C macro) -@anchor{topics/functions GCC_JIT_FUNCTION_IMPORTED}@anchor{c1} +@anchor{topics/functions GCC_JIT_FUNCTION_IMPORTED}@anchor{c2} @deffn {C Macro} GCC_JIT_FUNCTION_IMPORTED Function is not defined by the client code; we're merely @@ -7122,7 +7133,7 @@ header file. @end deffn @geindex GCC_JIT_FUNCTION_ALWAYS_INLINE (C macro) -@anchor{topics/functions GCC_JIT_FUNCTION_ALWAYS_INLINE}@anchor{c2} +@anchor{topics/functions GCC_JIT_FUNCTION_ALWAYS_INLINE}@anchor{c3} @deffn {C Macro} GCC_JIT_FUNCTION_ALWAYS_INLINE Function is only ever inlined into other functions, and is @@ -7139,19 +7150,19 @@ same as GCC_JIT_FUNCTION_INTERNAL. @end deffn @geindex gcc_jit_context_get_builtin_function (C function) -@anchor{topics/functions gcc_jit_context_get_builtin_function}@anchor{c3} +@anchor{topics/functions gcc_jit_context_get_builtin_function}@anchor{c4} @deffn {C Function} gcc_jit_function *gcc_jit_context_get_builtin_function (gcc_jit_context@w{ }*ctxt, const char@w{ }*name) @end deffn @geindex gcc_jit_function_as_object (C function) -@anchor{topics/functions gcc_jit_function_as_object}@anchor{c4} +@anchor{topics/functions gcc_jit_function_as_object}@anchor{c5} @deffn {C Function} gcc_jit_object * gcc_jit_function_as_object (gcc_jit_function@w{ }*func) Upcasting from function to object. @end deffn @geindex gcc_jit_function_get_param (C function) -@anchor{topics/functions gcc_jit_function_get_param}@anchor{c5} +@anchor{topics/functions gcc_jit_function_get_param}@anchor{c6} @deffn {C Function} gcc_jit_param * gcc_jit_function_get_param (gcc_jit_function@w{ }*func, int@w{ }index) Get the param of the given index (0-based). @@ -7173,7 +7184,7 @@ name. @end deffn @node Blocks,Statements,Functions,Creating and using functions -@anchor{topics/functions blocks}@anchor{c6} +@anchor{topics/functions blocks}@anchor{c7} @subsection Blocks @@ -7196,7 +7207,7 @@ one function. @end deffn @geindex gcc_jit_function_new_block (C function) -@anchor{topics/functions gcc_jit_function_new_block}@anchor{c7} +@anchor{topics/functions gcc_jit_function_new_block}@anchor{c8} @deffn {C Function} gcc_jit_block * gcc_jit_function_new_block (gcc_jit_function@w{ }*func, const char@w{ }*name) Create a basic block of the given name. The name may be NULL, but @@ -7206,26 +7217,26 @@ messages. @end deffn @geindex gcc_jit_block_as_object (C function) -@anchor{topics/functions gcc_jit_block_as_object}@anchor{c8} +@anchor{topics/functions gcc_jit_block_as_object}@anchor{c9} @deffn {C Function} gcc_jit_object * gcc_jit_block_as_object (gcc_jit_block@w{ }*block) Upcast from block to object. @end deffn @geindex gcc_jit_block_get_function (C function) -@anchor{topics/functions gcc_jit_block_get_function}@anchor{c9} +@anchor{topics/functions gcc_jit_block_get_function}@anchor{ca} @deffn {C Function} gcc_jit_function * gcc_jit_block_get_function (gcc_jit_block@w{ }*block) Which function is this block within? @end deffn @node Statements,,Blocks,Creating and using functions -@anchor{topics/functions statements}@anchor{ca} +@anchor{topics/functions statements}@anchor{cb} @subsection Statements @geindex gcc_jit_block_add_eval (C function) -@anchor{topics/functions gcc_jit_block_add_eval}@anchor{a4} +@anchor{topics/functions gcc_jit_block_add_eval}@anchor{a5} @deffn {C Function} void gcc_jit_block_add_eval (gcc_jit_block@w{ }*block, gcc_jit_location@w{ }*loc, gcc_jit_rvalue@w{ }*rvalue) Add evaluation of an rvalue, discarding the result @@ -7321,7 +7332,7 @@ block, boolval, on_true, and on_false must be non-NULL. @end deffn @geindex gcc_jit_block_end_with_jump (C function) -@anchor{topics/functions gcc_jit_block_end_with_jump}@anchor{cb} +@anchor{topics/functions gcc_jit_block_end_with_jump}@anchor{cc} @deffn {C Function} void gcc_jit_block_end_with_jump (gcc_jit_block@w{ }*block, gcc_jit_location@w{ }*loc, gcc_jit_block@w{ }*target) Terminate a block by adding a jump to the given target block. @@ -7336,7 +7347,7 @@ goto target; @end deffn @geindex gcc_jit_block_end_with_return (C function) -@anchor{topics/functions gcc_jit_block_end_with_return}@anchor{cc} +@anchor{topics/functions gcc_jit_block_end_with_return}@anchor{cd} @deffn {C Function} void gcc_jit_block_end_with_return (gcc_jit_block@w{ }*block, gcc_jit_location@w{ }*loc, gcc_jit_rvalue@w{ }*rvalue) Terminate a block by adding evaluation of an rvalue, returning the value. @@ -7351,7 +7362,7 @@ return expression; @end deffn @geindex gcc_jit_block_end_with_void_return (C function) -@anchor{topics/functions gcc_jit_block_end_with_void_return}@anchor{cd} +@anchor{topics/functions gcc_jit_block_end_with_void_return}@anchor{ce} @deffn {C Function} void gcc_jit_block_end_with_void_return (gcc_jit_block@w{ }*block, gcc_jit_location@w{ }*loc) Terminate a block by adding a valueless return, for use within a function @@ -7384,7 +7395,7 @@ return; @c . @node Source Locations,Compiling a context,Creating and using functions,Topic Reference -@anchor{topics/locations source-locations}@anchor{ce}@anchor{topics/locations doc}@anchor{cf} +@anchor{topics/locations source-locations}@anchor{cf}@anchor{topics/locations doc}@anchor{d0} @section Source Locations @@ -7430,7 +7441,7 @@ location. @end menu @node Faking it,,,Source Locations -@anchor{topics/locations faking-it}@anchor{d0} +@anchor{topics/locations faking-it}@anchor{d1} @subsection Faking it @@ -7468,7 +7479,7 @@ file, giving you @emph{something} you can step through in the debugger. @c . @node Compiling a context,,Source Locations,Topic Reference -@anchor{topics/compilation compiling-a-context}@anchor{d1}@anchor{topics/compilation doc}@anchor{d2} +@anchor{topics/compilation compiling-a-context}@anchor{d2}@anchor{topics/compilation doc}@anchor{d3} @section Compiling a context @@ -7487,7 +7498,7 @@ prevent any future compilation of that context. @end menu @node In-memory compilation,Ahead-of-time compilation,,Compiling a context -@anchor{topics/compilation in-memory-compilation}@anchor{d3} +@anchor{topics/compilation in-memory-compilation}@anchor{d4} @subsection In-memory compilation @@ -7498,7 +7509,7 @@ prevent any future compilation of that context. This calls into GCC and builds the code, returning a @cite{gcc_jit_result *}. -If this is non-NULL, the caller becomes responsible for +If the result is non-NULL, the caller becomes responsible for calling @pxref{39,,gcc_jit_result_release()} on it once they're done with it. @end deffn @@ -7522,7 +7533,7 @@ Functions are looked up by name. For this to succeed, a function with a name matching @cite{funcname} must have been created on @cite{result}'s context (or a parent context) via a call to @pxref{11,,gcc_jit_context_new_function()} with @cite{kind} -@pxref{bf,,GCC_JIT_FUNCTION_EXPORTED}: +@pxref{c0,,GCC_JIT_FUNCTION_EXPORTED}: @example gcc_jit_context_new_function (ctxt, @@ -7552,7 +7563,7 @@ to a segmentation fault. @end deffn @geindex gcc_jit_result_get_global (C function) -@anchor{topics/compilation gcc_jit_result_get_global}@anchor{af} +@anchor{topics/compilation gcc_jit_result_get_global}@anchor{b0} @deffn {C Function} void * gcc_jit_result_get_global (gcc_jit_result@w{ }*result, const char@w{ }*name) Locate a given global within the built machine code. @@ -7560,8 +7571,8 @@ Locate a given global within the built machine code. Globals are looked up by name. For this to succeed, a global with a name matching @cite{name} must have been created on @cite{result}'s context (or a parent context) via a call to -@pxref{ac,,gcc_jit_context_new_global()} with @cite{kind} -@pxref{ae,,GCC_JIT_GLOBAL_EXPORTED}. +@pxref{ad,,gcc_jit_context_new_global()} with @cite{kind} +@pxref{af,,GCC_JIT_GLOBAL_EXPORTED}. If the global is found, the result will need to be cast to a pointer of the correct type before it can be called. @@ -7609,11 +7620,11 @@ Once we're done with the code, this unloads the built .so file. This cleans up the result; after calling this, it's no longer valid to use the result, or any code or globals that were obtained by calling @pxref{17,,gcc_jit_result_get_code()} or -@pxref{af,,gcc_jit_result_get_global()} on it. +@pxref{b0,,gcc_jit_result_get_global()} on it. @end deffn @node Ahead-of-time compilation,,In-memory compilation,Compiling a context -@anchor{topics/compilation ahead-of-time-compilation}@anchor{d4} +@anchor{topics/compilation ahead-of-time-compilation}@anchor{d5} @subsection Ahead-of-time compilation @@ -7642,7 +7653,7 @@ suffix of the output file when determining what to do. @end cartouche @geindex gcc_jit_output_kind (C type) -@anchor{topics/compilation gcc_jit_output_kind}@anchor{d5} +@anchor{topics/compilation gcc_jit_output_kind}@anchor{d6} @deffn {C Type} enum gcc_jit_output_kind @end deffn @@ -7660,7 +7671,7 @@ Typical suffix @item -@pxref{d6,,GCC_JIT_OUTPUT_KIND_ASSEMBLER} +@pxref{d7,,GCC_JIT_OUTPUT_KIND_ASSEMBLER} @tab @@ -7668,7 +7679,7 @@ Typical suffix @item -@pxref{d7,,GCC_JIT_OUTPUT_KIND_OBJECT_FILE} +@pxref{d8,,GCC_JIT_OUTPUT_KIND_OBJECT_FILE} @tab @@ -7676,7 +7687,7 @@ Typical suffix @item -@pxref{d8,,GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY} +@pxref{d9,,GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY} @tab @@ -7684,7 +7695,7 @@ Typical suffix @item -@pxref{d9,,GCC_JIT_OUTPUT_KIND_EXECUTABLE} +@pxref{da,,GCC_JIT_OUTPUT_KIND_EXECUTABLE} @tab @@ -7694,21 +7705,21 @@ None, or .exe @geindex GCC_JIT_OUTPUT_KIND_ASSEMBLER (C macro) -@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_ASSEMBLER}@anchor{d6} +@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_ASSEMBLER}@anchor{d7} @deffn {C Macro} GCC_JIT_OUTPUT_KIND_ASSEMBLER Compile the context to an assembler file. @end deffn @geindex GCC_JIT_OUTPUT_KIND_OBJECT_FILE (C macro) -@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_OBJECT_FILE}@anchor{d7} +@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_OBJECT_FILE}@anchor{d8} @deffn {C Macro} GCC_JIT_OUTPUT_KIND_OBJECT_FILE Compile the context to an object file. @end deffn @geindex GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY (C macro) -@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY}@anchor{d8} +@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY}@anchor{d9} @deffn {C Macro} GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY Compile the context to a dynamic library. @@ -7718,7 +7729,7 @@ against. @end deffn @geindex GCC_JIT_OUTPUT_KIND_EXECUTABLE (C macro) -@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_EXECUTABLE}@anchor{d9} +@anchor{topics/compilation GCC_JIT_OUTPUT_KIND_EXECUTABLE}@anchor{da} @deffn {C Macro} GCC_JIT_OUTPUT_KIND_EXECUTABLE Compile the context to an executable. @@ -7745,7 +7756,7 @@ against. @c . @node C++ bindings for libgccjit,Internals,Topic Reference,Top -@anchor{cp/index c-bindings-for-libgccjit}@anchor{da}@anchor{cp/index doc}@anchor{db} +@anchor{cp/index c-bindings-for-libgccjit}@anchor{db}@anchor{cp/index doc}@anchor{dc} @chapter C++ bindings for libgccjit @@ -7892,7 +7903,7 @@ Compiling a context @node Tutorial<2>,Topic Reference<2>,,C++ bindings for libgccjit -@anchor{cp/intro/index doc}@anchor{dc}@anchor{cp/intro/index tutorial}@anchor{dd} +@anchor{cp/intro/index doc}@anchor{dd}@anchor{cp/intro/index tutorial}@anchor{de} @section Tutorial @@ -7922,7 +7933,7 @@ Compiling a context @end menu @node Tutorial part 1 "Hello world"<2>,Tutorial part 2 Creating a trivial machine code function<2>,,Tutorial<2> -@anchor{cp/intro/tutorial01 doc}@anchor{de}@anchor{cp/intro/tutorial01 tutorial-part-1-hello-world}@anchor{df} +@anchor{cp/intro/tutorial01 doc}@anchor{df}@anchor{cp/intro/tutorial01 tutorial-part-1-hello-world}@anchor{e0} @subsection Tutorial part 1: "Hello world" @@ -8092,7 +8103,7 @@ hello world @c . @node Tutorial part 2 Creating a trivial machine code function<2>,Tutorial part 3 Loops and variables<2>,Tutorial part 1 "Hello world"<2>,Tutorial<2> -@anchor{cp/intro/tutorial02 doc}@anchor{e0}@anchor{cp/intro/tutorial02 tutorial-part-2-creating-a-trivial-machine-code-function}@anchor{e1} +@anchor{cp/intro/tutorial02 doc}@anchor{e1}@anchor{cp/intro/tutorial02 tutorial-part-2-creating-a-trivial-machine-code-function}@anchor{e2} @subsection Tutorial part 2: Creating a trivial machine code function @@ -8121,7 +8132,7 @@ All state associated with compilation is associated with a @code{gccjit::context}, which is a thin C++ wrapper around the C API's @pxref{8,,gcc_jit_context *}. -Create one using @pxref{e2,,gccjit;;context;;acquire()}: +Create one using @pxref{e3,,gccjit;;context;;acquire()}: @example gccjit::context ctxt; @@ -8134,7 +8145,7 @@ The JIT library has a system of types. It is statically-typed: every expression is of a specific type, fixed at compile-time. In our example, all of the expressions are of the C @cite{int} type, so let's obtain this from the context, as a @code{gccjit::type}, using -@pxref{e3,,gccjit;;context;;get_type()}: +@pxref{e4,,gccjit;;context;;get_type()}: @example gccjit::type int_type = ctxt.get_type (GCC_JIT_TYPE_INT); @@ -8147,7 +8158,7 @@ entity in the API is associated with a @code{gccjit::context}. Memory management is easy: all such "contextual" objects are automatically cleaned up for you when the context is released, using -@pxref{e4,,gccjit;;context;;release()}: +@pxref{e5,,gccjit;;context;;release()}: @example ctxt.release (); @@ -8180,7 +8191,7 @@ The C++ class hierarchy within the @code{gccjit} namespace looks like this: One thing you can do with a @code{gccjit::object} is to ask it for a human-readable description as a @code{std::string}, using -@pxref{e5,,gccjit;;object;;get_debug_string()}: +@pxref{e6,,gccjit;;object;;get_debug_string()}: @example printf ("obj: %s\n", obj.get_debug_string ().c_str ()); @@ -8200,7 +8211,7 @@ This is invaluable when debugging. Let's create the function. To do so, we first need to construct its single parameter, specifying its type and giving it a name, -using @pxref{e6,,gccjit;;context;;new_param()}: +using @pxref{e7,,gccjit;;context;;new_param()}: @example gccjit::param param_i = ctxt.new_param (int_type, "i"); @@ -8249,7 +8260,7 @@ gccjit::block block = func.new_block (); Our basic block is relatively simple: it immediately terminates by returning the value of an expression. -We can build the expression using @pxref{e7,,gccjit;;context;;new_binary_op()}: +We can build the expression using @pxref{e8,,gccjit;;context;;new_binary_op()}: @example gccjit::rvalue expr = @@ -8262,7 +8273,7 @@ gccjit::rvalue expr = A @code{gccjit::rvalue} is another example of a @code{gccjit::object} subclass. As before, we can print it with -@pxref{e5,,gccjit;;object;;get_debug_string()}. +@pxref{e6,,gccjit;;object;;get_debug_string()}. @example printf ("expr: %s\n", expr.get_debug_string ().c_str ()); @@ -8299,7 +8310,7 @@ block.end_with_return (expr); @noindent OK, we've populated the context. We can now compile it using -@pxref{e8,,gccjit;;context;;compile()}: +@pxref{e9,,gccjit;;context;;compile()}: @example gcc_jit_result *result; @@ -8349,12 +8360,12 @@ result: 25 @end menu @node Options<3>,Full example<3>,,Tutorial part 2 Creating a trivial machine code function<2> -@anchor{cp/intro/tutorial02 options}@anchor{e9} +@anchor{cp/intro/tutorial02 options}@anchor{ea} @subsubsection Options To get more information on what's going on, you can set debugging flags -on the context using @pxref{ea,,gccjit;;context;;set_bool_option()}. +on the context using @pxref{eb,,gccjit;;context;;set_bool_option()}. @c (I'm deliberately not mentioning @c :c:macro:`GCC_JIT_BOOL_OPTION_DUMP_INITIAL_TREE` here since I think @@ -8426,7 +8437,7 @@ square: By default, no optimizations are performed, the equivalent of GCC's @cite{-O0} option. We can turn things up to e.g. @cite{-O3} by calling -@pxref{eb,,gccjit;;context;;set_int_option()} with +@pxref{ec,,gccjit;;context;;set_int_option()} with @pxref{1f,,GCC_JIT_INT_OPTION_OPTIMIZATION_LEVEL}: @example @@ -8460,7 +8471,7 @@ square: Naturally this has only a small effect on such a trivial function. @node Full example<3>,,Options<3>,Tutorial part 2 Creating a trivial machine code function<2> -@anchor{cp/intro/tutorial02 full-example}@anchor{ec} +@anchor{cp/intro/tutorial02 full-example}@anchor{ed} @subsubsection Full example @@ -8603,7 +8614,7 @@ result: 25 @c . @node Tutorial part 3 Loops and variables<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2>,Tutorial part 2 Creating a trivial machine code function<2>,Tutorial<2> -@anchor{cp/intro/tutorial03 tutorial-part-3-loops-and-variables}@anchor{ed}@anchor{cp/intro/tutorial03 doc}@anchor{ee} +@anchor{cp/intro/tutorial03 tutorial-part-3-loops-and-variables}@anchor{ee}@anchor{cp/intro/tutorial03 doc}@anchor{ef} @subsection Tutorial part 3: Loops and variables @@ -8727,7 +8738,7 @@ gccjit::function func = @end menu @node Expressions lvalues and rvalues<2>,Control flow<2>,,Tutorial part 3 Loops and variables<2> -@anchor{cp/intro/tutorial03 expressions-lvalues-and-rvalues}@anchor{ef} +@anchor{cp/intro/tutorial03 expressions-lvalues-and-rvalues}@anchor{f0} @subsubsection Expressions: lvalues and rvalues @@ -8800,7 +8811,7 @@ body of a function. Our new example has a new kind of expression: we have two local variables. We create them by calling -@pxref{f0,,gccjit;;function;;new_local()}, supplying a type and a name: +@pxref{f1,,gccjit;;function;;new_local()}, supplying a type and a name: @example /* Build locals: */ @@ -8826,7 +8837,7 @@ Instead, having added the local to the function, we have to separately add an assignment of @cite{0} to @cite{local_i} at the beginning of the function. @node Control flow<2>,Visualizing the control flow graph<2>,Expressions lvalues and rvalues<2>,Tutorial part 3 Loops and variables<2> -@anchor{cp/intro/tutorial03 control-flow}@anchor{f1} +@anchor{cp/intro/tutorial03 control-flow}@anchor{f2} @subsubsection Control flow @@ -8865,8 +8876,8 @@ We now populate each block with statements. The entry block @cite{b_initial} consists of initializations followed by a jump to the conditional. We assign @cite{0} to @cite{i} and to @cite{sum}, using -@pxref{f2,,gccjit;;block;;add_assignment()} to add -an assignment statement, and using @pxref{f3,,gccjit;;context;;zero()} to get +@pxref{f3,,gccjit;;block;;add_assignment()} to add +an assignment statement, and using @pxref{f4,,gccjit;;context;;zero()} to get the constant value @cite{0} for the relevant type for the right-hand side of the assignment: @@ -8893,7 +8904,7 @@ C example. It contains a single statement: a conditional, which jumps to one of two destination blocks depending on a boolean @code{gccjit::rvalue}, in this case the comparison of @cite{i} and @cite{n}. -We could build the comparison using @pxref{f4,,gccjit;;context;;new_comparison()}: +We could build the comparison using @pxref{f5,,gccjit;;context;;new_comparison()}: @example gccjit::rvalue guard = @@ -8904,10 +8915,12 @@ gccjit::rvalue guard = @noindent and can then use this to add @cite{b_loop_cond}'s sole statement, via -@pxref{f5,,gccjit;;block;;end_with_conditional()}: +@pxref{f6,,gccjit;;block;;end_with_conditional()}: @example -b_loop_cond.end_with_conditional (guard); +b_loop_cond.end_with_conditional (guard, + b_after_loop, // on_true + b_loop_body); // on_false @end example @noindent @@ -8921,13 +8934,13 @@ gccjit::rvalue guard = (i >= n); @noindent -and hence write the block more concisely as: +and hence we can write the block more concisely as: @example b_loop_cond.end_with_conditional ( i >= n, - b_after_loop, - b_loop_body); + b_after_loop, // on_true + b_loop_body); // on_false @end example @noindent @@ -8936,7 +8949,7 @@ Next, we populate the body of the loop. The C statement @cite{sum += i * i;} is an assignment operation, where an lvalue is modified "in-place". We use -@pxref{f6,,gccjit;;block;;add_assignment_op()} to handle these operations: +@pxref{f7,,gccjit;;block;;add_assignment_op()} to handle these operations: @example /* sum += i * i */ @@ -8964,7 +8977,7 @@ b_loop_body.add_assignment_op (i, @cartouche @quotation Note For numeric constants other than 0 or 1, we could use -@pxref{f7,,gccjit;;context;;new_rvalue()}, which has overloads +@pxref{f8,,gccjit;;context;;new_rvalue()}, which has overloads for both @code{int} and @code{double}. @end quotation @end cartouche @@ -9040,12 +9053,12 @@ result: 285 @noindent @node Visualizing the control flow graph<2>,Full example<4>,Control flow<2>,Tutorial part 3 Loops and variables<2> -@anchor{cp/intro/tutorial03 visualizing-the-control-flow-graph}@anchor{f8} +@anchor{cp/intro/tutorial03 visualizing-the-control-flow-graph}@anchor{f9} @subsubsection Visualizing the control flow graph You can see the control flow graph of a function using -@pxref{f9,,gccjit;;function;;dump_to_dot()}: +@pxref{fa,,gccjit;;function;;dump_to_dot()}: @example func.dump_to_dot ("/tmp/sum-of-squares.dot"); @@ -9079,7 +9092,7 @@ install it with @cite{yum install python-xdot}): @end quotation @node Full example<4>,,Visualizing the control flow graph<2>,Tutorial part 3 Loops and variables<2> -@anchor{cp/intro/tutorial03 full-example}@anchor{fa} +@anchor{cp/intro/tutorial03 full-example}@anchor{fb} @subsubsection Full example @@ -9262,7 +9275,7 @@ loop_test returned: 285 @c . @node Tutorial part 4 Adding JIT-compilation to a toy interpreter<2>,,Tutorial part 3 Loops and variables<2>,Tutorial<2> -@anchor{cp/intro/tutorial04 tutorial-part-4-adding-jit-compilation-to-a-toy-interpreter}@anchor{fb}@anchor{cp/intro/tutorial04 doc}@anchor{fc} +@anchor{cp/intro/tutorial04 tutorial-part-4-adding-jit-compilation-to-a-toy-interpreter}@anchor{fc}@anchor{cp/intro/tutorial04 doc}@anchor{fd} @subsection Tutorial part 4: Adding JIT-compilation to a toy interpreter @@ -9284,7 +9297,7 @@ to it. @end menu @node Our toy interpreter<2>,Compiling to machine code<2>,,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 our-toy-interpreter}@anchor{fd} +@anchor{cp/intro/tutorial04 our-toy-interpreter}@anchor{fe} @subsubsection Our toy interpreter @@ -9692,7 +9705,7 @@ toyvm_function::interpret (int arg, FILE *trace) @end quotation @node Compiling to machine code<2>,Setting things up<2>,Our toy interpreter<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 compiling-to-machine-code}@anchor{fe} +@anchor{cp/intro/tutorial04 compiling-to-machine-code}@anchor{ff} @subsubsection Compiling to machine code @@ -9772,7 +9785,7 @@ This means our compiler has the following state: @end quotation @node Setting things up<2>,Populating the function<2>,Compiling to machine code<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 setting-things-up}@anchor{ff} +@anchor{cp/intro/tutorial04 setting-things-up}@anchor{100} @subsubsection Setting things up @@ -9940,7 +9953,7 @@ We create the locals within the function. @end quotation @node Populating the function<2>,Verifying the control flow graph<2>,Setting things up<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 populating-the-function}@anchor{100} +@anchor{cp/intro/tutorial04 populating-the-function}@anchor{101} @subsubsection Populating the function @@ -10068,7 +10081,7 @@ stack into @code{y} instead erroneously assigned it to @code{x}, leaving @code{y uninitialized. To track this kind of thing down, we can use -@pxref{101,,gccjit;;block;;add_comment()} to add descriptive comments +@pxref{102,,gccjit;;block;;add_comment()} to add descriptive comments to the internal representation. This is invaluable when looking through the generated IR for, say @code{factorial}: @@ -10217,14 +10230,14 @@ to the next block. This is analogous to simply incrementing the program counter. @node Verifying the control flow graph<2>,Compiling the context<2>,Populating the function<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 verifying-the-control-flow-graph}@anchor{102} +@anchor{cp/intro/tutorial04 verifying-the-control-flow-graph}@anchor{103} @subsubsection Verifying the control flow graph Having finished looping over the blocks, the context is complete. As before, we can verify that the control flow and statements are sane by -using @pxref{f9,,gccjit;;function;;dump_to_dot()}: +using @pxref{fa,,gccjit;;function;;dump_to_dot()}: @example fn.dump_to_dot ("/tmp/factorial.dot"); @@ -10248,7 +10261,7 @@ errors in our compiler. @end quotation @node Compiling the context<2>,Single-stepping through the generated code<2>,Verifying the control flow graph<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 compiling-the-context}@anchor{103} +@anchor{cp/intro/tutorial04 compiling-the-context}@anchor{104} @subsubsection Compiling the context @@ -10285,7 +10298,7 @@ We can now run the result: @end quotation @node Single-stepping through the generated code<2>,Examining the generated code<2>,Compiling the context<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 single-stepping-through-the-generated-code}@anchor{104} +@anchor{cp/intro/tutorial04 single-stepping-through-the-generated-code}@anchor{105} @subsubsection Single-stepping through the generated code @@ -10299,14 +10312,14 @@ It's possible to debug the generated code. To do this we need to both: @item Set up source code locations for our statements, so that we can meaningfully step through the code. We did this above by -calling @pxref{105,,gccjit;;context;;new_location()} and using the +calling @pxref{106,,gccjit;;context;;new_location()} and using the results. @item Enable the generation of debugging information, by setting @pxref{42,,GCC_JIT_BOOL_OPTION_DEBUGINFO} on the @code{gccjit::context} via -@pxref{ea,,gccjit;;context;;set_bool_option()}: +@pxref{eb,,gccjit;;context;;set_bool_option()}: @example ctxt.set_bool_option (GCC_JIT_BOOL_OPTION_DEBUGINFO, 1); @@ -10378,14 +10391,14 @@ optimization level in a regular compiler. @end cartouche @node Examining the generated code<2>,Putting it all together<2>,Single-stepping through the generated code<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 examining-the-generated-code}@anchor{106} +@anchor{cp/intro/tutorial04 examining-the-generated-code}@anchor{107} @subsubsection Examining the generated code How good is the optimized code? We can turn up optimizations, by calling -@pxref{eb,,gccjit;;context;;set_int_option()} with +@pxref{ec,,gccjit;;context;;set_int_option()} with @pxref{1f,,GCC_JIT_INT_OPTION_OPTIMIZATION_LEVEL}: @example @@ -10567,7 +10580,7 @@ Note that the stack pushing and popping have been eliminated, as has the recursive call (in favor of an iteration). @node Putting it all together<2>,Behind the curtain How does our code get optimized?<2>,Examining the generated code<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 putting-it-all-together}@anchor{107} +@anchor{cp/intro/tutorial04 putting-it-all-together}@anchor{108} @subsubsection Putting it all together @@ -10600,7 +10613,7 @@ compiler result: 55 @noindent @node Behind the curtain How does our code get optimized?<2>,,Putting it all together<2>,Tutorial part 4 Adding JIT-compilation to a toy interpreter<2> -@anchor{cp/intro/tutorial04 behind-the-curtain-how-does-our-code-get-optimized}@anchor{108} +@anchor{cp/intro/tutorial04 behind-the-curtain-how-does-our-code-get-optimized}@anchor{109} @subsubsection Behind the curtain: How does our code get optimized? @@ -10801,7 +10814,7 @@ representation: @code{initial}, @code{instr4} and @code{instr9}. @end menu @node Optimizing away stack manipulation<2>,Elimination of tail recursion<2>,,Behind the curtain How does our code get optimized?<2> -@anchor{cp/intro/tutorial04 optimizing-away-stack-manipulation}@anchor{109} +@anchor{cp/intro/tutorial04 optimizing-away-stack-manipulation}@anchor{10a} @subsubsection Optimizing away stack manipulation @@ -11081,7 +11094,7 @@ instr9: @noindent @node Elimination of tail recursion<2>,,Optimizing away stack manipulation<2>,Behind the curtain How does our code get optimized?<2> -@anchor{cp/intro/tutorial04 elimination-of-tail-recursion}@anchor{10a} +@anchor{cp/intro/tutorial04 elimination-of-tail-recursion}@anchor{10b} @subsubsection Elimination of tail recursion @@ -11168,7 +11181,7 @@ instr9: @c . @node Topic Reference<2>,,Tutorial<2>,C++ bindings for libgccjit -@anchor{cp/topics/index doc}@anchor{10b}@anchor{cp/topics/index topic-reference}@anchor{10c} +@anchor{cp/topics/index doc}@anchor{10c}@anchor{cp/topics/index topic-reference}@anchor{10d} @section Topic Reference @@ -11257,22 +11270,22 @@ Compiling a context @node Compilation contexts<2>,Objects<2>,,Topic Reference<2> -@anchor{cp/topics/contexts compilation-contexts}@anchor{10d}@anchor{cp/topics/contexts doc}@anchor{10e} +@anchor{cp/topics/contexts compilation-contexts}@anchor{10e}@anchor{cp/topics/contexts doc}@anchor{10f} @subsection Compilation contexts @geindex gccjit;;context (C++ class) -@anchor{cp/topics/contexts gccjit context}@anchor{10f} +@anchor{cp/topics/contexts gccjit context}@anchor{110} @deffn {C++ Class} gccjit::context @end deffn -The top-level of the C++ API is the @pxref{10f,,gccjit;;context} type. +The top-level of the C++ API is the @pxref{110,,gccjit;;context} type. -A @pxref{10f,,gccjit;;context} instance encapsulates the state of a +A @pxref{110,,gccjit;;context} instance encapsulates the state of a compilation. You can set up options on it, and add types, functions and code. -Invoking @pxref{e8,,gccjit;;context;;compile()} on it gives you a +Invoking @pxref{e9,,gccjit;;context;;compile()} on it gives you a @pxref{16,,gcc_jit_result *}. It is a thin wrapper around the C API's @pxref{8,,gcc_jit_context *}. @@ -11287,7 +11300,7 @@ It is a thin wrapper around the C API's @pxref{8,,gcc_jit_context *}. @end menu @node Lifetime-management<2>,Thread-safety<2>,,Compilation contexts<2> -@anchor{cp/topics/contexts lifetime-management}@anchor{110} +@anchor{cp/topics/contexts lifetime-management}@anchor{111} @subsubsection Lifetime-management @@ -11296,16 +11309,16 @@ have their lifetime bounded by the context they are created within, and cleanup of such objects is done for you when the context is released. @geindex gccjit;;context;;acquire (C++ function) -@anchor{cp/topics/contexts gccjit context acquire}@anchor{e2} +@anchor{cp/topics/contexts gccjit context acquire}@anchor{e3} @deffn {C++ Function} gccjit::context gccjit::context::acquire () -This function acquires a new @pxref{10f,,gccjit;;context} instance, +This function acquires a new @pxref{110,,gccjit;;context} instance, which is independent of any others that may be present within this process. @end deffn @geindex gccjit;;context;;release (C++ function) -@anchor{cp/topics/contexts gccjit context release}@anchor{e4} +@anchor{cp/topics/contexts gccjit context release}@anchor{e5} @deffn {C++ Function} void gccjit::context::release () This function releases all resources associated with the given context. @@ -11324,7 +11337,7 @@ ctxt.release (); @end deffn @geindex gccjit;;context;;new_child_context (C++ function) -@anchor{cp/topics/contexts gccjit context new_child_context}@anchor{111} +@anchor{cp/topics/contexts gccjit context new_child_context}@anchor{112} @deffn {C++ Function} gccjit::context gccjit::context::new_child_context () Given an existing JIT context, create a child context. @@ -11356,16 +11369,16 @@ there will likely be a performance hit for such nesting. @end deffn @node Thread-safety<2>,Error-handling<3>,Lifetime-management<2>,Compilation contexts<2> -@anchor{cp/topics/contexts thread-safety}@anchor{112} +@anchor{cp/topics/contexts thread-safety}@anchor{113} @subsubsection Thread-safety -Instances of @pxref{10f,,gccjit;;context} created via -@pxref{e2,,gccjit;;context;;acquire()} are independent from each other: +Instances of @pxref{110,,gccjit;;context} created via +@pxref{e3,,gccjit;;context;;acquire()} are independent from each other: only one thread may use a given context at once, but multiple threads could each have their own contexts without needing locks. -Contexts created via @pxref{111,,gccjit;;context;;new_child_context()} are +Contexts created via @pxref{112,,gccjit;;context;;new_child_context()} are related to their parent context. They can be partitioned by their ultimate ancestor into independent "family trees". Only one thread within a process may use a given "family tree" of such contexts at once, @@ -11373,7 +11386,7 @@ and if you're using multiple threads you should provide your own locking around entire such context partitions. @node Error-handling<3>,Debugging<2>,Thread-safety<2>,Compilation contexts<2> -@anchor{cp/topics/contexts error-handling}@anchor{113} +@anchor{cp/topics/contexts error-handling}@anchor{114} @subsubsection Error-handling @@ -11386,10 +11399,10 @@ NULL. You don't have to check everywhere for NULL results, since the API gracefully handles a NULL being passed in for any argument. Errors are printed on stderr and can be queried using -@pxref{114,,gccjit;;context;;get_first_error()}. +@pxref{115,,gccjit;;context;;get_first_error()}. @geindex gccjit;;context;;get_first_error (C++ function) -@anchor{cp/topics/contexts gccjit context get_first_error__gccjit contextP}@anchor{114} +@anchor{cp/topics/contexts gccjit context get_first_error__gccjit contextP}@anchor{115} @deffn {C++ Function} const char* gccjit::context::get_first_error (gccjit::context* ctxt) Returns the first error message that occurred on the context. @@ -11401,18 +11414,18 @@ If no errors occurred, this will be NULL. @end deffn @node Debugging<2>,Options<4>,Error-handling<3>,Compilation contexts<2> -@anchor{cp/topics/contexts debugging}@anchor{115} +@anchor{cp/topics/contexts debugging}@anchor{116} @subsubsection Debugging @geindex gccjit;;context;;dump_to_file (C++ function) -@anchor{cp/topics/contexts gccjit context dump_to_file__ssCR i}@anchor{116} +@anchor{cp/topics/contexts gccjit context dump_to_file__ssCR i}@anchor{117} @deffn {C++ Function} void gccjit::context::dump_to_file (const std::string& path, int update_locations) To help with debugging: dump a C-like representation to the given path, describing what's been set up on the context. -If "update_locations" is true, then also set up @pxref{117,,gccjit;;location} +If "update_locations" is true, then also set up @pxref{118,,gccjit;;location} information throughout the context, pointing at the dump file as if it were a source file. This may be of use in conjunction with @code{GCCJIT::BOOL_OPTION_DEBUGINFO} to allow stepping through the @@ -11420,7 +11433,7 @@ code in a debugger. @end deffn @geindex gccjit;;context;;dump_reproducer_to_file (C++ function) -@anchor{cp/topics/contexts gccjit context dump_reproducer_to_file__gcc_jit_contextP cCP}@anchor{118} +@anchor{cp/topics/contexts gccjit context dump_reproducer_to_file__gcc_jit_contextP cCP}@anchor{119} @deffn {C++ Function} void gccjit::context::dump_reproducer_to_file (gcc_jit_context* ctxt, const char* path) This is a thin wrapper around the C API @@ -11432,7 +11445,7 @@ for seeing what the C++ bindings are doing at the C level. @end deffn @node Options<4>,,Debugging<2>,Compilation contexts<2> -@anchor{cp/topics/contexts options}@anchor{119} +@anchor{cp/topics/contexts options}@anchor{11a} @subsubsection Options @@ -11444,12 +11457,12 @@ for seeing what the C++ bindings are doing at the C level. @end menu @node String Options<2>,Boolean options<2>,,Options<4> -@anchor{cp/topics/contexts string-options}@anchor{11a} +@anchor{cp/topics/contexts string-options}@anchor{11b} @subsubsection String Options @geindex gccjit;;context;;set_str_option (C++ function) -@anchor{cp/topics/contexts gccjit context set_str_option__enum cCP}@anchor{11b} +@anchor{cp/topics/contexts gccjit context set_str_option__enum cCP}@anchor{11c} @deffn {C++ Function} void gccjit::context::set_str_option (enum gcc_jit_str_option, const char* value) Set a string option of the context. @@ -11460,12 +11473,12 @@ meaning. @end deffn @node Boolean options<2>,Integer options<2>,String Options<2>,Options<4> -@anchor{cp/topics/contexts boolean-options}@anchor{11c} +@anchor{cp/topics/contexts boolean-options}@anchor{11d} @subsubsection Boolean options @geindex gccjit;;context;;set_bool_option (C++ function) -@anchor{cp/topics/contexts gccjit context set_bool_option__enum i}@anchor{ea} +@anchor{cp/topics/contexts gccjit context set_bool_option__enum i}@anchor{eb} @deffn {C++ Function} void gccjit::context::set_bool_option (enum gcc_jit_bool_option, int value) Set a boolean option of the context. @@ -11476,12 +11489,12 @@ meaning. @end deffn @node Integer options<2>,,Boolean options<2>,Options<4> -@anchor{cp/topics/contexts integer-options}@anchor{11d} +@anchor{cp/topics/contexts integer-options}@anchor{11e} @subsubsection Integer options @geindex gccjit;;context;;set_int_option (C++ function) -@anchor{cp/topics/contexts gccjit context set_int_option__enum i}@anchor{eb} +@anchor{cp/topics/contexts gccjit context set_int_option__enum i}@anchor{ec} @deffn {C++ Function} void gccjit::context::set_int_option (enum gcc_jit_int_option, int value) Set an integer option of the context. @@ -11509,18 +11522,18 @@ meaning. @c . @node Objects<2>,Types<2>,Compilation contexts<2>,Topic Reference<2> -@anchor{cp/topics/objects objects}@anchor{11e}@anchor{cp/topics/objects doc}@anchor{11f} +@anchor{cp/topics/objects objects}@anchor{11f}@anchor{cp/topics/objects doc}@anchor{120} @subsection Objects @geindex gccjit;;object (C++ class) -@anchor{cp/topics/objects gccjit object}@anchor{120} +@anchor{cp/topics/objects gccjit object}@anchor{121} @deffn {C++ Class} gccjit::object @end deffn Almost every entity in the API (with the exception of -@pxref{10f,,gccjit;;context} and @pxref{16,,gcc_jit_result *}) is a -"contextual" object, a @pxref{120,,gccjit;;object}. +@pxref{110,,gccjit;;context} and @pxref{16,,gcc_jit_result *}) is a +"contextual" object, a @pxref{121,,gccjit;;object}. A JIT object: @@ -11530,7 +11543,7 @@ A JIT object: @itemize * @item -is associated with a @pxref{10f,,gccjit;;context}. +is associated with a @pxref{110,,gccjit;;context}. @item is automatically cleaned up for you when its context is released so @@ -11556,17 +11569,17 @@ The C++ class hierarchy within the @code{gccjit} namespace looks like this: @noindent -The @pxref{120,,gccjit;;object} base class has the following operations: +The @pxref{121,,gccjit;;object} base class has the following operations: @geindex gccjit;;object;;get_context (C++ function) -@anchor{cp/topics/objects gccjit object get_contextC}@anchor{121} +@anchor{cp/topics/objects gccjit object get_contextC}@anchor{122} @deffn {C++ Function} gccjit::context gccjit::object::get_context () const Which context is the obj within? @end deffn @geindex gccjit;;object;;get_debug_string (C++ function) -@anchor{cp/topics/objects gccjit object get_debug_stringC}@anchor{e5} +@anchor{cp/topics/objects gccjit object get_debug_stringC}@anchor{e6} @deffn {C++ Function} std::string gccjit::object::get_debug_string () const Generate a human-readable description for the given object. @@ -11606,16 +11619,16 @@ obj: 4.0 * (float)i @c . @node Types<2>,Expressions<2>,Objects<2>,Topic Reference<2> -@anchor{cp/topics/types doc}@anchor{122}@anchor{cp/topics/types types}@anchor{123} +@anchor{cp/topics/types doc}@anchor{123}@anchor{cp/topics/types types}@anchor{124} @subsection Types @geindex gccjit;;type (C++ class) -@anchor{cp/topics/types gccjit type}@anchor{124} +@anchor{cp/topics/types gccjit type}@anchor{125} @deffn {C++ Class} gccjit::type gccjit::type represents a type within the library. It is a subclass -of @pxref{120,,gccjit;;object}. +of @pxref{121,,gccjit;;object}. @end deffn Types can be created in several ways: @@ -11625,7 +11638,7 @@ Types can be created in several ways: @item fundamental types can be accessed using -@pxref{e3,,gccjit;;context;;get_type()}: +@pxref{e4,,gccjit;;context;;get_type()}: @example gccjit::type int_type = ctxt.get_type (GCC_JIT_TYPE_INT); @@ -11645,7 +11658,7 @@ See @pxref{b,,gcc_jit_context_get_type()} for the available types. @item derived types can be accessed by using functions such as -@pxref{125,,gccjit;;type;;get_pointer()} and @pxref{126,,gccjit;;type;;get_const()}: +@pxref{126,,gccjit;;type;;get_pointer()} and @pxref{127,,gccjit;;type;;get_const()}: @example gccjit::type const_int_star = int_type.get_const ().get_pointer (); @@ -11666,12 +11679,12 @@ by creating structures (see below). @end menu @node Standard types<2>,Pointers const and volatile<2>,,Types<2> -@anchor{cp/topics/types standard-types}@anchor{127} +@anchor{cp/topics/types standard-types}@anchor{128} @subsubsection Standard types @geindex gccjit;;context;;get_type (C++ function) -@anchor{cp/topics/types gccjit context get_type__enum}@anchor{e3} +@anchor{cp/topics/types gccjit context get_type__enum}@anchor{e4} @deffn {C++ Function} gccjit::type gccjit::context::get_type (enum gcc_jit_types) Access a specific type. This is a thin wrapper around @@ -11679,14 +11692,14 @@ Access a specific type. This is a thin wrapper around @end deffn @geindex gccjit;;context;;get_int_type (C++ function) -@anchor{cp/topics/types gccjit context get_int_type__s i}@anchor{128} +@anchor{cp/topics/types gccjit context get_int_type__s i}@anchor{129} @deffn {C++ Function} gccjit::type gccjit::context::get_int_type (size_t num_bytes, int is_signed) Access the integer type of the given size. @end deffn @geindex gccjit;;context;;get_int_type (C++ function) -@anchor{cp/topics/types gccjit context get_int_type T}@anchor{129} +@anchor{cp/topics/types gccjit context get_int_type T}@anchor{12a} @deffn {C++ Function} gccjit::type gccjit::context::get_int_type () Access the given integer type. For example, you could map the @@ -11700,12 +11713,12 @@ gccjit::type t = ctxt.get_int_type (); @end deffn @node Pointers const and volatile<2>,Structures and unions<2>,Standard types<2>,Types<2> -@anchor{cp/topics/types pointers-const-and-volatile}@anchor{12a} +@anchor{cp/topics/types pointers-const-and-volatile}@anchor{12b} @subsubsection Pointers, @cite{const}, and @cite{volatile} @geindex gccjit;;type;;get_pointer (C++ function) -@anchor{cp/topics/types gccjit type get_pointer}@anchor{125} +@anchor{cp/topics/types gccjit type get_pointer}@anchor{126} @deffn {C++ Function} gccjit::type gccjit::type::get_pointer () Given type "T", get type "T*". @@ -11714,21 +11727,21 @@ Given type "T", get type "T*". @c FIXME: get_const doesn't seem to exist @geindex gccjit;;type;;get_const (C++ function) -@anchor{cp/topics/types gccjit type get_const}@anchor{126} +@anchor{cp/topics/types gccjit type get_const}@anchor{127} @deffn {C++ Function} gccjit::type gccjit::type::get_const () Given type "T", get type "const T". @end deffn @geindex gccjit;;type;;get_volatile (C++ function) -@anchor{cp/topics/types gccjit type get_volatile}@anchor{12b} +@anchor{cp/topics/types gccjit type get_volatile}@anchor{12c} @deffn {C++ Function} gccjit::type gccjit::type::get_volatile () Given type "T", get type "volatile T". @end deffn @geindex gccjit;;context;;new_array_type (C++ function) -@anchor{cp/topics/types gccjit context new_array_type__gccjit type i gccjit location}@anchor{12c} +@anchor{cp/topics/types gccjit context new_array_type__gccjit type i gccjit location}@anchor{12d} @deffn {C++ Function} gccjit::type gccjit::context::new_array_type (gccjit::type element_type, int num_elements, gccjit::location loc) Given type "T", get type "T[N]" (for a constant N). @@ -11736,31 +11749,31 @@ Param "loc" is optional. @end deffn @node Structures and unions<2>,,Pointers const and volatile<2>,Types<2> -@anchor{cp/topics/types structures-and-unions}@anchor{12d} +@anchor{cp/topics/types structures-and-unions}@anchor{12e} @subsubsection Structures and unions @geindex gccjit;;struct_ (C++ class) -@anchor{cp/topics/types gccjit struct_}@anchor{12e} +@anchor{cp/topics/types gccjit struct_}@anchor{12f} @deffn {C++ Class} gccjit::struct_ @end deffn A compound type analagous to a C @cite{struct}. -@pxref{12e,,gccjit;;struct_} is a subclass of @pxref{124,,gccjit;;type} (and thus -of @pxref{120,,gccjit;;object} in turn). +@pxref{12f,,gccjit;;struct_} is a subclass of @pxref{125,,gccjit;;type} (and thus +of @pxref{121,,gccjit;;object} in turn). @geindex gccjit;;field (C++ class) -@anchor{cp/topics/types gccjit field}@anchor{12f} +@anchor{cp/topics/types gccjit field}@anchor{130} @deffn {C++ Class} gccjit::field @end deffn -A field within a @pxref{12e,,gccjit;;struct_}. +A field within a @pxref{12f,,gccjit;;struct_}. -@pxref{12f,,gccjit;;field} is a subclass of @pxref{120,,gccjit;;object}. +@pxref{130,,gccjit;;field} is a subclass of @pxref{121,,gccjit;;object}. -You can model C @cite{struct} types by creating @pxref{12e,,gccjit;;struct_} and -@pxref{12f,,gccjit;;field} instances, in either order: +You can model C @cite{struct} types by creating @pxref{12f,,gccjit;;struct_} and +@pxref{130,,gccjit;;field} instances, in either order: @itemize * @@ -11816,14 +11829,14 @@ node.set_fields (fields); @c FIXME: the above API doesn't seem to exist yet @geindex gccjit;;context;;new_field (C++ function) -@anchor{cp/topics/types gccjit context new_field__gccjit type cCP gccjit location}@anchor{130} +@anchor{cp/topics/types gccjit context new_field__gccjit type cCP gccjit location}@anchor{131} @deffn {C++ Function} gccjit::field gccjit::context::new_field (gccjit::type type, const char* name, gccjit::location loc) Construct a new field, with the given type and name. @end deffn @geindex gccjit;;context;;new_struct_type (C++ function) -@anchor{cp/topics/types gccjit context new_struct_type__ssCR std vector field R gccjit location}@anchor{131} +@anchor{cp/topics/types gccjit context new_struct_type__ssCR std vector field R gccjit location}@anchor{132} @deffn {C++ Function} gccjit::struct_ gccjit::context::new_struct_type (const std::string& name, std::vector& fields, gccjit::location loc) @quotation @@ -11833,7 +11846,7 @@ Construct a new struct type, with the given name and fields. @end deffn @geindex gccjit;;context;;new_opaque_struct (C++ function) -@anchor{cp/topics/types gccjit context new_opaque_struct__ssCR gccjit location}@anchor{132} +@anchor{cp/topics/types gccjit context new_opaque_struct__ssCR gccjit location}@anchor{133} @deffn {C++ Function} gccjit::struct_ gccjit::context::new_opaque_struct (const std::string& name, gccjit::location loc) Construct a new struct type, with the given name, but without @@ -11860,7 +11873,7 @@ size of the struct is not known), or later specified using @c . @node Expressions<2>,Creating and using functions<2>,Types<2>,Topic Reference<2> -@anchor{cp/topics/expressions expressions}@anchor{133}@anchor{cp/topics/expressions doc}@anchor{134} +@anchor{cp/topics/expressions expressions}@anchor{134}@anchor{cp/topics/expressions doc}@anchor{135} @subsection Expressions @@ -11886,17 +11899,17 @@ Lvalues @node Rvalues<2>,Lvalues<2>,,Expressions<2> -@anchor{cp/topics/expressions rvalues}@anchor{135} +@anchor{cp/topics/expressions rvalues}@anchor{136} @subsubsection Rvalues @geindex gccjit;;rvalue (C++ class) -@anchor{cp/topics/expressions gccjit rvalue}@anchor{136} +@anchor{cp/topics/expressions gccjit rvalue}@anchor{137} @deffn {C++ Class} gccjit::rvalue @end deffn -A @pxref{136,,gccjit;;rvalue} is an expression that can be computed. It is a -subclass of @pxref{120,,gccjit;;object}, and is a thin wrapper around +A @pxref{137,,gccjit;;rvalue} is an expression that can be computed. It is a +subclass of @pxref{121,,gccjit;;object}, and is a thin wrapper around @pxref{13,,gcc_jit_rvalue *} from the C API. It can be simple, e.g.: @@ -11942,7 +11955,7 @@ Every rvalue has an associated type, and the API will check to ensure that types match up correctly (otherwise the context will emit an error). @geindex gccjit;;rvalue;;get_type (C++ function) -@anchor{cp/topics/expressions gccjit rvalue get_type}@anchor{137} +@anchor{cp/topics/expressions gccjit rvalue get_type}@anchor{138} @deffn {C++ Function} gccjit::type gccjit::rvalue::get_type () Get the type of this rvalue. @@ -11959,12 +11972,12 @@ Get the type of this rvalue. @end menu @node Simple expressions<2>,Unary Operations<2>,,Rvalues<2> -@anchor{cp/topics/expressions simple-expressions}@anchor{138} +@anchor{cp/topics/expressions simple-expressions}@anchor{139} @subsubsection Simple expressions @geindex gccjit;;context;;new_rvalue (C++ function) -@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type iC}@anchor{f7} +@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type iC}@anchor{f8} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_rvalue (gccjit::type numeric_type, int value) const Given a numeric type (integer or floating point), build an rvalue for @@ -11972,7 +11985,7 @@ the given constant @code{int} value. @end deffn @geindex gccjit;;context;;new_rvalue (C++ function) -@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type lC}@anchor{139} +@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type lC}@anchor{13a} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_rvalue (gccjit::type numeric_type, long value) const Given a numeric type (integer or floating point), build an rvalue for @@ -11980,7 +11993,7 @@ the given constant @code{long} value. @end deffn @geindex gccjit;;context;;zero (C++ function) -@anchor{cp/topics/expressions gccjit context zero__gccjit typeC}@anchor{f3} +@anchor{cp/topics/expressions gccjit context zero__gccjit typeC}@anchor{f4} @deffn {C++ Function} gccjit::rvalue gccjit::context::zero (gccjit::type numeric_type) const Given a numeric type (integer or floating point), get the rvalue for @@ -11994,7 +12007,7 @@ ctxt.new_rvalue (numeric_type, 0) @end deffn @geindex gccjit;;context;;one (C++ function) -@anchor{cp/topics/expressions gccjit context one__gccjit typeC}@anchor{13a} +@anchor{cp/topics/expressions gccjit context one__gccjit typeC}@anchor{13b} @deffn {C++ Function} gccjit::rvalue gccjit::context::one (gccjit::type numeric_type) const Given a numeric type (integer or floating point), get the rvalue for @@ -12008,7 +12021,7 @@ ctxt.new_rvalue (numeric_type, 1) @end deffn @geindex gccjit;;context;;new_rvalue (C++ function) -@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type doubleC}@anchor{13b} +@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type doubleC}@anchor{13c} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_rvalue (gccjit::type numeric_type, double value) const Given a numeric type (integer or floating point), build an rvalue for @@ -12016,14 +12029,14 @@ the given constant @code{double} value. @end deffn @geindex gccjit;;context;;new_rvalue (C++ function) -@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type voidPC}@anchor{13c} +@anchor{cp/topics/expressions gccjit context new_rvalue__gccjit type voidPC}@anchor{13d} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_rvalue (gccjit::type pointer_type, void* value) const Given a pointer type, build an rvalue for the given address. @end deffn @geindex gccjit;;context;;new_rvalue (C++ function) -@anchor{cp/topics/expressions gccjit context new_rvalue__ssCRC}@anchor{13d} +@anchor{cp/topics/expressions gccjit context new_rvalue__ssCRC}@anchor{13e} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_rvalue (const std::string& value) const Generate an rvalue of type @code{GCC_JIT_TYPE_CONST_CHAR_PTR} for @@ -12031,12 +12044,12 @@ the given string. This is akin to a string literal. @end deffn @node Unary Operations<2>,Binary Operations<2>,Simple expressions<2>,Rvalues<2> -@anchor{cp/topics/expressions unary-operations}@anchor{13e} +@anchor{cp/topics/expressions unary-operations}@anchor{13f} @subsubsection Unary Operations @geindex gccjit;;context;;new_unary_op (C++ function) -@anchor{cp/topics/expressions gccjit context new_unary_op__enum gccjit type gccjit rvalue gccjit location}@anchor{13f} +@anchor{cp/topics/expressions gccjit context new_unary_op__enum gccjit type gccjit rvalue gccjit location}@anchor{140} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_unary_op (enum gcc_jit_unary_op, gccjit::type result_type, gccjit::rvalue rvalue, gccjit::location loc) Build a unary operation out of an input rvalue. @@ -12052,7 +12065,7 @@ There are shorter ways to spell the various specific kinds of unary operation: @geindex gccjit;;context;;new_minus (C++ function) -@anchor{cp/topics/expressions gccjit context new_minus__gccjit type gccjit rvalue gccjit location}@anchor{140} +@anchor{cp/topics/expressions gccjit context new_minus__gccjit type gccjit rvalue gccjit location}@anchor{141} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_minus (gccjit::type result_type, gccjit::rvalue a, gccjit::location loc) Negate an arithmetic value; for example: @@ -12073,7 +12086,7 @@ builds the equivalent of this C expression: @end deffn @geindex new_bitwise_negate (C++ function) -@anchor{cp/topics/expressions new_bitwise_negate__gccjit type gccjit rvalue gccjit location}@anchor{141} +@anchor{cp/topics/expressions new_bitwise_negate__gccjit type gccjit rvalue gccjit location}@anchor{142} @deffn {C++ Function} gccjit::rvalue new_bitwise_negate (gccjit::type result_type, gccjit::rvalue a, gccjit::location loc) Bitwise negation of an integer value (one's complement); for example: @@ -12094,7 +12107,7 @@ builds the equivalent of this C expression: @end deffn @geindex new_logical_negate (C++ function) -@anchor{cp/topics/expressions new_logical_negate__gccjit type gccjit rvalue gccjit location}@anchor{142} +@anchor{cp/topics/expressions new_logical_negate__gccjit type gccjit rvalue gccjit location}@anchor{143} @deffn {C++ Function} gccjit::rvalue new_logical_negate (gccjit::type result_type, gccjit::rvalue a, gccjit::location loc) Logical negation of an arithmetic or pointer value; for example: @@ -12117,7 +12130,7 @@ builds the equivalent of this C expression: The most concise way to spell them is with overloaded operators: @geindex operator- (C++ function) -@anchor{cp/topics/expressions sub-operator__gccjit rvalue}@anchor{143} +@anchor{cp/topics/expressions sub-operator__gccjit rvalue}@anchor{144} @deffn {C++ Function} gccjit::rvalue operator- (gccjit::rvalue a) @example @@ -12128,7 +12141,7 @@ gccjit::rvalue negpi = -pi; @end deffn @geindex operator~ (C++ function) -@anchor{cp/topics/expressions inv-operator__gccjit rvalue}@anchor{144} +@anchor{cp/topics/expressions inv-operator__gccjit rvalue}@anchor{145} @deffn {C++ Function} gccjit::rvalue operator~ (gccjit::rvalue a) @example @@ -12139,7 +12152,7 @@ gccjit::rvalue mask = ~a; @end deffn @geindex operator! (C++ function) -@anchor{cp/topics/expressions not-operator__gccjit rvalue}@anchor{145} +@anchor{cp/topics/expressions not-operator__gccjit rvalue}@anchor{146} @deffn {C++ Function} gccjit::rvalue operator! (gccjit::rvalue a) @example @@ -12150,12 +12163,12 @@ gccjit::rvalue guard = !cond; @end deffn @node Binary Operations<2>,Comparisons<2>,Unary Operations<2>,Rvalues<2> -@anchor{cp/topics/expressions binary-operations}@anchor{146} +@anchor{cp/topics/expressions binary-operations}@anchor{147} @subsubsection Binary Operations @geindex gccjit;;context;;new_binary_op (C++ function) -@anchor{cp/topics/expressions gccjit context new_binary_op__enum gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{e7} +@anchor{cp/topics/expressions gccjit context new_binary_op__enum gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{e8} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_binary_op (enum gcc_jit_binary_op, gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) Build a binary operation out of two constituent rvalues. @@ -12171,59 +12184,59 @@ There are shorter ways to spell the various specific kinds of binary operation: @geindex gccjit;;context;;new_plus (C++ function) -@anchor{cp/topics/expressions gccjit context new_plus__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{147} +@anchor{cp/topics/expressions gccjit context new_plus__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{148} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_plus (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_minus (C++ function) -@anchor{cp/topics/expressions gccjit context new_minus__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{148} +@anchor{cp/topics/expressions gccjit context new_minus__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{149} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_minus (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_mult (C++ function) -@anchor{cp/topics/expressions gccjit context new_mult__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{149} +@anchor{cp/topics/expressions gccjit context new_mult__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14a} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_mult (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_divide (C++ function) -@anchor{cp/topics/expressions gccjit context new_divide__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14a} +@anchor{cp/topics/expressions gccjit context new_divide__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14b} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_divide (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_modulo (C++ function) -@anchor{cp/topics/expressions gccjit context new_modulo__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14b} +@anchor{cp/topics/expressions gccjit context new_modulo__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14c} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_modulo (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_bitwise_and (C++ function) -@anchor{cp/topics/expressions gccjit context new_bitwise_and__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14c} +@anchor{cp/topics/expressions gccjit context new_bitwise_and__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14d} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_bitwise_and (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_bitwise_xor (C++ function) -@anchor{cp/topics/expressions gccjit context new_bitwise_xor__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14d} +@anchor{cp/topics/expressions gccjit context new_bitwise_xor__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14e} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_bitwise_xor (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_bitwise_or (C++ function) -@anchor{cp/topics/expressions gccjit context new_bitwise_or__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14e} +@anchor{cp/topics/expressions gccjit context new_bitwise_or__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14f} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_bitwise_or (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_logical_and (C++ function) -@anchor{cp/topics/expressions gccjit context new_logical_and__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{14f} +@anchor{cp/topics/expressions gccjit context new_logical_and__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{150} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_logical_and (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_logical_or (C++ function) -@anchor{cp/topics/expressions gccjit context new_logical_or__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{150} +@anchor{cp/topics/expressions gccjit context new_logical_or__gccjit type gccjit rvalue gccjit rvalue gccjit location}@anchor{151} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_logical_or (gccjit::type result_type, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn The most concise way to spell them is with overloaded operators: @geindex operator+ (C++ function) -@anchor{cp/topics/expressions add-operator__gccjit rvalue gccjit rvalue}@anchor{151} +@anchor{cp/topics/expressions add-operator__gccjit rvalue gccjit rvalue}@anchor{152} @deffn {C++ Function} gccjit::rvalue operator+ (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12234,7 +12247,7 @@ gccjit::rvalue sum = a + b; @end deffn @geindex operator- (C++ function) -@anchor{cp/topics/expressions sub-operator__gccjit rvalue gccjit rvalue}@anchor{152} +@anchor{cp/topics/expressions sub-operator__gccjit rvalue gccjit rvalue}@anchor{153} @deffn {C++ Function} gccjit::rvalue operator- (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12245,7 +12258,7 @@ gccjit::rvalue diff = a - b; @end deffn @geindex operator* (C++ function) -@anchor{cp/topics/expressions mul-operator__gccjit rvalue gccjit rvalue}@anchor{153} +@anchor{cp/topics/expressions mul-operator__gccjit rvalue gccjit rvalue}@anchor{154} @deffn {C++ Function} gccjit::rvalue operator* (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12256,7 +12269,7 @@ gccjit::rvalue prod = a * b; @end deffn @geindex operator/ (C++ function) -@anchor{cp/topics/expressions div-operator__gccjit rvalue gccjit rvalue}@anchor{154} +@anchor{cp/topics/expressions div-operator__gccjit rvalue gccjit rvalue}@anchor{155} @deffn {C++ Function} gccjit::rvalue operator/ (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12267,7 +12280,7 @@ gccjit::rvalue result = a / b; @end deffn @geindex operator% (C++ function) -@anchor{cp/topics/expressions mod-operator__gccjit rvalue gccjit rvalue}@anchor{155} +@anchor{cp/topics/expressions mod-operator__gccjit rvalue gccjit rvalue}@anchor{156} @deffn {C++ Function} gccjit::rvalue operator% (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12278,7 +12291,7 @@ gccjit::rvalue mod = a % b; @end deffn @geindex operator& (C++ function) -@anchor{cp/topics/expressions and-operator__gccjit rvalue gccjit rvalue}@anchor{156} +@anchor{cp/topics/expressions and-operator__gccjit rvalue gccjit rvalue}@anchor{157} @deffn {C++ Function} gccjit::rvalue operator& (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12289,7 +12302,7 @@ gccjit::rvalue x = a & b; @end deffn @geindex operator^ (C++ function) -@anchor{cp/topics/expressions xor-operator__gccjit rvalue gccjit rvalue}@anchor{157} +@anchor{cp/topics/expressions xor-operator__gccjit rvalue gccjit rvalue}@anchor{158} @deffn {C++ Function} gccjit::rvalue operator^ (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12300,7 +12313,7 @@ gccjit::rvalue x = a ^ b; @end deffn @geindex operator| (C++ function) -@anchor{cp/topics/expressions or-operator__gccjit rvalue gccjit rvalue}@anchor{158} +@anchor{cp/topics/expressions or-operator__gccjit rvalue gccjit rvalue}@anchor{159} @deffn {C++ Function} gccjit::rvalue operator| (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12311,7 +12324,7 @@ gccjit::rvalue x = a | b; @end deffn @geindex operator&& (C++ function) -@anchor{cp/topics/expressions sand-operator__gccjit rvalue gccjit rvalue}@anchor{159} +@anchor{cp/topics/expressions sand-operator__gccjit rvalue gccjit rvalue}@anchor{15a} @deffn {C++ Function} gccjit::rvalue operator&& (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12322,7 +12335,7 @@ gccjit::rvalue cond = a && b; @end deffn @geindex operator|| (C++ function) -@anchor{cp/topics/expressions sor-operator__gccjit rvalue gccjit rvalue}@anchor{15a} +@anchor{cp/topics/expressions sor-operator__gccjit rvalue gccjit rvalue}@anchor{15b} @deffn {C++ Function} gccjit::rvalue operator|| (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12345,12 +12358,12 @@ gccjit::rvalue discriminant = (b * b) - (four * a * c); @end quotation @node Comparisons<2>,Function calls<2>,Binary Operations<2>,Rvalues<2> -@anchor{cp/topics/expressions comparisons}@anchor{15b} +@anchor{cp/topics/expressions comparisons}@anchor{15c} @subsubsection Comparisons @geindex gccjit;;context;;new_comparison (C++ function) -@anchor{cp/topics/expressions gccjit context new_comparison__enum gccjit rvalue gccjit rvalue gccjit location}@anchor{f4} +@anchor{cp/topics/expressions gccjit context new_comparison__enum gccjit rvalue gccjit rvalue gccjit location}@anchor{f5} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_comparison (enum gcc_jit_comparison, gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) Build a boolean rvalue out of the comparison of two other rvalues. @@ -12366,39 +12379,39 @@ There are shorter ways to spell the various specific kinds of binary operation: @geindex gccjit;;context;;new_eq (C++ function) -@anchor{cp/topics/expressions gccjit context new_eq__gccjit rvalue gccjit rvalue gccjit location}@anchor{15c} +@anchor{cp/topics/expressions gccjit context new_eq__gccjit rvalue gccjit rvalue gccjit location}@anchor{15d} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_eq (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_ne (C++ function) -@anchor{cp/topics/expressions gccjit context new_ne__gccjit rvalue gccjit rvalue gccjit location}@anchor{15d} +@anchor{cp/topics/expressions gccjit context new_ne__gccjit rvalue gccjit rvalue gccjit location}@anchor{15e} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_ne (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_lt (C++ function) -@anchor{cp/topics/expressions gccjit context new_lt__gccjit rvalue gccjit rvalue gccjit location}@anchor{15e} +@anchor{cp/topics/expressions gccjit context new_lt__gccjit rvalue gccjit rvalue gccjit location}@anchor{15f} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_lt (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_le (C++ function) -@anchor{cp/topics/expressions gccjit context new_le__gccjit rvalue gccjit rvalue gccjit location}@anchor{15f} +@anchor{cp/topics/expressions gccjit context new_le__gccjit rvalue gccjit rvalue gccjit location}@anchor{160} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_le (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_gt (C++ function) -@anchor{cp/topics/expressions gccjit context new_gt__gccjit rvalue gccjit rvalue gccjit location}@anchor{160} +@anchor{cp/topics/expressions gccjit context new_gt__gccjit rvalue gccjit rvalue gccjit location}@anchor{161} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_gt (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn @geindex gccjit;;context;;new_ge (C++ function) -@anchor{cp/topics/expressions gccjit context new_ge__gccjit rvalue gccjit rvalue gccjit location}@anchor{161} +@anchor{cp/topics/expressions gccjit context new_ge__gccjit rvalue gccjit rvalue gccjit location}@anchor{162} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_ge (gccjit::rvalue a, gccjit::rvalue b, gccjit::location loc) @end deffn The most concise way to spell them is with overloaded operators: @geindex operator== (C++ function) -@anchor{cp/topics/expressions eq-operator__gccjit rvalue gccjit rvalue}@anchor{162} +@anchor{cp/topics/expressions eq-operator__gccjit rvalue gccjit rvalue}@anchor{163} @deffn {C++ Function} gccjit::rvalue operator== (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12409,7 +12422,7 @@ gccjit::rvalue cond = (a == ctxt.zero (t_int)); @end deffn @geindex operator!= (C++ function) -@anchor{cp/topics/expressions neq-operator__gccjit rvalue gccjit rvalue}@anchor{163} +@anchor{cp/topics/expressions neq-operator__gccjit rvalue gccjit rvalue}@anchor{164} @deffn {C++ Function} gccjit::rvalue operator!= (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12420,7 +12433,7 @@ gccjit::rvalue cond = (i != j); @end deffn @geindex operator< (C++ function) -@anchor{cp/topics/expressions lt-operator__gccjit rvalue gccjit rvalue}@anchor{164} +@anchor{cp/topics/expressions lt-operator__gccjit rvalue gccjit rvalue}@anchor{165} @deffn {C++ Function} gccjit::rvalue operator< (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12431,7 +12444,7 @@ gccjit::rvalue cond = i < n; @end deffn @geindex operator<= (C++ function) -@anchor{cp/topics/expressions lte-operator__gccjit rvalue gccjit rvalue}@anchor{165} +@anchor{cp/topics/expressions lte-operator__gccjit rvalue gccjit rvalue}@anchor{166} @deffn {C++ Function} gccjit::rvalue operator<= (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12442,7 +12455,7 @@ gccjit::rvalue cond = i <= n; @end deffn @geindex operator> (C++ function) -@anchor{cp/topics/expressions gt-operator__gccjit rvalue gccjit rvalue}@anchor{166} +@anchor{cp/topics/expressions gt-operator__gccjit rvalue gccjit rvalue}@anchor{167} @deffn {C++ Function} gccjit::rvalue operator> (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12453,7 +12466,7 @@ gccjit::rvalue cond = (ch > limit); @end deffn @geindex operator>= (C++ function) -@anchor{cp/topics/expressions gte-operator__gccjit rvalue gccjit rvalue}@anchor{167} +@anchor{cp/topics/expressions gte-operator__gccjit rvalue gccjit rvalue}@anchor{168} @deffn {C++ Function} gccjit::rvalue operator>= (gccjit::rvalue a, gccjit::rvalue b) @example @@ -12466,12 +12479,12 @@ gccjit::rvalue cond = (score >= ctxt.new_rvalue (t_int, 100)); @c TODO: beyond this point @node Function calls<2>,Type-coercion<2>,Comparisons<2>,Rvalues<2> -@anchor{cp/topics/expressions function-calls}@anchor{168} +@anchor{cp/topics/expressions function-calls}@anchor{169} @subsubsection Function calls @geindex gcc_jit_context_new_call (C++ function) -@anchor{cp/topics/expressions gcc_jit_context_new_call__gcc_jit_contextP gcc_jit_locationP gcc_jit_functionP i gcc_jit_rvaluePP}@anchor{169} +@anchor{cp/topics/expressions gcc_jit_context_new_call__gcc_jit_contextP gcc_jit_locationP gcc_jit_functionP i gcc_jit_rvaluePP}@anchor{16a} @deffn {C++ Function} gcc_jit_rvalue* gcc_jit_context_new_call (gcc_jit_context* ctxt, gcc_jit_location* loc, gcc_jit_function* func, int numargs, gcc_jit_rvalue** args) Given a function and the given table of argument rvalues, construct a @@ -12480,14 +12493,14 @@ call to the function, with the result as an rvalue. @cartouche @quotation Note @code{gccjit::context::new_call()} merely builds a -@pxref{136,,gccjit;;rvalue} i.e. an expression that can be evaluated, +@pxref{137,,gccjit;;rvalue} i.e. an expression that can be evaluated, perhaps as part of a more complicated expression. The call @emph{won't} happen unless you add a statement to a function that evaluates the expression. For example, if you want to call a function and discard the result (or to call a function with @code{void} return type), use -@pxref{16a,,gccjit;;block;;add_eval()}: +@pxref{16b,,gccjit;;block;;add_eval()}: @example /* Add "(void)printf (arg0, arg1);". */ @@ -12500,12 +12513,12 @@ block.add_eval (ctxt.new_call (printf_func, arg0, arg1)); @end deffn @node Type-coercion<2>,,Function calls<2>,Rvalues<2> -@anchor{cp/topics/expressions type-coercion}@anchor{16b} +@anchor{cp/topics/expressions type-coercion}@anchor{16c} @subsubsection Type-coercion @geindex gccjit;;context;;new_cast (C++ function) -@anchor{cp/topics/expressions gccjit context new_cast__gccjit rvalue gccjit type gccjit location}@anchor{16c} +@anchor{cp/topics/expressions gccjit context new_cast__gccjit rvalue gccjit type gccjit location}@anchor{16d} @deffn {C++ Function} gccjit::rvalue gccjit::context::new_cast (gccjit::rvalue rvalue, gccjit::type type, gccjit::location loc) Given an rvalue of T, construct another rvalue of another type. @@ -12530,24 +12543,24 @@ P* <-> Q*, for pointer types P and Q @end deffn @node Lvalues<2>,Working with pointers structs and unions<2>,Rvalues<2>,Expressions<2> -@anchor{cp/topics/expressions lvalues}@anchor{16d} +@anchor{cp/topics/expressions lvalues}@anchor{16e} @subsubsection Lvalues @geindex gccjit;;lvalue (C++ class) -@anchor{cp/topics/expressions gccjit lvalue}@anchor{16e} +@anchor{cp/topics/expressions gccjit lvalue}@anchor{16f} @deffn {C++ Class} gccjit::lvalue @end deffn An lvalue is something that can of the @emph{left}-hand side of an assignment: a storage area (such as a variable). It is a subclass of -@pxref{136,,gccjit;;rvalue}, where the rvalue is computed by reading from the +@pxref{137,,gccjit;;rvalue}, where the rvalue is computed by reading from the storage area. It iss a thin wrapper around @pxref{24,,gcc_jit_lvalue *} from the C API. @geindex gccjit;;lvalue;;get_address (C++ function) -@anchor{cp/topics/expressions gccjit lvalue get_address__gccjit location}@anchor{16f} +@anchor{cp/topics/expressions gccjit lvalue get_address__gccjit location}@anchor{170} @deffn {C++ Function} gccjit::rvalue gccjit::lvalue::get_address (gccjit::location loc) Take the address of an lvalue; analogous to: @@ -12569,27 +12582,27 @@ Parameter "loc" is optional. @end menu @node Global variables<2>,,,Lvalues<2> -@anchor{cp/topics/expressions global-variables}@anchor{170} +@anchor{cp/topics/expressions global-variables}@anchor{171} @subsubsection Global variables @geindex gccjit;;context;;new_global (C++ function) -@anchor{cp/topics/expressions gccjit context new_global__enum gccjit type cCP gccjit location}@anchor{171} +@anchor{cp/topics/expressions gccjit context new_global__enum gccjit type cCP gccjit location}@anchor{172} @deffn {C++ Function} gccjit::lvalue gccjit::context::new_global (enum gcc_jit_global_kind, gccjit::type type, const char* name, gccjit::location loc) Add a new global variable of the given type and name to the context. -This is a thin wrapper around @pxref{ac,,gcc_jit_context_new_global()} from +This is a thin wrapper around @pxref{ad,,gcc_jit_context_new_global()} from the C API; the "kind" parameter has the same meaning as there. @end deffn @node Working with pointers structs and unions<2>,,Lvalues<2>,Expressions<2> -@anchor{cp/topics/expressions working-with-pointers-structs-and-unions}@anchor{172} +@anchor{cp/topics/expressions working-with-pointers-structs-and-unions}@anchor{173} @subsubsection Working with pointers, structs and unions @geindex gccjit;;rvalue;;dereference (C++ function) -@anchor{cp/topics/expressions gccjit rvalue dereference__gccjit location}@anchor{173} +@anchor{cp/topics/expressions gccjit rvalue dereference__gccjit location}@anchor{174} @deffn {C++ Function} gccjit::lvalue gccjit::rvalue::dereference (gccjit::location loc) Given an rvalue of pointer type @code{T *}, dereferencing the pointer, @@ -12622,7 +12635,7 @@ gccjit::lvalue content = *ptr; Field access is provided separately for both lvalues and rvalues: @geindex gccjit;;lvalue;;access_field (C++ function) -@anchor{cp/topics/expressions gccjit lvalue access_field__gccjit field gccjit location}@anchor{174} +@anchor{cp/topics/expressions gccjit lvalue access_field__gccjit field gccjit location}@anchor{175} @deffn {C++ Function} gccjit::lvalue gccjit::lvalue::access_field (gccjit::field field, gccjit::location loc) Given an lvalue of struct or union type, access the given field, @@ -12638,7 +12651,7 @@ in C. @end deffn @geindex gccjit;;rvalue;;access_field (C++ function) -@anchor{cp/topics/expressions gccjit rvalue access_field__gccjit field gccjit location}@anchor{175} +@anchor{cp/topics/expressions gccjit rvalue access_field__gccjit field gccjit location}@anchor{176} @deffn {C++ Function} gccjit::rvalue gccjit::rvalue::access_field (gccjit::field field, gccjit::location loc) Given an rvalue of struct or union type, access the given field @@ -12654,7 +12667,7 @@ in C. @end deffn @geindex gccjit;;rvalue;;dereference_field (C++ function) -@anchor{cp/topics/expressions gccjit rvalue dereference_field__gccjit field gccjit location}@anchor{176} +@anchor{cp/topics/expressions gccjit rvalue dereference_field__gccjit field gccjit location}@anchor{177} @deffn {C++ Function} gccjit::lvalue gccjit::rvalue::dereference_field (gccjit::field field, gccjit::location loc) Given an rvalue of pointer type @code{T *} where T is of struct or union @@ -12670,7 +12683,7 @@ in C, itself equivalent to @code{(*EXPR).FIELD}. @end deffn @geindex gccjit;;context;;new_array_access (C++ function) -@anchor{cp/topics/expressions gccjit context new_array_access__gccjit rvalue gccjit rvalue gccjit location}@anchor{177} +@anchor{cp/topics/expressions gccjit context new_array_access__gccjit rvalue gccjit rvalue gccjit location}@anchor{178} @deffn {C++ Function} gccjit::lvalue gccjit::context::new_array_access (gccjit::rvalue ptr, gccjit::rvalue index, gccjit::location loc) Given an rvalue of pointer type @code{T *}, get at the element @cite{T} at @@ -12689,7 +12702,7 @@ in C (or, indeed, to @code{PTR + INDEX}). Parameter "loc" is optional. @end deffn -For array accesses where you don't need to specify a @pxref{117,,gccjit;;location}, +For array accesses where you don't need to specify a @pxref{118,,gccjit;;location}, two overloaded operators are available: @quotation @@ -12729,7 +12742,7 @@ gccjit::lvalue element = array[0]; @c . @node Creating and using functions<2>,Source Locations<2>,Expressions<2>,Topic Reference<2> -@anchor{cp/topics/functions doc}@anchor{178}@anchor{cp/topics/functions creating-and-using-functions}@anchor{179} +@anchor{cp/topics/functions doc}@anchor{179}@anchor{cp/topics/functions creating-and-using-functions}@anchor{17a} @subsection Creating and using functions @@ -12742,36 +12755,36 @@ gccjit::lvalue element = array[0]; @end menu @node Params<2>,Functions<2>,,Creating and using functions<2> -@anchor{cp/topics/functions params}@anchor{17a} +@anchor{cp/topics/functions params}@anchor{17b} @subsubsection Params @geindex gccjit;;param (C++ class) -@anchor{cp/topics/functions gccjit param}@anchor{17b} +@anchor{cp/topics/functions gccjit param}@anchor{17c} @deffn {C++ Class} gccjit::param A @cite{gccjit::param} represents a parameter to a function. @end deffn @geindex gccjit;;context;;new_param (C++ function) -@anchor{cp/topics/functions gccjit context new_param__gccjit type cCP gccjit location}@anchor{e6} +@anchor{cp/topics/functions gccjit context new_param__gccjit type cCP gccjit location}@anchor{e7} @deffn {C++ Function} gccjit::param gccjit::context::new_param (gccjit::type type, const char* name, gccjit::location loc) In preparation for creating a function, create a new parameter of the given type and name. @end deffn -@pxref{17b,,gccjit;;param} is a subclass of @pxref{16e,,gccjit;;lvalue} (and thus -of @pxref{136,,gccjit;;rvalue} and @pxref{120,,gccjit;;object}). It is a thin +@pxref{17c,,gccjit;;param} is a subclass of @pxref{16f,,gccjit;;lvalue} (and thus +of @pxref{137,,gccjit;;rvalue} and @pxref{121,,gccjit;;object}). It is a thin wrapper around the C API's @pxref{25,,gcc_jit_param *}. @node Functions<2>,Blocks<2>,Params<2>,Creating and using functions<2> -@anchor{cp/topics/functions functions}@anchor{17c} +@anchor{cp/topics/functions functions}@anchor{17d} @subsubsection Functions @geindex gccjit;;function (C++ class) -@anchor{cp/topics/functions gccjit function}@anchor{17d} +@anchor{cp/topics/functions gccjit function}@anchor{17e} @deffn {C++ Class} gccjit::function A @cite{gccjit::function} represents a function - either one that we're @@ -12789,29 +12802,29 @@ This is a wrapper around the C API's @pxref{11,,gcc_jit_context_new_function()}. @end deffn @geindex gccjit;;context;;get_builtin_function (C++ function) -@anchor{cp/topics/functions gccjit context get_builtin_function__cCP}@anchor{17e} +@anchor{cp/topics/functions gccjit context get_builtin_function__cCP}@anchor{17f} @deffn {C++ Function} gccjit::function gccjit::context::get_builtin_function (const char* name) This is a wrapper around the C API's -@pxref{c3,,gcc_jit_context_get_builtin_function()}. +@pxref{c4,,gcc_jit_context_get_builtin_function()}. @end deffn @geindex gccjit;;function;;get_param (C++ function) -@anchor{cp/topics/functions gccjit function get_param__iC}@anchor{17f} +@anchor{cp/topics/functions gccjit function get_param__iC}@anchor{180} @deffn {C++ Function} gccjit::param gccjit::function::get_param (int index) const Get the param of the given index (0-based). @end deffn @geindex gccjit;;function;;dump_to_dot (C++ function) -@anchor{cp/topics/functions gccjit function dump_to_dot__cCP}@anchor{f9} +@anchor{cp/topics/functions gccjit function dump_to_dot__cCP}@anchor{fa} @deffn {C++ Function} void gccjit::function::dump_to_dot (const char* path) Emit the function in graphviz format to the given path. @end deffn @geindex gccjit;;function;;new_local (C++ function) -@anchor{cp/topics/functions gccjit function new_local__gccjit type cCP gccjit location}@anchor{f0} +@anchor{cp/topics/functions gccjit function new_local__gccjit type cCP gccjit location}@anchor{f1} @deffn {C++ Function} gccjit::lvalue gccjit::function::new_local (gccjit::type type, const char* name, gccjit::location loc) Create a new local variable within the function, of the given type and @@ -12819,19 +12832,19 @@ name. @end deffn @node Blocks<2>,Statements<2>,Functions<2>,Creating and using functions<2> -@anchor{cp/topics/functions blocks}@anchor{180} +@anchor{cp/topics/functions blocks}@anchor{181} @subsubsection Blocks @geindex gccjit;;block (C++ class) -@anchor{cp/topics/functions gccjit block}@anchor{181} +@anchor{cp/topics/functions gccjit block}@anchor{182} @deffn {C++ Class} gccjit::block A @cite{gccjit::block} represents a basic block within a function i.e. a sequence of statements with a single entry point and a single exit point. -@pxref{181,,gccjit;;block} is a subclass of @pxref{120,,gccjit;;object}. +@pxref{182,,gccjit;;block} is a subclass of @pxref{121,,gccjit;;object}. The first basic block that you create within a function will be the entrypoint. @@ -12844,7 +12857,7 @@ one function. @end deffn @geindex gccjit;;function;;new_block (C++ function) -@anchor{cp/topics/functions gccjit function new_block__cCP}@anchor{182} +@anchor{cp/topics/functions gccjit function new_block__cCP}@anchor{183} @deffn {C++ Function} gccjit::block gccjit::function::new_block (const char* name) Create a basic block of the given name. The name may be NULL, but @@ -12854,12 +12867,12 @@ messages. @end deffn @node Statements<2>,,Blocks<2>,Creating and using functions<2> -@anchor{cp/topics/functions statements}@anchor{183} +@anchor{cp/topics/functions statements}@anchor{184} @subsubsection Statements @geindex gccjit;;block;;add_eval (C++ function) -@anchor{cp/topics/functions gccjit block add_eval__gccjit rvalue gccjit location}@anchor{16a} +@anchor{cp/topics/functions gccjit block add_eval__gccjit rvalue gccjit location}@anchor{16b} @deffn {C++ Function} void gccjit::block::add_eval (gccjit::rvalue rvalue, gccjit::location loc) Add evaluation of an rvalue, discarding the result @@ -12875,7 +12888,7 @@ This is equivalent to this C code: @end deffn @geindex gccjit;;block;;add_assignment (C++ function) -@anchor{cp/topics/functions gccjit block add_assignment__gccjit lvalue gccjit rvalue gccjit location}@anchor{f2} +@anchor{cp/topics/functions gccjit block add_assignment__gccjit lvalue gccjit rvalue gccjit location}@anchor{f3} @deffn {C++ Function} void gccjit::block::add_assignment (gccjit::lvalue lvalue, gccjit::rvalue rvalue, gccjit::location loc) Add evaluation of an rvalue, assigning the result to the given @@ -12891,7 +12904,7 @@ lvalue = rvalue; @end deffn @geindex gccjit;;block;;add_assignment_op (C++ function) -@anchor{cp/topics/functions gccjit block add_assignment_op__gccjit lvalue enum gccjit rvalue gccjit location}@anchor{f6} +@anchor{cp/topics/functions gccjit block add_assignment_op__gccjit lvalue enum gccjit rvalue gccjit location}@anchor{f7} @deffn {C++ Function} void gccjit::block::add_assignment_op (gccjit::lvalue lvalue, enum gcc_jit_binary_op, gccjit::rvalue rvalue, gccjit::location loc) Add evaluation of an rvalue, using the result to modify an @@ -12921,7 +12934,7 @@ loop_body.add_assignment_op ( @end deffn @geindex gccjit;;block;;add_comment (C++ function) -@anchor{cp/topics/functions gccjit block add_comment__cCP gccjit location}@anchor{101} +@anchor{cp/topics/functions gccjit block add_comment__cCP gccjit location}@anchor{102} @deffn {C++ Function} void gccjit::block::add_comment (const char* text, gccjit::location loc) Add a no-op textual comment to the internal representation of the @@ -12935,7 +12948,7 @@ Parameter "loc" is optional. @end deffn @geindex gccjit;;block;;end_with_conditional (C++ function) -@anchor{cp/topics/functions gccjit block end_with_conditional__gccjit rvalue gccjit block gccjit block gccjit location}@anchor{f5} +@anchor{cp/topics/functions gccjit block end_with_conditional__gccjit rvalue gccjit block gccjit block gccjit location}@anchor{f6} @deffn {C++ Function} void gccjit::block::end_with_conditional (gccjit::rvalue boolval, gccjit::block on_true, gccjit::block on_false, gccjit::location loc) Terminate a block by adding evaluation of an rvalue, branching on the @@ -12956,7 +12969,7 @@ block, boolval, on_true, and on_false must be non-NULL. @end deffn @geindex gccjit;;block;;end_with_jump (C++ function) -@anchor{cp/topics/functions gccjit block end_with_jump__gccjit block gccjit location}@anchor{184} +@anchor{cp/topics/functions gccjit block end_with_jump__gccjit block gccjit location}@anchor{185} @deffn {C++ Function} void gccjit::block::end_with_jump (gccjit::block target, gccjit::location loc) Terminate a block by adding a jump to the given target block. @@ -12971,7 +12984,7 @@ goto target; @end deffn @geindex gccjit;;block;;end_with_return (C++ function) -@anchor{cp/topics/functions gccjit block end_with_return__gccjit rvalue gccjit location}@anchor{185} +@anchor{cp/topics/functions gccjit block end_with_return__gccjit rvalue gccjit location}@anchor{186} @deffn {C++ Function} void gccjit::block::end_with_return (gccjit::rvalue rvalue, gccjit::location loc) Terminate a block. @@ -13022,12 +13035,12 @@ return; @c . @node Source Locations<2>,Compiling a context<2>,Creating and using functions<2>,Topic Reference<2> -@anchor{cp/topics/locations source-locations}@anchor{186}@anchor{cp/topics/locations doc}@anchor{187} +@anchor{cp/topics/locations source-locations}@anchor{187}@anchor{cp/topics/locations doc}@anchor{188} @subsection Source Locations @geindex gccjit;;location (C++ class) -@anchor{cp/topics/locations gccjit location}@anchor{117} +@anchor{cp/topics/locations gccjit location}@anchor{118} @deffn {C++ Class} gccjit::location A @cite{gccjit::location} encapsulates a source code location, so that @@ -13038,10 +13051,10 @@ single-step through your language. @cite{gccjit::location} instances are optional: you can always omit them from any C++ API entrypoint accepting one. -You can construct them using @pxref{105,,gccjit;;context;;new_location()}. +You can construct them using @pxref{106,,gccjit;;context;;new_location()}. You need to enable @pxref{42,,GCC_JIT_BOOL_OPTION_DEBUGINFO} on the -@pxref{10f,,gccjit;;context} for these locations to actually be usable by +@pxref{110,,gccjit;;context} for these locations to actually be usable by the debugger: @example @@ -13052,7 +13065,7 @@ ctxt.set_bool_option (GCC_JIT_BOOL_OPTION_DEBUGINFO, 1); @end deffn @geindex gccjit;;context;;new_location (C++ function) -@anchor{cp/topics/locations gccjit context new_location__cCP i i}@anchor{105} +@anchor{cp/topics/locations gccjit context new_location__cCP i i}@anchor{106} @deffn {C++ Function} gccjit::location gccjit::context::new_location (const char* filename, int line, int column) Create a @cite{gccjit::location} instance representing the given source @@ -13065,13 +13078,13 @@ location. @end menu @node Faking it<2>,,,Source Locations<2> -@anchor{cp/topics/locations faking-it}@anchor{188} +@anchor{cp/topics/locations faking-it}@anchor{189} @subsubsection Faking it If you don't have source code for your internal representation, but need to debug, you can generate a C-like representation of the functions in -your context using @pxref{116,,gccjit;;context;;dump_to_file()}: +your context using @pxref{117,,gccjit;;context;;dump_to_file()}: @example ctxt.dump_to_file ("/tmp/something.c", @@ -13103,13 +13116,13 @@ file, giving you @emph{something} you can step through in the debugger. @c . @node Compiling a context<2>,,Source Locations<2>,Topic Reference<2> -@anchor{cp/topics/compilation compiling-a-context}@anchor{189}@anchor{cp/topics/compilation doc}@anchor{18a} +@anchor{cp/topics/compilation compiling-a-context}@anchor{18a}@anchor{cp/topics/compilation doc}@anchor{18b} @subsection Compiling a context -Once populated, a @pxref{10f,,gccjit;;context} can be compiled to -machine code, either in-memory via @pxref{e8,,gccjit;;context;;compile()} or -to disk via @pxref{18b,,gccjit;;context;;compile_to_file()}. +Once populated, a @pxref{110,,gccjit;;context} can be compiled to +machine code, either in-memory via @pxref{e9,,gccjit;;context;;compile()} or +to disk via @pxref{18c,,gccjit;;context;;compile_to_file()}. You can compile a context multiple times (using either form of compilation), although any errors that occur on the context will @@ -13122,12 +13135,12 @@ prevent any future compilation of that context. @end menu @node In-memory compilation<2>,Ahead-of-time compilation<2>,,Compiling a context<2> -@anchor{cp/topics/compilation in-memory-compilation}@anchor{18c} +@anchor{cp/topics/compilation in-memory-compilation}@anchor{18d} @subsubsection In-memory compilation @geindex gccjit;;context;;compile (C++ function) -@anchor{cp/topics/compilation gccjit context compile}@anchor{e8} +@anchor{cp/topics/compilation gccjit context compile}@anchor{e9} @deffn {C++ Function} gcc_jit_result* gccjit::context::compile () This calls into GCC and builds the code, returning a @@ -13138,19 +13151,19 @@ This is a thin wrapper around the @end deffn @node Ahead-of-time compilation<2>,,In-memory compilation<2>,Compiling a context<2> -@anchor{cp/topics/compilation ahead-of-time-compilation}@anchor{18d} +@anchor{cp/topics/compilation ahead-of-time-compilation}@anchor{18e} @subsubsection Ahead-of-time compilation Although libgccjit is primarily aimed at just-in-time compilation, it can also be used for implementing more traditional ahead-of-time -compilers, via the @pxref{18b,,gccjit;;context;;compile_to_file()} method. +compilers, via the @pxref{18c,,gccjit;;context;;compile_to_file()} method. @geindex gccjit;;context;;compile_to_file (C++ function) -@anchor{cp/topics/compilation gccjit context compile_to_file__enum cCP}@anchor{18b} +@anchor{cp/topics/compilation gccjit context compile_to_file__enum cCP}@anchor{18c} @deffn {C++ Function} void gccjit::context::compile_to_file (enum gcc_jit_output_kind, const char* output_path) -Compile the @pxref{10f,,gccjit;;context} to a file of the given +Compile the @pxref{110,,gccjit;;context} to a file of the given kind. This is a thin wrapper around the @@ -13175,7 +13188,7 @@ This is a thin wrapper around the @c . @node Internals,Indices and tables,C++ bindings for libgccjit,Top -@anchor{internals/index internals}@anchor{18e}@anchor{internals/index doc}@anchor{18f} +@anchor{internals/index internals}@anchor{18f}@anchor{internals/index doc}@anchor{190} @chapter Internals @@ -13189,7 +13202,7 @@ This is a thin wrapper around the @end menu @node Working on the JIT library,Running the test suite,,Internals -@anchor{internals/index working-on-the-jit-library}@anchor{190} +@anchor{internals/index working-on-the-jit-library}@anchor{191} @section Working on the JIT library @@ -13226,7 +13239,7 @@ gcc/libgccjit.so.0.0.1: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), Here's what those configuration options mean: @geindex command line option; --enable-host-shared -@anchor{internals/index cmdoption--enable-host-shared}@anchor{191} +@anchor{internals/index cmdoption--enable-host-shared}@anchor{192} @deffn {Option} --enable-host-shared Configuring with this option means that the compiler is built as @@ -13235,7 +13248,7 @@ but it necessary for a shared library. @end deffn @geindex command line option; --enable-languages=jit@comma{}c++ -@anchor{internals/index cmdoption--enable-languages}@anchor{192} +@anchor{internals/index cmdoption--enable-languages}@anchor{193} @deffn {Option} --enable-languages=jit,c++ This specifies which frontends to build. The JIT library looks like @@ -13254,7 +13267,7 @@ c++: error trying to exec 'cc1plus': execvp: No such file or directory @end deffn @geindex command line option; --disable-bootstrap -@anchor{internals/index cmdoption--disable-bootstrap}@anchor{193} +@anchor{internals/index cmdoption--disable-bootstrap}@anchor{194} @deffn {Option} --disable-bootstrap For hacking on the "jit" subdirectory, performing a full @@ -13264,7 +13277,7 @@ the compiler can still bootstrap itself. @end deffn @geindex command line option; --enable-checking=release -@anchor{internals/index cmdoption--enable-checking}@anchor{194} +@anchor{internals/index cmdoption--enable-checking}@anchor{195} @deffn {Option} --enable-checking=release The compile can perform extensive self-checking as it runs, useful when @@ -13275,7 +13288,7 @@ disable this self-checking. @end deffn @node Running the test suite,Environment variables,Working on the JIT library,Internals -@anchor{internals/index running-the-test-suite}@anchor{195} +@anchor{internals/index running-the-test-suite}@anchor{196} @section Running the test suite @@ -13338,7 +13351,7 @@ and once a test has been compiled, you can debug it directly: @end menu @node Running under valgrind,,,Running the test suite -@anchor{internals/index running-under-valgrind}@anchor{196} +@anchor{internals/index running-under-valgrind}@anchor{197} @subsection Running under valgrind @@ -13386,7 +13399,7 @@ When running under valgrind, it's best to have configured gcc with various known false positives. @node Environment variables,Overview of code structure,Running the test suite,Internals -@anchor{internals/index environment-variables}@anchor{197} +@anchor{internals/index environment-variables}@anchor{198} @section Environment variables @@ -13394,7 +13407,7 @@ When running client code against a locally-built libgccjit, three environment variables need to be set up: @geindex environment variable; LD_LIBRARY_PATH -@anchor{internals/index envvar-LD_LIBRARY_PATH}@anchor{198} +@anchor{internals/index envvar-LD_LIBRARY_PATH}@anchor{199} @deffn {Environment Variable} LD_LIBRARY_PATH @quotation @@ -13416,7 +13429,7 @@ libgccjit.so.0.0.1: ELF 64-bit LSB shared object, x86-64, version 1 (GNU/Linux), @end deffn @geindex environment variable; PATH -@anchor{internals/index envvar-PATH}@anchor{199} +@anchor{internals/index envvar-PATH}@anchor{19a} @deffn {Environment Variable} PATH The library uses a driver executable for converting from .s assembler @@ -13435,7 +13448,7 @@ of development. @end deffn @geindex environment variable; LIBRARY_PATH -@anchor{internals/index envvar-LIBRARY_PATH}@anchor{19a} +@anchor{internals/index envvar-LIBRARY_PATH}@anchor{19b} @deffn {Environment Variable} LIBRARY_PATH The driver executable invokes the linker, and the latter needs to locate @@ -13471,7 +13484,7 @@ hello world @noindent @node Overview of code structure,Design notes,Environment variables,Internals -@anchor{internals/index overview-of-code-structure}@anchor{19b} +@anchor{internals/index overview-of-code-structure}@anchor{19c} @section Overview of code structure @@ -13935,7 +13948,7 @@ JIT: gcc::jit::logger::~logger() @noindent @node Design notes,,Overview of code structure,Internals -@anchor{internals/index design-notes}@anchor{19c} +@anchor{internals/index design-notes}@anchor{19d} @section Design notes @@ -13948,7 +13961,7 @@ close as possible to the error; failing that, a good place is within @code{recording::context::validate ()} in jit-recording.c. @node Indices and tables,Index,Internals,Top -@anchor{index indices-and-tables}@anchor{19d} +@anchor{index indices-and-tables}@anchor{19e} @unnumbered Indices and tables diff --git a/gcc/jit/docs/cp/intro/tutorial03.rst b/gcc/jit/docs/cp/intro/tutorial03.rst index aac781d69ef..f4405ad2ea7 100644 --- a/gcc/jit/docs/cp/intro/tutorial03.rst +++ b/gcc/jit/docs/cp/intro/tutorial03.rst @@ -238,7 +238,9 @@ and can then use this to add `b_loop_cond`'s sole statement, via .. code-block:: c++ - b_loop_cond.end_with_conditional (guard); + b_loop_cond.end_with_conditional (guard, + b_after_loop, // on_true + b_loop_body); // on_false However :type:`gccjit::rvalue` has overloaded operators for this, so we express the conditional as @@ -247,14 +249,14 @@ express the conditional as gccjit::rvalue guard = (i >= n); -and hence write the block more concisely as: +and hence we can write the block more concisely as: .. code-block:: c++ b_loop_cond.end_with_conditional ( i >= n, - b_after_loop, - b_loop_body); + b_after_loop, // on_true + b_loop_body); // on_false Next, we populate the body of the loop. diff --git a/gcc/jit/docs/intro/tutorial03.rst b/gcc/jit/docs/intro/tutorial03.rst index cd7136a3c9c..6c1ca3e6ef7 100644 --- a/gcc/jit/docs/intro/tutorial03.rst +++ b/gcc/jit/docs/intro/tutorial03.rst @@ -229,6 +229,7 @@ We build the comparison using :c:func:`gcc_jit_context_new_comparison`: .. code-block:: c + /* (i >= n) */ gcc_jit_rvalue *guard = gcc_jit_context_new_comparison ( ctxt, NULL, @@ -241,7 +242,16 @@ and can then use this to add `b_loop_cond`'s sole statement, via .. code-block:: c - gcc_jit_block_end_with_conditional (b_loop_cond, NULL, guard); + /* Equivalent to: + if (guard) + goto after_loop; + else + goto loop_body; */ + gcc_jit_block_end_with_conditional ( + b_loop_cond, NULL, + guard, + b_after_loop, /* on_true */ + b_loop_body); /* on_false */ Next, we populate the body of the loop. diff --git a/gcc/jit/docs/topics/compilation.rst b/gcc/jit/docs/topics/compilation.rst index 708d0094c28..4eddf7672ac 100644 --- a/gcc/jit/docs/topics/compilation.rst +++ b/gcc/jit/docs/topics/compilation.rst @@ -37,7 +37,7 @@ In-memory compilation This calls into GCC and builds the code, returning a `gcc_jit_result *`. - If this is non-NULL, the caller becomes responsible for + If the result is non-NULL, the caller becomes responsible for calling :func:`gcc_jit_result_release` on it once they're done with it. diff --git a/gcc/jit/docs/topics/contexts.rst b/gcc/jit/docs/topics/contexts.rst index 46a08bdba4c..b7f281a5e69 100644 --- a/gcc/jit/docs/topics/contexts.rst +++ b/gcc/jit/docs/topics/contexts.rst @@ -138,7 +138,7 @@ be responsible for all of the rest: If no errors occurred, this will be NULL. If you are wrapping the C API for a higher-level language that supports -exception-handling, you may instead by interested in the last error that +exception-handling, you may instead be interested in the last error that occurred on the context, so that you can embed this in an exception: .. function:: const char *\ diff --git a/gcc/jit/docs/topics/expressions.rst b/gcc/jit/docs/topics/expressions.rst index 1cedb6621be..49317b9d55a 100644 --- a/gcc/jit/docs/topics/expressions.rst +++ b/gcc/jit/docs/topics/expressions.rst @@ -233,7 +233,7 @@ Binary Operation C equivalent For pointer addition, use :c:func:`gcc_jit_context_new_array_access`. -.. c:macro:: GCC_JIT_BINARY_OP_MINUS` +.. c:macro:: GCC_JIT_BINARY_OP_MINUS Subtraction of arithmetic values; analogous to: -- 2.30.2