User Defined Operator Overloads #7388

JordanRL · 2021-08-18T23:16:34Z

This is a draft PR so that early feedback on implementation can be received, or errors can be caught earlier.

Draft RFC for reference: https://wiki.php.net/rfc/user_defined_operator_overloads

Implementation checklist:

…overloads + whitespace errors

…pecial cases

HallofFamer · 2021-08-19T13:49:04Z

Reduces Need For Scalar Objects

Interesting RFC, but I dont think the need for opeator overloading is the reason why developers want Scalar Objects. There are more important reasons and I completely disagree that this RFC will reduce the need for scalar objects even if it passes.

JordanRL · 2021-08-20T01:52:19Z

Interesting RFC, but I dont think the need for opeator overloading is the reason why developers want Scalar Objects. There are more important reasons and I completely disagree that this RFC will reduce the need for scalar objects even if it passes.

This obviously doesn't eliminate the need for scalar objects. My point was that it reduces the need for them by enabling community created scalar objects to be acceptable solutions in some circumstances. Obviously that doesn't address the issue of re-standardizing the standard library which some people want to see as part of scalar objects, because that would necessarily require a standard implementation of them from core.

oprypkhantc · 2021-08-20T10:05:51Z

Just my off-topic 2 cents regarding the scalar objects:

I don't believe implementing them in PHP core by themselves would benefit the community much. For example, if String scalar object was implemented in PHP core, chances are it would have the same set of standard methods that PHP currently has as str_* functions. While there are a lot of them, there are usually not enough, so you would either end up using custom scalar objects from 3rd party or using ugly helper functions like str_pad_left(StringScalar, int): StringScalar.

So IMHO before even thinking of adding scalar objects, we need extension methods from C#/Kotlin. This in turn would mean PHP could implement barebones scalar objects that just have operators overloaded and a set of few very basic methods, nothing more. Community could then implement the rest. Every projects would then use an extensions library they like and it could be then backported to PHP once the community decides what's best.

… related SIGSEGV

Use operator keyword instead of magic methods

iluuu1994 · 2021-12-05T22:16:01Z

.gitignore

@@ -286,3 +286,10 @@ tmp-php.ini
 !/ext/fileinfo/magicdata.patch
 !/ext/pcre/pcre2lib/config.h
 !/win32/build/Makefile
+
+# -------


https://stackoverflow.com/a/7335487/1320374 😉

Thanks @iluuu1994. I was going to take care of this before I opened the PR from draft.

Np, I thought maybe you didn't know about global gitignores.

I actually didn't, so the comment was definitely helpful. :)

Zend/tests/bug63882.phpt

Fix enum case usage in zend_std_call_op_override

KapitanOczywisty · 2021-12-16T09:49:05Z

And another attempt on this which is failing. I can bet that in this form, overloads will never make into php.

A while back I've made extension for fun, in which I had Operator abstract class. When extending this class you could define methods like __add, __sub. It was more or less working, and you can look it up here: https://gist.github.com/KapitanOczywisty/8c63177650f4e1f581393471e1ebc388

Implementing such overloads for any object makes a big mess, especially for static analysis. It's a way better to make overloads into interface - similar to ArrayAccess. Then is crystal-clear which objects are affected. Of course you can't set argument type in that case, but in ArrayAccess and similar ones you can't either, so let user validate what is allowed as operand.

Also adding another syntax to handle operations is unnecessary complexity, just use magic methods like __add and don't touch tokenizer.

oprypkhantc · 2021-12-16T10:46:22Z

@KapitanOczywisty

Implementing such overloads for any object makes a big mess, especially for static analysis

It's in no way different to magic methods or an interface. Checking for an existing operator method overload is just as easy as checking for magic method existence or an interface supertype.

Then is crystal-clear which objects are affected

It's already crystal clear - you have a list of all operator overload methods at your disposal.

Also adding another syntax to handle operations is unnecessary complexity, just use magic methods like __add and don't touch tokenizer.

Read the internals and the RFC. There are plenty of arguments why magic methods make less sense than a separate keyword. Interfaces don't make any sense at all. It's possible that PHP will want to get rid of ArrayAccess at some point too.

cmb69 · 2021-12-16T11:50:38Z

@KapitanOczywisty, please do any non implementation related discussion on the internal mailing list. Otherwise it gets unwieldy here (and for any other RFC PR). Thank you!

KapitanOczywisty · 2021-12-16T15:24:57Z

@cmb69 That mailing list is the reason why php is 5 to 10 years behind modern programming languages.

cmb69 · 2021-12-16T15:37:34Z

@KapitanOczywisty, if that is the case, I wonder why you waste your time with such ancient tech. ;)

KapitanOczywisty · 2021-12-16T17:28:53Z

@cmb69 Only to maintain old projects, but otherwise typescript + nodejs whenever possible. There is noticeable decrease in php popularity. Updates could be summarized as "too late too little".

skrtdev · 2021-12-27T12:33:55Z

I like this PR

Girgias · 2022-01-03T14:17:17Z

Zend/zend_compile.c

-/* }}} */
-
-static void zend_compile_unary_op(znode *result, zend_ast *ast) /* {{{ */
+void zend_compile_unary_op(znode *result, zend_ast *ast) /* {{{ */


Why did you remove the static here?

Girgias · 2022-01-03T14:17:56Z

Zend/zend_enum.stub.php

+{
+	case LeftSide;
+	case RightSide;
+}


Girgias · 2022-01-03T14:19:21Z

Zend/zend_language_parser.y

 %type <num> method_modifiers non_empty_member_modifiers member_modifier
 %type <num> optional_property_modifiers property_modifier
 %type <num> class_modifiers class_modifier use_type backup_fn_flags

 %type <ptr> backup_lex_pos
 %type <str> backup_doc_comment

-%type <ident> reserved_non_modifiers semi_reserved
+%type <ident> reserved_non_modifiers semi_reserved ampersand overloadable_operator_list


Isn't the ampersand redundant here?

Girgias · 2022-01-03T14:26:34Z

ext/reflection/php_reflection.stub.php

+    /** @tentative-return-type */
+    public function hasOperator(string $name): bool {}
+
+    /** @tentative-return-type */
+    public function getOperator(string $name): ReflectionMethod {}
+
+    /** @tentative-return-type */
+    public function getOperators(?int $filter = null): array {}
+


These are new functions, therefore they can just have the return type be normal and not be tentative IMHO.

Girgias · 2022-01-03T14:28:48Z

Zend/zend_object_handlers.c

@@ -218,6 +219,193 @@ static void zend_std_call_issetter(zend_object *zobj, zend_string *prop_name, zv
 }
 /* }}} */

+static int zend_std_call_op_override(zend_uchar opcode, zval *result, zval *op1, zval *op2) /* {{{ */


Suggested change

static int zend_std_call_op_override(zend_uchar opcode, zval *result, zval *op1, zval *op2) /* {{{ */

static zend_result zend_std_call_op_override(zend_uchar opcode, zval *result, zval *op1, zval *op2) /* {{{ */

Girgias · 2022-01-03T14:31:32Z

Zend/tests/operator_overloads/operator_reflection.phpt

@@ -0,0 +1,80 @@
+--TEST--
+operator overload: reflection for operators


Reflection tests should be in ext/reflection/

Girgias · 2022-01-03T14:35:29Z

Zend/tests/operator_overloads/operator_position.phpt

+    	if ($left == OperandPosition::RightSide) {
+			echo "Right side".PHP_EOL;
+		} elseif ($left == OperandPosition::LeftSide) {
+			echo "Left side".PHP_EOL;
+		} else {
+    		echo "Unknown enum case!".PHP_EOL;
+    	}


Use match?

Suggested change

if ($left == OperandPosition::RightSide) {

echo "Right side".PHP_EOL;

} elseif ($left == OperandPosition::LeftSide) {

echo "Left side".PHP_EOL;

} else {

echo "Unknown enum case!".PHP_EOL;

}

echo match($left) {

OperandPosition::RightSide => 'Right side'

OperandPosition::LeftSide => 'Left side'

}, PHP_EOL;

(Haven't tried this just typed it out)

Girgias · 2022-01-03T14:37:31Z

Zend/tests/operator_overloads/add_operator.phpt

+    	$return = new A();
+    	$return->value = $this->value + $other;
+
+		return $return;


Nit: indent

Girgias · 2022-01-03T14:37:43Z

Zend/tests/operator_overloads/div_operator.phpt

+    		$return->value = $other / $this->value;
+    	}
+
+		return $return;


Nit: indent

Girgias · 2022-01-03T14:37:57Z

Zend/tests/operator_overloads/equals_fallback_comparison.phpt

