Updated license
[anna.git] / source / time / functions.cpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 // Local
38 #include <anna/time/functions.hpp>
39 #include <anna/time/internal/TZ.hpp>
40
41 // Standard
42 #include <stdlib.h> // getenv
43 #include <time.h>
44 #include <sys/time.h>
45 #include <string>
46
47 #include <anna/core/functions.hpp>
48
49
50 namespace anna {
51 namespace time {
52 TZ shell_local_tz;
53 unsigned long long int SecondsReference;
54 }
55 }
56
57
58 void anna::time::functions::initialize() throw() {
59 //throw(anna::RuntimeException) {
60 // If the system is configured properly, the default time zone will be correct. You might set TZ if you are
61 //  using a computer over a network from a different time zone, and would like times reported to you in the
62 //  time zone local to you, rather than what is local to the computer.
63   static bool cached = false;
64
65   if(!cached) {
66     // The getenv() function need not be reentrant. A function that is not required to be reentrant is not
67     //  required to be thread-safe.
68     const char *local_tz = getenv("TZ");
69     shell_local_tz.set(local_tz);
70 //      if (shell_local_tz.isUnset())
71 //         std::cout << "'TZ' enviroment variable is not defined on shell (it shouldn't be necesary)" << std::endl;
72 //    setControlPoint();
73     SecondsReference = 0;
74     cached = true;
75   }
76 }
77
78 void anna::time::functions::setControlPoint(unsigned long long int secondsTimestamp) throw() {
79   SecondsReference = secondsTimestamp ? secondsTimestamp : (::time(NULL));
80 }
81
82 unsigned long long int anna::time::functions::getSecondsReference() throw() {
83   return SecondsReference;
84 }
85
86 const anna::time::TZ & anna::time::functions::getLocalTz(void) throw() {
87   return (shell_local_tz);
88 }
89
90 bool anna::time::functions::initialized(void) throw() {
91   return (shell_local_tz.isInitialized());
92 }
93
94 unsigned long long int anna::time::functions::unixSeconds(void) throw() {
95   return (::time(NULL));
96 }
97
98 unsigned long long int anna::time::functions::unixMilliseconds() throw() {
99   struct timeval tv;
100   gettimeofday(&tv, NULL);
101   return (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
102 }
103
104 unsigned long long int anna::time::functions::lapsedMilliseconds() throw() {
105   struct timeval tv;
106   gettimeofday(&tv, NULL);
107   return ((tv.tv_sec - SecondsReference) * 1000) + (tv.tv_usec / 1000);
108 }
109
110 unsigned long long int anna::time::functions::unixMicroseconds(void) throw() {
111   struct timeval tv;
112   gettimeofday(&tv, NULL);
113   unsigned long long int result(tv.tv_sec);
114   result *= 1000000;
115   return result += tv.tv_usec;
116 }
117
118 std::string anna::time::functions::currentTimeAsString(void) throw() {
119   struct timeval tv;
120   gettimeofday(&tv, NULL);
121   struct tm *tm;
122   tm = localtime(&tv.tv_sec);
123   return (anna::functions::asString("%02d:%02d:%02d %d usecs", tm->tm_hour, tm->tm_min, tm->tm_sec, tv.tv_usec));
124 }
125