Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:111400
To: "internals@lists.php.net" <internals@lists.php.net>
Thread-Topic: Improving the usability of PHP's interactive shell?
 (completions, displaying expression results, custom syntax)
Thread-Index: AQHWXVBlEJWFSBe2+kWGt77QcnGQFKkwIN6X
Date: Sun, 9 Aug 2020 18:46:20 +0000
Message-ID:
 <DM6PR07MB6618D1FF727BC2F8C3B7EB2DF9470@DM6PR07MB6618.namprd07.prod.outlook.com>
References:
 <DM6PR07MB6618AB5EFCE0964816214CF4F97D0@DM6PR07MB6618.namprd07.prod.outlook.com>
In-Reply-To:
 <DM6PR07MB6618AB5EFCE0964816214CF4F97D0@DM6PR07MB6618.namprd07.prod.outlook.com>
Accept-Language: en-CA, en-US
Content-Language: en-CA
x-ms-exchange-messagesentrepresentingtype: 1
x-tmn: [v1mlErNnuGUpDMwmtoo5YmlqO1evjh448fc1N1oC8uO+zb6+fNez5Mn6QHhBzCRj]
x-ms-publictraffictype: Email
x-incomingheadercount: 44
x-eopattributedmessage: 0
x-ms-office365-filtering-correlation-id: 5390922e-c3b7-4aa6-bd5a-08d83c9481b5
x-ms-traffictypediagnostic: DM6NAM12HT117:
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info:
 BoIV1cY3kM5Rhke2Q53Pkv0AVTlD0cghcaoUiGMlMc7fhzB5UCNDtYcnua8mB7gTKEeVRLoFdK/BeD86aLOfPpLcnP/kMBjKoLp6HBKcdmTne7qypG7ON6fi6etNfsGNQtsxDFEoeObeGfhgHnv7qpKBA+fzYTkeo3OLZSTrctw/2W+yWEwy08o5yck/87xFtGllKwrTg8ly9GAxQzdPSGUfucLqfp6YMZ4f2dteoxthztux/G0MPyxyz9Mrch4j
x-forefront-antispam-report:
 CIP:255.255.255.255;CTRY:;LANG:en;SCL:0;SRV:;IPV:NLI;SFV:NSPM;H:DM6PR07MB6618.namprd07.prod.outlook.com;PTR:;CAT:NONE;SFTY:;SFS:;DIR:OUT;SFP:1901;
x-ms-exchange-antispam-messagedata:
 mW5LkkdYska5q2zyxLTZh2Vmg6CRCpD83XgL208JxNJUryIM9keowftdCnqUg8G63Xfguu7NJIuCvr7gTYwg6K2j22NovAKxCLIqP7KpZOG7ncj2UkuacsSZkL+IupvjQioX6KFTahxdp5gSDSsB61rsL7Cfr5aoq1EJm0hAU8dqw96N2hxtHr0xGiwQjFQi75tJ7Q/pEGxX9VxpOPYtww==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: hotmail.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-AuthSource: DM6NAM12FT008.eop-nam12.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-Network-Message-Id: 5390922e-c3b7-4aa6-bd5a-08d83c9481b5
X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-originalarrivaltime: 09 Aug 2020 18:46:20.1203
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Internet
X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6NAM12HT117
Subject: Re: Improving the usability of PHP's interactive shell? (completions,
 displaying expression results, custom syntax)
From: tysonandre775@hotmail.com (tyson andre)

Hi internals,=0A=
=0A=
> - Add a hook to `readline` such as `readline_set_php_result_handler_callb=
ack(function(mixed $result, string $snippet){...})`=0A=
> =A0 that can be used to create a user-defined function to print/process t=
he result of expressions.=0A=
>=A0 (Create a clone of `zend_eval_stringl` to support that)=0A=
> (The result value would instead be freed after the callback was called)=
=0A=
>=0A=
>=A0 Many other REPLs (Read-Eval-Print Loops) that I'm familiar with print =
a representation of the result of expressions, but PHP doesn't.=0A=
=0A=
I've added this in https://github.com/php/php-src/pull/5962 .=0A=
I plan to add a system ini setting that can be used to permanently disable =
this silently (enabled by default in all environments/example configs)=0A=
This will be callable if `readline` is installed, whether or not the shell =
is interactive or the SAPI is CLI.=0A=
- e.g. `cli.allow_interactive_shell_result_function=3D1` would be the defau=
lt. Other existing settings were https://www.php.net/manual/en/readline.con=
figuration.php=0A=
- A buggy handler closure might interfere with people trying to debug issue=
s,=0A=
  which is why the ini setting is proposed.=0A=
=0A=
```=0A=
readline_interactive_shell_result_function(=0A=
    function (string $code, $result) {=0A=
        // echo "Result of: " . trim($code) . "\n";=0A=
        echo json_encode($result) . "\n"; // or var_dump(), etc.=0A=
    });=0A=
```=0A=
=0A=
1. Are there objections to adding this in 8.1 (after adding the described i=
ni setting)?=0A=
2. Thoughts on the name? readline_interactive_shell_result_handler_function=
 probably makes more sense.=0A=
    https://www.php.net/manual/en/function.readline-completion-function.php=
 does something similar.=0A=
=0A=
The unit tests give an example of how this could be used.=0A=
https://github.com/php/php-src/pull/5962/files#diff-153ee3f384d333904c50000=
33bee9803=0A=
=0A=
Thanks,=0A=
- Tyson=