Skip to content

Commit

Permalink
Improved exception usage/classes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ioquatix
ioquatix committed Dec 19, 2021
1 parent 634f162 commit bee2878
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 38 deletions.
24 changes: 14 additions & 10 deletions file.c
View file
Expand Up @@ -2518,19 +2518,23 @@ rb_file_birthtime(VALUE obj)
off_t
rb_file_size(VALUE file)
{
rb_io_t *fptr;
struct stat st;
if (RB_TYPE_P(file, T_FILE)) {
rb_io_t *fptr;
struct stat st;

RB_IO_POINTER(file, fptr);
if (fptr->mode & FMODE_WRITABLE) {
rb_io_flush_raw(file, 0);
}
RB_IO_POINTER(file, fptr);
if (fptr->mode & FMODE_WRITABLE) {
rb_io_flush_raw(file, 0);
}

if (fstat(fptr->fd, &st) == -1) {
rb_sys_fail_path(fptr->pathv);
}
if (fstat(fptr->fd, &st) == -1) {
rb_sys_fail_path(fptr->pathv);
}

return st.st_size;
return st.st_size;
} else {
return NUM2OFFT(rb_funcall(file, idSize, 0));
}
}

static VALUE
Expand Down
2 changes: 2 additions & 0 deletions include/ruby/internal/intern/file.h
View file
Expand Up @@ -198,6 +198,8 @@ int rb_is_absolute_path(const char *path);
* @exception rb_eFrozenError `file` is frozen.
* @exception rb_eIOError `file` is closed.
* @exception rb_eSystemCallError Permission denied etc.
* @exception rb_eNoMethodError The given non-file object doesn't respond
* to `#size`.
* @return The size of the passed file.
* @note Passing a non-regular file such as a UNIX domain socket to this
* function is not a failure. But the return value is
Expand Down
46 changes: 26 additions & 20 deletions io_buffer.c
View file
Expand Up @@ -14,6 +14,11 @@
#include "internal/error.h"

VALUE rb_cIOBuffer;
VALUE rb_eIOBufferLockedError;
VALUE rb_eIOBufferAllocationError;
VALUE rb_eIOBufferMutationError;
VALUE rb_eIOBufferInvalidatedError;

size_t RUBY_IO_BUFFER_PAGE_SIZE;
size_t RUBY_IO_BUFFER_DEFAULT_SIZE;

Expand Down Expand Up @@ -163,7 +168,7 @@ io_buffer_initialize(struct rb_io_buffer *data, void *base, size_t size, enum rb
}

if (!data->base) {
rb_raise(rb_eRuntimeError, "Could not allocate buffer!");
rb_raise(rb_eIOBufferAllocationError, "Could not allocate buffer!");
}

data->source = source;
Expand Down Expand Up @@ -327,9 +332,6 @@ io_buffer_map(int argc, VALUE *argv, VALUE klass)
}

VALUE io = argv[0];
if (!RB_TYPE_P(io, T_FILE)) {
rb_raise(rb_eArgError, "Must be file/io!");
}

size_t size;
if (argc >= 2) {
Expand Down Expand Up @@ -622,7 +624,7 @@ rb_io_buffer_lock(VALUE self)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_LOCKED) {
rb_raise(rb_eRuntimeError, "Buffer already locked!");
rb_raise(rb_eIOBufferLockedError, "Buffer already locked!");
}

data->flags |= RB_IO_BUFFER_LOCKED;
Expand All @@ -637,7 +639,7 @@ rb_io_buffer_unlock(VALUE self)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (!(data->flags & RB_IO_BUFFER_LOCKED)) {
rb_raise(rb_eRuntimeError, "Buffer not locked!");
rb_raise(rb_eIOBufferLockedError, "Buffer not locked!");
}

