badline 0.12.0 → 0.12.1

data/lib/badline/options/event.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "badline/media/extensions"
+
 module Badline
   class Options
     # One event of --at or --script: what to do, with its argument, once
@@ -23,7 +25,7 @@ module Badline
 
       # What insert takes: disk images, tapes and cartridges, or an .m3u
       # or .vfl list of disks or a directory to mount as device 8.
-      INSERTABLE = %w[.d64 .d71 .d81 .g64 .t64 .tap .crt .m3u .vfl].freeze
+      INSERTABLE = Media::Extensions.of(%i[disk gcr archive tape cartridge disk_list])
 
       attr_reader :frame, :action, :argument
 

data/lib/badline/sid.rb

@@ -119,7 +119,7 @@ module Badline
     # second, for #drain_samples. `filter_chunk` overrides the one the SID
     # was built with, for a machine that built its own. `clock_hz` is the
     # rate the SID's cycles are taken to run at.
-    def record(rate:, filter_chunk: @filter_chunk, clock_hz: TimeOfDay::CLOCK_HZ)
+    def record(rate:, filter_chunk: @filter_chunk, clock_hz: Region::PAL.clock_hz)
       synthesize!
       catch_up
       @filter_chunk = filter_chunk

data/lib/badline/snapshot/machine_state.rb

@@ -19,6 +19,10 @@ module Badline
       MAJOR = 2
       MINOR = 0
 
+      # The values a 64-bit integer holds once encode doubles them, which a
+      # native build's integers can't exceed.
+      VALUES = (-(1 << 62))..((1 << 62) - 1)
+
       module_function
 
       def section(state)
@@ -41,7 +45,11 @@ module Badline
         strings = state.strings
         numbers = [values.length, strings.length]
         strings.each { |string| numbers << string.bytesize }
-        values.each { |value| numbers << (value.negative? ? (-2 * value) - 1 : 2 * value) }
+        values.each do |value|
+          raise RangeError, "#{value} is too large for a snapshot" unless VALUES.cover?(value)
+
+          numbers << (value.negative? ? (-2 * value) - 1 : 2 * value)
+        end
         index = numbers.pack("w*")
         [index.bytesize].pack("V") + index + strings.join
       end

data/lib/badline/snapshot/state.rb

@@ -16,10 +16,11 @@ module Badline
       # fails before anything is read into a machine. Layout 3, without the
       # KERNAL and datasette in the setup, layout 4, without the VIA shift
       # register's clock delay, layout 5, without the board in the setup,
-      # layout 6, without the C128's Z80, and layout 7, without a 1581 on the
-      # serial bus, still read.
-      SCHEMA = 8
-      READABLE = [3, 4, 5, 6, 7, SCHEMA].freeze
+      # layout 6, without the C128's Z80, layout 7, without a 1581 on the
+      # serial bus, and layout 8, with the VIC's unused cycle count and
+      # pending-write flag, still read.
+      SCHEMA = 9
+      READABLE = [3, 4, 5, 6, 7, 8, SCHEMA].freeze
 
       attr_reader :values, :strings
 

data/lib/badline/snapshot.rb

@@ -47,23 +47,25 @@ module Badline
     # applied and left out, yielding a line for each thing left out. A
     # snapshot that fails leaves the machine as it was.
     def restore(computer, path, &) = read(path).restore(computer, &)
+
+    # A machine's snapshots as .vsf files. Computer, Vic20 and C128 each
+    # include it.
+    module Files
+      def save_snapshot(path) = Snapshot.save(self, path)
+
+      def restore_snapshot(path, &) = Snapshot.restore(self, path, &)
+    end
   end
 
   class Computer
-    def save_snapshot(path) = Snapshot.save(self, path)
-
-    def restore_snapshot(path, &) = Snapshot.restore(self, path, &)
+    include Snapshot::Files
   end
 
   class Vic20
-    def save_snapshot(path) = Snapshot.save(self, path)
-
-    def restore_snapshot(path, &) = Snapshot.restore(self, path, &)
+    include Snapshot::Files
   end
 
   class C128
