903156c1e2
-- I am too lazy to write my own documentation right now, this is what doxygen was designed for right?
212 lines
14 KiB
HTML
212 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<title>Unuk: src/libUnuk/Debug.cpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Unuk <span id="projectnumber">1.0</span></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li id="searchli">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<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">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
initNavTree('_debug_8cpp.html','');
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">src/libUnuk/Debug.cpp</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="_debug_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#include <iostream></span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor">#include <fstream></span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor">#include <cstdarg></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include <ctime></span>
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#include "<a class="code" href="_debug_8h.html">Debug.h</a>"</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor">#include "string"</span>
|
|
<a name="l00007"></a>00007
|
|
<a name="l00008"></a>00008
|
|
<a name="l00009"></a>00009 <span class="keyword">using namespace </span>std;
|
|
<a name="l00010"></a>00010
|
|
<a name="l00011"></a>00011 <span class="comment">// ===================================================================</span>
|
|
<a name="l00012"></a>00012 <span class="comment">// The Debug log allows us to display ever piece of data that</span>
|
|
<a name="l00013"></a>00013 <span class="comment">// populates our class components, anything that is loaded, serialized,</span>
|
|
<a name="l00014"></a>00014 <span class="comment">// de-serialized etc will be printed out to a text file.</span>
|
|
<a name="l00015"></a>00015 <span class="comment">// (Running our program in a terminal, this debug log will print to it.)</span>
|
|
<a name="l00016"></a>00016 <span class="comment">// ===================================================================</span>
|
|
<a name="l00017"></a>00017
|
|
<a name="l00018"></a>00018 <a class="code" href="class_debug.html">Debug</a> *<a class="code" href="class_debug.html#ace75e2aa3105e64f9fc82c537b45135d">Debug::logger</a> = <a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>;
|
|
<a name="l00019"></a>00019
|
|
<a name="l00020"></a><a class="code" href="class_debug.html#ace4118d95ec0e79f5fa4d7248e94b569">00020</a> <a class="code" href="class_debug.html#ace4118d95ec0e79f5fa4d7248e94b569">Debug::Debug</a>(<span class="keywordtype">bool</span> logToFile) {
|
|
<a name="l00021"></a>00021 time_t timestamp;
|
|
<a name="l00022"></a>00022 <span class="keywordflow">if</span>(logToFile) {
|
|
<a name="l00023"></a>00023 logFile.open(<span class="stringliteral">"../Bin/Debug.log"</span>, ios::out);
|
|
<a name="l00024"></a>00024 <span class="keywordflow">if</span>(!logToFile) {
|
|
<a name="l00025"></a>00025 <span class="comment">// We can not open our log.</span>
|
|
<a name="l00026"></a>00026 cerr << <span class="stringliteral">"Warning: Can not open Debug.log to write, continueing without logging\n"</span>;
|
|
<a name="l00027"></a>00027 } <span class="keywordflow">else</span> {
|
|
<a name="l00028"></a>00028 <span class="comment">// Log File is open, let us give it a nice time stamp.</span>
|
|
<a name="l00029"></a>00029 timestamp = time(<a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>);
|
|
<a name="l00030"></a>00030 logFile << <span class="stringliteral">"Log Started: "</span> << ctime(&timestamp) << endl;
|
|
<a name="l00031"></a>00031 }
|
|
<a name="l00032"></a>00032 }
|
|
<a name="l00033"></a>00033 }
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a><a class="code" href="class_debug.html#adcb21888f9ca900feee3bdab564c47c3">00035</a> <a class="code" href="class_debug.html#adcb21888f9ca900feee3bdab564c47c3">Debug::~Debug</a>(<span class="keywordtype">void</span>) {
|
|
<a name="l00036"></a>00036 time_t timestamp;
|
|
<a name="l00037"></a>00037
|
|
<a name="l00038"></a>00038 <span class="comment">// We only need to close the log if it is open.</span>
|
|
<a name="l00039"></a>00039 <span class="keywordflow">if</span>(logFile) {
|
|
<a name="l00040"></a>00040 <span class="comment">// Give it a closing timestamp.</span>
|
|
<a name="l00041"></a>00041 timestamp = time(<a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>);
|
|
<a name="l00042"></a>00042 logFile << endl << <span class="stringliteral">"Log Closed: "</span> << ctime(&timestamp) << endl;
|
|
<a name="l00043"></a>00043
|
|
<a name="l00044"></a>00044 <span class="comment">// Close the log file.</span>
|
|
<a name="l00045"></a>00045 logFile.close();
|
|
<a name="l00046"></a>00046 }
|
|
<a name="l00047"></a>00047 }
|
|
<a name="l00048"></a>00048
|
|
<a name="l00049"></a><a class="code" href="class_debug.html#a7f171818a11f4d6b8dee3b44c4d6f0a7">00049</a> <span class="keywordtype">void</span> <a class="code" href="class_debug.html#a7f171818a11f4d6b8dee3b44c4d6f0a7">Debug::message</a>(std::string msg) {
|
|
<a name="l00050"></a>00050 <span class="keywordflow">if</span>(logFile) {
|
|
<a name="l00051"></a>00051 logFile << msg << endl;
|
|
<a name="l00052"></a>00052 }
|
|
<a name="l00053"></a>00053 cerr << msg << endl << endl;
|
|
<a name="l00054"></a>00054 }
|
|
<a name="l00055"></a>00055
|
|
<a name="l00056"></a><a class="code" href="class_debug.html#afb2b4be02c39146a0e3a388b1d2a9883">00056</a> <span class="keywordtype">void</span> <a class="code" href="class_debug.html#a7f171818a11f4d6b8dee3b44c4d6f0a7">Debug::message</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, ...) {
|
|
<a name="l00057"></a>00057 va_list vargList; <span class="comment">// This is to handlle the variable arguments</span>
|
|
<a name="l00058"></a>00058
|
|
<a name="l00059"></a>00059 <span class="keywordtype">char</span> outBuf[1024];
|
|
<a name="l00060"></a>00060 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> outLen;
|
|
<a name="l00061"></a>00061
|
|
<a name="l00062"></a>00062 <span class="comment">// This takes the arguments and puts them into the character array.</span>
|
|
<a name="l00063"></a>00063 va_start(vargList, msg);
|
|
<a name="l00064"></a>00064
|
|
<a name="l00065"></a>00065 <span class="preprocessor">#if defined WIN32</span>
|
|
<a name="l00066"></a>00066 <span class="preprocessor"></span> outLen = _vsnprintf(outBuf, <span class="keyword">sizeof</span>(outBuf), msg, vargList);
|
|
<a name="l00067"></a>00067 <span class="preprocessor">#else</span>
|
|
<a name="l00068"></a>00068 <span class="preprocessor"></span> outLen = vsnprintf(outBuf, <span class="keyword">sizeof</span>(outBuf), msg, vargList);
|
|
<a name="l00069"></a>00069 <span class="preprocessor">#endif</span>
|
|
<a name="l00070"></a>00070 <span class="preprocessor"></span>
|
|
<a name="l00071"></a>00071 va_end(vargList);
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <span class="keywordflow">if</span>(outLen >= <span class="keyword">sizeof</span>(outBuf)) {
|
|
<a name="l00074"></a>00074 outLen = <span class="keyword">sizeof</span>(outBuf);
|
|
<a name="l00075"></a>00075 }
|
|
<a name="l00076"></a>00076
|
|
<a name="l00077"></a>00077 <span class="keywordflow">if</span>(logFile) {
|
|
<a name="l00078"></a>00078 logFile << outBuf << endl;
|
|
<a name="l00079"></a>00079 }
|
|
<a name="l00080"></a>00080
|
|
<a name="l00081"></a>00081 cerr << outBuf << endl;
|
|
<a name="l00082"></a>00082 }
|
|
<a name="l00083"></a>00083
|
|
<a name="l00084"></a><a class="code" href="class_debug.html#a70ec5b616303ab46c46f6e231799d07f">00084</a> <span class="keywordtype">bool</span> <a class="code" href="class_debug.html#a70ec5b616303ab46c46f6e231799d07f">Debug::openLog</a>(<span class="keywordtype">bool</span> logToFile) {
|
|
<a name="l00085"></a>00085 <span class="comment">// Make sure the logger has not already been initialized.</span>
|
|
<a name="l00086"></a>00086 <span class="keywordflow">if</span>(logger != <a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) {
|
|
<a name="l00087"></a>00087 logger->message(<span class="stringliteral">"Warning: Multiple calls to openLog()."</span>);
|
|
<a name="l00088"></a>00088 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
<a name="l00089"></a>00089 }
|
|
<a name="l00090"></a>00090 logger = <span class="keyword">new</span> <a class="code" href="class_debug.html">Debug</a>(logToFile);
|
|
<a name="l00091"></a>00091 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
<a name="l00092"></a>00092 }
|
|
<a name="l00093"></a>00093
|
|
<a name="l00094"></a><a class="code" href="class_debug.html#aab477ba859e35b69510dee5e7bc476e4">00094</a> <span class="keywordtype">void</span> <a class="code" href="class_debug.html#aab477ba859e35b69510dee5e7bc476e4">Debug::closeLog</a>(<span class="keywordtype">void</span>) {
|
|
<a name="l00095"></a>00095 <span class="keywordflow">if</span>(logger == <a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) {
|
|
<a name="l00096"></a>00096 cerr << <span class="stringliteral">"Warning: Call to closeLog() with NULL logger pointer."</span> << endl;
|
|
<a name="l00097"></a>00097 <span class="keywordflow">return</span>;
|
|
<a name="l00098"></a>00098 }
|
|
<a name="l00099"></a>00099 <span class="keyword">delete</span> logger;
|
|
<a name="l00100"></a>00100 logger = <a class="code" href="_node_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>;
|
|
<a name="l00101"></a>00101 }
|
|
</pre></div></div>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="_debug_8cpp.html">Debug.cpp</a> </li>
|
|
<li class="footer">Generated on Wed Nov 2 2011 22:46:22 for Unuk by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|