cosmos 3.5.1 → 3.5.2

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

@@ -1,134 +1,134 @@
-# 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'
-
-module Cosmos
-
-  class DataViewerComponent < Qt::Widget
-    attr_reader :tab_name
-    attr_reader :packets
-    attr_reader :text
-
-    # Create a component to go inside the DataViewer
-    #
-    # @param parent [Qt::Widget] Parent widget
-    # @param tab_name [String] Name of the tab which displays this widget
-    def initialize(parent, tab_name)
-      super(parent)
-      @tab_name = tab_name
-      @packets = []
-      @processed_queue = Queue.new
-      @log_file_directory = System.paths['LOGS']
-      @max_block_count = 1000
-      @timer = nil
-    end
-
-    # Adds a packet to the list of packets this components processes
-    #
-    # @param target_name [String] Name of the target
-    # @param packet_name [String] Name of the packet
-    def add_packet(target_name, packet_name)
-      @packets << [target_name, packet_name]
-    end
-
-    # Builds the gui for this component
-    def initialize_gui
-      @top_layout = Qt::VBoxLayout.new
-
-      @text = Qt::PlainTextEdit.new
-      @text.setReadOnly(true)
-      @text.setMaximumBlockCount(@max_block_count)
-      @text.font = Cosmos.get_default_small_font
-      @text.setWordWrapMode(Qt::TextOption::NoWrap)
-      @top_layout.addWidget(@text)
-
-      @button = Qt::PushButton.new('Save Text to File')
-      @button.connect(SIGNAL('clicked()')) do
-        Qt.execute_in_main_thread(true) do
-          filename = File.join(@log_file_directory, File.build_timestamped_filename(['dataviewer']))
-
-          # Prompt user for filename
-          filename = Qt::FileDialog::getSaveFileName(self, "Save As...", filename, "Text Files (*.txt);;All Files (*)")
-          if not filename.nil? and not filename.empty?
-            @log_file_directory = File.dirname(filename)
-            @log_file_directory << '/' unless @log_file_directory[-1..-1] == '\\'
-
-            File.open(filename, 'w') do |file|
-              file.write(@text.toPlainText)
-            end
-          end
-        end
-      end
-      @top_layout.addWidget(@button)
-
-      @timer = Qt::Timer.new(self)
-      @timer.connect(SIGNAL('timeout()')) { scroll_to_bottom() }
-      @timer.setSingleShot(true)
-
-      setLayout(@top_layout)
-    end
-
-    # Updates the gui with any changes if needed
-    def update_gui
-      begin
-        loop do
-          # Get new processed text
-          processed_text = @processed_queue.pop(true)
-
-          # Add text to text widget
-          @text.appendPlainText(processed_text)
-        end
-      rescue ThreadError
-        # Nothing to do
-      end
-    end
-
-    # Resets the gui and any intermediate processing
-    def reset
-      @text.setPlainText("")
-    end
-
-    def showEvent(event)
-      # When the tab is shown we want to ensure the scroll bar is at the
-      # maximum to allow the PlainTextArea to automatically hold the scroll
-      # at the bottom of the display while appending things.
-      # If this is not done, switching tabs will cause the scroll bar
-      # to "stick" and not stay at the bottom with the newest text.
-      @timer.start(100)
-    end
-
-    def scroll_to_bottom
-      @text.verticalScrollBar.value = @text.verticalScrollBar.maximum
-    end
-
-    # Processes the given packet. No gui interaction should be done in this
-    # method. Override this method for other components.
-    def process_packet(packet)
-      processed_text = ''
-      processed_text << '*' * 80 << "\n"
-      processed_text << "* #{packet.target_name} #{packet.packet_name}\n"
-      processed_text << "* Received Time: #{packet.received_time.formatted}\n" if packet.received_time
-      processed_text << "* Received Count: #{packet.received_count}\n"
-      processed_text << '*' * 80 << "\n"
-      processed_text << packet.formatted(:WITH_UNITS) << "\n"
-      # Ensure that queue does not grow infinitely while paused
-      if @processed_queue.length < 1000
-        @processed_queue << processed_text
-      end
-    end
-
-    # Shutdown the Data Viewer Component. Called when program is closed.
-    def shutdown
-      # Do nothing by default
-    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'
+
+module Cosmos
+
+  class DataViewerComponent < Qt::Widget
+    attr_reader :tab_name
+    attr_reader :packets
+    attr_reader :text
+
+    # Create a component to go inside the DataViewer
+    #
+    # @param parent [Qt::Widget] Parent widget
+    # @param tab_name [String] Name of the tab which displays this widget
+    def initialize(parent, tab_name)
+      super(parent)
+      @tab_name = tab_name
+      @packets = []
+      @processed_queue = Queue.new
+      @log_file_directory = System.paths['LOGS']
+      @max_block_count = 1000
+      @timer = nil
+    end
+
+    # Adds a packet to the list of packets this components processes
+    #
+    # @param target_name [String] Name of the target
+    # @param packet_name [String] Name of the packet
+    def add_packet(target_name, packet_name)
+      @packets << [target_name, packet_name]
+    end
+
+    # Builds the gui for this component
+    def initialize_gui
+      @top_layout = Qt::VBoxLayout.new
+
+      @text = Qt::PlainTextEdit.new
+      @text.setReadOnly(true)
+      @text.setMaximumBlockCount(@max_block_count)
+      @text.font = Cosmos.get_default_small_font
+      @text.setWordWrapMode(Qt::TextOption::NoWrap)
+      @top_layout.addWidget(@text)
+
+      @button = Qt::PushButton.new('Save Text to File')
+      @button.connect(SIGNAL('clicked()')) do
+        Qt.execute_in_main_thread(true) do
+          filename = File.join(@log_file_directory, File.build_timestamped_filename(['dataviewer']))
+
+          # Prompt user for filename
+          filename = Qt::FileDialog::getSaveFileName(self, "Save As...", filename, "Text Files (*.txt);;All Files (*)")
+          if not filename.nil? and not filename.empty?
+            @log_file_directory = File.dirname(filename)
+            @log_file_directory << '/' unless @log_file_directory[-1..-1] == '\\'
+
+            File.open(filename, 'w') do |file|
+              file.write(@text.toPlainText)
+            end
+          end
+        end
+      end
+      @top_layout.addWidget(@button)
+
+      @timer = Qt::Timer.new(self)
+      @timer.connect(SIGNAL('timeout()')) { scroll_to_bottom() }
+      @timer.setSingleShot(true)
+
+      setLayout(@top_layout)
+    end
+
+    # Updates the gui with any changes if needed
+    def update_gui
+      begin
+        loop do
+          # Get new processed text
+          processed_text = @processed_queue.pop(true)
+
+          # Add text to text widget
+          @text.appendPlainText(processed_text)
+        end
+      rescue ThreadError
+        # Nothing to do
+      end
+    end
+
+    # Resets the gui and any intermediate processing
+    def reset
+      @text.setPlainText("")
+    end
+
+    def showEvent(event)
+      # When the tab is shown we want to ensure the scroll bar is at the
+      # maximum to allow the PlainTextArea to automatically hold the scroll
+      # at the bottom of the display while appending things.
+      # If this is not done, switching tabs will cause the scroll bar
+      # to "stick" and not stay at the bottom with the newest text.
+      @timer.start(100)
+    end
+
+    def scroll_to_bottom
+      @text.verticalScrollBar.value = @text.verticalScrollBar.maximum
+    end
+
+    # Processes the given packet. No gui interaction should be done in this
+    # method. Override this method for other components.
+    def process_packet(packet)
+      processed_text = ''
+      processed_text << '*' * 80 << "\n"
+      processed_text << "* #{packet.target_name} #{packet.packet_name}\n"
+      processed_text << "* Received Time: #{packet.received_time.formatted}\n" if packet.received_time
+      processed_text << "* Received Count: #{packet.received_count}\n"
+      processed_text << '*' * 80 << "\n"
+      processed_text << packet.formatted(:WITH_UNITS) << "\n"
+      # Ensure that queue does not grow infinitely while paused
+      if @processed_queue.length < 1000
+        @processed_queue << processed_text
+      end
+    end
+
+    # Shutdown the Data Viewer Component. Called when program is closed.
+    def shutdown
+      # Do nothing by default
+    end
+  end
+
+end # module Cosmos

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

