home *** CD-ROM | disk | FTP | other *** search
/ ftp.cs.arizona.edu / ftp.cs.arizona.edu.tar / ftp.cs.arizona.edu / icon / historic / v941.tgz / icon.v941src.tar / icon.v941src / ipl / cfuncs / icall.h < prev    next >
C/C++ Source or Header  |  2001-05-31  |  7KB  |  199 lines
  1. /*
  2. ############################################################################
  3. #
  4. #    File:     icall.h
  5. #
  6. #    Subject:  Definitions for external C functions
  7. #
  8. #    Author:   Gregg M. Townsend
  9. #
  10. #    Date:     May 31, 2001
  11. #
  12. ############################################################################
  13. #
  14. #   This file is in the public domain.
  15. #
  16. ############################################################################
  17. #
  18. #   These definitions assist in writing external C functions for use with
  19. #   Version 9 of Icon.
  20. #
  21. ############################################################################
  22. # 
  23. #   From Icon, loadfunc(libfile, funcname) loads a C function of the form
  24. #     int func(int argc, descriptor argv[])
  25. #   where "descriptor" is the structure type defined here.  The C
  26. #   function returns -1 to fail, 0 to succeed, or a positive integer
  27. #   to report an error.  Argv[1] through argv[argc] are the incoming
  28. #   arguments; the return value on success (or the offending value
  29. #   in case of error) is stored in argv[0].
  30. # 
  31. #   In the macro descriptions below, d is a descriptor value, typically
  32. #   a member of the argv array.  IMPORTANT: many macros assume that the
  33. #   C function's parameters are named "argc" and "argv" as noted above.
  34. #
  35. ############################################################################
  36. # 
  37. #   IconType(d) returns one of the characters {cfinprsCILRST} indicating
  38. #   the type of a value according to the key on page 247 of the Red Book.
  39. #   The character I indicates a large (multiprecision) integer.
  40. # 
  41. #   Only a few of these types (i, r, f, s) are easily manipulated in C.
  42. #   Given that the type has been verified, the following macros return
  43. #   the value of a descriptor in C terms:
  44. # 
  45. #     IntegerVal(d)    value of a integer (type 'i') as a C long
  46. #     RealVal(d)    value of a real (type 'r') as a C double
  47. #     FileVal(d)    value of a file (type 'f') as a C FILE pointer
  48. #     FileStat(d)    status field of a file
  49. #     StringVal(d)    value of a string (type 's') as a C char pointer
  50. #             (copied if necessary to add \0 for termination)
  51. # 
  52. #     StringAddr(d)    address of possibly unterminated string
  53. #     StringLen(d)    length of string
  54. # 
  55. #   These macros check the type of an argument, converting if necessary,
  56. #   and returning an error code if the argument is wrong:
  57. # 
  58. #     ArgInteger(i)        check that argv[i] is an integer
  59. #     ArgReal(i)        check that argv[i] is a real number
  60. #     ArgString(i)        check that argv[i] is a string
  61. #
  62. #   Caveats:
  63. #      Allocation failure is not detected.
  64. #
  65. ############################################################################
  66. # 
  67. #   These macros return from the C function back to Icon code:
  68. # 
  69. #     Return            return argv[0] (initially &null)
  70. #     RetArg(i)        return argv[i]
  71. #     RetNull()        return &null
  72. #     RetInteger(i)        return integer value i
  73. #     RetReal(v)        return real value v
  74. #     RetFile(fp,status,name)    return (newly opened) file
  75. #     RetString(s)        return null-terminated string s
  76. #     RetStringN(s, n)    return string s whose length is n
  77. #     RetAlcString(s, n)    return already-allocated string
  78. #     RetConstString(s)    return constant string s
  79. #     RetConstStringN(s, n)    return constant string s of length n
  80. #     Fail            return failure status
  81. #     Error(n)        return error code n
  82. #     ArgError(i,n)        return argv[i] as offending value for error n
  83. #
  84. ############################################################################
  85.  */
  86.  
  87. #include <stdio.h>
  88. #include <limits.h>
  89.  
  90. #if INT_MAX == 32767
  91. #define WordSize 16
  92. #elif LONG_MAX == 2147483647L
  93. #define WordSize 32
  94. #else
  95. #define WordSize 64
  96. #endif
  97.  
  98. #if WordSize <= 32
  99. #define F_Nqual    0x80000000        /* set if NOT string qualifier */
  100. #define F_Var      0x40000000        /* set if variable */
  101. #define F_Ptr      0x10000000        /* set if value field is pointer */
  102. #define F_Typecode 0x20000000        /* set if dword includes type code */
  103. #else
  104. #define F_Nqual    0x8000000000000000    /* set if NOT string qualifier */
  105. #define F_Var      0x4000000000000000    /* set if variable */
  106. #define F_Ptr      0x1000000000000000    /* set if value field is pointer */
  107. #define F_Typecode 0x2000000000000000    /* set if dword includes type code */
  108. #endif
  109.  
  110. #define D_Typecode    (F_Nqual | F_Typecode)
  111.  
  112. #define T_Null         0        /* null value */
  113. #define T_Integer     1        /* integer */
  114. #define T_Real         3        /* real number */
  115. #define T_File         5        /* file, including window */
  116.  
  117. #define D_Null        (T_Null     | D_Typecode)
  118. #define D_Integer    (T_Integer  | D_Typecode)
  119. #define D_Real        (T_Real     | D_Typecode | F_Ptr)
  120. #define D_File        (T_File     | D_Typecode | F_Ptr)
  121.  
  122. #define Fs_Read        0001        /* file open for reading */
  123. #define Fs_Write    0002        /* file open for writing */
  124. #define Fs_Pipe        0020        /* file is a [popen] pipe */
  125. #define Fs_Window    0400        /* file is a window */
  126.  
  127.  
  128. typedef long word;
  129. typedef struct { word dword, vword; } descriptor;
  130. typedef struct { word title; double rval; } realblock;
  131. typedef struct { word title; FILE *fp; word stat; descriptor fname; } fileblock;
  132.  
  133. char *alcstr(char *s, word len);
  134. realblock *alcreal(double v);
  135. fileblock *alcfile(FILE *fp, int stat, descriptor *name);
  136. double getdbl(descriptor *d);
  137.  
  138. extern descriptor nulldesc;        /* null descriptor */
  139.  
  140.  
  141. #define IconType(d) ((d).dword>=0 ? 's' : "niIrcfpRL.S.T.....C"[(d).dword&31])
  142.  
  143.  
  144. #define IntegerVal(d) ((d).vword)
  145.  
  146. #define RealVal(d) getdbl(&(d))
  147.  
  148. #define FileVal(d) (((fileblock *)((d).vword))->fp)
  149. #define FileStat(d) (((fileblock *)((d).vword))->stat)
  150.  
  151. #define StringAddr(d) ((char *)(d).vword)
  152. #define StringLen(d) ((d).dword)
  153.  
  154. #define StringVal(d) \
  155. (*(char*)((d).vword+(d).dword) ? cnv_c_str(&(d),&(d)) : 0, (char*)((d).vword))
  156.  
  157.  
  158. #define ArgInteger(i) do { if (argc < (i)) Error(101); \
  159. if (!cnv_int(&argv[i],&argv[i])) ArgError(i,101); } while (0)
  160.  
  161. #define ArgReal(i) do { if (argc < (i)) Error(102); \
  162. if (!cnv_real(&argv[i],&argv[i])) ArgError(i,102); } while (0)
  163.  
  164. #define ArgString(i) do { if (argc < (i)) Error(103); \
  165. if (!cnv_str(&argv[i],&argv[i])) ArgError(i,103); } while (0)
  166.  
  167.  
  168. #define RetArg(i) return (argv[0] = argv[i], 0)
  169.  
  170. #define RetNull() return (argv->dword = D_Null, argv->vword = 0)
  171.  
  172. #define RetInteger(i) return (argv->dword = D_Integer, argv->vword = i, 0)
  173.  
  174. #define RetReal(v) return (argv->dword=D_Real, argv->vword=(word)alcreal(v), 0)
  175.  
  176. #define RetFile(fp,stat,name) \
  177. do { descriptor dd; dd.vword = (word)alcstr(name, dd.dword = strlen(name)); \
  178.    argv->dword = D_File; argv->vword = (word)alcfile(fp, stat, &dd); \
  179.    return 0; } while (0)
  180.  
  181. #define RetString(s) \
  182. do { word n = strlen(s); \
  183. argv->dword = n; argv->vword = (word)alcstr(s,n); return 0; } while (0)
  184.  
  185. #define RetStringN(s,n) \
  186. do { argv->dword = n; argv->vword = (word)alcstr(s,n); return 0; } while (0)
  187.  
  188. #define RetConstString(s) return (argv->dword=strlen(s), argv->vword=(word)s, 0)
  189.  
  190. #define RetConstStringN(s,n) return (argv->dword=n, argv->vword=(word)s, 0)
  191.  
  192. #define RetAlcString(s,n) return (argv->dword=n, argv->vword=(word)s, 0)
  193.  
  194.  
  195. #define Fail return -1
  196. #define Return return 0
  197. #define Error(n) return n
  198. #define ArgError(i,n) return (argv[0] = argv[i], n)
  199.