summaryrefslogtreecommitdiff
path: root/print/XPSDrvSmpl/src/common/workbuff.cpp
blob: efa5fcc8aa43b0ca95b28d12d2bbfbfee3b8aca9 (plain)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*++

Copyright (c) 2005 Microsoft Corporation

All rights reserved.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.

File Name:

   workbuff.cpp

Abstract:

   CWorkingBuffer class implementation. This class provides a means of working
   with a local buffer by defining a simple interface that allows the retrieval
   of a buffer of an appropriate size, handling reallocation as necessary.

--*/

#include "precomp.h"
#include "debug.h"
#include "globals.h"
#include "xdstring.h"
#include "workbuff.h"

/*++

Routine Name:

    CWorkingBuffer::CWorkingBuffer

Routine Description:

    CWorkingBuffer class constructor

Arguments:

    None

Return Value:

    None
    Throws CXDException(HRESULT) on an error

--*/
CWorkingBuffer::CWorkingBuffer() :
    m_pBuffer(NULL),
    m_cbSize(CB_COPY_BUFFER)
{
    m_pBuffer = HeapAlloc(GetProcessHeap(), 0, m_cbSize);

    if (m_pBuffer == NULL)
    {
        m_cbSize = 0;
        throw CXDException(E_OUTOFMEMORY);
    }
}

/*++

Routine Name:

    CWorkingBuffer::~CWorkingBuffer

Routine Description:

    CWorkingBuffer class destructor

Arguments:

    None

Return Value:

    None

--*/
CWorkingBuffer::~CWorkingBuffer()
{
    if (m_pBuffer != NULL)
    {
        HeapFree(GetProcessHeap(), 0, m_pBuffer);
        m_pBuffer = NULL;
        m_cbSize = 0;
    }
}

/*++

Routine Name:

    CWorkingBuffer::GetBuffer

Routine Description:

    This routine returns a pointer to a buffer of at least the requested size. If the internal
    buffer is not large enough it will be resized accordingly.

Arguments:

    cbSize   - Requested size of the buffer
    ppBuffer - Pointer to a VOID pointer that recieves the buffer

Return Value:

    HRESULT
    S_OK - On success
    E_*  - On error

--*/
HRESULT
CWorkingBuffer::GetBuffer(
    _In_                       CONST ULONGLONG cbSize,
    _Outptr_result_bytebuffer_(cbSize) PVOID*          ppBuffer
    )
{
    HRESULT hr = S_OK;

    if (SUCCEEDED(hr = CHECK_POINTER(ppBuffer, E_POINTER)))
    {
        *ppBuffer = NULL;

        if (cbSize == 0)
        {
            hr = E_INVALIDARG;
        }

        if (m_cbSize == 0)
        {
            //
            // We have no existing buffer - we should have one
            //
            hr = E_FAIL;
        }
    }

    if (SUCCEEDED(hr))
    {
        if (m_cbSize >= cbSize)
        {
            *ppBuffer = m_pBuffer;
        }
        else
        {
            //
            // Double the buffer size till it is greater than the requested size
            //
            SIZE_T cbNewSize = m_cbSize;
            while (cbNewSize < cbSize)
            {
                cbNewSize *= 2;
            };

            _Analysis_assume_(cbNewSize >= 1);

            //
            // Reallocate the buffer
            //
            PVOID pNewBuffer = HeapReAlloc(GetProcessHeap(), 0, m_pBuffer, cbNewSize);

            if (pNewBuffer != NULL)
            {
                m_cbSize = cbNewSize;
                m_pBuffer = pNewBuffer;
                *ppBuffer = m_pBuffer;
            }
            else
            {
                hr = E_OUTOFMEMORY;
            }
        }
    }

    ERR_ON_HR(hr);
    return hr;
};

/*++

Routine Name:

    CWorkingBuffer::GetBufferAt

Routine Description:

    This routine returns a pointer into the internal buffer at the requested offset. This will
    not grow the size of the buffer.

Arguments:

    cbOffset - Offset into the internal buffer
    cbSize   - Size of the requested buffer
    ppBuffer - Pointer to a VOID pointer that recieves the buffer

Return Value:

    HRESULT
    S_OK                                          - On success
    HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) - If the internal buffer is not large enough
    E_*                                           - On error

--*/
HRESULT
CWorkingBuffer::GetBufferAt(
    _In_                       ULONG           cbOffset,
    _In_                       CONST ULONGLONG cbSize,
    _Outptr_result_bytebuffer_(cbSize) PVOID*          ppBuffer
    )
{
    HRESULT hr = S_OK;

    if (SUCCEEDED(hr = CHECK_POINTER(ppBuffer, E_POINTER)))
    {
        *ppBuffer = NULL;

        if (cbSize + cbOffset < m_cbSize)
        {
            *ppBuffer = reinterpret_cast<PBYTE>(m_pBuffer) + cbOffset;
        }
        else
        {
            hr = HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER);
        }
    }

    ERR_ON_HR(hr);
    return hr;
}