src/pl/plperl/plperl.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * plperl.h
   4  *        Common include file for PL/Perl files
   5  *
   6  * This should be included _AFTER_ postgres.h and system include files
   7  *
   8  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
   9  * Portions Copyright (c) 1995, Regents of the University of California
  10  *
  11  * src/pl/plperl/plperl.h
  12  */
  13
  14 #ifndef PL_PERL_H
  15 #define PL_PERL_H
  16
  17 /* stop perl headers from hijacking stdio and other stuff on Windows */
  18 #ifdef WIN32
  19 #define WIN32IO_IS_STDIO
  20 #endif                                                  /* WIN32 */
  21
  22 /*
  23  * Supply a value of PERL_UNUSED_DECL that will satisfy gcc - the one
  24  * perl itself supplies doesn't seem to.
  25  */
  26 #define PERL_UNUSED_DECL pg_attribute_unused()
  27
  28 /*
  29  * Sometimes perl carefully scribbles on our *printf macros.
  30  * So we undefine them here and redefine them after it's done its dirty deed.
  31  */
  32 #undef vsnprintf
  33 #undef snprintf
  34 #undef vsprintf
  35 #undef sprintf
  36 #undef vfprintf
  37 #undef fprintf
  38 #undef vprintf
  39 #undef printf
  40
  41 /*
  42  * Perl scribbles on the "_" macro too.
  43  */
  44 #undef _
  45
  46 /*
  47  * ActivePerl 5.18 and later are MinGW-built, and their headers use GCC's
  48  * __inline__.  Translate to something MSVC recognizes. Also, perl.h sometimes
  49  * defines isnan, so undefine it here and put back the definition later if
  50  * perl.h doesn't.
  51  */
  52 #ifdef _MSC_VER
  53 #define __inline__ inline
  54 #ifdef isnan
  55 #undef isnan
  56 #endif
  57 #endif
  58
  59 /*
  60  * Regarding bool, both PostgreSQL and Perl might use stdbool.h or not,
  61  * depending on configuration.  If both agree, things are relatively harmless.
  62  * If not, things get tricky.  If PostgreSQL does but Perl does not, define
  63  * HAS_BOOL here so that Perl does not redefine bool; this avoids compiler
  64  * warnings.  If PostgreSQL does not but Perl does, we need to undefine bool
  65  * after we include the Perl headers; see below.
  66  */
  67 #ifdef PG_USE_STDBOOL
  68 #define HAS_BOOL 1
  69 #endif
  70
  71
  72 /*
  73  * Get the basic Perl API.  We use PERL_NO_GET_CONTEXT mode so that our code
  74  * can compile against MULTIPLICITY Perl builds without including XSUB.h.
  75  */
  76 #define PERL_NO_GET_CONTEXT
  77 #include "EXTERN.h"
  78 #include "perl.h"
  79
  80 /*
  81  * We want to include XSUB.h only within .xs files, because on some platforms
  82  * it undesirably redefines a lot of libc functions.  But it must appear
  83  * before ppport.h, so use a #define flag to control inclusion here.
  84  */
  85 #ifdef PG_NEED_PERL_XSUB_H
  86 /*
  87  * On Windows, win32_port.h defines macros for a lot of these same functions.
  88  * To avoid compiler warnings when XSUB.h redefines them, #undef our versions.
  89  */
  90 #ifdef WIN32
  91 #undef accept
  92 #undef bind
  93 #undef connect
  94 #undef fopen
  95 #undef fstat
  96 #undef kill
  97 #undef listen
  98 #undef lstat
  99 #undef mkdir
 100 #undef open
 101 #undef putenv
 102 #undef recv
 103 #undef rename
 104 #undef select
 105 #undef send
 106 #undef socket
 107 #undef stat
 108 #undef unlink
 109 #endif
 110
 111 #include "XSUB.h"
 112 #endif
 113
 114 /* put back our *printf macros ... this must match src/include/port.h */
 115 #ifdef vsnprintf
 116 #undef vsnprintf
 117 #endif
 118 #ifdef snprintf
 119 #undef snprintf
 120 #endif
 121 #ifdef vsprintf
 122 #undef vsprintf
 123 #endif
 124 #ifdef sprintf
 125 #undef sprintf
 126 #endif
 127 #ifdef vfprintf
 128 #undef vfprintf
 129 #endif
 130 #ifdef fprintf
 131 #undef fprintf
 132 #endif
 133 #ifdef vprintf
 134 #undef vprintf
 135 #endif
 136 #ifdef printf
 137 #undef printf
 138 #endif
 139
 140 #define vsnprintf               pg_vsnprintf
 141 #define snprintf                pg_snprintf
 142 #define vsprintf                pg_vsprintf
 143 #define sprintf                 pg_sprintf
 144 #define vfprintf                pg_vfprintf
 145 #define fprintf                 pg_fprintf
 146 #define vprintf                 pg_vprintf
 147 #define printf(...)             pg_printf(__VA_ARGS__)
 148
 149 /*
 150  * Put back "_" too; but rather than making it just gettext() as the core
 151  * code does, make it dgettext() so that the right things will happen in
 152  * loadable modules (if they've set up TEXTDOMAIN correctly).  Note that
 153  * we can't just set TEXTDOMAIN here, because this file is used by more
 154  * extensions than just PL/Perl itself.
 155  */
 156 #undef _
 157 #define _(x) dgettext(TEXTDOMAIN, x)
 158
 159 /* put back the definition of isnan if needed */
 160 #ifdef _MSC_VER
 161 #ifndef isnan
 162 #define isnan(x) _isnan(x)
 163 #endif
 164 #endif
 165
 166 /* perl version and platform portability */
 167 #define NEED_eval_pv
 168 #define NEED_newRV_noinc
 169 #define NEED_sv_2pv_flags
 170 #include "ppport.h"
 171
 172 /*
 173  * perl might have included stdbool.h.  If we also did that earlier (see c.h),
 174  * then that's fine.  If not, we probably rejected it for some reason.  In
 175  * that case, undef bool and proceed with our own bool.  (Note that stdbool.h
 176  * makes bool a macro, but our own replacement is a typedef, so the undef
 177  * makes ours visible again).
 178  */
 179 #ifndef PG_USE_STDBOOL
 180 #ifdef bool
 181 #undef bool
 182 #endif
 183 #endif
 184
 185 /* supply HeUTF8 if it's missing - ppport.h doesn't supply it, unfortunately */
 186 #ifndef HeUTF8
 187 #define HeUTF8(he)                         ((HeKLEN(he) == HEf_SVKEY) ?                    \
 188                                                                 SvUTF8(HeKEY_sv(he)) :                             \
 189                                                                 (U32)HeKUTF8(he))
 190 #endif
 191
 192 /* supply GvCV_set if it's missing - ppport.h doesn't supply it, unfortunately */
 193 #ifndef GvCV_set
 194 #define GvCV_set(gv, cv)                (GvCV(gv) = cv)
 195 #endif
 196
 197 /* Perl 5.19.4 changed array indices from I32 to SSize_t */
 198 #if PERL_BCDVERSION >= 0x5019004
 199 #define AV_SIZE_MAX SSize_t_MAX
 200 #else
 201 #define AV_SIZE_MAX I32_MAX
 202 #endif
 203
 204 /* declare routines from plperl.c for access by .xs files */
 205 HV                 *plperl_spi_exec(char *, int);
 206 void            plperl_return_next(SV *);
 207 SV                 *plperl_spi_query(char *);
 208 SV                 *plperl_spi_fetchrow(char *);
 209 SV                 *plperl_spi_prepare(char *, int, SV **);
 210 HV                 *plperl_spi_exec_prepared(char *, HV *, int, SV **);
 211 SV                 *plperl_spi_query_prepared(char *, int, SV **);
 212 void            plperl_spi_freeplan(char *);
 213 void            plperl_spi_cursor_close(char *);
 214 void            plperl_spi_commit(void);
 215 void            plperl_spi_rollback(void);
 216 char       *plperl_sv_to_literal(SV *, char *);
 217 void            plperl_util_elog(int level, SV *msg);
 218
 219 #endif                                                  /* PL_PERL_H */