taskjuggler 0.0.2 → 0.0.3

data/lib/ProjectFileParser.rb

@@ -14,6 +14,8 @@ require 'TextParser'
 require 'TextScanner'
 require 'TjpSyntaxRules'
 require 'RichText'
+require 'RTPNavigator'
+require 'RTPReport'
 
 class TaskJuggler
 
@@ -47,9 +49,14 @@ class TaskJuggler
 
     # Call this function with the master file to start processing a TJP file or
     # a set of TJP files.
-    def open(masterFile)
+    def open(file, master)
       begin
-        @scanner = TextScanner.new(masterFile, @messageHandler)
+        @scanner = TextScanner.new(file, @messageHandler)
+        # We need the TextScanner object for error reporting.
+        if master && file != '.' && file[-4, 4] != '.tjp'
+          error('illegal_extension', "Project file name must end with " +
+                '\'.tjp\' extension')
+        end
         @scanner.open
       rescue StandardError
         error('file_open', $!.message)
@@ -168,7 +175,7 @@ class TaskJuggler
       # Register the new Attribute type with the Property set it should belong
       # to.
       @propertySet.addAttributeType(AttributeDefinition.new(
-        @val[1], @val[2], type, inherit, scenarioSpecific, default, true))
+        @val[1], @val[2], type, inherit, false, scenarioSpecific, default, true))
 
       # Add the new user-defined attribute as reportable attribute to the parser
       # rule.
@@ -188,20 +195,41 @@ class TaskJuggler
     # actual input file. So we have to map the error location in the RichText
     # input stream back to the position in the project file.
     def newRichText(text)
+      sfi = sourceFileInfo
       begin
         rText = RichText.new(text)
+        rText.registerProtocol(RTPNavigator.new(@project, sfi))
+        rText.registerProtocol(RTPReport.new(@project, sfi))
       rescue RichTextException => msg
-        sfi = sourceFileInfo
-        correctSFI = SourceFileInfo.new(sfi.fileName,
-                                        sfi.lineNo + msg.lineNo - 1, 0)
+        sfi = SourceFileInfo.new(sfi.fileName, sfi.lineNo + msg.lineNo - 1, 0)
         message = Message.new(msg.id, 'error', msg.text + "\n" + msg.line,
-                              @property, nil, correctSFI)
+                              @property, nil, sfi)
         @messageHandler.send(message)
 
       end
       rText
     end
 
+    # This method is a convenience wrapper around Project.new. It checks if
+    # the report name already exists. It also triggers the attribute
+    # inheritance. +name+ is the name of the report, +type+ is the report
+    # type. +sourceFileInfo+ is a SourceFileInfo of the report definition. The
+    # method returns the newly created Report.
+    def newReport(name, type, sourceFileInfo)
+      if @project.reportByName(name)
+        error('report_redefinition',
+              "A report with the name #{name} has already been defined.")
+      end
+      @property = Report.new(@project, "report#{@reportCounter += 1}",
+                             name, nil)
+      @property.typeSpec = type
+      @property.sourceFileInfo = sourceFileInfo
+      @property.set('formats', [ type ])
+      @property.inheritAttributes
+      @property
+    end
+
+
     # If the @limitResources list is not empty, we have to create a Limits
     # object for each Resource. Otherwise, one Limits object is enough.
     def setLimit(name, value, interval)
@@ -218,12 +246,53 @@ class TaskJuggler
     # syntax tree definition. The *Rule functions may only be used in _rule
     # functions. And only one function call per _rule function is allowed.
 
