jota 0.8.0

data/lib/clip_array.rb

@@ -0,0 +1,393 @@
+
+# $Id: clip_array.rb 37 2009-02-09 10:06:02Z dz $
+
+# if you use vim and don't like folds type zR
+
+
+require 'app_error'
+require 'clip'
+require 'helper'
+require 'preferences'
+
+class ClipArray < Array
+
+# Instance Variables
+#       self		Array		[Clip.new]	the array of clips
+#       current_index	Integer		0	the position of current clip
+#	pref		Preferences	Preferences.defaults	preferences object
+#	file_and_path	String		ni	name and path of current file
+#	filename	String		ni	name of current file
+#	dirname		String		ni	directory of current file
+#	file		File		ni	current File object
+#	autosave_thread	Thread		nil	thread for autosaving
+
+
+attr_reader :current_index, :file, :filename, :dirname, :file_and_path
+attr_accessor :pref
+
+# Clear array and reset index
+def clear
+#{{{1
+	super
+	@current_index = -1
+end #}}}1
+
+# Clear array and create one empty clip
+def clear1
+#{{{1
+	clear
+	self << Clip.new
+end #}}}1
+
+def initialize
+#{{{1
+	clear
+	@file = nil
+	@filename = nil
+	@pref = Preferences.defaults
+	@autosave_thread = nil
+	print_verbose "initializing clip array"
+end #}}}1
+
+def <<(clip)
+#{{{1
+	push(clip)
+	@current_index = length-1
+	return self
+end #}}}1
+
+def set_file(file,file_and_path)
+#{{{1
+	@file = file
+	@file_and_path = file_and_path
+	@filename = File.basename(file_and_path)
+	@dirname = File.dirname(file_and_path)
+end #}}}1
+
+#
+#	Export
+#
+
+#def save_as_mbox(filename)
+##{{{1
+#	filename = get_filename(filename,:save)
+#
+#	puts "# saving clips to '#{filename}', format mbox" if $VERBOSE
+#
+#	f = open(filename,"w")
+#	write_mbox(f)
+#	self.each do | clip |
+#		f.print "From %s@localhost %s\n" % 
+#			[Version::PROGRAM_NAME, Time.now.ctime]
+#		f.print(escape_from(clip.to_mbox.chomp))
+#		f.print("\n")
+#	end
+#	f.close
+#end #}}}1
+#
+#def save_as_yaml(filename)
+##{{{1
+#	filename = get_filename(filename,:save)
+#
+#	arr = Array.new
+#	self.each_index do | i | 
+#		arr[i] = self[i].to_hash
+#	end
+#
+#	puts "# saving clips to '#{filename}', format yaml" if $VERBOSE
+#
+#	File.open(filename,"w") do | file |
+#		YAML::dump(arr, file)
+#	end
+#end #}}}1
+
+#def ClipArray.load(filename,format)
+##{{{1
+#	case format
+#	when :mbox
+#		return ClipArray.load_from_mbox(filename)
+#	when :yaml
+#		return ClipArray.load_from_yaml(filename)
+#	end
+#end #}}}1
+
+def current_index=(num)
+#{{{1
+	if num < 0 then
+		@current_index = 0
+	elsif num >= length then
+		@current_index = length - 1
+	else
+		@current_index = num
+	end
+	print_verbose "going to clip #{@current_index+1}"
+end #}}}1
+
+def next
+#{{{1
+	if @current_index < length-1 then
+		@current_index += 1
+		print_verbose "going to next clip #{@current_index+1}"
+	end
+	return self
+end #}}}1
+
+def prev
+#{{{1
+	if @current_index > 0 then
+		@current_index -= 1
+		print_verbose "going to previous clip #{@current_index+1}"
+	end
+	return self
+end #}}}1
+
+def delete
+#{{{1
+	if @current_index == length-1 then
+		new_current_index = @current_index - 1
+	else
+		new_current_index = @current_index
+	end
+
+	print_verbose "deleting clip #{@current_index+1}"
+	delete_at(@current_index)
+
+	if length == 0 then
+		clear1
+	else
+		@current_index = new_current_index
+	end
+	
+end #}}}1
+
+def new
+#{{{1
+	c = Clip.new
+	push(c)
+	@current_index = length-1
+	print_verbose "creating new clip #{@current_index+1}"
+end #}}}1
+
+def current
+#{{{1
+	return self[@current_index]
+end #}}}1
+
+#def ClipArray.load_from_yaml(filename)
+##{{{1
+#	filename = get_filename(filename,:open)
+#	ca = self.new
+#
+#	puts "# loading clips from '#{filename}', format yaml" if $VERBOSE
+#
+#	begin
+#		yaml = YAML::load_file(filename)
+#		yaml.each_index do | i |
+#			clip = Clip.from_hash(yaml[i])
+#			puts "#  '#{clip.title}' loaded" if $VERBOSE
+#			ca[i] = clip
+#		end
+#	rescue SystemCallError
+#		puts "# loading failed, continuing with empty clips" if $VERBOSE
+#	end
+#
+#	ca.current_index = ca.length - 1
+#	return ca
+#end #}}}1
+#
+#def ClipArray.load_from_mbox(filename)
+##{{{1
+#	ca = self.new
+#	str = nil
+#
+#	puts "# loading clips from '#{filename}', format mbox" if $VERBOSE
+#
+#	begin
+#		file = open(get_filename(filename,:open),"r")
+#		ca = ClipArray.read_mbox(file)
+#	ensure
+#		file.close
+#	end
+#
+#	return ca
+#end #}}}1
+
+def ClipArray.create(file_and_path)
+#{{{1
+	print_verbose "creating file '#{file_and_path}"
+
+	if File.exists?(file_and_path) then
+		raise AppError, "File '#{file_and_path}' already exists"
+	end
+
+	begin
+		file = File.open(file_and_path,"w+")
+		ca = ClipArray.new.clear1
+		ca.set_file(file,file_and_path)
+		
+		# test if writable
+		obtain_exclusive_lock(file)
+
+		obtain_shared_lock(file)
+	rescue Exception
+		file.close if file
+		raise
+	end
+
+	return ca
+end #}}}1
+
+def ClipArray.open(file_and_path)
+#{{{1
+	print_verbose "opening file '#{file_and_path}'"
+
+	begin
+		file = File.open(file_and_path,"r+")
+		ca = ClipArray.read_mbox(file)
+		ca.set_file(file,file_and_path)
+
+		# test if writable
+		obtain_exclusive_lock(file)
+
+		obtain_shared_lock(file)
+	rescue Exception
+		file.close if file
+		raise
+	end
+
+	return ca
+end #}}}1
+
+def save
+#{{{1
+	if @file.nil? then
+		return
+	end
+
+	print_verbose "saving file '#{@filename}'"
+
+	obtain_exclusive_lock(@file)
+	@file.truncate(0)
+	@file.rewind
+	write_mbox(@file)
+	@file.flush
+	obtain_shared_lock(@file)
+end #}}}1
+
+def close
+#{{{1
+	autosave(0)
+	save
+	print_verbose "closing file '#{@filename}'"
+	if @file then
+		release_lock(@file)
+		@file.close
+	end
+	@file = nil
+	@filename = nil
+	clear
+end #}}}1
+
+def autosave(seconds)
+#{{{1
+	print_debug "autosave(#{seconds}) called"
+	if @autosave_thread then
+		print_debug "  killing old thread"
+		@autosave_thread.kill
+		@autosave_thread = nil
+	end
+
+	if seconds == 0 then
+		print_debug "  returning because seconds==0"
+		return
+	end
+
+	print_verbose "starting autosave thread"
+	@autosave_thread = Thread.new do
+		while true
+			print_verbose "autosaving at #{Time.now}"
+			save
+			sleep(seconds)
+		end
+	end
+end #}}}1
+
+
+private 
+
+
+def ClipArray.read_mbox(file)
+#{{{1
+	ca = self.new
+	first_line = true
+	str = ""
+	i = 1
+
+	print_debug "reading clips, mbox format"
+
+	if file.eof? or file.readline =~ /^From / then
+		# valid
+	else
+		raise AppError, "Not an Mbox file"
+	end
+
+	file.each_line do | line |
+	line.chomp!
+		if line =~ /^From / then
+			if not first_line then
+				clip = Clip.from_mbox(unescape_from(str))
+				if clip.type == :pref then
+					ca.pref = Preferences.read(clip.data)
+					print_debug "  #{i}: Preferences"
+				else
+					ca << clip
+					print_debug "  #{i}: '#{clip.title}'"
+				end
+				i += 1
+			end
+			str = ""
+		else
+			str << line << "\n"
+		end
+		first_line = false
+	end
+
+	if str != "" then
+		clip = Clip.from_mbox(unescape_from(str))
+		if clip.type == :pref then
+			ca.pref = Preferences.read(clip.data)
+			print_debug "  #{i}: Preferences"
+		else
+			ca << clip
+			print_debug "  #{i}: '#{clip.title}'"
+		end
+	end
+
+	ca.current_index = ca.length - 1
+	return ca
+end #}}}1
+
+def write_mbox(file)
+#{{{1
+	print_debug "writing clips, mbox format"
+	i = 1
+
+	# Pref clip first
+	pc = Clip.new
+	pc.type = :pref
+	pc.title = "Preferences"
+	pc.data = @pref.write
+
+	([pc]+self).each do | clip |
+		file.print "From %s@localhost %s\n" % 
+			[Version::PROGRAM_NAME, Time.now.ctime]
+		file.print(escape_from(clip.to_mbox.chomp))
+		file.print("\n")
+		print_debug "  #{i}: '#{clip.title}'"
+		i += 1
+	end
+end #}}}1
+
+end # class
+
+# vim600: set foldmethod=marker: