cosmos 4.3.0-java → 4.4.0-java

data/lib/cosmos/tools/config_editor/config_editor.rb

@@ -33,6 +33,7 @@ module Cosmos
 
     UNTITLED = 'Untitled'
     UNTITLED_TAB_TEXT = "  #{UNTITLED}  "
+    MAX_RECENT_FILES = 20
     # Mapping of the human readable configuration name to an array containing the
     # yaml file name and typical location of the configuration file
     CONFIGURATION_FILES = {
@@ -47,6 +48,8 @@ module Cosmos
       "Screen Definition" =>
         ["screen", "/config/targets/TARGET/screens/*.txt"],
       "Separator" => [nil, nil],
+      "Command Sequence Configuration" =>
+        ["cmd_sequence", "/config/tools/cmd_sequence/cmd_sequence.txt"],
       "Data Viewer Configuration" =>
         ["data_viewer", "/config/tools/data_viewer/data_viewer.txt"],
       "Handbook Creator Configuration" =>
@@ -100,13 +103,17 @@ module Cosmos
       @file_new.statusTip = 'Start a new file'
       @file_new.connect(SIGNAL('triggered()')) { file_new() }
 
+      @clear_file_open_recent = Qt::Action.new('&Clear Recent', self)
+      @clear_file_open_recent.statusTip = 'Clear the recently opened file list'
+      @clear_file_open_recent.connect(SIGNAL('triggered()')) { clear_file_open_recent() }
+
       @file_close = Qt::Action.new('&Close', self)
       @file_close_keyseq = Qt::KeySequence.new('Ctrl+W')
       @file_close.shortcut  = @file_close_keyseq
       @file_close.statusTip = 'Close the file'
       @file_close.connect(SIGNAL('triggered()')) { file_close() }
 
-      @file_reload = Qt::Action.new('&Reload', self)
+      @file_reload = Qt::Action.new('Re&load', self)
       @file_reload_keyseq = Qt::KeySequence.new('Ctrl+R')
       @file_reload.shortcut  = @file_reload_keyseq
       @file_reload.statusTip = 'Reload a file'
@@ -239,6 +246,20 @@ module Cosmos
       @file_open.setIcon(Cosmos.get_icon('open.png'))
       target_dirs_action(@file_open, File.join(Cosmos::USERPATH,'config'), '', method(:file_open))
 
+      @file_open_recent = @file_menu.addMenu('Open &Recent')
+      @file_open_recent.setIcon(Cosmos.get_icon('open.png'))
+      settings = Qt::Settings.new('Ball Aerospace', self.class.to_s)
+      if settings.contains('recent_files')
+        recent = settings.value('recent_files').toStringList()
+        recent.each do |filename|
+          action = Qt::Action.new(filename, self)
+          action.connect(SIGNAL('triggered()')) { open_filename(filename) }
+          @file_open_recent.addAction(action)
+        end
+      end
+      @file_open_recent.addSeparator()
+      @file_open_recent.addAction(@clear_file_open_recent)
+
       @file_menu.addAction(@file_close)
       @file_menu.addAction(@file_reload)
       @file_menu.addSeparator()
@@ -408,36 +429,67 @@ module Cosmos
     # File->Open
     def file_open(filename = nil)
       if File.directory?(filename)
-        filename = Qt::FileDialog.getOpenFileName(self, "Select File", filename)
-      end
-      unless filename.nil? || filename.empty?
-        # If the user opens a file we already have open
-        # just set the current tab to that file and return
-        @tab_book.tabs.each_with_index do |tab, index|
-          if tab.filename == filename
-            @tab_book.setCurrentIndex(index)
-            @tab_book.currentTab.set_text_from_file(filename)
-            @tab_book.currentTab.filename = filename
-            return
-          end
+        filenames = Qt::FileDialog.getOpenFileNames(self, "Select File(s)", filename, "COSMOS (*.rb *.txt);;All Files(*.*)")
+      else
+        filenames = [filename]
+      end
+      # Remove nils and convert filenames to UNIX path structure
+      filenames = filenames.compact.map {|filename| filename.gsub("\\","/") }
+      return if filenames.nil? || filenames.empty?
+      Qt::Application.setOverrideCursor(Qt::Cursor.new(Qt::WaitCursor))
+      filenames.each do |filename|
+        open_filename(filename)
+
+        found = false
+        @file_open_recent.actions.each do |action|
+          found = true if action.text == filename
         end
+        next if found
+        action = Qt::Action.new(filename, self)
+        action.connect(SIGNAL('triggered()')) { open_filename(filename) }
+        @file_open_recent.insertAction(@file_open_recent.actions[0], action)
+        # Add 2 for the separator and Clear Recent action
+        if @file_open_recent.actions.length > (MAX_RECENT_FILES + 2)
+          @file_open_recent.removeAction(@file_open_recent.actions[-3]) # ignore last 2
+        end
+      end
+      update_tree()
+      Qt::Application.restoreOverrideCursor()
+    end
 
-        if ((@tab_book.count == 1) &&
-            @tab_book.currentTab.filename.empty? &&
-            !@tab_book.currentTab.modified)
-          # Active Tab is an unmodified Untitled so just open the file in it
+    def clear_file_open_recent
+      # Subtract 2 for the separator and Clear Recent action
+      (@file_open_recent.actions.length - 2).times do
+        @file_open_recent.removeAction(@file_open_recent.actions[0])
+      end
+    end
+
+    def open_filename(filename)
+      # If the user opens a file we already have open
+      # just set the current tab to that file and return
+      @tab_book.tabs.each_with_index do |tab, index|
+        if tab.filename == filename
+          @tab_book.setCurrentIndex(index)
           @tab_book.currentTab.set_text_from_file(filename)
           @tab_book.currentTab.filename = filename
-          @tab_book.setTabText(@tab_book.currentIndex, File.basename(filename))
-        else
-          create_tab(filename)
+          return
         end
+      end
 
-        update_title()
-        @procedure_dir = File.dirname(filename)
-        @procedure_dir << '/' if @procedure_dir[-1..-1] != '/' and @procedure_dir[-1..-1] != '\\'
+      if ((@tab_book.count == 1) &&
+          @tab_book.currentTab.filename.empty? &&
+          !@tab_book.currentTab.modified)
+        # Active Tab is an unmodified Untitled so just open the file in it
+        @tab_book.currentTab.set_text_from_file(filename)
+        @tab_book.currentTab.filename = filename
+        @tab_book.setTabText(@tab_book.currentIndex, File.basename(filename))
+      else
+        create_tab(filename)
       end
-      update_tree()
+
+      update_title()
+      @procedure_dir = File.dirname(filename)
+      @procedure_dir << '/' if @procedure_dir[-1..-1] != '/' and @procedure_dir[-1..-1] != '\\'
     end
 
     # File->Reload
@@ -615,6 +667,10 @@ module Cosmos
 
     def closeEvent(event)
       if prompt_for_save_if_needed_on_close()
+        settings = Qt::Settings.new('Ball Aerospace', self.class.to_s)
+        recent_files = @file_open_recent.actions.collect {|action| action.text }
+        # Ignore the last 2 because of the separator and Clear Recent action
+        settings.setValue('recent_files', Qt::Variant.new(recent_files[0..-3]))
         super(event)
       else
         event.ignore()

data/lib/cosmos/tools/config_editor/config_editor_frame.rb

@@ -249,6 +249,8 @@ module Cosmos
         elsif @filename.include?('/config/tools/')
           if @filename.include?('cmd_tlm_server')
             @file_type = "Server Configuration"
+          elsif @filename.include?('cmd_sequence')
+            @file_type = "Command Sequence Configuration"
           elsif @filename.include?('data_viewer')
             @file_type = "Data Viewer Configuration"
           elsif @filename.include?('handbook_creator')

data/lib/cosmos/tools/data_viewer/data_viewer.rb

@@ -20,12 +20,14 @@ Cosmos.catch_fatal_exception do
   require 'cosmos/gui/widgets/realtime_button_bar'
   require 'cosmos/tools/data_viewer/data_viewer_component'
   require 'cosmos/tools/data_viewer/dump_component'
+  require 'cosmos/tools/data_viewer/text_component'
   require 'cosmos/config/config_parser'
   require 'cosmos/script'
 end
 
 module Cosmos
-
+  # Displays data in text format. Useful for telemetry that doesn't work well with
+  # telemetry screens such as memory dumps or large amounts of text.
   class DataViewer < QtTool
     slots 'context_menu(const QPoint&)'
     slots 'handle_tab_change(int)'
@@ -80,7 +82,8 @@ module Cosmos
             component.initialize_gui
             @tab_book.addTab(component, component.tab_name)
           end
-          if @auto_start
+          toggle_replay_mode() if options.replay
+          if @auto_start || options.start
             handle_start()
           end
           ConfigParser.splash = nil
@@ -767,17 +770,20 @@ module Cosmos
           options.width = 550
           options.height = 500
           options.title = "Data Viewer"
-          options.config_file = 'data_viewer.txt'
+          options.start = false
+          options.replay = false
+          options.config_file = true # config_file is required
           option_parser.separator "Data Viewer Specific Options:"
-          option_parser.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
-            options.config_file = arg
+          option_parser.on("-s", "--start", "Start processing immediately") do |arg|
+            options.start = true
+          end
+          option_parser.on("--replay", "Start Data Viewer in Replay mode") do
+            options.replay = true
           end
         end
 
         super(option_parser, options)
       end
     end
-
-  end # class DataViewer
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/data_viewer/dump_component.rb

@@ -12,13 +12,8 @@ require 'cosmos'
 require 'cosmos/tools/data_viewer/data_viewer_component'
 
 module Cosmos
-
-  # DumpComponent class
-  #
-  # This class displays packets as raw hex values
-  #
+  # Displays packets as raw hex values
   class DumpComponent < DataViewerComponent
-
     # Processes the given packet. No gui interaction should be done in this
     # method. Override this method for other components.
     def process_packet (packet)
@@ -35,7 +30,5 @@ module Cosmos
         @processed_queue << processed_text
       end
     end
-
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/data_viewer/text_component.rb

@@ -0,0 +1,77 @@
+# 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/tools/data_viewer/data_viewer_component'
+
+module Cosmos
+  # Displays strings from a telemetry item. To use this in a script
+  # you can call with inject_tlm("TGT", "PKT", "ITEM": "<R>Error text")
+  # or pass a color with inject_tlm("TGT", "PKT", "ITEM": "<grey>Error text")
+  # The color is in brackets and can be B, G, Y, R for COSMOS blue, green
+  # yellow and red or simply a color name recognized by Qt.
+  class TextComponent < DataViewerComponent
+    # @param parent [Qt::Widget] Parent widget
+    # @param tab_name [String] Name of the tab which displays this widget
+    # @param item_name [String] Name of the item to read from the packet
+    def initialize(parent, tab_name, item_name)
+      super(parent, tab_name)
+      @item_name = item_name
+    end
+
+    # Override the update_gui to display the text
+    def update_gui
+      begin
+        loop do
+          latest = @processed_queue.pop(true)
+          # Check for optional formatted date followed by COSMOS color <G>,<Y>,<R>,<B>
+          # Regex notes:
+          #   ?: makes the optional date a non-matching group
+          #   The \d+ after the dot matches subseconds which is followed by a space.
+          #   The whole date match is optional if there is no packet.received_time.
+          #   The matching group surrounds the GYRB single character set.
+          if match = latest.match(/^(?:\d{4}\/\d\d\/\d\d \d\d:\d\d:\d\d\.\d+ )?<([GYRB])>/)
+            case match.captures[0]
+            when 'G'
+              color = Cosmos::GREEN
+            when 'Y'
+              color = Cosmos::YELLOW
+            when 'R'
+              color = Cosmos::RED
+            when 'B'
+              color = Cosmos::BLUE
+            end
+            @text.appendText(latest.sub(/<.*?>/,''), color)
+          # Check for optional formatted date followed by color name
+          # See Regex notes above for more information. Note that the .*? makes the match
+          # inside the parens non greedy so it matches the first close bracket '>'
+          elsif match = latest.match(/^(?:\d{4}\/\d\d\/\d\d \d\d:\d\d:\d\d\.\d+ )?<(.*?)>/)
+            @text.appendText(latest.sub(/<.*?>/,''), Cosmos.getColor(match.captures[0]))
+          else # add black text
+            @text.appendText(latest)
+          end
+        end
+      rescue ThreadError
+        # Nothing to do
+      end
+    end
+
+    # Add the time and the item to the queue
+    def process_packet(packet)
+      processed_text = ''
+      processed_text << "#{packet.received_time.formatted} " if packet.received_time
+      processed_text << packet.read(@item_name)
+      # Ensure that queue does not grow infinitely while paused
+      if @processed_queue.length < 1000
+        @processed_queue << processed_text
+      end
+    end
+  end
+end

data/lib/cosmos/tools/handbook_creator/handbook_creator.rb

@@ -17,12 +17,10 @@ Cosmos.catch_fatal_exception do
 end
 
 module Cosmos
-
   # Creates command and telemetry handbooks from the COSMOS definitions in
   # both HTML and PDF format.
   class HandbookCreator < QtTool
-
-    def initialize (options)
+    def initialize(options)
       super(options) # MUST BE FIRST - All code before super is executed twice in RubyQt Based classes
       Cosmos.load_cosmos_icon("handbook_creator.png")
 
@@ -40,6 +38,7 @@ module Cosmos
       end
     end
 
+    # Create the application menu actions
     def initialize_actions
       super()
       @hide_ignored_action = Qt::Action.new('&Hide Ignored Items', self)
@@ -48,44 +47,26 @@ module Cosmos
       @hide_ignored_action.statusTip = 'Do not include ignored items in command and telemetry handbooks'
       @hide_ignored_action.setCheckable(true)
       @hide_ignored_action.setChecked(false)
+
+      @copy_assets_action = Qt::Action.new('&Copy Assets to Output', self)
+      @copy_assets_action.statusTip = 'Copy the default assets to the output directory'
+      @copy_assets_action.connect(SIGNAL('triggered()')) { copy_assets(true) }
     end
 
+    # Create the application menus and add the actions to the menu
     def initialize_menus
-      # File Menu
       @file_menu = menuBar.addMenu('&File')
       @file_menu.addAction(@hide_ignored_action)
+      @file_menu.addAction(@copy_assets_action)
       @file_menu.addAction(@exit_action)
 
-      # Help Menu
       @about_string = "Handbook Creator creates Command and Telemetry Handbooks"
       initialize_help_menu()
     end
 
-    def create_pdfs(both, hide_ignored)
-      success = false
-      ProgressDialog.execute(self, 'PDF Creation Progress', 700, 600, true, false, true, true, false) do |progress_dialog|
-        begin
-          success = @config.create_pdf(hide_ignored, progress_dialog)
-          if success
-            msg = "\n\n"
-            msg << "HTML and " if both
-            msg << "PDF Handbooks created successfully"
-            progress_dialog.append_text(msg)
-          else
-            progress_dialog.append_text("\nPDF Handbooks could not be created.\n\nIs wkhtmltopdf in your PATH and are all existing pdfs closed?\n\nUsing version 0.11.0_rc1 of wkhtmltox is recommended which can be found at: http://download.gna.org/wkhtmltopdf/obsolete/\n\nVersion 0.12.x has shown issues with Handbook Creator's default templates.")
-          end
-        rescue => error
-          progress_dialog.append_text("\n\nError processing:\n#{error.formatted}")
-        ensure
-          progress_dialog.complete
-        end
-      end
-    rescue Exception => err
-      Cosmos.handle_critical_exception(err)
-    end
-
+    # Create the application with several buttons to create handbooks (HTML & PDF)
+    # and open the generated HTML output in a browser.
     def initialize_central_widget
-      # Create the central widget
       @central_widget = Qt::Widget.new
       setCentralWidget(@central_widget)
 
@@ -95,6 +76,7 @@ module Cosmos
       @html_button.setStyleSheet("text-align:left")
       @html_button.connect(SIGNAL('clicked()')) do
         begin
+          copy_assets()
           @config.create_html(@hide_ignored_action.isChecked)
           Qt::MessageBox.information(self, 'Done', 'HTML Handbooks created successfully')
         rescue Exception => err
@@ -106,6 +88,7 @@ module Cosmos
       @pdf_button = Qt::PushButton.new(Cosmos.get_icon('pdf-32.png'), 'Create PDF Handbooks')
       @pdf_button.setStyleSheet("text-align:left")
       @pdf_button.connect(SIGNAL('clicked()')) do
+        copy_assets()
         create_pdfs(false, @hide_ignored_action.isChecked)
       end
       @top_layout.addWidget(@pdf_button)
@@ -114,6 +97,7 @@ module Cosmos
       @html_pdf_button.setStyleSheet("text-align:left")
       @html_pdf_button.connect(SIGNAL('clicked()')) do
         begin
+          copy_assets()
           @config.create_html(@hide_ignored_action.isChecked)
           create_pdfs(true, @hide_ignored_action.isChecked)
         rescue Exception => err
@@ -136,21 +120,63 @@ module Cosmos
       @central_widget.setLayout(@top_layout)
     end
 
-    # Runs the application
+    # Copy the assets (css, fonts, images, javascript) from the project config directory
+    # into the outputs/handbooks directory. When called as a part of generating the output
+    # files this copy will not occur if the assets directory already exists in case it has
+    # been modified by the user. This is also called from a menu option which can copy over
+    # existing output assets if permitted by the user.
+    def copy_assets(menu_request = false)
+      source_path = File.join(::Cosmos::USERPATH,'config','tools','handbook_creator','assets')
+      output_path = File.join(System.paths['HANDBOOKS'], 'assets')
+      if menu_request
+        if File.exist?(output_path)
+          if Qt::MessageBox.warning(self, "Warning!", "#{output_path} already exists. Overwrite?",
+            Qt::MessageBox::Yes | Qt::MessageBox::No) == Qt::MessageBox::No
+            return
+          else
+            FileUtils.cp_r(source_path, System.paths['HANDBOOKS'])
+          end
+        else
+          FileUtils.cp_r(source_path, System.paths['HANDBOOKS'])
+        end
+      else
+        FileUtils.cp_r(source_path, System.paths['HANDBOOKS']) unless File.exist?(output_path)
+      end
+    end
+
+    # Create the PDFs inside a progress dialog as this action takes a significant amount of time
+    def create_pdfs(both, hide_ignored)
+      success = false
+      ProgressDialog.execute(self, 'PDF Creation Progress', 700, 600, true, false, true, true, false) do |progress_dialog|
+        begin
+          success = @config.create_pdf(hide_ignored, progress_dialog)
+          if success
+            msg = "\n\n"
+            msg << "HTML and " if both
+            msg << "PDF Handbooks created successfully"
+            progress_dialog.append_text(msg)
+          else
+            progress_dialog.append_text("\nPDF Handbooks could not be created.\n\nIs wkhtmltopdf in your PATH and are all existing pdfs closed?\n\nUsing version 0.11.0_rc1 of wkhtmltox is recommended which can be found at: http://download.gna.org/wkhtmltopdf/obsolete/\n\nVersion 0.12.x has shown issues with Handbook Creator's default templates.")
+          end
+        rescue => error
+          progress_dialog.append_text("\n\nError processing:\n#{error.formatted}")
+        ensure
+          progress_dialog.complete
+        end
+      end
+    rescue Exception => err
+      Cosmos.handle_critical_exception(err)
+    end
+
     def self.run(option_parser = nil, options = nil)
       Cosmos.catch_fatal_exception do
         unless option_parser and options
           option_parser, options = create_default_options()
           options.title = "Handbook Creator"
-          options.config_file = File.join(Cosmos::USERPATH, 'config', 'tools', 'handbook_creator', 'handbook_creator.txt')
-          option_parser.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
-            options.config_file = File.join(Cosmos::USERPATH, 'config', 'tools', 'handbook_creator', arg)
-          end
+          options.config_file = true # config_file is required
         end
         super(option_parser, options)
       end
     end
-
-  end # class HandbookCreator
-
-end # module Cosmos
+  end
+end