annotate lib/verify.h @ 6329:ffad934ef3bd

* verify.h (verify_true): Provide alternative definition for C++.
author Paul Eggert <eggert@cs.ucla.edu>
date Wed, 05 Oct 2005 06:50:03 +0000
parents 71bde2024cdc
children a1a506584827
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
1 /* Compile-time assert-like macros.
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
3 Copyright (C) 2005 Free Software Foundation, Inc.
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
5 This program is free software; you can redistribute it and/or modify
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
7 the Free Software Foundation; either version 2, or (at your option)
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
8 any later version.
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 GNU General Public License for more details.
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
16 along with this program; if not, write to the Free Software Foundation,
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19 /* Written by Paul Eggert and Jim Meyering. */
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21 #ifndef VERIFY_H
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22 # define VERIFY_H 1
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23
6282
ad1b37bff099 Fix typo in comment.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6281
diff changeset
24 /* Each of these macros verifies that its argument R is a nonzero
ad1b37bff099 Fix typo in comment.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6281
diff changeset
25 constant expression. To be portable, R's type must be integer (or
6302
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
26 boolean). Unlike assert, there is no run-time overhead.
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27
6302
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
28 There are two macros, since no single macro can be used in all
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
29 contexts in C. verify_true (R) is for scalar contexts, where it
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
30 may be cast to void if need be. verify (R) is for declaration
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
31 contexts, e.g., the top level.
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32
6302
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
33 The symbols verify_error_if_negative_size__ and verify_function__
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
34 are private to this header. */
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
35
6302
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
36 /* Verify requirement R at compile-time, as an integer constant expression.
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
37 Return true. */
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
38
6329
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
39 # ifdef __cplusplus
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
40 template <int w>
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
41 struct verify_type__ { unsigned int verify_error_if_negative_size__: w; };
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
42 # define verify_true(R) \
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
43 (!!sizeof (verify_type__<(R) ? 1 : -1>))
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
44 # else
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
45 # define verify_true(R) \
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
46 (!!sizeof \
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
47 (struct { unsigned int verify_error_if_negative_size__: (R) ? 1 : -1; }))
ffad934ef3bd * verify.h (verify_true): Provide alternative definition for C++.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6302
diff changeset
48 # endif
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
49
6302
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
50 /* Verify requirement R at compile-time, as a declaration without a
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
51 trailing ';'. */
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
52
71bde2024cdc (verify_expr): Remove, replacing with:
Paul Eggert <eggert@cs.ucla.edu>
parents: 6290
diff changeset
53 # define verify(R) extern int (* verify_function__ (void)) [verify_true (R)]
6267
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54
58c87cabeb1c * modules/verify: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55 #endif