Add stubs for ext-expect (#761)

* Add stubs for ext-expect

Co-authored-by: Aleksander Movsesov <aleksander.movsesov@jetbrains.com>

PhpStormStubsMap.php

@@ -1733,6 +1733,8 @@ const FUNCTIONS = array (
   'exif_tagname' => 'exif/exif.php',
   'exif_thumbnail' => 'exif/exif.php',
   'exp' => 'standard/standard_3.php',
+  'expect_expectl' => 'expect/expect.php',
+  'expect_popen' => 'expect/expect.php',
   'explode' => 'standard/standard_1.php',
   'expm1' => 'standard/standard_3.php',
   'extension_loaded' => 'Core/Core.php',
@@ -6304,6 +6306,12 @@ const CONSTANTS = array (
   'EV_TIMEOUT' => 'libevent/libevent.php',
   'EV_WRITE' => 'libevent/libevent.php',
   'EXIF_USE_MBSTRING' => 'exif/exif.php',
+  'EXP_EOF' => 'expect/expect.php',
+  'EXP_EXACT' => 'expect/expect.php',
+  'EXP_FULLBUFFER' => 'expect/expect.php',
+  'EXP_GLOB' => 'expect/expect.php',
+  'EXP_REGEXP' => 'expect/expect.php',
+  'EXP_TIMEOUT' => 'expect/expect.php',
   'EXTR_IF_EXISTS' => 'standard/standard_defines.php',
   'EXTR_OVERWRITE' => 'standard/standard_defines.php',
   'EXTR_PREFIX_ALL' => 'standard/standard_defines.php',

expect/expect.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * Indicates that the pattern is a glob-style string pattern.
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_GLOB = 1;
+/**
+ * Indicates that the pattern is an exact string.
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_EXACT = 2;
+/**
+ * Indicates that the pattern is a regexp-style string pattern.
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_REGEXP = 3;
+/**
+ * Value, returned by <em>expect_expectl()</em>, when <b>EOF</b> is reached.
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_EOF = -11;
+/**
+ * Value, returned by <em>expect_expectl()</em> upon timeout of seconds, specified in value of <b>expect.timeout</b>
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_TIMEOUT = -2;
+/**
+ * Value, returned by <em>expect_expectl()</em> if no pattern have been matched.
+ * @link https://www.php.net/manual/en/expect.constants.php
+ */
+const EXP_FULLBUFFER = -5;
+
+/**
+ * Execute command via Bourne shell, and open the PTY stream to the process
+ *
+ * @param string $command Command to execute.
+ * @return resource|false Returns an open PTY stream to the processes stdio, stdout, and stderr.
+ *                        On failure this function returns FALSE.
+ * @since PECL expect >= 0.1.0
+ * @link https://www.php.net/manual/en/function.expect-popen.php
+ */
+function expect_popen(string $command)
+{
+	unset($command);
+	return false;
+}
+
+/**
+ * Waits until the output from a process matches one of the patterns, a specified time period has passed,
+ * or an EOF is seen.
+ *
+ * If match is provided, then it is filled with the result of search. The matched string can be found in match[0].
+ * The match substrings (according to the parentheses) in the original pattern can be found in match[1], match[2],
+ * and so on, up to match[9] (the limitation of libexpect).
+ *
+ * @param resource $expect An Expect stream, previously opened with expect_popen()
+ * @param array $cases <p>An array of expect cases. Each expect case is an indexed array, as described in the following table:</p>
+ * <p>
+ * <tr valign="top">
+ * <td>Index Key</td>
+ * <td>Value Type</td>
+ * <td>Description</td>
+ * <td>Is Mandatory</td>
+ * <td>Default Value</td>
+ * </tr>
+ * <tr valign="top">
+ * <td>0</td>
+ * <td>string</td>
+ * <td>pattern, that will be matched against the output from the stream</td>
+ * <td>Yes</td>
+ * <td></td>
+ * </tr>
+ * <tr valign="top">
+ * <td>1</td>
+ * <td>mixed</td>
+ * <td>value, that will be returned by this function, if the pattern matches</td>
+ * <td>Yes</td>
+ * <td></td>
+ * </tr>
+ * <tr valign="top">
+ * <td>2</td>
+ * <td>integer</td>
+ * <td>pattern type, one of: <b>EXP_GLOB</b>, <b>EXP_EXACT</b> or <b>EXP_REGEXP</b></td>
+ * <td>No</td>
+ * <td><b>EXP_GLOB</b></td>
+ * </tr>
+ * </p>
+ * @param array $match
+ *
+ * @return int Returns value associated with the pattern that was matched.
+ * 			   On failure this function returns: <b>EXP_EOF</b>, <b>EXP_TIMEOUT</b> or <b>EXP_FULLBUFFER</b>
+ * @since PECL expect >= 0.1.0
+ * @link https://www.php.net/manual/en/function.expect-expectl.php
+ */
+function expect_expectl($expect, array $cases, array &$match = array()): int
+{
+	unset ($expect, $cases, $match);
+	return 0;
+}

meta/.phpstorm.meta.php

@@ -183,6 +183,8 @@ namespace PHPSTORM_META {
     
     expectedArguments(\exif_read_data(), 1, 'FILE', 'COMPUTED', 'ANY_TAG', 'IFD0', 'THUMBNAIL', 'COMMENT', 'EXIF');
 
+    expectedReturnValues(\expect_expectl(), \EXP_EOF, \EXP_TIMEOUT, \EXP_FULLBUFFER);
+
     expectedArguments(\imap_close(), 1, CL_EXPUNGE);
     expectedArguments(\event_base_loop(), 1, EVLOOP_ONCE|EVLOOP_NONBLOCK);
     expectedArguments(\mb_convert_case(), 1, MB_CASE_UPPER,MB_CASE_LOWER,MB_CASE_TITLE);