+    # This function creates a set of rules to describe a list of keywords.
+    # _name_ is the name of the top-level rule and _items_ can be a Hash or
+    # Array. The array just contains the allowed keywords, the Hash contains
+    # keyword/description pairs. The description is used to describe
+    # the keyword in the manual. The syntax supports two special cases. A '*'
+    # means all items in the list and '-' means the list is empty.
+    def allOrNothingListRule(name, items)
+      newRule(name) {
+        # A '*' means all possible items should be in the list.
+        pattern(%w( _* ), lambda {
+          KeywordArray.new([ '*' ])
+        })
+        descr('A shortcut for all items')
+        # A '-' means the list should be empty.
+        pattern([ '_ - ' ], lambda {
+          KeywordArray.new
+        })
+        descr('No items')
+        # Or the list consists of one or more comma separated keywords.
+        pattern([ "!#{name}_AoN_ruleItems" ], lambda {
+          KeywordArray.new(@val)
+        })
+      }
+      # Create the rule for the comma separated list.
+      newRule("#{name}_AoN_ruleItems") {
+        listRule("more#{name}_AoN_ruleItems", "!#{name}_AoN_ruleItem")
+      }
+      # Create the rule for the keywords with their description.
+      newRule("#{name}_AoN_ruleItem") {
+        if items.is_a?(Array)
+          items.each { |keyword| singlePattern('_' + keyword) }
+        else
+          items.each do |keyword, description|
+            singlePattern('_' + keyword)
+            descr(description) if description
+          end
+        end
+      }
+    end
+
     def listRule(name, listItem)
       pattern([ "#{listItem}", "!#{name}" ], lambda {
         [ @val[0] ] + (@val[1].nil? ? [] : @val[1])
       })
-      newRule(name)
-      commaListRule(listItem)
+      newRule(name) {
+        commaListRule(listItem)
+      }
     end
 
     def commaListRule(listItem)
@@ -261,7 +330,7 @@ class TaskJuggler
     def descr(text)
       if @cr.patterns[-1].length != 1 ||
          (@cr.patterns[-1][0][0] != ?_ && @cr.patterns[-1][0][0] != ?$)
-        raise('descr() may only be used for patterns with terminal tokens.')
+        raise 'descr() may only be used for patterns with terminal tokens.'
       end
       arg(0, nil, text)
     end
@@ -291,6 +360,13 @@ class TaskJuggler
     def example(file, tag = nil)
       @cr.setExample(file, tag)
     end
+    # Determine the title of the column with the ID _colId_. The title may be
+    # from the static set or be from a user defined attribute.
+    def columnTitle(colId)
+      TableReport.defaultColumnTitle(colId) ||
+        @project.attributeName(colId)
+    end
+
 
     # To manage certain variables that have file scope throughout a hierachie
     # of nested include files, we use a @fileStack to track those variables.
@@ -298,7 +374,8 @@ class TaskJuggler
     # return from an included file, we need to restore the old values. This
     # function creates or resets the stack.
     def initFileStack
-      @fileStackVariables = %w( taskprefix resourceprefix accountprefix )
+      @fileStackVariables = %w( taskprefix reportprefix
+                                resourceprefix accountprefix )
       stackEntry = {}
       @fileStackVariables.each do |var|
         stackEntry[var] = ''

data/lib/PropertyList.rb

@@ -91,7 +91,8 @@ class TaskJuggler
       end
       if scIdx == -1
         if @propertySet.scenarioSpecific?(criteria)
-          raise TjException.new, "Attribute #{criteria} is scenario specific"
+          raise TjException.new, "Attribute #{criteria} is scenario specific." +
+                "You must specify a scenario id."
         end
       else
         if !@propertySet.scenarioSpecific?(criteria)

data/lib/PropertySet.rb

@@ -101,12 +101,21 @@ class TaskJuggler
       @attributeDefinitions[attrId].scenarioSpecific
     end
 
