diff options
author | Jennifer Averett <Jennifer.Averett@OARcorp.com> | 2010-05-24 20:07:09 +0000 |
---|---|---|
committer | Jennifer Averett <Jennifer.Averett@OARcorp.com> | 2010-05-24 20:07:09 +0000 |
commit | a518bc5b1a39e27a75bb5510ebf272c7658144b1 (patch) | |
tree | 5c8e7bcfb36f333f88f94673627addd5fcd7969d /covoar/Explanations.h | |
parent | 2010-05-24 Jennifer Averett <Jennifer.Averett@OARcorp.com> (diff) | |
download | rtems-testing-a518bc5b1a39e27a75bb5510ebf272c7658144b1.tar.bz2 |
2010-05-24 Jennifer Averett <Jennifer.Averett@OARcorp.com>
* covoar/05_ascending.gif, covoar/05_descending.gif,
covoar/05_unsorted.gif, covoar/ConfigFile.cc, covoar/ConfigFile.h,
covoar/CoverageFactory.cc, covoar/CoverageFactory.h,
covoar/CoverageMap.cc, covoar/CoverageMap.h,
covoar/CoverageMapBase.cc, covoar/CoverageMapBase.h,
covoar/CoverageRanges.cc, covoar/CoverageRanges.h,
covoar/CoverageReaderBase.cc, covoar/CoverageReaderBase.h,
covoar/CoverageReaderQEMU.cc, covoar/CoverageReaderQEMU.h,
covoar/CoverageReaderRTEMS.cc, covoar/CoverageReaderRTEMS.h,
covoar/CoverageReaderSkyeye.cc, covoar/CoverageReaderSkyeye.h,
covoar/CoverageReaderTSIM.cc, covoar/CoverageReaderTSIM.h,
covoar/CoverageWriterBase.cc, covoar/CoverageWriterBase.h,
covoar/CoverageWriterRTEMS.cc, covoar/CoverageWriterRTEMS.h,
covoar/CoverageWriterSkyeye.cc, covoar/CoverageWriterSkyeye.h,
covoar/CoverageWriterTSIM.cc, covoar/CoverageWriterTSIM.h,
covoar/DesiredSymbols.cc, covoar/DesiredSymbols.h,
covoar/ExecutableInfo.cc, covoar/ExecutableInfo.h,
covoar/Explanations.cc, covoar/Explanations.h, covoar/Makefile,
covoar/ObjdumpProcessor.cc, covoar/ObjdumpProcessor.h,
covoar/ReportsBase.cc, covoar/ReportsBase.h, covoar/ReportsHtml.cc,
covoar/ReportsHtml.h, covoar/ReportsText.cc, covoar/ReportsText.h,
covoar/SymbolTable.cc, covoar/SymbolTable.h, covoar/TargetBase.cc,
covoar/TargetBase.h, covoar/TargetFactory.cc, covoar/TargetFactory.h,
covoar/Target_arm.cc, covoar/Target_arm.h, covoar/Target_i386.cc,
covoar/Target_i386.h, covoar/Target_lm32.cc, covoar/Target_lm32.h,
covoar/Target_m68k.cc, covoar/Target_m68k.h,
covoar/Target_powerpc.cc, covoar/Target_powerpc.h,
covoar/Target_sparc.cc, covoar/Target_sparc.h,
covoar/TraceConverter.cc, covoar/TraceList.cc, covoar/TraceList.h,
covoar/TraceReaderBase.cc, covoar/TraceReaderBase.h,
covoar/TraceReaderLogQEMU.cc, covoar/TraceReaderLogQEMU.h,
covoar/TraceWriterBase.cc, covoar/TraceWriterBase.h,
covoar/TraceWriterQEMU.cc, covoar/TraceWriterQEMU.h,
covoar/app_common.cc, covoar/app_common.h, covoar/configfile_test.cc,
covoar/coverage_converter.cc, covoar/covmerge.cc, covoar/covoar.cc,
covoar/covoar.css, covoar/filter.gif, covoar/qemu-dump-trace.c,
covoar/qemu-log.h, covoar/qemu-traces.h, covoar/rtemscov_header.h,
covoar/skyeye_header.h, covoar/table.js: New files.
Diffstat (limited to 'covoar/Explanations.h')
-rw-r--r-- | covoar/Explanations.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/covoar/Explanations.h b/covoar/Explanations.h new file mode 100644 index 0000000..5c4764e --- /dev/null +++ b/covoar/Explanations.h @@ -0,0 +1,123 @@ +/* + * $Id$ + */ + +/*! @file Explanations.h + * @brief Explanations Specification + * + * This file contains the specification of the Explanations class. + */ + +#ifndef __EXPLANATIONS_H__ +#define __EXPLANATIONS_H__ + +#include <map> +#include <stdint.h> +#include <string> +#include <vector> + +namespace Coverage { + + /*! @class Explanation + * + * This class defines the information that comprises an explanation + * of an uncovered range or branch. + */ + class Explanation { + + public: + + /*! + * This member variable contains the starting line number of + * the uncovered range or branch. + */ + std::string startingPoint; + + /*! + * This member variable contains the classification of + * the explanation. + */ + std::string classification; + + /*! + * This member variable contains the multi-line explanation text. + */ + std::vector<std::string> explanation; + + /*! + * This member variable indicates whether this explanation was + * used during analysis. + */ + bool found; + + /*! + * This method constructs an Explanation instance. + */ + Explanation() {found = false;} + + /*! + * This method destructs an Explanation instance. + */ + ~Explanation() {} + }; + + /*! @class Explanations + * + * This class defines a set of Explanation instances. + */ + class Explanations { + + public: + + /*! + * This member variable contains a list of Explanation instances. + */ + std::map<std::string, Explanation> set; + + /*! + * This method constructs an Explanations instance. + */ + Explanations(); + + /*! + * This method destructs an Explanations instance. + */ + ~Explanations(); + + /*! + * This methods loads the explanation information from the + * specified file. + * + * @param[in] explanations specifies the file name containing + * the explanation information + */ + void load( + const char* const explanations + ); + + /*! + * This method returns the explanation associated with the + * specified starting line number. + * + * @param[in] start specifies the starting line number for + * which to search + */ + const Explanation *lookupExplanation( + std::string& start + ); + + /*! + * This method writes a file that contains a list of any + * explanations that were not looked up. + * + * @param[in] fileName specifies the name of the file to write + */ + void writeNotFound( + const char* const fileName + ); + + }; + +} + +#endif |