alda-rb 0.2.1 → 0.3.1

data/lib/alda-rb/event_list.rb

@@ -15,6 +15,11 @@ module Alda::EventList
 	# The set containing the available variable names.
 	attr_accessor :variables
 	
+	##
+	# When the module is included by a subclass of Alda::Event,
+	# this method overrides Alda::Event#on_contained.
+	# When invoked, calls the overridden method (if any) and then evaluates the block
+	# given when ::new was called.
 	def on_contained
 		super if defined? super
 		instance_eval &@block if @block
@@ -33,6 +38,9 @@ module Alda::EventList
 	#
 	# 2. Starting with 2 lowercase letters and
 	#    ending with underline character: instrument. See Alda::Part.
+	#    This will trigger a warning if we are using \Alda 2 because
+	#    parts inside a sequence are not allowed in \Alda 2
+	#    ({alda-lang/alda#441}[https://github.com/alda-lang/alda/discussions/441#discussioncomment-3825064]).
 	#
 	# 3. Starting with 2 lowercase letters: inline lisp code,
 	#    set variable, or get variable.
@@ -82,14 +90,13 @@ module Alda::EventList
 			if args.first.is_a? String
 				Alda::Part.new [part], args.first
 			else
+				Alda::Utils.warn 'parts in sequence not allowed in v2' if Alda.v2? && !args.empty?
 				sequence_sugar.(Alda::Part.new [part])
 			end
 		when /\A[a-z][a-z].*\z/                   =~ name
 			arg = args.first
 			if block || !has_variable?(name) && args.size == 1 && arg.is_a?(Alda::Event) &&
-					!arg.is_a?(Alda::InlineLisp) && !arg.is_a?(Alda::LispIdentifier) &&
-					!(arg.is_a?(Alda::EventContainer) &&
-							(arg.event.is_a?(Alda::InlineLisp) || arg.event.is_a?(Alda::LispIdentifier)))
+					!arg.is_event_of?(Alda::InlineLisp) && !arg.is_event_of?(Alda::LispIdentifier)
 				Alda::SetVariable.new name, *args, &block
 			elsif has_variable?(name) && (args.empty? || args.size == 1 && arg.is_a?(Alda::Event))
 				sequence_sugar.(Alda::GetVariable.new name)
@@ -145,8 +152,8 @@ module Alda::EventList
 	#
 	# Append the events of another Alda::EventList object here.
 	# This method covers the disadvantage of alda's being unable to
-	# import scores from other files.
-	# See https://github.com/alda-lang/alda-core/issues/8.
+	# import scores from other files
+	# ({alda-lang/alda-core#8}[https://github.com/alda-lang/alda-core/issues/8]).
 	def import event_list
 		@events.concat event_list.events
 		nil
@@ -156,7 +163,7 @@ module Alda::EventList
 	# :call-seq:
 	#   new(&block) -> Alda::EventList
 	#
-	# +block+ is to be passed with the Alda::EventList object as +self+.
+	# The parameter +block+ is to be passed with the Alda::EventList object as +self+.
 	#
 	# Note that +block+ is not called immediately.
 	# It is instead called in #on_contained.
@@ -198,6 +205,16 @@ module Alda::EventList
 	def events_alda_codes delimiter = ' '
 		@events.map(&:to_alda_code).join delimiter
 	end
+	
+	##
+	# :call-seq:
+	#   event_list == other -> true or false
+	#
+	# Returns true if +other+ is of the same class as +event_list+
+	# and they have the same (in the sense of <tt>==</tt>) #events and #variables.
+	def == other
+		super || self.class == other.class && @events == other.events && @variables == other.variables
+	end
 end
 
 ##
@@ -222,7 +239,7 @@ class Alda::Score
 	#   Alda::Score.new { piano_; c; d; e }.play from: 1
 	#   # (plays only an E note)
 	def play **opts
-		Alda.play code: self, **opts
+		Alda.env(ALDA_DISABLE_SPAWNING: :no) { Alda.play code: self, **opts }
 	end
 	
 	##
@@ -270,13 +287,13 @@ class Alda::Score
 	
 	##
 	# :call-seq:
-	#   load(filename) -> Alda::InlineLisp
+	#   load(filename) -> Alda::Raw
 	#
 	# Loads alda codes from a file.
 	#
-	# Actually appends a Alda::InlineLisp event of +alda-code+ lisp call.
+	# Actually appends a Alda::Raw event with the contents in the file +filename+.
 	def load filename
-		event = Alda::InlineLisp.new :alda_code, File.read(filename)
+		event = Alda::Raw.new File.read filename
 		@events.push event
 		event
 	end
@@ -310,4 +327,34 @@ class Alda::Score
 		@variables.clear
 		nil
 	end
