php-src/ext/pdo_pgsql/php_pdo_pgsql_int.h
Christoph M. Becker 50b3a0d011
Add comments about internal headers (GH-15689)
A common convention is to name internal C header files as `*_int.h`.
Since a couple of these are actually installed, we add comments that
this is not supposed to happen, (a) to avoid installing further
internal headers, and (b) to pave the way to fix this in the next major
PHP version.

Somewhat special is php_gmp_int.h, where "int" is meant as abbreviation
for "interface".

Another common convention is appending `_priv` or `_private`, but since
there have not been any issues regarding these headers so far, we
refrain from adding respective comments to these headers.

Anyhow, it might be a good idea to introduce some common naming
convention for such internal/private headers.
2024-09-08 16:11:25 +02:00

131 lines
4.5 KiB
C

/*
+----------------------------------------------------------------------+
| Copyright (c) The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| https://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Authors: Edin Kadribasic <edink@emini.dk> |
| Ilia Alshanestsky <ilia@prohost.org> |
| Wez Furlong <wez@php.net> |
+----------------------------------------------------------------------+
*/
/* internal header; not supposed to be installed */
#ifndef PHP_PDO_PGSQL_INT_H
#define PHP_PDO_PGSQL_INT_H
#include <libpq-fe.h>
#include <libpq/libpq-fs.h>
#include <php.h>
#define PHP_PDO_PGSQL_CONNECTION_FAILURE_SQLSTATE "08006"
typedef struct {
const char *file;
int line;
unsigned int errcode;
char *errmsg;
} pdo_pgsql_error_info;
/* stuff we use in a pgsql database handle */
typedef struct {
PGconn *server;
unsigned attached:1;
unsigned _reserved:31;
pdo_pgsql_error_info einfo;
Oid pgoid;
unsigned int stmt_counter;
/* The following two variables have the same purpose. Unfortunately we need
to keep track of two different attributes having the same effect. */
bool emulate_prepares;
bool disable_native_prepares; /* deprecated since 5.6 */
bool disable_prepares;
HashTable *lob_streams;
zend_fcall_info_cache *notice_callback;
} pdo_pgsql_db_handle;
typedef struct {
Oid pgsql_type;
} pdo_pgsql_column;
typedef struct {
pdo_pgsql_db_handle *H;
PGresult *result;
pdo_pgsql_column *cols;
char *cursor_name;
char *stmt_name;
zend_string *query;
char **param_values;
int *param_lengths;
int *param_formats;
Oid *param_types;
int current_row;
bool is_prepared;
} pdo_pgsql_stmt;
typedef struct {
Oid oid;
} pdo_pgsql_bound_param;
extern const pdo_driver_t pdo_pgsql_driver;
extern int pdo_pgsql_scanner(pdo_scanner_t *s);
extern int _pdo_pgsql_error(pdo_dbh_t *dbh, pdo_stmt_t *stmt, int errcode, const char *sqlstate, const char *msg, const char *file, int line);
#define pdo_pgsql_error(d,e,z) _pdo_pgsql_error(d, NULL, e, z, NULL, __FILE__, __LINE__)
#define pdo_pgsql_error_msg(d,e,m) _pdo_pgsql_error(d, NULL, e, NULL, m, __FILE__, __LINE__)
#define pdo_pgsql_error_stmt(s,e,z) _pdo_pgsql_error(s->dbh, s, e, z, NULL, __FILE__, __LINE__)
#define pdo_pgsql_error_stmt_msg(stmt, e, sqlstate, msg) \
_pdo_pgsql_error(stmt->dbh, stmt, e, sqlstate, msg, __FILE__, __LINE__)
extern const struct pdo_stmt_methods pgsql_stmt_methods;
#define pdo_pgsql_sqlstate(r) PQresultErrorField(r, PG_DIAG_SQLSTATE)
enum {
PDO_PGSQL_ATTR_DISABLE_PREPARES = PDO_ATTR_DRIVER_SPECIFIC,
PDO_PGSQL_ATTR_RESULT_MEMORY_SIZE,
};
struct pdo_pgsql_lob_self {
zval dbh;
PGconn *conn;
int lfd;
Oid oid;
};
enum pdo_pgsql_specific_constants {
PGSQL_TRANSACTION_IDLE = PQTRANS_IDLE,
PGSQL_TRANSACTION_ACTIVE = PQTRANS_ACTIVE,
PGSQL_TRANSACTION_INTRANS = PQTRANS_INTRANS,
PGSQL_TRANSACTION_INERROR = PQTRANS_INERROR,
PGSQL_TRANSACTION_UNKNOWN = PQTRANS_UNKNOWN
};
php_stream *pdo_pgsql_create_lob_stream(zval *pdh, int lfd, Oid oid);
extern const php_stream_ops pdo_pgsql_lob_stream_ops;
void pdo_pgsql_cleanup_notice_callback(pdo_pgsql_db_handle *H);
void pdo_libpq_version(char *buf, size_t len);
void pdo_pgsql_close_lob_streams(pdo_dbh_t *dbh);
void pgsqlCopyFromArray_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlCopyFromFile_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlCopyToArray_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlCopyToFile_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlLOBCreate_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlLOBOpen_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlLOBUnlink_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlGetNotify_internal(INTERNAL_FUNCTION_PARAMETERS);
void pgsqlGetPid_internal(INTERNAL_FUNCTION_PARAMETERS);
#endif /* PHP_PDO_PGSQL_INT_H */