Cleanup: misc spelling fixes
[blender.git] / source / blender / imbuf / intern / dds / Stream.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup imbdds
19  */
20
21 /* simple memory stream functions with buffer overflow check */
22
23 #ifndef __STREAM_H__
24 #define __STREAM_H__
25
26 struct Stream {
27   unsigned char *mem;  // location in memory
28   unsigned int size;   // size
29   unsigned int pos;    // current position
30   bool failed;         // error occurred when seeking
31   Stream(unsigned char *m, unsigned int s) : mem(m), size(s), pos(0), failed(false)
32   {
33   }
34   unsigned int seek(unsigned int p);
35   void set_failed(const char *msg);
36 };
37
38 unsigned int mem_read(Stream &mem, unsigned long long &i);
39 unsigned int mem_read(Stream &mem, unsigned int &i);
40 unsigned int mem_read(Stream &mem, unsigned short &i);
41 unsigned int mem_read(Stream &mem, unsigned char &i);
42 unsigned int mem_read(Stream &mem, unsigned char *i, unsigned int cnt);
43
44 #endif /* __STREAM_H__ */