rpicsim 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b6af21f7563390039da12c8b89f5680a02cb986
-  data.tar.gz: 1b76b192dcbea43027d5279cebc2f4949c42377d
+  metadata.gz: ffc22a3d36cfe7fe55d2bd971e0e01410e639dcc
+  data.tar.gz: a8589f0756b0cb3fd7fbd9af22727945318414e3
 SHA512:
-  metadata.gz: ac3c2f02ad9039fc16940f436cc35bffe710c028e084f52f23c4b4c81d4d4ead4b982af6032529b4259e2ef39e21d130fecead04486d70b3cdd7cbdc95ee936f
-  data.tar.gz: fedd8d6089a28a1e7395beb446e7a7467778c69c696e3a6e7fffa5eb2910cf15cf370b51f268e49e379b8f33116c88197e1b571ac7778b58b6495c28615c4ff7
+  metadata.gz: 9d5209c814cf043635c779466ba9687246228644a368f6d7bea5d53d4a5944b8f7dbe04f83ee548db9c77b3ec3d1151323350146bf6639105bd6c992a7656195
+  data.tar.gz: c106a56ba5c1ac8932b0563d91f9d38eb03bc3fcfc29349ab90fadc02ffdfd0c837a9ab0e27c59c57a95ef22b01996a598feb6abdc3b0d9eefc5158426db2388

data/docs/ChangeLog.md

@@ -1,6 +1,12 @@
 Change log
 ====
 
+1.1.0
+----
+Released on 2015-07-27.
+
+- Added support for MPLAB X v3.05.
+
 1.0.0
 ----
 Released on 2014-09-17.

data/docs/KnownIssues.md

@@ -57,6 +57,29 @@ _MPLAB X versions affected: all tested versions_
 This issue is tested in `spec/mplab/program_file_spec.rb`.
 
 
+MPLAB X writes log files to the current directory
+----
+_Type: MPLAB X issue_
+
+_MPLAB X versions affected: 2.20 and later_
+
+Starting with MPLAB X v2.20, the MPLAB X code writes log files to the current working directory.
+These files have names that start with "MPLABXLog.xml".
+Unfortunately, these files cannot be deleted from the same Ruby process that runs RPicSim, because MPLAB X keeps handles open to the files and we have not found a way to close those handles.
+
+If you are using Rake to run your specs, you can enhance the spec task so that it removes the files after running the specs:
+
+    # After running specs, clean up the log files that MPLAB X makes.
+    Rake::Task['spec'].enhance do
+      FileUtils.rm Dir.glob 'MPLABXLog.xml*'
+    end
+
+These files are created as soon as the com.microchip.mplab.logger.Logger class is loaded by the JVM.
+It might be possible to replace the implementation of that class in order to avoid creating the files.
+
+This issue is tested in `spec/mplab/log_file_spec.rb`.
+
+
 Cannot detect PIC model from COF file
 ----
 _Type: RPicSim missing feature_
@@ -179,17 +202,18 @@ Midrange ADC gives incorrect readings
 ----
 _Type: MPLAB X bug_
 
-_MPLAB X versions affected: all tested versions_
+_MPLAB X versions affected: 1.85, 1.90, 1.95, 2.00, 2.05, 2.10, 2.15, 2.20_
 
 The simulated ADC for midrange PIC microcontrollers has various issues in different versions of MPLAB X that make it give incorrect readings.
 These issues might affect other PIC architectures as well.
 