-    def save_snapshot(path) = Snapshot.save(self, path)
-
-    def restore_snapshot(path, &) = Snapshot.restore(self, path, &)
+    include Snapshot::Files
   end
 end

data/lib/badline/storage/d64_image.rb

@@ -20,15 +20,23 @@ module Badline
       # The sides of a disk the image's tracks fill.
       def sides = 1
 
-      def sectors_in(track)
-        case track
-        when 1..17 then 21
-        when 18..24 then 19
-        when 25..30 then 18
-        else 17
-        end
+      # The last track of each of the 1541's speed zones but the innermost,
+      # from the outermost, zone 3, in: tracks 1-17, 18-24 and 25-30, and
+      # zone 0 from 31 on.
+      ZONE_LAST_TRACKS = [17, 24, 30].freeze
+
+      # The sectors a track holds in each zone, by its number.
+      ZONE_SECTORS = [17, 18, 19, 21].freeze
+
+      # The speed zone a track is written in, 3 for the outermost.
+      def self.zone(track)
+        zone = 3
+        zone -= 1 while zone.positive? && track > ZONE_LAST_TRACKS[3 - zone]
+        zone
       end
 
+      def sectors_in(track) = ZONE_SECTORS[D64Image.zone(track)]
+
       private
 
       def error_tables = ERROR_TABLES

data/lib/badline/storage/disk_image/writing.rb

@@ -11,7 +11,7 @@ module Badline
       module Writing
         # Whether the disk takes writes: the image wasn't opened read-only
         # and the host file takes them.
-        def writable? = !read_only? && ::File.writable?(@path)
+        def writable? = !read_only? && File.writable?(@path)
 
         # Writes a new file, or with `replace` writes over the one of the
         # same name in its directory entry. A name already on the disk
@@ -87,7 +87,7 @@ module Badline
           saved = [@bytes.dup, @errors&.dup]
           begin
             yield
-            ::File.binwrite(@path, (@bytes + @errors.to_a).pack("C*"))
+            File.binwrite(@path, (@bytes + @errors.to_a).pack("C*"))
           rescue WriteError, SystemCallError => e
             @bytes, @errors = saved
             raise e.is_a?(WriteError) ? e : WriteError.new(WriteError::WRITE_PROTECT_ON)

data/lib/badline/storage/disk_image.rb

@@ -46,7 +46,7 @@ module Badline
       # path, whether it is write-protected, and its bytes with the error
       # table after them.
       def save_setup(out)
-        out.int(storage_kind).string(::File.expand_path(@path)).boolean(@read_only).blob(@bytes + @errors.to_a)
+        out.int(storage_kind).string(File.expand_path(@path)).boolean(@read_only).blob(@bytes + @errors.to_a)
       end
 
       # A LOAD reads only PRG files. An OPEN names the type it wants, or

data/lib/badline/storage/host_directory.rb

@@ -19,7 +19,7 @@ module Badline
 
       # What Storage.reopen needs to open the directory again.
       def save_setup(out)
-        out.int(HOST_DIRECTORY).string(::File.expand_path(@path))
+        out.int(HOST_DIRECTORY).string(File.expand_path(@path))
       end
 
       def read_file(name, **)

data/lib/badline/storage/t64.rb

@@ -26,7 +26,7 @@ module Badline
       # What Storage.reopen needs to open the archive again: its path and
       # its bytes.
       def save_setup(out)
-        out.int(T64_ARCHIVE).string(::File.expand_path(@path)).blob(@bytes)
+        out.int(T64_ARCHIVE).string(File.expand_path(@path)).blob(@bytes)
       end
 
       def read_file(name, **)

data/lib/badline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Badline
-  VERSION = "0.12.0"
+  VERSION = "0.12.1"
 end

data/lib/badline/vic/bank.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # The 16K window the VIC sees into RAM, selected by CIA2 $DD00, in the
     # bank a +256K picks for it. Character
     # ROM shadows $1000-$1FFF in banks 0 and 2.

data/lib/badline/vic/border_mask.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # Border coverage per 8-pixel group, tracked as the sequencer outputs
     # a line.
     #

