]>
cygwin.com Git - cygwin-apps/setup.git/blob - io_stream.h
2 * Copyright (c) 2001, Robert Collins.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * A copy of the GNU General Public License can be found at
12 * Written by Robert Collins <rbtcollins@hotmail.com>
16 #ifndef SETUP_IO_STREAM_H
17 #define SETUP_IO_STREAM_H
19 /* this is the parent class for all IO operations. It's flexable enough to be cover for
20 * HTTP access, local file access, and files being extracted from archives.
21 * It also encapsulates the idea of an archive, and all non-archives become the special
27 class IOStreamProvider
;
29 /* Some things don't fit cleanly just - TODO
30 * make mkdir_p fit in the hierarchy
33 //Where is this defined?
34 #if defined(_WIN32) && ! defined(__CYGWIN__)
35 typedef signed long ssize_t
;
39 #define _ATTR_(foo) __attribute__ foo
69 IO_SEEK_SET
= SEEK_SET
,
70 IO_SEEK_END
= SEEK_END
,
71 IO_SEEK_CUR
= SEEK_CUR
78 /* Register a new io_stream provider */
79 static void registerProvider (IOStreamProvider
&, String
const &urlscheme
);
80 /* create a new stream from an existing one - used to get
83 * will return NULL if there is no sub-stream available (ie (peek()
84 * didn't match any known magic number) && nextfilename () = NULL
86 static io_stream
*factory (io_stream
*);
87 /* open a stream by url. The particular stream type returned
88 * will depend on the url passed.
89 * ie for file:// it will be a disk file.
90 * for ftp:// it will perform an upload to a ftp site.
91 * the second parameter - mode can specify r|w && t|b. Other flags are not currently
93 * Automatic decompression does not occur. Compressed files will return a io_stream
94 * from archive::decompress. This behaviour is by design - to allow deliberate access
95 * to the compressed data.
96 * To create a stream that will be compressed, you should open the url, and then get a new stream
97 * from archive::compress.
98 * If a stream is opened for reading, and it's an archive, the next_file_name method
99 * will return non-NULL. To access the files within the archive use io_stream::factory
100 * to create a new stream that will read from the archive.
102 static io_stream
*open (String
const &, String
const &);
103 static int remove (String
const &);
104 static int exists (String
const &);
105 /* moves physical stream source to dest. A copy will be attempted if a
106 * pointer flip fails.
108 static int move (String
const &, String
const &);
109 /* ensure that we have access to the entire path */
110 /* Create a directory, and any needed parent directories.
111 * returns 1 on failure.
113 static int mkpath_p (path_type_t
, String
const &);
114 /* link from, to, type. Returns 1 on failure */
115 static int mklink (String
const &, String
const &, io_stream_link_t
);
116 /* copy from stream to stream - 0 on success */
117 static ssize_t
copy (io_stream
*, io_stream
*);
118 /* TODO: we may need two versions of each of these:
119 1 for external use - when the path is known
120 1 for inline use, for example to set the mtime of a file being written
123 /* set the modification time of a file - returns 1 on failure
124 * may distrupt internal state - use after all important io is complete
126 virtual int set_mtime (int) = 0;
127 /* get the mtime for a file TODO make this a stat(0 style call */
128 virtual int get_mtime () = 0;
129 /* How long is the file? 0 means check error(). if error() is 0, the file
130 * is 0 bytes long. Otherwise the file length cannot be determined
132 virtual size_t get_size () = 0;
133 /* read data (duh!) */
134 virtual ssize_t
read (void *buffer
, size_t len
) = 0;
135 /* provide data to (double duh!) */
136 virtual ssize_t
write (const void *buffer
, size_t len
) = 0;
137 /* read data without removing it from the class's internal buffer */
138 virtual ssize_t
peek (void *buffer
, size_t len
) = 0;
139 /* ever read the f* functions from libc ? */
140 virtual long tell () = 0;
141 virtual int seek (long, io_stream_seek_t
) = 0;
142 /* try guessing this one */
143 virtual int error () = 0;
144 /* hmm, yet another for the guessing books */
145 virtual char *gets (char *, size_t len
);
146 /* what sort of stream is this?
148 * IO_STREAM_INVALID - not a valid stream.
149 * IO_STREAM_STREAM - just another stream.
150 * IO_STREAM_COMPRESS - a compressed or compressing stream.
151 * IO_STREAM_ARCHIVE - an archive of some sort, with > 0 files.
152 * this is a crutch for real runtime type evaluation.
154 /* Find out the next stream name -
155 * ie for foo.tar.gz, at offset 0, next_file_name = foo.tar
156 * for foobar that is an archive, next_file_name is the next
157 * extractable filename.
159 // virtual const char* next_file_name() = NULL;
160 /* if you are still needing these hints... give up now! */
161 virtual ~ io_stream () = 0;
163 io_stream
& operator << (io_stream
&);
166 void operator= (const io_stream
&);
167 io_stream () : destroyed (0)
170 io_stream (const io_stream
&);
171 unsigned int destroyed
;
173 static int move_copy (String
const &, String
const &);
176 #endif /* SETUP_IO_STREAM_H */
This page took 0.03889 seconds and 5 git commands to generate.