rb-appscript 0.2.0

data/src/lib/_appscript/defaultterminology.rb

@@ -0,0 +1,245 @@
+#!/usr/local/bin/ruby
+# Copyright (C) 2006 HAS. 
+# Released under MIT License.
+
+module DefaultTerminology
+	# Defines built-in terminology available for any application. When constructing the terminology tables for a particular application, the Terminology module will duplicate these tables and then add application-specific terms to create the finished lookup tables.
+
+	require "aem"
+	
+	Enums = {
+		'yes ' => :yes,
+		'no  ' => :no,
+		'ask ' => :ask,
+		
+		'case' => :case,
+		'diac' => :diacriticals,
+		'expa' => :expansion,
+		'hyph' => :hyphens,
+		'punc' => :punctuation,
+		'whit' => :whitespace,
+		'nume' => :numeric_strings,
+		'rmte' => :application_responses,
+	}
+
+	Types = {
+		'****' => :anything,
+		
+		'bool' => :boolean,
+		
+		'shor' => :short_integer,
+		'long' => :integer,
+		'magn' => :unsigned_integer,
+		'comp' => :double_integer,
+		
+		'fixd' => :fixed,
+		'lfxd' => :long_fixed,
+		'decm' => :decimal_struct,
+		
+		'sing' => :short_float,
+		'doub' => :float,
+		'exte' => :extended_float,
+		'ldbl' => :float_128bit,
+		
+		'TEXT' => :string,
+		'cstr' => :c_string,
+		'pstr' => :pascal_string,
+		'STXT' => :styled_text,
+		'tsty' => :text_style_info,
+		'styl' => :styled_clipboard_text,
+		'encs' => :encoded_string,
+		'psct' => :writing_code,
+		'intl' => :international_writing_code,
+		'itxt' => :international_text,
+		'sutx' => :styled_unicode_text,
+		'utxt' => :unicode_text,
+  		'utf8' => :utf8_text, # typeUTF8Text
+		'ut16' => :utf16_text, # typeUTF16ExternalRepresentation
+		
+		'vers' => :version,
+		'ldt ' => :date,
+		'list' => :list,
+		'reco' => :record,
+		'rdat' => :data,
+		'scpt' => :script,
+		
+		'insl' => :location_reference,
+		'obj ' => :reference,
+		
+		'alis' => :alias,
+		'fsrf' => :file_ref,
+		'fss ' => :file_specification,
+		'furl' => :file_url,
+		
+		'QDpt' => :point,
+		'qdrt' => :bounding_rectangle,
+		'fpnt' => :fixed_point,
+		'frct' => :fixed_rectangle,
+		'lpnt' => :long_point,
+		'lrct' => :long_rectangle,
+		'lfpt' => :long_fixed_point,
+		'lfrc' => :long_fixed_rectangle,
+		
+		'EPS ' => :EPS_picture,
+		'GIFf' => :GIF_picture,
+		'JPEG' => :JPEG_picture,
+		'PICT' => :PICT_picture,
+		'TIFF' => :TIFF_picture,
+		'cRGB' => :RGB_color,
+		'tr16' => :RGB16_color,
+		'tr96' => :RGB96_color,
+		'cgtx' => :graphic_text,
+		'clrt' => :color_table,
+		'tpmm' => :pixel_map_record,
+		
+		'best' => :best,
+		'type' => :type_class,
+		'enum' => :enumerator,
+		'prop' => :property,
+		
+		# AEAddressDesc types
+		
+		'port' => :mach_port,
+		'kpid' => :kernel_process_id,
+		'bund' => :application_bundle_id,
+		'psn ' => :process_serial_number,
+		'sign' => :application_signature,
+		'aprl' => :application_url,
+		
+		# misc.
+		
+		'msng' => :missing_value,
+		
+		'pcls' => :class_,
+		
+		'null' => :null,
+		
+		'mLoc' => :machine_location,
+		'mach' => :machine,
+		
+		'tdas' => :dash_style,
+		'trot' => :rotation,
+		
+		'suin' => :suite_info,
+		'gcli' => :class_info,
+		'pinf' => :property_info,
+		'elin' => :element_info,
+		'evin' => :event_info,
+		'pmin' => :parameter_info,
+		
+		# unit types
+		
+		'cmtr' => :centimeters,
+		'metr' => :meters,
+		'kmtr' => :kilometers,
+		'inch' => :inches,
+		'feet' => :feet,
+		'yard' => :yards,
+		'mile' => :miles,
+		
+		'sqrm' => :square_meters,
+		'sqkm' => :square_kilometers,
+		'sqft' => :square_feet,
+		'sqyd' => :square_yards,
+		'sqmi' => :square_miles,
+		
+		'ccmt' => :cubic_centimeters,
+		'cmet' => :cubic_meters,
+		'cuin' => :cubic_inches,
+		'cfet' => :cubic_feet,
+		'cyrd' => :cubic_yards,
+		
+		'litr' => :liters,
+		'qrts' => :quarts,
+		'galn' => :gallons,
+		
+		'gram' => :grams,
+		'kgrm' => :kilograms,
+		'ozs ' => :ounces,
+		'lbs ' => :pounds,
+		
+		'degc' => :degrees_Celsius,
+		'degf' => :degrees_Fahrenheit,
+		'degk' => :degrees_Kelvin,
+		
+		# month and weekday
+		
+		'jan ' => :January,
+		'feb ' => :February,
+		'mar ' => :March,
+		'apr ' => :April,
+		'may ' => :May,
+		'jun ' => :June,
+		'jul ' => :July,
+		'aug ' => :August,
+		'sep ' => :September,
+		'oct ' => :October,
+		'nov ' => :November,
+		'dec ' => :December,
+		
+		'sun ' => :Sunday,
+		'mon ' => :Monday,
+		'tue ' => :Tuesday,
+		'wed ' => :Wednesday,
+		'thu ' => :Thursday,
+		'fri ' => :Friday,
+		'sat ' => :Saturday,
+	}
+	
+	#######
+	# TypeByCode and TypeByName tables are used to convert Ruby Symbols to and from AEDescs of typeType, typeEnum and typeProperty.
+	
+	TypeByCode = Types.clone.update(Enums)
+
+	TypeByName = {}
+	Types.each { |code, name| TypeByName[name] = AEM::AEType.new(code) }
+	Enums.each { |code, name| TypeByName[name] = AEM::AEEnum.new(code) }
+	
+	#######
+	# ReferenceByCode tables is used by ReferenceRenderer module to convert property and element four-char codes to human readable names
+	#
+	# ReferenceByName table is used to convert appscript-style references and commands to their aem equivalents
+	
+	ReferenceByCode = {
+		'pcls' => 'class_',
+		'ID  ' => 'id_',
+	}
+	
+	ReferenceByName = {
+		:quit => [:command, ['aevtquit', {
+				:saving => 'savo',
+				}]],
+		:activate => [:command, ['miscactv', {
+				}]],
+		:run => [:command, ['aevtoapp', {
+				}]],
+		:launch => [:command, ['ascrnoop', {
+				}]],
+		:open => [:command, ['aevtodoc', {
+				}]],
+		:get => [:command, ['coregetd', {
+				}]],
+		:print => [:command, ['aevtpdoc', {
+				}]],
+		:class_ => [:property, 'pcls'],
+		:set => [:command, ['coresetd', {
+				:to => 'data',
+				}]],
+		:reopen => [:command, ['aevtrapp', {
+				}]],
+		:id_ => [:property, 'ID  '],
+		:open_location => [:command, ['GURLGURL', {
+				:window => 'WIND',
+				}]],
+	}
+
+	#######
+	# DefaultCommands; used by Terminology._make_reference_table to check for any collisions between standard and application-defined commands where the command names are the same but the codes are different
+	
+	DefaultCommands = {} # {'quit' => 'aevtquit', 'activate' => 'miscactv',...}
+	ReferenceByName.each do |name, info|
+		if info[0] == :command
+			DefaultCommands[name.to_s] = info[1][0]
+		end
+	end
+end

