src/gallium/auxiliary/util/u_stream.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * Cross-platform sequential access stream abstraction.
  31  */
  32
  33 #ifndef U_STREAM_H
  34 #define U_STREAM_H
  35
  36
  37 #include "pipe/p_compiler.h"
  38
  39
  40 struct util_stream;
  41
  42
  43 /**
  44  * Create a stream
  45  * @param filename relative or absolute path (necessary for windows)
  46  * @param optional maximum file size (0 for a growable size).
  47  */
  48 struct util_stream *
  49 util_stream_create(const char *filename, size_t max_size);
  50
  51 boolean
  52 util_stream_write(struct util_stream *stream, const void *data, size_t size);
  53
  54 void
  55 util_stream_flush(struct util_stream *stream);
  56
  57 void
  58 util_stream_close(struct util_stream *stream);
  59
  60
  61 #endif /* U_STREAM_H */