1// Copyright (c) 2010, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// binarystream implements part of the std::iostream interface as a
31// wrapper around std::stringstream to allow reading and writing strings
32// and integers of known size.
33
34#ifndef GOOGLE_BREAKPAD_PROCESSOR_BINARYSTREAM_H_
35#define GOOGLE_BREAKPAD_PROCESSOR_BINARYSTREAM_H_
36
37#include <sstream>
38#include <string>
39
40#include "common/using_std_string.h"
41#include "google_breakpad/common/breakpad_types.h"
42
43namespace google_breakpad {
44using std::ios_base;
45using std::ios;
46
47class binarystream {
48 public:
49  explicit binarystream(ios_base::openmode which = ios_base::out|ios_base::in)
50    : stream_(which) {}
51  explicit binarystream(const string &str,
52                        ios_base::openmode which = ios_base::out|ios_base::in)
53    : stream_(str, which) {}
54  explicit binarystream(const char *str, size_t size,
55                        ios_base::openmode which = ios_base::out|ios_base::in)
56    : stream_(string(str, size), which) {}
57
58  binarystream &operator>>(string &str);
59  binarystream &operator>>(uint8_t &u8);
60  binarystream &operator>>(uint16_t &u16);
61  binarystream &operator>>(uint32_t &u32);
62  binarystream &operator>>(uint64_t &u64);
63
64  // Note: strings are truncated at 65535 characters
65  binarystream &operator<<(const string &str);
66  binarystream &operator<<(uint8_t u8);
67  binarystream &operator<<(uint16_t u16);
68  binarystream &operator<<(uint32_t u32);
69  binarystream &operator<<(uint64_t u64);
70
71  // Forward a few methods directly from the stream object
72  bool eof() const { return stream_.eof(); }
73  void clear() { stream_.clear(); }
74  string str() const { return stream_.str(); }
75  void str(const string &s) { stream_.str(s); }
76
77  // Seek both read and write pointers to the beginning of the stream.
78  void rewind() {
79    stream_.seekg (0, ios::beg);
80    stream_.seekp (0, ios::beg);
81    // This is to clear all the error flags, since only the EOF flag is cleared
82    // with seekg().
83    stream_.clear();
84  }
85
86 private:
87  std::stringstream stream_;
88};
89
90}  // namespace google_breakpad
91
92#endif  // GOOGLE_BREAKPAD_PROCESSOR_BINARYSTREAM_H_
93