Add stubs for internal status functions

Author: RogerGee

docs/DOCS.txt

@@ -2186,6 +2186,55 @@ void git_stash_pop(resource $repo,int $index,?array $stash_apply_options)
 
 string git_stash_save(resource $repo,resource $signature,string $message,int $flags)
 
+----------------------------------------
+[git_status]
+----------------------------------------
+
+array git_status_byindex(resource $statuslist,int $idx)
+
+    ** The return array has the following structure: **
+
+        array(3) {
+          ["status"]
+          ["head_to_index"]
+            // git_diff_delta array
+          ["index_to_workdir"]
+            // git_diff_delta array
+        }
+
+    Returns a git_status_entry array
+
+?int|bool git_status_file(resource $repo,string $path)
+
+    The function returns:
+
+        - int: if the path was successfully found, the return value is an
+               integer bitmask containing the status flags
+        - null: the path was ambiguous
+        - false: the path was not found
+
+void git_status_foreach(resource $repo,callable $callback,mixed $payload)
+
+    Callback signature: void callback(string $path,int $status_flag,mixed $payload)
+
+        The function should throw on error.
+
+void git_status_foreach_ext(resource $repo,?array $status_options,callable $callback,mixed $payload)
+
+    See notes on git_status_foreach() for callback signature.
+
+int git_status_list_entrycount(resource $statuslist)
+
+void git_status_list_free(resource $statuslist)
+
+array git_status_list_get_perfdata(resource $statuslist)
+
+resource git_status_list_new(resource $repo,?array $status_options)
+
+    Returns git_status_list resource
+
+bool git_status_should_ignore(resource $repo,string $path)
+
 ----------------------------------------
 [git_tree]
     [git_tree_entry]
@@ -2403,65 +2452,6 @@ git_trace_set(int)
     ** NOTE: this function uses the standard PHP error log to write traces. This
        only works if your libgit2 was built with tracing enabled. **
 
-----------------------------------------
-[git_status]
-----------------------------------------
-
-git_status_byindex(resource,int)
-
-    ** The return array has the following structure: **
-
-        array(3) {
-          ["status"]
-          ["head_to_index"]
-            // git_diff_delta array
-          ["index_to_workdir"]
-            // git_diff_delta array
-        }
-
-    Returns array
-
-git_status_file(resource,string)
-
-    The function returns:
-
-        - int: if the path was successfully found, the return value is an
-               integer bitmask containing the status flags
-        - null: the path was ambiguous
-        - false: the path was not found
-
-    Returns mixed
-
-git_status_foreach(resource,callable,mixed)
-
-    Callback signature: void callback(string $path,int $status_flag,mixed $payload)
-
-        The function should throw on error.
-
-git_status_foreach_ext(resource,array,callable,mixed)
-
-    See notes on git_status_foreach() for callback signature.
-
-git_status_list_entrycount(resource)
-
-    Returns int
-
-git_status_list_free(resource)
-
-git_status_list_get_perfdata(resource)
-
-    Returns array
-
-git_status_list_new(resource,array|null)
-
-    ** Note: The options array is optional. **
-
-    Returns resource
-
-git_status_should_ignore(resource,string)
-
-    Returns bool
-
 ----------------------------------------
 [git_submodule]
 ----------------------------------------

status.h

@@ -6,7 +6,9 @@
 
 #ifndef PHPGIT2_STATUS_H
 #define PHPGIT2_STATUS_H
+
 #include "diff.h"
+#include "stubs/status_arginfo.h"
 
 namespace php_git2
 {

stubs/status.stub.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * @param resource $statuslist
+ */
+function git_status_byindex($statuslist,int $idx) : array {}
+
+/**
+ * @param resource $repo
+ */
+function git_status_file($repo,string $path) : int|bool|null {}
+
+/**
+ * @param resource $repo
+ */
+function git_status_foreach($repo,callable $callback,mixed $payload) : void {}
+
+/**
+ * @param resource $repo
+ */
+function git_status_foreach_ext($repo,?array $status_options,callable $callback,mixed $payload) : void {}
+
+/**
+ * @param resource $statuslist
+ */
+function git_status_list_entrycount($statuslist) : int {}
+
+/**
+ * @param resource $statuslist
+ */
+function git_status_list_free($statuslist) : void {}
+
+/**
+ * @param resource $statuslist
+ */
+function git_status_list_get_perfdata($statuslist) : array {}
+
+/**
+ * @param resource $repo
+ *
+ * @return resource
+ */
+function git_status_list_new($repo,?array $status_options) {}
+
+/**
+ * @param resource $repo
+ */
+function git_status_should_ignore($repo,string $path) : bool {}

stubs/status_arginfo.h

@@ -0,0 +1,47 @@
+/* This is a generated file, edit the .stub.php file instead.
+ * Stub hash: b4368c1ca85b02de91b0b62811f361edfef99c68 */
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_byindex, 0, 2, IS_ARRAY, 0)
+	ZEND_ARG_INFO(0, statuslist)
+	ZEND_ARG_TYPE_INFO(0, idx, IS_LONG, 0)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_git_status_file, 0, 2, MAY_BE_LONG|MAY_BE_BOOL|MAY_BE_NULL)
+	ZEND_ARG_INFO(0, repo)
+	ZEND_ARG_TYPE_INFO(0, path, IS_STRING, 0)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_foreach, 0, 3, IS_VOID, 0)
+	ZEND_ARG_INFO(0, repo)
+	ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
+	ZEND_ARG_TYPE_INFO(0, payload, IS_MIXED, 0)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_foreach_ext, 0, 4, IS_VOID, 0)
+	ZEND_ARG_INFO(0, repo)
+	ZEND_ARG_TYPE_INFO(0, status_options, IS_ARRAY, 1)
+	ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
+	ZEND_ARG_TYPE_INFO(0, payload, IS_MIXED, 0)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_list_entrycount, 0, 1, IS_LONG, 0)
+	ZEND_ARG_INFO(0, statuslist)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_list_free, 0, 1, IS_VOID, 0)
+	ZEND_ARG_INFO(0, statuslist)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_list_get_perfdata, 0, 1, IS_ARRAY, 0)
+	ZEND_ARG_INFO(0, statuslist)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_INFO_EX(arginfo_git_status_list_new, 0, 0, 2)
+	ZEND_ARG_INFO(0, repo)
+	ZEND_ARG_TYPE_INFO(0, status_options, IS_ARRAY, 1)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_git_status_should_ignore, 0, 2, _IS_BOOL, 0)
+	ZEND_ARG_INFO(0, repo)
+	ZEND_ARG_TYPE_INFO(0, path, IS_STRING, 0)
+ZEND_END_ARG_INFO()

stubs/tmp.h

@@ -160,33 +160,6 @@ ZEND_END_ARG_INFO()
 ZEND_BEGIN_ARG_INFO(arginfo_git_trace_set,{})
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_byindex,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_file,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_foreach,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_foreach_ext,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_list_entrycount,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_list_free,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_list_get_perfdata,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_list_new,{})
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_git_status_should_ignore,{})
-ZEND_END_ARG_INFO()
-
 ZEND_BEGIN_ARG_INFO(arginfo_git_submodule_add_finalize,{})
 ZEND_END_ARG_INFO()