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

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


#line 10 "dk4maiddsz.ctr"

/**	@file
	Retrieve size_t value from
	dkChar string in decimal notation.
*/

#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

/**	Retrieve numeric value from string, decimal notation.
	@param	rp	Pointer to result variable for the found value.
	@param	src	String to check for numeric value.
			In addition to the numeric value the string can
			contain a suffix 'K', 'M', 'G', 'T', 'P', 'E',
			'Z' or 'Y' to indicate multiples of powers of 1024
			(kibibytes, mibibytes...).
			Suffixes 'k', 'm', 'g', 't', 'p', 'e', 'z' or 'y'
			indicate multiples of powers of 1000
			(kilobytes, megabytes...).
	@param	endptr	Address of pointer variable.
			A pointer to the first character not processed
			is stored here.
			The function may also store a NULL pointer in this
			variable.
	@param	atg	Allow trailing garbage:
			0=no unprocessable trailing bytes allowed,
			1=trailing whitespaces allowed,
			2=any trailing characters allowed.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	DK4_E_INVALID_ARGUMENTS	if rp or src is NULL,
	DK4_E_MATH_OVERFLOW	if the number is out of range, or
	DK4_E_SYNTAX		if src contains illegal characters.
*/
int
dk4ma_input_dk_dec_size_t(
  size_t	 *rp,
  const dkChar	 *src,
  const dkChar	**endptr,
  int		  atg,
  dk4_er_t	 *erp
);

/**	Retrieve numeric value from string, decimal notation.
	@param	rp	Pointer to result variable for the found value.
	@param	src	String to check for numeric value.
	@param	endptr	Address of pointer variable.
			A pointer to the first character not processed
			is stored here.
			The function may also store a NULL pointer in this
			variable.
	@param	atg	Allow trailing garbage:
			0=no unprocessable trailing bytes allowed,
			1=trailing whitespaces allowed,
			2=any trailing characters allowed.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	DK4_E_INVALID_ARGUMENTS	if rp or src is NULL,
	DK4_E_MATH_OVERFLOW	if the number is out of range, or
	DK4_E_SYNTAX		if src contains illegal characters.
*/

int
dk4ma_input_dk_dec_size_t_simple(
  size_t	 *rp,
  const dkChar	 *src,
  const dkChar	**endptr,
  int		  atg,
  dk4_er_t	 *erp
);

#ifdef __cplusplus
}
#endif




#endif