Skip to content

Java Class Definer

Java Class Definer

Bases: type

Class Function Implementation Guidelines:

Python functions (including init): Use native Python types (e.g., str, int) for all inputs and outputs.

Simulated Java functions (@java_method_def): Use Java types (e.g., String, Integer) for all inputs and outputs, except for the 8 primitive types. Note: Distinguish Integer (object) from int (primitive).

Primitive return types: Map Java integers to Python int, and Java float/double to Python float.

Source code in androidemu/java/class_def.py
class JavaClassDef(type):
    """
    Class Function Implementation Guidelines:

    Python functions (including __init__): Use native Python types (e.g., str, int) for all inputs and outputs.

    Simulated Java functions (@java_method_def): Use Java types (e.g., String, Integer) for all inputs and outputs, except for the 8 primitive types. Note: Distinguish Integer (object) from int (primitive).

    Primitive return types: Map Java integers to Python int, and Java float/double to Python float.
    """

    def __init__(cls, name, base, ns, jvm_name=None, jvm_fields=None, jvm_ignore=False, jvm_super=None):
        cls.jvm_id:         int                         = next_cls_id()
        cls.jvm_name:       str                         = jvm_name
        cls.jvm_methods:    Dict[int, 'JavaMethodDef']  = dict()
        cls.jvm_fields:     Dict[int, 'JavaFieldDef']   = dict()
        cls.jvm_ignore:     bool                        = jvm_ignore
        cls.jvm_super:      'JavaClassDef'              = jvm_super
        cls.class_object:   'JavaClassDef'              = None

        cls._name_sig_cache = {}

        # Register all defined Java methods.
        for member_name, member_obj in inspect.getmembers(cls):
            real_obj = member_obj
            if isinstance(member_obj, staticmethod):
                real_obj = member_obj.__func__

            if hasattr(real_obj, 'jvm_method'):
                method = real_obj.jvm_method
                cls.jvm_methods[method.jvm_id] = method
                cls._name_sig_cache[(method.name, method.signature)] = method

        # Register all defined Java fields.
        if jvm_fields is not None:
            for jvm_field in jvm_fields:
                cls.jvm_fields[jvm_field.jvm_id] = jvm_field
        type.__init__(cls, name, base, ns)

    def __new__(cls, name, base, ns, **kargs):
        return type.__new__(cls, name, base, ns)

    # def register_native(cls, name, signature, ptr_func) -> None:
    #     found = False

    #     # Search for a defined jvm method.
    #     for method in cls.jvm_methods.values():
    #         if method.name == name and method.signature == signature:
    #             method.native_addr = ptr_func
    #             found = True
    #             break

    #     if not found:
    #         raise RuntimeError("Register native ('%s', '%s') failed on class %s. Not found method" % (name, signature, cls.__name__))

    def register_native(cls, name, signature, ptr_func) -> None:
        found = False

        for method in cls.jvm_methods.values():
            if method.name == name and method.signature == signature:
                method.native_addr = ptr_func
                found = True
                break

        if not found:
            from .method_def import JavaMethodDef
            method = JavaMethodDef(name, None, name, signature, native=True)
            method.native_addr = ptr_func
            cls.jvm_methods[method.jvm_id] = method
            cls._name_sig_cache[(name, signature)] = method

    def find_method(cls, name: str, signature: str) -> 'JavaMethodDef':
        """
        Find a PyMethod by its name and signature

        :param name: Name
        :param signature: Signature
        :return: PyMethod
        """
        method = cls._name_sig_cache.get((name, signature))
        if method:
            return method
        if cls.jvm_super is not None:
            return cls.jvm_super.find_method(name, signature)
        return None

    def find_method_sig_with_no_ret(cls, name, signature_no_ret) -> None:
        """
        Used to support Java reflection; Java reflection signatures have no return values.
        @param signature_no_ret: something like (ILjava/lang/String;).
        """
        assert signature_no_ret[0] == "(" and signature_no_ret[len(signature_no_ret)-1] == ")", "signature_no_ret error"
        for method in cls.jvm_methods.values():
            if method.name == name and method.signature.startswith(signature_no_ret):
                return method

        if (cls.jvm_super is not None):
            return cls.jvm_super.find_method_sig_with_no_ret(name, signature_no_ret)
        return None


    def find_method_by_id(cls, jvm_id: int) -> 'JavaMethodDef':
        """
        Find a PyMethod by its ID

        :param jvm_id: ID
        :return: PyMethod
        """
        if (jvm_id in cls.jvm_methods):
            return cls.jvm_methods[jvm_id]
        if cls.jvm_super is not None:
            return cls.jvm_super.find_method_by_id(jvm_id)
        return None

    def find_field(cls, name: str, signature: str, is_static: bool) -> 'JavaFieldDef':
        """
        Find a PyField by its name and signature

        :param name: Name
        :param signature: Signature
        :return: PyField
        """
        for field in cls.jvm_fields.values():
            if field.name == name and field.signature == signature and field.is_static == is_static:
                return field

        if (cls.jvm_super is not None):
            return cls.jvm_super.find_field(name, signature, is_static)

        return None

    def find_field_by_id(cls, jvm_id: int) -> 'JavaFieldDef':
        """
        Find a PyField by its ID

        :param jvm_id: ID
        :return: PyField
        """
        if (jvm_id in cls.jvm_fields):
            return cls.jvm_fields[jvm_id]
        if cls.jvm_super is not None:
            return cls.jvm_super.find_field_by_id(jvm_id)
        return None

