ru_excel 0.0.6

data/lib/ru_excel/formatting.rb

@@ -0,0 +1,231 @@
+=begin
+The  XF  record is able to store explicit cell formatting attributes or the
+attributes  of  a cell style. Explicit formatting includes the reference to
+a  cell  style  XF  record. This allows to extend a defined cell style with
+some  explicit  attributes.  The  formatting  attributes  are  divided into
+6 groups
+
+Group           Attributes
+-------------------------------------
+Number format   Number format index (index to FORMAT record)
+Font            Font index (index to FONT record)
+Alignment       Horizontal and vertical alignment, text wrap, indentation, 
+                orientation/rotation, text direction
+Border          Border line styles and colours
+Background      Background area style and colours
+Protection      Cell locked, formula hidden
+
+For  each  group  a flag in the cell XF record specifies whether to use the
+attributes  contained  in  that  XF  record  or  in  the  referenced  style
+XF  record. In style XF records, these flags specify whether the attributes
+will  overwrite  explicit  cell  formatting  when  the  style is applied to
+a  cell. Changing a cell style (without applying this style to a cell) will
+change  all  cells which already use that style and do not contain explicit
+cell  attributes for the changed style attributes. If a cell XF record does
+not  contain  explicit  attributes  in a group (if the attribute group flag
+is not set), it repeats the attributes of its style XF record.
+=end
+require File.dirname(__FILE__)+'/biff_records'
+
+module Excel
+  class Font
+    ESCAPEMENT_NONE         = 0x00
+    ESCAPEMENT_SUPERSCRIPT  = 0x01
+    ESCAPEMENT_SUBSCRIPT    = 0x02
+    
+    UNDERLINE_NONE          = 0x00
+    UNDERLINE_SINGLE        = 0x01
+    UNDERLINE_SINGLE_ACC    = 0x21
+    UNDERLINE_DOUBLE        = 0x02
+    UNDERLINE_DOUBLE_ACC    = 0x22
+    
+    FAMILY_NONE         = 0x00
+    FAMILY_ROMAN        = 0x01
+    FAMILY_SWISS        = 0x02
+    FAMILY_MODERN       = 0x03
+    FAMILY_SCRIPT       = 0x04
+    FAMILY_DECORARTIVE  = 0x05
+    
+    CHARSET_ANSI_LATIN          = 0x00
+    CHARSET_SYS_DEFAULT         = 0x01
+    CHARSET_SYMBOL              = 0x02
+    CHARSET_APPLE_ROMAN         = 0x4D
+    CHARSET_ANSI_JAP_SHIFT_JIS  = 0x80
+    CHARSET_ANSI_KOR_HANGUL     = 0x81
+    CHARSET_ANSI_KOR_JOHAB      = 0x82
+    CHARSET_ANSI_CHINESE_GBK    = 0x86
+    CHARSET_ANSI_CHINESE_BIG5   = 0x88
+    CHARSET_ANSI_GREEK          = 0xA1
+    CHARSET_ANSI_TURKISH        = 0xA2
+    CHARSET_ANSI_VIETNAMESE     = 0xA3
+    CHARSET_ANSI_HEBREW         = 0xB1
+    CHARSET_ANSI_ARABIC         = 0xB2
+    CHARSET_ANSI_BALTIC         = 0xBA
+    CHARSET_ANSI_CYRILLIC       = 0xCC
+    CHARSET_ANSI_THAI           = 0xDE
+    CHARSET_ANSI_LATIN_II       = 0xEE
+    CHARSET_OEM_LATIN_I         = 0xFF   
+    
+    def initialize
+        # twip = 1/20 of a point = 1/1440 of a inch
+        # usually resolution == 96 pixels per 1 inch 
+        # (rarely 120 pixels per 1 inch or another one)
+        
+        @height = 0x00C8 # 200: this is font with height 10 points
+        @italic = false
+        @struck_out = false
+        @outline = false
+        @shadow = false
+        @colour_index = 0x7FFF
+        @bold = false
+        @_weight = 0x0190 # 0x02BC gives bold font
+        @escapement = ESCAPEMENT_NONE
+        @underline = UNDERLINE_NONE
+        @family = FAMILY_NONE
+        @charset = CHARSET_ANSI_CYRILLIC       
+        @name = 'Arial'
+    end
+    attr_accessor :height, :italic, :struck_out, :outline, :shadow, :colour_index, :bold, :_weight
+    attr_accessor :underline, :family, :charset, :name
+                
+    def get_biff_record
+        height = @height
+        
+        options = 0x00
+        if @bold
+            options |= 0x01
+            @_weight = 0x02BC
+        end
+        options |= 0x02 if @italic
+        options |= 0x04 if @underline != UNDERLINE_NONE
+        options |= 0x08 if @struck_out
+        options |= 0x010 if @outline
+        options |= 0x020 if @shadow
+
+        colour_index = @colour_index 
+        weight = @_weight
+        escapement = @escapement
+        underline = @underline 
+        family = @family 
+        charset = @charset
+        name = @name
+
+        BiffRecord.fontRecord(
+                    height, options, colour_index, weight, escapement, 
+                    underline, family, charset, 
+                    name)
+    end
+  end
+
+  class Alignment
+    HORZ_GENERAL                = 0x00
+    HORZ_LEFT                   = 0x01
+    HORZ_CENTER                 = 0x02
+    HORZ_RIGHT                  = 0x03
+    HORZ_FILLED                 = 0x04
+    HORZ_JUSTIFIED              = 0x05 # BIFF4-BIFF8X
+    HORZ_CENTER_ACROSS_SEL      = 0x06 # Centred across selection (BIFF4-BIFF8X)
+    HORZ_DISTRIBUTED            = 0x07 # Distributed (BIFF8X)
+    
+    VERT_TOP                    = 0x00 
+    VERT_CENTER                 = 0x01
+    VERT_BOTTOM                 = 0x02
+    VERT_JUSTIFIED              = 0x03 # Justified (BIFF5-BIFF8X)
+    VERT_DISIRIBUTED            = 0x04 # Distributed (BIFF8X)
+
+    DIRECTION_GENERAL           = 0x00 # BIFF8X
+    DIRECTION_LR                = 0x01
+    DIRECTION_RL                = 0x02
+
+    ORIENTATION_NOT_ROTATED     = 0x00
+    ORIENTATION_STACKED         = 0x01
+    ORIENTATION_90_CC           = 0x02
+    ORIENTATION_90_CW           = 0x03
+
+    ROTATION_0_ANGLE            = 0x00
+    ROTATION_STACKED            = 0xFF
+
+    WRAP_AT_RIGHT               = 0x01
+    NOT_WRAP_AT_RIGHT           = 0x00
+
+    SHRINK_TO_FIT               = 0x01
+    NOT_SHRINK_TO_FIT           = 0x00
+
+    def initialize
+        @horz = HORZ_GENERAL
+        @vert = VERT_BOTTOM
+        @dire = DIRECTION_GENERAL
+        @orie = ORIENTATION_NOT_ROTATED
+        @rota = ROTATION_0_ANGLE
+        @wrap = NOT_WRAP_AT_RIGHT
+#        @wrap = WRAP_AT_RIGHT
+        @shri = NOT_SHRINK_TO_FIT
+        @inde = 0
+        @merg = 0
+    end
+    attr_accessor :horz, :vert, :dire, :orie, :rota, :wrap, :shri, :inde, :merg
+  end
+
+  class Borders
+    NO_LINE = 0x00
+    THIN    = 0x01
+    MEDIUM  = 0x02
+    DASHED  = 0x03
+    DOTTED  = 0x04
+    THICK   = 0x05
+    DOUBLE  = 0x06
+    HAIR    = 0x07
+    #The following for BIFF8
+    MEDIUM_DASHED               = 0x08
+    THIN_DASH_DOTTED            = 0x09
+    MEDIUM_DASH_DOTTED          = 0x0A
+    THIN_DASH_DOT_DOTTED        = 0x0B
+    MEDIUM_DASH_DOT_DOTTED      = 0x0C
+    SLANTED_MEDIUM_DASH_DOTTED  = 0x0D
+    
+    NEED_DIAG1      = 0x01
+    NEED_DIAG2      = 0x01
+    NO_NEED_DIAG1   = 0x00
+    NO_NEED_DIAG2   = 0x00
+
+    def initialize
+        @left   = NO_LINE
+        @right  = NO_LINE
+        @top    = NO_LINE
+        @bottom = NO_LINE
+        @diag   = NO_LINE
+
+        @left_colour   = 0x40
+        @right_colour  = 0x40
+        @top_colour    = 0x40
+        @bottom_colour = 0x40
+        @diag_colour   = 0x40
+        
+        @need_diag1 = NO_NEED_DIAG1
+        @need_diag2 = NO_NEED_DIAG2
+    end
+    
+    attr_accessor :left, :right, :top, :bottom, :diag, :left_colour, :right_colour, :top_colour, :bottom_colour
+    attr_accessor :diag_colour, :need_diag1, :need_diag2
+  end
+
+  class Pattern
+    # patterns 0x00 - 0x12
+    NO_PATTERN      = 0x00 
+    SOLID_PATTERN   = 0x01 
+    def initialize
+        @pattern = NO_PATTERN
+        @pattern_fore_colour = 0x40
+        @pattern_back_colour = 0x41
+    end
+    attr_accessor :pattern, :pattern_fore_colour, :pattern_back_colour
+  end
+
+  class Protection
+    def initialize
+        @cell_locked = 1
+        @formula_hidden = 0
+    end
+    attr_accessor :cell_locked, :formula_hidden
+  end
+end

