cosmos 4.0.3-java

data/lib/cosmos/gui/dialogs/details_dialog.rb

@@ -0,0 +1,190 @@
+# 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/gui/qt'
+require 'cosmos/script'
+
+module Cosmos
+  # Creates a dialog showing the details about a given command or telemetry
+  # item. This class is a base class and should not be instantiated. Use
+  # CmdDetailsDialog or TlmDetailsDialog.
+  class DetailsDialog < Qt::Dialog
+    # @return [Array<DetailsDialog>] Instances of the details dialog
+    @@instances = []
+
+    # @param parent [Qt::Dialog] Parent for the dialog
+    # @param target_name [String] Name of the target
+    # @param packet_name [String] Name of the packet
+    # @param item_name [String] Name of the item
+    def initialize(parent, target_name, packet_name, item_name)
+      super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
+
+      @target_name = target_name
+      @packet_name = packet_name
+      @item_name = item_name
+      @limits_layout = nil
+      @limits_labels = {}
+
+      @@instances << self
+    end
+
+    protected
+
+    # Creates and populates the layout for the dialog
+    def build_details_layout(item, cmd_tlm)
+      details_layout = Qt::FormLayout.new
+      details_layout.addRow("Bit Offset:", Qt::Label.new(tr("#{show_nil(item.bit_offset)}")))
+      details_layout.addRow("Bit Size:", Qt::Label.new(tr("#{show_nil(item.bit_size)}")))
+      details_layout.addRow("Data Type:", Qt::Label.new(tr("#{show_data_type(item.data_type)}")))
+      details_layout.addRow("Array Size:", Qt::Label.new(tr("#{show_nil(item.array_size)}")))
+      if cmd_tlm == :CMD
+        if item.range
+          details_layout.addRow("Minimum:", Qt::Label.new(tr(item.range.first.to_s)))
+          details_layout.addRow("Maximum:", Qt::Label.new(tr(item.range.last.to_s)))
+        end
+        details_layout.addRow("Default:", Qt::Label.new(tr("#{show_nil(item.default)}"))) if item.default
+      end
+      details_layout.addRow("Format String:", Qt::Label.new(tr("#{show_nil(item.format_string)}")))
+      details_layout.addRow("Read_Conversion:", Qt::Label.new(tr("#{show_conversion(item.read_conversion)}")))
+      details_layout.addRow("Write_Conversion:", Qt::Label.new(tr("#{show_conversion(item.write_conversion)}")))
+      details_layout.addRow("Id Value:", Qt::Label.new(tr("#{show_nil(item.id_value)}")))
+      details_layout.addRow("Description:", Qt::Label.new(tr("#{show_nil(item.description)}")))
+      details_layout.addRow("Units Full:", Qt::Label.new(tr("#{show_nil(item.units_full)}")))
+      details_layout.addRow("Units Abbreviation:", Qt::Label.new(tr("#{show_nil(item.units)}")))
+      details_layout.addRow("Endianness:", Qt::Label.new(tr("#{show_endianness(item.endianness)}")))
+      if item.states
+        details_layout.addRow(build_states_details(item))
+      else
+        details_layout.addRow("States:", Qt::Label.new(tr("None")))
+      end
+      if cmd_tlm == :CMD
+        details_layout.addRow("Required:", Qt::Label.new(tr(item.required.to_s)))
+      else
+        limits = item.limits.values
+        if limits
+          details_layout.addRow(build_limits_details(limits))
+        else
+          details_layout.addRow(tr("Limits:"), Qt::Label.new("None"))
+        end
+        if limits || item.state_colors
+          details_layout.addRow(tr("Limits Checking Enabled:"), Qt::Label.new(tr("#{show_nil(item.limits.enabled)}")))
+        end
+        if limits
+          details_layout.addRow(tr("Limits Persistence Setting:"), Qt::Label.new(tr("#{show_nil(item.limits.persistence_setting)}")))
+          details_layout.addRow(tr("Limits Persistence Count:"), Qt::Label.new(tr("#{show_nil(item.limits.persistence_count)}")))
+        end
+        if item.meta.empty?
+          details_layout.addRow(tr("Meta:"), Qt::Label.new("None"))
+        else
+          item.meta.each do |key, value|
+            details_layout.addRow(tr("Meta[#{key}]:"), Qt::Label.new(value.to_s))
+          end
+        end
+      end
+      details_layout
+    end
+
+    # Create the states details layout
+    def build_states_details(item)
+      states_details = Qt::GroupBox.new(tr("States"))
+      scroll_layout = Qt::VBoxLayout.new
+      states_details.setLayout(scroll_layout)
+      scroll_area = Qt::ScrollArea.new
+      scroll_area.setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff)
+      scroll_layout.addWidget(scroll_area)
+      scroll_widget = Qt::Widget.new
+      scroll_area.setWidget(scroll_widget)
+      states_layout = Qt::FormLayout.new
+      scroll_widget.setLayout(states_layout)
+      item.states.sort {|a, b| a[1] <=> b[1]}.each do |state_name, state_value|
+        if item.state_colors
+          states_layout.addRow(tr("#{state_name}:"), Qt::Label.new(tr("#{state_value} #{item.state_colors[state_name]}")))
+        else
+          states_layout.addRow(tr("#{state_name}:"), Qt::Label.new(tr("#{state_value}")))
+        end
+      end
+      # Figure out the how big the states layout wants to be and set the
+      # scroll area to this height if possible. Otherwise limit it to 200px.
+      if states_layout.minimumSize.height > 200
+        scroll_area.setMinimumHeight(200)
+      else
+        scroll_area.setMinimumHeight(states_layout.minimumSize.height + 5)
+      end
+      scroll_widget.adjustSize
+      states_details
+    end
+
+    # Create the limits details layout
+    def build_limits_details(limits)
+      limits_details = Qt::GroupBox.new(tr("Limits"))
+      @limits_layout = Qt::FormLayout.new
+      limits.each do |limits_set_name, limits_settings|
+        if limits_settings[4] && limits_settings[5]
+          label = Qt::Label.new("RL/#{limits_settings[0]} YL/#{limits_settings[1]} YH/#{limits_settings[2]} RH/#{limits_settings[3]} GL/#{limits_settings[4]} GH/#{limits_settings[5]}")
+        else
+          label = Qt::Label.new("RL/#{limits_settings[0]} YL/#{limits_settings[1]} YH/#{limits_settings[2]} RH/#{limits_settings[3]}")
+        end
+        @limits_labels[limits_set_name] = label
+        @limits_layout.addRow(tr("#{limits_set_name}:"), label)
+      end
+      limits_details.setLayout(@limits_layout)
+      limits_details
+    end
+
+    def show_nil(object, show_as = 'nil')
+      if object.nil?
+        return show_as
+      else
+        return object
+      end
+    end
+
+    def show_data_type(data_type)
+      case data_type
+      when nil
+        return 'nil'
+      when :INT, :UINT, :FLOAT, :STRING, :BLOCK, :DERIVED
+        return data_type.to_s
+      else
+        return "INVALID (#{data_type})"
+      end
+    end
+
+    def show_endianness(endianness)
+      case endianness
+      when :BIG_ENDIAN
+        return 'BIG_ENDIAN'
+      else
+        return 'LITTLE_ENDIAN'
+      end
+    end
+
+    def show_conversion(object)
+      if object.nil?
+        return 'nil'
+      else
+        return object.to_s
+      end
+    end
+
+    def reject
+      super()
+      @@instances.delete(self)
+      self.dispose
+    end
+
+    def closeEvent(event)
+      super(event)
+      @@instances.delete(self)
+      self.dispose
+    end
+  end
+end

