• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #ifndef CURLINC_OPTIONS_H
2 #define CURLINC_OPTIONS_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 
27 #ifdef  __cplusplus
28 extern "C" {
29 #endif
30 
31 typedef enum {
32   CURLOT_LONG,    /* long (a range of values) */
33   CURLOT_VALUES,  /*      (a defined set or bitmask) */
34   CURLOT_OFF_T,   /* curl_off_t (a range of values) */
35   CURLOT_OBJECT,  /* pointer (void *) */
36   CURLOT_STRING,  /*         (char * to null-terminated buffer) */
37   CURLOT_SLIST,   /*         (struct curl_slist *) */
38   CURLOT_CBPTR,   /*         (void * passed as-is to a callback) */
39   CURLOT_BLOB,    /* blob (struct curl_blob *) */
40   CURLOT_FUNCTION /* function pointer */
41 } curl_easytype;
42 
43 /* Flag bits */
44 
45 /* "alias" means it is provided for old programs to remain functional,
46    we prefer another name */
47 #define CURLOT_FLAG_ALIAS (1<<0)
48 
49 /* The CURLOPTTYPE_* id ranges can still be used to figure out what type/size
50    to use for curl_easy_setopt() for the given id */
51 struct curl_easyoption {
52   const char *name;
53   CURLoption id;
54   curl_easytype type;
55   unsigned int flags;
56 };
57 
58 CURL_EXTERN const struct curl_easyoption *
59 curl_easy_option_by_name(const char *name);
60 
61 CURL_EXTERN const struct curl_easyoption *
62 curl_easy_option_by_id(CURLoption id);
63 
64 CURL_EXTERN const struct curl_easyoption *
65 curl_easy_option_next(const struct curl_easyoption *prev);
66 
67 #ifdef __cplusplus
68 } /* end of extern "C" */
69 #endif
70 #endif /* CURLINC_OPTIONS_H */
71