data/lib/ru_excel/row.rb

@@ -0,0 +1,170 @@
+dir = File.dirname(__FILE__)
+require dir+'/biff_records'
+require dir+'/worksheet'
+require dir+'/style'
+require 'date'
+
+module Excel
+  class Row
+
+    #################################################################
+    ## Constructor
+    #################################################################
+    def initialize(index, parent_sheet)
+        @idx = index
+        @parent = parent_sheet
+        @parent_wb = parent_sheet.parent
+        @cells = []
+        @min_col_idx = 0
+        @max_col_idx = 0
+        @total_str = 0
+        @xf_index = 0x0F
+        @has_default_format = 0
+        @height_in_pixels = 0x11
+        
+        @height = 0x00FF
+        @has_default_height = 0x00
+        @level = 0
+        @collapse = 0
+        @hidden = 0
+        @space_above = 0
+        @space_below = 0
+    end
+    
+    attr_accessor :level
+
+    def _adjust_height(style)
+        twips = style.font.height
+        points = twips.to_f/20.0
+        # Cell height in pixels can be calcuted by following approx. formula
+        # cell height in pixels = font height in points * 83/50 + 2/5
+        # It works when screen resolution is 96 dpi 
+        pix = (points*83.0/50.0 + 2.0/5.0.to_i).round
+        if pix > @height_in_pixels
+            @height_in_pixels = pix
+        end
+    end
+
+
+    def _adjust_bound_col_idx(*args)
+        for arg in args
+            if arg < @min_col_idx
+                @min_col_idx = arg
+            elsif arg > @max_col_idx
+                @max_col_idx = arg
+            end
+        end
+    end
+
+    EPOCH = Date.new(1899, 12, 31)
+    TIME_EPOCH = Time.mktime(1902, 1, 1)
+    TIME_EPOCH_ADD = (Date.new(1902, 1, 1) - Date.new(1899, 12, 31))
+    def _excel_date_dt(date)
+        if Date === date
+            xldate = (date - EPOCH).to_f + date.offset.to_f
+        elsif Time === date
+            xldate = (date - TIME_EPOCH + 
+                      date.utc_offset - TIME_EPOCH.utc_offset).to_f / (24 * 60 * 60) +
+                     TIME_EPOCH_ADD
+        else
+            raise date.inspect+' is not a date'
+        end
+        # Add a day for Excel's missing leap day in 1900
+        xldate += 1 if xldate > 59
+        xldate
+    end
+
+    def get_height_in_pixels
+        @height_in_pixels
+    end
+
+
+    def set_style(style)
+        _adjust_height(style)
+        @xf_index = @parent_wb.add_style(style)
+    end
+
+            
+    def get_xf_index
+        @xf_index
+    end
+
+    
+    def get_cells_count
+        @cells.length
+    end
+
+    
+    def get_min_col
+        @min_col_idx
+    end
+
+        
+    def get_max_col
+        @min_col_idx
+    end
+
+        
+    def get_str_count
+        @total_str
+    end
+
+
+    def get_row_biff_data
+        height_options = (@height & 0x07FFF) 
+        height_options |= (@has_default_height & 0x01) << 15
+
+        options =  (@level & 0x07) << 0
+        options |= (@collapse & 0x01) << 4
+        options |= (@hidden & 0x01) << 5
+        options |= (0x00 & 0x01) << 6
+        options |= (0x01 & 0x01) << 8
+        if @xf_index != 0x0F
+            options |= (0x01 & 0x01) << 7
+        else
+            options |= (0x00 & 0x01) << 7
+        end
+        options |= (@xf_index & 0x0FFF) << 16 
+        options |= (0x00 & @space_above) << 28
+        options |= (0x00 & @space_below) << 29
+        
+        BiffRecord.rowRecord(@idx, @min_col_idx, @max_col_idx, height_options, options)
+    end
+
+    def get_cells_biff_data
+        #@cells.map{|c| c.get_biff_data()}.join('')
+        @cells.join('')
+    end
+
+
+    def get_index
+        @idx
+    end
+
+
+    def write(col, label, style)
+        _adjust_height(style)
+        _adjust_bound_col_idx(col)
+        if String === label
+            if label.length > 0
+                @cells << Cell.strCell(self, col, @parent_wb.add_style(style), @parent_wb.add_str(label))
+                @total_str += 1
+            else
+                @cells << Cell.blankCell(self, col, @parent_wb.add_style(style))
+            end
+        elsif Numeric === label
+            @cells << Cell.numberCell(self, col, @parent_wb.add_style(style), label)
+        elsif Date === label or Time === label
+            @cells << Cell.numberCell(self, col, @parent_wb.add_style(style), _excel_date_dt(label))
+        else
+            @cells << Cell.formulaCell(self, col, @parent_wb.add_style(style), label)
+        end
+    end
+
+    def write_blanks(c1, c2, style)
+        _adjust_height(style)
+        _adjust_bound_col_idx(c1, c2)
+        @cells << Cell.mulBlankCell(self, c1, c2, @parent_wb.add_style(style))
+    end
+  end
+end

