summaryrefslogtreecommitdiff
path: root/src/md/inc/streamutil.h
blob: 89c493476f7530fc34708515e82b10ffe4aa91c7 (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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

// 

#if !defined( __STREAMUTIL_H__ )
#define __STREAMUTIL_H__

namespace StreamUtil
{

//  Write data to stream and advance the totalBytes counter
//
inline
HRESULT WriteToStream( IStream * strm, void const * data, UINT32 sizeInBytes, UINT32 * totalBytes = NULL )
{
    HRESULT hr = strm->Write( data, sizeInBytes, NULL );
    if ( SUCCEEDED( hr ) && totalBytes != NULL )
        *totalBytes += sizeInBytes;
    return hr;
}


//  Write a POD to stream
//
template < typename T >
HRESULT WritePODToStream( IStream * strm, T val, UINT32 * totalBytes )
{
    return WriteToStream( strm, & val, sizeof( val ), totalBytes );
}


//  Write concrete data types to stream
//  Add additional overloads as needed
//

inline
HRESULT WriteToStream( IStream * strm, int val, UINT32 * totalBytes = NULL )
{
    return WritePODToStream( strm, val, totalBytes );
}


inline
HRESULT WriteToStream( IStream * strm, DWORD val, UINT32 * totalBytes = NULL )
{
    return WritePODToStream( strm, val, totalBytes );
}


inline
HRESULT WriteToStream( IStream * strm, WORD val, UINT32 * totalBytes = NULL )
{
    return WritePODToStream( strm, val, totalBytes );
}


inline
HRESULT WriteToStream( IStream * strm, BYTE val, UINT32 * totalBytes = NULL )
{
    return WritePODToStream( strm, val, totalBytes );
}


//  Align to DWORD boundary
//
inline
HRESULT AlignDWORD( IStream * strm, UINT32 * totalBytes )
{
    HRESULT hr = S_OK;

    UINT32 aligned = *totalBytes + 3 & ~3;
    if (aligned > *totalBytes)
    {   // The *totalBytes were not aligned to DWORD, we need to add padding
        DWORD data = 0;
        hr = WriteToStream( strm, & data, aligned - *totalBytes, totalBytes );
    }
    else if (aligned < *totalBytes)
    {   // We got an integer overflow in 'aligned' expression above
        hr = COR_E_OVERFLOW;
    }
    
    return hr;
}


//  Get stream position
//
inline
HRESULT GetPos( IStream * strm, UINT32 * pos )
{
    LARGE_INTEGER temp = { {0} };
    ULARGE_INTEGER ul_pos = { {0} };
    HRESULT hr = strm->Seek( temp, STREAM_SEEK_CUR, & ul_pos );
    * pos = ul_pos.u.LowPart;
    return hr;
}


class NullStream : public IStream
{
public:
    NullStream()
        : m_pos( 0 )
    {}
    
    ULONG STDMETHODCALLTYPE AddRef()
    {
        _ASSERTE( false );
        return 0;
    }

    ULONG STDMETHODCALLTYPE Release()
    {
        SUPPORTS_DAC_HOST_ONLY;
        _ASSERTE( false );
        return 0;
    }

    HRESULT STDMETHODCALLTYPE QueryInterface( REFIID, PVOID* )
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }
    
    HRESULT STDMETHODCALLTYPE Read(void *pv, ULONG cb, ULONG *pcbRead)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }
    
    HRESULT STDMETHODCALLTYPE Write(const void  *pv, ULONG cb, ULONG *pcbWritten)
    {
        m_pos += cb;
        if (pcbWritten != NULL)
        {
            *pcbWritten = cb;
        }
        return S_OK;
    }
    
    HRESULT STDMETHODCALLTYPE Seek(LARGE_INTEGER dlibMove,DWORD dwOrigin, ULARGE_INTEGER *plibNewPosition)
    {
        if ( dwOrigin != STREAM_SEEK_CUR || dlibMove.QuadPart != 0 || plibNewPosition == NULL )
            return E_NOTIMPL;

        plibNewPosition->u.HighPart = 0;
        plibNewPosition->u.LowPart = m_pos;
        return S_OK;
    }

    HRESULT STDMETHODCALLTYPE SetSize(ULARGE_INTEGER libNewSize)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE CopyTo(
        IStream     *pstm,
        ULARGE_INTEGER cb,
        ULARGE_INTEGER *pcbRead,
        ULARGE_INTEGER *pcbWritten)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE Commit(
        DWORD       grfCommitFlags)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE Revert()
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE LockRegion(
        ULARGE_INTEGER libOffset,
        ULARGE_INTEGER cb,
        DWORD       dwLockType)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE UnlockRegion(
        ULARGE_INTEGER libOffset,
        ULARGE_INTEGER cb,
        DWORD       dwLockType)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE Stat(
        STATSTG     *pstatstg,
        DWORD       grfStatFlag)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

    HRESULT STDMETHODCALLTYPE Clone(
        IStream     **ppstm)
    {
        _ASSERTE( false );
        return E_NOTIMPL;
    }

private:
    UINT32 m_pos;
};  // class NullStream

};  // namespace StreamUtil

#endif