/* * Copyright (c) 2017, The OpenThread Authors. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the copyright holder nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ /** * @file * This file includes macros for validating runtime conditions. */ #ifndef CODE_UTILS_H #define CODE_UTILS_H /** * This checks for the specified condition, which is expected to * commonly be true, and branches to the local label 'exit' if the * condition is false. * * @param[in] aCondition A Boolean expression to be evaluated. * */ #define otEXPECT(aCondition) \ do \ { \ if (!(aCondition)) \ { \ goto exit; \ } \ } while (0) /** * This checks for the specified condition, which is expected to * commonly be true, and both executes @p anAction and branches to * the local label 'exit' if the condition is false. * * @param[in] aCondition A Boolean expression to be evaluated. * @param[in] aAction An expression or block to execute when the * assertion fails. * */ #define otEXPECT_ACTION(aCondition, aAction) \ do \ { \ if (!(aCondition)) \ { \ aAction; \ goto exit; \ } \ } while (0) /** * This macro calculates the number of elements in an array. * * @param[in] aArray Name of the array variable. * * @returns Number of elements in the array. * */ #define otARRAY_LENGTH(aArray) (sizeof(aArray) / sizeof(aArray[0])) #endif // CODE_UTILS_H