badline 0.7.0 → 0.8.0

data/lib/badline/media/disk_set.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Badline
+  module Media
+    # The disks of a set a disk image belongs to, found by name in its
+    # folder: images whose names differ only in their disk, side or part
+    # markers, such as "Disk 1", "Side B", "d2", "(Disk 1 of 3)", ordered
+    # by those markers. A name with no marker can end in a number or a
+    # letter, as in game_1.d64 and game_2.d64, which counts only when the
+    # folder has the first of the set too.
+    module DiskSet
+      KINDS = %w[disk disc side part].freeze
+      EXTENSIONS = %w[.d64 .d71 .d81 .g64].freeze
+
+      # The paths of the set's disks in order, or just `path` when it
+      # belongs to none.
+      def self.around(path)
+        extension = File.extname(path).downcase
+        return [path] unless EXTENSIONS.include?(extension)
+
+        marked = !parse(stem(path))[1].negative?
+        base = key(stem(path), marked)[0]
+        found = siblings(File.dirname(path), extension, base, marked)
+        return [path] if found.size < 2 || (!marked && found.none? { |pair| pair[0] == 1 })
+
+        found.sort_by { |pair| pair[0] }.map { |pair| File.join(File.dirname(path), pair[1]) }
+      end
+
+      # The name's words without their markers, joined, and the order the
+      # markers give it, -1 for none.
+      def self.parse(stem)
+        words = words(stem)
+        base = []
+        values = []
+        index = 0
+        index = take(words, index, base, values) while index < words.size
+        [base.join(" "), order(values)]
+      end
+
+      # The words before a trailing number or letter, joined, and its
+      # order, -1 for a name that doesn't end in one.
+      def self.trailing(stem)
+        words = words(stem)
+        last = words.last.to_s
+        return ["", -1] if words.size < 2 || !value?(last) || last.length > 2
+
+        [words[0, words.size - 1].join(" "), value(last)]
+      end
+
+      def self.words(stem) = stem.downcase.split(/[^a-z0-9]+/).reject(&:empty?)
+
+      def self.stem(path) = File.basename(path, File.extname(path))
+
+      def self.key(stem, marked) = marked ? parse(stem) : trailing(stem)
+
+      # The order and name of each image in the folder in the set.
+      def self.siblings(directory, extension, base, marked)
+        found = []
+        children(directory).each do |name|
+          next unless File.extname(name).downcase == extension
+
+          name_key = key(stem(name), marked)
+          found << [name_key[1], name] if name_key[0] == base && !name_key[1].negative?
+        end
+        found
+      end
+
+      # Adds the word at `index` to the base, or its marker's value to the
+      # values, and returns the index of the next word.
+      def self.take(words, index, base, values)
+        word = words[index]
+        following = words[index + 1].to_s
+        if KINDS.include?(word) && value?(following)
+          values << value(following)
+          index += 2
+          index += 2 if words[index] == "of" && words[index + 1].to_s.match?(/\A\d+\z/)
+          index
+        elsif marker?(word)
+          values << value(word.sub(/\A(disk|disc|side|part|d|s)/, ""))
+          index + 1
+        else
+          base << word
+          index + 1
+        end
+      end
+
+      def self.marker?(word) = word.match?(/\A(disk|disc|side|part)(\d+|[a-z])\z/) || word.match?(/\A[ds]\d+\z/)
+
+      def self.value?(word) = word.match?(/\A(\d+|[a-z])\z/)
+
+      # A number counts as itself and a letter by its place in the
+      # alphabet, so side A is 1.
+      def self.value(word) = word.match?(/\A\d+\z/) ? word.to_i : word.ord - 96
+
+      def self.order(values)
+        return -1 if values.empty?
+
+        values.reduce(0) { |order, value| (order * 1000) + value }
+      end
+
+      def self.children(directory)
+        Dir.children(directory)
+      rescue SystemCallError
+        []
+      end
+    end
+  end
+end

data/lib/badline/media.rb

@@ -2,6 +2,7 @@
 
 require "badline/media/true_drive"
 require "badline/media/queue"
+require "badline/media/disk_set"
 
 module Badline
   module Media

data/lib/badline/options/table.rb

@@ -16,7 +16,7 @@ module Badline
       Option.new("--version", "Show the version and what built it", section: "Options", build: :native),
       Option.new("--no-autostart", "Boot to READY. instead of running the program",
                  section: "Window options", needs: :window),
-      Option.new("--read-only", "Mount a disk image write-protected, leaving its file unchanged",
+      Option.new("--writable", "Let the machine write to disk images, changing their files",
                  section: "Window options", needs: :window),
       Option.new("--sound", "Play the SID through the host's audio device (F10 mutes)",
                  section: "Window options", needs: :window),

data/lib/badline/options.rb

@@ -61,7 +61,7 @@ module Badline
       @sid_model = nil
       @reu = nil
       @autostart = true
-      @read_only = false
+      @writable = false
       @sound = native
       @frames = 0
       @paced = true
@@ -135,7 +135,7 @@ module Badline
 
     def autostart? = @autostart
 
-    def read_only? = @read_only
+    def writable? = @writable
 
     def sound? = @sound
 
@@ -238,7 +238,7 @@ module Badline
     def switch(name)
       case name
       when "--no-autostart" then @autostart = false
-      when "--read-only" then @read_only = true
+      when "--writable" then @writable = true
       when "--sound" then @sound = true
       when "--no-sound" then @sound = false
       when "--no-vsync" then @vsync = false

data/lib/badline/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badline
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Inge Jørgensen
@@ -41,7 +41,11 @@ files:
 - MIT-LICENSE
 - README.md
 - SECURITY.md
+- doc/library.md
+- doc/media.md
 - doc/pinned-behaviour.md
+- doc/sid-player.md
+- doc/snapshots.md
 - exe/badline-ruby
 - lib/badline.rb
 - lib/badline/address_bus.rb
@@ -137,16 +141,23 @@ files:
 - lib/badline/frontend/audio_sink.rb
 - lib/badline/frontend/boot.rb
 - lib/badline/frontend/buttons.rb
+- lib/badline/frontend/confirmation.rb
 - lib/badline/frontend/controls.rb
 - lib/badline/frontend/drive_led.rb
+- lib/badline/frontend/file_browser.rb
 - lib/badline/frontend/filter_view.rb
 - lib/badline/frontend/frame_rate.rb
+- lib/badline/frontend/frame_report.rb
 - lib/badline/frontend/gamepads.rb
 - lib/badline/frontend/info_view.rb
 - lib/badline/frontend/keys.rb
+- lib/badline/frontend/menu_dialogs.rb
+- lib/badline/frontend/menu_media.rb
+- lib/badline/frontend/menu_pages.rb
 - lib/badline/frontend/pacer.rb
 - lib/badline/frontend/pad_port.rb
 - lib/badline/frontend/painter.rb
+- lib/badline/frontend/pause_menu.rb
 - lib/badline/frontend/player_commands.rb
 - lib/badline/frontend/player_footer.rb
 - lib/badline/frontend/player_header.rb
@@ -197,6 +208,7 @@ files:
 - lib/badline/keyboard.rb
 - lib/badline/keyboard_buffer.rb
 - lib/badline/media.rb
+- lib/badline/media/disk_set.rb
 - lib/badline/media/queue.rb
 - lib/badline/media/true_drive.rb
 - lib/badline/memory.rb