| 1 |
/* This file is part of the SvarCOM project and is published under the terms
|
1 |
/* This file is part of the SvarCOM project and is published under the terms
|
| 2 |
* of the MIT license.
|
2 |
* of the MIT license.
|
| 3 |
*
|
3 |
*
|
| 4 |
* Copyright (C) 2021 Mateusz Viste
|
4 |
* Copyright (C) 2021-2022 Mateusz Viste
|
| 5 |
*
|
5 |
*
|
| 6 |
* Permission is hereby granted, free of charge, to any person obtaining a
|
6 |
* Permission is hereby granted, free of charge, to any person obtaining a
|
| 7 |
* copy of this software and associated documentation files (the "Software"),
|
7 |
* copy of this software and associated documentation files (the "Software"),
|
| 8 |
* to deal in the Software without restriction, including without limitation
|
8 |
* to deal in the Software without restriction, including without limitation
|
| 9 |
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
9 |
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
| 10 |
* and/or sell copies of the Software, and to permit persons to whom the
|
10 |
* and/or sell copies of the Software, and to permit persons to whom the
|
| 11 |
* Software is furnished to do so, subject to the following conditions:
|
11 |
* Software is furnished to do so, subject to the following conditions:
|
| 12 |
*
|
12 |
*
|
| 13 |
* The above copyright notice and this permission notice shall be included in
|
13 |
* The above copyright notice and this permission notice shall be included in
|
| 14 |
* all copies or substantial portions of the Software.
|
14 |
* all copies or substantial portions of the Software.
|
| 15 |
*
|
15 |
*
|
| 16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 17 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 18 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 19 |
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19 |
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 20 |
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
20 |
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
| 21 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
21 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
| 22 |
* DEALINGS IN THE SOFTWARE.
|
22 |
* DEALINGS IN THE SOFTWARE.
|
| 23 |
*/
|
23 |
*/
|
| 24 |
|
24 |
|
| 25 |
/*
|
25 |
/*
|
| 26 |
* routines used to manipulate the environment block
|
26 |
* routines used to manipulate the environment block
|
| 27 |
* Copyright (C) 2021, Mateusz Viste
|
- |
|
| 28 |
*/
|
27 |
*/
|
| 29 |
|
28 |
|
| 30 |
#ifndef ENV_H
|
29 |
#ifndef ENV_H
|
| 31 |
#define ENV_H
|
30 |
#define ENV_H
|
| 32 |
|
31 |
|
| 33 |
/* looks for varname in environment block and returns a far ptr to it if
|
32 |
/* looks for varname in environment block and returns a far ptr to it if
|
| 34 |
* found, NULL otherwise. varname MUST be in upper-case and MUST be terminated
|
33 |
* found, NULL otherwise. varname MUST be in upper-case and MUST be terminated
|
| 35 |
* by either a = sign or a NULL terminator */
|
34 |
* by either a = sign or a NULL terminator */
|
| 36 |
char far *env_lookup(unsigned short env_seg, const char *varname);
|
35 |
char far *env_lookup(unsigned short env_seg, const char *varname);
|
| 37 |
|
36 |
|
| 38 |
/* almost identical to env_lookup(), but instead of returning a pointer
|
37 |
/* almost identical to env_lookup(), but instead of returning a pointer
|
| 39 |
* to the 'NAME=value' string, it returns a pointer to value (or NULL if
|
38 |
* to the 'NAME=value' string, it returns a pointer to value (or NULL if
|
| 40 |
* var not found) */
|
39 |
* var not found) */
|
| 41 |
char far *env_lookup_val(unsigned short env_seg, const char *varname);
|
40 |
char far *env_lookup_val(unsigned short env_seg, const char *varname);
|
| 42 |
|
41 |
|
| - |
|
42 |
/* locates the value of env variable varname and copies it to result, up to
|
| - |
|
43 |
* ressz bytes (incl. the NULL terminator). returns the length of the value on
|
| - |
|
44 |
* success, 0 if var not found or couldn't fit in ressz). */
|
| - |
|
45 |
unsigned short env_lookup_valcopy(char *res, unsigned short ressz, unsigned short env_seg, const char *varname);
|
| - |
|
46 |
|
| 43 |
/* returns the size, in bytes, of the allocated environment block */
|
47 |
/* returns the size, in bytes, of the allocated environment block */
|
| 44 |
unsigned short env_allocsz(unsigned short env_seg);
|
48 |
unsigned short env_allocsz(unsigned short env_seg);
|
| 45 |
|
49 |
|
| 46 |
/* remove a variable from environment, if present. returns 0 on success, non-zero if variable not found */
|
50 |
/* remove a variable from environment, if present. returns 0 on success, non-zero if variable not found */
|
| 47 |
int env_dropvar(unsigned short env_seg, const char *varname);
|
51 |
int env_dropvar(unsigned short env_seg, const char *varname);
|
| 48 |
|
52 |
|
| 49 |
#define ENV_SUCCESS 0
|
53 |
#define ENV_SUCCESS 0
|
| 50 |
#define ENV_NOTENOM -1
|
54 |
#define ENV_NOTENOM -1
|
| 51 |
#define ENV_INVSYNT -2
|
55 |
#define ENV_INVSYNT -2
|
| 52 |
|
56 |
|
| 53 |
/* Writes a variable to environment block. The variable must in the form
|
57 |
/* Writes a variable to environment block. The variable must in the form
|
| 54 |
* "varname=value". If variable is already present in the environment block,
|
58 |
* "varname=value". If variable is already present in the environment block,
|
| 55 |
* then the value will be updated. If the new value is empty, then the
|
59 |
* then the value will be updated. If the new value is empty, then the
|
| 56 |
* existing variable (if any) is removed.
|
60 |
* existing variable (if any) is removed.
|
| 57 |
*
|
61 |
*
|
| 58 |
* This function returns:
|
62 |
* This function returns:
|
| 59 |
* ENV_SUCCESS = success
|
63 |
* ENV_SUCCESS = success
|
| 60 |
* ENV_NOTENOM = not enough available space in memory block
|
64 |
* ENV_NOTENOM = not enough available space in memory block
|
| 61 |
* ENV_INVSYNT = invalid syntax
|
65 |
* ENV_INVSYNT = invalid syntax
|
| 62 |
*/
|
66 |
*/
|
| 63 |
int env_setvar(unsigned short env_seg, const char *v);
|
67 |
int env_setvar(unsigned short env_seg, const char *v);
|
| 64 |
|
68 |
|
| 65 |
#endif
|
69 |
#endif
|
| 66 |
|
70 |
|