cpputest.github.io/docs/_test_output_8h_source.html at master · cpputest/cpputest.github.io

History

257 lines (255 loc) · 29.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>CppUTest Documentation: include/CppUTest/TestOutput.h Source File</title>

$(document).ready(function() { searchBox.OnSelectItem(0); });

</script>

</head>

<body>

<tbody>

<div id="projectname">CppUTest Documentation

</div>

</td>

</tr>

</tbody>

</table>

</div>

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

<li><a href="annotated.html"><span>Classes</span></a></li>

<li class="current"><a href="files.html"><span>Files</span></a></li>

<li>

<img id="MSearchSelect" src="search/mag_sel.png"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

alt=""/>

<input type="text" id="MSearchField" value="Search" accesskey="S"

onfocus="searchBox.OnSearchFieldFocus(true)"

onblur="searchBox.OnSearchFieldFocus(false)"

onkeyup="searchBox.OnSearchFieldChange(event)"/>

</span><span class="right">

</span>

</div>

</li>

</ul>

</div>

</ul>

</div>

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a></div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

<ul>

<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_53c566fdc3e5a6aa083c9b65caf1b73f.html">CppUTest</a></li> </ul>

</div>

</div>

<div class="title">TestOutput.h</div> </div>

</div>

<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>

<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div>

<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>

<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>

<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * * Redistributions in binary form must reproduce the above copyright</span></div>

<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>

<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>

<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Neither the name of the <organization> nor the</span></div>

<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * names of its contributors may be used to endorse or promote products</span></div>

<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * derived from this software without specific prior written permission.</span></div>

<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY</span></div>

<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span></div>

<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div>

<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY</span></div>

<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div>

<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div>

<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span></div>

<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>

<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div>

<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>

<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef D_TestOutput_h</span></div>

<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor">#define D_TestOutput_h</span></div>

<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// This is a minimal printer inteface.</span></div>

<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// We kept streams out too keep footprint small, and so the test</span></div>

<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// harness could be used with less capable compilers so more</span></div>

<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// platforms could use this test harness</span></div>

<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span><a class="code" href="class_utest_shell.html">UtestShell</a>;</div>

<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span><a class="code" href="class_test_failure.html">TestFailure</a>;</div>

<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span><a class="code" href="class_test_result.html">TestResult</a>;</div>

<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="class_test_output.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="class_test_output.html">TestOutput</a></div>

<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div>

<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">explicit</span> <a class="code" href="class_test_output.html">TestOutput</a>();</div>

<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_test_output.html">TestOutput</a>();</div>

<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printTestsStarted();</div>

<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printTestsEnded(<span class="keyword">const</span> <a class="code" href="class_test_result.html">TestResult</a>& result);</div>

<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printCurrentTestStarted(<span class="keyword">const</span> <a class="code" href="class_utest_shell.html">UtestShell</a>& test);</div>

<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printCurrentTestEnded(<span class="keyword">const</span> <a class="code" href="class_test_result.html">TestResult</a>& res);</div>

<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printCurrentGroupStarted(<span class="keyword">const</span> <a class="code" href="class_utest_shell.html">UtestShell</a>& test);</div>

<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printCurrentGroupEnded(<span class="keyword">const</span> <a class="code" href="class_test_result.html">TestResult</a>& res);</div>

<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> verbose();</div>

<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span>*)=0;</div>

<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> print(<span class="keyword">const</span> <span class="keywordtype">char</span>*);</div>

<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> print(<span class="keywordtype">long</span>);</div>

<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printDouble(<span class="keywordtype">double</span>);</div>

<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printHex(<span class="keywordtype">long</span>);</div>

<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> print(<span class="keyword">const</span> <a class="code" href="class_test_failure.html">TestFailure</a>& failure);</div>

<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printTestRun(<span class="keywordtype">int</span> number, <span class="keywordtype">int</span> total);</div>

<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setProgressIndicator(<span class="keyword">const</span> <span class="keywordtype">char</span>*);</div>

<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush();</div>

<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">enum</span> WorkingEnvironment {vistualStudio, eclipse, detectEnvironment};</div>

