xref: /aosp_15_r20/external/google-breakpad/src/third_party/curl/curlrules.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1*9712c20fSFrederick Mayle #ifndef __CURL_CURLRULES_H
2*9712c20fSFrederick Mayle #define __CURL_CURLRULES_H
3*9712c20fSFrederick Mayle /***************************************************************************
4*9712c20fSFrederick Mayle  *                                  _   _ ____  _
5*9712c20fSFrederick Mayle  *  Project                     ___| | | |  _ \| |
6*9712c20fSFrederick Mayle  *                             / __| | | | |_) | |
7*9712c20fSFrederick Mayle  *                            | (__| |_| |  _ <| |___
8*9712c20fSFrederick Mayle  *                             \___|\___/|_| \_\_____|
9*9712c20fSFrederick Mayle  *
10*9712c20fSFrederick Mayle  * Copyright (C) 1998 - 2009, Daniel Stenberg, <[email protected]>, et al.
11*9712c20fSFrederick Mayle  *
12*9712c20fSFrederick Mayle  * This software is licensed as described in the file COPYING, which
13*9712c20fSFrederick Mayle  * you should have received as part of this distribution. The terms
14*9712c20fSFrederick Mayle  * are also available at http://curl.haxx.se/docs/copyright.html.
15*9712c20fSFrederick Mayle  *
16*9712c20fSFrederick Mayle  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17*9712c20fSFrederick Mayle  * copies of the Software, and permit persons to whom the Software is
18*9712c20fSFrederick Mayle  * furnished to do so, under the terms of the COPYING file.
19*9712c20fSFrederick Mayle  *
20*9712c20fSFrederick Mayle  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21*9712c20fSFrederick Mayle  * KIND, either express or implied.
22*9712c20fSFrederick Mayle  *
23*9712c20fSFrederick Mayle  * $Id: curlrules.h,v 1.7 2009-10-27 16:56:20 yangtse Exp $
24*9712c20fSFrederick Mayle  ***************************************************************************/
25*9712c20fSFrederick Mayle 
26*9712c20fSFrederick Mayle /* ================================================================ */
27*9712c20fSFrederick Mayle /*                    COMPILE TIME SANITY CHECKS                    */
28*9712c20fSFrederick Mayle /* ================================================================ */
29*9712c20fSFrederick Mayle 
30*9712c20fSFrederick Mayle /*
31*9712c20fSFrederick Mayle  * NOTE 1:
32*9712c20fSFrederick Mayle  * -------
33*9712c20fSFrederick Mayle  *
34*9712c20fSFrederick Mayle  * All checks done in this file are intentionally placed in a public
35*9712c20fSFrederick Mayle  * header file which is pulled by curl/curl.h when an application is
36*9712c20fSFrederick Mayle  * being built using an already built libcurl library. Additionally
37*9712c20fSFrederick Mayle  * this file is also included and used when building the library.
38*9712c20fSFrederick Mayle  *
39*9712c20fSFrederick Mayle  * If compilation fails on this file it is certainly sure that the
40*9712c20fSFrederick Mayle  * problem is elsewhere. It could be a problem in the curlbuild.h
41*9712c20fSFrederick Mayle  * header file, or simply that you are using different compilation
42*9712c20fSFrederick Mayle  * settings than those used to build the library.
43*9712c20fSFrederick Mayle  *
44*9712c20fSFrederick Mayle  * Nothing in this file is intended to be modified or adjusted by the
45*9712c20fSFrederick Mayle  * curl library user nor by the curl library builder.
46*9712c20fSFrederick Mayle  *
47*9712c20fSFrederick Mayle  * Do not deactivate any check, these are done to make sure that the
48*9712c20fSFrederick Mayle  * library is properly built and used.
49*9712c20fSFrederick Mayle  *
50*9712c20fSFrederick Mayle  * You can find further help on the libcurl development mailing list:
51*9712c20fSFrederick Mayle  * http://cool.haxx.se/mailman/listinfo/curl-library/
52*9712c20fSFrederick Mayle  *
53*9712c20fSFrederick Mayle  * NOTE 2
54*9712c20fSFrederick Mayle  * ------
55*9712c20fSFrederick Mayle  *
56*9712c20fSFrederick Mayle  * Some of the following compile time checks are based on the fact
57*9712c20fSFrederick Mayle  * that the dimension of a constant array can not be a negative one.
58*9712c20fSFrederick Mayle  * In this way if the compile time verification fails, the compilation
59*9712c20fSFrederick Mayle  * will fail issuing an error. The error description wording is compiler
60*9712c20fSFrederick Mayle  * dependent but it will be quite similar to one of the following:
61*9712c20fSFrederick Mayle  *
62*9712c20fSFrederick Mayle  *   "negative subscript or subscript is too large"
63*9712c20fSFrederick Mayle  *   "array must have at least one element"
64*9712c20fSFrederick Mayle  *   "-1 is an illegal array size"
65*9712c20fSFrederick Mayle  *   "size of array is negative"
66*9712c20fSFrederick Mayle  *
67*9712c20fSFrederick Mayle  * If you are building an application which tries to use an already
68*9712c20fSFrederick Mayle  * built libcurl library and you are getting this kind of errors on
69*9712c20fSFrederick Mayle  * this file, it is a clear indication that there is a mismatch between
70*9712c20fSFrederick Mayle  * how the library was built and how you are trying to use it for your
71*9712c20fSFrederick Mayle  * application. Your already compiled or binary library provider is the
72*9712c20fSFrederick Mayle  * only one who can give you the details you need to properly use it.
73*9712c20fSFrederick Mayle  */
74*9712c20fSFrederick Mayle 
75*9712c20fSFrederick Mayle /*
76*9712c20fSFrederick Mayle  * Verify that some macros are actually defined.
77*9712c20fSFrederick Mayle  */
78*9712c20fSFrederick Mayle 
79*9712c20fSFrederick Mayle #ifndef CURL_SIZEOF_LONG
80*9712c20fSFrederick Mayle #  error "CURL_SIZEOF_LONG definition is missing!"
81*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_SIZEOF_LONG_is_missing
82*9712c20fSFrederick Mayle #endif
83*9712c20fSFrederick Mayle 
84*9712c20fSFrederick Mayle #ifndef CURL_TYPEOF_CURL_SOCKLEN_T
85*9712c20fSFrederick Mayle #  error "CURL_TYPEOF_CURL_SOCKLEN_T definition is missing!"
86*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_TYPEOF_CURL_SOCKLEN_T_is_missing
87*9712c20fSFrederick Mayle #endif
88*9712c20fSFrederick Mayle 
89*9712c20fSFrederick Mayle #ifndef CURL_SIZEOF_CURL_SOCKLEN_T
90*9712c20fSFrederick Mayle #  error "CURL_SIZEOF_CURL_SOCKLEN_T definition is missing!"
91*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_SIZEOF_CURL_SOCKLEN_T_is_missing
92*9712c20fSFrederick Mayle #endif
93*9712c20fSFrederick Mayle 
94*9712c20fSFrederick Mayle #ifndef CURL_TYPEOF_CURL_OFF_T
95*9712c20fSFrederick Mayle #  error "CURL_TYPEOF_CURL_OFF_T definition is missing!"
96*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_TYPEOF_CURL_OFF_T_is_missing
97*9712c20fSFrederick Mayle #endif
98*9712c20fSFrederick Mayle 
99*9712c20fSFrederick Mayle #ifndef CURL_FORMAT_CURL_OFF_T
100*9712c20fSFrederick Mayle #  error "CURL_FORMAT_CURL_OFF_T definition is missing!"
101*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_FORMAT_CURL_OFF_T_is_missing
102*9712c20fSFrederick Mayle #endif
103*9712c20fSFrederick Mayle 
104*9712c20fSFrederick Mayle #ifndef CURL_FORMAT_CURL_OFF_TU
105*9712c20fSFrederick Mayle #  error "CURL_FORMAT_CURL_OFF_TU definition is missing!"
106*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_FORMAT_CURL_OFF_TU_is_missing
107*9712c20fSFrederick Mayle #endif
108*9712c20fSFrederick Mayle 
109*9712c20fSFrederick Mayle #ifndef CURL_FORMAT_OFF_T
110*9712c20fSFrederick Mayle #  error "CURL_FORMAT_OFF_T definition is missing!"
111*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_FORMAT_OFF_T_is_missing
112*9712c20fSFrederick Mayle #endif
113*9712c20fSFrederick Mayle 
114*9712c20fSFrederick Mayle #ifndef CURL_SIZEOF_CURL_OFF_T
115*9712c20fSFrederick Mayle #  error "CURL_SIZEOF_CURL_OFF_T definition is missing!"
116*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_SIZEOF_CURL_OFF_T_is_missing
117*9712c20fSFrederick Mayle #endif
118*9712c20fSFrederick Mayle 
119*9712c20fSFrederick Mayle #ifndef CURL_SUFFIX_CURL_OFF_T
120*9712c20fSFrederick Mayle #  error "CURL_SUFFIX_CURL_OFF_T definition is missing!"
121*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_T_is_missing
122*9712c20fSFrederick Mayle #endif
123*9712c20fSFrederick Mayle 
124*9712c20fSFrederick Mayle #ifndef CURL_SUFFIX_CURL_OFF_TU
125*9712c20fSFrederick Mayle #  error "CURL_SUFFIX_CURL_OFF_TU definition is missing!"
126*9712c20fSFrederick Mayle    Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_TU_is_missing
127*9712c20fSFrederick Mayle #endif
128*9712c20fSFrederick Mayle 
129*9712c20fSFrederick Mayle /*
130*9712c20fSFrederick Mayle  * Macros private to this header file.
131*9712c20fSFrederick Mayle  */
132*9712c20fSFrederick Mayle 
133*9712c20fSFrederick Mayle #define CurlchkszEQ(t, s) sizeof(t) == s ? 1 : -1
134*9712c20fSFrederick Mayle 
135*9712c20fSFrederick Mayle #define CurlchkszGE(t1, t2) sizeof(t1) >= sizeof(t2) ? 1 : -1
136*9712c20fSFrederick Mayle 
137*9712c20fSFrederick Mayle /*
138*9712c20fSFrederick Mayle  * Verify that the size previously defined and expected for long
139*9712c20fSFrederick Mayle  * is the same as the one reported by sizeof() at compile time.
140*9712c20fSFrederick Mayle  */
141*9712c20fSFrederick Mayle 
142*9712c20fSFrederick Mayle typedef char
143*9712c20fSFrederick Mayle   __curl_rule_01__
144*9712c20fSFrederick Mayle     [CurlchkszEQ(long, CURL_SIZEOF_LONG)];
145*9712c20fSFrederick Mayle 
146*9712c20fSFrederick Mayle /*
147*9712c20fSFrederick Mayle  * Verify that the size previously defined and expected for
148*9712c20fSFrederick Mayle  * curl_off_t is actually the the same as the one reported
149*9712c20fSFrederick Mayle  * by sizeof() at compile time.
150*9712c20fSFrederick Mayle  */
151*9712c20fSFrederick Mayle 
152*9712c20fSFrederick Mayle typedef char
153*9712c20fSFrederick Mayle   __curl_rule_02__
154*9712c20fSFrederick Mayle     [CurlchkszEQ(curl_off_t, CURL_SIZEOF_CURL_OFF_T)];
155*9712c20fSFrederick Mayle 
156*9712c20fSFrederick Mayle /*
157*9712c20fSFrederick Mayle  * Verify at compile time that the size of curl_off_t as reported
158*9712c20fSFrederick Mayle  * by sizeof() is greater or equal than the one reported for long
159*9712c20fSFrederick Mayle  * for the current compilation.
160*9712c20fSFrederick Mayle  */
161*9712c20fSFrederick Mayle 
162*9712c20fSFrederick Mayle typedef char
163*9712c20fSFrederick Mayle   __curl_rule_03__
164*9712c20fSFrederick Mayle     [CurlchkszGE(curl_off_t, long)];
165*9712c20fSFrederick Mayle 
166*9712c20fSFrederick Mayle /*
167*9712c20fSFrederick Mayle  * Verify that the size previously defined and expected for
168*9712c20fSFrederick Mayle  * curl_socklen_t is actually the the same as the one reported
169*9712c20fSFrederick Mayle  * by sizeof() at compile time.
170*9712c20fSFrederick Mayle  */
171*9712c20fSFrederick Mayle 
172*9712c20fSFrederick Mayle typedef char
173*9712c20fSFrederick Mayle   __curl_rule_04__
174*9712c20fSFrederick Mayle     [CurlchkszEQ(curl_socklen_t, CURL_SIZEOF_CURL_SOCKLEN_T)];
175*9712c20fSFrederick Mayle 
176*9712c20fSFrederick Mayle /*
177*9712c20fSFrederick Mayle  * Verify at compile time that the size of curl_socklen_t as reported
178*9712c20fSFrederick Mayle  * by sizeof() is greater or equal than the one reported for int for
179*9712c20fSFrederick Mayle  * the current compilation.
180*9712c20fSFrederick Mayle  */
181*9712c20fSFrederick Mayle 
182*9712c20fSFrederick Mayle typedef char
183*9712c20fSFrederick Mayle   __curl_rule_05__
184*9712c20fSFrederick Mayle     [CurlchkszGE(curl_socklen_t, int)];
185*9712c20fSFrederick Mayle 
186*9712c20fSFrederick Mayle /* ================================================================ */
187*9712c20fSFrederick Mayle /*          EXTERNALLY AND INTERNALLY VISIBLE DEFINITIONS           */
188*9712c20fSFrederick Mayle /* ================================================================ */
189*9712c20fSFrederick Mayle 
190*9712c20fSFrederick Mayle /*
191*9712c20fSFrederick Mayle  * CURL_ISOCPP and CURL_OFF_T_C definitions are done here in order to allow
192*9712c20fSFrederick Mayle  * these to be visible and exported by the external libcurl interface API,
193*9712c20fSFrederick Mayle  * while also making them visible to the library internals, simply including
194*9712c20fSFrederick Mayle  * setup.h, without actually needing to include curl.h internally.
195*9712c20fSFrederick Mayle  * If some day this section would grow big enough, all this should be moved
196*9712c20fSFrederick Mayle  * to its own header file.
197*9712c20fSFrederick Mayle  */
198*9712c20fSFrederick Mayle 
199*9712c20fSFrederick Mayle /*
200*9712c20fSFrederick Mayle  * Figure out if we can use the ## preprocessor operator, which is supported
201*9712c20fSFrederick Mayle  * by ISO/ANSI C and C++. Some compilers support it without setting __STDC__
202*9712c20fSFrederick Mayle  * or  __cplusplus so we need to carefully check for them too.
203*9712c20fSFrederick Mayle  */
204*9712c20fSFrederick Mayle 
205*9712c20fSFrederick Mayle #if defined(__STDC__) || defined(_MSC_VER) || defined(__cplusplus) || \
206*9712c20fSFrederick Mayle   defined(__HP_aCC) || defined(__BORLANDC__) || defined(__LCC__) || \
207*9712c20fSFrederick Mayle   defined(__POCC__) || defined(__SALFORDC__) || defined(__HIGHC__) || \
208*9712c20fSFrederick Mayle   defined(__ILEC400__)
209*9712c20fSFrederick Mayle   /* This compiler is believed to have an ISO compatible preprocessor */
210*9712c20fSFrederick Mayle #define CURL_ISOCPP
211*9712c20fSFrederick Mayle #else
212*9712c20fSFrederick Mayle   /* This compiler is believed NOT to have an ISO compatible preprocessor */
213*9712c20fSFrederick Mayle #undef CURL_ISOCPP
214*9712c20fSFrederick Mayle #endif
215*9712c20fSFrederick Mayle 
216*9712c20fSFrederick Mayle /*
217*9712c20fSFrederick Mayle  * Macros for minimum-width signed and unsigned curl_off_t integer constants.
218*9712c20fSFrederick Mayle  */
219*9712c20fSFrederick Mayle 
220*9712c20fSFrederick Mayle #ifdef CURL_ISOCPP
221*9712c20fSFrederick Mayle #  define __CURL_OFF_T_C_HELPER2(Val,Suffix) Val ## Suffix
222*9712c20fSFrederick Mayle #else
223*9712c20fSFrederick Mayle #  define __CURL_OFF_T_C_HELPER2(Val,Suffix) Val/**/Suffix
224*9712c20fSFrederick Mayle #endif
225*9712c20fSFrederick Mayle #define __CURL_OFF_T_C_HELPER1(Val,Suffix) __CURL_OFF_T_C_HELPER2(Val,Suffix)
226*9712c20fSFrederick Mayle #define CURL_OFF_T_C(Val)  __CURL_OFF_T_C_HELPER1(Val,CURL_SUFFIX_CURL_OFF_T)
227*9712c20fSFrederick Mayle #define CURL_OFF_TU_C(Val) __CURL_OFF_T_C_HELPER1(Val,CURL_SUFFIX_CURL_OFF_TU)
228*9712c20fSFrederick Mayle 
229*9712c20fSFrederick Mayle /*
230*9712c20fSFrederick Mayle  * Get rid of macros private to this header file.
231*9712c20fSFrederick Mayle  */
232*9712c20fSFrederick Mayle 
233*9712c20fSFrederick Mayle #undef CurlchkszEQ
234*9712c20fSFrederick Mayle #undef CurlchkszGE
235*9712c20fSFrederick Mayle 
236*9712c20fSFrederick Mayle /*
237*9712c20fSFrederick Mayle  * Get rid of macros not intended to exist beyond this point.
238*9712c20fSFrederick Mayle  */
239*9712c20fSFrederick Mayle 
240*9712c20fSFrederick Mayle #undef CURL_PULL_WS2TCPIP_H
241*9712c20fSFrederick Mayle #undef CURL_PULL_SYS_TYPES_H
242*9712c20fSFrederick Mayle #undef CURL_PULL_SYS_SOCKET_H
243*9712c20fSFrederick Mayle #undef CURL_PULL_STDINT_H
244*9712c20fSFrederick Mayle #undef CURL_PULL_INTTYPES_H
245*9712c20fSFrederick Mayle 
246*9712c20fSFrederick Mayle #undef CURL_TYPEOF_CURL_SOCKLEN_T
247*9712c20fSFrederick Mayle #undef CURL_TYPEOF_CURL_OFF_T
248*9712c20fSFrederick Mayle 
249*9712c20fSFrederick Mayle #endif /* __CURL_CURLRULES_H */
250