cosmos 4.5.0 → 5.0.2.pre.beta2

data/lib/cosmos/tools/table_manager/table_manager_core.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program 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 Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'cosmos'
 require 'cosmos/tools/table_manager/table_config'
@@ -15,21 +24,26 @@ module Cosmos
   # Provides the low level Table Manager methods which do not require a GUI.
   class TableManagerCore
     # Generic error raised when a more specific error doesn't work
-    class CoreError < StandardError; end
+    class CoreError < StandardError
+    end
+
     # Raised when opening a file that is either larger or smaller than its definition
-    class MismatchError < CoreError; end
+    class MismatchError < CoreError
+    end
+
     # Raised when there is no current table configuration
     class NoConfigError < CoreError
       # @return [String] Error message
       def message
-        "No current table configuration"
+        'No current table configuration'
       end
     end
+
     # Raised when there is no table in the current configuration
     class NoTableError < CoreError
       # @return [String] Error message
       def message
-        "Table does not exist in current configuration"
+        'Table does not exist in current configuration'
       end
     end
 
@@ -38,7 +52,7 @@ module Cosmos
 
     # Create the instance
     def initialize
-      reset()
+      reset
     end
 
     # Clears the configuration
@@ -48,20 +62,98 @@ module Cosmos
 
     # @param filename [String] Create a new TableConfig instance and process the filename
     def process_definition(filename)
-      @config = TableConfig.new()
+      @config = TableConfig.new
       @config.process_file(filename)
     end
 
+    def generate_json(bin_path, def_path)
+      tables = []
+      json = { tables: tables }
+      begin
+        file_open(bin_path, def_path)
+      rescue CoreError => err
+        json['errors'] = err.message
+      end
+      @config.tables.each do |table_name, table|
+        tables << {
+          name: table_name,
+          numRows: table.num_rows,
+          numColumns: table.num_columns,
+          headers: [],
+          rows: [],
+        }
+        col = 0
+        row = 0
+        num_cols = table.num_columns
+        table.sorted_items.each_with_index do |item, index|
+          next if item.hidden
+          if table.num_columns == 1
+            if row == 0
+              tables[-1][:headers] = [ "INDEX", "NAME", "VALUE" ]
+            end
+            tables[-1][:rows] << [
+              {
+                index: row + 1,
+                name: item.name,
+                value: table.read(item.name, :FORMATTED),
+                states: item.states,
+                editable: item.editable,
+              },
+            ]
+          else
+            if row == 0 && col == 0
+              tables[-1][:headers] << "INDEX"
+            end
+            if row == 0
+              tables[-1][:headers] << item.name[0..-2]
+            end
+            if col == 0
+              # Each row is an array of items
+              tables[-1][:rows][row] = []
+            end
+            tables[-1][:rows][row] << {
+              index: row + 1,
+              name: item.name,
+              value: table.read(item.name, :FORMATTED),
+              states: item.states,
+              editable: item.editable,
+            }
+          end
+          col += 1
+          if col == table.num_columns
+            col = 0
+            row += 1
+          end
+        end
+      end
+      json.to_json
+    end
+
+    def save_tables(bin_path, def_path, tables)
+      file_open(bin_path, def_path)
+      tables.each do |table|
+        table_def = @config.tables[table['name']]
+        table['rows'].each do |row|
+          row.each do |item|
+            # TODO: I don't know how the frontend could edit an item like this:
+            # item:{"name"=>"BINARY", "value"=>{"json_class"=>"String", "raw"=>[222, 173, 190, 239]} }
+            next if item['value'].is_a? Hash
+            table_def.write(item['name'], item['value'])
+          end
+        end
+      end
+      file_save(bin_path)
+      bin_path
+    end
+
     # @param def_path [String] Definition file to process
     # @param output_dir [String] Output directory to create the new file
     # @return [String] Binary file path
     def file_new(def_path, output_dir)
       process_definition(def_path)
