Utilities/cmcurl/include/curl/options.h

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