2008-08-06 11:15:24 -07:00
|
|
|
/* EINA - EFL data type library
|
|
|
|
* Copyright (C) 2008 Cedric Bail
|
|
|
|
*
|
|
|
|
* 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-31 08:08:19 -07:00
|
|
|
#ifndef EINA_MAGIC_H_
|
|
|
|
#define EINA_MAGIC_H_
|
|
|
|
|
2008-09-26 04:41:55 -07:00
|
|
|
#ifdef EINA_MAGIC_DEBUG
|
2008-07-31 08:08:19 -07:00
|
|
|
|
2008-08-01 07:25:20 -07:00
|
|
|
#include "eina_types.h"
|
|
|
|
|
2008-07-31 08:08:19 -07:00
|
|
|
#define EINA_MAGIC_NONE 0x1234fedc
|
|
|
|
|
|
|
|
#define EINA_MAGIC Eina_Magic __magic;
|
|
|
|
|
|
|
|
#define EINA_MAGIC_SET(d, m) (d)->__magic = (m)
|
|
|
|
#define EINA_MAGIC_CHECK(d, m) ((d) && ((d)->__magic == (m)))
|
2008-09-25 02:02:41 -07:00
|
|
|
#define EINA_MAGIC_FAIL(d, m) eina_magic_fail((void*)(d), (d) ? (d)->__magic : 0, (m), __FILE__, __FUNCTION__, __LINE__);
|
2008-07-31 08:08:19 -07:00
|
|
|
|
|
|
|
typedef unsigned int Eina_Magic;
|
|
|
|
|
2008-10-10 02:33:40 -07:00
|
|
|
EAPI int eina_magic_string_init(void);
|
|
|
|
EAPI int eina_magic_string_shutdown(void);
|
2008-07-31 08:08:19 -07:00
|
|
|
|
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
|
|
|
EAPI const char* eina_magic_string_get(Eina_Magic magic) EINA_PURE EINA_WARN_UNUSED_RESULT;
|
|
|
|
EAPI void eina_magic_string_set(Eina_Magic magic, const char *magic_name) EINA_ARG_NONNULL(2);
|
2008-07-31 08:08:19 -07:00
|
|
|
EAPI void eina_magic_fail(void *d, Eina_Magic m, Eina_Magic req_m,
|
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
|
|
|
const char *file, const char *fnc, int line) EINA_ARG_NONNULL(4, 5);
|
2008-07-31 08:08:19 -07:00
|
|
|
|
|
|
|
#else
|
|
|
|
|
2008-09-25 02:02:41 -07:00
|
|
|
#define EINA_MAGIC_NONE ((void) 0)
|
2008-07-31 08:08:19 -07:00
|
|
|
#define EINA_MAGIC
|
2008-09-25 02:02:41 -07:00
|
|
|
#define EINA_MAGIC_SET(d, m) ((void) 0)
|
2008-07-31 08:08:19 -07:00
|
|
|
#define EINA_MAGIC_CHECK(d, m) (1)
|
2008-09-25 02:02:41 -07:00
|
|
|
#define EINA_MAGIC_FAIL(d, m) ((void) 0)
|
2008-07-31 08:08:19 -07:00
|
|
|
|
|
|
|
#define eina_magic_string_get(Magic) (NULL)
|
2008-09-25 02:02:41 -07:00
|
|
|
#define eina_magic_string_set(Magic, Magic_Name) ((void) 0)
|
|
|
|
#define eina_magic_fail(d, m, req_m, file, fnx, line) ((void) 0)
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
#define eina_magic_string_init() do {} while(0)
|
|
|
|
#define eina_magic_string_shutdown() do {} while(0)
|
2008-07-31 08:08:19 -07:00
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* EINA_MAGIC_H_ */
|