writeexcel 0.1.0

data/examples/tab_colors.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to set Excel worksheet tab colours.
+#
+# reverse('©'), May 2006, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+workbook   = Spreadsheet::WriteExcel.new('tab_colors.xls')
+
+worksheet1 =  workbook.add_worksheet
+worksheet2 =  workbook.add_worksheet
+worksheet3 =  workbook.add_worksheet
+worksheet4 =  workbook.add_worksheet
+
+# Worsheet1 will have the default tab colour.
+worksheet2.set_tab_color('red')
+worksheet3.set_tab_color('green')
+worksheet4.set_tab_color(0x35) # Orange
+
+workbook.close
+
+workbook.close

data/lib/writeexcel/biffwriter.rb

@@ -0,0 +1,260 @@
+#
+# BIFFwriter - An abstract base class for Excel workbooks and worksheets.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2008, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+
+require 'tempfile'
+
+class BIFFWriter
+
+  BIFF_Version = 0x0600
+  BigEndian    = [1].pack("I") == [1].pack("N")
+
+  attr_reader :byte_order, :data, :datasize
+
+  ######################################################################
+  # The args here aren't used by BIFFWriter, but they are needed by its
+  # subclasses.  I don't feel like creating multiple constructors.
+  ######################################################################
+
+  def initialize
+    set_byte_order
+    @data            = ''
+    @datasize        = 0
+    @limit           = 8224
+    @ignore_continue = 0
+    
+    # Open a tmp file to store the majority of the Worksheet data. If this fails,
+    # for example due to write permissions, store the data in memory. This can be
+    # slow for large files.
+    @filehandle = Tempfile.new('spreadsheetwriteexcel')
+    @filehandle.binmode
+
+    # failed. store temporary data in memory.
+    @using_tmpfile = @filehandle ? true : false
+    
+  end
+
+  ###############################################################################
+  #
+  # _set_byte_order()
+  #
+  # Determine the byte order and store it as class data to avoid
+  # recalculating it for each call to new().
+  #
+  def set_byte_order
+    # Check if "pack" gives the required IEEE 64bit float
+    teststr = [1.2345].pack("d")
+    hexdata = [0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F]
+    number  = hexdata.pack("C8")
+
+    if number == teststr
+      @byte_order = 0    # Little Endian
+    elsif number == teststr.reverse
+      @byte_order = 1    # Big Endian
+    else
+      # Give up. I'll fix this in a later version.
+      raise( "Required floating point format not supported "  +
+      "on this platform. See the portability section " +
+      "of the documentation."
+      )
+    end
+  end
+
+  ###############################################################################
+  #
+  # _prepend($data)
+  #
+  # General storage function
+  #
+  def prepend(*args)
+    d = args.join
+    d = add_continue(d) if d.length > @limit
+
+    @datasize += d.length
+    @data      = d + @data
+
+#print "prepend\n"
+#print d.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ') + "\n\n"
+    return d
+  end
+
+  ###############################################################################
+  #
+  # _append($data)
+  #
+  # General storage function
+  #
+  def append(*args)
+    d = args.join
+    # Add CONTINUE records if necessary
+    d = add_continue(d) if d.length > @limit
+    if @using_tmpfile
+      @filehandle.write d
+      @datasize += d.length
+    else
+      @datasize += d.length
+      @data      = @data + d
+    end
+#print "apend\n"
+#print d.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ') + "\n\n"
+    return d
+  end
+
+  ###############################################################################
+  #
+  # get_data().
+  #
+  # Retrieves data from memory in one chunk, or from disk in $buffer
+  # sized chunks.
+  #
+  def get_data
+    buflen = 4096
+
+    # Return data stored in memory
+    unless @data.nil?
+      tmp   = @data
+      @data = nil
+      if @using_tmpfile
+        @filehandle.open
+        @filehandle.binmode
+      end
+      return tmp
+    end
+
+    # Return data stored on disk
+    if @using_tmpfile
+      return @filehandle.read(buflen)
+    end
+
+    # No data to return
+    return nil
+  end
+
+  ###############################################################################
+  #
+  # _store_bof($type)
+  #
+  # $type = 0x0005, Workbook
+  # $type = 0x0010, Worksheet
+  #
+  # Writes Excel BOF record to indicate the beginning of a stream or
+  # sub-stream in the BIFF file.
+  #
+  def store_bof(type = 0x0005)
+    record  = 0x0809      # Record identifier
+    length  = 0x0010      # Number of bytes to follow
+
+    # According to the SDK $build and $year should be set to zero.
+    # However, this throws a warning in Excel 5. So, use these
+    # magic numbers.
+    build   = 0x0DBB
+    year    = 0x07CC
+
+    bfh     = 0x00000041
+    sfo     = 0x00000006
+
+    header  = [record,length].pack("vv")
+    data    = [BIFF_Version,type,build,year,bfh,sfo].pack("vvvvVV")
+
+    prepend(header, data)
+  end
+
+  ###############################################################################
+  #
+  # _store_eof()
+  #
+  # Writes Excel EOF record to indicate the end of a BIFF stream.
+  #
+  def store_eof
+    record = 0x000A
+    length = 0x0000
+    header = [record,length].pack("vv")
+
+    append(header)
+  end
+
+  ###############################################################################
+  #
+  # _add_continue()
+  #
+  # Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In
+  # Excel 97 the limit is 8228 bytes. Records that are longer than these limits
+  # must be split up into CONTINUE blocks.
+  #
+  # This function take a long BIFF record and inserts CONTINUE records as
+  # necessary.
+  #
+  # Some records have their own specialised Continue blocks so there is also an
+  # option to bypass this function.
+  #
+  def add_continue(data)
+    record      = 0x003C # Record identifier
+
+    # Skip this if another method handles the continue blocks.
+    return data if @ignore_continue != 0
+
+    # The first 2080/8224 bytes remain intact. However, we have to change
+    # the length field of the record.
+    #
+
+    # in perl
+    #  $tmp = substr($data, 0, $limit, "");
+    if data.length > @limit
+      tmp = data[0, @limit]
+      data[0, @limit] = ''
+    else
+      tmp = data.dup
+      data = ''
+    end
+
+    tmp[2, 2] = [@limit-4].pack('v')
+
+    # Strip out chunks of 2080/8224 bytes +4 for the header.
+    while (data.length > @limit)
+      header  = [record, @limit].pack("vv")
+      tmp     = tmp + header + data[0, @limit]
+      data[0, @limit] = ''
+    end
+
+    # Mop up the last of the data
+    header  = [record, data.length].pack("vv")
+    tmp     = tmp + header + data
+
+    return tmp
+  end
+
+  ###############################################################################
+  #
+  # _add_mso_generic()
+  #    my $type        = $_[0];
+  #    my $version     = $_[1];
+  #    my $instance    = $_[2];
+  #    my $data        = $_[3];
+  #
+  # Create a mso structure that is part of an Escher drawing object. These are
+  # are used for images, comments and filters. This generic method is used by
+  # other methods to create specific mso records.
+  #
+  # Returns the packed record.
+  #
+  def add_mso_generic(type, version, instance, data, length = nil)
+    length  = length.nil? ? data.length : length
+
+    # The header contains version and instance info packed into 2 bytes.
+    header  = version | (instance << 4)
+
+    record  = [header, type, length].pack('vvV') + data
+
+    return record
+  end
+
+end

