Subversion Repositories SvarDOS

Rev

Rev 1629 | Rev 1823 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
421 mateuszvis 1
/* This file is part of the SvarCOM project and is published under the terms
2
 * of the MIT license.
3
 *
1629 mateusz.vi 4
 * Copyright (C) 2021-2024 Mateusz Viste
421 mateuszvis 5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a
7
 * copy of this software and associated documentation files (the "Software"),
8
 * to deal in the Software without restriction, including without limitation
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
11
 * Software is furnished to do so, subject to the following conditions:
12
 *
13
 * The above copyright notice and this permission notice shall be included in
14
 * all copies or substantial portions of the Software.
15
 *
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,
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
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
22
 * DEALINGS IN THE SOFTWARE.
23
 */
24
 
352 mateuszvis 25
#ifndef HELPERS_H
26
#define HELPERS_H
27
 
530 mateuszvis 28
/* case-insensitive comparison of strings, compares up to maxlen characters.
29
 * returns non-zero on equality. */
30
int imatchlim(const char *s1, const char *s2, unsigned short maxlen);
352 mateuszvis 31
 
530 mateuszvis 32
#define imatch(a,b) imatchlim(a,b,0xffff)
33
 
352 mateuszvis 34
/* returns zero if s1 starts with s2 */
35
int strstartswith(const char *s1, const char *s2);
36
 
538 mateuszvis 37
/* outputs a NULL-terminated string to handle (hSTDOUT or hSTDERR) */
38
void output_internal(const char *s, unsigned char nl, unsigned char handle);
369 mateuszvis 39
 
437 mateuszvis 40
/* outputs a NULL-terminated NLS string to stdout */
542 mateuszvis 41
void nls_output_internal(unsigned short id, unsigned char nl, unsigned char handle);
437 mateuszvis 42
 
538 mateuszvis 43
#define hSTDOUT 1
44
#define hSTDERR 2
45
 
46
#define output(x) output_internal(x, 0, hSTDOUT)
47
#define outputnl(x) output_internal(x, 1, hSTDOUT)
542 mateuszvis 48
#define nls_output(x,y) nls_output_internal((x << 8) | y, 0, hSTDOUT)
49
#define nls_outputnl(x,y) nls_output_internal((x << 8) | y, 1, hSTDOUT)
1719 mateusz.vi 50
#define nls_output_err(x,y) nls_output_internal((x << 8) | y, 0, hSTDERR)
542 mateuszvis 51
#define nls_outputnl_err(x,y) nls_output_internal((x << 8) | y, 1, hSTDERR)
369 mateuszvis 52
 
1719 mateusz.vi 53
/* output DOS error e to stderr, terminated with a CR/LF */
538 mateuszvis 54
void nls_outputnl_doserr(unsigned short e);
55
 
388 mateuszvis 56
/*
57
 * FileInfoRec (DTA) format:
58
 * offset size desc
59
 *    +0   21  reserved
60
 *  +15h    1  file attr (1=RO 2=Hidden 4=System 8=VOL 16=DIR 32=Archive
61
 *  +16h    2  time: bits 0-4=bi-seconds (0-30), bits 5-10=minutes (0-59), bits 11-15=hour (0-23)
62
 *  +18h    2  date: bits 0-4=day(0-31), bits 5-8=month (1-12), bits 9-15=years since 1980
63
 *  +1ah    4  DWORD file size, in bytes
64
 *  +1eh   13  13-bytes max ASCIIZ filename
65
 */
66
_Packed struct DTA {
67
  char reserved[21];
68
  unsigned char attr;
420 mateuszvis 69
  unsigned short time_sec2:5;
70
  unsigned short time_min:6;
71
  unsigned short time_hour:5;
72
  unsigned short date_dy:5;
73
  unsigned short date_mo:4;
74
  unsigned short date_yr:7;
388 mateuszvis 75
  unsigned long size;
76
  char fname[13];
77
};
78
 
420 mateuszvis 79
 
80
/* this is also known as the "Country Info Block" or "CountryInfoRec":
81
 * offset size desc
82
 *   +0      2   wDateFormat  0=USA (m d y), 1=Europe (d m y), 2=Japan (y m d)
83
 *   +2      5  szCrncySymb  currency symbol (ASCIIZ)
84
 *   +7      2  szThouSep    thousands separator (ASCIIZ)
85
 *   +9      2  szDecSep     decimal separator (ASCIIZ)
86
 * +0bH      2  szDateSep    date separator (ASCIIZ)
87
 * +0dH      2  szTimeSep    time separator (ASCIIZ)
88
 * +0fH      1  bCrncyFlags  currency format flags
89
 * +10H      1  bCrncyDigits decimals digits in currency
90
 * +11H      1  bTimeFormat  time format 0=12h 1=24h
91
 * +12H      4  pfCasemap    Casemap FAR call address
92
 * +16H      2  szDataSep    data list separator (ASCIIZ)
93
 * +18H     10  res          reserved zeros
94
 *          34               total length
95
 */
96
_Packed struct nls_patterns {
97
  unsigned short dateformat;
98
  char currency[5];
99
  char thousep[2];
100
  char decsep[2];
101
  char datesep[2];
102
  char timesep[2];
103
  unsigned char currflags;
104
  unsigned char currdigits;
105
  unsigned char timefmt;
106
  void far *casemapfn;
107
  char datalistsep[2];
108
  char reserved[10];
109
};
110
 