data->flags &= ~RB_IO_BUFFER_LOCKED;
Expand All @@ -652,7 +654,7 @@ rb_io_buffer_locked(VALUE self)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_LOCKED) {
rb_raise(rb_eRuntimeError, "Buffer already locked!");
rb_raise(rb_eIOBufferLockedError, "Buffer already locked!");
}

data->flags |= RB_IO_BUFFER_LOCKED;
Expand All @@ -671,7 +673,7 @@ rb_io_buffer_free(VALUE self)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_LOCKED) {
rb_raise(rb_eRuntimeError, "Buffer is locked!");
rb_raise(rb_eIOBufferLockedError, "Buffer is locked!");
}

io_buffer_free(data);
Expand All @@ -683,7 +685,7 @@ static inline void
rb_io_buffer_validate(struct rb_io_buffer *data, size_t offset, size_t length)
{
if (offset + length > data->size) {
rb_raise(rb_eRuntimeError, "Specified offset + length exceeds source size!");
rb_raise(rb_eArgError, "Specified offset + length exceeds source size!");
}
}

Expand Down Expand Up @@ -751,11 +753,11 @@ rb_io_buffer_get_mutable(VALUE self, void **base, size_t *size)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_IMMUTABLE) {
rb_raise(rb_eRuntimeError, "Buffer is immutable!");
rb_raise(rb_eIOBufferMutationError, "Buffer is immutable!");
}

if (!io_buffer_validate(data)) {
rb_raise(rb_eRuntimeError, "Buffer has been invalidated!");
rb_raise(rb_eIOBufferInvalidatedError, "Buffer has been invalidated!");
}

if (data && data->base) {
Expand All @@ -765,7 +767,7 @@ rb_io_buffer_get_mutable(VALUE self, void **base, size_t *size)
return;
}

rb_raise(rb_eRuntimeError, "Buffer is not allocated!");
rb_raise(rb_eIOBufferAllocationError, "Buffer is not allocated!");
}

void
Expand All @@ -775,7 +777,7 @@ rb_io_buffer_get_immutable(VALUE self, const void **base, size_t *size)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (!io_buffer_validate(data)) {
rb_raise(rb_eRuntimeError, "Buffer has been invalidated!");
rb_raise(rb_eIOBufferInvalidatedError, "Buffer has been invalidated!");
}

if (data && data->base) {
Expand All @@ -785,7 +787,7 @@ rb_io_buffer_get_immutable(VALUE self, const void **base, size_t *size)
return;
}

rb_raise(rb_eRuntimeError, "Buffer is not allocated!");
rb_raise(rb_eIOBufferAllocationError, "Buffer is not allocated!");
}

size_t
Expand All @@ -798,7 +800,7 @@ rb_io_buffer_copy(VALUE self, VALUE source, size_t offset)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_IMMUTABLE) {
rb_raise(rb_eRuntimeError, "Buffer is immutable!");
rb_raise(rb_eIOBufferMutationError, "Buffer is immutable!");
}

if (RB_TYPE_P(source, T_STRING)) {
Expand Down Expand Up @@ -830,7 +832,7 @@ rb_io_buffer_transfer(VALUE self)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_LOCKED) {
rb_raise(rb_eRuntimeError, "Cannot transfer ownership of locked buffer!");
rb_raise(rb_eIOBufferLockedError, "Cannot transfer ownership of locked buffer!");
}

VALUE instance = rb_io_buffer_type_allocate(rb_class_of(self));
Expand Down Expand Up @@ -877,7 +879,7 @@ rb_io_buffer_resize(VALUE self, size_t size)
TypedData_Get_Struct(self, struct rb_io_buffer, &rb_io_buffer_type, data);

if (data->flags & RB_IO_BUFFER_LOCKED) {
rb_raise(rb_eRuntimeError, "Cannot resize locked buffer!");
rb_raise(rb_eIOBufferLockedError, "Cannot resize locked buffer!");
}

if (data->base == NULL) {
Expand All @@ -886,7 +888,7 @@ rb_io_buffer_resize(VALUE self, size_t size)
}