-    # Return whether the attribute with _attrId_ is scenario specific or not.
-    def inheritable?(attrId)
-      # All hardwired attributes are not inheritable.
+    # Return whether the attribute with _attrId_ is inherited from the global
+    # scope.
+    def inheritedFromProject?(attrId)
+      # All hardwired attributes are not inherited.
+      return false if @attributeDefinitions[attrId].nil?
+
+      @attributeDefinitions[attrId].inheritedFromProject
+    end
+
+    # Return whether the attribute with _attrId_ is inherited from parent.
+    def inheritedFromParent?(attrId)
+      # All hardwired attributes are not inherited.
       return false if @attributeDefinitions[attrId].nil?
 
-      @attributeDefinitions[attrId].inheritable
+      @attributeDefinitions[attrId].inheritedFromParent
     end
 
     # Return whether or not the attribute was user defined.

data/lib/PropertyTreeNode.rb

@@ -40,6 +40,12 @@ class TaskJuggler
     # specified by a hierachical _id_ (e. g. 'father.son').
     def initialize(propertySet, id, name, parent)
       @propertySet = propertySet
+      # If _id_ is still nil, we generate a unique id.
+      unless id
+        tag = self.class.to_s.gsub(/TaskJuggler::/, '')
+        id = '_' + tag + '_' + (propertySet.items + 1).to_s
+        id = parent.id + '.' + id if !@propertySet.flatNamespace && parent
+      end
       if !@propertySet.flatNamespace && id.include?('.')
         parentId = id[0..(id.rindex('.') - 1)]
         # Set parent to the parent property if it's still nil.
@@ -73,13 +79,19 @@ class TaskJuggler
 
       @attributes = Hash.new
       @scenarioAttributes = Array.new(@project.scenarioCount)
-      @project.scenarioCount.times do |i|
-        @scenarioAttributes[i] = Hash.new
-      end
+      @scenarioAttributes.collect! { |sca| sca = Hash.new }
+
       # Scenario specific data
       @data = nil
     end
 
+    # We only use deep_clone for attributes, never for properties. Since
+    # attributes may reference properties these references should remain
+    # references.
+    def deep_clone
+      self
+    end
+
     # Return the index of the child _node_.
     def levelSeqNo(node)
       @children.index(node) + 1
@@ -87,12 +99,9 @@ class TaskJuggler
 
     # Inherit values for the attributes from the parent node or the Project.
     def inheritAttributes
-      # These attributes are being inherited from the Project.
-      whitelist = %w( limits priority projectid rate vacation workinghours )
-
       # Inherit non-scenario-specific values
       @propertySet.eachAttributeDefinition do |attrDef|
-        next if attrDef.scenarioSpecific || !attrDef.inheritable
+        next if attrDef.scenarioSpecific || !attrDef.inheritedFromParent
 
         aId = attrDef.id
         if parent
@@ -102,7 +111,7 @@ class TaskJuggler
           end
         else
           # Inherit selected values from project if top-level property
-          if whitelist.index(aId)
+          if attrDef.inheritedFromProject
             if @project[aId]
               @attributes[aId].inherit(@project[aId])
             end
@@ -112,7 +121,7 @@ class TaskJuggler
 
       # Inherit scenario-specific values
       @propertySet.eachAttributeDefinition do |attrDef|
-        next if !attrDef.scenarioSpecific || !attrDef.inheritable
+        next if !attrDef.scenarioSpecific || !attrDef.inheritedFromParent
 
         @project.scenarioCount.times do |scenarioIdx|
           if parent
@@ -124,7 +133,7 @@ class TaskJuggler
             end
           else
             # Inherit selected values from project if top-level property
-            if whitelist.index(attrDef.id)
+            if attrDef.inheritedFromProject
               if @project[attrDef.id] &&
                  @scenarioAttributes[scenarioIdx][attrDef.id]
                 @scenarioAttributes[scenarioIdx][attrDef.id].inherit(
@@ -156,8 +165,8 @@ class TaskJuggler
               inherited(attrDef.id, parentScenarioIdx)) &&
              !(provided(attrDef.id, scenarioIdx) ||
                inherited(attrDef.id, scenarioIdx))
