Skip to content

Add OIIO_NODISCARD to ImageInput create/open/read methods #5111

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

Open
mvanhorn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add OIIO_NODISCARD to ImageInput create/open/read methods #5111

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
93 changes: 51 additions & 42 deletions src/include/OpenImageIO/imageio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1051,16 +1051,18 @@ class OIIO_API ImageInput {
/// A `unique_ptr` that will close and free the ImageInput when
/// it exits scope or is reset. The pointer will be empty if the
/// required writer was not able to be created.
static unique_ptr create (string_view filename, bool do_open=false,
const ImageSpec *config=nullptr,
Filesystem::IOProxy* ioproxy = nullptr,
string_view plugin_searchpath = "");
OIIO_NODISCARD static unique_ptr create (string_view filename,
bool do_open=false,
const ImageSpec *config=nullptr,
Filesystem::IOProxy* ioproxy = nullptr,
string_view plugin_searchpath = "");

/// Create an ImageInput using a UTF-16 encoded wstring filename.
static unique_ptr create (const std::wstring& filename, bool do_open=false,
const ImageSpec *config=nullptr,
Filesystem::IOProxy* ioproxy = nullptr,
string_view plugin_searchpath = "") {
OIIO_NODISCARD static unique_ptr create (const std::wstring& filename,
bool do_open=false,
const ImageSpec *config=nullptr,
Filesystem::IOProxy* ioproxy = nullptr,
string_view plugin_searchpath = "") {
return create(Strutil::utf16_to_utf8(filename), do_open, config,
ioproxy, plugin_searchpath);
}
Expand Down Expand Up @@ -1180,10 +1182,11 @@ class OIIO_API ImageInput {
///
/// @returns
/// `true` if the file was found and opened successfully.
virtual bool open (const std::string& name, ImageSpec &newspec) = 0;
OIIO_NODISCARD virtual bool open (const std::string& name,
ImageSpec &newspec) = 0;

/// Open the ImageInput using a UTF-16 encoded wstring filename.
bool open (const std::wstring& name, ImageSpec &newspec) {
OIIO_NODISCARD bool open (const std::wstring& name, ImageSpec &newspec) {
return open(Strutil::utf16_to_utf8(name), newspec);
}

Expand All @@ -1207,13 +1210,14 @@ class OIIO_API ImageInput {
///
/// @returns
/// `true` if the file was found and opened successfully.
virtual bool open (const std::string& name, ImageSpec &newspec,
const ImageSpec& config OIIO_MAYBE_UNUSED) {
OIIO_NODISCARD virtual bool open (const std::string& name,
ImageSpec &newspec,
const ImageSpec& config OIIO_MAYBE_UNUSED) {
return open(name,newspec);
}
/// Open the ImageInput using a UTF-16 encoded wstring filename.
bool open (const std::wstring& name, ImageSpec &newspec,
const ImageSpec& config OIIO_MAYBE_UNUSED) {
OIIO_NODISCARD bool open (const std::wstring& name, ImageSpec &newspec,
const ImageSpec& config OIIO_MAYBE_UNUSED) {
return open(name,newspec);
}

Expand Down Expand Up @@ -1411,15 +1415,17 @@ class OIIO_API ImageInput {
/// y, and z).
/// @returns `true` upon success, or `false` upon failure.
///
virtual bool read_image(int subimage, int miplevel, int chbegin, int chend,
TypeDesc format, const image_span<std::byte>& data);
OIIO_NODISCARD virtual bool read_image(int subimage, int miplevel,
int chbegin, int chend,
TypeDesc format,
const image_span<std::byte>& data);

/// A version of `read_image()` taking an `image_span<T>`, where the type
/// of the underlying data is `T`. This is a convenience wrapper around
/// the `read_image()` that takes an `image_span<std::byte>`.
template<typename T>
bool read_image(int subimage, int miplevel, int chbegin, int chend,
const image_span<T>& data)
OIIO_NODISCARD bool read_image(int subimage, int miplevel, int chbegin,
int chend, const image_span<T>& data)
{
static_assert(!std::is_const_v<T>,
"read_image() does not accept image_span<const T>");
Expand All @@ -1432,8 +1438,8 @@ class OIIO_API ImageInput {
/// contiguous strides in all dimensions. This is a convenience wrapper
/// around the `read_image()` that takes an `image_span<T>`.
template<typename T>
bool read_image(int subimage, int miplevel, int chbegin, int chend,
span<T> data)
OIIO_NODISCARD bool read_image(int subimage, int miplevel, int chbegin,
int chend, span<T> data)
{
static_assert(!std::is_const_v<T>,
"read_image() does not accept span<const T>");
Expand Down Expand Up @@ -1480,17 +1486,19 @@ class OIIO_API ImageInput {
/// Added in OIIO 3.1, this is the "safe" preferred alternative to
/// the version of read_scanlines that takes raw pointers.
///
virtual bool read_scanlines(int subimage, int miplevel, int ybegin,
int yend, int chbegin, int chend,
TypeDesc format,
const image_span<std::byte>& data);
OIIO_NODISCARD virtual bool read_scanlines(int subimage, int miplevel,
int ybegin, int yend,
int chbegin, int chend,
TypeDesc format,
const image_span<std::byte>& data);

/// A version of `read_scanlines()` taking an `image_span<T>`, where the
/// type of the underlying data is `T`. This is a convenience wrapper
/// around the `read_scanlines()` that takes an `image_span<std::byte>`.
template<typename T>
bool read_scanlines(int subimage, int miplevel, int ybegin, int yend,
int chbegin, int chend, const image_span<T>& data)
OIIO_NODISCARD bool read_scanlines(int subimage, int miplevel, int ybegin,
int yend, int chbegin, int chend,
const image_span<T>& data)
{
static_assert(!std::is_const_v<T>,
"read_scanlines() does not accept span<const T>");
Expand All @@ -1504,8 +1512,9 @@ class OIIO_API ImageInput {
/// contiguous strides in all dimensions. This is a convenience wrapper
/// around the `read_scanlines()` that takes an `image_span<T>`.
template<typename T>
bool read_scanlines(int subimage, int miplevel, int ybegin, int yend,
int chbegin, int chend, span<T> data)
OIIO_NODISCARD bool read_scanlines(int subimage, int miplevel, int ybegin,
int yend, int chbegin, int chend,
span<T> data)
{
static_assert(!std::is_const_v<T>,
"read_scanlines() does not accept span<const T>");
Expand Down Expand Up @@ -1773,12 +1782,12 @@ class OIIO_API ImageInput {
///
/// @note This call was changed for OpenImageIO 2.0 to include the
/// explicit subimage and miplevel parameters.
virtual bool read_scanlines (int subimage, int miplevel,
int ybegin, int yend, int z,
int chbegin, int chend,
TypeDesc format, void *data,
stride_t xstride=AutoStride,
stride_t ystride=AutoStride);
OIIO_NODISCARD virtual bool read_scanlines (int subimage, int miplevel,
int ybegin, int yend, int z,
int chbegin, int chend,
TypeDesc format, void *data,
stride_t xstride=AutoStride,
stride_t ystride=AutoStride);

/// Read the tile whose upper-left origin is (x,y,z) into `data[]`,
/// converting if necessary from the native data format of the file into
Expand Down Expand Up @@ -1904,14 +1913,14 @@ class OIIO_API ImageInput {
/// @param progress_callback/progress_callback_data
/// Optional progress callback.
/// @returns `true` upon success, or `false` upon failure.
virtual bool read_image (int subimage, int miplevel,
int chbegin, int chend,
TypeDesc format, void *data,
stride_t xstride=AutoStride,
stride_t ystride=AutoStride,
stride_t zstride=AutoStride,
ProgressCallback progress_callback=NULL,
void *progress_callback_data=NULL);
OIIO_NODISCARD virtual bool read_image (int subimage, int miplevel,
int chbegin, int chend,
TypeDesc format, void *data,
stride_t xstride=AutoStride,
stride_t ystride=AutoStride,
stride_t zstride=AutoStride,
ProgressCallback progress_callback=NULL,
void *progress_callback_data=NULL);

/// @}

Expand Down
Loading