From 6d2d1a5bb195f94fd0c8e88a1dcd5b350a034959 Mon Sep 17 00:00:00 2001
From: Gordon Hecker <gh@emlix.com>
Date: Wed, 10 Mar 2010 18:56:34 +0100
Subject: [PATCH] plugin interface: extensions  * permit plugins to register
 commandline options  * permit tool specific initialization of plugins

Signed-off-by: Gordon Hecker <gh@emlix.com>
---
 Changelog               |  2 ++
 local/build-numbers.lua |  6 +++++-
 local/build.lua         |  6 +++++-
 local/cf.lua            |  6 +++++-
 local/dlist.lua         |  6 +++++-
 local/dsort.lua         |  6 +++++-
 local/e2build.lua       | 31 ++++++++++++++++++++++++++++++-
 local/e2tool.lua        | 21 ++++++++++++++++++---
 local/fetch-sources.lua |  6 +++++-
 local/ls-project.lua    |  6 +++++-
 local/new-source.lua    |  6 +++++-
 local/playground.lua    |  6 +++++-
 12 files changed, 95 insertions(+), 13 deletions(-)

diff --git a/Changelog b/Changelog
index 2b6d3e0..73aa093 100644
--- a/Changelog
+++ b/Changelog
@@ -1,4 +1,6 @@
 NEXT:
+ * the plugin interface was extended to permit plugins to register
+   commandline options and permit tool specific initialization of plugins
  * a serious bug in the hashcache was fixed. The buildid calculation
    used outdated hash of files from the project tree.
  * the username is included in the chroot environment path again
diff --git a/local/build-numbers.lua b/local/build-numbers.lua
index 36b07cc..944b744 100755
--- a/local/build-numbers.lua
+++ b/local/build-numbers.lua
@@ -30,6 +30,10 @@
 require("e2local")
 require("e2tool")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "build-numbers")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage:
@@ -45,7 +49,7 @@ local build_mode = policy.handle_commandline_options(opts, true)
 if not build_mode then
 	e2lib.abort("no build mode given")
 end
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/build.lua b/local/build.lua
index 6f41cc9..1eb1e89 100755
--- a/local/build.lua
+++ b/local/build.lua
@@ -31,6 +31,10 @@ require("e2local")
 require("e2tool")
 require("e2build")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "build")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-build [<option> | <result> ...]
@@ -56,7 +60,7 @@ if not build_mode then
 	e2lib.abort("no build mode given")
 end
 
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/cf.lua b/local/cf.lua
index 04bacfa..1fbefc9 100755
--- a/local/cf.lua
+++ b/local/cf.lua
@@ -30,6 +30,10 @@
 require("e2local")
 require("e2tool")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "cf")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2 cf <command> ...
@@ -54,7 +58,7 @@ local opts = e2option.parse(arg)
 
 -- initialize some basics in the info structure without actually loading
 -- the project configuration.
-local info, re = e2tool.collect_project_info(nil, true)
+info, re = e2tool.collect_project_info(info, true)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/dlist.lua b/local/dlist.lua
index 431b064..8f19919 100755
--- a/local/dlist.lua
+++ b/local/dlist.lua
@@ -31,6 +31,10 @@ require("e2local")
 require("e2tool")
 require("e2build")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "dlist")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-dlist [<option> | <result> ...]
@@ -46,7 +50,7 @@ if #opts.arguments == 0 then
 elseif #opts.arguments ~= 1 then e2option.usage(1) end
 
 local result = opts.arguments[1]
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/dsort.lua b/local/dsort.lua
index 4dc7eac..1bb4d5b 100755
--- a/local/dsort.lua
+++ b/local/dsort.lua
@@ -31,6 +31,10 @@ require("e2local")
 require("e2tool")
 require("e2build")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "dsort")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-dsort
@@ -40,7 +44,7 @@ lists all results sorted by dependency
 
 e2option.parse(arg)
 
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/e2build.lua b/local/e2build.lua
index 979858d..d00266c 100644
--- a/local/e2build.lua
+++ b/local/e2build.lua
@@ -803,7 +803,7 @@ end
 -- @param results table: list of results, sorted by dependencies
 -- @return bool
 -- @return an error object on failure
-function build_results(info, results)
+function build_results_default(info, results)
   e2lib.logf(3, "building results")
   for _, r in ipairs(results) do
     local e = new_error("building result failed: %s", r)
