home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1996 February / PCWK0296.iso / sharewar / dos / program / gs300sr1 / gs300sr1.exe / STREAM.C < prev    next >
C/C++ Source or Header  |  1994-07-31  |  14KB  |  544 lines
  1. /* Copyright (C) 1989, 1992, 1993, 1994 Aladdin Enterprises.  All rights reserved.
  2.   
  3.   This file is part of Aladdin Ghostscript.
  4.   
  5.   Aladdin Ghostscript is distributed with NO WARRANTY OF ANY KIND.  No author
  6.   or distributor accepts any responsibility for the consequences of using it,
  7.   or for whether it serves any particular purpose or works at all, unless he
  8.   or she says so in writing.  Refer to the Aladdin Ghostscript Free Public
  9.   License (the "License") for full details.
  10.   
  11.   Every copy of Aladdin Ghostscript must include a copy of the License,
  12.   normally in a plain ASCII text file named PUBLIC.  The License grants you
  13.   the right to copy, modify and redistribute Aladdin Ghostscript, but only
  14.   under certain conditions described in the License.  Among other things, the
  15.   License requires that the copyright notice and this notice be preserved on
  16.   all copies.
  17. */
  18.  
  19. /* stream.c */
  20. /* Stream package for Ghostscript interpreter */
  21. #include "stdio_.h"        /* includes std.h */
  22. #include "memory_.h"
  23. #include "gdebug.h"
  24. #include "gpcheck.h"
  25. #include "stream.h"
  26. #include "strimpl.h"
  27.  
  28. /* Forward declarations */
  29. private int sreadbuf(P2(stream *, stream_cursor_write *));
  30. private int swritebuf(P3(stream *, stream_cursor_read *, bool));
  31.  
  32. /* Forward declarations */
  33. private void stream_compact(P1(stream *));
  34.  
  35. /* Structure types for allocating streams. */
  36. private_st_stream();
  37. public_st_stream_state();    /* default */
  38. /* GC procedures */
  39. #define st ((stream *)vptr)
  40. private ENUM_PTRS_BEGIN(stream_enum_ptrs) return 0;
  41.     if ( !st->foreign )
  42.       {    ENUM_PTR(0, stream, cbuf);
  43.       }
  44.     ENUM_PTR(1, stream, strm);
  45.     ENUM_PTR(2, stream, prev);
  46.     ENUM_PTR(3, stream, next);
  47.     ENUM_PTR(4, stream, state);
  48. ENUM_PTRS_END
  49. private RELOC_PTRS_BEGIN(stream_reloc_ptrs) {
  50.     byte *cbuf_old = st->cbuf;
  51.     if ( cbuf_old != 0 && !st->foreign )
  52.     {    uint reloc;
  53.         RELOC_PTR(stream, cbuf);
  54.         reloc = cbuf_old - st->cbuf;
  55.         /* Relocate the other buffer pointers. */
  56.         st->srptr -= reloc;
  57.         st->srlimit -= reloc;        /* same as swptr */
  58.         st->swlimit -= reloc;
  59.     }
  60.     RELOC_PTR(stream, strm);
  61.     RELOC_PTR(stream, prev);
  62.     RELOC_PTR(stream, next);
  63.     RELOC_PTR(stream, state);
  64. } RELOC_PTRS_END
  65. #undef st
  66.  
  67. /* Dummy template for streams that don't have a separate state. */
  68. private const stream_template s_no_template =
  69. {    &st_stream_state, 0, 0, 1, 1, 0
  70. };
  71.  
  72. /* ------ Generic procedures ------ */
  73.  
  74. /* Allocate a stream and initialize it minimally. */
  75. stream *
  76. s_alloc(gs_memory_t *mem, client_name_t cname)
  77. {    stream *s = gs_alloc_struct(mem, stream, &st_stream, cname);
  78.     if ( s == 0 )
  79.       return 0;
  80.     s->memory = mem;
  81.     s->report_error = s_no_report_error;
  82.     return s;
  83. }
  84.  
  85. /* Allocate a stream state and initialize it minimally. */
  86. stream_state *
  87. s_alloc_state(gs_memory_t *mem, gs_memory_type_ptr_t stype,
  88.   client_name_t cname)
  89. {    stream_state *st = gs_alloc_struct(mem, stream_state, stype, cname);
  90.     if ( st == 0 )
  91.       return 0;
  92.     st->memory = mem;
  93.     st->report_error = s_no_report_error;
  94.     return st;
  95. }
  96.  
  97. /* Vacuous stream initialization */
  98. int
  99. s_no_init(stream_state *st)
  100. {    return 0;
  101. }
  102.  
  103. /* Standard stream initialization */
  104. void
  105. s_std_init(register stream *s, byte *ptr, uint len, const stream_procs *pp,
  106.   int modes)
  107. {    s->template = &s_no_template;
  108.     s->cbuf = ptr;
  109.     s->srptr = s->srlimit = s->swptr = ptr - 1;
  110.     s->swlimit = ptr - 1 + len;
  111.     s->end_status = 0;
  112.     s->foreign = 0;
  113.     s->modes = modes;
  114.     s->position = 0;
  115.     s->bsize = s->cbsize = len;
  116.     s->strm = 0;            /* not a filter */
  117.     s->procs = *pp;
  118.     s->state = 0;
  119.     s->file = 0;
  120.     if_debug4('s', "[s]init 0x%lx, buf=0x%lx, len=%u, modes=%d\n",
  121.           (ulong)s, (ulong)ptr, len, modes);
  122. }
  123.  
  124. /* Implement a stream procedure as a no-op. */
  125. int
  126. s_std_null(stream *s)
  127. {    return 0;
  128. }
  129.  
  130. /* Discard the contents of the buffer when reading. */
  131. void
  132. s_std_read_reset(stream *s)
  133. {    s->srptr = s->srlimit = s->cbuf - 1;
  134. }
  135.  
  136. /* Discard the contents of the buffer when writing. */
  137. void
  138. s_std_write_reset(stream *s)
  139. {    s->swptr = s->cbuf- 1;
  140. }
  141.  
  142. /* Flush data to end-of-file when reading. */
  143. int
  144. s_std_read_flush(stream *s)
  145. {    while ( 1 )
  146.     {    s->srptr = s->srlimit = s->cbuf - 1;
  147.         if ( s->end_status ) break;
  148.         s_process_read_buf(s);
  149.     }
  150.     return (s->end_status == EOFC ? 0 : s->end_status);
  151. }
  152.  
  153. /* Flush buffered data when writing. */
  154. int
  155. s_std_write_flush(stream *s)
  156. {    return s_process_write_buf(s, false);
  157. }
  158.  
  159. /* Indicate an error when asked for available input bytes. */
  160. int
  161. s_std_noavailable(stream *s, long *pl)
  162. {    return ERRC;
  163. }
  164.  
  165. /* Indicate an error when asked to seek. */
  166. int
  167. s_std_noseek(stream *s, long pos)
  168. {    return ERRC;
  169. }
  170.  
  171. /* Standard stream closing. */
  172. int
  173. s_std_close(stream *s)
  174. {    return 0;
  175. }
  176.  
  177. /* Standard stream finalization.  Disable the stream. */
  178. void
  179. s_disable(register stream *s)
  180. {    s->cbuf = 0;
  181.     s->bsize = 0;
  182.     s->modes = 0;
  183.     s->cursor.r.ptr = s->cursor.r.limit = 0;
  184.     s->cursor.w.limit = 0;
  185.     s->procs.close = s_std_null;
  186.     /****** SHOULD DO MORE THAN THIS ******/
  187.     if_debug1('s', "[s]disable 0x%lx\n", (ulong)s);
  188. }
  189.  
  190. /* Implement flushing for encoding filters. */
  191. int
  192. s_filter_write_flush(register stream *s)
  193. {    int status = s_process_write_buf(s, false);
  194.     if ( status != 0 )
  195.       return status;
  196.     return sflush(s->strm);
  197. }
  198.  
  199. /* Close a filter.  If this is an encoding filter, flush it first. */
  200. int
  201. s_filter_close(register stream *s)
  202. {    if ( s_is_writing(s) )
  203.     {    int status = s_process_write_buf(s, true);
  204.         if ( status != 0 && status != EOFC )
  205.           return status;
  206.     }
  207.     return s_std_close(s);
  208. }    
  209.  
  210. /* Disregard a stream error message. */
  211. int
  212. s_no_report_error(stream_state *st, const char *str)
  213. {    return 0;
  214. }
  215.  
  216. /* ------ Implementation-independent procedures ------ */
  217.  
  218. /* Store the amount of available data in a(n input) stream. */
  219. int
  220. savailable(stream *s, long *pl)
  221. {    return (*(s)->procs.available)(s, pl);
  222. }
  223.  
  224. /* Return the current position of a stream. */
  225. long
  226. stell(stream *s)
  227. {    /* The stream might have been closed, but the position */
  228.     /* is still meaningful in this case. */
  229.     const byte *ptr = (s_is_writing(s) ? s->swptr : s->srptr);
  230.     return (ptr == 0 ? 0 : ptr + 1 - s->cbuf) + s->position;
  231. }
  232.  
  233. /* Close a stream, disabling it if successful. */
  234. /* (The stream may already be closed.) */
  235. int
  236. sclose(register stream *s)
  237. {    stream_state *st;
  238.     int code = (*s->procs.close)(s);
  239.     if ( code < 0 )
  240.       return code;
  241.     st = s->state;
  242.     if ( st != 0 )
  243.       { stream_proc_release((*release)) = st->template->release;
  244.         if ( release != 0 )
  245.           (*release)(st);
  246.         if ( st != (stream_state *)s && st->memory != 0 )
  247.           gs_free_object(st->memory, st, "s_std_close");
  248.         s->state = 0;
  249.       }
  250.     s_disable(s);
  251.     return code;
  252. }
  253.  
  254. /* Implement sgetc when the buffer may be empty. */
  255. /* If the buffer really is empty, refill it and then read a byte. */
  256. int
  257. spgetc(register stream *s)
  258. {    for ( ; ; )
  259.     {    int status;
  260.         if ( !sendrp(s) )
  261.             return *++(s->srptr);
  262.         status = s->end_status;
  263.         switch ( status )
  264.         {
  265.         case EOFC:
  266.             status = sclose(s);
  267.             if ( status == 0 )
  268.                 return EOFC;
  269.             s->end_status = status;
  270.             /* falls through */
  271.         default:        /* ERRC */
  272.             return status;
  273.         case 0: ;
  274.         }
  275.         s_process_read_buf(s);
  276.     }
  277. }
  278.  
  279. /* Implementing sputc when the buffer is full, */
  280. /* by flushing the buffer and then writing the byte. */
  281. int
  282. spputc(register stream *s, byte b)
  283. {    for ( ; ; )
  284.     {    if ( s->end_status )
  285.             return s->end_status;
  286.         if ( !sendwp(s) )
  287.         {    *++(s->swptr) = b;
  288.             return b;
  289.         }
  290.         s_process_write_buf(s, false);
  291.     }
  292. }
  293.  
  294. /* Push back a character onto a (read) stream. */
  295. /* The character must be the same as the last one read. */
  296. /* Return 0 on success, ERRC on failure. */
  297. int
  298. sungetc(register stream *s, byte c)
  299. {    if ( !s_is_reading(s) || s->srptr < s->cbuf || *(s->srptr) != c )
  300.         return ERRC;
  301.     s->srptr--;
  302.     return 0;
  303. }
  304.  
  305. /* Get a string from a stream. */
  306. /* Return 0 if the string was filled, or an exception status. */
  307. int
  308. sgets(stream *s, byte *buf, uint nmax, uint *pn)
  309. {    stream_cursor_write cw;
  310.     int status = 0;
  311.     cw.ptr = buf - 1;
  312.     cw.limit = cw.ptr + nmax;
  313.     while ( cw.ptr < cw.limit )
  314.     {    if ( !sendrp(s) )
  315.             stream_move(&s->cursor.r, &cw);
  316.         else
  317.         {    uint wanted = cw.limit - cw.ptr;
  318.             int c;
  319.             stream_state *st;
  320.             if ( wanted >= s->bsize >> 2 &&
  321.                  (st = s->state) != 0 &&
  322.                  wanted >= st->template->min_out_size
  323.                )
  324.             {    status = sreadbuf(s, &cw);
  325.                 if ( status != 1 || cw.ptr == cw.limit )
  326.                     break;
  327.             }
  328.             c = spgetc(s);
  329.             if ( c < 0 )
  330.             {    status = c;
  331.                 break;
  332.             }
  333.             *++(cw.ptr) = c;
  334.         }
  335.     }
  336.     *pn = cw.ptr + 1 - buf;
  337.     return (status >= 0 ? 0 : status);
  338. }
  339.  
  340. /* Write a string on a stream. */
  341. /* Return 0 if the entire string was written, or an exception status. */
  342. int
  343. sputs(register stream *s, const byte *str, uint wlen, uint *pn)
  344. {    uint len = wlen;
  345.     int status = s->end_status;
  346.     if ( status >= 0 )
  347.       while ( len > 0 )
  348.     {    uint count = s->swlimit - s->swptr;
  349.         if ( count > 0 )
  350.         {    if ( count > len ) count = len;
  351.             memcpy(s->swptr + 1, str, count);
  352.             s->swptr += count;
  353.             str += count;
  354.             len -= count;
  355.         }
  356.         else
  357.         {    byte ch = *str++;
  358.             status = sputc(s, ch);
  359.             if ( status < 0 )
  360.                 break;
  361.             len--;
  362.         }
  363.     }
  364.     *pn = wlen - len;
  365.     return (status >= 0 ? 0 : status);
  366. }
  367.  
  368. /* Skip a specified distance in a read stream. */
  369. /* Return 0, EOFC, or ERRC. */
  370. int
  371. spskip(register stream *s, long n)
  372. {    if ( n < 0 || !s_is_reading(s) ) return ERRC;
  373.     if ( s_can_seek(s) )
  374.         return sseek(s, stell(s) + n);
  375.     while ( sbufavailable(s) < n )
  376.     {    int code;
  377.         n -= sbufavailable(s) + 1;
  378.         s->srptr = s->srlimit;
  379.         if ( s->end_status )
  380.             return s->end_status;
  381.         code = sgetc(s);
  382.         if ( code < 0 )
  383.             return code;
  384.     }
  385.     s->srptr += n;
  386.     return 0;
  387. }    
  388.  
  389. /* ------ Utilities ------ */
  390.  
  391. /* Implement the old read_buf procedure in terms of the new */
  392. /* process procedure. */
  393. int
  394. s_process_read_buf(stream *s)
  395. {    int status;
  396.     stream_compact(s);
  397.     status = sreadbuf(s, &s->cursor.w);
  398.     s->end_status = (status >= 0 ? 0 : status);
  399.     return 0;
  400. }
  401.  
  402. /* Implement the old write_buf procedure in terms of the new */
  403. /* process procedure. */
  404. int
  405. s_process_write_buf(stream *s, bool last)
  406. {    int status;
  407.     status = swritebuf(s, &s->cursor.r, last);
  408.     stream_compact(s);
  409.     if ( status >= 0 )
  410.       status = 0;
  411.     s->end_status = status;
  412.     return status;
  413. }
  414.  
  415. /* Move forward or backward in a pipeline.  We temporarily reverse */
  416. /* the direction of the pointers while doing this. */
  417. /* (Cf the Deutsch-Schorr-Waite graph marking algorithm.) */
  418. #define move_back(curr, prev)\
  419. { stream *back = prev->strm;\
  420.   prev->strm = curr; curr = prev; prev = back;\
  421. }
  422. #define move_ahead(curr, prev)\
  423. { stream *ahead = curr->strm;\
  424.   curr->strm = prev; prev = curr; curr = ahead;\
  425. }
  426.  
  427. /* Read from a pipeline. */
  428. private int
  429. sreadbuf(stream *s, stream_cursor_write *pbuf)
  430. {    stream *prev = 0;
  431.     stream *curr = s;
  432.     int status;
  433.     for ( ; ; )
  434.     {    for ( ; ; )
  435.         {    /* Descend into the recursion. */
  436.             stream *strm = curr->strm;
  437.             stream_cursor_read cr;
  438.             stream_cursor_read *pr;
  439.             stream_cursor_write *pw;
  440.             bool eof;
  441.             if ( strm == 0 )
  442.                 cr.ptr = 0, cr.limit = 0, pr = &cr,
  443.                 eof = false;
  444.             else
  445.                 pr = &strm->cursor.r,
  446.                 eof = strm->end_status == EOFC;
  447.             pw = (prev == 0 ? pbuf : &curr->cursor.w);
  448.             status = (*curr->procs.process)(curr->state, pr, pw, eof);
  449.             if ( strm == 0 || status != 0 )
  450.                 break;
  451.             status = strm->end_status;
  452.             if ( status < 0 )
  453.                 break;
  454.             move_ahead(curr, prev);
  455.             stream_compact(curr);
  456.         }
  457.         /* Unwind from the recursion. */
  458.         curr->end_status = (status >= 0 ? 0 : status);
  459.         if ( prev == 0 )
  460.             return status;
  461.         move_back(curr, prev);
  462.     }
  463. }
  464.  
  465. /* Write to a pipeline. */
  466. private int
  467. swritebuf(stream *s, stream_cursor_read *pbuf, bool last)
  468. {    stream *prev = 0;
  469.     stream *curr = s;
  470.     int status;
  471.     for ( ; ; )
  472.     {    for ( ; ; )
  473.         {    /* Descend into the recursion. */
  474.             stream *strm = curr->strm;
  475.             stream_cursor_write cw;
  476.             stream_cursor_read *pr;
  477.             stream_cursor_write *pw;
  478.             bool end;
  479.             if ( strm == 0 )
  480.                 cw.ptr = 0, cw.limit = 0, pw = &cw;
  481.             else
  482.                 pw = &strm->cursor.w;
  483.             if ( prev == 0 )
  484.               pr = pbuf, end = last;
  485.             else
  486.               pr = &curr->cursor.r;
  487.             status = (*curr->procs.process)(curr->state, pr, pw,
  488.                             end);
  489.             if ( strm == 0 || status < 0 )
  490.                 break;
  491.             if ( status == 1 )
  492.                 end = false;
  493.             else
  494.             {    /* Keep going if we are closing */
  495.                 /* a filter with a sub-stream. */
  496.                 /* We know status == 0. */
  497.                 if ( !end || !curr->strm_is_temp )
  498.                     break;
  499.             }
  500.             status = strm->end_status;
  501.             if ( status < 0 )
  502.                 break;
  503.             move_ahead(curr, prev);
  504.             stream_compact(curr);
  505.         }
  506.         /* Unwind from the recursion. */
  507.         curr->end_status = (status >= 0 ? 0 : status);
  508.         if ( prev == 0 )
  509.             return status;
  510.         move_back(curr, prev);
  511.     }
  512. }
  513.  
  514. /* Move as much data as possible from one buffer to another. */
  515. /* Return 0 if the input became empty, 1 if the output became full. */
  516. int
  517. stream_move(stream_cursor_read *pr, stream_cursor_write *pw)
  518. {    uint rcount = pr->limit - pr->ptr;
  519.     uint wcount = pw->limit - pw->ptr;
  520.     uint count;
  521.     int status;
  522.     if ( rcount <= wcount )
  523.         count = rcount, status = 0;
  524.     else
  525.         count = wcount, status = 1;
  526.     memmove(pw->ptr + 1, pr->ptr + 1, count);
  527.     pr->ptr += count;
  528.     pw->ptr += count;
  529.     return status;
  530. }
  531.  
  532. /* If possible, compact the information in a stream buffer to the bottom. */
  533. private void
  534. stream_compact(stream *s)
  535. {    if ( s->cursor.r.ptr >= s->cbuf )
  536.     {    uint dist = s->cursor.r.ptr + 1 - s->cbuf;
  537.         memmove(s->cbuf, s->cursor.r.ptr + 1,
  538.             (uint)(s->cursor.r.limit - s->cursor.r.ptr));
  539.         s->cursor.r.ptr = s->cbuf - 1;
  540.         s->cursor.r.limit -= dist;        /* same as w.ptr */
  541.         s->position += dist;
  542.     }
  543. }
  544.