topherfangio-lcdproc-ruby 0.1.1

data/lib/lcdproc/widget.rb

@@ -0,0 +1,142 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  # *NOTE*: You may only have one (1) type of the following per screen: hbar, vbar or num. They currently conflict
+  # with each other and will not draw properly. You *MAY* have as many of each type per screen as you like. For
+  # instance, you *MAY* have twenty (20) vertical bars per screen or four (4) horizontal bars on a screen, but
+  # you cannot mix and match!
+  
+  module Widget
+    attr_reader :id, :screen, :type, :visible
+    @supported_types = {}
+    
+    # Finds the first widget that is of type _type_ and returns a new instance of it.
+    #
+    # * <tt>type</tt> - A symbol representing the type of widget you wish to create.
+    # * <tt>id</tt> - A unique string by which you can indentify the widget. Defaults to the widget type +
+    # "Widget_" + a sequence number
+    #
+    # Example:
+    #
+    #   w = Widget.new( :string, 'Test' )
+    def Widget.new( type = :string, id = nil  )
+      if @supported_types.include? type
+        @supported_types[ type ].new( id )
+      else
+        return nil
+      end
+    end
+    
+    # Returns an array of symbols listing the supported types of widgets.
+    def Widget.supported_types
+      @supported_types.keys
+    end
+    
+    # Allows a particular type of widget to inform the Widget module (which is a Widget factory) that it is
+    # able to support a particular type of widget.
+    def Widget.add_support( type, widget_class )
+      @supported_types[type] = widget_class
+    end
+    
+    # Allows a widget to be attached to a screen.
+    def attach_to( screen )
+      @screen = screen
+      
+      return true
+    end
+    
+    # Allows a widget to be dettached from a screen.
+    def detach
+      attach_to nil
+    end
+    
+    
+    # Sends the command to the LCDd server to remove the widget from the screen unless you
+    # pass false, in which case it does everything but send the command
+    def hide( send_command = true )
+      
+      if not send_command
+        @visible = false
+        @screen.client.add_message( "Widget '#{@id}' is now hidden" )
+        return true
+      end
+      
+      # Only if we are visible, attempt to hide ourselves
+      if @visible
+        response = @screen.client.send_command( Command.new( "widget_del #{@screen.id} #{self.id}" ) )
+        
+        if response.successful?
+          @visible = false
+          @screen.client.add_message( "Widget '#{@id}' is now hidden" )
+          return true
+        else
+          @visible = true
+          @screen.client.add_message( "Error: Widget '#{@id}' could NOT be hidden (#{response.message})" )
+          return false
+        end
+      else
+        return true
+      end
+      
+    end
+    
+    # Sends the command to the LCDd server to show the widget on the screen unless you
+    # pass false, in which case it does everything but send the command
+    def show( send_command = true )
+      
+      if not send_command
+        @visible = true
+        @screen.client.add_message( "Widget '#{@id}' is now visible" )
+        return true
+      end
+      
+      # If we aren't already visible, attempt to make oursevles visible
+      if not @visible
+        response = @screen.client.send_command( Command.new( "widget_add #{@screen.id} #{self.id} #{@type.to_s}" ) )
+        
+        if response.successful?
+          @visible = true
+          @screen.client.add_message( "Widget '#{@id}' is now visible" )
+          
+          self.update
+          
+          return true
+        else
+          @visible = false
+          @screen.client.add_message( "Error: Widget '#{@id}' could NOT be displayed (#{response.message})" )
+          return false
+        end
+      else
+        return true
+      end
+    end
+    
+    
+  end
+  
+end

data/lib/lcdproc/widgets/graph.rb

