taskjuggler 0.0.6 → 0.0.7

data/doc/TaskJuggler/MessageHandler.html

@@ -71,7 +71,21 @@
 					
 					<li><a href="#method-c-new">::new</a></li>
 					
-					<li><a href="#method-i-send">#send</a></li>
+					<li><a href="#method-i-addMessage">#addMessage</a></li>
+					
+					<li><a href="#method-i-critical">#critical</a></li>
+					
+					<li><a href="#method-i-debug">#debug</a></li>
+					
+					<li><a href="#method-i-error">#error</a></li>
+					
+					<li><a href="#method-i-fatal">#fatal</a></li>
+					
+					<li><a href="#method-i-info">#info</a></li>
+					
+					<li><a href="#method-i-to_s">#to_s</a></li>
+					
+					<li><a href="#method-i-warning">#warning</a></li>
 					
 				</ul>
 			</div>
@@ -165,6 +179,10 @@
 				
 					<li><a href="../TaskJuggler/DurationAttribute.html">TaskJuggler::DurationAttribute</a></li>
 				
+					<li><a href="../TaskJuggler/FileList.html">TaskJuggler::FileList</a></li>
+				
+					<li><a href="../TaskJuggler/FileRecord.html">TaskJuggler::FileRecord</a></li>
+				
 					<li><a href="../TaskJuggler/FixnumAttribute.html">TaskJuggler::FixnumAttribute</a></li>
 				
 					<li><a href="../TaskJuggler/FlagListAttribute.html">TaskJuggler::FlagListAttribute</a></li>
@@ -237,8 +255,6 @@
 				
 					<li><a href="../TaskJuggler/Macro.html">TaskJuggler::Macro</a></li>
 				
-					<li><a href="../TaskJuggler/MacroParser.html">TaskJuggler::MacroParser</a></li>
-				
 					<li><a href="../TaskJuggler/MacroTable.html">TaskJuggler::MacroTable</a></li>
 				
 					<li><a href="../TaskJuggler/ManagerResponsibilities.html">TaskJuggler::ManagerResponsibilities</a></li>
@@ -303,6 +319,8 @@
 				
 					<li><a href="../TaskJuggler/RTFReportLink.html">TaskJuggler::RTFReportLink</a></li>
 				
+					<li><a href="../TaskJuggler/RTFWithQuerySupport.html">TaskJuggler::RTFWithQuerySupport</a></li>
+				
 					<li><a href="../TaskJuggler/RealFormat.html">TaskJuggler::RealFormat</a></li>
 				
 					<li><a href="../TaskJuggler/RealFormatAttribute.html">TaskJuggler::RealFormatAttribute</a></li>
@@ -349,8 +367,6 @@
 				
 					<li><a href="../TaskJuggler/RichTextElement.html">TaskJuggler::RichTextElement</a></li>
 				
-					<li><a href="../TaskJuggler/RichTextException.html">TaskJuggler::RichTextException</a></li>
-				
 					<li><a href="../TaskJuggler/RichTextFunctionExample.html">TaskJuggler::RichTextFunctionExample</a></li>
 				
 					<li><a href="../TaskJuggler/RichTextFunctionHandler.html">TaskJuggler::RichTextFunctionHandler</a></li>
@@ -391,6 +407,8 @@
 				
 					<li><a href="../TaskJuggler/ShiftScenario.html">TaskJuggler::ShiftScenario</a></li>
 				
+					<li><a href="../TaskJuggler/SimpleQueryExpander.html">TaskJuggler::SimpleQueryExpander</a></li>
+				
 					<li><a href="../TaskJuggler/SortListAttribute.html">TaskJuggler::SortListAttribute</a></li>
 				
 					<li><a href="../TaskJuggler/SourceFileInfo.html">TaskJuggler::SourceFileInfo</a></li>
@@ -501,6 +519,8 @@
 				
 					<li><a href="../TaskJuggler/UserManual.html">TaskJuggler::UserManual</a></li>
 				
+					<li><a href="../TaskJuggler/VimSyntax.html">TaskJuggler::VimSyntax</a></li>
+				
 					<li><a href="../TaskJuggler/WebServer.html">TaskJuggler::WebServer</a></li>
 				
 					<li><a href="../TaskJuggler/WorkingHours.html">TaskJuggler::WorkingHours</a></li>
@@ -543,7 +563,13 @@
 		<h1 class="class">TaskJuggler::MessageHandler</h1>
 
 		<div id="description">
-			
+			<p>
+The <a href="MessageHandler.html">MessageHandler</a> can display and store
+application messages. Depending on the type of the message, a TjExeption
+can be raised (:error), or the program can be immedidately aborted
+(:fatal). Other types will just continue the program flow.
+</p>
+
 		</div>
 
 		<!-- Constants -->
@@ -582,6 +608,23 @@
 				
 				
 				
+				</div>
+			</div>
+			
+			<div id="scenario-attribute-method" class="method-detail">
+				<a name="scenario"></a>
+				
+				<a name="scenario="></a>
+				
+				<div class="method-heading attribute-method-heading">
+					<span class="method-name">scenario</span><span
+						class="attribute-access-type">[RW]</span>
+				</div>
+
+				<div class="method-description">
+				
+				
+				
 				</div>
 			</div>
 			
@@ -607,20 +650,23 @@
 
 				<div class="method-description">
 					
