Class: MOFile

Inherits:
Hash
  • Object
show all
Defined in:
lib/gettext/mofile.rb

Defined Under Namespace

Classes: Header, HeaderRev1, InvalidFormat

Constant Summary collapse

MAGIC_BIG_ENDIAN = 
"\x95\x04\x12\xde"
MAGIC_LITTLE_ENDIAN = 
"\xde\x12\x04\x95"
HASHWORDBITS =

From gettext-0.12.1/gettext-runtime/intl/hash-string.h Defines the so called ‘hashpjw’ function by P.J. Weinberger [see Aho/Sethi/Ullman, COMPILERS: Principles, Techniques and Tools, 1986, 1987 Bell Telephone Laboratories, Inc.]

32

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(output_charset = nil) ⇒ MOFile

Returns a new instance of MOFile.



52
53
54
55
56
57
58
 
# File 'lib/gettext/mofile.rb', line 52

def initialize(output_charset = nil)
  @filename = nil
  @last_modified = nil
  @little_endian = true
  @output_charset = output_charset
  super()
end

Instance Attribute Details

#charset ⇒ Object (readonly)

Returns the value of attribute charset.



295
296
297
 
# File 'lib/gettext/mofile.rb', line 295

def charset
  @charset
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



24
25
26
 
# File 'lib/gettext/mofile.rb', line 24

def filename
  @filename
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



294
295
296
 
# File 'lib/gettext/mofile.rb', line 294

def last_modified
  @last_modified
end

#little_endian ⇒ Object

Returns the value of attribute little_endian.



294
295
296
 
# File 'lib/gettext/mofile.rb', line 294

def little_endian
  @little_endian
end

#nplurals ⇒ Object (readonly)

Returns the value of attribute nplurals.



295
296
297
 
# File 'lib/gettext/mofile.rb', line 295

def nplurals
  @nplurals
end

#path ⇒ Object

Returns the value of attribute path.



294
295
296
 
# File 'lib/gettext/mofile.rb', line 294

def path
  @path
end

#plural ⇒ Object (readonly)

Returns the value of attribute plural.



295
296
297
 
# File 'lib/gettext/mofile.rb', line 295

def plural
  @plural
end

Class Method Details

.open(arg = nil, output_charset = nil) ⇒ Object 



47
48
49
50
 
# File 'lib/gettext/mofile.rb', line 47

def self.open(arg = nil, output_charset = nil)
  result = self.new(output_charset)
  result.load(arg)
end

Instance Method Details

#hash_string(str) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/gettext/mofile.rb', line 192

def hash_string(str)
  hval = 0
  i = 0
  str.each_byte do |b|
    break if b == '\0'
    hval <<= 4
    hval += b.to_i
    g = hval & (0xf << (HASHWORDBITS - 4))
    if (g != 0)
      hval ^= g >> (HASHWORDBITS - 8)
      hval ^= g
    end
  end
  hval
end

#load(arg) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/gettext/mofile.rb', line 71

def load(arg)
  if arg.kind_of? String
    begin
	st = File.stat(arg)
	@last_modified = [st.ctime, st.mtime]
    rescue Exception
    end
    load_from_file(arg)
  else
    load_from_stream(arg)
  end
  @filename = arg
  self
end

#load_from_file(filename) ⇒ Object 



275
276
277
278
279
280
281
282
283
 
# File 'lib/gettext/mofile.rb', line 275

def load_from_file(filename)
  @filename = filename
  begin
    File.open(filename, 'rb'){|f| load_from_stream(f)}
  rescue => e
    e.set_backtrace("File: #{@filename}")
    raise e
  end
end

#load_from_stream(io) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/gettext/mofile.rb', line 86

