Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add buffered_stream_reader_test and fix registry #48

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Add buffered_stream_reader_test and fix registry #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions spelling.dic
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@
derks
bcfd
Anymap
jpegls
pgmfile
ppmfile
graymap
pixmap
115 changes: 45 additions & 70 deletions src/buffered_stream_reader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

module;

#include "macros.hpp"
#include "intellisense.hpp"

module buffered_stream_reader;
Expand All @@ -19,6 +20,8 @@ constexpr UINT MAX_BUFFER_SIZE = 65536;

buffered_stream_reader::buffered_stream_reader(_In_ IStream* stream) : buffer_(MAX_BUFFER_SIZE)
{
ASSERT(stream);

stream_.copy_from(stream);

// buffer_ = new BYTE[MAX_BUFFER_SIZE];
Expand All @@ -29,128 +32,100 @@ buffered_stream_reader::buffered_stream_reader(_In_ IStream* stream) : buffer_(M
buffer_size_ = read;
}

HRESULT buffered_stream_reader::ReadChar(char* c)
uint32_t buffered_stream_reader::read_int()
{
char str[12];

read_string(str, sizeof(str));
uint32_t value;
if (const auto [ptr, ec] = std::from_chars(str, std::end(str), value); ec != std::errc())
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);

return value;
}

bool buffered_stream_reader::try_read_bytes(void* buffer, const size_t size)
{
ULONG bytes_read;
read_bytes(buffer, static_cast<ULONG>(size), &bytes_read);
if (bytes_read != size)
return false;

return true;
}

char buffered_stream_reader::read_char()
{
if (position_ + sizeof(char) > buffer_size_)
{
if (buffer_size_ == MAX_BUFFER_SIZE)
{
RefillBuffer();

if (buffer_size_ < sizeof(char))
return S_FALSE;
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);
}
else
return S_FALSE;
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);
}

*c = buffer_[position_];
const char result = buffer_[position_];

position_ += sizeof(char);

return S_OK;
return result;
}

HRESULT buffered_stream_reader::SkipLine()
void buffered_stream_reader::skip_line()
{
while (true)
{
char c;

const HRESULT hr = ReadChar(&c);

if (hr != S_OK)
return hr;
const char c = read_char();

if (c == 0x0A)
return S_OK;
return;
}
}

HRESULT buffered_stream_reader::ReadString(char* str, ULONG maxCount)
void buffered_stream_reader::read_string(char* str, ULONG maxCount)
{
if (maxCount == 0)
return E_INVALIDARG;
ASSERT(maxCount > 0);

ULONG charsRead = 0;

while (true)
{
char c;

HRESULT hr = ReadChar(&c);

if (FAILED(hr))
return hr;

if (hr == S_FALSE)
if (charsRead == 0)
return S_FALSE;
else
{
*str = 0x00;
return S_OK;
}
char c = read_char();

if (isspace(c))
if (charsRead == 0)
continue;
else
{
*str = 0x00;
return S_OK;
return;
}

if (c == '#')
if (charsRead == 0)
{
hr = SkipLine();

if (FAILED(hr))
return hr;

if (hr == S_FALSE)
{
*str = 0x00;
return hr;
}

skip_line();
continue;
}
else
{
*str = 0x00;
return S_OK;
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);
}

*str = c;
str++;
charsRead++;

if (charsRead == maxCount)
return WINCODEC_ERR_BADSTREAMDATA;
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);
}
}

uint32_t buffered_stream_reader::read_int_slow()
{
char str[12];

winrt::check_hresult(ReadString(str, sizeof(str)));
uint32_t value;
if (const auto [ptr, ec] = std::from_chars(str, std::end(str), value); ec != std::errc())
winrt::throw_hresult(WINCODEC_ERR_BADSTREAMDATA);

return value;
}

bool buffered_stream_reader::try_read_bytes(void* buffer, const size_t size)
{
ULONG bytes_read;
if (const HRESULT hr{ReadBytes(buffer, static_cast<ULONG>(size), &bytes_read)}; FAILED(hr) || bytes_read != size)
return false;

return true;
}