data/lib/badline/vic/collisions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # = Sprite collisions
     #
     # The $D01E/$D01F latches and the per-pixel sprite coverage that feeds

data/lib/badline/vic/color_patches.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # A mid-line color register write becomes visible one pixel into the
     # column emitted the cycle after the write. That emit paints the whole
     # column with the new color, so the boundary pixel is patched back to

data/lib/badline/vic/display_state.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # = VIC-II display state
     #
     # The bad line condition, the video counters it drives, and the DMA it

data/lib/badline/vic/graphics_mode.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     module GraphicsMode
       # Foreground masks depend only on the data byte, so each byte maps to a
       # precomputed frozen pattern shared by reference instead of being

data/lib/badline/vic/graphics_shifter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # The graphics shift register, pixel by pixel, for the groups where a
     # mode or XSCROLL change lands (VICE x64sc `draw_graphics`). The
     # sequencer paints whole bytes everywhere else, which comes to the same

data/lib/badline/vic/register_log.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # Mid-line writes to the sprite registers, keyed by the pixel at which
     # they become visible. Compositing replays the line through the log, so
     # each pixel is drawn with the register values that were in effect when

data/lib/badline/vic/registers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # = VIC-II Registers
     #
     # == Sprite positions

data/lib/badline/vic/sequencer.rb

@@ -8,7 +8,7 @@ require "badline/vic/sequencer_output"
 require "badline/vic/sequencer_state"
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # = VIC-II Sequencer
     #
     # Turns fetched graphics data into output pixels.

data/lib/badline/vic/sequencer_output.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sequencer
       # Writes a column's 8-pixel group into the line buffers, through the
       # main border flip-flop and XSCROLL.

data/lib/badline/vic/sequencer_state.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sequencer
       # The sequencer's save_state and load_state.
       module SavedState

data/lib/badline/vic/sprite/internal_bus.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprite
       # = InternalBus
       #

data/lib/badline/vic/sprite/saved_state.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprite
       # The sprite's save_state and load_state.
       module SavedState

data/lib/badline/vic/sprite/shifter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprite
       # The X comparator and the 24-bit shift register behind it: where a
       # line fires the sprite, and the pixels each firing shifts out.

data/lib/badline/vic/sprite/timing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprite
       # = Timing
       #

data/lib/badline/vic/sprite.rb

@@ -6,7 +6,7 @@ require "badline/vic/sprite/saved_state"
 require "badline/vic/sprite/timing"
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     # = Sprite
     #
     # The DMA/display state machine and the pixel sequencer for one sprite.

data/lib/badline/vic/sprites.rb

@@ -6,7 +6,7 @@ require "badline/vic/sprite"
 require "badline/vic/sprites_state"
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprites
       include SavedState
 

data/lib/badline/vic/sprites_state.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     class Sprites
       # The sprites' save_state and load_state.
       module SavedState

data/lib/badline/vic.rb

@@ -7,7 +7,7 @@ require "badline/vic/sequencer"
 require "badline/vic/sprites"
 
 module Badline
-  class VIC < Cycleable
+  class VIC
     include Addressable
     include IntegerHelper
 
@@ -145,7 +145,6 @@ module Badline
       @render = true
 
       power_on!
-      super()
     end
 
     # The VIC has no reset pin, so only a power cycle brings back the
@@ -192,7 +191,7 @@ module Badline
     # a front end repaints.
     def save_state(out)
       out.marker("VIC")
-      out.int(@column).int(@rasterline).int(@cycles).boolean(@pending_write)
+      out.int(@column).int(@rasterline)
       out.int(@g_tick).ints(@g_kind).int(@g_kept_char).int(@g_kept_color).boolean(@g_display)
       out.int(@fetch_d011).boolean(@lp_triggered).boolean(@lp_low).boolean(@raster_match)
       out.int(@vic_bank.lines)
@@ -469,8 +468,10 @@ module Badline
     def load_beam(input)
       @column = input.int
       @rasterline = @output_line = input.int
-      @cycles = input.int
-      @pending_write = input.boolean?
+      if input.schema < 9
+        input.int
+        input.boolean?
+      end
       @g_tick = input.int
       input.ints_into(@g_kind)
       @g_kept_char = input.int

