/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */ /* camel-stream.c : abstract class for a stream */ /* * Author: * Bertrand Guiheneuf * * Copyright 1999, 2000 Ximian, Inc. (www.ximian.com) * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ #ifdef HAVE_CONFIG_H #include #endif #include #include "camel-stream.h" static CamelObjectClass *parent_class = NULL; /* Returns the class for a CamelStream */ #define CS_CLASS(so) CAMEL_STREAM_CLASS(CAMEL_OBJECT_GET_CLASS(so)) /* default implementations, do very little */ static ssize_t stream_read (CamelStream *stream, char *buffer, size_t n) { return 0; } static ssize_t stream_write (CamelStream *stream, const char *buffer, size_t n) { return n; } static int stream_close (CamelStream *stream) { return 0; } static int stream_flush (CamelStream *stream) { return 0; } static gboolean stream_eos (CamelStream *stream) { return stream->eos; } static int stream_reset (CamelStream *stream) { return 0; } static void camel_stream_class_init (CamelStreamClass *camel_stream_class) { parent_class = camel_type_get_global_classfuncs( CAMEL_OBJECT_TYPE ); /* virtual method definition */ camel_stream_class->read = stream_read; camel_stream_class->write = stream_write; camel_stream_class->close = stream_close; camel_stream_class->flush = stream_flush; camel_stream_class->eos = stream_eos; camel_stream_class->reset = stream_reset; } CamelType camel_stream_get_type (void) { static CamelType camel_stream_type = CAMEL_INVALID_TYPE; if (camel_stream_type == CAMEL_INVALID_TYPE) { camel_stream_type = camel_type_register( CAMEL_OBJECT_TYPE, "CamelStream", sizeof( CamelStream ), sizeof( CamelStreamClass ), (CamelObjectClassInitFunc) camel_stream_class_init, NULL, NULL, NULL ); } return camel_stream_type; } /** * camel_stream_read: * @stream: a CamelStream. * @buffer: buffer where bytes pulled from the stream are stored. * @n: max number of bytes to read. * * Read at most @n bytes from the @stream object and stores them * in the buffer pointed at by @buffer. * * Return value: number of bytes actually read, or -1 on error and * set errno. **/ ssize_t camel_stream_read (CamelStream *stream, char *buffer, size_t n) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); g_return_val_if_fail (n == 0 || buffer, -1); return CS_CLASS (stream)->read (stream, buffer, n); } /** * camel_stream_write: * @stream: a CamelStream object. * @buffer: buffer to write. * @n: number of bytes to write * * Write @n bytes from the buffer pointed at by @buffer into @stream. * * Return value: the number of bytes actually written to the stream, * or -1 on error. **/ ssize_t camel_stream_write (CamelStream *stream, const char *buffer, size_t n) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); g_return_val_if_fail (n == 0 || buffer, -1); return CS_CLASS (stream)->write (stream, buffer, n); } /** * camel_stream_flush: * @stream: a CamelStream object * * Flushes the contents of the stream to its backing store. Only meaningful * on writable streams. * * Return value: -1 on error. **/ int camel_stream_flush (CamelStream *stream) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); return CS_CLASS (stream)->flush (stream); } /** * camel_stream_close: * @stream: * * Close a stream. * * Return value: -1 on error. **/ int camel_stream_close (CamelStream *stream) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); return CS_CLASS (stream)->close (stream); } /** * camel_stream_eos: * @stream: a CamelStream object * * Test if there are bytes left to read on the @stream object. * * Return value: %TRUE if all the contents on the stream has been read, or * %FALSE if information is still available. **/ gboolean camel_stream_eos (CamelStream *stream) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), TRUE); return CS_CLASS (stream)->eos (stream); } /** * camel_stream_reset: reset a stream * @stream: the stream object * * Reset a stream. That is, put it in a state where it can be read * from the beginning again. Not all streams in Camel are seekable, * but they must all be resettable. * * Return value: -1 on error. **/ int camel_stream_reset (CamelStream *stream) { g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); return CS_CLASS (stream)->reset (stream); } /***************** Utility functions ********************/ /** * camel_stream_write_string: * @stream: a stream object * @string: a string * * Writes the string to the stream. * * Return value: the number of characters output, -1 on error. **/ ssize_t camel_stream_write_string (CamelStream *stream, const char *string) { return camel_stream_write (stream, string, strlen (string)); } /** * camel_stream_printf: * @stream: a stream object * @fmt: a printf-style format string * * This printfs the given data to @stream. * * Return value: the number of characters output, -1 on error. **/ ssize_t camel_stream_printf (CamelStream *stream, const char *fmt, ... ) { va_list args; char *string; ssize_t ret; g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); va_start (args, fmt); string = g_strdup_vprintf (fmt, args); va_end (args); if (!string) return -1; ret = camel_stream_write (stream, string, strlen (string)); g_free (string); return ret; } /** * camel_stream_write_to_stream: * @stream: Source CamelStream. * @output_stream: Destination CamelStream. * * Write all of a stream (until eos) into another stream, in a blocking * fashion. * * Return value: Returns -1 on error, or the number of bytes succesfully * copied across streams. **/ ssize_t camel_stream_write_to_stream (CamelStream *stream, CamelStream *output_stream) { char tmp_buf[4096]; ssize_t total = 0; ssize_t nb_read; ssize_t nb_written; g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1); g_return_val_if_fail (CAMEL_IS_STREAM (output_stream), -1); while (!camel_stream_eos (stream)) { nb_read = camel_stream_read (stream, tmp_buf, sizeof (tmp_buf)); if (nb_read < 0) return -1; else if (nb_read > 0) { nb_written = 0; while (nb_written < nb_read) { ssize_t len = camel_stream_write (output_stream, tmp_buf + nb_written, nb_read - nb_written); if (len < 0) return -1; nb_written += len; } total += nb_written; } } return total; } te_Holidays_Slovenia?id=4869d3ad1ea005405d74b8e1bb87bcda0d22058c&showmsg=1'>Expand)AuthorAgeFilesLines * Add NO_STAGE all over the place in preparation for the staging support (cat: ...bapt2013-09-211-5/+1 * At the moment 1385 ports use BUILD_DEPENDS= ${RUN_DEPENDS} and 450eadler2012-01-221-1/+1 * -remove MD5ohauer2011-07-031-1/+0 * - Pass maintainership to miwitabthorpe2009-03-251-1/+1 * - Update to 0.1.2tabthorpe2008-10-143-6/+9 * - Update to 0.1.1tabthorpe2008-09-033-6/+6 1'>121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396