1 /* 2 * Copyright (c) 2017, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes macros for validating runtime conditions. 32 */ 33 34 #ifndef CODE_UTILS_H 35 #define CODE_UTILS_H 36 37 /** 38 * This checks for the specified condition, which is expected to 39 * commonly be true, and branches to the local label 'exit' if the 40 * condition is false. 41 * 42 * @param[in] aCondition A Boolean expression to be evaluated. 43 */ 44 #define otEXPECT(aCondition) \ 45 do \ 46 { \ 47 if (!(aCondition)) \ 48 { \ 49 goto exit; \ 50 } \ 51 } while (0) 52 53 /** 54 * This checks for the specified condition, which is expected to 55 * commonly be true, and both executes @p anAction and branches to 56 * the local label 'exit' if the condition is false. 57 * 58 * @param[in] aCondition A Boolean expression to be evaluated. 59 * @param[in] aAction An expression or block to execute when the 60 * assertion fails. 61 */ 62 #define otEXPECT_ACTION(aCondition, aAction) \ 63 do \ 64 { \ 65 if (!(aCondition)) \ 66 { \ 67 aAction; \ 68 goto exit; \ 69 } \ 70 } while (0) 71 72 /** 73 * Calculates the number of elements in an array. 74 * 75 * @param[in] aArray Name of the array variable. 76 * 77 * @returns Number of elements in the array. 78 */ 79 #define otARRAY_LENGTH(aArray) (sizeof(aArray) / sizeof(aArray[0])) 80 81 #endif // CODE_UTILS_H 82