curl-curl/lib/curlx/README.md
Daniel Stenberg 255aac56f9
curlx: move into to curlx/
Move curlx_ functions into its own subdir.

The idea is to use the curlx_ prefix proper on these functions, and use
these same function names both in tool, lib and test suite source code.
Stop the previous special #define setup for curlx_ names.

The printf defines are now done for the library alone. Tests no longer
use the printf defines. The tool code sets its own defines. The printf
functions are not curlx, they are publicly available.

The strcase defines are not curlx_ functions and should not be used by
tool or server code.

dynbuf, warnless, base64, strparse, timeval, timediff are now proper
curlx functions.

When libcurl is built statically, the functions from the library can be
used as-is. The key is then that the functions must work as-is, without
having to be recompiled for use in tool/tests. This avoids symbol
collisions - when libcurl is built statically, we use those functions
directly when building the tool/tests. When libcurl is shared, we
build/link them separately for the tool/tests.

Assisted-by: Jay Satiro

Closes #17253
2025-05-07 11:01:15 +02:00

791 B

curlx

Functions that are prefixed with curlx_ are internal global functions that are written in a way to allow them to be "borrowed" and used outside of the library: in the curl tool and in the curl test suite.

The curlx functions are not part of the libcurl API, but are stand-alone functions whose sources can be built and used outside of libcurl. There are not API or ABI guarantees. The functions are not written or meant to be used outside of the curl project.

Only functions actually used by the library are provided here.

Ways to success

  • Do not use struct Curl_easy in these files
  • Do not use the printf defines in these files
  • Make them as stand-alone as possible