mirror of
https://github.com/curl/curl.git
synced 2026-08-05 17:16:15 +03:00
Backtrack on previous change that aimed to solve the wrong `share.h` being included. It turns out it did not fix this issue. At the same time it introduced relative header filenames and the need to include the same headers differently depending on the source files' location, reducing readability and editability. Replace this method by re-adding curl's lib source directory to the header path and addressing headers by the their full, relative name to that base directory. Aligning with this method already used in src and tests. With these advantages: - makes includes easier to read, recognize, grep, sort, write, and copy between sources, - syncs the way these headers are included across curl components, - avoids the ambiguity between system `schannel.h`, `rustls.h` vs. local headers using the same names in `lib/vtls`, - silences clang-tidy `readability-duplicate-include` checker, which detects the above issue, Ref: https://clang.llvm.org/extra/clang-tidy/checks/readability/duplicate-include.html - possibly silences TIOBE coding standard warnings: `6.10.2.a: Don't use relative paths in #include statements.` - long shot: it works well with concatenated test sources, for clang-tidy-friendly custom unity builds. Ref: #20667 Slight downside: it's not enforced. If there happens to be a collision between a local `lib/*.h` header and a system one, the solution is to rename (possibly with its `.c` counterpart) into the `curl_` namespace. This is also the method used by curl in the past. Also: - curlx/inet_pton: reduce scope of an include. - toolx/tool_time: apply this to an include, and update VS project files accordingly. Also dropping unnecessary lib/curlx header path. - clang-tidy: enable `readability-duplicate-include`. Follow-up to3887069c66#19676 Follow-up to625f2c1644#16991 #16949 Closes #20623
52 lines
2.3 KiB
C
52 lines
2.3 KiB
C
#ifndef HEADER_CURL_CURLX_H
|
|
#define HEADER_CURL_CURLX_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 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.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.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
|
|
/*
|
|
* Defines protos and includes all header files that provide the curlx_*
|
|
* functions. The curlx_* functions are not part of the libcurl API, but are
|
|
* stand-alone functions whose sources can be built and linked by apps if need
|
|
* be.
|
|
*/
|
|
|
|
#include "curlx/base64.h" /* for curlx_base64* */
|
|
#include "curlx/basename.h" /* for curlx_basename() */
|
|
#include "curlx/dynbuf.h" /* for curlx_dyn_*() */
|
|
#include "curlx/fopen.h" /* for curlx_f*() */
|
|
#include "curlx/inet_ntop.h" /* for curlx_inet_ntop() */
|
|
#include "curlx/inet_pton.h" /* for curlx_inet_pton() */
|
|
#include "curlx/multibyte.h" /* for curlx_convert_*() */
|
|
#include "curlx/nonblock.h" /* for curlx_nonblock() */
|
|
#include "curlx/strcopy.h" /* for curlx_strcopy() */
|
|
#include "curlx/strdup.h" /* for curlx_memdup*() and curlx_tcsdup() */
|
|
#include "curlx/strerr.h" /* for curlx_strerror() */
|
|
#include "curlx/strparse.h" /* for curlx_str_* parsing functions */
|
|
#include "curlx/timediff.h" /* for timediff_t type and related functions */
|
|
#include "curlx/timeval.h" /* for curlx_now type and related functions */
|
|
#include "curlx/version_win32.h" /* for curlx_verify_windows_version() */
|
|
#include "curlx/wait.h" /* for curlx_wait_ms() */
|
|
#include "curlx/winapi.h" /* for curlx_winapi_strerror() */
|
|
|
|
#endif /* HEADER_CURL_CURLX_H */
|