-            @scenarioAttributes[scenarioIdx][attrDef.id].inherit(
-                @scenarioAttributes[parentScenarioIdx][attrDef.id].get)
+            @scenarioAttributes[scenarioIdx][attrDef.id] =
+              @scenarioAttributes[parentScenarioIdx][attrDef.id].deep_clone
           end
         end
       end
@@ -321,7 +330,16 @@ class TaskJuggler
     # _scenarioIdx_.
     def getAttr(attributeId, scenarioIdx = nil)
       if scenarioIdx.nil?
-        @attributes[attributeId]
+        case attributeId
+        when 'id'
+          @id
+        when 'name'
+          @name
+        when 'seqno'
+          @sequenceNo
+        else
+          @attributes[attributeId]
+        end
       else
         @scenarioAttributes[scenarioIdx][attributeId]
       end
@@ -410,12 +428,13 @@ class TaskJuggler
       end
       res += '  Children: ' + children + "\n"  unless children.empty?
       @attributes.sort.each do |key, attr|
-        if attr.get != @propertySet.defaultValue(key)
+        #if attr.get != @propertySet.defaultValue(key)
           res += indent("  #{key}: ", attr.to_s)
-        end
+        #end
       end
       unless @scenarioAttributes.empty?
         project.scenarioCount.times do |sc|
+          break if @scenarioAttributes[sc].nil?
           headerShown = false
           @scenarioAttributes[sc].sort.each do |key, attr|
             if attr.get != @propertySet.defaultValue(key)

data/lib/Query.rb

@@ -73,7 +73,8 @@ class TaskJuggler
         end
         # Same for the scope property.
         if !@scopeProperty.nil? && !@scopePropertyId.nil?
-          @scopeProperty = resolvePropertyId(@scopePropertyType, @scopePropertyId)
+          @scopeProperty = resolvePropertyId(@scopePropertyType,
+                                             @scopePropertyId)
         end
         # Make sure the have a reference to the project.
         @project = @property.project unless @project

data/lib/RTPNavigator.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = RTPNavigator.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+#
+# 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 'RichTextProtocolHandler'
+require 'XMLElement'
+require 'reports/Navigator'
+
+class TaskJuggler
+
+  # This class is a specialized RichTextProtocolHandler that generates a
+  # navigation bar for all reports that match the specified LogicalExpression.
+  # It currently only supports HTML.
+  class RTPNavigator < RichTextProtocolHandler
+
+    def initialize(project, sourceFileInfo)
+      super(project, 'navigator', sourceFileInfo)
+    end
+
+    # Not supported for this protocol
+    def to_s(args)
+      ''
+    end
+
+    # Return a XMLElement tree that represents the navigator in HTML code.
+    def to_html(args)
+      if args.nil? || (id = args['id']).nil?
+        error('rtp_nav_id_missing',
+              "Argument 'id' missing to specify the navigator to be used.")
+      end
+      unless (navBar = @project['navigators'][id])
+        error('rtp_nav_unknown_id', "Unknown navigator #{id}")
+      end
+      navBar.to_html
+    end
+
+    # Not supported for this protocol.
+    def to_tagged(args)
+      nil
+    end
+
+  end
+
+end
+

data/lib/RTPReport.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = RTPReport.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+#
+# 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 'RichTextProtocolHandler'
+require 'XMLElement'
+
+class TaskJuggler
+
+  # This class is a specialized RichTextProtocolHandler that includes a
+  # report into the RichText output for supported formats.
+  class RTPReport < RichTextProtocolHandler
+
+    def initialize(project, sourceFileInfo)
+      super(project, 'report', sourceFileInfo)
+    end
+
+    # Not supported for this protocol
+    def to_s(args)
+      ''
+    end
+
+    # Return a HTML tree for the report.
+    def to_html(args)
+      if args.nil? || (id = args['id']).nil?
+        error('rtp_report_id',
+              "Argument 'id' missing to specify the report to be used.")
+      end
+      unless (report = @project.report(id))
+        error('rtp_report_unknown_id', "Unknown report #{id}")
+      end
+
+      # Save the old report context record
+      oldReportContext = @project.reportContext
+      # Create a new context for the report.
+      @project.reportContext = ReportContext.new(@project, report)
+      # Generate the report with the new context
+      report.generate
+      html = report.to_html
+      # Restore the global report context record again.
+      @project.reportContext = oldReportContext
+
+      html
+    end
+
+    # Not supported for this protocol.
+    def to_tagged(args)
+      nil
+    end
+
+  end
+
+end
+

