wren-lang / wren-cli

A command line tool for the Wren programming language
MIT License
129 stars 30 forks source link

Setters should return their argument #54

Open ChayimFriedman2 opened 3 years ago

ChayimFriedman2 commented 3 years ago

In Wren, assignment returns its value, like in C:

var a
System.print(a = 5) // 5

When implementing setters, we need to maintain this behavior:

// Not good
class C {
  static a=(value) {
    __a = value
  }
}
System.print(C.a = 5) // null

// Good
class C {
  static a=(value) { __a = value }
}
System.print(C.a = 5) // 5

// Also good
class C {
  static a=(value) {
    __a = value
    return value
  }
}
System.print(C.a = 5) // 5

Generally, the CLI do that, except in one foreign setter - Stdin.isRaw=(_):

https://github.com/wren-lang/wren-cli/blob/b82cf5a2e21ef54a8ac8347b27899edfeeffa724/src/module/io.c#L509-L525

Instead we should do:

void stdinIsRawSet(WrenVM* vm)
{
  initStdin();

  isStdinRaw = wrenGetSlotBool(vm, 1);

  if (uv_guess_handle(stdinDescriptor) == UV_TTY)
  {
    uv_tty_t* handle = (uv_tty_t*)stdinStream;
    uv_tty_set_mode(handle, isStdinRaw ? UV_TTY_MODE_RAW : UV_TTY_MODE_NORMAL);
  }
  else
  {
    // Can't set raw mode when not talking to a TTY.
    // TODO: Make this a runtime error?
  }

  wrenEnsureSlots(vm, 1); // Is that required? Probably not
  wrenSetSlotBool(vm, 0, isStdinRaw);
}
joshgoebel commented 3 years ago

While the other issue is being discussed (adding the API) would you like to go ahead and make a PR for this? It seems the agreement was reached that this is the correct behavior at least. :-)

aosenkidu commented 1 year ago

Interesting point of view. As we usually do not really "use" setters, but what other languages call "property access". Aka, we pretend there is no setter and we could write to the field/attribute directly: obj.property = value

hence we have the idea from C etc. that: var x = obj.property = value assigns value to the variabel x after calling the setter property on the object obj.

In my opinion the compiler should take care on the level of that expression that this is the case. And there is no reason that the setter is returning its argument.

In fact the setter should return "this". And that also should be the responsibility of the compiler. So you can write: obj.propertyOne(value).propertyTwo(anotherValue)

Albeit, while I'm typing this: I wonder if you can call a setter in wren, or if a setter can only be accessed via "="?