summaryrefslogtreecommitdiff
path: root/support/dktools/dk4pathw.h
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/dktools/dk4pathw.h
Initial commit
Diffstat (limited to 'support/dktools/dk4pathw.h')
-rw-r--r--support/dktools/dk4pathw.h143
1 files changed, 143 insertions, 0 deletions
diff --git a/support/dktools/dk4pathw.h b/support/dktools/dk4pathw.h
new file mode 100644
index 0000000000..83eba9ed3c
--- /dev/null
+++ b/support/dktools/dk4pathw.h
@@ -0,0 +1,143 @@
+/*
+ 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: dk4pathw.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 DK4PATHW_H_INCLUDED
+/** Avoid multiple inclusions. */
+#define DK4PATHW_H_INCLUDED 1
+
+
+#line 9 "dk4pathw.ctr"
+
+/** @file
+ String operations for path names
+ (wchar_t characters).
+*/
+
+#ifndef DK4CONF_H_INCLUDED
+#include "dk4conf.h"
+#endif
+
+#ifndef DK4TYPES_H_INCLUDED
+#include "dk4types.h"
+#endif
+
+#ifndef DK4ERROR_H_INCLUDED
+#include "dk4error.h"
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Check whether a file name is an absolute path.
+ CRT on Windows: Not used.
+ @param path Path name to check.
+ @return 1 for absolute path, 0 for other path.
+*/
+int
+dk4pathw_is_absolute(const wchar_t *path);
+
+/** Check whether a file name is a relative path.
+ CRT on Windows: Not used.
+ @param path Path name to check.
+ @return 1 for absolute path, 0 for other path.
+*/
+int
+dk4pathw_is_relative(const wchar_t *path);
+
+/** Append path filename to path name already stored in buffer.
+ CRT on Windows: Optional, disabling CRT degrades performance.
+ @param buffer Buffer already containing a path.
+ @param sz Buffer size.
+ @param filename Relative file name to append to buffer.
+ @param erp Error report, may be NULL.
+ @return 1 on success, 0 on error.
+
+ Error codes:
+ - DK4_E_INVALID_ARGUMENTS<br>
+ if buffer or filename is NULL or sz is 0,
+ - DK4_E_MATH_OVERFLOW<br>
+ if filename is too long,
+ - DK4_E_MEMORY<br>
+ if allocation of a filename copy fails,
+ - DK4_E_SYNTAX<br>
+ if too many .. in filename,
+ - DK4_E_BUFFER_TOO_SMALL<br>
+ if buffer size is too small.
+*/
+int
+dk4pathw_append(
+ wchar_t *buffer, size_t sz, const wchar_t *filename, dk4_er_t *erp
+);
+
+/** Find pointer to suffix.
+ CRT on Windows: Not used.
+ @param filename File name to find suffix for.
+ @param erp Error report, may be NULL.
+ @return Pointer to suffix dot if found, NULL otherwise.
+
+ Error codes:
+ - DK4_E_INVALID_ARGUMENTS<br>
+ if filename is NULL,
+ - DK4_E_NOT_FOUND<br>
+ if the file name does not contain a suffix.
+*/
+wchar_t *
+dk4pathw_get_suffix(const wchar_t *filename, dk4_er_t *erp);
+
+/** Correct file name separators from slash to backslash on Windows,
+ vice versa on other systems.
+ CRT on Windows: Not used.
+ @param filename File name to correct.
+*/
+void
+dk4pathw_correct_sep(wchar_t *filename);
+
+/** Check whether file name needs expansion on Windows.
+ CRT on Windows: Not used.
+ @param filename File name to check.
+ @return 1 if expansion is necessary, 0 otherwise.
+*/
+int
+dk4pathw_must_expand(const wchar_t *filename);
+
+#ifdef __cplusplus
+}
+#endif
+
+
+
+
+#endif