sio.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:10k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: sio.h,v 1.3.36.3 2004/07/09 01:44:45 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _SIO_H_
  50. #define _SIO_H_
  51. #include "hlxclib/errno.h"
  52. #include "debug.h"
  53. #include "fio.h"
  54. class IO;
  55. class SIO
  56. {
  57. public:
  58. SIO();
  59.     virtual ~SIO() = 0;
  60.     int error();
  61.     int end_of_file();
  62.     Byte* read_alloc(int& size);
  63.     virtual Byte* read_alloc(int& size, off_t seek, int whence)=0;
  64.     Byte* read_realloc(Byte* buf, int oldsize, int& size);
  65.     int read_undo(Byte* buf, int len);
  66.     void read_free(Byte* buf);
  67.     off_t read_offset();
  68.     virtual off_t read_seek(off_t off, int whence) = 0;
  69.     virtual int read_pushback(Byte* buf, int len) = 0;
  70.     int read_count();
  71.     Byte* write_alloc(int& size);
  72.     virtual Byte* write_alloc(int& size, off_t seek, int whence)=0;
  73.     Byte* write_realloc(Byte* buf, int oldsize, int& size);
  74.     int write_undo(Byte* buf, int len);
  75.     int write_free(Byte* buf);
  76.     off_t write_offset();
  77.     virtual off_t write_seek(off_t off, int whence) = 0;
  78.     int write_flush();
  79.     int write_flush_count();
  80.     BOOL write_flush_needed();
  81.     virtual off_t file_size() = 0;
  82.     void unset_eof();
  83.     virtual char * get_pathname() { return NULL;};
  84.     virtual int get_would_block() {return 0;}
  85.     void set_delete_io(int flag) { delete_io = flag; }
  86.     struct Region
  87.     {
  88. Region* next;
  89. Region* prev;
  90. off_t off;     // offset into file
  91. off_t flush_off;  // offset into file for writing
  92. Byte* base;     // this is where data starts
  93. Byte* limit;     // this is where data ends
  94. int refcount;
  95. Region();
  96. Region(Region* link);
  97. void set_buf(Byte* b, int size, off_t offset = 0);
  98.     };
  99. protected:
  100.     struct Region_list
  101.     {
  102. off_t off; // current offset into file
  103. Byte* ptr; // ptr to data on next access
  104. Byte* end; // data ends here
  105. Region* regs; // list of regions
  106. Region* creg; // current region
  107. int eof; // 1 if end of file
  108. Region_list();
  109. ~Region_list();
  110. Region* find(Byte* buf, Region**& rp);
  111. Region* find(off_t offt, Region**& rp);
  112. Byte* remove(Region* reg);
  113.     };
  114.     IO* io; // object that does the real io
  115.     int flags;
  116.     off_t write_off; // data written up to this point
  117.     Region_list reader;
  118.     Region_list writer;
  119.     int err; // last error
  120.     int delete_io;
  121.     virtual Byte* _read_alloc(int& size) = 0;
  122.     virtual void _read_free(Byte* buf) = 0;
  123.     int _read_count();
  124.     int _read_space();
  125.     virtual Byte* _write_alloc(int& size) = 0;
  126.     virtual int _write_free(Byte* buf) = 0;
  127.     virtual int _write_flush(Region* reg) = 0;
  128.     int _write_count();
  129.     int _write_space();
  130. };
  131. inline
  132. SIO::Region::Region() {
  133.     next = 0;
  134.     prev = 0;
  135.     refcount = 0;
  136. }
  137. inline
  138. SIO::Region::Region(SIO::Region* link) {
  139.     link->next = this;
  140.     prev = link;
  141.     next = 0;
  142.     refcount = 0;
  143. }
  144. inline void
  145. SIO::Region::set_buf(Byte* b, int size, off_t offset) {
  146.     base = b;
  147.     limit = b + size;
  148.     flush_off = off = offset;
  149. }
  150. inline
  151. SIO::Region_list::Region_list() {
  152.     creg = regs = new Region;
  153.     off = 0;
  154.     eof = 0;
  155. }
  156. inline
  157. SIO::Region_list::~Region_list() {
  158.     while (regs) {
  159. Region* next = regs->next;
  160. delete regs;
  161. regs = next;
  162.         if (next) next->prev = 0;
  163.     }
  164. }
  165. inline int
  166. SIO::error() {
  167.     return err;
  168. }
  169. inline int
  170. SIO::end_of_file() {
  171.     return reader.eof;
  172. }
  173. inline
  174. SIO::SIO() {
  175.     err = 0;
  176.     write_off = 0;
  177.     delete_io = 1;
  178. }
  179. inline
  180. SIO::~SIO() {
  181. }
  182. inline int
  183. SIO::_read_count() {
  184.     return reader.end - reader.ptr;
  185. }
  186. inline int
  187. SIO::_read_space() {
  188.     return reader.creg->limit - reader.end;
  189. }
  190. inline off_t
  191. SIO::read_offset() {
  192.     return reader.creg->off + (reader.ptr - reader.creg->base);
  193. }
  194. inline Byte*
  195. SIO::read_alloc(int& size) {
  196.     if (size < 0) {
  197. DPRINTF(D_ERROR,("illegal read_alloc request %d bytesn", size));
  198. err = EINVAL;
  199. return 0;
  200.     }
  201.     Byte* p = reader.ptr + size;
  202.     if (p <= reader.end) {
  203. reader.creg->refcount++;
  204. /*
  205.  * Return the base of the region if the user requests a
  206.  * read_alloc of 0 bytes. This avoids corrupting the region
  207.  * list when the corresponding call to read_free is made
  208.  *
  209.  * NOTE: read_undo and read_realloc may NOT be performed on
  210.  *  the pointer returned
  211.  */
  212. if (size == 0)
  213.     return reader.creg->base;
  214. Byte* b = reader.ptr;
  215. reader.ptr = p;
  216. return b;
  217.     }
  218.     return _read_alloc(size);
  219. }
  220. inline Byte*
  221. SIO::read_realloc(Byte* buf, int oldsize, int& size)
  222. {
  223.     // realloc allowed only on the very last allocation
  224.     if (buf + oldsize != reader.ptr) {
  225. size = oldsize;
  226. return buf;
  227.     }
  228.     // shrink case is easy, just unread the bytes beyond size
  229.     if (size <= oldsize) {
  230. reader.ptr -= oldsize - size;
  231. reader.eof = 0;
  232. return buf;
  233.     }
  234.     // essentially do an unread and a new read_alloc
  235.     reader.ptr = buf;
  236.     reader.creg->refcount--;
  237.     return read_alloc(size);
  238. }
  239. inline void
  240. SIO::read_free(Byte* buf)
  241. {
  242.     if (!buf)
  243. return;
  244.     /*
  245.      * If buf == reader.creg->base then it may have come from a read_alloc
  246.      * of 0 bytes. We must free this pointer even if it has the same address
  247.      * as reader.end
  248.      */
  249.     if (buf == reader.creg->base || (reader.creg->base < buf && buf < reader.end))
  250.     {
  251. reader.creg->refcount--;
  252. return;
  253.     }
  254.     DPRINTF(D_ALLOC, ("freeing %pn", buf));
  255.     _read_free(buf);
  256. }
  257. /*
  258.  * read_undo is same as
  259.  * buf = read_realloc(buf, len, 0); read_free(buf);
  260.  */
  261. inline int
  262. SIO::read_undo(Byte* buf, int len)
  263. {
  264.     // can not read undo in case of any error
  265.     if (err)
  266. return -1;
  267.     if (buf + len == reader.ptr) {
  268. reader.ptr = buf;
  269. reader.creg->refcount--;
  270.     } else {
  271. DPRINTF(D_ALLOC, ("freeing %p count %dn", buf, len));
  272. _read_free(buf);
  273.     }
  274.     // XXX err may need to be cleared
  275.     reader.eof = 0;
  276.     return 0;
  277. }
  278. inline int
  279. SIO::_write_count() {
  280.     return writer.end - writer.ptr;
  281. }
  282. inline int
  283. SIO::_write_space() {
  284.     return writer.creg->limit - writer.ptr;
  285. }
  286. inline Byte*
  287. SIO::write_alloc(int& size) {
  288.     // XXX this needs to be moved to the non file case.
  289.     // sio is a generic interface and can not assume
  290.     // any specific buffering scheme.
  291.     Byte* p = writer.ptr + size;
  292.     if (p <= writer.creg->limit) {
  293. writer.creg->refcount++;
  294. /*
  295.  * Return the base of the region if the user requests a
  296.  * write_alloc of 0 bytes. This keeps write_alloc orthogonal
  297.  * with read_alloc
  298.  *
  299.  * NOTE: write_undo and write_realloc may NOT be performed on
  300.  *  the pointer returned
  301.  */
  302. if (size == 0)
  303.     return writer.creg->base;
  304. Byte* b = writer.ptr;
  305. writer.end = writer.ptr = p;
  306. return b;
  307.     }
  308.     return _write_alloc(size);
  309. }
  310. inline Byte*
  311. SIO::write_realloc(Byte* buf, int oldsize, int& size)
  312. {
  313.     // XXX this code's been disabled since 1997 so it was removed
  314.     // XXX unsupported
  315.     return 0;
  316. }
  317. inline int
  318. SIO::write_free(Byte* buf)
  319. {
  320.     //
  321.     // let the derived class decide what to do with the data
  322.     //
  323.     return _write_free(buf);
  324. }
  325. /*
  326.  * write_undo is same as
  327.  * buf = write_realloc(buf, len, 0); write_free(buf);
  328.  */
  329. inline int
  330. SIO::write_undo(Byte* buf, int len)
  331. {
  332.     // XXX this code's been disabled since 1997 so it was removed
  333.     // XXX unsupported
  334.     return -1;
  335. }
  336. inline int
  337. SIO::write_flush()
  338. {
  339.     Region* reg = writer.regs;
  340.     if (reg == writer.creg)
  341. return 0;
  342.     if (_write_flush(reg) < 0)
  343.     {
  344. if (err)
  345.     return -1;
  346. return 0;
  347.     }
  348.     writer.regs = reg->next;
  349.     if (writer.regs) writer.regs->prev = 0;
  350.     delete[] reg->base;
  351.     delete reg;
  352.     
  353.     return 0;
  354. }
  355. inline off_t
  356. SIO::write_offset() {
  357.     return writer.creg->off + (writer.ptr - writer.creg->base);
  358. }
  359. inline void
  360. SIO::unset_eof() {
  361.     reader.eof = 0;
  362. }
  363. inline int
  364. SIO::read_count() {
  365.     return _read_count();
  366. }
  367. #endif/*_SIO_H*/