src/basic/escape.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <sys/types.h>
  25 #include <inttypes.h>
  26
  27 /* What characters are special in the shell? */
  28 /* must be escaped outside and inside double-quotes */
  29 #define SHELL_NEED_ESCAPE "\"\\`$"
  30 /* can be escaped or double-quoted */
  31 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
  32
  33 typedef enum UnescapeFlags {
  34         UNESCAPE_RELAX = 1,
  35 } UnescapeFlags;
  36
  37 char *cescape(const char *s);
  38 char *cescape_length(const char *s, size_t n);
  39 size_t cescape_char(char c, char *buf);
  40
  41 int cunescape(const char *s, UnescapeFlags flags, char **ret);
  42 int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
  43 int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
  44 int cunescape_one(const char *p, size_t length, char *ret, uint32_t *ret_unicode);
  45
  46 char *xescape(const char *s, const char *bad);
  47
  48 char *shell_escape(const char *s, const char *bad);
  49 char *shell_maybe_quote(const char *s);