js/src/jsstaticcheck.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator client code, released
  17  * March 31, 1998.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1998
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef jsstaticcheck_h___
  41 #define jsstaticcheck_h___
  42
  43 #ifdef NS_STATIC_CHECKING
  44 /*
  45  * Trigger a control flow check to make sure that code flows through label
  46  */
  47 inline __attribute__ ((unused)) void MUST_FLOW_THROUGH(const char *label) {
  48 }
  49
  50 /* avoid unused goto-label warnings */
  51 #define MUST_FLOW_LABEL(label) goto label; label:
  52
  53 inline JS_FORCES_STACK void VOUCH_DOES_NOT_REQUIRE_STACK() {}
  54
  55 inline JS_FORCES_STACK void
  56 JS_ASSERT_NOT_ON_TRACE(JSContext *cx)
  57 {
  58     JS_ASSERT(!JS_ON_TRACE(cx));
  59 }
  60
  61 #else
  62 #define MUST_FLOW_THROUGH(label)            ((void) 0)
  63 #define MUST_FLOW_LABEL(label)
  64 #define VOUCH_DOES_NOT_REQUIRE_STACK()      ((void) 0)
  65 #define JS_ASSERT_NOT_ON_TRACE(cx)          JS_ASSERT(!JS_ON_TRACE(cx))
  66 #endif
  67 #define VOUCH_HAVE_STACK                    VOUCH_DOES_NOT_REQUIRE_STACK
  68
  69 /* sixgill annotation defines */
  70
  71 /* Avoid name collision if included with other headers defining annotations. */
  72 #ifndef HAVE_STATIC_ANNOTATIONS
  73 #define HAVE_STATIC_ANNOTATIONS
  74
  75 #ifdef XGILL_PLUGIN
  76
  77 #define STATIC_PRECONDITION(COND)         __attribute__((precondition(#COND)))
  78 #define STATIC_PRECONDITION_ASSUME(COND)  __attribute__((precondition_assume(#COND)))
  79 #define STATIC_POSTCONDITION(COND)        __attribute__((postcondition(#COND)))
  80 #define STATIC_POSTCONDITION_ASSUME(COND) __attribute__((postcondition_assume(#COND)))
  81 #define STATIC_INVARIANT(COND)            __attribute__((invariant(#COND)))
  82 #define STATIC_INVARIANT_ASSUME(COND)     __attribute__((invariant_assume(#COND)))
  83
  84 /* Used to make identifiers for assert/assume annotations in a function. */
  85 #define STATIC_PASTE2(X,Y) X ## Y
  86 #define STATIC_PASTE1(X,Y) STATIC_PASTE2(X,Y)
  87
  88 #define STATIC_ASSERT(COND)                          \
  89   JS_BEGIN_MACRO                                     \
  90     __attribute__((assert_static(#COND), unused))    \
  91     int STATIC_PASTE1(assert_static_, __COUNTER__);  \
  92   JS_END_MACRO
  93
  94 #define STATIC_ASSUME(COND)                          \
  95   JS_BEGIN_MACRO                                     \
  96     __attribute__((assume_static(#COND), unused))    \
  97     int STATIC_PASTE1(assume_static_, __COUNTER__);  \
  98   JS_END_MACRO
  99
 100 #define STATIC_ASSERT_RUNTIME(COND)                         \
 101   JS_BEGIN_MACRO                                            \
 102     __attribute__((assert_static_runtime(#COND), unused))   \
 103     int STATIC_PASTE1(assert_static_runtime_, __COUNTER__); \
 104   JS_END_MACRO
 105
 106 #else /* XGILL_PLUGIN */
 107
 108 #define STATIC_PRECONDITION(COND)          /* nothing */
 109 #define STATIC_PRECONDITION_ASSUME(COND)   /* nothing */
 110 #define STATIC_POSTCONDITION(COND)         /* nothing */
 111 #define STATIC_POSTCONDITION_ASSUME(COND)  /* nothing */
 112 #define STATIC_INVARIANT(COND)             /* nothing */
 113 #define STATIC_INVARIANT_ASSUME(COND)      /* nothing */
 114
 115 #define STATIC_ASSERT(COND)          JS_BEGIN_MACRO /* nothing */ JS_END_MACRO
 116 #define STATIC_ASSUME(COND)          JS_BEGIN_MACRO /* nothing */ JS_END_MACRO
 117 #define STATIC_ASSERT_RUNTIME(COND)  JS_BEGIN_MACRO /* nothing */ JS_END_MACRO
 118
 119 #endif /* XGILL_PLUGIN */
 120
 121 #define STATIC_SKIP_INFERENCE STATIC_INVARIANT(skip_inference())
 122
 123 #endif /* HAVE_STATIC_ANNOTATIONS */
 124
 125 #endif /* jsstaticcheck_h___ */