granicus.if.org Git - postgresql/blob - 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-2018, 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
  33 #ifdef USE_REPL_SNPRINTF
  34 #undef snprintf
  35 #undef vsnprintf
  36 #endif
  37
  38 /*
  39  * ActivePerl 5.18 and later are MinGW-built, and their headers use GCC's
  40  * __inline__.  Translate to something MSVC recognizes.
  41  */
  42 #ifdef _MSC_VER
  43 #define __inline__ inline
  44 #endif
  45
  46 /*
  47  * Regarding bool, both PostgreSQL and Perl might use stdbool.h or not,
  48  * depending on configuration.  If both agree, things are relatively harmless.
  49  * If not, things get tricky.  If PostgreSQL does but Perl does not, define
  50  * HAS_BOOL here so that Perl does not redefine bool; this avoids compiler
  51  * warnings.  If PostgreSQL does not but Perl does, we need to undefine bool
  52  * after we include the Perl headers; see below.
  53  */
  54 #ifdef USE_STDBOOL
  55 #define HAS_BOOL 1
  56 #endif
  57
  58
  59 /*
  60  * Get the basic Perl API.  We use PERL_NO_GET_CONTEXT mode so that our code
  61  * can compile against MULTIPLICITY Perl builds without including XSUB.h.
  62  */
  63 #define PERL_NO_GET_CONTEXT
  64 #include "EXTERN.h"
  65 #include "perl.h"
  66
  67 /*
  68  * We want to include XSUB.h only within .xs files, because on some platforms
  69  * it undesirably redefines a lot of libc functions.  But it must appear
  70  * before ppport.h, so use a #define flag to control inclusion here.
  71  */
  72 #ifdef PG_NEED_PERL_XSUB_H
  73 #include "XSUB.h"
  74 #endif
  75
  76 /* put back our snprintf and vsnprintf */
  77 #ifdef USE_REPL_SNPRINTF
  78 #ifdef snprintf
  79 #undef snprintf
  80 #endif
  81 #ifdef vsnprintf
  82 #undef vsnprintf
  83 #endif
  84 #ifdef __GNUC__
  85 #define vsnprintf(...)  pg_vsnprintf(__VA_ARGS__)
  86 #define snprintf(...)   pg_snprintf(__VA_ARGS__)
  87 #else
  88 #define vsnprintf               pg_vsnprintf
  89 #define snprintf                pg_snprintf
  90 #endif                                                  /* __GNUC__ */
  91 #endif                                                  /* USE_REPL_SNPRINTF */
  92
  93 /* perl version and platform portability */
  94 #define NEED_eval_pv
  95 #define NEED_newRV_noinc
  96 #define NEED_sv_2pv_flags
  97 #include "ppport.h"
  98
  99 /*
 100  * perl might have included stdbool.h.  If we also did that earlier (see c.h),
 101  * then that's fine.  If not, we probably rejected it for some reason.  In
 102  * that case, undef bool and proceed with our own bool.  (Note that stdbool.h
 103  * makes bool a macro, but our own replacement is a typedef, so the undef
 104  * makes ours visible again).
 105  */
 106 #ifndef USE_STDBOOL
 107 #ifdef bool
 108 #undef bool
 109 #endif
 110 #endif
 111
 112 /* supply HeUTF8 if it's missing - ppport.h doesn't supply it, unfortunately */
 113 #ifndef HeUTF8
 114 #define HeUTF8(he)                         ((HeKLEN(he) == HEf_SVKEY) ?                    \
 115                                                                 SvUTF8(HeKEY_sv(he)) :                             \
 116                                                                 (U32)HeKUTF8(he))
 117 #endif
 118
 119 /* supply GvCV_set if it's missing - ppport.h doesn't supply it, unfortunately */
 120 #ifndef GvCV_set
 121 #define GvCV_set(gv, cv)                (GvCV(gv) = cv)
 122 #endif
 123
 124 /* Perl 5.19.4 changed array indices from I32 to SSize_t */
 125 #if PERL_BCDVERSION >= 0x5019004
 126 #define AV_SIZE_MAX SSize_t_MAX
 127 #else
 128 #define AV_SIZE_MAX I32_MAX
 129 #endif
 130
 131 /* declare routines from plperl.c for access by .xs files */
 132 HV                 *plperl_spi_exec(char *, int);
 133 void            plperl_return_next(SV *);
 134 SV                 *plperl_spi_query(char *);
 135 SV                 *plperl_spi_fetchrow(char *);
 136 SV                 *plperl_spi_prepare(char *, int, SV **);
 137 HV                 *plperl_spi_exec_prepared(char *, HV *, int, SV **);
 138 SV                 *plperl_spi_query_prepared(char *, int, SV **);
 139 void            plperl_spi_freeplan(char *);
 140 void            plperl_spi_cursor_close(char *);
 141 void            plperl_spi_commit(void);
 142 void            plperl_spi_rollback(void);
 143 char       *plperl_sv_to_literal(SV *, char *);
 144 void            plperl_util_elog(int level, SV *msg);
 145
 146 #endif                                                  /* PL_PERL_H */