-      yield 0.3 if block_given?
-
-      @config.table_names.each {|table_name| set_binary_data_to_default(table_name) }
-      yield 0.7 if block_given?
-
+      @config.table_names.each do |table_name|
+        set_binary_data_to_default(table_name)
+      end
       bin_path = File.join(output_dir, def_to_bin_filename(def_path))
       file_save(bin_path)
       bin_path
@@ -79,20 +171,18 @@ module Cosmos
     # @param filename [String] Filename to write, overwritten if it exists.
     def file_save(filename)
       raise NoConfigError unless @config
-      file_check()
-      File.open(filename, "wb") do |file|
-        @config.tables.each do |table_name, table|
-          file.write(table.buffer)
-        end
+      file_check
+      File.open(filename, 'wb') do |file|
+        @config.tables.each { |table_name, table| file.write(table.buffer) }
       end
-      file_report(filename, @config.filename)
+      # file_report(filename, @config.filename)
     end
 
     # @return [String] Success string if parameters all check. Raises
     #   a CoreError if errors are found.
     def file_check
       raise NoConfigError unless @config
-      result = ""
+      result = ''
       @config.table_names.each do |name|
         table_result = table_check(name)
         unless table_result.empty?
@@ -100,7 +190,7 @@ module Cosmos
         end
       end
       raise CoreError, result unless result.empty?
-      "All parameters are within their constraints."
+      'All parameters are within their constraints.'
     end
 
     # Create a CSV report file based on the file contents.
@@ -111,9 +201,9 @@ module Cosmos
     # @return [String] Report filename path
     def file_report(bin_path, def_path)
       raise NoConfigError unless @config
-      file_check()
+      file_check
 
-      basename = File.basename(bin_path, ".dat")
+      basename = File.basename(bin_path, '.bin')
       report_path = File.join(File.dirname(bin_path), "#{basename}.csv")
       File.open(report_path, 'w+') do |file|
         file.write("File Definition, #{def_path}\n")
@@ -123,18 +213,21 @@ module Cosmos
           file.puts(table.table_name)
 
           # Write the column headers
-          if table.type == :TWO_DIMENSIONAL
-            columns = ["Item"]
+          if table.type == :ROW_COLUMN
+            columns = ['Item']
+
             # Remove the '0' from the 'itemname0'
-            table.num_columns.times.each {|x| columns << items[x].name[0...-1] }
-            file.puts columns.join(", ")
+            table.num_columns.times.each do |x|
+              columns << items[x].name[0...-1]
+            end
+            file.puts columns.join(', ')
           else
-            file.puts "Label, Value"
+            file.puts 'Label, Value'
           end
 
           # Write the table item values
           (0...table.num_rows).each do |r|
-            if table.type == :TWO_DIMENSIONAL
+            if table.type == :ROW_COLUMN
               rowtext = "#{r + 1}"
             else
               rowtext = items[r].name
@@ -142,7 +235,7 @@ module Cosmos
 
             file.write "#{rowtext}, "
             (0...table.num_columns).each do |c|
-              if table.type == :TWO_DIMENSIONAL
+              if table.type == :ROW_COLUMN
                 table_item = items[c + r * table.num_columns]
               else
                 table_item = items[r]
@@ -161,8 +254,8 @@ module Cosmos
     # Create a hex formatted string of all the file data
     def file_hex
       raise NoConfigError unless @config
-      data = ""
-      @config.tables.values.each {|table| data << table.buffer }
+      data = ''
+      @config.tables.values.each { |table| data << table.buffer }
       "#{data.formatted}\n\nTotal Bytes Read: #{data.length}"
     end
 
@@ -172,7 +265,7 @@ module Cosmos
       table = @config.table(table_name)
       raise NoTableError unless table
 
-      result = ""
+      result = ''
       table_items = table.sorted_items
 
       # Check the ranges and constraints for each item in the table