data/lib/ru_excel/style.rb

@@ -0,0 +1,135 @@
+dir = File.dirname(__FILE__)
+require dir+'/formatting'
+require dir+'/biff_records'
+
+module Excel
+
+  class XFStyle
+    Default_num_format = 'general'
+    Default_font = Font.new()
+    Default_alignment = Alignment.new()
+    Default_borders = Borders.new()
+    Default_pattern = Pattern.new()
+    Default_protection = Protection.new()
+
+    def initialize
+        @num_format_str  = Default_num_format
+        @font            = Default_font 
+        @alignment       = Default_alignment
+        @borders         = Default_borders
+        @pattern         = Default_pattern 
+        @protection      = Default_protection
+    end
+    attr_accessor :num_format_str, :font, :alignment, :borders, :pattern, :protection
+  end
+
+  class StyleCollection
+    Std_num_fmt_list = [
+            'general',
+            '0',
+            '0.00',
+            '#,##0',
+            '#,##0.00',
+            '"$"#,##0_);("$"#,##',
+            '"$"#,##0_);[Red]("$"#,##',
+            '"$"#,##0.00_);("$"#,##',
+            '"$"#,##0.00_);[Red]("$"#,##',
+            '0%',
+            '0.00%',
+            '0.00E+00',
+            '# ?/?',
+            '# ??/??',
+            'M/D/YY',
+            'D-MMM-YY',
+            'D-MMM',
+            'MMM-YY',
+            'h:mm AM/PM',
+            'h:mm:ss AM/PM',
+            'h:mm',
+            'h:mm:ss',
+            'M/D/YY h:mm',
+            '_(#,##0_);(#,##0)',
+            '_(#,##0_);[Red](#,##0)',
+            '_(#,##0.00_);(#,##0.00)',
+            '_(#,##0.00_);[Red](#,##0.00)',
+            '_("$"* #,##0_);_("$"* (#,##0);_("$"* "-"_);_(@_)',
+            '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
+            '_("$"* #,##0.00_);_("$"* (#,##0.00);_("$"* "-"??_);_(@_)',
+            '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
+            'mm:ss',
+            '[h]:mm:ss',
+            'mm:ss.0',
+            '##0.0E+0',
+            '@'   
+    ]
+
+    NumFormats = {}
+    for fmtidx, fmtstr in (0...23).zip(Std_num_fmt_list[(0)...(23)])
+        NumFormats[fmtstr] = fmtidx
+    end
+    for fmtidx, fmtstr in (37...50).zip(Std_num_fmt_list[(23)..-1])
+        NumFormats[fmtstr] = fmtidx 
+    end
+
+    def initialize
+        @_fonts = {}
+        @_fonts[Font.new()] = 0
+        @_fonts[Font.new()] = 1
+        @_fonts[Font.new()] = 2
+        @_fonts[Font.new()] = 3
+        # The font with index 4 is omitted in all BIFF versions
+        @_fonts[Font.new()] = 5
+        @_num_formats = NumFormats.dup
+
+        @_xf = {}
+        @default_style = XFStyle.new()
+        @_default_xf = _add_style(@default_style)[0]
+    end
+    attr_accessor :default_style
+
+    def add(style)
+        style == nil ? 0x10 : _add_style(style)[1]
+    end
+
+    def _add_style(style)
+        num_format_str = style.num_format_str
+        num_format_idx = @_num_formats[num_format_str] ||=
+            163 + @_num_formats.length - Std_num_fmt_list.length
+        font = style.font
+        font_idx = @_fonts[font] ||= @_fonts.length + 1
+        xf = [font_idx, num_format_idx, style.alignment, style.borders, style.pattern, style.protection]
+        xf_index = @_xf[xf] ||= 0x10 + @_xf.length
+        [xf, xf_index]
+    end
+
+    def get_biff_data
+        result = ''
+        result << _all_fonts()
+        result << _all_num_formats()
+        result << _all_cell_styles()
+        result << _all_styles()
+        result
+    end
+
+    def _all_fonts
+        fonts = @_fonts.map{|k,v| [v,k]}.sort!
+        fonts.collect!{|_,font| font.get_biff_record}
+        fonts.join('')
+    end
+
+    def _all_num_formats
+        formats = @_num_formats.select{|k, v| v>=163}.to_a.each{|a| a.reverse!}
+        formats.map!{|fmtidx, fmtstr| BiffRecord.numberFormatRecord(fmtidx, fmtstr)}
+        formats.join('')
+    end
+
+    def _all_cell_styles
+        result = BiffRecord.xfRecord(@_default_xf, 'style') * 16
+        result << @_xf.map{|k,v| [v,k]}.sort!.collect!{|_,xf| BiffRecord.xfRecord(xf)}.join('')
+    end
+
+    def _all_styles
+        BiffRecord.styleRecord()
+    end
+  end
+end

