@@ -1,11 +1,14 @@ module Diakonos module Functions + # Shows the About page, which gives information on Diakonos. def about about_write open_file @about_filename end + # Deletes characters up to, but not including, a given character. + # Also puts the deleted text into the clipboard. def delete_to( char = nil ) if char.nil? set_iline "Type character to delete to..." @@ -22,6 +25,10 @@ module Diakonos end end + # Deletes characters between, but not including, a given pair of + # characters. Also puts the deleted text into the clipboard. + # Brace characters are intelligently matched with their opposite-side + # counterparts if the left-side brace is given (e.g. '['). def delete_to_and_from( char = nil ) if char.nil? set_iline "Type character to delete to and from..." @@ -38,6 +45,7 @@ module Diakonos end end + # Evaluates (executes) Ruby code. def evaluate( code_ = nil ) if code_.nil? if @current_buffer.changing_selection @@ -70,6 +78,7 @@ module Diakonos end end + # Starts the interactive help system. def help( prefill = '' ) if ! File.exist?( @help_dir ) || Dir[ "#{@help_dir}/*" ].size == 0 set_iline 'There are no help files installed.' @@ -141,6 +150,7 @@ module Diakonos end end + # Loads Ruby code from file using Kernel#load. def load_script( name_ = nil ) if name_.nil? name = get_user_input( "File to load as script: ", history: @rlh_files ) @@ -203,6 +213,7 @@ module Diakonos set_iline "Type any chain of keystrokes or key chords, then press Enter..." end + # Quits Diakonos (gracefully). def quit @quitting = true to_all = nil @@ -234,6 +245,7 @@ module Diakonos refresh_all end + # Starts or stops macro recording. def toggle_macro_recording( name = nil ) if @macro_history stop_recording_macro @@ -242,10 +254,12 @@ module Diakonos end end + # Undoes the latest change made to the current_buffer. def undo( buffer = @current_buffer ) buffer.undo end + # Redoes the latest change undone on the current_buffer. def unundo( buffer = @current_buffer ) buffer.unundo end lib/diakonos/functions.rb @@ -15,10 +15,12 @@ module Diakonos @current_buffer.delete_selection end + # Calls Buffer#delete on the current_buffer. def delete @current_buffer.delete end + # Deletes the current line and adds it to the clipboard. def delete_line removed_text = @current_buffer.delete_line @clipboard.add_clip( [ removed_text, "" ] ) if removed_text lib/diakonos/functions/basics.rb @@ -1,7 +1,7 @@ module Diakonos module Functions - # Returns true iff the cursor changed positions + # @return [true,false] true iff the cursor changed positions def cursor_down @current_buffer.cursor_to( @current_buffer.last_row + 1, @@ -12,7 +12,7 @@ module Diakonos ) end - # Returns true iff the cursor changed positions + # @return [true,false] true iff the cursor changed positions def cursor_left( stopped_typing = Buffer::STOPPED_TYPING ) @current_buffer.cursor_to( @current_buffer.last_row, @@ -31,7 +31,7 @@ module Diakonos ) end - # Returns true iff the cursor changed positions + # @return [true,false] true iff the cursor changed positions def cursor_up @current_buffer.cursor_to( @current_buffer.last_row - 1, @@ -42,35 +42,40 @@ module Diakonos ) end + # Moves the cursor to the beginning of the current buffer. def cursor_bof @current_buffer.cursor_to( 0, 0, Buffer::DO_DISPLAY ) end + # Moves the cursor to the beginning of the current line. def cursor_bol @current_buffer.cursor_to_bol end + # Moves the cursor to the end of the current line. def cursor_eol @current_buffer.cursor_to_eol end + # Moves the cursor to the end of the current buffer. def cursor_eof @current_buffer.cursor_to_eof end - # Top of view + # Moves the cursor to the top of the viewport of the current buffer. def cursor_tov @current_buffer.cursor_to_tov end - # Bottom of view + # Moves the cursor to the bottom of the viewport of the current buffer. def cursor_bov @current_buffer.cursor_to_bov end + # Pops the cursor stack of the current buffer. def cursor_return( dir_str = "backward" ) stack_pointer, stack_size = @current_buffer.cursor_return( direction_of( dir_str, :backward ) ) - set_iline( "Location: #{stack_pointer+1}/#{stack_size}" ) + set_iline "Location: #{stack_pointer+1}/#{stack_size}" end def go_block_outer @@ -86,6 +91,7 @@ module Diakonos @current_buffer.go_block_previous end + # Moves the cursor to the next occurrence of the given character. def go_to_char( char = nil ) char ||= get_char( "Type character to go to..." ) @@ -97,6 +103,7 @@ module Diakonos end end + # Moves the cursor to the closest previous occurrence of the given character. def go_to_char_previous( char = nil ) char ||= get_char( "Type character to go to..." ) lib/diakonos/functions/cursor.rb 9f9e032615125e1b40d9992d8692f93eb448d431 Pistos gitsomegrace.5.pistos@geoshell.com http://github.com/Pistos/diakonos/commit/ac14a0267cf5a4efb7a5738113e65fb7140af120 ac14a0267cf5a4efb7a5738113e65fb7140af120 2009-07-06T08:05:11-07:00 2009-07-06T08:05:11-07:00 Added a smattering of rdocs. 04f43f643a5fe48a340464b979b41aaae0bedc8d Pistos gitsomegrace.5.pistos@geoshell.com