data/lib/badline/vic20/attachments.rb

@@ -3,10 +3,12 @@
 module Badline
   class Vic20
     # What plugs into the VIC-20 besides its chips: cartridge ROM in the
-    # expansion blocks, the disk device 8 serves through the KERNAL traps,
-    # and a true 1541 or 1581 on the serial bus.
+    # expansion blocks, the disk device 8 serves through the KERNAL traps
+    # (Computer::KernalTraps), and a true 1541 or 1581 on the serial bus
+    # (Computer::TrueDrives).
     module Attachments
-      include Drive1581::Slot
+      include Computer::TrueDrives
+      include Computer::KernalTraps
 
       # The cycle by which a 1541 switched on with the machine has run its
       # DOS's reset, the RAM test and the ROM checksum, and waits on the
@@ -27,90 +29,18 @@ module Badline
         power_cycle!
       end
 
-      # Puts the storage in device 8. Mounting again swaps the disk at any
-      # point while the machine runs: the drive keeps its RAM and its
-      # status.
-      def mount(storage)
-        return @drive.insert(storage) if @drive
-
-        @drive = KernalTrap::Drive.new(storage)
-        layout = KernalTrap::VIC20_LAYOUT
-        load_trap = KernalTrap::Load.new(cpu:, bus:, layout:, drive: @drive)
-        cpu.install_trap(layout.load) { load_trap.call }
-        @serial_trap = KernalTrap::Serial.new(cpu:, bus:, layout:, drive: @drive, device: serial_trap_device).install
-        save_trap = @save_trap = KernalTrap::Save.new(cpu:, bus:, layout:, drive: @drive)
-        cpu.install_trap(layout.save) { save_trap.call }
-      end
-
-      # Takes device 8's mounted storage out, and with it the LOAD, SAVE and
-      # serial traps, so the KERNAL's routines go out over the serial bus.
-      # Mounting again starts a new drive, with its RAM cleared.
-      def unmount
-        return unless @drive
+      private
 
-        cpu.remove_trap(KernalTrap::VIC20_LAYOUT.load)
-        cpu.remove_trap(KernalTrap::VIC20_LAYOUT.save)
-        @serial_trap.uninstall
-        @serial_trap = nil
-        @save_trap = nil
-        @drive = nil
-      end
+      # The VIC-20's KERNAL, which the traps stand in for.
+      def trap_layout = KernalTrap::VIC20_LAYOUT
 
-      # Whether device 8 serves a disk or directory through the traps.
-      def mounted? = !@drive.nil?
+      def trap_bus = @bus
 
-      # Plugs in a Drive1541, which then runs alongside the VIC-20 on its own
-      # clock and talks to it over the serial bus. The serial traps stop
-      # answering the drive's device number, so the KERNAL's TALK, LISTEN
-      # and byte transfers reach the drive. The LOAD and SAVE traps stay,
-      # and still serve a mounted image.
-      #
       # A drive that powers on with the machine takes longer to boot than
       # the KERNAL, and doesn't answer the bus until it has, so the
       # machine's on_init handlers wait for it too.
-      def attach_drive1541(drive)
+      def drive1541_attached
         @init_threshold = [@init_threshold, DRIVE_BOOT_CYCLES].max if @cycles < @init_threshold
-        @iec_bus.detach(@drive1541) if @drive1541
-        drive.host_clock_hz = timing.clock_hz
-        @drive1541 = drive
-        drive.connect(@iec_bus)
-        @serial_trap&.device = serial_trap_device
-      end
-
-      # The true drive on the serial bus: the Drive1581 ahead of the
-      # Drive1541, or nil.
-      def true_drive = @drive1581 || @drive1541
-
-      # Plugs a Drive1541 in as device 8, in place of a 1581 there, and
-      # returns it.
-      def plug_true_drive
-        detach_drive1581 if drive1581_on_device8?
-        Drive1541.new.tap { |drive| attach_drive1541(drive) }
-      end
-
-      # Unplugs the Drive1541, leaving the serial bus with nothing on it.
-      def detach_drive1541
-        return unless @drive1541
-
-        @iec_bus.detach(@drive1541)
-        @drive1541 = nil
-        @serial_trap&.device = serial_trap_device
-      end
-
-      # Records what the KERNAL prints through CHROUT (ChroutTrap).
-      def capture_output
-        @capture_output ||= ChroutTrap.new(cpu:, bus:, layout: KernalTrap::VIC20_LAYOUT).tap do |trap|
-          cpu.install_trap(ChroutTrap::ADDRESS) { trap.call }
-        end
-      end
-
-      private
-
-      # The device number the serial traps answer: device 8, unless a true
-      # drive is on the bus as device 8.
-      def serial_trap_device
-        device = KernalTrap::Routine::DEVICE
-        @drive1541&.device == device || drive1581_on_device8? ? nil : device
       end
 
       # A 1581 plugged in, as a 1541 does, holds the machine's on_init