@@ -1,40 +1,40 @@
-# 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
-
-  # DumpComponent class
-  #
-  # This class 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)
-      processed_text = ''
-      processed_text << '*' * 80 << "\n"
-      processed_text << "* #{packet.target_name} #{packet.packet_name}\n"
-      processed_text << "* Received Time: #{packet.received_time.formatted}\n" if packet.received_time
-      processed_text << "* Received Count: #{packet.received_count}\n"
-      processed_text << '*' * 80 << "\n"
-      processed_text << packet.buffer.formatted << "\n"
-      # Ensure that queue does not grow infinitely while paused
-      if @processed_queue.length < 1000
-        @processed_queue << processed_text
-      end
-    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'
+require 'cosmos/tools/data_viewer/data_viewer_component'
+
+module Cosmos
+
+  # DumpComponent class
+  #
+  # This class 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)
+      processed_text = ''
+      processed_text << '*' * 80 << "\n"
+      processed_text << "* #{packet.target_name} #{packet.packet_name}\n"
+      processed_text << "* Received Time: #{packet.received_time.formatted}\n" if packet.received_time
+      processed_text << "* Received Count: #{packet.received_count}\n"
+      processed_text << '*' * 80 << "\n"
+      processed_text << packet.buffer.formatted << "\n"
+      # Ensure that queue does not grow infinitely while paused
+      if @processed_queue.length < 1000
+        @processed_queue << processed_text
+      end
+    end
+
+  end
+
+end # module Cosmos

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

