2001-10-12 17:08:39 -07:00
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
|
2001-10-21 15:03:36 -07:00
|
|
|
<!ENTITY e17 "<productname>Enlightenment 0.17</productname>">
|
2001-10-12 17:08:39 -07:00
|
|
|
]>
|
|
|
|
|
|
|
|
|
2001-11-01 15:55:39 -08:00
|
|
|
<book id="e17-manual">
|
2001-10-12 17:08:39 -07:00
|
|
|
<bookinfo>
|
2001-10-21 15:03:36 -07:00
|
|
|
<title>The Enlightenment 0.17 Manual</title>
|
2001-10-12 17:08:39 -07:00
|
|
|
|
|
|
|
<authorgroup>
|
|
|
|
<author>
|
2001-10-21 15:03:36 -07:00
|
|
|
<firstname>Christian</firstname>
|
|
|
|
<surname>Kreibich</surname>
|
2001-10-12 17:08:39 -07:00
|
|
|
<affiliation>
|
|
|
|
<address>
|
2001-10-21 15:03:36 -07:00
|
|
|
<email>cK@whoop.org</email>
|
2001-10-12 17:08:39 -07:00
|
|
|
</address>
|
|
|
|
</affiliation>
|
|
|
|
</author>
|
|
|
|
</authorgroup>
|
|
|
|
|
|
|
|
<copyright>
|
|
|
|
<year>2001</year>
|
|
|
|
<holder>Christian Kreibich</holder>
|
|
|
|
</copyright>
|
|
|
|
|
|
|
|
<legalnotice>
|
|
|
|
<para>
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to
|
|
|
|
deal in the Software without restriction, including without limitation the
|
|
|
|
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
|
|
sell copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies of the Software and its documentation and acknowledgment shall be
|
|
|
|
given in the documentation and software packages that this Software was
|
|
|
|
used.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
|
|
THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
|
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
</para>
|
|
|
|
</legalnotice>
|
|
|
|
|
|
|
|
<releaseinfo>
|
|
|
|
This is document is nowhere near being finished. Be patient.
|
|
|
|
</releaseinfo>
|
|
|
|
|
|
|
|
</bookinfo>
|
|
|
|
|
|
|
|
<toc></toc>
|
|
|
|
|
|
|
|
<chapter id="introduction">
|
|
|
|
<title>Introduction</title>
|
|
|
|
<para>
|
2001-10-21 15:03:36 -07:00
|
|
|
This document explains the &e17; release, for both users and
|
|
|
|
developers.
|
2001-10-12 17:08:39 -07:00
|
|
|
</para>
|
|
|
|
</chapter>
|
|
|
|
|
2001-10-21 15:03:36 -07:00
|
|
|
<chapter id="using">
|
|
|
|
<title>Using &e17;</title>
|
2001-10-12 17:08:39 -07:00
|
|
|
<para>
|
2001-10-21 15:03:36 -07:00
|
|
|
Here's how you use &e17;.
|
2001-10-12 17:08:39 -07:00
|
|
|
</para>
|
|
|
|
|
2001-10-21 15:03:36 -07:00
|
|
|
<section id="wm">
|
|
|
|
<title id="wm.title">The Window Manager</title>
|
2001-10-12 17:08:39 -07:00
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
2001-10-21 15:03:36 -07:00
|
|
|
|
|
|
|
<section id="fm">
|
|
|
|
<title id="fm.title">The File Manager</title>
|
2001-10-12 17:08:39 -07:00
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
2001-10-21 15:03:36 -07:00
|
|
|
</chapter>
|
2001-10-12 17:08:39 -07:00
|
|
|
|
2001-10-21 15:03:36 -07:00
|
|
|
<chapter id="inside">
|
|
|
|
<title>Inside &e17;</title>
|
|
|
|
<para>
|
|
|
|
This chapter explains the inner workings of &e17;.
|
|
|
|
</para>
|
|
|
|
<section id="architecture">
|
|
|
|
<title id="architecture.title">&e17; Architecture</title>
|
|
|
|
<section id="overall">
|
|
|
|
<title id="overall.title">Overview</title>
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section id="modules">
|
|
|
|
<title id="modules.title">Modules</title>
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
2001-10-12 17:08:39 -07:00
|
|
|
</section>
|
2001-10-21 15:03:36 -07:00
|
|
|
|
|
|
|
<section id="concepts">
|
|
|
|
<title id="concepts.title">Themeing</title>
|
|
|
|
<section id="overview">
|
|
|
|
<title id="overview.title">Overview</title>
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section id="system">
|
|
|
|
<title id="system.title">System Settings</title>
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section id="user">
|
|
|
|
<title id="user.title">User Settings</title>
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
<section id="code">
|
|
|
|
<title>Code Documentation</title>
|
2001-11-01 15:55:39 -08:00
|
|
|
!Isrc/actions.h
|
|
|
|
!Isrc/border.h
|
|
|
|
!Isrc/desktops.h
|
|
|
|
!Isrc/entry.h
|
|
|
|
!Isrc/fs.h
|
|
|
|
!Isrc/guides.h
|
2001-10-21 15:03:36 -07:00
|
|
|
!Isrc/iconbar.c
|
2001-11-03 06:55:21 -08:00
|
|
|
!Isrc/icons.h
|
2001-11-01 15:55:39 -08:00
|
|
|
!Isrc/menu.h
|
2001-10-21 15:16:00 -07:00
|
|
|
!Isrc/menu.c
|
Alright, I spent some time now reading e17's code. Here's what
I've changed, this is big, so read this carefully :)
* I've added debugging macros for messages and function call
tracing. Usage:
D("Creating item %i %i %i\n", x, y, z);
Define DEBUG to use the D macro.
D_ENTER;
D_RETURN;
D_RETURN_(x);
These are for call tracing. Use D_RETURN_(x) when returning
something from a function. Define DEBUG_NEST to use this.
* added iconbar header file to Makefile.am
* added proper new()/cleanup() calls for E_Delayed_Action;
* I've completely rewritten the object and observer handling. Bye
bye macros, this was nasty. It'll be hard enough to avoid leaks
with usecounting in C. We now basically have the same system as gtk.
There's a clear separation of observer and object code now.
An E_Object by itself has nothing to do with observing or being
observed, therefore, there are now E_Observers and E_Observees
that are derived from E_Object. IMPORTANT: The cleanup system now
reflects the reference count system, therefore, all ..._free()
calls are now static, because the destructor should never be called explicitly, but implicitly through e_object_unref(). The object handling
now is as follows:
- The cleanup functions clean up everything that is contained in
a struct, but NOT the struct itself. Instead of the final
free() call, they call the destructor of the base class. The
calls will walk up the hierarchy and clean up what's contained in
every struct, and the final e_object_cleanup() will free the
structure itself. E_Delayed_Action is a good example.
- The only calls that influence the reference count are
e_object_ref() and e_object_unref(). If you need to do things
before an object gets destroyed, you can query the use count using
e_object_get_usecount() and check if it's equal to 1. So this:
OBJ_UNREF(b);
OBJ_IF_FREE(b)
{
ecore_window_reparent(e->win, 0, 0, 0);
e_icccm_release(e->win);
OBJ_FREE(b);
}
now is this:
if (e_object_get_usecount(E_OBJECT(b)) == 1)
{
ecore_window_reparent(e->win, 0, 0, 0);
e_icccm_release(e->win);
}
e_object_unref(E_OBJECT(b));
object.h and observer.h are completely commented, it shouldn't be
too hard to understand. This'll need to be documented in the manual
anyway.
* E_Objects are now used in lots of places where void* were used as
pointers to objects before, especially in the actions code. This is
obviously better, as it will generate compiler warnings when people
want to pass things to functions that expect E_Objects. This could
probably be more restrictive.
* Added typedefs for the function prototypes in E_Action_Impl. Those
fat signatures were just painful to read in the function
declarations/implementations.
* I've also tried to give parameters more useful names. Calling an
object "o" is a lot of fun when you want to grep for it.
* Included is also Graham's latest menu.c patch. Sorry for the
delay, Graham.
* I've added checks to the menu code that make sure that menus
don't pop up when they're empty (which resulted in a little useless
rectangle).
I guess that's it for now. Sorry if I broke anything, but this was
necessary imho.
SVN revision: 5605
2001-11-02 09:07:52 -08:00
|
|
|
!Isrc/object.h
|
|
|
|
!Isrc/observer.h
|
|
|
|
!Isrc/place.h
|
2001-11-01 15:55:39 -08:00
|
|
|
!Isrc/view.h
|
|
|
|
|
2001-10-12 17:08:39 -07:00
|
|
|
</section>
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
</book>
|
|
|
|
|