fhlow 1.91.0

data/lib/module_fhlow/fhlowexception.rb

@@ -0,0 +1,55 @@
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2007 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+
+
+
+module Fhlow
+
+    # FhlowException is derived from StandardError in order to extend it with an additional
+    # attribute _caller_.
+    class FhlowException < StandardError
+
+        # Holds information about the object or the program state that throws this exception.
+        attr_reader :caller
+
+        # Sets the attribute _caller_ and calls the constructor of StandardError.
+        # +_caller+:: Informations about the object or the program state that throws this exception.
+        # <tt>*_args</tt>:: An Array of arguments for the constructor of StandardError
+        def initialize (_caller, *_args)
+            super(_args)
+            @caller = _caller
+        end
+    end
+
+    # FhlowObjectNotFoundException is used as more specific exception by Node.
+    class FhlowObjectNotFoundException < FhlowException
+    end
+
+    # FhlowToolException is used as more specific exception for Plugins.
+    class FhlowPluginException < FhlowException
+    end
+    
+    # FhlowFileNotFoundException is used as more specific exception if a file was not found.
+    class FhlowFileNotFoundException < FhlowException
+    end
+end

data/lib/module_fhlow/leaf.rb

@@ -0,0 +1,197 @@
+
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2006 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+
+require 'fhlowexception'
+require 'config'
+
+module Fhlow
+
+    # Leaf's are fhlows major objects. They are created while parsing the directory
+    # structure as children of Node's. A Leaf holds informations about its dependencies
+    # which are also Leaf's. 
+    # Leaf is an _acstract_ class, so there have to be subclasses in order to create
+    # Leaf objects.
+    class Leaf
+            # The name of the Leaf
+            attr_reader :name
+
+            # The prefix of the Leaf.
+            attr_reader :prefix
+
+            # The configuration container.
+            attr_reader :conf
+
+        protected
+            # Initializes the class valiables and loads the config file.
+            # +_prefix+:: The prefix of the Leaf.
+            # +_name+:: The Name of the Leaf.
+            # +_parent+:: The reference to the parent.
+            # +_conf+:: The configuration information from higher levels.
+            # +_log+:: The reference to the Log object.
+            # +_pen+:: The reference to a Pen object.
+            def initialize(_prefix, _name, _parent, _log, _pen)
+                @name           = _name
+                @dependencies   = Hash.new     # a list of objects that leaf depends on
+                @parent         = _parent
+                @conf           = nil
+                @prefix         = _prefix
+                @log            = _log
+                @pen            = _pen
+
+                if File.exist?(@parent.getPath+@prefix+@name+"/config.flw") 
+                    @conf = Config::Config.new(@parent.getPath+@prefix+@name+"/config.flw") 
+                    # inherit the configurations from previous levels
+                    @conf.merge(@parent.conf)
+                    @log.debug(@prefix+@name, "Sucessfully merged inherited configs from #{@parent.prefix+@parent.name}.")
+                else
+                    raise FhlowException.new(@parent.getPath+@prefix+@name, "/config.flw not found.")
+                end
+
+                @log.info(@prefix+@name, "leaf initialized -> #{self}")
+            end
+        
+        public
+            # Collects the dependencies by building a list of object references using the 
+            # information from the configuration object.
+            # This function is invoked by the _parent_. See RootNode.initialize and Node.fetchDependencies for more
+            # information.
+            def fetchDependencies()
+
+                # there needs to be a [Dependencies] section the config file 
+                if @conf["Dependencies"].nil?
+                    raise FhlowException.new(getPath, "Couldn't find section [Dependencies] in any config.flw file responsible for this leaf.")
+                end
+
+                # iterate through all items of the [Dependencies] section
+                @conf["Dependencies"].each do |item|    # item -> one item of the [Dependencies] section
+                    fetchOneDependency(item)
+                end
+                
+                dummy = ""
+                @dependencies.each{ |deptype, leafs| dummy += "#{deptype} -> "; leafs.each { |leaf| dummy += "#{leaf.prefix}#{leaf.name} "}; dummy += "; " }
+                @log.debug(@prefix+@name, "direct dependencies: #{dummy}")
+                
+            end
+
+
+            # Each configuration item in the [Dependencies] section of the config file is passed to this function in order to
+            # request the coresponding Leaf from the _parent_. If __item_ is is of type Config::ComplexUnit architectures are
+            # also handled.
+            # +_item+:: One item from the section [Dependencies].
+            # == TODO
+            # in die konkreten leafs auslagern
+            def fetchOneDependency(_item)
+                if _item.instance_of?(Config::ComplexUnit)
+                    _item.value.each do |value|  
+                        begin
+                            leaf = @parent.getLeaf(value["deppath"], value["deppath"].length-1)
+                            raise FhlowException.new(@prefix+@name), "requested a Fhlow::Unit but got a #{leaf.class.to_s}!" unless leaf.instance_of?(Unit)
+                            leaf.addArchitectures(self, _item.name, value["archs"])
+                            raise FhlowException.new(@prefix+@name), "has itself as dependency!" if leaf == self
+                        rescue FhlowObjectNotFoundException => e
+                            # fetch the exception and add the name of this leaf so the errormessage is more accurate
+                            raise FhlowObjectNotFoundException.new(@prefix+@name), "#{e.caller}: #{e.message}"
+                        end
+        
+                        # init the container if it is nil
+                        @dependencies[_item.name] = Array.new if @dependencies[_item.name].nil?
+
+                        # save the object in the container if it does'nt exist
+                        @dependencies[_item.name].push(leaf) unless @dependencies[_item.name].include?(leaf)
+                    end
+                
+                elsif _item.instance_of?(Config::ComplexPackage)
+                    _item.value.each do |value|    
+                        begin
+                            leaf = @parent.getLeaf(value, value.length-1)
+                            raise FhlowException.new(@prefix+@name), "has itself as dependency!" if leaf == self
+                        rescue FhlowObjectNotFoundException => e
+                            # fetch the exception and add the name of this leaf so the errormessage is more accurate
+                            raise FhlowObjectNotFoundException.new(@prefix+@name), "#{e.caller}: #{e.message}"
+                        end
+        
+                        # init the container if it is nil
+                        @dependencies[_item.name] = Array.new if @dependencies[_item.name].nil?
+
+                        # save the object in the container if it does'nt exist
+                        @dependencies[_item.name].push(leaf) unless @dependencies[_item.name].include?(leaf)
+                    end
+                end
+            end
+
+
+
+=begin            def fetchOneDependency(_name, _value)
+                # this funktion needs to be implemented in an derived class!
+                raise FhlowException.new(self.class), "fetchOneDependency() is not implemented for "+self.class.to_s
+            end
+=end
+
+
+            # This function returns an Array of filenames in respect of the dependency tree and needs to be implemented 
+            # by subclasses.
+            # +_deptype+:: Type of the requested dependencies (could be Units, BhvUnits, Packages and so on)
+            # +_istoplevel+:: Is used to indicate the first entrance to this function.
+            # +_caller+:: Reference to the caller of the function. This is needed to request architectures.
+            # +_files+:: The Array of the files which will be filled with the requested filenames and returned in the end.
+            def getFiles(_deptype, _istoplevel=true, _caller=nil, _files=Array.new)
+                # this funktion needs to be implemented in an derived class!
+                raise FhlowException.new(self.class), "getFiles() is not implemented for "+self.class.to_s
+            end
+
+            # Returns the absolute path in the filesystem by requesting the path from the _parent_ and adding
+            # _prefix_ and _name_.
+            def getPath()
+                @parent.getPath+@prefix+@name+"/"
+            end
+        
+            # Prints information about this child.
+            # +_prefix+:: This prefix will be added to the output of ths function.
+            # +_depth+:: The depth of the recursion.
+            # +_caller+:: The reference to the caller.
+            # == TODO
+            # in die konkreten leafs auslagern
+            def printMe(_prefix="    ", _depth=0, _caller=nil)
+
+                if self.instance_of?(Unit)
+                    str = ""
+                    @pen.puts _prefix, @pen.magenta, @prefix, @name, @pen.clear, 
+                              @architectures[_depth==0 ? self : _caller].nil? ? 
+                                "\n" :  
+                                "(  "+(@architectures[_depth==0 ? self : _caller].each { |key, value| str += "#{@pen.blue}#{key}#{@pen.clear} -> #{value.join(", ")};  " }; str+=")")
+                else
+                    @pen.print _prefix, @pen.yellow, @prefix, @name, @pen.clear, "\n"
+                end
+                
+                @dependencies.each do |deptype, leafs| 
+                    leafs.each { |leaf| leaf.printMe(_prefix+"    ", _depth+1, self) } 
+                end if !@dependencies.empty?
+
+                @pen.print "\n" if _depth == 0
+
+            end
+
+    end
+
+end

data/lib/module_fhlow/leaf.rb~

@@ -0,0 +1,202 @@
+
+#----------------------------------------------------------------------------
+# 
+# Copyright (C) 2006 Simon Lasselsberger
+# simon.lasselsberger@fh-hagenberg.at
+#
+# This file is part of the _fhlow_ scripting environment.
+#
+# The _fhlow_ scripting environment is free software; you can redistribute 
+# it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# _fhlow_ 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with _fhlow_; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+#----------------------------------------------------------------------------
+
+require 'fhlowexception'
+require 'config'
+
+module Fhlow
+
+    # Leaf's are fhlows major objects. They are created while parsing the directory
+    # structure as children of Node's. A Leaf holds informations about its dependencies
+    # which are also Leaf's. 
+    # Leaf is an _acstract_ class, so there have to be subclasses in order to create
+    # Leaf objects.
+    class Leaf
+            # The name of the Leaf
+            attr_reader :name
+
+            # The prefix of the Leaf.
+            attr_reader :prefix
+
+            # The configuration container.
+            attr_reader :conf
+
+        protected
+            # Initializes the class valiables and loads the config file.
+            # +_prefix+:: The prefix of the Leaf.
+            # +_name+:: The Name of the Leaf.
+            # +_parent+:: The reference to the parent.
+            # +_conf+:: The configuration information from higher levels.
+            # +_log+:: The reference to the Log object.
+            # +_pen+:: The reference to a Pen object.
+            def initialize(_prefix, _name, _parent, _log, _pen)
+                @name           = _name
+                @dependencies   = Hash.new     # a list of objects that leaf depends on
+                @parent         = _parent
+                @conf           = nil
+                @prefix         = _prefix
+                @log            = _log
+                @pen            = _pen
+
+                if File.exist?(@parent.getPath+@prefix+@name+"/config.flw") 
+                    @conf = Config::Config.new(@parent.getPath+@prefix+@name+"/config.flw") 
+                    # inherit the configurations from previous levels
+                    @conf.merge(@parent.conf)
+                    @log.debug(@prefix+@name, "Sucessfully merged inherited configs from #{@parent.prefix+@parent.name}.")
+                else
+                    raise FhlowException.new(@parent.getPath+@prefix+@name, "/config.flw not found.")
+                end
+
+                @log.info(@prefix+@name, "leaf initialized -> #{self}")
+            end
+        
+        public
+            # Collects the dependencies by building a list of object references using the 
+            # information from the configuration object.
+            # This function is invoked by the _parent_. See RootNode.initialize and Node.fetchDependencies for more
+            # information.
+            def fetchDependencies()
+
+                # there needs to be a [Dependencies] section the config file 
+                if @conf["Dependencies"].nil?
+                    raise FhlowException.new(getPath, "Couldn't find section [Dependencies] in any config.flw file responsible for this leaf.")
+                end
+
+                # iterate through all items of the [Dependencies] section
+                @conf["Dependencies"].each do |item|    # item -> one item of the [Dependencies] section
+                    fetchOneDependency(item)
+                end
+                
+                dummy = ""
+                @dependencies.each{ |deptype, leafs| dummy += "#{deptype} -> "; leafs.each { |leaf| dummy += "#{leaf.prefix}#{leaf.name} "}; dummy += "; " }
+                @log.debug(@prefix+@name, "direct dependencies: #{dummy}")
+                
+            end
+
+
+            # Each configuration item in the [Dependencies] section of the config file is passed to this function in order to
+            # request the coresponding Leaf from the _parent_. If __item_ is is of type Config::ComplexUnit architectures are
+            # also handled.
+            # +_item+:: One item from the section [Dependencies].
+            # == TODO
+            # in die konkreten leafs auslagern
+            def fetchOneDependency(_item)
+                if _item.instance_of?(Config::ComplexUnit)
+                    _item.value.each do |value|  
+                        begin
+                            
+                            if @name == "Cpu"
+                                puts "here"
+                            end
+
+                            leaf = @parent.getLeaf(value["deppath"], value["deppath"].length+1)
+                            raise FhlowException.new(@prefix+@name), "requested a Fhlow::Unit but got a #{leaf.class.to_s}!" unless leaf.instance_of?(Unit)
+                            leaf.addArchitectures(self, _item.name, value["archs"])
+                            raise FhlowException.new(@prefix+@name), "has itself as dependency!" if leaf == self
+                        rescue FhlowObjectNotFoundException => e
+                            # fetch the exception and add the name of this leaf so the errormessage is more accurate
+                            raise FhlowObjectNotFoundException.new(@prefix+@name), "#{e.caller}: #{e.message}"
+                        end
+        
+                        # init the container if it is nil
+                        @dependencies[_item.name] = Array.new if @dependencies[_item.name].nil?
+
+                        # save the object in the container if it does'nt exist
+                        @dependencies[_item.name].push(leaf) unless @dependencies[_item.name].include?(leaf)
+                    end
+                
+                elsif _item.instance_of?(Config::ComplexPackage)
+                    _item.value.each do |value|    
+                        begin
+                            leaf = @parent.getLeaf(value, value.length+1)
+                            raise FhlowException.new(@prefix+@name), "has itself as dependency!" if leaf == self
+                        rescue FhlowObjectNotFoundException => e
+                            # fetch the exception and add the name of this leaf so the errormessage is more accurate
+                            raise FhlowObjectNotFoundException.new(@prefix+@name), "#{e.caller}: #{e.message}"
+                        end
+        
+                        # init the container if it is nil
+                        @dependencies[_item.name] = Array.new if @dependencies[_item.name].nil?
+
+                        # save the object in the container if it does'nt exist
+                        @dependencies[_item.name].push(leaf) unless @dependencies[_item.name].include?(leaf)
+                    end
+                end
+            end
+
+
+
+=begin            def fetchOneDependency(_name, _value)
+                # this funktion needs to be implemented in an derived class!
+                raise FhlowException.new(self.class), "fetchOneDependency() is not implemented for "+self.class.to_s
+            end
+=end
+
+
+            # This function returns an Array of filenames in respect of the dependency tree and needs to be implemented 
+            # by subclasses.
+            # +_deptype+:: Type of the requested dependencies (could be Units, BhvUnits, Packages and so on)
+            # +_istoplevel+:: Is used to indicate the first entrance to this function.
+            # +_caller+:: Reference to the caller of the function. This is needed to request architectures.
+            # +_files+:: The Array of the files which will be filled with the requested filenames and returned in the end.
+            def getFiles(_deptype, _istoplevel=true, _caller=nil, _files=Array.new)
+                # this funktion needs to be implemented in an derived class!
+                raise FhlowException.new(self.class), "getFiles() is not implemented for "+self.class.to_s
+            end
+
+            # Returns the absolute path in the filesystem by requesting the path from the _parent_ and adding
+            # _prefix_ and _name_.
+            def getPath()
+                @parent.getPath+@prefix+@name+"/"
+            end
+        
+            # Prints information about this child.
+            # +_prefix+:: This prefix will be added to the output of ths function.
+            # +_depth+:: The depth of the recursion.
+            # +_caller+:: The reference to the caller.
+            # == TODO
+            # in die konkreten leafs auslagern
+            def printMe(_prefix="    ", _depth=0, _caller=nil)
+
+                if self.instance_of?(Unit)
+                    str = ""
+                    @pen.puts _prefix, @pen.magenta, @prefix, @name, @pen.clear, 
+                              @architectures[_depth==0 ? self : _caller].nil? ? 
+                                "\n" :  
+                                "(  "+(@architectures[_depth==0 ? self : _caller].each { |key, value| str += "#{@pen.blue}#{key}#{@pen.clear} -> #{value.join(", ")};  " }; str+=")")
+                else
+                    @pen.print _prefix, @pen.yellow, @prefix, @name, @pen.clear, "\n"
+                end
+                
+                @dependencies.each do |deptype, leafs| 
+                    leafs.each { |leaf| leaf.printMe(_prefix+"    ", _depth+1, self) } 
+                end if !@dependencies.empty?
+
+                @pen.print "\n" if _depth == 0
+
+            end
+
+    end
+
+end