4 ******************************************************************************
5 FOR ANY ISSUES PLEASE EMAIL:
6 enlightenment-devel@lists.sourceforge.net
7 ******************************************************************************
9 EFL is a collection of libraries for handling many common tasks a
10 developer may have such as data structures, communication, rendering,
13 There are many components inside EFL. They also build various things
14 like shared libraries, loadable plug-in modules and also binary
15 executables. Different elements will end up being licensed differently
16 too. Below is a rundown of the components, what they do and their
19 All library source is in the src/lib/ directory. All binaries are in
20 src/bin/. All loadable modules are in src/modules/. All data files are
21 in the data/ directory. Licensing details are listed in COPYING and
22 the licenses/ directory. The pc/ directory holds all the Package
23 Config files installed to help developers build against EFL.
25 For more documentation please see:
27 https://www.enlightenment.org/docs
32 EFL is primarily developerd on Linux (GNU/Linux) and should work on
33 most distributions as long as dependencies are provided. It has been
34 compiled and run also on Windows (using MINGW32 - please see
35 http://www.winbuilds.org ), Mac OS X, FreeBSD and NetBSD.
42 //BSD 2-Clause license//
44 This is the core main-loop, system events and execution layer. This
45 handles running the main loop, integrating with external data and
46 timing sources (the system clock, file descriptors, system signals),
47 and producing an event queue, walking that queue and dispatching
48 events to appropriate callbacks.
54 //BSD 2-Clause license//
56 This library provides an API for audio playback and recording. It uses
57 pulse audio underneath to handle mixing and policies. The API for this
58 should not be considered stable right now because it relies on EO and
59 EO is not considered finalized yet.
65 //BSD 2-Clause license//
67 This provides wrappers/abstractions around Max OS-X Cocoa APIs to help
74 //BSD 2-Clause license//
76 This provides a completely event-based TCP/UDP and Unix domain socket
77 API that integrates with the main-loop. This means no blocking to send
78 or receive data, supporting "infinite send buffers" with storage and
79 spooling being done by Ecore Con. It also supports SSL encryption
80 transparently turned on or not on the same connection, certificate
81 verification, CURL wrapping for HTTP connection usage (GETs, POSTs
82 etc.), asynchronous DNS lookups and provides the ability to also be a
83 server, not just a client, with the same event-based API.
89 //BSD 2-Clause license//
91 This acts as glue between the display target (X11, Wayland,
92 Frame buffer, Cocoa on OSX, Win32 etc.) and Evas. It creates/provides a
93 target for Evas to render to (a Window or Surface etc.) and feeds
94 input events (Keyboard, Mouse, Multi-touch) into Evas, which then
95 selects the target object and calls the callbacks. It also provides
96 wrappers/glue for manipulating the Window/Surface.
102 //BSD 2-Clause license//
104 This provides virtual terminal allocation, access and handling,
105 frame buffer information, raw input handling for keyboard, mouse and
112 //BSD 2-Clause license//
114 This provides file access convenience APIs for doing simple file
115 operations like renames, copies, listing directories and more. It also
116 supports file change monitoring and URL downloads.
122 //BSD 2-Clause license//
124 This is an input method abstraction framework to allow EFL to talk to
125 things like SCIM, IBus, Wayland and XIM. This allows for complex text
126 entry in languages such as Chinese, Japanese and Korean.
132 //BSD 2-Clause license//
134 This library glues Input method support from Ecore IMF and Evas
141 //BSD 2-Clause license//
143 This acts as a generic input layer where multiple display systems can
144 post events in the same format to the event queue.
148 **Ecore Input Evas:**
150 //BSD 2-Clause license//
152 This Routes events from Ecore Input into a given Evas canvas which
153 will then route the event further to the destination object and
160 //BSD 2-Clause license//
162 This acts as a layer on top of Ecore Con which handles entire IPC
163 message packets, dealing with header delta compression and
164 portability, as well as ensuring an entire message is received in one
165 go as a single IPC message, regardless of payload data size. The
166 entire API is event based almost exactly like Ecore Con and thus it
167 supports all the transport layers Ecore Con supports.
174 //BSD 2-Clause license//
176 This acts as a wrapper/glue around SDL to handle SDL Windows as well
177 as input events from SDL and tie them to the Ecore main-loop and event
184 //BSD 2-Clause license//
186 This is a glue/wrapper library to interface EFL to Wayland libraries
187 to tie them into the Ecore main-loop and event queue.
193 //BSD 2-Clause license//
195 This acts as glue/wrapper around Windows Win32 APIs to tie them into
196 the Ecore main-loop and event queue.
202 //BSD 2-Clause license//
204 This acts as glue/wrapper around Windows CE APIs to tie them into the
205 Ecore main-loop and event queue.
211 //BSD 2-Clause license//
213 This is a library to wrap/deal with Xlib make dealing with X11 less painful
214 and less footwork as well as being glue to tie these into the Ecore main-loop
221 //BSD 2-Clause license// (except the epp binary which is GPLv2)
223 This is a graphics event, input, theme, animation and theme
224 abstraction library used to place many UI/UX elements into data files
225 (called edj files) that define how to react to incoming
226 events/signals, and define animation time lines, states, relative
227 scalable layout and much much more. It comes with a compiler that
228 compiles source "edc" files into "edj" files (which are actually just
229 data files managed by Eet). These "edj" files are fully portable and
230 can work on any OS/Architecture just like a JPEG or PNG might be
237 //BSD 2-Clause license//
239 This library is a data storage, encoding and decoding library
240 designed to be extremely compact, fast and easy to use. It can take
241 data structures directly from memory and serialize them portably to
242 disk, then de-serialize them right back to the same data structures in
243 memory, handling allocation and population of memory all for you in 1
244 call. It handles indirections such as pointers, linked lists, arrays
245 and hash tables too, so almost any level of data structure complexity
246 can be easily saved and loaded back. It is used for "edj" files by
247 Edje as well as all configuration in Enlightenment, Elementary and
248 Terminology. It supports encryption of data too via SSL, signing of
249 files, as well as various compression techniques. It also supports
250 encoding and decoding of image data in lossless or lossy form.
256 //BSD 2-Clause license//
258 This library acts as an abstraction to discovering hardware interfaces
259 for sensors as well as removable media and much more.
265 //BSD 2-Clause license//
267 This is just some core common header data like a common version number
268 for EFL and how to expose the EO API.
274 //BSD 2-Clause license//
276 This library provides code for handling Freedesktop.org standards such
277 as .desktop files, XDG Menus, Icon search paths and more. It provides
278 a central daemon to handle monitoring for changes that the library
279 talks to, and the daemon handles updating local cache files the
288 This library provides low-level routines for common things like linked
289 lists, hash tables, growable arrays, basic string buffers, shared
290 string tokens, mmaped() file access, thread abstraction and locking,
291 memory pools, copy-on-write segments, iterators, matrices, general
292 data models, red/black trees, quad-trees, a simple SAX XML parser and
301 This is an asynchronous I/O library for doing disk I/O without blocking.
309 This is a DBus access library to allow you to create DBus services as
310 well as clients. This glues in DBus into the main-loop so all access is
317 //Small license (same as ZLib license)//
319 This is a small C-like language compiler and byte-code interpreter
320 library. This is used for scripting in Edje. The code is based on
321 original source from the Pawn/Small Language but has been made
322 portable (endianness issues fixed) and 64bit issues fixed, with the
323 runtime library being refactored to be extremely small.
329 //BSD 2-Clause license//
331 This is a wrapper around Gstreamer 1.x pluggable decoder libraries
332 This glues in the decoder library, and its output into a smart Evas object
333 that will display the playback for you as the video plays, as well as
334 providing higher level controls to seek, play, pause and query the stream
335 regardless of the back-end used.
341 //BSD 2-Clause license//
343 This is a core object system API that EFL 1.8 and on depend on. The
344 API is not finalized, so do not depend on it yet in EFL 1.8, but
345 future EFL versions will lock it down.
347 This object system does simple and multiple inheritance, refcounting,
348 strong and weak references, auto-deletion of child objects, unifies
349 callback handling with a single path, and also abstracts object
350 pointers to be indirect table lookups for increased safety at runtime.
356 //BSD 2-Clause license//
358 This library provides a wrapper around the Bullet physics library,
359 allowing for it to be linked directly with Evas objects and control
360 their behavior as if they were real physical objects. This is now
361 disabled by default as it's rarely if ever used by anything.
369 This library provides core API for a thumbnailing daemon as well as
370 the thumbnail daemon itself. Ethumb Client talks with Ethumb to pass
371 off thumbnail generation to a central location to be done
380 This is the client-side part of Ethumb that provides an API for
381 clients to request the Ethumb thumbnailer to generate or find cached
388 //BSD 2-Clause license//
390 This is the core rendering and scene graph abstraction library for
391 EFL. It manages a stateful 2D scene graph that defines the entire
392 content of any canvas. This supplies rendering back-ends for many
393 display systems like X11, Windows, Wayland, Frame-buffer etc. and via
394 many rendering APIs like OpenGL, OpenGL-ES 2, and pure software
395 implementations that are fast and accurate.
401 //BSD 2-Clause license//
403 This library acts as a porting library for Windows to provide missing
404 libc calls not in Mingw32 that EFL needs.
409 COMPILING AND INSTALLING
410 ------------------------
412 See the INSTALL file: https://git.enlightenment.org/core/efl.git/tree/INSTALL
418 EFL requires a C and C++ compiler by default. C++ exists mostly to interface
419 to C++ libraries like Bullet and our C++ bindings.
426 * gstreamer (Ensure all codecs you want are installed.)
428 * luajit (lua 5.1 or 5.2 support optional)
453 * libxi (2.2 or newer)
454 * opengl(mesa etc.) (opengl/glx/full or opengl-es2/egl. full opengl only on osx - must be explicitly specified to be full to have support)
456 * util-linux (limbount + libblkid)
458 * poppler / poppler-cpp
462 * openmp (clang needs libomp, while gcc uses libgomp)
467 You may also want wayland support when on Linux. This enables support
468 for EFL to trget wayland support for client applications. To do this
475 This requires linux frame-buffer support, headers etc. This supports
476 basic frame-buffers like /dev/fb as well as input via /dev/input for
477 keyboards and mice in a basic way. Enable this with:
481 For more modern framebuffer support you may want drm/kms rendering
482 support so enable this. This is what you also want for wayland
483 compositor support in enlightenment as it will want to be able to
484 render to a moder framebuffer tarbet with atomic buffer swapping. To
489 You may want to change the install prefix for EFL with:
491 --prefix=/path/to/prefix
493 The default prefix if not given is "/usr/local". Many people like to
494 use prefixes like /opt/e or /opt/efl or /home/USERNAME/software etc.
499 You can affect compilation optimization, debugging and other factors
500 by setting your CFLAGS environment variable (and CXXFLAGS). Be aware
501 that to ensure ABI stability you should use the exact same CFLAGS /
502 CXXFLAGS for all the build of EFL and any applications/libraries that
505 There are many other configure options that can be used, but in
506 general it is not a good idea to go enabling or disabling things
507 unless you wish to break things. The defaults are well tested, with
508 the above recommended options also being well tested. Go much further
509 and your mileage may vary wildly. Disabling features is a good way of
510 breaking EFL functionality, so it is not recommended to mess with
511 these without understanding the implications. The defaults
512 have been carefully considered to provide full functionality so users
513 will not be missing anything.
519 EFL officially offers openssl or gnutls as cryptography backends. By
520 default it uses "openssl" to do signature, cipher and related. Alternatively
521 one can use "gnutls" (some distros are strict about licenses and want gnutls
522 instead of openssl) You can switch to gnutls with: