Skip to main content

rustjava_runtime/classes/java/lang/ref/
reference.rs

1use alloc::vec;
2
3use jvm::{ClassInstanceRef, Jvm, Result};
4use jvm_class_proto::{JavaFieldProto, JavaMethodProto};
5use jvm_types::{ClassAccessFlags, FieldAccessFlags, MethodAccessFlags};
6
7use crate::{RuntimeClassProto, RuntimeContext, classes::java::lang::Object};
8
9// abstract class java.lang.ref.Reference
10pub struct Reference;
11
12impl Reference {
13    pub fn as_proto() -> RuntimeClassProto {
14        RuntimeClassProto {
15            name: "java/lang/ref/Reference",
16            parent_class: Some("java/lang/Object"),
17            interfaces: vec![],
18            methods: vec![
19                JavaMethodProto::new("<init>", "(Ljava/lang/Object;)V", Self::init, MethodAccessFlags::empty()),
20                JavaMethodProto::new("get", "()Ljava/lang/Object;", Self::get, MethodAccessFlags::PUBLIC),
21                JavaMethodProto::new("clear", "()V", Self::clear, MethodAccessFlags::PUBLIC),
22            ],
23            // the garbage collector does not trace this field and clears it once the referent is otherwise unreachable
24            fields: vec![JavaFieldProto::new("referent", "Ljava/lang/Object;", FieldAccessFlags::PRIVATE)],
25            access_flags: ClassAccessFlags::PUBLIC | ClassAccessFlags::ABSTRACT,
26        }
27    }
28
29    async fn init(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>, referent: ClassInstanceRef<Object>) -> Result<()> {
30        tracing::debug!("java.lang.ref.Reference::<init>({this:?}, {referent:?})");
31
32        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
33        jvm.put_field(&mut this, "java/lang/ref/Reference", "referent", "Ljava/lang/Object;", referent)
34            .await?;
35
36        Ok(())
37    }
38
39    async fn get(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<Object>> {
40        tracing::debug!("java.lang.ref.Reference::get({this:?})");
41
42        jvm.get_field(&this, "java/lang/ref/Reference", "referent", "Ljava/lang/Object;").await
43    }
44
45    async fn clear(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>) -> Result<()> {
46        tracing::debug!("java.lang.ref.Reference::clear({this:?})");
47
48        jvm.put_field(
49            &mut this,
50            "java/lang/ref/Reference",
51            "referent",
52            "Ljava/lang/Object;",
53            ClassInstanceRef::<Object>::new(None),
54        )
55        .await
56    }
57}