+	
+	##
+	# :call-seq:
+	#   raw(contents) -> Alda::Raw
+	#
+	# Adds an Alda::Raw event to the event list and returns it.
+	# The event is not contained by a container.
+	#
+	#   Alda::Score.new { raw 'piano: c d e' }.to_s # => "piano: c d e"
+	def raw contents
+		Alda::Raw.new(contents).tap { @events.push _1 }
+	end
+	
+	##
+	# :call-seq:
+	#   l(head, *args) -> Alda::EventContainer
+	#
+	# Adds an Alda::EventContainer containing an Alda::InlineLisp event to the event list.
+	# In most cases, #method_misssing is a more convenient way to add an inline Lisp event.
+	# However, sometimes you may want to programmatically control which Lisp function to be called,
+	# or the function name is already a valid Ruby method name
+	# (for example, you want to use +f+ or +p+ as the dynamics but +f+ would be interpreted as a note
+	# and +p+ is already a Ruby method for printing)
+	# so that it cannot trigger #method_missing,
+	# then you should use this method.
+	#
+	#   Alda::Score.new { piano_; l :p; c }.to_s # => "piano: (p ) c"
+	def l head, *args
+		Alda::EventContainer.new(Alda::InlineLisp.new(head, *args), self).tap { @events.push _1 }
+	end
 end

data/lib/alda-rb/patches.rb

@@ -1,41 +1,89 @@
 require 'stringio'
 
 ##
+# Contains patches to Ruby's core classes.
+class Thread
+	##
+	# Because \Alda 2 uses quoted lists to denote lists (vectors) of symbols,
+	# we have to keep track of whether we are inside a list already
+	# (because this notation is inconsistent for inner lists and outer lists).
+	attr_accessor :inside_alda_list
+end
+
+##
+# Contains patches to Ruby's core classes.
 class Array
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
+	# Behaves differently for \Alda 1 and \Alda 2 (due to
+	# {a breaking change}[https://github.com/alda-lang/alda/blob/master/doc/alda-2-migration-guide.md#attribute-syntax-has-changed-in-some-cases]).
 	def to_alda_code
-		"[#{map(&:to_alda_code).join ' '}]"
+		contents = -> { map(&:to_alda_code).join ' ' }
+		if Alda.v1?
+			"[#{contents.()}]"
+		else
+			thread = Thread.current
+			if thread.inside_alda_list
+				"(#{contents.()})"
+			else
+				thread.inside_alda_list = true
+				"'(#{contents.()})".tap { thread.inside_alda_list = false }
+			end
+		end
 	end
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
-		reverse_each &:detach_from_parent
+	def detach_from_parent(...)
+		reverse_each { _1.detach_from_parent(...) }
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class Hash
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
+	# Behaves differently for \Alda 1 and \Alda 2 (due to
+	# {a breaking change}[https://github.com/alda-lang/alda/blob/master/doc/alda-2-migration-guide.md#attribute-syntax-has-changed-in-some-cases]).
 	def to_alda_code
-		"[#{map(&:to_alda_code).join ' '}]"
+		contents = -> { map { "#{_1.to_alda_code} #{_2.to_alda_code}" }.join ' ' }
+		if Alda.v1?
+			"{#{contents.()}}"
+		else
+			thread = Thread.current
+			if thread.inside_alda_list
+				"(#{contents.()})"
+			else
+				thread.inside_alda_list = true
+				"'(#{contents.()})".tap { thread.inside_alda_list = false }
+			end
+		end
 	end
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
-		each.reverse_each &:detach_from_parent
+	def detach_from_parent(...)
+		each.reverse_each { _1.detach_from_parent(...) }
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class String
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		dump
@@ -43,29 +91,37 @@ class String
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class Symbol
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
-		?: + to_s
+		"#{Alda.v1? ? ?: : Thread.current.inside_alda_list ? '' : ?'}#{to_s}"
 	end
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class Numeric
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		inspect
@@ -73,14 +129,18 @@ class Numeric
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class Range
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		"#{first}-#{last}"
@@ -88,14 +148,18 @@ class Range
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class TrueClass
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		'true'
@@ -103,14 +167,18 @@ class TrueClass
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class FalseClass
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		'false'
@@ -118,14 +186,18 @@ class FalseClass
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class NilClass
 	
 	##
+	# :call-seq:
+	#   to_alda_code() -> String
+	#
 	# See Alda::Event#to_alda_code.
 	def to_alda_code
 		'nil'
@@ -133,11 +205,12 @@ class NilClass
 	
 	##
 	# See Alda::Event#detach_from_parent.
-	def detach_from_parent
+	def detach_from_parent(...)
 	end
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class Proc
 	
 	##
@@ -155,6 +228,7 @@ class Proc
 end
 
 ##
+# Contains patches to Ruby's core classes.
 class StringIO
 	
 	##