Annotation of libwww/Library/src/HTUtils.html, revision 2.49
2.6 timbl 1: <HTML>
2: <HEAD>
2.35 frystyk 3: <TITLE>Utility macros</TITLE>
2.49 ! frystyk 4: <!-- Changed by: Henrik Frystyk Nielsen, 11-Dec-1995 -->
2.6 timbl 5: </HEAD>
2.3 timbl 6: <BODY>
2.24 frystyk 7:
2.20 frystyk 8: <H1>Macros for general use</H1>
9:
2.24 frystyk 10: <PRE>
11: /*
2.31 frystyk 12: ** (c) COPYRIGHT MIT 1995.
2.24 frystyk 13: ** Please first read the full copyright statement in the file COPYRIGH.
14: */
15: </PRE>
16:
17: This module is a part of the <A
2.44 frystyk 18: HREF="http://www.w3.org/pub/WWW/Library/"> W3C Reference Library</A>.
2.20 frystyk 19:
2.26 frystyk 20: See also the system dependent file <A HREF="tcp.html">tcp module</A>
21: for system specific information. <P>
22:
2.1 timbl 23: <PRE>
24: #ifndef HTUTILS_H
25: #define HTUTILS_H
26:
2.26 frystyk 27: #if defined(__STDC__) || defined(__cplusplus) || defined(_WINDOWS)
28: #define _STANDARD_CODE_
2.1 timbl 29: #endif
2.20 frystyk 30: </PRE>
31:
2.45 frystyk 32: <A NAME="debug"><H2>Debug message control</H2></A>
2.20 frystyk 33:
2.39 frystyk 34: This is the global flag for setting the WWWTRACE options.
2.20 frystyk 35:
36: <PRE>
2.26 frystyk 37: #ifndef DEBUG
38: #define DEBUG /* No one ever turns this off as trace is too important */
39: #endif /* Keep option for really small memory applications too */
40:
2.44 frystyk 41: #ifdef WWW_WIN_DLL
42: extern int * WWW_TraceFlag; /* Global flag for all W3 trace */
43: #else
2.20 frystyk 44: extern int WWW_TraceFlag; /* Global flag for all W3 trace */
2.44 frystyk 45: #endif
46:
2.20 frystyk 47: </PRE>
48:
2.39 frystyk 49: The verbose mode is no longer a simple boolean but a bit field so that
50: it is possible to see parts of the output messages. The
51: <EM>WWWTRACE</EM> define still outputs all messages if verbose mode is
52: active, but in addition the following WWWTRACE defines have been made:
2.1 timbl 53:
2.20 frystyk 54: <PRE>
2.40 frystyk 55: #define WWWTRACE_FILE 1
56: #define WWWTRACE_STDERR 2
57: #define WWWTRACE_TTY 3
58:
59: #ifndef WWWTRACE_MODE
2.42 frystyk 60: #if (defined _WINDOWS) && !defined(_CONSOLE)
61: #define WWWTRACE_MODE WWWTRACE_TTY
62: #else
2.40 frystyk 63: #define WWWTRACE_MODE WWWTRACE_STDERR
64: #endif
2.42 frystyk 65: #endif
2.40 frystyk 66:
67: #if WWWTRACE_MODE == WWWTRACE_FILE
2.26 frystyk 68: extern FILE *WWWTrace;
2.46 frystyk 69: #ifndef HT_TRACE_FILE
70: #define HT_TRACE_FILE "WWWTRACE.TXT"
2.26 frystyk 71: #endif
2.40 frystyk 72: #define TTYPrint fprintf
73: #define TDEST WWWTrace
74: #endif
75:
76: #if WWWTRACE_MODE == WWWTRACE_STDERR
77: #define TTYPrint fprintf
78: #define TDEST stderr
2.26 frystyk 79: #endif
2.40 frystyk 80:
81: #if WWWTRACE_MODE == WWWTRACE_TTY
82: #if defined(_WINDOWS) && !defined(_CONSOLE) /* EGP */
83: /* standard windows 3.x and non-console WIN32 programs */
2.43 frystyk 84: #define TDEST 0
2.44 frystyk 85: #ifdef WWW_WIN_DLL
2.43 frystyk 86: typedef int TTYPrint_t(unsigned int target, const char* fmt, ...);
87: extern TTYPrint_t** PTTYPrint;
88: #define TTYPrint (**PTTYPrint)
89: #else
2.40 frystyk 90: int TTYPrint(unsigned int target, const char* fmt, ...);
2.43 frystyk 91: #endif
2.40 frystyk 92: #else
93: /* if there is a real console, us it */
2.43 frystyk 94: #define TDEST stderr
2.40 frystyk 95: int TTYPrint(FILE* target, const char* fmt, ...);
96: #endif
97: #endif
2.26 frystyk 98:
2.20 frystyk 99: typedef enum _HTTraceFlags {
2.44 frystyk 100: SHOW_UTIL_TRACE = 0x1, /* 1 */
101: SHOW_APP_TRACE = 0x2, /* 10 */
102: SHOW_CACHE_TRACE = 0x4, /* 100 */
2.32 frystyk 103: SHOW_SGML_TRACE = 0x8, /* 1000 */
2.29 frystyk 104: SHOW_BIND_TRACE = 0x10, /* 1.0000 */
2.32 frystyk 105: SHOW_THREAD_TRACE = 0x20, /* 10.0000 */
2.27 frystyk 106: SHOW_STREAM_TRACE = 0x40, /* 100.0000 */
2.32 frystyk 107: SHOW_PROTOCOL_TRACE = 0x80, /* 1000.0000 */
108: SHOW_URI_TRACE = 0x200, /* 10.0000.0000 */
109: SHOW_ANCHOR_TRACE = 0x800, /* 10.00.0000.0000 */
2.20 frystyk 110: SHOW_ALL_TRACE = 0xFFF /* 11.11.1111.1111 */
111: } HTTraceFlags;
112: </PRE>
113:
114: The flags are made so that they can serve as a group flag for correlated
115: trace messages, e.g. showing messages for SGML and HTML at the same time.
116:
117: <PRE>
2.1 timbl 118: #ifdef DEBUG
2.44 frystyk 119: #ifdef WWW_WIN_DLL
120: #define WWWTRACE (*WWW_TraceFlag)
121: #define UTIL_TRACE (*WWW_TraceFlag & SHOW_UTIL_TRACE)
122: #define APP_TRACE (*WWW_TraceFlag & SHOW_APP_TRACE)
123: #define CACHE_TRACE (*WWW_TraceFlag & SHOW_CACHE_TRACE)
124: #define SGML_TRACE (*WWW_TraceFlag & SHOW_SGML_TRACE)
125: #define BIND_TRACE (*WWW_TraceFlag & SHOW_BIND_TRACE)
126: #define THD_TRACE (*WWW_TraceFlag & SHOW_THREAD_TRACE)
127: #define STREAM_TRACE (*WWW_TraceFlag & SHOW_STREAM_TRACE)
128: #define PROT_TRACE (*WWW_TraceFlag & SHOW_PROTOCOL_TRACE)
129: #define URI_TRACE (*WWW_TraceFlag & SHOW_URI_TRACE)
130: #define ANCH_TRACE (*WWW_TraceFlag & SHOW_ANCHOR_TRACE)
131: #else
2.39 frystyk 132: #define WWWTRACE (WWW_TraceFlag)
2.44 frystyk 133: #define UTIL_TRACE (WWW_TraceFlag & SHOW_UTIL_TRACE)
134: #define APP_TRACE (WWW_TraceFlag & SHOW_APP_TRACE)
2.27 frystyk 135: #define CACHE_TRACE (WWW_TraceFlag & SHOW_CACHE_TRACE)
2.20 frystyk 136: #define SGML_TRACE (WWW_TraceFlag & SHOW_SGML_TRACE)
2.29 frystyk 137: #define BIND_TRACE (WWW_TraceFlag & SHOW_BIND_TRACE)
2.23 frystyk 138: #define THD_TRACE (WWW_TraceFlag & SHOW_THREAD_TRACE)
2.27 frystyk 139: #define STREAM_TRACE (WWW_TraceFlag & SHOW_STREAM_TRACE)
2.20 frystyk 140: #define PROT_TRACE (WWW_TraceFlag & SHOW_PROTOCOL_TRACE)
141: #define URI_TRACE (WWW_TraceFlag & SHOW_URI_TRACE)
142: #define ANCH_TRACE (WWW_TraceFlag & SHOW_ANCHOR_TRACE)
2.44 frystyk 143: #endif
2.1 timbl 144: #else
2.39 frystyk 145: #define WWWTRACE 0
2.44 frystyk 146: #define UTIL_TRACE 0
147: #define APP_TRACE 0
2.29 frystyk 148: #define CACHE_TRACE 0
2.20 frystyk 149: #define SGML_TRACE 0
2.29 frystyk 150: #define BIND_TRACE 0
2.27 frystyk 151: #define THD_TRACE 0
152: #define STREAM_TRACE 0
2.20 frystyk 153: #define PROT_TRACE 0
154: #define URI_TRACE 0
155: #define ANCH_TRACE 0
2.1 timbl 156: #endif
2.3 timbl 157: </PRE>
2.26 frystyk 158:
159: <H2>Standard C library for malloc() etc</H2>
160:
161: Replace memory allocation and free C RTL functions with VAXC$xxx_OPT
162: altrenatives for VAXC (but not DECC) on VMS. This makes a big
163: performance difference. (Foteos Macrides).
164:
165: <PRE>
166: #ifdef vax
167: #ifdef unix
168: #define ultrix /* Assume vax+unix=ultrix */
169: #endif
170: #endif
171:
172: #ifndef VMS
173: #ifndef ultrix
174: #ifdef NeXT
175: #include <libc.h> /* NeXT */
176: #endif
177:
178: #ifndef Mips
179: #ifndef MACH /* Vincent.Cate@furmint.nectar.cs.cmu.edu */
180: #include <stdlib.h> /* ANSI */
181: #endif
182: #endif
183:
184: #else /* ultrix */
185: #include <malloc.h>
186: #include <memory.h>
187: #include <stdio.h>
188: #include <stdlib.h> /* ANSI */ /* BSN */
189: #endif
190:
191: #else /* VMS */
192: #include <stdio.h>
193: #include <stdlib.h>
194: #include <unixlib.h>
195: #include <ctype.h>
196: #if defined(VAXC) && !defined(__DECC)
197: #define malloc VAXC$MALLOC_OPT
198: #define calloc VAXC$CALLOC_OPT
199: #define free VAXC$FREE_OPT
200: #define cfree VAXC$CFREE_OPT
201: #define realloc VAXC$REALLOC_OPT
202: #endif /* VAXC but not DECC */
203: #define unlink remove
204: #define gmtime localtime
205: #include <stat.h>
206: #define S_ISDIR(m) (((m)&S_IFMT) == S_IFDIR)
207: #define S_ISREG(m) (((m)&S_IFMT) == S_IFREG)
208: #define putenv HTVMS_putenv
209: #endif
210: </PRE>
211:
2.29 frystyk 212: <H3>Safe Cleaning Memory</H3>
213:
214: <PRE>
215: #define FREE(x) if (x) {free(x); x=NULL;}
216: </PRE>
217:
218: <A NAME="declaration"><H2>Macros for declarations</H2></A>
2.26 frystyk 219:
220: <PRE>
221: #define PUBLIC /* Accessible outside this module */
2.1 timbl 222: #define PRIVATE static /* Accessible only within this module */
223:
2.26 frystyk 224: #ifdef _STANDARD_CODE_
225:
2.49 ! frystyk 226: #if defined(sco) && !defined(_SCO_DS)
! 227: #define CONST /* The pre SCO 5.0 CC compiler does not know const */
2.26 frystyk 228: #else
2.49 ! frystyk 229: #define CONST const /* "const" only exists in STDC */
2.26 frystyk 230: #endif
231:
2.21 frystyk 232: #endif /* _STANDARD_CODE_ (ANSI) */
2.1 timbl 233:
234: #ifndef NULL
235: #define NULL ((void *)0)
236: #endif
2.26 frystyk 237: </PRE>
2.1 timbl 238:
2.3 timbl 239: <H2>Booleans</H2>
2.26 frystyk 240:
241: <PRE>
2.30 frystyk 242: #ifndef BOOLEAN_DEFINED
2.26 frystyk 243: typedef char BOOLEAN; /* Logical value */
2.30 frystyk 244: #endif
2.1 timbl 245:
246: #ifndef CURSES
247: #ifndef TRUE
248: #define TRUE (BOOLEAN)1
249: #define FALSE (BOOLEAN)0
250: #endif
2.3 timbl 251: #endif /* CURSES */
2.1 timbl 252:
253: #ifndef BOOL
254: #define BOOL BOOLEAN
255: #endif
256: #ifndef YES
2.14 timbl 257: #define YES (BOOL)1
258: #define NO (BOOL)0
2.1 timbl 259: #endif
260:
2.11 timbl 261: #ifndef HTMIN
262: #define HTMIN(a,b) ((a) <= (b) ? (a) : (b))
263: #define HTMAX(a,b) ((a) >= (b) ? (a) : (b))
2.1 timbl 264: #endif
2.26 frystyk 265: </PRE>
2.1 timbl 266:
2.35 frystyk 267: <A NAME="ReturnCodes"><H2>Return Codes for Protocol Modules and Streams</H2></A>
268:
269: Theese are the codes returned from the protocol modules, and the
270: stream modules. Success are (>=0) and failure are (<0)
2.1 timbl 271:
2.3 timbl 272: <PRE>
2.23 frystyk 273: #define HT_OK 0 /* Generic success */
2.37 frystyk 274: #define HT_ALL 1 /* Used by Net Manager */
275:
2.38 frystyk 276: #define HT_PERSISTENT 29995 /* Wait for persistent connection */
2.37 frystyk 277: #define HT_IGNORE 29996 /* Ignore this in the Net manager */
2.35 frystyk 278: #define HT_NO_DATA 29997 /* OK but no data was loaded */
279: #define HT_REDIRECTION_ON_FLY 29998 /* Redo the retrieve with a new URL */
2.44 frystyk 280: #define HT_REDIRECT 29998 /* Redo the retrieve with a new URL */
2.23 frystyk 281: #define HT_LOADED 29999 /* Instead of a socket */
282:
283: #define HT_ERROR -1 /* Generic failure */
284: #define HT_NO_ACCESS -10 /* Access not available */
285: #define HT_FORBIDDEN -11 /* Access forbidden */
286: #define HT_INTERNAL -12 /* Weird -- should never happen. */
2.35 frystyk 287:
288: #define HT_RETRY -29996 /* If service isn't available */
2.23 frystyk 289: #define HT_WOULD_BLOCK -29997 /* If we are in a select */
2.15 frystyk 290: #define HT_INTERRUPTED -29998 /* Note the negative value! */
2.35 frystyk 291: </PRE>
292:
293: The following codes are positive values that will be parsed back
294: through streams. This can be used to introduce stream specific return
295: values
2.1 timbl 296:
2.35 frystyk 297: <PRE>
298: #define HT_RELOAD 29996 /* If we must reload the document */
299: </PRE>
300:
301: <H2>Other stuff</H2>
302:
303: <PRE>
2.26 frystyk 304: #ifdef _STANDARD_CODE_
305: #include <stdarg.h>
306: #else
307: #include <varargs.h>
308: #endif
2.3 timbl 309: </PRE>
2.26 frystyk 310:
311: <H2>Out Of Memory checking for malloc() return:</H2>
312:
313: <PRE>
314: #ifndef __FILE__
2.1 timbl 315: #define __FILE__ ""
316: #define __LINE__ ""
317: #endif
318:
319: #define outofmem(file, func) \
2.26 frystyk 320: { fprintf(TDEST, "%s %s: out of memory.\nProgram aborted.\n", file, func); \
2.1 timbl 321: exit(1);}
322:
2.26 frystyk 323: </PRE>
2.1 timbl 324:
2.26 frystyk 325: <H2>Upper- and Lowercase macros</H2>
326:
327: The problem here is that toupper(x) is not defined officially unless
328: isupper(x) is. These macros are CERTAINLY needed on #if defined(pyr)
329: || define(mips) or BDSI platforms. For safefy, we make them mandatory.
2.1 timbl 330:
2.25 roeber 331: <PRE>
2.26 frystyk 332: #include <ctype.h>
2.1 timbl 333:
334: #ifndef TOLOWER
2.27 frystyk 335: #define TOLOWER(c) tolower(c)
336: #define TOUPPER(c) toupper(c)
2.29 frystyk 337: #endif
338: </PRE>
339:
340: <H2>Max and Min values for Integers and Floating Point</H2>
341:
342: <PRE>
343: #ifdef FLT_EPSILON /* The ANSI C way define */
344: #define HT_EPSILON FLT_EPSILON
345: #else
346: #define HT_EPSILON 0.00000001
2.27 frystyk 347: #endif
348: </PRE>
349:
350: <H2>White Characters</H2>
351:
352: Is character <B>c</B> white space?
353:
354: <PRE>
355: #ifdef OLD_CODE
356: #define WHITE(c) (((unsigned char)(TOASCII(c))) <= 32)
357: #else
358: #define WHITE(c) isspace(c)
359: #endif
2.26 frystyk 360: </PRE>
361:
362: <H2>The local equivalents of CR and LF</H2>
2.1 timbl 363:
2.26 frystyk 364: We can check for these after net ascii text has been converted to the
365: local representation. Similarly, we include them in strings to be sent
366: as net ascii after translation.
367:
368: <PRE>
369: #define LF FROMASCII('\012') /* ASCII line feed LOCAL EQUIVALENT */
370: #define CR FROMASCII('\015') /* Will be converted to ^M for transmission */
2.6 timbl 371:
2.1 timbl 372: #endif /* HTUTILS_H */
2.26 frystyk 373: </PRE>
2.1 timbl 374:
2.26 frystyk 375: end of utilities
376: </BODY>
2.6 timbl 377: </HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTUtils.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src