#!/usr/bin/env ruby -w
# encoding: UTF-8
#
# = FunctionExample.rb -- The TaskJuggler III Project Management Software
#
# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
#               by Chris Schlaeger <chris@linux.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
#

require 'taskjuggler/RichText/FunctionHandler'
require 'taskjuggler/TjpExample'
require 'taskjuggler/XMLElement'

class TaskJuggler

  # This class is a specialized RichTextFunctionHandler that turns references to
  # TJP example code in the test/TestSuite/Syntax/Correct directory into
  # embedded example code. It currently only supports HTML.
  class RichTextFunctionExample < RichTextFunctionHandler

    def initialize
      super('example')
      @blockFunction = true
    end

    # Not supported for this function
    def to_s(args)
      ''
    end

    # Return a XMLElement tree that represents the example file as HTML code.
    def to_html(args)
      unless (file = args['file'])
        raise "'file' argument missing"
      end
      tag = args['tag']

      example = TjpExample.new
      fileName = AppConfig.dataDirs('test')[0] +
                 "TestSuite/Syntax/Correct/#{file}.tjp"
      example.open(fileName)
      frame = XMLElement.new('div', 'class' => 'codeframe')
      frame << (pre = XMLElement.new('pre', 'class' => 'code'))
      unless (text = example.to_s(tag))
        raise "There is no tag '#{tag}' in file " +
            "#{fileName}."
      end
      pre << XMLText.new(text)
      frame
    end

    # Not supported for this function.
    def to_tagged(args)
      nil
    end

  end

end