@@ -0,0 +1,185 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module Widgets
+    
+    class Graph
+      include LCDProc::Widget
+      LCDProc::Widget.add_support( :graph, self )
+      
+      attr_accessor :bars, :x, :y
+      
+      # Note that the lenght is not changeable after you have added a graph.
+      attr_reader :length
+      
+      @@widget_count = 0
+      
+      
+      # Creates a new Graph widget which can then be displayed anywhere on the screen.
+      #
+      # * <tt>id</tt> - A unique string which identifies this widget. Defaults to "GraphWidget_" + a sequence number.
+      # * <tt>col</tt> - The beginning column in which you wish to display the graph on screen. Defaults to 1.
+      # * <tt>row</tt> - The beginning row in which you wish to display the text on screen. Defaults to 1.
+      # * <tt>length</tt> - The length of the graph (how many vertical bars to show). Defaults to 21 - x for a 20x4 screen.
+      #
+      # Example:
+      #
+      #   w = Graph.new
+      #
+      # or
+      #
+      #   w = Graph.new( 'Test', 'This is a graph', 1, 5, 10 )
+      #
+      # *NOTE*: The length of the graph is not changeable after it has been created
+      def initialize( id = "GraphWidget_" + @@widget_count.to_s, col = 1, row = 1, length = 21 - col)
+        if id.nil?
+          id = "GraphWidget_#{@@widget_count}"
+        end
+        
+        @id = id
+        @type = :graph
+        @screen = nil
+        @visible = false
+        
+        @x = col
+        @y = row
+        @length = length
+        
+        @bars = []
+        @length.times{ |i| @bars << VBar.new( "#{self.id}_Bar_#{i}", 1, @x + i, @y ) }
+        
+        @@widget_count += 1
+      end
+      
+      
+      # Actually sends the command to the LCDd server to remove the widget from the screen
+      def hide
+        
+        # Only if we are visible, attempt to hide ourselves
+        if @visible
+          passed = true
+          
+          @bars.each do |bar|
+            
+            # If at any point we fail, bail out and return false
+            if not bar.hide or not bar.detach
+              passed = false
+              break
+            end
+            
+          end
+          
+          if passed
+            @visible = false
+            @screen.client.add_message( "Widget '#{@id}' is now hidden" )
+            return true
+          else
+            @visible = true
+            @screen.client.add_message( "Error: Widget '#{@id}' could NOT be hidden (#{response.message})" )
+            return false
+          end
+        else
+          return true
+        end
+        
+      end
+      
+      
+      # Actually sends the command to the LCDd server to add the widget to the screen
+      def show
+        
+        # If we aren't already visible, attempt to make oursevles visible
+        if not @visible
+          commands = []
+          passed = true
+          
+          @bars.each do |bar|
+            
+            # If at any point we fail, bail out and return false
+            if not bar.attach_to( @screen ) or not bar.show( false )
+              passed = false
+              break
+            end
+            
+          end
+          
+          @bars.each do |bar|
+            commands << "widget_add #{@screen.id} #{bar.id} #{bar.type.to_s}"
+          end
+          
+          response = @screen.client.send_command( Command.new( commands ) )
+          
+          if response.successful? and passed
+            @visible = true
+            @screen.client.add_message( "Widget '#{@id}' is now visible" )
+            
+            self.update
+            
+            return true
+          else
+            @visible = false
+            @screen.client.add_message( "Error: Widget '#{@id}' could NOT be displayed (#{response.message})" )
+            return false
+          end
+        else
+          return true
+        end
+        
+      end
+      
+      
+      # Sends to command to the LCDd server to update the widget on screen
+      def update
+        
+        if @screen
+          commands = []
+          
+          @bars.each do |bar|
+            commands << "widget_set #{@screen.id} #{bar.id} #{bar.x} #{bar.y} #{bar.height}"
+          end
+          
+          response = @screen.client.send_command( Command.new( commands ) )
+          
+          if response.successful?
+            @screen.client.add_message( "Widget '#{@id}' was successfully updated" )
+            return true
+          else
+            @screen.client.add_message( "Error: Widget '#{@id}' was NOT successfully updated (#{response.message})" )
+            return true
+          end
+        else
+          @screen.client.add_message( "Error: Cannot update Widget '#{@id}' until it is attached to a screen" )
+          return false
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/lcdproc/widgets/hbar.rb