@@ -190,17 +283,21 @@ module Cosmos
             if table_item.states && table_item.states.include?(value)
               value = table_item.states[value]
             end
+
             # check to see if the value lies within its valid range
             unless table_item.range.include?(value)
               if table_item.format_string
                 value = table.read(table_item.name, :FORMATTED)
-                range_first = sprintf(table_item.format_string, table_item.range.first)
-                range_last = sprintf(table_item.format_string, table_item.range.last)
+                range_first =
+                  sprintf(table_item.format_string, table_item.range.first)
+                range_last =
+                  sprintf(table_item.format_string, table_item.range.last)
               else
                 range_first = table_item.range.first
                 range_last = table_item.range.last
               end
-              result << "  #{table_item.name}: #{value} outside valid range of #{range_first}..#{range_last}\n"
+              result <<
+                "  #{table_item.name}: #{value} outside valid range of #{range_first}..#{range_last}\n"
             end
           end
         end # end each column
@@ -228,8 +325,12 @@ module Cosmos
     def table_save(table_name, filename)
       raise NoConfigError unless @config
       result = table_check(table_name)
-      raise CoreError, "Errors in #{table_name}:\n#{result}" unless result.empty?
-      File.open(filename, 'wb') {|file| file.write(@config.table(table_name).buffer) }
+      unless result.empty?
+        raise CoreError, "Errors in #{table_name}:\n#{result}"
+      end
+      File.open(filename, 'wb') do |file|
+        file.write(@config.table(table_name).buffer)
+      end
     end
 
     # Commit a table from the current configuration into a new binary
@@ -243,17 +344,21 @@ module Cosmos
       raise NoTableError unless save_table
 
       result = table_check(table_name)
-      raise CoreError, "Errors in #{table_name}:\n#{result}" unless result.empty?
+      unless result.empty?
+        raise CoreError, "Errors in #{table_name}:\n#{result}"
+      end
 
       config = TableConfig.new
       begin
         config.process_file(def_file)
       rescue => err
-        raise CoreError, "The table definition file:#{def_file} has the following errors:\n#{err}"
+        raise CoreError,
+              "The table definition file:#{def_file} has the following errors:\n#{err}"
       end
 
       if !config.table_names.include?(table_name.upcase)
-        raise NoTableError, "#{table_name} not found in #{def_file} table definition file."
+        raise NoTableError,
+              "#{table_name} not found in #{def_file} table definition file."
       end
 
       saved_config = @config
@@ -285,7 +390,7 @@ module Cosmos
         # Remove any extension if present
         basename = File.basename(def_path, File.extname(def_path))
       end
-      "#{basename}.dat"
+      "#{basename}.bin"
     end
 
     # Opens the given binary file and populates the table definition.
@@ -293,28 +398,32 @@ module Cosmos
     def open_and_load_binary_file(filename)
       begin
         data = nil
+
         # read the binary file and store it into an array
-        File.open(filename, 'rb') do |file|
-          data = file.read
-        end
+        File.open(filename, 'rb') { |file| data = file.read }
       rescue => err
         raise "Unable to open and load #{filename} due to #{err}."
       end
 
       binary_data_index = 0
       total_table_length = 0
-      @config.tables.each {|table_name, table| total_table_length += table.length }
+      @config.tables.each do |table_name, table|
+        total_table_length += table.length
+      end
       @config.tables.each do |table_name, table|
         if binary_data_index + table.length > data.length
           table.buffer = data[binary_data_index..-1]
-          raise MismatchError, "Binary size of #{data.length} not large enough to fully represent table definition of length #{total_table_length}. The remaining table definition (starting with byte #{data.length - binary_data_index} in #{table.table_name}) will be filled with 0."
+          raise MismatchError,
+                "Binary size of #{data.length} not large enough to fully represent table definition of length #{total_table_length}. The remaining table definition (starting with byte #{data.length - binary_data_index} in #{table.table_name}) will be filled with 0."
         end
