glaemscribe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e9f617d5136cabf67f2956d2e7f2ff819b10200
+  data.tar.gz: 10c475fd8eeb1008b491be028ef418ecc75975ab
+SHA512:
+  metadata.gz: 4df56fe4e0d19a4efa206fda5e2654d3670f2c579732ee2b6a30e58bcee2765034e10f0d5377dff7a6c3617b480dba7e1abf4decb462e7eb90838996578683ea
+  data.tar.gz: ebfd8a156d2a5a93ae25e455f80275da909891cdc47624bde2a8f37b09ba69c8f6c06267376d92bb6d08a12e237e8526f55350f44de44eb21d34dd6efd6d9dbb

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Glǽmscribe (also written Glaemscribe) is a software dedicated to
+the transcription of texts between writing systems, and more 
+specifically dedicated to the transcription of J.R.R. Tolkien's 
+invented languages to some of his devised writing systems.
+
+Copyright (C) 2015 Benjamin Babut (Talagan).
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/bin/glaemscribe

@@ -0,0 +1,307 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+#
+# Glǽmscribe (also written Glaemscribe) is a software dedicated to
+# the transcription of texts between writing systems, and more 
+# specifically dedicated to the transcription of J.R.R. Tolkien's 
+# invented languages to some of his devised writing systems.
+# 
+# Copyright (C) 2015 Benjamin Babut (Talagan).
+# 
+# This program 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
+# any later version.
+# 
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+###############
+#  ENV STUFF  #
+###############
+
+begin
+  require 'commander/import'
+rescue Exception => e
+  puts "The 'glaemscribe' binary requires the 'commander' gem to work. Please 'gem install commander' to make it work or add it to your Gemfile."
+  exit(0)
+end
+
+env_version = ""
+begin
+  # Try to load dev version before loading the gem one
+  require File.dirname(__FILE__) + "/../lib_rb/glaemscribe.rb"
+  env_version = " (DEVELOPER VERSION - LOADED FROM SRC DIRECTORY)"
+  Glaemscribe::API::Debug.enabled = false
+rescue Exception => e
+  # This is (probably) the gem version
+  require 'glaemscribe'
+end
+
+# Just a small monkey patch because I found commander lacks a new line at the beginning of its formatters
+module Commander
+  module HelpFormatter
+    class Terminal < Base
+      def render
+        "\n" + template(:help).result(ProgramContext.new(@runner).get_binding)
+      end
+    end
+  end
+end
+
+#############
+#  HELPERS  #
+#############
+
+def puts_available_modes
+  puts "\n #{$terminal.color 'Available modes are :', :bold }\n\n"
+  puts Glaemscribe::API::ResourceManager.available_mode_names.map{|k| ". " + k.strip}.join("\n")
+  puts "\n"
+end
+
+def perxit(error = nil, exit_code = nil)
+  STDERR.puts "*** " + error if(error)
+  exit(exit_code) if(exit_code)
+end
+
+def pereol
+  STDERR.puts "\n"
+end
+
+def profile
+  # Profile the code
+  RubyProf.start
+  yield()
+  result = RubyProf.stop
+  printer = RubyProf::MultiPrinter.new(result)
+  printer.print(:path => ".", :profile => "profile")
+end
+
+##############
+#  PROGRAMM  #
+##############
+
+program :name, "glaemscribe#{env_version}"
+program :version, '0.0.1'
+program :description, 'Glǽmscribe (also written Glaemscribe) is a software dedicated to the
+transcription of texts between writing systems, and more specifically
+dedicated to the transcription of J.R.R. Tolkien\'s invented languages 
+to some of his devised writing systems.'
+program :help, 'Author', 'Benjamin Talagan Babut'
+
+##############
+#  COMMANDS  #
+##############
+
+default_command :transcribe
+
+command :transcribe do |c|
+  
+  c.syntax      = 'glaemscribe transcribe file [options]'
+  c.summary     = 'Transcribes a file (default command)'
+  c.description = "Transcribes a file with the given options. You can use '-' instead of a file name to work with stdin."
+   
+  c.option '-m',  '--mode mode',                 String, "The name of the embedded mode to use. See the 'list' command to get a list of available modes names."
+  c.option '-c',  '--charset charset',           String, 'The name of the charset to use. If not given, glaemscribe will load and use the default charset defined in the mode.' 
+  c.option        '--modefile modefile',         String, 'Use a custom mode file instead of an embedded one. The file extension must be .glaem .'
+  c.option        '--charsetfile charsetfile',   String, 'Use a custom charset file instead of an embedded one. The file extension must be .cst .'
+  c.option '-o',  '--options name1:value1,name2:value2,...',   String, 'Pass options to the transcriptor (see the mode options documentation).'
+   
+  c.action do |args, options|
+      
+    filename = args[0]
+    # Let's do some checks
+    if !filename && options.__hash__.keys.count == 0
+      # Nothing at all given!
+      command(:help).run()
+      exit(123)
+    end
+   
+    if !filename
+      perxit("No file given for transcription.", 1)
+    end
+        
+    if !options.mode && !options.modefile
+      perxit("An option 'mode' (-m) or 'modefile' (--modefile) is mandatory!", 2)
+    end
+    
+    if options.mode && options.modefile
+      perxit("Option 'mode' (-m) and 'modefile' (--modefile) are not compatible. You have to chose!")
+    end
+    
+    if options.charset && options.charsetfile
+      perxit("Option 'charset' (-c) and 'charsetfile' (--charsetfile) are not compatible. You have to chose!")
+    end
+        
+    charset        = nil
+    charset_name   = nil
+    
+    # If given a charset_file, it should be loaded BEFORE so that we have it in our charset base
+    if options.charsetfile
+      # External charset file loading
+      charset_name   = Glaemscribe::API::ResourceManager.charset_name_from_file_path(options.charsetfile)
+      
+      begin
+        charset      = Glaemscribe::API::CharsetParser.new().parse(options.charsetfile)
+        # Put it in our base of charsets
+        Glaemscribe::API::ResourceManager.loaded_charsets[charset_name] = charset      
+      rescue Errno::ENOENT
+        perxit("Charset file '#{options.charsetfile}' could not be opened for reading.",3)
+      end
+    elsif options.charset
+      charset_name  = options.charset 
+      # Let the mode load the embedded charset
+    end
+           
+    mode      = nil
+    mode_name = nil
+  
+    if options.mode
+      # Embedded mode loading
+      mode_name = options.mode
+      
+      Glaemscribe::API::ResourceManager.load_modes([mode_name])
+      mode = Glaemscribe::API::ResourceManager.loaded_modes[mode_name]
+      
+      if !mode
+        perxit("Embedded #{mode_name} not handled!")
+        puts_available_modes
+        perxit(nil, 3)
+      end
+      
+    else
+      # External mode file loading
+      mode_name = Glaemscribe::API::ResourceManager.mode_name_from_file_path(options.modefile)
+      
+      begin
+        mode      = Glaemscribe::API::ModeParser.new().parse(options.modefile)
+      rescue Errno::ENOENT
+        perxit("Mode file '#{options.modefile}' could not be opened for reading.",3)
+      end
+      
+      Glaemscribe::API::ResourceManager.loaded_modes[mode_name] = mode   
+    end  
+         
+    if mode.errors.any?
+      pereol
+      perxit("The mode '#{mode_name}' contains errors. ")
+      mode.errors.each{ |e|
+        puts "** #{mode.name}:#{e.line}: #{e.text}"
+      }
+      pereol
+      perxit("Transcription cannot continue", 3)
+    end
+    
+    if mode.warnings.any?
+      pereol
+      perxit("The mode '#{mode_name}' contains warnings. ")
+      mode.warnings.each{ |e|
+        puts "** #{mode.name}:#{e.line}: #{e.text}"
+      }
+      pereol
+      perxit("Continuing transcription without guarantee...\n")     
+    end
+
+    # If a charset was forced (embedded or with external file), check that the mode supports it
+    if charset_name
+      charset       = mode.supported_charsets[charset_name]
+      perxit("Was asked to use charset '#{charset_name}', but the mode does not handle it. Aborting.", 12) if !charset
+    end
+    
+    if options.options
+      a = options.options.split(",").map{ |o| o.split(":") }.flatten.map{|s| s.strip }
+      opts = Hash[*a]
+      mode.finalize(opts)
+    end   
+    
+    # Ready for transcription ...
+  
+    if(filename == "-")
+      perxit "Opened in stdin mode, waiting for input..."
+      begin
+        while to_transcribe = STDIN.gets
+          success, ret = mode.transcribe(to_transcribe, charset) 
+          if success
+            STDOUT.puts ret
+          else
+            perxit("The transcription failed.")
+            perxit(ret, 42)    
+          end 
+        end
+      rescue Interrupt
+        perxit "Interrupted, end of session.", 42     
+      end
+    else
+            
+      to_transcribe = ""    
+      begin
+        File.open(args[0],"rb:utf-8") {|f|
+          to_transcribe = f.read
+        }
+      rescue Errno::ENOENT
+        perxit("File '#{args[0]}' could not be opened for reading.",3)
+      end
+          
+      success, ret = mode.transcribe(to_transcribe, charset)
+      
+      if success
+        STDOUT.puts ret
+      else
+        perxit("The transcription failed.")
+        perxit(ret, 42)    
+      end
+    end
+    
+  end  
+end
+
+command :list do |c|
+  
+  c.syntax      = 'glaemscribe list'
+  c.summary     = 'Lists all available embedded modes'
+  c.description = 'Lists all available embedded modes.'
+    
+  c.action do |args, options|
+    puts_available_modes  
+  end
+  
+end
+
+
+command :info do |c|
+  
+  c.syntax      = 'glaemscribe info'
+  c.summary     = "Displays information about an embedded mode"
+  c.description = "Displays information about the embedded mode 'modename'."
+    
+  c.action do |args, options|
+    
+    mode_name = args[0]
+    if !mode_name
+      perxit("No mode name given!", 2)
+    end
+  
+    Glaemscribe::API::ResourceManager.load_modes(mode_name)
+    mode = Glaemscribe::API::ResourceManager.loaded_modes[mode_name]
+    if !mode
+      perxit("Mode #{mode_name} not handled!")
+      perxit(nil, 3)
+    end
+    
+    puts "#{$terminal.color "Mode ID   " , :bold} : #{mode.name}"
+    puts "#{$terminal.color "Language  " , :bold} : #{mode.language}"
+    puts "#{$terminal.color "Writing   " , :bold} : #{mode.writing}"
+    puts "#{$terminal.color "Human Name" , :bold} : #{mode.human_name}"
+    puts "#{$terminal.color "Authors   " , :bold} : #{mode.authors}"
+    puts "#{$terminal.color "Version   " , :bold} : #{mode.version}"
+      
+  end
+  
+end
+
+