data/src/lib/_appscript/referencerenderer.rb

@@ -0,0 +1,132 @@
+#!/usr/local/bin/ruby
+# Copyright (C) 2006 HAS. 
+# Released under MIT License.
+
+require "_aem/aemreference"
+
+
+class ReferenceRenderer
+	# Generates string representations of appscript references from aem object specifiers.
+
+	private_class_method :new
+	attr_reader :result
+	
+	def initialize(app_data)
+		@_app_data = app_data
+		@result = "AS"
+	end
+	
+	def _format(val)
+		if val.is_a?(AEMReference::Base)
+			return ReferenceRenderer.render(@_app_data, val)
+		else
+			return val.inspect
+		end
+	end
+	
+	def property(code)
+		name = @_app_data.reference_by_code.fetch('p'+code) { @_app_data.reference_by_code.fetch('e'+code) }
+		@result += ".#{name}"
+		return self
+	end
+	
+	def elements(code)
+		name = @_app_data.reference_by_code.fetch('e'+code) { @_app_data.reference_by_code.fetch('p'+code) }
+		@result += ".#{name}"
+		return self
+	end
+	
+	def by_name(name)
+		@result += "[#{_format(name)}]"
+		return self
+	end
+	
+	def by_index(index)
+		@result += "[#{_format(index)}]"
+		return self
+	end
+	
+	def by_id(id)
+		@result += ".ID(#{_format(id)})"
+		return self
+	end
+	
+	def by_range(sel1, sel2)
+		@result += "[#{_format(sel1)}, #{_format(sel2)}]"
+		return self
+	end
+	
+	def by_filter(sel)
+		@result += "[#{_format(sel)}]"
+		return self
+	end
+	
+	def previous(sel)
+		@result += ".previous(#{_format(@_app_data.type_by_code[sel])})"
+		return self
+	end
+	
+	def next(sel)
+		@result += ".next(#{_format(@_app_data.type_by_code[sel])})"
+		return self
+	end
+	
+	def app
+		if @_app_data.path
+			@result += ".app(#{@_app_data.path.inspect})"
+		elsif @_app_data.pid
+			@result += ".app.by_pid(#{@_app_data.pid.inspect})"
+		elsif @_app_data.url
+			@result += ".app.by_url(#{@_app_data.url.inspect})"
+		else
+			@result += ".app.current"
+		end
+		return self
+	end
+	
+	def con
+		@result += ".con"
+		return self
+	end
+	
+	def its
+		@result += ".its"
+		return self
+	end
+	
+	def method_missing(name, *args)
+		if args.length > 0
+			@result += ".#{name.to_s}(#{(args.map { |arg| arg.inspect }).join(', ')})"
+		else
+			@result += ".#{name.to_s}"
+		end
+		return self
+	end
+	
+	# public
+	
+	def ReferenceRenderer.render(app_data, aem_reference)
+		# Take an aem reference, e.g.:
+		#
+		#	app.elements('docu').by_index(1).property('ctxt')
+		#
+		# and an AppData instance containing application's location and terminology, 
+		# and render an appscript-style reference string, e.g.:
+		#
+		#	"AS.app('/Applications/TextEdit.app').documents[1].text"
+		#
+		# Used by AS::Reference#to_s
+		#
+		f = new(app_data)
+		begin
+			aem_reference.AEM_resolve(f)
+			return f.result
+		rescue
+			return aem_reference.inspect
+		end
+	end
+
+end
+
+	
+	

