Merge pull request #37 from activey/#3

#3 - debian package builder plugin :) Very early version ;P

Author: Łukasz Grabski

.gitignore

@@ -1,4 +1,5 @@
-target/*
-src/library/c/
-src/library/vapi/
+target/bin/*
+target/plugins/*
+src/library/c/*.h
+src/library/vapi/*.vapi
 **/target/lib/*.so

build-cmdline.sh

@@ -10,4 +10,4 @@ PACKAGES_PREFIXED=$(printf " --pkg %s" "${PACKAGES[@]}")
 VAPI_DIRS_PREFIXED=$(printf " --vapidir %s" "${VAPI_DIRS[@]}")
 
 mkdir -p target/plugins
-valac -g -v $SOURCES_PREFIXED -X -Wl,-rpath=\$ORIGIN/lib -X -Ltarget/lib -X -lbob -X -Isrc/library/c $VAPI_DIRS_PREFIXED $PACKAGES_PREFIXED -o target/bob
+valac -g -v $SOURCES_PREFIXED -X -Wl,-rpath=\$ORIGIN/lib -X -Ltarget/lib -X -lbob -X -Isrc/library/c $VAPI_DIRS_PREFIXED $PACKAGES_PREFIXED -o target/bin/bob

plugin-build/old.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+LIBRARY_NAME='plugin-build'
+VAPI_SOURCES=(`find ../src/library/vapi -type f -name "**.vapi"`)
+HEADER_LOCATION=('../src/library/c')
+SOURCES=(`find src/library/vala -type f -name "**.vala"`)
+PACKAGES=('glib-2.0' 'gobject-2.0' 'gio-2.0' 'json-glib-1.0' 'gmodule-2.0' 'libvala-0.28')
+
+VAPI_SOURCES_PREFIXED=$(printf "%s " "${VAPI_SOURCES[@]}")
+SOURCES_PREFIXED=$(printf "%s " "${SOURCES[@]}")
+PACKAGES_PREFIXED=$(printf " --pkg %s" "${PACKAGES[@]}")
+
+mkdir -p target/lib
+valac -v --library=$LIBRARY_NAME $VAPI_SOURCES_PREFIXED $SOURCES_PREFIXED -X -fPIC -X --shared -X -I$HEADER_LOCATION $PACKAGES_PREFIXED -o target/lib/lib$LIBRARY_NAME.so

plugin-build/src/library/c/plugin-build-0.0.1.h

@@ -9,6 +9,7 @@
 #include <glib-object.h>
 #include <stdlib.h>
 #include <string.h>
+#include <vala.h>
 
 G_BEGIN_DECLS
 
@@ -101,6 +102,17 @@ typedef struct _bobbuilderbuildpluginCCOptions bobbuilderbuildpluginCCOptions;
 typedef struct _bobbuilderbuildpluginCCOptionsClass bobbuilderbuildpluginCCOptionsClass;
 typedef struct _bobbuilderbuildpluginCCOptionsPrivate bobbuilderbuildpluginCCOptionsPrivate;
 
+#define BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER (bob_builder_build_plugin_depenedency_data_tester_get_type ())
+#define BOB_BUILDER_BUILD_PLUGIN_DEPENEDENCY_DATA_TESTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER, bobbuilderbuildpluginDepenedencyDataTester))
+#define BOB_BUILDER_BUILD_PLUGIN_DEPENEDENCY_DATA_TESTER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER, bobbuilderbuildpluginDepenedencyDataTesterClass))
+#define BOB_BUILDER_BUILD_PLUGIN_IS_DEPENEDENCY_DATA_TESTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER))
+#define BOB_BUILDER_BUILD_PLUGIN_IS_DEPENEDENCY_DATA_TESTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER))
+#define BOB_BUILDER_BUILD_PLUGIN_DEPENEDENCY_DATA_TESTER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), BOB_BUILDER_BUILD_PLUGIN_TYPE_DEPENEDENCY_DATA_TESTER, bobbuilderbuildpluginDepenedencyDataTesterClass))
+
+typedef struct _bobbuilderbuildpluginDepenedencyDataTester bobbuilderbuildpluginDepenedencyDataTester;
+typedef struct _bobbuilderbuildpluginDepenedencyDataTesterClass bobbuilderbuildpluginDepenedencyDataTesterClass;
+typedef struct _bobbuilderbuildpluginDepenedencyDataTesterPrivate bobbuilderbuildpluginDepenedencyDataTesterPrivate;
+
 struct _bobbuilderbuildpluginBuildApplicationPlugin {
 	bobbuilderbuildpluginAbstractBobBuildPlugin parent_instance;
 	bobbuilderbuildpluginBuildApplicationPluginPrivate * priv;
@@ -151,14 +163,12 @@ typedef enum  {
 } bobbuilderbuildpluginCompilationError;
 #define BOB_BUILDER_BUILD_PLUGIN_COMPILATION_ERROR bob_builder_build_plugin_compilation_error_quark ()
 struct _bobbuilderbuildpluginValaCodeCompiler {
-	GTypeInstance parent_instance;
-	volatile int ref_count;
+	ValaCodeVisitor parent_instance;
 	bobbuilderbuildpluginValaCodeCompilerPrivate * priv;
 };
 
 struct _bobbuilderbuildpluginValaCodeCompilerClass {
-	GTypeClass parent_class;
-	void (*finalize) (bobbuilderbuildpluginValaCodeCompiler *self);
+	ValaCodeVisitorClass parent_class;
 };
 
 struct _bobbuilderbuildpluginValaCodeCompilerOutcome {
@@ -194,6 +204,15 @@ struct _bobbuilderbuildpluginCCOptionsClass {
 	void (*finalize) (bobbuilderbuildpluginCCOptions *self);
 };
 
+struct _bobbuilderbuildpluginDepenedencyDataTester {
+	ValaCodeVisitor parent_instance;
+	bobbuilderbuildpluginDepenedencyDataTesterPrivate * priv;
+};
+
+struct _bobbuilderbuildpluginDepenedencyDataTesterClass {
+	ValaCodeVisitorClass parent_class;
+};
+
 
 GType bob_builder_build_plugin_build_application_plugin_get_type (void) G_GNUC_CONST;
 bobbuilderbuildpluginBuildApplicationPlugin* bob_builder_build_plugin_build_application_plugin_new (void);
@@ -284,12 +303,6 @@ void bob_builder_build_plugin_build_configuration_library_usage_builder_set_vapi
 bobbuilderrecipeprojectBobBuildProjectDependencyScope bob_builder_build_plugin_build_configuration_library_usage_builder_get_scope (bobbuilderbuildpluginBuildConfigurationLibraryUsageBuilder* self);
 void bob_builder_build_plugin_build_configuration_library_usage_builder_set_scope (bobbuilderbuildpluginBuildConfigurationLibraryUsageBuilder* self, bobbuilderrecipeprojectBobBuildProjectDependencyScope value);
 GQuark bob_builder_build_plugin_compilation_error_quark (void);
-gpointer bob_builder_build_plugin_vala_code_compiler_ref (gpointer instance);
-void bob_builder_build_plugin_vala_code_compiler_unref (gpointer instance);
-GParamSpec* bob_builder_build_plugin_param_spec_vala_code_compiler (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags);
-void bob_builder_build_plugin_value_set_vala_code_compiler (GValue* value, gpointer v_object);
-void bob_builder_build_plugin_value_take_vala_code_compiler (GValue* value, gpointer v_object);
-gpointer bob_builder_build_plugin_value_get_vala_code_compiler (const GValue* value);
 GType bob_builder_build_plugin_vala_code_compiler_get_type (void) G_GNUC_CONST;
 bobbuilderbuildpluginValaCodeCompiler* bob_builder_build_plugin_vala_code_compiler_new (bobbuilderbuildpluginBuildConfiguration* buildConfiguration);
 bobbuilderbuildpluginValaCodeCompiler* bob_builder_build_plugin_vala_code_compiler_construct (GType object_type, bobbuilderbuildpluginBuildConfiguration* buildConfiguration);
@@ -336,6 +349,10 @@ void bob_builder_build_plugin_cc_options_addCHeadersDirectoryLocation (bobbuilde
 void bob_builder_build_plugin_cc_options_useLibrary (bobbuilderbuildpluginCCOptions* self, const gchar* name);
 void bob_builder_build_plugin_cc_options_addDebugFlag (bobbuilderbuildpluginCCOptions* self);
 gchar** bob_builder_build_plugin_cc_options_getCcOptions (bobbuilderbuildpluginCCOptions* self, int* result_length1);
+GType bob_builder_build_plugin_depenedency_data_tester_get_type (void) G_GNUC_CONST;
+bobbuilderbuildpluginDepenedencyDataTester* bob_builder_build_plugin_depenedency_data_tester_new (const gchar* package, const gchar* vapiFilePath);
+bobbuilderbuildpluginDepenedencyDataTester* bob_builder_build_plugin_depenedency_data_tester_construct (GType object_type, const gchar* package, const gchar* vapiFilePath);
+void bob_builder_build_plugin_depenedency_data_tester_test (bobbuilderbuildpluginDepenedencyDataTester* self);
 
 
 G_END_DECLS

plugin-build/src/library/vala/bob/builder/build/plugin/BuildApplicationPlugin.vala

@@ -70,7 +70,7 @@ namespace bob.builder.build.plugin {
 				.cHeaderFileName(BobFiles.FILE_SOURCE_C_HEADER_NAME.printf(projectRecipe.shortName, projectRecipe.version))
 				.ccOption("-fPIC")
 				.ccOption("-shared")
-				.ccOption("-Wl,-rpath=\$ORIGIN/%s".printf(BobDirectories.DIRECTORY_LIB))
+				.ccOption("-Wl,-rpath=\$ORIGIN/../%s".printf(BobDirectories.DIRECTORY_LIB))
 				.ccOption("-L%s".printf(BobDirectories.DIRECTORY_TARGET_LIB))
 				.build();
 			return new ValaCodeCompiler(buildConfiguration);
@@ -81,9 +81,9 @@ namespace bob.builder.build.plugin {
 				.runtimeScope()
 				.dependencies(projectRecipe.dependencies)
 				.sources(projectRecipe.mainSourceFiles)
-				.targetDirectory(BobDirectories.DIRECTORY_TARGET)
+				.targetDirectory(BobDirectories.DIRECTORY_TARGET_BIN)
 				.targetFileName(projectRecipe.shortName)
-				.ccOption("-Wl,-rpath=\$ORIGIN/%s".printf(BobDirectories.DIRECTORY_LIB))
+				.ccOption("-Wl,-rpath=\$ORIGIN/../%s".printf(BobDirectories.DIRECTORY_LIB))
 				.ccOption("-L%s".printf(BobDirectories.DIRECTORY_TARGET_LIB));
 
 			if (libraryCompilationOutcome.binaryGenerated) {

plugin-build/src/library/vala/bob/builder/build/plugin/ValaCodeCompiler.vala

@@ -9,7 +9,7 @@ namespace bob.builder.build.plugin {
         PARSING_ERROR, CCOMPILATION_ERROR
     }
 
-    public class ValaCodeCompiler {
+    public class ValaCodeCompiler : CodeVisitor {
 
         private const string DEFAULT_COLORS = "error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01";
 

plugin-build/src/library/vapi/plugin-build-0.0.1.vapi

@@ -80,7 +80,14 @@ namespace bob {
 					public void useLibrary (string name);
 				}
 				[CCode (cheader_filename = "plugin-build-0.0.1.h")]
-				public class ValaCodeCompiler {
+				public class DepenedencyDataTester : Vala.CodeVisitor {
+					public DepenedencyDataTester (string package, string vapiFilePath);
+					public void test ();
+					public override void visit_class (Vala.Class clazz);
+					public override void visit_source_file (Vala.SourceFile sourceFile);
+				}
+				[CCode (cheader_filename = "plugin-build-0.0.1.h")]
+				public class ValaCodeCompiler : Vala.CodeVisitor {
 					public ValaCodeCompiler (bob.builder.build.plugin.BuildConfiguration buildConfiguration);
 					public bob.builder.build.plugin.ValaCodeCompilerOutcome compile () throws bob.builder.build.plugin.CompilationError;
 				}

plugin-debian/README.md

@@ -0,0 +1,57 @@
+# Debian packaging plugin
+Given code base consists of two Valder build plugins which are capable of creating debian packages with two different forms:
+
+## debian:package
+This particular plugin creates a .deb file with all runtime and libriaries binaries locater under target/ directory structure. It's algorithm is quite naive and follows given steps:
+
+* Collect all binaries located under **target/bin** and **target/lib**,
+* Call 'ldd <file>' for each of them where <file> is one of collected binaries,
+* Call 'dpkg <library>' for each library used to get list of required dependencies,
+* Generate control and md5sums files,
+* Pack everything with 'dpkg -b'
+
+## debian:package-dev
+As you can guess this plugin creates a debian archive with all development files necessary for further usage by other developers out there. It's algorithm is slightly more complicated and involces steps as following:
+
+* Initialize CodeContext from libvala,
+* For each project dependency do:
+  * Use dependency as a temporary CodeContext external package,
+  * Do an AST traversal using CodeVisitor instance,
+  * Collect all .vapi and .h files found by CodeContext and CodeVisitor referenced anywhere possible,
+  * For each .h file run 'dpkg -S' and 'apt search' to find debian package that contains given file,
+  * Generate control and md5sums files,
+  * Pack everything with 'dpkg -b'
+
+Usualy in debian control file one can define some additional metadata like package section name, mainainter address, etc. For that purpose, receipe file (**receipe.bob**) structure has been extended and now now allows to define some additional information. Please find following example:
+
+```json
+{
+    "project": {
+        "name": "Some project",
+        "shortName": "something",
+        "version": "0.0.1",
+        "details": {
+            "description": "This is some project",
+            "authors": ["Lukasz Grabski <[email protected]>", "Linus Torvalds <[email protected]>"],
+            "section": "devel",
+            "architecture": "all"
+        },
+```
+
+Both plugins take an advantage of "details" section using it's data to fill in control file. Bellow you can find all control file attributes currently used.
+
+Control file attribute | Binding | Default value if not available
+-------------|-------------------|-----------------
+Package      | project.shortName | 'unknown'
+Version      | project.version | '0.0.1'
+Description  | project.details.description | ''
+Section      | project.details.section | 'unknown'
+Priority     | project.details.priority | 'optional'
+Architecture | project.details.architecture | 'all'
+Depends      | *Generated automatically* |
+Maintainer   | project.details.authors[0] | ''
+Uploaders    | project.details.authors[1..n] | ''
+
+Packages will be locater under **/tmp** directory.
+
+Everything is very experimental. Please send your notes or suggestions if any.

plugin-debian/build.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bob collect-sources repository:scan repository:copy-libs build

plugin-debian/recipe.bob

@@ -0,0 +1,34 @@
+{
+  "project" : {
+    "name" : "plugin-debian",
+    "shortName" : "plugin-debian",
+    "version" : "0.0.1",
+    "dependencies" : [
+      {
+        "dependency" : "glib",
+        "version" : "2.0"
+      },
+      {
+        "dependency" : "gobject",
+        "version" : "2.0"
+      },
+      {
+        "dependency" : "gee",
+        "version" : "0.8"
+      },
+      {
+        "dependency" : "bob",
+        "version" : "0.0.1"
+      },
+      {
+        "dependency" : "libvala",
+        "version": "0.28"
+      }
+      ]
+  },
+  "plugins": {
+    "build": {
+      "debug": true
+    }
+  }
+}