home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / recio213.zip / recio.h < prev    next >
C/C++ Source or Header  |  1995-09-05  |  13KB  |  334 lines
  1. /****************************************************************************
  2.    MODULE: recio.h
  3.   PURPOSE: record input/output header file included in application
  4. COPYRIGHT: (C) 1994-1995, William Pierpoint
  5.   VERSION: 2.13
  6.   RELEASE: September 4, 1995
  7. *****************************************************************************/
  8.  
  9. #ifndef RECIO_H
  10. #define RECIO_H
  11.  
  12. /* include FILE and size_t types */
  13. #ifndef EOF
  14. #include <stdio.h>
  15. #endif
  16.  
  17. /* include struct tm and time_t types */
  18. #ifndef CLOCKS_PER_SEC
  19. #include <time.h>
  20. #endif
  21.  
  22. /* define SIZE_T_MAX */
  23. #ifndef SIZE_T_MAX
  24. #define SIZE_T_MAX (~(size_t)0)
  25. #endif
  26.  
  27. /* structure of REC abstract data type */
  28. typedef struct {
  29.         int      r_fd;       /* descriptor */
  30.         unsigned r_flags;    /* status flags */
  31.         FILE    *r_fp;       /* file pointer */
  32.   const char    *r_fname;    /* pointer to name of file */
  33.         long     r_recno;    /* record number */
  34.         unsigned r_fldno;    /* field number */
  35.         size_t   r_colno;    /* column number */
  36.         size_t   r_recsiz;   /* size of record buffer */
  37.         size_t   r_reclen;   /* length of record buffer */
  38.         char    *r_recp;     /* pointer to record buffer */
  39.         size_t   r_fldsiz;   /* size of field buffer */
  40.         char    *r_fldp;     /* pointer to field buffer */
  41.         int      r_fldch;    /* field separator character */
  42.         int      r_txtch;    /* text delimiter character */
  43.   const char    *r_tmfmt;    /* pointer to time format string */
  44.         int      r_cxtno;    /* context number */
  45. } REC;
  46.  
  47. /* structure of rpos_t abstract data type */
  48. typedef struct {
  49.         int      r_fd;       /* descriptor */
  50.         unsigned r_fldno;    /* field number  */
  51.         size_t   r_colno;    /* column number */
  52.         long     r_recno;    /* record number */
  53. } rpos_t;
  54.  
  55. /* constant expression macros */
  56. #define RECBUFSIZ   80       /* minimum size of record buffer */
  57. #define FLDBUFSIZ   20       /* minimum size of field buffer */
  58. #define RECFLDCH   ' '       /* record field separator character */
  59. #define RECTXTCH   ' '       /* text delimiter character */
  60. #define RECBEGYR  1951       /* year time format %y begins */
  61.  
  62. #define ROPEN_MAX   12       /* max no of rec streams open at same time */
  63. #define R_READ       0       /* read mode */
  64. #define R_WRITE      1       /* write/append mode */
  65.  
  66. /* compiler dependencies */
  67. #if defined (__BORLANDC__)
  68. #define NSBUFSIZ    34       /* string buffer sized for ltoa, dtoa, etc */
  69.  
  70. #ifndef TIME_T_MIN
  71. #define TIME_T_MIN  ((time_t)0)
  72. #endif
  73.  
  74. #ifndef TIME_T_MAX
  75. #ifndef LONG_MAX
  76. #include <limits.h>
  77. #endif
  78. #define TIME_T_MAX  ((time_t)LONG_MAX)
  79. #endif
  80.  
  81. #else
  82. #error For this compiler, you need to set:
  83. #error (1) NSBUFSIZ.  See DESIGN.TXT section 3.6.
  84. #error (2) TIME_T_MIN & TIME_T_MAX.  See DESIGN.TXT section 3.5.
  85. #endif
  86. extern char _r_nsbuf[NSBUFSIZ]; /* numeric to string conversion buffer */
  87.  
  88. /* enumerate errors */
  89. enum {
  90.     R_EDOM=1,                /* argument outside domain */
  91.     R_EINVAL,                /* invalid argument value */
  92.     R_EINVDAT,               /* invalid data */
  93.     R_EINVMOD,               /* invalid read or write mode */
  94.     R_EMISDAT,               /* missing data */
  95.     R_ENOMEM,                /* could not allocate memory */
  96.     R_ENOPUT,                /* failed put to stream */
  97.     R_ERANGE,                /* data out of range */
  98.     R_EFAULT                 /* unknown error */
  99. };
  100.  
  101. /* enumerate warnings */
  102. enum {
  103.     R_WEMPSTR=1,             /* data string empty */
  104.     R_WNOREG,                /* unable to register function (atexit full) */
  105.     R_WWIDTH,                /* column width too small for data */
  106.     R_WTMFMT,                /* date/time data incomplete */
  107.     R_WFAULT                 /* unknown warning */
  108. };
  109.  
  110. /* define static record streams */
  111. extern REC *recin;           /* recin  record pointer */
  112. extern REC *recout;          /* recout record pointer */
  113. extern REC *recerr;          /* recerr record pointer */
  114. extern REC *recprn;          /* recprn record pointer */
  115.  
  116. #define RECIN       -1       /* recin  context number */
  117. #define RECOUT      -2       /* recout context number */
  118. #define RECERR      -3       /* recerr context number */
  119. #define RECPRN      -4       /* recprn context number */
  120.  
  121. /* record status flags definitions */
  122. #define _R_COL       1       /* beginning column flag (bit 0) */
  123. #define _R_WRT       2       /* read/write stream flag (bit 1) */
  124. #define _R_TXT       4       /* current field text char indicator (bit 2) */
  125. #define _R_EOF     128       /* end-of-file indicator (bit 7) */
  126. #define _R_ERR     256       /* error indicator (bits 8-11) */
  127. #define _R_WRN    4096       /* warning indicator (bits 12-15) */
  128.  
  129. #define _R_ERRMAX   15       /* maximum error number */
  130. #define _R_WRNMAX   15       /* maximum warning number */
  131.  
  132. /* functions implemented as macros */
  133. #define rskipfld(rp)     (rskipnfld((rp), 1))
  134. #define rresetrec(rp)    (rsetrecstr((rp), rrecs(rp)))
  135. #define rnames(rp)       ((rp)->r_fname)
  136. #define rrecs(rp)        ((rp)->r_recp)
  137. #define rflds(rp)        ((rp)->r_fldp)
  138. #define rrecno(rp)       ((rp)->r_recno)
  139. #define rfldno(rp)       ((rp)->r_fldno)
  140. #define rcolno(rp)       ((rp)->r_colno + rbegcolno(rp))
  141. #define rcxtno(rp)       ((rp)->r_cxtno)
  142. #define rbegcolno(rp)    ((rp)->r_flags & _R_COL)
  143. #define ristxtfld(rp)    ((rp)->r_flags & _R_TXT)
  144. #define reof(rp)         ((rp)->r_flags & _R_EOF)
  145.  
  146. #define rgetfldpos(rp, pos)  (_rgetfldpos((rp), &(pos)))
  147. #define rsetfldpos(rp, pos)  (_rsetfldpos((rp), &(pos)))
  148.  
  149. #define rgeti(rp)        (rbgeti( (rp), 10))
  150. #define rgetl(rp)        (rbgetl( (rp), 10))
  151. #define rgetui(rp)       (rbgetui((rp), 10))
  152. #define rgetul(rp)       (rbgetul((rp), 10))
  153.  
  154. #define rcgeti(rp, begcol, endcol)  (rcbgeti( (rp), (begcol), (endcol), 10))
  155. #define rcgetl(rp, begcol, endcol)  (rcbgetl( (rp), (begcol), (endcol), 10))
  156. #define rcgetui(rp, begcol, endcol) (rcbgetui((rp), (begcol), (endcol), 10))
  157. #define rcgetul(rp, begcol, endcol) (rcbgetul((rp), (begcol), (endcol), 10))
  158.  
  159. #define rputi(rp, num)   (rbputi( (rp), 10, (num)))
  160. #define rputl(rp, num)   (rbputl( (rp), 10, (num)))
  161. #define rputui(rp, num)  (rbputui((rp), 10, (num)))
  162. #define rputul(rp, num)  (rbputul((rp), 10, (num)))
  163.  
  164. #define rcputi(rp, begcol, endcol, num)  (rcbputi( (rp), (begcol), (endcol), 10, (num)))
  165. #define rcputl(rp, begcol, endcol, num)  (rcbputl( (rp), (begcol), (endcol), 10, (num)))
  166. #define rcputui(rp, begcol, endcol, num) (rcbputui((rp), (begcol), (endcol), 10, (num)))
  167. #define rcputul(rp, begcol, endcol, num) (rcbputul((rp), (begcol), (endcol), 10, (num)))
  168.  
  169. #define strimbegs(str)           (scntrimbegs((str), ' ', SIZE_T_MAX))
  170. #define strimends(str)           (scntrimends((str), ' ', SIZE_T_MAX))
  171. #define strims(str)              (scntrims((str), ' ', SIZE_T_MAX))
  172. #define sctrimbegs(str, ch)      (scntrimbegs((str), (ch), SIZE_T_MAX))
  173. #define sctrimends(str, ch)      (scntrimends((str), (ch), SIZE_T_MAX))
  174. #define sctrims(str, ch)         (scntrims((str), (ch), SIZE_T_MAX))
  175. #define scpys(dst, src)          (_scpys(&(dst), (src)))
  176. #define scats(dst, src)          (_scats(&(dst), (src)))
  177.  
  178. #ifdef __cplusplus
  179. extern "C" {
  180. #endif
  181.  
  182. /* function prototypes */
  183. /* source: recio.c */
  184. extern void  rclose(REC *rp);
  185. extern int   rcloseall(void);
  186. extern int   risvalid(REC *rp);
  187. extern REC  *ropen(const char *filename, const char *mode);
  188. extern void  rsetbegcolno(REC *rp, int colno);
  189. extern void  rsetcxtno(REC *rp, int cxtno);
  190. extern void  rsetfldch(REC *rp, int ch);
  191. extern void  rsettmfmt(REC *rp, const char *fmt);
  192. extern void  rsettxtch(REC *rp, int ch);
  193.  
  194. /* source: rerr.c */
  195. extern void  rclearerr(REC *rp);
  196. extern int   rerror(REC *rp);
  197. extern char *rerrstr(REC *rp);
  198. extern int   rseterr(REC *rp, int errnum);
  199. extern void  rseterrfn(void(*rerrfn)(REC *rp));
  200. extern char *rstrerror(int errnum);
  201. extern void  rinit(void(*rerrfn)(REC *rp), void(*rwarnfn)(REC *rp));
  202.  
  203. /* source: remsg.c */
  204. extern void rerrmsg(REC *rp);
  205.  
  206. /* source: rwarn.c */
  207. extern void  rclearwarn(REC *rp);
  208. extern int   rwarning(REC *rp);
  209. extern char *rwarnstr(REC *rp);
  210. extern int   rsetwarn(REC *rp, int warnum);
  211. extern void  rsetwarnfn(void(*rwarnfn)(REC *rp));
  212. extern char *rstrwarning(int warnum);
  213.  
  214. /* source: rwmsg.c */
  215. extern void rwarnmsg(REC *rp);
  216.  
  217. /* source: rget.c */
  218. extern char    *rgetrec(REC *rp);
  219. extern void     _rgetfldpos(REC *rp, rpos_t *pos);
  220. extern void     _rsetfldpos(REC *rp, const rpos_t *pos);
  221. extern void     rsetfldsiz(REC *rp, size_t fldsize);
  222. extern void     rsetfldstr(REC *rp, const char *s);
  223. extern void     rsetrecsiz(REC *rp, size_t recsize);
  224. extern void     rsetrecstr(REC *rp, const char *s);
  225. extern unsigned rskipnfld(REC *rp, unsigned num);
  226. extern unsigned rnumfld(REC *rp);
  227.  
  228. /* source: rgetf.c */
  229. extern float  rgetf(REC *rp);
  230. extern double rgetd(REC *rp);
  231.  
  232. /* source: rgets.c */
  233. extern int    rgetc(REC *rp);
  234. extern char  *rgets(REC *rp);
  235.  
  236. /* source: rgett.c */
  237. extern time_t    rgett(REC *rp);
  238. extern struct tm rgettm(REC *rp);
  239. extern time_t    sftotime(const char *s, const char *fmt);
  240. extern struct tm sftotm(const char *s, const char *fmt);
  241. extern time_t    tmtotime(struct tm);
  242. extern struct tm timetotm(time_t);
  243. extern void      rsetbegyr(int year);
  244.  
  245. /* source: rbget.c */
  246. extern int           rbgeti( REC *rp, int base);
  247. extern unsigned int  rbgetui(REC *rp, int base);
  248. extern long          rbgetl( REC *rp, int base);
  249. extern unsigned long rbgetul(REC *rp, int base);
  250.  
  251. /* source: rcgetf.c */
  252. extern float  rcgetf(REC *rp, size_t begcol, size_t endcol);
  253. extern double rcgetd(REC *rp, size_t begcol, size_t endcol);
  254.  
  255. /* source: rcgets.c */
  256. extern int    rcgetc(REC *rp, size_t col);
  257. extern char  *rcgets(REC *rp, size_t begcol, size_t endcol);
  258.  
  259. /* source: rcgett.c */
  260. extern time_t    rcgett(REC *rp, size_t begcol, size_t endcol);
  261. extern struct tm rcgettm(REC *rp, size_t begcol, size_t endcol);
  262.  
  263. /* source: rcbget.c */
  264. extern int           rcbgeti( REC *rp, size_t begcol, size_t endcol, int base);
  265. extern unsigned int  rcbgetui(REC *rp, size_t begcol, size_t endcol, int base);
  266. extern long          rcbgetl( REC *rp, size_t begcol, size_t endcol, int base);
  267. extern unsigned long rcbgetul(REC *rp, size_t begcol, size_t endcol, int base);
  268.  
  269. /* source: rput.c */
  270. extern void rputrec(REC *rp);
  271.  
  272. /* source: rputf.c */
  273. extern void rputf(REC *rp, float f);
  274. extern void rputd(REC *rp, double d);
  275.  
  276. /* source: rputs.c */
  277. extern void rputc(REC *rp, int ch);
  278. extern void rputs(REC *rp, const char *str);
  279.  
  280. /* source: rputt.c */
  281. extern void rputt(REC *rp, time_t time);
  282. extern void rputtm(REC *rp, struct tm t);
  283.  
  284. /* source: rbput.c */
  285. extern void rbputi(REC *rp, int base, int i);
  286. extern void rbputui(REC *rp, int base, unsigned int ui);
  287. extern void rbputl(REC *rp, int base, long l);
  288. extern void rbputul(REC *rp, int base, unsigned long ul);
  289.  
  290. /* source: rcputs.c */
  291. extern void rcputc(REC *rp, size_t col, int ch);
  292. extern void rcputs(REC *rp, size_t begcol, size_t endcol, const char *str);
  293.  
  294. /* source: rcputf.c */
  295. extern void rcputf(REC *rp, size_t begcol, size_t endcol, float f);
  296. extern void rcputd(REC *rp, size_t begcol, size_t endcol, double d);
  297.  
  298. /* source: rcputt.c */
  299. extern void rcputt(REC *rp, size_t begcol, size_t endcol, time_t time);
  300. extern void rcputtm(REC *rp, size_t begcol, size_t endcol, struct tm t);
  301.  
  302. /* source: rcbput.c */
  303. extern void rcbputi(REC *rp, size_t begcol, size_t endcol, int base, int i);
  304. extern void rcbputui(REC *rp, size_t begcol, size_t endcol, int base, unsigned int ui);
  305. extern void rcbputl(REC *rp, size_t begcol, size_t endcol, int base, long l);
  306. extern void rcbputul(REC *rp, size_t begcol, size_t endcol, int base, unsigned long ul);
  307.  
  308. /* source: rfix.c */
  309. extern void rbfixi( REC *rp, int base);
  310. extern void rbfixui(REC *rp, int base);
  311. extern void rbfixl( REC *rp, int base);
  312. extern void rbfixul(REC *rp, int base);
  313. extern void rfixc(REC *rp);
  314. extern void rfixf(REC *rp);
  315. extern void rfixd(REC *rp);
  316. extern void rfixi(REC *rp);
  317. extern void rfixl(REC *rp);
  318. extern void rfixt(REC *rp);
  319. extern void rfixui(REC *rp);
  320. extern void rfixul(REC *rp);
  321.  
  322. /* source: rstr.c */
  323. extern char *scntrimbegs(char *str, int ch, size_t num);
  324. extern char *scntrimends(char *str, int ch, size_t num);
  325. extern char *scntrims(char *str, int ch, size_t num);
  326. extern char *_scpys(char **dst, const char *src);
  327. extern char *_scats(char **dst, const char *src);
  328.  
  329. #ifdef  __cplusplus
  330. }
  331. #endif
  332.  
  333. #endif
  334.