3 * ====================================================================
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
20 * ====================================================================
23 * @file svn_cmdline_private.h
24 * @brief Private functions for Subversion cmdline.
27 #ifndef SVN_CMDLINE_PRIVATE_H
28 #define SVN_CMDLINE_PRIVATE_H
30 #include <apr_pools.h>
33 #include "svn_string.h"
34 #include "svn_error.h"
39 #endif /* __cplusplus */
41 /** Write a property as an XML element into @a *outstr.
43 * If @a outstr is NULL, allocate @a *outstr in @a pool; else append to
44 * @a *outstr, allocating in @a outstr's pool
46 * @a propname is the property name. @a propval is the property value, which
47 * will be encoded if it contains unsafe bytes.
49 * If @a inherited_prop is TRUE then @a propname is an inherited property,
50 * otherwise @a propname is an explicit property.
53 svn_cmdline__print_xml_prop(svn_stringbuf_t **outstr,
55 svn_string_t *propval,
56 svn_boolean_t inherited_prop,
60 /** An implementation of @c svn_auth_gnome_keyring_unlock_prompt_func_t that
61 * prompts the user for default GNOME Keyring password.
63 * Expects a @c svn_cmdline_prompt_baton2_t to be passed as @a baton.
68 svn_cmdline__auth_gnome_keyring_unlock_prompt(char **keyring_password,
69 const char *keyring_name,
73 /** Container for config options parsed with svn_cmdline__parse_config_option
77 typedef struct svn_cmdline__config_argument_t
83 } svn_cmdline__config_argument_t;
85 /** Parser for 'FILE:SECTION:OPTION=[VALUE]'-style option arguments.
87 * Parses @a opt_arg and places its value in @a config_options, an apr array
88 * containing svn_cmdline__config_argument_t* elements, allocating the option
94 svn_cmdline__parse_config_option(apr_array_header_t *config_options,
98 /** Sets the config options in @a config_options, an apr array containing
99 * @c svn_cmdline__config_argument_t* elements, to the configuration in @a cfg,
100 * a hash mapping of <tt>const char *</tt> configuration file names to
101 * @c svn_config_t *'s. Write warnings to stderr.
103 * Use @a prefix as prefix and @a argument_name in warning messages.
108 svn_cmdline__apply_config_options(apr_hash_t *config,
109 const apr_array_header_t *config_options,
111 const char *argument_name);
113 /* Return a string allocated in POOL that is a copy of STR but with each
114 * line prefixed with INDENT. A line is all characters up to the first
115 * CR-LF, LF-CR, CR or LF, or the end of STR if sooner. */
117 svn_cmdline__indent_string(const char *str,
121 /* Print to stdout a hash PROP_HASH that maps property names (char *) to
122 property values (svn_string_t *). The names are assumed to be in UTF-8
123 format; the values are either in UTF-8 (the special Subversion props) or
126 If OUT is not NULL, then write to it rather than stdout.
128 If NAMES_ONLY is true, print just names, else print names and
131 svn_cmdline__print_prop_hash(svn_stream_t *out,
132 apr_hash_t *prop_hash,
133 svn_boolean_t names_only,
136 /* Similar to svn_cmdline__print_prop_hash(), only output xml to *OUTSTR.
137 If INHERITED_PROPS is true, then PROP_HASH contains inherited properties,
138 otherwise PROP_HASH contains explicit properties. If *OUTSTR is NULL,
139 allocate it first from POOL, otherwise append to it. */
141 svn_cmdline__print_xml_prop_hash(svn_stringbuf_t **outstr,
142 apr_hash_t *prop_hash,
143 svn_boolean_t names_only,
144 svn_boolean_t inherited_props,
148 /* Search for a text editor command in standard environment variables,
149 and invoke it to edit PATH. Use POOL for all allocations.
151 If EDITOR_CMD is not NULL, it is the name of the external editor
152 command to use, overriding anything else that might determine the
155 CONFIG is a hash of svn_config_t * items keyed on a configuration
156 category (SVN_CONFIG_CATEGORY_CONFIG et al), and may be NULL. */
158 svn_cmdline__edit_file_externally(const char *path,
159 const char *editor_cmd,
163 /* Search for a text editor command in standard environment variables,
164 and invoke it to edit CONTENTS (using a temporary file created in
165 directory BASE_DIR). Return the new contents in *EDITED_CONTENTS,
166 or set *EDITED_CONTENTS to NULL if no edit was performed.
168 If EDITOR_CMD is not NULL, it is the name of the external editor
169 command to use, overriding anything else that might determine the
172 If TMPFILE_LEFT is NULL, the temporary file will be destroyed.
173 Else, the file will be left on disk, and its path returned in
176 CONFIG is a hash of svn_config_t * items keyed on a configuration
177 category (SVN_CONFIG_CATEGORY_CONFIG et al), and may be NULL.
179 If AS_TEXT is TRUE, recode CONTENTS and convert to native eol-style before
180 editing and back again afterwards. In this case, ENCODING determines the
181 encoding used during editing. If non-NULL, use the named encoding, else
182 use the system encoding. If AS_TEXT is FALSE, don't do any translation.
183 In that case, ENCODING is ignored.
185 Use POOL for all allocations. Use PREFIX as the prefix for the
186 temporary file used by the editor.
188 If return error, *EDITED_CONTENTS is not touched. */
190 svn_cmdline__edit_string_externally(svn_string_t **edited_contents,
191 const char **tmpfile_left,
192 const char *editor_cmd,
193 const char *base_dir,
194 const svn_string_t *contents,
197 svn_boolean_t as_text,
198 const char *encoding,
202 /** Wrapper for apr_getopt_init(), which see.
207 svn_cmdline__getopt_init(apr_getopt_t **os,
212 /* Determine whether interactive mode should be enabled, based on whether
213 * the user passed the --non-interactive or --force-interactive options.
214 * If neither option was passed, interactivity is enabled if standard
215 * input is connected to a terminal device.
220 svn_cmdline__be_interactive(svn_boolean_t non_interactive,
221 svn_boolean_t force_interactive);
226 #endif /* __cplusplus */
228 #endif /* SVN_CMDLINE_PRIVATE_H */