data/lib/badline/vic20/saved_state.rb

@@ -105,27 +105,6 @@ module Badline
 
       private
 
-      # The disk device 8 serves through the traps, with its channels.
-      def save_trap_drive(out)
-        out.boolean(!@drive.nil?)
-        return unless @drive
-
-        @drive.save_state(out)
-        @serial_trap.save_state(out)
-        @save_trap.save_state(out)
-      end
-
-      def load_trap_drive(input)
-        return unmount unless input.boolean?
-
-        storage = Storage.reopen(input)
-        unmount
-        mount(storage)
-        @drive.load_state(input)
-        @serial_trap.load_state(input)
-        @save_trap.load_state(input)
-      end
-
       # A true 1541 on the serial bus, with its device number.
       def save_drive1541(out)
         out.boolean(!@drive1541.nil?)
@@ -135,15 +114,6 @@ module Badline
         @drive1541.save_state(out)
       end
 
-      def load_drive1541(input)
-        return detach_drive1541 unless input.boolean?
-
-        device = input.int
-        detach_drive1541 if @drive1541 && @drive1541.device != device
-        attach_drive1541(Drive1541.new(device:)) unless @drive1541
-        @drive1541.load_state(input)
-      end
-
       def check_ram(ram)
         return if ram == @ram_configuration
 

data/lib/badline/vic20.rb

@@ -23,6 +23,7 @@ module Badline
   class Vic20
     include IntegerHelper
     include KeyboardBuffer
+    include Machine::Clocking
     include Attachments
     include PortWiring
     include SavedState
@@ -33,10 +34,6 @@ module Badline
     # The RAM expansion it was built with, a key of Bus::RAM_CONFIGURATIONS.
     attr_reader :ram_configuration
 
-    # The path of the disk or directory device 8 serves through the traps
-    # (Attachments), or an empty one.
-    def mounted_path = @drive.nil? ? "" : @drive.path
-
     def ram = @bus.ram
 
     def family = :vic20
@@ -100,31 +97,6 @@ module Badline
       @cycles += 1
     end
 
-    # Runs `count` cycles, one #cycle! after another.
-    def run_cycles(count)
-      i = 0
-      while i < count
-        cycle!
-        i += 1
-      end
-    end
-
-    # Runs cycles until the block returns true or the cycle count passes
-    # `limit`, checking before each cycle.
-    def run_until(limit)
-      cycle! until yield || @cycles > limit
-    end
-
-    # Runs the block once the KERNAL has booted (see init_threshold), or
-    # now if it has.
-    def on_init(&block)
-      if @cycles < @init_threshold
-        @init_handlers << block
-      else
-        block.call
-      end
-    end
-
     # The chip whose #display a front end shows.
     def video = @vic
 
@@ -192,10 +164,6 @@ module Badline
       reset!
     end
 
-    def inspect
-      "#<#{self.class.name} cycles=#{@cycles} cpu=(#{@cpu.inspect})>"
-    end
-
     private
 
     # The cycle by which the KERNAL has booted and BASIC printed READY,
@@ -215,9 +183,5 @@ module Badline
       @cpu.nmi = true if nmi && !@nmi_asserted
       @nmi_asserted = nmi
     end
-
-    def handle_init
-      @init_handlers.each(&:call)
-    end
   end
 end