if (io_buffer_external_p(data->flags)) {
rb_raise(rb_eRuntimeError, "Cannot resize external buffer!");
rb_raise(rb_eIOBufferMutationError, "Cannot resize external buffer!");
}

#ifdef MREMAP_MAYMOVE
Expand Down Expand Up @@ -956,7 +958,7 @@ static void
io_buffer_validate_type(size_t size, size_t offset)
{
if (offset > size) {
rb_raise(rb_eRuntimeError, "Type extends beyond end of buffer!");
rb_raise(rb_eArgError, "Type extends beyond end of buffer!");
}
}

Expand Down Expand Up @@ -1151,7 +1153,7 @@ rb_io_buffer_clear(VALUE self, uint8_t value, size_t offset, size_t length)
rb_io_buffer_get_mutable(self, &base, &size);

if (offset + length > size) {
rb_raise(rb_eRuntimeError, "Offset + length out of bounds!");
rb_raise(rb_eArgError, "The given offset + length out of bounds!");
}

memset((char*)base + offset, value, length);
Expand Down Expand Up @@ -1215,6 +1217,10 @@ void
Init_IO_Buffer(void)
{
rb_cIOBuffer = rb_define_class_under(rb_cIO, "Buffer", rb_cObject);
rb_eIOBufferLockedError = rb_define_class_under(rb_cIOBuffer, "LockedError", rb_eRuntimeError);
rb_eIOBufferAllocationError = rb_define_class_under(rb_cIOBuffer, "AllocationError", rb_eRuntimeError);
rb_eIOBufferMutationError = rb_define_class_under(rb_cIOBuffer, "MutationError", rb_eRuntimeError);
rb_eIOBufferInvalidatedError = rb_define_class_under(rb_cIOBuffer, "InvalidatedError", rb_eRuntimeError);

rb_define_alloc_func(rb_cIOBuffer, rb_io_buffer_type_allocate);
rb_define_singleton_method(rb_cIOBuffer, "for", rb_io_buffer_type_for, 1);
Expand Down
15 changes: 7 additions & 8 deletions test/ruby/test_io_buffer.rb
View file
Expand Up @@ -60,11 +60,11 @@ def test_new_immutable
buffer = IO::Buffer.new(128, IO::Buffer::INTERNAL|IO::Buffer::IMMUTABLE)
assert buffer.immutable?

assert_raise RuntimeError do
assert_raise IO::Buffer::MutationError do
buffer.copy("", 0)
end

assert_raise RuntimeError do
assert_raise IO::Buffer::MutationError do
buffer.copy("!", 1)
end
end
Expand All @@ -75,7 +75,7 @@ def test_file_mapped
end

def test_file_mapped_invalid
assert_raise ArgumentError do
assert_raise NoMethodError do
IO::Buffer.map("foobar")
end
end
Expand Down Expand Up @@ -163,8 +163,7 @@ def test_slice
def test_slice_bounds
buffer = IO::Buffer.new(128)

# What is best exception class?
assert_raise RuntimeError do
assert_raise ArgumentError do
buffer.slice(128, 10)
end

Expand All @@ -176,13 +175,13 @@ def test_slice_bounds
def test_locked
buffer = IO::Buffer.new(128, IO::Buffer::INTERNAL|IO::Buffer::LOCKED)

assert_raise RuntimeError do
assert_raise IO::Buffer::LockedError do
buffer.resize(256)
end

assert_equal 128, buffer.size

assert_raise RuntimeError do
assert_raise IO::Buffer::LockedError do
buffer.free
end

Expand All @@ -203,7 +202,7 @@ def test_invalidation

# (4) scheduler returns
# (5) rb_write_internal invalidate the buffer object
assert_raise RuntimeError do
assert_raise IO::Buffer::LockedError do
buffer.free
end

Expand Down

0 comments on commit bee2878

Please sign in to comment.