naksh 0.2.0

data/docs/userguide/en/old_naksh.xml

@@ -0,0 +1,180 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+<!-- SYMBOLIC ENTITIES -->
+<!ENTITY appversion "0.2.0"> <!-- the version of the application -->
+<!ENTITY manrevision "0.0.1"><!-- the revision number of this manual -->
+<!ENTITY date "January 2008"><!-- the release date of this manual -->
+<!ENTITY app "<application>Naksh</application>">
+<!-- the name of the application -->
+<!-- INCLUDED FILES -->
+<!ENTITY introduction SYSTEM "introduction.xml">
+<!ENTITY gettingstarted SYSTEM "getting-started.xml">
+<!ENTITY settings SYSTEM "settings.xml">
+<!ENTITY bugs SYSTEM "bugs.xml">
+<!ENTITY about SYSTEM "about.xml">
+<!ENTITY gnufdl SYSTEM "gnu-fdl-1.2.xml">
+
+<!-- CHARACTER MNEMONICS -->
+<!ENTITY copy "&#169;"> <!-- copyright sign -->
+]>
+<!--
+  This is part of the Naksh Manual.
+  Copyright (C) 2011-2008 Mahmut Bulut
+  See the file alexandria.xml for copying conditions.
+-->
+<!--
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.2
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+  A copy of the license is included in the section entitled "GNU
+  Free Documentation License" (see the file gnu-fdl-1.2.xml).
+-->
+
+<!--
+This document is based upon a GNOME documentation template, designed
+by the GNOME Documentation Project Team.
+-->
+
+<!--
+(Do not remove this comment block.)
+Maintained by the GNOME Documentation Project
+http://developer.gnome.org/projects/gdp
+Template version: 2.0 beta
+Template last modified Apr 11, 2002
+-->
+
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+
+  <!-- please do not change the id; for translations, change lang to -->
+  <!-- appropriate code -->
+
+  <articleinfo>
+    <title>&app; Manual</title>
+
+    <copyright>
+      <year>2011</year>
+      <holder>Cathal Mc Ginley</holder>
+    </copyright>
+    <copyright>
+      <year>2005</year>
+      <holder>Liam Davison</holder>
+    </copyright>
+    <!-- translators: uncomment this:
+   <copyright>
+   <year>2011</year>
+   <holder>TRANSLATOR_NAME (LANGUAGE translation)</holder>
+   </copyright>
+    -->
+
+    <legalnotice id="legalnotice">
+      <para>
+  Permission is granted to copy, distribute and/or modify this
+  document under the terms of the GNU Free Documentation License,
+  Version 1.2 or any later version published by the Free Software
+  Foundation; with no Invariant Sections, no Front-Cover Texts,
+  and no Back-Cover Texts. A copy of the license is included in
+  the section entitled <xref linkend="gfdl"/>.
+      </para>
+    </legalnotice>
+
+
+    <authorgroup>
+      <author>
+  <firstname>Liam</firstname>
+  <surname>Davison</surname>
+  <affiliation>
+    <orgname>&app; documentation writing</orgname>
+    <address> carnegie@liamjdavison.info<email>carnegie@liamjdavison.info</email> </address>
+  </affiliation>
+      </author>
+      <othercredit role="maintainer">
+  <firstname>Cathal</firstname>
+  <surname>Mc Ginley</surname>
+  <affiliation>
+    <orgname>&app; developers</orgname>
+    <address> <email>cathal.alexandria@gnostai.org</email> </address>
+  </affiliation>
+  <contrib>Maintenance</contrib>
+      </othercredit>
+      <!-- This is appropriate place for other contributors: translators,
+     maintainers,  etc. Commented out by default.
+
+     <othercredit role="translator">
+     <firstname>Latin</firstname>
+     <surname>Translator 1</surname>
+     <affiliation>
+     <orgname>Latin Translation Team</orgname>
+     <address> <email>translator@gnome.org</email> </address>
+     </affiliation>
+     <contrib>Latin translation</contrib>
+     </othercredit>
+      -->
+    </authorgroup>
+
+    <!-- According to GNU FDL, revision history is mandatory if you are -->
+    <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
+    <!-- Remember to remove the &manrevision; entity from the revision entries -->
+    <!-- other than the current revision. -->
+
+    <revhistory>
+      <revision>
+  <revnumber>Alexandria Manual V&manrevision;</revnumber>
+  <date>&date;</date>
+  <revdescription>
+    <para role="author">Cathal Mc Ginley
+    <email>cathal.alexandria@gnostai.org</email></para>
+    <para role="publisher">Alexandria Documentation</para>
+  </revdescription>
+      </revision>
+      <revision>
+  <revnumber>Alexandria Manual V0.0.8</revnumber>
+  <date>November 2005</date>
+  <revdescription>
+    <para role="author">Liam Davison
+    <email>carnegie@liamjdavison.info</email></para>
+    <para role="publisher">Alexandria Documentation</para>
+  </revdescription>
+      </revision>
+    </revhistory>
+
+    <releaseinfo>This manual describes version &appversion; of &app;</releaseinfo>
+
+    <legalnotice id="feedback">
+      <title>Feedback</title>
+
+      <para>Alexandria is not an official part of GNOME. To report a bug
+      or make a suggestion regarding the &app; application or this
+      manual, follow the directions on the <ulink
+      url="http://alexandria.rubyforge.org/feedback.html"
+      type="http">&app; Feedback web page</ulink>.
+      </para>
+
+    </legalnotice>
+    <!-- Translators may also add here feedback address for translations -->
+
+  </articleinfo>
+
+  <indexterm zone="index">
+    <primary>Alexandria</primary>
+  </indexterm>
+
+  <!-- ============= Document Body ============================= -->
+
+  &introduction;
+  &gettingstarted;
+  &addingbooks;
+  &editingbookproperties;
+  &workingwithlibraries;
+  &searching;
+  &smartlibraries;
+  &exporting;
+  &settings;
+  &bugs;
+  &about;
+
+  &gnufdl;
+
+</article>

