rrtf 0.1.1

data/lib/rrtf/font.rb

@@ -0,0 +1,182 @@
+require 'stringio'
+
+module RRTF
+   # This class represents a font for use with some RTF content.
+   class Font
+      # A declaration for a font family. This family is used for monospaced
+      # fonts (e.g. Courier New).
+      MODERN                        = :modern
+
+      # A declaration for a font family. This family is used for proportionally
+      # spaced serif fonts (e.g. Arial, Times New Roman).
+      ROMAN                         = :roman
+
+      # A declaration for a font family. This family is used for proportionally
+      # spaced sans serif fonts (e.g. Tahoma, Lucida Sans).
+      SWISS                         = :swiss
+
+      # A declaration for a font family. This family is used where none of the
+      # other families apply.
+      NIL                           = 'nil'.intern
+
+
+      # Attribute accessor.
+      attr_reader :family, :name
+
+
+      # Format: "<FAMILY_CONSTANT>:<Name>"
+      def self.from_string(str)
+        if str =~ /([a-z]+):(.+)/i
+          parts = str.split(':')
+          self.new(RRTF::Utilities.constantize("RRTF::Font::#{parts.first}"), parts.last)
+        else
+          RTFError.fire("Unreconized string font format '#{str}'.")
+        end
+      end
+
+
+      # This is the constructor for the Font class.
+      #
+      # ==== Parameters
+      # family::  The font family for the new font. This should be one of
+      #           Font::MODERN, Font::ROMAN, Font::SWISS or
+      #           Font::NIL.
+      # name::    A string containing the font name.
+      #
+      # ==== Exceptions
+      # RTFError::  Generated whenever an invalid font family is specified.
+      def initialize(family, name)
+         # Check that a valid family has been provided.
+         if ![MODERN, ROMAN, SWISS, NIL].include?(family)
+            RTFError::fire("Unknown font family specified for Font object.")
+         end
+         @family = family
+         @name   = name
+      end
+
+      # This method overloads the equivalence test operator for the Font class
+      # to allow for Font comparisons.
+      #
+      # ==== Parameters
+      # object::  A reference to the object to be compared with.
+      def ==(object)
+         object.instance_of?(Font) &&
+         object.family == @family &&
+         object.name   == @name
+      end
+
+      # This method fetches a textual description for a Font object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_s(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         "#{prefix}Family: #{@family.id2name}, Name: #{@name}"
+      end
+
+      # This method generates the RTF representation for a Font object as it
+      # would appear within a document font table.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_rtf(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         "#{prefix}\\f#{@family.id2name} #{@name};"
+      end
+   end # End of the Font class.
+
+
+   # This class represents the font table for an RTF document. An instance of
+   # the class is used internally by the Document class and should not need to
+   # be explicitly instantiated (although it can be obtained from a Document
+   # object if needed).
+   class FontTable
+      # This is the constructor for the RTFTable class.
+      #
+      # ==== Parameters
+      # *fonts::  Zero or more font objects that are to be added to the font
+      #           table. Objects that are not Fonts will be ignored.
+      def initialize(*fonts)
+         @fonts = []
+         fonts.each {|font| add(font)}
+      end
+
+      # This method is used to retrieve a count of the number of fonts held
+      # within an instance of the FontTable class.
+      def size
+         @fonts.size
+      end
+
+      # This method adds a font to a FontTable instance. This method returns
+      # a reference to the FontTable object updated.
+      #
+      # ==== Parameters
+      # font::  A reference to the font to be added. If this is not a Font
+      #         object or already exists in the table it will be ignored.
+      def add(font)
+         if font.instance_of?(Font)
+            @fonts.push(font) if @fonts.index(font).nil?
+         end
+         self
+      end
+
+      # This method iterates over the contents of a FontTable object. This
+      # method expects a block that takes a single parameter (the next font
+      # from the table).
+      def each
+         @fonts.each {|font| yield font} if block_given?
+      end
+
+      # This method overloads the array dereference operator for the FontTable
+      # class.
+      #
+      # ==== Parameters
+      # index::  The index into the font table of the font to be retrieved. If
+      #          the index is invalid then nil is returned.
+      def [](index)
+         @fonts[index]
+      end
+
+      # This method fetches the index of a font within a FontTable object. If
+      # the font does not exist in the table then nil is returned.
+      #
+      # ==== Parameters
+      # font::  A reference to the font to check for.
+      def index(font)
+         @fonts.index(font)
+      end
+
+      # This method generates a textual description for a FontTable object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_s(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+         text << "#{prefix}Font Table (#{@fonts.size} fonts)"
+         @fonts.each {|font| text << "\n#{prefix}   #{font}"}
+         text.string
+      end
+
+      # This method generates the RTF text for a FontTable object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_rtf(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+         text << "#{prefix}{\\fonttbl"
+         @fonts.each_index do |index|
+            text << "\n#{prefix}{\\f#{index}#{@fonts[index].to_rtf}}"
+         end
+         text << "\n#{prefix}}"
+         text.string
+      end
+
+      alias << add
+   end # End of the FontTable class.
+end # End of the RTF module.

