mkhelp: generate code for --disable-manual as well
[platform/upstream/curl.git] / src / tool_cfgable.h
1 #ifndef HEADER_CURL_TOOL_CFGABLE_H
2 #define HEADER_CURL_TOOL_CFGABLE_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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 #include "tool_setup.h"
25
26 #include "tool_sdecls.h"
27
28 #include "tool_metalink.h"
29
30 struct GlobalConfig;
31
32 struct OperationConfig {
33   CURL *easy;               /* A copy of the handle from GlobalConfig */
34   bool remote_time;
35   char *random_file;
36   char *egd_file;
37   char *useragent;
38   char *cookie;             /* single line with specified cookies */
39   char *cookiejar;          /* write to this file */
40   char *cookiefile;         /* read from this file */
41   bool cookiesession;       /* new session? */
42   bool encoding;            /* Accept-Encoding please */
43   bool tr_encoding;         /* Transfer-Encoding please */
44   unsigned long authtype;   /* auth bitmask */
45   bool use_resume;
46   bool resume_from_current;
47   bool disable_epsv;
48   bool disable_eprt;
49   bool ftp_pret;
50   long proto;
51   bool proto_present;
52   long proto_redir;
53   bool proto_redir_present;
54   curl_off_t resume_from;
55   char *postfields;
56   curl_off_t postfieldsize;
57   char *referer;
58   double timeout;
59   double connecttimeout;
60   long maxredirs;
61   curl_off_t max_filesize;
62   char *headerfile;
63   char *ftpport;
64   char *iface;
65   int localport;
66   int localportrange;
67   unsigned short porttouse;
68   char *range;
69   long low_speed_limit;
70   long low_speed_time;
71   char *dns_servers;   /* dot notation: 1.1.1.1;2.2.2.2 */
72   char *dns_interface; /* interface name */
73   char *dns_ipv4_addr; /* dot notation */
74   char *dns_ipv6_addr; /* dot notation */
75   char *userpwd;
76   char *login_options;
77   char *tls_username;
78   char *tls_password;
79   char *tls_authtype;
80   char *proxyuserpwd;
81   char *proxy;
82   int proxyver;             /* set to CURLPROXY_HTTP* define */
83   char *noproxy;
84   char *mail_from;
85   struct curl_slist *mail_rcpt;
86   char *mail_auth;
87   bool sasl_ir;             /* Enable/disable SASL initial response */
88   bool proxytunnel;
89   bool ftp_append;          /* APPE on ftp */
90   bool use_ascii;           /* select ascii or text transfer */
91   bool autoreferer;         /* automatically set referer */
92   bool failonerror;         /* fail on (HTTP) errors */
93   bool include_headers;     /* send headers to data output */
94   bool no_body;             /* don't get the body */
95   bool dirlistonly;         /* only get the FTP dir list */
96   bool followlocation;      /* follow http redirects */
97   bool unrestricted_auth;   /* Continue to send authentication (user+password)
98                                when following ocations, even when hostname
99                                changed */
100   bool netrc_opt;
101   bool netrc;
102   char *netrc_file;
103   struct getout *url_list;  /* point to the first node */
104   struct getout *url_last;  /* point to the last/current node */
105   struct getout *url_get;   /* point to the node to fill in URL */
106   struct getout *url_out;   /* point to the node to fill in outfile */
107   char *cipher_list;
108   char *cert;
109   char *cert_type;
110   char *cacert;
111   char *capath;
112   char *crlfile;
113   char *key;
114   char *key_type;
115   char *key_passwd;
116   char *pubkey;
117   char *hostpubmd5;
118   char *engine;
119   bool crlf;
120   char *customrequest;
121   char *krblevel;
122   long httpversion;
123   bool nobuffer;
124   bool readbusy;            /* set when reading input returns EAGAIN */
125   bool globoff;
126   bool use_httpget;
127   bool insecure_ok;         /* set TRUE to allow insecure SSL connects */
128   bool create_dirs;
129   bool ftp_create_dirs;
130   bool ftp_skip_ip;
131   bool proxynegotiate;
132   bool proxyntlm;
133   bool proxydigest;
134   bool proxybasic;
135   bool proxyanyauth;
136   char *writeout;           /* %-styled format string to output */
137   bool writeenv;            /* write results to environment, if available */
138   struct curl_slist *quote;
139   struct curl_slist *postquote;
140   struct curl_slist *prequote;
141   long ssl_version;
142   long ip_version;
143   curl_TimeCond timecond;
144   time_t condtime;
145   struct curl_slist *headers;
146   struct curl_httppost *httppost;
147   struct curl_httppost *last_post;
148   struct curl_slist *telnet_options;
149   struct curl_slist *resolve;
150   HttpReq httpreq;
151
152   /* for bandwidth limiting features: */
153   curl_off_t sendpersecond; /* send to peer */
154   curl_off_t recvpersecond; /* receive from peer */
155
156   bool ftp_ssl;
157   bool ftp_ssl_reqd;
158   bool ftp_ssl_control;
159   bool ftp_ssl_ccc;
160   int ftp_ssl_ccc_mode;
161
162   char *socksproxy;         /* set to server string */
163   int socksver;             /* set to CURLPROXY_SOCKS* define */
164   char *socks5_gssapi_service;  /* set service name for gssapi principal
165                                  * default rcmd */
166   int socks5_gssapi_nec ;   /* The NEC reference server does not protect
167                              * the encryption type exchange */
168
169   bool tcp_nodelay;
170   long req_retry;           /* number of retries */
171   long retry_delay;         /* delay between retries (in seconds) */
172   long retry_maxtime;       /* maximum time to keep retrying */
173
174   char *ftp_account;        /* for ACCT */
175   char *ftp_alternative_to_user;  /* send command if USER/PASS fails */
176   int ftp_filemethod;
177   long tftp_blksize;        /* TFTP BLKSIZE option */
178   bool ignorecl;            /* --ignore-content-length */
179   bool disable_sessionid;
180
181   bool raw;
182   bool post301;
183   bool post302;
184   bool post303;
185   bool nokeepalive;         /* for keepalive needs */
186   long alivetime;
187   bool content_disposition; /* use Content-disposition filename */
188
189   int default_node_flags;   /* default flags to search for each 'node', which
190                                is basically each given URL to transfer */
191
192   bool xattr;               /* store metadata in extended attributes */
193   long gssapi_delegation;
194   bool ssl_allow_beast;     /* allow this SSL vulnerability */
195
196   bool use_metalink;        /* process given URLs as metalink XML file */
197   metalinkfile *metalinkfile_list; /* point to the first node */
198   metalinkfile *metalinkfile_last; /* point to the last/current node */
199 #ifdef CURLDEBUG
200   bool test_event_based;
201 #endif
202   char *xoauth2_bearer;       /* XOAUTH2 bearer token */
203   bool nonpn;                 /* enable/disable TLS NPN extension */
204   bool noalpn;                /* enable/disable TLS ALPN extension */
205
206   struct GlobalConfig *global;
207   struct OperationConfig *prev;
208   struct OperationConfig *next; /* Always last in the struct */
209 };
210
211 struct GlobalConfig {
212   CURL *easy;                     /* Once we have one, we keep it here */
213   int showerror;                  /* -1 == unset, default => show errors
214                                       0 => -s is used to NOT show errors
215                                       1 => -S has been used to show errors */
216   bool mute;                      /* don't show messages, --silent given */
217   bool noprogress;                /* don't show progress bar --silent given */
218   bool isatty;                    /* Updated internally if output is a tty */
219   FILE *errors;                   /* Error stream, defaults to stderr */
220   bool errors_fopened;            /* Whether error stream isn't stderr */
221   char *trace_dump;               /* file to dump the network trace to */
222   FILE *trace_stream;
223   bool trace_fopened;
224   trace tracetype;
225   bool tracetime;                 /* include timestamp? */
226   int progressmode;               /* CURL_PROGRESS_BAR / CURL_PROGRESS_STATS */
227   char *libcurl;                  /* Output libcurl code to this file name */
228
229   struct OperationConfig *first;
230   struct OperationConfig *current;
231   struct OperationConfig *last;   /* Always last in the struct */
232 };
233
234 void config_init(struct OperationConfig *config);
235 void config_free(struct OperationConfig *config);
236
237 #endif /* HEADER_CURL_TOOL_CFGABLE_H */