@@ -1,156 +1,156 @@
-# 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'
-Cosmos.catch_fatal_exception do
-  require 'cosmos/gui/qt_tool'
-  require 'cosmos/gui/dialogs/splash'
-  require 'cosmos/gui/dialogs/progress_dialog'
-  require 'cosmos/tools/handbook_creator/handbook_creator_config'
-end
-
-module Cosmos
-
-  # Creates command and telemetry handbooks from the COSMOS definitions in
-  # both HTML and PDF format.
-  class HandbookCreator < QtTool
-
-    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")
-
-      initialize_actions()
-      initialize_menus()
-      initialize_central_widget()
-      complete_initialize()
-
-      # Bring up slash screen for long duration tasks after creation
-      Splash.execute(self) do |splash|
-        ConfigParser.splash = splash
-        System.commands
-        @config = HandbookCreatorConfig.new(options.config_file)
-        ConfigParser.splash = nil
-      end
-    end
-
-    def initialize_actions
-      super()
-      @hide_ignored_action = Qt::Action.new(tr('&Hide Ignored Items'), self)
-      @hide_ignored_keyseq = Qt::KeySequence.new(tr('Ctrl+H'))
-      @hide_ignored_action.shortcut  = @hide_ignored_keyseq
-      @hide_ignored_action.statusTip = tr('Do not include ignored items in command and telemetry handbooks')
-      @hide_ignored_action.setCheckable(true)
-      @hide_ignored_action.setChecked(false)
-    end
-
-    def initialize_menus
-      # File Menu
-      @file_menu = menuBar.addMenu(tr('&File'))
-      @file_menu.addAction(@hide_ignored_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: https://code.google.com/p/wkhtmltopdf/downloads/list?can=1.\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 initialize_central_widget
-      # Create the central widget
-      @central_widget = Qt::Widget.new
-      setCentralWidget(@central_widget)
-
-      @top_layout = Qt::VBoxLayout.new
-
-      @html_button = Qt::PushButton.new(Cosmos.get_icon('html-32.png'), 'Create HTML Handbooks')
-      @html_button.setStyleSheet("text-align:left")
-      @html_button.connect(SIGNAL('clicked()')) do
-        begin
-          @config.create_html(@hide_ignored_action.isChecked)
-          Qt::MessageBox.information(self, 'Done', 'HTML Handbooks created successfully')
-        rescue Exception => err
-          Cosmos.handle_critical_exception(err)
-        end
-      end
-      @top_layout.addWidget(@html_button)
-
-      @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
-        create_pdfs(false, @hide_ignored_action.isChecked)
-      end
-      @top_layout.addWidget(@pdf_button)
-
-      @html_pdf_button = Qt::PushButton.new('Create HTML and PDF Handbooks')
-      @html_pdf_button.setStyleSheet("text-align:left")
-      @html_pdf_button.connect(SIGNAL('clicked()')) do
-        begin
-          @config.create_html(@hide_ignored_action.isChecked)
-          create_pdfs(true, @hide_ignored_action.isChecked)
-        rescue Exception => err
-          Cosmos.handle_critical_exception(err)
-        end
-      end
-      @top_layout.addWidget(@html_pdf_button)
-
-      @open_button = Qt::PushButton.new(Cosmos.get_icon('open_in_browser-32.png'), 'Open in Web Browser')
-      @open_button.setStyleSheet("text-align:left")
-      @open_button.connect(SIGNAL('clicked()')) do
-        begin
-          Cosmos.open_in_web_browser(File.join(System.paths['HANDBOOKS'], @config.pages[0].filename))
-        rescue Exception => err
-          Cosmos.handle_critical_exception(err)
-        end
-      end
-      @top_layout.addWidget(@open_button)
-
-      @central_widget.setLayout(@top_layout)
-    end
-
-    # Runs the application
-    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
-        end
-        super(option_parser, options)
-      end
-    end
-
-  end # class HandbookCreator
-
-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'
+Cosmos.catch_fatal_exception do
+  require 'cosmos/gui/qt_tool'
+  require 'cosmos/gui/dialogs/splash'
+  require 'cosmos/gui/dialogs/progress_dialog'
+  require 'cosmos/tools/handbook_creator/handbook_creator_config'
+end
+
+module Cosmos
+
+  # Creates command and telemetry handbooks from the COSMOS definitions in
+  # both HTML and PDF format.
+  class HandbookCreator < QtTool
+
+    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")
+
+      initialize_actions()
+      initialize_menus()
+      initialize_central_widget()
+      complete_initialize()
+
+      # Bring up slash screen for long duration tasks after creation
+      Splash.execute(self) do |splash|
+        ConfigParser.splash = splash
+        System.commands
+        @config = HandbookCreatorConfig.new(options.config_file)
+        ConfigParser.splash = nil
+      end
+    end
+
+    def initialize_actions
+      super()
+      @hide_ignored_action = Qt::Action.new(tr('&Hide Ignored Items'), self)
+      @hide_ignored_keyseq = Qt::KeySequence.new(tr('Ctrl+H'))
+      @hide_ignored_action.shortcut  = @hide_ignored_keyseq
+      @hide_ignored_action.statusTip = tr('Do not include ignored items in command and telemetry handbooks')
+      @hide_ignored_action.setCheckable(true)
+      @hide_ignored_action.setChecked(false)
+    end
+
+    def initialize_menus
+      # File Menu
+      @file_menu = menuBar.addMenu(tr('&File'))
+      @file_menu.addAction(@hide_ignored_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
+
+    def initialize_central_widget
+      # Create the central widget
+      @central_widget = Qt::Widget.new
+      setCentralWidget(@central_widget)
+
+      @top_layout = Qt::VBoxLayout.new
+
+      @html_button = Qt::PushButton.new(Cosmos.get_icon('html-32.png'), 'Create HTML Handbooks')
+      @html_button.setStyleSheet("text-align:left")
+      @html_button.connect(SIGNAL('clicked()')) do
+        begin
+          @config.create_html(@hide_ignored_action.isChecked)
+          Qt::MessageBox.information(self, 'Done', 'HTML Handbooks created successfully')
+        rescue Exception => err
+          Cosmos.handle_critical_exception(err)
+        end
+      end
+      @top_layout.addWidget(@html_button)
+
+      @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
+        create_pdfs(false, @hide_ignored_action.isChecked)
+      end
+      @top_layout.addWidget(@pdf_button)
+
+      @html_pdf_button = Qt::PushButton.new('Create HTML and PDF Handbooks')
+      @html_pdf_button.setStyleSheet("text-align:left")
+      @html_pdf_button.connect(SIGNAL('clicked()')) do
+        begin
+          @config.create_html(@hide_ignored_action.isChecked)
+          create_pdfs(true, @hide_ignored_action.isChecked)
+        rescue Exception => err
+          Cosmos.handle_critical_exception(err)
+        end
+      end
+      @top_layout.addWidget(@html_pdf_button)
+
+      @open_button = Qt::PushButton.new(Cosmos.get_icon('open_in_browser-32.png'), 'Open in Web Browser')
+      @open_button.setStyleSheet("text-align:left")
+      @open_button.connect(SIGNAL('clicked()')) do
+        begin
+          Cosmos.open_in_web_browser(File.join(System.paths['HANDBOOKS'], @config.pages[0].filename))
+        rescue Exception => err
+          Cosmos.handle_critical_exception(err)
+        end
+      end
+      @top_layout.addWidget(@open_button)
+
+      @central_widget.setLayout(@top_layout)
+    end
+
+    # Runs the application
+    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
+        end
+        super(option_parser, options)
+      end
+    end
+
+  end # class HandbookCreator
+
+end # module Cosmos