data/src/lib/_appscript/reservedkeywords.rb

@@ -0,0 +1,107 @@
+#!/usr/local/bin/ruby
+# Copyright (C) 2006 HAS. 
+# Released under MIT License.
+
+# This list is mirrored in ch.6 of the appscript manual and in py-appscript's osaterminology.makeidentifier module
+
+ReservedKeywords = [
+	"==",
+	"===",
+	"=~",
+	"AS_aem_reference",
+	"AS_aem_reference=",
+	"AS_app_data",
+	"AS_app_data=",
+	"AS_resolve",
+	"ID",
+	"[]",
+	"__id__",
+	"__send__",
+	"_aem_application_class",
+	"_call",
+	"_resolve_range_boundary",
+	"_send_command",
+	"abort_transaction",
+	"after",
+	"and",
+	"any",
+	"before",
+	"by_creator",
+	"by_id",
+	"by_name",
+	"by_pid",
+	"by_url",
+	"class",
+	"clone",
+	"commands",
+	"contains",
+	"current",
+	"display",
+	"does_not_contain",
+	"does_not_end_with",
+	"does_not_start_with",
+	"dup",
+	"elements",
+	"end",
+	"end_transaction",
+	"ends_with",
+	"eq",
+	"eql?",
+	"equal?",
+	"extend",
+	"first",
+	"freeze",
+	"frozen?",
+	"ge",
+	"gt",
+	"hash",
+	"help",
+	"id",
+	"ignore",
+	"inspect",
+	"instance_eval",
+	"instance_of?",
+	"instance_variable_get",
+	"instance_variable_set",
+	"instance_variables",
+	"is_a?",
+	"is_in",
+	"is_not_in",
+	"keywords",
+	"kind_of?",
+	"last",
+	"launch",
+	"le",
+	"lt",
+	"method",
+	"method_missing",
+	"methods",
+	"middle",
+	"ne",
+	"next",
+	"nil?",
+	"not",
+	"object_id",
+	"or",
+	"parameters",
+	"previous",
+	"private_methods",
+	"properties",
+	"protected_methods",
+	"public_methods",
+	"respond_to?",
+	"result_type",
+	"send",
+	"singleton_methods",
+	"start",
+	"start_transaction",
+	"starts_with",
+	"taint",
+	"tainted?",
+	"timeout",
+	"to_a",
+	"to_s",
+	"type",
+	"untaint",
+	"wait_reply",
+]