mir_php/

stubs.rs

/// Built-in PHP function and class stubs.
///
/// Provides arities for core PHP functions and common extensions so the
/// analyser does not flag standard-library calls as undefined.
///
/// Each entry is `(name, required_args, max_args)`.
/// `usize::MAX` means variadic (no upper bound).

/// Arity bounds for a built-in callable.
#[derive(Debug, Clone, Copy)]
pub struct Arity {
    pub required: usize,
    pub max: usize,
}

/// Look up the arity of a built-in PHP function by name.
/// Returns `None` if the name is not a known built-in.
pub fn function_arity(name: &str) -> Option<Arity> {
    BUILTIN_FUNCTIONS
        .binary_search_by_key(&name, |&(n, _, _)| n)
        .ok()
        .map(|i| {
            let (_, req, max) = BUILTIN_FUNCTIONS[i];
            Arity { required: req, max }
        })
}

/// True if `name` is a known built-in class / interface / exception.
pub fn is_builtin_class(name: &str) -> bool {
    BUILTIN_CLASSES
        .binary_search_by_key(&name, |&n| n)
        .is_ok()
}

/// Sorted list of built-in PHP function names with (required, max) arg counts.
/// `usize::MAX` means variadic. Must stay sorted for binary search.
pub static BUILTIN_FUNCTIONS: &[(&str, usize, usize)] = &[
    ("abs", 1, 1),
    ("array_chunk", 2, 3),
    ("array_column", 2, 3),
    ("array_combine", 2, 2),
    ("array_diff", 1, usize::MAX),
    ("array_diff_assoc", 1, usize::MAX),
    ("array_diff_key", 1, usize::MAX),
    ("array_fill", 3, 3),
    ("array_filter", 1, 3),
    ("array_flip", 1, 1),
    ("array_intersect", 1, usize::MAX),
    ("array_intersect_key", 1, usize::MAX),
    ("array_key_exists", 2, 2),
    ("array_key_first", 1, 1),
    ("array_key_last", 1, 1),
    ("array_keys", 1, 3),
    ("array_map", 2, usize::MAX),
    ("array_merge", 0, usize::MAX),
    ("array_merge_recursive", 0, usize::MAX),
    ("array_pad", 3, 3),
    ("array_pop", 1, 1),
    ("array_push", 1, usize::MAX),
    ("array_replace", 1, usize::MAX),
    ("array_reverse", 1, 2),
    ("array_search", 2, 3),
    ("array_shift", 1, 1),
    ("array_slice", 2, 4),
    ("array_splice", 2, 4),
    ("array_sum", 1, 1),
    ("array_unique", 1, 2),
    ("array_unshift", 1, usize::MAX),
    ("array_values", 1, 1),
    ("arsort", 1, 2),
    ("asort", 1, 2),
    ("base64_decode", 1, 2),
    ("base64_encode", 1, 1),
    ("base_convert", 3, 3),
    ("basename", 1, 2),
    ("ceil", 1, 1),
    ("chr", 1, 1),
    ("chunk_split", 1, 3),
    ("class_alias", 2, 3),
    ("class_exists", 1, 2),
    ("class_implements", 1, 2),
    ("class_parents", 1, 2),
    ("compact", 1, usize::MAX),
    ("copy", 2, 3),
    ("count", 1, 2),
    ("ctype_alpha", 1, 1),
    ("ctype_digit", 1, 1),
    ("ctype_lower", 1, 1),
    ("ctype_upper", 1, 1),
    ("curl_close", 1, 1),
    ("curl_error", 1, 1),
    ("curl_exec", 1, 1),
    ("curl_getinfo", 1, 2),
    ("curl_init", 0, 1),
    ("curl_setopt", 3, 3),
    ("curl_setopt_array", 2, 2),
    ("date", 1, 2),
    ("date_create", 0, 2),
    ("date_diff", 2, 3),
    ("date_format", 2, 2),
    ("defined", 1, 1),
    ("dirname", 1, 2),
    ("empty", 1, 1),
    ("end", 1, 1),
    ("error_log", 1, 4),
    ("error_reporting", 0, 1),
    ("exec", 1, 3),
    ("explode", 2, 3),
    ("extension_loaded", 1, 1),
    ("extract", 1, 3),
    ("fclose", 1, 1),
    ("feof", 1, 1),
    ("fgets", 1, 2),
    ("file", 1, 3),
    ("file_exists", 1, 1),
    ("file_get_contents", 1, 5),
    ("file_put_contents", 2, 4),
    ("filemtime", 1, 1),
    ("filesize", 1, 1),
    ("floor", 1, 1),
    ("fopen", 2, 4),
    ("fread", 2, 2),
    ("fseek", 2, 3),
    ("function_exists", 1, 2),
    ("fwrite", 2, 3),
    ("get_class", 0, 1),
    ("get_class_methods", 1, 1),
    ("get_declared_classes", 0, 0),
    ("get_object_vars", 1, 1),
    ("getenv", 0, 2),
    ("gettype", 1, 1),
    ("glob", 1, 2),
    ("gmdate", 1, 2),
    ("header", 1, 3),
    ("htmlentities", 1, 4),
    ("htmlspecialchars", 1, 4),
    ("htmlspecialchars_decode", 1, 2),
    ("http_response_code", 0, 1),
    ("implode", 1, 2),
    ("in_array", 2, 3),
    ("ini_get", 1, 1),
    ("ini_set", 2, 2),
    ("interface_exists", 1, 2),
    ("intval", 1, 2),
    ("is_a", 2, 3),
    ("is_array", 1, 1),
    ("is_bool", 1, 1),
    ("is_callable", 1, 3),
    ("is_dir", 1, 1),
    ("is_file", 1, 1),
    ("is_float", 1, 1),
    ("is_int", 1, 1),
    ("is_null", 1, 1),
    ("is_numeric", 1, 1),
    ("is_object", 1, 1),
    ("is_readable", 1, 1),
    ("is_string", 1, 1),
    ("is_subclass_of", 2, 3),
    ("is_writable", 1, 1),
    ("json_decode", 1, 4),
    ("json_encode", 1, 3),
    ("json_last_error", 0, 0),
    ("json_last_error_msg", 0, 0),
    ("krsort", 1, 2),
    ("ksort", 1, 2),
    ("lcfirst", 1, 1),
    ("ltrim", 1, 2),
    ("max", 1, usize::MAX),
    ("mb_convert_encoding", 2, 3),
    ("mb_detect_encoding", 1, 3),
    ("mb_internal_encoding", 0, 1),
    ("mb_strlen", 1, 2),
    ("mb_strpos", 2, 4),
    ("mb_strrpos", 2, 4),
    ("mb_strtolower", 1, 2),
    ("mb_strtoupper", 1, 2),
    ("mb_substr", 2, 4),
    ("md5", 1, 2),
    ("method_exists", 2, 2),
    ("microtime", 0, 1),
    ("min", 1, usize::MAX),
    ("mkdir", 1, 4),
    ("mktime", 0, 6),
    ("number_format", 1, 4),
    ("ob_end_clean", 0, 0),
    ("ob_end_flush", 0, 0),
    ("ob_get_clean", 0, 0),
    ("ob_get_contents", 0, 0),
    ("ob_start", 0, 3),
    ("ord", 1, 1),
    ("pack", 1, usize::MAX),
    ("parse_url", 1, 2),
    ("pathinfo", 1, 2),
    ("phpversion", 0, 1),
    ("preg_match", 2, 5),
    ("preg_match_all", 2, 5),
    ("preg_quote", 1, 2),
    ("preg_replace", 3, 5),
    ("preg_replace_callback", 3, 5),
    ("preg_split", 2, 4),
    ("print_r", 1, 2),
    ("property_exists", 2, 2),
    ("range", 2, 3),
    ("rawurldecode", 1, 1),
    ("rawurlencode", 1, 1),
    ("realpath", 1, 1),
    ("rename", 2, 3),
    ("reset", 1, 1),
    ("rmdir", 1, 2),
    ("round", 1, 3),
    ("rtrim", 1, 2),
    ("serialize", 1, 1),
    ("session_destroy", 0, 0),
    ("session_id", 0, 1),
    ("session_name", 0, 1),
    ("session_start", 0, 1),
    ("setcookie", 1, 7),
    ("sha1", 1, 2),
    ("sleep", 1, 1),
    ("sort", 1, 2),
    ("sprintf", 1, usize::MAX),
    ("sqrt", 1, 1),
    ("srand", 0, 2),
    ("str_contains", 2, 2),
    ("str_ends_with", 2, 2),
    ("str_pad", 2, 4),
    ("str_repeat", 2, 2),
    ("str_replace", 3, 4),
    ("str_split", 1, 2),
    ("str_starts_with", 2, 2),
    ("str_word_count", 1, 3),
    ("strcasecmp", 2, 2),
    ("strcmp", 2, 2),
    ("strip_tags", 1, 2),
    ("stripslashes", 1, 1),
    ("strlen", 1, 1),
    ("strncmp", 3, 3),
    ("strpos", 2, 3),
    ("strrchr", 2, 2),
    ("strrev", 1, 1),
    ("strrpos", 2, 3),
    ("strstr", 2, 3),
    ("strtok", 1, 2),
    ("strtolower", 1, 1),
    ("strtotime", 1, 2),
    ("strtoupper", 1, 1),
    ("strval", 1, 1),
    ("substr", 2, 3),
    ("substr_count", 2, 4),
    ("substr_replace", 3, 4),
    ("sys_get_temp_dir", 0, 0),
    ("time", 0, 0),
    ("touch", 1, 3),
    ("trigger_error", 1, 2),
    ("trim", 1, 2),
    ("uasort", 2, 2),
    ("ucfirst", 1, 1),
    ("ucwords", 1, 2),
    ("uksort", 2, 2),
    ("unlink", 1, 2),
    ("unserialize", 1, 2),
    ("urldecode", 1, 1),
    ("urlencode", 1, 1),
    ("usort", 2, 2),
    ("var_dump", 1, usize::MAX),
    ("var_export", 1, 2),
    ("wordwrap", 1, 4),
];