data/glaemresources/charsets/cirth_ds.cst

@@ -0,0 +1,205 @@
+\**
+
+Glǽmscribe (also written Glaemscribe) is a software dedicated to
+the transcription of texts between writing systems, and more 
+specifically dedicated to the transcription of J.R.R. Tolkien's 
+invented languages to some of his devised writing systems.
+
+Copyright (C) 2015 Benjamin Babut (Talagan).
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+**\
+
+
+\**   **\ \char 20 SPACE
+\** ! **\ \char 21 CIRTH_11
+\** " **\ \char 22 CIRTH_EREB_3
+\** # **\ \char 23 CIRTH_13
+\** $ **\ \char 24 CIRTH_14
+\** % **\ \char 25 CIRTH_15
+\** & **\ \char 26 CIRTH_EREB_4
+\** ' **\ \char 27 ?
+\** ( **\ \char 28 CIRTH_EREB_6
+\** ) **\ \char 29 CIRTH_EREB_7
+\** * **\ \char 2a CIRTH_EREB_5
+\** + **\ \char 2b CIRTH_NUMERAL_4
+\** , **\ \char 2c CIRTH_53
+\** - **\ \char 2d ?
+\** . **\ \char 2e CIRTH_54
+\** / **\ \char 2f CIRTH_55
+\** 0 **\ \char 30 CIRTH_10
+\** 1 **\ \char 31 CIRTH_1
+\** 2 **\ \char 32 CIRTH_2
+\** 3 **\ \char 33 CIRTH_3
+\** 4 **\ \char 34 CIRTH_4
+\** 5 **\ \char 35 CIRTH_5
+\** 6 **\ \char 36 CIRTH_6
+\** 7 **\ \char 37 CIRTH_7
+\** 8 **\ \char 38 CIRTH_8
+\** 9 **\ \char 39 CIRTH_9
+\** : **\ \char 3a CIRTH_EREB_2
+\** ; **\ \char 3b CIRTH_40
+\** < **\ \char 3c CIRTH_52_ALT
+\** = **\ \char 3d ?
+\** > **\ \char 3e CIRTH_55_ALT
+\** ? **\ \char 3f CIRTH_56_ALT
+\** @ **\ \char 40 CIRTH_12
+\** A **\ \char 41 CIRTH_41
+\** B **\ \char 42 CIRTH_60
+\** C **\ \char 43 CIRTH_58
+\** D **\ \char 44 CIRTH_43
+\** E **\ \char 45 CIRTH_28
+\** F **\ \char 46 CIRTH_44
+\** G **\ \char 47 CIRTH_45
+\** H **\ \char 48 ?
+\** I **\ \char 49 CIRTH_PUNCT_MID_DOT
+\** J **\ \char 4a CIRTH_38_ALT
+\** K **\ \char 4b CIRTH_EREB_1
+\** L **\ \char 4c CIRTH_45_ALT
+\** M **\ \char 4d CIRTH_51_ALT
+\** N **\ \char 4e CIRTH_SPACE
+\** O **\ \char 4f CIRTH_PUNCT_TWO_DOTS
+\** P **\ \char 50 CIRTH_PUNCT_THREE_DOTS
+\** Q **\ \char 51 CIRTH_26
+\** R **\ \char 52 CIRTH_29
+\** S **\ \char 53 CIRTH_42
+\** T **\ \char 54 CIRTH_30
+\** U **\ \char 55 CIRTH_PUNCT_STAR
+\** V **\ \char 56 CIRTH_59
+\** W **\ \char 57 CIRTH_27
+\** X **\ \char 58 CIRTH_57
+\** Y **\ \char 59 ?
+\** Z **\ \char 5a CIRTH_56
+\** [ **\ \char 5b ?
+\** \ **\ \char 5c CIRTH_PUNCT_DOT
+\** ] **\ \char 5d ?
+\** ^ **\ \char 5e ?
+\** _ **\ \char 5f ?
+\** ` **\ \char 60 CIRTH_SPACE_BIG
+\** a **\ \char 61 CIRTH_31
+\** b **\ \char 62 CIRTH_50
+\** c **\ \char 63 CIRTH_48
+\** d **\ \char 64 CIRTH_33
+\** e **\ \char 65 CIRTH_18
+\** f **\ \char 66 CIRTH_34
+\** g **\ \char 67 CIRTH_35
+\** h **\ \char 68 CIRTH_36
+\** i **\ \char 69 CIRTH_23
+\** j **\ \char 6a CIRTH_37
+\** k **\ \char 6b CIRTH_38
+\** l **\ \char 6c CIRTH_39
+\** m **\ \char 6d CIRTH_52
+\** n **\ \char 6e CIRTH_51
+\** o **\ \char 6f CIRTH_24
+\** p **\ \char 70 CIRTH_25
+\** q **\ \char 71 CIRTH_16
+\** r **\ \char 72 CIRTH_19
+\** s **\ \char 73 CIRTH_32
+\** t **\ \char 74 CIRTH_20
+\** u **\ \char 75 CIRTH_22
+\** v **\ \char 76 CIRTH_49
+\** w **\ \char 77 CIRTH_17
+\** x **\ \char 78 CIRTH_47
+\** y **\ \char 79 CIRTH_21
+\** z **\ \char 7a CIRTH_46
+\** { **\ \char 7b CIRTH_PUNCT_THREE_DOTS_L
+\** | **\ \char 7c CIRTH_PUNCT_DOUBLE_VBAR
+\** } **\ \char 7d CIRTH_PUNCT_FOUR_DOTS
+\** ~ **\ \char 7e ?
+\** € **\ \char 80 ?
+\**   **\ \char a0 ?
+\** ¤ **\ \char a4 ?
+\** § **\ \char a7 ?
+\** © **\ \char a9 ?
+\** « **\ \char ab ?
+\** ® **\ \char ae ?
+\** ¶ **\ \char b6 ?
+\** » **\ \char bb ?
+\** ¼ **\ \char bc ?
+\** ½ **\ \char bd ?
+\** ¾ **\ \char be ?
+\** ¿ **\ \char bf ?
+\** À **\ \char c0 ?
+\** Á **\ \char c1 ?
+\** Â **\ \char c2 ?
+\** Ã **\ \char c3 ?
+\** Ä **\ \char c4 ?
+\** Å **\ \char c5 ?
+\** Æ **\ \char c6 ?
+\** Ç **\ \char c7 ?
+\** È **\ \char c8 ?
+\** É **\ \char c9 ?
+\** Ê **\ \char ca ?
+\** Ë **\ \char cb ?
+\** Ì **\ \char cc ?
+\** Í **\ \char cd ?
+\** Î **\ \char ce ?
+\** Ï **\ \char cf ?
+\** Ð **\ \char d0 ?
+\** Ñ **\ \char d1 ?
+\** Ò **\ \char d2 ?
+\** Ó **\ \char d3 ?
+\** Ô **\ \char d4 ?
+\** Õ **\ \char d5 ?
+\** Ö **\ \char d6 ?
+\** × **\ \char d7 ?
+\** Ø **\ \char d8 ?
+\** Ù **\ \char d9 ?
+\** Ú **\ \char da ?
+\** Û **\ \char db ?
+\** Ü **\ \char dc ?
+\** Ý **\ \char dd ?
+\** Þ **\ \char de ?
+\** ß **\ \char df ?
+\** à **\ \char e0 ?
+\** á **\ \char e1 ?
+\** â **\ \char e2 ?
+\** ã **\ \char e3 ?
+\** ä **\ \char e4 ?
+\** å **\ \char e5 ?
+\** æ **\ \char e6 ?
+\** ç **\ \char e7 ?
+\** è **\ \char e8 ?
+\** é **\ \char e9 ?
+\** ê **\ \char ea ?
+\** ë **\ \char eb ?
+\** ì **\ \char ec ?
+\** í **\ \char ed ?
+\** î **\ \char ee ?
+\** ï **\ \char ef ?
+\** ð **\ \char f0 ?
+\** ñ **\ \char f1 ?
+\** ò **\ \char f2 ?
+\** ó **\ \char f3 ?
+\** ô **\ \char f4 ?
+\** õ **\ \char f5 ?
+\** ö **\ \char f6 ?
+\** ÷ **\ \char f7 ?
+\** ø **\ \char f8 ?
+\** ù **\ \char f9 ?
+\** ú **\ \char fa ?
+\** û **\ \char fb ?
+\** ü **\ \char fc ?
+\** ý **\ \char fd ?
+\** þ **\ \char fe ?
+\** ÿ **\ \char ff ?
+\** ‘ **\ \char 2018 ?
+\** • **\ \char 2022 ?
+\** … **\ \char 2026 ?
+\** ‹ **\ \char 2039 ?
+\** › **\ \char 203a ?
+\** ∙ **\ \char 2219 ?
+\** ◼ **\ \char 25fc ?
+