Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:106526
MIME-Version: 1.0
References: <CAF+90c95GBUbbWUDhP2jW1q9uK3cnEomcwN7xWAup=PhJ0+S1Q@mail.gmail.com>
 <C992EA19-3544-4591-9D37-9F018AE8279C@koalephant.com>
In-Reply-To: <C992EA19-3544-4591-9D37-9F018AE8279C@koalephant.com>
Date: Sat, 10 Aug 2019 15:11:47 +0200
Message-ID: <CAF+90c-n8dUbEowtr_t6VvbuYDD9qxBOPhQU7WaPar1rykW8=A@mail.gmail.com>
To: Stephen Reay <php-lists@koalephant.com>
Cc: PHP internals <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="00000000000087a746058fc30980"
Subject: Re: [PHP-DEV] Call for participation: Annotating internal function
 argument and return types
From: nikita.ppv@gmail.com (Nikita Popov)

--00000000000087a746058fc30980
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Sat, Aug 10, 2019 at 2:00 PM Stephen Reay <php-lists@koalephant.com>
wrote:

>
> > On 10 Aug 2019, at 17:56, Nikita Popov <nikita.ppv@gmail.com> wrote:
> >
> > Hi,
> >
> > Lack of type information for internal functions in Reflection is a
> > long-standing issue. In PHP 8 we finally have all the necessary technic=
al
> > groundwork done to support argument and return type annotations on
> internal
> > functions at scale.
> >
> > The only thing left is to actually add those type annotations ... to ma=
ny
> > hundreds of functions. This is something everyone can help with, as it
> does
> > not need expertise in C.
> >
> > I've opened a sample PR to show the process:
> > https://github.com/php/php-src/pull/4499
> >
> > Here, we take some existing arginfo structures in basic_functions.c and
> > convert them into stubs in basic_functions.stub.php. We can take the
> > argument names from the existing arginfo. To figure out the types, we
> need
> > to look at the implementation (the php.net documentation tends to lie
> about
> > details).
> >
> > For example, the first function, set_time_limit is defined in
> >
> https://github.com/php/php-src/blob/172c71980df0fe4c9d62c3365f0a2cdb139e3=
e86/main/main.c#L1501
> .
> > We see that it accepts an "l" parameter, which is an int. We see that i=
t
> > uses RETVAL_TRUE and RETVAL_FALSE, which means the return value is a
> bool.
> >
> > Once this is done, we need to auto-generate new arginfo data. If you
> have a
> > development setup, this is done automatically when running "make".
> > Otherwise, it's possible to manually run "php scripts/dev/gen_stub.php
> > ext/standard/basic_functions.stub.php".
> >
> > Any help would be appreciated :)
> >
> > Regards,
> > Nikita
>
> I=E2=80=99d like to help if I can.
>
> Some extensions have what appear to be conditional arginfo (for example
> the LDAP extension, which I *assume* is to handle building against
> different versions of underlying ldap library that support different
> features) - is there a way / need to handle those  in this stub format th=
at
> the generator script understands?
>

You can do the same as in the source code:

#ifdef HAVE_LDAP_SASL
function ldap_sasl_bind(...) {}
#endif

These conditions will be carried over in the generated code.

Nikita

--00000000000087a746058fc30980--