| #ifndef CURLINC_URLAPI_H |
| #define CURLINC_URLAPI_H |
| /*************************************************************************** |
| * _ _ ____ _ |
| * Project ___| | | | _ \| | |
| * / __| | | | |_) | | |
| * | (__| |_| | _ <| |___ |
| * \___|\___/|_| \_\_____| |
| * |
| * Copyright (C) 2018 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. |
| * |
| * This software is licensed as described in the file COPYING, which |
| * you should have received as part of this distribution. The terms |
| * are also available at https://curl.haxx.se/docs/copyright.html. |
| * |
| * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| * copies of the Software, and permit persons to whom the Software is |
| * furnished to do so, under the terms of the COPYING file. |
| * |
| * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| * KIND, either express or implied. |
| * |
| ***************************************************************************/ |
| |
| #include "curl.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* the error codes for the URL API */ |
| typedef enum { |
| CURLUE_OK, |
| CURLUE_BAD_HANDLE, /* 1 */ |
| CURLUE_BAD_PARTPOINTER, /* 2 */ |
| CURLUE_MALFORMED_INPUT, /* 3 */ |
| CURLUE_BAD_PORT_NUMBER, /* 4 */ |
| CURLUE_UNSUPPORTED_SCHEME, /* 5 */ |
| CURLUE_URLDECODE, /* 6 */ |
| CURLUE_OUT_OF_MEMORY, /* 7 */ |
| CURLUE_USER_NOT_ALLOWED, /* 8 */ |
| CURLUE_UNKNOWN_PART, /* 9 */ |
| CURLUE_NO_SCHEME, /* 10 */ |
| CURLUE_NO_USER, /* 11 */ |
| CURLUE_NO_PASSWORD, /* 12 */ |
| CURLUE_NO_OPTIONS, /* 13 */ |
| CURLUE_NO_HOST, /* 14 */ |
| CURLUE_NO_PORT, /* 15 */ |
| CURLUE_NO_QUERY, /* 16 */ |
| CURLUE_NO_FRAGMENT /* 17 */ |
| } CURLUcode; |
| |
| typedef enum { |
| CURLUPART_URL, |
| CURLUPART_SCHEME, |
| CURLUPART_USER, |
| CURLUPART_PASSWORD, |
| CURLUPART_OPTIONS, |
| CURLUPART_HOST, |
| CURLUPART_PORT, |
| CURLUPART_PATH, |
| CURLUPART_QUERY, |
| CURLUPART_FRAGMENT, |
| CURLUPART_ZONEID /* added in 7.65.0 */ |
| } CURLUPart; |
| |
| #define CURLU_DEFAULT_PORT (1<<0) /* return default port number */ |
| #define CURLU_NO_DEFAULT_PORT (1<<1) /* act as if no port number was set, |
| if the port number matches the |
| default for the scheme */ |
| #define CURLU_DEFAULT_SCHEME (1<<2) /* return default scheme if |
| missing */ |
| #define CURLU_NON_SUPPORT_SCHEME (1<<3) /* allow non-supported scheme */ |
| #define CURLU_PATH_AS_IS (1<<4) /* leave dot sequences */ |
| #define CURLU_DISALLOW_USER (1<<5) /* no user+password allowed */ |
| #define CURLU_URLDECODE (1<<6) /* URL decode on get */ |
| #define CURLU_URLENCODE (1<<7) /* URL encode on set */ |
| #define CURLU_APPENDQUERY (1<<8) /* append a form style part */ |
| #define CURLU_GUESS_SCHEME (1<<9) /* legacy curl-style guessing */ |
| #define CURLU_NO_AUTHORITY (1<<10) /* Allow empty authority when the |
| scheme is unknown. */ |
| |
| typedef struct Curl_URL CURLU; |
| |
| /* |
| * curl_url() creates a new CURLU handle and returns a pointer to it. |
| * Must be freed with curl_url_cleanup(). |
| */ |
| CURL_EXTERN CURLU *curl_url(void); |
| |
| /* |
| * curl_url_cleanup() frees the CURLU handle and related resources used for |
| * the URL parsing. It will not free strings previously returned with the URL |
| * API. |
| */ |
| CURL_EXTERN void curl_url_cleanup(CURLU *handle); |
| |
| /* |
| * curl_url_dup() duplicates a CURLU handle and returns a new copy. The new |
| * handle must also be freed with curl_url_cleanup(). |
| */ |
| CURL_EXTERN CURLU *curl_url_dup(CURLU *in); |
| |
| /* |
| * curl_url_get() extracts a specific part of the URL from a CURLU |
| * handle. Returns error code. The returned pointer MUST be freed with |
| * curl_free() afterwards. |
| */ |
| CURL_EXTERN CURLUcode curl_url_get(CURLU *handle, CURLUPart what, |
| char **part, unsigned int flags); |
| |
| /* |
| * curl_url_set() sets a specific part of the URL in a CURLU handle. Returns |
| * error code. The passed in string will be copied. Passing a NULL instead of |
| * a part string, clears that part. |
| */ |
| CURL_EXTERN CURLUcode curl_url_set(CURLU *handle, CURLUPart what, |
| const char *part, unsigned int flags); |
| |
| |
| #ifdef __cplusplus |
| } /* end of extern "C" */ |
| #endif |
| |
| #endif /* CURLINC_URLAPI_H */ |