class Text::Hyphen

Introduction

Text::Hyphen -- hyphenate words using modified versions of TeX hyphenation patterns.

Usage

require 'text/hyphen'
hh = Text::Hyphen.new(:language => 'en_us', :left => 2, :right => 2)
  # Defaults to the above
hh = TeX::Hyphen.new

word = "representation"
points = hyp.hyphenate(word)    #=> [3, 5, 8, 10]
puts hyp.visualize(word)        #=> rep-re-sen-ta-tion

en = Text::Hyphen.new(:left => 0, :right => 0)
fr = Text::Hyphen.new(:language = "fr", :left => 0, :right => 0)
puts en.visualise("organiser")  #=> or-gan-iser
puts fr.visualise("organiser")  #=> or-ga-ni-ser

Description

Creates a new Hyphen object and loads the language patterns into memory. The hyphenator can then be asked for the hyphenation of a word. If no language is specified, then the language en_us (EN_US) is used by default.

Copyright

Copyright © 2004 - 2005 Austin Ziegler

Version

1.0.2

Based On

TeX::Hyphen 0.4 Copyright (c) 2003 - 2004 Martin DeMello and Austin Ziegler, in turn based on Perl's TeX::Hyphen

search.cpan.org/author/JANPAZ/TeX-Hyphen-0.140/lib/TeX/Hyphen.pm

Copyright © 1997 - 2002 Jan Pazdziora

Licence

Licensing for Text::Hyphen is unfortunately complex because of the various copyrights and licences of the source hyphenation files. Some of these files are available only under the TeX licence and others are available only under the GNU GPL while others are public domain. Each language file has these licences embedded within the file. Please consult each file’s licence to ensure that it is compatible with your application.

The copyright on the Text::Hyphen application/library and the Ruby translations of hyphenation files belongs to Austin Ziegler. All other copyrights on original versions still stand; Text::Hyphen is a derivative work of these and other projects.

Application and Compilation Licences

Text::Hyphen, the application/library is licensed under the same terms as Ruby. Note that this specifically refers to the contents of bin/hyphen, lib/text/hyphen.rb, and lib/text/hyphen/language.rb.

Individual language hyphenation files are NOT licensed under these terms, but under the following MIT-style licence and the original hyphenation pattern licenses. The copyright for the original TeX hyphenation files is held by the original authors; any mistakes in conversion of these files to Ruby is attributable to the contributors to the Text::Hyphen package only.

The compilation package Text::Hyphen is licensed under the same terms as Ruby.

Blanket Language Hyphenation File Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Public Class Methods

new(options = {}) { |self| ... } click to toggle source

The following initializations are equivalent:

hyp = TeX::Hyphenate.new(:language => "EU")
hyp = TeX::Hyphenate.new { |h| h.language = "EU" }
# File lib/text/hyphen.rb, line 129
def initialize(options = {}) # :yields self:
  @iso_language = options[:language]
  @left         = options[:left]
  @right        = options[:right]
  @language     = nil

  @cache        = {}
  @vcache       = {}

  @hyphen       = {}
  @begin_hyphen = {}
  @end_hyphen   = {}
  @both_hyphen  = {}
  @exception    = {}

  @first_load = true
  yield self if block_given?
  @first_load = false

  load_language

  @left       ||= DEFAULT_MIN_LEFT
  @right      ||= DEFAULT_MIN_RIGHT
end

Public Instance Methods

clear_cache!() click to toggle source
# File lib/text/hyphen.rb, line 216
def clear_cache!
  @cache.clear
  @vcache.clear
end
hyphenate(word) click to toggle source

Returns a list of places where the word can be divided, as

hyp.hyphenate('representation')

returns [3, 5, 8, 10]. If the word has been hyphenated previously, it will be returned from a per-instance cache.

# File lib/text/hyphen.rb, line 160
def hyphenate(word)
  word = word.downcase
  $stderr.puts "Hyphenating #{word}" if DEBUG
  return @cache[word] if @cache.has_key?(word)
  res = @language.exceptions[word]
  return @cache[word] = make_result_list(res) if res

  result = [0] * (word.split(%r/).size + 1)
  rightstop = word.split(%r/).size - @right

  updater = Proc.new do |hash, str, pos|
    if hash.has_key?(str)
      $stderr.print "#{pos}: #{str}: #{hash[str]}" if DEBUG
      hash[str].split(%r/).each_with_index do |cc, ii|
        cc = cc.to_i
        result[ii + pos] = cc if cc > result[ii + pos]
      end
      $stderr.print ": #{result}\n" if DEBUG
    end
  end

    # Walk the word
  (0..rightstop).each do |pos|
    restlength = word.length - pos
    (1..restlength).each do |length|
      substr = word[pos, length]
      updater[@language.hyphen, substr, pos]
      updater[@language.start, substr, pos] if pos.zero?
      updater[@language.stop, substr, pos] if (length == restlength)
    end
  end

  updater[@language.both, word, 0] if @language.both[word]

  (0..@left).each { |i| result[i] = 0 }
  ((-1 - @right)..(-1)).each { |i| result[i] = 0 }
  @cache[word] = make_result_list(result)
end
hyphenate_to(word, size) click to toggle source

This function will hyphenate a word so that the first point is at most size characters.

# File lib/text/hyphen.rb, line 223
def hyphenate_to(word, size)
  point = hyphenate(word).delete_if { |e| e >= size }.max
  if point.nil?
    [nil, word]
  else
    [word[0 ... point] + "-", word[point .. -1]]
  end
end
language=(lang) click to toggle source
# File lib/text/hyphen.rb, line 111
def language=(lang)
  require 'text/hyphen/language' unless defined?(Text::Hyphen::Language)
  if lang.kind_of? Text::Hyphen::Language
    @iso_language = lang.to_s.split(%r{::})[-1].downcase
    @language     = lang
  else
    @iso_language = lang.downcase
    load_language
  end
  @iso_language
end
stats() click to toggle source

Returns statistics

# File lib/text/hyphen.rb, line 233
  def stats
    _b = @language.both.size
    _s = @language.start.size
    _e = @language.stop.size
    _h = @language.hyphen.size
    _x = @language.exceptions.size
    _T = _b + _s + _e + _h + _x

    s = "
The language '%s' contains %d total hyphenation patterns.
    % 6d patterns are word start patterns.
    % 6d patterns are word stop patterns.
    % 6d patterns are word start/stop patterns.
    % 6d patterns are normal patterns.
    % 6d patterns are exceptions.

"
    s % [ @iso_language, _T, _s, _e, _b, _h, _x ]
  end
visualise(word) click to toggle source

Returns a visualization of the hyphenation points, so:

hyp.visualize('representation')

returns rep-re-sen-ta-tion, at least for English patterns. If the word has been visualised previously, it will be returned from a per-instance cache.

# File lib/text/hyphen.rb, line 206
def visualise(word)
  return @vcache[word] if @vcache.has_key?(word)
  w = word.dup
  hyphenate(w).each_with_index do |pos, n| 
    w[pos.to_i + n, 0] = '-' if pos != 0
  end
  @vcache[word] = w
end
Also aliased as: visualize
visualize(word) click to toggle source
Alias for: visualise