diakonos 0.8.11 → 0.9.8

data/help/scripting.dhf

@@ -0,0 +1,92 @@
+# Scripting Diakonos
+
+Diakonos has several features and mechanisms that allow you to manipulate it
+using Ruby, a beautiful yet powerful programming language
+(http://www.ruby-lang.org).
+
+## Working with Selected Text
+
+Select the text you wish to operate on (by pressing <Ctrl-space> and moving
+the cursor).  You can then work with the text in one of three ways:
+
+1. as a contiguous string of characters
+2. iterating over each line
+3. as an array of lines
+
+### As a String
+
+Press <Shift-F7> to work with the text as if it were one big string (multiple
+for Ruby code that uses the variable "str".  For example, entering
+
+  str.upcase
+
+will convert the selected text to uppercase.
+
+### Iterating Over Each Line
+
+Press <F7> to iterate over each line of selected text.  You will be prompted
+for Ruby code which will act as the body of a Ruby block which uses the
+variable "line" and evaluates to a String.  For example:
+
+  line.strip.squeeze( ' ' )
+
+will strip off whitespace from the beginning and end of each line and then
+collapse all consecutive sequences of spaces into single spaces.
+
+### As an Array of Lines
+
+Press <Alt-F7> to work with the text as if it were an Array of lines.  You
+will be prompted for Ruby code which operates on the array variable "lines".
+For example:
+
+  lines.find_all { |l| /foo/ === l }
+
+will replace the selected lines with the lines that match the regular expression
+/foo/.
+
+  lines.sort
+
+will sort the selected lines.
+
+## Startup Scripts
+
+Any file placed in ~/.diakonos/scripts/ will be require-d (as Ruby code) when
+Diakonos starts up.  Any valid Ruby code can be placed there.  Advanced users
+can even manipulate Diakonos itself by referencing the $diakonos global
+variable.
+
+After the startup scripts are require-d, Diakonos evaluates any Ruby code given
+with the -e command line argument.  Here is an example of using the -e argument
+to initiate a search on startup:
+
+  diakonos -e 'find "search expression", case_sensitive: true' filename
+
+See also the documentation on extensions.
+
+## Hooks
+
+Diakonos provides a means for you to execute arbitrary Ruby code when certain
+events occur.  In other words, you can "hook" code onto the events.  At
+present, the following hooks are available:
+
+  :after_buffer_switch
+  :after_open
+  :after_save
+  :after_startup
+
+To hook onto one of these events, place code into the ~/.diakonos/scripts/
+directory.  Example hook code can be seen at
+
+  http://github.com/Pistos/dk-git/blob/master/git-branch.rb
+
+Your code should create a Proc object (possibly with a block parameter,
+depending on the hook), and then register it with the following syntax:
+
+  $diakonos.register_proc( my_proc, :after_open )
+
+The register_proc method takes an optional third parameter: an integer
+indicating the relative priority for your Proc.  Lower numbers are used for
+greater priority (like the UNIX "niceness" level).  Procs registered for the
+same hook are executed in order of priority.
+
+Tags: script scripts scripting program programming language ruby select selected text manipulate manipulating operate operating change changing work working line lines adjust adjusting hook hooks hooking proc procedure block trigger triggers method function functions start up startup

data/help/search.dhf

@@ -0,0 +1,103 @@
+# Searching for and Replacing Text
+
+## Executive Summary
+
+### Searching
+
+<Ctrl-F>            Begin search
+<F3>                Find next
+<Ctrl-R>            Begin search and replace
+
+<Ctrl-Alt-U>        Clear match highlighting
+<Alt-F>             Begin case-sensitive search
+<Ctrl-Alt-F>        Begin upward search
+<Shift-F3>          Find next upwards
+
+While typing search expression:
+
+<Enter>             Confirm search expression
+<Esc> <Esc>         Abort search
+
+### Grepping
+
+<Alt-G>             Grep current buffer
+<Alt-Shift-G>       Grep all buffers
+<Ctrl-Alt-G>        Grep a directory
+
+While typing grep expression:
+
+<Up>, <Down>        Select a grep result to jump to
+<Enter>             Jump to selected grep result
+<F5>                Decrease context around matches
+<F6>                Increase context around matches
+<Esc> <Esc>         Abort grep
+
+
+## Searching for Text
+
+Press <Ctrl-F> to perform a case-insensitive search for text.  You will be
+prompted for what to search for.  As you type your search expression,
+matching text will be highlighted.  You can try it right now as you read this
+document!  Press <Ctrl-F> and then type the word "text".  Press <Esc> twice to
+abort the search.  If the find.return_on_abort setting is set to true, then the
+cursor will return to where it was when the search began.  Otherwise, it will
+remain where the last search brought it.
+
+What you type will be interpreted as a regular expression.  (If you don't know
+what a regular expression is, search the Internet, or read the Wikipedia
+article: http://en.wikipedia.org/wiki/Regular_expression )
+
+Press <Enter> to submit your search expression, and Diakonos will keep the
+cursor on the first match it found and select it.  That is, it selects the
+closest match below the point where you initiated the search.  Press <F3> to
+move the cursor to the next match.
+
+To clear the highlighting on matches, press <Ctrl-Alt-U>.
+
+### Advanced Searching
+
+Use <Alt-F> to do a case-sensitive regular expression search.  <Ctrl-Alt-F>
+will search upwards (backwards), and <Shift-F3> will repeat a search upwards.
+
+The findExact function will perform a search which does not consider the
+search expression to be a regular expression, but rather a literal string.
+There is no default key mapping for findExact; use <F12> to modify your
+configuration.  Alternatively, you can press <Shift-F2> and enter "findExact"
+to execute the function directly.
+
+If you select text before searching, the search will be restricted to the
+selected text.  Even repeated searches with <F3> will be restricted.
+
+## Replacing Text
+
+Press <Ctrl-R> to replace text.  As with searching, you will be prompted for
+what to search for.  Press <Enter> to submit your search expression, and then
+you will be prompted for the replacement text.  Press <Enter> to submit the
+replacement text.
+
+Diakonos will then highlight each individual match and ask whether or not you
+wish to replace the selected text.  You can also choose to replace all matches
+throughout the file at once.
+
+The search expression you provide is considered a regular expression.  You can
+also use parentheses to capture groups, and refer to those groups on your
+replacement string with \1, \2, etc., which correspond to the first group, the
+second group, etc.
+
+## Grepping
+
+Press <Ctrl-Alt-G> to begin grepping files under a directory (recursively).
+Specify the directory, then press <Enter>. Then begin typing a regular
+expression.  The display will update as you type according to the matches
+found.  If you see a match you'd like to jump to, use <Down> (and <Up>) to
+select a match, and press <Enter> to view that line of that file.  Press <Esc>
+twice to abort the grep.
+
+If you need to see more context around the matches, press <F6> during the grep.
+<F5> reduces the context.  The grep.context setting is used for the default
+amount of context to show.
+
+Use <Alt-Shift-G> to grep through all open buffers, <Alt-G> to grep only the
+current buffer.
+
+Tags: search searching replace replacing find finding text string regex regexp regular expression grep grepping dir dirs directory buffer buffers file files

data/help/shell.dhf

@@ -0,0 +1,60 @@
+# External Programs
+
+Diakonos has several functions available that you can map to keys in order to
+execute external programs, scripts and applications: shell, execute and
+pasteShellResult. Each one takes an optional string argument, which is the
+shell command to execute.  If no argument is given, the user is prompted for
+the command to execute.
+
+shell will run the command and show the results in a new buffer.  execute will
+run the command, and allow you to interact with it, but discard the results.
+pasteShellResult will paste the command's results at the current cursor
+location.
+
+The shell command also takes an optional second parameter which lets you
+specify the file to which the shell results are to be written.
+
+Press <F2> to specify an arbitrary command to run with 'shell'.
+Press <F8> to specify an arbitrary command to run with 'execute'.
+
+## Shell Variables
+
+The command strings to these commands given can contain any of the following
+variables:
+
+$f  the current buffer's filepath
+$d  the current buffer's directory
+$F  all current buffer filepaths, space-separated
+$i  a string obtained from user input
+$c  temp file containing current clipboard text
+$k  temp file containing current klipper (KDE clipboard) text
+$s  temp file containing currently selected text
+
+## Examples
+
+The following examples are found in the default configuration file.
+
+
+key ctrl+alt+c    shell "ruby -c $f"
+
+Press <Ctrl-Alt-C> to check the Ruby syntax of the current buffer.
+
+
+key esc d         shell "diff -U 5 -w -b $c $s", "clipboard.diff"
+
+Press <Alt-D> to diff the current clipboard text against the currently selected
+text, and write the result to a file named clipboard.diff.
+
+
+key esc l         execute "aspell check $f"
+
+Press <Alt-L> to interactively spell check the current file with the aspell
+program.  (This keychord is not active in the default configuration.)
+
+
+key f9            shell "cd $d; git diff --ignore-space-change -- $f", 'git.diff'
+
+Press <F9> to see all changes made to the current buffer that have not been
+committed to the git repository yet.
+
+Tags: shell system exec execute spawn spawning executing shelling out external program programs application app apps applications variable variables substitute substitution spell spelling check git diff difference

data/help/speed.dhf

@@ -0,0 +1,23 @@
+# Speeding Up Diakonos
+
+Diakonos is known to run a little slower on some less-powerful systems.  Here
+are some of the things you can do to speed up Diakonos.  Each one involves a
+tradeoff between editor features and speed.  You don't need to enact them all,
+just do whatever you need or can sacrifice.
+
+- Turn off the context line ("content.visible false" in the config file).
+
+- After a successful find, unhighlight the found items, if you don't need to
+see them any more (Ctrl-Alt-U by default).
+
+- Turn off syntax highlighting by specifying a file type of "text"
+(Alt-Shift-T to specify the type).  Alternatively, just reduce the number or
+complexity of highlight definitions in the language you are using.  More
+highlight definitions means more work for Diakonos during display.
+
+- If you are using a graphical desktop (such as KDE or Gnome), change the size
+of the window to something smaller, since this will mean fewer characters for
+Diakonos to redraw.  Equivalently, for raw console (TTY) users, try a larger
+font size for a similar effect.
+
+Tags: slow diakonos speed speed-up speedup fast faster draw redraw screen font context line quick quicker syntax highlight highlighting

data/help/support.dhf

@@ -0,0 +1,15 @@
+# Support
+
+You can chat about Diakonos in the ##pistos channel of the Libera IRC
+network.
+
+Go to the IRC channel for technical support, or to give feedback and commentary
+about Diakonos.  It's the place go for bug reports, feature requests and tech
+support.  Even if Pistos is not around, he will eventually read anything you
+have to say.
+
+If IRC is not your thing, you can file bug reports at the issue tracker:
+
+  https://github.com/Pistos/diakonos/issues
+
+Tags: help support technical tech contact email e-mail info information chat irc channel pistos author creator

data/help/switch-buffers.dhf

@@ -0,0 +1,15 @@
+# Switching Buffers
+
+To switch between buffers, press Alt-number, with the number corresponding to
+the index of the buffer you wish to change to.  For example, <Alt-1> will
+switch to the first buffer, <Alt-3> will switch to the third buffer, and so on.
+
+You can also browse through the buffers by pressing <Alt-minus> and <Alt-=>.
+
+To bring up a list of the currently open files, press <Ctrl-Alt-B>.  There are
+two ways to select a buffer from this list: Either type the number or letter
+shown in the left column corresponding to the file you wish to switch to, or
+use the <Up> and <Down> arrow keys to select a buffer, and press <Enter> to
+switch to it.
+
+Tags: switch switching buffer buffers file files change between list current currently open

data/help/tabs.dhf

@@ -0,0 +1,36 @@
+# Tab Characters
+
+## Indenting with tab characters instead of spaces
+
+By default, Diakonos indents with spaces.
+
+To insert a single tab character, press <Ctrl-T>.
+
+To make Diakonos always indent with tab characters, look for the indent
+settings for the language whose behaviour you wish to configure.  For example,
+to change the indentation of Ruby, add the following line to your configuration
+file (<F12>):
+
+lang.ruby.indent.using_tabs true
+
+## Changing the width of tab characters
+
+The width of a tab character depends on the language of the file.  To change
+the width for a specific language, change the tabsize setting for the
+language.  For example, to change the tab size of Ruby files, open the
+configuration file by pressing <F12>, and look for a line like this:
+
+lang.ruby.tabsize 2
+
+Then change the number 2 to whatever number you desire, such as 4.
+
+## Converting tab characters
+
+Diakonos can convert tabs to spaces when files are opened.  Set the
+convert_tabs configuration option to true:
+
+convert_tabs true
+
+By default Diakonos does not do this.
+
+Tags: tab tabs indent indenting indentation insert space spaces whitespace char character characters width size number

data/help/undo.dhf

@@ -0,0 +1,9 @@
+# Undoing
+
+Use <Ctrl-Z> to undo one or more of the most recent changes you've made to the
+current file.  Each file has its own undo history.
+
+Use <Ctrl-Y> to redo one or more changes that you've undone.
+
+
+Tags: undo undoing mistake back revert redo

data/help/uninstall.dhf

@@ -0,0 +1,18 @@
+# Uninstalling Diakonos
+
+To uninstall Diakonos, simply run diakonos with an --uninstall switch:
+
+  diakonos --uninstall
+
+Diakonos will list all the files and directories that will be removed from your
+system, and prompt you for confirmation.  Diakonos does not install hidden
+files that are not shown to you.
+
+The only other Diakonos-related files on your system will be under your home
+directory, inside ~/.diakonos . These are not uninstalled, to allow you to
+upgrade Diakonos and preserve your settings and customizations.  The
+~/.diakonos directory can be removed manually, or even edited if you are an
+advanced user.
+
+
+Tags: install installing installation uninstall uninstalling uninstallation remove removal removing

data/help/welcome.dhf

@@ -0,0 +1,32 @@
+# Welcome to Diakonos!
+
+Hello, and welcome to Diakonos!  My name is Pistos; I am the author of Diakonos,
+and I would like to thank you for trying the Diakonos text editor.
+
+I have crafted Diakonos with ease of use in mind, so I hope you find it the
+most easy-to-use console text editor available for Linux.  If you have any
+suggestions, questions or comments, please share your thoughts in the ##pistos
+channel of the Libera IRC network.
+
+## Getting Started
+
+Press <F1> at any time to activate Diakonos' interactive help system.
+
+## Gnome Terminal
+
+Gnome Terminal by default has several keyboard shortcuts which conflict with
+Diakonos.  For a smoother Diakonos experience, you should disable as many of
+these as you are comfortable with.  To edit Gnome Terminal's keyboard
+shortcuts, go to the Edit menu, then select Keyboard Shortcuts.  Double click
+a shortcut and press Backspace to disable it; repeat for each shortcut you
+wish to disable.
+
+## Removing the Welcome Message
+
+To stop this welcome message from appearing, edit the configuration file (by
+pressing <F12>), add the line "suppress_welcome true", and press <Ctrl-S> to
+save your change.
+
+
+
+Tags: diakonos welcome intro introduction getting started starting new newb newbie remove message

data/help/word-wrap.dhf

@@ -0,0 +1,17 @@
+# Word Wrap
+
+Press <Alt-W> and Diakonos will perform basic word wrapping of the paragraph
+under the cursor.  Paragraphs are considered to be delineated by empty lines
+before and after.
+
+The wrap_margin setting of a language controls the column at which word
+wrapping will occur.  For example, to change the margin for text files, set
+this setting:
+
+lang.text.wrap_margin   80
+
+where 80 is the maximum line length allowed.
+
+Diakonos does not have any facility to do soft wrapping.
+
+Tags: word wrap wrapping hard soft cr carriage return paragraph format formatting margin margins column line length conf config configure configuring set setting settings

data/lib/diakonos/about.rb

@@ -0,0 +1,69 @@
+module Diakonos
+  class Diakonos
+
+    def about_write
+      File.open( @about_filename, "w" ) do |f|
+        inst = ::Diakonos::INSTALL_SETTINGS
+
+        configs = @configs.map(&:to_s).join("\n")
+
+        ext_loaded = @extensions.loaded_extensions.sort_by { |e|
+          e.name.downcase
+        }.map { |e|
+          %{
+### #{e.name} #{e.version}
+#{e.description}
+          }.strip
+        }.join( "\n\n" )
+
+        ext_not_loaded = @extensions.not_loaded_extensions.sort.map { |e|
+          "### #{e} (NOT LOADED)"
+        }.join( "\n" )
+
+        installation_artifact = File.join(inst[:lib_dir], 'diakonos', 'installation.rb')
+        if File.exist?(installation_artifact)
+          install_time = File.mtime(installation_artifact)
+        else
+          install_time = "--"
+        end
+
+        f.puts %{
+# About Diakonos
+
+Licence:        MIT Licence
+Copyright:      Copyright (c) 2004-#{ Time.now.year } Pistos
+
+## Version
+
+Version:        #{ ::Diakonos::VERSION }
+Code Date:      #{ ::Diakonos::LAST_MODIFIED }
+Install Time:   #{ install_time }
+Ruby Version:   #{ ::RUBY_VERSION }
+
+## Paths
+
+Home dir:       #{ @diakonos_home }
+
+### Installation
+
+Prefix:             #{ inst[ :prefix ] }
+Executable dir:     #{ inst[ :bin_dir ] }
+Help dir:           #{ inst[ :help_dir ] }
+System config dir:  #{ inst[ :conf_dir ] }
+System library dir: #{ inst[ :lib_dir ] }
+
+### Configuration Files
+
+#{ configs }
+
+## Extensions
+
+#{ ext_loaded }
+
+#{ ext_not_loaded }
+        }.strip
+      end
+    end
+
+  end
+end

data/lib/diakonos/bookmark.rb

@@ -0,0 +1,46 @@
+module Diakonos
+
+  class Bookmark
+
+    attr_reader :buffer, :row, :col, :name
+
+    def initialize( buffer, row, col, name = nil )
+      @buffer = buffer
+      @row = row
+      @col = col
+      @name = name
+    end
+
+    def == (other)
+      return false if other.nil?
+      ( @buffer == other.buffer && @row == other.row && @col == other.col )
+    end
+
+    def <=> (other)
+      return nil if other.nil?
+      comparison = ( $diakonos.buffer_to_number( @buffer ) <=> $diakonos.buffer_to_number( other.buffer ) )
+      return comparison if comparison != 0
+      comparison = ( @row <=> other.row )
+      return comparison if comparison != 0
+      @col <=> other.col
+    end
+
+    def < (other)
+      ( ( self <=> other ) < 0 )
+    end
+    def > (other)
+      ( ( self <=> other ) > 0 )
+    end
+
+    def shift( row_inc, col_inc )
+      row += row_inc
+      col += col_inc
+    end
+
+    def to_s
+      "[#{@name}|#{@buffer.name}:#{@row+1},#{@col+1}]"
+    end
+
+  end
+
+end

data/lib/diakonos/buffer/bookmarking.rb

@@ -0,0 +1,47 @@
+module Diakonos
+
+  class Buffer
+
+    def go_to_next_bookmark
+      cur_pos = Bookmark.new( self, @last_row, @last_col )
+      next_bm = @bookmarks.find do |bm|
+        bm > cur_pos
+      end
+      if next_bm
+        cursor_to( next_bm.row, next_bm.col, DO_DISPLAY )
+      end
+    end
+
+    def go_to_previous_bookmark
+      cur_pos = Bookmark.new( self, @last_row, @last_col )
+      # There's no reverse_find method, so, we have to do this manually.
+      prev = nil
+      @bookmarks.reverse_each do |bm|
+        if bm < cur_pos
+          prev = bm
+          break
+        end
+      end
+      if prev
+        cursor_to( prev.row, prev.col, DO_DISPLAY )
+      end
+    end
+
+    def toggle_bookmark
+      bookmark = Bookmark.new( self, @last_row, @last_col )
+      existing = @bookmarks.find do |bm|
+        bm == bookmark
+      end
+      if existing
+        @bookmarks.delete existing
+        $diakonos.set_iline "Bookmark #{existing.to_s} deleted."
+      else
+        @bookmarks.push bookmark
+        @bookmarks.sort
+        $diakonos.set_iline "Bookmark #{bookmark.to_s} set."
+      end
+    end
+
+  end
+
+end