+
+    public operator <=>(mixed $other): int
+    {
+		return ($this->value <=> $other);


Nit: indent

Was being confused because the file view was showing them misalligned, but it's because you're mixing tabs and spaces, PHPT files should be space indented.

moniang · 2022-01-14T02:42:07Z

I hope it will pass the voting phase, although it is unlikely.

JordanRL added 5 commits August 11, 2021 11:10

Initial commit of user defined operator overloads

58a1456

Added InvalidOperator exception and fixed error handling of operator …

c46492d

…overloads + whitespace errors

Started on ZEND_IS_LARGER work

6811080

Further implementation of op overloads

4a84a91

Finished implementation of compare and updated several tests; added s…

6be3d1a

…pecial cases

JordanRL added 2 commits August 20, 2021 15:47

Fixing various comparison issues and making comparison optional

5fe2ad1

Added bitwise operators and updated several tests

ff79f94

krakjoe added the RFC label Aug 31, 2021

JordanRL added 19 commits November 26, 2021 13:03

Interim commit

88bd550

Resolving merge conflicts

0a0d9ec

Improvements to operator overloads and IS_LARGER opcode

2fa6d98

Fixing some bugs

a2c3f15

Updating extensions for changes to objects and ZEND_UNCOMPARABLE

80497fc

Resolving failing tests for operator overloads

3953f37

Fixing extension handling for object compare handler

6fe6fe2

Updating pow test

ae584fb

Fixing fallback from __equals to __compareto, and fixing named_params…

0ca2ad0

… related SIGSEGV

Resolving some build errors in CI

ce042d1

Resolving a missed build error in CI

0139183

Resolving SIGSEGV

1e3038f

removing ZEND_USER_FUNCTION set

f3a44b8

Removing test code

96d72ce

Removing old comment

cfda296

Merge branch 'master' into operator-overloads

bbcaf38

Trying JIT handling

b23f4e7

Fixing typo in case

5ebaed4

Another case typo

b042c7d

bwoebi and others added 7 commits December 3, 2021 17:03

Use operator keyword instead of magic methods

29ddc0d

Merge pull request #3 from bwoebi/operator-overloads

faab4f2

Use operator keyword instead of magic methods

Use operator keyword instead of magic methods

3697f39

Merge pull request #4 from bwoebi/operator-overloads

52f3f09

Use operator keyword instead of magic methods

Updating InvalidOperatorError name

fc3a89c

Adding more tests for op overloads

9afc789

Resolving more memory leaks and segfaults

e044f53

iluuu1994 reviewed Dec 5, 2021

View reviewed changes

JordanRL added 2 commits December 8, 2021 17:44

Switched to OperandPosition enum

3bae673

Updates

280ad16

ricardoboss reviewed Dec 9, 2021

View reviewed changes

Zend/tests/bug63882.phpt Show resolved Hide resolved

bwoebi and others added 7 commits December 10, 2021 11:39

Fix enum case usage in zend_std_call_op_override

7e1601b

Merge pull request #5 from bwoebi/operator-overloads

5f500bc

Fix enum case usage in zend_std_call_op_override

Adding helper functions for extensions

b0492c4

Disallow direct method calls to operators

3d33ddd

Reflection support for operator overloads

6395654

Merge branch 'master' into operator-overloads

814d9a2

Allowing direct calls via closures

8d1994f

Girgias reviewed Jan 3, 2022

View reviewed changes

JordanRL closed this Jan 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User Defined Operator Overloads #7388

User Defined Operator Overloads #7388

JordanRL commented Aug 18, 2021 •

edited

Loading

HallofFamer commented Aug 19, 2021 •

edited

Loading

JordanRL commented Aug 20, 2021 •

edited

Loading

oprypkhantc commented Aug 20, 2021

iluuu1994 Dec 5, 2021

JordanRL Dec 6, 2021

iluuu1994 Dec 6, 2021

JordanRL Dec 6, 2021

KapitanOczywisty commented Dec 16, 2021

oprypkhantc commented Dec 16, 2021

cmb69 commented Dec 16, 2021

KapitanOczywisty commented Dec 16, 2021

cmb69 commented Dec 16, 2021

KapitanOczywisty commented Dec 16, 2021

skrtdev commented Dec 27, 2021

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

Girgias Jan 3, 2022

moniang commented Jan 14, 2022

	static int zend_std_call_op_override(zend_uchar opcode, zval result, zval op1, zval op2) / {{{ */
	static zend_result zend_std_call_op_override(zend_uchar opcode, zval result, zval op1, zval op2) / {{{ */

		@@ -0,0 +1,80 @@
		--TEST--
		operator overload: reflection for operators

User Defined Operator Overloads #7388

User Defined Operator Overloads #7388

Conversation

JordanRL commented Aug 18, 2021 • edited Loading

HallofFamer commented Aug 19, 2021 • edited Loading

JordanRL commented Aug 20, 2021 • edited Loading

oprypkhantc commented Aug 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KapitanOczywisty commented Dec 16, 2021

oprypkhantc commented Dec 16, 2021

cmb69 commented Dec 16, 2021

KapitanOczywisty commented Dec 16, 2021

cmb69 commented Dec 16, 2021

KapitanOczywisty commented Dec 16, 2021

skrtdev commented Dec 27, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moniang commented Jan 14, 2022

JordanRL commented Aug 18, 2021 •

edited

Loading

HallofFamer commented Aug 19, 2021 •

edited

Loading

JordanRL commented Aug 20, 2021 •

edited

Loading