find_field(name, signature, is_static)

Find a PyField by its name and signature

Parameters:

Name Type Description Default
name str

Name

required
signature str

Signature

required

Returns:

Type Description
JavaFieldDef

PyField

Source code in androidemu/java/class_def.py
def find_field(cls, name: str, signature: str, is_static: bool) -> 'JavaFieldDef':
    """
    Find a PyField by its name and signature

    :param name: Name
    :param signature: Signature
    :return: PyField
    """
    for field in cls.jvm_fields.values():
        if field.name == name and field.signature == signature and field.is_static == is_static:
            return field

    if (cls.jvm_super is not None):
        return cls.jvm_super.find_field(name, signature, is_static)

    return None

find_field_by_id(jvm_id)

Find a PyField by its ID

Parameters:

Name Type Description Default
jvm_id int

ID

required

Returns:

Type Description
JavaFieldDef

PyField

Source code in androidemu/java/class_def.py
def find_field_by_id(cls, jvm_id: int) -> 'JavaFieldDef':
    """
    Find a PyField by its ID

    :param jvm_id: ID
    :return: PyField
    """
    if (jvm_id in cls.jvm_fields):
        return cls.jvm_fields[jvm_id]
    if cls.jvm_super is not None:
        return cls.jvm_super.find_field_by_id(jvm_id)
    return None

find_method(name, signature)

Find a PyMethod by its name and signature

Parameters:

Name Type Description Default
name str

Name

required
signature str

Signature

required

Returns:

Type Description
JavaMethodDef

PyMethod

Source code in androidemu/java/class_def.py
def find_method(cls, name: str, signature: str) -> 'JavaMethodDef':
    """
    Find a PyMethod by its name and signature

    :param name: Name
    :param signature: Signature
    :return: PyMethod
    """
    method = cls._name_sig_cache.get((name, signature))
    if method:
        return method
    if cls.jvm_super is not None:
        return cls.jvm_super.find_method(name, signature)
    return None

find_method_by_id(jvm_id)

Find a PyMethod by its ID

Parameters:

Name Type Description Default
jvm_id int

ID

required

Returns:

Type Description
JavaMethodDef

PyMethod

Source code in androidemu/java/class_def.py
def find_method_by_id(cls, jvm_id: int) -> 'JavaMethodDef':
    """
    Find a PyMethod by its ID

    :param jvm_id: ID
    :return: PyMethod
    """
    if (jvm_id in cls.jvm_methods):
        return cls.jvm_methods[jvm_id]
    if cls.jvm_super is not None:
        return cls.jvm_super.find_method_by_id(jvm_id)
    return None

find_method_sig_with_no_ret(name, signature_no_ret)

Used to support Java reflection; Java reflection signatures have no return values. @param signature_no_ret: something like (ILjava/lang/String;).

Source code in androidemu/java/class_def.py
def find_method_sig_with_no_ret(cls, name, signature_no_ret) -> None:
    """
    Used to support Java reflection; Java reflection signatures have no return values.
    @param signature_no_ret: something like (ILjava/lang/String;).
    """
    assert signature_no_ret[0] == "(" and signature_no_ret[len(signature_no_ret)-1] == ")", "signature_no_ret error"
    for method in cls.jvm_methods.values():
        if method.name == name and method.signature.startswith(signature_no_ret):
            return method

    if (cls.jvm_super is not None):
        return cls.jvm_super.find_method_sig_with_no_ret(name, signature_no_ret)
    return None