111
 
389 mateuszvis 112
#define DOS_ATTR_RO   1
113
#define DOS_ATTR_HID  2
114
#define DOS_ATTR_SYS  4
115
#define DOS_ATTR_VOL  8
116
#define DOS_ATTR_DIR 16
117
#define DOS_ATTR_ARC 32
118
 
388 mateuszvis 119
/* find first matching files using a FindFirst DOS call
542 mateuszvis 120
 * attr contains DOS attributes that files MAY have (ie attr=0 will match only
121
 * files that have no attributes at all)
388 mateuszvis 122
 * returns 0 on success or a DOS err code on failure */
123
unsigned short findfirst(struct DTA *dta, const char *pattern, unsigned short attr);
124
 
125
/* find next matching, ie. continues an action intiated by findfirst() */
126
unsigned short findnext(struct DTA *dta);
127
 
392 mateuszvis 128
/* print s string and wait for a single key press from stdin. accepts only
129
 * key presses defined in the c ASCIIZ string. returns offset of pressed key
130
 * in string. keys in c MUST BE UPPERCASE! */
131
unsigned short askchoice(const char *s, const char *c);
132
 
399 mateuszvis 133
/* converts a path to its canonic representation, returns 0 on success
134
 * or DOS err on failure (invalid drive) */
135
unsigned short file_truename(const char *src, char *dst);
392 mateuszvis 136
 
137
/* returns DOS attributes of file, or -1 on error */
138
int file_getattr(const char *fname);
139
 
396 mateuszvis 140
/* returns screen's width (in columns) */
141
unsigned short screen_getwidth(void);
142
 
143
/* returns screen's height (in rows) */
144
unsigned short screen_getheight(void);
145
 
146
/* displays the "Press any key to continue" msg and waits for a keypress */
147
void press_any_key(void);
148
 
399 mateuszvis 149
/* validate a drive (A=0, B=1, etc). returns 1 if valid, 0 otherwise */
150
int isdrivevalid(unsigned char drv);
151
 
406 mateuszvis 152
/* converts a filename into FCB format (FILENAMEEXT) */
153
void file_fname2fcb(char *dst, const char *src);
154
 
155
/* converts a FCB filename (FILENAMEEXT) into normal format (FILENAME.EXT) */
156
void file_fcb2fname(char *dst, const char *src);
157
 
430 mateuszvis 158
/* converts an ASCIIZ string into an unsigned short. returns 0 on success.
159
 * on error, result will contain all valid digits that were read until
160
 * error occurred (0 on overflow or if parsing failed immediately) */
426 mateuszvis 161
int atous(unsigned short *r, const char *s);
410 mateuszvis 162
 
415 mateuszvis 163
/* appends a backslash if path is a directory
164
 * returns the (possibly updated) length of path */
165
unsigned short path_appendbkslash_if_dir(char *path);
166
 
416 mateuszvis 167
/* get current path drive d (A=1, B=2, etc - 0 is "current drive")
168
 * returns 0 on success, doserr otherwise */
169
unsigned short curpathfordrv(char *buff, unsigned char d);
170
 
420 mateuszvis 171
/* fills a nls_patterns struct with current NLS patterns, returns 0 on success, DOS errcode otherwise */
172
unsigned short nls_getpatterns(struct nls_patterns *p);
173
 
174
/* computes a formatted date based on NLS patterns found in p
175
 * returns length of result */
176
unsigned short nls_format_date(char *s, unsigned short yr, unsigned char mo, unsigned char dy, const struct nls_patterns *p);
177
 
426 mateuszvis 178
/* computes a formatted time based on NLS patterns found in p, sc are ignored if set 0xff
420 mateuszvis 179
 * returns length of result */
426 mateuszvis 180
unsigned short nls_format_time(char *s, unsigned char ho, unsigned char mn, unsigned char sc, const struct nls_patterns *p);
420 mateuszvis 181
 
182
/* computes a formatted integer number based on NLS patterns found in p
183
 * returns length of result */
423 mateuszvis 184
unsigned short nls_format_number(char *s, unsigned long num, const struct nls_patterns *p);
420 mateuszvis 185
 
1137 mateusz.vi 186
/* capitalize an ASCIZ string following country-dependent rules */
187
void nls_strtoup(char *buff);
188
 
437 mateuszvis 189
/* reload nls ressources from svarcom.lng into langblock */
190
void nls_langreload(char *buff, unsigned short env);
191
 
571 mateuszvis 192
/* locates executable fname in path and fill res with result. returns 0 on success,
193
 * -1 on failed match and -2 on failed match + "don't even try with other paths"
194
 * extptr is filled with a ptr to the extension in fname (NULL if no extension) */
195
int lookup_cmd(char *res, const char *fname, const char *path, const char **extptr);
196
 
197
/* fills fname with the path and filename to the linkfile related to the
198
 * executable link "linkname". returns 0 on success. */
199
int link_computefname(char *fname, const char *linkname, unsigned short env_seg);
200
 
352 mateuszvis 201
#endif