src/gallium/auxiliary/os/os_stream.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008-2010 VMware, Inc.
   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 VMWARE 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 _OS_STREAM_H_
  34 #define _OS_STREAM_H_
  35
  36
  37 #include "pipe/p_compiler.h"
  38
  39
  40 /**
  41  * OS stream (FILE, socket, etc) abstraction.
  42  */
  43 struct os_stream
  44 {
  45    void
  46    (*close)(struct os_stream *stream);
  47
  48    boolean
  49    (*write)(struct os_stream *stream, const void *data, size_t size);
  50
  51    void
  52    (*flush)(struct os_stream *stream);
  53 };
  54
  55
  56 static INLINE void
  57 os_stream_close(struct os_stream *stream)
  58 {
  59    if (!stream)
  60       return;
  61
  62    stream->close(stream);
  63 }
  64
  65
  66 static INLINE boolean
  67 os_stream_write(struct os_stream *stream, const void *data, size_t size)
  68 {
  69    if (!stream)
  70       return FALSE;
  71    return stream->write(stream, data, size);
  72 }
  73
  74
  75 static INLINE boolean
  76 os_stream_write_str(struct os_stream *stream, const char *str)
  77 {
  78    size_t size;
  79    if (!stream)
  80       return FALSE;
  81    for(size = 0; str[size]; ++size)
  82       ;
  83    return stream->write(stream, str, size);
  84 }
  85
  86
  87 static INLINE void
  88 os_stream_flush(struct os_stream *stream)
  89 {
  90    stream->flush(stream);
  91 }
  92
  93
  94 struct os_stream *
  95 os_file_stream_create(const char *filename);
  96
  97
  98 struct os_stream *
  99 os_null_stream_create(void);
 100
 101
 102 extern struct os_stream *
 103 os_log_stream;
 104
 105
 106 struct os_stream *
 107 os_str_stream_create(size_t initial_size);
 108
 109
 110 const char *
 111 os_str_stream_get(struct os_stream *stream);
 112
 113 char *
 114 os_str_stream_get_and_close(struct os_stream *stream);
 115
 116
 117 #if defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
 118 #define os_file_stream_create(_filename) os_null_stream_create()
 119 #endif
 120
 121
 122 #endif /* _OS_STREAM_H_ */