summaryrefslogtreecommitdiff
path: root/support/dktools/dk4stat.h
blob: 6b1b72f9ec76a36a6513932f1cc85b7b0cf1d831 (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
/*
	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: dk4stat.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 DK4STAT_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STAT_H_INCLUDED 1


#line 8 "dk4stat.ctr"

/**	@file
	File statistics (retrieve information from
	stat() and lstat() results).

	Note: The stat() and lstat() functions are sufficient for
	non-Windows systems.
	On Windows systems the st_dev and st_ino components may contain
	dummy contents, the stat structure does not contain information
	about symbolic links.

	For a portable (both Windows and non-Windows) check whether a file
	is a symbolic link, reparse point... use the dk4_file_info_t
	data type from dk4fileit.h and the functions from dk4filei.h.

	CRT on Windows: Required.
*/

#include "dk4statt.h"

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

#ifdef __cplusplus
extern "C" {
#endif

/**	Check whether the file information is about a regular file.
	@param	stb	Stat buffer filled previously.
	@param	erp	Error report, may be NULL.
	@return	1 for regular file, 0 otherwise.

*/
int
dk4stat_is_regular(const dk4_stat_t *stb, dk4_er_t *erp);

/**	Check whether the file information is about a directory.
	@param	stb	Stat buffer filled previously.
	@param	erp	Error report, may be NULL.
	@return	1 for regular file, 0 otherwise.

*/
int
dk4stat_is_directory(const dk4_stat_t *stb, dk4_er_t *erp);

/**	Check whether the file information is about a symbolic link.
	@param	stb	Stat buffer filled previously.
	@param	erp	Error report, may be NULL.
	@return	1 for regular file, 0 otherwise.

*/
int
dk4stat_is_symlink(const dk4_stat_t *stb, dk4_er_t *erp);

/**	Check whether the file information is about UNIX domain socket.
	@param	stb	Stat buffer filled previously.
	@param	erp	Error report, may be NULL.
	@return	1 for regular file, 0 otherwise.

*/
int
dk4stat_is_unix_domain_socket(const dk4_stat_t *stb, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif