summaryrefslogtreecommitdiff
path: root/support/dktools/dk4mkdhw.h
blob: c54a08241220d46174ade853f40dfb5c3412ecd0 (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
/*
	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: dk4mkdhw.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 DK4MKDHW_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4MKDHW_H_INCLUDED 1


#line 10 "dk4mkdhw.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 wchar_t string.
*/

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

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

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

#if DK4_HAVE_WCHAR_H
#ifndef WCHAR_H_INCLUDED
#include <wchar.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.
*/
wchar_t *
dk4mkdir_hierarchy_wc_first_sep(wchar_t *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 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_CREATE_DIR_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateDirectory()
	  function failed.
*/
int
dk4mkdir_hierarchy_wc_one(const wchar_t *fn, int ro, dk4_er_t *erp);

/**	Create directory structure.
	CRT on Windows: Optional.
	@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_wc(const wchar_t *fn, int lc, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif




#endif