/// Sorted list of built-in PHP class / interface / exception names.
static BUILTIN_CLASSES: &[&str] = &[
    "ArrayAccess",
    "ArrayIterator",
    "ArrayObject",
    "BadFunctionCallException",
    "BadMethodCallException",
    "Closure",
    "Countable",
    "DateInterval",
    "DateTime",
    "DateTimeImmutable",
    "DateTimeInterface",
    "DateTimeZone",
    "DirectoryIterator",
    "DomainException",
    "Error",
    "Exception",
    "FilesystemIterator",
    "Generator",
    "GlobIterator",
    "InfiniteIterator",
    "InvalidArgumentException",
    "Iterator",
    "IteratorAggregate",
    "JsonSerializable",
    "LengthException",
    "LogicException",
    "OutOfBoundsException",
    "OutOfRangeException",
    "OverflowException",
    "PDO",
    "PDOException",
    "PDOStatement",
    "RangeException",
    "RecursiveArrayIterator",
    "RecursiveDirectoryIterator",
    "RecursiveIterator",
    "RecursiveIteratorIterator",
    "ReflectionClass",
    "ReflectionException",
    "ReflectionFunction",
    "ReflectionMethod",
    "ReflectionProperty",
    "RuntimeException",
    "Serializable",
    "SplDoublyLinkedList",
    "SplFileInfo",
    "SplFileObject",
    "SplFixedArray",
    "SplMaxHeap",
    "SplMinHeap",
    "SplPriorityQueue",
    "SplQueue",
    "SplStack",
    "Stringable",
    "Throwable",
    "TypeError",
    "UnderflowException",
    "UnexpectedValueException",
    "ValueError",
    "WeakMap",
    "WeakReference",
    "stdClass",
];

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn builtin_functions_are_sorted() {
        for pair in BUILTIN_FUNCTIONS.windows(2) {
            assert!(
                pair[0].0 <= pair[1].0,
                "out of order: '{}' before '{}'",
                pair[0].0,
                pair[1].0
            );
        }
    }

    #[test]
    fn builtin_classes_are_sorted() {
        for pair in BUILTIN_CLASSES.windows(2) {
            assert!(pair[0] <= pair[1], "out of order: '{}' before '{}'", pair[0], pair[1]);
        }
    }

    #[test]
    fn strlen_is_known() {
        assert!(function_arity("strlen").is_some());
    }

    #[test]
    fn pdo_is_builtin_class() {
        assert!(is_builtin_class("PDO"));
    }

    #[test]
    fn unknown_function_is_none() {
        assert!(function_arity("totally_unknown_fn_xyz").is_none());
    }
}