data/lib/rrtf/information.rb

@@ -0,0 +1,110 @@
+require 'stringio'
+require 'date'
+
+module RRTF
+   # This class represents an information group for a RTF document.
+   class Information
+      # Attribute accessor.
+      attr_reader :title, :author, :company, :created, :comments
+
+      # Attribute mutator.
+      attr_writer :title, :author, :company, :comments
+
+
+      # This is the constructor for the Information class.
+      #
+      # ==== Parameters
+      # title::     A string containing the document title information. Defaults
+      #             to nil.
+      # author::    A string containing the document author information.
+      #             Defaults to nil.
+      # company::   A string containing the company name information. Defaults
+      #             to nil.
+      # comments::  A string containing the information comments. Defaults to
+      #             nil to indicate no comments.
+      # creation::  A Time object or a String that can be parsed into a Time
+      #             object (using ParseDate) indicating the document creation
+      #             date and time. Defaults to nil to indicate the current
+      #             date and time.
+      #
+      # ==== Exceptions
+      # RTFError::  Generated whenever invalid creation date/time details are
+      #             specified.
+      def initialize(title=nil, author=nil, company=nil, comments=nil, creation=nil)
+         @title       = title
+         @author      = author
+         @company     = company
+         @comments    = comments
+         self.created = (creation == nil ? Time.new : creation)
+      end
+
+      # This method provides the created attribute mutator for the Information
+      # class.
+      #
+      # ==== Parameters
+      # setting::  The new creation date/time setting for the object. This
+      #            should be either a Time object or a string containing
+      #            date/time details that can be parsed into a Time object
+      #            (using the parsedate method).
+      #
+      # ==== Exceptions
+      # RTFError::  Generated whenever invalid creation date/time details are
+      #             specified.
+      def created=(setting)
+         if setting.instance_of?(Time)
+            @created = setting
+         else
+           datetime = Date._parse(setting.to_s).values_at(:year, :mon, :mday, :hour, :min, :sec, :zone, :wday)
+            if datetime == nil
+               RTFError.fire("Invalid document creation date/time information "\
+                             "specified.")
+            end
+            @created = Time.local(datetime[0], datetime[1], datetime[2],
+                                  datetime[3], datetime[4], datetime[5])
+         end
+      end
+
+      # This method creates a textual description for an Information object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_s(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+
+         text << "#{prefix}Information"
+         text << "\n#{prefix}   Title:    #{@title}"    unless @title.nil?
+         text << "\n#{prefix}   Author:   #{@author}"   unless @author.nil?
+         text << "\n#{prefix}   Company:  #{@company}"  unless @company.nil?
+         text << "\n#{prefix}   Comments: #{@comments}" unless @comments.nil?
+         text << "\n#{prefix}   Created:  #{@created}"  unless @created.nil?
+
+         text.string
+      end
+
+      # This method generates the RTF text for an Information object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_rtf(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+
+         text << "#{prefix}{\\info"
+         text << "\n#{prefix}{\\title #{@title}}"       unless @title.nil?
+         text << "\n#{prefix}{\\author #{@author}}"     unless @author.nil?
+         text << "\n#{prefix}{\\company #{@company}}"   unless @company.nil?
+         text << "\n#{prefix}{\\doccomm #{@comments}}"  unless @comments.nil?
+         unless @created.nil?
+            text << "\n#{prefix}{\\createim\\yr#{@created.year}"
+            text << "\\mo#{@created.month}\\dy#{@created.day}"
+            text << "\\hr#{@created.hour}\\min#{@created.min}}"
+         end
+         text << "\n#{prefix}}"
+
+         text.string
+      end
+   end # End of the Information class.
+end # End of the RTF module.

data/lib/rrtf/list.rb