data/docs/userguide/en/userguide-en.omf

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE omf PUBLIC "-//OMF//DTD Scrollkeeper OMF Variant V1.0//EN" "http://scrollkeeper.sourceforge.net/dtds/scrollkeeper-omf-1.0/scrollkeeper-omf.dtd">
+<omf><!-- why not use xml:lang? -->
+  <resource>
+    <creator>
+      scienceblock@gmail.com (Mahmut Bulut)
+    </creator>
+    <maintainer>
+      scienceblock@gmail.com (Mahmut Bulut)
+    </maintainer>
+    <contributor>
+      fedzor
+    </contributor>
+    <contributor>
+      Antonio Salazar
+    </contributor>
+    <title>
+      Naksh Manual
+    </title>
+    <date>
+      2011-21-05
+    </date>
+    <version identifier="0.2.0" date="2011-21-05" description="Initial Developer Version"/>
+    <subject category="Applications|Utilities|Terminals"/>
+    <description>
+      A general-purpose shell written in Ruby
+    </description>
+    <type>
+      user's guide
+    </type>
+    <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/>
+    <identifier url="file://usr/share/doc/naksh/naksh.xml"/><!-- this should be a variable set upon installation -->
+    <language code="Ruby"/><!-- maybe the language element should have content, maybe I am misusing the code attribute -->
+    <relation seriesid="1d5fa320-bd0b-11dc-946b-ea1420edaf2f"/>
+    <rights type="GNU FDL" license.version="1.1" holder="Mahmut Bulut"/>
+  </resource>
+</omf>

data/lib/naksh.rb