@@ -0,0 +1,101 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module Widgets
+    
+    class HBar
+      include LCDProc::Widget
+      LCDProc::Widget.add_support( :hbar, self )
+      
+      attr_accessor :x, :y, :length
+      
+      @@widget_count = 0
+      
+      
+      # Creates a new HBar widget which can then be displayed anywhere on the screen.
+      #
+      # * <tt>:id</tt> - A unique string which identifies this widget. Defaults to "HBarWidget_" + a sequence number.
+      # * <tt>:bar_length</tt> - The length of the bar. Default to 120 (fills a 20x4 character screen).
+      # * <tt>:row</tt> - The row in which the bar should be positioned. Defaults to 1.
+      # * <tt>:col</tt> - The column in which the bar should be positioned. Defaults to 1.
+      #
+      # Example:
+      #
+      #   w = HBar.new
+      #
+      # or
+      #
+      #   w = HBar.new( 'TestBar', 15, 1, 5 )
+      def initialize( id = "HBarWidget_#{@@widget_count}", bar_length = 120, row = 1, col = 1 )
+        if id.nil?
+          id = "HBarWidget_#{@@widget_count}"
+        end
+        
+        @id = id
+        @type = :hbar
+        @screen = nil
+        @visible = false
+        
+        @length = bar_length
+        @x = row
+        @y = col
+        
+        @@widget_count += 1
+      end
+      
+      
+      # Sends to command to the LCDd server to update the widget on screen
+      def update
+        if @screen
+          
+          bar_length = @length
+          
+          if @length < 1
+            bar_length = @length * 120
+          end
+          
+          response = @screen.client.send_command( Command.new( "widget_set #{@screen.id} #{self.id} #{@x} #{@y} \"#{bar_length}\"" ) )
+          
+          if response.successful?
+            @screen.client.add_message( "Widget '#{@id}' was successfully updated" )
+            return true
+          else
+            @screen.client.add_message( "Error: Widget '#{@id}' was NOT successfully updated (#{response.message})" )
+            return true
+          end
+        else
+          @screen.client.add_message( "Error: Cannot update Widget '#{@id}' until it is attached to a screen" )
+          return false
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/lcdproc/widgets/icon.rb

@@ -0,0 +1,94 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module Widgets
+    
+    class Icon
+      include LCDProc::Widget
+      LCDProc::Widget.add_support( :icon, self )
+      
+      attr_accessor :x, :y, :name
+      
+      @@widget_count = 0
+      
+      
+      # Creates a new Icon widget which can then be displayed anywhere on the screen.
+      #
+      # * <tt>:id</tt> - A unique string which identifies this widget. Defaults to "IconWidget_" + a sequence number.
+      # * <tt>:icon_name</tt> - The name of the icon that you wish to display on the screen. Default to "".
+      # * <tt>:col</tt> - The column in which you wish to display the text on screen. Defaults to 1.
+      # * <tt>:row</tt> - The row in which you wish to display the text on screen. Defaults to 1.
+      #
+      # Example:
+      #
+      #   w = Icon.new
+      #
+      # or
+      #
+      #   w = Icon.new( 'Test', 'This is a icon', 1, 5 )
+      def initialize( id = "IconWidget_#{@@widget_count}", icon_name = "", col = 1, row = 1 )
+        if id.nil?
+          id = "IconWidget_#{@@widget_count}"
+        end
+        
+        @id = id
+        @type = :icon
+        @screen = nil
+        @visible = false
+        
+        @name = icon_name
+        @x = col
+        @y = row
+        
+        @@widget_count += 1
+      end
+      
+      
+      # Sends to command to the LCDd server to update the widget on screen
+      def update
+        if @screen
+          response = @screen.client.send_command( Command.new( "widget_set #{@screen.id} #{self.id} #{@x} #{@y} \"#{@text}\"" ) )
+          
+          if response.successful?
+            @screen.client.add_message( "Widget '#{@id}' was successfully updated" )
+            return true
+          else
+            @screen.client.add_message( "Error: Widget '#{@id}' was NOT successfully updated (#{response.message})" )
+            return true
+          end
+        else
+          @screen.client.add_message( "Error: Cannot update Widget '#{@id}' until it is attached to a screen" )
+          return false
+        end
+      end
+      
+    end
+    
+  end
+  
+end