2010-05-27 Jennifer Averett <Jennifer.Averett@OARcorp.com>

	* ReportsBase.cc, ReportsBase.h, ReportsHtml.cc, ReportsHtml.h,
	ReportsText.cc, ReportsText.h: Added visual break between information
	sections in the annotated report.

7 files changed, 93 insertions, 4 deletions

diff --git a/covoar/ChangeLog b/covoar/ChangeLog
index e4d8929..2cc7e28 100644
--- a/covoar/ChangeLog
+++ b/covoar/ChangeLog
@@ -1,3 +1,9 @@
+2010-05-27	Jennifer Averett <Jennifer.Averett@OARcorp.com>
+
+	* ReportsBase.cc, ReportsBase.h, ReportsHtml.cc, ReportsHtml.h,
+	ReportsText.cc, ReportsText.h: Added visual break between information
+	sections in the annotated report.
+
 2010-05-26	Joel Sherrill <joel.sherrilL@OARcorp.com>
 
 	* CoverageReaderTSIM.cc: Branch coverage works now.
diff --git a/covoar/ReportsBase.cc b/covoar/ReportsBase.cc
index 643df4a..0512c07 100644
--- a/covoar/ReportsBase.cc
+++ b/covoar/ReportsBase.cc
@@ -201,6 +201,7 @@ void ReportsBase::WriteAnnotatedReport(
     theBranches = ditr->second.uncoveredBranches;
 
     // Add annotations to each line where necessary
+    AnnotatedStart( aFile );
     for (itr = theInstructions->begin();
          itr != theInstructions->end();
          itr++ ) {
@@ -236,6 +237,8 @@ void ReportsBase::WriteAnnotatedReport(
       
       PutAnnotatedLine( aFile, state, line, id); 
     }
+
+    AnnotatedEnd( aFile );
   }
 
   CloseAnnotatedFile( aFile );
diff --git a/covoar/ReportsBase.h b/covoar/ReportsBase.h
index aa304f3..3e7bce9 100644
--- a/covoar/ReportsBase.h
+++ b/covoar/ReportsBase.h
@@ -271,8 +271,8 @@ class ReportsBase {
     );
 
     /*!
-     *  This method puts any necessary footer information into
-     *  the report then closes the file.
+     *  This method puts any necessary a line of annotated
+     *  data into the file.
      *
      *  @param[in] aFile identifies the report file name
      *  @param[in] state identifies the state machine state
@@ -287,6 +287,27 @@ class ReportsBase {
     )=0;
 
     /*!
+     *  This method puts any necessary header information in
+     *  front of an annotated section.
+     *
+     *  @param[in] aFile identifies the report file name
+     */
+     virtual void AnnotatedStart(
+      FILE*                aFile
+    )=0;
+ 
+    /*!
+     *  This method puts any necessary footer information in
+     *  front of an annotated section.
+     *
+     *  @param[in] aFile identifies the report file name
+     */
+     virtual void AnnotatedEnd(
+      FILE*                aFile
+    )=0;
+ 
+
+    /*!
      *  This method puts any necessary footer information into
      *  the report then closes the file.
      *
diff --git a/covoar/ReportsHtml.cc b/covoar/ReportsHtml.cc
index b772313..3631e42 100644
--- a/covoar/ReportsHtml.cc
+++ b/covoar/ReportsHtml.cc
@@ -406,6 +406,22 @@ namespace Coverage {
     return aFile;
   }
 
+  void ReportsHtml::AnnotatedStart(
+    FILE*                aFile
+  )
+  {
+    fprintf( 
+      aFile,
+      "<hr>\n" 
+    );
+  }
+ 
+  void ReportsHtml::AnnotatedEnd(
+    FILE*                aFile
+  )
+  {
+  }
+
   void ReportsHtml::PutAnnotatedLine( 
     FILE*                aFile, 
     AnnotatedLineState_t state, 
diff --git a/covoar/ReportsHtml.h b/covoar/ReportsHtml.h
index bf58988..44ec9e0 100644
--- a/covoar/ReportsHtml.h
+++ b/covoar/ReportsHtml.h
@@ -149,6 +149,16 @@ class ReportsHtml: public ReportsBase {
     );
 
     /* Inherit documentation from base class. */ 
+     virtual void AnnotatedStart(
+      FILE*                aFile
+    );
+ 
+    /* Inherit documentation from base class. */ 
+     virtual void AnnotatedEnd(
+      FILE*                aFile
+    );
+ 
+    /* Inherit documentation from base class. */ 
     virtual bool PutNoBranchInfo(
       FILE* report
     );
diff --git a/covoar/ReportsText.cc b/covoar/ReportsText.cc
index 29ee4aa..0e5bddd 100644
--- a/covoar/ReportsText.cc
+++ b/covoar/ReportsText.cc
@@ -21,6 +21,23 @@ ReportsText::ReportsText( time_t timestamp ):
   reportExtension_m = ".txt";
 }
 
