-
Notifications
You must be signed in to change notification settings - Fork 168
/
TjpSyntaxRules.rb
7650 lines (6707 loc) · 249 KB
/
TjpSyntaxRules.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env ruby -w
# encoding: UTF-8
#
# = TjpSyntaxRules.rb -- The TaskJuggler III Project Management Software
#
# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
# 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.
#
class TaskJuggler
# This module contains the rule definition for the TJP syntax. Every rule is
# put in a function who's name must start with rule_. The functions are not
# necessary but make the file more readable and receptable to syntax folding.
module TjpSyntaxRules
def rule_absoluteTaskId
pattern(%w( !taskIdUnverifd ), lambda {
id = (@taskprefix.empty? ? '' : @taskprefix + '.') + @val[0]
if (task = @project.task(id)).nil?
error('unknown_abs_task', "Unknown task #{id}", @sourceFileInfo[0])
end
task
})
end
def rule_account
pattern(%w( !accountHeader !accountBody ), lambda {
@property = @property.parent
})
doc('account', <<'EOT'
Declares an account. Accounts can be used to calculate costs of tasks or the
whole project. Account declaration may be nested, but only leaf accounts may
be used to track turnover. When the cost of a task is split over multiple
accounts they all must have the same top-level group account. Top-level
accounts can be used for profit/loss calculations. The sub-account structure
of a top-level account should be organized accordingly.
Accounts have a global name space. All IDs must be unique within the accounts of the project.
EOT
)
example('Account', '1')
end
def rule_accountAttributes
repeatable
optional
pattern(%w( !account))
pattern(%w( !accountScenarioAttributes ))
pattern(%w( !scenarioIdCol !accountScenarioAttributes ), lambda {
@scenarioIdx = 0
})
# Other attributes will be added automatically.
end
def rule_accountBody
optionsRule('accountAttributes')
end
def rule_accountCredit
pattern(%w( !valDate $STRING !number ), lambda {
AccountCredit.new(@val[0], @val[1], @val[2])
})
arg(1, 'description', 'Short description of the transaction')
arg(2, 'amount', 'Amount to be booked.')
end
def rule_accountCredits
listRule('moreAccountCredits', '!accountCredit')
end
def rule_accountHeader
pattern(%w( _account !optionalID $STRING ), lambda {
if @property.nil? && !@accountprefix.empty?
@property = @project.accout(@accountprefix)
end
if @val[1] && @project.account(@val[1])
error('account_exists', "Account #{@val[1]} has already been defined.",
@sourceFileInfo[1], @property)
end
@property = Account.new(@project, @val[1], @val[2], @property)
@property.sourceFileInfo = @sourceFileInfo[0]
@property.inheritAttributes
@scenarioIdx = 0
})
arg(2, 'name', 'A name or short description of the account')
end
def rule_accountId
pattern(%w( $ID ), lambda {
id = @val[0]
id = @accountprefix + '.' + id unless @accountprefix.empty?
# In case we have a nested supplement, we need to prepend the parent ID.
id = @property.fullId + '.' + id if @property && @property.is_a?(Account)
if (account = @project.account(id)).nil?
error('unknown_account', "Unknown account #{id}", @sourceFileInfo[0])
end
account
})
end
def rule_accountReport
pattern(%w( !accountReportHeader !reportBody ), lambda {
@property = @property.parent
})
level(:beta)
doc('accountreport', <<'EOT'
The report lists accounts and their respective values in a table. The report
can operate in two modes:
# Balance mode: If a [[balance]] has been set, the report will include the
defined cost and revenue accounts as well as all their sub accounts. To reduce
the list of included accounts, you can use the [[hideaccount]],
[[rollupaccount]] or [[accountroot]] attributes. The order of the task can
be controlled with [[sortaccounts]]. If the first sorting criteria is tree
sorting, the parent accounts will always be included to form the tree.
Tree sorting is the default. You need to change it if you do not want certain
parent accounts to be included in the report. Additionally, it will contain a line at the end that lists the balance (revenue - cost).
# Normal mode: All reports are listed in the order and completeness as defined
by the other report attributes. No balance line will be included.
EOT
)
example('AccountReport')
end
def rule_accountReportHeader
pattern(%w( _accountreport !optionalID !reportName ), lambda {
newReport(@val[1], @val[2], :accountreport, @sourceFileInfo[0]) do
unless @property.modified?('columns')
# Set the default columns for this report.
%w( bsi name monthly ).each do |col|
@property.get('columns') <<
TableColumnDefinition.new(col, columnTitle(col))
end
end
# Show all accounts, sorted by tree, seqno-up.
unless @property.modified?('hideAccount')
@property.set('hideAccount',
LogicalExpression.new(LogicalOperation.new(0)))
end
unless @property.modified?('sortAccounts')
@property.set('sortAccounts',
[ [ 'tree', true, -1 ],
[ 'seqno', true, -1 ] ])
end
end
})
end
def rule_accountScenarioAttributes
pattern(%w( _aggregate !aggregate ), lambda {
@property.set('aggregate', @val[1])
})
doc('aggregate', <<'EOT'
Specifies whether the account is used to track task or resource specific
amounts. The default is to track tasks.
EOT
)
example('AccountReport')
pattern(%w( _credits !accountCredits ), lambda {
@property['credits', @scenarioIdx] += @val[1]
})
doc('credits', <<'EOT'
Book the specified amounts to the account at the specified date. The
desciptions are just used for documentary purposes.
EOT
)
example('Account', '1')
pattern(%w( !flags ))
doc('flags.account', <<'EOT'
Attach a set of flags. The flags can be used in logical expressions to filter
properties from the reports.
EOT
)
# Other attributes will be added automatically.
end
def rule_aggregate
pattern(%w( _resources ), lambda {
:resources
})
descr('Aggregate resources')
pattern(%w( _tasks ), lambda {
:tasks
})
descr('Aggregate tasks')
end
def rule_alertLevel
pattern(%w( $ID ), lambda {
level = @project['alertLevels'].indexById(@val[0])
unless level
levels = @project['alertLevels'].map { |l| l.id }
error('bad_alert', "Unknown alert level #{@val[0]}. Must be " +
"one of #{levels.join(', ')}", @sourceFileInfo[0])
end
level
})
arg(0, 'alert level', <<'EOT'
By default supported values are ''''green'''', ''''yellow'''' and ''''red''''.
The default value is ''''green''''. You can define your own levels with
[[alertlevels]].
EOT
)
end
def rule_alertLevelDefinition
pattern(%w( $ID $STRING !color ), lambda {
[ @val[0], @val[1], @val[2] ]
})
arg(0, 'ID', "A unique ID for the alert level")
arg(1, 'color name', 'A unique name of the alert level color')
end
def rule_alertLevelDefinitions
listRule('moreAlertLevelDefinitions', '!alertLevelDefinition')
end
def rule_allocate
pattern(%w( _allocate !allocations ), lambda {
checkContainer('allocate')
@property['allocate', @scenarioIdx] += @val[1]
})
doc('allocate', <<'EOT'
Specify which resources should be allocated to the task. The
attributes provide numerous ways to control which resource is used and when
exactly it will be assigned to the task. Shifts and limits can be used to
restrict the allocation to certain time intervals or to limit them to a
certain maximum per time period. The purge statement can be used to remove
inherited allocations or flags.
For effort-based tasks the task duration is clipped to only extend from the
begining of the first allocation to the end of the last allocation. This is
done to optimize for an overall minimum project duration as dependent tasks
can potentially use the unallocated, clipped slots.
EOT
)
example('Allocate-1', '1')
end
def rule_allocation
pattern(%w( !allocationHeader !allocationBody ), lambda {
@val[0]
})
end
def rule_allocationAttributes
optional
repeatable
pattern(%w( _alternative !resourceId !moreAlternatives ), lambda {
([ @val[1] ] + (@val[2] ? @val[2] : [])).each do |candidate|
@allocate.addCandidate(candidate)
end
})
doc('alternative', <<'EOT'
Specify which resources should be allocated to the task. The optional
attributes provide numerous ways to control which resource is used and when
exactly it will be assigned to the task. Shifts and limits can be used to
restrict the allocation to certain time intervals or to limit them to a
certain maximum per time period.
EOT
)
example('Alternative', '1')
pattern(%w( !limits ), lambda {
limits = @property['limits', @scenarioIdx] = @val[0]
@allocate.candidates.each do |resource|
limits.limits.each do |l|
l.resource = resource if resource.leaf?
end
end
})
level(:removed)
doc('limits.allocate', '')
pattern(%w( _select !allocationSelectionMode ), lambda {
@allocate.setSelectionMode(@val[1])
})
doc('select', <<'EOT'
The select functions controls which resource is picked from an allocation and
it's alternatives. The selection is re-evaluated each time the resource used
in the previous time slot becomes unavailable.
Even for non-persistent allocations a change in the resource selection only
happens if the resource used in the previous (or next for ASAP tasks) time
slot has become unavailable.
EOT
)
pattern(%w( _persistent ), lambda {
@allocate.persistent = true
})
doc('persistent', <<'EOT'
Specifies that once a resource is picked from the list of alternatives this
resource is used for the whole task. This is useful when several alternative
resources have been specified. Normally the selected resource can change after
each break. A break is an interval of at least one timeslot where no resources
were available.
EOT
)
pattern(%w( _mandatory ), lambda {
@allocate.mandatory = true
})
doc('mandatory', <<'EOT'
Makes a resource allocation mandatory. This means, that for each time slot
only then resources are allocated when all mandatory resources are available.
So either all mandatory resources can be allocated for the time slot, or no
resource will be allocated.
EOT
)
pattern(%w( !allocateShiftAssignments !shiftAssignment ), lambda {
begin
@allocate.shifts = @shiftAssignments
rescue AttributeOverwrite
# Multiple shift assignments are a common idiom, so don't warn about
# them.
end
@shiftAssignments = nil
})
level(:deprecated)
also('shifts.allocate')
doc('shift.allocate', <<'EOT'
Limits the allocations of resources during the specified interval to the
specified shift. Multiple shifts can be defined, but shift intervals may not
overlap. Allocation shifts are an additional restriction to the
[[shifts.task|task shifts]] and [[shifts.resource|resource shifts]] or
[[workinghours.resource|resource working hours]]. Allocations will only be
made for time slots that are specified as duty time in all relevant shifts.
The restriction to the shift is only active during the specified time
interval. Outside of this interval, no restrictions apply.
EOT
)
pattern(%w( !allocateShiftsAssignments !shiftAssignments ), lambda {
begin
@allocate.shifts = @shiftAssignments
rescue AttributeOverwrite
# Multiple shift assignments are a common idiom, so don't warn about
# them.
end
@shiftAssignments = nil
})
doc('shifts.allocate', <<'EOT'
Limits the allocations of resources during the specified interval to the
specified shift. Multiple shifts can be defined, but shift intervals may not
overlap. Allocation shifts are an additional restriction to the
[[shifts.task|task shifts]] and [[shifts.resource|resource shifts]] or
[[workinghours.resource|resource working hours]]. Allocations will only be
made for time slots that are specified as duty time in all relevant shifts.
The restriction to the shift is only active during the specified time
interval. Outside of this interval, no restrictions apply.
EOT
)
end
def rule_allocationBody
optionsRule('allocationAttributes')
end
def rule_allocationHeader
pattern(%w( !resourceId ), lambda {
@allocate = Allocation.new([ @val[0] ])
})
end
def rule_allocations
listRule('moreAllocations', '!allocation')
end
def rule_allocationSelectionMode
singlePattern('_maxloaded')
descr('Pick the available resource that has been used the most so far.')
singlePattern('_minloaded')
descr('Pick the available resource that has been used the least so far.')
singlePattern('_minallocated')
descr(<<'EOT'
Pick the resource that has the smallest allocation factor. The
allocation factor is calculated from the various allocations of the resource
across the tasks. This is the default setting.)
EOT
)
singlePattern('_order')
descr('Pick the first available resource from the list.')
singlePattern('_random')
descr('Pick a random resource from the list.')
end
def rule_allocateShiftAssignments
pattern(%w( _shift ), lambda {
@shiftAssignments = @allocate.shifts
})
end
def rule_allocateShiftsAssignments
pattern(%w( _shifts ), lambda {
@shiftAssignments = @allocate.shifts
})
end
def rule_allOrNone
pattern(%w( _all ), lambda {
1
})
pattern(%w( _none ), lambda {
0
})
end
def rule_argument
singlePattern('$ABSOLUTE_ID')
singlePattern('!date')
singlePattern('$ID')
singlePattern('$INTEGER')
singlePattern('$FLOAT')
end
def rule_argumentList
optional
pattern(%w( _( !argumentListBody _) ), lambda {
@val[1].nil? ? [] : @val[1]
})
end
def rule_argumentListBody
optional
pattern(%w( !argument !moreArguments ), lambda {
[ @val[0] ] + (@val[1].nil? ? [] : @val[1])
})
end
def rule_author
pattern(%w( _author !resourceId ), lambda {
@journalEntry.author = @val[1]
})
doc('author', <<'EOT'
This attribute can be used to capture the authorship or source of the
information.
EOT
)
end
def rule_balance
pattern(%w( _balance !balanceAccounts ), lambda {
@val[1]
})
doc('balance', <<'EOT'
During report generation, TaskJuggler can consider some accounts to be revenue accounts, while other can be considered cost accounts. By using the balance attribute, two top-level accounts can be designated for a profit-loss-analysis. This analysis includes all sub accounts of these two top-level accounts.
To clear a previously set balance, just use a ''''-''''.
EOT
)
example('AccountReport')
end
def rule_balanceAccounts
pattern(%w( !accountId !accountId ), lambda {
if @val[0].parent
error('cost_acct_no_top',
"The cost account #{@val[0].fullId} is not a top-level account.",
@sourceFileInfo[0])
end
if @val[1].parent
error('rev_acct_no_top',
"The revenue account #{@val[1].fullId} is not a top-level " +
"account.", @sourceFileInfo[1])
end
if @val[0] == @val[1]
error('cost_rev_same',
'The cost and revenue accounts may not be the same.',
@sourceFileInfo[0])
end
[ @val[0], @val[1] ]
})
arg(0, 'cost account', <<'EOT'
The top-level account that is used for all cost related charges.
EOT
)
arg(2, 'revenue account', <<'EOT'
The top-level account that is used for all revenue related charges.
EOT
)
pattern([ '_-' ], lambda {
[ nil, nil ]
})
end
def rule_bookingAttributes
optional
repeatable
pattern(%w( _overtime $INTEGER ), lambda {
if @val[1] < 0 || @val[1] > 2
error('overtime_range',
"Overtime value #{@val[1]} out of range (0 - 2).",
@sourceFileInfo[1], @property)
end
@booking.overtime = @val[1]
})
doc('overtime.booking', <<'EOT'
This attribute enables bookings during off-hours and leaves. It implicitly
sets the [[sloppy.booking|sloppy]] attribute accordingly.
EOT
)
arg(1, 'value', <<'EOT'
* '''0''': You can only book available working time. (Default)
* '''1''': You can book off-hours as well.
* '''2''': You can book working time, off-hours and vacation time.
EOT
)
pattern(%w( _sloppy $INTEGER ), lambda {
if @val[1] < 0 || @val[1] > 2
error('sloppy_range',
"Sloppyness value #{@val[1]} out of range (0 - 2).",
@sourceFileInfo[1], @property)
end
@booking.sloppy = @val[1]
})
doc('sloppy.booking', <<'EOT'
Controls how strict TaskJuggler checks booking intervals for conflicts with
working periods and leaves. This attribute only affects the check for
conflicts. No assignments will be made unless the [[overtime.booking|
overtime]] attribute is set accordingly.
EOT
)
arg(1, 'sloppyness', <<'EOT'
* '''0''': Period may not contain any off-duty hours, vacation or other task
assignments. (default)
* '''1''': Period may contain off-duty hours, but no vacation time or other
task assignments.
* '''2''': Period may contain off-duty hours and vacation time, but no other
task assignments.
EOT
)
end
def rule_bookingBody
optionsRule('bookingAttributes')
end
def rule_calendarDuration
pattern(%w( !number !durationUnit ), lambda {
convFactors = [ 60.0, # minutes
60.0 * 60, # hours
60.0 * 60 * 24, # days
60.0 * 60 * 24 * 7, # weeks
60.0 * 60 * 24 * 30.4167, # months
60.0 * 60 * 24 * 365 # years
]
((@val[0] * convFactors[@val[1]]) / @project['scheduleGranularity']).to_i
})
arg(0, 'value', 'A floating point or integer number')
end
def rule_chargeset
pattern(%w( _chargeset !chargeSetItem !moreChargeSetItems ), lambda {
checkContainer('chargeset')
items = [ @val[1] ]
items += @val[2] if @val[2]
chargeSet = ChargeSet.new
begin
items.each do |item|
chargeSet.addAccount(item[0], item[1])
end
chargeSet.complete
rescue TjException
error('chargeset', $!.message, @sourceFileInfo[0], @property)
end
masterAccounts = []
@property['chargeset', @scenarioIdx].each do |set|
masterAccounts << set.master
end
if masterAccounts.include?(chargeSet.master)
error('chargeset_master',
"All charge sets for this property must have different " +
"top-level accounts.", @sourceFileInfo[0], @property)
end
@property['chargeset', @scenarioIdx] =
@property['chargeset', @scenarioIdx] + [ chargeSet ]
})
doc('chargeset', <<'EOT'
A chargeset defines how the turnover associated with the property will be
charged to one or more accounts. A property may have any number of charge sets,
but each chargeset must deal with a different top-level account. A charge set
consists of one or more accounts. Each account must be a leaf account. The
account ID may be followed by a percentage value that determines the share for
this account. The total percentage of all accounts must be exactly 100%. If
some accounts don't have a percentage specification, the remainder to 100% is
distributed evenly between them.
EOT
)
end
def rule_chargeMode
singlePattern('_onstart')
descr('Charge the amount on starting the task.')
singlePattern('_onend')
descr('Charge the amount on finishing the task.')
singlePattern('_perhour')
descr('Charge the amount for every hour the task lasts.')
singlePattern('_perday')
descr('Charge the amount for every day the task lasts.')
singlePattern('_perweek')
descr('Charge the amount for every week the task lasts.')
end
def rule_chargeSetItem
pattern(%w( !accountId !optionalPercent ), lambda {
if @property.is_a?(Task)
aggregate = :tasks
elsif @property.is_a?(Resource)
aggregate = :resources
else
raise "Unknown property type #{@property.class}"
end
if @val[0].get('aggregate') != aggregate
error('account_bad_aggregate',
"The account #{@val[0].fullId} cannot aggregate amounts " +
"related to #{aggregate}.")
end
[ @val[0], @val[1] ]
})
arg(0, 'account', 'The ID of a previously defined leaf account.')
arg(1, 'share', 'A percentage between 0 and 100%')
end
def rule_chartScale
singlePattern('_hour')
descr('Set chart resolution to 1 hour.')
singlePattern('_day')
descr('Set chart resolution to 1 day.')
singlePattern('_week')
descr('Set chart resolution to 1 week.')
singlePattern('_month')
descr('Set chart resolution to 1 month.')
singlePattern('_quarter')
descr('Set chart resolution to 1 quarter.')
singlePattern('_year')
descr('Set chart resolution to 1 year.')
end
def rule_color
pattern(%w( $STRING ), lambda {
col = @val[0]
unless /#[0-9A-Fa-f]{3}/ =~ col || /#[0-9A-Fa-f]{3}/ =~ col
error('bad_color',
"Color values must be specified as '#RGB' or '#RRGGBB' values",
@sourceFileInfo[0])
end
col
})
arg(0, 'color', <<'EOT'
The RGB color values of the color. The following formats are supported: #RGB
and #RRGGBB. Where R, G, B are hexadecimal values. See
[http://en.wikipedia.org/wiki/Web_colors Wikipedia] for more details.
EOT
)
end
def rule_columnBody
optionsRule('columnOptions')
end
def rule_columnDef
pattern(%w( !columnId !columnBody ), lambda {
@val[0]
})
end
def rule_columnId
pattern(%w( !reportableAttributes ), lambda {
@column = TableColumnDefinition.new(@val[0], columnTitle(@val[0]))
})
doc('columnid', <<'EOT'
This is a comprehensive list of all pre-defined [[columns]]. In addition to
the listed IDs all user defined attributes can be used as column IDs.
EOT
)
end
def rule_columnOptions
optional
repeatable
pattern(%w( _celltext !logicalExpression $STRING ), lambda {
@column.cellText.addPattern(
CellSettingPattern.new(newRichText(@val[2], @sourceFileInfo[2]),
@val[1]))
})
doc('celltext.column', <<'EOT'
Specifies an alternative content that is used for the cells of the column.
Usually such a text contains a query function. Otherwise all cells of the
column will have the same fixed value. The logical expression specifies for
which cells the text should be used. If multiple celltext patterns are
provided for a column, the first matching one is taken for each cell.
EOT
)
arg(2, 'text',
'Alterntive cell text specified as [[Rich_Text_Attributes|Rich Text]]')
pattern(%w( _cellcolor !logicalExpression !color ), lambda {
@column.cellColor.addPattern(
CellSettingPattern.new(@val[2], @val[1]))
})
doc('cellcolor.column', <<'EOT'
Specifies an alternative background color for the cells of this column. The
[[logicalexpression|logical expression]] specifies for which cells the color
should be used. If multiple cellcolor patterns are provided for a column, the
first matching one is used for each cell.
EOT
)
pattern(%w( _end !date ), lambda {
@column.end = @val[1]
})
doc('end.column', <<'EOT'
Normally, columns with calculated values take the specified report period into
account when calculating their values. With this attribute, the user can
specify an end date for the period that should be used when calculating the
values of this column. It does not have an impact on column with time
invariant values.
EOT
)
pattern(%w( _fontcolor !logicalExpression !color ), lambda {
@column.fontColor.addPattern(
CellSettingPattern.new(@val[2], @val[1]))
})
doc('fontcolor.column', <<'EOT'
Specifies an alternative font color for the cells of this column. The
[[logicalexpression|logical expression]] specifies for which cells the color
should be used. If multiple fontcolor patterns are provided for a column, the
first matching one is used for each cell.
EOT
)
pattern(%w( _halign !logicalExpression !hAlignment ), lambda {
@column.hAlign.addPattern(
CellSettingPattern.new(@val[2], @val[1]))
})
doc('halign.column', <<'EOT'
Specifies the horizontal alignment of the cell content. The
[[logicalexpression|logical expression]] specifies for which cells the alignment
setting should be used. If multiple halign patterns are provided for a column,
the first matching one is used for each cell.
EOT
)
pattern(%w( _listitem $STRING ), lambda {
@column.listItem = @val[1]
})
doc('listitem.column', <<'EOT'
Specifies a RichText pattern that is used to generate the text for the list
items. The pattern should contain at least one ''''<nowiki><</nowiki>-query
attribute='XXX'->'''' element that will be replaced with the value of
attribute XXX. For the replacement, the property of the query will be the list
item.
EOT
)
pattern(%w( _listtype !listType ), lambda {
@column.listType = @val[1]
})
also(%w( listitem.column ))
doc('listtype.column', <<'EOT'
Specifies what type of list should be used. This attribute only affects
columns that contain a list of items.
EOT
)
pattern(%w( _period !interval ), lambda {
@column.start = @val[1].start
@column.end = @val[1].end
})
doc('period.column', <<'EOT'
This property is a shortcut for setting the [[start.column|start]] and
[[end.column|end]] property at the same time.
EOT
)
pattern(%w( _scale !chartScale ), lambda {
@column.scale = @val[1]
})
doc('scale.column', <<'EOT'
Specifies the scale that should be used for a chart column. This value is ignored for all other columns.
EOT
)
pattern(%w( _start !date ), lambda {
@column.start = @val[1]
})
doc('start.column', <<'EOT'
Normally, columns with calculated values take the specified report period into
account when calculating their values. With this attribute, the user can
specify a start date for the period that should be used when calculating the
values of this column. It does not have an impact on column with time
invariant values.
EOT
)
pattern(%w( _timeformat1 $STRING ), lambda {
@column.timeformat1 = @val[1]
})
doc('timeformat1', <<'EOT'
Specify an alternative format for the upper header line of calendar or Gantt
chart columns.
EOT
)
arg(1, 'format', 'See [[timeformat]] for details.')
pattern(%w( _timeformat2 $STRING ), lambda {
@column.timeformat2 = @val[1]
})
doc('timeformat2', <<'EOT'
Specify an alternative format for the lower header line of calendar or Gantt
chart columns.
EOT
)
arg(1, 'format', 'See [[timeformat]] for details.')
pattern(%w( _title $STRING ), lambda {
@column.title = @val[1]
})
doc('title.column', <<'EOT'
Specifies an alternative title for a report column.
EOT
)
arg(1, 'text', 'The new column title.')
pattern(%w( _tooltip !logicalExpression $STRING ), lambda {
@column.tooltip.addPattern(
CellSettingPattern.new(newRichText(@val[2], @sourceFileInfo[2]),
@val[1]))
})
doc('tooltip.column', <<'EOT'
Specifies an alternative content for the tooltip. This will replace the
original content of the tooltip that would be available for columns with text
that does not fit the column with. The [[logicalexpression|logical expression]]
specifies for which cells the text should be used. If multiple tooltip
patterns are provided for a column, the first matching one is taken for each
cell.
EOT
)
arg(2, 'text', <<'EOT'
The content of the tooltip. The text is interpreted as [[Rich_Text_Attributes|
Rich Text]].
EOT
)
pattern(%w( _width !number ), lambda {
@column.width = @val[1]
})
doc('width.column', <<'EOT'
Specifies the maximum width of the column in screen pixels. If the content of
the column does not fit into this width, it will be cut off. In some cases a
scrollbar is added or a tooltip window with the complete content is shown when
the mouse is moved over the column. The latter is only supported in
interactive output formats. The resulting column width may be smaller if the
column has a fixed width (e. g. the chart column).
EOT
)
end
def rule_currencyFormat
pattern(%w( _currencyformat $STRING $STRING $STRING $STRING $INTEGER ),
lambda {
RealFormat.new(@val.slice(1, 5))
})
doc('currencyformat',
'These values specify the default format used for all currency ' +
'values.')
example('Currencyformat')
arg(1, 'negativeprefix', 'Prefix for negative numbers')
arg(2, 'negativesuffix', 'Suffix for negative numbers')
arg(3, 'thousandsep', 'Separator used for every 3rd digit')
arg(4, 'fractionsep', 'Separator used to separate the fraction digits')
arg(5, 'fractiondigits', 'Number of fraction digits to show')
end
def rule_date
pattern(%w( !dateCalcedOrNot ), lambda {
resolution = @project.nil? ? Project.maxScheduleGranularity :
@project['scheduleGranularity']
if @val[0] % resolution != 0
error('misaligned_date',
"The date must be aligned to the timing resolution (" +
"#{resolution / 60} min) of the project.",
@sourceFileInfo[0])
end
@val[0]
})
doc('date', <<'EOT'
A DATE is date and time specification similar to the ISO 8601 date format.
Instead of the hard to read ISO notation with a ''''T'''' between the date and
time sections, we simply use the more intuitive and easier to read dash:
''''<nowiki>YYYY-MM-DD[-hh:mm[:ss]][-TIMEZONE]</nowiki>''''. Hour, minutes,
seconds, and the ''''TIMEZONE'''' are optional. If not specified, the values
are set to 0. ''''TIMEZONE'''' must be an offset to GMT or UTC, specified as
''''+HHMM'''' or ''''-HHMM''''. Dates must always be aligned with the
[[timingresolution]].
TaskJuggler also supports simple date calculations. You can add or substract a
given interval from a fixed date.
%{2009-11-01 + 8m}
This will result in an actual date of around 2009-07-01. Keep in mind that due
to the varying lengths of months TaskJuggler cannot add exactly 8 calendar
months. The date calculation functionality makes most sense when used with
macros.
%{${now} - 2w}
This is result in a date 2 weeks earlier than the current (or specified) date.
See [[duration]] for a complete list of supported time intervals. Don't forget
to put at least one space character after the date to prevent TaskJuggler from
interpreting the interval as an hour.
Date attributes may be invalid in some cases. This needs special care in
[[logicalexpression|logical expressions]].
EOT
)
end
def rule_dateCalcedOrNot
singlePattern('$DATE')
pattern(%w( _% _{ $DATE !plusOrMinus !intervalDuration _} ), lambda {
@val[2] + ((@val[3] == '+' ? 1 : -1) * @val[4])
})
end
def rule_declareFlagList
listRule('moreDeclareFlagList', '$ID')
end
def rule_details
pattern(%w( _details $STRING ), lambda {
return if @val[1].empty?
rtTokenSetMore =
[ :LINEBREAK, :SPACE, :WORD, :BOLD, :ITALIC, :CODE, :BOLDITALIC,
:PRE, :HREF, :HREFEND, :REF, :REFEND, :HLINE, :TITLE2, :TITLE3,
:TITLE4, :TITLE2END, :TITLE3END, :TITLE4END,
:BULLET1, :BULLET2, :BULLET3, :BULLET4, :NUMBER1, :NUMBER2, :NUMBER3,
:NUMBER4 ]
if @val[1] == "Some more details\n"
error('ts_default_details',
"'Some more details' is not a valid value",
@sourceFileInfo[1])
end
@journalEntry.details = newRichText(@val[1], @sourceFileInfo[1],
rtTokenSetMore)
})
doc('details', <<'EOT'
This is a continuation of the [[summary]] of the journal or status entry. It
can be several paragraphs long.
EOT
)
arg(1, 'text', <<'EOT'
The text will be interpreted as [[Rich_Text_Attributes|Rich Text]]. Only a
subset of the markup is supported for this attribute. You can use word
formatting, paragraphs, hyperlinks, lists, section and subsection
headers.
EOT
)
end
def rule_durationUnit
pattern(%w( _min ), lambda { 0 })