-* **Bad modulus:** In MPLAB X 1.90 and later, simply setting a pin to high with `pin.set(true)` will result in an ADC reading of 0.
+* **Bad modulus:** In MPLAB X 1.90 through 2.20, simply setting a pin to high with `pin.set(true)` will result in an ADC reading of 0.
   The workaround is to use `pin.set(4.9)`.
   The ADC acts like it is using a modulus operator incorrectly as a way of limiting the ADC result to be between 0 and 255.
 * **No intermediate values:** In MPLAB X 1.85, setting a pin to any voltage other than 0 V will result in an ADC reading of 255.
 
 These issues are tested in `spec/integration/adc_midrange_spec.rb`.  The bad modulus issue was {http://www.microchip.com/forums/m760886.aspx reported to Microchip} in November 2013.
+The midrange ADC seems to work correctly in MPLAB X 3.05.
 
 
 Variables from XC8 are not correctly identified
@@ -208,4 +232,21 @@ _MPLAB X versions affected: all tested verions_
 Attempting to read from the top (last) byte of program memory will cause an exception because the top address is not considered to be valid.
 For example, you cannot use `program_memory.read_byte(0x7FFF)` on a PIC18F25K50 simulation.
 One workaround is to use `read_word` instead.
-This seems to only affect PIC18 devices.
+This seems to only affect PIC18 devices.
+
+Older versions of MPLAB X do not work with later Java SE Runtime Environments
+----
+
+MPLAB X is based on NetBeans, so older versions of it suffer from [Netbeans bug 229191](https://netbeans.org/bugzilla/show_bug.cgi?id=229191) and will not run properly on the Java SE Runtime Environment 8 or later.  If you try to use an older version of MPLAB X with a newer version of Java, you might get this error:
+
+    java.lang.IllegalStateException: java.lang.IllegalAccessException:
+    Class org.openide.util.WeakListenerImpl$ProxyListener can not access
+    a member of class org.openide.filesystems.$Proxy20 with modifiers "public"
+            at org.openide.util.WeakListenerImpl$ProxyListener.<init>(WeakListenerImpl.java:423)
+    ...
+
+A solution is to download and install the "Java SE Runtime Environment 7u80" from [Oracle](http://www.oracle.com/).
+JRuby uses the JAVA_HOME environment variable to figure out which version of Java to use, so you would set the JAVA_HOME environment variable to point to version 7 for the purposes of running your tests.
+If you are using a shell like Bash, a command like the one below can be used to temporarily set the environment variable for the duration of one command instead of changing it globally for your whole system:
+
+    JAVA_HOME="C:\Program Files\Java\jre7" rspec

data/docs/RSpecIntegration.md

@@ -8,7 +8,7 @@ Most of the example code in this manual assumes that you have the RSpec integrat
 Turning on RSpec integration
 ----
 
-To enable the RSpec integration, simply put this line in your `spec_helper.rb`:
+To load RPicSim and enable its RSpec integration, simply put this line in your `spec_helper.rb`:
 
     !!!ruby
     require 'rpicsim/rspec'
@@ -38,6 +38,9 @@ Alternatively, if you just want a subset of the features described here, you can
     # Better error messages for RSpec 2.x
     require 'rpicsim/rspec/be_predicate'
 
+You will also need to load RPicSim itself by writing:
+
+    require 'rpicsim'
 
 Helper methods
 ----

data/lib/rpicsim/flaws.rb

@@ -49,9 +49,14 @@ module RPicSim
 
     @flaw_hash = {}
 
-    # Returns the {Flaw} with the specified name.
-    # @param name [Symbol] The name of the flaw.  The names are listed in +flaws.rb+.
-    # @return [Flaw]
+    # Returns the effect of the flaw with the specified name for the currently
+    # loaded version of MPLAB X.
+    #
+    # The names and effects are listed in +flaws.rb+.
+    #
+    # The returned value will usually be a boolean, but sometimes a Symbol.
+    #
+    # @param name [Symbol] The name of the flaw.
     def self.[](name)
       @flaw_hash[name].effect Mplab.version
     end
@@ -62,6 +67,18 @@ module RPicSim
       yield flaw
     end
 
+    add(:creates_log_files) do |flaw|
+      flaw.affects_version '1.85', false
+      flaw.affects_version '1.90', false
+      flaw.affects_version '1.95', false
+      flaw.affects_version '2.00', false
+      flaw.affects_version '2.05', false
+      flaw.affects_version '2.10', false
+      flaw.affects_version '2.15', false
+      flaw.affects_version '2.20', true
+      flaw.probably_affects_other_versions true
+    end
+
     add(:writing_tris_affects_output) do |flaw|
       flaw.affects_version '1.85', true
       flaw.affects_version '1.90', true
@@ -86,7 +103,15 @@ module RPicSim
 
     add(:adc_midrange) do |flaw|
       flaw.affects_version '1.85', :no_middle_values
-      flaw.probably_affects_other_versions :bad_modulus
+      flaw.affects_version '1.90', :bad_modulus
+      flaw.affects_version '1.95', :bad_modulus
+      flaw.affects_version '2.00', :bad_modulus
+      flaw.affects_version '2.05', :bad_modulus
+      flaw.affects_version '2.10', :bad_modulus
+      flaw.affects_version '2.15', :bad_modulus
+      flaw.affects_version '2.20', :bad_modulus
+      flaw.affects_version '3.05', false
+      flaw.probably_affects_other_versions false
     end
 
     add(:instruction_inc_is_in_byte_units) do |flaw|

data/lib/rpicsim/mplab/mplab_loader.rb

@@ -19,7 +19,6 @@ module RPicSim::Mplab
           mplablibs/modules/*.jar
           mplablibs/modules/ext/*.jar
           platform/lib/org-openide-util*.jar
-          platform/lib/org-openide-util.jar
           mdbcore/modules/ext/org-openide-filesystems.jar
       }.each do |pattern|
         Dir.glob(jar_dir + pattern).each do |jar_file|
@@ -31,8 +30,10 @@ module RPicSim::Mplab
       # In case MPLAB X was uninstalled and its directory remains, this can provide
       # a useful error message to the user.
       begin
+        org.openide.filesystems.FileObject
         org.openide.util.Lookup
         com.microchip.mplab.mdbcore.simulator.Simulator
+        com.microchip.mplab.mdbcore.platformtool.PlatformToolMetaManager
       rescue NameError
         $stderr.puts "Failed to load MPLAB X classes.\n" +
           "MPLAB X dir: #{dir}\nMPLAB X jar dir: #{jar_dir}\nClass path:\n" + $CLASSPATH.to_a.join("\n") + "\n\n"
@@ -77,7 +78,6 @@ module RPicSim::Mplab
     end
 
     def auto_detect_mplab_dir
-      # Default installation directories for MPLAB X:
       candidates = [
         'C:/Program Files (x86)/Microchip/MPLABX/',  # 64-bit Windows
         'C:/Program Files/Microchip/MPLABX/',        # 32-bit Windows
@@ -86,7 +86,13 @@ module RPicSim::Mplab
       ]
       dir = candidates.find { |d| File.directory?(d) }
       raise cannot_find_mplab_error if !dir
-      dir
+
+      # Some time between 2.20 and 3.05, MPLABX started installing itself into
+      # a subdirectory named after the version, for example "v3.05".  Here we
+      # check for the existence of such subdirectories and use the highest
+      # version of MPLAB X that is available.  If it is not available, we'll
+      # use dir anyway because it might contain an older version of MPLAB X.
+      Dir.glob(dir + 'v?.??').sort.last or dir
     end
 
     def cannot_find_mplab_error

data/lib/rpicsim/mplab/mplab_program_file.rb

@@ -6,7 +6,7 @@ module RPicSim::Mplab
     def initialize(filename, device)
       raise "File does not exist: #{filename}" if !File.exist?(filename)  # Avoid a Java exception.
 
-      if !File.realdirpath(filename).split('/').include?('dist')
+      if !File.realdirpath(filename).split(%r{/|\\}).include?('dist')
         raise 'The file must be inside a directory named dist or else the MCLoader ' \
               'class will throw an exception saying that it cannot find the COF file.'
       end

data/lib/rpicsim/version.rb

@@ -2,5 +2,5 @@
 module RPicSim
   # The version number of this gem, as a string.
   # @return [String]
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -16,48 +16,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rpicsim.rb
-- lib/rpicsim/composite_memory.rb
-- lib/rpicsim/flaws.rb
-- lib/rpicsim/label.rb
-- lib/rpicsim/memory.rb
-- lib/rpicsim/memory_watcher.rb
-- lib/rpicsim/mplab.rb
-- lib/rpicsim/pin.rb
-- lib/rpicsim/program_counter.rb
-- lib/rpicsim/program_file.rb
-- lib/rpicsim/rspec.rb
-- lib/rpicsim/sim.rb
-- lib/rpicsim/stack_pointer.rb
-- lib/rpicsim/stack_trace.rb
-- lib/rpicsim/symbol_set.rb
-- lib/rpicsim/variable.rb
-- lib/rpicsim/variable_set.rb
-- lib/rpicsim/version.rb
-- lib/rpicsim/xc8_sym_file.rb
-- lib/rpicsim/mplab/mplab_assembly.rb
-- lib/rpicsim/mplab/mplab_device_info.rb
-- lib/rpicsim/mplab/mplab_instruction.rb
-- lib/rpicsim/mplab/mplab_loader.rb
-- lib/rpicsim/mplab/mplab_memory.rb
-- lib/rpicsim/mplab/mplab_nmmr_info.rb
-- lib/rpicsim/mplab/mplab_observer.rb
-- lib/rpicsim/mplab/mplab_pin.rb
-- lib/rpicsim/mplab/mplab_processor.rb
-- lib/rpicsim/mplab/mplab_program_file.rb
-- lib/rpicsim/mplab/mplab_register.rb
-- lib/rpicsim/mplab/mplab_sfr_info.rb
-- lib/rpicsim/mplab/mplab_simulator.rb
-- lib/rpicsim/rspec/be_predicate.rb
-- lib/rpicsim/rspec/helpers.rb
-- lib/rpicsim/rspec/persistent_expectations.rb
-- lib/rpicsim/rspec/sim_diagnostics.rb
-- lib/rpicsim/storage/memory_integer.rb
-- lib/rpicsim/storage/register.rb
+- ".yardopts"
+- Gemfile
 - Introduction.md
 - LICENSE.txt
 - README.md
-- Gemfile
 - docs/ChangeLog.md
 - docs/Contributing.md
 - docs/Debugging.md
@@ -75,8 +38,8 @@ files:
 - docs/PersistentExpectations.md
 - docs/Pins.md
 - docs/QuickStartGuide.md
-- docs/RamWatcher.md
 - docs/RSpecIntegration.md
+- docs/RamWatcher.md
 - docs/Running.md
 - docs/Stubbing.md
 - docs/SupportedCompilers.md
@@ -85,7 +48,44 @@ files:
 - docs/SupportedOperatingSystems.md
 - docs/UnitTesting.md
 - docs/Variables.md
-- .yardopts
+- lib/rpicsim.rb
+- lib/rpicsim/composite_memory.rb
+- lib/rpicsim/flaws.rb
+- lib/rpicsim/label.rb
+- lib/rpicsim/memory.rb
+- lib/rpicsim/memory_watcher.rb
+- lib/rpicsim/mplab.rb
+- lib/rpicsim/mplab/mplab_assembly.rb
+- lib/rpicsim/mplab/mplab_device_info.rb
+- lib/rpicsim/mplab/mplab_instruction.rb
+- lib/rpicsim/mplab/mplab_loader.rb
+- lib/rpicsim/mplab/mplab_memory.rb
+- lib/rpicsim/mplab/mplab_nmmr_info.rb
+- lib/rpicsim/mplab/mplab_observer.rb
+- lib/rpicsim/mplab/mplab_pin.rb
+- lib/rpicsim/mplab/mplab_processor.rb
+- lib/rpicsim/mplab/mplab_program_file.rb
+- lib/rpicsim/mplab/mplab_register.rb
+- lib/rpicsim/mplab/mplab_sfr_info.rb
+- lib/rpicsim/mplab/mplab_simulator.rb
+- lib/rpicsim/pin.rb
+- lib/rpicsim/program_counter.rb
+- lib/rpicsim/program_file.rb
+- lib/rpicsim/rspec.rb
+- lib/rpicsim/rspec/be_predicate.rb
+- lib/rpicsim/rspec/helpers.rb
+- lib/rpicsim/rspec/persistent_expectations.rb
+- lib/rpicsim/rspec/sim_diagnostics.rb
+- lib/rpicsim/sim.rb
+- lib/rpicsim/stack_pointer.rb
+- lib/rpicsim/stack_trace.rb
+- lib/rpicsim/storage/memory_integer.rb
+- lib/rpicsim/storage/register.rb
+- lib/rpicsim/symbol_set.rb
+- lib/rpicsim/variable.rb
+- lib/rpicsim/variable_set.rb
+- lib/rpicsim/version.rb
+- lib/rpicsim/xc8_sym_file.rb
 homepage: https://github.com/pololu/rpicsim
 licenses:
 - MIT
@@ -96,19 +96,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2'
 requirements:
 - JRuby
 - MPLAB X
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: RPicSim provides an interface to the MPLAB X PIC simulator that allows you to write simulator-based automated tests of PIC firmware with Ruby and RSpec.