void buffered_stream_reader::read_bytes(void* buffer, size_t size)
{
const size_t remaining_in_buffer = buffer_size_ - position_;
Expand All @@ -171,7 +146,7 @@ void buffered_stream_reader::read_bytes(void* buffer, size_t size)
wincodec::error_stream_read);
}

HRESULT buffered_stream_reader::ReadBytes(void* buf, const ULONG count, ULONG* bytesRead)
void buffered_stream_reader::read_bytes(void* buf, const ULONG count, ULONG* bytesRead)
{
auto b{static_cast<BYTE*>(buf)};
ULONG remaining = count;
Expand All @@ -183,7 +158,7 @@ HRESULT buffered_stream_reader::ReadBytes(void* buf, const ULONG count, ULONG* b
memcpy(b, buffer_.data() + position_, remaining);
position_ += remaining;
*bytesRead = count;
return S_OK;
return;
}

memcpy(b, buffer_.data() + position_, buffer_size_ - position_);
Expand All @@ -196,7 +171,7 @@ HRESULT buffered_stream_reader::ReadBytes(void* buf, const ULONG count, ULONG* b
if (buffer_size_ == 0)
{
*bytesRead = count - remaining;
return S_OK;
return;
}
}
}
Expand Down
12 changes: 6 additions & 6 deletions src/buffered_stream_reader.ixx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,8 @@ export class buffered_stream_reader final
public:
explicit buffered_stream_reader(_In_ IStream* stream);

HRESULT ReadChar(char* c);
HRESULT SkipLine();
HRESULT ReadString(char* str, ULONG maxCount);
[[nodiscard]] std::uint32_t read_int_slow();
bool try_read_bytes(void* buffer, size_t size);
[[nodiscard]] std::uint32_t read_int();
[[nodiscard]] bool try_read_bytes(void* buffer, size_t size);
void read_bytes(void* buffer, size_t size);

[[nodiscard]] std::vector<std::byte> read_bytes(const size_t size)
Expand All @@ -30,9 +27,12 @@ public:
return bytes;
}

HRESULT ReadBytes(void* buf, ULONG count, ULONG* bytesRead);
void read_bytes(void* buf, ULONG count, ULONG* bytesRead);

private:
char read_char();
void skip_line();
void read_string(char* str, ULONG maxCount);
void RefillBuffer();

