writeexcel 0.6.6 → 0.6.7

data/lib/writeexcel/colors.rb

@@ -58,6 +58,10 @@ class Colors
       0x7FFF
     end
   end
+
+  def inspect
+    to_s
+  end
 end  # class Colors
 
 end  # module Writeexcel

data/lib/writeexcel/format.rb

@@ -25,14 +25,12 @@ module Writeexcel
 class Format < Colors
   require 'writeexcel/helper'
 
-  ###############################################################################
   #
-  # initialize(xf_index=0, properties = {})
+  # Constructor
+  #
   #    xf_index   :
   #    properties : Hash of property => value
   #
-  # Constructor
-  #
   def initialize(xf_index = 0, properties = {})   # :nodoc:
     @xf_index       = xf_index
 
@@ -179,9 +177,6 @@ class Format < Colors
     @font_only      = other.font_only
   end
 
-  ###############################################################################
-  #
-  # get_xf($style)
   #
   # Generate an Excel BIFF XF record.
   #
@@ -335,9 +330,6 @@ class Format < Colors
     header + data
   end
 
-  ###############################################################################
-  #
-  # get_font()
   #
   # Generate an Excel BIFF FONT record.
   #
@@ -406,9 +398,6 @@ class Format < Colors
     header + data + rgch
   end
 
-  ###############################################################################
-  #
-  # get_font_key()
   #
   # Returns a unique hash key for a font. Used by Workbook->_store_all_fonts()
   #
@@ -422,9 +411,6 @@ class Format < Colors
     key.gsub(' ', '_') # Convert the key to a single word
   end
 
-  ###############################################################################
-  #
-  # xf_index()
   #
   # Returns the used by Worksheet->_XF()
   #
@@ -616,9 +602,6 @@ class Format < Colors
     @font_only
   end
 
-  ###############################################################################
-  #
-  # class method    Format._get_color(colour)
   #
   #  used from Worksheet.rb
   #
@@ -628,9 +611,6 @@ class Format < Colors
     Colors.new.get_color(color)
   end
 
-  ###############################################################################
-  #
-  # set_type()
   #
   # Set the XF object type as 0 = cell XF or 0xFFF5 = style XF.
   #
@@ -986,9 +966,6 @@ class Format < Colors
     end
   end
 
-  ###############################################################################
-  #
-  # set_valign()
   #
   # Set vertical cell alignment. This is required by the set_format_properties()
   # method to differentiate between the vertical and horizontal properties.
@@ -1023,9 +1000,6 @@ class Format < Colors
     set_text_h_align(6)
   end
 
-  ###############################################################################
-  #
-  # set_merge()
   #
   # This was the way to implement a merge in Excel5. However it should have been
   # called "center_across" and not "merge".

data/lib/writeexcel/formula.rb

@@ -31,9 +31,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     initialize_hashes
   end
 
-  ###############################################################################
-  #
-  # parse_formula()
   #
   # Takes a textual description of a formula and returns a RPN encoded byte
   # string.
@@ -60,9 +57,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     end
   end
 
-  ###############################################################################
-  #
-  # parse_tokens()
   #
   # Convert each token or token pair to its Excel 'ptg' equivalent.
   #
@@ -227,9 +221,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   ###############################################################################
 
 
-  ###############################################################################
-  #
-  #  _check_volatile()
   #
   # Check if the formula contains a volatile function, i.e. a function that must
   # be recalculated each time a cell is updated. These formulas require a ptgAttr
@@ -251,9 +242,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     volatile
   end
 
-  ###############################################################################
-  #
-  # _convert_volatile()
   #
   # Convert _vol to a ptgAttr tag formatted to indicate that the formula contains
   # a volatile function. See _check_volatile()
@@ -263,9 +251,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
       return [@ptg['ptgAttr'], 0x1, 0x0].pack("CCv")
   end
 
-  ###############################################################################
-  #
-  # _convert_bool()
   #
   # Convert a boolean token to ptgBool
   #
@@ -274,9 +259,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
 
 
-  ###############################################################################
-  #
-  # _convert_number()
   #
   # Convert a number token to ptgInt or ptgNum
   #
@@ -291,9 +273,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     end
   end
 
-  ###############################################################################
-  #
-  # _convert_string()
   #
   # Convert a string to a ptg Str.
   #
@@ -322,9 +301,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     [@ptg['ptgStr'], length, encoding].pack("CCC") + str
   end
 
-  ###############################################################################
-  #
-  # _convert_ref2d()
   #
   # Convert an Excel reference such as A1, $B2, C$3 or $D$4 to a ptgRefV.
   #
@@ -346,9 +322,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     ptgref + row + col
   end
 
-  ###############################################################################
-  #
-  # _convert_ref3d
   #
   # Convert an Excel 3d reference such as "Sheet1!A1" or "Sheet1:Sheet2!A1" to a
   # ptgRef3dV.
