File: SharedBuffer.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (163 lines) | stat: -rw-r--r-- 5,668 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
 * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SharedBuffer_h
#define SharedBuffer_h

#include "platform/PlatformExport.h"
#include "third_party/skia/include/core/SkData.h"
#include "wtf/Forward.h"
#include "wtf/RefCounted.h"
#include "wtf/Vector.h"
#include "wtf/text/WTFString.h"

namespace blink {

class WebProcessMemoryDump;

class PLATFORM_EXPORT SharedBuffer : public RefCounted<SharedBuffer> {
 public:
  enum : unsigned { kSegmentSize = 0x1000 };

  static PassRefPtr<SharedBuffer> create() {
    return adoptRef(new SharedBuffer);
  }

  HAS_STRICTLY_TYPED_ARG
  static PassRefPtr<SharedBuffer> create(STRICTLY_TYPED_ARG(size)) {
    STRICT_ARG_TYPE(size_t);
    return adoptRef(new SharedBuffer(size));
  }

  HAS_STRICTLY_TYPED_ARG
  static PassRefPtr<SharedBuffer> create(const char* data,
                                         STRICTLY_TYPED_ARG(size)) {
    STRICT_ARG_TYPE(size_t);
    return adoptRef(new SharedBuffer(data, size));
  }

  HAS_STRICTLY_TYPED_ARG
  static PassRefPtr<SharedBuffer> create(const unsigned char* data,
                                         STRICTLY_TYPED_ARG(size)) {
    STRICT_ARG_TYPE(size_t);
    return adoptRef(new SharedBuffer(data, size));
  }

  static PassRefPtr<SharedBuffer> adoptVector(Vector<char>&);

  ~SharedBuffer();

  // Calling this function will force internal segmented buffers to be merged
  // into a flat buffer. Use getSomeData() whenever possible for better
  // performance.
  const char* data() const;

  size_t size() const;

  bool isEmpty() const { return !size(); }

  void append(PassRefPtr<SharedBuffer>);

  HAS_STRICTLY_TYPED_ARG
  void append(const char* data, STRICTLY_TYPED_ARG(size)) {
    ALLOW_NUMERIC_ARG_TYPES_PROMOTABLE_TO(size_t);
    appendInternal(data, size);
  }
  void append(const Vector<char>&);

  void clear();

  PassRefPtr<SharedBuffer> copy() const;

  // Return the number of consecutive bytes after "position". "data"
  // points to the first byte.
  // Return 0 when no more data left.
  // When extracting all data with getSomeData(), the caller should
  // repeat calling it until it returns 0.
  // Usage:
  //      const char* segment;
  //      size_t pos = 0;
  //      while (size_t length = sharedBuffer->getSomeData(segment, pos)) {
  //          // Use the data. for example: decoder->decode(segment, length);
  //          pos += length;
  //      }
  HAS_STRICTLY_TYPED_ARG
  size_t getSomeData(
      const char*& data,
      STRICTLY_TYPED_ARG(position) = static_cast<size_t>(0)) const {
    STRICT_ARG_TYPE(size_t);
    return getSomeDataInternal(data, position);
  }

  // Returns the content data into "dest" as a flat buffer. "byteLength" must
  // exactly match with size(). |dest| must not be null even if |bytesLength|
  // is 0.
  HAS_STRICTLY_TYPED_ARG
  void getAsBytes(void* dest, STRICTLY_TYPED_ARG(byteLength)) const {
    STRICT_ARG_TYPE(size_t);
    DCHECK_EQ(byteLength, size());
    auto result = getAsBytesInternal(dest, 0, byteLength);
    DCHECK(result);
  }

  // Copies "byteLength" bytes from "position"-th bytes (0 origin) of the
  // content data into "dest" as a flat buffer, Returns true on success,
  // otherwise the content of "dest" is not guaranteed.
  HAS_STRICTLY_TYPED_ARG
  bool getPartAsBytes(void* dest,
                      STRICTLY_TYPED_ARG(position),
                      STRICTLY_TYPED_ARG(byteLength)) const {
    STRICT_ARG_TYPE(size_t);
    return getAsBytesInternal(dest, position, byteLength);
  }

  // Creates an SkData and copies this SharedBuffer's contents to that
  // SkData without merging segmented buffers into a flat buffer.
  sk_sp<SkData> getAsSkData() const;

  void onMemoryDump(const String& dumpPrefix, WebProcessMemoryDump*) const;

 private:
  SharedBuffer();
  explicit SharedBuffer(size_t);
  SharedBuffer(const char*, size_t);
  SharedBuffer(const unsigned char*, size_t);

  // See SharedBuffer::data().
  void mergeSegmentsIntoBuffer() const;

  void appendInternal(const char* data, size_t);
  bool getAsBytesInternal(void* dest, size_t, size_t) const;
  size_t getSomeDataInternal(const char*& data, size_t position) const;

  size_t m_size;
  mutable Vector<char> m_buffer;
  mutable Vector<char*> m_segments;
};

}  // namespace blink

#endif  // SharedBuffer_h