winrt::com_ptr<IStream> stream_;
Expand Down
6 changes: 4 additions & 2 deletions src/dll_main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ void register_general_decoder_settings(const GUID& class_id, const GUID& wic_cat

void register_decoder_file_extension(const wchar_t* file_type_name, const wchar_t* file_extension, const wchar_t* mime_type)
{
const wstring extension_sub_key{LR"(SOFTWARE\Classes\"s + file_extension + LR"\)"};
const wstring extension_sub_key{LR"(SOFTWARE\Classes\)"s + file_extension + LR"(\)"};
registry::set_value(extension_sub_key, L"", file_type_name);
registry::set_value(extension_sub_key, L"Content Type", mime_type);
registry::set_value(extension_sub_key, L"PerceivedType", L"image");
Expand Down Expand Up @@ -109,7 +109,7 @@ void register_decoder()

// Register the byte pattern that allows WICs to identify files as our image type.
register_decoder_pattern(sub_key, 0, array{std::byte{0x50}, std::byte{0x35}});
register_decoder_pattern(sub_key, 0, array{std::byte{0x50}, std::byte{0x36}});
register_decoder_pattern(sub_key, 1, array{std::byte{0x50}, std::byte{0x36}});

register_decoder_file_extension(L"pgmfile", L".pgm", L"image/x-portable-graymap");
register_decoder_file_extension(L"ppmfile", L".ppm", L"image/x-portable-pixmap");
Expand Down Expand Up @@ -183,6 +183,7 @@ extern "C" __control_entrypoint(DllExport) HRESULT __stdcall DllCanUnloadNow()
HRESULT __stdcall DllRegisterServer()
try
{
TRACE("netpbm-wic-codec::DllRegisterServer\n");
register_decoder();

SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, nullptr, nullptr);
Expand All @@ -198,6 +199,7 @@ catch (...)
HRESULT __stdcall DllUnregisterServer()
try
{
TRACE("netpbm-wic-codec::DllUnregisterServer\n");
// Note: keep the .pgm file registration intact.
return unregister(id::netpbm_decoder, CATID_WICBitmapDecoders);
}
Expand Down
9 changes: 4 additions & 5 deletions src/pnm_header.ixx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ export struct pnm_header
char magic[2];
ULONG bytesRead;

if (const HRESULT hr{streamReader.ReadBytes((BYTE*)&magic, sizeof(magic), &bytesRead)}; FAILED(hr))
return hr;
streamReader.read_bytes((BYTE*)&magic, sizeof(magic), &bytesRead);
if (bytesRead != sizeof(magic))
throw_hresult(wincodec::error_bad_header);

Expand Down Expand Up @@ -86,8 +85,8 @@ export struct pnm_header
throw_hresult(wincodec::error_bad_header);
}

width = streamReader.read_int_slow();
height = streamReader.read_int_slow();
width = streamReader.read_int();
height = streamReader.read_int();

if (width < 1 || height < 1)
return WINCODEC_ERR_BADHEADER;
Expand All @@ -96,7 +95,7 @@ export struct pnm_header

if (PnmType != PnmType::Bitmap)
{
maxColorValue = streamReader.read_int_slow();
maxColorValue = streamReader.read_int();
}
else
maxColorValue = 1;
Expand Down
67 changes: 67 additions & 0 deletions test/buffered_stream_reader_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright (c) Victor Derks.
// SPDX-License-Identifier: MIT

#include "intellisense.hpp"
#include "util.hpp"

import std;
import "win.h";
import test.winrt;

import buffered_stream_reader;

using std::span;
using winrt::com_ptr;
using namespace Microsoft::VisualStudio::CppUnitTestFramework;

TEST_CLASS(buffered_stream_reader_test)
{
public:
TEST_METHOD(read_bytes) // NOLINT
{
std::vector<char> source;
source.push_back(0);
source.push_back(1);
buffered_stream_reader reader(create_memory_stream(source).get());

std::vector<char> destination(2);
ULONG bytes_read;
reader.read_bytes(destination.data(), static_cast<ULONG>(destination.size()), &bytes_read);

Assert::AreEqual(2UL, bytes_read);
}

TEST_METHOD(read_bytes_not_enough_available) // NOLINT
{
std::vector<char> source;
source.push_back(0);
buffered_stream_reader reader(create_memory_stream(source).get());

std::vector<char> destination(2);
ULONG bytes_read;
reader.read_bytes(destination.data(), static_cast<ULONG>(destination.size()), &bytes_read);

Assert::AreEqual(1UL, bytes_read);
}

TEST_METHOD(read_int) // NOLINT
{
std::vector<char> source;
std::string str1 = "256 ";
source.insert(source.end(), str1.begin(), str1.end());
buffered_stream_reader reader(create_memory_stream(source).get());

auto value = reader.read_int();

Assert::AreEqual(256U, value);
}

private:
com_ptr<IStream> create_memory_stream(span<char> source)
{
com_ptr<IStream> stream;
stream.attach(SHCreateMemStream(reinterpret_cast<BYTE*>(source.data()), static_cast<UINT>(source.size())));

return stream;
}
};
1 change: 1 addition & 0 deletions test/test.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@
</Link>
</ItemDefinitionGroup>
<ItemGroup>
<ClCompile Include="buffered_stream_reader_test.cpp" />
<ClCompile Include="dll_main_test.cpp" />
<ClCompile Include="test_errors.ixx" />
<ClCompile Include="netpbm_bitmap_decoder_test.cpp" />
Expand Down
3 changes: 3 additions & 0 deletions test/test.vcxproj.filters
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@
<ClCompile Include="test_winrt.ixx">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="buffered_stream_reader_test.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<ClInclude Include="util.hpp">
Expand Down
Loading