data/lib/cosmos/gui/dialogs/exception_dialog.rb

@@ -0,0 +1,106 @@
+# 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
+
+# This file contains the implementation of the ExceptionDialog class.   This class
+# is used to display an exception window
+
+require 'cosmos'
+require 'cosmos/gui/qt'
+
+module Cosmos
+  # Creates a dialog to display a COSMOS exception to the user. The dialog can
+  # close the application and log the exception. This is the primary dialog to
+  # display when something goes unexpectedly wrong.
+  class ExceptionDialog
+    # @return [Mutex] Mutex to make this dialog single threaded
+    @@mutex = Mutex.new
+
+    # @param parent [Qt::Dialog] Parent of this dialog
+    # @param exception [Exception] Ruby Exception to display details about
+    # @param title [String] Title of the dialog
+    # @param exit_afterwards [Boolean] Whether to completely exit the
+    #   application after displaying the dialog. Useful for fatal exceptions.
+    # @param log_exception [Boolean] Whether to create an exception log file
+    # @param log_file [String] Name of the log file to create
+    def initialize(parent, exception, title = 'COSMOS Exception', exit_afterwards = true, log_exception = true, log_file = nil)
+      return unless @@mutex.try_lock
+
+      unless exception.class == SystemExit || exception.class == Interrupt
+        # ConfigParser::Errors are configuration user errors. We don't want to clutter
+        # up list of real exceptions with user configuration errors.
+        # Same goes for FatalErrors
+        unless exception.class == ConfigParser::Error || exception.class == FatalError
+          log_file = Cosmos.write_exception_file(exception) if log_exception
+        end
+
+        if Qt::CoreApplication.instance
+          msg = Qt::MessageBox.new(parent)
+          msg.setWindowTitle(title)
+          msg.setTextFormat(Qt::RichText)
+          msg.setIcon(Qt::MessageBox::Critical)
+          case exception
+          # ConfigParser::Errors are a special case generated with a known format
+          # by the ConfigParser
+          when ConfigParser::Error
+            # Substitute the html tags '<' and '>' and then replace newlines with html breaks
+            usage = exception.usage.gsub("<", "&#060;").gsub(">", "&#062;").gsub("\n", "<br/>")
+            message = exception.message.gsub("<", "&#060;").gsub(">", "&#062;").gsub("\n", "<br/>")
+            line = exception.keyword + ' ' + exception.parameters.join(' ').gsub("<", "&#060;").gsub(">", "&#062;").gsub("\n", "<br/>")
+            text = "Error at #{exception.filename}:#{exception.line_number}<br/><br/>#{line}<br/><br/>Usage: #{usage}<br/><br/>#{message}"
+            unless exception.url.nil?
+              text << "<br/><br/>For more information see <a href='#{exception.url}'>#{exception.url}</a>."
+            end
+          # FatalErrors are errors explicitly raised when a known fatal issue
+          # occurs. Since it is a known issue we don't put up the full error
+          # dialog.
+          when FatalError
+            text = "Error: #{exception.message.gsub("\n", "<br/>")}"
+          else
+            file_contents = ""
+            # First read the log_file we wrote out to the logs directory
+            # Change newlines to %0A for Outlook and remove all quotes to avoid breaking the link
+            begin
+              message = exception.message.gsub("\n", "<br/>")
+              file_contents = File.read(log_file).gsub("\n", "%0A").gsub("'", "").gsub("\"", "") if log_file
+            rescue
+            end
+            text = "The following error occurred:<br/>#{message}"
+            text << "<br/><br/>Please contact your local COSMOS expert.<br/><br/>This error has been logged:<br/>#{log_file}<br/><br/> <a href='mailto:rmelton@ball.com;jmthomas@ball.com?subject=COSMOS exception&body=#{file_contents}'>Click here</a> to email this log to the COSMOS developers." if log_file
+          end
+          text << "<br/><br/>NOTE!: The application will exit once you accept or dismiss this dialog!" if exit_afterwards
+          msg.setText(text)
+          if log_file
+            open_button = Qt::PushButton.new("Open Exception Log in Text Editor")
+            open_button.connect(SIGNAL('clicked()')) do
+              Cosmos.open_in_text_editor(log_file)
+              sleep(2)
+            end
+            msg.addButton(open_button, Qt::MessageBox::ResetRole)
+          end
+          close_button = Qt::PushButton.new("Close")
+          msg.addButton(close_button, Qt::MessageBox::ActionRole)
+          msg.raise
+          msg.exec
+          msg.dispose
+        end # if Qt::CoreApplication.instance
+      end #  unless exception.class == SystemExit or exception.class == Interrupt
+      @@mutex.unlock
+      if exit_afterwards
+        Qt::CoreApplication.instance.exit(1) if Qt::CoreApplication.instance
+        exit 1 # incase CoreApplication doesn't exit yet or didn't complete the exit
+      end
+    end # def initialize
+
+    # @return [Boolean] Whether this dialog has already been instantiated
+    def self.dialog_open?
+      @@mutex.locked?
+    end
+  end
+end

