1 #ifndef HEADER_CURL_TOOL_SDECLS_H 2 #define HEADER_CURL_TOOL_SDECLS_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 /* 29 * OutStruct variables keep track of information relative to curl's 30 * output writing, which may take place to a standard stream or a file. 31 * 32 * 'filename' member is either a pointer to a filename string or NULL 33 * when dealing with a standard stream. 34 * 35 * 'alloc_filename' member is TRUE when string pointed by 'filename' has been 36 * dynamically allocated and 'belongs' to this OutStruct, otherwise FALSE. 37 * 38 * 'is_cd_filename' member is TRUE when string pointed by 'filename' has been 39 * set using a server-specified Content-Disposition filename, otherwise FALSE. 40 * 41 * 's_isreg' member is TRUE when output goes to a regular file, this also 42 * implies that output is 'seekable' and 'appendable' and also that member 43 * 'filename' points to filename's string. For any standard stream member 44 * 's_isreg' will be FALSE. 45 * 46 * 'fopened' member is TRUE when output goes to a regular file and it 47 * has been fopen'ed, requiring it to be closed later on. In any other 48 * case this is FALSE. 49 * 50 * 'stream' member is a pointer to a stream controlling object as returned 51 * from a 'fopen' call or a standard stream. 52 * 53 * 'config' member is a pointer to associated 'OperationConfig' struct. 54 * 55 * 'bytes' member represents amount written so far. 56 * 57 * 'init' member holds original file size or offset at which truncation is 58 * taking place. Always zero unless appending to a non-empty regular file. 59 * 60 * [Windows] 61 * 'utf8seq' member holds an incomplete UTF-8 sequence destined for the console 62 * until it can be completed (1-4 bytes) + NUL. 63 */ 64 65 struct OutStruct { 66 char *filename; 67 bool alloc_filename; 68 bool is_cd_filename; 69 bool s_isreg; 70 bool fopened; 71 FILE *stream; 72 curl_off_t bytes; 73 curl_off_t init; 74 #ifdef _WIN32 75 unsigned char utf8seq[5]; 76 #endif 77 }; 78 79 /* 80 * A linked list of these 'getout' nodes contain URL's to fetch, 81 * as well as information relative to where URL contents should 82 * be stored or which file should be uploaded. 83 */ 84 85 struct getout { 86 struct getout *next; /* next one */ 87 char *url; /* the URL we deal with */ 88 char *outfile; /* where to store the output */ 89 char *infile; /* file to upload, if GETOUT_UPLOAD is set */ 90 int flags; /* options - composed of GETOUT_* bits */ 91 int num; /* which URL number in an invocation */ 92 }; 93 94 #define GETOUT_OUTFILE (1<<0) /* set when outfile is deemed done */ 95 #define GETOUT_URL (1<<1) /* set when URL is deemed done */ 96 #define GETOUT_USEREMOTE (1<<2) /* use remote filename locally */ 97 #define GETOUT_UPLOAD (1<<3) /* if set, -T has been used */ 98 #define GETOUT_NOUPLOAD (1<<4) /* if set, -T "" has been used */ 99 100 /* 101 * 'trace' enumeration represents curl's output look'n feel possibilities. 102 */ 103 104 typedef enum { 105 TRACE_NONE, /* no trace/verbose output at all */ 106 TRACE_BIN, /* tcpdump inspired look */ 107 TRACE_ASCII, /* like *BIN but without the hex output */ 108 TRACE_PLAIN /* -v/--verbose type */ 109 } trace; 110 111 112 /* 113 * 'HttpReq' enumeration represents HTTP request types. 114 */ 115 116 typedef enum { 117 TOOL_HTTPREQ_UNSPEC, /* first in list */ 118 TOOL_HTTPREQ_GET, 119 TOOL_HTTPREQ_HEAD, 120 TOOL_HTTPREQ_MIMEPOST, 121 TOOL_HTTPREQ_SIMPLEPOST, 122 TOOL_HTTPREQ_PUT 123 } HttpReq; 124 125 126 /* 127 * Complete struct declarations which have OperationConfig struct members, 128 * just in case this header is directly included in some source file. 129 */ 130 131 #include "tool_cfgable.h" 132 133 #endif /* HEADER_CURL_TOOL_SDECLS_H */ 134
