xref: /curl/src/tool_getparam.h (revision 07bcae89)
1 #ifndef HEADER_CURL_TOOL_GETPARAM_H
2 #define HEADER_CURL_TOOL_GETPARAM_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 #include "tool_setup.h"
27 
28 typedef enum {
29   PARAM_OK = 0,
30   PARAM_OPTION_AMBIGUOUS,
31   PARAM_OPTION_UNKNOWN,
32   PARAM_REQUIRES_PARAMETER,
33   PARAM_BAD_USE,
34   PARAM_HELP_REQUESTED,
35   PARAM_MANUAL_REQUESTED,
36   PARAM_VERSION_INFO_REQUESTED,
37   PARAM_ENGINES_REQUESTED,
38   PARAM_GOT_EXTRA_PARAMETER,
39   PARAM_BAD_NUMERIC,
40   PARAM_NEGATIVE_NUMERIC,
41   PARAM_LIBCURL_DOESNT_SUPPORT,
42   PARAM_LIBCURL_UNSUPPORTED_PROTOCOL,
43   PARAM_NO_MEM,
44   PARAM_NEXT_OPERATION,
45   PARAM_NO_PREFIX,
46   PARAM_NUMBER_TOO_LARGE,
47   PARAM_NO_NOT_BOOLEAN,
48   PARAM_CONTDISP_SHOW_HEADER, /* --include and --remote-header-name */
49   PARAM_CONTDISP_RESUME_FROM, /* --continue-at and --remote-header-name */
50   PARAM_READ_ERROR,
51   PARAM_EXPAND_ERROR, /* --expand problem */
52   PARAM_BLANK_STRING,
53   PARAM_LAST
54 } ParameterError;
55 
56 struct GlobalConfig;
57 struct OperationConfig;
58 
59 ParameterError getparameter(const char *flag, char *nextarg,
60                             argv_item_t cleararg,
61                             bool *usedarg,
62                             struct GlobalConfig *global,
63                             struct OperationConfig *operation);
64 
65 #ifdef UNITTESTS
66 void parse_cert_parameter(const char *cert_parameter,
67                           char **certname,
68                           char **passphrase);
69 #endif
70 
71 ParameterError parse_args(struct GlobalConfig *config, int argc,
72                           argv_item_t argv[]);
73 
74 #endif /* HEADER_CURL_TOOL_GETPARAM_H */
75