+void ReportsText::AnnotatedStart(
+  FILE*                aFile
+)
+{
+  fprintf( 
+    aFile, 
+    "========================================"
+    "=======================================\n" 
+  );
+}
+ 
+void ReportsText::AnnotatedEnd(
+  FILE*                aFile
+)
+{
+}
+
 void ReportsText::PutAnnotatedLine( 
   FILE*                aFile, 
   AnnotatedLineState_t state, 
diff --git a/covoar/ReportsText.h b/covoar/ReportsText.h
index 3e7710d..c787749 100644
--- a/covoar/ReportsText.h
+++ b/covoar/ReportsText.h
@@ -60,17 +60,30 @@ class ReportsText: public ReportsBase {
 
   protected:
 
+   /* Inherit documentation from base class. */ 
     virtual void PutAnnotatedLine( 
       FILE*                aFile, 
       AnnotatedLineState_t state, 
       std::string          line, 
       uint32_t             id 
     );
-
+ 
+   /* Inherit documentation from base class. */ 
+     virtual void AnnotatedStart(
+      FILE*                aFile
+    );
+ 
+    /* Inherit documentation from base class. */ 
+     virtual void AnnotatedEnd(
+      FILE*                aFile
+    );
+ 
+   /* Inherit documentation from base class. */ 
     virtual bool PutNoBranchInfo(
       FILE* report
     );
 
+   /* Inherit documentation from base class. */ 
     virtual bool PutBranchEntry(
       FILE*                                            report,
       unsigned int                                     number,
@@ -78,6 +91,7 @@ class ReportsText: public ReportsBase {
       Coverage::CoverageRanges::ranges_t::iterator     rangePtr
     );
 
+   /* Inherit documentation from base class. */ 
     virtual void putCoverageNoRange(
       FILE*        report,
       FILE*        noRangeFile,
@@ -85,6 +99,7 @@ class ReportsText: public ReportsBase {
       std::string  symbol
     );
 
+   /* Inherit documentation from base class. */ 
     virtual bool PutCoverageLine(
       FILE*                                           report,
       unsigned int                                    number,
@@ -92,6 +107,7 @@ class ReportsText: public ReportsBase {
       Coverage::CoverageRanges::ranges_t::iterator    ritr
     );
 
+   /* Inherit documentation from base class. */ 
     virtual bool PutSizeLine(
       FILE*                                           report,
       unsigned int                                    number,
@@ -99,12 +115,12 @@ class ReportsText: public ReportsBase {
       Coverage::CoverageRanges::ranges_t::iterator    range
     );
 
+   /* Inherit documentation from base class. */ 
     virtual bool PutSymbolSummaryLine(
       FILE*                                           report,
       unsigned int                                    number,
       Coverage::DesiredSymbols::symbolSet_t::iterator symbol
     );
-
 };
 
 }