aboutsummaryrefslogtreecommitdiff
path: root/src/libs/dutil/WixToolset.DUtil/inc/buffutil.h
blob: 116b67bd290afec823b73fc9a8528bc9a7b35728 (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
#pragma once
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.


#ifdef __cplusplus
extern "C" {
#endif


// macro definitions

#define ReleaseBuffer(b) BuffFree(b)
#define ReleaseNullBuffer(b) BuffFree(b)
#define BuffFree(b) if (b.pbData) { MemFree(b.pbData); b.pbData = NULL; } b.cbData = 0


// structs

// A buffer that owns its data and must be freed with BuffFree().
typedef struct _BUFF_BUFFER
{
    LPBYTE pbData;
    SIZE_T cbData;
} BUFF_BUFFER;

// A read-only buffer with internal pointer that can be advanced for multiple reads.
typedef struct _BUFF_READER
{
    LPCBYTE pbData;
    SIZE_T cbData;

    SIZE_T iBuffer;
} BUFF_READER;

// A write buffer that does not own its data.
typedef struct _BUFF_WRITER
{
    LPBYTE *ppbData;
    SIZE_T *pcbData;
} BUFF_WRITER;


// function declarations

HRESULT BuffReadNumber(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __out DWORD* pdw
    );
HRESULT BuffReadNumber64(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __out DWORD64* pdw64
    );
HRESULT BuffReadPointer(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __out DWORD_PTR* pdw
);
HRESULT BuffReadString(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __deref_out_z LPWSTR* pscz
    );
HRESULT BuffReadStringAnsi(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __deref_out_z LPSTR* pscz
    );
HRESULT BuffReadStream(
    __in_bcount(cbBuffer) const BYTE* pbBuffer,
    __in SIZE_T cbBuffer,
    __inout SIZE_T* piBuffer,
    __deref_inout_bcount(*pcbStream) BYTE** ppbStream,
    __out SIZE_T* pcbStream
    );
HRESULT BuffSkipExtraData(
    __in SIZE_T cbExpectedSize,
    __in SIZE_T cbActualSize,
    __inout SIZE_T* piBuffer
    );

HRESULT BuffReaderReadNumber(
    __in BUFF_READER* pReader,
    __out DWORD* pdw
    );
HRESULT BuffReaderReadNumber64(
    __in BUFF_READER* pReader,
    __out DWORD64* pdw64
    );
HRESULT BuffReaderReadPointer(
    __in BUFF_READER* pReader,
    __out DWORD_PTR* pdw
);
HRESULT BuffReaderReadString(
    __in BUFF_READER* pReader,
    __deref_out_z LPWSTR* pscz
    );
HRESULT BuffReaderReadStringAnsi(
    __in BUFF_READER* pReader,
    __deref_out_z LPSTR* pscz
    );
HRESULT BuffReaderReadStream(
    __in BUFF_READER* pReader,
    __deref_inout_bcount(*pcbStream) BYTE** ppbStream,
    __out SIZE_T* pcbStream
    );

HRESULT BuffWriteNumber(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in DWORD dw
    );
HRESULT BuffWriteNumber64(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in DWORD64 dw64
    );
HRESULT BuffWritePointer(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in DWORD_PTR dw
);
HRESULT BuffWriteString(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in_z_opt LPCWSTR scz
    );
HRESULT BuffWriteStringAnsi(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in_z_opt LPCSTR scz
    );
HRESULT BuffWriteStream(
    __deref_inout_bcount(*piBuffer) BYTE** ppbBuffer,
    __inout SIZE_T* piBuffer,
    __in_bcount(cbStream) const BYTE* pbStream,
    __in SIZE_T cbStream
    );

HRESULT BuffWriteNumberToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in DWORD dw
    );
HRESULT BuffWriteNumber64ToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in DWORD64 dw64
    );
HRESULT BuffWritePointerToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in DWORD_PTR dw
    );
HRESULT BuffWriteStringToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in_z_opt LPCWSTR scz
    );
HRESULT BuffWriteStringAnsiToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in_z_opt LPCSTR scz
    );
HRESULT BuffWriteStreamToBuffer(
    __in BUFF_BUFFER* pBuffer,
    __in_bcount(cbStream) const BYTE* pbStream,
    __in SIZE_T cbStream
    );

HRESULT BuffWriterWriteNumber(
    __in BUFF_WRITER* pWriter,
    __in DWORD dw
    );
HRESULT BuffWriterWriteNumber64(
    __in BUFF_WRITER* pWriter,
    __in DWORD64 dw64
    );
HRESULT BuffWriterWritePointer(
    __in BUFF_WRITER* pWriter,
    __in DWORD_PTR dw
    );
HRESULT BuffWriterWriteString(
    __in BUFF_WRITER* pWriter,
    __in_z_opt LPCWSTR scz
    );
HRESULT BuffWriterWriteStringAnsi(
    __in BUFF_WRITER* pWriter,
    __in_z_opt LPCSTR scz
    );
HRESULT BuffWriterWriteStream(
    __in BUFF_WRITER* pWriter,
    __in_bcount(cbStream) const BYTE* pbStream,
    __in SIZE_T cbStream
    );

#ifdef __cplusplus
}
#endif