data/lib/RealFormat.rb

@@ -16,20 +16,33 @@ class TaskJuggler
   # rules. These rules determine how negative values are represented, how the
   # fractional part is shown and how to structure the mantissa. The result is
   # always a String.
+  #
+  # The class uses the following parameters to control the formating.
+  # signPrefix: Prefix used for negative numbers. (String)
+  # signSuffix: Suffix used for negative numbers. (String)
+  # thousandsSeparator: Separator used after 3 integer digits. (String)
+  # fractionSeparator: Separator used between the inter part and the
+  #                    fractional part. (String)
+  # fractionDigits: Number of fractional digits to show. (Fixnum)
   class RealFormat
 
     # Create a new RealFormat object and define the formating rules.
     def initialize(args)
-      # Prefix used for negative numbers. (String)
-      @signPrefix = args[0]
-      # Suffix used for negative numbers. (String)
-      @signSuffix = args[1]
-      # Separator used after 3 integer digits. (String)
-      @thousandsSeparator = args[2]
-      # Separator used between the inter part and the fractional part. (String)
-      @fractionSeparator = args[3]
-      # Number of fractional digits to show. (Fixnum)
-      @fractionDigits = args[4]
+      iVars = %w( @signPrefix @signSuffix @thousandsSeparator
+                  @fractionSeparator @fractionDigits )
+      if args.is_a?(RealFormat)
+        # The argument is another RealFormat object.
+        iVars.each do |iVar|
+          instance_variable_set(iVar, args.instance_variable_get(iVar))
+        end
+      elsif args.length == 5
+        # The argument is a list of values.
+        0.upto(4) do |i|
+          instance_variable_set(iVars[i], args[i])
+        end
+      else
+        raise RuntimeError, "Bad number of parameters #{args.length}"
+      end
     end
 
     # Converts the Float _number_ into a String representation according to the
@@ -67,6 +80,11 @@ class TaskJuggler
       out
     end
 
+    def to_s
+      [ @signPrefix, @signSuffix, @thousandsSeparator, @fractionSeparator,
+        @fractionDigits ].collect { |s| "\"#{s}\"" }.join(' ')
+    end
+
   end
 
 end

data/lib/RichTextElement.rb

@@ -162,6 +162,7 @@ class TaskJuggler
         post = "\n\n"
       when :ref
       when :href
+      when :blockfunc
       when :italic
       when :bold
       when :code
@@ -243,6 +244,14 @@ class TaskJuggler
       when :href
         pre = "<a href=\"#{@data}\" target=\"_blank\">"
         post = '</a>'
+      when :blockfunc
+        pre = "<blockfunc:#{@data[0]}"
+        if @data[1]
+          @data[1].keys.sort.each do |key|
+            pre += " #{key}=\"#{@data[1][key]}\""
+          end
+        end
+        post = "/>"
       when :italic
         pre = '<i>'
         post = '</i>'
@@ -273,6 +282,7 @@ class TaskJuggler
 
     # Convert the intermediate representation into HTML elements.
     def to_html
+      noChilds = false
       html =
       case @category
       when :richtext
@@ -296,10 +306,12 @@ class TaskJuggler
         end
         el
       when :hline
+        noChilds = true
         XMLElement.new('hr')
       when :paragraph
         XMLElement.new('p')
       when :pre