-					
+					<p>
+Initialize the <a href="MessageHandler.html">MessageHandler</a>.
+<em>console</em> specifies if the messages should be printed to $stderr.
+</p>
 					
 
 					
 					<div class="method-source-code"
 						id="new-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 19</span>
-19:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">console</span> = <span class="ruby-keyword kw">false</span>)
-20:       <span class="ruby-ivar">@messages</span> = []
-21:       <span class="ruby-ivar">@console</span> = <span class="ruby-identifier">console</span>
-22: 
-23:       <span class="ruby-ivar">@errors</span> = <span class="ruby-value">0</span>
-24:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 91</span>
+91:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">console</span> = <span class="ruby-keyword kw">false</span>)
+92:       <span class="ruby-ivar">@messages</span> = []
+93:       <span class="ruby-ivar">@console</span> = <span class="ruby-identifier">console</span>
+94:       <span class="ruby-comment cmt"># We count the errors.</span>
+95:       <span class="ruby-ivar">@errors</span> = <span class="ruby-value">0</span>
+96:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -637,35 +683,310 @@
 			<h3 class="section-header">Public Instance Methods</h3>
 
 		
-			<div id="send-method" class="method-detail ">
-				<a name="method-i-send"></a>
+			<div id="add-essage-method" class="method-detail ">
+				<a name="method-i-addMessage"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">addMessage</span><span
+						class="method-args">(type, id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Generate a message by specifying the <em>type</em>.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="add-essage-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 135</span>
+135:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addMessage</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>,
+136:                    <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+137:       <span class="ruby-identifier">abortOnError</span> = <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:error</span>
+138:       <span class="ruby-comment cmt"># Treat criticals like errors but without generating another</span>
+139:       <span class="ruby-comment cmt"># exception.</span>
+140:       <span class="ruby-identifier">type</span> = <span class="ruby-value">:error</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:critical</span>
+141: 
+142:       <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+143:       <span class="ruby-ivar">@messages</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">msg</span>
+144:       <span class="ruby-comment cmt"># Print the message to $stderr if requested by the user.</span>
+145:       <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@console</span>
+146: 
+147:       <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>
+148:       <span class="ruby-keyword kw">when</span> <span class="ruby-value">:error</span>
+149:         <span class="ruby-comment cmt"># Increase the error counter.</span>
+150:         <span class="ruby-ivar">@errors</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+151:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">TjException</span>.<span class="ruby-identifier">new</span>, <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">abortOnError</span>
+152:       <span class="ruby-keyword kw">when</span> <span class="ruby-value">:fatal</span>
+153:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>
+154:       <span class="ruby-keyword kw">end</span>
+155:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="critical-method" class="method-detail ">
+				<a name="method-i-critical"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">critical</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Generate an critical message.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="critical-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 111</span>
+111:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">critical</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+112:                  <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+113:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:critical</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+114:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="debug-method" class="method-detail ">
+				<a name="method-i-debug"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">debug</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Generate a debug message.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="debug-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 129</span>
+129:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+130:               <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+131:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:info</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+132:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="error-method" class="method-detail ">
+				<a name="method-i-error"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">error</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Generate an error message.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="error-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 105</span>
+105:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+106:               <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+107:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:error</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+108:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="fatal-method" class="method-detail ">
+				<a name="method-i-fatal"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">fatal</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Generate a fatal message that will abort the application.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="fatal-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 99</span>
+ 99:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+100:               <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+101:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:fatal</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+102:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="info-method" class="method-detail ">
+				<a name="method-i-info"></a>
 
 				<div class="method-heading">
 				
-					<span class="method-name">send</span><span
-						class="method-args">(message)</span>
+					<span class="method-name">info</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
 				</div>
 
 				<div class="method-description">
 					
+					<p>
+Generate an info message.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="info-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 123</span>
+123:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+124:              <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+125:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:info</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+126:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="to-s-method" class="method-detail ">
+				<a name="method-i-to_s"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">to_s</span><span
+						class="method-args">()</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Convert all messages into a single <a href="../String.html">String</a>.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="to-s-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 158</span>
+158:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+159:       <span class="ruby-identifier">text</span> = <span class="ruby-value str">''</span>
+160:       <span class="ruby-ivar">@messages</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">msg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">text</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">to_s</span> }
+161:       <span class="ruby-identifier">text</span>
+162:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="warning-method" class="method-detail ">
+				<a name="method-i-warning"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">warning</span><span
+						class="method-args">(id, message, sourceFileInfo = nil, line = nil, data = nil, scenario = nil)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
 					
+					<p>
+Generate a warning.
+</p>
 					
 
 					
 					<div class="method-source-code"
-						id="send-source">
+						id="warning-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 26</span>
-26:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">message</span>)
-27:       <span class="ruby-ivar">@errors</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'error'</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'fatal'</span>
-28:       <span class="ruby-ivar">@messages</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">message</span>
-29:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@console</span>
-30:         <span class="ruby-comment cmt"># The to_s call is necessary to support remote prints via DRb.</span>
-31:         <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>
-32:       <span class="ruby-keyword kw">end</span>
-33:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/MessageHandler.rb, line 117</span>
+117:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warning</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">line</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">data</span> = <span class="ruby-keyword kw">nil</span>,
+118:                 <span class="ruby-identifier">scenario</span> = <span class="ruby-keyword kw">nil</span>)
+119:       <span class="ruby-identifier">addMessage</span>(<span class="ruby-value">:warning</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">sourceFileInfo</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">scenario</span>)
+120:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>