efl/legacy/eina/src/include
Gustavo Sverzut Barbieri b0ee5696a6 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 13:17:51 +00:00
..
.cvsignore Add .cvsignore. 2008-07-30 13:09:03 +00:00
Eina.h Actually include eina_convert in the main header. 2008-10-20 15:01:01 +00:00
Makefile.am Use includedir instead of prefix/include to install Eina headers. 2008-12-04 16:25:40 +00:00
eina_accessor.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_array.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_benchmark.h Change eina_benchmark_register API as it can fail in many occasion. 2008-09-19 12:32:24 +00:00
eina_config.h.in Give more choice to eina_list mempool. 2008-10-06 14:47:09 +00:00
eina_convert.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_counter.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_error.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_f16p16.h Use float instead of double. 2008-12-23 17:23:35 +00:00
eina_file.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_hash.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_inline_array.x Fix EINA_ARRAY_ITER_NEXT off by one bug. With this fix you can no longer push 2008-12-19 17:55:57 +00:00
eina_inline_hash.x __UNUSED__ macro is not exported by eina. 2008-12-09 11:01:12 +00:00
eina_inline_list.x Patch from quarium. 2008-09-25 14:46:16 +00:00
eina_inline_mempool.x Put the mempool backend structure with other structure. 2008-10-20 13:23:18 +00:00
eina_inline_rbtree.x Fix some constness. 2008-11-10 16:23:56 +00:00
eina_inline_rectangle.x eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_inlist.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_iterator.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_lalloc.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_list.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_magic.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_mempool.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_module.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_private.h Remove PATH_MAX use. 2008-12-23 13:12:06 +00:00
eina_rbtree.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_rectangle.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_stringshare.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00
eina_types.h eina gets lots of gcc attributes to its api. 2008-12-26 13:17:51 +00:00