diff --git a/sflphone-common/Makefile.am b/sflphone-common/Makefile.am
index 6d464df1bf37e8d39e06d4e3e91f6ecc220143b6..c5de2501fbb765d640061938f15ce4b259270a3a 100644
--- a/sflphone-common/Makefile.am
+++ b/sflphone-common/Makefile.am
@@ -18,6 +18,12 @@ unittest:
@echo " -- You need the cppunit devel package to compile the unitary tests."
endif
+doc:
+ @(cd doc; make)
+ @echo ""
+ @echo "D-Bus API HTML documentation has been generated in doc/dbus-api/doc/spec"
+ @echo ""
+
indent:
@echo "Indenting code:"
if [ -f $(ASTYLERC) ] ; then \
diff --git a/sflphone-common/configure.ac b/sflphone-common/configure.ac
index 96434834b6f544fc4da4751b583e5d54f003584a..5a412e3c47302b2eb152fa88d4ad860404b9945f 100644
--- a/sflphone-common/configure.ac
+++ b/sflphone-common/configure.ac
@@ -70,12 +70,12 @@ AC_CONFIG_FILES([Makefile])
dnl Unitary test section
AC_CONFIG_FILES([test/Makefile])
-
AC_CONFIG_FILES([ringtones/Makefile])
AC_CONFIG_FILES([man/Makefile])
AC_CONFIG_FILES([doc/Makefile \
+ doc/dbus-api/Makefile \
doc/doxygen/Makefile])
dnl the file stamp-h.in should be there before (instead of AC_CONFIG_HEADERS(config.h))
diff --git a/sflphone-common/doc/Makefile.am b/sflphone-common/doc/Makefile.am
index bbe34b9b1a6c74986447496e5d138d4902d5f937..f742c26ce5b69235cbafa55a31bf5292ffffa0e7 100644
--- a/sflphone-common/doc/Makefile.am
+++ b/sflphone-common/doc/Makefile.am
@@ -1,6 +1,6 @@
-SUBDIRS = doxygen
+SUBDIRS = doxygen dbus-api
.PHONY: doc
doc:
- $(MAKE) -C doxygen doc
\ No newline at end of file
+ $(MAKE) -C doxygen doc
diff --git a/sflphone-common/doc/dbus-api/Makefile.am b/sflphone-common/doc/dbus-api/Makefile.am
new file mode 100644
index 0000000000000000000000000000000000000000..ced9bceb9dcbb3635220042dfdc8cacd9f35fe13
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/Makefile.am
@@ -0,0 +1,28 @@
+include $(top_srcdir)/globals.mak
+
+XSLTPROC=xsltproc --xinclude --nonet
+PYTHON=python
+
+XMLS= $(wildcard $(top_srcdir)/src/dbus/spec/*.xml)
+TEMPLATES= $(wildcard doc/templates/*)
+
+GENERATED_FILES = \
+ doc/spec.html \
+ doc/spec/index.html
+
+doc/spec.html: $(XMLS) tools/doc-generator.xsl
+ @install -d tmp/doc
+ $(XSLTPROC) tools/doc-generator.xsl spec/all.xml > tmp/$@
+ mv tmp/$@ $@
+
+doc/spec/index.html: $(XMLS) tools/doc-generator.py tools/specparser.py $(TEMPLATES)
+ @install -d tmp/doc
+ $(PYTHON) tools/doc-generator.py spec/all.xml doc/spec sflphone-spec org.sflphone.SFLphone
+
+all: $(GENERATED_FILES)
+
+clean:
+ rm -rf $(GENERATED_FILES)
+ rm -rf doc/spec
+ rm -rf tmp
+
diff --git a/sflphone-common/doc/dbus-api/README b/sflphone-common/doc/dbus-api/README
new file mode 100644
index 0000000000000000000000000000000000000000..3adb69af24b6160d4339180ba0d31cc003ab850e
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/README
@@ -0,0 +1,7 @@
+SFLphone D-Bus API documentation. Generated with xsltproc.
+
+Wiki reference: https://projects.savoirfairelinux.com/wiki/sflphone/Dbus-API
+
+Run Makefile to generate the HTML API documentation, from the xml interfaces in *sflphone-common/src/dbus*.
+
+The documentation is generated in *sflphone-common/doc/dbus-api/doc/spec*
diff --git a/sflphone-common/doc/dbus-api/doc/templates/devhelp.devhelp2 b/sflphone-common/doc/dbus-api/doc/templates/devhelp.devhelp2
new file mode 100644
index 0000000000000000000000000000000000000000..af327fa6d99be647dc588b574b489ab6f6bf8ace
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/devhelp.devhelp2
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<book xmlns="http://www.devhelp.net/book" title="$spec.title" name="$name" link="index.html">
+ <chapters>
+#for $interface in $spec.interfaces
+ <sub name="$interface.name" link="$interface.get_url()"/>
+#end for
+ <sub name="Generic Types" link="generic-types.html"/>
+ <sub name="Errors" link="errors.html"/>
+ <sub name="Full Index" link="fullindex.html"/>
+ </chapters>
+ <functions>
+#for $obj in $spec.everything.values() + $spec.types.values() + $spec.errors.values()
+ <keyword type="$obj.devhelp_name" name="$obj.get_title()" link="$obj.get_url()" #slurp
+#if $obj.deprecated: deprecated="true" #slurp
+/>
+#end for
+ </functions>
+</book>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/errors.html b/sflphone-common/doc/dbus-api/doc/templates/errors.html
new file mode 100644
index 0000000000000000000000000000000000000000..907d6601c2145a5c825a82165b3cc493528076ca
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/errors.html
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>Errors</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+ <body>
+ <div class="header">
+ <h1>Errors</h1>
+ <a href="index.html">Interface Index</a>
+ (<a href="interfaces.html">Compact</a>)
+ | <a href="#summary">Summary</a>
+ | <a href="#errors">Errors</a>
+ </div>
+ <div class="main">
+ <div class="summary">
+ <a name="summary"></a>
+ <h3>Errors</h3>
+ <table class="summary">
+ #for $error in $spec.errors.values()
+ #if $error.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$error.get_url()">$error.short_name</a></td>
+ <td>
+ #if $error.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ </div>
+
+ <div class="outset errors error">
+ <a name="errors"></a>
+ <h1>Errors</h1>
+ #for $error in $spec.errors.values()
+ <div class="inset error">
+ <a name="$error.name"></a>
+ <span class="permalink">(<a href="$error.get_url()">Permalink</a>)</span>
+ <h2>
+ $error.short_name
+ </h2>
+
+ <div class="indent">
+ <code>$error.name</code>
+ </div>
+
+ $error.get_added()
+ $error.get_deprecated()
+ $error.get_docstring()
+ </div>
+ #end for
+ </div>
+ </div>
+
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/fullindex.html b/sflphone-common/doc/dbus-api/doc/templates/fullindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..2c465e1dd71271750111de42d7c471f0d01686fd
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/fullindex.html
@@ -0,0 +1,60 @@
+#from itertools import groupby
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>Full Index</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+
+#set $star = []
+#for $item in $spec.everything.values() + $spec.errors.values() + $spec.generic_types
+ #echo $star.append(($item.short_name, $item))
+ #slurp
+#end for
+#echo $star.sort(key = lambda t: t[0].title())
+#slurp
+## one use iterators...
+#set $groups = [ (l, list(g)) for l, g in (groupby($star, key = lambda t: t[0][0].upper())) ]
+#set $letters = set(map(lambda t: t[0], groups))
+
+ <body>
+ <div class="header">
+ <h1>Full Index</h1>
+ <a href="index.html">Interface Index</a>
+ (<a href="interfaces.html">Compact</a>)
+ #for $a in map(chr, xrange(ord('A'), ord('Z')+1))
+ #if $a in $letters
+ | <a href="#$a">$a</a>
+ #else
+ | $a
+ #end if
+ #end for
+ </div>
+
+ <div class="main">
+ <table class="summary">
+ #for l, g in $groups
+ <tr><th colspan="3"><a name="$l"></a>$l</th></tr>
+ #for $n in $g
+ #if $n[1].deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td>
+ <a href="$n[1].get_url()" title="$n[1].get_title()">$n[0]</a>
+ #if $n[1].deprecated: (deprecated)
+ </td>
+ <td>$n[1].get_type_name()</td>
+ <td>
+ #if $n[1].parent.__class__.__name__ == 'Interface': $n[1].parent.name
+ </td>
+ </tr>
+ #end for
+ #end for
+ <table>
+ </div>
+
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/generic-types.html b/sflphone-common/doc/dbus-api/doc/templates/generic-types.html
new file mode 100644
index 0000000000000000000000000000000000000000..0bb209e432210d364402ce23987000dbe66b7185
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/generic-types.html
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>Generic Types</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+ <body>
+ <div class="header">
+ <h1>Generic Types</h1>
+ <a href="index.html">Interface Index</a>
+ (<a href="interfaces.html">Compact</a>)
+ | <a href="#summary">Summary</a>
+ | <a href="#types">Types</a>
+ </div>
+ <div class="main">
+ <div class="summary">
+ <a name="summary"></a>
+ <h3>Generic Types</h3>
+ <table class="summary">
+ #for $type in $spec.generic_types
+ #if $type.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$type.get_url()">$type.short_name</a></td>
+ <td>$type.get_type_name()</td>
+ <td>$type.dbus_type</td>
+ <td>
+ #if $type.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ </div>
+
+ <div class="outset types type">
+ <a name="types"></a>
+ <h1>Generic Types</h1>
+ #for $type in $spec.generic_types
+ <div class="inset type">
+ <a name="$type.name"></a>
+ <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span>
+ <h2>
+ $type.short_name — $type.dbus_type
+ </h2>
+
+ $type.get_added()
+ $type.get_deprecated()
+ $type.get_docstring()
+ $type.get_breakdown()
+ </div>
+ #end for
+ </div>
+ </div>
+
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/index.html b/sflphone-common/doc/dbus-api/doc/templates/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..efc38d4e8ec411eb9721c5e01f222f0c4d392913
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/index.html
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>$spec.title &mdash v$spec.version</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+ <body>
+ <div class="header">
+ <h1>$spec.title</h1>
+ <a href="#interfaces">Interfaces</a>
+ (<a href="interfaces.html">Compact</a>)
+ | <a href="generic-types.html">Generic Types</a>
+ | <a href="errors.html">Errors</a>
+ | <a href="fullindex.html">Full Index</a>
+ </div>
+
+ <div class="main">
+ <h3 class="version">Version $spec.version</h3>
+ <p class="copyrights">
+ #echo '<br/>'.join($spec.copyrights)
+ </p>
+ $spec.license
+
+ <a name="interfaces"></a>
+ <h3>Interfaces</h3>
+ <ul>
+ #def output($items)
+ #for $item in $items
+ #if $item.__class__.__name__ == 'Section'
+ <li class="chapter">$item.short_name</li>
+ $item.get_docstring()
+ <ul>
+ $output($item.items)
+ </ul>
+ #else
+ #if $item.causes_havoc
+ <li class="causes-havoc">
+ #elif $item.deprecated
+ <li class="deprecated">
+ #else
+ <li>
+ #end if
+ <a href="$item.get_url()">$item.name</a>
+ #if $item.causes_havoc
+ (unstable)
+ #elif $item.deprecated
+ (deprecated)
+ #end if
+ </li>
+ #end if
+ #end for
+ #end def
+ $output($spec.items)
+ </ul>
+
+ <a name="other"></a>
+ <h3>Other</h3>
+ <ul>
+ <li><a href="generic-types.html">Generic Types</a></li>
+ <li><a href="errors.html">Errors</a></li>
+ </ul>
+
+ </div>
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/interface.html b/sflphone-common/doc/dbus-api/doc/templates/interface.html
new file mode 100644
index 0000000000000000000000000000000000000000..79c35b201c8c6d001022567028311f38c8390dee
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/interface.html
@@ -0,0 +1,424 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>$interface.name</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+ <body>
+ <div class="header">
+ <h1>Interface $interface.name</h1>
+ <a href="index.html">Interface Index</a>
+ (<a href="interfaces.html">Compact</a>)
+ | <a href="#summary">Summary</a>
+ #if $interface.docstring: | <a href="#description">Description</a>
+ #if $interface.methods: | <a href="#methods">Methods</a>
+ #if $interface.signals: | <a href="#signals">Signals</a>
+ #if $interface.properties: | <a href="#properties">Properties</a>
+ #if $interface.tpproperties: | <a href="#tpproperties">Telepathy Properties</a>
+ #if $interface.contact_attributes: | <a href="#contact-attributes">Contact Attributes</a>
+ #if $interface.handler_capability_tokens: | <a href="#handler-capability-tokens">Handler Capability Tokens</a>
+ #if $interface.types: | <a href="#types">Types</a>
+ </div>
+ <div class="main">
+
+ #if $interface.methods or $interface.signals or $interface.properties or $interface.types or $interface.tpproperties
+ <div class="summary">
+ <a name="summary"></a>
+ #if $interface.methods
+ <h3>Methods</h3>
+ <table class="summary">
+ #for $method in $interface.methods
+ #if $method.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$method.get_url()">$method.short_name</a></td>
+ <td>($method.get_in_args())</td>
+ <td>→</td>
+ <td>$method.get_out_args()</td>
+ <td>
+ #if $method.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.signals
+ <h3>Signals</h3>
+ <table class="summary">
+ #for $signal in $interface.signals
+ #if $signal.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$signal.get_url()">$signal.short_name</a></td>
+ <td>($signal.get_args())</td>
+ <td>
+ #if $signal.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.properties
+ <h3>Properties</h3>
+ <table class="summary">
+ #for $property in $interface.properties
+ #if $property.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$property.get_url()">$property.short_name</a></td>
+ <td>
+ $property.dbus_type
+ #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
+ </td>
+ <td>$property.get_access()</td>
+ <td>
+ #if $property.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.tpproperties
+ <h3>Telepathy Properties</h3>
+ <table class="summary">
+ #for $property in $interface.tpproperties
+ <tr class="deprecated">
+ <td><a href="$property.get_url()">$property.short_name</a></td>
+ <td>
+ $property.dbus_type
+ #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.contact_attributes
+ <h3>Contact Attributes</h3>
+ <table class="summary">
+ #for $token in $interface.contact_attributes
+ <tr class="contact-attribute">
+ <td><a href="$token.get_url()">$token.name</a></td>
+ <td>
+ $token.dbus_type
+ #if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.handler_capability_tokens
+ <h3>Handler Capability Tokens</h3>
+ <table class="summary">
+ #for $token in $interface.handler_capability_tokens
+ <tr class="handler-capability-token">
+ <td><a href="$token.get_url()">$token.name</a>
+ #if $token.is_family
+ (etc.)
+ #end if
+ </td>
+ <td>
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+
+ #if $interface.types
+ <h3>Types</h3>
+ <table class="summary">
+ #for $type in $interface.types
+ #if type.deprecated
+ <tr class="deprecated">
+ #else
+ <tr>
+ #end if
+ <td><a href="$type.get_url()">$type.short_name</a></td>
+ <td>$type.get_type_name()</td>
+ <td>$type.dbus_type</td>
+ <td>
+ #if $type.deprecated: (deprecated)
+ </td>
+ </tr>
+ #end for
+ </table>
+ #end if
+ </div>
+ #end if
+
+ #if $interface.causes_havoc
+ <div class="havoc"><span class="warning">WARNING:</span>
+ This interface is $interface.causes_havoc and is likely to cause havoc
+ to your API/ABI if bindings are generated. Do not include this interface
+ in libraries that care about compatibility.
+ </div>
+ #end if
+ $interface.get_added()
+ $interface.get_changed()
+ $interface.get_deprecated()
+
+ #if $interface.requires
+ <div class="requires">
+ Objects implementing this interface must also implement:
+ <ul>
+ #for $req in $interface.get_requires()
+ <li><a href="$req.get_url()" title="$req.get_title()">$req.name</a></li>
+ #end for
+ </ul>
+ </div>
+ #end if
+
+ #if $interface.docstring
+ <a name="description"></a>
+ <h3>Description</h3>
+ $interface.get_docstring()
+ #end if
+
+ #if $interface.methods
+ <div class="outset methods method">
+ <a name="methods"></a>
+ <h1>Methods</h1>
+ #for $method in $interface.methods
+ <div class="inset method">
+ <a name="$method.name"></a>
+ <span class="permalink">(<a href="$method.get_url()">Permalink</a>)</span>
+ <h2>$method.short_name ($method.get_in_args()) → $method.get_out_args()</h2>
+
+ $method.get_added()
+ $method.get_changed()
+ $method.get_deprecated()
+
+ #if $method.in_args
+ <div class="indent">
+ <h3>Parameters</h3>
+ <ul>
+ #for $arg in $method.in_args
+ <li>
+ $arg.short_name — $arg.dbus_type
+ #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
+ </li>
+ $arg.get_added()
+ $arg.get_changed()
+ $arg.get_deprecated()
+ $arg.get_docstring()
+ #end for
+ </ul>
+ </div>
+ #end if
+
+ #if $method.out_args
+ <div class="indent">
+ <h3>Returns</h3>
+ <ul>
+ #for $arg in $method.out_args
+ <li>
+ $arg.short_name — $arg.dbus_type
+ #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
+ </li>
+ $arg.get_added()
+ $arg.get_changed()
+ $arg.get_deprecated()
+ $arg.get_docstring()
+ #end for
+ </ul>
+ </div>
+ #end if
+
+ $method.get_docstring()
+
+ #if $method.possible_errors
+ <hr/>
+ <div class="indent">
+ <h3>Possible Errors</h3>
+ <ul>
+ #for $error in $method.possible_errors
+ <li><a href="$error.get_url()" title="$error.get_title()">$error.get_error().short_name</a></li>
+ $error.get_added()
+ $error.get_changed()
+ $error.get_deprecated()
+ $error.get_docstring()
+ #end for
+ </ul>
+ </div>
+ #end if
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.signals
+ <div class="outset signals signal">
+ <a name="signals"></a>
+ <h1>Signals</h1>
+ #for $signal in $interface.signals
+ <div class="inset signal">
+ <a name="$signal.name"></a>
+ <span class="permalink">(<a href="$signal.get_url()">Permalink</a>)</span>
+ <h2>$signal.short_name ($signal.get_args())</h2>
+
+ $signal.get_added()
+ $signal.get_changed()
+ $signal.get_deprecated()
+
+ #if $signal.args
+ <div class="indent">
+ <h3>Parameters</h3>
+ <ul>
+ #for $arg in $signal.args
+ <li>
+ $arg.short_name — $arg.dbus_type
+ #if $arg.get_type(): (<a href="$arg.get_type_url()" title="$arg.get_type_title()">$arg.get_type().short_name</a>)
+ </li>
+ $arg.get_added()
+ $arg.get_changed()
+ $arg.get_deprecated()
+ $arg.get_docstring()
+ #end for
+ </ul>
+ </div>
+ #end if
+
+ $signal.get_docstring()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.properties
+ <div class="outset properties property">
+ <a name="properties"></a>
+ <h1>Properties</h1>
+ <div>
+ Accessed using the org.freedesktop.DBus.Properties interface.
+ </div>
+ #for $property in $interface.properties
+ <div class="inset property">
+ <a name="$property.name"></a>
+ <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span>
+ <h2>
+ $property.short_name — $property.dbus_type
+ #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
+ </h2>
+ <div class="access">$property.get_access()</div>
+
+ $property.get_added()
+ $property.get_changed()
+ $property.get_deprecated()
+ $property.get_docstring()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.tpproperties
+ <div class="outset tpproperties tpproperty">
+ <a name="tpproperties"></a>
+ <h1>Telepathy Properties</h1>
+ <div>
+ Accessed using the org.freedesktop.Telepathy.Properties interface.
+ </div>
+ #for $property in $interface.tpproperties
+ <div class="inset tpproperty">
+ <a name="$property.name"></a>
+ <span class="permalink">(<a href="$property.get_url()">Permalink</a>)</span>
+ <h2>
+ $property.short_name — $property.dbus_type
+ #if $property.type: (<a href="$property.get_type_url()" title="$property.get_type_title()">$property.get_type().short_name</a>)
+ </h2>
+ $property.get_added()
+ $property.get_changed()
+ $property.get_deprecated()
+ $property.get_docstring()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.contact_attributes
+ <div class="outset contact-attributes">
+ <a name="contact-attributes"></a>
+ <h1>Contact Attributes</h1>
+ <div>
+ Attributes that a contact can have, accessed with the
+ org.freedesktop.Telepathy.Connection.Interface.Contacts interface.
+ </div>
+ #for $token in $interface.contact_attributes
+ <div class="inset contact-attribute">
+ <a name="$token.name"></a>
+ <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
+ <h2>
+ $token.name — $token.dbus_type
+ #if $token.type: (<a href="$token.get_type_url()" title="$token.get_type_title()">$token.get_type().short_name</a>)
+ </h2>
+ $token.get_added()
+ $token.get_changed()
+ $token.get_deprecated()
+ $token.get_docstring()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.handler_capability_tokens
+ <div class="outset handler-capability-tokens">
+ <a name="handler-capability-tokens"></a>
+ <h1>Handler Capability Tokens</h1>
+ <div>
+ Tokens representing capabilities that a Client.Handler can have.
+ </div>
+ #for $token in $interface.handler_capability_tokens
+ <div class="inset handler-capability-token">
+ <a name="$token.name"></a>
+ <span class="permalink">(<a href="$token.get_url()">Permalink</a>)</span>
+ <h2>
+ $token.name
+ #if $token.is_family
+ (etc.)
+ #end if
+ </h2>
+ $token.get_added()
+ $token.get_changed()
+ $token.get_deprecated()
+ $token.get_docstring()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ #if $interface.types
+ <div class="outset types type">
+ <a name="types"></a>
+ <h1>Types</h1>
+ #for $type in $interface.types
+ <div class="inset type">
+ <a name="$type.name"></a>
+ <span class="permalink">$type.get_type_name() (<a href="$type.get_url()">Permalink</a>)</span>
+ <h2>
+ $type.short_name — $type.dbus_type
+ </h2>
+
+ $type.get_added()
+ $type.get_changed()
+ $type.get_deprecated()
+ $type.get_docstring()
+ $type.get_breakdown()
+ </div>
+ #end for
+ </div>
+ #end if
+
+ </div>
+
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/interfaces.html b/sflphone-common/doc/dbus-api/doc/templates/interfaces.html
new file mode 100644
index 0000000000000000000000000000000000000000..a93334c65de98f8e1a8933316778579d3e18d6a7
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/interfaces.html
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+ <head>
+ <title>$spec.title &mdash v$spec.version</title>
+ <link rel="stylesheet" href="style.css" type="text/css"/>
+ </head>
+ <body>
+ <div class="header">
+ <h1>$spec.title</h1>
+ <a href="index.html">Full</a>
+ | <a href="generic-types.html">Generic Types</a>
+ | <a href="errors.html">Errors</a>
+ | <a href="fullindex.html">Full Index</a>
+ </div>
+
+ <div class="main">
+ <b>Version $spec.version</b>
+
+ <a name="interfaces"></a>
+ <h3>Interfaces</h3>
+ <ul>
+ #for $interface in $spec.interfaces
+ #if $interface.causes_havoc
+ <li class="causes-havoc">
+ #elif $interface.deprecated
+ <li class="deprecated">
+ #else
+ <li>
+ #end if
+ <a href="$interface.get_url()">$interface.name</a>
+ #if $interface.causes_havoc
+ (unstable)
+ #elif $interface.deprecated
+ (deprecated)
+ #end if
+ </li>
+ #end for
+ </ul>
+
+ <a name="other"></a>
+ <h3>Other</h3>
+ <ul>
+ <li><a href="generic-types.html">Generic Types</a></li>
+ <li><a href="errors.html">Errors</a></li>
+ </ul>
+
+ </div>
+ </body>
+</html>
diff --git a/sflphone-common/doc/dbus-api/doc/templates/style.css b/sflphone-common/doc/dbus-api/doc/templates/style.css
new file mode 100644
index 0000000000000000000000000000000000000000..979ced8caee61b00d127e83feb7c5576fbf1c191
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/doc/templates/style.css
@@ -0,0 +1,237 @@
+html, body,
+h1, h2 {
+ font-family: "Georgia";
+ margin: 0;
+ padding: 0;
+}
+
+h3 {
+ margin-top: 2pt;
+ margin-bottom: 2pt;
+}
+
+ul {
+ margin: 1ex;
+ margin-left: 1.5em;
+ padding: 0;
+}
+
+hr {
+ border-style: none;
+ color: #cccccc;
+ background-color: #cccccc;
+ height: 1px;
+}
+
+div.header {
+ position: fixed;
+ height: 4em;
+ background-color: AliceBlue;
+ width: 100%;
+ margin: 0;
+ padding: 0.5ex;
+ border-bottom: 1px solid black;
+ top: 0;
+ left: 0;
+ z-index: 1;
+}
+
+div.header h1 {
+ white-space: nowrap;
+ text-overflow: ellipsis;
+ overflow: hidden;
+}
+
+div.main {
+ margin-top: 5em;
+ margin-left: 1ex;
+ margin-right: 1ex;
+ margin-bottom: 1ex;
+}
+
+div.main a[name] {
+ position: relative;
+ top: -4.5em;
+}
+
+div.outset {
+ padding: 1ex;
+ margin-top: 1ex;
+ margin-bottom: 1ex;
+}
+
+div.inset {
+ background-color: white;
+ margin-top: 1ex;
+ margin-bottom: 1ex;
+ padding: 0.5ex;
+}
+
+div.indent {
+ margin-left: 1em;
+}
+
+div.methods {
+ background-color: #fcaf3e;
+}
+
+div.method {
+ border: 1px solid #f57900;
+}
+
+div.signals {
+ background-color: #729fcf;
+}
+
+div.signal {
+ border: 1px solid #3465a4;
+}
+
+div.properties {
+ background-color: #ad7fa8;
+}
+
+div.property {
+ border: 1px solid #75507b;
+}
+
+div.tpproperties {
+ background-color: #999999;
+}
+
+div.tpproperty {
+ border: 1px solid #333333;
+}
+
+div.contact-attributes {
+ background-color: #ccccff;
+ border: 1px solid #9999cc;
+}
+
+div.contact-attribute {
+ border: 1px solid #9999cc;
+}
+
+div.handler-capability-tokens {
+ background-color: #339933;
+ border: 1px solid #228822;
+}
+
+div.handler-capability-token {
+ border: 1px solid #228822;
+}
+
+div.types {
+ background-color: #e9b96e;
+}
+
+div.type {
+ border: 1px solid #c17d11;
+}
+
+div.errors {
+ background-color: #ef2929;
+}
+
+div.error {
+ border: 1px solid #cc0000;
+}
+
+div.access {
+ font-weight: bold;
+ margin-left: 1ex;
+}
+
+div.summary {
+ padding: 0.5ex;
+ background-color: #eeeeec;
+ border: 1px solid #d3d7cf;
+}
+
+table.summary {
+ margin: 1ex;
+ font-size: small;
+}
+
+table.summary td {
+ padding-right: 1ex;
+}
+
+li.chapter {
+ margin-top: 1ex;
+ font-weight: bold;
+}
+
+li.causes-havoc {
+ font-style: italic;
+}
+
+li.deprecated,
+li.deprecated a,
+table.summary tr.deprecated td,
+table.summary tr.deprecated td a {
+ color: gray;
+}
+
+div.requires,
+div.docstring {
+ margin: 1ex;
+}
+
+div.added {
+ border-left: 2px solid #4e9a06;
+ margin: 1ex;
+ padding-left: 1ex;
+}
+
+div.added span.version {
+ color: #4e9a06;
+ font-weight: bold;
+}
+
+div.changed {
+ border-left: 2px solid #8f5902;
+ margin: 1ex;
+ padding-left: 1ex;
+}
+
+div.changed span.version {
+ color: #8f5902;
+ font-weight: bold;
+}
+
+div.deprecated,
+div.havoc {
+ border-left: 2px solid #a40000;
+ margin: 1ex;
+ padding-left: 1ex;
+}
+
+div.deprecated span.version,
+span.warning {
+ color: #a40000;
+ font-weight: bold;
+}
+
+div.rationale {
+ border-left: 2px solid gray;
+ margin: 1ex;
+ padding-left: 1ex;
+}
+
+span.permalink {
+ float: right;
+ font-size: x-small;
+}
+
+.license {
+ clear: both;
+ border: 1px solid #dedede;
+ font-style: italic;
+ padding: 15px;
+}
+
+.copyrights {
+ clear: both;
+ float: right;
+}
diff --git a/sflphone-common/doc/dbus-api/spec/all.xml b/sflphone-common/doc/dbus-api/spec/all.xml
new file mode 100644
index 0000000000000000000000000000000000000000..b87a0e1e41083510f2666fdb62b8c339087eef61
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/all.xml
@@ -0,0 +1,55 @@
+<tp:spec
+ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+
+<tp:title>SFLphone D-Bus Interface Specification</tp:title>
+<tp:version>0.9.8</tp:version>
+
+<tp:copyright>Copyright © 2005-2010 Savoir-faire Linux Inc</tp:copyright>
+
+<tp:license xmlns="http://www.w3.org/1999/xhtml">
+<p>This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.</p>
+
+<p>This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.</p>
+
+<p>You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
+</tp:license>
+
+<tp:section name="Instances Manager">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ An Instance Manager to handle multiple clients connections. Count the number of clients actually registered to the core. When initializing your client, you need to register it against the core by using this interface.
+ </p>
+ </tp:docstring>
+ <xi:include href="instance-introspec.xml"/>
+</tp:section>
+
+<tp:section name="Call Manager">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A Call Manager to handle call-related features.
+ </p>
+ </tp:docstring>
+ <xi:include href="callmanager-introspec.xml"/>
+</tp:section>
+
+<tp:section name="Configuration Manager">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>
+ A Configuration Manager to handle account configuration, user preferences, ...
+ </p>
+ </tp:docstring>
+ <xi:include href="configurationmanager-introspec.xml"/>
+</tp:section>
+
+<xi:include href="generic-types.xml"/>
+
+</tp:spec>
diff --git a/sflphone-common/doc/dbus-api/spec/callmanager-introspec.xml b/sflphone-common/doc/dbus-api/spec/callmanager-introspec.xml
new file mode 120000
index 0000000000000000000000000000000000000000..2150eca25d2f7405bf1f7c8684247457538207c6
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/callmanager-introspec.xml
@@ -0,0 +1 @@
+../../../src/dbus/callmanager-introspec.xml
\ No newline at end of file
diff --git a/sflphone-common/doc/dbus-api/spec/configurationmanager-introspec.xml b/sflphone-common/doc/dbus-api/spec/configurationmanager-introspec.xml
new file mode 120000
index 0000000000000000000000000000000000000000..d340519f1a8287c927fa3e8c516b256438dc2a63
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/configurationmanager-introspec.xml
@@ -0,0 +1 @@
+../../../src/dbus/configurationmanager-introspec.xml
\ No newline at end of file
diff --git a/sflphone-common/doc/dbus-api/spec/errors.xml b/sflphone-common/doc/dbus-api/spec/errors.xml
new file mode 100644
index 0000000000000000000000000000000000000000..22a629baff276dbeb4439352acb7df7a90b319be
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/errors.xml
@@ -0,0 +1,417 @@
+<?xml version="1.0" ?>
+<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" namespace="org.freedesktop.Telepathy.Error">
+ <tp:error name="Network Error">
+ <tp:docstring>
+ Raised when there is an error reading from or writing to the network.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Not Implemented">
+ <tp:docstring>
+ Raised when the requested method, channel, etc is not available on this connection.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Invalid Argument">
+ <tp:docstring>
+ Raised when one of the provided arguments is invalid.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Not Available">
+ <tp:docstring>
+ Raised when the requested functionality is temporarily unavailable.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Permission Denied">
+ <tp:docstring>
+ The user is not permitted to perform the requested operation.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Disconnected">
+ <tp:docstring>
+ The connection is not currently connected and cannot be used.
+ This error may also be raised when operations are performed on a
+ Connection for which
+ <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">StatusChanged</tp:dbus-ref>
+ has signalled status Disconnected for reason None.
+
+ <tp:rationale>
+ The second usage corresponds to None in the
+ <tp:type>Connection_Status_Reason</tp:type> enum; if a better reason
+ is available, the corresponding error should be used instead.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Invalid Handle">
+ <tp:docstring>
+ The handle specified is unknown on this channel or connection.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Channel.Banned">
+ <tp:docstring>
+ You are banned from the channel.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Channel.Full">
+ <tp:docstring>
+ The channel is full.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Channel.Invite Only">
+ <tp:docstring>
+ The requested channel is invite-only.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Not Yours">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The requested channel or other resource already exists, and another
+ user interface in this session is responsible for it.</p>
+
+ <p>User interfaces SHOULD handle this error unobtrusively, since it
+ indicates that some other user interface is already processing the
+ channel.</p>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cancelled">
+ <tp:docstring>
+ Raised by an ongoing request if it is cancelled by user request before
+ it has completed, or when operations are performed on an object which
+ the user has asked to close (for instance, a Connection where the user
+ has called Disconnect, or a Channel where the user has called Close).
+
+ <tp:rationale>
+ The second form can be used to correspond to the Requested member in
+ the <tp:type>Connection_Status_Reason</tp:type> enum, or to
+ to represent the situation where disconnecting a Connection,
+ closing a Channel, etc. has been requested by the user but this
+ request has not yet been acted on, for instance because the
+ service will only act on the request when it has finished processing
+ an event queue.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Authentication Failed">
+ <tp:docstring>
+ Raised when authentication with a service was unsuccessful.
+ <tp:rationale>
+ This corresponds to Authentication_Failed in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Encryption Not Available">
+ <tp:docstring>
+ Raised if a user request insisted that encryption should be used,
+ but encryption was not actually available.
+
+ <tp:rationale>
+ This corresponds to part of Encryption_Error in the
+ <tp:type>Connection_Status_Reason</tp:type> enum. It's been separated
+ into a distinct error here because the two concepts that were part
+ of EncryptionError seem to be things that could reasonably appear
+ differently in the UI.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Encryption Error">
+ <tp:docstring>
+ Raised if encryption appears to be available, but could not actually be
+ used (for instance if SSL/TLS negotiation fails).
+ <tp:rationale>
+ This corresponds to part of Encryption_Error in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Not Provided">
+ <tp:docstring>
+ Raised if the server did not provide a SSL/TLS certificate. This error
+ MUST NOT be used to represent the absence of a client certificate
+ provided by the Telepathy connection manager.
+ <tp:rationale>
+ This corresponds to Cert_Not_Provided in the
+ <tp:type>Connection_Status_Reason</tp:type> enum. That error
+ explicitly applied only to server SSL certificates, so this one
+ is similarly limited; having the CM present a client certificate
+ is a possible future feature, but it should have its own error
+ handling.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Untrusted">
+ <tp:docstring>
+ Raised if the server provided a SSL/TLS certificate signed by an
+ untrusted certifying authority. This error SHOULD NOT be used to
+ represent a self-signed certificate: see the Self Signed error for that.
+ <tp:rationale>
+ This corresponds to Cert_Untrusted in the
+ <tp:type>Connection_Status_Reason</tp:type> enum, with a clarification
+ to avoid ambiguity.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Expired">
+ <tp:docstring>
+ Raised if the server provided an expired SSL/TLS certificate.
+ <tp:rationale>
+ This corresponds to Cert_Expired in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Not Activated">
+ <tp:docstring>
+ Raised if the server provided an SSL/TLS certificate that will become
+ valid at some point in the future.
+ <tp:rationale>
+ This corresponds to Cert_Not_Activated in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Fingerprint Mismatch">
+ <tp:docstring>
+ Raised if the server provided an SSL/TLS certificate that did not have
+ the expected fingerprint.
+ <tp:rationale>
+ This corresponds to Cert_Fingerprint_Mismatch in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Hostname Mismatch">
+ <tp:docstring>
+ Raised if the server provided an SSL/TLS certificate that did not match
+ its hostname.
+ <tp:rationale>
+ This corresponds to Cert_Hostname_Mismatch in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Self Signed">
+ <tp:docstring>
+ Raised if the server provided an SSL/TLS certificate that is self-signed
+ and untrusted.
+ <tp:rationale>
+ This corresponds to Cert_Hostname_Mismatch in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Cert.Invalid">
+ <tp:docstring>
+ Raised if the server provided an SSL/TLS certificate that is
+ unacceptable in some way that does not have a more specific error.
+ <tp:rationale>
+ This corresponds to Cert_Other_Error in the
+ <tp:type>Connection_Status_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Not Capable">
+ <tp:docstring>
+ Raised when requested functionality is unavailable due to contact
+ not having required capabilities.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Offline">
+ <tp:docstring>
+ Raised when requested functionality is unavailable because a contact is
+ offline.
+
+ <tp:rationale>
+ This corresponds to Offline in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Channel.Kicked">
+ <tp:docstring>
+ Used to represent a user being ejected from a channel by another user,
+ for instance being kicked from a chatroom.
+
+ <tp:rationale>
+ This corresponds to Kicked in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Busy">
+ <tp:docstring>
+ Used to represent a user being removed from a channel because of a
+ "busy" indication. This error SHOULD NOT be used to represent a server
+ or other infrastructure being too busy to process a request - for that,
+ see ServerBusy.
+
+ <tp:rationale>
+ This corresponds to Busy in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="No Answer">
+ <tp:docstring>
+ Used to represent a user being removed from a channel because they did
+ not respond, e.g. to a StreamedMedia call.
+
+ <tp:rationale>
+ This corresponds to No_Answer in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Does Not Exist">
+ <tp:docstring>
+ Raised when the requested user does not, in fact, exist.
+
+ <tp:rationale>
+ This corresponds to Invalid_Contact in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum, but can also be
+ used to represent other things not existing (like chatrooms, perhaps).
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Terminated">
+ <tp:docstring>
+ Raised when a channel is terminated for an unspecified reason. In
+ particular, this error SHOULD be used whenever normal termination of
+ a 1-1 StreamedMedia call by the remote user is represented as a D-Bus
+ error name.
+
+ <tp:rationale>
+ This corresponds to None in the
+ <tp:type>Channel_Group_Change_Reason</tp:type> enum.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Connection Refused">
+ <tp:docstring>
+ Raised when a connection is refused.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Connection Failed">
+ <tp:docstring>
+ Raised when a connection can't be established.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Connection Lost">
+ <tp:docstring>
+ Raised when a connection is broken.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Already Connected">
+ <tp:docstring>
+ Raised when the user attempts to connect to an account but they are
+ already connected (perhaps from another client or computer), and the
+ protocol or account settings do not allow this.
+
+ <tp:rationale>
+ XMPP can have this behaviour if the user chooses the same resource
+ in both clients (it is server-dependent whether the result is
+ AlreadyConnected on the new connection, ConnectionReplaced on the
+ old connection, or two successful connections).
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Connection Replaced">
+ <tp:docstring>
+ Raised by an existing connection to an account if it is replaced by
+ a new connection (perhaps from another client or computer).
+
+ <tp:rationale>
+ In MSNP, when connecting twice with the same Passport, the new
+ connection "wins" and the old one is automatically disconnected.
+ XMPP can also have this behaviour if the user chooses the same
+ resource in two clients (it is server-dependent whether the result is
+ AlreadyConnected on the new connection, ConnectionReplaced on the
+ old connection, or two successful connections).
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Registration Exists">
+ <tp:docstring>
+ Raised during in-band registration if the server indicates that the
+ requested account already exists.
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Service Busy">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ Raised if a server or some other piece of infrastructure cannot process
+ the request, e.g. due to resource limitations. Clients MAY try again
+ later.
+
+ <tp:rationale>
+ This is not the same error as Busy, which indicates that a
+ <em>user</em> is busy.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:error name="Resource Unavailable">
+ <tp:docstring>
+ Raised if a request cannot be satisfied because a process local to the
+ user has insufficient resources. Clients MAY try again
+ later.
+
+ <tp:rationale>
+ For instance, the <tp:dbus-ref
+ namespace="org.freedesktop.Telepathy">ChannelDispatcher</tp:dbus-ref>
+ might raise this error for some or all channel requests if it has
+ detected that there is not enough free memory.
+ </tp:rationale>
+ </tp:docstring>
+ </tp:error>
+
+ <tp:copyright>Copyright © 2005-2009 Collabora Limited</tp:copyright>
+ <tp:copyright>Copyright © 2005-2009 Nokia Corporation</tp:copyright>
+ <tp:license xmlns="http://www.w3.org/1999/xhtml">
+<p>This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.</p>
+
+<p>This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.</p>
+
+<p>You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
+ </tp:license>
+</tp:errors>
diff --git a/sflphone-common/doc/dbus-api/spec/generic-types.xml b/sflphone-common/doc/dbus-api/spec/generic-types.xml
new file mode 100644
index 0000000000000000000000000000000000000000..d4dce1552dcaaf6fa37f61ffd499dfcb03ea49e8
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/generic-types.xml
@@ -0,0 +1,168 @@
+<tp:generic-types
+ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+
+ <tp:simple-type name="Unix_Timestamp" type="u">
+ <tp:docstring>An unsigned 32-bit integer representing time as the number
+ of seconds elapsed since the Unix epoch
+ (1970-01-01T00:00:00Z)</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="Unix_Timestamp64" type="x">
+ <tp:docstring>An signed 64-bit integer representing time as the number
+ of seconds elapsed since the Unix epoch
+ (1970-01-01T00:00:00Z); negative for times before the epoch</tp:docstring>
+
+ <tp:rationale>The Text interface is the only user of Unix_Timestamp so
+ far, and we'd like to be Y2038 compatible in future
+ interfaces.</tp:rationale>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Bus_Name" type="s"
+ array-name="DBus_Bus_Name_List">
+ <tp:docstring>A string representing a D-Bus bus name - either a well-known
+ name like "org.freedesktop.Telepathy.MissionControl" or a unique name
+ like ":1.123"</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Well_Known_Name" type="s"
+ array-name="DBus_Well_Known_Name_List">
+ <tp:docstring>A string representing a D-Bus well-known
+ name like "org.freedesktop.Telepathy.MissionControl".</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Unique_Name" type="s"
+ array-name="DBus_Unique_Name_List">
+ <tp:docstring>A string representing a D-Bus unique name, such as
+ ":1.123"</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Interface" type="s"
+ array-name="DBus_Interface_List">
+ <tp:docstring>An ASCII string representing a D-Bus interface - two or more
+ elements separated by dots, where each element is a non-empty
+ string of ASCII letters, digits and underscores, not starting with
+ a digit. The maximum total length is 255 characters. For example,
+ "org.freedesktop.DBus.Peer".</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Error_Name" type="s">
+ <tp:docstring>An ASCII string representing a D-Bus error. This is
+ syntactically the same as a <tp:type>DBus_Interface</tp:type>, but the
+ meaning is different.</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Signature" type="s">
+ <tp:docstring>A string representing a D-Bus signature
+ (the 'g' type isn't used because of poor interoperability, particularly
+ with dbus-glib)</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Member" type="s">
+ <tp:docstring>An ASCII string representing a D-Bus method, signal
+ or property name - a non-empty string of ASCII letters, digits and
+ underscores, not starting with a digit, with a maximum length of 255
+ characters. For example, "Ping".</tp:docstring>
+ </tp:simple-type>
+
+ <tp:simple-type name="DBus_Qualified_Member" type="s"
+ array-name="DBus_Qualified_Member_List">
+ <tp:docstring>A string representing the full name of a D-Bus method,
+ signal or property, consisting of a DBus_Interface, followed by
+ a dot, followed by a DBus_Member. For example,
+ "org.freedesktop.DBus.Peer.Ping".</tp:docstring>
+ </tp:simple-type>
+
+ <tp:mapping name="Qualified_Property_Value_Map"
+ array-name="Qualified_Property_Value_Map_List">
+ <tp:docstring>A mapping from strings representing D-Bus
+ properties (by their namespaced names) to their values.</tp:docstring>
+ <tp:member type="s" name="Key" tp:type="DBus_Qualified_Member">
+ <tp:docstring>
+ A D-Bus interface name, followed by a dot and a D-Bus property name.
+ </tp:docstring>
+ </tp:member>
+ <tp:member type="v" name="Value">
+ <tp:docstring>
+ The value of the property.
+ </tp:docstring>
+ </tp:member>
+ </tp:mapping>
+
+ <tp:mapping name="String_Variant_Map" array-name="String_Variant_Map_List">
+ <tp:docstring>A mapping from strings to variants representing extra
+ key-value pairs.</tp:docstring>
+ <tp:member type="s" name="Key"/>
+ <tp:member type="v" name="Value"/>
+ </tp:mapping>
+
+ <tp:mapping name="String_String_Map" array-name="String_String_Map_List">
+ <tp:docstring>A mapping from strings to strings representing extra
+ key-value pairs.</tp:docstring>
+ <tp:member type="s" name="Key"/>
+ <tp:member type="s" name="Value"/>
+ </tp:mapping>
+
+ <tp:struct name="Socket_Address_IP" array-name="Socket_Address_IP_List">
+ <tp:docstring>An IP address and port.</tp:docstring>
+ <tp:member type="s" name="Address">
+ <tp:docstring>Either a dotted-quad IPv4 address literal as for
+ <tp:type>Socket_Address_IPv4</tp:type>, or an RFC2373 IPv6 address
+ as for <tp:type>Socket_Address_IPv6</tp:type>.
+ </tp:docstring>
+ </tp:member>
+ <tp:member type="q" name="Port">
+ <tp:docstring>The TCP or UDP port number.</tp:docstring>
+ </tp:member>
+ </tp:struct>
+
+ <tp:struct name="Socket_Address_IPv4">
+ <tp:docstring>An IPv4 address and port.</tp:docstring>
+ <tp:member type="s" name="Address">
+ <tp:docstring>A dotted-quad IPv4 address literal: four ASCII decimal
+ numbers, each between 0 and 255 inclusive, e.g.
+ "192.168.0.1".</tp:docstring>
+ </tp:member>
+ <tp:member type="q" name="Port">
+ <tp:docstring>The TCP or UDP port number.</tp:docstring>
+ </tp:member>
+ </tp:struct>
+
+ <tp:struct name="Socket_Address_IPv6">
+ <tp:docstring>An IPv6 address and port.</tp:docstring>
+ <tp:member type="s" name="Address">
+ <tp:docstring>An IPv6 address literal as specified by RFC2373
+ section 2.2, e.g. "2001:DB8::8:800:200C:4171".</tp:docstring>
+ </tp:member>
+ <tp:member type="q" name="Port">
+ <tp:docstring>The TCP or UDP port number.</tp:docstring>
+ </tp:member>
+ </tp:struct>
+
+ <tp:struct name="Socket_Netmask_IPv4">
+ <tp:docstring>An IPv4 network or subnet.</tp:docstring>
+ <tp:member type="s" name="Address">
+ <tp:docstring>A dotted-quad IPv4 address literal: four ASCII decimal
+ numbers, each between 0 and 255 inclusive, e.g.
+ "192.168.0.1".</tp:docstring>
+ </tp:member>
+ <tp:member type="y" name="Prefix_Length">
+ <tp:docstring>The number of leading bits of the address that must
+ match, for this netmask to be considered to match an
+ address.</tp:docstring>
+ </tp:member>
+ </tp:struct>
+
+ <tp:struct name="Socket_Netmask_IPv6">
+ <tp:docstring>An IPv6 network or subnet.</tp:docstring>
+ <tp:member type="s" name="Address">
+ <tp:docstring>An IPv6 address literal as specified by RFC2373
+ section 2.2, e.g. "2001:DB8::8:800:200C:4171".</tp:docstring>
+ </tp:member>
+ <tp:member type="y" name="Prefix_Length">
+ <tp:docstring>The number of leading bits of the address that must
+ match, for this netmask to be considered to match an
+ address.</tp:docstring>
+ </tp:member>
+ </tp:struct>
+
+</tp:generic-types>
diff --git a/sflphone-common/doc/dbus-api/spec/instance-introspec.xml b/sflphone-common/doc/dbus-api/spec/instance-introspec.xml
new file mode 120000
index 0000000000000000000000000000000000000000..2e02dfe7239982ae1df5ef975ddacafb9897839a
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/spec/instance-introspec.xml
@@ -0,0 +1 @@
+../../../src/dbus/instance-introspec.xml
\ No newline at end of file
diff --git a/sflphone-common/doc/dbus-api/tools/devhelp.xsl b/sflphone-common/doc/dbus-api/tools/devhelp.xsl
new file mode 100644
index 0000000000000000000000000000000000000000..60f9e1c5304f68e8db9c6cb0cefc7db78d04398d
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/tools/devhelp.xsl
@@ -0,0 +1,91 @@
+<!-- Generate a Devhelp index from the Telepathy specification.
+The master copy of this stylesheet is in the Telepathy spec repository -
+please make any changes there.
+
+Copyright (C) 2006-2008 Collabora Limited
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+-->
+
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+ <xsl:template match="/">
+ <book xmlns="http://www.devhelp.net/book" title="Telepathy Specification"
+ name="telepathy-spec" link="spec.html">
+ <xsl:text>
</xsl:text>
+ <chapters>
+ <xsl:text>
</xsl:text>
+ <xsl:apply-templates select="//interface" />
+ </chapters>
+ <xsl:text>
</xsl:text>
+ <functions>
+ <xsl:text>
</xsl:text>
+ <xsl:apply-templates select="//method" />
+ <xsl:apply-templates select="//signal" />
+ <xsl:apply-templates select="//property" />
+ <xsl:apply-templates select="//tp:enum" />
+ <xsl:apply-templates select="//tp:simple-type" />
+ <xsl:apply-templates select="//tp:mapping" />
+ <xsl:apply-templates select="//tp:flags" />
+ <xsl:apply-templates select="//tp:struct" />
+ </functions>
+ <xsl:text>
</xsl:text>
+ </book>
+ </xsl:template>
+
+ <xsl:template match="interface">
+ <xsl:text> </xsl:text>
+ <sub xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="{concat('spec.html#', @name)}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="method">
+ <xsl:text> </xsl:text>
+ <keyword type="function" xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="spec.html#{../@name}.{@name}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="signal | property">
+ <xsl:text> </xsl:text>
+ <keyword type="" xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="spec.html#{../@name}.{@name}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="tp:simple-type">
+ <xsl:text> </xsl:text>
+ <keyword type="typedef" xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="spec.html#type-{@name}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="tp:enum | tp:flags">
+ <xsl:text> </xsl:text>
+ <keyword type="enum" xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="spec.html#type-{@name}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="tp:mapping | tp:struct">
+ <xsl:text> </xsl:text>
+ <keyword type="struct" xmlns="http://www.devhelp.net/book" name="{@name}"
+ link="spec.html#type-{@name}" />
+ <xsl:text>
</xsl:text>
+ </xsl:template>
+
+</xsl:stylesheet>
diff --git a/sflphone-common/doc/dbus-api/tools/doc-generator.py b/sflphone-common/doc/dbus-api/tools/doc-generator.py
new file mode 100755
index 0000000000000000000000000000000000000000..5fc19ce907435806cabd31baa75b05f0a9b76d82
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/tools/doc-generator.py
@@ -0,0 +1,104 @@
+#!/usr/bin/env python
+#
+# doc-generator.py
+#
+# Generates HTML documentation from the parsed spec using Cheetah templates.
+#
+# Copyright (C) 2009 Collabora Ltd.
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# Authors: Davyd Madeley <davyd.madeley@collabora.co.uk>
+#
+
+import sys
+import os
+import os.path
+import shutil
+
+try:
+ from Cheetah.Template import Template
+except ImportError, e:
+ print >> sys.stderr, e
+ print >> sys.stderr, "Install `python-cheetah'?"
+ sys.exit(-1)
+
+import specparser
+
+program, spec_file, output_path, project, namespace = sys.argv
+
+template_path = os.path.join(os.path.dirname(program), '../doc/templates')
+
+# make the output path
+try:
+ os.mkdir(output_path)
+except OSError:
+ pass
+# copy in the CSS
+shutil.copy(os.path.join(template_path, 'style.css'), output_path)
+
+def load_template(filename):
+ try:
+ file = open(os.path.join(template_path, filename))
+ template_def = file.read()
+ file.close()
+ except IOError, e:
+ print >> sys.stderr, "Could not load template file `%s'" % filename
+ print >> sys.stderr, e
+ sys.exit(-1)
+
+ return template_def
+
+spec = specparser.parse(spec_file, namespace)
+
+# write out HTML files for each of the interfaces
+
+# Not using render_template here to avoid recompiling it n times.
+namespace = {}
+template_def = load_template('interface.html')
+t = Template(template_def, namespaces = [namespace])
+for interface in spec.interfaces:
+ namespace['interface'] = interface
+
+ # open the output file
+ out = open(os.path.join(output_path, '%s.html' % interface.name), 'w')
+ print >> out, unicode(t).encode('utf-8')
+ out.close()
+
+def render_template(name, namespaces, target=None):
+ if target is None:
+ target = name
+
+ namespace = { 'spec': spec }
+ template_def = load_template(name)
+ t = Template(template_def, namespaces=namespaces)
+ out = open(os.path.join(output_path, target), 'w')
+ print >> out, unicode(t).encode('utf-8')
+ out.close()
+
+namespaces = { 'spec': spec }
+
+render_template('generic-types.html', namespaces)
+render_template('errors.html', namespaces)
+render_template('interfaces.html', namespaces)
+render_template('fullindex.html', namespaces)
+
+dh_namespaces = { 'spec': spec, 'name': project }
+render_template('devhelp.devhelp2', dh_namespaces,
+ target=('%s.devhelp2' % project))
+
+# write out the TOC last, because this is the file used as the target in the
+# Makefile.
+render_template('index.html', namespaces)
diff --git a/sflphone-common/doc/dbus-api/tools/doc-generator.xsl b/sflphone-common/doc/dbus-api/tools/doc-generator.xsl
new file mode 100644
index 0000000000000000000000000000000000000000..fe9cd9f08d193606f37f41259cb75601b431602f
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/tools/doc-generator.xsl
@@ -0,0 +1,1266 @@
+<!-- Generate HTML documentation from the Telepathy specification.
+The master copy of this stylesheet is in the Telepathy spec repository -
+please make any changes there.
+
+Copyright (C) 2006-2008 Collabora Limited
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+-->
+
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ exclude-result-prefixes="tp html">
+ <!--Don't move the declaration of the HTML namespace up here — XMLNSs
+ don't work ideally in the presence of two things that want to use the
+ absence of a prefix, sadly. -->
+
+ <xsl:param name="allow-undefined-interfaces" select="false()"/>
+
+ <xsl:template match="html:* | @*" mode="html">
+ <xsl:copy>
+ <xsl:apply-templates mode="html" select="@*|node()"/>
+ </xsl:copy>
+ </xsl:template>
+
+ <xsl:template match="tp:type" mode="html">
+ <xsl:call-template name="tp-type">
+ <xsl:with-param name="tp-type" select="string(.)"/>
+ </xsl:call-template>
+ </xsl:template>
+
+ <!-- tp:dbus-ref: reference a D-Bus interface, signal, method or property -->
+ <xsl:template match="tp:dbus-ref" mode="html">
+ <xsl:variable name="name">
+ <xsl:choose>
+ <xsl:when test="@namespace">
+ <xsl:value-of select="@namespace"/>
+ <xsl:text>.</xsl:text>
+ </xsl:when>
+ </xsl:choose>
+ <xsl:value-of select="string(.)"/>
+ </xsl:variable>
+
+ <xsl:choose>
+ <xsl:when test="//interface[@name=$name]
+ or //interface/method[concat(../@name, '.', @name)=$name]
+ or //interface/signal[concat(../@name, '.', @name)=$name]
+ or //interface/property[concat(../@name, '.', @name)=$name]
+ or //interface[@name=concat($name, '.DRAFT')]
+ or //interface/method[
+ concat(../@name, '.', @name)=concat($name, '.DRAFT')]
+ or //interface/signal[
+ concat(../@name, '.', @name)=concat($name, '.DRAFT')]
+ or //interface/property[
+ concat(../@name, '.', @name)=concat($name, '.DRAFT')]
+ ">
+ <a xmlns="http://www.w3.org/1999/xhtml" href="#{$name}">
+ <xsl:value-of select="string(.)"/>
+ </a>
+ </xsl:when>
+
+ <xsl:when test="$allow-undefined-interfaces">
+ <span xmlns="http://www.w3.org/1999/xhtml" title="defined elsewhere">
+ <xsl:value-of select="string(.)"/>
+ </span>
+ </xsl:when>
+
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: cannot find D-Bus interface, method, </xsl:text>
+ <xsl:text>signal or property called '</xsl:text>
+ <xsl:value-of select="$name"/>
+ <xsl:text>' </xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+
+ <!-- tp:member-ref: reference a property of the current interface -->
+ <xsl:template match="tp:member-ref" mode="html">
+ <xsl:variable name="prefix" select="concat(ancestor::interface/@name,
+ '.')"/>
+ <xsl:variable name="name" select="string(.)"/>
+
+ <xsl:if test="not(ancestor::interface)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: Cannot use tp:member-ref when not in an</xsl:text>
+ <xsl:text> <interface> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:choose>
+ <xsl:when test="ancestor::interface/signal[@name=$name]"/>
+ <xsl:when test="ancestor::interface/method[@name=$name]"/>
+ <xsl:when test="ancestor::interface/property[@name=$name]"/>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: interface </xsl:text>
+ <xsl:value-of select="ancestor::interface/@name"/>
+ <xsl:text> has no signal/method/property called </xsl:text>
+ <xsl:value-of select="$name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <a xmlns="http://www.w3.org/1999/xhtml" href="#{$prefix}{$name}">
+ <xsl:value-of select="$name"/>
+ </a>
+ </xsl:template>
+
+ <xsl:template match="*" mode="identity">
+ <xsl:copy>
+ <xsl:apply-templates mode="identity"/>
+ </xsl:copy>
+ </xsl:template>
+
+ <xsl:template match="tp:docstring">
+ <xsl:apply-templates mode="html"/>
+ </xsl:template>
+
+ <xsl:template match="tp:added">
+ <p class="added" xmlns="http://www.w3.org/1999/xhtml">Added in
+ version <xsl:value-of select="@version"/>.
+ <xsl:apply-templates select="node()" mode="html"/></p>
+ </xsl:template>
+
+ <xsl:template match="tp:changed">
+ <xsl:choose>
+ <xsl:when test="node()">
+ <p class="changed" xmlns="http://www.w3.org/1999/xhtml">Changed in
+ version <xsl:value-of select="@version"/>:
+ <xsl:apply-templates select="node()" mode="html"/></p>
+ </xsl:when>
+ <xsl:otherwise>
+ <p class="changed">Changed in version
+ <xsl:value-of select="@version"/></p>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+
+ <xsl:template match="tp:deprecated">
+ <p class="deprecated" xmlns="http://www.w3.org/1999/xhtml">Deprecated
+ since version <xsl:value-of select="@version"/>.
+ <xsl:apply-templates select="node()" mode="html"/></p>
+ </xsl:template>
+
+ <xsl:template match="tp:rationale" mode="html">
+ <div xmlns="http://www.w3.org/1999/xhtml" class="rationale">
+ <xsl:apply-templates select="node()" mode="html"/>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="tp:errors">
+ <h1 xmlns="http://www.w3.org/1999/xhtml">Errors</h1>
+ <xsl:apply-templates/>
+ </xsl:template>
+
+ <xsl:template match="tp:generic-types">
+ <h1 xmlns="http://www.w3.org/1999/xhtml">Generic types</h1>
+ <xsl:call-template name="do-types"/>
+ </xsl:template>
+
+ <xsl:template name="do-types">
+ <xsl:if test="tp:simple-type">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Simple types</h2>
+ <xsl:apply-templates select="tp:simple-type"/>
+ </xsl:if>
+
+ <xsl:if test="tp:enum">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Enumerated types:</h2>
+ <xsl:apply-templates select="tp:enum"/>
+ </xsl:if>
+
+ <xsl:if test="tp:flags">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Sets of flags:</h2>
+ <xsl:apply-templates select="tp:flags"/>
+ </xsl:if>
+
+ <xsl:if test="tp:struct">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Structure types</h2>
+ <xsl:apply-templates select="tp:struct"/>
+ </xsl:if>
+
+ <xsl:if test="tp:mapping">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Mapping types</h2>
+ <xsl:apply-templates select="tp:mapping"/>
+ </xsl:if>
+
+ <xsl:if test="tp:external-type">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Types defined elsewhere</h2>
+ <dl><xsl:apply-templates select="tp:external-type"/></dl>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template match="tp:error">
+ <h2 xmlns="http://www.w3.org/1999/xhtml"><a name="{concat(../@namespace, '.', translate(@name, ' ', ''))}"></a><xsl:value-of select="concat(../@namespace, '.', translate(@name, ' ', ''))"/></h2>
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </xsl:template>
+
+ <xsl:template match="/tp:spec/tp:copyright">
+ <div xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates mode="text"/>
+ </div>
+ </xsl:template>
+ <xsl:template match="/tp:spec/tp:license">
+ <div xmlns="http://www.w3.org/1999/xhtml" class="license">
+ <xsl:apply-templates mode="html"/>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="tp:copyright"/>
+ <xsl:template match="tp:license"/>
+
+ <xsl:template match="interface">
+ <h1 xmlns="http://www.w3.org/1999/xhtml"><a name="{@name}"></a><xsl:value-of select="@name"/></h1>
+
+ <xsl:if test="@tp:causes-havoc">
+ <p xmlns="http://www.w3.org/1999/xhtml" class="causes-havoc">
+ This interface is <xsl:value-of select="@tp:causes-havoc"/>
+ and is likely to cause havoc to your API/ABI if bindings are generated.
+ Don't include it in libraries that care about compatibility.
+ </p>
+ </xsl:if>
+
+ <xsl:if test="tp:requires">
+ <p>Implementations of this interface must also implement:</p>
+ <ul xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:for-each select="tp:requires">
+ <li><code><a href="#{@interface}"><xsl:value-of select="@interface"/></a></code></li>
+ </xsl:for-each>
+ </ul>
+ </xsl:if>
+
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+
+ <xsl:choose>
+ <xsl:when test="method">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Methods:</h2>
+ <xsl:apply-templates select="method"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <p xmlns="http://www.w3.org/1999/xhtml">Interface has no methods.</p>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <xsl:choose>
+ <xsl:when test="signal">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Signals:</h2>
+ <xsl:apply-templates select="signal"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <p xmlns="http://www.w3.org/1999/xhtml">Interface has no signals.</p>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <xsl:choose>
+ <xsl:when test="tp:property">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">Telepathy Properties:</h2>
+ <p xmlns="http://www.w3.org/1999/xhtml">Accessed using the
+ <a href="#org.freedesktop.Telepathy.Properties">Telepathy
+ Properties</a> interface.</p>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:property"/>
+ </dl>
+ </xsl:when>
+ <xsl:otherwise>
+ <p xmlns="http://www.w3.org/1999/xhtml">Interface has no Telepathy
+ properties.</p>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <xsl:choose>
+ <xsl:when test="property">
+ <h2 xmlns="http://www.w3.org/1999/xhtml">D-Bus core Properties:</h2>
+ <p xmlns="http://www.w3.org/1999/xhtml">Accessed using the
+ org.freedesktop.DBus.Properties interface.</p>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="property"/>
+ </dl>
+ </xsl:when>
+ <xsl:otherwise>
+ <p xmlns="http://www.w3.org/1999/xhtml">Interface has no D-Bus core
+ properties.</p>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <xsl:call-template name="do-types"/>
+
+ </xsl:template>
+
+ <xsl:template match="tp:flags">
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a tp:flags type </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @type on tp:flags type</xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <h3>
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a>
+ </h3>
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:variable name="value-prefix">
+ <xsl:choose>
+ <xsl:when test="@value-prefix">
+ <xsl:value-of select="@value-prefix"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="@name"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+ <xsl:for-each select="tp:flag">
+ <dt xmlns="http://www.w3.org/1999/xhtml"><code><xsl:value-of select="concat($value-prefix, '_', @suffix)"/> = <xsl:value-of select="@value"/></code></dt>
+ <xsl:choose>
+ <xsl:when test="tp:docstring">
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </dd>
+ </xsl:when>
+ <xsl:otherwise>
+ <dd xmlns="http://www.w3.org/1999/xhtml">(Undocumented)</dd>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:for-each>
+ </dl>
+ </xsl:template>
+
+ <xsl:template match="tp:enum">
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a tp:enum type </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @type on tp:enum type</xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <h3 xmlns="http://www.w3.org/1999/xhtml">
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a>
+ </h3>
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:variable name="value-prefix">
+ <xsl:choose>
+ <xsl:when test="@value-prefix">
+ <xsl:value-of select="@value-prefix"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="@name"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+ <xsl:for-each select="tp:enumvalue">
+ <dt xmlns="http://www.w3.org/1999/xhtml"><code><xsl:value-of select="concat($value-prefix, '_', @suffix)"/> = <xsl:value-of select="@value"/></code></dt>
+ <xsl:choose>
+ <xsl:when test="tp:docstring">
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </dd>
+ </xsl:when>
+ <xsl:otherwise>
+ <dd xmlns="http://www.w3.org/1999/xhtml">(Undocumented)</dd>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:for-each>
+ </dl>
+ </xsl:template>
+
+ <xsl:template name="binding-name-check">
+ <xsl:if test="not(@tp:name-for-bindings)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: Binding name missing from </xsl:text>
+ <xsl:value-of select="parent::interface/@name"/>
+ <xsl:text>.</xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="translate(@tp:name-for-bindings, '_', '') != @name">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: Binding name </xsl:text>
+ <xsl:value-of select="@tp:name-for-bindings"/>
+ <xsl:text> doesn't correspond to D-Bus name </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template match="property">
+
+ <xsl:call-template name="binding-name-check"/>
+
+ <xsl:if test="not(parent::interface)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: property </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> does not have an interface as parent </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a property of </xsl:text>
+ <xsl:value-of select="../@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @type on property </xsl:text>
+ <xsl:value-of select="concat(../@name, '.', @name)"/>
+ <xsl:text>: '</xsl:text>
+ <xsl:value-of select="@access"/>
+ <xsl:text>' </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <a name="{concat(../@name, '.', @name)}">
+ <code><xsl:value-of select="@name"/></code>
+ </a>
+ <xsl:text> − </xsl:text>
+ <code><xsl:value-of select="@type"/></code>
+ <xsl:call-template name="parenthesized-tp-type"/>
+ <xsl:text>, </xsl:text>
+ <xsl:choose>
+ <xsl:when test="@access = 'read'">
+ <xsl:text>read-only</xsl:text>
+ </xsl:when>
+ <xsl:when test="@access = 'write'">
+ <xsl:text>write-only</xsl:text>
+ </xsl:when>
+ <xsl:when test="@access = 'readwrite'">
+ <xsl:text>read/write</xsl:text>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: unknown or missing value for </xsl:text>
+ <xsl:text>@access on property </xsl:text>
+ <xsl:value-of select="concat(../@name, '.', @name)"/>
+ <xsl:text>: '</xsl:text>
+ <xsl:value-of select="@access"/>
+ <xsl:text>' </xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="tp:property">
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:if test="@name">
+ <code><xsl:value-of select="@name"/></code> −
+ </xsl:if>
+ <code><xsl:value-of select="@type"/></code>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="tp:mapping">
+ <div xmlns="http://www.w3.org/1999/xhtml" class="struct">
+ <h3>
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a> − a{
+ <xsl:for-each select="tp:member">
+ <xsl:value-of select="@type"/>
+ <xsl:text>: </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:if test="position() != last()"> → </xsl:if>
+ </xsl:for-each>
+ }
+ </h3>
+ <div class="docstring">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:if test="string(@array-name) != ''">
+ <p>In bindings that need a separate name, arrays of
+ <xsl:value-of select="@name"/> should be called
+ <xsl:value-of select="@array-name"/>.</p>
+ </xsl:if>
+ </div>
+ <div>
+ <h4>Members</h4>
+ <dl>
+ <xsl:apply-templates select="tp:member" mode="members-in-docstring"/>
+ </dl>
+ </div>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="tp:docstring" mode="in-index"/>
+
+ <xsl:template match="tp:simple-type | tp:enum | tp:flags | tp:external-type"
+ mode="in-index">
+ − <xsl:value-of select="@type"/>
+ </xsl:template>
+
+ <xsl:template match="tp:simple-type">
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a tp:simple-type </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @type on tp:simple-type</xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <div xmlns="http://www.w3.org/1999/xhtml" class="simple-type">
+ <h3>
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a> − <xsl:value-of select="@type"/>
+ </h3>
+ <div class="docstring">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </div>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="tp:external-type">
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a tp:external-type </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @type on tp:external-type</xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <div xmlns="http://www.w3.org/1999/xhtml" class="external-type">
+ <dt>
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a> − <xsl:value-of select="@type"/>
+ </dt>
+ <dd>Defined by: <xsl:value-of select="@from"/></dd>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="tp:struct" mode="in-index">
+ − ( <xsl:for-each select="tp:member">
+ <xsl:value-of select="@type"/>
+ <xsl:if test="position() != last()">, </xsl:if>
+ </xsl:for-each> )
+ </xsl:template>
+
+ <xsl:template match="tp:mapping" mode="in-index">
+ − a{ <xsl:for-each select="tp:member">
+ <xsl:value-of select="@type"/>
+ <xsl:if test="position() != last()"> → </xsl:if>
+ </xsl:for-each> }
+ </xsl:template>
+
+ <xsl:template match="tp:struct">
+ <div xmlns="http://www.w3.org/1999/xhtml" class="struct">
+ <h3>
+ <a name="type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a> − (
+ <xsl:for-each select="tp:member">
+ <xsl:value-of select="@type"/>
+ <xsl:text>: </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:if test="position() != last()">, </xsl:if>
+ </xsl:for-each>
+ )
+ </h3>
+ <div class="docstring">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </div>
+ <xsl:choose>
+ <xsl:when test="string(@array-name) != ''">
+ <p>In bindings that need a separate name, arrays of
+ <xsl:value-of select="@name"/> should be called
+ <xsl:value-of select="@array-name"/>.</p>
+ </xsl:when>
+ <xsl:otherwise>
+ <p>Arrays of <xsl:value-of select="@name"/> don't generally
+ make sense.</p>
+ </xsl:otherwise>
+ </xsl:choose>
+ <div>
+ <h4>Members</h4>
+ <dl>
+ <xsl:apply-templates select="tp:member" mode="members-in-docstring"/>
+ </dl>
+ </div>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="method">
+
+ <xsl:call-template name="binding-name-check"/>
+
+ <xsl:if test="not(parent::interface)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: method </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> does not have an interface as parent </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a method of </xsl:text>
+ <xsl:value-of select="../@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:for-each select="arg">
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an arg of method </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has no type</xsl:text>
+ </xsl:message>
+ </xsl:if>
+ <xsl:choose>
+ <xsl:when test="@direction='in'">
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an 'in' arg of method </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has no name</xsl:text>
+ </xsl:message>
+ </xsl:if>
+ </xsl:when>
+ <xsl:when test="@direction='out'">
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="no">
+ <xsl:text>WARNING: an 'out' arg of method </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has no name</xsl:text>
+ </xsl:message>
+ </xsl:if>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an arg of method </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has direction neither 'in' nor 'out'</xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:for-each>
+
+ <div xmlns="http://www.w3.org/1999/xhtml" class="method">
+ <h3 xmlns="http://www.w3.org/1999/xhtml">
+ <a name="{concat(../@name, concat('.', @name))}">
+ <xsl:value-of select="@name"/>
+ </a> (
+ <xsl:for-each xmlns="" select="arg[@direction='in']">
+ <xsl:value-of select="@type"/>: <xsl:value-of select="@name"/>
+ <xsl:if test="position() != last()">, </xsl:if>
+ </xsl:for-each>
+ ) →
+ <xsl:choose>
+ <xsl:when test="arg[@direction='out']">
+ <xsl:for-each xmlns="" select="arg[@direction='out']">
+ <xsl:value-of select="@type"/>
+ <xsl:if test="position() != last()">, </xsl:if>
+ </xsl:for-each>
+ </xsl:when>
+ <xsl:otherwise>nothing</xsl:otherwise>
+ </xsl:choose>
+ </h3>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="docstring">
+ <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </div>
+
+ <xsl:if test="arg[@direction='in']">
+ <div xmlns="http://www.w3.org/1999/xhtml">
+ <h4>Parameters</h4>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="arg[@direction='in']"
+ mode="parameters-in-docstring"/>
+ </dl>
+ </div>
+ </xsl:if>
+
+ <xsl:if test="arg[@direction='out']">
+ <div xmlns="http://www.w3.org/1999/xhtml">
+ <h4>Returns</h4>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="arg[@direction='out']"
+ mode="returns-in-docstring"/>
+ </dl>
+ </div>
+ </xsl:if>
+
+ <xsl:if test="tp:possible-errors">
+ <div xmlns="http://www.w3.org/1999/xhtml">
+ <h4>Possible errors</h4>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:possible-errors/tp:error"/>
+ </dl>
+ </div>
+ </xsl:if>
+
+ </div>
+ </xsl:template>
+
+ <xsl:template name="tp-type">
+ <xsl:param name="tp-type"/>
+ <xsl:param name="type"/>
+
+ <xsl:variable name="single-type">
+ <xsl:choose>
+ <xsl:when test="contains($tp-type, '[]')">
+ <xsl:value-of select="substring-before($tp-type, '[]')"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="$tp-type"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <xsl:variable name="type-of-single-tp-type">
+ <xsl:choose>
+ <xsl:when test="//tp:simple-type[@name=$single-type]">
+ <xsl:value-of select="string(//tp:simple-type[@name=$single-type]/@type)"/>
+ </xsl:when>
+ <xsl:when test="//tp:struct[@name=$single-type]">
+ <xsl:text>(</xsl:text>
+ <xsl:for-each select="//tp:struct[@name=$single-type]/tp:member">
+ <xsl:value-of select="@type"/>
+ </xsl:for-each>
+ <xsl:text>)</xsl:text>
+ </xsl:when>
+ <xsl:when test="//tp:enum[@name=$single-type]">
+ <xsl:value-of select="string(//tp:enum[@name=$single-type]/@type)"/>
+ </xsl:when>
+ <xsl:when test="//tp:flags[@name=$single-type]">
+ <xsl:value-of select="string(//tp:flags[@name=$single-type]/@type)"/>
+ </xsl:when>
+ <xsl:when test="//tp:mapping[@name=$single-type]">
+ <xsl:text>a{</xsl:text>
+ <xsl:for-each select="//tp:mapping[@name=$single-type]/tp:member">
+ <xsl:value-of select="@type"/>
+ </xsl:for-each>
+ <xsl:text>}</xsl:text>
+ </xsl:when>
+ <xsl:when test="//tp:external-type[@name=$single-type]">
+ <xsl:value-of select="string(//tp:external-type[@name=$single-type]/@type)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: Unable to find type '</xsl:text>
+ <xsl:value-of select="$tp-type"/>
+ <xsl:text>' </xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <xsl:variable name="type-of-tp-type">
+ <xsl:if test="contains($tp-type, '[]')">
+ <!-- one 'a', plus one for each [ after the [], and delete all ] -->
+ <xsl:value-of select="concat('a',
+ translate(substring-after($tp-type, '[]'), '[]', 'a'))"/>
+ </xsl:if>
+ <xsl:value-of select="$type-of-single-tp-type"/>
+ </xsl:variable>
+
+ <xsl:if test="string($type) != '' and
+ string($type-of-tp-type) != string($type)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: tp:type '</xsl:text>
+ <xsl:value-of select="$tp-type"/>
+ <xsl:text>' has D-Bus type '</xsl:text>
+ <xsl:value-of select="$type-of-tp-type"/>
+ <xsl:text>' but has been used with type='</xsl:text>
+ <xsl:value-of select="$type"/>
+ <xsl:text>' </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="contains($tp-type, '[]')">
+ <xsl:call-template name="tp-type-array-usage-check">
+ <xsl:with-param name="single-type" select="$single-type"/>
+ <xsl:with-param name="type-of-single-tp-type"
+ select="$type-of-single-tp-type"/>
+ </xsl:call-template>
+ </xsl:if>
+
+ <a href="#type-{$single-type}"><xsl:value-of select="$tp-type"/></a>
+
+ </xsl:template>
+
+ <xsl:template name="tp-type-array-usage-check">
+ <xsl:param name="single-type"/>
+ <xsl:param name="type-of-single-tp-type"/>
+
+ <xsl:variable name="array-name">
+ <xsl:choose>
+ <xsl:when test="//tp:struct[@name=$single-type]">
+ <xsl:value-of select="//tp:struct[@name=$single-type]/@array-name"/>
+ </xsl:when>
+ <xsl:when test="//tp:mapping[@name=$single-type]">
+ <xsl:value-of select="//tp:mapping[@name=$single-type]/@array-name"/>
+ </xsl:when>
+ <xsl:when test="//tp:external-type[@name=$single-type]">
+ <xsl:value-of select="//tp:external-type[@name=$single-type]/@array-name"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="''"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <xsl:if test="not(contains('ybnqiuxtdsvog', $type-of-single-tp-type))">
+ <xsl:if test="not($array-name) or $array-name=''">
+ <xsl:message terminate="yes">
+ <xsl:text>No array-name specified for complex type </xsl:text>
+ <xsl:value-of select="$single-type"/>
+ <xsl:text>, but array used </xsl:text>
+ </xsl:message>
+ </xsl:if>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template name="parenthesized-tp-type">
+ <xsl:if test="@tp:type">
+ <xsl:text> (</xsl:text>
+ <xsl:call-template name="tp-type">
+ <xsl:with-param name="tp-type" select="@tp:type"/>
+ <xsl:with-param name="type" select="@type"/>
+ </xsl:call-template>
+ <xsl:text>)</xsl:text>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template match="tp:member" mode="members-in-docstring">
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <code><xsl:value-of select="@name"/></code> −
+ <code><xsl:value-of select="@type"/></code>
+ <xsl:call-template name="parenthesized-tp-type"/>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:choose>
+ <xsl:when test="tp:docstring">
+ <xsl:apply-templates select="tp:docstring" />
+ </xsl:when>
+ <xsl:otherwise>
+ <em>(undocumented)</em>
+ </xsl:otherwise>
+ </xsl:choose>
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="arg" mode="parameters-in-docstring">
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <code><xsl:value-of select="@name"/></code> −
+ <code><xsl:value-of select="@type"/></code>
+ <xsl:call-template name="parenthesized-tp-type"/>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring" />
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="arg" mode="returns-in-docstring">
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:if test="@name">
+ <code><xsl:value-of select="@name"/></code> −
+ </xsl:if>
+ <code><xsl:value-of select="@type"/></code>
+ <xsl:call-template name="parenthesized-tp-type"/>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="tp:docstring"/>
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="tp:possible-errors/tp:error">
+ <dt xmlns="http://www.w3.org/1999/xhtml">
+ <code><xsl:value-of select="@name"/></code>
+ </dt>
+ <dd xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:variable name="name" select="@name"/>
+ <xsl:choose>
+ <xsl:when test="tp:docstring">
+ <xsl:apply-templates select="tp:docstring"/>
+ </xsl:when>
+ <xsl:when test="//tp:errors/tp:error[concat(../@namespace, '.', translate(@name, ' ', ''))=$name]/tp:docstring">
+ <xsl:apply-templates select="//tp:errors/tp:error[concat(../@namespace, '.', translate(@name, ' ', ''))=$name]/tp:docstring"/> <em xmlns="http://www.w3.org/1999/xhtml">(generic description)</em>
+ </xsl:when>
+ <xsl:otherwise>
+ (Undocumented.)
+ </xsl:otherwise>
+ </xsl:choose>
+ </dd>
+ </xsl:template>
+
+ <xsl:template match="signal">
+
+ <xsl:call-template name="binding-name-check"/>
+
+ <xsl:if test="not(parent::interface)">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: signal </xsl:text>
+ <xsl:value-of select="@name"/>
+ <xsl:text> does not have an interface as parent </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: missing @name on a signal of </xsl:text>
+ <xsl:value-of select="../@name"/>
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:if>
+
+ <xsl:for-each select="arg">
+ <xsl:if test="not(@type) or @type = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an arg of signal </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has no type</xsl:text>
+ </xsl:message>
+ </xsl:if>
+ <xsl:if test="not(@name) or @name = ''">
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an arg of signal </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has no name</xsl:text>
+ </xsl:message>
+ </xsl:if>
+ <xsl:choose>
+ <xsl:when test="not(@direction)"/>
+ <xsl:when test="@direction='in'">
+ <xsl:message terminate="no">
+ <xsl:text>INFO: an arg of signal </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has unnecessary direction 'in'</xsl:text>
+ </xsl:message>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>ERR: an arg of signal </xsl:text>
+ <xsl:value-of select="concat(../../@name, '.', ../@name)"/>
+ <xsl:text> has direction other than 'in'</xsl:text>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:for-each>
+
+ <div xmlns="http://www.w3.org/1999/xhtml" class="signal">
+ <h3 xmlns="http://www.w3.org/1999/xhtml">
+ <a name="{concat(../@name, concat('.', @name))}">
+ <xsl:value-of select="@name"/>
+ </a> (
+ <xsl:for-each xmlns="" select="arg">
+ <xsl:value-of select="@type"/>: <xsl:value-of select="@name"/>
+ <xsl:if test="position() != last()">, </xsl:if>
+ </xsl:for-each>
+ )</h3>
+
+ <div xmlns="http://www.w3.org/1999/xhtml" class="docstring">
+ <xsl:apply-templates select="tp:docstring"/>
+ <xsl:apply-templates select="tp:added"/>
+ <xsl:apply-templates select="tp:changed"/>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </div>
+
+ <xsl:if test="arg">
+ <div xmlns="http://www.w3.org/1999/xhtml">
+ <h4>Parameters</h4>
+ <dl xmlns="http://www.w3.org/1999/xhtml">
+ <xsl:apply-templates select="arg" mode="parameters-in-docstring"/>
+ </dl>
+ </div>
+ </xsl:if>
+ </div>
+ </xsl:template>
+
+ <xsl:output method="xml" indent="no" encoding="ascii"
+ omit-xml-declaration="yes"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
+ doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" />
+
+ <xsl:template match="/tp:spec">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>
+ <xsl:value-of select="tp:title"/>
+ <xsl:if test="tp:version">
+ <xsl:text> version </xsl:text>
+ <xsl:value-of select="tp:version"/>
+ </xsl:if>
+ </title>
+ <style type="text/css">
+
+ body {
+ font-family: sans-serif;
+ margin: 2em;
+ height: 100%;
+ font-size: 1.2em;
+ }
+ h1 {
+ padding-top: 5px;
+ padding-bottom: 5px;
+ font-size: 1.6em;
+ background: #dadae2;
+ }
+ h2 {
+ font-size: 1.3em;
+ }
+ h3 {
+ font-size: 1.2em;
+ }
+ a:link, a:visited, a:link:hover, a:visited:hover {
+ font-weight: bold;
+ }
+ .topbox {
+ padding-top: 10px;
+ padding-left: 10px;
+ border-bottom: black solid 1px;
+ padding-bottom: 10px;
+ background: #dadae2;
+ font-size: 2em;
+ font-weight: bold;
+ color: #5c5c5c;
+ }
+ .topnavbox {
+ padding-left: 10px;
+ padding-top: 5px;
+ padding-bottom: 5px;
+ background: #abacba;
+ border-bottom: black solid 1px;
+ font-size: 1.2em;
+ }
+ .topnavbox a{
+ color: black;
+ font-weight: normal;
+ }
+ .sidebar {
+ float: left;
+ /* width:9em;
+ border-right:#abacba solid 1px;
+ border-left: #abacba solid 1px;
+ height:100%; */
+ border: #abacba solid 1px;
+ padding-left: 10px;
+ margin-left: 10px;
+ padding-right: 10px;
+ margin-right: 10px;
+ color: #5d5d5d;
+ background: #dadae2;
+ }
+ .sidebar a {
+ text-decoration: none;
+ border-bottom: #e29625 dotted 1px;
+ color: #e29625;
+ font-weight: normal;
+ }
+ .sidebar h1 {
+ font-size: 1.2em;
+ color: black;
+ }
+ .sidebar ul {
+ padding-left: 25px;
+ padding-bottom: 10px;
+ border-bottom: #abacba solid 1px;
+ }
+ .sidebar li {
+ padding-top: 2px;
+ padding-bottom: 2px;
+ }
+ .sidebar h2 {
+ font-style:italic;
+ font-size: 0.81em;
+ padding-left: 5px;
+ padding-right: 5px;
+ font-weight: normal;
+ }
+ .date {
+ font-size: 0.6em;
+ float: right;
+ font-style: italic;
+ }
+ .method, .signal, .property {
+ margin-left: 1em;
+ margin-right: 4em;
+ }
+ .rationale {
+ font-style: italic;
+ border-left: 0.25em solid #808080;
+ padding-left: 0.5em;
+ }
+
+ .added {
+ color: #006600;
+ background: #ffffff;
+ }
+ .deprecated {
+ color: #ff0000;
+ background: #ffffff;
+ }
+ table, tr, td, th {
+ border: 1px solid #666;
+ }
+
+ </style>
+ </head>
+ <body>
+ <h1 class="topbox">
+ <xsl:value-of select="tp:title" />
+ </h1>
+ <xsl:if test="tp:version">
+ <h2>Version <xsl:value-of select="string(tp:version)"/></h2>
+ </xsl:if>
+ <xsl:apply-templates select="tp:copyright"/>
+ <xsl:apply-templates select="tp:license"/>
+ <xsl:apply-templates select="tp:docstring"/>
+
+ <h2>Interfaces</h2>
+ <ul>
+ <xsl:for-each select="//node/interface">
+ <li><code><a href="#{@name}"><xsl:value-of select="@name"/></a></code></li>
+ </xsl:for-each>
+ </ul>
+
+ <xsl:apply-templates select="//node"/>
+ <xsl:apply-templates select="tp:generic-types"/>
+ <xsl:apply-templates select="tp:errors"/>
+
+ <h1>Index</h1>
+ <h2>Index of interfaces</h2>
+ <ul>
+ <xsl:for-each select="//node/interface">
+ <li><code><a href="#{@name}"><xsl:value-of select="@name"/></a></code></li>
+ </xsl:for-each>
+ </ul>
+ <h2>Index of types</h2>
+ <ul>
+ <xsl:for-each select="//tp:simple-type | //tp:enum | //tp:flags | //tp:mapping | //tp:struct | //tp:external-type">
+ <xsl:sort select="@name"/>
+ <li>
+ <code>
+ <a href="#type-{@name}">
+ <xsl:value-of select="@name"/>
+ </a>
+ </code>
+ <xsl:apply-templates mode="in-index" select="."/>
+ </li>
+ </xsl:for-each>
+ </ul>
+ </body>
+ </html>
+ </xsl:template>
+
+ <xsl:template match="node">
+ <xsl:apply-templates />
+ </xsl:template>
+
+ <xsl:template match="text()">
+ <xsl:if test="normalize-space(.) != ''">
+ <xsl:message terminate="yes">
+ <xsl:text>Stray text: {{{</xsl:text>
+ <xsl:value-of select="." />
+ <xsl:text>}}} </xsl:text>
+ </xsl:message>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template match="*">
+ <xsl:message terminate="yes">
+ <xsl:text>Unrecognised element: {</xsl:text>
+ <xsl:value-of select="namespace-uri(.)" />
+ <xsl:text>}</xsl:text>
+ <xsl:value-of select="local-name(.)" />
+ <xsl:text> </xsl:text>
+ </xsl:message>
+ </xsl:template>
+</xsl:stylesheet>
+
+<!-- vim:set sw=2 sts=2 et: -->
diff --git a/sflphone-common/doc/dbus-api/tools/specparser.py b/sflphone-common/doc/dbus-api/tools/specparser.py
new file mode 100644
index 0000000000000000000000000000000000000000..4208ad4104cab3c2a73aa75c71e05b3a53541b43
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/tools/specparser.py
@@ -0,0 +1,866 @@
+#
+# specparser.py
+#
+# Reads in a spec document and generates pretty data structures from it.
+#
+# Copyright (C) 2009 Collabora Ltd.
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# Authors: Davyd Madeley <davyd.madeley@collabora.co.uk>
+#
+
+import sys
+import xml.dom.minidom
+
+import xincludator
+
+XMLNS_TP = 'http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0'
+
+class UnknownAccess(Exception): pass
+class UnknownDirection(Exception): pass
+class UnknownType(Exception): pass
+class UnnamedItem(Exception): pass
+class UntypedItem(Exception): pass
+class UnsupportedArray(Exception): pass
+
+def getText(dom):
+ try:
+ if dom.childNodes[0].nodeType == dom.TEXT_NODE:
+ return dom.childNodes[0].data
+ else:
+ return ''
+ except IndexError:
+ return ''
+
+def getChildrenByName(dom, namespace, name):
+ return filter(lambda n: n.nodeType == n.ELEMENT_NODE and \
+ n.namespaceURI == namespace and \
+ n.localName == name,
+ dom.childNodes)
+
+def build_name(namespace, name):
+ """Returns a name by appending `name' to the namespace of this object.
+ """
+ return '.'.join(
+ filter(lambda n: n is not None and n != '',
+ [namespace, name.replace(' ', '')])
+ )
+
+class Base(object):
+ """The base class for any type of XML node in the spec that implements the
+ 'name' attribute.
+
+ Don't instantiate this class directly.
+ """
+ devhelp_name = ""
+
+ def __init__(self, parent, namespace, dom):
+ self.short_name = name = dom.getAttribute('name')
+ self.namespace = namespace
+ self.name = build_name(namespace, name)
+ self.parent = parent
+
+ try:
+ self.docstring = getChildrenByName(dom, XMLNS_TP, 'docstring')[0]
+ except IndexError:
+ self.docstring = None
+
+ try:
+ self.added = getChildrenByName(dom, XMLNS_TP, 'added')[0]
+ except IndexError:
+ self.added = None
+
+ try:
+ self.deprecated = getChildrenByName(dom, XMLNS_TP, 'deprecated')[0]
+ except IndexError:
+ self.deprecated = None
+
+ self.changed = getChildrenByName(dom, XMLNS_TP, 'changed')
+
+ self.validate()
+
+ def validate(self):
+ if self.short_name == '':
+ raise UnnamedItem("Node %s of %s has no name" % (
+ self.__class__.__name__, self.parent))
+
+ def get_type_name(self):
+ return self.__class__.__name__
+
+ def get_spec(self):
+ return self.parent.get_spec()
+
+ def get_root_namespace(self):
+ return self.get_interface().name
+
+ def get_interface(self):
+ return self.parent.get_interface()
+
+ def get_url(self):
+ return "%s#%s" % (self.get_interface().get_url(), self.name)
+
+ def _get_generic_with_ver(self, nnode, htmlclass, txt):
+ if nnode is None:
+ return ''
+ else:
+ # make a copy of this node, turn it into a HTML <div> tag
+ node = nnode.cloneNode(True)
+ node.tagName = 'div'
+ node.baseURI = None
+ node.setAttribute('class', htmlclass)
+
+ try:
+ node.removeAttribute('version')
+
+ span = xml.dom.minidom.parseString(
+ ('<span class="version">%s\n</span>' % txt) %
+ nnode.getAttribute('version')).firstChild
+ node.insertBefore(span, node.firstChild)
+ except xml.dom.NotFoundErr:
+ print >> sys.stderr, \
+ 'WARNING: %s was %s, but gives no version' % (self, htmlclass)
+
+ self._convert_to_html(node)
+
+ return node.toxml().encode('ascii', 'xmlcharrefreplace')
+
+ def get_added(self):
+ return self._get_generic_with_ver(self.added, 'added',
+ "Added in %s.")
+
+ def get_deprecated(self):
+ return self._get_generic_with_ver(self.deprecated, 'deprecated',
+ "Deprecated since %s.")
+
+ def get_changed(self):
+ return '\n'.join(map(lambda n:
+ self._get_generic_with_ver(n, 'changed', "Changed in %s."),
+ self.changed))
+
+ def get_docstring(self):
+ """Get the docstring for this node, but do node substitution to
+ rewrite types, interfaces, etc. as links.
+ """
+ if self.docstring is None:
+ return ''
+ else:
+ # make a copy of this node, turn it into a HTML <div> tag
+ node = self.docstring.cloneNode(True)
+ node.tagName = 'div'
+ node.baseURI = None
+ node.setAttribute('class', 'docstring')
+
+ self._convert_to_html(node)
+
+ return node.toxml().encode('ascii', 'xmlcharrefreplace')
+
+ def _convert_to_html(self, node):
+ spec = self.get_spec()
+ namespace = self.get_root_namespace()
+
+ # rewrite <tp:rationale>
+ for n in node.getElementsByTagNameNS(XMLNS_TP, 'rationale'):
+ n.tagName = 'div'
+ n.namespaceURI = None
+ n.setAttribute('class', 'rationale')
+
+ # rewrite <tp:type>
+ for n in node.getElementsByTagNameNS(XMLNS_TP, 'type'):
+ t = spec.lookup_type(getText(n))
+ n.tagName = 'a'
+ n.namespaceURI = None
+ n.setAttribute('href', t.get_url())
+
+ # rewrite <tp:member-ref>
+ for n in node.getElementsByTagNameNS(XMLNS_TP, 'member-ref'):
+ key = getText(n)
+ try:
+ o = spec.lookup(key, namespace=namespace)
+ except KeyError:
+ print >> sys.stderr, \
+ "WARNING: Key '%s' not known in namespace '%s'" % (
+ key, namespace)
+ continue
+
+ n.tagName = 'a'
+ n.namespaceURI = None
+ n.setAttribute('href', o.get_url())
+ n.setAttribute('title', o.get_title())
+
+ # rewrite <tp:dbus-ref>
+ for n in node.getElementsByTagNameNS(XMLNS_TP, 'dbus-ref'):
+ namespace = n.getAttribute('namespace')
+ key = getText(n)
+ try:
+ o = spec.lookup(key, namespace=namespace)
+ except KeyError:
+ print >> sys.stderr, \
+ "WARNING: Key '%s' not known in namespace '%s'" % (
+ key, namespace)
+ continue
+
+ n.tagName = 'a'
+ n.namespaceURI = None
+ n.setAttribute('href', o.get_url())
+ n.setAttribute('title', o.get_title())
+
+ def get_title(self):
+ return '%s %s' % (self.get_type_name(), self.name)
+
+ def __repr__(self):
+ return '%s(%s)' % (self.__class__.__name__, self.name)
+
+class PossibleError(Base):
+ def __init__(self, parent, namespace, dom):
+ super(PossibleError, self).__init__(parent, namespace, dom)
+
+ def get_error(self):
+ spec = self.get_spec()
+ try:
+ return spec.errors[self.name]
+ except KeyError:
+ return External(self.name)
+
+ def get_url(self):
+ return self.get_error().get_url()
+
+ def get_title(self):
+ return self.get_error().get_title()
+
+ def get_docstring(self):
+ d = super(PossibleError, self).get_docstring()
+ if d == '':
+ return self.get_error().get_docstring()
+ else:
+ return d
+
+class Method(Base):
+ devhelp_name = "function"
+
+ def __init__(self, parent, namespace, dom):
+ super(Method, self).__init__(parent, namespace, dom)
+
+ args = build_list(self, Arg, self.name,
+ dom.getElementsByTagName('arg'))
+
+ # separate arguments as input and output arguments
+ self.in_args = filter(lambda a: a.direction == Arg.DIRECTION_IN, args)
+ self.out_args = filter(lambda a: a.direction == Arg.DIRECTION_OUT, args)
+
+ for arg in args:
+ if arg.direction == Arg.DIRECTION_IN or \
+ arg.direction == Arg.DIRECTION_OUT:
+ continue
+
+ print >> sys.stderr, "WARNING: '%s' of method '%s' does not specify a suitable direction" % (arg, self)
+
+ self.possible_errors = build_list(self, PossibleError, None,
+ dom.getElementsByTagNameNS(XMLNS_TP, 'error'))
+
+ def get_in_args(self):
+ return ', '.join(map(lambda a: a.spec_name(), self.in_args))
+
+ def get_out_args(self):
+ if len(self.out_args) > 0:
+ return ', '.join(map(lambda a: a.spec_name(), self.out_args))
+ else:
+ return 'nothing'
+
+class Typed(Base):
+ """The base class for all typed nodes (i.e. Arg and Property).
+
+ Don't instantiate this class directly.
+ """
+
+ def __init__(self, parent, namespace, dom):
+ super(Typed, self).__init__(parent, namespace, dom)
+
+ self.type = dom.getAttributeNS(XMLNS_TP, 'type')
+ self.dbus_type = dom.getAttribute('type')
+
+ # check we have a dbus type
+ if self.dbus_type == '':
+ raise UntypedItem("Node referred to by '%s' has no type" % dom.toxml())
+ def get_type(self):
+ return self.get_spec().lookup_type(self.type)
+
+ def get_type_url(self):
+ t = self.get_type()
+ if t is None: return ''
+ else: return t.get_url()
+
+ def get_type_title(self):
+ t = self.get_type()
+ if t is None: return ''
+ else: return t.get_title()
+
+ def spec_name(self):
+ return '%s: %s' % (self.dbus_type, self.short_name)
+
+ def __repr__(self):
+ return '%s(%s:%s)' % (self.__class__.__name__, self.name, self.dbus_type)
+
+class Property(Typed):
+ ACCESS_READ = 1
+ ACCESS_WRITE = 2
+
+ ACCESS_READWRITE = ACCESS_READ | ACCESS_WRITE
+
+ def __init__(self, parent, namespace, dom):
+ super(Property, self).__init__(parent, namespace, dom)
+
+ access = dom.getAttribute('access')
+ if access == 'read':
+ self.access = self.ACCESS_READ
+ elif access == 'write':
+ self.access = self.ACCESS_WRITE
+ elif access == 'readwrite':
+ self.access = self.ACCESS_READWRITE
+ else:
+ raise UnknownAccess("Unknown access '%s' on %s" % (access, self))
+
+ def get_access(self):
+ if self.access & self.ACCESS_READ and self.access & self.ACCESS_WRITE:
+ return 'Read/Write'
+ elif self.access & self.ACCESS_READ:
+ return 'Read only'
+ elif self.access & self.ACCESS_WRITE:
+ return 'Write only'
+
+class AwkwardTelepathyProperty(Typed):
+ def get_type_name(self):
+ return 'Telepathy Property'
+
+class Arg(Typed):
+ DIRECTION_IN, DIRECTION_OUT, DIRECTION_UNSPECIFIED = range(3)
+
+ def __init__(self, parent, namespace, dom):
+ super(Arg, self).__init__(parent, namespace, dom)
+
+ direction = dom.getAttribute('direction')
+ if direction == 'in':
+ self.direction = self.DIRECTION_IN
+ elif direction == 'out':
+ self.direction = self.DIRECTION_OUT
+ elif direction == '':
+ self.direction = self.DIRECTION_UNSPECIFIED
+ else:
+ raise UnknownDirection("Unknown direction '%s' on %s" % (
+ direction, self.parent))
+
+class Signal(Base):
+ def __init__(self, parent, namespace, dom):
+ super(Signal, self).__init__(parent, namespace, dom)
+
+ self.args = build_list(self, Arg, self.name,
+ dom.getElementsByTagName('arg'))
+
+ for arg in self.args:
+ if arg.direction == Arg.DIRECTION_UNSPECIFIED:
+ continue
+
+ print >> sys.stderr, "WARNING: '%s' of signal '%s' does not specify a suitable direction" % (arg, self)
+
+ def get_args(self):
+ return ', '.join(map(lambda a: a.spec_name(), self.args))
+
+class External(object):
+ """External objects are objects that are referred to in another spec.
+
+ We have to attempt to look them up if at all possible.
+ """
+
+ def __init__(self, name):
+ self.name = self.short_name = name
+
+ def get_url(self):
+ return None
+
+ def get_title(self):
+ return 'External %s' % self.name
+
+ def get_docstring(self):
+ return None
+
+ def __repr__(self):
+ return '%s(%s)' % (self.__class__.__name__, self.name)
+
+class Interface(Base):
+ def __init__(self, parent, namespace, dom, spec_namespace):
+ super(Interface, self).__init__(parent, namespace, dom)
+
+ # If you're writing a spec with more than one top-level namespace, you
+ # probably want to replace spec_namespace with a list.
+ if self.name.startswith(spec_namespace + "."):
+ self.short_name = self.name[len(spec_namespace) + 1:]
+ else:
+ self.short_name = self.name
+
+ # build lists of methods, etc., in this interface
+ self.methods = build_list(self, Method, self.name,
+ dom.getElementsByTagName('method'))
+ self.properties = build_list(self, Property, self.name,
+ dom.getElementsByTagName('property'))
+ self.signals = build_list(self, Signal, self.name,
+ dom.getElementsByTagName('signal'))
+ self.tpproperties = build_list(self, AwkwardTelepathyProperty,
+ self.name, dom.getElementsByTagNameNS(XMLNS_TP, 'property'))
+ self.handler_capability_tokens = build_list(self,
+ HandlerCapabilityToken, self.name,
+ dom.getElementsByTagNameNS(XMLNS_TP,
+ 'handler-capability-token'))
+ self.contact_attributes = build_list(self, ContactAttribute, self.name,
+ dom.getElementsByTagNameNS(XMLNS_TP, 'contact-attribute'))
+
+ # build a list of types in this interface
+ self.types = parse_types(self, dom, self.name)
+
+ # find out if this interface causes havoc
+ self.causes_havoc = dom.getAttributeNS(XMLNS_TP, 'causes-havoc')
+ if self.causes_havoc == '': self.causes_havoc = None
+
+ # find out what we're required to also implement
+ self.requires = map(lambda n: n.getAttribute('interface'),
+ getChildrenByName(dom, XMLNS_TP, 'requires'))
+
+ def get_interface(self):
+ return self
+
+ def get_requires(self):
+ spec = self.get_spec()
+
+ def lookup(r):
+ try:
+ return spec.lookup(r)
+ except KeyError:
+ return External(r)
+
+ return map(lookup, self.requires)
+
+ def get_url(self):
+ return '%s.html' % self.name
+
+class Error(Base):
+ def get_url(self):
+ return 'errors.html#%s' % self.name
+
+ def get_root_namespace(self):
+ return self.namespace
+
+class DBusList(object):
+ """Stores a list of a given DBusType. Provides some basic validation to
+ determine whether or not the type is sane.
+ """
+ def __init__(self, child):
+ self.child = child
+
+ if isinstance(child, DBusType):
+ self.ultimate = child
+ self.depth = 1
+
+ if self.child.array_name == '':
+ raise UnsupportedArray("Type '%s' does not support being "
+ "used in an array" % self.child.name)
+ else:
+ self.name = build_name(self.child.namespace,
+ self.child.array_name)
+ self.short_name = self.child.array_name
+
+ elif isinstance(child, DBusList):
+ self.ultimate = child.ultimate
+ self.depth = child.depth + 1
+ self.name = self.child.name + '_List'
+ self.short_name = self.child.short_name + '_List'
+
+ # check that our child can operate at this depth
+ maxdepth = int(self.ultimate.array_depth)
+ if self.depth > maxdepth:
+ raise TypeError("Type '%s' has exceeded its maximum depth (%i)" % (self, maxdepth))
+
+ else:
+ raise TypeError("DBusList can contain only a DBusType or DBusList not '%s'" % child)
+
+ self.dbus_type = 'a' + self.child.dbus_type
+
+ def get_url(self):
+ return self.ultimate.get_url()
+
+ def get_title(self):
+ return "Array of %s" % self.child.get_title()
+
+ def __repr__(self):
+ return 'Array(%s)' % self.child
+
+class DBusType(Base):
+ """The base class for all D-Bus types referred to in the spec.
+
+ Don't instantiate this class directly.
+ """
+
+ devhelp_name = "typedef"
+
+ def __init__(self, parent, namespace, dom):
+ super(DBusType, self).__init__(parent, namespace, dom)
+
+ self.dbus_type = dom.getAttribute('type')
+ self.array_name = dom.getAttribute('array-name')
+ self.array_depth = dom.getAttribute('array-depth')
+
+ def get_root_namespace(self):
+ return self.namespace
+
+ def get_breakdown(self):
+ return ''
+
+ def get_url(self):
+ if isinstance(self.parent, Interface):
+ html = self.parent.get_url()
+ else:
+ html = 'generic-types.html'
+
+ return '%s#%s' % (html, self.name)
+
+class SimpleType(DBusType):
+ def get_type_name(self):
+ return 'Simple Type'
+
+class ExternalType(DBusType):
+ def __init__(self, parent, namespace, dom):
+ super(ExternalType, self).__init__(parent, namespace, dom)
+
+ # FIXME: until we are able to cross reference external types to learn
+ # about their array names, we're just going to assume they work like
+ # this
+ self.array_name = self.short_name + '_List'
+
+ def get_type_name(self):
+ return 'External Type'
+
+class StructLike(DBusType):
+ """Base class for all D-Bus types that look kind of like Structs
+
+ Don't instantiate this class directly.
+ """
+
+ class StructMember(Typed):
+ def get_root_namespace(self):
+ return self.parent.get_root_namespace()
+
+ def __init__(self, parent, namespace, dom):
+ super(StructLike, self).__init__(parent, namespace, dom)
+
+ self.members = build_list(self, StructLike.StructMember, None,
+ dom.getElementsByTagNameNS(XMLNS_TP, 'member'))
+
+ def get_breakdown(self):
+ str = ''
+ str += '<ul>\n'
+ for member in self.members:
+ # attempt to lookup the member up in the type system
+ t = member.get_type()
+
+ str += '<li>%s — %s' % (member.name, member.dbus_type)
+ if t: str += ' (<a href="%s" title="%s">%s</a>)' % (
+ t.get_url(), t.get_title(), t.short_name)
+ str += '</li>\n'
+ str += member.get_docstring()
+ str += '</ul>\n'
+
+ return str
+
+class Mapping(StructLike):
+ def __init__(self, parent, namespace, dom):
+ super(Mapping, self).__init__(parent, namespace, dom)
+
+ # rewrite the D-Bus type
+ self.dbus_type = 'a{%s}' % ''.join(map(lambda m: m.dbus_type, self.members))
+
+class Struct(StructLike):
+
+ devhelp_name = "struct"
+
+ def __init__(self, parent, namespace, dom):
+ super(Struct, self).__init__(parent, namespace, dom)
+
+ # rewrite the D-Bus type
+ self.dbus_type = '(%s)' % ''.join(map(lambda m: m.dbus_type, self.members))
+
+class EnumLike(DBusType):
+ """Base class for all D-Bus types that look kind of like Enums
+
+ Don't instantiate this class directly.
+ """
+ class EnumValue(Base):
+ def __init__(self, parent, namespace, dom):
+ super(EnumLike.EnumValue, self).__init__(parent, namespace, dom)
+
+ # rewrite self.name
+ self.short_name = dom.getAttribute('suffix')
+ self.name = build_name(namespace, self.short_name)
+
+ self.value = dom.getAttribute('value')
+
+ super(EnumLike.EnumValue, self).validate()
+
+ def validate(self):
+ pass
+
+ def get_root_namespace(self):
+ return self.parent.get_root_namespace()
+
+ def get_breakdown(self):
+ str = ''
+ str += '<ul>\n'
+ for value in self.values:
+ # attempt to lookup the member.name as a type in the type system
+ str += '<li>%s (%s)</li>\n' % (value.short_name, value.value)
+ str += value.get_added()
+ str += value.get_changed()
+ str += value.get_deprecated()
+ str += value.get_docstring()
+ str += '</ul>\n'
+
+ return str
+
+class Enum(EnumLike):
+
+ devhelp_name = "enum"
+
+ def __init__(self, parent, namespace, dom):
+ super(Enum, self).__init__(parent, namespace, dom)
+
+ self.values = build_list(self, EnumLike.EnumValue, self.name,
+ dom.getElementsByTagNameNS(XMLNS_TP, 'enumvalue'))
+
+class Flags(EnumLike):
+ def __init__(self, parent, namespace, dom):
+ super(Flags, self).__init__(parent, namespace, dom)
+
+ self.values = build_list(self, EnumLike.EnumValue, self.name,
+ dom.getElementsByTagNameNS(XMLNS_TP, 'flag'))
+ self.flags = self.values # in case you're looking for it
+
+class TokenBase(Base):
+
+ devhelp_name = "macro" # it's a constant, which is near enough...
+ separator = '/'
+
+ def __init__(self, parent, namespace, dom):
+ super(TokenBase, self).__init__(parent, namespace, dom)
+ self.name = namespace + '/' + self.short_name
+
+class ContactAttribute(TokenBase, Typed):
+
+ def get_type_name(self):
+ return 'Contact Attribute'
+
+class HandlerCapabilityToken(TokenBase):
+
+ def get_type_name(self):
+ return 'Handler Capability Token'
+
+ def __init__(self, parent, namespace, dom):
+ super(HandlerCapabilityToken, self).__init__(parent, namespace, dom)
+
+ is_family = dom.getAttribute('is-family')
+ assert is_family in ('yes', 'no', '')
+ self.is_family = (is_family == 'yes')
+
+class SectionBase(object):
+ """A SectionBase is an abstract base class for any type of node that can
+ contain a <tp:section>, which means the top-level Spec object, or any
+ Section object.
+
+ It should not be instantiated directly.
+ """
+
+ def __init__(self, dom, spec_namespace):
+
+ self.items = []
+
+ def recurse(nodes):
+ # iterate through the list of child nodes
+ for node in nodes:
+ if node.nodeType != node.ELEMENT_NODE: continue
+
+ if node.tagName == 'node':
+ # recurse into this level for interesting items
+ recurse(node.childNodes)
+ elif node.namespaceURI == XMLNS_TP and \
+ node.localName == 'section':
+ self.items.append(Section(self, None, node,
+ spec_namespace))
+ elif node.tagName == 'interface':
+ self.items.append(Interface(self, None, node,
+ spec_namespace))
+
+ recurse(dom.childNodes)
+
+class Section(Base, SectionBase):
+ def __init__(self, parent, namespace, dom, spec_namespace):
+ Base.__init__(self, parent, namespace, dom)
+ SectionBase.__init__(self, dom, spec_namespace)
+
+ def get_root_namespace(self):
+ return None
+
+class Spec(SectionBase):
+ def __init__(self, dom, spec_namespace):
+ # build a dictionary of errors in this spec
+ try:
+ errorsnode = dom.getElementsByTagNameNS(XMLNS_TP, 'errors')[0]
+ self.errors = build_dict(self, Error,
+ errorsnode.getAttribute('namespace'),
+ errorsnode.getElementsByTagNameNS(XMLNS_TP, 'error'))
+ except IndexError:
+ self.errors = {}
+
+ # build a list of generic types
+ self.generic_types = reduce (lambda a, b: a + b,
+ map(lambda l: parse_types(self, l),
+ dom.getElementsByTagNameNS(XMLNS_TP, 'generic-types')),
+ [])
+
+ # create a top-level section for this Spec
+ SectionBase.__init__(self, dom.documentElement, spec_namespace)
+
+ # build a list of interfaces in this spec
+ self.interfaces = []
+ def recurse(items):
+ for item in items:
+ if isinstance(item, Section): recurse(item.items)
+ elif isinstance(item, Interface): self.interfaces.append(item)
+ recurse(self.items)
+
+ # build a giant dictionary of everything (interfaces, methods, signals
+ # and properties); also build a dictionary of types
+ self.everything = {}
+ self.types = {}
+
+ for type in self.generic_types: self.types[type.short_name] = type
+
+ for interface in self.interfaces:
+ self.everything[interface.name] = interface
+
+ for method in interface.methods:
+ self.everything[method.name] = method
+ for signal in interface.signals:
+ self.everything[signal.name] = signal
+ for property in interface.properties:
+ self.everything[property.name] = property
+ for property in interface.tpproperties:
+ self.everything[property.name] = property
+ for token in interface.contact_attributes:
+ self.everything[token.name] = token
+ for token in interface.handler_capability_tokens:
+ self.everything[token.name] = token
+
+ for type in interface.types:
+ self.types[type.short_name] = type
+
+ # get some extra bits for the HTML
+ node = dom.getElementsByTagNameNS(XMLNS_TP, 'spec')[0]
+ self.title = getText(getChildrenByName(node, XMLNS_TP, 'title')[0])
+
+ try:
+ self.version = getText(getChildrenByName(node, XMLNS_TP, 'version')[0])
+ except IndexError:
+ self.version = None
+
+ self.copyrights = map(getText,
+ getChildrenByName(node, XMLNS_TP, 'copyright'))
+
+ try:
+ license = getChildrenByName(node, XMLNS_TP, 'license')[0]
+ license.tagName = 'div'
+ license.namespaceURI = None
+ license.setAttribute('class', 'license')
+ self.license = license.toxml()
+ except IndexError:
+ self.license = ''
+
+ # FIXME: we need to check all args for type correctness
+
+ def get_spec(self):
+ return self
+
+ def lookup(self, name, namespace=None):
+ key = build_name(namespace, name)
+ return self.everything[key]
+
+ def lookup_type(self, type_):
+ if type_.endswith('[]'):
+ return DBusList(self.lookup_type(type_[:-2]))
+
+ if type_ == '': return None
+ elif type_ in self.types:
+ return self.types[type_]
+
+ raise UnknownType("Type '%s' is unknown" % type_)
+
+ def __repr__(self):
+ return '%s(%s)' % (self.__class__.__name__, self.title)
+
+def build_dict(parent, type_, namespace, nodes):
+ """Build a dictionary of D-Bus names to Python objects representing that
+ name using the XML node for that item in the spec.
+
+ e.g. 'org.freedesktop.Telepathy.Channel' : Interface(Channel)
+
+ Works for any Python object inheriting from 'Base' whose XML node
+ implements the 'name' attribute.
+ """
+
+ def build_tuple(node):
+ o = type_(parent, namespace, node)
+ return(o.name, o)
+
+ return dict(build_tuple(n) for n in nodes)
+
+def build_list(parent, type_, namespace, nodes):
+ return map(lambda node: type_(parent, namespace, node), nodes)
+
+def parse_types(parent, dom, namespace = None):
+ """Parse all of the types of type nodes mentioned in 't' from the node
+ 'dom' and insert them into the dictionary 'd'.
+ """
+ t = [
+ (SimpleType, 'simple-type'),
+ (Enum, 'enum'),
+ (Flags, 'flags'),
+ (Mapping, 'mapping'),
+ (Struct, 'struct'),
+ (ExternalType, 'external-type'),
+ ]
+
+ types = []
+
+ for (type_, tagname) in t:
+ types += build_list(parent, type_, namespace,
+ dom.getElementsByTagNameNS(XMLNS_TP, tagname))
+
+ return types
+
+def parse(filename, spec_namespace):
+ dom = xml.dom.minidom.parse(filename)
+ xincludator.xincludate(dom, filename)
+
+ spec = Spec(dom, spec_namespace)
+
+ return spec
+
+if __name__ == '__main__':
+ parse(sys.argv[1])
diff --git a/sflphone-common/doc/dbus-api/tools/specparser.pyc b/sflphone-common/doc/dbus-api/tools/specparser.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..0a26b0bf150ae052a840cee27735b00ecd9ea6b0
Binary files /dev/null and b/sflphone-common/doc/dbus-api/tools/specparser.pyc differ
diff --git a/sflphone-common/doc/dbus-api/tools/xincludator.py b/sflphone-common/doc/dbus-api/tools/xincludator.py
new file mode 100644
index 0000000000000000000000000000000000000000..63e106ace13664eb71571342bec39780175e25bd
--- /dev/null
+++ b/sflphone-common/doc/dbus-api/tools/xincludator.py
@@ -0,0 +1,39 @@
+#!/usr/bin/python
+
+from sys import argv, stdout, stderr
+import codecs, locale
+import os
+import xml.dom.minidom
+
+stdout = codecs.getwriter('utf-8')(stdout)
+
+NS_XI = 'http://www.w3.org/2001/XInclude'
+
+def xincludate(dom, base, dropns = []):
+ remove_attrs = []
+ for i in xrange(dom.documentElement.attributes.length):
+ attr = dom.documentElement.attributes.item(i)
+ if attr.prefix == 'xmlns':
+ if attr.localName in dropns:
+ remove_attrs.append(attr)
+ else:
+ dropns.append(attr.localName)
+ for attr in remove_attrs:
+ dom.documentElement.removeAttributeNode(attr)
+ for include in dom.getElementsByTagNameNS(NS_XI, 'include'):
+ href = include.getAttribute('href')
+ # FIXME: assumes Unixy paths
+ filename = os.path.join(os.path.dirname(base), href)
+ subdom = xml.dom.minidom.parse(filename)
+ xincludate(subdom, filename, dropns)
+ if './' in href:
+ subdom.documentElement.setAttribute('xml:base', href)
+ include.parentNode.replaceChild(subdom.documentElement, include)
+
+if __name__ == '__main__':
+ argv = argv[1:]
+ dom = xml.dom.minidom.parse(argv[0])
+ xincludate(dom, argv[0])
+ xml = dom.toxml()
+ stdout.write(xml)
+ stdout.write('\n')
diff --git a/sflphone-common/doc/dbus-api/tools/xincludator.pyc b/sflphone-common/doc/dbus-api/tools/xincludator.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..1172f2daf89056937b733fe218beea72eb72f4fa
Binary files /dev/null and b/sflphone-common/doc/dbus-api/tools/xincludator.pyc differ
diff --git a/sflphone-common/doc/misc/debian-package.txt b/sflphone-common/doc/misc/debian-package.txt
deleted file mode 100644
index 23409b79dfb4227ac49caad79578864f0db85c38..0000000000000000000000000000000000000000
--- a/sflphone-common/doc/misc/debian-package.txt
+++ /dev/null
@@ -1,33 +0,0 @@
-***************************** HOW_TO DEBIAN PACKAGE ********************************
-
-This document aims at explaining how to build a binary debian package.
-
-- Identify the dependencies at the runtime. You can describe them in the control file.
-- Build the directory tree
-
- packagename_version
- |
- |
- _____|______
- | |
- \|/ \|/
- /usr DEBIAN
-
-- Write the control file in the DEBIAN directory (you must have at least this one file), and prerm, postinst scripts,..
-- Describe the files you need in the package, that is the files you need to make run the program (executables, libraries), docs, images, etc... and where you need it. For instance, the binary executables should be in /usr/bin, images in /usr/share, ...
-- Build the debian package:
- dpkg --build packagename packagename.deb .
-Note: Be careful to debian package naming conventions (packagename_version_arch.deb)
-
-- Install the package:
- dpkg --install packagename.deb (as a root)
-If the dependant packages are not automatically configured, launch sudo apt-get -f install. It will configure the package you need to make run the application.
-Note: The graphical interface of the debian package manager does configures the missing dependant packages automatically.
-
-- To remove the package, run : dpkg --remove packagename (must be root)
-
-
-
-
-
-
diff --git a/sflphone-common/doc/misc/echange.txt b/sflphone-common/doc/misc/echange.txt
deleted file mode 100644
index ee2058e56b2423aace9d6a577012cfd4ee30b0cb..0000000000000000000000000000000000000000
--- a/sflphone-common/doc/misc/echange.txt
+++ /dev/null
@@ -1,21 +0,0 @@
- --> INVITE (20) --> 0 0 IN IP4 192.168.1.172 c=IN IP4 192.168.1.172 m=audio 56198
- <-- 407 Proxy Auth
- --> ACK 20
- --> INVITE (21) 0 0 IN IP4 192.168.1.172 c=IN IP4 192.168.1.172 m=audio 56198 (proxy-auth)
- <-- 100 Trying (21 INVITE)
- <-- 180 Ringing (21 INVITE)
- <-- 200 OK root 26195 26195 IN IP4 192.168.1.10 c=IN IP4 192.168.1.10 m=audio 15792
- --> ACK 21
- <-- INVITE (102) root 26195 26196 IN IP4 192.168.1.124 c=IN IP4 192.168.1.124 m=audio 53628
- --> 100 Trying (102 INVITE)
- --> 403 Forbidden (102 INVITE)
- --> ACK (192.168.1.172) (102 ACK)
- --> INVITE (103) root 26195 26197 IN IP4 192.168.1.10 c=IN IP4 192.168.1.10 m=audio 15792
- <-- 100 Trying (103 INVITE)
- <-- 500 Retry Later (103 INVITE)
-#
-U 192.168.1.172:5060 -> 192.168.1.10:5060
- SIP/2.0 500 Retry Later..Via: SIP/2.0/UDP 192.168.1.10:5060;branch=z9hG4bK2af68dba;rport=5060..From
- : <sip:124@savoirfairelinux.net>;tag=as46619d38..To: "Yan Morin 2" <sip:sfl-127@savoirfairelinux.ne
- t>;tag=785584300..Call-ID: 1746410696@192.168.1.172..CSeq: 103 INVITE..Retry-After: 10..Allow: INVI
- TE, ACK, OPTIONS, CANCEL, BYE, SUBSCRIBE, NOTIFY, MESSAGE, INFO, REFER, UPDATE..Content-Length: 0..
\ No newline at end of file
diff --git a/sflphone-common/doc/misc/libsamplerate.png b/sflphone-common/doc/misc/libsamplerate.png
deleted file mode 100644
index 4d918b85924c7934527adcaf5d744e42e47030fc..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/misc/libsamplerate.png and /dev/null differ
diff --git a/sflphone-common/doc/misc/matrice-comparaison.ods b/sflphone-common/doc/misc/matrice-comparaison.ods
deleted file mode 100644
index 4543641697d34036c785a0991a5ab26b8918ec09..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/misc/matrice-comparaison.ods and /dev/null differ
diff --git a/sflphone-common/doc/misc/outgoingcall.txt b/sflphone-common/doc/misc/outgoingcall.txt
deleted file mode 100644
index b08053381261641d87ab6995b748c971bfc66a86..0000000000000000000000000000000000000000
--- a/sflphone-common/doc/misc/outgoingcall.txt
+++ /dev/null
@@ -1,15 +0,0 @@
-1. outgoingCall()
-1.1 generateNewCallId() (short)
-1.2 pushBackNewCall()
-1.2.1 new Call(id, type, _voIPLinkVector.at(DFT_VOIP_LINK))
-1.2.1.1 _state = NotExist;
-1.2.1.2 _voIPLink->newOutgoingCall(_id);
-1.2.1.2.1 new SipCall(callid, Manager::instance().getCodecDescVector()));
-1.2.1.2.2 _sipcallVector.push_back(sipcall);
-1.2.1.2.3 sipcall->setStandBy(true);
-1.2.2 _callVector.push_back(call);
-1.3 call->setStatus(string(TRYING_STATUS));
-1.4 call->setState(Progressing);
-1.5 call->setCallerIdNumber(to);
-1.6 call->outgoingCall(to);
-
diff --git a/sflphone-common/doc/misc/playtone.txt b/sflphone-common/doc/misc/playtone.txt
deleted file mode 100644
index f8efb9212fd25fbdd0dd73ffa8e79d65b6608b11..0000000000000000000000000000000000000000
--- a/sflphone-common/doc/misc/playtone.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-Appel:
-playtone s1 [joue tant que playtone = false]
-playdtmf s2 1 [si playtone = true ( playtone = false) flush, start playdtmf]
-playdtmf s3 0 []
-playdtmf s4 3 []
-
-
-
-
diff --git a/sflphone-common/doc/misc/sflphoneqt-startup.txt b/sflphone-common/doc/misc/sflphoneqt-startup.txt
deleted file mode 100644
index 5b2af9b903d9f53eec081a8969d88993112853db..0000000000000000000000000000000000000000
--- a/sflphone-common/doc/misc/sflphoneqt-startup.txt
+++ /dev/null
@@ -1,61 +0,0 @@
-main.cpp: main()
--> app = new SFLPhoneApp
- -> new SessionIO, 3999
- -> new session
- -> new SessionId
- -> new SessionIO (create)
- -> Requester::registerSession()
- -> envoie session a ConfigurationManager
- -> envoie session a PhoneLineManager(initialize)
- -> new Session(session)
- -> new Account <-- supprimé
- -> configure le nombre de ligne de PhoneLineManager::setNbLines
- -> new PhoneLine
-
- -> new Request Object (commande)
- -> new NumericKeypad
--> new and show splash
--> sfl = new SFLPhoneWindow
- -> positionne fenêtre
- -> new ConfigurationPanel
- -> connection updates au panel
- -> connection bouton panel a la fenetre
- -> peinture apres 50 milli-seconde
- -> initialisation graphique
-
--> initConnections(sfl)
- -> associe les PhoneLineButton au PhoneLine
- -> associe needRegister
- -> associe soundDriverChanged
- -> connecte les boutons de la fenetre au phonelinemanager
- -> associe phonelinemanager au lcd (messages texet)
- -> associe evenement daemon
- -> associe lauching (daemon)
- -> associe status - phone line
- -> associe evenement update, setup
--> launch
- -> Launcher->start()
--> PhoneLineManager::connect et attend "connected"
--> loadSkin
--> exec
-
-Evenement:
--Lorsque le PhoneLineManager est connectée (connected)
- le splash disparait splash.hide()
--Lorsque le PhoneLineManager gère le getEvents
- app.handleArg()
-
-TCPSessionIOCreator::create
--> TCPSessionIO::connected|
- PhoneLineManagerImpl::connected|
- -> PhoneLineManagerImpl::readyToSendStatus|
- -> PhoneLineManagerImpl::startSession()
- -> mSession::getCallStatus()
- -> SFLPhoneWindow::show
- -> splash::hide
-
-CallStatusRequest
- -> onSuccess -> PhoneLineManager::selectLine()
- -> PhoneLineManager::handleEvents()
- -> onEntry -> CallStatus::execute() -> PhoneLineManager::addCall()
- -> onError -> PhoneLineManager::errorOnCallStatus()
diff --git a/sflphone-common/doc/screenshots/accounts.png b/sflphone-common/doc/screenshots/accounts.png
deleted file mode 100644
index 2a1d033892ad357faf1e79c20141ffb9b6bd1d80..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/accounts.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/audio-parameters.png b/sflphone-common/doc/screenshots/audio-parameters.png
deleted file mode 100644
index 7be7badab519fd06a3c5ef00f9c2916f12511f4b..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/audio-parameters.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/desktop-notif-voice mail.png b/sflphone-common/doc/screenshots/desktop-notif-voice mail.png
deleted file mode 100644
index 4d2899877f696477da49f7cee1935e52d43189bf..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/desktop-notif-voice mail.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/desktop-notification.png b/sflphone-common/doc/screenshots/desktop-notification.png
deleted file mode 100644
index c854b8252253f8fdb9c89ee41fc02b2ef2ca9c3a..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/desktop-notification.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/gtk gui.png b/sflphone-common/doc/screenshots/gtk gui.png
deleted file mode 100644
index 958beb4ee40b156630d41ecb7c5ce77f35cb4256..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/gtk gui.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/several-calls.png b/sflphone-common/doc/screenshots/several-calls.png
deleted file mode 100644
index 65dc12dbcbba742c04f3d974bca9fe660a004756..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/several-calls.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/sflphoneDialpad_gtk_0.8.png b/sflphone-common/doc/screenshots/sflphoneDialpad_gtk_0.8.png
deleted file mode 100644
index 00d6ce8a0620d1a81244146884b22cf641a26906..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/sflphoneDialpad_gtk_0.8.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/sflphone_gtk_0.8.png b/sflphone-common/doc/screenshots/sflphone_gtk_0.8.png
deleted file mode 100644
index 39b01d78d6c16ed71c20c13b548b7f5f2db9ff33..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/sflphone_gtk_0.8.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/sflphone_metal.png b/sflphone-common/doc/screenshots/sflphone_metal.png
deleted file mode 100644
index ed34ee700257aa068667d3ebf6db1966f7cbd1c9..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/sflphone_metal.png and /dev/null differ
diff --git a/sflphone-common/doc/screenshots/sflphone_qt3_0.6.2.png b/sflphone-common/doc/screenshots/sflphone_qt3_0.6.2.png
deleted file mode 100644
index 3b53ce3190013f36ff1a4dc8bb54b051f51ca865..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/screenshots/sflphone_qt3_0.6.2.png and /dev/null differ
diff --git a/sflphone-common/doc/sflphone_video/abstract.odt b/sflphone-common/doc/sflphone_video/abstract.odt
deleted file mode 100644
index e9263f9cff27f087345e37418b363eba096349b0..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/sflphone_video/abstract.odt and /dev/null differ
diff --git a/sflphone-common/doc/sflphone_video/ressources.odt b/sflphone-common/doc/sflphone_video/ressources.odt
deleted file mode 100644
index 1c9cfed4cc410d060e1f4fc2bc4b959ccf66764b..0000000000000000000000000000000000000000
Binary files a/sflphone-common/doc/sflphone_video/ressources.odt and /dev/null differ
diff --git a/sflphone-common/src/dbus/instance-introspec.xml b/sflphone-common/src/dbus/instance-introspec.xml
index 6d8879e622cb5dc2cfdc23c4333e29f89870df5e..4b7d075cd87112df83744e3740f892d4f1cb26e5 100644
--- a/sflphone-common/src/dbus/instance-introspec.xml
+++ b/sflphone-common/src/dbus/instance-introspec.xml
@@ -2,7 +2,7 @@
<node name="/instance-introspec" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.sflphone.SFLphone.Instance">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Instances Manager to handle multiple client connections to the core.</p>
+ <p>Count the number of clients actually registered to the core. When initializing your client, you need to register it against the core by using this interface.</p>
</tp:docstring>
<method name="Register" tp:name-for-bindings="Register">
<tp:docstring>