librarian/hyphenator.py

   1 """
   2
   3 This is a Pure Python module to hyphenate text.
   4
   5 It is inspired by Ruby's Text::Hyphen, but currently reads standard *.dic files,
   6 that must be installed separately.
   7
   8 In the future it's maybe nice if dictionaries could be distributed together with
   9 this module, in a slightly prepared form, like in Ruby's Text::Hyphen.
  10
  11 Wilbert Berendsen, March 2008
  12 info@wilbertberendsen.nl
  13
  14 License: LGPL.
  15
  16 """
  17 from __future__ import print_function, unicode_literals
  18
  19 import sys
  20 import re
  21
  22 __all__ = ("Hyphenator")
  23
  24 # cache of per-file Hyph_dict objects
  25 hdcache = {}
  26
  27 # precompile some stuff
  28 parse_hex = re.compile(r'\^{2}([0-9a-f]{2})').sub
  29 parse = re.compile(r'(\d?)(\D?)').findall
  30
  31 def hexrepl(matchObj):
  32     return unichr(int(matchObj.group(1), 16))
  33
  34
  35 class parse_alt(object):
  36     """
  37     Parse nonstandard hyphen pattern alternative.
  38     The instance returns a special int with data about the current position
  39     in the pattern when called with an odd value.
  40     """
  41     def __init__(self, pat, alt):
  42         alt = alt.split(',')
  43         self.change = alt[0]
  44         if len(alt) > 2:
  45             self.index = int(alt[1])
  46             self.cut = int(alt[2]) + 1
  47         else:
  48             self.index = 1
  49             self.cut = len(re.sub(r'[\d\.]', '', pat)) + 1
  50         if pat.startswith('.'):
  51             self.index += 1
  52
  53     def __call__(self, val):
  54         self.index -= 1
  55         val = int(val)
  56         if val & 1:
  57             return dint(val, (self.change, self.index, self.cut))
  58         else:
  59             return val
  60
  61
  62 class dint(int):
  63     """
  64     Just an int some other data can be stuck to in a data attribute.
  65     Call with ref=other to use the data from the other dint.
  66     """
  67     def __new__(cls, value, data=None, ref=None):
  68         obj = int.__new__(cls, value)
  69         if ref and type(ref) == dint:
  70             obj.data = ref.data
  71         else:
  72             obj.data = data
  73         return obj
  74
  75
  76 class Hyph_dict(object):
  77     """
  78     Reads a hyph_*.dic file and stores the hyphenation patterns.
  79     Parameters:
  80     -filename : filename of hyph_*.dic to read
  81     """
  82     def __init__(self, filename):
  83         self.patterns = {}
  84         f = open(filename)
  85         charset = f.readline().strip()
  86         if charset.startswith('charset '):
  87             charset = charset[8:].strip()
  88
  89         for pat in f:
  90             pat = pat.decode(charset).strip()
  91             if not pat or pat[0] == '%': continue
  92             # replace ^^hh with the real character
  93             pat = parse_hex(hexrepl, pat)
  94             # read nonstandard hyphen alternatives
  95             if '/' in pat:
  96                 pat, alt = pat.split('/', 1)
  97                 factory = parse_alt(pat, alt)
  98             else:
  99                 factory = int
 100             tag, value = zip(*[(s, factory(i or "0")) for i, s in parse(pat)])
 101             # if only zeros, skip this pattern
 102             if max(value) == 0: continue
 103             # chop zeros from beginning and end, and store start offset.
 104             start, end = 0, len(value)
 105             while not value[start]: start += 1
 106             while not value[end-1]: end -= 1
 107             self.patterns[''.join(tag)] = start, value[start:end]
 108         f.close()
 109         self.cache = {}
 110         self.maxlen = max(map(len, self.patterns.keys()))
 111
 112     def positions(self, word):
 113         """
 114         Returns a list of positions where the word can be hyphenated.
 115         E.g. for the dutch word 'lettergrepen' this method returns
 116         the list [3, 6, 9].
 117
 118         Each position is a 'data int' (dint) with a data attribute.
 119         If the data attribute is not None, it contains a tuple with
 120         information about nonstandard hyphenation at that point:
 121         (change, index, cut)
 122
 123         change: is a string like 'ff=f', that describes how hyphenation
 124             should take place.
 125         index: where to substitute the change, counting from the current
 126             point
 127         cut: how many characters to remove while substituting the nonstandard
 128             hyphenation
 129         """
 130         word = word.lower()
 131         points = self.cache.get(word)
 132         if points is None:
 133             prepWord = '.%s.' % word
 134             res = [0] * (len(prepWord) + 1)
 135             for i in range(len(prepWord) - 1):
 136                 for j in range(i + 1, min(i + self.maxlen, len(prepWord)) + 1):
 137                     p = self.patterns.get(prepWord[i:j])
 138                     if p:
 139                         offset, value = p
 140                         s = slice(i + offset, i + offset + len(value))
 141                         res[s] = map(max, value, res[s])
 142
 143             points = [dint(i - 1, ref=r) for i, r in enumerate(res) if r % 2]
 144             self.cache[word] = points
 145         return points
 146
 147
 148 class Hyphenator(object):
 149     """
 150     Reads a hyph_*.dic file and stores the hyphenation patterns.
 151     Provides methods to hyphenate strings in various ways.
 152     Parameters:
 153     -filename : filename of hyph_*.dic to read
 154     -left: make the first syllabe not shorter than this
 155     -right: make the last syllabe not shorter than this
 156     -cache: if true (default), use a cached copy of the dic file, if possible
 157
 158     left and right may also later be changed:
 159       h = Hyphenator(file)
 160       h.left = 1
 161     """
 162     def __init__(self, filename, left=2, right=2, cache=True):
 163         self.left  = left
 164         self.right = right
 165         if not cache or filename not in hdcache:
 166             hdcache[filename] = Hyph_dict(filename)
 167         self.hd = hdcache[filename]
 168
 169     def positions(self, word):
 170         """
 171         Returns a list of positions where the word can be hyphenated.
 172         See also Hyph_dict.positions. The points that are too far to
 173         the left or right are removed.
 174         """
 175         right = len(word) - self.right
 176         return [i for i in self.hd.positions(word) if self.left <= i <= right]
 177
 178     def iterate(self, word):
 179         """
 180         Iterate over all hyphenation possibilities, the longest first.
 181         """
 182         if isinstance(word, str):
 183             word = word.decode('latin1')
 184         for p in reversed(self.positions(word)):
 185             if p.data:
 186                 # get the nonstandard hyphenation data
 187                 change, index, cut = p.data
 188                 if word.isupper():
 189                     change = change.upper()
 190                 c1, c2 = change.split('=')
 191                 yield word[:p+index] + c1, c2 + word[p+index+cut:]
 192             else:
 193                 yield word[:p], word[p:]
 194
 195     def wrap(self, word, width, hyphen='-'):
 196         """
 197         Return the longest possible first part and the last part of the
 198         hyphenated word. The first part has the hyphen already attached.
 199         Returns None, if there is no hyphenation point before width, or
 200         if the word could not be hyphenated.
 201         """
 202         width -= len(hyphen)
 203         for w1, w2 in self.iterate(word):
 204             if len(w1) <= width:
 205                 return w1 + hyphen, w2
 206
 207     def inserted(self, word, hyphen='-'):
 208         """
 209         Returns the word as a string with all the possible hyphens inserted.
 210         E.g. for the dutch word 'lettergrepen' this method returns
 211         the string 'let-ter-gre-pen'. The hyphen string to use can be
 212         given as the second parameter, that defaults to '-'.
 213         """
 214         if isinstance(word, str):
 215             word = word.decode('latin1')
 216         l = list(word)
 217         for p in reversed(self.positions(word)):
 218             if p.data:
 219                 # get the nonstandard hyphenation data
 220                 change, index, cut = p.data
 221                 if word.isupper():
 222                     change = change.upper()
 223                 l[p + index : p + index + cut] = change.replace('=', hyphen)
 224             else:
 225                 l.insert(p, hyphen)
 226         return ''.join(l)
 227
 228     __call__ = iterate
 229
 230
 231 if __name__ == "__main__":
 232
 233     dict_file = sys.argv[1]
 234     word = sys.argv[2].decode('latin1')
 235
 236     h = Hyphenator(dict_file, left=1, right=1)
 237
 238     for i in h(word):
 239         print(i)
 240