data/lib/cosmos/gui/dialogs/exception_list_dialog.rb

@@ -0,0 +1,60 @@
+# 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
+
+# This file contains the implementation of the ExceptionListDialog class.   This class
+# provides a dialog box to show a list of exceptions.
+
+require 'cosmos'
+require 'cosmos/gui/qt'
+require 'cosmos/gui/dialogs/exception_dialog'
+
+module Cosmos
+  # Displays a list of exceptions in a dialog box. Clicking on any of the
+  # exceptions creates a new ExceptionDialog which shows the details.
+  class ExceptionListDialog < Qt::Dialog
+    # @param message [String] Text to display in the dialog
+    # @param exception_list [Array<Exception>] Array of exceptions to display
+    # @param title [String] Dialog title
+    # @param parent [Qt::Widget] Parent for this dialog
+    def initialize(message, exception_list, title = 'COSMOS Exception List', parent = Qt::CoreApplication.instance.activeWindow)
+      super(parent)
+      self.window_title = title
+      layout = Qt::VBoxLayout.new
+      self.layout = layout
+
+      @exception_list = exception_list
+
+      layout.addWidget(Qt::Label.new(message))
+
+      @list = Qt::ListWidget.new
+      @exception_list.each_with_index do |exception, index|
+        string = "#{index + 1}. #{exception.class} : #{exception.message}"
+        Qt::ListWidgetItem.new(tr(string), @list)
+      end
+      layout.addWidget(@list)
+      @list.connect(SIGNAL('itemSelectionChanged ()')) do
+        ExceptionDialog.new(self, @exception_list[@list.currentRow], title, false)
+      end
+
+      ok_button = Qt::PushButton.new('Ok')
+      connect(ok_button, SIGNAL('clicked()'), self, SLOT('accept()'))
+      layout.addWidget(ok_button, 0, Qt::AlignCenter)
+
+      # Constrain the maximum size in case the list is huge
+      setMaximumSize(800, 600)
+      # Ideally we resize to show the entire list
+      resize(@list.width, @list.height)
+
+      self.raise
+      exec()
+      dispose()
+    end
+  end
+end

