2008-08-06 11:15:24 -07:00
|
|
|
/* EINA - EFL data type library
|
|
|
|
|
* Copyright (C) 2007-2008 Carsten Haitzler, Vincent Torri, Jorge Luis Zapata Muga
|
|
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
* License along with this library;
|
|
|
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
*/
|
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
#ifndef EINA_TYPES_H_
|
|
|
|
|
#define EINA_TYPES_H_
|
|
|
|
|
|
2009-06-22 13:03:58 -07:00
|
|
|
/**
|
|
|
|
|
* @addtogroup Eina_Core_Group Core
|
|
|
|
|
*
|
|
|
|
|
* @{
|
|
|
|
|
*/
|
|
|
|
|
|
2009-06-08 01:27:33 -07:00
|
|
|
/**
|
|
|
|
|
* @defgroup Eina_Types_Group Types
|
|
|
|
|
*
|
|
|
|
|
* @{
|
|
|
|
|
*/
|
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
#ifdef EAPI
|
|
|
|
|
# undef EAPI
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifdef _WIN32
|
|
|
|
|
# ifdef EFL_EINA_BUILD
|
|
|
|
|
# ifdef DLL_EXPORT
|
|
|
|
|
# define EAPI __declspec(dllexport)
|
|
|
|
|
# else
|
|
|
|
|
# define EAPI
|
|
|
|
|
# endif /* ! DLL_EXPORT */
|
|
|
|
|
# else
|
|
|
|
|
# define EAPI __declspec(dllimport)
|
|
|
|
|
# endif /* ! EFL_EINA_BUILD */
|
|
|
|
|
#else
|
|
|
|
|
# ifdef __GNUC__
|
|
|
|
|
# if __GNUC__ >= 4
|
|
|
|
|
# define EAPI __attribute__ ((visibility("default")))
|
|
|
|
|
# else
|
|
|
|
|
# define EAPI
|
|
|
|
|
# endif
|
|
|
|
|
# else
|
|
|
|
|
# define EAPI
|
|
|
|
|
# endif
|
|
|
|
|
#endif
|
|
|
|
|
|
2009-06-08 01:27:33 -07:00
|
|
|
#include "eina_config.h"
|
|
|
|
|
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
#ifdef EINA_WARN_UNUSED_RESULT
|
|
|
|
|
# undef EINA_WARN_UNUSED_RESULT
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_ARG_NONNULL
|
|
|
|
|
# undef EINA_ARG_NONNULL
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_MALLOC
|
|
|
|
|
# undef EINA_MALLOC
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_PURE
|
|
|
|
|
# undef EINA_PURE
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_PRINTF
|
|
|
|
|
# undef EINA_PRINTF
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_SCANF
|
|
|
|
|
# undef EINA_SCANF
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_FORMAT
|
|
|
|
|
# undef EINA_FORMAT
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_CONST
|
|
|
|
|
# undef EINA_CONST
|
|
|
|
|
#endif
|
2008-12-26 10:31:14 -08:00
|
|
|
#ifdef EINA_UNLIKELY
|
|
|
|
|
# undef EINA_UNLIKELY
|
|
|
|
|
#endif
|
|
|
|
|
#ifdef EINA_LIKELY
|
|
|
|
|
# undef EINA_LIKELY
|
|
|
|
|
#endif
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
|
|
|
|
|
#ifdef HAVE___ATTRIBUTE__
|
|
|
|
|
# ifdef __GNUC__
|
|
|
|
|
# if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
|
|
|
|
|
# define EINA_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
|
|
|
|
|
# else
|
|
|
|
|
# define EINA_WARN_UNUSED_RESULT
|
|
|
|
|
# endif
|
|
|
|
|
|
2008-12-26 10:31:14 -08:00
|
|
|
# if (!defined(EINA_SAFETY_CHECKS)) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# define EINA_ARG_NONNULL(idx, ...) __attribute__ ((nonnull(idx, ## __VA_ARGS__)))
|
|
|
|
|
# else
|
|
|
|
|
# define EINA_ARG_NONNULL(idx, ...)
|
|
|
|
|
# endif
|
|
|
|
|
|
2009-03-19 18:00:35 -07:00
|
|
|
# if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
|
|
|
|
|
# define EINA_DEPRECATED __attribute__ ((__deprecated__))
|
|
|
|
|
# else
|
|
|
|
|
# define EINA_DEPRECATED
|
|
|
|
|
# endif
|
|
|
|
|
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
|
|
|
|
|
# define EINA_MALLOC __attribute__ ((malloc))
|
|
|
|
|
# define EINA_PURE __attribute__ ((pure))
|
|
|
|
|
# else
|
|
|
|
|
# define EINA_MALLOC
|
|
|
|
|
# define EINA_PURE
|
|
|
|
|
# endif
|
|
|
|
|
|
|
|
|
|
# if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
|
|
|
|
|
# define EINA_PRINTF(fmt, arg) __attribute__((format (printf, fmt, arg)))
|
|
|
|
|
# define EINA_SCANF(fmt, arg) __attribute__((format (scanf, fmt, arg)))
|
|
|
|
|
# define EINA_FORMAT(fmt) __attribute__((format_arg(fmt)))
|
|
|
|
|
# define EINA_CONST __attribute__((const))
|
2008-12-26 10:31:14 -08:00
|
|
|
# define EINA_UNLIKELY(exp) __builtin_expect((exp), 0)
|
|
|
|
|
# define EINA_LIKELY(exp) __builtin_expect((exp), 1)
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# else
|
|
|
|
|
# define EINA_PRINTF(fmt, arg)
|
|
|
|
|
# define EINA_SCANF(fmt, arg)
|
|
|
|
|
# define EINA_FORMAT(fmt)
|
|
|
|
|
# define EINA_CONST
|
2009-01-26 08:23:07 -08:00
|
|
|
# define EINA_UNLIKELY(exp) exp
|
|
|
|
|
# define EINA_LIKELY(exp) exp
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# endif
|
|
|
|
|
# else /* no __GNUC__ */
|
|
|
|
|
# define EINA_WARN_UNUSED_RESULT
|
|
|
|
|
# define EINA_ARG_NONNULL(idx, ...)
|
|
|
|
|
# define EINA_MALLOC
|
|
|
|
|
# define EINA_PURE
|
|
|
|
|
# define EINA_PRINTF(fmt, arg)
|
|
|
|
|
# define EINA_SCANF(fmt, arg)
|
|
|
|
|
# define EINA_FORMAT(fmt)
|
|
|
|
|
# define EINA_CONST
|
2009-01-26 08:23:07 -08:00
|
|
|
# define EINA_UNLIKELY(exp) exp
|
|
|
|
|
# define EINA_LIKELY(exp) exp
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# endif
|
2009-03-19 18:00:35 -07:00
|
|
|
#elif defined(_WIN32)
|
|
|
|
|
# define EINA_WARN_UNUSED_RESULT
|
|
|
|
|
# define EINA_ARG_NONNULL(idx, ...)
|
|
|
|
|
# if defined(_MSC_VER) && _MSC_VER >= 1300
|
|
|
|
|
# define EINA_DEPRECATED __declspec(deprecated)
|
|
|
|
|
# else
|
|
|
|
|
# define EINA_DEPRECATED
|
|
|
|
|
# endif
|
|
|
|
|
# define EINA_MALLOC
|
|
|
|
|
# define EINA_PURE
|
|
|
|
|
# define EINA_PRINTF(fmt, arg)
|
|
|
|
|
# define EINA_SCANF(fmt, arg)
|
|
|
|
|
# define EINA_FORMAT(fmt)
|
|
|
|
|
# define EINA_CONST
|
|
|
|
|
# define EINA_UNLIKELY(exp) exp
|
|
|
|
|
# define EINA_LIKELY(exp) exp
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
#else /* no HAVE___ATTRIBUTE__ */
|
|
|
|
|
# define EINA_WARN_UNUSED_RESULT
|
|
|
|
|
# define EINA_ARG_NONNULL(idx, ...)
|
2009-03-19 18:00:35 -07:00
|
|
|
# define EINA_DEPRECATED
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
# define EINA_MALLOC
|
|
|
|
|
# define EINA_PURE
|
|
|
|
|
# define EINA_PRINTF(fmt, arg)
|
|
|
|
|
# define EINA_SCANF(fmt, arg)
|
|
|
|
|
# define EINA_FORMAT(fmt)
|
|
|
|
|
# define EINA_CONST
|
2009-01-26 08:23:07 -08:00
|
|
|
# define EINA_UNLIKELY(exp) exp
|
|
|
|
|
# define EINA_LIKELY(exp) exp
|
eina gets lots of gcc attributes to its api.
this should help with optimizations and code correctness, please see
"info gcc" for detailed explanation on these.
if you experience some functions not working as expected, please
double check if they're not marked with EINA_PURE or EINA_CONST, maybe
I misused them. Remove the macro and try again.
brief explanation:
* EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some
function, it will emit a warning (and -Werror will make it an
error). This way it will be harder to miss the attribution
"l = eina_list_append(l, v)".
* EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL
argument, or some tool (ie: clang) finds it could get a NULL but
this is not accepted by API, then a warning will be emitted. This
will help those that still use eina_hash_add() as if it is
evas_hash_add().
* EINA_MALLOC: any non-NULL pointer it returns cannot alias any other
pointer valid when function returns.
* EINA_PURE: function have no effects other than the return and this
return just depend on parameters and/or globals. You might call
this function in a loop a thousand times and it will return the
same value, thus you may move this function outside the loop and
remove it.
* EINA_CONST: stricter version of EINA_PURE, it will not check for
global parameters, that is, you cannot consider pointer
arguments. Use it for math things like "int sqrt(int)".
* EINA_PRINTF(fmt, arg): will check format parameter specified in
position "fmt" and passed arguments starting at position "arg", it
will check for things like giving integers where short or strings
were expected.
* EINA_SCANF(fmt, arg): similar to eina_printf().
* EINA_FORMAT(fmt): for use with things like dgettext(), it will get
a printf-like format string and modifies it.
Please review and test it with your software, make sure you make clean
before you install the new version so it has any effect.
If you find some functions are missing EINA_WARN_UNUSED_RESULT and
EINA_ARG_NONNULL or others, please add them.
SVN revision: 38323
2008-12-26 05:17:51 -08:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
/* remove this TRUE/FALSE redifinitions */
|
|
|
|
|
|
|
|
|
|
#ifndef TRUE
|
|
|
|
|
# define TRUE 1
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef FALSE
|
|
|
|
|
# define FALSE 0
|
|
|
|
|
#endif
|
|
|
|
|
|
2008-10-21 08:21:37 -07:00
|
|
|
typedef unsigned char Eina_Bool;
|
2009-06-08 01:27:33 -07:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @def EINA_FALSE
|
|
|
|
|
* boolean value FALSE (numerical value 0)
|
|
|
|
|
*/
|
2008-10-24 03:57:00 -07:00
|
|
|
#define EINA_FALSE ((Eina_Bool)0)
|
2009-06-08 01:27:33 -07:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @def EINA_TRUE
|
|
|
|
|
* boolean value TRUE (numerical value 1)
|
|
|
|
|
*/
|
2008-10-24 03:57:00 -07:00
|
|
|
#define EINA_TRUE ((Eina_Bool)1)
|
2008-07-30 05:46:55 -07:00
|
|
|
|
|
|
|
|
EAPI extern const unsigned int eina_prime_table[];
|
|
|
|
|
|
|
|
|
|
#define EINA_SORT_MIN 0
|
|
|
|
|
#define EINA_SORT_MAX 1
|
|
|
|
|
|
|
|
|
|
typedef int (*Eina_Compare_Cb) (const void *data1, const void *data2);
|
|
|
|
|
#define EINA_COMPARE_CB(function) ((Eina_Compare_Cb)function)
|
|
|
|
|
|
2008-08-11 09:21:51 -07:00
|
|
|
typedef Eina_Bool (*Eina_Each)(const void *container,
|
|
|
|
|
void *data,
|
|
|
|
|
void *fdata);
|
|
|
|
|
#define EINA_EACH(Function) ((Eina_Each)Function)
|
|
|
|
|
|
2008-09-24 10:14:29 -07:00
|
|
|
typedef void (*Eina_Free_Cb)(void *data);
|
|
|
|
|
#define EINA_FREE_CB(Function) ((Eina_Free_Cb)Function)
|
2008-08-11 09:21:51 -07:00
|
|
|
|
2009-06-22 13:03:58 -07:00
|
|
|
/**
|
|
|
|
|
* @}
|
|
|
|
|
*/
|
|
|
|
|
|
2009-06-08 01:27:33 -07:00
|
|
|
/**
|
|
|
|
|
* @}
|
|
|
|
|
*/
|
|
|
|
|
|
2008-08-28 00:46:42 -07:00
|
|
|
#endif /* EINA_TYPES_H_ */
|