def load_from_stream(io)
  magic = io.read(4)
  case magic
  when MAGIC_BIG_ENDIAN
    @little_endian = false
  when MAGIC_LITTLE_ENDIAN
    @little_endian = true
  else
    raise InvalidFormat.new(sprintf("Unknown signature %s", magic.dump))
  end

  endian_type6 = @little_endian ? 'V6' : 'N6'
  endian_type_astr = @little_endian ? 'V*' : 'N*'

  header = HeaderRev1.new(magic, *(io.read(4 * 6).unpack(endian_type6)))

  if header.revision == 1
    # FIXME: It doesn't support sysdep correctly.
    header.n_sysdep_segments = io.read(4).unpack(endian_type6)
    header.sysdep_segments_offset = io.read(4).unpack(endian_type6)
    header.n_sysdep_strings = io.read(4).unpack(endian_type6)
    header.orig_sysdep_tab_offset = io.read(4).unpack(endian_type6)
    header.trans_sysdep_tab_offset = io.read(4).unpack(endian_type6)
  elsif header.revision > 1
    raise InvalidFormat.new(sprintf("file format revision %d isn't supported", header.revision))
  end
  io.pos = header.orig_table_offset
  orig_table_data = io.read((4 * 2) * header.nstrings).unpack(endian_type_astr)

  io.pos = header.translated_table_offset
  trans_table_data = io.read((4 * 2) * header.nstrings).unpack(endian_type_astr)

  original_strings = Array.new(header.nstrings)
  for i in 0...header.nstrings
    io.pos = orig_table_data[i * 2 + 1]
    original_strings[i] = io.read(orig_table_data[i * 2 + 0])
  end

  clear
  for i in 0...header.nstrings
    io.pos = trans_table_data[i * 2 + 1]
    str = io.read(trans_table_data[i * 2 + 0])

    if (! original_strings[i]) || original_strings[i] == ""
      if str
        @charset = nil
        @nplurals = nil
        @plural = nil
        str.each_line{|line|
          if /^Content-Type:/i =~ line and /charset=((?:\w|-)+)/i =~ line
            @charset = $1
          elsif /^Plural-Forms:\s*nplurals\s*\=\s*(\d*);\s*plural\s*\=\s*([^;]*)\n?/ =~ line
            @nplurals = $1
            @plural = $2
          end
          break if @charset and @nplurals
        }
        @nplurals = "1" unless @nplurals
        @plural = "0" unless @plural
      end
    else
      if @output_charset
        begin
          str = Iconv.conv(@output_charset, @charset, str) if @charset
        rescue Iconv::Failure
          if $DEBUG
            warn "@charset = ", @charset
            warn"@output_charset = ", @output_charset
            warn "msgid = ", original_strings[i]
            warn "msgstr = ", str
          end
        end
      end
    end
    self[original_strings[i]] = str.freeze
  end
  self
end

#next_prime(seed) ⇒ Object

From gettext-0.12.1/gettext-tools/lib/hash.c



179
180
181
182
183
184
185
 
# File 'lib/gettext/mofile.rb', line 179

def next_prime(seed)
  seed |= 1
  while (! prime?(seed))
    seed += 2
  end
  seed
end

#prime?(candidate) ⇒ Boolean

From gettext-0.12.1/gettext-tools/lib/hash.c

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/gettext/mofile.rb', line 166

def prime?(candidate)
  divn = 3
  sq = divn * divn

  while (sq < candidate && candidate % divn != 0)
    divn += 1
    sq += 4 * divn
    divn += 1
  end
  candidate % divn != 0
end

#save_to_file(filename) ⇒ Object 



285
286
287
 
# File 'lib/gettext/mofile.rb', line 285

def save_to_file(filename)
  File.open(filename, 'wb'){|f| save_to_stream(f)}
end

#save_to_stream(io) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/gettext/mofile.rb', line 208

def save_to_stream(io)
  #Save data as little endian format.
  header_size = 4 * 7
  table_size  = 4 * 2 * size

  hash_table_size = next_prime((size * 4) / 3) 
  hash_table_size = 3 if hash_table_size <= 2
  header = Header.new(
    MAGIC_LITTLE_ENDIAN,          # magic
    0,                            # revision
    size,                         # nstrings
    header_size,                  # orig_table_offset
    header_size + table_size,     # translated_table_offset
    hash_table_size,              # hash_table_size
    header_size + table_size * 2  # hash_table_offset
  )
  io.write(header.to_a.pack('a4V*'))

  ary = to_a
  ary.sort!{|a, b| a[0] <=> b[0]} # sort by original string

  pos = header.hash_table_size * 4 + header.hash_table_offset

  orig_table_data = Array.new()
  ary.each{|item, _|
    orig_table_data.push(item.size)
    orig_table_data.push(pos)
    pos += item.size + 1 # +1 is <NUL>
  }
  io.write(orig_table_data.pack('V*'))

  trans_table_data = Array.new()
  ary.each{|_, item|
    trans_table_data.push(item.size)
    trans_table_data.push(pos)
    pos += item.size + 1 # +1 is <NUL>
  }
  io.write(trans_table_data.pack('V*'))

  hash_tab = Array.new(hash_table_size)
  j = 0
  ary[0...size].each {|key, _|
    hash_val = hash_string(key)
    idx = hash_val % hash_table_size
    if hash_tab[idx] != nil
      incr = 1 + (hash_val % (hash_table_size - 2))
      begin
        if (idx >= hash_table_size - incr)
          idx -= hash_table_size - incr
        else
          idx += incr
        end
      end until (hash_tab[idx] == nil)
    end
    hash_tab[idx] = j + 1
    j += 1
  }
  hash_tab.collect!{|i| i ? i : 0}

  io.write(hash_tab.pack('V*'))

  ary.each{|item, _| io.write(item); io.write("\0") }
  ary.each{|_, item| io.write(item); io.write("\0") }

  self
end

#set_comment(msgid_or_sym, comment) ⇒ Object 



289
290
291
 
# File 'lib/gettext/mofile.rb', line 289

def set_comment(msgid_or_sym, comment)
  #Do nothing
end

#update! ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/gettext/mofile.rb', line 60

def update!
  if FileTest.exist?(@filename)
    st = File.stat(@filename)
    load(@filename) unless (@last_modified == [st.ctime, st.mtime])
  else
    warn "#{@filename} was lost." if $DEBUG
    clear
  end
  self
end