@@ -824,6 +824,35 @@ function build_results(info, results)
   return true, nil
 end
 
+function build_results(info, results)
+  for i,f in ipairs(build_results_ftab) do
+    rc, re = f(info, results)
+    if not rc then
+      return rc, re
+    end
+  end
+  return true, nil
+end
+
+build_results_ftab = {
+	build_results_default,
+}
+
+function register_build_results(func, position, post)
+  for i,f in ipairs(build_results_ftab) do
+    if f == position then
+      if post then
+        table.insert(build_results_ftab, i + 1 ,func)
+	return true, nil
+      else
+	table.insert(build_results_ftab, i, func)
+	return true, nil
+      end
+    end
+  end
+  return false, new_error("registering build_results function failed")
+end
+
 --- build a result
 -- @param info
 -- @param result string: result name
diff --git a/local/e2tool.lua b/local/e2tool.lua
index e28b413..5f413e3 100644
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -376,12 +376,20 @@ function load_user_config2(info, path, types)
   return list, nil
 end
 
-function collect_project_info(path, skip_load_config)
+--- initialize the local library, load and initialize local plugins
+-- @param path string: path to project tree
+-- @param tool string: tool name (without the 'e2-' prefix)
+-- @return table: the info table, or false on failure
+-- @return an error object on failure
+function local_init(path, tool)
   local rc, re
-  local e = new_error("reading project configuration")
-
+  local e = new_error("initializing")
   local info = {}
 
+  -- provide the current tool name to allow conditionals in plugin
+  -- initialization
+  info.current_tool = tool
+
   -- set the umask value to be used in chroot
   info.chroot_umask = 18   -- 0022 octal
   init_umask(info)
@@ -426,6 +434,13 @@ function collect_project_info(path, skip_load_config)
     return false, e:cat(re)
   end
 
+  return info
+end
+
+function collect_project_info(info, skip_load_config)
+  local rc, re
+  local e = new_error("reading project configuration")
+
   -- check for configuration compatibility
   info.config_syntax_compat = buildconfig.SYNTAX
   info.config_syntax_file = ".e2/syntax"
diff --git a/local/fetch-sources.lua b/local/fetch-sources.lua
index e4e83fa..f2ba774 100755
--- a/local/fetch-sources.lua
+++ b/local/fetch-sources.lua
@@ -31,6 +31,10 @@ require("e2local")
 require("e2tool")
 require("e2build")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "fetch-sources")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-fetch-sources <source> ...
@@ -67,7 +71,7 @@ e2option.flag("source", "select sources by source names (default)")
 e2option.flag("result", "select sources by result names")
 
 local opts = e2option.parse(arg)
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/ls-project.lua b/local/ls-project.lua
index 3e639c5..6a1bca2 100755
--- a/local/ls-project.lua
+++ b/local/ls-project.lua
@@ -30,6 +30,10 @@
 require("e2local")
 require("e2tool")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "ls-project")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-ls-project [<result> ...]
@@ -45,7 +49,7 @@ e2option.flag("all", "show unused results and sources, too")
 
 local opts = e2option.parse(arg)
 
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/new-source.lua b/local/new-source.lua
index c962285..12db7e7 100644
--- a/local/new-source.lua
+++ b/local/new-source.lua
@@ -31,6 +31,10 @@
 require("e2local")
 require("e2tool")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "new-source")
+if not info then
+  e2lib.abort(re)
+end
 
 e2option.documentation = [[
 usage: e2-new-source --git [--server <server>] <name>
@@ -238,7 +242,7 @@ function new_files_source(c, server, location, source_file, checksum_file,
 	return true, nil
 end
 
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
diff --git a/local/playground.lua b/local/playground.lua
index 8a43a11..51c274c 100644
--- a/local/playground.lua
+++ b/local/playground.lua
@@ -31,6 +31,10 @@ require("e2local")
 require("e2tool")
 require("e2build")
 e2lib.init()
+local info, re = e2tool.local_init(nil, "playground")
+if not info then
+  e2lib.abort(re)
+end
 
 local e = new_error("entering playground failed")
 local rc, re
@@ -50,7 +54,7 @@ local build_mode = policy.handle_commandline_options(opts, true)
 if not build_mode then
 	e2lib.abort("no build mode given")
 end
-local info, re = e2tool.collect_project_info()
+info, re = e2tool.collect_project_info(info)
 if not info then
   e2lib.abort(re)
 end
-- 
2.39.5