Contents

#--
# ByteOrder
#
# Copyright (c) 2003 Michael Neumann
#
# ==========================================================================
# Revision History ::
# --------------------------------------------------------------------------
#  2005.04.28  TO   * Minor modifications to documentation.
# ==========================================================================
#
# :NOTE: This seems like a little much for what's really a single method.
#        In the future this should be reduced and moved to Nano Methods.
#        Only reason I haven't done so yet, is b/c BinaryReader
#        depends on it.
#
#++

#:title: ByteOrder
#
# ByteOrder module makes it possible to determine your systems
# byte order, either big or little endian.
#
# == Usage
#
#   ByteOrder.byteorder => :LittleEndian
#
# == Author(s)
#
# * Michael Neumann
#
#
module ByteOrder

  Native = :Native
  BigEndian = Big = Network = :BigEndian
  LittleEndian = Little = :LittleEndian

  # examines the byte order of the underlying machine
  def byte_order
    if [0x12345678].pack("L") == "\x12\x34\x56\x78"
      BigEndian
    else
      LittleEndian
    end
  end

  alias_method :byteorder, :byte_order

  def little_endian?
    byte_order == LittleEndian
  end

  def big_endian?
    byte_order == BigEndian
  end

  alias little? little_endian?
  alias big? big_endian?
  alias network? big_endian?

  module_function :byte_order, :byteorder
  module_function :little_endian?, :little?
  module_function :big_endian?, :big?, :network?

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
mega-0.3.1	lib/mega/byteorder.rb