gloo 1.4.2 → 2.0.0

data/lib/gloo/core/event_manager.rb

@@ -0,0 +1,45 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# The Event Manager.
+# Run scripts in response to pre-defined events.
+#
+
+module Gloo
+  module Core
+    class EventManager
+
+      #
+      # Set up the event manager.
+      #
+      def initialize( engine )
+        @engine = engine
+        @engine.log.debug 'event manager intialized...'
+      end
+
+      #
+      # Run on_load scripts in the recently loaded object
+      # If no obj is given the script will be run in root.
+      #
+      def on_load( obj = nil, in_heap = false )
+        return unless obj || in_heap
+
+        @engine.log.debug 'on_load event'
+        arr = Gloo::Core::ObjFinder.by_name( @engine, 'on_load', obj )
+        arr.each { |o| Gloo::Exec::Dispatch.message( @engine, 'run', o ) }
+      end
+
+      #
+      # Run on_unload scripts in the object that will be unloaded.
+      #
+      def on_unload( obj )
+        return unless obj
+
+        @engine.log.debug 'on_unload event'
+        arr = Gloo::Core::ObjFinder.by_name( @engine, 'on_unload', obj )
+        arr.each { |o| Gloo::Exec::Dispatch.message( @engine, 'run', o ) }
+      end
+
+    end
+  end
+end

data/lib/gloo/core/factory.rb

