inform-runtime 1.0.4 → 1.2.0

data/lib/story_teller/core.rb

@@ -0,0 +1,38 @@
+# lib/story_teller/core.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+#
+# This file is part of the StoryTeller.
+#
+# The StoryTeller is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# The StoryTeller is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative 'builtins'
+require_relative 'stdlib'
+require_relative 'logging'
+require_relative 'prototype'
+require_relative 'command'
+require_relative 'history'
+require_relative 'events'
+require_relative 'grammar_parser'
+require_relative 'kernel'
+require_relative 'mixins'
+require_relative 'helpers'
+require_relative 'io'
+require_relative 'publication'
+require_relative 'context'
+require_relative 'world_tree'
+require_relative 'library'
+require_relative 'engine'

data/lib/{runtime → story_teller}/daemon.rb

@@ -1,24 +1,23 @@
+# src/lib/daemon.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of the StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# The StoryTeller is free software: you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# The Inform Runtime is distributed in the hope that it will be useful,
+# The StoryTeller is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with the Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
-
-require 'set'
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
 # In order to support atmospheric messages and NPC automation
 # based on timers, I'm trying to come up with an approach for
@@ -75,14 +74,14 @@ require 'set'
 #   has   switchable ~on;
 #
 
-# The Inform module
-module Inform
+# The StoryTeller module
+module StoryTeller
   def run_daemons
     return if defined?(TURN_BASED)
-    Inform::Daemons.start
+    StoryTeller::Daemons.start
   end
 
-  # The Inform::Daemons module
+  # The StoryTeller::Daemons module
   module Daemons
     def spawn
       @spawn ||= defined?(Java) ? java.util.concurrent.ConcurrentSkipListSet.new : Set.new
@@ -98,10 +97,10 @@ module Inform
       java.util.concurrent.Executors.newSingleThreadScheduledExecutor()
     end
 
-    # The Inform::Daemons::Entheogen class encapsulates a heartbeat which
+    # The StoryTeller::Daemons::Entheogen class encapsulates a heartbeat which
     # is a ScheduledFuture created by the Heart executor and instantiated
-    # when Inform::Daemons.start is executed.
-    class Entheogen < Inform::System::Object
+    # when StoryTeller::Daemons.start is executed.
+    class Entheogen < Inform::Ephemeral::Object
       attr_accessor :heartbeat
     end
 
@@ -114,13 +113,13 @@ module Inform
     end
 
     def on?
-      return false if Inform::Daemons.ghost.heartbeat.nil?
-      Inform::Daemons.ghost.heartbeat.isCancelled() == false
+      return false if StoryTeller::Daemons.ghost.heartbeat.nil?
+      StoryTeller::Daemons.ghost.heartbeat.isCancelled() == false
     end
 
     def rescan
-      Inform::Daemons.spawn.clear
-      Inform::Daemons.scan_objects
+      StoryTeller::Daemons.spawn.clear
+      StoryTeller::Daemons.scan_objects
     end
 
     DaemonScanElapsedMessage = "Scanned %<daemons>s daemons in %<elapsed>0.2f milliseconds".freeze
@@ -138,32 +137,32 @@ module Inform
 
     # rubocop: disable Metrics/AbcSize
     def self.start
-      initial_delay = Inform::Game.config[:daemon_initial_delay]
-      period = Inform::Game.config[:daemons_period]
+      initial_delay = StoryTeller::Game.config[:daemon_initial_delay]
+      period = StoryTeller::Game.config[:daemons_period]
       unit = defined?(Java) ? java.util.concurrent.TimeUnit::MILLISECONDS : 'milliseconds'
       Thread.new do
-        Inform::Daemons.rescan
+        StoryTeller::Daemons.rescan
         log.debug "Starting daemons..."
