glib-2.0/glib/gshell.h

0001 /* gshell.h - Shell-related utilities
0002  *
0003  *  Copyright 2000 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General Public License
0018  * along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  */
0020
0021 #ifndef __G_SHELL_H__
0022 #define __G_SHELL_H__
0023
0024 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
0025 #error "Only <glib.h> can be included directly."
0026 #endif
0027
0028 #include <glib/gerror.h>
0029
0030 G_BEGIN_DECLS
0031
0032 #define G_SHELL_ERROR g_shell_error_quark ()
0033
0034 typedef enum
0035 {
0036   /* mismatched or otherwise mangled quoting */
0037   G_SHELL_ERROR_BAD_QUOTING,
0038   /* string to be parsed was empty */
0039   G_SHELL_ERROR_EMPTY_STRING,
0040   G_SHELL_ERROR_FAILED
0041 } GShellError;
0042
0043 GLIB_AVAILABLE_IN_ALL
0044 GQuark g_shell_error_quark (void);
0045
0046 GLIB_AVAILABLE_IN_ALL
0047 gchar*   g_shell_quote      (const gchar   *unquoted_string);
0048 GLIB_AVAILABLE_IN_ALL
0049 gchar*   g_shell_unquote    (const gchar   *quoted_string,
0050                              GError       **error);
0051 GLIB_AVAILABLE_IN_ALL
0052 gboolean g_shell_parse_argv (const gchar   *command_line,
0053                              gint          *argcp,
0054                              gchar       ***argvp,
0055                              GError       **error);
0056
0057 G_END_DECLS
0058
0059 #endif /* __G_SHELL_H__ */