summaryrefslogtreecommitdiffstats
path: root/tester/covoar/CoverageWriterBase.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2014-05-09 21:50:37 +1000
committerChris Johns <chrisj@rtems.org>2014-06-18 16:48:08 +1200
commit100f517ab37265acdf067e36b6860020ec8b2184 (patch)
tree2316c8b888e11dcbcfbfc66a0c1e31991ea20656 /tester/covoar/CoverageWriterBase.h
parent4.11: Add ntp patch. (diff)
downloadrtems-tools-100f517ab37265acdf067e36b6860020ec8b2184.tar.bz2
covoar: Merger the covoar source from rtems-testing.git.
Use waf to build covoar.
Diffstat (limited to 'tester/covoar/CoverageWriterBase.h')
-rw-r--r--tester/covoar/CoverageWriterBase.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/tester/covoar/CoverageWriterBase.h b/tester/covoar/CoverageWriterBase.h
new file mode 100644
index 0000000..1d7d6eb
--- /dev/null
+++ b/tester/covoar/CoverageWriterBase.h
@@ -0,0 +1,57 @@
+/*! @file CoverageWriterBase.h
+ * @brief CoverageWriterBase Specification
+ *
+ * This file contains the specification of the CoverageWriterBase class.
+ */
+
+#ifndef __COVERAGE_WRITER_BASE_H__
+#define __COVERAGE_WRITER_BASE_H__
+
+#include <stdint.h>
+
+#include "CoverageMapBase.h"
+
+namespace Coverage {
+
+ /*! @class CoverageWriterBase
+ *
+ * This is the specification of the CoverageWriter base class.
+ * All CoverageWriter implementations inherit from this class.
+ */
+ class CoverageWriterBase {
+
+ public:
+
+ /*!
+ * This method constructs a CoverageWriterBase instance.
+ */
+ CoverageWriterBase();
+
+ /*!
+ * This method destructs a CoverageWriterBase instance.
+ */
+ virtual ~CoverageWriterBase();
+
+ /*!
+ * This method writes the @a coverage map for the specified
+ * address range and writes it to @file.
+ *
+ * @param[in] file specifies the name of the file to write
+ * @param[in] coverage specifies the coverage map to output
+ * @param[in] lowAddress specifies the lowest address in the
+ * coverage map to process
+ * @param[in] highAddress specifies the highest address in the
+ * coverage map to process
+ *
+ * @return Returns TRUE if the method succeeded and FALSE if it failed.
+ */
+ virtual void writeFile(
+ const char* const file,
+ CoverageMapBase* coverage,
+ uint32_t lowAddress,
+ uint32_t highAddress
+ ) = 0;
+ };
+
+}
+#endif