-        daemons = Inform::Daemons.method(:daemons).to_proc
-        Inform::Daemons.ghost.heartbeat = Inform::Daemons.heart.scheduleAtFixedRate(
+        daemons = StoryTeller::Daemons.method(:daemons).to_proc
+        StoryTeller::Daemons.ghost.heartbeat = StoryTeller::Daemons.heart.scheduleAtFixedRate(
           daemons, initial_delay, period, unit)
       end
     end
     # rubocop: enable Metrics/AbcSize
 
     def self.stop
-      Inform::Daemons.ghost.heartbeat.cancel(false)
-      Inform::Daemons.spawn.clear
+      StoryTeller::Daemons.ghost.heartbeat.cancel(false)
+      StoryTeller::Daemons.spawn.clear
     end
 
     DaemonExecutionElapsedMessage = "\e[1m\e[33mExecuted daemons in %<elapsed>0.2f milliseconds\e[39m\e[22m".freeze
 
     def self.daemons
       start = Time.ms
-      Inform::Daemons.spawn.each do |daemon|
+      StoryTeller::Daemons.spawn.each do |daemon|
         # In realtime games, each_turn is a synonym for daemon
         next unless daemon.respond_to?(:daemon) || daemon.respond_to?(:each_turn)
-        Inform::Daemons.execute daemon
+        StoryTeller::Daemons.execute daemon
       end
     ensure
       finish = Time.ms
@@ -185,7 +184,7 @@ module Inform
       # TODO: Use a pool of InformLibraries until
       # comprehensive event contexts can be implemented
       log.warn "Using singleton Ghost InformLibrary for #{obj} daemon"
-      obj.inflib = Inform::Runtime.libraries[Inform::Daemons.ghost]
+      obj.inflib = StoryTeller::Engine.libraries[StoryTeller::Daemons.ghost]
     end
 
     # TODO: Potentially go ahead and print any string results
@@ -216,14 +215,14 @@ module Inform
     end
 
     def StartDaemon(obj)
-      Inform::Daemons.spawn.add obj if obj.respond_to?(:daemon) || obj.respond_to?(:each_turn)
+      StoryTeller::Daemons.spawn.add obj if obj.respond_to?(:daemon) || obj.respond_to?(:each_turn)
     end
 
     def StopDaemon(obj)
       return if obj.nil?
       log.warn "Stopping daemon: #{obj}"
       obj.undef_method(:daemon) # TODO: Maybe don't do this
-      Inform::Daemons.spawn.remove obj
+      StoryTeller::Daemons.spawn.remove obj
     end
 
     def StartTimer(obj, interval)
@@ -235,11 +234,11 @@ module Inform
     end
 
     def daemonize(event)
-      Inform::Daemons.schedules[self] = event
+      StoryTeller::Daemons.schedules[self] = event
     end
 
     def daemonic?
-      Inform::Daemons.schedules.include? self
+      StoryTeller::Daemons.schedules.include? self
     end
 
     def before_destroy
@@ -250,17 +249,17 @@ module Inform
 
     # rubocop: disable Metrics/AbcSize
     def occasionally(time = nil, &block)
-      time = Inform::Game.config[:daemons_frequency_default] if time.nil?
+      time = StoryTeller::Game.config[:daemons_frequency_default] if time.nil?
       return if active? || daemonic?
       frequency = ((self.&:frequency) || time).to_i
       occasion = rand(frequency) + 1
       log.trace "Scheduling occasional daemonic event for #{self} in #{occasion} seconds"
-      (Inform::Daemons.schedules[self] = delay(occasion, &block)).finally do
-        Inform::Daemons.schedules.delete self
+      (StoryTeller::Daemons.schedules[self] = delay(occasion, &block)).finally do
+        StoryTeller::Daemons.schedules.delete self
       end
     end
   end
   # rubocop: enable Metrics/AbcSize
   # module Daemons
 end
-# module Inform
+# module StoryTeller

data/lib/story_teller/engine.rb

@@ -0,0 +1,151 @@
+# lib/story_teller/engine.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+#
+# This file is part of the StoryTeller.
+#
+# The StoryTeller is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# The StoryTeller is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative 'session'
+require_relative 'io'
+require_relative 'context'
+require_relative 'library'
+require_relative 'publication'
+
+# The StoryTeller module
+module StoryTeller
+  # The Engine module
+  module Engine
+    # The Library module
+    module Library
+      def play
+        log.debug "Using engine-managed InformLibrary play method override"
+        inform_library = StoryTeller::Engine.libraries[StoryTeller::Engine]
+        inform_library.play
+        inform_library
+      end
+    end
+
+    # The Config class
+    module Config
+      DEFAULTS = {
+        environment: 'default',
+        inform6lib_gem_code_prefix: 'inform',
+        language: 'English',
+        properties: 'player actor action action_to_be ' \
+          'results parameters pattern ' \
+          'noun second inp1 inp2 ' \
+          'special_word special_number special_number1 special_number2 ' \
+          'consult_words match_from wn verb_wordnum words ' \
+          'parser_action parser_one parser_two scope_reason',
+        log_level: Logger::INFO
+      }.freeze
+    end
+
+    module_function
+
+    def libraries
+      @libraries ||= {}
+    end
+
+    def main_object=(obj)
+      @main_object = obj
+    end
+
+    def main_object
+      @main_object
+    end
+
+    def default_config
+      @default_config ||= StoryTeller::Engine::Config::DEFAULTS
+    end
+
+    def inform_code_prefix
+      StoryTeller::Engine.default_config[:inform6lib_gem_code_prefix]
+    end
+
+    def project_dir_path
+      @project_dir_path ||= begin
+        story_dir_path = File.expand_path(__dir__)
+        lib_dir_path = File.expand_path(File.dirname(story_dir_path))
+        File.expand_path(File.dirname(lib_dir_path))
+      end
+    end
+
+    def executable=(executable)
+      @executable = executable
+    end
+
+    def executable
+      @executable
+    end
+
+    def default_environment
+      StoryTeller::Engine.default_config[:environment]
+    end
+
+    def default_invocation_properties
+      StoryTeller::Engine.default_config.fetch(:properties, '').split.map(&:to_sym).freeze
+    end
+
+    def invocation_properties
+      @invocation_properties ||= default_invocation_properties
+    end
+
+    def invocation_properties=(properties)
+      @invocation_properties = properties
+      @invocation_context = nil
+    end
+
+    def invocation_context
+      @invocation_context ||= Struct.new(*invocation_properties)
+    end
+
+    def language_name
+      StoryTeller::Engine.default_config[:language]
+    end
+
+    def player?(obj)
+      return false unless defined?(StoryTeller::IO::Session) && StoryTeller::IO::Session.respond_to?(:players)
+      StoryTeller::IO::Session.players.include?(obj)
+    end
+
+    def prime_dictionary
+      Inform::Object.select_map(:name).compact.each do |n|
+        StoryTeller::Dictionary.merge(n.split(/[,\s]+/).grep_v(/[^a-z]/i).map(&:downcase).map(&:to_sym))
+      end
+    end
+  end
+  # module Engine
+
+  # The StoryTeller::Privileges module to implement privilege
+  module Privileges
+    def admin?
+      self.has?(:admin)
+    end
+
+    def builder?
+      admin? || self.has?(:builder)
+    end
+  end
+end
+# module StoryTeller
+
+if defined?(ZCODE_ONLY)
+  # Simulate compiling with Z-code only compiler
+  WORDSIZE = (2**((0.size * 8) - 2) - 1)
+end
+# defined?(ZCODE_ONLY)

data/lib/story_teller/ephemeral_adapter.rb

@@ -0,0 +1,42 @@
+# lib/story_teller/ephemeral_adapter.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+#
+# This file is part of StoryTeller.
+#
+# StoryTeller is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StoryTeller is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
+
+# module StoryTeller
+module StoryTeller
+  # module EphemeralAdapter
+  module EphemeralAdapter
+    Adapter = {
+      name: :ephemeral,
+      object_class: Inform::Ephemeral::Object,
+      tag_class: Inform::Ephemeral::Tag,
+      link_class: Inform::Ephemeral::Link,
+      module_class: Inform::Ephemeral::Module
+    }.freeze
+
+    module_function
+
+    def register!
+      StoryTeller::ModelAdapter.register!(Adapter)
+    end
+  end
+end
+
+StoryTeller::EphemeralAdapter.register!

data/lib/{runtime → story_teller}/events.rb

@@ -1,22 +1,23 @@
+# lib/story_teller/events.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# StoryTeller is free software: you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# The Inform Runtime is distributed in the hope that it will be useful,
+# StoryTeller is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with the Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
+# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
 # The Time class
 class Time
@@ -480,13 +481,13 @@ module EventInitializationMethods
   def generate_identity
     s = format(EventCauseIdentityTemplate, identity: @cause.identity, name: @cause.name)
     if !@callstack.empty?
-      trace = @callstack.first.gsub(Inform::Runtime.project_dir_path, '')
+      trace = @callstack.first.gsub(StoryTeller::Engine.project_dir_path, '')
       location, line_number, method_name = CallerPattern.match(trace)&.captures
       s << format(EventSourceFullTemplate,
         method_name: method_name, source_location: location, source_line_number: line_number)
     elsif @activity.respond_to?(:source_location) || @activity.is_a?(Proc)
       activity_source_location_enumerator = @activity.source_location.each
-      source_location = activity_source_location_enumerator.next.gsub(Inform::Runtime.project_dir_path, '')
+      source_location = activity_source_location_enumerator.next.gsub(StoryTeller::Engine.project_dir_path, '')
       source_line_number = activity_source_location_enumerator.next
       s << format(
         EventSourceTemplate, source_location: source_location, source_line_number: source_line_number)
@@ -536,8 +537,6 @@ module Inform
       invoke(self)
     end
 
-    private
-
     include EventInitializationMethods
   end
 

data/lib/{runtime → story_teller}/experimental/handler_dsl.rb

@@ -1,22 +1,23 @@
+# lib/story_teller/experimental/handler_dsl.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of the StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# The StoryTeller is free software: you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# The Inform Runtime is distributed in the hope that it will be useful,
+# The StoryTeller is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with the Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
 # The Inform module
 module Inform
@@ -37,7 +38,7 @@ module Inform
 
   # The Inform::Behavior module
   module Behavior
-    Registry = Class.new(Hash)
+    class Registry < Hash; end
     REGISTRY = Registry.new
 
     def self.key_for(obj)
@@ -126,18 +127,6 @@ module Inform
 
   # The BuilderInstanceMethods module
   module BuilderInstanceMethods
-    # Unknown method with a block => define it on behavior.
-    # def method_missing(method_name, *args, &block)
-    #   return @target.public_send(method_name, *args) if block.nil?
-    #   local_context = @context
-    #   @behavior.send(:define_method, method_name) do |*call_args, &_block|
-    #     instance_exec(local_context, *call_args, &block)
-    #   end
-    #   method_name
-    # rescue NoMethodError
-    #   super
-    # end
-
     def method_missing(method_name, *args, &block)
       # 1) Try the real receiver first (even when a block is present)
       log.debug "@target: #{@target.inspect}"

data/lib/story_teller/experimental/reverse_engineer_class.rb

@@ -0,0 +1,37 @@
+# lib/story_teller/experimental/reverse_engineer_class.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+#
+# This file is part of StoryTeller.
+#
+# StoryTeller is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StoryTeller is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
+
+# The ReverseEngineerClass module
+module ReverseEngineerClass
+  def singleton_object_to_class(object, superclass = Object)
+    source = object.singleton_class
+
+    Class.new(superclass) do
+      source.instance_methods(false).each do |method_name|
+        define_method(method_name, source.instance_method(method_name))
+      end
+    end
+  end
+
+  old_library = InformLibrary
+  Object.send(:remove_const, :InformLibrary)
+  InformLibrary = singleton_object_to_class(old_library, Inform::Ephemeral::Object)
+end