@@ -377,9 +350,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     ptgref + ext_ref + row + col
   end
 
-  ###############################################################################
-  #
-  # _convert_range2d()
   #
   # Convert an Excel range such as A1:D4 or A:D to a ptgRefV.
   #
@@ -409,9 +379,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     ptgarea + row1 + row2 + col1 + col2
   end
 
-  ###############################################################################
-  #
-  # _convert_range3d
   #
   # Convert an Excel 3d range such as "Sheet1!A1:D4" or "Sheet1:Sheet2!A1:D4" to
   # a ptgArea3dV.
@@ -448,9 +415,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     ptgarea + ext_ref + row1 + row2 + col1+ col2
   end
 
-  ###############################################################################
-  #
-  # _pack_ext_ref()
   #
   # Convert the sheet name part of an external reference, for example "Sheet1" or
   # "Sheet1:Sheet2", to a packed structure.
@@ -491,9 +455,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     [index].pack("v")
   end
 
-  ###############################################################################
-  #
-  # _get_sheet_index()
   #
   # Look up the index that corresponds to an external sheet name. The hash of
   # sheet names is updated by the add_worksheet() method of the Workbook class.
@@ -515,9 +476,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   public :get_sheet_index
 
-  ###############################################################################
-  #
-  # set_ext_sheets()
   #
   # This semi-public method is used to update the hash of sheet names. It is
   # updated by the add_worksheet() method of the Workbook class.
@@ -529,9 +487,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   public :set_ext_sheets
 
-  ###############################################################################
-  #
-  # get_ext_sheets()
   #
   # This semi-public method is used to get the worksheet references that were
   # used in formulas for inclusion in the EXTERNSHEET Workbook record.
@@ -541,9 +496,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   public :get_ext_sheets
 
-  ###############################################################################
-  #
-  # get_ext_ref_count()
   #
   # TODO This semi-public method is used to update the hash of sheet names. It is
   # updated by the add_worksheet() method of the Workbook class.
@@ -552,9 +504,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     @ext_ref_count
   end
 
-  ###############################################################################
-  #
-  # _get_name_index()
   #
   # Look up the index that corresponds to an external defined name. The hash of
   # defined names is updated by the define_name() method in the Workbook class.
@@ -568,9 +517,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   private :get_name_index
 
-  ###############################################################################
-  #
-  # set_ext_name()
   #
   # This semi-public method is used to update the hash of defined names.
   #
@@ -579,9 +525,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   public :set_ext_name
 
-  ###############################################################################
-  #
-  # _convert_function()
   #
   # Convert a function to a ptgFunc or ptgFuncVarV depending on the number of
   # args that it takes.
@@ -607,9 +550,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     end
   end
 
-  ###############################################################################
-  #
-  # _convert_name()
   #
   # Convert a symbolic name into a name reference.
   #
@@ -629,9 +569,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
   end
   private :convert_name
 
-  ###############################################################################
-  #
-  # _cell_to_rowcol($cell_ref)
   #
   # Convert an Excel cell reference such as A1 or $B2 or C$3 or $D$4 to a zero
   # indexed row and column number. Also returns two boolean values to indicate
@@ -654,9 +591,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     [row, col, row_rel, col_rel]
   end
 
-  ###############################################################################
-  #
-  # _cell_to_packed_rowcol($row, $col, $row_rel, $col_rel)
   #
   # pack() row and column into the required 3 byte format.
   #
@@ -676,10 +610,6 @@ class Formula < ExcelFormulaParser       #:nodoc:
     [row, col]
   end
 
-  ###############################################################################
-  #
-  # _initialize_hashes()
-  #
   def initialize_hashes
 
     # The Excel ptg indices
@@ -1024,6 +954,10 @@ class Formula < ExcelFormulaParser       #:nodoc:
     }
 
   end
+
+  def inspect
+    to_s
+  end
 end
 
 if $0 ==__FILE__

data/lib/writeexcel/image.rb

