Tom Hacohen
parent
2374281331
commit
809a7d4e1e
|
|
@ -49,3 +49,4 @@ add_subdirectory(examples/composite_objects)
|
|||
|
||||
add_subdirectory(tests EXCLUDE_FROM_ALL)
|
||||
|
||||
add_subdirectory(doc)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,144 @@
|
|||
# - Run Doxygen
|
||||
#
|
||||
# Adds a doxygen target that runs doxygen to generate the html
|
||||
# and optionally the LaTeX API documentation.
|
||||
# The doxygen target is added to the doc target as a dependency.
|
||||
# i.e.: the API documentation is built with:
|
||||
# make doc
|
||||
#
|
||||
# USAGE: GLOBAL INSTALL
|
||||
#
|
||||
# Install it with:
|
||||
# cmake ./ && sudo make install
|
||||
# Add the following to the CMakeLists.txt of your project:
|
||||
# include(UseDoxygen OPTIONAL)
|
||||
# Optionally copy Doxyfile.in in the directory of CMakeLists.txt and edit it.
|
||||
#
|
||||
# USAGE: INCLUDE IN PROJECT
|
||||
#
|
||||
# set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
# include(UseDoxygen)
|
||||
# Add the Doxyfile.in and UseDoxygen.cmake files to the projects source directory.
|
||||
#
|
||||
#
|
||||
# CONFIGURATION
|
||||
#
|
||||
# To configure Doxygen you can edit Doxyfile.in and set some variables in cmake.
|
||||
# Variables you may define are:
|
||||
# DOXYFILE_SOURCE_DIR - Path where the Doxygen input files are.
|
||||
# Defaults to the current source directory.
|
||||
# DOXYFILE_EXTRA_SOURCES - Additional source diretories/files for Doxygen to scan.
|
||||
# The Paths should be in double quotes and separated by space. e.g.:
|
||||
# "${CMAKE_CURRENT_BINARY_DIR}/foo.c" "${CMAKE_CURRENT_BINARY_DIR}/bar/"
|
||||
#
|
||||
# DOXYFILE_OUTPUT_DIR - Path where the Doxygen output is stored.
|
||||
# Defaults to "${CMAKE_CURRENT_BINARY_DIR}/doc".
|
||||
#
|
||||
# DOXYFILE_LATEX - ON/OFF; Set to "ON" if you want the LaTeX documentation
|
||||
# to be built.
|
||||
# DOXYFILE_LATEX_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
|
||||
# the Doxygen LaTeX output is stored. Defaults to "latex".
|
||||
#
|
||||
# DOXYFILE_HTML_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
|
||||
# the Doxygen html output is stored. Defaults to "html".
|
||||
#
|
||||
|
||||
#
|
||||
# Copyright (c) 2009, 2010, 2011 Tobias Rautenkranz <tobias@rautenkranz.ch>
|
||||
#
|
||||
# Redistribution and use is allowed according to the terms of the New
|
||||
# BSD license.
|
||||
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
|
||||
#
|
||||
|
||||
macro(usedoxygen_set_default name value type docstring)
|
||||
if(NOT DEFINED "${name}")
|
||||
set("${name}" "${value}" CACHE "${type}" "${docstring}")
|
||||
endif()
|
||||
endmacro()
|
||||
|
||||
find_package(Doxygen)
|
||||
|
||||
if(DOXYGEN_FOUND)
|
||||
find_file(DOXYFILE_IN "Doxyfile.in"
|
||||
PATHS "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_ROOT}/Modules/"
|
||||
NO_DEFAULT_PATH
|
||||
DOC "Path to the doxygen configuration template file")
|
||||
set(DOXYFILE "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
|
||||
include(FindPackageHandleStandardArgs)
|
||||
find_package_handle_standard_args(DOXYFILE_IN DEFAULT_MSG "DOXYFILE_IN")
|
||||
endif()
|
||||
|
||||
if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
|
||||
usedoxygen_set_default(DOXYFILE_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doc"
|
||||
PATH "Doxygen output directory")
|
||||
usedoxygen_set_default(DOXYFILE_HTML_DIR "html"
|
||||
STRING "Doxygen HTML output directory")
|
||||
usedoxygen_set_default(DOXYFILE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}"
|
||||
PATH "Input files source directory")
|
||||
usedoxygen_set_default(DOXYFILE_EXTRA_SOURCE_DIRS ""
|
||||
STRING "Additional source files/directories separated by space")
|
||||
set(DOXYFILE_SOURCE_DIRS "\"${DOXYFILE_SOURCE_DIR}\" ${DOXYFILE_EXTRA_SOURCES}")
|
||||
|
||||
usedoxygen_set_default(DOXYFILE_LATEX YES BOOL "Generate LaTeX API documentation" OFF)
|
||||
usedoxygen_set_default(DOXYFILE_LATEX_DIR "latex" STRING "LaTex output directory")
|
||||
|
||||
mark_as_advanced(DOXYFILE_OUTPUT_DIR DOXYFILE_HTML_DIR DOXYFILE_LATEX_DIR
|
||||
DOXYFILE_SOURCE_DIR DOXYFILE_EXTRA_SOURCE_DIRS DOXYFILE_IN)
|
||||
|
||||
|
||||
set_property(DIRECTORY
|
||||
APPEND PROPERTY
|
||||
ADDITIONAL_MAKE_CLEAN_FILES
|
||||
"${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_HTML_DIR}")
|
||||
|
||||
add_custom_target(doxygen
|
||||
COMMAND "${DOXYGEN_EXECUTABLE}"
|
||||
"${DOXYFILE}"
|
||||
COMMENT "Writing documentation to ${DOXYFILE_OUTPUT_DIR}..."
|
||||
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
|
||||
|
||||
set(DOXYFILE_DOT "NO")
|
||||
if(DOXYGEN_DOT_EXECUTABLE)
|
||||
set(DOXYFILE_DOT "YES")
|
||||
endif()
|
||||
|
||||
## LaTeX
|
||||
set(DOXYFILE_PDFLATEX "NO")
|
||||
|
||||
set_property(DIRECTORY APPEND PROPERTY
|
||||
ADDITIONAL_MAKE_CLEAN_FILES
|
||||
"${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
|
||||
|
||||
if(DOXYFILE_LATEX STREQUAL "ON")
|
||||
set(DOXYFILE_GENERATE_LATEX "YES")
|
||||
find_package(LATEX)
|
||||
find_program(DOXYFILE_MAKE make)
|
||||
mark_as_advanced(DOXYFILE_MAKE)
|
||||
if(LATEX_COMPILER AND MAKEINDEX_COMPILER AND DOXYFILE_MAKE)
|
||||
if(PDFLATEX_COMPILER)
|
||||
set(DOXYFILE_PDFLATEX "YES")
|
||||
endif()
|
||||
|
||||
add_custom_command(TARGET doxygen
|
||||
POST_BUILD
|
||||
COMMAND "${DOXYFILE_MAKE}"
|
||||
COMMENT "Running LaTeX for Doxygen documentation in ${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}..."
|
||||
WORKING_DIRECTORY "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
|
||||
else()
|
||||
set(DOXYGEN_LATEX "NO")
|
||||
endif()
|
||||
else()
|
||||
set(DOXYFILE_GENERATE_LATEX "NO")
|
||||
endif()
|
||||
|
||||
|
||||
configure_file("${DOXYFILE_IN}" "${DOXYFILE}" @ONLY)
|
||||
|
||||
get_target_property(DOC_TARGET doc TYPE)
|
||||
if(NOT DOC_TARGET)
|
||||
add_custom_target(doc)
|
||||
endif()
|
||||
|
||||
add_dependencies(doc doxygen)
|
||||
endif()
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
include(UseDoxygen OPTIONAL)
|
||||
|
||||
add_custom_target(__copy_img COMMAND ${CMAKE_COMMAND} -E copy_directory
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/img/
|
||||
${CMAKE_CURRENT_BINARY_DIR}/html/)
|
||||
|
||||
add_dependencies(doc __copy_img)
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,273 @@
|
|||
/*
|
||||
Author:
|
||||
Andres Blanc <andresblanc@gmail.com>
|
||||
DaveMDS Andreoli <dave@gurumeditation.it>
|
||||
|
||||
Supported Browsers:
|
||||
ie7, opera9, konqueror4 and firefox3
|
||||
|
||||
Please use a different file for ie6, ie5, etc. hacks.
|
||||
*/
|
||||
|
||||
|
||||
/* Necessary to place the footer at the bottom of the page */
|
||||
html, body {
|
||||
height: 100%;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
#container {
|
||||
min-height: 100%;
|
||||
height: auto !important;
|
||||
height: 100%;
|
||||
margin: 0 auto -53px;
|
||||
}
|
||||
|
||||
#footer, #push {
|
||||
height: 53px;
|
||||
}
|
||||
|
||||
|
||||
* html #container {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
/* Prevent floating elements overflowing containers */
|
||||
.clear {
|
||||
clear: both;
|
||||
width: 0px;
|
||||
height: 0px;
|
||||
}
|
||||
|
||||
/* Flexible & centered layout from 750 to 960 pixels */
|
||||
.layout {
|
||||
max-width: 960px;
|
||||
min-width: 760px;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
body {
|
||||
/*font-family: Lucida Grande, Helvetica, sans-serif;*/
|
||||
font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif
|
||||
}
|
||||
|
||||
/* Prevent design overflowing the viewport in small resolutions */
|
||||
#container {
|
||||
padding-right: 17px;
|
||||
padding-left: 17px;
|
||||
background-image: url(head_bg.png);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
/****************************/
|
||||
/* Top main menu */
|
||||
/****************************/
|
||||
#header_logo {
|
||||
background-image : url(logo.png);
|
||||
width : 61px;
|
||||
}
|
||||
|
||||
#header_logo a {
|
||||
position : absolute;
|
||||
border : 0px;
|
||||
background-color : transparent;
|
||||
top : 0px;
|
||||
width : 60px;
|
||||
height : 60px;
|
||||
}
|
||||
|
||||
#header_menu {
|
||||
background-image : url(header_menu_background.png);
|
||||
font : normal 10pt verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
|
||||
text-align : right;
|
||||
}
|
||||
|
||||
#header_last {
|
||||
background-image : url(header_menu_background_last.png);
|
||||
width : 15px;
|
||||
}
|
||||
|
||||
td.nav_passive {
|
||||
background : url(header_menu_unselected_background.png) 0 0 no-repeat;
|
||||
height : 63px;
|
||||
font-family : "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
|
||||
font-size : 11px;
|
||||
padding : 20px 10px 20px 10px;
|
||||
vertical-align : middle;
|
||||
}
|
||||
|
||||
td.nav_active {
|
||||
background : url(header_menu_current_background.png) 0 0 no-repeat;
|
||||
height : 63px;
|
||||
color : #646464;
|
||||
font-family : "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
|
||||
font-size : 11px;
|
||||
font-weight : bold;
|
||||
padding : 20px 10px 20px 10px;
|
||||
vertical-align : middle;
|
||||
}
|
||||
|
||||
#header_menu a {
|
||||
display : block;
|
||||
text-decoration : none;
|
||||
cursor : pointer;
|
||||
color : #cdcdcd;
|
||||
}
|
||||
|
||||
|
||||
|
||||
#header {
|
||||
width: 100%;
|
||||
height: 102px;
|
||||
}
|
||||
|
||||
#header h1 {
|
||||
width: 63px;
|
||||
height: 63px;
|
||||
position: absolute;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
#header h1 span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#header h2 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* .menu-container is used to set properties common to .menu and .submenu */
|
||||
#header .menu-container {
|
||||
}
|
||||
|
||||
#header .menu-container ul {
|
||||
list-style-type: none;
|
||||
list-style-position: inside;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
#header .menu-container li {
|
||||
display: block;
|
||||
float: right;
|
||||
}
|
||||
|
||||
#header .menu {
|
||||
height: 63px;
|
||||
display: block;
|
||||
background-image: url(menu_bg.png);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
#header .menu ul {
|
||||
height: 100%;
|
||||
display: block;
|
||||
background-image: url(menu_bg_last.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: top right;
|
||||
padding-right: 17px;
|
||||
}
|
||||
|
||||
#header .menu li {
|
||||
height: 100%;
|
||||
text-align: center;
|
||||
background-image: url(menu_bg_unsel.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu a {
|
||||
height: 100%;
|
||||
display: block;
|
||||
color: #cdcdcd;
|
||||
text-decoration: none;
|
||||
font-size: 10pt;
|
||||
line-height: 59px;
|
||||
text-align: center;
|
||||
padding: 0px 15px 0px 15px;
|
||||
}
|
||||
|
||||
#header .menu li:hover {
|
||||
background-image: url(menu_bg_hover.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu li:hover a {
|
||||
color: #FFFFFF;
|
||||
}
|
||||
|
||||
#header .menu li.current {
|
||||
background-image: url(menu_bg_current.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu li.current a {
|
||||
color: #646464;
|
||||
}
|
||||
|
||||
|
||||
/* Hide all the submenus but the current */
|
||||
#header .submenu ul {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#header .submenu .current {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#header .submenu {
|
||||
font: bold 10px verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
#header .submenu a {
|
||||
color: #888888;
|
||||
text-decoration: none;
|
||||
font-size: 0.9em;
|
||||
line-height: 15px;
|
||||
padding:0px 5px 0px 5px;
|
||||
}
|
||||
|
||||
#header .submenu a:hover {
|
||||
color: #444444;
|
||||
}
|
||||
|
||||
#header .submenu li {
|
||||
border-left: 1px solid #DDDDDD;
|
||||
}
|
||||
|
||||
#header .submenu li:last-child {
|
||||
border-left: 0;
|
||||
}
|
||||
|
||||
#header .doxytitle {
|
||||
position: absolute;
|
||||
font-size: 1.8em;
|
||||
font-weight: bold;
|
||||
color: #444444;
|
||||
line-height: 35px;
|
||||
}
|
||||
|
||||
#header small {
|
||||
font-size: 0.4em;
|
||||
}
|
||||
|
||||
#footer {
|
||||
background-image: url(foot_bg.png);
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
#footer table {
|
||||
width: 100%;
|
||||
text-align: center;
|
||||
white-space: nowrap;
|
||||
padding: 5px 30px 5px 30px;
|
||||
font-size: 0.8em;
|
||||
font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
|
||||
color: #888888;
|
||||
}
|
||||
|
||||
#footer td.copyright {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
|
||||
<div id="push"></div>
|
||||
</div> <!-- #content -->
|
||||
</div> <!-- .layout -->
|
||||
|
||||
</div> <!-- #container -->
|
||||
|
||||
|
||||
<div id="footer">
|
||||
<table><tr>
|
||||
<td class="poweredby"><img src="doxygen.png"></td>
|
||||
<td>Samsung Electronics is supporting the EFL Documentation Project</td>
|
||||
<td class="copyright">Copyright ©$year Enlightenment</td>
|
||||
<td class="generated">Docs generated $datetime</td>
|
||||
</tr></table>
|
||||
</div>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>$title</title>
|
||||
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
|
||||
<meta name="author" content="Andres Blanc" >
|
||||
|
||||
<link rel="icon" href="img/favicon.png" type="image/x-icon">
|
||||
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
|
||||
<link rel="icon" href="img/favicon.png" type="image/ico">
|
||||
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="e.css">
|
||||
<link rel="stylesheet" type="text/css" href="edoxy.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="header">
|
||||
<div class="layout">
|
||||
|
||||
<h1><span>Enlightenment</span></h1>
|
||||
<h2><span>Beauty at your fingertips</span></h2>
|
||||
|
||||
<table cellspacing="0" cellpadding="0" width="100%"><tr>
|
||||
<td id="header_logo">
|
||||
<a href="http://www.enlightenment.org"></a>
|
||||
</td>
|
||||
<td id="header_menu">
|
||||
<table cellspacing="0" cellpadding="0" align="right"><tr>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=home">Home</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=news">News</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=about">About</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=download">Download</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=support">Support</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contact">Contact</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://trac.enlightenment.org/e">Tracker</a></td>
|
||||
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=docs">Docs</a></td>
|
||||
</tr></table>
|
||||
</td>
|
||||
<td id="header_last"></td>
|
||||
</tr></table>
|
||||
|
||||
<div class="doxytitle">
|
||||
$projectname Documentation <small>at $date</small>
|
||||
</div>
|
||||
|
||||
<div class="menu-container">
|
||||
<div class="submenu">
|
||||
<ul class="current">
|
||||
<li><a href="files.html">Files</a></li>
|
||||
<li><a href="modules.html">Modules</a></li>
|
||||
<li><a href="pages.html">Related Pages</a></li>
|
||||
<li class="current"><a href="index.html">Main Page</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
<div class="layout">
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
|
|
@ -0,0 +1,483 @@
|
|||
/*
|
||||
* This file contain a custom doxygen style to match e.org graphics
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/* BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
|
||||
font-family: Geneva, Arial, Helvetica, sans-serif;
|
||||
}*/
|
||||
BODY, TD {
|
||||
font-size: 12px;
|
||||
}
|
||||
H1 {
|
||||
text-align: center;
|
||||
font-size: 160%;
|
||||
}
|
||||
H2 {
|
||||
font-size: 120%;
|
||||
}
|
||||
H3 {
|
||||
font-size: 100%;
|
||||
}
|
||||
CAPTION {
|
||||
font-weight: bold
|
||||
}
|
||||
DIV.qindex {
|
||||
width: 100%;
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
padding: 2px;
|
||||
line-height: 140%;
|
||||
}
|
||||
DIV.navpath {
|
||||
width: 100%;
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
padding: 2px;
|
||||
line-height: 140%;
|
||||
}
|
||||
DIV.navtab {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
TD.navtab {
|
||||
font-size: 70%;
|
||||
}
|
||||
A.qindex {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
color: #1A419D;
|
||||
}
|
||||
A.qindex:visited {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
color: #1A419D
|
||||
}
|
||||
A.qindex:hover {
|
||||
text-decoration: none;
|
||||
background-color: #ddddff;
|
||||
}
|
||||
A.qindexHL {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff;
|
||||
border: 1px double #9295C2;
|
||||
}
|
||||
A.qindexHL:hover {
|
||||
text-decoration: none;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff;
|
||||
}
|
||||
A.qindexHL:visited {
|
||||
text-decoration: none;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff
|
||||
}
|
||||
A.el {
|
||||
text-decoration: none;
|
||||
font-weight: bold
|
||||
}
|
||||
A.elRef {
|
||||
font-weight: bold
|
||||
}
|
||||
A.code:link {
|
||||
text-decoration: none;
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.code:visited {
|
||||
text-decoration: none;
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.codeRef:link {
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.codeRef:visited {
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A:hover, A:visited:hover {
|
||||
text-decoration: none;
|
||||
/* background-color: #f2f2ff; */
|
||||
color: #000055;
|
||||
}
|
||||
A.anchor {
|
||||
color: #000;
|
||||
}
|
||||
DL.el {
|
||||
margin-left: -1cm
|
||||
}
|
||||
.fragment {
|
||||
font-family: monospace, fixed;
|
||||
font-size: 95%;
|
||||
}
|
||||
PRE.fragment {
|
||||
border: 1px solid #CCCCCC;
|
||||
background-color: #f5f5f5;
|
||||
margin-top: 4px;
|
||||
margin-bottom: 4px;
|
||||
margin-left: 2px;
|
||||
margin-right: 8px;
|
||||
padding-left: 6px;
|
||||
padding-right: 6px;
|
||||
padding-top: 4px;
|
||||
padding-bottom: 4px;
|
||||
}
|
||||
DIV.ah {
|
||||
background-color: black;
|
||||
font-weight: bold;
|
||||
color: #ffffff;
|
||||
margin-bottom: 3px;
|
||||
margin-top: 3px
|
||||
}
|
||||
|
||||
DIV.groupHeader {
|
||||
margin-left: 16px;
|
||||
margin-top: 12px;
|
||||
margin-bottom: 6px;
|
||||
font-weight: bold;
|
||||
}
|
||||
DIV.groupText {
|
||||
margin-left: 16px;
|
||||
font-style: italic;
|
||||
font-size: 90%
|
||||
}
|
||||
/*BODY {
|
||||
background: white;
|
||||
color: black;
|
||||
margin-right: 20px;
|
||||
margin-left: 20px;
|
||||
}*/
|
||||
TD.indexkey {
|
||||
background-color: #e8eef2;
|
||||
font-weight: bold;
|
||||
padding-right : 10px;
|
||||
padding-top : 2px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
TD.indexvalue {
|
||||
background-color: #e8eef2;
|
||||
font-style: italic;
|
||||
padding-right : 10px;
|
||||
padding-top : 2px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
TR.memlist {
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
P.formulaDsp {
|
||||
text-align: center;
|
||||
}
|
||||
IMG.formulaDsp {
|
||||
}
|
||||
IMG.formulaInl {
|
||||
vertical-align: middle;
|
||||
}
|
||||
SPAN.keyword { color: #008000 }
|
||||
SPAN.keywordtype { color: #604020 }
|
||||
SPAN.keywordflow { color: #e08000 }
|
||||
SPAN.comment { color: #800000 }
|
||||
SPAN.preprocessor { color: #806020 }
|
||||
SPAN.stringliteral { color: #002080 }
|
||||
SPAN.charliteral { color: #008080 }
|
||||
SPAN.vhdldigit { color: #ff00ff }
|
||||
SPAN.vhdlchar { color: #000000 }
|
||||
SPAN.vhdlkeyword { color: #700070 }
|
||||
SPAN.vhdllogic { color: #ff0000 }
|
||||
|
||||
.mdescLeft {
|
||||
padding: 0px 8px 4px 8px;
|
||||
font-size: 80%;
|
||||
font-style: italic;
|
||||
background-color: #FAFAFA;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px;
|
||||
}
|
||||
.mdescRight {
|
||||
padding: 0px 8px 4px 8px;
|
||||
font-size: 80%;
|
||||
font-style: italic;
|
||||
background-color: #FAFAFA;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px;
|
||||
}
|
||||
.memItemLeft {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memItemRight {
|
||||
padding: 1px 8px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplItemLeft {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: none;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplItemRight {
|
||||
padding: 1px 8px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: none;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplParams {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
color: #606060;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.search {
|
||||
color: #003399;
|
||||
font-weight: bold;
|
||||
}
|
||||
FORM.search {
|
||||
margin-bottom: 0px;
|
||||
margin-top: 0px;
|
||||
}
|
||||
INPUT.search {
|
||||
font-size: 75%;
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
background-color: #e8eef2;
|
||||
}
|
||||
TD.tiny {
|
||||
font-size: 75%;
|
||||
}
|
||||
a {
|
||||
color: #1A41A8;
|
||||
}
|
||||
a:visited {
|
||||
color: #2A3798;
|
||||
}
|
||||
.dirtab {
|
||||
padding: 4px;
|
||||
border-collapse: collapse;
|
||||
border: 1px solid #84b0c7;
|
||||
}
|
||||
TH.dirtab {
|
||||
background: #e8eef2;
|
||||
font-weight: bold;
|
||||
}
|
||||
HR {
|
||||
height: 1px;
|
||||
border: none;
|
||||
border-top: 1px solid black;
|
||||
}
|
||||
|
||||
/* Style for detailed member documentation */
|
||||
.memtemplate {
|
||||
font-size: 80%;
|
||||
color: #606060;
|
||||
font-weight: normal;
|
||||
margin-left: 3px;
|
||||
}
|
||||
.memnav {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
.memitem {
|
||||
padding: 4px;
|
||||
background-color: #eef3f5;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #dedeee;
|
||||
-moz-border-radius: 8px 8px 8px 8px;
|
||||
}
|
||||
.memname {
|
||||
white-space: nowrap;
|
||||
font-weight: bold;
|
||||
}
|
||||
.memdoc{
|
||||
padding-left: 10px;
|
||||
}
|
||||
.memproto {
|
||||
background-color: #d5e1e8;
|
||||
width: 100%;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #84b0c7;
|
||||
font-weight: bold;
|
||||
-moz-border-radius: 8px 8px 8px 8px;
|
||||
}
|
||||
.paramkey {
|
||||
text-align: right;
|
||||
}
|
||||
.paramtype {
|
||||
white-space: nowrap;
|
||||
}
|
||||
.paramname {
|
||||
color: #602020;
|
||||
font-style: italic;
|
||||
white-space: nowrap;
|
||||
}
|
||||
/* End Styling for detailed member documentation */
|
||||
|
||||
/* for the tree view */
|
||||
.ftvtree {
|
||||
font-family: sans-serif;
|
||||
margin:0.5em;
|
||||
}
|
||||
/* these are for tree view when used as main index */
|
||||
.directory {
|
||||
font-size: 9pt;
|
||||
font-weight: bold;
|
||||
}
|
||||
.directory h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
/* The following two styles can be used to replace the root node title */
|
||||
/* with an image of your choice. Simply uncomment the next two styles, */
|
||||
/* specify the name of your image and be sure to set 'height' to the */
|
||||
/* proper pixel height of your image. */
|
||||
|
||||
/* .directory h3.swap { */
|
||||
/* height: 61px; */
|
||||
/* background-repeat: no-repeat; */
|
||||
/* background-image: url("yourimage.gif"); */
|
||||
/* } */
|
||||
/* .directory h3.swap span { */
|
||||
/* display: none; */
|
||||
/* } */
|
||||
|
||||
.directory > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
.directory p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.directory div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
.directory img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
/* these are for tree view when not used as main index */
|
||||
.directory-alt {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
.directory-alt h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
.directory-alt > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
.directory-alt p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.directory-alt div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
.directory-alt img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 173 B |
Binary file not shown.
|
After Width: | Height: | Size: 214 B |
Binary file not shown.
|
After Width: | Height: | Size: 192 B |
Binary file not shown.
|
After Width: | Height: | Size: 637 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 192 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 637 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
|
|
@ -4,7 +4,22 @@
|
|||
#include <stdarg.h>
|
||||
#include <Eina.h>
|
||||
|
||||
/* Check that the types are castable and cast them. */
|
||||
/**
|
||||
* @defgroup Eobj Eobj Generic Object System
|
||||
*
|
||||
* The Eobj generic object system. It was designed to be the base object
|
||||
* system for the EFL.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @def EOBJ_TYPECHECK(type, x)
|
||||
*
|
||||
* Checks x is castable to type "type" and casts it to it.
|
||||
* @param type The C type to check against.
|
||||
* @param x the variable to test and cast.
|
||||
*/
|
||||
#define EOBJ_TYPECHECK(type, x) \
|
||||
({ \
|
||||
type __x; \
|
||||
|
|
@ -13,117 +28,431 @@
|
|||
(type) x; \
|
||||
})
|
||||
|
||||
#define EOBJ_ARRAY_SIZE(arr) (sizeof(arr) / sizeof(*arr))
|
||||
|
||||
/**
|
||||
* @typedef Eobj
|
||||
* The basic Object type.
|
||||
*/
|
||||
typedef struct _Eobj Eobj;
|
||||
/**
|
||||
* @typedef Eobj_Op
|
||||
* The Eobj operation type id.
|
||||
*/
|
||||
typedef unsigned int Eobj_Op;
|
||||
|
||||
/**
|
||||
* @def EOBJ_NOOP
|
||||
* A special Eobj_Op meaning "No operation".
|
||||
*/
|
||||
#define EOBJ_NOOP ((Eobj_Op) 0)
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Class
|
||||
* The basic Object class type.
|
||||
*/
|
||||
typedef struct _Eobj_Class Eobj_Class;
|
||||
typedef int Eobj_Class_Id;
|
||||
|
||||
typedef enum
|
||||
/**
|
||||
* An enum representing the possible types of an Eobj class.
|
||||
*/
|
||||
enum _Eobj_Class_Type
|
||||
{
|
||||
EOBJ_CLASS_TYPE_REGULAR = 0,
|
||||
EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT,
|
||||
EOBJ_CLASS_TYPE_INTERFACE,
|
||||
EOBJ_CLASS_TYPE_MIXIN
|
||||
} Eobj_Class_Type;
|
||||
EOBJ_CLASS_TYPE_REGULAR = 0, /**< Regular class. */
|
||||
EOBJ_CLASS_TYPE_REGULAR_NO_INSTANT, /**< Regular non instant-able class. */
|
||||
EOBJ_CLASS_TYPE_INTERFACE, /**< Interface */
|
||||
EOBJ_CLASS_TYPE_MIXIN /**< Mixin */
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Class_Type
|
||||
* A convenience typedef for #_Eobj_Class_Type.
|
||||
*/
|
||||
typedef enum _Eobj_Class_Type Eobj_Class_Type;
|
||||
|
||||
/**
|
||||
* @typedef eobj_op_func_type
|
||||
* The type of the Op functions. This is the type of the functions used by
|
||||
* Eobj.
|
||||
*/
|
||||
typedef void (*eobj_op_func_type)(Eobj *, void *class_data, va_list *list);
|
||||
|
||||
typedef struct
|
||||
/**
|
||||
* @struct _Eobj_Op_Func_Description
|
||||
* Used to associate an Op with a func.
|
||||
* @see eobj_class_funcs_set
|
||||
*/
|
||||
struct _Eobj_Op_Func_Description
|
||||
{
|
||||
Eobj_Op op;
|
||||
eobj_op_func_type func;
|
||||
} Eobj_Op_Func_Description;
|
||||
Eobj_Op op; /**< The op */
|
||||
eobj_op_func_type func; /**< The function to call for the op. */
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Op_Func_Description
|
||||
* A convenience typedef for #_Eobj_Op_Func_Description
|
||||
*/
|
||||
typedef struct _Eobj_Op_Func_Description Eobj_Op_Func_Description;
|
||||
|
||||
/**
|
||||
* @def EOBJ_OP_FUNC(op, func)
|
||||
* A convenience macro to be used when populating the #Eobj_Op_Func_Description
|
||||
* array.
|
||||
*/
|
||||
#define EOBJ_OP_FUNC(op, func) { op, func }
|
||||
/**
|
||||
* @def EOBJ_OP_FUNC_SENTINEL
|
||||
* A convenience macro to be used when populating the #Eobj_Op_Func_Description
|
||||
* array. It must appear at the end of the ARRAY.
|
||||
*/
|
||||
#define EOBJ_OP_FUNC_SENTINEL { 0, NULL }
|
||||
|
||||
typedef struct
|
||||
/**
|
||||
* @struct _Eobj_Event_Description
|
||||
* This struct holds the description of a specific event.
|
||||
*/
|
||||
struct _Eobj_Event_Description
|
||||
{
|
||||
const char *name; /**< name used for lookups */
|
||||
const char *type; /**< used for introspection purposes, documents what goes as callback event information (@c event_info) */
|
||||
const char *doc; /**< documentation for introspection purposes */
|
||||
} Eobj_Event_Description;
|
||||
const char *name; /**< name of the event. */
|
||||
const char *type; /**< describes the data passed in event_info */
|
||||
const char *doc; /**< Explanation about the event. */
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Event_Description
|
||||
* A convenience typedef for #_Eobj_Event_Description
|
||||
*/
|
||||
typedef struct _Eobj_Event_Description Eobj_Event_Description;
|
||||
|
||||
|
||||
typedef struct
|
||||
/**
|
||||
* @struct _Eobj_Op_Description
|
||||
* This struct holds the description of a specific op.
|
||||
*/
|
||||
struct _Eobj_Op_Description
|
||||
{
|
||||
Eobj_Op sub_op;
|
||||
const char *name;
|
||||
/* FIXME: properly define the type so it'll support get/set and etc.
|
||||
* Do I even need/want type? If so, do I need/want it here? docs aren't
|
||||
* enough? */
|
||||
const char *type;
|
||||
const char *doc;
|
||||
} Eobj_Op_Description;
|
||||
Eobj_Op sub_op; /**< The sub_id of the op in it's class. */
|
||||
const char *name; /**< The name of the op. */
|
||||
const char *type; /**< descripbes the Op's function signature. */
|
||||
const char *doc; /**< Explanation about the Op. */
|
||||
};
|
||||
|
||||
typedef struct
|
||||
/**
|
||||
* @typedef Eobj_Op_Description
|
||||
* A convenience typedef for #_Eobj_Op_Description
|
||||
*/
|
||||
typedef struct _Eobj_Op_Description Eobj_Op_Description;
|
||||
|
||||
/**
|
||||
* @struct _Eobj_Class_Description
|
||||
* This struct holds the description of a class.
|
||||
* This description should be passed to eobj_class_new.
|
||||
* Please use the #EOBJ_CLASS_DESCRIPTION_OPS macro when populating it.
|
||||
*/
|
||||
struct _Eobj_Class_Description
|
||||
{
|
||||
const char *name;
|
||||
Eobj_Class_Type type;
|
||||
const char *name; /**< The name of the class. */
|
||||
Eobj_Class_Type type; /**< The type of the class. */
|
||||
struct {
|
||||
Eobj_Op *base_op_id;
|
||||
const Eobj_Op_Description *descs;
|
||||
size_t count;
|
||||
} ops;
|
||||
const Eobj_Event_Description **events;
|
||||
size_t data_size;
|
||||
void (*constructor)(Eobj *obj, void *class_data);
|
||||
void (*destructor)(Eobj *obj, void *class_data);
|
||||
void (*class_constructor)(Eobj_Class *klass);
|
||||
void (*class_destructor)(Eobj_Class *klass);
|
||||
} Eobj_Class_Description;
|
||||
} ops; /**< The ops description, should be filled using #EOBJ_CLASS_DESCRIPTION_OPS */
|
||||
const Eobj_Event_Description **events; /**< The event descriptions for this class. */
|
||||
size_t data_size; /**< The size of data (private + protected + public) this class needs per object. */
|
||||
void (*constructor)(Eobj *obj, void *class_data); /**< The constructor of the object. */
|
||||
void (*destructor)(Eobj *obj, void *class_data); /**< The destructor of the object. */
|
||||
void (*class_constructor)(Eobj_Class *klass); /**< The constructor of the class. */
|
||||
void (*class_destructor)(Eobj_Class *klass); /**< The destructor of the class. */
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Class_Description
|
||||
* A convenience typedef for #_Eobj_Class_Description
|
||||
*/
|
||||
typedef struct _Eobj_Class_Description Eobj_Class_Description;
|
||||
|
||||
/**
|
||||
* @def EOBJ_CLASS_DESCRIPTION_OPS(base_op_id, op_descs, count)
|
||||
* An helper macro to help populating #Eobj_Class_Description.
|
||||
* @param base_op_id A pointer to the base op id of the class.
|
||||
* @param op_descs the op descriptions array.
|
||||
* @param count the number of ops in the op descriptions array.
|
||||
*/
|
||||
#define EOBJ_CLASS_DESCRIPTION_OPS(base_op_id, op_descs, count) { base_op_id, op_descs, count }
|
||||
|
||||
#define EOBJ_OP_DESCRIPTION(op, type, doc) { op, #op, type, doc }
|
||||
/**
|
||||
* @def EOBJ_OP_DESCRIPTION(op, type, doc)
|
||||
* An helper macro to help populating #Eobj_Op_Description
|
||||
* @param sub_id The sub id of the op being described.
|
||||
* @param type The type string for the op.
|
||||
* @param doc Additional doc for the op.
|
||||
* @see Eobj_Op_Description
|
||||
* @see EOBJ_OP_DESCRIPTION_SENTINEL
|
||||
*/
|
||||
#define EOBJ_OP_DESCRIPTION(sub_id, type, doc) { sub_id, #sub_id, type, doc }
|
||||
/**
|
||||
* @def EOBJ_OP_DESCRIPTION_SENTINEL
|
||||
* An helper macro to help populating #Eobj_Op_Description
|
||||
* Should be placed at the end of the array.
|
||||
* @see Eobj_Op_Description
|
||||
* @see EOBJ_OP_DESCRIPTION
|
||||
*/
|
||||
#define EOBJ_OP_DESCRIPTION_SENTINEL { 0, NULL, NULL, NULL }
|
||||
|
||||
/**
|
||||
* @def EOBJ_EVENT_DESCRIPTION(name, type, doc)
|
||||
* An helper macro to help populating #Eobj_Event_Description
|
||||
* @param name The name of the event.
|
||||
* @param type The type string of the event.
|
||||
* @param doc Additional doc for the event.
|
||||
* @see Eobj_Event_Description
|
||||
*/
|
||||
#define EOBJ_EVENT_DESCRIPTION(name, type, doc) { name, type, doc }
|
||||
|
||||
/**
|
||||
* @brief Init the eobj subsystem
|
||||
* @return #EINA_TRUE on success.
|
||||
*
|
||||
* @see eobj_shutfown()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_init(void);
|
||||
|
||||
/**
|
||||
* @brief Shutdown the eobj subsystem
|
||||
* @return #EINA_TRUE on success.
|
||||
*
|
||||
* @see eobj_init()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_shutdown(void);
|
||||
|
||||
/**
|
||||
* @def eobj_do
|
||||
* A convenience wrapper around eobj_do_internal()
|
||||
* @see eobj_do_internal
|
||||
*/
|
||||
#define eobj_do(object, ...) eobj_do_internal(object, __VA_ARGS__, (Eobj_Op) 0)
|
||||
|
||||
/**
|
||||
* @brief Issues ops on an object.
|
||||
* @param obj The object to work on
|
||||
* @param ... NULL terminated list of OPs and parameters.
|
||||
* @return #EINA_TRUE on success.
|
||||
*
|
||||
* Use the helper macros, don't pass the parameters manually.
|
||||
* Use #eobj_do instead of this function.
|
||||
*
|
||||
* @see #eobj_do
|
||||
*/
|
||||
EAPI Eina_Bool eobj_do_internal(Eobj *obj, ...);
|
||||
|
||||
/**
|
||||
* @brief Calls the super function for the specific op.
|
||||
* @param obj The object to work on
|
||||
* @param op The wanted op.
|
||||
* @param ... list of parameters.
|
||||
* @return #EINA_TRUE on success.
|
||||
*
|
||||
* Use the helper macros, don't pass the parameters manually.
|
||||
*
|
||||
* @see #eobj_do
|
||||
*/
|
||||
EAPI Eina_Bool eobj_super_do(Eobj *obj, Eobj_Op op, ...);
|
||||
|
||||
EAPI const Eobj_Class *eobj_class_get(Eobj *obj);
|
||||
/**
|
||||
* @brief Gets the class of the object.
|
||||
* @param obj The object to work on
|
||||
* @return The object's class.
|
||||
*
|
||||
* @see eobj_class_name_get()
|
||||
*/
|
||||
EAPI const Eobj_Class *eobj_class_get(const Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Gets the name of the passed class.
|
||||
* @param klass the class to work on.
|
||||
* @return The class's name.
|
||||
*
|
||||
* @see eobj_class_get()
|
||||
*/
|
||||
EAPI const char *eobj_class_name_get(const Eobj_Class *klass);
|
||||
|
||||
/**
|
||||
* @brief Calls the super constructor of the object passed.
|
||||
* @param obj the object to work on.
|
||||
*
|
||||
* @see eobj_destructor_super()
|
||||
*/
|
||||
EAPI void eobj_constructor_super(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Calls the super destructor of the object passed.
|
||||
* @param obj the object to work on.
|
||||
*
|
||||
* @see eobj_constructor_super()
|
||||
*/
|
||||
EAPI void eobj_destructor_super(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Notify eobj that there was an error when constructing the object.
|
||||
* @param obj the object to work on.
|
||||
*
|
||||
* (Should only be called from within a constructor/destructor).
|
||||
*
|
||||
* @see eobj_constructor_error_get()
|
||||
*/
|
||||
EAPI void eobj_constructor_error_set(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Check if there was an error constructing obj
|
||||
* @param obj the object to work on.
|
||||
* @return #EINA_TRUE if there was an error.
|
||||
*
|
||||
* (Should only be called from within a constructor/destructor).
|
||||
*
|
||||
* @see eobj_constructor_error_set()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_constructor_error_get(const Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Create a new class.
|
||||
* @param desc the class description to create the class with.
|
||||
* @param parent the class to inherit from.
|
||||
* @param ... A NULL terminated list of extensions (interfaces, mixins and the classes of any composite objects).
|
||||
* @return The new class's handle on success, or NULL otherwise.
|
||||
*/
|
||||
EAPI Eobj_Class *eobj_class_new(const Eobj_Class_Description *desc, const Eobj_Class *parent, ...);
|
||||
/* FIXME: Do I want that exposed? */
|
||||
EAPI void eobj_class_free(Eobj_Class *klass);
|
||||
|
||||
/**
|
||||
* @brief Sets the OP functions for a class.
|
||||
* @param klass the class to set the functions to.
|
||||
* @param func_descs a NULL terminated array of #Eobj_Op_Func_Description
|
||||
*
|
||||
* Should be called from within the class constructor.
|
||||
*/
|
||||
EAPI void eobj_class_funcs_set(Eobj_Class *klass, const Eobj_Op_Func_Description *func_descs);
|
||||
|
||||
/**
|
||||
* @brief Create a new object.
|
||||
* @param klass the class of the object to create.
|
||||
* @param parent the parent to set to the object.
|
||||
* @return An handle to the new object on success, NULL otherwise.
|
||||
*/
|
||||
EAPI Eobj *eobj_add(const Eobj_Class *klass, Eobj *parent);
|
||||
|
||||
/**
|
||||
* @brief Get the parent of an object
|
||||
* @param obj the object to get the parent of.
|
||||
* @return a pointer to the parent object.
|
||||
*/
|
||||
EAPI Eobj *eobj_parent_get(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Get a pointer to the data of an object for a specific class.
|
||||
* @param obj the object to work on.
|
||||
* @param klass the klass associated with the data.
|
||||
* @return a pointer to the data.
|
||||
*/
|
||||
EAPI void *eobj_data_get(Eobj *obj, const Eobj_Class *klass);
|
||||
|
||||
/**
|
||||
* @brief Increment the object's reference count by 1.
|
||||
* @param obj the object to work on.
|
||||
* @return The object passed.
|
||||
*
|
||||
* @see eobj_unref()
|
||||
* @see eobj_ref_get()
|
||||
*/
|
||||
EAPI Eobj *eobj_ref(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Decrement the object's reference count by 1 and free it if needed.
|
||||
* @param obj the object to work on.
|
||||
*
|
||||
* @see eobj_ref()
|
||||
* @see eobj_ref_get()
|
||||
*/
|
||||
EAPI void eobj_unref(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Return the ref count of the object passed.
|
||||
* @param obj the object to work on.
|
||||
* @return the ref count of the object.
|
||||
*
|
||||
* @see eobj_ref()
|
||||
* @see eobj_unref()
|
||||
*/
|
||||
EAPI int eobj_ref_get(const Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Delete the object passed (disregarding ref count).
|
||||
* @param obj the object to work on.
|
||||
*
|
||||
* @see eobj_unref()
|
||||
*/
|
||||
EAPI void eobj_del(Eobj *obj);
|
||||
|
||||
/**
|
||||
* @brief Set generic data to object.
|
||||
* @param obj the object to work on.
|
||||
* @param key the key associated with the data
|
||||
* @param data the data to set.
|
||||
* @return the previous data associated with the key.
|
||||
*
|
||||
* @see eobj_generic_data_get()
|
||||
* @see eobj_generic_data_del()
|
||||
*/
|
||||
EAPI void *eobj_generic_data_set(Eobj *obj, const char *key, const void *data);
|
||||
|
||||
/**
|
||||
* @brief Get generic data from object.
|
||||
* @param obj the object to work on.
|
||||
* @param key the key associated with the data
|
||||
* @return the data associated with the key.
|
||||
*
|
||||
* @see eobj_generic_data_set()
|
||||
* @see eobj_generic_data_del()
|
||||
*/
|
||||
EAPI void *eobj_generic_data_get(const Eobj *obj, const char *key);
|
||||
|
||||
/**
|
||||
* @brief Del generic data from object.
|
||||
* @param obj the object to work on.
|
||||
* @param key the key associated with the data
|
||||
* @return the data previously associated with the key.
|
||||
*
|
||||
* @see eobj_generic_data_set()
|
||||
* @see eobj_generic_data_get()
|
||||
*/
|
||||
EAPI void *eobj_generic_data_del(Eobj *obj, const char *key);
|
||||
|
||||
#define EOBJ_CLASS_BASE eobj_base_class_get()
|
||||
EAPI const Eobj_Class *eobj_base_class_get(void) EINA_CONST;
|
||||
/**
|
||||
* @brief Make an object a composite object of another.
|
||||
* @param obj the "parent" object.
|
||||
* @param comp_obj the object that will be used to composite obj.
|
||||
*
|
||||
* @see eobj_composite_object_detach()
|
||||
* @see eobj_composite_is()
|
||||
*/
|
||||
EAPI void eobj_composite_object_attach(Eobj *obj, Eobj *comp_obj);
|
||||
|
||||
EAPI void eobj_composite_object_attach(Eobj *obj, Eobj *emb_obj);
|
||||
EAPI void eobj_composite_object_detach(Eobj *obj, Eobj *emb_obj);
|
||||
EAPI Eina_Bool eobj_composite_is(Eobj *emb_obj);
|
||||
/**
|
||||
* @brief Detach a composite object from another object.
|
||||
* @param obj the "parent" object.
|
||||
* @param comp_obj the object attached to obj.
|
||||
*
|
||||
* @see eobj_composite_object_attach()
|
||||
* @see eobj_composite_is()
|
||||
*/
|
||||
EAPI void eobj_composite_object_detach(Eobj *obj, Eobj *comp_obj);
|
||||
|
||||
/**
|
||||
* @brief Check if an object is a composite object.
|
||||
* @param comp_obj the object to be checked.
|
||||
* @return #EINA_TRUE if it is, #EINA_FALSE otherwise.
|
||||
*
|
||||
* @see eobj_composite_object_attach()
|
||||
* @see eobj_composite_object_detach()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_composite_is(Eobj *comp_obj);
|
||||
|
||||
/* Events */
|
||||
/**
|
||||
|
|
@ -141,26 +470,166 @@ EAPI Eina_Bool eobj_composite_is(Eobj *emb_obj);
|
|||
* Slightly less prioritized than default.
|
||||
*/
|
||||
#define EOBJ_CALLBACK_PRIORITY_AFTER 100
|
||||
|
||||
/**
|
||||
* @typedef Eobj_Callback_Priority
|
||||
*
|
||||
* Callback priority value. Range is -32k - 32k. The lower the number, the
|
||||
* bigger the priority.
|
||||
*
|
||||
* @see EOBJ_CALLBACK_PRIORITY_AFTER
|
||||
* @see EOBJ_CALLBACK_PRIORITY_BEFORE
|
||||
* @see EOBJ_CALLBACK_PRIORITY_DEFAULT
|
||||
*/
|
||||
typedef short Eobj_Callback_Priority;
|
||||
|
||||
/* True meaning continue, False meaning stop callbacks. - Make it an enum? */
|
||||
/**
|
||||
* @typedef Eobj_Event_Cb
|
||||
*
|
||||
* An event callback prototype.
|
||||
*
|
||||
* @param data The user data registered with the callback.
|
||||
* @param obj The object which initiated the event.
|
||||
* @param desc The event's description.
|
||||
* @param event_info additional data passed with the event.
|
||||
* @return #EINA_FALSE to stop calling additional callbacks for the event, #EINA_TRUE to continue.
|
||||
*/
|
||||
typedef Eina_Bool (*Eobj_Event_Cb)(void *data, Eobj *obj, const Eobj_Event_Description *desc, void *event_info);
|
||||
|
||||
/**
|
||||
* @brief Add an event callback forwarder for an event and an object.
|
||||
* @param obj The object to listen to events on.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param new_obj The object to emit events from.
|
||||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
||||
*
|
||||
* @see eobj_event_callback_forwarder_del()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_event_callback_forwarder_add(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj);
|
||||
|
||||
/**
|
||||
* @brief Remove an event callback forwarder for an event and an object.
|
||||
* @param obj The object to listen to events on.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param new_obj The object to emit events from.
|
||||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
||||
*
|
||||
* @see eobj_event_callback_forwarder_add()
|
||||
*/
|
||||
EAPI Eina_Bool eobj_event_callback_forwarder_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj *new_obj);
|
||||
|
||||
/* callbacks of the same priority are called in reverse order of creation. */
|
||||
/**
|
||||
* @def eobj_event_callback_add(obj, desc, cb, data)
|
||||
* Add a callback for an event.
|
||||
* @param obj The object to listen to events on.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param cb the callback to call.
|
||||
* @param data additional data to pass to the callback.
|
||||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
||||
*
|
||||
* callbacks of the same priority are called in reverse order of creation.
|
||||
*
|
||||
* @see eobj_event_callback_priority_add()
|
||||
*/
|
||||
#define eobj_event_callback_add(obj, desc, cb, data) \
|
||||
eobj_event_callback_priority_add(obj, desc, \
|
||||
EOBJ_CALLBACK_PRIORITY_DEFAULT, cb, data)
|
||||
|
||||
/**
|
||||
* @brief Add a callback for an event with a specific priority.
|
||||
* @param obj The object to listen to events on.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param priority The priority of the callback.
|
||||
* @param cb the callback to call.
|
||||
* @param data additional data to pass to the callback.
|
||||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
||||
*
|
||||
* callbacks of the same priority are called in reverse order of creation.
|
||||
*
|
||||
* @see #eobj_event_callback_add
|
||||
*/
|
||||
EAPI Eina_Bool eobj_event_callback_priority_add(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Callback_Priority priority, Eobj_Event_Cb cb, const void *data);
|
||||
|
||||
/**
|
||||
* @brief Del a callback for an event
|
||||
* @param obj The object to listen to delete from.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param func the callback to delete.
|
||||
* @return The additional data that was set to be passed to the callback.
|
||||
*
|
||||
* @see eobj_event_callback_del_full()
|
||||
*/
|
||||
EAPI void *eobj_event_callback_del(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func);
|
||||
|
||||
/**
|
||||
* @brief Del a callback with a specific data associated to it for an event.
|
||||
* @param obj The object to listen to delete from.
|
||||
* @param desc The description of the event to listen to.
|
||||
* @param func the callback to delete.
|
||||
* @param user_data The data to compare.
|
||||
* @return The additional data that was set to be passed to the callback.
|
||||
*
|
||||
* @see eobj_event_callback_del()
|
||||
*/
|
||||
EAPI void *eobj_event_callback_del_full(Eobj *obj, const Eobj_Event_Description *desc, Eobj_Event_Cb func, const void *user_data);
|
||||
|
||||
/**
|
||||
* @brief Call the callbacks for an event of an object.
|
||||
* @param obj The object to work on.
|
||||
* @param desc The description of the event to call.
|
||||
* @param event_info Extra event info to pass to the callbacks.
|
||||
* @return #EINA_FALSE if one of the callbacks aborted the callback calls or #EINA_TRUE otherwise.
|
||||
*/
|
||||
EAPI Eina_Bool eobj_event_callback_call(Eobj *obj, const Eobj_Event_Description *desc, const void *event_info);
|
||||
|
||||
/**
|
||||
* @var _EOBJ_SIG_CALLBACK_ADD
|
||||
* see EOBJ_SIG_CALLBACK_ADD
|
||||
*/
|
||||
EAPI extern const Eobj_Event_Description _EOBJ_SIG_CALLBACK_ADD;
|
||||
|
||||
/**
|
||||
* @def EOBJ_SIG_CALLBACK_ADD
|
||||
* The event description (of type #Eobj_Event_Description) for
|
||||
* The "Callback listener added" event.
|
||||
*/
|
||||
#define EOBJ_SIG_CALLBACK_ADD (&(_EOBJ_SIG_CALLBACK_ADD))
|
||||
|
||||
/**
|
||||
* @var _EOBJ_SIG_CALLBACK_DEL
|
||||
* see EOBJ_SIG_CALLBACK_DEL
|
||||
*/
|
||||
EAPI extern const Eobj_Event_Description _EOBJ_SIG_CALLBACK_DEL;
|
||||
|
||||
/**
|
||||
* @def EOBJ_SIG_CALLBACK_DEL
|
||||
* The event description (of type #Eobj_Event_Description) for
|
||||
* The "Callback listener deleted" event.
|
||||
*/
|
||||
#define EOBJ_SIG_CALLBACK_DEL (&(_EOBJ_SIG_CALLBACK_DEL))
|
||||
|
||||
/**
|
||||
* @addtogroup Eobj_Class_Base Eobj's Base class.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @def EOBJ_CLASS_BASE
|
||||
* The class type for the Eobj base class.
|
||||
*/
|
||||
#define EOBJ_CLASS_BASE eobj_base_class_get()
|
||||
/**
|
||||
* @brief Use #EOBJ_CLASS_BASE
|
||||
* @internal
|
||||
* */
|
||||
EAPI const Eobj_Class *eobj_base_class_get(void) EINA_CONST;
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
#include "config.h"
|
||||
|
||||
typedef int Eobj_Class_Id;
|
||||
|
||||
static int _eobj_log_dom = -1;
|
||||
|
||||
static Eobj_Class **_eobj_classes;
|
||||
|
|
@ -422,7 +424,7 @@ eobj_super_do(Eobj *obj, Eobj_Op op, ...)
|
|||
}
|
||||
|
||||
EAPI const Eobj_Class *
|
||||
eobj_class_get(Eobj *obj)
|
||||
eobj_class_get(const Eobj *obj)
|
||||
{
|
||||
return obj->klass;
|
||||
}
|
||||
|
|
@ -545,6 +547,31 @@ eobj_class_funcs_set(Eobj_Class *klass, const Eobj_Op_Func_Description *func_des
|
|||
}
|
||||
}
|
||||
|
||||
void
|
||||
eobj_class_free(Eobj_Class *klass)
|
||||
{
|
||||
if (klass->constructed)
|
||||
{
|
||||
if (klass->desc->class_destructor)
|
||||
klass->desc->class_destructor(klass);
|
||||
|
||||
dich_func_clean_all(klass);
|
||||
}
|
||||
|
||||
{
|
||||
Eina_Inlist *itrn;
|
||||
Eobj_Extension_Node *extn;
|
||||
EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
|
||||
{
|
||||
free(extn);
|
||||
}
|
||||
}
|
||||
|
||||
free(klass->mro);
|
||||
|
||||
free(klass);
|
||||
}
|
||||
|
||||
EAPI Eobj_Class *
|
||||
eobj_class_new(const Eobj_Class_Description *desc, const Eobj_Class *parent, ...)
|
||||
{
|
||||
|
|
@ -662,31 +689,6 @@ cleanup:
|
|||
}
|
||||
#undef _CLS_NEW_CHECK
|
||||
|
||||
EAPI void
|
||||
eobj_class_free(Eobj_Class *klass)
|
||||
{
|
||||
if (klass->constructed)
|
||||
{
|
||||
if (klass->desc->class_destructor)
|
||||
klass->desc->class_destructor(klass);
|
||||
|
||||
dich_func_clean_all(klass);
|
||||
}
|
||||
|
||||
{
|
||||
Eina_Inlist *itrn;
|
||||
Eobj_Extension_Node *extn;
|
||||
EINA_INLIST_FOREACH_SAFE(klass->extensions, itrn, extn)
|
||||
{
|
||||
free(extn);
|
||||
}
|
||||
}
|
||||
|
||||
free(klass->mro);
|
||||
|
||||
free(klass);
|
||||
}
|
||||
|
||||
EAPI Eobj *
|
||||
eobj_add(const Eobj_Class *klass, Eobj *parent)
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue