Rename python renderer to plugin example and leave it be as a template

CMakeLists.txt

@@ -30,6 +30,7 @@ pkg_search_module(GLIB REQUIRED glib-2.0)
 pkg_check_modules(GTK3 REQUIRED gtk+-3.0)
 pkg_check_modules(CAIRO REQUIRED cairo)
 
+include_directories(${GLIB_INCLUDE_DIRS} ${GTK3_INCLUDE_DIRS} ${CAIRO_INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR}/include)
 add_subdirectory(plugins)
 
 add_compile_options(-Wall -Wextra -Wold-style-declaration -Wuninitialized -Wmaybe-uninitialized -Wunused-parameter)
@@ -48,7 +49,6 @@ add_subdirectory(doxygen)
 add_subdirectory(translations)
 add_subdirectory(version)
 
-include_directories(${GLIB_INCLUDE_DIRS} ${GTK3_INCLUDE_DIRS} ${CAIRO_INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR}/include)
 link_directories(${GLIB_LINK_DIRS} ${GTK3_LINK_DIRS} ${CAIRO_LINK_DIRS})
 add_definitions(${GLIB2_CFLAGS_OTHER})
 

command-line.c

@@ -104,7 +104,9 @@ static int create_renderers(char **renderers,
 				fprintf(stderr, _("Please specify shared object for external renderer. Will ignore this renderer.\n"));
 				continue;
 			}
-			output_renderer = GDS_RENDER_OUTPUT_RENDERER(external_renderer_new_with_so(ext_params->so_path));
+			output_renderer = GDS_RENDER_OUTPUT_RENDERER(
+						external_renderer_new_with_so_and_param(ext_params->so_path,
+											ext_params->cli_params));
 		} else {
 			continue;
 		}

doxygen/external-renderer.dox

@@ -9,6 +9,7 @@
  * Property Name    | Description
  * -----------------|----------------------------------------------------------------
  * shared-object-path  | Path to the shared object used for rendering
+ * param-string | Command line parameters passed to external renderer's init function
  *
  * All these properties have to be set for rendering.
  *

include/gds-render/output-renderers/external-renderer-interfaces.h

@@ -41,6 +41,11 @@
  */
 #define EXTERNAL_LIBRARY_FORK_REQUEST exported_fork_request
 
+/**
+ * @brief Define for declaring the exported functions
+ */
+#define FUNC_DECL(FUNC) FUNC
+
 /** @} */
 
 #endif /* __EXTERNAL_RENDERER_INTERFACES_H__ */

include/gds-render/output-renderers/external-renderer.h

@@ -50,9 +50,10 @@ ExternalRenderer *external_renderer_new();
 /**
  * @brief Create new ExternalRenderer object with specified shared object path
  * @param so_path Path to shared object, the rendering function is searched in
+ * @param param_string Command line parameter string passed to external renderer
  * @return New object.
  */
-ExternalRenderer *external_renderer_new_with_so(const char *so_path);
+ExternalRenderer *external_renderer_new_with_so_and_param(const char *so_path, const char *param_string);
 
 G_END_DECLS
 

output-renderers/external-renderer.c

@@ -40,10 +40,12 @@
 struct _ExternalRenderer {
 	GdsOutputRenderer parent;
 	char *shared_object_path;
+	char *cli_param_string;
 };
 
 enum {
 	PROP_SO_PATH = 1, /**< @brief Shared object path property */
+	PROP_PARAM_STRING, /** @brief Shared object renderer parameter string from CLI */
 	N_PROPERTIES /**< @brief Used to get property count */
 };
 
@@ -56,10 +58,11 @@ G_DEFINE_TYPE(ExternalRenderer, external_renderer, GDS_RENDER_TYPE_OUTPUT_RENDER
  * @param output_file Destination file
  * @param scale the scaling value to scale the output cell down by.
  * @param so_path Path to shared object
+ * @param params Parameters passed to EXTERNAL_LIBRARY_INIT_FUNCTION
  * @return 0 if successful
  */
 static int external_renderer_render_cell(struct gds_cell *toplevel_cell, GList *layer_info_list,
-				   const char *output_file, double scale,  const char *so_path)
+				   const char *output_file, double scale,  const char *so_path, const char *params)
 {
 	int (*so_render_func)(struct gds_cell *, GList *, const char *, double) = NULL;
 	int (*so_init_func)(const char *, const char *) = NULL;
@@ -120,14 +123,15 @@ static int external_renderer_render_cell(struct gds_cell *toplevel_cell, GList *
 	if (fork_pid != 0)
 		goto end_forked;
 
-	// TODO: Get parameters form command line and pass here
-	ret = so_init_func(NULL, _app_version_string);
+	ret = so_init_func(params, _app_version_string);
 	if (!ret)
 		ret = so_render_func(toplevel_cell, layer_info_list, output_file, scale);
 
+	/* If we are in a separate process, terminate here */
 	if (forking_req)
 		exit(ret);
 
+	/* The forked paths end here */
 end_forked:
 	if (forking_req) {
 		waitpid(fork_pid, &forked_status, 0);
@@ -158,7 +162,8 @@ static int external_renderer_render_output(GdsOutputRenderer *renderer,
 	if (settings)
 		layer_infos = layer_settings_get_layer_info_list(settings);
 
-	ret = external_renderer_render_cell(cell, layer_infos, output_file, scale, ext_renderer->shared_object_path);
+	ret = external_renderer_render_cell(cell, layer_infos, output_file, scale, ext_renderer->shared_object_path,
+					    ext_renderer->cli_param_string);
 	if (settings)
 		g_object_unref(settings);
 
@@ -175,6 +180,9 @@ static void external_renderer_get_property(GObject *obj, guint property_id, GVal
 	case PROP_SO_PATH:
 		g_value_set_string(value, self->shared_object_path);
 		break;
+	case PROP_PARAM_STRING:
+		g_value_set_string(value, self->cli_param_string);
+		break;
 	default:
 		G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, property_id, pspec);
 		break;
@@ -193,6 +201,11 @@ static void external_renderer_set_property(GObject *obj, guint property_id, cons
 			g_free(self->shared_object_path);
 		self->shared_object_path = g_value_dup_string(value);
 		break;
+	case PROP_PARAM_STRING:
+		if (self->cli_param_string)
+			g_free(self->cli_param_string);
+		self->cli_param_string = g_value_dup_string(value);
+		break;
 	default:
 		G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, property_id, pspec);
 		break;
@@ -201,7 +214,9 @@ static void external_renderer_set_property(GObject *obj, guint property_id, cons
 
 static void external_renderer_dispose(GObject *self_obj)
 {
-	ExternalRenderer *self = GDS_RENDER_EXTERNAL_RENDERER(self_obj);
+	ExternalRenderer *self;
+
+	self = GDS_RENDER_EXTERNAL_RENDERER(self_obj);
 
 	if (self->shared_object_path) {
 		g_free(self->shared_object_path);
@@ -236,12 +251,19 @@ static void external_renderer_class_init(ExternalRendererClass *klass)
 					    "Path to the shared object to search rendering function in.",
 					    NULL,
 					    G_PARAM_READWRITE);
+	external_renderer_properties[PROP_PARAM_STRING] =
+			g_param_spec_string("param-string",
+					    "Shared object renderer parameter string",
+					    "Command line arguments passed to the external shared object renderer",
+					    NULL,
+					    G_PARAM_READWRITE);
 	g_object_class_install_properties(oclass, N_PROPERTIES, external_renderer_properties);
 }
 
 static void external_renderer_init(ExternalRenderer *self)
 {
 	self->shared_object_path = NULL;
+	self->cli_param_string = NULL;
 }
 
 ExternalRenderer *external_renderer_new()
@@ -249,9 +271,10 @@ ExternalRenderer *external_renderer_new()
 	return g_object_new(GDS_RENDER_TYPE_EXTERNAL_RENDERER, NULL);
 }
 
-ExternalRenderer *external_renderer_new_with_so(const char *so_path)
+ExternalRenderer *external_renderer_new_with_so_and_param(const char *so_path, const char *param_string)
 {
-	return g_object_new(GDS_RENDER_TYPE_EXTERNAL_RENDERER, "shared-object-path", so_path, NULL);
+	return g_object_new(GDS_RENDER_TYPE_EXTERNAL_RENDERER, "shared-object-path", so_path,
+				"param-string", param_string,NULL);
 }
 
 /** @} */

plugins/CMakeLists.txt

@@ -1,2 +1,2 @@
-add_subdirectory(python-renderer)
-add_custom_target(plugins DEPENDS pythonrenderer)
+add_subdirectory(plugin-example)
+add_custom_target(plugins DEPENDS pluginexample)

plugins/plugin-example/CMakeLists.txt

@@ -1,4 +1,4 @@
-project(pythonrenderer)
+project(pluginexample)
 cmake_minimum_required(VERSION 2.8)
 find_package(PkgConfig REQUIRED)
 pkg_search_module(PYTHON REQUIRED python3)

plugins/plugin-example/src/plugin-main.c

@@ -0,0 +1,19 @@
+#include <stdio.h>
+#include <glib.h>
+#include <gds-render/gds-utils/gds-types.h>
+#include <gds-render/output-renderers/external-renderer-interfaces.h>
+
+int FUNC_DECL(EXTERNAL_LIBRARY_RENDER_FUNCTION)(struct gds_cell *toplevel, GList *layer_info_list, const char *output_file_name, double scale)
+{
+	if (!toplevel)
+		return -1000;
+
+	printf("Rendering %s\n", toplevel->name);
+	return 0;
+}
+
+int FUNC_DECL(EXTERNAL_LIBRARY_INIT_FUNCTION)(const char *params, const char *version)
+{
+	printf("Init with params: %s\ngds-render version: %s\n", params, version);
+	return 0;
+}

plugins/python-renderer/src/plugin-main.c

@@ -1,7 +0,0 @@
-#include <stdio.h>
-#include <stdlib.h>
-
-int a(void)
-{
-	return 0;
-}