Subversion Repositories SvarDOS

Rev

Rev 530 | Rev 542 | 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
 *
4
 * Copyright (C) 2021 Mateusz Viste
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 */
445 mateuszvis 41
void nls_output_internal(unsigned short id, unsigned char nl);
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)
437 mateuszvis 48
#define nls_output(x,y) nls_output_internal((x << 8) | y, 0)
49
#define nls_outputnl(x,y) nls_output_internal((x << 8) | y, 1)
369 mateuszvis 50
 
538 mateuszvis 51
/* output DOS error e to stderr */
52
void nls_outputnl_doserr(unsigned short e);
53
 
388 mateuszvis 54
/*
55
 * FileInfoRec (DTA) format:
56
 * offset size desc
57
 *    +0   21  reserved
58
 *  +15h    1  file attr (1=RO 2=Hidden 4=System 8=VOL 16=DIR 32=Archive
59
 *  +16h    2  time: bits 0-4=bi-seconds (0-30), bits 5-10=minutes (0-59), bits 11-15=hour (0-23)
60
 *  +18h    2  date: bits 0-4=day(0-31), bits 5-8=month (1-12), bits 9-15=years since 1980
61
 *  +1ah    4  DWORD file size, in bytes
62
 *  +1eh   13  13-bytes max ASCIIZ filename
63
 */
64
_Packed struct DTA {
65
  char reserved[21];
66
  unsigned char attr;
420 mateuszvis 67
  unsigned short time_sec2:5;
68
  unsigned short time_min:6;
69
  unsigned short time_hour:5;
70
  unsigned short date_dy:5;
71
  unsigned short date_mo:4;
72
  unsigned short date_yr:7;
388 mateuszvis 73
  unsigned long size;
74
  char fname[13];
75
};
76
 
420 mateuszvis 77
 
78
/* this is also known as the "Country Info Block" or "CountryInfoRec":
79
 * offset size desc
80
 *   +0      2   wDateFormat  0=USA (m d y), 1=Europe (d m y), 2=Japan (y m d)
81
 *   +2      5  szCrncySymb  currency symbol (ASCIIZ)
82
 *   +7      2  szThouSep    thousands separator (ASCIIZ)
83
 *   +9      2  szDecSep     decimal separator (ASCIIZ)
84
 * +0bH      2  szDateSep    date separator (ASCIIZ)
85
 * +0dH      2  szTimeSep    time separator (ASCIIZ)
86
 * +0fH      1  bCrncyFlags  currency format flags
87
 * +10H      1  bCrncyDigits decimals digits in currency
88
 * +11H      1  bTimeFormat  time format 0=12h 1=24h
89
 * +12H      4  pfCasemap    Casemap FAR call address
90
 * +16H      2  szDataSep    data list separator (ASCIIZ)
91
 * +18H     10  res          reserved zeros
92
 *          34               total length
93
 */
94
_Packed struct nls_patterns {
95
  unsigned short dateformat;
96
  char currency[5];
97
  char thousep[2];
98
  char decsep[2];
99
  char datesep[2];
100
  char timesep[2];
101
  unsigned char currflags;
102
  unsigned char currdigits;
103
  unsigned char timefmt;
104
  void far *casemapfn;
105
  char datalistsep[2];
106
  char reserved[10];
107
};
108
 
109
 
389 mateuszvis 110
#define DOS_ATTR_RO   1
111
#define DOS_ATTR_HID  2
112
#define DOS_ATTR_SYS  4
113
#define DOS_ATTR_VOL  8
114
#define DOS_ATTR_DIR 16
115
#define DOS_ATTR_ARC 32
116
 
388 mateuszvis 117
/* find first matching files using a FindFirst DOS call
406 mateuszvis 118
 * attr contains DOS attributes that files MUST have (ie attr=0 will match all
119
 * files)
388 mateuszvis 120
 * returns 0 on success or a DOS err code on failure */
121
unsigned short findfirst(struct DTA *dta, const char *pattern, unsigned short attr);
122
 
123
/* find next matching, ie. continues an action intiated by findfirst() */
124
unsigned short findnext(struct DTA *dta);
125
 
392 mateuszvis 126
/* print s string and wait for a single key press from stdin. accepts only
127
 * key presses defined in the c ASCIIZ string. returns offset of pressed key
128
 * in string. keys in c MUST BE UPPERCASE! */
129
unsigned short askchoice(const char *s, const char *c);
130
 
399 mateuszvis 131
/* converts a path to its canonic representation, returns 0 on success
132
 * or DOS err on failure (invalid drive) */
133
unsigned short file_truename(const char *src, char *dst);
392 mateuszvis 134
 
135
/* returns DOS attributes of file, or -1 on error */
136
int file_getattr(const char *fname);
137
 
396 mateuszvis 138
/* returns screen's width (in columns) */
139
unsigned short screen_getwidth(void);
140
 
141
/* returns screen's height (in rows) */
142
unsigned short screen_getheight(void);
143
 
144
/* displays the "Press any key to continue" msg and waits for a keypress */
145
void press_any_key(void);
146
 
399 mateuszvis 147
/* validate a drive (A=0, B=1, etc). returns 1 if valid, 0 otherwise */
148
int isdrivevalid(unsigned char drv);
149
 
406 mateuszvis 150
/* converts a filename into FCB format (FILENAMEEXT) */
151
void file_fname2fcb(char *dst, const char *src);
152
 
153
/* converts a FCB filename (FILENAMEEXT) into normal format (FILENAME.EXT) */
154
void file_fcb2fname(char *dst, const char *src);
155
 
430 mateuszvis 156
/* converts an ASCIIZ string into an unsigned short. returns 0 on success.
157
 * on error, result will contain all valid digits that were read until
158
 * error occurred (0 on overflow or if parsing failed immediately) */
426 mateuszvis 159
int atous(unsigned short *r, const char *s);
410 mateuszvis 160
 
415 mateuszvis 161
/* appends a backslash if path is a directory
162
 * returns the (possibly updated) length of path */
163
unsigned short path_appendbkslash_if_dir(char *path);
164
 
416 mateuszvis 165
/* get current path drive d (A=1, B=2, etc - 0 is "current drive")
166
 * returns 0 on success, doserr otherwise */
167
unsigned short curpathfordrv(char *buff, unsigned char d);
168
 
420 mateuszvis 169
/* fills a nls_patterns struct with current NLS patterns, returns 0 on success, DOS errcode otherwise */
170
unsigned short nls_getpatterns(struct nls_patterns *p);
171
 
172
/* computes a formatted date based on NLS patterns found in p
173
 * returns length of result */
174
unsigned short nls_format_date(char *s, unsigned short yr, unsigned char mo, unsigned char dy, const struct nls_patterns *p);
175
 
426 mateuszvis 176
/* computes a formatted time based on NLS patterns found in p, sc are ignored if set 0xff
420 mateuszvis 177
 * returns length of result */
426 mateuszvis 178
unsigned short nls_format_time(char *s, unsigned char ho, unsigned char mn, unsigned char sc, const struct nls_patterns *p);
420 mateuszvis 179
 
180
/* computes a formatted integer number based on NLS patterns found in p
181
 * returns length of result */
423 mateuszvis 182
unsigned short nls_format_number(char *s, unsigned long num, const struct nls_patterns *p);
420 mateuszvis 183
 
437 mateuszvis 184
/* reload nls ressources from svarcom.lng into langblock */
185
void nls_langreload(char *buff, unsigned short env);
186
 
352 mateuszvis 187
#endif