summaryrefslogtreecommitdiff
path: root/support/dktools/dk4mkdh8.h
blob: becec7e4e89d1044cb37ac877a914f7e0ae48f91 (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
/*
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: dk4mkdh8.ctr
*/

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


#line 10 "dk4mkdh8.ctr"

/**	@file
	Make directory hierarchy (create all parent directories for a
	file or directory and the directory itself if required),
	the file or directory name is specified as char string.
*/

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

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

/**	Find position of first separator for real directory.

	This function is not intended for use in application programs,
	it is exported only for use from the dk4appmkdh module.

	The function either returns a value or sets the back variable
	to 1 or reports an error.
	@param	fn	File name.
	@param	bptr	Pointer to the back variable.
	@param	lc	Flag: Last component in fn is directory too.
	@param	erp	Error report, may be NULL.
	@return	First separator after a real directory on success if
	found, NULL otherwise.
*/
char *
dk4mkdir_hierarchy_c8_first_sep(char *fn, int *bptr, int lc, dk4_er_t *erp);

/**	Check whether directory exists or attempt to create directory.
	@param	fn	File name.
	@param	ro	Flag: Read only (test directory presence),
			do not attempt to create the directory.
	@param	erp	Error report, may be NULL.
	@return	1 if directory is available now, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_NOT_FOUND<br>
	  if a server/share combination is not present on Windows,
	- DK4_E_NON_DIR<br>
	  if any component in the path is not a directory,
	- DK4_E_MKDIR_FAILED<br>
	  with errno value in iDetails1 if the mkdir() function failed on a
	  non-Windows system.
	- DK4_E_CREATE_DIR_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateDirectory()
	  function failed on a Windows system.
*/
int
dk4mkdir_hierarchy_c8_one(const char *fn, int ro, dk4_er_t *erp);

/**	Create directory structure.
	@param	fn	File name.
	@param	lc	Flag: Last component in fn is directory too.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if fn is too long,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size allocation,
	- DK4_E_NOT_FOUND<br>
	  if a server/share combination is not present on Windows,
	- DK4_E_NON_DIR<br>
	  if one of the components in fn is not a directory,
	- DK4_E_MKDIR_FAILED<br>
	  with errno in idetails if the function fails to create the directory
	  or a parent directory,
	- DK4_E_CREATE_DIR_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateDirectory()
	  function failed on a Windows system.
*/
int
dk4mkdir_hierarchy_c8(const char *fn, int lc, dk4_er_t *erp);


#if DK4_HAVE_UID_T && DK4_HAVE_GID_T && DK4_HAVE_MODE_T && (!DK4_ON_WINDOWS)

/**	Create directory structure for a given POSIX user and group.
	@param	fn	File name.
	@param	lc	Flag: Last component in fn is directory too.
	@param	uid	User ID for new directories.
	@param	gid	Group ID for new directories.
	@param	mode	Permissions to new directories.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if fn is too long,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size allocation,
	- DK4_E_NOT_FOUND<br>
	  if a server/share combination is not present on Windows,
	- DK4_E_NON_DIR<br>
	  if one of the components in fn is not a directory,
	- DK4_E_MKDIR_FAILED<br>
	  with errno in idetails if the function fails to create the directory
	  or a parent directory,
	- DK4_E_CHOWN_FAILED<br>
	  with errno value in iDetails1 if the chown() function failed on a
	  non-Windows system,
	- DK4_E_CHMOD_FAILED<br>
	  with errno value in iDetails1 if the chmod() function failed on a
	  non-Windows system,
	- DK4_E_CREATE_DIR_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateDirectory()
	  function failed on a Windows system.
*/
int
dk4mkdir_hierarchy_ugm_c8(
  const char	*fn,
  int		 lc,
  uid_t		 uid,
  gid_t		 gid,
  mode_t	 mode,
  dk4_er_t	*erp
);

#endif

#ifdef __cplusplus
}
#endif




#endif