Remove some extraneous spaces after @items.
[kopensolaris-gnu/glibc.git] / manual / lang.texi
1 @node Language Features, Library Summary, System Configuration, Top
2 @appendix C Language Facilities in the Library
3
4 Some of the facilities implemented by the C library really should be
5 thought of as parts of the C language itself.  These facilities ought to
6 be documented in the C Language Manual, not in the library manual; but
7 since we don't have the language manual yet, and documentation for these
8 features has been written, we are publishing it here.
9
10 @menu
11 * Consistency Checking::        Using @code{assert} to abort if
12                                  something ``impossible'' happens.
13 * Variadic Functions::          Defining functions with varying numbers
14                                  of args. 
15 * Null Pointer Constant::       The macro @code{NULL}.
16 * Important Data Types::        Data types for object sizes.
17 * Data Type Measurements::      Parameters of data type representations.
18 @end menu
19
20 @node Consistency Checking
21 @section Explicitly Checking Internal Consistency
22 @cindex consistency checking
23 @cindex impossible events
24 @cindex assertions
25
26 When you're writing a program, it's often a good idea to put in checks
27 at strategic places for ``impossible'' errors or violations of basic
28 assumptions.  These checks are helpful in debugging problems due to
29 misunderstandings between different parts of the program.
30
31 @pindex assert.h
32 The @code{assert} macro, defined in the header file @file{assert.h},
33 provides a convenient way to abort the program while printing a message
34 about where in the program the error was detected.
35
36 @vindex NDEBUG
37 Once you think your program is debugged, you can disable the error
38 checks performed by the @code{assert} macro by recompiling with the
39 macro @code{NDEBUG} defined.  This means you don't actually have to
40 change the program source code to disable these checks.
41
42 But disabling these consistency checks is undesirable unless they make
43 the program significantly slower.  All else being equal, more error
44 checking is good no matter who is running the program.  A wise user
45 would rather have a program crash, visibly, than have it return nonsense
46 without indicating anything might be wrong.
47
48 @comment assert.h
49 @comment ANSI
50 @deftypefn Macro void assert (int @var{expression})
51 Verify the programmer's belief that @var{expression} should be nonzero
52 at this point in the program.
53
54 If @code{NDEBUG} is not defined, @code{assert} tests the value of
55 @var{expression}.  If it is false (zero), @code{assert} aborts the
56 program (@pxref{Aborting a Program}) after printing a message of the
57 form:
58
59 @smallexample
60 @file{@var{file}}:@var{linenum}: Assertion `@var{expression}' failed.
61 @end smallexample
62
63 @noindent
64 on the standard error stream @code{stderr} (@pxref{Standard Streams}).
65 The filename and line number are taken from the C preprocessor macros
66 @code{__FILE__} and @code{__LINE__} and specify where the call to
67 @code{assert} was written.
68
69 If the preprocessor macro @code{NDEBUG} is defined at the point where
70 @file{assert.h} is included, the @code{assert} macro is defined to do
71 absolutely nothing.
72
73 @strong{Warning:} Even the argument expression @var{expression} is not
74 evaluated if @code{NDEBUG} is in effect.  So never use @code{assert}
75 with arguments that involve side effects.  For example, @code{assert
76 (++i > 0);} is a bad idea, because @code{i} will not be incremented if
77 @code{NDEBUG} is defined.
78 @end deftypefn
79
80 @strong{Usage note:} The @code{assert} facility is designed for
81 detecting @emph{internal inconsistency}; it is not suitable for
82 reporting invalid input or improper usage by @emph{the user} of the
83 program.
84
85 The information in the diagnostic messages printed by the @code{assert}
86 macro is intended to help you, the programmer, track down the cause of a
87 bug, but is not really useful for telling a user of your program why his
88 or her input was invalid or why a command could not be carried out.  So
89 you can't use @code{assert} to print the error messages for these
90 eventualities.
91
92 What's more, your program should not abort when given invalid input, as
93 @code{assert} would do---it should exit with nonzero status (@pxref{Exit
94 Status}) after printing its error messages, or perhaps read another
95 command or move on to the next input file.
96
97 @xref{Error Messages}, for information on printing error messages for
98 problems that @emph{do not} represent bugs in the program.
99
100
101 @node Variadic Functions
102 @section Variadic Functions
103 @cindex variable number of arguments
104 @cindex variadic functions
105 @cindex optional arguments
106
107 ANSI C defines a syntax for declaring a function to take a variable
108 number or type of arguments.  (Such functions are referred to as
109 @dfn{varargs functions} or @dfn{variadic functions}.)  However, the
110 language itself provides no mechanism for such functions to access their
111 non-required arguments; instead, you use the variable arguments macros
112 defined in @file{stdarg.h}.
113
114 This section describes how to declare variadic functions, how to write
115 them, and how to call them properly.
116
117 @strong{Compatibility Note:} Many older C dialects provide a similar,
118 but incompatible, mechanism for defining functions with variable numbers
119 of arguments, using @file{varargs.h}.
120
121 @menu
122 * Why Variadic::                Reasons for making functions take
123                                  variable arguments. 
124 * How Variadic::                How to define and call variadic functions.
125 * Variadic Example::            A complete example.
126 @end menu
127
128 @node Why Variadic
129 @subsection Why Variadic Functions are Used
130
131 Ordinary C functions take a fixed number of arguments.  When you define
132 a function, you specify the data type for each argument.  Every call to
133 the function should supply the expected number of arguments, with types
134 that can be converted to the specified ones.  Thus, if the function
135 @samp{foo} is declared with @code{int foo (int, char *);} then you must
136 call it with two arguments, a number (any kind will do) and a string
137 pointer.
138
139 But some functions perform operations that can meaningfully accept an
140 unlimited number of arguments.
141
142 In some cases a function can handle any number of values by operating on
143 all of them as a block.  For example, consider a function that allocates
144 a one-dimensional array with @code{malloc} to hold a specified set of
145 values.  This operation makes sense for any number of values, as long as
146 the length of the array corresponds to that number.  Without facilities
147 for variable arguments, you would have to define a separate function for
148 each possible array size.
149
150 The library function @code{printf} (@pxref{Formatted Output}) is an
151 example of another class of function where variable arguments are
152 useful.  This function prints its arguments (which can vary in type as
153 well as number) under the control of a format template string.
154
155 These are good reasons to define a @dfn{variadic} function which can
156 handle as many arguments as the caller chooses to pass.
157
158 Some functions such as @code{open} take a fixed set of arguments, but
159 occasionally ignore the last few.  Strict adherence to ANSI C requires
160 these functions to be defined as variadic; in practice, however, the GNU
161 C compiler and most other C compilers let you define such a function to
162 take a fixed set of arguments---the most it can ever use---and then only
163 @emph{declare} the function as variadic (or not declare its arguments
164 at all!).
165
166 @node How Variadic
167 @subsection How Variadic Functions are Defined and Used
168
169 Defining and using a variadic function involves three steps:
170
171 @itemize @bullet
172 @item
173 @emph{Define} the function as variadic, using an ellipsis
174 (@samp{@dots{}}) in the argument list, and using special macros to
175 access the variable arguments.  @xref{Receiving Arguments}.
176
177 @item
178 @emph{Declare} the function as variadic, using a prototype with an
179 ellipsis (@samp{@dots{}}), in all the files which call it.
180 @xref{Variadic Prototypes}.
181
182 @item
183 @emph{Call} the function by writing the fixed arguments followed by the
184 additional variable arguments.  @xref{Calling Variadics}.
185 @end itemize
186
187 @menu
188 * Variadic Prototypes::  How to make a prototype for a function
189                           with variable arguments.
190 * Receiving Arguments::  Steps you must follow to access the
191                           optional argument values.
192 * How Many Arguments::   How to decide whether there are more arguments. 
193 * Calling Variadics::    Things you need to know about calling
194                           variable arguments functions.
195 * Argument Macros::      Detailed specification of the macros
196                           for accessing variable arguments.
197 * Old Varargs::          The pre-ANSI way of defining variadic functions.
198 @end menu
199
200 @node Variadic Prototypes
201 @subsubsection Syntax for Variable Arguments
202 @cindex function prototypes (variadic)
203 @cindex prototypes for variadic functions
204 @cindex variadic function prototypes
205
206 A function that accepts a variable number of arguments must be declared
207 with a prototype that says so.   You write the fixed arguments as usual,
208 and then tack on @samp{@dots{}} to indicate the possibility of 
209 additional arguments.  The syntax of ANSI C requires at least one fixed
210 argument before the @samp{@dots{}}.  For example,
211
212 @smallexample
213 int 
214 func (const char *a, int b, @dots{})
215 @{
216   @dots{}
217 @}      
218 @end smallexample
219
220 @noindent
221 outlines a definition of a function @code{func} which returns an
222 @code{int} and takes two required arguments, a @code{const char *} and
223 an @code{int}.  These are followed by any number of anonymous
224 arguments.
225
226 @strong{Portability note:} For some C compilers, the last required
227 argument must not be declared @code{register} in the function
228 definition.  Furthermore, this argument's type must be
229 @dfn{self-promoting}: that is, the default promotions must not change
230 its type.  This rules out array and function types, as well as
231 @code{float}, @code{char} (whether signed or not) and @w{@code{short int}}
232 (whether signed or not).  This is actually an ANSI C requirement.
233
234 @node Receiving Arguments
235 @subsubsection Receiving the Argument Values
236 @cindex variadic function argument access
237 @cindex arguments (variadic functions)
238
239 Ordinary fixed arguments have individual names, and you can use these
240 names to access their values.  But optional arguments have no
241 names---nothing but @samp{@dots{}}.  How can you access them?
242
243 @pindex stdarg.h
244 The only way to access them is sequentially, in the order they were
245 written, and you must use special macros from @file{stdarg.h} in the
246 following three step process:
247
248 @enumerate
249 @item
250 You initialize an argument pointer variable of type @code{va_list} using
251 @code{va_start}.  The argument pointer when initialized points to the
252 first optional argument.
253
254 @item
255 You access the optional arguments by successive calls to @code{va_arg}.
256 The first call to @code{va_arg} gives you the first optional argument,
257 the next call gives you the second, and so on.
258
259 You can stop at any time if you wish to ignore any remaining optional
260 arguments.  It is perfectly all right for a function to access fewer
261 arguments than were supplied in the call, but you will get garbage
262 values if you try to access too many arguments.
263
264 @item
265 You indicate that you are finished with the argument pointer variable by
266 calling @code{va_end}.
267
268 (In practice, with most C compilers, calling @code{va_end} does nothing
269 and you do not really need to call it.  This is always true in the GNU C
270 compiler.  But you might as well call @code{va_end} just in case your
271 program is someday compiled with a peculiar compiler.)
272 @end enumerate
273
274 @xref{Argument Macros}, for the full definitions of @code{va_start}, 
275 @code{va_arg} and @code{va_end}.
276
277 Steps 1 and 3 must be performed in the function that accepts the
278 optional arguments.  However, you can pass the @code{va_list} variable
279 as an argument to another function and perform all or part of step 2
280 there.
281
282 You can perform the entire sequence of the three steps multiple times
283 within a single function invocation.  If you want to ignore the optional
284 arguments, you can do these steps zero times.
285
286 You can have more than one argument pointer variable if you like.  You
287 can initialize each variable with @code{va_start} when you wish, and
288 then you can fetch arguments with each argument pointer as you wish.
289 Each argument pointer variable will sequence through the same set of
290 argument values, but at its own pace.
291
292 @strong{Portability note:} With some compilers, once you pass an
293 argument pointer value to a subroutine, you must not keep using the same
294 argument pointer value after that subroutine returns.  For full
295 portability, you should just pass it to @code{va_end}.  This is actually
296 an ANSI C requirement, but most ANSI C compilers work happily
297 regardless.
298
299 @node How Many Arguments
300 @subsubsection How Many Arguments Were Supplied
301 @cindex number of arguments passed
302 @cindex how many arguments
303 @cindex arguments, how many
304
305 There is no general way for a function to determine the number and type
306 of the optional arguments it was called with.  So whoever designs the
307 function typically designs a convention for the caller to tell it how
308 many arguments it has, and what kind.  It is up to you to define an
309 appropriate calling convention for each variadic function, and write all
310 calls accordingly.
311
312 One kind of calling convention is to pass the number of optional
313 arguments as one of the fixed arguments.  This convention works provided
314 all of the optional arguments are of the same type.
315
316 A similar alternative is to have one of the required arguments be a bit
317 mask, with a bit for each possible purpose for which an optional
318 argument might be supplied.  You would test the bits in a predefined
319 sequence; if the bit is set, fetch the value of the next argument,
320 otherwise use a default value.
321
322 A required argument can be used as a pattern to specify both the number
323 and types of the optional arguments.  The format string argument to
324 @code{printf} is one example of this (@pxref{Formatted Output Functions}).
325
326 Another possibility is to pass an ``end marker'' value as the last
327 optional argument.  For example, for a function that manipulates an
328 arbitrary number of pointer arguments, a null pointer might indicate the
329 end of the argument list.  (This assumes that a null pointer isn't
330 otherwise meaningful to the function.)  The @code{execl} function works
331 in just this way; see @ref{Executing a File}.
332
333
334 @node Calling Variadics
335 @subsubsection Calling Variadic Functions
336 @cindex variadic functions, calling
337 @cindex calling variadic functions
338 @cindex declaring variadic functions
339
340 You don't have to write anything special when you call a variadic function.
341 Just write the arguments (required arguments, followed by optional ones)
342 inside parentheses, separated by commas, as usual.  But you should prepare
343 by declaring the function with a prototype, and you must know how the
344 argument values are converted.
345
346 In principle, functions that are @emph{defined} to be variadic must also
347 be @emph{declared} to be variadic using a function prototype whenever
348 you call them.  (@xref{Variadic Prototypes}, for how.)  This is because
349 some C compilers use a different calling convention to pass the same set
350 of argument values to a function depending on whether that function
351 takes variable arguments or fixed arguments.
352
353 In practice, the GNU C compiler always passes a given set of argument
354 types in the same way regardless of whether they are optional or
355 required.  So, as long as the argument types are self-promoting, you can
356 safely omit declaring them.  Usually it is a good idea to declare the
357 argument types for variadic functions, and indeed for all functions.
358 But there are a few functions which it is extremely convenient not to
359 have to declare as variadic---for example, @code{open} and
360 @code{printf}.
361
362 @cindex default argument promotions
363 @cindex argument promotion
364 Since the prototype doesn't specify types for optional arguments, in a
365 call to a variadic function the @dfn{default argument promotions} are
366 performed on the optional argument values.  This means the objects of
367 type @code{char} or @w{@code{short int}} (whether signed or not) are
368 promoted to either @code{int} or @w{@code{unsigned int}}, as
369 appropriate; and that objects of type @code{float} are promoted to type
370 @code{double}.  So, if the caller passes a @code{char} as an optional
371 argument, it is promoted to an @code{int}, and the function should get
372 it with @code{va_arg (@var{ap}, int)}.
373
374 Conversion of the required arguments is controlled by the function
375 prototype in the usual way: the argument expression is converted to the
376 declared argument type as if it were being assigned to a variable of
377 that type.
378
379 @node Argument Macros
380 @subsubsection Argument Access Macros
381
382 Here are descriptions of the macros used to retrieve variable arguments.
383 These macros are defined in the header file @file{stdarg.h}.
384 @pindex stdarg.h
385
386 @comment stdarg.h
387 @comment ANSI
388 @deftp {Data Type} va_list
389 The type @code{va_list} is used for argument pointer variables.
390 @end deftp
391
392 @comment stdarg.h
393 @comment ANSI
394 @deftypefn {Macro} void va_start (va_list @var{ap}, @var{last_required})
395 This macro initializes the argument pointer variable @var{ap} to point
396 to the first of the optional arguments of the current function;
397 @var{last_required} must be the last required argument to the function.
398
399 @xref{Old Varargs}, for an alternate definition of @code{va_start}
400 found in the header file @file{varargs.h}.
401 @end deftypefn
402
403 @comment stdarg.h
404 @comment ANSI
405 @deftypefn {Macro} @var{type} va_arg (va_list @var{ap}, @var{type})
406 The @code{va_arg} macro returns the value of the next optional argument,
407 and modifies the value of @var{ap} to point to the subsequent argument.
408 Thus, successive uses of @code{va_arg} return successive optional 
409 arguments.
410
411 The type of the value returned by @code{va_arg} is @var{type} as
412 specified in the call.  @var{type} must be a self-promoting type (not
413 @code{char} or @code{short int} or @code{float}) that matches the type
414 of the actual argument.
415 @end deftypefn
416
417 @comment stdarg.h
418 @comment ANSI
419 @deftypefn {Macro} void va_end (va_list @var{ap})
420 This ends the use of @var{ap}.  After a @code{va_end} call, further
421 @code{va_arg} calls with the same @var{ap} may not work.  You should invoke
422 @code{va_end} before returning from the function in which @code{va_start}
423 was invoked with the same @var{ap} argument.
424
425 In the GNU C library, @code{va_end} does nothing, and you need not ever
426 use it except for reasons of portability.
427 @refill
428 @end deftypefn
429
430 @node Variadic Example
431 @subsection Example of a Variadic Function
432
433 Here is a complete sample function that accepts a variable number of
434 arguments.  The first argument to the function is the count of remaining
435 arguments, which are added up and the result returned.  While trivial,
436 this function is sufficient to illustrate how to use the variable
437 arguments facility.
438
439 @comment Yes, this example has been tested.
440 @smallexample
441 @include add.c.texi
442 @end smallexample
443
444 @node Old Varargs
445 @subsubsection Old-Style Variadic Functions
446
447 @pindex varargs.h
448 Before ANSI C, programmers used a slightly different facility for
449 writing variadic functions.  The GNU C compiler still supports it;
450 currently, it is more portable than the ANSI C facility, since support
451 for ANSI C is still not universal.  The header file which defines the
452 old-fashioned variadic facility is called @file{varargs.h}.
453
454 Using @file{varargs.h} is almost the same as using @file{stdarg.h}.
455 There is no difference in how you call a variadic function;
456 @xref{Calling Variadics}.  The only difference is in how you define
457 them.  First of all, you must use old-style non-prototype syntax, like
458 this:
459
460 @smallexample
461 tree
462 build (va_alist)
463      va_dcl
464 @{
465 @end smallexample
466
467 Secondly, you must give @code{va_start} just one argument, like this:
468
469 @smallexample
470   va_list p;
471   va_start (p);
472 @end smallexample
473
474 These are the special macros used for defining old-style variadic
475 functions:
476
477 @comment varargs.h
478 @comment Unix
479 @deffn Macro va_alist
480 This macro stands for the argument name list required in a variadic
481 function.  
482 @end deffn
483
484 @comment varargs.h
485 @comment Unix
486 @deffn Macro va_dcl
487 This macro declares the implicit argument or arguments for a variadic
488 function.
489 @end deffn
490
491 @comment varargs.h
492 @comment Unix
493 @deftypefn {Macro} void va_start (va_list @var{ap})
494 This macro, as defined in @file{varargs.h}, initializes the argument
495 pointer variable @var{ap} to point to the first argument of the current
496 function.
497 @end deftypefn
498
499 The other argument macros, @code{va_arg} and @code{va_end}, are the same
500 in @file{varargs.h} as in @file{stdarg.h}; see @ref{Argument Macros} for
501 details.
502
503 It does not work to include both @file{varargs.h} and @file{stdarg.h} in
504 the same compilation; they define @code{va_start} in conflicting ways.
505
506 @node Null Pointer Constant
507 @section Null Pointer Constant
508 @cindex null pointer constant
509
510 The null pointer constant is guaranteed not to point to any real object.
511 You can assign it to any pointer variable since it has type @code{void
512 *}.  The preferred way to write a null pointer constant is with
513 @code{NULL}.
514
515 @comment stddef.h
516 @comment ANSI
517 @deftypevr Macro {void *} NULL
518 This is a null pointer constant.
519 @end deftypevr
520
521 You can also use @code{0} or @code{(void *)0} as a null pointer
522 constant, but using @code{NULL} is cleaner because it makes the purpose
523 of the constant more evident.
524
525 If you use the null pointer constant as a function argument, then for
526 complete portability you should make sure that the function has a
527 prototype declaration.  Otherwise, if the target machine has two
528 different pointer representations, the compiler won't know which
529 representation to use for that argument.  You can avoid the problem by
530 explicitly casting the constant to the proper pointer type, but we
531 recommend instead adding a prototype for the function you are calling.
532
533 @node Important Data Types
534 @section Important Data Types
535
536 The result of subtracting two pointers in C is always an integer, but the
537 precise data type varies from C compiler to C compiler.  Likewise, the
538 data type of the result of @code{sizeof} also varies between compilers.
539 ANSI defines standard aliases for these two types, so you can refer to
540 them in a portable fashion.  They are defined in the header file 
541 @file{stddef.h}.
542 @pindex stddef.h
543
544 @comment stddef.h
545 @comment ANSI
546 @deftp {Data Type} ptrdiff_t
547 This is the signed integer type of the result of subtracting two
548 pointers.  For example, with the declaration @code{char *p1, *p2;}, the
549 expression @code{p2 - p1} is of type @code{ptrdiff_t}.  This will
550 probably be one of the standard signed integer types (@w{@code{short
551 int}}, @code{int} or @w{@code{long int}}), but might be a nonstandard
552 type that exists only for this purpose.
553 @end deftp
554
555 @comment stddef.h
556 @comment ANSI
557 @deftp {Data Type} size_t
558 This is an unsigned integer type used to represent the sizes of objects.
559 The result of the @code{sizeof} operator is of this type, and functions
560 such as @code{malloc} (@pxref{Unconstrained Allocation}) and
561 @code{memcpy} (@pxref{Copying and Concatenation}) accept arguments of
562 this type to specify object sizes.
563
564 @strong{Usage Note:} @code{size_t} is the preferred way to declare any
565 arguments or variables that hold the size of an object.
566 @end deftp
567
568 In the GNU system @code{size_t} is equivalent to either
569 @w{@code{unsigned int}} or @w{@code{unsigned long int}}.  These types
570 have identical properties on the GNU system, and for most purposes, you
571 can use them interchangeably.  However, they are distinct as data types,
572 which makes a difference in certain contexts.
573
574 For example, when you specify the type of a function argument in a
575 function prototype, it makes a difference which one you use.  If the
576 system header files declare @code{malloc} with an argument of type
577 @code{size_t} and you declare @code{malloc} with an argument of type
578 @code{unsigned int}, you will get a compilation error if @code{size_t}
579 happens to be @code{unsigned long int} on your system.  To avoid any
580 possibility of error, when a function argument or value is supposed to
581 have type @code{size_t}, never declare its type in any other way.
582
583 @strong{Compatibility Note:} Implementations of C before the advent of
584 ANSI C generally used @code{unsigned int} for representing object sizes
585 and @code{int} for pointer subtraction results.  They did not
586 necessarily define either @code{size_t} or @code{ptrdiff_t}.  Unix
587 systems did define @code{size_t}, in @file{sys/types.h}, but the
588 definition was usually a signed type.
589
590 @node Data Type Measurements
591 @section Data Type Measurements
592
593 Most of the time, if you choose the proper C data type for each object
594 in your program, you need not be concerned with just how it is
595 represented or how many bits it uses.  When you do need such
596 information, the C language itself does not provide a way to get it.
597 The header files @file{limits.h} and @file{float.h} contain macros
598 which give you this information in full detail.
599
600 @menu
601 * Width of Type::           How many bits does an integer type hold?
602 * Range of Type::           What are the largest and smallest values
603                              that an integer type can hold?
604 * Floating Type Macros::    Parameters that measure the floating point types. 
605 * Structure Measurement::   Getting measurements on structure types.
606 @end menu
607
608 @node Width of Type
609 @subsection Computing the Width of an Integer Data Type
610 @cindex integer type width
611 @cindex width of integer type
612 @cindex type measurements, integer
613
614 The most common reason that a program needs to know how many bits are in
615 an integer type is for using an array of @code{long int} as a bit vector.
616 You can access the bit at index @var{n} with
617
618 @smallexample
619 vector[@var{n} / LONGBITS] & (1 << (@var{n} % LONGBITS))
620 @end smallexample
621
622 @noindent
623 provided you define @code{LONGBITS} as the number of bits in a
624 @code{long int}.
625
626 @pindex limits.h
627 There is no operator in the C language that can give you the number of
628 bits in an integer data type.  But you can compute it from the macro
629 @code{CHAR_BIT}, defined in the header file @file{limits.h}.
630
631 @table @code
632 @comment limits.h
633 @comment ANSI
634 @item CHAR_BIT
635 This is the number of bits in a @code{char}---eight, on most systems.
636 The value has type @code{int}.
637
638 You can compute the number of bits in any data type @var{type} like
639 this:
640
641 @smallexample
642 sizeof (@var{type}) * CHAR_BIT
643 @end smallexample
644 @end table
645
646 @node Range of Type
647 @subsection Range of an Integer Type
648 @cindex integer type range
649 @cindex range of integer type
650 @cindex limits, integer types
651
652 Suppose you need to store an integer value which can range from zero to
653 one million.  Which is the smallest type you can use?  There is no
654 general rule; it depends on the C compiler and target machine.  You can
655 use the @samp{MIN} and @samp{MAX} macros in @file{limits.h} to determine
656 which type will work.
657
658 Each signed integer type has a pair of macros which give the smallest
659 and largest values that it can hold.  Each unsigned integer type has one
660 such macro, for the maximum value; the minimum value is, of course,
661 zero.
662
663 The values of these macros are all integer constant expressions.  The
664 @samp{MAX} and @samp{MIN} macros for @code{char} and @w{@code{short
665 int}} types have values of type @code{int}.  The @samp{MAX} and
666 @samp{MIN} macros for the other types have values of the same type
667 described by the macro---thus, @code{ULONG_MAX} has type
668 @w{@code{unsigned long int}}.
669
670 @comment Extra blank lines make it look better.
671 @table @code
672 @comment limits.h
673 @comment ANSI
674 @item SCHAR_MIN
675 This is the minimum value that can be represented by a @w{@code{signed char}}.
676
677 @comment limits.h
678 @comment ANSI
679 @item SCHAR_MAX
680 @comment limits.h
681 @comment ANSI
682 @itemx UCHAR_MAX
683 These are the maximum values that can be represented by a
684 @w{@code{signed char}} and @w{@code{unsigned char}}, respectively.
685
686 @comment limits.h
687 @comment ANSI
688 @item CHAR_MIN
689 This is the minimum value that can be represented by a @code{char}.
690 It's equal to @code{SCHAR_MIN} if @code{char} is signed, or zero
691 otherwise.
692
693 @comment limits.h
694 @comment ANSI
695 @item CHAR_MAX
696 This is the maximum value that can be represented by a @code{char}.
697 It's equal to @code{SCHAR_MAX} if @code{char} is signed, or
698 @code{UCHAR_MAX} otherwise.
699
700 @comment limits.h
701 @comment ANSI
702 @item SHRT_MIN
703 This is the minimum value that can be represented by a @w{@code{signed
704 short int}}.  On most machines that the GNU C library runs on,
705 @code{short} integers are 16-bit quantities.
706
707 @comment limits.h
708 @comment ANSI
709 @item SHRT_MAX
710 @comment limits.h
711 @comment ANSI
712 @itemx USHRT_MAX
713 These are the maximum values that can be represented by a
714 @w{@code{signed short int}} and @w{@code{unsigned short int}},
715 respectively.
716
717 @comment limits.h
718 @comment ANSI
719 @item INT_MIN
720 This is the minimum value that can be represented by a @w{@code{signed
721 int}}.  On most machines that the GNU C system runs on, an @code{int} is
722 a 32-bit quantity.
723
724 @comment limits.h
725 @comment ANSI
726 @item INT_MAX
727 @comment limits.h
728 @comment ANSI
729 @itemx UINT_MAX
730 These are the maximum values that can be represented by, respectively,
731 the type @w{@code{signed int}} and the type @w{@code{unsigned int}}.
732
733 @comment limits.h
734 @comment ANSI
735 @item LONG_MIN
736 This is the minimum value that can be represented by a @w{@code{signed
737 long int}}.  On most machines that the GNU C system runs on, @code{long}
738 integers are 32-bit quantities, the same size as @code{int}.
739
740 @comment limits.h
741 @comment ANSI
742 @item LONG_MAX
743 @comment limits.h
744 @comment ANSI
745 @itemx ULONG_MAX
746 These are the maximum values that can be represented by a
747 @w{@code{signed long int}} and @code{unsigned long int}, respectively.
748
749 @comment limits.h
750 @comment GNU
751 @item LONG_LONG_MIN
752 This is the minimum value that can be represented by a @w{@code{signed
753 long long int}}.  On most machines that the GNU C system runs on,
754 @w{@code{long long}} integers are 64-bit quantities.
755
756 @comment limits.h
757 @comment GNU
758 @item LONG_LONG_MAX
759 @comment limits.h
760 @comment ANSI
761 @itemx ULONG_LONG_MAX
762 These are the maximum values that can be represented by a @code{signed
763 long long int} and @code{unsigned long long int}, respectively.
764
765 @comment limits.h
766 @comment GNU
767 @item WCHAR_MAX
768 This is the maximum value that can be represented by a @code{wchar_t}.
769 @xref{Wide Char Intro}.
770 @end table
771
772 The header file @file{limits.h} also defines some additional constants
773 that parameterize various operating system and file system limits.  These
774 constants are described in @ref{System Configuration}.
775
776 @node Floating Type Macros
777 @subsection Floating Type Macros
778 @cindex floating type measurements
779 @cindex measurements of floating types
780 @cindex type measurements, floating
781 @cindex limits, floating types
782
783 The specific representation of floating point numbers varies from
784 machine to machine.  Because floating point numbers are represented
785 internally as approximate quantities, algorithms for manipulating
786 floating point data often need to take account of the precise details of
787 the machine's floating point representation.
788
789 Some of the functions in the C library itself need this information; for
790 example, the algorithms for printing and reading floating point numbers
791 (@pxref{I/O on Streams}) and for calculating trigonometric and
792 irrational functions (@pxref{Mathematics}) use it to avoid round-off
793 error and loss of accuracy.  User programs that implement numerical
794 analysis techniques also often need this information in order to
795 minimize or compute error bounds.
796
797 The header file @file{float.h} describes the format used by your
798 machine.
799
800 @menu
801 * Floating Point Concepts::     Definitions of terminology.
802 * Floating Point Parameters::   Details of specific macros.
803 * IEEE Floating Point::         The measurements for one common
804                                  representation. 
805 @end menu
806
807 @node Floating Point Concepts
808 @subsubsection Floating Point Representation Concepts
809
810 This section introduces the terminology for describing floating point
811 representations.
812
813 You are probably already familiar with most of these concepts in terms
814 of scientific or exponential notation for floating point numbers.  For
815 example, the number @code{123456.0} could be expressed in exponential
816 notation as @code{1.23456e+05}, a shorthand notation indicating that the
817 mantissa @code{1.23456} is multiplied by the base @code{10} raised to
818 power @code{5}.
819
820 More formally, the internal representation of a floating point number
821 can be characterized in terms of the following parameters:
822
823 @itemize @bullet
824 @item
825 @cindex sign (of floating point number)
826 The @dfn{sign} is either @code{-1} or @code{1}.
827
828 @item
829 @cindex base (of floating point number)
830 @cindex radix (of floating point number)
831 The @dfn{base} or @dfn{radix} for exponentiation, an integer greater
832 than @code{1}.  This is a constant for a particular representation.
833
834 @item
835 @cindex exponent (of floating point number)
836 The @dfn{exponent} to which the base is raised.  The upper and lower
837 bounds of the exponent value are constants for a particular
838 representation.
839
840 @cindex bias (of floating point number exponent)
841 Sometimes, in the actual bits representing the floating point number,
842 the exponent is @dfn{biased} by adding a constant to it, to make it
843 always be represented as an unsigned quantity.  This is only important
844 if you have some reason to pick apart the bit fields making up the
845 floating point number by hand, which is something for which the GNU
846 library provides no support.  So this is ignored in the discussion that
847 follows.
848
849 @item
850 @cindex mantissa (of floating point number)
851 @cindex significand (of floating point number)
852 The @dfn{mantissa} or @dfn{significand}, an unsigned integer which is a
853 part of each floating point number.
854
855 @item 
856 @cindex precision (of floating point number)
857 The @dfn{precision} of the mantissa.  If the base of the representation
858 is @var{b}, then the precision is the number of base-@var{b} digits in
859 the mantissa.  This is a constant for a particular representation.
860
861 @cindex hidden bit (of floating point number mantissa)
862 Many floating point representations have an implicit @dfn{hidden bit} in
863 the mantissa.  This is a bit which is present virtually in the mantissa,
864 but not stored in memory because its value is always 1 in a normalized
865 number.  The precision figure (see above) includes any hidden bits.
866
867 Again, the GNU library provides no facilities for dealing with such
868 low-level aspects of the representation.
869 @end itemize
870
871 The mantissa of a floating point number actually represents an implicit
872 fraction whose denominator is the base raised to the power of the
873 precision.  Since the largest representable mantissa is one less than
874 this denominator, the value of the fraction is always strictly less than
875 @code{1}.  The mathematical value of a floating point number is then the
876 product of this fraction, the sign, and the base raised to the exponent.
877
878 @cindex normalized floating point number
879 We say that the floating point number is @dfn{normalized} if the
880 fraction is at least @code{1/@var{b}}, where @var{b} is the base.  In
881 other words, the mantissa would be too large to fit if it were
882 multiplied by the base.  Non-normalized numbers are sometimes called
883 @dfn{denormal}; they contain less precision than the representation
884 normally can hold.
885
886 If the number is not normalized, then you can subtract @code{1} from the
887 exponent while multiplying the mantissa by the base, and get another
888 floating point number with the same value.  @dfn{Normalization} consists
889 of doing this repeatedly until the number is normalized.  Two distinct
890 normalized floating point numbers cannot be equal in value.
891
892 (There is an exception to this rule: if the mantissa is zero, it is
893 considered normalized.  Another exception happens on certain machines
894 where the exponent is as small as the representation can hold.  Then
895 it is impossible to subtract @code{1} from the exponent, so a number
896 may be normalized even if its fraction is less than @code{1/@var{b}}.)
897
898 @node Floating Point Parameters
899 @subsubsection Floating Point Parameters
900
901 @pindex float.h
902 These macro definitions can be accessed by including the header file
903 @file{float.h} in your program.
904
905 Macro names starting with @samp{FLT_} refer to the @code{float} type,
906 while names beginning with @samp{DBL_} refer to the @code{double} type
907 and names beginning with @samp{LDBL_} refer to the @code{long double}
908 type.  (Currently GCC does not support @code{long double} as a distinct
909 data type, so the values for the @samp{LDBL_} constants are equal to the
910 corresponding constants for the @code{double} type.)@refill
911
912 Of these macros, only @code{FLT_RADIX} is guaranteed to be a constant
913 expression.  The other macros listed here cannot be reliably used in
914 places that require constant expressions, such as @samp{#if}
915 preprocessing directives or in the dimensions of static arrays.
916
917 Although the ANSI C standard specifies minimum and maximum values for
918 most of these parameters, the GNU C implementation uses whatever values
919 describe the floating point representation of the target machine.  So in
920 principle GNU C actually satisfies the ANSI C requirements only if the
921 target machine is suitable.  In practice, all the machines currently
922 supported are suitable.
923
924 @table @code
925 @comment float.h
926 @comment ANSI
927 @item FLT_ROUNDS
928 This value characterizes the rounding mode for floating point addition.
929 The following values indicate standard rounding modes:
930
931 @need 750
932
933 @table @code
934 @item -1
935 The mode is indeterminable.
936 @item 0
937 Rounding is towards zero.
938 @item 1
939 Rounding is to the nearest number.
940 @item 2
941 Rounding is towards positive infinity.
942 @item 3
943 Rounding is towards negative infinity.
944 @end table
945
946 @noindent
947 Any other value represents a machine-dependent nonstandard rounding
948 mode.
949
950 On most machines, the value is @code{1}, in accordance with the IEEE
951 standard for floating point.
952
953 Here is a table showing how certain values round for each possible value
954 of @code{FLT_ROUNDS}, if the other aspects of the representation match
955 the IEEE single-precision standard.
956
957 @smallexample
958                 0      1             2             3
959  1.00000003    1.0    1.0           1.00000012    1.0
960  1.00000007    1.0    1.00000012    1.00000012    1.0
961 -1.00000003   -1.0   -1.0          -1.0          -1.00000012
962 -1.00000007   -1.0   -1.00000012   -1.0          -1.00000012
963 @end smallexample
964
965 @comment float.h
966 @comment ANSI
967 @item FLT_RADIX
968 This is the value of the base, or radix, of exponent representation.
969 This is guaranteed to be a constant expression, unlike the other macros
970 described in this section.  The value is 2 on all machines we know of
971 except the IBM 360 and derivatives.
972
973 @comment float.h
974 @comment ANSI
975 @item FLT_MANT_DIG
976 This is the number of base-@code{FLT_RADIX} digits in the floating point
977 mantissa for the @code{float} data type.  The following expression
978 yields @code{1.0} (even though mathematically it should not) due to the
979 limited number of mantissa digits:
980
981 @smallexample
982 float radix = FLT_RADIX;
983
984 1.0f + 1.0f / radix / radix / @dots{} / radix
985 @end smallexample
986
987 @noindent
988 where @code{radix} appears @code{FLT_MANT_DIG} times.
989
990 @comment float.h
991 @comment ANSI
992 @item DBL_MANT_DIG
993 @itemx LDBL_MANT_DIG
994 This is the number of base-@code{FLT_RADIX} digits in the floating point
995 mantissa for the data types @code{double} and @code{long double},
996 respectively.
997
998 @comment Extra blank lines make it look better.
999 @comment float.h
1000 @comment ANSI
1001 @item FLT_DIG
1002 This is the number of decimal digits of precision for the @code{float}
1003 data type.  Technically, if @var{p} and @var{b} are the precision and
1004 base (respectively) for the representation, then the decimal precision
1005 @var{q} is the maximum number of decimal digits such that any floating
1006 point number with @var{q} base 10 digits can be rounded to a floating
1007 point number with @var{p} base @var{b} digits and back again, without
1008 change to the @var{q} decimal digits.
1009
1010 The value of this macro is supposed to be at least @code{6}, to satisfy
1011 ANSI C.
1012
1013 @comment float.h
1014 @comment ANSI
1015 @item DBL_DIG
1016 @itemx LDBL_DIG
1017 These are similar to @code{FLT_DIG}, but for the data types
1018 @code{double} and @code{long double}, respectively.  The values of these
1019 macros are supposed to be at least @code{10}.
1020
1021 @comment float.h
1022 @comment ANSI
1023 @item FLT_MIN_EXP
1024 This is the smallest possible exponent value for type @code{float}.
1025 More precisely, is the minimum negative integer such that the value
1026 @code{FLT_RADIX} raised to this power minus 1 can be represented as a
1027 normalized floating point number of type @code{float}.
1028
1029 @comment float.h
1030 @comment ANSI
1031 @item DBL_MIN_EXP
1032 @itemx LDBL_MIN_EXP
1033 These are similar to @code{FLT_MIN_EXP}, but for the data types
1034 @code{double} and @code{long double}, respectively.
1035
1036 @comment float.h
1037 @comment ANSI
1038 @item FLT_MIN_10_EXP
1039 This is the minimum negative integer such that @code{10} raised to this
1040 power minus 1 can be represented as a normalized floating point number
1041 of type @code{float}.  This is supposed to be @code{-37} or even less.
1042
1043 @comment float.h
1044 @comment ANSI
1045 @item DBL_MIN_10_EXP
1046 @itemx LDBL_MIN_10_EXP
1047 These are similar to @code{FLT_MIN_10_EXP}, but for the data types
1048 @code{double} and @code{long double}, respectively.
1049
1050 @comment float.h
1051 @comment ANSI
1052 @item FLT_MAX_EXP
1053 This is the largest possible exponent value for type @code{float}.  More
1054 precisely, this is the maximum positive integer such that value
1055 @code{FLT_RADIX} raised to this power minus 1 can be represented as a
1056 floating point number of type @code{float}.
1057
1058 @comment float.h
1059 @comment ANSI
1060 @item DBL_MAX_EXP
1061 @itemx LDBL_MAX_EXP
1062 These are similar to @code{FLT_MAX_EXP}, but for the data types
1063 @code{double} and @code{long double}, respectively.
1064
1065 @comment float.h
1066 @comment ANSI
1067 @item FLT_MAX_10_EXP
1068 This is the maximum positive integer such that @code{10} raised to this
1069 power minus 1 can be represented as a normalized floating point number
1070 of type @code{float}.  This is supposed to be at least @code{37}.
1071
1072 @comment float.h
1073 @comment ANSI
1074 @item DBL_MAX_10_EXP
1075 @itemx LDBL_MAX_10_EXP
1076 These are similar to @code{FLT_MAX_10_EXP}, but for the data types
1077 @code{double} and @code{long double}, respectively.
1078
1079 @comment float.h
1080 @comment ANSI
1081 @item FLT_MAX
1082 The value of this macro is the maximum number representable in type
1083 @code{float}.  It is supposed to be at least @code{1E+37}.  The value
1084 has type @code{float}.
1085
1086 The smallest representable number is @code{- FLT_MAX}.
1087
1088 @comment float.h
1089 @comment ANSI
1090 @item DBL_MAX
1091 @itemx LDBL_MAX
1092 These are similar to @code{FLT_MAX}, but for the data types
1093 @code{double} and @code{long double}, respectively.  The type of the
1094 macro's value is the same as the type it describes.
1095
1096 @comment float.h
1097 @comment ANSI
1098 @item FLT_MIN
1099 The value of this macro is the minimum normalized positive floating
1100 point number that is representable in type @code{float}.  It is supposed
1101 to be no more than @code{1E-37}.
1102
1103 @comment float.h
1104 @comment ANSI
1105 @item DBL_MIN
1106 @itemx LDBL_MIN
1107 These are similar to @code{FLT_MIN}, but for the data types
1108 @code{double} and @code{long double}, respectively.  The type of the
1109 macro's value is the same as the type it describes.
1110
1111 @comment float.h
1112 @comment ANSI
1113 @item FLT_EPSILON
1114 This is the minimum positive floating point number of type @code{float}
1115 such that @code{1.0 + FLT_EPSILON != 1.0} is true.  It's supposed to
1116 be no greater than @code{1E-5}.
1117
1118 @comment float.h
1119 @comment ANSI
1120 @item DBL_EPSILON
1121 @itemx LDBL_EPSILON
1122 These are similar to @code{FLT_EPSILON}, but for the data types
1123 @code{double} and @code{long double}, respectively.  The type of the
1124 macro's value is the same as the type it describes.  The values are not
1125 supposed to be greater than @code{1E-9}.
1126 @end table
1127
1128 @node IEEE Floating Point
1129 @subsubsection IEEE Floating Point
1130 @cindex IEEE floating point representation 
1131 @cindex floating point, IEEE
1132
1133 Here is an example showing how the floating type measurements come out
1134 for the most common floating point representation, specified by the
1135 @cite{IEEE Standard for Binary Floating Point Arithmetic (ANSI/IEEE Std
1136 754-1985)}.  Nearly all computers designed since the 1980s use this
1137 format.
1138
1139 The IEEE single-precision float representation uses a base of 2.  There
1140 is a sign bit, a mantissa with 23 bits plus one hidden bit (so the total
1141 precision is 24 base-2 digits), and an 8-bit exponent that can represent
1142 values in the range -125 to 128, inclusive.
1143
1144 So, for an implementation that uses this representation for the
1145 @code{float} data type, appropriate values for the corresponding
1146 parameters are:
1147
1148 @smallexample
1149 FLT_RADIX                             2
1150 FLT_MANT_DIG                         24
1151 FLT_DIG                               6
1152 FLT_MIN_EXP                        -125
1153 FLT_MIN_10_EXP                      -37
1154 FLT_MAX_EXP                         128
1155 FLT_MAX_10_EXP                      +38
1156 FLT_MIN                 1.17549435E-38F
1157 FLT_MAX                 3.40282347E+38F
1158 FLT_EPSILON             1.19209290E-07F
1159 @end smallexample
1160
1161 Here are the values for the @code{double} data type:
1162
1163 @smallexample
1164 DBL_MANT_DIG                         53
1165 DBL_DIG                              15
1166 DBL_MIN_EXP                       -1021
1167 DBL_MIN_10_EXP                     -307
1168 DBL_MAX_EXP                        1024
1169 DBL_MAX_10_EXP                      308
1170 DBL_MAX         1.7976931348623157E+308
1171 DBL_MIN         2.2250738585072014E-308
1172 DBL_EPSILON     2.2204460492503131E-016
1173 @end smallexample
1174
1175 @node Structure Measurement
1176 @subsection Structure Field Offset Measurement
1177
1178 You can use @code{offsetof} to measure the location within a structure
1179 type of a particular structure member.
1180
1181 @comment stddef.h
1182 @comment ANSI
1183 @deftypefn {Macro} size_t offsetof (@var{type}, @var{member})
1184 This expands to a integer constant expression that is the offset of the
1185 structure member named @var{member} in a the structure type @var{type}.
1186 For example, @code{offsetof (struct s, elem)} is the offset, in bytes,
1187 of the member @code{elem} in a @code{struct s}.
1188
1189 This macro won't work if @var{member} is a bit field; you get an error
1190 from the C compiler in that case.
1191 @end deftypefn