summaryrefslogtreecommitdiffstats
path: root/src/lib/io/StreamBuffer.h
blob: 49b666bc7bb18917c9634855368614b720e2e25f (plain) (blame)
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
/*
 * barrier -- mouse and keyboard sharing utility
 * Copyright (C) 2012-2016 Symless Ltd.
 * Copyright (C) 2002 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file LICENSE that should have accompanied this file.
 * 
 * This package is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "base/EventTypes.h"
#include "common/stdlist.h"
#include "common/stdvector.h"

//! FIFO of bytes
/*!
This class maintains a FIFO (first-in, last-out) buffer of bytes.
*/
class StreamBuffer {
public:
    StreamBuffer();
    ~StreamBuffer();

    //! @name manipulators
    //@{

    //! Read data without removing from buffer
    /*!
    Return a pointer to memory with the next \c n bytes in the buffer
    (which must be <= getSize()).  The caller must not modify the returned
    memory nor delete it.
    */
    const void*            peek(UInt32 n);

    //! Discard data
    /*!
    Discards the next \c n bytes.  If \c n >= getSize() then the buffer
    is cleared.
    */
    void                pop(UInt32 n);

    //! Write data to buffer
    /*!
    Appends \c n bytes from \c data to the buffer.
    */
    void                write(const void* data, UInt32 n);

    //@}
    //! @name accessors
    //@{

    //! Get size of buffer
    /*!
    Returns the number of bytes in the buffer.
    */
    UInt32                getSize() const;

    //@}

private:
    static const UInt32    kChunkSize;

    typedef std::vector<UInt8> Chunk;
    typedef std::list<Chunk> ChunkList;

    ChunkList            m_chunks;
    UInt32                m_size;
    UInt32                m_headUsed;
};