summaryrefslogtreecommitdiff
path: root/support/dktools/dk4ftime.h
blob: 00b12fcb9703e57501dea3b8f07375c97acf2634 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4ftime.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef DK4FTIME_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4FTIME_H_INCLUDED 1


#line 10 "dk4ftime.ctr"

/**	@file
	File related timestamps (timestamp comparison, converstion to text.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4TIMEC_H_INCLUDED
#include "dk4timec.h"
#endif

#if DK4_ON_WINDOWS
#ifndef WINDOWS_H_INCLUDED
#include <windows.h>
#define	WINDOWS_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_SYS_TYPES_H
#ifndef SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define	SYS_TYPES_H_INCLUDED 1
#endif
#endif
#if DK4_TIME_WITH_SYS_TIME
#ifndef SYS_TIME_H_INCLUDED
#include <sys/time.h>
#define	SYS_TIME_H_INCLUDED 1
#endif
#ifndef TIME_H_INCLUDED
#include <time.h>
#define	TIME_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_TIME_H
#ifndef TIME_H_INCLUDED
#include <time.h>
#define	TIME_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_SYS_TIME_H
#ifndef SYS_TIME_H_INCLUDED
#include <sys/time.h>
#define	SYS_TIME_H_INCLUDED 1
#endif
#endif
#endif
#endif
#ifndef DK4TIME_H_INCLUDED
#include "dk4time.h"
#endif
#endif



#if DK4_ON_WINDOWS
/**	File related timestamp.
*/
typedef	FILETIME	dk4_file_time_t;
#else
/**	File related timestamp.
*/
typedef	dk4_time_t	dk4_file_time_t;
#endif



#ifdef __cplusplus
extern "C" {
#endif

/**	Compare two timestamps.
	CRT on Windows: Not used.
	@param	l	Left timestamp.
	@param	r	Right timestamp.
	@return	1 if l>r, 0 if l=r, -1 if l<r.
*/
int
dk4filetime_compare(const dk4_file_time_t *l, const dk4_file_time_t *r);

/**	Convert timestamp to text ``yyyy-mm-dd hh:mm:ss''.
	CRT on Windows: Optional.
	@param	dptr	Result buffer address.
	@param	dsz	Result buffer size (number of dkChar).
	@param	fit	Timestamp to convert.
	@param	erp	Error report, may be NULL.
	@return 1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr or fit is NULL or dsz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occures in a size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small,
	- DK4_E_BUG<br>
	  if CRT or Windows API functions failed to convert the timestamp to
	  local time information.
*/
int
dk4filetime_to_text_c8(
  char			*dptr,
  size_t		 dsz,
  const dk4_file_time_t	*fit,
  dk4_er_t		*erp
);

/**	Convert timestamp to text ``yyyy-mm-dd hh:mm:ss''.
	CRT on Windows: Optional.
	@param	dptr	Result buffer address.
	@param	dsz	Result buffer size (number of dkChar).
	@param	fit	Timestamp to convert.
	@param	erp	Error report, may be NULL.
	@return 1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr or fit is NULL or dsz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occures in a size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small,
	- DK4_E_BUG<br>
	  if CRT or Windows API functions failed to convert the timestamp to
	  local time information.
*/
int
dk4filetime_to_text_wc(
  wchar_t		*dptr,
  size_t		 dsz,
  const dk4_file_time_t	*fit,
  dk4_er_t		*erp
);

/**	Convert timestamp to text ``yyyy-mm-dd hh:mm:ss''.
	CRT on Windows: Optional.
	@param	dptr	Result buffer address.
	@param	dsz	Result buffer size (number of dkChar).
	@param	fit	Timestamp to convert.
	@param	erp	Error report, may be NULL.
	@return 1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr or fit is NULL or dsz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occures in a size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small,
	- DK4_E_BUG<br>
	  if CRT or Windows API functions failed to convert the timestamp to
	  local time information.
*/
int
dk4filetime_to_text(
  dkChar		*dptr,
  size_t		 dsz,
  const dk4_file_time_t	*fit,
  dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif




#endif