Class: Platform

Inherits:
Object show all
Defined in:
lib/standard/facets/platform.rb

Overview

Platform class

Original version from RubyGems, Copyright © 2007 Eric Hodel

Constant Summary collapse

RUBY =

A pure-ruby gem that may use Gem::Specification#extensions to build binary files.

'ruby'
CURRENT =

A platform-specific gem that is built for the packaging ruby's platform. This will be replaced with Gem::Platform::local.

'current'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arch) ⇒ Platform

Returns a new instance of Platform.


85
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
# File 'lib/standard/facets/platform.rb', line 85

def initialize(arch)
  case arch
  when Array then
    @cpu, @os, @version = arch
  when String then
    arch = arch.split '-'

    if arch.length > 2 and arch.last !~ /\d/ then # reassemble x86-linux-gnu
      extra = arch.pop
      arch.last << "-#{extra}"
    end

    cpu = arch.shift

    @cpu = case cpu
           when /i\d86/ then 'x86'
           else cpu
           end

    if arch.length == 2 and arch.last =~ /^\d+$/ then # for command-line
      @os, @version = arch
      return
    end

    os, = arch
    @cpu, os = nil, cpu if os.nil? # legacy jruby

    @os, @version = case os
      when /aix(\d+)/ then             [ 'aix',       $1  ]
      when /cygwin/ then               [ 'cygwin',    nil ]
      when /darwin(\d+)?/ then         [ 'darwin',    $1  ]
      when /freebsd(\d+)/ then         [ 'freebsd',   $1  ]
      when /hpux(\d+)/ then            [ 'hpux',      $1  ]
      when /^java$/, /^jruby$/ then    [ 'java',      nil ]
      when /^java([\d.]*)/ then        [ 'java',      $1  ]
      when /linux/ then                [ 'linux',     $1  ]
      when /mingw32/ then              [ 'mingw32',   nil ]
      when /(mswin\d+)(\_(\d+))?/ then
        os, version = $1, $3
        @cpu = 'x86' if @cpu.nil? and os =~ /32$/
        [os, version]
      when /netbsdelf/ then            [ 'netbsdelf', nil ]
      when /openbsd(\d+\.\d+)/ then    [ 'openbsd',   $1  ]
      when /solaris(\d+\.\d+)/ then    [ 'solaris',   $1  ]
      # test
      when /^(\w+_platform)(\d+)/ then [ $1,          $2  ]
      else                             [ 'unknown',   nil ]
    end
  when Platform then
    @cpu = arch.cpu
    @os = arch.os
    @version = arch.version
  else
    raise ArgumentError, "invalid argument #{arch.inspect}"
  end
end

Instance Attribute Details

#cpuObject

Returns the value of attribute cpu


24
25
26
# File 'lib/standard/facets/platform.rb', line 24

def cpu
  @cpu
end

#osObject

Returns the value of attribute os


27
28
29
# File 'lib/standard/facets/platform.rb', line 27

def os
  @os
end

#versionObject

Returns the value of attribute version


30
31
32
# File 'lib/standard/facets/platform.rb', line 30

def version
  @version
end

Class Method Details

.localObject


58
59
60
61
62
# File 'lib/standard/facets/platform.rb', line 58

def self.local
  arch = RbConfig::CONFIG['arch']
  arch = "#{arch}_60" if arch =~ /mswin32$/
  @local ||= new(arch)
end

.match(platform) ⇒ Object


65
66
67
68
69
70
# File 'lib/standard/facets/platform.rb', line 65

def self.match(platform)
  supported.any? do |local_platform|
    platform.nil? or local_platform == platform or
      (local_platform != Platform::RUBY and local_platform =~ platform)
  end
end

.new(arch) ⇒ Object

:nodoc:


73
74
75
76
77
78
79
80
81
82
# File 'lib/standard/facets/platform.rb', line 73

def self.new(arch) # :nodoc:
  case arch
  when Platform::CURRENT then
    Platform.local
  when Platform::RUBY, nil, '' then
    Platform::RUBY
  else
    super
  end
end

.supportedObject

Array of supported platforms (ie. pure-Ruby and local platform).


45
46
47
# File 'lib/standard/facets/platform.rb', line 45

def self.supported
  @suported ||= [Platform::RUBY, Platform.local]
end

Instance Method Details

#==(other) ⇒ Object


158
159
160
161
# File 'lib/standard/facets/platform.rb', line 158

def ==(other)
  self.class === other and
    @cpu == other.cpu and @os == other.os and @version == other.version
end

#===(other) ⇒ Object


164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/standard/facets/platform.rb', line 164

def ===(other)
  return nil unless Platform === other

  # cpu
  (@cpu == 'universal' or other.cpu == 'universal' or @cpu == other.cpu) and

  # os
  @os == other.os and

  # version
  (@version.nil? or other.version.nil? or @version == other.version)
end

#=~(other) ⇒ Object


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/standard/facets/platform.rb', line 178

