WebSVN – DevTools – Diff – /EA_DocGen/trunk/EA_DocGen/TextualContent.cs

 namespace EA_DocGen
+{
 	/// <summary>
 	/// Summary description for TextualContent.
 	/// </summary>
-	public class TextualContent
+   public class TextualContent
-	{
+   {
-      private Word.Application WordApp = null;
-      private Word.Document WordDocument = null;
+      private static char[] trim_newlines;
-      private DocSectionTracking DocSectionTracker = null;
-		public TextualContent(Word.Application wordApp, Word.Document wordDocument, DocSectionTracking docSectionTracker)
-		{
-         WordApp = wordApp;
-         WordDocument = wordDocument;
+      public static void initialise()
-         DocSectionTracker = docSectionTracker;
-		}
-      public void AcceptWordAppAndDoc(Word.Application wordApp, Word.Document wordDocument)
+      {
-         WordApp = wordApp;
+         string s_trim_newlines = "\r\n";
-         WordDocument = wordDocument;
+         trim_newlines = s_trim_newlines.ToCharArray();
+      }
-      public Word.Range appendDescription(string wordText, EA_Utilities EA_Utils)
+      public static Word.Range appendDescription(string wordText)
+      {
-         return appendDescription(wordText, EA_Utils, false);
+         return appendDescription(wordText, false);
+      }
-      public Word.Range appendDescription(string wordText, EA_Utilities EA_Utils, bool continuation)
+      public static Word.Range appendDescription(string wordText, bool continuation)
+      {
-         return appendDescription(wordText, EA_Constants.styleName_Body1, EA_Utils, continuation);
+         return appendDescription(wordText, EA_Constants.styleName_Body1, continuation);
+      }
-      public Word.Range appendDescription(string wordText, string styleName, EA_Utilities EA_Utils, bool continuation)
+      public static Word.Range appendDescription(string wordText, string styleName, bool continuation)
+      {
          Word.Range wr = null;
          if (wordText != null && wordText.Length > 0)
+         {
             wr = appendAndSelectText(wordText, styleName, continuation);
+         }
-         else if (!EA_Utils.options.opt_SuppressElementDescriptionMissingWarnings)
+         else if (!EA_DocGenOptions.opt_SuppressElementDescriptionMissingWarnings)
+         {
             wr = appendAndSelectText("Description missing!", styleName, continuation);
             // For some wierd reason, if continuing on same paragraph, we have to decrement the range start by 1
             // otherwise the D of Description, does not get the red color or italic style
             if (continuation)
       /// the specified style formatting to it.
       /// </summary>
       /// <param name="wordText"></param>
       /// <param name="styleText"></param>
       /// <param name="continuation"></param>
-      public Word.Range appendAndSelectText(string wordText, string styleText)
+      public static Word.Range appendAndSelectText(string wordText, string styleText)
+      {
          return appendAndSelectText(wordText, styleText, false );
+      }
-      public Word.Range appendAndSelectText(string wordText, string styleText, bool continuation )
+      public static Word.Range appendAndSelectText(string wordText, string styleText, bool continuation )
+      {
          if (wordText.Length > 0)
+         {
             Word.Range WordRange = null;
             object startLocation;
             object endLocation;
             object style = styleText;
             int i;
             startLocation = 0;
-            endLocation = i = WordDocument.Content.End;
+            endLocation = i = createWordDoc.WordDocument.Content.End;
-            WordRange = WordDocument.Range(ref startLocation, ref endLocation);
+            WordRange = createWordDoc.WordDocument.Range(ref startLocation, ref endLocation);
             if (!continuation)
                WordRange.InsertAfter( "\n" );
             WordRange.InsertAfter( wordText );
             // Make a range out of the pasted text
             startLocation = i;
-            endLocation = WordDocument.Content.End;
+            endLocation = createWordDoc.WordDocument.Content.End;
-            WordRange = WordDocument.Range(ref startLocation, ref endLocation);
+            WordRange = createWordDoc.WordDocument.Range(ref startLocation, ref endLocation);
             // and set the pasted text style
             WordRange.set_Style(ref style);
             return WordRange;
+         }
       /// Appends a specified text string to the word document, selects the new text, and applies
       /// a heading level style to it.
       /// </summary>
       /// <param name="wordText"></param>
       /// <param name="level"></param>
-      public void appendAndSelectHeadingText(string wordText, int level)
+      public static void appendAndSelectHeadingText(string wordText, int level)
+      {
          // A caller is requesting a new heading level so pass the level to the tracking
          // object so that we can predict exactly what the level numbering should be for
          // diagnostics and fake heading generation (see below in the switch statement).
-         DocSectionTracker.trackDocSection(level);
+         DocSectionTracking.trackDocSection(level);
          // Convert level to heading style
          string styleText;
          switch(level)
+         {
             default:
                // MS-Word cannot produce headings above level 9 and so we have to
                // fake a heading by constructing it from our document section tracking data.
                styleText = EA_Constants.styleName_Heading10OrAbove;
-               wordText = DocSectionTracker.formHeadingString(wordText);
+               wordText = DocSectionTracking.formHeadingString(wordText);
                break;
+         }
          // append the text as a heading
          appendAndSelectText(wordText, styleText);
+      }
+      public static string trimTrailingReturns(string s)
+      {
+          return s.TrimEnd(trim_newlines);
+      }
-      public string testSuiteName(EA.Element theElement)
+      public static string testSuiteName(EA.Element theElement)
+      {
          return "Test Suite - " + theElement.Name;
+      }
-      public void appendUnitTestSuite(EA.Element theElement, int recurse_level, ref ArrayList classList, ref EA_Utilities EA_Utils)
+      public static void appendUnitTestSuite(EA.Element theElement, int recurse_level, ref ArrayList classList)
+      {
          if (theElement.StereotypeEx.IndexOf("API") < 0)
+         {
             // element does not have an API stereotype, so is not a class for which unit tests are expected.
             return;
+            }
+         }
+      }
-      public void appendUnitTestSuite(EA.Package thePackage, int recurse_level, ref ArrayList classList, ref EA_Utilities EA_Utils)
+      public static void appendUnitTestSuite(EA.Package thePackage, int recurse_level, ref ArrayList classList)
+      {
          EA_ElementSorter elementSorter = new EA_ElementSorter(thePackage);
          EA.Element theElement = null;
          int theElementsRelativeLevel = 0;
          if (true == elementSorter.getFirst(ref theElement, ref theElementsRelativeLevel))
+         {
             do
+            {
                if (theElement.Type.StartsWith("Class"))
+               {
-                  appendUnitTestSuite(theElement, recurse_level, ref classList, ref EA_Utils);
+                  appendUnitTestSuite(theElement, recurse_level, ref classList);
+               }
             } while (true == elementSorter.getNext(ref theElement, ref theElementsRelativeLevel));
+         }
          // Scan through the packages within this package.
          foreach(EA.Package lowerLevelPackage in thePackage.Packages)
+         {
             // recurse
-            appendUnitTestSuite(lowerLevelPackage, recurse_level, ref classList, ref EA_Utils);
+            appendUnitTestSuite(lowerLevelPackage, recurse_level, ref classList);
+         }
+      }
-      public void SelectInsertionPointAtEndOfDocument()
+      public static void SelectInsertionPointAtEndOfDocument()
+      {
          object unit;
          object extend;
          unit = Word.WdUnits.wdStory;
          extend = Word.WdMovementType.wdMove;
-         WordApp.Selection.EndKey(ref unit, ref extend);
+         createWordDoc.WordApp.Selection.EndKey(ref unit, ref extend);
+      }
       /// <summary>
       /// Generates the text for requirements.  This uses custom styles to format the text
       /// rather than formatting it in code.
       /// </summary>
-      public bool generateRequirementText( EA.Element theElement, EA_Utilities EA_Utils )
+      public static bool generateRequirementText( EA.Element theElement )
+      {
          if ( theElement.Type.StartsWith("Requirement"))
+         {
             string reqID = "";
             string reqShortDesc = "";
-            string reqNotes = "";
-            string reqStatusText = "";
             string reqHeadingStyle ="";
             string reqParaStyle = "";
-            object reqNameStyle = EA_Constants.styleName_ReqName;
-            Word.Range shortDescRange;
             // Set the style depending on the status
             switch ( theElement.Status )
+            {
                case "Proposed":
-                  reqStatusText = "(Proposed)";
                   reqHeadingStyle = EA_Constants.styleName_ReqPropHdr;
                   reqParaStyle    = EA_Constants.styleName_ReqPropBody;
                   break;
                case "Rejected":
                   reqHeadingStyle = EA_Constants.styleName_ReqRejHdr;
                   reqParaStyle    = EA_Constants.styleName_ReqRejBody;
                   break;
                case "Approved":
-                  //reqStatusText = "(Approved)";
-                  //reqStatusText = "(Phase " + theElement.Phase + ")";
                   reqHeadingStyle = EA_Constants.styleName_ReqAppHdr;
                   reqParaStyle    = EA_Constants.styleName_ReqAppBody;
                   break;
                default:
-                  reqStatusText = "(" + theElement.Status + ")";
-                  //reqStatusText = "(" + theElement.Status + ")(Phase " + theElement.Phase + ")";
                   reqHeadingStyle = EA_Constants.styleName_ReqAppHdr;
                   reqParaStyle    = EA_Constants.styleName_ReqAppBody;
                   break;
+            }
             // Pull out the ID from the name
             int pos = theElement.Name.IndexOf( " ", 0, theElement.Name.Length );
+            if (pos > 0)
-            reqID = theElement.Name.Substring( 0, pos );
+               reqID = theElement.Name.Substring( 0, pos );
+            // Count '.' chars in the ID
+            int numDots = 0;
+            foreach (char c in reqID)
+            {
+               if (c == '.')
+                  numDots++;
+            }
+            // Calculate what the left/hanging indent should be based on the standard 2.5 cm plus a
+            // factor derived from the number of dots in the ID
+            float indent_cm = (float)(2.5 + (0.5 * numDots));
             // Pull out the short description from the rest of the name
             reqShortDesc = theElement.Name.Substring( pos, theElement.Name.Length-pos );
             reqShortDesc = reqShortDesc.Trim();
-            // Pull out the notes
-            reqNotes = theElement.Notes.ToString();
             // Add the text
-            appendAndSelectText( reqID + '\t', reqHeadingStyle );
+            Word.Range wr_id = appendAndSelectText( reqID + '\t', reqHeadingStyle );
-            shortDescRange = appendAndSelectText( reqShortDesc, reqHeadingStyle, true );
+            Word.Range wr_desc = appendAndSelectText( reqShortDesc, reqHeadingStyle, true );
+            //Bold the short description
+            wr_desc.Start = wr_desc.Start-1;
+            wr_desc.Font.Bold = 1;
+            // Indent according to the number of dots in the tag
+            if (numDots > 0)
+            {
+               wr_desc.ParagraphFormat.LeftIndent      =  createWordDoc.WordApp.CentimetersToPoints(indent_cm);
+               wr_desc.ParagraphFormat.FirstLineIndent = -createWordDoc.WordApp.CentimetersToPoints(indent_cm);
+            }
+            // Add requirement notes/body, if there is any
+            if (theElement.Notes != null && theElement.Notes.Length > 0)
+            {
-            Word.Range WordRange = appendAndSelectText( '\t' + reqStatusText, reqHeadingStyle, true );
+               Word.Range wr_body = appendAndSelectText( theElement.Notes, reqParaStyle );
-            //reapply the name char style to the short desc.
+               // indent according to the number of dots in the tag
-            shortDescRange.Start = shortDescRange.Start-1;
+               if (numDots > 0)
+               {
+                  wr_body.ParagraphFormat.LeftIndent = createWordDoc.WordApp.CentimetersToPoints( indent_cm );
+               }
+            }
+            else
+            {
+               // If the requirement has no body text, its SpaceAfter will be 3, so we adjust it here to 6
-            shortDescRange.End = WordRange.Start-1;
+               // just like what the body would have, if it were present.
-            shortDescRange.set_Style( ref reqNameStyle );
+               wr_desc.ParagraphFormat.SpaceAfter = 6;
+            }
-            appendAndSelectText( reqNotes, reqParaStyle );
             return true;
+         }
          return false;
+      }
-	}
+   }
+}

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/TextualContent.cs – Rev 2104 → 2106