cosmos 3.5.1 → 3.5.2

data/lib/cosmos/ccsds/ccsds_packet.rb

@@ -1,63 +1,63 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'cosmos/packets/packet'
-
-module Cosmos
-
-  # Packet which defines the required CCSDS items which include Version, Type,
-  # Secondary Header Flag, APID, Sequence Flags, Sequence Count and Length. It
-  # will optionally include a data item which will contain the rest of the
-  # CCSDS packet data. This is optional to make it easier to subclass this
-  # packet and add secondary header fields.
-  class CcsdsPacket < Packet
-
-    # CCSDS telemetry type
-    TELEMETRY = 0
-    # CCSDS telecommand type
-    COMMAND = 1
-
-    # CCSDS sequence flag indicating continuation packet
-    MIDDLE = 0
-    # CCSDS sequence flag indicating continuation packet
-    CONTINUATION = 0
-    # CCSDS sequence flag indicating the first packet
-    FIRST = 1
-    # CCSDS sequence flag indicating the last packet
-    LAST = 2
-    # CCSDS sequence flag indicating a stand alone packet
-    STANDALONE = 3
-
-    # Length Field Offset to number of bytes in entire packet
-    LENGTH_FIELD_OFFSET = 7
-
-    # Creates a CCSDS packet by setting the target and packet name and then
-    # defining all the fields in a CCSDS packet with a primary header. If a
-    # secondary header is desired, define a secondary header field and then
-    # override the CcsdsData field to start after bit offset 48.
-    #
-    # @param target_name [String] The target name
-    # @param packet_name [String] The packet name
-    def initialize(target_name = nil, packet_name = nil, include_ccsds_data = true)
-      super(target_name, packet_name, :BIG_ENDIAN)
-      define_item('CcsdsVersion', 0, 3, :UINT)
-      define_item('CcsdsType', 3, 1, :UINT)
-      define_item('CcsdsShf', 4, 1, :UINT)
-      define_item('CcsdsApid', 5, 11, :UINT)
-      define_item('CcsdsSeqflags', 16, 2, :UINT)
-      item = define_item('CcsdsSeqcnt', 18, 14, :UINT)
-      item.overflow = :TRUNCATE
-      define_item('CcsdsLength', 32, 16, :UINT)
-      define_item('CcsdsData', 48, 0, :BLOCK) if include_ccsds_data
-    end
-
-  end
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/packets/packet'
+
+module Cosmos
+
+  # Packet which defines the required CCSDS items which include Version, Type,
+  # Secondary Header Flag, APID, Sequence Flags, Sequence Count and Length. It
+  # will optionally include a data item which will contain the rest of the
+  # CCSDS packet data. This is optional to make it easier to subclass this
+  # packet and add secondary header fields.
+  class CcsdsPacket < Packet
+
+    # CCSDS telemetry type
+    TELEMETRY = 0
+    # CCSDS telecommand type
+    COMMAND = 1
+
+    # CCSDS sequence flag indicating continuation packet
+    MIDDLE = 0
+    # CCSDS sequence flag indicating continuation packet
+    CONTINUATION = 0
+    # CCSDS sequence flag indicating the first packet
+    FIRST = 1
+    # CCSDS sequence flag indicating the last packet
+    LAST = 2
+    # CCSDS sequence flag indicating a stand alone packet
+    STANDALONE = 3
+
+    # Length Field Offset to number of bytes in entire packet
+    LENGTH_FIELD_OFFSET = 7
+
+    # Creates a CCSDS packet by setting the target and packet name and then
+    # defining all the fields in a CCSDS packet with a primary header. If a
+    # secondary header is desired, define a secondary header field and then
+    # override the CcsdsData field to start after bit offset 48.
+    #
+    # @param target_name [String] The target name
+    # @param packet_name [String] The packet name
+    def initialize(target_name = nil, packet_name = nil, include_ccsds_data = true)
+      super(target_name, packet_name, :BIG_ENDIAN)
+      define_item('CcsdsVersion', 0, 3, :UINT)
+      define_item('CcsdsType', 3, 1, :UINT)
+      define_item('CcsdsShf', 4, 1, :UINT)
+      define_item('CcsdsApid', 5, 11, :UINT)
+      define_item('CcsdsSeqflags', 16, 2, :UINT)
+      item = define_item('CcsdsSeqcnt', 18, 14, :UINT)
+      item.overflow = :TRUNCATE
+      define_item('CcsdsLength', 32, 16, :UINT)
+      define_item('CcsdsData', 48, 0, :BLOCK) if include_ccsds_data
+    end
+
+  end
+
+end # module Cosmos

