Update XS code generation notes

Perl-GPU · Mar 11, 2017 · d7c57f7 · d7c57f7
1 parent 88d0906
commit d7c57f7
Show file tree

Hide file tree

Showing 4 changed files with 839 additions and 11 deletions.
diff --git a/utils/XS_generate_NOTES.txt b/utils/XS_generate_NOTES.txt
@@ -40,7 +40,7 @@ GLEW include file declarations in glew.h.
 * Categorize OpenGL bindings as "good" or "bad" according to whether
   or not they have pointer arguments.
 
-  - The good routines
+  - The good routines (DONE)
     - translate cleanly to XS with default typemaps
     - won't require a separate _p perlish version
     - There are 1265 good routines that translate directly (yay!)
@@ -62,19 +62,28 @@ GLEW include file declarations in glew.h.
     -    2 routines with 6 ptrs
     -    1 routines with 7 ptrs
 
-  - Still needs to be detemined the best typemap for pointers
+  - Propose using T_PTRREF or T_PTROBJ for pointers at perl level
     - T_PTR is simple but could lead to SEGFAULT with bad values
-    - Opaque pointers might be better
-    - If the perl value corresponding to the pointer argument is
-      some type of reference (blessed or unblessed) we can use
-      that information to implement simply.  For example, a
-      single argument could be:
-      - an array ref, [ ]
-      - a hash ref, { }
-      - a scalar ref, \$
-      - a blessed object: PDL, Cpointer, OGA, ...
+    - T_PTRREF/OBJ protect pointer value from accidental corruption
+    - Using a reference/object makes for simple typemaps
+      - Just use ref to identify and then use 
+      - Can be done from Perl or C/XS
+      - Some examples:
+        - an array ref, [ ]
+        - a hash ref, { }
+        - a scalar ref, \$
+        - a blessed object: PDL, Cpointer, OGA, ...
 
 * Consider writing generate-XS.pl as a modulino so that it could be
   used as either a command or a module to load and use.
 
+* Propose use of roles to generalize implementation
+  - Basic role provides placeholders for needed functionality
+  - Use around method modifiers to provide actual function
+  - Should be able to "compile" the around routine make fast
+    - could be memoized at the perl level
+    - could be done from the C/XS level
+  - First implementation will focus on functionality
+  - Optimized routines to come or use specific _c routine
+