mirror of
https://github.com/postgres/postgres.git
synced 2025-08-19 23:22:23 +03:00
74938d1320
Add various widely useful "IWYU pragma" annotations, such as - Common header files such as c.h, postgres.h should be "always_keep". - System headers included in c.h, postgres.h etc. should be considered "export". - Some portability headers such as getopt_long.h should be "always_keep", so they are not considered superfluous on some platforms. - Certain system headers included from portability headers should be considered "export" because the purpose of the portability header is to wrap them. - Superfluous includes marked as "for backward compatibility" get a formal IWYU annotation. - Generated header included in utils/syscache.h is marked exported. This is a very commonly used include and this avoids lots of complaints. Discussion: https://www.postgresql.org/message-id/flat/9395d484-eff4-47c2-b276-8e228526c8ae@eisentraut.org
75 lines
2.2 KiB
C
75 lines
2.2 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* postgres_ext.h
|
|
*
|
|
* This file contains declarations of things that are visible everywhere
|
|
* in PostgreSQL *and* are visible to clients of frontend interface libraries.
|
|
* For example, the Oid type is part of the API of libpq and other libraries.
|
|
*
|
|
* Declarations which are specific to a particular interface should
|
|
* go in the header file for that interface (such as libpq-fe.h). This
|
|
* file is only for fundamental Postgres declarations.
|
|
*
|
|
* User-written C functions don't count as "external to Postgres."
|
|
* Those function much as local modifications to the backend itself, and
|
|
* use header files that are otherwise internal to Postgres to interface
|
|
* with the backend.
|
|
*
|
|
* src/include/postgres_ext.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
/* IWYU pragma: always_keep */
|
|
|
|
#ifndef POSTGRES_EXT_H
|
|
#define POSTGRES_EXT_H
|
|
|
|
#include <stdint.h>
|
|
|
|
/*
|
|
* Object ID is a fundamental type in Postgres.
|
|
*/
|
|
typedef unsigned int Oid;
|
|
|
|
#ifdef __cplusplus
|
|
#define InvalidOid (Oid(0))
|
|
#else
|
|
#define InvalidOid ((Oid) 0)
|
|
#endif
|
|
|
|
#define OID_MAX UINT_MAX
|
|
/* you will need to include <limits.h> to use the above #define */
|
|
|
|
#define atooid(x) ((Oid) strtoul((x), NULL, 10))
|
|
/* the above needs <stdlib.h> */
|
|
|
|
|
|
/* Define a signed 64-bit integer type for use in client API declarations. */
|
|
typedef int64_t pg_int64;
|
|
|
|
/*
|
|
* Identifiers of error message fields. Kept here to keep common
|
|
* between frontend and backend, and also to export them to libpq
|
|
* applications.
|
|
*/
|
|
#define PG_DIAG_SEVERITY 'S'
|
|
#define PG_DIAG_SEVERITY_NONLOCALIZED 'V'
|
|
#define PG_DIAG_SQLSTATE 'C'
|
|
#define PG_DIAG_MESSAGE_PRIMARY 'M'
|
|
#define PG_DIAG_MESSAGE_DETAIL 'D'
|
|
#define PG_DIAG_MESSAGE_HINT 'H'
|
|
#define PG_DIAG_STATEMENT_POSITION 'P'
|
|
#define PG_DIAG_INTERNAL_POSITION 'p'
|
|
#define PG_DIAG_INTERNAL_QUERY 'q'
|
|
#define PG_DIAG_CONTEXT 'W'
|
|
#define PG_DIAG_SCHEMA_NAME 's'
|
|
#define PG_DIAG_TABLE_NAME 't'
|
|
#define PG_DIAG_COLUMN_NAME 'c'
|
|
#define PG_DIAG_DATATYPE_NAME 'd'
|
|
#define PG_DIAG_CONSTRAINT_NAME 'n'
|
|
#define PG_DIAG_SOURCE_FILE 'F'
|
|
#define PG_DIAG_SOURCE_LINE 'L'
|
|
#define PG_DIAG_SOURCE_FUNCTION 'R'
|
|
|
|
#endif /* POSTGRES_EXT_H */
|