src/include/fe_utils/string_utils.h

   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 */