diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/dktools/dk4path8.h |
Initial commit
Diffstat (limited to 'support/dktools/dk4path8.h')
-rw-r--r-- | support/dktools/dk4path8.h | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/support/dktools/dk4path8.h b/support/dktools/dk4path8.h new file mode 100644 index 0000000000..b41b1f2e44 --- /dev/null +++ b/support/dktools/dk4path8.h @@ -0,0 +1,142 @@ +/* + 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: dk4path8.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 DK4PATH8_H_INCLUDED +/** Avoid multiple inclusions. */ +#define DK4PATH8_H_INCLUDED 1 + + +#line 9 "dk4path8.ctr" + +/** @file + String operations for path names + (8 bit 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 +dk4path8_is_absolute(const char *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 +dk4path8_is_relative(const char *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 +dk4path8_append(char *buffer, size_t sz, const char *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. +*/ +char * +dk4path8_get_suffix(const char *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 +dk4path8_correct_sep(char *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 +dk4path8_must_expand(const char *filename); + +#ifdef __cplusplus +} +#endif + + + + +#endif |