src/lib/eina_safety_checks.c

   1 /* EINA - EFL data type library
   2  * Copyright (C) 2008 Gustavo Sverzut Barbieri
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library;
  16  * if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 # include "config.h"
  21 #endif
  22
  23 #include "eina_private.h"
  24 #include "eina_error.h"
  25 #include "eina_log.h"
  26 #include "eina_safety_checks.h"
  27
  28 /*============================================================================*
  29 *                                  Local                                     *
  30 *============================================================================*/
  31
  32 /*============================================================================*
  33 *                                 Global                                     *
  34 *============================================================================*/
  35
  36 /**
  37  * @internal
  38  * @brief Shut down the safety checks module.
  39  *
  40  * @return #EINA_TRUE on success, #EINA_FALSE on failure.
  41  *
  42  * This function shuts down the error module set up by
  43  * eina_safety_checks_init(). It is called by eina_shutdown().
  44  *
  45  * @see eina_shutdown()
  46  */
  47 Eina_Bool
  48 eina_safety_checks_shutdown(void)
  49 {
  50    return EINA_TRUE;
  51 }
  52
  53 /*============================================================================*
  54 *                                   API                                      *
  55 *============================================================================*/
  56
  57 /**
  58  * @cond LOCAL
  59  */
  60
  61 EAPI Eina_Error EINA_ERROR_SAFETY_FAILED = 0;
  62
  63 static const char EINA_ERROR_SAFETY_FAILED_STR[] = "Safety check failed.";
  64
  65 /**
  66  * @endcond
  67  */
  68
  69 /**
  70  * @internal
  71  * @brief Initialize the safety checks module.
  72  *
  73  * @return #EINA_TRUE on success, #EINA_FALSE on failure.
  74  *
  75  * This function sets up the safety checks module of Eina. It is
  76  * called by eina_init().
  77  *
  78  * @see eina_init()
  79  */
  80 Eina_Bool
  81 eina_safety_checks_init(void)
  82 {
  83    EINA_ERROR_SAFETY_FAILED = eina_error_msg_static_register(
  84          EINA_ERROR_SAFETY_FAILED_STR);
  85    return EINA_TRUE;
  86 }
  87
  88 /**
  89  * @}
  90  */