lib/curlx.h

   1 #ifndef __CURLX_H
   2 #define __CURLX_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2004, 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  * $Id$
  24  ***************************************************************************/
  25
  26 /*
  27  * Defines protos and includes all header files that provide the curlx_*
  28  * functions. The curlx_* functions are not part of the libcurl API, but are
  29  * stand-alone functions whose sources can be built and linked by apps if need
  30  * be.
  31  */
  32
  33 #include <curl/mprintf.h>
  34 /* this is still a public header file that provides the curl_mprintf()
  35    functions while they still are offered publicly. They will be made library-
  36    private one day */
  37
  38 #include "strequal.h"
  39 /* "strequal.h" provides the strequal protos */
  40
  41 #include "strtoofft.h"
  42 /* "strtoofft.h" provides this function: curlx_strtoofft(), returns a
  43    curl_off_t number from a given string.
  44 */
  45
  46 #include "timeval.h"
  47 /*
  48   "timeval.h" sets up a 'struct timeval' even for platforms that otherwise
  49   don't have one and has protos for these functions:
  50
  51   curlx_tvnow()
  52   curlx_tvdiff()
  53   curlx_tvdiff_secs()
  54 */
  55
  56 /* Now setup curlx_ * names for the functions that are to become curlx_ and
  57    be removed from a future libcurl official API:
  58    curlx_getenv
  59    curlx_mprintf (and its variations)
  60    curlx_strequal
  61    curlx_strnequal
  62
  63 */
  64
  65 #define curlx_getenv curl_getenv
  66 #define curlx_strequal curl_strequal
  67 #define curlx_strnequal curl_strnequal
  68 #define curlx_mvsnprintf curl_mvsnprintf
  69 #define curlx_msnprintf curl_msnprintf
  70 #define curlx_maprintf curl_maprintf
  71 #define curlx_mvaprintf curl_mvaprintf
  72 #define curlx_msprintf curl_msprintf
  73 #define curlx_mprintf curl_mprintf
  74 #define curlx_mfprintf curl_mfprintf
  75 #define curlx_mvsprintf curl_mvsprintf
  76 #define curlx_mvprintf curl_mvprintf
  77 #define curlx_mvfprintf curl_mvfprintf
  78
  79 #ifdef ENABLE_CURLX_PRINTF
  80 /* If this define is set, we define all "standard" printf() functions to use
  81    the curlx_* version instead. It makes the source code transparant and
  82    easier to understand/patch. Undefine them first in case _MPRINTF_REPLACE
  83    is set. */
  84 # undef printf
  85 # undef fprintf
  86 # undef sprintf
  87 # undef snprintf
  88 # undef vprintf
  89 # undef vfprintf
  90 # undef vsprintf
  91 # undef vsnprintf
  92 # undef aprintf
  93 # undef vaprintf
  94
  95 # define printf curlx_mprintf
  96 # define fprintf curlx_mfprintf
  97 # define sprintf curlx_msprintf
  98 # define snprintf curlx_msnprintf
  99 # define vprintf curlx_mvprintf
 100 # define vfprintf curlx_mvfprintf
 101 # define vsprintf curlx_mvsprintf
 102 # define vsnprintf curlx_mvsnprintf
 103 # define aprintf curlx_maprintf
 104 # define vaprintf curlx_mvaprintf
 105 #endif /* ENABLE_CURLX_PRINTF */
 106
 107 #endif /* __CURLX_H */