-        table.buffer = data[binary_data_index...binary_data_index + table.length]
+        table.buffer =
+          data[binary_data_index...binary_data_index + table.length]
         binary_data_index += table.length
       end
       if binary_data_index < data.length
-        raise MismatchError, "Binary size of #{data.length} larger than table definition of length #{total_table_length}. Discarding the remaing #{data.length - binary_data_index} bytes."
+        raise MismatchError,
+              "Binary size of #{data.length} larger than table definition of length #{total_table_length}. Discarding the remaing #{data.length - binary_data_index} bytes."
       end
     end
   end
-end # module Cosmos
+end

data/lib/cosmos/tools/table_manager/table_parser.rb

@@ -1,13 +1,23 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program 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 Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
+require 'cosmos/packets/parsers/packet_parser'
 require 'cosmos/tools/table_manager/table'
 
 module Cosmos
@@ -19,13 +29,14 @@ module Cosmos
     #   parsing this command will be appened to this array
     def self.parse_table(parser, tables, warnings)
       parser = TableParser.new(parser)
-      parser.verify_parameters()
+      parser.verify_parameters
       parser.create_table(tables, warnings)
     end
 
     # Verify the correct number of arguments to the TABLE keyword
     def verify_parameters
-      @usage = "TABLE <TABLE NAME> <ENDIANNESS: BIG_ENDIAN/LITTLE_ENDIAN> <DISPLAY: ONE_DIMENSIONAL/TWO_DIMENSIONAL> <TWO_DIMENSIONAL TABLE ROWS> <DESCRIPTION (Optional)>"
+      @usage =
+        'TABLE <TABLE NAME> <ENDIANNESS: BIG_ENDIAN/LITTLE_ENDIAN> <DISPLAY: KEY_VALUE/ROW_COLUMN> <ROW_COLUMN ROW COUNT> <DESCRIPTION (Optional)>'
       @parser.verify_num_parameters(3, 5, @usage)
     end
 
@@ -36,22 +47,29 @@ module Cosmos
       table_name = params[0].to_s.upcase
       endianness = params[1].to_s.upcase.to_sym
       if endianness != :BIG_ENDIAN && endianness != :LITTLE_ENDIAN
-        raise @parser.error("Invalid endianness #{params[1]}. Must be BIG_ENDIAN or LITTLE_ENDIAN.", @usage)
+        raise @parser.error(
+                "Invalid endianness #{params[1]}. Must be BIG_ENDIAN or LITTLE_ENDIAN.",
+                @usage,
+              )
       end
       type = params[2].to_s.upcase.to_sym
       case type
-      when :ONE_DIMENSIONAL
+      when :KEY_VALUE, :ONE_DIMENSIONAL # :ONE_DIMENSIONAL is deprecated
         @parser.verify_num_parameters(3, 4, @usage)
         description = params[3].to_s
-      when :TWO_DIMENSIONAL
+      when :ROW_COLUMN, :TWO_DIMENSIONAL # :TWO_DIMENSIONAL is deprecated
         @parser.verify_num_parameters(4, 5, @usage)
         num_rows = params[3].to_i
         description = params[4].to_s
       else
-        raise @parser.error("Invalid display type #{params[2]}. Must be ONE_DIMENSIONAL or TWO_DIMENSIONAL.", @usage)
+        raise @parser.error(
+                "Invalid display type #{params[2]}. Must be KEY_VALUE or ROW_COLUMN.",
+                @usage,
+              )
       end
-      table = Table.new(table_name, endianness, type, description, @parser.filename)
-      table.num_rows = num_rows if type == :TWO_DIMENSIONAL
+      table =
+        Table.new(table_name, endianness, type, description, @parser.filename)
+      table.num_rows = num_rows if type == :ROW_COLUMN
       TableParser.finish_create_table(table, tables, warnings)
     end