Commit 58c2577a3ff80e7416ef0434769e2af23365719c

Alan Modra 2013-11-13T16:55:36

This enshrines the current testsuite practice of using ffi_arg for returned values. It would be reasonable and logical to use the actual return argument type as passed to ffi_prep_cif, but this would mean changing a large number of tests that use ffi_arg and all backends that write results to an ffi_arg.

diff --git a/ChangeLog b/ChangeLog
index 3cb6188..806af18 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2013-11-13  Alan Modra  <amodra@gmail.com>
+
+	* doc/libffi.texi (Simple Example): Correct example code.
+	* doc/libffi.info, doc/stamp-vti, doc/version.texi: Rebuilt.
+
 2013-11-13  Anthony Green  <green@moxielogic.com>
 
 	* include/ffi_common.h: Respect HAVE_ALLOCA_H for GNU compiler
diff --git a/doc/libffi.info b/doc/libffi.info
index fb02d37..4d42f5b 100644
--- a/doc/libffi.info
+++ b/doc/libffi.info
@@ -186,7 +186,7 @@ Here is a trivial example that calls 'puts' a few times.
        ffi_type *args[1];
        void *values[1];
        char *s;
-       int rc;
+       ffi_arg rc;
 
        /* Initialize the argument info vectors */
        args[0] = &ffi_type_pointer;
@@ -194,7 +194,7 @@ Here is a trivial example that calls 'puts' a few times.
 
        /* Initialize the cif */
        if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1,
-     		       &ffi_type_uint, args) == FFI_OK)
+     		       &ffi_type_sint, args) == FFI_OK)
          {
            s = "Hello World!";
            ffi_call(&cif, puts, &rc, values);
@@ -363,6 +363,7 @@ The following example initializes a 'ffi_type' object representing the
            int i;
 
            tm_type.size = tm_type.alignment = 0;
+           tm_type.type = FFI_TYPE_STRUCT;
            tm_type.elements = &tm_type_elements;
 
            for (i = 0; i < 9; i++)
@@ -477,7 +478,7 @@ A trivial example that creates a new 'puts' by binding 'fputs' with
      #include <ffi.h>
 
      /* Acts like puts with the file given at time of enclosure. */
-     void puts_binding(ffi_cif *cif, unsigned int *ret, void* args[],
+     void puts_binding(ffi_cif *cif, ffi_arg *ret, void* args[],
                        FILE *stream)
      {
        *ret = fputs(*(char **)args[0], stream);
@@ -502,7 +503,7 @@ A trivial example that creates a new 'puts' by binding 'fputs' with
 
            /* Initialize the cif */
            if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1,
-                            &ffi_type_uint, args) == FFI_OK)
+                            &ffi_type_sint, args) == FFI_OK)
              {
                /* Initialize the closure, setting stream to stdout */
                if (ffi_prep_closure_loc(closure, &cif, puts_binding,
@@ -602,14 +603,14 @@ Node: Introduction1429
 Node: Using libffi3061
 Node: The Basics3547
 Node: Simple Example7198
-Node: Types8225
-Node: Primitive Types8508
-Node: Structures10329
-Node: Type Example11203
-Node: Multiple ABIs12426
-Node: The Closure API12797
-Node: Closure Example15741
-Node: Missing Features17300
-Node: Index17753
+Node: Types8229
+Node: Primitive Types8512
+Node: Structures10333
+Node: Type Example11207
+Node: Multiple ABIs12473
+Node: The Closure API12844
+Node: Closure Example15788
+Node: Missing Features17342
+Node: Index17795
 
 End Tag Table
diff --git a/doc/libffi.texi b/doc/libffi.texi
index eca11dc..d13c5c0 100644
--- a/doc/libffi.texi
+++ b/doc/libffi.texi
@@ -214,7 +214,7 @@ int main()
   ffi_type *args[1];
   void *values[1];
   char *s;
-  int rc;
+  ffi_arg rc;
   
   /* Initialize the argument info vectors */    
   args[0] = &ffi_type_pointer;
@@ -222,7 +222,7 @@ int main()
   
   /* Initialize the cif */
   if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1, 
-		       &ffi_type_uint, args) == FFI_OK)
+		       &ffi_type_sint, args) == FFI_OK)
     @{
       s = "Hello World!";
       ffi_call(&cif, puts, &rc, values);
@@ -414,6 +414,7 @@ Here is the corresponding code to describe this struct to
       int i;
 
       tm_type.size = tm_type.alignment = 0;
+      tm_type.type = FFI_TYPE_STRUCT;
       tm_type.elements = &tm_type_elements;
     
       for (i = 0; i < 9; i++)
@@ -540,7 +541,7 @@ A trivial example that creates a new @code{puts} by binding
 #include <ffi.h>
 
 /* Acts like puts with the file given at time of enclosure. */
-void puts_binding(ffi_cif *cif, unsigned int *ret, void* args[], 
+void puts_binding(ffi_cif *cif, ffi_arg *ret, void* args[], 
                   FILE *stream)
 @{
   *ret = fputs(*(char **)args[0], stream);
@@ -565,7 +566,7 @@ int main()
 
       /* Initialize the cif */
       if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1,
-                       &ffi_type_uint, args) == FFI_OK)
+                       &ffi_type_sint, args) == FFI_OK)
         @{
           /* Initialize the closure, setting stream to stdout */
           if (ffi_prep_closure_loc(closure, &cif, puts_binding, 
diff --git a/doc/stamp-vti b/doc/stamp-vti
index fbdde9b..3c7f7b2 100644
--- a/doc/stamp-vti
+++ b/doc/stamp-vti
@@ -1,4 +1,4 @@
-@set UPDATED 2 July 2013
-@set UPDATED-MONTH July 2013
+@set UPDATED 13 November 2013
+@set UPDATED-MONTH November 2013
 @set EDITION 3.0.14-rc0
 @set VERSION 3.0.14-rc0
diff --git a/doc/version.texi b/doc/version.texi
index fbdde9b..3c7f7b2 100644
--- a/doc/version.texi
+++ b/doc/version.texi
@@ -1,4 +1,4 @@
-@set UPDATED 2 July 2013
-@set UPDATED-MONTH July 2013
+@set UPDATED 13 November 2013
+@set UPDATED-MONTH November 2013
 @set EDITION 3.0.14-rc0
 @set VERSION 3.0.14-rc0