data/lib/cosmos/ccsds/ccsds_parser.rb

@@ -1,143 +1,143 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'cosmos'
-require 'cosmos/ccsds/ccsds_packet'
-
-module Cosmos
-
-  # Unsegments CCSDS packets and perform other CCSDS processing tasks.
-  class CcsdsParser
-
-    # @return [Symbol] Indicates if the parser is :READY to start a new series
-    #   of packets or is :IN_PROGRESS
-    attr_reader :state
-
-    # @return [String] Binary data that has been collected so far towards the
-    #   completely unsegmented packet. Note: This value is cleared once the
-    #   entire packet is formed and also cleared due to errors.
-    attr_reader :in_progress_data
-
-    # @return [String] The most recent successfully unsegmented packet's data
-    attr_reader :unsegmented_data
-
-    # @return [Integer] Sequence count of the previously received packet
-    attr_reader :sequence_count
-
-    # Create a new {CcsdsPacket} and set the state to :READY
-    def initialize
-      @ccsds_packet = CcsdsPacket.new
-      @unsegmented_data = nil
-      @sequence_count = nil
-      reset()
-    end
-
-    # Resets internal state to :READY and clears the in_progress_data
-    def reset
-      @state = :READY
-      @in_progress_data = ''
-    end
-
-    # Given a segment of a larger CCSDS packet, stores the data until a complete
-    # unsegmented packet can be created.  Returns the unsegmented packet data
-    # once it is complete, or nil if still in progress. Raises
-    # CcsdsParser::CcsdsSegmentationError if a problem is encountered while
-    # unsegmenting.
-    #
-    # @param packet [Packet] A CCSDS packet
-    # @return [String|nil] The reconstituted CCSDS packet buffer or nil if the
-    #   packet has not yet been fully assembled
-    def unsegment_packet(packet)
-      @ccsds_packet.buffer = packet.buffer
-
-      previous_sequence_count = @sequence_count
-      @sequence_count = @ccsds_packet.read('CcsdsSeqcnt')
-
-      # Handle each segment
-      case @ccsds_packet.read('CcsdsSeqflags')
-      when CcsdsPacket::CONTINUATION
-        #####################################################
-        # Continuation packet - only process if in progress
-        #####################################################
-
-        if @state == :IN_PROGRESS
-          if @sequence_count == ((previous_sequence_count + 1) % 16384)
-            @in_progress_data << @ccsds_packet.read('CcsdsData')
-            return nil
-          else
-            reset()
-            raise CcsdsSegmentationError, "Missing packet(s) before continuation packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
-          end
-        else
-          reset()
-          raise CcsdsSegmentationError, "Unexpected continuation packet"
-        end
-
-      when CcsdsPacket::FIRST
-        #######################################################
-        # First packet - always process
-        #######################################################
-
-        if @state == :IN_PROGRESS
-          reset()
-          @state = :IN_PROGRESS
-          @in_progress_data << @ccsds_packet.buffer
-          raise CcsdsSegmentationError, "Unexpected first packet"
-        else
-          @state = :IN_PROGRESS
-          @in_progress_data << @ccsds_packet.buffer
-          return nil
-        end
-
-      when CcsdsPacket::LAST
-        ######################################################################
-        # Last packet - only process if in progress
-        ######################################################################
-
-        if @state == :IN_PROGRESS
-          if @sequence_count == ((previous_sequence_count + 1) % 16384)
-            @in_progress_data << @ccsds_packet.read('CcsdsData')
-            @unsegmented_data = @in_progress_data
-            reset()
-            return @unsegmented_data
-          else
-            reset()
-            raise CcsdsSegmentationError, "Missing packet(s) before last packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
-          end
-        else
-          reset()
-          raise CcsdsSegmentationError, "Unexpected last packet"
-        end
-
-      when CcsdsPacket::STANDALONE
-        ############################################################
-        # Standalone packet - save and return its data
-        ############################################################
-
-        # Update most recent unsegmented data
-        @unsegmented_data = @ccsds_packet.buffer
-
-        if @state == :IN_PROGRESS
-          reset()
-          raise CcsdsSegmentationError, "Unexpected standalone packet"
-        else
-          reset()
-          return @unsegmented_data
-        end
-
-      end # case raw_sequence_flags
-    end
-
-    # Class to indicate errors that occur during the unsegmenting process
-    class CcsdsSegmentationError < StandardError; end
-
-  end # end class CcsdsParser
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos'
+require 'cosmos/ccsds/ccsds_packet'
+
+module Cosmos
+
+  # Unsegments CCSDS packets and perform other CCSDS processing tasks.
+  class CcsdsParser
+
+    # @return [Symbol] Indicates if the parser is :READY to start a new series
+    #   of packets or is :IN_PROGRESS
+    attr_reader :state
+
+    # @return [String] Binary data that has been collected so far towards the
+    #   completely unsegmented packet. Note: This value is cleared once the
+    #   entire packet is formed and also cleared due to errors.
+    attr_reader :in_progress_data
+
+    # @return [String] The most recent successfully unsegmented packet's data
+    attr_reader :unsegmented_data
+
+    # @return [Integer] Sequence count of the previously received packet
+    attr_reader :sequence_count
+
+    # Create a new {CcsdsPacket} and set the state to :READY
+    def initialize
+      @ccsds_packet = CcsdsPacket.new
+      @unsegmented_data = nil
+      @sequence_count = nil
+      reset()
+    end
+
+    # Resets internal state to :READY and clears the in_progress_data
+    def reset
+      @state = :READY
+      @in_progress_data = ''
+    end
+
+    # Given a segment of a larger CCSDS packet, stores the data until a complete
+    # unsegmented packet can be created.  Returns the unsegmented packet data
+    # once it is complete, or nil if still in progress. Raises
+    # CcsdsParser::CcsdsSegmentationError if a problem is encountered while
+    # unsegmenting.
+    #
+    # @param packet [Packet] A CCSDS packet
+    # @return [String|nil] The reconstituted CCSDS packet buffer or nil if the
+    #   packet has not yet been fully assembled
+    def unsegment_packet(packet)
+      @ccsds_packet.buffer = packet.buffer
+
+      previous_sequence_count = @sequence_count
+      @sequence_count = @ccsds_packet.read('CcsdsSeqcnt')
+
+      # Handle each segment
+      case @ccsds_packet.read('CcsdsSeqflags')
+      when CcsdsPacket::CONTINUATION
+        #####################################################
+        # Continuation packet - only process if in progress
+        #####################################################
+
+        if @state == :IN_PROGRESS
+          if @sequence_count == ((previous_sequence_count + 1) % 16384)
+            @in_progress_data << @ccsds_packet.read('CcsdsData')
+            return nil
+          else
+            reset()
+            raise CcsdsSegmentationError, "Missing packet(s) before continuation packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
+          end
+        else
+          reset()
+          raise CcsdsSegmentationError, "Unexpected continuation packet"
+        end
+
+      when CcsdsPacket::FIRST
+        #######################################################
+        # First packet - always process
+        #######################################################
+
+        if @state == :IN_PROGRESS
+          reset()
+          @state = :IN_PROGRESS
+          @in_progress_data << @ccsds_packet.buffer
+          raise CcsdsSegmentationError, "Unexpected first packet"
+        else
+          @state = :IN_PROGRESS
+          @in_progress_data << @ccsds_packet.buffer
+          return nil
+        end
+
+      when CcsdsPacket::LAST
+        ######################################################################
+        # Last packet - only process if in progress
+        ######################################################################
+
+        if @state == :IN_PROGRESS
+          if @sequence_count == ((previous_sequence_count + 1) % 16384)
+            @in_progress_data << @ccsds_packet.read('CcsdsData')
+            @unsegmented_data = @in_progress_data
+            reset()
+            return @unsegmented_data
+          else
+            reset()
+            raise CcsdsSegmentationError, "Missing packet(s) before last packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
+          end
+        else
+          reset()
+          raise CcsdsSegmentationError, "Unexpected last packet"
+        end
+
+      when CcsdsPacket::STANDALONE
+        ############################################################
+        # Standalone packet - save and return its data
+        ############################################################
+
+        # Update most recent unsegmented data
+        @unsegmented_data = @ccsds_packet.buffer
+
+        if @state == :IN_PROGRESS
+          reset()
+          raise CcsdsSegmentationError, "Unexpected standalone packet"
+        else
+          reset()
+          return @unsegmented_data
+        end
+
+      end # case raw_sequence_flags
+    end
+
+    # Class to indicate errors that occur during the unsegmenting process
+    class CcsdsSegmentationError < StandardError; end
+
+  end # end class CcsdsParser
+
+end # module Cosmos

