reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 1 | /* |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 2 | * Copyright 2006 The Android Open Source Project |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 3 | * |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 6 | */ |
| 7 | |
| 8 | #ifndef SkStream_DEFINED |
| 9 | #define SkStream_DEFINED |
| 10 | |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 11 | #include "SkData.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 12 | #include "SkRefCnt.h" |
| 13 | #include "SkScalar.h" |
| 14 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 15 | class SkStream; |
| 16 | class SkStreamRewindable; |
| 17 | class SkStreamSeekable; |
| 18 | class SkStreamAsset; |
| 19 | class SkStreamMemory; |
| 20 | |
reed@google.com | 3b34505 | 2013-05-07 15:59:16 +0000 | [diff] [blame] | 21 | /** |
| 22 | * SkStream -- abstraction for a source of bytes. Subclasses can be backed by |
| 23 | * memory, or a file, or something else. |
| 24 | * |
| 25 | * NOTE: |
| 26 | * |
| 27 | * Classic "streams" APIs are sort of async, in that on a request for N |
| 28 | * bytes, they may return fewer than N bytes on a given call, in which case |
| 29 | * the caller can "try again" to get more bytes, eventually (modulo an error) |
| 30 | * receiving their total N bytes. |
skia.committer@gmail.com | 2b34fe0 | 2013-05-08 07:01:40 +0000 | [diff] [blame] | 31 | * |
reed@google.com | 3b34505 | 2013-05-07 15:59:16 +0000 | [diff] [blame] | 32 | * Skia streams behave differently. They are effectively synchronous, and will |
| 33 | * always return all N bytes of the request if possible. If they return fewer |
| 34 | * (the read() call returns the number of bytes read) then that means there is |
| 35 | * no more data (at EOF or hit an error). The caller should *not* call again |
| 36 | * in hopes of fulfilling more of the request. |
| 37 | */ |
scroggo | a1193e4 | 2015-01-21 12:09:53 -0800 | [diff] [blame] | 38 | class SK_API SkStream : public SkNoncopyable { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 39 | public: |
scroggo | a1193e4 | 2015-01-21 12:09:53 -0800 | [diff] [blame] | 40 | virtual ~SkStream() {} |
| 41 | |
| 42 | /** |
reed@google.com | e1575aa | 2013-03-18 21:08:46 +0000 | [diff] [blame] | 43 | * Attempts to open the specified file, and return a stream to it (using |
scroggo | a1193e4 | 2015-01-21 12:09:53 -0800 | [diff] [blame] | 44 | * mmap if available). On success, the caller is responsible for deleting. |
| 45 | * On failure, returns NULL. |
reed@google.com | e1575aa | 2013-03-18 21:08:46 +0000 | [diff] [blame] | 46 | */ |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 47 | static SkStreamAsset* NewFromFile(const char path[]); |
skia.committer@gmail.com | 8eaddb0 | 2013-03-19 07:15:10 +0000 | [diff] [blame] | 48 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 49 | /** Reads or skips size number of bytes. |
| 50 | * If buffer == NULL, skip size bytes, return how many were skipped. |
| 51 | * If buffer != NULL, copy size bytes into buffer, return how many were copied. |
| 52 | * @param buffer when NULL skip size bytes, otherwise copy size bytes into buffer |
| 53 | * @param size the number of bytes to skip or copy |
bungeman@google.com | 88682b7 | 2013-07-19 13:55:41 +0000 | [diff] [blame] | 54 | * @return the number of bytes actually read. |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 55 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 56 | virtual size_t read(void* buffer, size_t size) = 0; |
| 57 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 58 | /** Skip size number of bytes. |
| 59 | * @return the actual number bytes that could be skipped. |
| 60 | */ |
| 61 | size_t skip(size_t size) { |
bungeman@google.com | 0430692 | 2013-11-13 19:53:46 +0000 | [diff] [blame] | 62 | return this->read(NULL, size); |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 63 | } |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 64 | |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 65 | /** |
| 66 | * Attempt to peek at size bytes. |
scroggo | d61c384 | 2015-12-07 11:37:13 -0800 | [diff] [blame] | 67 | * If this stream supports peeking, copy min(size, peekable bytes) into |
| 68 | * buffer, and return the number of bytes copied. |
| 69 | * If the stream does not support peeking, or cannot peek any bytes, |
| 70 | * return 0 and leave buffer unchanged. |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 71 | * The stream is guaranteed to be in the same visible state after this |
| 72 | * call, regardless of success or failure. |
scroggo | d61c384 | 2015-12-07 11:37:13 -0800 | [diff] [blame] | 73 | * @param buffer Must not be NULL, and must be at least size bytes. Destination |
| 74 | * to copy bytes. |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 75 | * @param size Number of bytes to copy. |
scroggo | d61c384 | 2015-12-07 11:37:13 -0800 | [diff] [blame] | 76 | * @return The number of bytes peeked/copied. |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 77 | */ |
scroggo | d61c384 | 2015-12-07 11:37:13 -0800 | [diff] [blame] | 78 | virtual size_t peek(void* /*buffer*/, size_t /*size*/) const { return 0; } |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 79 | |
bungeman@google.com | 88682b7 | 2013-07-19 13:55:41 +0000 | [diff] [blame] | 80 | /** Returns true when all the bytes in the stream have been read. |
| 81 | * This may return true early (when there are no more bytes to be read) |
| 82 | * or late (after the first unsuccessful read). |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 83 | */ |
bungeman@google.com | 0430692 | 2013-11-13 19:53:46 +0000 | [diff] [blame] | 84 | virtual bool isAtEnd() const = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 85 | |
| 86 | int8_t readS8(); |
| 87 | int16_t readS16(); |
| 88 | int32_t readS32(); |
| 89 | |
| 90 | uint8_t readU8() { return (uint8_t)this->readS8(); } |
| 91 | uint16_t readU16() { return (uint16_t)this->readS16(); } |
| 92 | uint32_t readU32() { return (uint32_t)this->readS32(); } |
| 93 | |
| 94 | bool readBool() { return this->readU8() != 0; } |
| 95 | SkScalar readScalar(); |
| 96 | size_t readPackedUInt(); |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 97 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 98 | //SkStreamRewindable |
scroggo@google.com | 4d213ab | 2013-08-28 13:08:54 +0000 | [diff] [blame] | 99 | /** Rewinds to the beginning of the stream. Returns true if the stream is known |
| 100 | * to be at the beginning after this call returns. |
| 101 | */ |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 102 | virtual bool rewind() { return false; } |
| 103 | |
| 104 | /** Duplicates this stream. If this cannot be done, returns NULL. |
| 105 | * The returned stream will be positioned at the beginning of its data. |
| 106 | */ |
| 107 | virtual SkStreamRewindable* duplicate() const { return NULL; } |
| 108 | |
| 109 | //SkStreamSeekable |
| 110 | /** Returns true if this stream can report it's current position. */ |
| 111 | virtual bool hasPosition() const { return false; } |
| 112 | /** Returns the current position in the stream. If this cannot be done, returns 0. */ |
| 113 | virtual size_t getPosition() const { return 0; } |
| 114 | |
| 115 | /** Seeks to an absolute position in the stream. If this cannot be done, returns false. |
| 116 | * If an attempt is made to seek past the end of the stream, the position will be set |
| 117 | * to the end of the stream. |
| 118 | */ |
djsollen | c87dd2c | 2014-11-14 11:11:46 -0800 | [diff] [blame] | 119 | virtual bool seek(size_t /*position*/) { return false; } |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 120 | |
| 121 | /** Seeks to an relative offset in the stream. If this cannot be done, returns false. |
| 122 | * If an attempt is made to move to a position outside the stream, the position will be set |
| 123 | * to the closest point within the stream (beginning or end). |
| 124 | */ |
djsollen | c87dd2c | 2014-11-14 11:11:46 -0800 | [diff] [blame] | 125 | virtual bool move(long /*offset*/) { return false; } |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 126 | |
| 127 | /** Duplicates this stream. If this cannot be done, returns NULL. |
| 128 | * The returned stream will be positioned the same as this stream. |
| 129 | */ |
| 130 | virtual SkStreamSeekable* fork() const { return NULL; } |
| 131 | |
| 132 | //SkStreamAsset |
| 133 | /** Returns true if this stream can report it's total length. */ |
| 134 | virtual bool hasLength() const { return false; } |
| 135 | /** Returns the total length of the stream. If this cannot be done, returns 0. */ |
bungeman@google.com | 0430692 | 2013-11-13 19:53:46 +0000 | [diff] [blame] | 136 | virtual size_t getLength() const { return 0; } |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 137 | |
| 138 | //SkStreamMemory |
| 139 | /** Returns the starting address for the data. If this cannot be done, returns NULL. */ |
| 140 | //TODO: replace with virtual const SkData* getData() |
| 141 | virtual const void* getMemoryBase() { return NULL; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 142 | }; |
| 143 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 144 | /** SkStreamRewindable is a SkStream for which rewind and duplicate are required. */ |
| 145 | class SK_API SkStreamRewindable : public SkStream { |
| 146 | public: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 147 | bool rewind() override = 0; |
| 148 | SkStreamRewindable* duplicate() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 149 | }; |
| 150 | |
| 151 | /** SkStreamSeekable is a SkStreamRewindable for which position, seek, move, and fork are required. */ |
| 152 | class SK_API SkStreamSeekable : public SkStreamRewindable { |
| 153 | public: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 154 | SkStreamSeekable* duplicate() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 155 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 156 | bool hasPosition() const override { return true; } |
| 157 | size_t getPosition() const override = 0; |
| 158 | bool seek(size_t position) override = 0; |
| 159 | bool move(long offset) override = 0; |
| 160 | SkStreamSeekable* fork() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 161 | }; |
| 162 | |
| 163 | /** SkStreamAsset is a SkStreamSeekable for which getLength is required. */ |
| 164 | class SK_API SkStreamAsset : public SkStreamSeekable { |
| 165 | public: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 166 | SkStreamAsset* duplicate() const override = 0; |
| 167 | SkStreamAsset* fork() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 168 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 169 | bool hasLength() const override { return true; } |
| 170 | size_t getLength() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 171 | }; |
| 172 | |
| 173 | /** SkStreamMemory is a SkStreamAsset for which getMemoryBase is required. */ |
| 174 | class SK_API SkStreamMemory : public SkStreamAsset { |
| 175 | public: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 176 | SkStreamMemory* duplicate() const override = 0; |
| 177 | SkStreamMemory* fork() const override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 178 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 179 | const void* getMemoryBase() override = 0; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 180 | }; |
| 181 | |
ctguil@chromium.org | dfc5ffe | 2011-03-30 20:14:49 +0000 | [diff] [blame] | 182 | class SK_API SkWStream : SkNoncopyable { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 183 | public: |
| 184 | virtual ~SkWStream(); |
| 185 | |
| 186 | /** Called to write bytes to a SkWStream. Returns true on success |
| 187 | @param buffer the address of at least size bytes to be written to the stream |
| 188 | @param size The number of bytes in buffer to write to the stream |
| 189 | @return true on success |
| 190 | */ |
| 191 | virtual bool write(const void* buffer, size_t size) = 0; |
| 192 | virtual void newline(); |
| 193 | virtual void flush(); |
| 194 | |
commit-bot@chromium.org | 490fb6b | 2014-03-06 17:16:26 +0000 | [diff] [blame] | 195 | virtual size_t bytesWritten() const = 0; |
| 196 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 197 | // helpers |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 198 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 199 | bool write8(U8CPU); |
| 200 | bool write16(U16CPU); |
| 201 | bool write32(uint32_t); |
| 202 | |
halcanary | cbc060a | 2016-04-11 19:41:48 -0700 | [diff] [blame^] | 203 | bool writeText(const char text[]) { |
| 204 | SkASSERT(text); |
| 205 | return this->write(text, strlen(text)); |
| 206 | } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 207 | bool writeDecAsText(int32_t); |
vandebo@chromium.org | d877fdb | 2010-10-12 23:08:13 +0000 | [diff] [blame] | 208 | bool writeBigDecAsText(int64_t, int minDigits = 0); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 209 | bool writeHexAsText(uint32_t, int minDigits = 0); |
| 210 | bool writeScalarAsText(SkScalar); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 211 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 212 | bool writeBool(bool v) { return this->write8(v); } |
| 213 | bool writeScalar(SkScalar); |
| 214 | bool writePackedUInt(size_t); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 215 | |
commit-bot@chromium.org | dcb8e54 | 2014-03-05 18:25:20 +0000 | [diff] [blame] | 216 | bool writeStream(SkStream* input, size_t length); |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 217 | |
epoger@google.com | 8e3fb2d | 2013-03-20 15:56:03 +0000 | [diff] [blame] | 218 | /** |
commit-bot@chromium.org | dcb8e54 | 2014-03-05 18:25:20 +0000 | [diff] [blame] | 219 | * This returns the number of bytes in the stream required to store |
| 220 | * 'value'. |
| 221 | */ |
| 222 | static int SizeOfPackedUInt(size_t value); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 223 | }; |
| 224 | |
| 225 | //////////////////////////////////////////////////////////////////////////////////////// |
| 226 | |
| 227 | #include "SkString.h" |
bungeman@google.com | fab44db | 2013-10-11 18:50:45 +0000 | [diff] [blame] | 228 | #include <stdio.h> |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 229 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 230 | /** A stream that wraps a C FILE* file stream. */ |
| 231 | class SK_API SkFILEStream : public SkStreamAsset { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 232 | public: |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 233 | /** Initialize the stream by calling sk_fopen on the specified path. |
| 234 | * This internal stream will be closed in the destructor. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 235 | */ |
| 236 | explicit SkFILEStream(const char path[] = NULL); |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 237 | |
| 238 | enum Ownership { |
| 239 | kCallerPasses_Ownership, |
| 240 | kCallerRetains_Ownership |
| 241 | }; |
| 242 | /** Initialize the stream with an existing C file stream. |
| 243 | * While this stream exists, it assumes exclusive access to the C file stream. |
| 244 | * The C file stream will be closed in the destructor unless the caller specifies |
| 245 | * kCallerRetains_Ownership. |
| 246 | */ |
| 247 | explicit SkFILEStream(FILE* file, Ownership ownership = kCallerPasses_Ownership); |
| 248 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 249 | virtual ~SkFILEStream(); |
| 250 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 251 | /** Returns true if the current path could be opened. */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 252 | bool isValid() const { return fFILE != NULL; } |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 253 | |
| 254 | /** Close the current file, and open a new file with the specified path. |
| 255 | * If path is NULL, just close the current file. |
| 256 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 257 | void setPath(const char path[]); |
| 258 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 259 | size_t read(void* buffer, size_t size) override; |
| 260 | bool isAtEnd() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 261 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 262 | bool rewind() override; |
| 263 | SkStreamAsset* duplicate() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 264 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 265 | size_t getPosition() const override; |
| 266 | bool seek(size_t position) override; |
| 267 | bool move(long offset) override; |
| 268 | SkStreamAsset* fork() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 269 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 270 | size_t getLength() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 271 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 272 | const void* getMemoryBase() override; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 273 | |
| 274 | private: |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 275 | FILE* fFILE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 276 | SkString fName; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 277 | Ownership fOwnership; |
| 278 | // fData is lazilly initialized when needed. |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 279 | mutable sk_sp<SkData> fData; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 280 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 281 | typedef SkStreamAsset INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 282 | }; |
| 283 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 284 | class SK_API SkMemoryStream : public SkStreamMemory { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 285 | public: |
| 286 | SkMemoryStream(); |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 287 | |
| 288 | /** We allocate (and free) the memory. Write to it via getMemoryBase() */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 289 | SkMemoryStream(size_t length); |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 290 | |
| 291 | /** If copyData is true, the stream makes a private copy of the data. */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 292 | SkMemoryStream(const void* data, size_t length, bool copyData = false); |
scroggo@google.com | e490420 | 2013-01-09 22:02:58 +0000 | [diff] [blame] | 293 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 294 | /** Use the specified data as the memory for this stream. |
| 295 | * The stream will call ref() on the data (assuming it is not NULL). |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 296 | * DEPRECATED |
scroggo@google.com | e490420 | 2013-01-09 22:02:58 +0000 | [diff] [blame] | 297 | */ |
| 298 | SkMemoryStream(SkData*); |
| 299 | |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 300 | /** Creates the stream to read from the specified data */ |
| 301 | SkMemoryStream(sk_sp<SkData>); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 302 | |
| 303 | /** Resets the stream to the specified data and length, |
| 304 | just like the constructor. |
| 305 | if copyData is true, the stream makes a private copy of the data |
| 306 | */ |
| 307 | virtual void setMemory(const void* data, size_t length, |
| 308 | bool copyData = false); |
djsollen@google.com | 57f4969 | 2011-02-23 20:46:31 +0000 | [diff] [blame] | 309 | /** Replace any memory buffer with the specified buffer. The caller |
| 310 | must have allocated data with sk_malloc or sk_realloc, since it |
| 311 | will be freed with sk_free. |
| 312 | */ |
| 313 | void setMemoryOwned(const void* data, size_t length); |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 314 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 315 | /** Return the stream's data in a SkData. |
| 316 | * The caller must call unref() when it is finished using the data. |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 317 | */ |
| 318 | SkData* copyToData() const; |
| 319 | |
| 320 | /** |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 321 | * Use the specified data as the memory for this stream. |
| 322 | * The stream will call ref() on the data (assuming it is not NULL). |
| 323 | * The function returns the data parameter as a convenience. |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 324 | */ |
| 325 | SkData* setData(SkData*); |
| 326 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 327 | void skipToAlign4(); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 328 | const void* getAtPos(); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 329 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 330 | size_t read(void* buffer, size_t size) override; |
| 331 | bool isAtEnd() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 332 | |
scroggo | d61c384 | 2015-12-07 11:37:13 -0800 | [diff] [blame] | 333 | size_t peek(void* buffer, size_t size) const override; |
scroggo | 028a413 | 2015-04-02 13:19:51 -0700 | [diff] [blame] | 334 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 335 | bool rewind() override; |
| 336 | SkMemoryStream* duplicate() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 337 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 338 | size_t getPosition() const override; |
| 339 | bool seek(size_t position) override; |
| 340 | bool move(long offset) override; |
| 341 | SkMemoryStream* fork() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 342 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 343 | size_t getLength() const override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 344 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 345 | const void* getMemoryBase() override; |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 346 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 347 | private: |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 348 | sk_sp<SkData> fData; |
| 349 | size_t fOffset; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 350 | |
bungeman@google.com | 6cab1a4 | 2013-05-29 13:43:31 +0000 | [diff] [blame] | 351 | typedef SkStreamMemory INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 352 | }; |
| 353 | |
| 354 | ///////////////////////////////////////////////////////////////////////////////////////////// |
| 355 | |
alokp@chromium.org | f7751ae | 2012-07-17 19:10:36 +0000 | [diff] [blame] | 356 | class SK_API SkFILEWStream : public SkWStream { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 357 | public: |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 358 | SkFILEWStream(const char path[]); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 359 | virtual ~SkFILEWStream(); |
| 360 | |
| 361 | /** Returns true if the current path could be opened. |
| 362 | */ |
| 363 | bool isValid() const { return fFILE != NULL; } |
| 364 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 365 | bool write(const void* buffer, size_t size) override; |
| 366 | void flush() override; |
caryclark | 7471fa4 | 2015-12-16 13:41:23 -0800 | [diff] [blame] | 367 | void fsync(); |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 368 | size_t bytesWritten() const override; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 369 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 370 | private: |
halcanary | d76be9c | 2015-11-20 13:47:49 -0800 | [diff] [blame] | 371 | FILE* fFILE; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 372 | |
| 373 | typedef SkWStream INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 374 | }; |
| 375 | |
caryclark | 15e2a53 | 2016-03-16 06:51:55 -0700 | [diff] [blame] | 376 | class SK_API SkMemoryWStream : public SkWStream { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 377 | public: |
| 378 | SkMemoryWStream(void* buffer, size_t size); |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 379 | bool write(const void* buffer, size_t size) override; |
| 380 | size_t bytesWritten() const override { return fBytesWritten; } |
junov@chromium.org | 1cc8f6f | 2012-02-22 21:00:42 +0000 | [diff] [blame] | 381 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 382 | private: |
| 383 | char* fBuffer; |
| 384 | size_t fMaxLength; |
| 385 | size_t fBytesWritten; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 386 | |
| 387 | typedef SkWStream INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 388 | }; |
| 389 | |
ctguil@chromium.org | dfc5ffe | 2011-03-30 20:14:49 +0000 | [diff] [blame] | 390 | class SK_API SkDynamicMemoryWStream : public SkWStream { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 391 | public: |
| 392 | SkDynamicMemoryWStream(); |
| 393 | virtual ~SkDynamicMemoryWStream(); |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 394 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 395 | bool write(const void* buffer, size_t size) override; |
| 396 | size_t bytesWritten() const override { return fBytesWritten; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 397 | // random access write |
| 398 | // modifies stream and returns true if offset + size is less than or equal to getOffset() |
| 399 | bool write(const void* buffer, size_t offset, size_t size); |
| 400 | bool read(void* buffer, size_t offset, size_t size); |
vandebo@chromium.org | a518086 | 2010-10-26 19:48:49 +0000 | [diff] [blame] | 401 | size_t getOffset() const { return fBytesWritten; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 402 | |
| 403 | // copy what has been written to the stream into dst |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 404 | void copyTo(void* dst) const; |
halcanary | 7af2150 | 2015-02-23 12:17:59 -0800 | [diff] [blame] | 405 | void writeToStream(SkWStream* dst) const; |
reed@google.com | 70442a6 | 2011-06-23 21:48:04 +0000 | [diff] [blame] | 406 | |
| 407 | /** |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 408 | * Return a copy of the data written so far. This call is responsible for |
| 409 | * calling unref() when they are finished with the data. |
reed@google.com | 70442a6 | 2011-06-23 21:48:04 +0000 | [diff] [blame] | 410 | */ |
reed@google.com | 8d0b577 | 2011-06-24 13:07:31 +0000 | [diff] [blame] | 411 | SkData* copyToData() const; |
reed@google.com | 70442a6 | 2011-06-23 21:48:04 +0000 | [diff] [blame] | 412 | |
bungeman@google.com | 88682b7 | 2013-07-19 13:55:41 +0000 | [diff] [blame] | 413 | /** Reset, returning a reader stream with the current content. */ |
bungeman@google.com | c29f3d8 | 2013-07-19 22:32:11 +0000 | [diff] [blame] | 414 | SkStreamAsset* detachAsStream(); |
bungeman@google.com | 88682b7 | 2013-07-19 13:55:41 +0000 | [diff] [blame] | 415 | |
| 416 | /** Reset the stream to its original, empty, state. */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 417 | void reset(); |
| 418 | void padToAlign4(); |
| 419 | private: |
| 420 | struct Block; |
| 421 | Block* fHead; |
| 422 | Block* fTail; |
| 423 | size_t fBytesWritten; |
reed | fde0511 | 2016-03-11 13:02:28 -0800 | [diff] [blame] | 424 | mutable sk_sp<SkData> fCopy; // is invalidated if we write after it is created |
reed@google.com | 8a85d0c | 2011-06-24 19:12:12 +0000 | [diff] [blame] | 425 | |
| 426 | void invalidateCopy(); |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 427 | |
bungeman@google.com | 88682b7 | 2013-07-19 13:55:41 +0000 | [diff] [blame] | 428 | // For access to the Block type. |
| 429 | friend class SkBlockMemoryStream; |
| 430 | friend class SkBlockMemoryRefCnt; |
| 431 | |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 432 | typedef SkWStream INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 433 | }; |
| 434 | |
| 435 | |
reed@google.com | a718c5e | 2013-03-05 17:49:10 +0000 | [diff] [blame] | 436 | class SK_API SkDebugWStream : public SkWStream { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 437 | public: |
commit-bot@chromium.org | 490fb6b | 2014-03-06 17:16:26 +0000 | [diff] [blame] | 438 | SkDebugWStream() : fBytesWritten(0) {} |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 439 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 440 | // overrides |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 441 | bool write(const void* buffer, size_t size) override; |
| 442 | void newline() override; |
| 443 | size_t bytesWritten() const override { return fBytesWritten; } |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 444 | |
| 445 | private: |
commit-bot@chromium.org | 490fb6b | 2014-03-06 17:16:26 +0000 | [diff] [blame] | 446 | size_t fBytesWritten; |
reed@google.com | 3b42998 | 2012-06-26 15:30:08 +0000 | [diff] [blame] | 447 | typedef SkWStream INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 448 | }; |
| 449 | |
| 450 | // for now |
| 451 | typedef SkFILEStream SkURLStream; |
| 452 | |
| 453 | #endif |