@@ -0,0 +1,158 @@
+# -*- coding:utf-8 -*-
+require 'digest/md5'
+
+module Writeexcel
+  class Image
+    attr_reader :row, :col, :filename, :x_offset, :y_offset, :scale_x, :scale_y
+    attr_reader :data, :size, :checksum1, :checksum2
+    attr_accessor :id, :type, :width, :height, :ref_count
+
+    def initialize(row, col, filename, x_offset = 0, y_offset = 0, scale_x = 1, scale_y = 1)
+      @row = row
+      @col = col
+      @filename = filename
+      @x_offset = x_offset
+      @y_offset = y_offset
+      @scale_x  = scale_x
+      @scale_y  = scale_y
+      get_checksum_method
+    end
+
+    def import
+      File.open(@filename, "rb") do |fh|
+        raise "Couldn't import #{@filename}: #{$!}" unless fh
+        @data = fh.read
+      end
+      @size = data.bytesize
+      @checksum1 = image_checksum(@data)
+      @checksum2 = @checksum1
+      process
+    end
+
+    private
+
+    # Process the image and extract dimensions.
+    def process
+      case filetype
+      when 'PNG'
+        process_png(@data)
+      when 'JPG'
+        process_jpg(@data)
+      when 'BMP'
+        process_bmp(@data)
+        # The 14 byte header of the BMP is stripped off.
+        @data[0, 13] = ''
+        # A checksum of the new image data is also required.
+        @checksum2  = image_checksum(@data, @id, @id)
+        # Adjust size -14 (header) + 16 (extra checksum).
+        @size += 2
+      end
+    end
+
+    def filetype
+      return 'PNG' if @data.unpack('x A3')[0] ==  'PNG'
+      return 'BMP' if @data.unpack('A2')[0] == 'BM'
+      if data.unpack('n')[0] == 0xFFD8
+        return 'JPG' if @data.unpack('x6 A4')[0] == 'JFIF' || @data.unpack('x6 A4')[0] == 'Exif'
+      else
+        raise "Unsupported image format for file: #{@filename}\n"
+      end
+    end
+
+    # Extract width and height information from a PNG file.
+    def process_png(data)
+      @type   = 6 # Excel Blip type (MSOBLIPTYPE).
+      @width  = data[16, 4].unpack("N")[0]
+      @height = data[20, 4].unpack("N")[0]
+    end
+
+    # Extract width and height information from a BMP file.
+    def process_bmp(data)       #:nodoc:
+      @type     = 7   # Excel Blip type (MSOBLIPTYPE).
+      # Read the bitmap width and height. Verify the sizes.
+      @width, @height = data.unpack("x18 V2")
+      check_verify(data)
+    end
+
+    def check_verify(data)
+      # Check that the file is big enough to be a bitmap.
+      raise "#{@filename} doesn't contain enough data." if data.bytesize <= 0x36
+      raise "#{@filename}: largest image width #{width} supported is 65k." if @width > 0xFFFF
+      raise "#{@filename}: largest image height supported is 65k." if @height > 0xFFFF
+
+      # Read the bitmap planes and bpp data. Verify them.
+      planes, bitcount = data.unpack("x26 v2")
+      raise "#{@filename} isn't a 24bit true color bitmap." unless bitcount == 24
+      raise "#{@filename}: only 1 plane supported in bitmap image." unless planes == 1
+
+      # Read the bitmap compression. Verify compression.
+      compression = data.unpack("x30 V")
+      raise "#{@filename}: compression not supported in bitmap image." unless compression == 0
+    end
+
+    # Extract width and height information from a JPEG file.
+    def process_jpg(data)
+      @type     = 5  # Excel Blip type (MSOBLIPTYPE).
+
+      offset = 2
+      data_length = data.bytesize
+
+      # Search through the image data to find the 0xFFC0 marker. The height and
+      # width are contained in the data for that sub element.
+      while offset < data_length
+        marker  = data[offset,   2].unpack("n")
+        marker = marker[0]
+        length  = data[offset+2, 2].unpack("n")
+        length = length[0]
+
+        if marker == 0xFFC0 || marker == 0xFFC2
+          height = data[offset+5, 2].unpack("n")
+          @height = height[0]
+          width  = data[offset+7, 2].unpack("n")
+          @width  = width[0]
+          break
+        end
+
+        offset += length + 2
+        break if marker == 0xFFDA
+      end
+
+      raise "#{@filename}: no size data found in jpeg image.\n" unless @height
+    end
+
+    #
+    # Generate a checksum for the image using whichever module is available. The
+    # available modules are checked in get_checksum_method(). Excel uses an MD4
+    # checksum but any other will do. In the event of no checksum module being
+    # available we simulate a checksum using the image index.
+    #
+    # index1 and index2 is not used.
+    #
+    def image_checksum(data, index1 = 0, index2 = 0)       #:nodoc:
+      case @checksum_method
+      when 3
+        Digest::MD5.hexdigest(data)
+      when 1
+        # Digest::MD4
+        #           return Digest::MD4::md4_hex($data);
+      when 2
+        # Digest::Perl::MD4
+        #           return Digest::Perl::MD4::md4_hex($data);
+      else
+        # Default
+  #      return sprintf('%016X%016X', index2, index1)
+      end
+    end
+
+    #
+    # Check for modules available to calculate image checksum. Excel uses MD4 but
+    # MD5 will also work.
+    #
+    # ------- cxn03651 add -------
+    # md5 can use in ruby. so, @checksum_method is always 3.
+
+    def get_checksum_method       #:nodoc:
+      @checksum_method = 3
+    end
+  end
+end