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    int
  55    (*vprintf)(struct os_stream *stream, const char* format, va_list ap);
  56 };
  57
  58
  59 static INLINE void
  60 os_stream_close(struct os_stream *stream)
  61 {
  62    if (!stream)
  63       return;
  64
  65    stream->close(stream);
  66 }
  67
  68
  69 static INLINE boolean
  70 os_stream_write(struct os_stream *stream, const void *data, size_t size)
  71 {
  72    if (!stream)
  73       return FALSE;
  74    return stream->write(stream, data, size);
  75 }
  76
  77
  78 static INLINE boolean
  79 os_stream_write_str(struct os_stream *stream, const char *str)
  80 {
  81    size_t size;
  82    if (!stream)
  83       return FALSE;
  84    for(size = 0; str[size]; ++size)
  85       ;
  86    return stream->write(stream, str, size);
  87 }
  88
  89
  90 static INLINE void
  91 os_stream_flush(struct os_stream *stream)
  92 {
  93    stream->flush(stream);
  94 }
  95
  96 int
  97 os_default_stream_vprintf (struct os_stream* stream, const char *format, va_list ap);
  98
  99 static INLINE int
 100 os_stream_vprintf (struct os_stream* stream, const char *format, va_list ap)
 101 {
 102    return stream->vprintf(stream, format, ap);
 103 }
 104
 105 static INLINE int
 106 os_stream_printf (struct os_stream* stream, const char *format, ...)
 107 {
 108    int retval;
 109    va_list args;
 110
 111    va_start (args, format);
 112    retval = stream->vprintf(stream, format, args);
 113    va_end (args);
 114
 115    return retval;
 116 }
 117
 118 struct os_stream *
 119 os_file_stream_create(const char *filename);
 120
 121
 122 struct os_stream *
 123 os_null_stream_create(void);
 124
 125
 126 extern struct os_stream *
 127 os_log_stream;
 128
 129
 130 struct os_stream *
 131 os_str_stream_create(size_t initial_size);
 132
 133
 134 const char *
 135 os_str_stream_get(struct os_stream *stream);
 136
 137 char *
 138 os_str_stream_get_and_close(struct os_stream *stream);
 139
 140
 141 #if defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
 142 #define os_file_stream_create(_filename) os_null_stream_create()
 143 #endif
 144
 145 #endif /* _OS_STREAM_H_ */