data/lib/writeexcel/chart.rb

@@ -0,0 +1,217 @@
+###############################################################################
+#
+# Chart - A writer class for Excel Charts.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2008, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/biffwriter'
+
+class Chart
+
+
+  attr_reader :name
+
+
+  ###############################################################################
+  #
+  # new()
+  #
+  # Constructor. Creates a new Chart object from a BIFFwriter object
+  #
+  def initialize(filename, name, index, encoding, activesheet, firstsheet)
+    @filename          = filename
+    @name              = name
+    @index             = index
+    @encoding          = encoding
+    @activesheet       = activesheet
+    @firstsheet        = firstsheet
+
+    @type              = 0x0200
+    @ext_sheets        = []
+    @using_tmpfile     = 1
+    @filehandle        = ""
+    @fileclosed        = false
+    @offset            = 0
+    @xls_rowmax        = 0
+    @xls_colmax        = 0
+    @xls_strmax        = 0
+    @dim_rowmin        = 0
+    @dim_rowmax        = 0
+    @dim_colmin        = 0
+    @dim_colmax        = 0
+    @dim_changed       = 0
+    @colinfo           = []
+    @selection         = [0, 0]
+    @panes             = []
+    @active_pane       = 3
+    @frozen            = 0
+    @selected          = 0
+    @hidden            = 0
+
+    @paper_size        = 0x0
+    @orientation       = 0x1
+    @header            = ''
+    @footer            = ''
+    @hcenter           = 0
+    @vcenter           = 0
+    @margin_head       = 0.50
+    @margin_foot       = 0.50
+    @margin_left       = 0.75
+    @margin_right      = 0.75
+    @margin_top        = 1.00
+    @margin_bottom     = 1.00
+
+    @title_rowmin      = nil
+    @title_rowmax      = nil
+    @title_colmin      = nil
+    @title_colmax      = nil
+    @print_rowmin      = nil
+    @print_rowmax      = nil
+    @print_colmin      = nil
+    @print_colmax      = nil
+
+    @print_gridlines   = 1
+    @screen_gridlines  = 1
+    @print_headers     = 0
+
+    @fit_page          = 0
+    @fit_width         = 0
+    @fit_height        = 0
+
+    @hbreaks           = []
+    @vbreaks           = []
+
+    @protect           = 0
+    @password          = nil
+
+    @col_sizes         = {}
+    @row_sizes         = {}
+
+    @col_formats       = {}
+    @row_formats       = {}
+
+    @zoom              = 100
+    @print_scale       = 100
+
+    @leading_zeros     = 0
+
+    @outline_row_level = 0
+    @outline_style     = 0
+    @outline_below     = 1
+    @outline_right     = 1
+    @outline_on        = 1
+
+    _initialize
+  end
+
+  ###############################################################################
+  #
+  # get_data().
+  #
+  # Retrieves data from memory in one chunk, or from disk in $buffer
+  # sized chunks.
+  #
+  def get_data
+    buffer = 4096
+
+    return tmp if read(@filehandle, tmp, buffer)
+
+    # No data to return
+    return nil
+  end
+
+
+  ###############################################################################
+  #
+  # select()
+  #
+  # Set this worksheet as a selected worksheet, i.e. the worksheet has its tab
+  # highlighted.
+  #
+  def select
+    @hidden         = 0 # Selected worksheet can't be hidden.
+    @selected       = 1
+  end
+
+
+  ###############################################################################
+  #
+  # activate()
+  #
+  # Set this worksheet as the active worksheet, i.e. the worksheet that is
+  # displayed when the workbook is opened. Also set it as selected.
+  #
+  def activate
+    @hidden      = 0 # Active worksheet can't be hidden.
+    @selected    = 1
+    @activesheet = @index
+  end
+
+
+  ###############################################################################
+  #
+  # hide()
+  #
+  # Hide this worksheet.
+  #
+  def hide
+    @hidd        = 1
+
+    # A hidden worksheet shouldn't be active or selected.
+    @selecte     = 0
+    @activesheet = 0
+    @firstsheet  = 0
+  end
+
+
+  ###############################################################################
+  #
+  # set_first_sheet()
+  #
+  # Set this worksheet as the first visible sheet. This is necessary
+  # when there are a large number of worksheets and the activated
+  # worksheet is not visible on the screen.
+  #
+  def set_first_sheet
+    hidden      = 0 # Active worksheet can't be hidden.
+    firstsheet  = index
+  end
+
+
+
+  ###############################################################################
+
+  private
+
+  ###############################################################################
+
+
+  ###############################################################################
+  #
+  # _initialize()
+  #
+  def _initialize
+    filehandle = open(@filename, "rb") or
+    die "Couldn't open #{@filename} in add_chart_ext(): $!.\n"
+    @filehandle = filehandle
+    @datasize   = File.Stat.size(@filename)
+  end
+
+  ###############################################################################
+  #
+  # _close()
+  #
+  # Add data to the beginning of the workbook (note the reverse order)
+  # and to the end of the workbook.
+  #
+  def _close
+  end
+
+end