Date:: 2008 (created)

Introduction

The Eina library is a library that implements an API for data types in an efficient way. It also provides some useful tools like opening shared libraries, errors management, type conversion, time accounting and memory pool.

This library is cross-platform and can be compiled and used on Linux, BSD, Opensolaris and Windows (XP and CE).

The data types that are available are (see Data Types):

Fp standard floating point numbers.
Inline Array standard array of inlined members.
Array standard array of void* data.
Hash Table standard hash of void* data.
Inline List list with nodes inlined into user type.
Compact List Compact List.
List standard list of void* data.
Iterator Functions Iterator functions.
Sparse Matrix sparse matrix of void* data.
Red-Black tree red-black tree with nodes inlined into user type.
String Buffer mutable string to prepend, insert or append strings to a buffer.
Stringshare saves memory by sharing read-only string references.
Tiler split, merge and navigates into 2D tiled regions.
Trash container of unused but allocated data.
Generic Value Storage container for generic value storage and access.

The tools that are available are (see Tools):

Benchmark helper to write benchmarks.
Convert faster conversion from strings to integers, double, etc.
Counter measures number of calls and their time.
Cpu Cpu and architecture related helpers.
Error error identifiers.
File simple file list and path split.
Lazy allocator simple lazy allocator.
Log full-featured logging system.
Magic provides runtime type checking.
Memory Pool abstraction for various memory allocators.
Module lists, loads and share modules using Eina_Module standard.
Rectangle rectangle structure and standard manipulation methods.
Safety Checks extra checks that will report unexpected conditions and can be disabled at compile time.
String a set of functions that manages C strings.

How to compile

Eina is a library your application links to. The procedure for this is very simple. You simply have to compile your application with the appropriate compiler flags that the pkg-config script outputs. For example:

Compiling C or C++ files into object files:

   gcc -c -o main.o main.c `pkg-config --cflags eina`

Linking object files into a binary executable:

   gcc -o my_application main.o `pkg-config --libs eina`

See pkgconfig

Next Steps

After you understood what Eina is and installed it in your system you should proceed understanding the programming interface.

Introductory Example

//Compile with:
//gcc -g eina_list_01.c -o eina_list_01 `pkg-config --cflags --libs eina`

#include <stdio.h>
#include <Eina.h>

int
main(int argc, char **argv)
{
   (void)argc;
   (void)argv;
   Eina_List *list = NULL;
   Eina_List *l;
   void *list_data;

   eina_init();

   list = eina_list_append(list, "tigh");
   list = eina_list_append(list, "adar");
   list = eina_list_append(list, "baltar");
   list = eina_list_append(list, "roslin");

   EINA_LIST_FOREACH(list, l, list_data)
     printf("%s\n", (char*)list_data);
   printf("\n");

   l = eina_list_nth_list(list, 1);
   list = eina_list_append_relative_list(list, "cain", l);

   list = eina_list_append_relative(list, "zarek", "cain");

   list = eina_list_prepend(list, "adama");

   list = eina_list_prepend_relative(list, "gaeta", "cain");

   list = eina_list_prepend_relative_list(list, "lampkin", l);

   EINA_LIST_FOREACH(list, l, list_data)
     printf("%s\n", (char*)list_data);

   eina_list_free(list);

   eina_shutdown();

   return 0;
}

More examples can be found at Eina Examples.

Table of Contents

Introduction

How to compile

Next Steps

Introductory Example