doc/www/doxygen/html/log_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: log.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>log.h</h1><a href="log_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       log.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             General header for the Barry library</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2008-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_LOG_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_LOG_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;iomanip&gt;</span>
  49 <a name="l00027"></a>00027
  50 <a name="l00028"></a>00028 <span class="keyword">namespace </span>Barry {
  51 <a name="l00029"></a>00029
  52 <a name="l00030"></a>00030 <span class="comment">//</span>
  53 <a name="l00031"></a>00031 <span class="comment">// LogLock</span>
  54 <a name="l00032"></a>00032 <span class="comment">//</span><span class="comment"></span>
  55 <a name="l00033"></a>00033 <span class="comment">/// RAII locking class used to protect the logStream passed into</span>
  56 <a name="l00034"></a>00034 <span class="comment">/// Barry::Init() (common.h).  If the application uses the same stream for</span>
  57 <a name="l00035"></a>00035 <span class="comment">/// its own logging, it should use this lock class, or use the macros</span>
  58 <a name="l00036"></a>00036 <span class="comment">/// in log.h.</span>
  59 <a name="l00037"></a>00037 <span class="comment">///</span>
  60 <a name="l00038"></a><a class="code" href="classBarry_1_1LogLock.html">00038</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1LogLock.html" title="RAII locking class used to protect the logStream passed into Barry::Init() (common...">LogLock</a>
  61 <a name="l00039"></a>00039 {
  62 <a name="l00040"></a>00040 <span class="keyword">public</span>:
  63 <a name="l00041"></a>00041         <a class="code" href="classBarry_1_1LogLock.html" title="RAII locking class used to protect the logStream passed into Barry::Init() (common...">LogLock</a>();
  64 <a name="l00042"></a>00042         ~<a class="code" href="classBarry_1_1LogLock.html" title="RAII locking class used to protect the logStream passed into Barry::Init() (common...">LogLock</a>();
  65 <a name="l00043"></a>00043 };
  66 <a name="l00044"></a>00044
  67 <a name="l00045"></a>00045 BXEXPORT <span class="keywordtype">bool</span> LogVerbose();
  68 <a name="l00046"></a>00046 BXEXPORT std::ostream* GetLogStream();
  69 <a name="l00047"></a>00047
  70 <a name="l00048"></a>00048 } <span class="comment">// namespace Barry</span>
  71 <a name="l00049"></a>00049
  72 <a name="l00050"></a>00050 <span class="preprocessor">#define barrylog(x)     { Barry::LogLock lock; (*Barry::GetLogStream()) &lt;&lt; x &lt;&lt; std::endl; }</span>
  73 <a name="l00051"></a>00051 <span class="preprocessor"></span>
  74 <a name="l00052"></a>00052 <span class="comment">// controlled by command line -v switch</span>
  75 <a name="l00053"></a>00053 <span class="preprocessor">#define barryverbose(x) if(Barry::LogVerbose()) { Barry::LogLock lock; (*Barry::GetLogStream()) &lt;&lt; x &lt;&lt; std::endl; }</span>
  76 <a name="l00054"></a>00054 <span class="preprocessor"></span>
  77 <a name="l00055"></a>00055 <span class="preprocessor">#endif // __BARRY_LOG_H__</span>
  78 <a name="l00056"></a>00056 <span class="preprocessor"></span>
  79 </pre></div></div>
  80 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:52 2009 for Barry by&nbsp;
  81 <a href="http://www.doxygen.org/index.html">
  82 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  83 </body>
  84 </html>