doc/www/doxygen/html/time_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: time.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>time.h</h1><a href="time_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       time.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Time related conversion routines.</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///             time_t is the POSIX time.</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span><span class="comment">///             min1900_t is the minutes from Jan 1, 1900</span>
  28 <a name="l00006"></a>00006 <span class="comment"></span><span class="comment">///</span>
  29 <a name="l00007"></a>00007 <span class="comment"></span>
  30 <a name="l00008"></a>00008 <span class="comment">/*</span>
  31 <a name="l00009"></a>00009 <span class="comment">    Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  32 <a name="l00010"></a>00010 <span class="comment"></span>
  33 <a name="l00011"></a>00011 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  34 <a name="l00012"></a>00012 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  35 <a name="l00013"></a>00013 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  36 <a name="l00014"></a>00014 <span class="comment">    (at your option) any later version.</span>
  37 <a name="l00015"></a>00015 <span class="comment"></span>
  38 <a name="l00016"></a>00016 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  39 <a name="l00017"></a>00017 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  40 <a name="l00018"></a>00018 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  41 <a name="l00019"></a>00019 <span class="comment"></span>
  42 <a name="l00020"></a>00020 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  43 <a name="l00021"></a>00021 <span class="comment">    root directory of this project for more details.</span>
  44 <a name="l00022"></a>00022 <span class="comment">*/</span>
  45 <a name="l00023"></a>00023
  46 <a name="l00024"></a>00024 <span class="preprocessor">#ifndef __BARRY_TIME_H__</span>
  47 <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_TIME_H__</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor"></span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;sys/time.h&gt;</span>           <span class="comment">// for struct timespec</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;<a class="code" href="time_8h.html" title="Time related conversion routines.">time.h</a>&gt;</span>
  52 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
  53 <a name="l00031"></a>00031
  54 <a name="l00032"></a>00032 <span class="comment">//</span>
  55 <a name="l00033"></a>00033 <span class="comment">// Calculate the number of minutes between Jan 01, 1900 and Jan 01, 1970</span>
  56 <a name="l00034"></a>00034 <span class="comment">//</span>
  57 <a name="l00035"></a>00035 <span class="comment">// There are 17 leap years between 1900 and 1970</span>
  58 <a name="l00036"></a>00036 <span class="comment">//    (1969-1900) / 4 = 17.25</span>
  59 <a name="l00037"></a>00037 <span class="comment">//</span>
  60 <a name="l00038"></a>00038 <span class="comment">// 1900 itself is not a leap year (not divisible by 400)</span>
  61 <a name="l00039"></a>00039 <span class="comment">//</span>
  62 <a name="l00040"></a>00040 <span class="preprocessor">#define DAY_MINUTES (24 * 60)</span>
  63 <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define YEAR_MINUTES (365 * DAY_MINUTES)</span>
  64 <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define LEAP_YEAR_COUNT ((1970-1901) / 4)</span>
  65 <a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define YEAR_COUNT (1970 - 1900)</span>
  66 <a name="l00044"></a>00044 <span class="preprocessor"></span>
  67 <a name="l00045"></a>00045 <span class="comment">// therefore, the difference between standard C's time and min1900_t's</span>
  68 <a name="l00046"></a>00046 <span class="comment">// time in minutes:</span>
  69 <a name="l00047"></a>00047 <span class="preprocessor">#define STDC_MIN1900_DIFF (YEAR_COUNT * YEAR_MINUTES + LEAP_YEAR_COUNT * DAY_MINUTES)</span>
  70 <a name="l00048"></a>00048 <span class="preprocessor"></span>
  71 <a name="l00049"></a>00049 <span class="keyword">namespace </span>Barry {
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051 <span class="keyword">typedef</span> <span class="keywordtype">long</span> min1900_t;
  74 <a name="l00052"></a>00052
  75 <a name="l00053"></a>00053 BXEXPORT min1900_t time2min(time_t t);
  76 <a name="l00054"></a>00054 BXEXPORT time_t min2time(min1900_t m);
  77 <a name="l00055"></a>00055
  78 <a name="l00056"></a>00056 <span class="comment">// FIXME - turn TimeZone into a C typedef and wrap this in extern "C"</span>
  79 <a name="l00057"></a>00057 <span class="comment">// so the data can be used in both C and C++ libraries</span>
  80 <a name="l00058"></a>00058 <span class="keyword">struct </span>BXEXPORT TimeZone
  81 <a name="l00059"></a>00059 {
  82 <a name="l00060"></a>00060         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Code;
  83 <a name="l00061"></a>00061         <span class="keywordtype">signed</span> <span class="keywordtype">short</span> HourOffset;
  84 <a name="l00062"></a>00062         <span class="keywordtype">signed</span> <span class="keywordtype">short</span> MinOffset;
  85 <a name="l00063"></a>00063         <span class="keyword">const</span> <span class="keywordtype">char</span> *Name;
  86 <a name="l00064"></a>00064 };
  87 <a name="l00065"></a>00065
  88 <a name="l00066"></a>00066 <span class="comment">// FIXME - put this somewhere for both C and C++</span>
  89 <a name="l00067"></a>00067 <span class="preprocessor">#define TIME_ZONE_CODE_ERR      0xffff</span>
  90 <a name="l00068"></a>00068 <span class="preprocessor"></span>
  91 <a name="l00069"></a>00069 BXEXPORT <span class="keyword">const</span> TimeZone* <a class="code" href="namespaceBarry.html#b664177c654a0cb41bc8fc40b39eabda" title="Returns a pointer to an array of TimeZone structs.">GetTimeZoneTable</a>();
  92 <a name="l00070"></a>00070 BXEXPORT <span class="keyword">const</span> TimeZone* <a class="code" href="namespaceBarry.html#8b42d46bf7b5cb8f4d9e0bde1d61f226" title="Searches the internal timezone code table for the given Code and returns a pointer...">GetTimeZone</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Code);
  93 <a name="l00071"></a>00071 BXEXPORT <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="namespaceBarry.html#56ac220ad3edcfbefcebb35c685212d1" title="Searches the internal timezone table for the first matching Code.">GetTimeZoneCode</a>(<span class="keywordtype">signed</span> <span class="keywordtype">short</span> HourOffset,
  94 <a name="l00072"></a>00072         <span class="keywordtype">signed</span> <span class="keywordtype">short</span> MinOffset = 0);
  95 <a name="l00073"></a>00073
  96 <a name="l00074"></a>00074 <span class="comment">// Message time conversion stuff</span>
  97 <a name="l00075"></a>00075 BXEXPORT time_t <a class="code" href="namespaceBarry.html#30255c53ebed390fc98a50e9c5d49984" title="This routine takes the day of the year and returns a time_t adjusted from the first...">DayToDate</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Day );
  98 <a name="l00076"></a>00076 BXEXPORT time_t <a class="code" href="namespaceBarry.html#2f4e6ee9d4afc6a26ae0166329609600" title="Localize the funky math used to convert a Blackberry message timestamp into a time_t...">Message2Time</a>(uint16_t r_date, uint16_t r_time);
  99 <a name="l00077"></a>00077
 100 <a name="l00078"></a>00078 <span class="comment">// Thread timeout creation</span>
 101 <a name="l00079"></a>00079 BXEXPORT <span class="keyword">struct </span>timespec* <a class="code" href="namespaceBarry.html#0e1dc80f82d25739631c39b545f812bb" title="Creates a pthread_cond_timedwait() compatible timespec struct, based on a given timeout...">ThreadTimeout</a>(<span class="keywordtype">int</span> timeout_ms, <span class="keyword">struct</span> timespec *spec);
 102 <a name="l00080"></a>00080
 103 <a name="l00081"></a>00081 } <span class="comment">// namespace Barry</span>
 104 <a name="l00082"></a>00082
 105 <a name="l00083"></a>00083 <span class="preprocessor">#endif</span>
 106 <a name="l00084"></a>00084 <span class="preprocessor"></span>
 107 </pre></div></div>
 108 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:53 2009 for Barry by&nbsp;
 109 <a href="http://www.doxygen.org/index.html">
 110 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 111 </body>
 112 </html>