data/lib/cosmos/gui/dialogs/find_replace_dialog.rb

@@ -0,0 +1,272 @@
+# 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/gui/qt'
+require 'singleton'
+
+module Cosmos
+  # Provides a Qt::Dialog which implements Find and optionally Replace
+  # functionality for a Qt::PlainTextEdit.
+  class FindReplaceDialog < Qt::Dialog
+    include Singleton
+
+    # (see #show_find)
+    def self.show_find(parent)
+      self.instance.show_find(parent)
+    end
+    # Displays a Find dialog
+    # @param parent [Qt::Widget] Dialog parent which must implement a
+    #   search_text method which returns a String to search on
+    def show_find(parent)
+      @parent = parent
+      disable_replace
+      show_dialog
+    end
+
+    # (see #show_replace)
+    def self.show_replace(parent)
+      self.instance.show_replace(parent)
+    end
+    # Displays a Find/Replace dialog
+    # @param parent [Qt::Widget] Dialog parent which must implement a
+    #   search_text method which returns a String to search on
+    def show_replace(parent)
+      @parent = parent
+      enable_replace
+      show_dialog
+    end
+
+    # (see #find_next)
+    def self.find_next(parent)
+      self.instance.find_next(parent)
+    end
+    # Finds the next instance of the search term
+    # @param parent [#search_text] Object which must implement a
+    #   search_text method which returns a String to search on
+    def find_next(parent)
+      flags = find_flags()
+      flags &= ~Qt::TextDocument::FindBackward.to_i
+      found = parent.search_text.find(find_text(), flags)
+      if !found && wrap_around?
+        cursor = parent.search_text.textCursor
+        cursor.movePosition(Qt::TextCursor::Start)
+        parent.search_text.setTextCursor(cursor)
+        parent.search_text.find(find_text(), flags)
+      end
+    end
+
+    # (see #find_previous)
+    def self.find_previous(parent)
+      self.instance.find_previous(parent)
+    end
+    # Finds the previous instance of the search term
+    # @param parent [#search_text] Object which must implement a
+    #   search_text method which returns a String to search on
+    def find_previous(parent)
+      flags = find_flags()
+      flags |= Qt::TextDocument::FindBackward.to_i
+      found = parent.search_text.find(find_text(), flags)
+      if !found && wrap_around?
+        cursor = parent.search_text.textCursor
+        cursor.movePosition(Qt::TextCursor::End)
+        parent.search_text.setTextCursor(cursor)
+        parent.search_text.find(find_text(), flags)
+      end
+    end
+
+    private
+
+    def initialize
+      # The dialog will be re-parented when shown so pass nil
+      super(nil, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
+      # Items which are only valid in a Replace dialog
+      @replace_items = []
+
+      layout = Qt::HBoxLayout.new
+      left_side = Qt::VBoxLayout.new
+      left_side.addLayout(create_input_layout)
+      left_side.addLayout(create_options_layout)
+      layout.addLayout(left_side)
+      layout.addLayout(create_button_layout)
+
+      setLayout(layout)
+    end
+
+    def create_input_layout
+      input_layout = Qt::FormLayout.new
+      @find_box = Qt::LineEdit.new
+      input_layout.addRow(tr("Fi&nd what:"), @find_box)
+      @replace_box = Qt::LineEdit.new
+      replace_label = Qt::Label.new(tr("Re&place with:"))
+      replace_label.setBuddy(@replace_box)
+      @replace_items << replace_label
+      input_layout.addRow(replace_label, @replace_box)
+      @replace_items << @replace_box
+      input_layout
+    end
+
+    def create_options_layout
+      options_layout = Qt::HBoxLayout.new
+      options_layout.addLayout(create_checkbox_layout)
+      options_layout.addWidget(create_direction_widget)
+      options_layout
+    end
+
+    def create_checkbox_layout
+      checkbox_layout = Qt::VBoxLayout.new
+      @match_whole_word = Qt::CheckBox.new("Match &whole word only")
+      checkbox_layout.addWidget(@match_whole_word)
+      @match_case = Qt::CheckBox.new("Match &case")
+      checkbox_layout.addWidget(@match_case)
+      @wrap_around = Qt::CheckBox.new("Wrap ar&ound")
+      @wrap_around.setChecked(true)
+      checkbox_layout.addWidget(@wrap_around)
+      checkbox_layout.addStretch
+      checkbox_layout
+    end
+
+    def create_direction_widget
+      @up = Qt::RadioButton.new("&Up")
+      down = Qt::RadioButton.new("&Down")
+      down.setChecked(true)
+      direction_layout = Qt::VBoxLayout.new
+      direction_layout.addWidget(@up)
+      direction_layout.addWidget(down)
+      direction_layout.addStretch
+      direction = Qt::GroupBox.new(tr("Direction"))
+      direction.setLayout(direction_layout)
+      direction
+    end
+
+    def create_button_layout
+      find_next = Qt::PushButton.new("&Find Next")
+      find_next.setDefault(true)
+      find_next.connect(SIGNAL('clicked()')) { handle_find_next }
+      cancel = Qt::PushButton.new("Cancel")
+      cancel.connect(SIGNAL('clicked()')) { reject }
+      replace = Qt::PushButton.new("&Replace")
+      replace.connect(SIGNAL('clicked()')) { handle_replace }
+      @replace_items << replace
+      replace_all = Qt::PushButton.new("Replace &All")
+      replace_all.connect(SIGNAL('clicked()')) { handle_replace_all }
+      @replace_items << replace_all
+
+      button_layout = Qt::VBoxLayout.new
+      button_layout.addWidget(find_next)
+      button_layout.addWidget(replace)
+      button_layout.addWidget(replace_all)
+      button_layout.addWidget(cancel)
+      button_layout.addStretch
+      button_layout
+    end
+
+    def show_dialog
+      @find_box.selectAll
+      @find_box.setFocus(Qt::PopupFocusReason)
+      setParent(@parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint | 3)
+      show()
+    end
+
+    def enable_replace
+      @replace_items.each {|item| item.show }
+      setWindowTitle('Replace')
+    end
+
+    def disable_replace
+      @replace_items.each {|item| item.hide }
+      setWindowTitle('Find')
+    end
+
+    def find_flags
+      flags = 0
+      flags |= Qt::TextDocument::FindBackward.to_i if @up.isChecked
+      flags |= Qt::TextDocument::FindCaseSensitively.to_i if @match_case.isChecked
+      flags |= Qt::TextDocument::FindWholeWords.to_i if @match_whole_word.isChecked
+      flags
+    end
+
+    def wrap_around?
+      @wrap_around.isChecked
+    end
+
+    def find_up?
+      @up.isChecked
+    end
+
+    def find_text
+      @find_box.text
+    end
+
+    def replace_text
+      @replace_box.text
+    end
+
+    def handle_find_next
+      text = @parent.search_text
+      found = text.find(find_text, find_flags)
+      if !found && wrap_around?
+        cursor = text.textCursor
+        if find_up?
+          cursor.movePosition(Qt::TextCursor::End)
+        else
+          cursor.movePosition(Qt::TextCursor::Start)
+        end
+        text.setTextCursor(cursor)
+        text.find(find_text, find_flags)
+      end
+    end
+
+    def handle_replace
+      text = @parent.search_text
+      if text.textCursor.hasSelection &&
+        text.textCursor.selectedText == find_text
+        found = true
+      else
+        found = text.find(find_text, find_flags)
+        if !found && wrap_around?
+          cursor = text.textCursor
+          if find_up?
+            cursor.movePosition(Qt::TextCursor::End)
+          else
+            cursor.movePosition(Qt::TextCursor::Start)
+          end
+          text.setTextCursor(cursor)
+          found = text.find(find_text, find_flags)
+        end
+      end
+      if found
+        cursor = text.textCursor
+        cursor.removeSelectedText
+        position = cursor.position
+        cursor.insertText(replace_text)
+        # Move the cursor back over the inserted text to select it
+        cursor.movePosition(Qt::TextCursor::PreviousCharacter, Qt::TextCursor::KeepAnchor, replace_text.length)
+        text.setTextCursor(cursor)
+      end
+    end
+
+    def handle_replace_all
+      text = @parent.search_text
+      cursor = text.textCursor
+      # Start the edit block so this can be all undone with a single undo step
+      cursor.beginEditBlock
+
+      cursor.movePosition(Qt::TextCursor::Start)
+      text.setTextCursor(cursor)
+
+      while (text.find(find_text, find_flags) == true)
+        text.textCursor.removeSelectedText
+        text.textCursor.insertText(replace_text)
+      end
+      cursor.endEditBlock
+    end
+  end # class FindReplaceDialog
+end # module Cosmos