1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GLIBMM_SHELL_H
#define _GLIBMM_SHELL_H
/* $Id$ */
/* Copyright (C) 2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glib/gshell.h>
#include <string>
#include <glibmm/arrayhandle.h>
#include <glibmm/error.h>
#include <glibmmconfig.h>
GLIBMM_USING_STD(string)
namespace Glib
{
/** @defgroup ShellUtils Shell-related Utilities
* Shell-like command line handling.
* @{
*/
/** Exception class for shell utility errors.
*/
class ShellError : public Glib::Error
{
public:
enum Code
{
BAD_QUOTING,
EMPTY_STRING,
FAILED
};
ShellError(Code error_code, const Glib::ustring& error_message);
explicit ShellError(GError* gobject);
Code code() const;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
static void throw_func(GError* gobject);
friend void wrap_init(); // uses throw_func()
#endif
};
/** Parses a command line into an argument vector, in much the same way the
* shell would, but without many of the expansions the shell would perform
* (variable expansion, globs, operators, filename expansion, etc.\ are not
* supported). The results are defined to be the same as those you would
* get from a UNIX98 /bin/sh, as long as the input contains none of the
* unsupported shell expansions. If the input does contain such expansions,
* they are passed through literally.
* @param command_line Command line to parse.
* @return Array of args (The generic ArrayHandle will be implicitly
* converted to any STL compatible container type).
* @throw Glib::ShellError
*/
Glib::ArrayHandle<std::string> shell_parse_argv(const std::string& command_line);
/** Quotes a string so that the shell (/bin/sh) will interpret the quoted
* string to mean @a unquoted_string. If you pass a filename to the shell,
* for example, you should first quote it with this function. The quoting
* style used is undefined (single or double quotes may be used).
* @param unquoted_string A literal string.
* @return A quoted string.
*/
std::string shell_quote(const std::string& unquoted_string);
/** Unquotes a string as the shell (/bin/sh) would. Only handles quotes; if
* a string contains file globs, arithmetic operators, variables, backticks,
* redirections, or other special-to-the-shell features, the result will be
* different from the result a real shell would produce (the variables,
* backticks, etc. will be passed through literally instead of being expanded).
* This function is guaranteed to succeed if applied to the result of
* shell_quote(). If it fails, it throws a Glib::ShellError exception. The
* @a quoted_string need not actually contain quoted or escaped text;
* shell_unquote() simply goes through the string and unquotes/unescapes
* anything that the shell would. Both single and double quotes are handled,
* as are escapes including escaped newlines.
*
* Shell quoting rules are a bit strange. Single quotes preserve the literal
* string exactly. Escape sequences are not allowed; not even <tt>\\'</tt> --
* if you want a <tt>'</tt> in the quoted text, you have to do something like
* <tt>'foo'\\''bar'</tt>. Double quotes allow <tt>$</tt>, <tt>`</tt>,
* <tt>"</tt>, <tt>\\</tt>, and newline to be escaped with backslash.
* Otherwise double quotes preserve things literally.
*
* @param quoted_string Shell-quoted string.
* @return An unquoted string.
* @throw Glib::ShellError
*/
std::string shell_unquote(const std::string& quoted_string);
/** @} group ShellUtils */
} // namespace Glib
#endif /* _GLIBMM_SHELL_H */
|
