PostgreSQL Source Code  git master
string_utils.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * String-processing utility routines for frontend code
4  *
5  * Utility functions that interpret backend output or quote strings for
6  * assorted contexts.
7  *
8  *
9  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
10  * Portions Copyright (c) 1994, Regents of the University of California
11  *
12  * src/include/fe_utils/string_utils.h
13  *
14  *-------------------------------------------------------------------------
15  */
16 #ifndef STRING_UTILS_H
17 #define STRING_UTILS_H
18 
19 #include "libpq-fe.h"
20 #include "pqexpbuffer.h"
21 
22 /* Global variables controlling behavior of fmtId() and fmtQualifiedId() */
23 extern PGDLLIMPORT int quote_all_identifiers;
24 extern PQExpBuffer (*getLocalPQExpBuffer) (void);
25 
26 /* Functions */
27 extern const char *fmtId(const char *rawid);
28 extern const char *fmtQualifiedId(const char *schema, const char *id);
29 
30 extern char *formatPGVersionNumber(int version_number, bool include_minor,
31  char *buf, size_t buflen);
32 
33 extern void appendStringLiteral(PQExpBuffer buf, const char *str,
34  int encoding, bool std_strings);
35 extern void appendStringLiteralConn(PQExpBuffer buf, const char *str,
36  PGconn *conn);
37 extern void appendStringLiteralDQ(PQExpBuffer buf, const char *str,
38  const char *dqprefix);
39 extern void appendByteaLiteral(PQExpBuffer buf,
40  const unsigned char *str, size_t length,
41  bool std_strings);
42 
43 extern void appendShellString(PQExpBuffer buf, const char *str);
44 extern bool appendShellStringNoError(PQExpBuffer buf, const char *str);
45 extern void appendConnStrVal(PQExpBuffer buf, const char *str);
46 extern void appendPsqlMetaConnect(PQExpBuffer buf, const char *dbname);
47 
48 extern bool parsePGArray(const char *atext, char ***itemarray, int *nitems);
49 extern void appendPGArray(PQExpBuffer buffer, const char *value);
50 
51 extern bool appendReloptionsArray(PQExpBuffer buffer, const char *reloptions,
52  const char *prefix, int encoding, bool std_strings);
53 
54 extern bool processSQLNamePattern(PGconn *conn, PQExpBuffer buf,
55  const char *pattern,
56  bool have_where, bool force_escape,
57  const char *schemavar, const char *namevar,
58  const char *altnamevar, const char *visibilityrule,
59  PQExpBuffer dbnamebuf, int *dotcnt);
60 
61 extern void patternToSQLRegex(int encoding, PQExpBuffer dbnamebuf,
62  PQExpBuffer schemabuf, PQExpBuffer namebuf,
63  const char *pattern, bool force_escape,
64  bool want_literal_dbname, int *dotcnt);
65 
66 #endif /* STRING_UTILS_H */
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1319
str
const char * str
Definition: hashfn_unstable.h:263
nitems
#define nitems(x)
Definition: indent.h:31
value
static struct @157 value
encoding
int32 encoding
Definition: pg_database.h:41
buf
static char * buf
Definition: pg_test_fsync.c:73
PQExpBuffer
PQExpBufferData * PQExpBuffer
Definition: pqexpbuffer.h:51
dbname
char * dbname
Definition: streamutil.c:52
conn
PGconn * conn
Definition: streamutil.c:55
appendShellStringNoError
bool appendShellStringNoError(PQExpBuffer buf, const char *str)
Definition: string_utils.c:441
appendShellString
void appendShellString(PQExpBuffer buf, const char *str)
Definition: string_utils.c:429
appendStringLiteralConn
void appendStringLiteralConn(PQExpBuffer buf, const char *str, PGconn *conn)
Definition: string_utils.c:293
appendPGArray
void appendPGArray(PQExpBuffer buffer, const char *value)
Definition: string_utils.c:740
processSQLNamePattern
bool processSQLNamePattern(PGconn *conn, PQExpBuffer buf, const char *pattern, bool have_where, bool force_escape, const char *schemavar, const char *namevar, const char *altnamevar, const char *visibilityrule, PQExpBuffer dbnamebuf, int *dotcnt)
Definition: string_utils.c:891
appendPsqlMetaConnect
void appendPsqlMetaConnect(PQExpBuffer buf, const char *dbname)
Definition: string_utils.c:590
appendByteaLiteral
void appendByteaLiteral(PQExpBuffer buf, const unsigned char *str, size_t length, bool std_strings)
Definition: string_utils.c:374
fmtId
const char * fmtId(const char *rawid)
Definition: string_utils.c:64
parsePGArray
bool parsePGArray(const char *atext, char ***itemarray, int *nitems)
Definition: string_utils.c:657
appendStringLiteral
void appendStringLiteral(PQExpBuffer buf, const char *str, int encoding, bool std_strings)
Definition: string_utils.c:215
patternToSQLRegex
void patternToSQLRegex(int encoding, PQExpBuffer dbnamebuf, PQExpBuffer schemabuf, PQExpBuffer namebuf, const char *pattern, bool force_escape, bool want_literal_dbname, int *dotcnt)
Definition: string_utils.c:1063
appendReloptionsArray
bool appendReloptionsArray(PQExpBuffer buffer, const char *reloptions, const char *prefix, int encoding, bool std_strings)
Definition: string_utils.c:804
fmtQualifiedId
const char * fmtQualifiedId(const char *schema, const char *id)
Definition: string_utils.c:145
quote_all_identifiers
PGDLLIMPORT int quote_all_identifiers
Definition: ruleutils.c:337
getLocalPQExpBuffer
PQExpBuffer(* getLocalPQExpBuffer)(void)
Definition: string_utils.c:27
appendStringLiteralDQ
void appendStringLiteralDQ(PQExpBuffer buf, const char *str, const char *dqprefix)
Definition: string_utils.c:331
appendConnStrVal
void appendConnStrVal(PQExpBuffer buf, const char *str)
Definition: string_utils.c:545
formatPGVersionNumber
char * formatPGVersionNumber(int version_number, bool include_minor, char *buf, size_t buflen)
Definition: string_utils.c:177
pg_conn
Definition: libpq-int.h:377