data/lib/ru_excel/unicode_utils.rb

@@ -0,0 +1,73 @@
+=begin
+From BIFF8 on, strings are always stored using UTF-16LE  text encoding. The
+character  array  is  a  sequence  of  16-bit  values4.  Additionally it is
+possible  to  use  a  compressed  format, which omits the high bytes of all
+characters, if they are all zero.
+
+The following tables describe the standard format of the entire string, but
+in many records the strings differ from this format. This will be mentioned
+separately. It is possible (but not required) to store Rich-Text formatting
+information  and  Asian  phonetic information inside a Unicode string. This
+results  in  four  different  ways  to  store a string. The character array
+is not zero-terminated.
+
+The  string  consists  of  the  character count (as usual an 8-bit value or
+a  16-bit value), option flags, the character array and optional formatting
+information.  If the string is empty, sometimes the option flags field will
+not occur. This is mentioned at the respective place.
+
+Offset  Size    Contents
+0       1 or 2  Length of the string (character count, ln)
+1 or 2  1       Option flags:
+                  Bit   Mask Contents
+                  0     01H  Character compression (ccompr):
+                               0 = Compressed (8-bit characters)
+                               1 = Uncompressed (16-bit characters)
+                  2     04H  Asian phonetic settings (phonetic):
+                               0 = Does not contain Asian phonetic settings
+                               1 = Contains Asian phonetic settings
+                  3     08H  Rich-Text settings (richtext):
+                               0 = Does not contain Rich-Text settings
+                               1 = Contains Rich-Text settings
+[2 or 3] 2      (optional, only if richtext=1) Number of Rich-Text formatting runs (rt)
+[var.]   4      (optional, only if phonetic=1) Size of Asian phonetic settings block (in bytes, sz)
+var.     ln or 
+         2�ln   Character array (8-bit characters or 16-bit characters, dependent on ccompr)
+[var.]   4�rt   (optional, only if richtext=1) List of rt formatting runs 
+[var.]   sz     (optional, only if phonetic=1) Asian Phonetic Settings Block 
+=end
+
+
+require 'iconv'
+module Excel
+    module UnicodeUtils
+	
+	def u2ints(str)
+	    Excel::ICONV[:to_unicode].iconv(str).unpack('S*')
+	end
+	
+	def u2bytes(str)
+	    Excel::ICONV[:to_unicode].iconv(str)
+	end
+	
+	def upack2(str)
+	    begin
+		ustr = Excel::ICONV[:check_ascii].iconv(str)
+		[str.length, 0].pack('SC')+str
+	    rescue Iconv::IllegalSequence
+		ustr = u2bytes(str)
+		[ustr.length / 2, 1].pack('SC')+ustr
+	    end
+	end
+	
+	def upack1(str)
+	    begin
+		ustr = Excel::ICONV[:check_ascii].iconv(str)
+		[str.length, 0].pack('CC')+str
+	    rescue Iconv::IllegalSequence
+		ustr = u2bytes(str)
+		[ustr.length / 2, 1].pack('CC')+ustr
+	    end
+	end
+    end
+end