<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> setWorkingEnvironment(WorkingEnvironment workEnvironment);</div>

<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> WorkingEnvironment getWorkingEnvironment();</div>

<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">protected</span>:</div>

<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printEclipseErrorInFileOnLine(<a class="code" href="class_simple_string.html">SimpleString</a> file, <span class="keywordtype">int</span> lineNumber);</div>

<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printVistualStudioErrorInFileOnLine(<a class="code" href="class_simple_string.html">SimpleString</a> file, <span class="keywordtype">int</span> lineNumber);</div>

<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printProgressIndicator();</div>

<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> printFileAndLineForTestAndFailure(<span class="keyword">const</span> <a class="code" href="class_test_failure.html">TestFailure</a>& failure);</div>

<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> printFileAndLineForFailure(<span class="keyword">const</span> <a class="code" href="class_test_failure.html">TestFailure</a>& failure);</div>

<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> printFailureInTest(<a class="code" href="class_simple_string.html">SimpleString</a> testName);</div>

<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> printFailureMessage(<a class="code" href="class_simple_string.html">SimpleString</a> reason);</div>

<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> printErrorInFileOnLineFormattedForWorkingEnvironment(<a class="code" href="class_simple_string.html">SimpleString</a> testFile, <span class="keywordtype">int</span> lineNumber);</div>

<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="class_test_output.html">TestOutput</a>(<span class="keyword">const</span> <a class="code" href="class_test_output.html">TestOutput</a>&);</div>

<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="class_test_output.html">TestOutput</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_test_output.html">TestOutput</a>&);</div>

<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> dotCount_;</div>

<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> verbose_;</div>

<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* progressIndication_;</div>

<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">static</span> WorkingEnvironment workingEnvironment_;</div>

<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="class_test_output.html">TestOutput</a>& operator<<(<a class="code" href="class_test_output.html">TestOutput</a>&, <span class="keyword">const</span> <span class="keywordtype">char</span>*);</div>

<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="class_test_output.html">TestOutput</a>& operator<<(<a class="code" href="class_test_output.html">TestOutput</a>&, <span class="keywordtype">long</span>);</div>

<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// ConsoleTestOutput.h</span></div>

<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// Printf Based Solution</span></div>

<div class="line"><a name="l00107"></a><span class="lineno"><a class="code" href="class_console_test_output.html"> 107</a></span> <span class="keyword">class </span><a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>: <span class="keyword">public</span> <a class="code" href="class_test_output.html">TestOutput</a></div>

<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">public</span>:</div>

<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">explicit</span> <a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>()</div>

<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>()</div>

<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> printBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span>* s);</div>

<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush();</div>

<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">private</span>:</div>

<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>(<span class="keyword">const</span> <a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>&);</div>

<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_console_test_output.html">ConsoleTestOutput</a>&);</div>

<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// StringBufferTestOutput.h</span></div>

<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">// TestOutput for test purposes</span></div>

<div class="line"><a name="l00134"></a><span class="lineno"><a class="code" href="class_string_buffer_test_output.html"> 134</a></span> <span class="keyword">class </span><a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>: <span class="keyword">public</span> <a class="code" href="class_test_output.html">TestOutput</a></div>

<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">public</span>:</div>

<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">explicit</span> <a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>()</div>

<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>();</div>

<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">void</span> printBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span>* s)</div>

<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  output += s;</div>

<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">void</span> flush()</div>

<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  output = <span class="stringliteral">""</span>;</div>

<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">const</span> <a class="code" href="class_simple_string.html">SimpleString</a>& getOutput()</div>

<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">return</span> output;</div>

<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="keyword">private</span>:</div>

<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="class_simple_string.html">SimpleString</a> output;</div>

<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>(<span class="keyword">const</span> <a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>&);</div>

<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_string_buffer_test_output.html">StringBufferTestOutput</a>&);</div>

<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#endif</span></div>

</div></div>

Generated on Wed Apr 24 2013 12:22:06 for CppUTest Documentation by  <a href="http://www.doxygen.org/index.html">

</a> 1.8.3.1

</small></address>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

_test_output_8h_source.html

Latest commit

History

_test_output_8h_source.html

File metadata and controls