+        noChilds = true
         pre = XMLElement.new('pre')
         pre << XMLText.new(@children[0])
       when :bulletlist1
@@ -327,19 +339,12 @@ class TaskJuggler
       when :numberitem3
         XMLElement.new('li')
       when :ref
-        if @data.include?(':')
-          protocol, path = @data.split(':')
-          raise TjException.new, "Reference protocol empty." if protocol.empty?
-          if path.empty?
-            raise TjException.new, "Reference path may not be empty."
-          end
-          args = children_to_s.split(' ')
-          return @richText.protocolHandler(protocol).to_html(path, args)
-        else
-          XMLElement.new('a', 'href' => "#{@data}.html")
-        end
+        XMLElement.new('a', 'href' => "#{@data}.html")
       when :href
         XMLElement.new('a', 'href' => @data, 'target' => '_blank')
+      when :blockfunc
+        noChilds = true
+        @richText.protocolHandler(@data[0]).to_html(@data[1])
       when :italic
         XMLElement.new('i')
       when :bold
@@ -347,13 +352,14 @@ class TaskJuggler
       when :code
         XMLElement.new('code')
       when :text
+        noChilds = true
         XMLText.new(@children[0])
       else
         raise TjException.new, "Unknown RichTextElement category #{@category}"
       end
 
       # Some elements never have leaves.
-      return html if [ :text, :pre, :hline ].include?(@category)
+      return html if noChilds
 
       @children.each do |el_i|
         html << el_i.to_html

data/lib/RichTextParser.rb

@@ -33,6 +33,7 @@ class TaskJuggler
       # These are the tokens that can be returned by the RichTextScanner.
       @variables = %w( LINEBREAK SPACE WORD BOLD ITALIC CODE BOLDITALIC PRE
                        HREF HREFEND REF REFEND HLINE
+                       BLOCKFUNCSTART BLOCKFUNCEND ID STRING
                        TITLE1 TITLE2 TITLE3 TITLE1END TITLE2END TITLE3END
                        BULLET1 BULLET2 BULLET3 NUMBER1 NUMBER2 NUMBER3 )
       # Load the rule set into the parser.

data/lib/RichTextProtocolExample.rb

@@ -22,27 +22,24 @@ class TaskJuggler
   class RichTextProtocolExample < RichTextProtocolHandler
 
     def initialize
-      super('example')
+      super(nil, 'example')
     end
 
     # Not supported for this protocol
-    def to_s(path, args)
+    def to_s(args)
       ''
     end
 
     # Return a XMLElement tree that represents the example file as HTML code.
-    def to_html(path, args)
-      if args.length > 1
-        raise "The example protocol may only take upto one argument."
-      elsif args.length == 1
-        tag = args[0]
-      else
-        tag = nil
+    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/#{path}.tjp"
+                 "TestSuite/Syntax/Correct/#{file}.tjp"
       example.open(fileName)
       frame = XMLElement.new('div', 'class' => 'codeframe')
       frame << (pre = XMLElement.new('pre', 'class' => 'code'))
@@ -55,7 +52,7 @@ class TaskJuggler
     end
 
     # Not supported for this protocol.
-    def to_tagged(path, args)
+    def to_tagged(args)
       nil
     end
 

data/lib/RichTextProtocolHandler.rb

@@ -25,8 +25,18 @@ class TaskJuggler
 
     attr_reader :protocol
 
-    def initialize(protocol)
+    def initialize(project, protocol, sourceFileInfo = nil)
+      @project = project
       @protocol = protocol
+      @sourceFileInfo = sourceFileInfo
+    end
+
+    def error(id, text)
+      message = Message.new(id, 'error', text, nil, nil, @sourceFileInfo)
+      @project.sendMessage(message)
+
+      # An empty strings signals an already reported error
+      raise TjException.new, ''
     end
 
   end