@@ -0,0 +1,219 @@
+module RRTF
+  class ListTable
+    def initialize
+      @templates = []
+    end
+
+    def new_template
+      @templates.push ListTemplate.new(next_template_id)
+      @templates.last
+    end
+
+    def to_rtf(indent=0)
+      return '' if @templates.empty?
+
+      prefix = indent > 0 ? ' ' * indent : ''
+
+      # List table
+      text = "#{prefix}{\\*\\listtable"
+      @templates.each {|tpl| text << tpl.to_rtf}
+      text << "}"
+
+      # List override table, a Cargo Cult.
+      text << "#{prefix}{\\*\\listoverridetable"
+      @templates.each do |tpl|
+        text << "{\\listoverride\\listid#{tpl.id}\\listoverridecount0\\ls#{tpl.id}}"
+      end
+      text << "}\n"
+    end
+
+    protected
+      def next_template_id
+        @templates.size + 1
+      end
+
+  end
+
+  class ListMarker
+    def initialize(name, codepoint=nil)
+      @name      = name
+      @codepoint = codepoint
+    end
+
+    def bullet?
+      !@codepoint.nil?
+    end
+
+    def type
+      bullet? ? :bullet : :decimal
+    end
+
+    def number_type
+      # 23: bullet, 0: arabic
+      # applies to the \levelnfcN macro
+      #
+      bullet? ? 23 : 0
+    end
+
+    def name
+      name  = "\\{#@name\\}"
+      name << '.' unless bullet?
+      name
+    end
+
+    def template_format
+      # The first char is the string size, the next ones are
+      # either placeholders (\'0X) or actual characters to
+      # include in the format. In the bullet case, \uc0 is
+      # used to get rid of the multibyte translation: we want
+      # an Unicode character.
+      #
+      # In the decimal case, we have a fixed format, with a
+      # dot following the actual number.
+      #
+      if bullet?
+        "\\'01\\uc0\\u#@codepoint"
+      else
+        "\\'02\\'00. "
+      end
+    end
+
+    def text_format(n=nil)
+      text =
+        if bullet?
+          "\\uc0\\u#@codepoint"
+        else
+          "#{n}."
+        end
+
+      "\t#{text}\t"
+    end
+  end
+
+  class ListTemplate
+    attr_reader :id
+
+    Markers = {
+      :disc    => ListMarker.new('disc',    0x2022),
+      :hyphen  => ListMarker.new('hyphen',  0x2043),
+      :decimal => ListMarker.new('decimal'        )
+    }
+
+    def initialize(id)
+      @levels = []
+      @id     = id
+    end
+
+    def level_for(level, kind = :bullets)
+      @levels[level-1] ||= begin
+        # Only disc for now: we'll add support
+        # for more customization options later
+        marker = Markers[kind == :bullets ? :disc : :decimal]
+        ListLevel.new(self, marker, level)
+      end
+    end
+
+    def to_rtf(indent=0)
+      prefix = indent > 0 ? ' ' * indent : ''
+
+      text = "#{prefix}{\\list\\listtemplate#{id}\\listhybrid"
+      @levels.each {|lvl| text << lvl.to_rtf}
+      text << "{\\listname;}\\listid#{id}}\n"
+
+      text
+    end
+  end
+
+  class ListLevel
+    ValidLevels = (1..9)
+
+    LevelTabs = [
+      220,  720,  1133, 1700, 2267,
+      2834, 3401, 3968, 4535, 5102,
+      5669, 6236, 6803
+    ].freeze
+
+    ResetTabs = [560].concat(LevelTabs[2..-1]).freeze
+
+    attr_reader :level, :marker
+
+    def initialize(template, marker, level)
+      unless marker.kind_of? ListMarker
+        RTFError.fire("Invalid marker #{marker.inspect}")
+      end
+
+      unless ValidLevels.include? level
+        RTFError.fire("Invalid list level: #{level}")
+      end
+
+      @template = template
+      @level    = level
+      @marker   = marker
+    end
+
+    def type
+      @marker.type
+    end
+
+    def reset_tabs
+      ResetTabs
+    end
+
+    def tabs
+      @tabs ||= begin
+        tabs = LevelTabs.dup # Kernel#tap would be prettier here
+
+        (@level - 1).times do
+          # Reverse-engineered while looking at Textedit.app
+          # generated output: they already made sure that it
+          # would look good on every RTF editor :-p
+          #
+          a,  = tabs.shift(3)
+          a,b = a + 720, a + 1220
+          tabs.shift while tabs.first < b
+          tabs.unshift a, b
+        end
+
+        tabs
+      end
+    end
+
+    def id
+      @id ||= @template.id * 10 + level
+    end
+
+    def indent
+      @indent ||= level * 720
+    end
+
+    def to_rtf(indent=0)
+      prefix = indent > 0 ? ' ' * indent : ''
+
+      text  = "#{prefix}{\\listlevel\\levelstartat1"
+
+      # Marker type. The first declaration is for Backward Compatibility (BC).
+      nfc  = @marker.number_type
+      text << "\\levelnfc#{nfc}\\levelnfcn#{nfc}"
+
+      # Justification, currently only left justified (0). First decl for BC.
+      text << '\leveljc0\leveljcn0'
+
+      # Character that follows the level text, currently only TAB.
+      text << '\levelfollow0'
+
+      # BC: Minimum distance from the left & right edges.
+      text << '\levelindent0\levelspace360'
+
+      # Marker name
+      text << "{\\*\\levelmarker #{@marker.name}}"
+
+      # Marker text format
+      text << "{\\leveltext\\leveltemplateid#{id}#{@marker.template_format};}"
+      text << '{\levelnumbers;}'
+
+      # The actual spacing
+      text << "\\fi-360\\li#{self.indent}\\lin#{self.indent}}\n"
+    end
+
+  end
+end