Add documentation generator and mock docs

2 files changed, 175 insertions, 0 deletions

diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt
new file mode 100644
index 0000000..957fdbf
--- /dev/null
+++ b/tools/CMakeLists.txt
@@ -0,0 +1,24 @@
+cmake_minimum_required(VERSION 2.8)
+
+add_definitions("--std=c99 -Wall")
+
+# --- Find packages and libraries ---------------------------------------------
+find_package(PkgConfig)
+
+pkg_check_modules(GLIB2 glib-2.0>=2.24 REQUIRED)
+pkg_check_modules(GOBJECT2 gobject-2.0>=2.24 REQUIRED)
+
+# --- Build targets -----------------------------------------------------------
+include_directories(
+    ${GLIB2_INCLUDE_DIRS}
+    ${GOBJECT2_INCLUDE_DIRS}
+    ${CMAKE_CURRENT_BINARY_DIR}/../src/
+    ${CMAKE_CURRENT_SOURCE_DIR}/../src
+    )
+
+add_executable(gen-doc gen-doc.c)
+
+target_link_libraries(gen-doc uca 
+    ${GLIB2_LIBRARIES}
+    ${GOBJECT2_LIBRARIES}
+    )
diff --git a/tools/gen-doc.c b/tools/gen-doc.c
new file mode 100644
index 0000000..d9b6b41
--- /dev/null
+++ b/tools/gen-doc.c
@@ -0,0 +1,151 @@
+/* Copyright (C) 2012 Matthias Vogelgesang <matthias.vogelgesang@kit.edu>
+   (Karlsruhe Institute of Technology)
+
+   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, USA */
+
+#include <glib-object.h>
+#include "uca-plugin-manager.h"
+#include "uca-camera.h"
+
+
+static void
+print_usage (void)
+{
+    GList *types;
+    UcaPluginManager *manager;
+
+    manager = uca_plugin_manager_new ();
+    g_print ("Usage: gen-doc [ ");
+    types = uca_plugin_manager_get_available_cameras (manager);
+
+    if (types == NULL) {
+        g_print ("] -- no camera plugin found\n");
+        return;
+    }
+
+    for (GList *it = g_list_first (types); it != NULL; it = g_list_next (it)) {
+        gchar *name = (gchar *) it->data;
+        if (g_list_next (it) == NULL)
+            g_print ("%s ]\n", name);
+        else
+            g_print ("%s, ", name);
+    }
+}
+
+static const gchar *
+get_flags_description (GParamSpec *pspec)
+{
+    static const gchar *descriptions[] = {
+        "",
+        "Read-only",
+        "Write-only",
+        "Read / Write",
+        ""
+    };
+
+    if (pspec->flags >= 3)
+        return descriptions[3];
+
+    return descriptions[pspec->flags];
+}
+
+static void
+print_property_toc (GParamSpec **pspecs, guint n_props)
+{
+    g_print ("<h2>Properties</h2><ul id=\"toc\">");
+
+    for (guint i = 0; i < n_props; i++) {
+        GParamSpec *pspec = pspecs[i]; 
+        const gchar *name = g_param_spec_get_name (pspec);
+    
+        g_print ("<li><code><a href=#%s>\"%s\"</a></code></li>", name, name);
+    }
+
+    g_print ("</ul>");
+}
+
+static void
+print_property_descriptions (GParamSpec **pspecs, guint n_props)
+{
+    g_print ("<h2>Details</h2><dl>");
+
+    for (guint i = 0; i < n_props; i++) {
+        GParamSpec *pspec = pspecs[i]; 
+        const gchar *name = g_param_spec_get_name (pspec);
+
+        g_print ("<dt id=\"%s\"><a href=\"#toc\">%s</a></dt>\n", name, name);
+        g_print ("<dd>");
+        g_print ("<pre><code class=\"prop-type\">\"%s\" : %s : %s</code></pre>\n", 
+                 name, 
+                 g_type_name (pspec->value_type),
+                 get_flags_description (pspec));
+        g_print ("<p>%s</p>\n", g_param_spec_get_blurb (pspec));
+        g_print ("</dd>");
+    }
+
+    g_print ("</dl>");
+}
+
+static void
+print_properties (UcaCamera *camera)
+{
+    GObjectClass *oclass;
+    GParamSpec **pspecs;
+    guint n_props;
+    
+    oclass = G_OBJECT_GET_CLASS (camera);
+    pspecs = g_object_class_list_properties (oclass, &n_props);
+
+    print_property_toc (pspecs, n_props);
+    print_property_descriptions (pspecs, n_props);
+
+    g_free (pspecs);
+}
+
+static const gchar *html_header = "<html><head>\
+<link rel=\"stylesheet\" href=\"style.css\" type=\"text/css\" />\
+<link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700|Droid+Serif:400,400italic|Inconsolata' rel='stylesheet' type='text/css'>\
+<title>%s &mdash; properties</title></head><body>";
+static const gchar *html_footer = "</body></html>";
+
+int main(int argc, char *argv[])
+{
+    UcaPluginManager *manager;
+    UcaCamera *camera;
+    GError *error = NULL;
+
+    g_type_init();
+
+    if (argc < 2) {
+        print_usage();
+        return 1;
+    }
+
+    manager = uca_plugin_manager_new ();
+    camera = uca_plugin_manager_new_camera (manager, argv[1], &error);
+
+    if (camera == NULL) {
+        g_print("Error during initialization: %s\n", error->message);
+        return 1;
+    }
+
+    g_print (html_header, argv[1]);
+    g_print ("<div id=\"header\"><h1 class=\"title\">Property documentation of %s</h1>", argv[1]);
+    print_properties (camera);
+    g_print ("%s\n", html_footer);
+
+    g_object_unref (camera);
+    g_object_unref (manager);
+}