def =~(other)
  case other
  when Platform then # nop
  when String then
    # This data is from http://gems.rubyforge.org/gems/yaml on 19 Aug 2007
    other = case other
      when /^i686-darwin(\d)/ then     ['x86',       'darwin',  $1]
      when /^i\d86-linux/ then         ['x86',       'linux',   nil]
      when 'java', 'jruby' then        [nil,         'java',    nil]
      when /mswin32(\_(\d+))?/ then    ['x86',       'mswin32', $2]
      when 'powerpc-darwin' then       ['powerpc',   'darwin',  nil]
      when /powerpc-darwin(\d)/ then   ['powerpc',   'darwin',  $1]
      when /sparc-solaris2.8/ then     ['sparc',     'solaris', '2.8']
      when /universal-darwin(\d)/ then ['universal', 'darwin',  $1]
      else                             other
    end

    other = Platform.new other
  else
    return nil
  end

  self === other
end

#big_endian?Boolean

Returns:

  • (Boolean)

229
230
231
# File 'lib/standard/facets/platform.rb', line 229

def big_endian?
  byte_order == :big
end

#bsd?Boolean

Returns:

  • (Boolean)

299
300
301
# File 'lib/standard/facets/platform.rb', line 299

def bsd?
  host_os =~ /bsd/
end

#byte_orderObject Also known as: byteorder

Byte order of CPU. Determine byte order of underlying machine.

Examines the byte order of the underlying machine. Returns :big if Big Endian and :little if Little Endian.

TODO: This doesn't work well apearently. We need to use a chart for possible cpus instead, maybe.


212
213
214
215
216
217
218
# File 'lib/standard/facets/platform.rb', line 212

def byte_order
  if [0x12345678].pack("L") == "\x12\x34\x56\x78"
    :big
  else
    :little
  end
end

#cardinal?Boolean Also known as: parrot?, perl?

Returns:

  • (Boolean)

278
279
280
# File 'lib/standard/facets/platform.rb', line 278

def cardinal?
  'cardinal' === interpreter
end

#host_osObject

O P E R A T I N G S Y S T E M


287
288
289
# File 'lib/standard/facets/platform.rb', line 287

def host_os
  RbConfig::CONFIG['host_os']
end

#inspectObject


143
144
145
# File 'lib/standard/facets/platform.rb', line 143

def inspect
  "#<%s:0x%x @cpu=%p, @os=%p, @version=%p>" % [self.class, object_id, *to_a]
end

#interpreterObject

Return the name of the ruby interpreter.


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/standard/facets/platform.rb', line 236

def interpreter
  @interpreter ||= (
    if RUBY_PLATFORM == 'parrot'
      'cardinal'
    elsif RUBY_ENGINE == 'ruby'
      if RUBY_DESCRIPTION =~ /Enterprise/i
        'ree'
      else
        'mri'
      end
    else
      RUBY_ENGINE.to_s # jruby, rbx, ironruby, macruby, etc.
    end
  )
end

#ironruby?Boolean Also known as: iron_ruby?

Returns:

  • (Boolean)

273
274
275
# File 'lib/standard/facets/platform.rb', line 273

def ironruby?
  'ironruby' === interpreter
end

#jruby?Boolean Also known as: java?

Returns:

  • (Boolean)

258
259
260
# File 'lib/standard/facets/platform.rb', line 258

def jruby?
  'jruby' === interpreter
end

#linux?Boolean

Returns:

  • (Boolean)

291
292
293
# File 'lib/standard/facets/platform.rb', line 291

def linux?
  host_os =~ /linux|cygwin/
end

#little_endian?Boolean

Returns:

  • (Boolean)

224
225
226
# File 'lib/standard/facets/platform.rb', line 224

def little_endian?
  byte_order == :little
end

#mac?Boolean

Returns:

  • (Boolean)

295
296
297
# File 'lib/standard/facets/platform.rb', line 295

def mac?
  host_os =~ /mac|darwin/
end

#mri?Boolean Also known as: official_ruby?, ruby?

Returns:

  • (Boolean)

252
253
254
# File 'lib/standard/facets/platform.rb', line 252

def mri?
  'mri' === interpreter
end

#posix?Boolean

Returns:

  • (Boolean)

317
318
319
320
321
322
323
324
# File 'lib/standard/facets/platform.rb', line 317

def posix?
  linux? or mac? or bsd? or solaris? or begin 
    fork do end
    true
  rescue NotImplementedError, NoMethodError
    false
  end
end

#ree?Boolean Also known as: enterprise?

Returns:

  • (Boolean)

268
269
270
# File 'lib/standard/facets/platform.rb', line 268

def ree?
  'ree' === interpreter
end

#rubinius?Boolean Also known as: rbx?

Returns:

  • (Boolean)

263
264
265
# File 'lib/standard/facets/platform.rb', line 263

def rubinius?
  'rbx' === interpreter
end

#solaris?Boolean

Returns:

  • (Boolean)

307
308
309
# File 'lib/standard/facets/platform.rb', line 307

def solaris?
  host_os =~ /solaris|sunos/
end

#symbian?Boolean

TODO: who knows what symbian returns?

Returns:

  • (Boolean)

312
313
314
# File 'lib/standard/facets/platform.rb', line 312

def symbian?
  host_os =~ /symbian/
end

#to_aObject


148
149
150
# File 'lib/standard/facets/platform.rb', line 148

def to_a
  [@cpu, @os, @version]
end

#to_sObject


153
154
155
# File 'lib/standard/facets/platform.rb', line 153

def to_s
  to_a.compact.join '-'
end

#windows?Boolean

Returns:

  • (Boolean)

303
304
305
# File 'lib/standard/facets/platform.rb', line 303

def windows?
  host_os =~ /mswin|mingw/
end