PostgreSQL Source Code git master
builtins.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * builtins.h
4 * Declarations for operations on built-in types.
5 *
6 *
7 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
9 *
10 * src/include/utils/builtins.h
11 *
12 *-------------------------------------------------------------------------
13 */
14#ifndef BUILTINS_H
15#define BUILTINS_H
16
17#include "fmgr.h"
18#include "nodes/nodes.h"
19#include "utils/fmgrprotos.h"
20
21/* Sign + the most decimal digits an 8-byte number could have */
22#define MAXINT8LEN 20
23
24/* bool.c */
25extern bool parse_bool(const char *value, bool *result);
26extern bool parse_bool_with_len(const char *value, size_t len, bool *result);
27
28/* domains.c */
29extern void domain_check(Datum value, bool isnull, Oid domainType,
30 void **extra, MemoryContext mcxt);
31extern bool domain_check_safe(Datum value, bool isnull, Oid domainType,
32 void **extra, MemoryContext mcxt,
33 Node *escontext);
34extern int errdatatype(Oid datatypeOid);
35extern int errdomainconstraint(Oid datatypeOid, const char *conname);
36
37/* encode.c */
38extern uint64 hex_encode(const char *src, size_t len, char *dst);
39extern uint64 hex_decode(const char *src, size_t len, char *dst);
40extern uint64 hex_decode_safe(const char *src, size_t len, char *dst,
41 Node *escontext);
42
43/* int.c */
44extern int2vector *buildint2vector(const int16 *int2s, int n);
45
46/* name.c */
47extern void namestrcpy(Name name, const char *str);
48extern int namestrcmp(Name name, const char *str);
49
50/* numutils.c */
51extern int16 pg_strtoint16(const char *s);
52extern int16 pg_strtoint16_safe(const char *s, Node *escontext);
53extern int32 pg_strtoint32(const char *s);
54extern int32 pg_strtoint32_safe(const char *s, Node *escontext);
55extern int64 pg_strtoint64(const char *s);
56extern int64 pg_strtoint64_safe(const char *s, Node *escontext);
57extern uint32 uint32in_subr(const char *s, char **endloc,
58 const char *typname, Node *escontext);
59extern uint64 uint64in_subr(const char *s, char **endloc,
60 const char *typname, Node *escontext);
61extern int pg_itoa(int16 i, char *a);
62extern int pg_ultoa_n(uint32 value, char *a);
63extern int pg_ulltoa_n(uint64 value, char *a);
64extern int pg_ltoa(int32 value, char *a);
65extern int pg_lltoa(int64 value, char *a);
66extern char *pg_ultostr_zeropad(char *str, uint32 value, int32 minwidth);
67extern char *pg_ultostr(char *str, uint32 value);
68
69/* oid.c */
70extern oidvector *buildoidvector(const Oid *oids, int n);
71extern Oid oidparse(Node *node);
72extern int oid_cmp(const void *p1, const void *p2);
73
74/* regexp.c */
75extern char *regexp_fixed_prefix(text *text_re, bool case_insensitive,
76 Oid collation, bool *exact);
77
78/* ruleutils.c */
79extern PGDLLIMPORT bool quote_all_identifiers;
80extern const char *quote_identifier(const char *ident);
81extern char *quote_qualified_identifier(const char *qualifier,
82 const char *ident);
83extern void generate_operator_clause(fmStringInfo buf,
84 const char *leftop, Oid leftoptype,
85 Oid opoid,
86 const char *rightop, Oid rightoptype);
87
88/* varchar.c */
89extern int bpchartruelen(char *s, int len);
90
91/* popular functions from varlena.c */
92extern text *cstring_to_text(const char *s);
93extern text *cstring_to_text_with_len(const char *s, int len);
94extern char *text_to_cstring(const text *t);
95extern void text_to_cstring_buffer(const text *src, char *dst, size_t dst_len);
96
97#define CStringGetTextDatum(s) PointerGetDatum(cstring_to_text(s))
98#define TextDatumGetCString(d) text_to_cstring((text *) DatumGetPointer(d))
99
100/* xid.c */
101extern int xidComparator(const void *arg1, const void *arg2);
102extern int xidLogicalComparator(const void *arg1, const void *arg2);
103
104/* inet_cidr_ntop.c */
105extern char *pg_inet_cidr_ntop(int af, const void *src, int bits,
106 char *dst, size_t size);
107
108/* inet_net_pton.c */
109extern int pg_inet_net_pton(int af, const char *src,
110 void *dst, size_t size);
111
112/* network.c */
113extern double convert_network_to_scalar(Datum value, Oid typid, bool *failure);
114extern Datum network_scan_first(Datum in);
115extern Datum network_scan_last(Datum in);
116extern void clean_ipv6_addr(int addr_family, char *addr);
117
118/* numeric.c */
119extern Datum numeric_float8_no_overflow(PG_FUNCTION_ARGS);
120
121/* format_type.c */
122
123/* Control flags for format_type_extended */
124#define FORMAT_TYPE_TYPEMOD_GIVEN 0x01 /* typemod defined by caller */
125#define FORMAT_TYPE_ALLOW_INVALID 0x02 /* allow invalid types */
126#define FORMAT_TYPE_FORCE_QUALIFY 0x04 /* force qualification of type */
127#define FORMAT_TYPE_INVALID_AS_NULL 0x08 /* NULL if undefined */
128extern char *format_type_extended(Oid type_oid, int32 typemod, bits16 flags);
129
130extern char *format_type_be(Oid type_oid);
131extern char *format_type_be_qualified(Oid type_oid);
132extern char *format_type_with_typemod(Oid type_oid, int32 typemod);
133
134extern int32 type_maximum_size(Oid type_oid, int32 typemod);
135
136/* quote.c */
137extern char *quote_literal_cstr(const char *rawstr);
138
139#endif /* BUILTINS_H */
format_type_extended
char * format_type_extended(Oid type_oid, int32 typemod, bits16 flags)
Definition: format_type.c:112
pg_inet_net_pton
int pg_inet_net_pton(int af, const char *src, void *dst, size_t size)
Definition: inet_net_pton.c:61
pg_strtoint64_safe
int64 pg_strtoint64_safe(const char *s, Node *escontext)
Definition: numutils.c:650
uint64in_subr
uint64 uint64in_subr(const char *s, char **endloc, const char *typname, Node *escontext)
Definition: numutils.c:985
clean_ipv6_addr
void clean_ipv6_addr(int addr_family, char *addr)
Definition: network.c:2060
xidComparator
int xidComparator(const void *arg1, const void *arg2)
Definition: xid.c:152
quote_qualified_identifier
char * quote_qualified_identifier(const char *qualifier, const char *ident)
Definition: ruleutils.c:13103
pg_strtoint64
int64 pg_strtoint64(const char *s)
Definition: numutils.c:644
format_type_be_qualified
char * format_type_be_qualified(Oid type_oid)
Definition: format_type.c:353
type_maximum_size
int32 type_maximum_size(Oid type_oid, int32 typemod)
Definition: format_type.c:412
format_type_with_typemod
char * format_type_with_typemod(Oid type_oid, int32 typemod)
Definition: format_type.c:362
bpchartruelen
int bpchartruelen(char *s, int len)
Definition: varchar.c:676
network_scan_last
Datum network_scan_last(Datum in)
Definition: network.c:1669
quote_all_identifiers
PGDLLIMPORT bool quote_all_identifiers
Definition: ruleutils.c:339
errdatatype
int errdatatype(Oid datatypeOid)
Definition: domains.c:407
regexp_fixed_prefix
char * regexp_fixed_prefix(text *text_re, bool case_insensitive, Oid collation, bool *exact)
Definition: regexp.c:1953
pg_ltoa
int pg_ltoa(int32 value, char *a)
Definition: numutils.c:1120
format_type_be
char * format_type_be(Oid type_oid)
Definition: format_type.c:343
parse_bool
bool parse_bool(const char *value, bool *result)
Definition: bool.c:31
cstring_to_text_with_len
text * cstring_to_text_with_len(const char *s, int len)
Definition: varlena.c:204
quote_literal_cstr
char * quote_literal_cstr(const char *rawstr)
Definition: quote.c:103
pg_ultostr_zeropad
char * pg_ultostr_zeropad(char *str, uint32 value, int32 minwidth)
Definition: numutils.c:1267
generate_operator_clause
void generate_operator_clause(fmStringInfo buf, const char *leftop, Oid leftoptype, Oid opoid, const char *rightop, Oid rightoptype)
Definition: ruleutils.c:13429
pg_inet_cidr_ntop
char * pg_inet_cidr_ntop(int af, const void *src, int bits, char *dst, size_t size)
Definition: inet_cidr_ntop.c:56
buildint2vector
int2vector * buildint2vector(const int16 *int2s, int n)
Definition: int.c:114
pg_strtoint32_safe
int32 pg_strtoint32_safe(const char *s, Node *escontext)
Definition: numutils.c:389
namestrcmp
int namestrcmp(Name name, const char *str)
Definition: name.c:247
pg_ulltoa_n
int pg_ulltoa_n(uint64 value, char *a)
Definition: numutils.c:1140
pg_strtoint16
int16 pg_strtoint16(const char *s)
Definition: numutils.c:122
oidparse
Oid oidparse(Node *node)
Definition: oid.c:235
xidLogicalComparator
int xidLogicalComparator(const void *arg1, const void *arg2)
Definition: xid.c:169
buildoidvector
oidvector * buildoidvector(const Oid *oids, int n)
Definition: oid.c:87
oid_cmp
int oid_cmp(const void *p1, const void *p2)
Definition: oid.c:258
errdomainconstraint
int errdomainconstraint(Oid datatypeOid, const char *conname)
Definition: domains.c:431
quote_identifier
const char * quote_identifier(const char *ident)
Definition: ruleutils.c:13019
hex_decode_safe
uint64 hex_decode_safe(const char *src, size_t len, char *dst, Node *escontext)
Definition: encode.c:217
namestrcpy
void namestrcpy(Name name, const char *str)
Definition: name.c:233
cstring_to_text
text * cstring_to_text(const char *s)
Definition: varlena.c:192
uint32in_subr
uint32 uint32in_subr(const char *s, char **endloc, const char *typname, Node *escontext)
Definition: numutils.c:898
convert_network_to_scalar
double convert_network_to_scalar(Datum value, Oid typid, bool *failure)
Definition: network.c:1467
hex_encode
uint64 hex_encode(const char *src, size_t len, char *dst)
Definition: encode.c:181
text_to_cstring_buffer
void text_to_cstring_buffer(const text *src, char *dst, size_t dst_len)
Definition: varlena.c:256
pg_lltoa
int pg_lltoa(int64 value, char *a)
Definition: numutils.c:1227
numeric_float8_no_overflow
Datum numeric_float8_no_overflow(PG_FUNCTION_ARGS)
Definition: numeric.c:4779
pg_ultostr
char * pg_ultostr(char *str, uint32 value)
Definition: numutils.c:1307
pg_itoa
int pg_itoa(int16 i, char *a)
Definition: numutils.c:1042
pg_strtoint32
int32 pg_strtoint32(const char *s)
Definition: numutils.c:383
domain_check
void domain_check(Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt)
Definition: domains.c:346
pg_strtoint16_safe
int16 pg_strtoint16_safe(const char *s, Node *escontext)
Definition: numutils.c:128
domain_check_safe
bool domain_check_safe(Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt, Node *escontext)
Definition: domains.c:355
text_to_cstring
char * text_to_cstring(const text *t)
Definition: varlena.c:225
hex_decode
uint64 hex_decode(const char *src, size_t len, char *dst)
Definition: encode.c:211
network_scan_first
Datum network_scan_first(Datum in)
Definition: network.c:1655
parse_bool_with_len
bool parse_bool_with_len(const char *value, size_t len, bool *result)
Definition: bool.c:37
pg_ultoa_n
int pg_ultoa_n(uint32 value, char *a)
Definition: numutils.c:1055
bits16
uint16 bits16
Definition: c.h:510
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1291
int64
int64_t int64
Definition: c.h:499
int16
int16_t int16
Definition: c.h:497
int32
int32_t int32
Definition: c.h:498
uint64
uint64_t uint64
Definition: c.h:503
uint32
uint32_t uint32
Definition: c.h:502
PG_FUNCTION_ARGS
#define PG_FUNCTION_ARGS
Definition: fmgr.h:193
str
const char * str
Definition: hashfn_unstable.h:254
ident
#define ident
Definition: indent_codes.h:47
value
static struct @165 value
a
int a
Definition: isn.c:73
i
int i
Definition: isn.c:77
len
const void size_t len
Definition: pg_crc32c_sse42.c:28
buf
static char * buf
Definition: pg_test_fsync.c:72
typname
NameData typname
Definition: pg_type.h:41
Datum
uintptr_t Datum
Definition: postgres.h:69
Oid
unsigned int Oid
Definition: postgres_ext.h:30
Node
Definition: nodes.h:135
int2vector
Definition: c.h:686
nameData
Definition: c.h:712
oidvector
Definition: c.h:697
varlena
Definition: c.h:658
name
const char * name
Definition: wait_event_funcs.c:28