Module: ICU::Lib

Extended by:
FFI::Library
Defined in:
lib/ffi-icu/lib.rb,
lib/ffi-icu/lib/util.rb

Defined Under Namespace

Modules: Util Classes: UParseError, UTransPosition, VersionInfo

Class Method Summary collapse

Class Method Details

.attach_optional_function(*args) ⇒ Object 



200
201
202
203
 
# File 'lib/ffi-icu/lib.rb', line 200

def self.attach_optional_function(*args)
  attach_function *args
rescue FFI::NotFoundError
end

.check_error ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/ffi-icu/lib.rb', line 126

def self.check_error
  ptr = FFI::MemoryPointer.new(:int)
  ret = yield(ptr)
  error_code = ptr.read_int

  if error_code > 0
    name = Lib.u_errorName error_code
    if name == "U_BUFFER_OVERFLOW_ERROR"
      raise BufferOverflowError
    elsif name == "U_MISSING_RESOURCE_ERROR"
      raise MissingResourceError
    else
      raise Error, name
    end
  elsif error_code < 0
    $stderr.puts "ffi-icu: #{Lib.u_errorName error_code}" if $DEBUG || $VERBOSE
  end

  ret
end

.cldr_version ⇒ Object 



190
191
192
193
194
 
# File 'lib/ffi-icu/lib.rb', line 190

def self.cldr_version
  @cldr_version ||= VersionInfo.new.tap do |version|
    check_error { |status| ulocdata_getCLDRVersion(version, status) }
  end
end

.enum_ptr_to_array(enum_ptr) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ffi-icu/lib.rb', line 147

def self.enum_ptr_to_array(enum_ptr)
  length = check_error do |status|
    uenum_count(enum_ptr, status)
  end

  len = FFI::MemoryPointer.new(:int)

  (0...length).map do |idx|
    check_error { |st| uenum_next(enum_ptr, len, st) }
  end
end

.figure_suffix(version) ⇒ Object 



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
 
# File 'lib/ffi-icu/lib.rb', line 94

def self.figure_suffix(version)
  # For some reason libicu prepends its exported functions with version information,
  # which differs across all platforms.  Some examples:
  #
  # OSX:
  #   u_errorName
  #
  # CentOS 5
  #   u_errorName_3_6
  #
  # Fedora 14 and Windows (using mingw)
  #   u_errorName_44
  #
  # So we need to figure out which one it is.

  # Here are the possible suffixes
  suffixes = [""]
  if version
    suffixes << "_#{version}" << "_#{version[0].chr}_#{version[1].chr}" << "_#{version.split('.')[0]}"
  end

  # Try to find the u_errorName function using the possible suffixes
  suffixes.find do |suffix|
    function_name = "u_errorName#{suffix}"
    function_names(function_name, nil).find do |fname|
      ffi_libraries.find do |lib|
        lib.find_function(fname)
      end
    end
  end
end

.find_lib(lib) ⇒ Object 



30
31
32
33
34
 
# File 'lib/ffi-icu/lib.rb', line 30

def self.find_lib(lib)
  Dir.glob(search_paths.map { |path|
    File.expand_path(File.join(path, lib))
  }).first
end

.icu_version(libs) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ffi-icu/lib.rb', line 77

def self.icu_version(libs)
  version = nil

  libs.find do |lib|
    # Get the version - sure would be nice if libicu exported this in a function
    # we could just call cause this is super fugly!
    match = lib.name.match(/(\d\d)\.#{FFI::Platform::LIBSUFFIX}/) ||
            lib.name.match(/#{FFI::Platform::LIBSUFFIX}\.(\d\d)/)
    if match
      version = match[1]
    end
  end

  # Note this may return nil, like on OSX
  version
end

.load_icu ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ffi-icu/lib.rb', line 36

def self.load_icu
  # First find the library
  lib_names = case ICU.platform
              when :bsd
                [find_lib("libicui18n.#{FFI::Platform::LIBSUFFIX}.??"),
                 find_lib("libicutu.#{FFI::Platform::LIBSUFFIX}.??")]
              when :osx
                if ENV.key?('FFI_ICU_LIB')
                  # Ensure we look in the user-supplied override dir for a user-compiled libicu
                  [find_lib("libicui18n.??.#{FFI::Platform::LIBSUFFIX}"),
                  find_lib("libicutu.??.#{FFI::Platform::LIBSUFFIX}")]
                elsif Gem::Version.new(`sw_vers -productVersion`) >= Gem::Version.new('11')
                  # See https://developer.apple.com/documentation/macos-release-notes/macos-big-sur-11_0_1-release-notes (62986286)
                  ["libicucore.#{FFI::Platform::LIBSUFFIX}"]
                else
                  [find_lib("libicucore.#{FFI::Platform::LIBSUFFIX}")]
                end
              when :linux
                [find_lib("libicui18n.#{FFI::Platform::LIBSUFFIX}.??"),
                 find_lib("libicutu.#{FFI::Platform::LIBSUFFIX}.??")]
              when :windows
                [find_lib("icuuc??.#{FFI::Platform::LIBSUFFIX}"),
                 find_lib("icuin??.#{FFI::Platform::LIBSUFFIX}")]
              end

  lib_names.compact! if lib_names

  if not lib_names or lib_names.length == 0
    raise LoadError, "Could not find ICU on #{ICU.platform.inspect}. Patches welcome, or you can add the containing directory yourself: #{self}.search_paths << '/path/to/lib'"
  end

  # And now try to load the library
  begin
    libs = ffi_lib(*lib_names)
  rescue LoadError => ex
    raise LoadError, "no idea how to load ICU on #{ICU.platform.inspect}, patches appreciated! (#{ex.message})"
  end

  icu_version(libs)
end

.not_available(func_name) ⇒ Object 



159
160
161
162
163
 
# File 'lib/ffi-icu/lib.rb', line 159

def self.not_available(func_name)
  self.class.send :define_method, func_name do |*args|
    raise Error, "#{func_name} not available on platform #{ICU.platform.inspect}"
  end
end

.resource_bundle_name(type) ⇒ Object 



447
448
449
450
 
# File 'lib/ffi-icu/lib.rb', line 447

def self.resource_bundle_name(type)
  stem = "icudt" + version.read_array_of_char(4)[0].to_s + "l" + "-"
  stem + type.to_s
end

.search_paths ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/ffi-icu/lib.rb', line 14

def self.search_paths
  @search_paths ||= begin
    if ENV['FFI_ICU_LIB']
      [ ENV['FFI_ICU_LIB'] ]
    elsif FFI::Platform::IS_WINDOWS
      ENV['PATH'].split(File::PATH_SEPARATOR)
    else
      [
        '/usr/local/{lib64,lib}',
        '/opt/local/{lib64,lib}',
        '/usr/{lib64,lib}',
      ] + Dir['/usr/lib/*-linux-gnu'] # for Debian Multiarch http://wiki.debian.org/Multiarch
    end
  end
end

.version ⇒ Object 



196
197
198
 
# File 'lib/ffi-icu/lib.rb', line 196

def self.version
  @version ||= VersionInfo.new.tap { |version| u_getVersion(version) }
end