[GR-21458] Refactor file mode constants and path for C API.

PullRequest: truffleruby/2408

Author: aardvark179

CHANGELOG.md

@@ -54,6 +54,7 @@ Compatibility:
 * Add support for `rb_scan_args_kw` in C API (#2244, @LillianZ).
 * Update random implementation layout to be more compatible (#2234).
 * Set `RbConfig::CONFIG['LIBPATHFLAG'/'RPATHFLAG']` like MRI to let `$LIBPATH` changes in `extconf.rb` work.
+* Access to path and mode via `rb_io_t` from C has been changed to improve compatibility for io-console.
 
 Performance:
 

lib/truffle/truffle/cext.rb

@@ -1697,14 +1697,6 @@ def rb_class_inherited_p(ruby_module, object)
     end
   end
 
-  def rb_tr_readable(mode)
-    mode == File::Constants::RDONLY || mode == File::Constants::RDWR
-  end
-
-  def rb_tr_writable(mode)
-    mode == File::Constants::WRONLY || mode == File::Constants::RDWR
-  end
-
   def rb_backref_get
     Primitive.regexp_last_match_get(Truffle::ThreadOperations.ruby_caller_special_variables([Truffle::CExt, Truffle::Interop.singleton_class]))
   end

lib/truffle/truffle/cext_structs.rb

@@ -358,7 +358,7 @@ def polyglot_read_member(name)
     when 'mode'
       @io.instance_variable_get(:@mode)
     when 'pathv'
-      Primitive.cext_wrap(@pathv)
+      Primitive.cext_wrap(@io.instance_variable_get(:@path))
     when 'tied_io_for_writing'
       Primitive.cext_wrap(@tied_io_for_writing)
     else
@@ -371,7 +371,7 @@ def polyglot_write_member(name, value)
     when 'mode'
       @io.instance_variable_set(:@mode, value)
     when 'pathv'
-      @pathv = Primitive.cext_unwrap(value)
+      @io.instance_variable_set(:@path, Primitive.cext_unwrap(value))
     when 'tied_io_for_writing'
       @tied_io_for_writing = Primitive.cext_unwrap(value)
     else

spec/ruby/optional/capi/ext/io_spec.c

@@ -227,6 +227,16 @@ static VALUE io_spec_errno_set(VALUE self, VALUE val) {
   return val;
 }
 
+VALUE io_spec_mode_sync_flag(VALUE self, VALUE io) {
+  rb_io_t *fp;
+  GetOpenFile(io, fp);
+  if (fp->mode & FMODE_SYNC) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
 void Init_io_spec(void) {
   VALUE cls = rb_define_class("CApiIOSpecs", rb_cObject);
   rb_define_method(cls, "GetOpenFile_fd", io_spec_GetOpenFile_fd, 1);
@@ -251,6 +261,7 @@ void Init_io_spec(void) {
   rb_define_method(cls, "rb_fd_fix_cloexec", io_spec_rb_fd_fix_cloexec, 1);
   rb_define_method(cls, "rb_cloexec_open", io_spec_rb_cloexec_open, 3);
   rb_define_method(cls, "errno=", io_spec_errno_set, 1);
+  rb_define_method(cls, "rb_io_mode_sync_flag", io_spec_mode_sync_flag, 1);
 }
 
 #ifdef __cplusplus

spec/ruby/optional/capi/io_spec.rb

@@ -375,3 +375,29 @@
     @io.close_on_exec?.should be_true
   end
 end
+
+describe "rb_io_t modes flags" do
+  before :each do
+    @o = CApiIOSpecs.new
+    @name = tmp("c_api_rb_io_specs")
+    touch @name
+  end
+
+  after :each do
+    rm_r @name
+  end
+
+  it "has the sync flag set if the IO object is synced in Ruby" do
+    File.open(@name) { |io|
+      io.sync = true
+      @o.rb_io_mode_sync_flag(io).should == true
+    }
+  end
+
+  it "has the sync flag unset if the IO object is not synced in Ruby" do
+    File.open(@name) { |io|
+      io.sync = false
+      @o.rb_io_mode_sync_flag(io).should == false
+    }
+  end
+end

src/main/c/cext/io.c

@@ -153,11 +153,11 @@ VALUE rb_get_path(VALUE object) {
 }
 
 int rb_tr_readable(int mode) {
-  return polyglot_as_boolean(polyglot_invoke(RUBY_CEXT, "rb_tr_readable", mode));
+  return mode & FMODE_READABLE;
 }
 
 int rb_tr_writable(int mode) {
-  return polyglot_as_boolean(polyglot_invoke(RUBY_CEXT, "rb_tr_writable", mode));
+  return mode & FMODE_WRITABLE;
 }
 
 int rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2_p, int *fmode_p) {

src/main/ruby/truffleruby/core/file.rb

@@ -56,6 +56,23 @@ module Constants
     F_DUPFD_CLOEXEC = Truffle::Config['platform.fcntl.F_DUPFD_CLOEXEC']
     FD_CLOEXEC = Truffle::Config['platform.fcntl.FD_CLOEXEC']
 
+    # These constants are copied from lib/cext/include/ruby/io.h and
+    # are used to help ensure that the flags set in IO modes in C and
+    # Ruby use the same values.
+    FMODE_READABLE = 0x00000001
+    FMODE_WRITABLE = 0x00000002
+    FMODE_READWRITE = (FMODE_READABLE|FMODE_WRITABLE)
+    FMODE_BINMODE = 0x00000004
+    FMODE_SYNC = 0x00000008
+    FMODE_TTY = 0x00000010
+    FMODE_DUPLEX = 0x00000020
+    FMODE_APPEND = 0x00000040
+    FMODE_CREATE = 0x00000080
+    FMODE_EXCL = 0x00000400
+    FMODE_TRUNC = 0x00000800
+    FMODE_TEXTMODE = 0x00001000
+    FMODE_SETENC_BY_BOM = 0x00100000
+
     RDONLY   = Truffle::Config['platform.file.O_RDONLY']
     WRONLY   = Truffle::Config['platform.file.O_WRONLY']
     RDWR     = Truffle::Config['platform.file.O_RDWR']
@@ -1281,7 +1298,13 @@ def size
   end
 end     # File
 
-# Inject the constants into IO
+# Inject the constants into IO and IOOperations
 class IO
   include File::Constants
 end
+
+module Truffle
+  module IOOperations
+    include File::Constants
+  end
+end