@@ -0,0 +1,165 @@
+#!/usr/local/bin/ruby
+# 2011 Mahmut Bulut
+
+# This file is part of Naksh.
+#
+# Naksh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Naksh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Naksh.  If not, see <http://www.gnu.org/licenses/>.
+
+
+require 'gettext'
+require 'pathname'
+
+dir=Pathname.new(__FILE__).realpath
+Dir.chdir(File.dirname(__FILE__))
+
+module Naksh
+
+  #anything that won't kill naksh should mixin this
+  module NonCriticalError
+  end
+
+end
+
+
+
+require 'naksh/configuration/hash.rb'
+Naksh.config['/env/runmode']= ($0==__FILE__)? 'interactive' : 'lib'
+
+if ((Pathname.new(Naksh.config['/dir'])+'lib'+'naksh.rb').to_s !=dir.to_s rescue true)
+  $stdout.puts 'Naksh configuration information is inaccurate. Loading defaults...'
+  require 'naksh/defaults.rb'
+end
+
+Naksh.config['/env/pwd']=   Pathname.new((ENV["PWD"] or Dir.pwd)).realpath.to_s
+Naksh.config['/env/user']=  ENV['USER'] or ENV['USERNAME'] or ''
+Naksh.config['/env/home']=  (ENV['USERPROFILE'] or ENV["HOME"] or '')
+Naksh.config['/env/host']=  (ENV['COMPUTERNAME'] or '')
+Naksh.config['/env/pwd']=   Naksh.config['/env/home'] if Naksh.config['/env/home']
+Naksh.config['/env/locale']=         'en'
+Naksh.config['/meta/svn/revision']=  `svn info`[/Revision: (\d+)/,1].to_i rescue -1
+require 'naksh/buffer.rb'
+require 'naksh/stdlibext.rb'
+require 'naksh/path_entry.rb'
+require 'naksh/command_handling.rb'
+require 'naksh/history.rb'
+require 'naksh/session.rb'
+require 'naksh/interfaces.rb'
+require 'naksh/syntax.rb'
+#hack to make stuff work if you don't use gettext
+def _(str)
+  str
+end unless respond_to? :_
+
+module Naksh
+  module Commands
+  end
+
+
+  def Naksh.attempt_submit config_entry
+    case Naksh.config[config_entry]
+      when 'submit'
+        input=Naksh.interface.in
+        Naksh.interface.on_pre_submit
+        if Naksh.syntax.complete? input
+          begin
+            return false unless Naksh.syntax.try_execute(input)
+          rescue Naksh::NonCriticalError=>error
+            Naksh.buffer.clear
+            Naksh.interface.err.print((_('Naksh: %s')%[error.to_s])<<"\n")
+          end
+          Naksh.current_session.history.position=Naksh.current_session.history.length
+          Naksh.current_session.history<<input
+          Naksh.interface.new_prompt
+          return true
+        else
+          return false
+        end
+      when 'char'
+        return false
+      else
+        $stderr.puts _("Naksh.config[%s] has unrecognized value: %s")%[config_entry,Naksh.config[config_entry].inspect]
+        return nil
+    end
+    raise RuntimeError,_('this should never be executed')
+  end
+
+
+  def Naksh.quit
+    Naksh.interface.quit
+    true
+  end
+
+  #this should be a spell checker
+  #Naksh.suggestions('xml-cpy-editor')#=>'xml-copy-editor'
+  #autocomplete is the next best thing
+  def Naksh.suggestions(com_str)
+    Naksh.autocomplete(com_str)
+  end
+
+
+  #replaces %{var} with var.value
+  def Naksh.replace_vars(str)
+    str=str.gsub('%{pwd}',Naksh.config['/env/pwd'].sub(/\A/+Naksh.config['/env/home'],'~'))
+    str.gsub!('%{user}',Naksh.config['/env/user'])
+    str.gsub!('%{host}',Naksh.config['/env/host'])
+    str
+  end
+
+
+  def Naksh.evaluate_path(str)
+    if path.match(/\A\//) and File.exist? path
+      return path
+    else
+      Naksh.interface.err.puts _('addpath: invalid filepath')
+      return false
+    end
+  end
+
+
+end
+
+require 'naksh/syntax/bash.rb'
+Naksh.syntax=Naksh::Syntax::Bash
+
+#the order items are added to the path is the order they will be searched
+Naksh.path<<PathEntry.new('/home/mahmutbulut/Projects/naksh/lib/naksh/commands/naksh',:nkc_dir)
+Naksh.path<<PathEntry.new('/home/mahmutbulut/Projects/naksh/lib/naksh/commands/gnu',:nkc_dir)
+Naksh.path<<PathEntry.new('/home/mahmutbulut/Projects/naksh/lib/naksh/commands/bash',:nkc_dir)
+Naksh.path<<PathEntry.new('/usr/bin',:external_dir)
+
+if Naksh.config['/env/runmode']=='interactive'
+
+  case Naksh.config['/interface/default']
+    when 'tty'
+      require 'naksh/interfaces/tty.rb'
+      Naksh.interface=Naksh::Interfaces::Tty
+    when 'gtk'
+      require 'naksh/interfaces/gtk.rb'
+      Naksh.interface=Naksh::Interfaces::Rbgtk
+    when 'wxw'
+      require 'naksh/interfaces/wxw.rb'
+      Naksh.interface=Naksh::Interfaces::Wxw
+    when 'fox'
+      require 'naksh/interfaces/fox.rb'
+      Naksh.interface=Naksh::Interfaces::Fox
+    else
+      $stderr.puts "The configuration is requesting an unknown interface `#{Naksh.config['/interface/default']}'"
+  end
+
+  Naksh.buffer.err=Naksh.interface.err
+  Naksh.buffer.out=Naksh.interface.out
+
+  Naksh.interface.run(Naksh::Session.new)
+
+end

data/lib/naksh/buffer.rb

@@ -0,0 +1,153 @@
+#!/usr/local/bin/ruby
+# 2011 Mahmut Bulut
+
+# This file is part of Naksh.
+#
+# Naksh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Naksh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Naksh.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'stringio'
+
+module Naksh
+
+
+  #for internal buffers
+  #these should be replaced with a file
+  #named BufferClass for to prevent typing errors
+  class BufferClass
+
+
+    def initialize(inp=nil,out=nil,err=nil)
+      @in =inp
+      @out=out
+      @err=err
+      @new=String.new
+      @old=StringIO.new
+      @silenced=false
+    end
+
+    attr_accessor :in,:out,:err
+
+    def pp *a
+      a.each do |i|
+        @out.pp i.to_s
+      end
+      nil
+    end
+
+    def print *a
+      a.each do |i|
+        @out.print i.to_s
+      end
+      nil
+    end
+
+
+    def puts *a
+      a.each do |i|
+        @out.print i.to_s
+        @out.print "\n" unless i[-1]=="\n" or i[-1].chr=="\n"
+      end
+      nil
+    end
+
+
+    def fake_print *a
+      @new<<a.join('')
+      nil
+    end
+
+
+    def fake_puts *a
+      a.each do |i|
+        @new<<i.to_s
+        @new<<"\n" unless @new[-1]=="\n" or @new[-1].chr=="\n"
+      end
+      nil
+    end
+
+    alias_method :fake_pp,:fake_puts
+
+
+    alias_method :real_pp,   :pp
+    alias_method :real_print,:print
+    alias_method :real_puts, :puts
+
+
+    #see Buffer#silenced?
+    def silence
+      @silenced=true
+      self.class.class_eval('undef_method :print,:puts,:pp')
+      self.class.class_eval('alias_method :pp,   :fake_pp')
+      self.class.class_eval('alias_method :print,:fake_print')
+      self.class.class_eval('alias_method :puts, :fake_puts')
+    end
+
+    # if silenced? is true, Buffer#puts and Buffer#print
+    # are storing data for later use,
+    # and not sending it to Buffer#out
+    def silenced?
+      @silenced
+    end
+
+
+    #wipe anything stored and call self.speak
+    def clear
+      @old=StringIO.new
+      @new=String.new
+      speak
+    end
+
+
+    def speak
+      @silenced=false
+      self.class.class_eval('undef_method :print,:puts,:pp')
+      self.class.class_eval('alias_method :print,:real_print')
+      self.class.class_eval('alias_method :pp,   :real_pp')
+      self.class.class_eval('alias_method :puts, :real_puts')
+    end
+
+
+    #this is useful if you don't want incremental output, just a single final dump
+    def flush
+      @out.print @old.read
+    end
+
+
+    def gets
+      @old.gets
+    end
+
+    #just like gets, but throws an error at end of file
+    def readline
+      @old.readline
+    end
+
+    # this tells the buffer you're working on a new command,
+    # and anything you printed before should be getted now
+    def next
+      @old=StringIO.new(@new)
+      @new=String.new
+    end
+
+
+  end
+
+  @buffer    = BufferClass.new
+
+
+  def Naksh.buffer
+    @buffer
+  end
+
+end