summaryrefslogtreecommitdiff
path: root/support/dktools/dk4stat.h
blob: 76453434aafc2b54ed6a5618fd05733acea19ee6 (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
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	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
*/

#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.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef	DK4STATT_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4statt.h"
#else
#include <dktools-4/dk4statt.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#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