@@ -0,0 +1,211 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An object factory.
+#
+
+module Gloo
+  module Core
+    class Factory < Baseo
+
+      # ---------------------------------------------------------------------
+      #    Initializer
+      # ---------------------------------------------------------------------
+
+      #
+      # Set up the object factory.
+      #
+      def initialize( engine )
+        @engine = engine
+        @engine.log.debug 'object factory intialized...'
+      end
+
+      # ---------------------------------------------------------------------
+      #    Factory Helpers
+      # ---------------------------------------------------------------------
+
+      #
+      # Helper shortcut to create an alias child object.
+      #
+      def create_alias( name, value, parent )
+        params = { :name => name,
+                   :type => 'alias',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a string child object.
+      #
+      def create_untyped( name, value, parent )
+        params = { :name => name,
+                   :type => 'untyped',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a string child object.
+      #
+      def create_string( name, value, parent )
+        params = { :name => name,
+                   :type => 'string',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a text child object.
+      #
+      def create_text( name, value, parent )
+        params = { :name => name,
+                   :type => 'text',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create an integer child object.
+      #
+      def create_int( name, value, parent )
+        params = { :name => name,
+                   :type => 'integer',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a boolean child object.
+      #
+      def create_bool( name, value, parent )
+        params = { :name => name,
+                   :type => 'boolean',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a container child object.
+      #
+      def create_can( name, parent )
+        params = { :name => name,
+                   :type => 'container',
+                   :value => nil,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a script child object.
+      #
+      def create_script( name, value, parent )
+        params = { :name => name,
+                   :type => 'script',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      #
+      # Helper shortcut to create a file child object.
+      #
+      def create_file( name, value, parent )
+        params = { :name => name,
+                   :type => 'file',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      # ---------------------------------------------------------------------
+      #    Object Factory
+      # ---------------------------------------------------------------------
+
+      # Create object with given name, type and value.
+      # One of either name or type is required.
+      # All values are optional when considered on their own.
+      # Parameter hash keys:
+      #  :name - the name of the object
+      #  :type - the name of the type
+      #  :value - the initial object value
+      #  :parent - the parent object
+      #  :squash_duplicates - if the object exists, use it rather
+      #                       than creating a new one?  Default = true
+      def create( params )
+        objtype = find_type params[ :type ]
+        return nil unless objtype
+
+        pn = Gloo::Core::Pn.new( @engine, params[ :name ] )
+        parent = params[ :parent ]
+        if parent.nil?
+          parent = pn.get_parent
+          obj_name = pn.name
+        else
+          obj_name = params[ :name ]
+        end
+
+        if pn.exists? && params[ :squash_duplicates ]
+          @engine.log.debug "Updating existing object: #{obj_name}"
+          return self.update_existing pn, params[ :value ]
+        end
+
+        @engine.log.debug "Creating new object: #{obj_name}"
+        return create_new obj_name, params[ :value ], objtype, parent
+      end
+
+      #
+      # Create a new object.
+      #
+      def create_new( name, value, type, parent )
+        unless parent
+          @engine.log.error "Could not create object.  Bad path: #{name}"
+          return nil
+        end
+
+        o = type.new( @engine )
+        o.name = name
+        o.set_value value
+        parent.add_child( o )
+        return o
+      end
+
+      #
+      # Find and Update an existing object.
+      #
+      def update_existing( pn, value )
+        o = pn.resolve
+        o.set_value value
+        return o
+      end
+
+      #
+      # Find the object type by name.
+      # Return nil if the object type cannot be found or
+      # cannot be created.
+      #
+      def find_type( type_name )
+        type_name = 'untyped' if type_name.nil? || type_name.strip.empty?
+        t = @engine.dictionary.find_obj( type_name )
+
+        if t.nil?
+          @engine.log.warn "Could not find type, '#{type_name}'"
+          return nil
+        end
+
+        unless t.can_create?
+          @engine.log.error "'#{type_name}' cannot be created."
+          return nil
+        end
+
+        return t
+      end
+
+    end
+  end
+end

data/lib/gloo/core/gloo_system.rb

@@ -0,0 +1,267 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# The System Object.
+# A virtual Object: the system object can be used to access
+# system level variables and functions.  But it is not
+# actually an object in the normal sense of the word.
+#
+require 'tty-platform'
+
+module Gloo
+  module Core
+    class GlooSystem < Obj
+
+      KEYWORD = 'gloo'.freeze
+      KEYWORD_SHORT = '$'.freeze
+
+      attr_reader :pn
+
+      # Set up the object.
+      def initialize( engine, pn )
+        @engine = engine
+        @pn = pn
+      end
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # The object type, suitable for display.
+      #
+      def type_display
+        return self.class.typename
+      end
+
+      # Is this the root object?
+      def root?
+        return false
+      end
+
+      # Can this object be created?
+      # This is true by default and only false for some special cases
+      # such as the System object.
+      def self.can_create?
+        false
+      end
+
+      # ---------------------------------------------------------------------
+      #    Value
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the parameter.
+      #
+      def param
+        return nil unless @pn && @pn.segments.count > 1
+
+        return @pn.segments[ 1..-1 ].join( '_' )
+      end
+
+      #
+      # Get the system value.
+      #
+      def value
+        return dispatch param
+      end
+
+      #
+      # There is no value object in the system.
+      #
+      def set_value( new_value )
+        # overriding base functionality with dummy function
+      end
+
+      #
+      # Get the value for display purposes.
+      #
+      def value_display
+        return value
+      end
+
+      #
+      # Is the value a String?
+      #
+      def value_string?
+        return true
+      end
+
+      #
+      # Is the value an Array?
+      #
+      def value_is_array?
+        return false
+      end
+
+      #
+      # Is the value a blank string?
+      #
+      def value_is_blank?
+        return true
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      def add_children_on_create?
+        return false
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return []
+      end
+
+      # Dispatch the message and get the value.
+      def dispatch( msg )
+        o = "msg_#{msg}"
+        return self.public_send( o ) if self.respond_to? o
+
+        @engine.log.error "Message #{msg} not implemented"
+        return false
+      end
+
+      # Get the system hostname.
+      def msg_hostname
+        return Socket.gethostname
+      end
+
+      # Get the logged in User.
+      def msg_user
+        return ENV[ 'USER' ]
+      end
+
+      # Get the user's home directory.
+      def msg_user_home
+        return File.expand_path( '~' )
+      end
+
+      # Get the working directory.
+      def msg_working_dir
+        return Dir.pwd
+      end
+
+      # Get the Gloo home directory
+      def msg_gloo_home
+        return @engine.settings.user_root
+      end
+
+      # Get the Gloo configuration directory
+      def msg_gloo_config
+        return @engine.settings.config_path
+      end
+
+      # Get the Gloo projects directory
+      def msg_gloo_projects
+        return @engine.settings.project_path
+      end
+
+      # Get the Gloo log directory
+      def msg_gloo_log
+        return @engine.settings.log_path
+      end
+
+      # ---------------------------------------------------------------------
+      #    Special chars
+      # ---------------------------------------------------------------------
+
+      # Carriage return (line feed)
+      def msg_line
+        return "\n"
+      end
+
+      # ---------------------------------------------------------------------
+      #    Screen Messages
+      # ---------------------------------------------------------------------
+
+      # Get the number of lines on screen.
+      def msg_screen_lines
+        return Gloo::App::Settings.lines( @engine )
+      end
+
+      # Get the number of columns on screen.
+      def msg_screen_cols
+        return Gloo::App::Settings.cols( @engine )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Platform Messages
+      # ---------------------------------------------------------------------
+
+      # Get the platform CPU
+      def msg_platform_cpu
+        platform = TTY::Platform.new
+        return platform.cpu
+      end
+
+      # Get the platform Operating System
+      def msg_platform_os
+        platform = TTY::Platform.new
+        return platform.os
+      end
+
+      # Get the platform version
+      def msg_platform_version
+        platform = TTY::Platform.new
+        return platform.version
+      end
+
+      # Is the platform Windows?
+      def msg_platform_windows?
+        platform = TTY::Platform.new
+        return platform.windows?
+      end
+
+      # Is the platform Unix?
+      def msg_platform_unix?
+        platform = TTY::Platform.new
+        return platform.unix?
+      end
+
+      # Is the platform Linux?
+      def msg_platform_linux?
+        platform = TTY::Platform.new
+        return platform.linux?
+      end
+
+      # Is the platform Mac?
+      def msg_platform_mac?
+        platform = TTY::Platform.new
+        return platform.mac?
+      end
+
+      #
+      # Get the command to open a file on this platform.
+      #
+      def self.open_for_platform
+        platform = TTY::Platform.new
+        return 'open' if platform.mac?
+        return 'xdg-open' if platform.linux?
+
+        return nil
+      end
+
+    end
+  end
+end

data/lib/gloo/core/heap.rb

@@ -0,0 +1,53 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# The Object Heap.
+# The collection of objects that are currently in play in
+# the running engine.
+#
+
+module Gloo
+  module Core
+    class Heap
+
+      # The context is a reference to an object, usually a container.
+      # The context will be the root by default.
+      attr_reader :context
+
+      attr_reader :it, :root, :error
+
+      #
+      # Set up the object heap.
+      #
+      def initialize( engine )
+        @engine = engine
+        @engine.log.debug 'object heap intialized...'
+
+        @root = Gloo::Objs::Container.new( @engine )
+        @root.name = 'root'
+
+        @context = Pn.root @engine
+        @it = It.new
+        @error = Error.new
+      end
+
+      #
+      # Unload the given obj--remove it from the heap.
+      #
+      def unload( obj )
+        can = obj.parent.nil? ? @root : obj.parent
+        return unless can
+
+        can.remove_child obj
+      end
+
+      #
+      # Is there one or more errors?
+      #
+      def error?
+        return @error.error_count.positive?
+      end
+
+    end
+  end
+end

data/lib/gloo/core/here.rb

@@ -0,0 +1,36 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Here helper class,
+# used to resolve relative referencing.
+#
+
+module Gloo
+  module Core
+    class Here
+
+      HERE = '^'.freeze
+
+      #
+      # Does the pathname start with here reference?
+      #
+      def self.includes_here_ref?( elements )
+        return elements.first.start_with?( HERE )
+      end
+
+      #
+      # Expand here reference if present.
+      #
+      def self.expand_here( engine, pn )
+        target = engine.exec_env.here_obj
+
+        here = pn.elements.first
+        remainder = pn.elements[ 1..-1 ].join( '.' )
+
+        here.length.times { target = target.parent }
+        pn.set_to "#{target.pn}.#{remainder}"
+      end
+
+    end
+  end
+end

data/lib/gloo/core/it.rb

@@ -0,0 +1,36 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# It is the value of the last command that was run.
+#
+
+module Gloo
+  module Core
+    class It
+
+      attr_accessor :value
+
+      #
+      # Set up the object.
+      #
+      def initialize
+        @value = nil
+      end
+
+      #
+      # Set the value of it.
+      #
+      def set_to( new_value )
+        @value = new_value
+      end
+
+      #
+      # Get the string representation of it.
+      #
+      def to_s
+        return @value.to_s
+      end
+
+    end
+  end
+end

data/lib/gloo/core/literal.rb

@@ -0,0 +1,30 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# A Literal value.
+# Base class for all literal values.
+#
+
+module Gloo
+  module Core
+    class Literal
+
+      attr_reader :value
+
+      #
+      # Create the expression from a list of tokens.
+      #
+      def initialize( value )
+        set_value( value )
+      end
+
+      #
+      # Set the literal value.
+      #
+      def set_value( value )
+        @value = value
+      end
+
+    end
+  end
+end