data/lib/cosmos/config/config_parser.rb

@@ -1,324 +1,324 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'cosmos/ext/config_parser'
-
-module Cosmos
-
-  # Reads COSMOS style configuration data which consists of keywords followed
-  # by 0 or more comma delimited parameters. Parameters with spaces must be
-  # enclosed in quotes. Quotes should also be used to indicate a parameter is a
-  # string. Keywords are case-insensitive and will be returned in uppercase.
-  class ConfigParser
-    # @return [String] The current keyword being parsed
-    attr_accessor :keyword
-
-    # @return [Array<String>] The parameters found after the keyword
-    attr_accessor :parameters
-
-    # @return [String] The name of the configuration file being parsed. This
-    #   will be an empty string if the parse_string class method is used.
-    attr_accessor :filename
-
-    # @return [String] The current line being parsed. This is the raw string
-    #   which is useful when printing errors.
-    attr_accessor :line
-
-    # @return [Integer] The current line number being parsed.
-    #   This will still be populated when using parse_string because lines
-    #   still must be delimited by newline characters.
-    attr_accessor :line_number
-
-    # @return [String] The default URL to use in errors. The URL can still be
-    #   overridden by directly passing it to the error method.
-    attr_accessor :url
-
-    # @see message_callback=
-    @@message_callback = nil
-
-    # @param message_callback [#call(String)] Callback method called with a
-    #   String when various parsing events occur.
-    def self.message_callback=(message_callback)
-      @@message_callback = message_callback
-    end
-
-    # @see progress_callback=
-    @@progress_callback = nil
-
-    # @param progress_callback [#call(Float)] Callback method called with a
-    #   Float (0.0 to 100.0) based on the amount of the io param that has
-    #   currently been processed.
-    def self.progress_callback=(progress_callback)
-      @@progress_callback = progress_callback
-    end
-
-    # Holds the current splash screen
-    @@splash = nil
-
-    # @param splash [Splash::SplashDialogBox] Set the splash dialog box which
-    #   will be updated with messages and progress.
-    def self.splash=(splash)
-      if splash
-        @@splash = splash
-        @@progress_callback = splash.progress_callback
-        @@message_callback = splash.message_callback
-      else
-        @@splash = nil
-        @@progress_callback = nil
-        @@message_callback = nil
-      end
-    end
-
-    # Returns the current splash screen if present
-    def self.splash
-      @@splash
-    end
-
-    # Regular expression used to break up an individual line into a keyword and
-    # comma delimited parameters. Handles parameters in single or double quotes.
-    PARSING_REGEX = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | \S+ }x #"
-
-    # Error which gets raised by ConfigParser in #verify_num_parameters. This
-    # is also the error that classes using ConfigParser should raise when they
-    # encounter a configuration error.
-    class Error < StandardError
-      attr_reader :keyword, :parameters, :filename, :line, :line_number
-
-      # @return [String] The usage string representing how this keyword should
-      #   be formatted.
-      attr_reader :usage
-
-      # @return [String] URL which points to usage documentation on the COSMOS
-      #   Wiki.
-      attr_reader :url
-
-      # Create an Error with the specified Config data
-      #
-      # @param config_parser [ConfigParser] Instance of ConfigParser so Error
-      #   has access to the ConfigParser attributes
-      # @param message [String] The error message which gets passed to the
-      #   StandardError constructor
-      # @param usage [String] The usage string representing how this keyword should
-      #   be formatted.
-      # @param url [String] URL which should point to usage information. By
-      #   default this gets constructed to point to the generic configuration
-      #   Guide on the COSMOS Wiki.
-      def initialize(config_parser, message = "Configuration Error", usage = "", url = "")
-        if Error == message
-          super(message.message)
-        elsif Exception == message
-          super("#{message.class}:#{message.message}")
-        else
-          super(message)
-        end
-        @keyword = config_parser.keyword
-        @parameters = config_parser.parameters
-        @filename = config_parser.filename
-        @line = config_parser.line
-        @line_number = config_parser.line_number
-        @usage = usage
-        @url = url
-      end
-    end
-
-    # @param url [String] The url to link to in error messages
-    def initialize(url = "https://github.com/BallAerospace/COSMOS/wiki/Configuration-Guide")
-      @url = url
-    end
-
-    # Creates an Error
-    #
-    # @param message [String] The string to set the Exception message to
-    # @param usage [String] The usage message
-    # @param url [String] Where to get help about this error
-    # @return [Error] The constructed error
-    def error(message, usage = "", url = @url)
-      return Error.new(self, message, usage, url)
-    end
-
-    # Processes a file and yields |config| to the given block
-    #
-    # @param filename [String] The full name and path of the configuration file
-    # @param yield_non_keyword_lines [Boolean] Whether to yield all lines including blank
-    #   lines or comment lines.
-    # @param remove_quotes [Boolean] Whether to remove beginning and ending single
-    #   or double quote characters from parameters.
-    # @param block [Block] The block to yield to
-    # @yieldparam keyword [String] The keyword in the current parsed line
-    # @yieldparam parameters [Array<String>] The parameters in the current parsed line
-    def parse_file(filename,
-                   yield_non_keyword_lines = false,
-                   remove_quotes = true,
-                   &block)
-      @filename = filename
-      file = File.new(@filename, 'r')
-      begin
-        size = file.stat.size.to_f
-
-        # Callbacks for beginning of parsing
-        @@message_callback.call("Parsing #{size} bytes of #{file.path}") if @@message_callback
-        @@progress_callback.call(0.0) if @@progress_callback
-
-        # Loop through each line of the data
-        parse_loop(file,
-                   yield_non_keyword_lines,
-                   remove_quotes,
-                   size,
-                   PARSING_REGEX,
-                   &block)
-      ensure
-        file.close unless file.closed?
-      end
-    end
-
-    # Verifies the parameters in the config parameter have the specified
-    # number of parameter and raises an Error if not.
-    #
-    # @param [Integer] min_num_params The minimum number of parameters
-    # @param [Integer] max_num_params The maximum number of parameters. Pass
-    #   nil to indicate there is no maximum number of parameters.
-    def verify_num_parameters(min_num_params, max_num_params, usage = "")
-      # This syntax works with 0 because each doesn't return any values
-      # for a backwards range
-      (1..min_num_params).each do |index|
-        # If the parameter is nil (0 based) then we have a problem
-        if @parameters[index-1].nil?
-          raise Error.new(self, "Not enough parameters for #{@keyword}.", usage, @url)
-        end
-      end
-      # If they pass nil for max_params we don't check for a maximum number
-      if max_num_params && !@parameters[max_num_params].nil?
-        raise Error.new(self, "Too many parameters for #{@keyword}.", usage, @url)
-      end
-    end
-
-    # Converts a String containing '', 'NIL' or 'NULL' to nil Ruby primitive.
-    # All other arguments are simply returned.
-    #
-    # @param value [Object]
-    # @return [nil|Object]
-    def self.handle_nil(value)
-      if String === value
-        case value.upcase
-        when '', 'NIL', 'NULL'
-          return nil
-        end
-      end
-      return value
-    end
-
-    # Converts a String containing 'TRUE' or 'FALSE' to true or false Ruby
-    # primitive. All other values are simply returned.
-    #
-    # @param value [Object]
-    # @return [true|false|Object]
-    def self.handle_true_false(value)
-      if String === value
-        case value.upcase
-        when 'TRUE'
-          return true
-        when 'FALSE'
-          return false
-        end
-      end
-      return value
-    end
-
-    # Converts a String containing '', 'NIL', 'NULL', 'TRUE' or 'FALSE' to nil,
-    # true or false Ruby primitives. All other values are simply returned.
-    #
-    # @param value [Object]
-    # @return [true|false|nil|Object]
-    def self.handle_true_false_nil(value)
-      if String === value
-        case value.upcase
-        when 'TRUE'
-          return true
-        when 'FALSE'
-          return false
-        when '', 'NIL', 'NULL'
-          return nil
-        end
-      end
-      return value
-    end
-
-    # Converts a string representing a defined constant into its value. The
-    # defined constants are the minimum and maximum values for all the
-    # allowable data types. [MIN/MAX]_[U]INT[8/16/32] and
-    # [MIN/MAX]_FLOAT[32/64]. Thus MIN_UINT8, MAX_INT32, and MIN_FLOAT64 are
-    # all allowable values. Any other strings raise ArgumentError but all other
-    # types are simply returned.
-    #
-    # @param value [Object] Can be anything
-    # @return [Numeric] The converted value. Either a Fixnum or Float.
-    def self.handle_defined_constants(value)
-      if value.class == String
-        case value.upcase
-        when 'MIN_INT8'
-          return -128
-        when 'MAX_INT8'
-          return 127
-        when 'MIN_INT16'
-          return -32768
-        when 'MAX_INT16'
-          return 32767
-        when 'MIN_INT32'
-          return -2147483648
-        when 'MAX_INT32'
-          return 2147483647
-        when 'MIN_INT64'
-          return -9223372036854775808
-        when 'MAX_INT64'
-          return 9223372036854775807
-        when 'MIN_UINT8', 'MIN_UINT16', 'MIN_UINT32', 'MIN_UINT64'
-          return 0
-        when 'MAX_UINT8'
-          return 255
-        when 'MAX_UINT16'
-          return 65535
-        when 'MAX_UINT32'
-          return 4294967295
-        when 'MAX_UINT64'
-          return 18446744073709551615
-        when 'MIN_FLOAT64'
-          return -Float::MAX
-        when 'MAX_FLOAT64'
-           return Float::MAX
-        when 'MIN_FLOAT32'
-          return -3.402823e38
-        when 'MAX_FLOAT32'
-          return 3.402823e38
-        when 'POS_INFINITY'
-          return Float::INFINITY
-        when 'NEG_INFINITY'
-          return -Float::INFINITY
-        else
-          raise ArgumentError, "Could not convert constant: #{value}"
-        end
-      end
-      return value
-    end
-
-    protected
-
-    # Iterates over each line of the io object and yields the keyword and
-    # parameters
-    #~ def parse_loop(
-      #~ io,
-      #~ yield_non_keyword_lines,
-      #~ remove_quotes,
-      #~ size,
-      #~ rx,
-      #~ &block)
-
-  end # class ConfigParser
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/ext/config_parser'
+
+module Cosmos
+
+  # Reads COSMOS style configuration data which consists of keywords followed
+  # by 0 or more comma delimited parameters. Parameters with spaces must be
+  # enclosed in quotes. Quotes should also be used to indicate a parameter is a
+  # string. Keywords are case-insensitive and will be returned in uppercase.
+  class ConfigParser
+    # @return [String] The current keyword being parsed
+    attr_accessor :keyword
+
+    # @return [Array<String>] The parameters found after the keyword
+    attr_accessor :parameters
+
+    # @return [String] The name of the configuration file being parsed. This
+    #   will be an empty string if the parse_string class method is used.
+    attr_accessor :filename
+
+    # @return [String] The current line being parsed. This is the raw string
+    #   which is useful when printing errors.
+    attr_accessor :line
+
+    # @return [Integer] The current line number being parsed.
+    #   This will still be populated when using parse_string because lines
+    #   still must be delimited by newline characters.
+    attr_accessor :line_number
+
+    # @return [String] The default URL to use in errors. The URL can still be
+    #   overridden by directly passing it to the error method.
+    attr_accessor :url
+
+    # @see message_callback=
+    @@message_callback = nil
+
+    # @param message_callback [#call(String)] Callback method called with a
+    #   String when various parsing events occur.
+    def self.message_callback=(message_callback)
+      @@message_callback = message_callback
+    end
+
+    # @see progress_callback=
+    @@progress_callback = nil
+
+    # @param progress_callback [#call(Float)] Callback method called with a
+    #   Float (0.0 to 100.0) based on the amount of the io param that has
+    #   currently been processed.
+    def self.progress_callback=(progress_callback)
+      @@progress_callback = progress_callback
+    end
+
+    # Holds the current splash screen
+    @@splash = nil
+
+    # @param splash [Splash::SplashDialogBox] Set the splash dialog box which
+    #   will be updated with messages and progress.
+    def self.splash=(splash)
+      if splash
+        @@splash = splash
+        @@progress_callback = splash.progress_callback
+        @@message_callback = splash.message_callback
+      else
+        @@splash = nil
+        @@progress_callback = nil
+        @@message_callback = nil
+      end
+    end
+
+    # Returns the current splash screen if present
+    def self.splash
+      @@splash
+    end
+
+    # Regular expression used to break up an individual line into a keyword and
+    # comma delimited parameters. Handles parameters in single or double quotes.
+    PARSING_REGEX = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | \S+ }x #"
+
+    # Error which gets raised by ConfigParser in #verify_num_parameters. This
+    # is also the error that classes using ConfigParser should raise when they
+    # encounter a configuration error.
+    class Error < StandardError
+      attr_reader :keyword, :parameters, :filename, :line, :line_number
+
+      # @return [String] The usage string representing how this keyword should
+      #   be formatted.
+      attr_reader :usage
+
+      # @return [String] URL which points to usage documentation on the COSMOS
+      #   Wiki.
+      attr_reader :url
+
+      # Create an Error with the specified Config data
+      #
+      # @param config_parser [ConfigParser] Instance of ConfigParser so Error
+      #   has access to the ConfigParser attributes
+      # @param message [String] The error message which gets passed to the
+      #   StandardError constructor
+      # @param usage [String] The usage string representing how this keyword should
+      #   be formatted.
+      # @param url [String] URL which should point to usage information. By
+      #   default this gets constructed to point to the generic configuration
+      #   Guide on the COSMOS Wiki.
+      def initialize(config_parser, message = "Configuration Error", usage = "", url = "")
+        if Error == message
+          super(message.message)
+        elsif Exception == message
+          super("#{message.class}:#{message.message}")
+        else
+          super(message)
+        end
+        @keyword = config_parser.keyword
+        @parameters = config_parser.parameters
+        @filename = config_parser.filename
+        @line = config_parser.line
+        @line_number = config_parser.line_number
+        @usage = usage
+        @url = url
+      end
+    end
+
+    # @param url [String] The url to link to in error messages
+    def initialize(url = "https://github.com/BallAerospace/COSMOS/wiki/Configuration-Guide")
+      @url = url
+    end
+
+    # Creates an Error
+    #
+    # @param message [String] The string to set the Exception message to
+    # @param usage [String] The usage message
+    # @param url [String] Where to get help about this error
+    # @return [Error] The constructed error
+    def error(message, usage = "", url = @url)
+      return Error.new(self, message, usage, url)
+    end
+
+    # Processes a file and yields |config| to the given block
+    #
+    # @param filename [String] The full name and path of the configuration file
+    # @param yield_non_keyword_lines [Boolean] Whether to yield all lines including blank
+    #   lines or comment lines.
+    # @param remove_quotes [Boolean] Whether to remove beginning and ending single
+    #   or double quote characters from parameters.
+    # @param block [Block] The block to yield to
+    # @yieldparam keyword [String] The keyword in the current parsed line
+    # @yieldparam parameters [Array<String>] The parameters in the current parsed line
+    def parse_file(filename,
+                   yield_non_keyword_lines = false,
+                   remove_quotes = true,
+                   &block)
+      @filename = filename
+      file = File.new(@filename, 'r')
+      begin
+        size = file.stat.size.to_f
+
+        # Callbacks for beginning of parsing
+        @@message_callback.call("Parsing #{size} bytes of #{file.path}") if @@message_callback
+        @@progress_callback.call(0.0) if @@progress_callback
+
+        # Loop through each line of the data
+        parse_loop(file,
+                   yield_non_keyword_lines,
+                   remove_quotes,
+                   size,
+                   PARSING_REGEX,
+                   &block)
+      ensure
+        file.close unless file.closed?
+      end
+    end
+
+    # Verifies the parameters in the config parameter have the specified
+    # number of parameter and raises an Error if not.
+    #
+    # @param [Integer] min_num_params The minimum number of parameters
+    # @param [Integer] max_num_params The maximum number of parameters. Pass
+    #   nil to indicate there is no maximum number of parameters.
+    def verify_num_parameters(min_num_params, max_num_params, usage = "")
+      # This syntax works with 0 because each doesn't return any values
+      # for a backwards range
+      (1..min_num_params).each do |index|
+        # If the parameter is nil (0 based) then we have a problem
+        if @parameters[index-1].nil?
+          raise Error.new(self, "Not enough parameters for #{@keyword}.", usage, @url)
+        end
+      end
+      # If they pass nil for max_params we don't check for a maximum number
+      if max_num_params && !@parameters[max_num_params].nil?
+        raise Error.new(self, "Too many parameters for #{@keyword}.", usage, @url)
+      end
+    end
+
+    # Converts a String containing '', 'NIL' or 'NULL' to nil Ruby primitive.
+    # All other arguments are simply returned.
+    #
+    # @param value [Object]
+    # @return [nil|Object]
+    def self.handle_nil(value)
+      if String === value
+        case value.upcase
+        when '', 'NIL', 'NULL'
+          return nil
+        end
+      end
+      return value
+    end
+
+    # Converts a String containing 'TRUE' or 'FALSE' to true or false Ruby
+    # primitive. All other values are simply returned.
+    #
+    # @param value [Object]
+    # @return [true|false|Object]
+    def self.handle_true_false(value)
+      if String === value
+        case value.upcase
+        when 'TRUE'
+          return true
+        when 'FALSE'
+          return false
+        end
+      end
+      return value
+    end
+
+    # Converts a String containing '', 'NIL', 'NULL', 'TRUE' or 'FALSE' to nil,
+    # true or false Ruby primitives. All other values are simply returned.
+    #
+    # @param value [Object]
+    # @return [true|false|nil|Object]
+    def self.handle_true_false_nil(value)
+      if String === value
+        case value.upcase
+        when 'TRUE'
+          return true
+        when 'FALSE'
+          return false
+        when '', 'NIL', 'NULL'
+          return nil
+        end
+      end
+      return value
+    end
+
+    # Converts a string representing a defined constant into its value. The
+    # defined constants are the minimum and maximum values for all the
+    # allowable data types. [MIN/MAX]_[U]INT[8/16/32] and
+    # [MIN/MAX]_FLOAT[32/64]. Thus MIN_UINT8, MAX_INT32, and MIN_FLOAT64 are
+    # all allowable values. Any other strings raise ArgumentError but all other
+    # types are simply returned.
+    #
+    # @param value [Object] Can be anything
+    # @return [Numeric] The converted value. Either a Fixnum or Float.
+    def self.handle_defined_constants(value)
+      if value.class == String
+        case value.upcase
+        when 'MIN_INT8'
+          return -128
+        when 'MAX_INT8'
+          return 127
+        when 'MIN_INT16'
+          return -32768
+        when 'MAX_INT16'
+          return 32767
+        when 'MIN_INT32'
+          return -2147483648
+        when 'MAX_INT32'
+          return 2147483647
+        when 'MIN_INT64'
+          return -9223372036854775808
+        when 'MAX_INT64'
+          return 9223372036854775807
+        when 'MIN_UINT8', 'MIN_UINT16', 'MIN_UINT32', 'MIN_UINT64'
+          return 0
+        when 'MAX_UINT8'
+          return 255
+        when 'MAX_UINT16'
+          return 65535
+        when 'MAX_UINT32'
+          return 4294967295
+        when 'MAX_UINT64'
+          return 18446744073709551615
+        when 'MIN_FLOAT64'
+          return -Float::MAX
+        when 'MAX_FLOAT64'
+           return Float::MAX
+        when 'MIN_FLOAT32'
+          return -3.402823e38
+        when 'MAX_FLOAT32'
+          return 3.402823e38
+        when 'POS_INFINITY'
+          return Float::INFINITY
+        when 'NEG_INFINITY'
+          return -Float::INFINITY
+        else
+          raise ArgumentError, "Could not convert constant: #{value}"
+        end
+      end
+      return value
+    end
+
+    protected
+
+    # Iterates over each line of the io object and yields the keyword and
+    # parameters
+    #~ def parse_loop(
+      #~ io,
+      #~ yield_non_keyword_lines,
+      #~ remove_quotes,
+      #~ size,
+      #~ rx,
+      #~ &block)
+
+  end # class ConfigParser
+
+end # module Cosmos