Exec.lua

--------------------------------------------------------------------------
-- This class holds a array of strings. These are commands that
-- the module file  can execute after all the environment variables
-- have been reported.
-- @classmod Exec
require("strict")

--------------------------------------------------------------------------
-- Lmod License
--------------------------------------------------------------------------
--
--  Lmod is licensed under the terms of the MIT license reproduced below.
--  This means that Lmod is free software and can be used for both academic
--  and commercial purposes at absolutely no cost.
--
--  ----------------------------------------------------------------------
--
--  Copyright (C) 2008-2018 Robert McLay
--
--  Permission is hereby granted, free of charge, to any person obtaining
--  a copy of this software and associated documentation files (the
--  "Software"), to deal in the Software without restriction, including
--  without limitation the rights to use, copy, modify, merge, publish,
--  distribute, sublicense, and/or sell copies of the Software, and to
--  permit persons to whom the Software is furnished to do so, subject
--  to the following conditions:
--
--  The above copyright notice and this permission notice shall be
--  included in all copies or substantial portions of the Software.
--
--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
--  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
--  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
--  NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
--  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
--  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
--  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
--  THE SOFTWARE.
--
--------------------------------------------------------------------------


require("utils")
local dbg  = require("Dbg"):dbg()
local M    = {}

s_exec = false

local function l_new(self)
   local o = {}
   o.a     = {}

   setmetatable(o,self)
   self.__index = self
   return o
end

--------------------------------------------------------------------------
-- The Exec Singleton Ctor.
-- @param self A Exec object
-- @return a Exec Singleton object.
function M.exec(self)
   if (not s_exec) then
      dbg.start{"Exec:exec()"}
      s_exec = l_new(self)
      dbg.fini("Exec:exec")
   end
   return s_exec
end

--------------------------------------------------------------------------
-- Register the command strings.
-- @param self A Exec object
function M.register(self, ...)
   local argA = pack(...)
   local a    = self.a

   for i = 1, argA.n do
      if (argA[i]) then
         a[#a+1] = argA[i]
      end
   end
end

--------------------------------------------------------------------------
-- Send the registered commands to stdout so that they can be evaluated
-- by the module command.
-- @param self A Exec object
function M.expand(self)
   local a = self.a

   for i = 1,#a do
      local v = a[i]:gsub(";%s*$","")
      io.stdout:write(v,";\n")
   end
end


return M