Skip to main content

rustjava_runtime/classes/java/lang/
throwable.rs

1use alloc::{boxed::Box, format, vec, vec::Vec};
2
3use jvm::{Array, ClassInstance, ClassInstanceRef, Jvm, Result, runtime::JavaLangString};
4use jvm_class_proto::{JavaFieldProto, JavaMethodProto};
5use jvm_types::{ClassAccessFlags, FieldAccessFlags, MethodAccessFlags};
6
7use crate::{
8    RuntimeClassProto, RuntimeContext,
9    classes::java::{
10        io::{PrintStream, PrintWriter},
11        lang::String,
12    },
13};
14
15// class java.lang.Throwable
16pub struct Throwable;
17
18impl Throwable {
19    pub fn as_proto() -> RuntimeClassProto {
20        RuntimeClassProto {
21            name: "java/lang/Throwable",
22            parent_class: Some("java/lang/Object"),
23            interfaces: vec!["java/io/Serializable"],
24            methods: vec![
25                JavaMethodProto::new("<init>", "()V", Self::init, MethodAccessFlags::PUBLIC),
26                JavaMethodProto::new("<init>", "(Ljava/lang/String;)V", Self::init_with_message, MethodAccessFlags::PUBLIC),
27                JavaMethodProto::new("<init>", "(Ljava/lang/Throwable;)V", Self::init_with_cause, MethodAccessFlags::PUBLIC),
28                JavaMethodProto::new(
29                    "<init>",
30                    "(Ljava/lang/String;Ljava/lang/Throwable;)V",
31                    Self::init_with_message_and_cause,
32                    MethodAccessFlags::PUBLIC,
33                ),
34                JavaMethodProto::new(
35                    "getCause",
36                    "()Ljava/lang/Throwable;",
37                    Self::get_cause,
38                    MethodAccessFlags::PUBLIC | MethodAccessFlags::SYNCHRONIZED,
39                ),
40                JavaMethodProto::new("getMessage", "()Ljava/lang/String;", Self::get_message, MethodAccessFlags::PUBLIC),
41                JavaMethodProto::new(
42                    "getLocalizedMessage",
43                    "()Ljava/lang/String;",
44                    Self::get_localized_message,
45                    MethodAccessFlags::PUBLIC,
46                ),
47                JavaMethodProto::new(
48                    "initCause",
49                    "(Ljava/lang/Throwable;)Ljava/lang/Throwable;",
50                    Self::init_cause,
51                    MethodAccessFlags::PUBLIC | MethodAccessFlags::SYNCHRONIZED,
52                ),
53                JavaMethodProto::new("toString", "()Ljava/lang/String;", Self::to_string, MethodAccessFlags::PUBLIC),
54                JavaMethodProto::new(
55                    "fillInStackTrace",
56                    "()Ljava/lang/Throwable;",
57                    Self::fill_in_stack_trace,
58                    MethodAccessFlags::PUBLIC | MethodAccessFlags::SYNCHRONIZED,
59                ),
60                JavaMethodProto::new("printStackTrace", "()V", Self::print_stack_trace, MethodAccessFlags::PUBLIC),
61                JavaMethodProto::new(
62                    "printStackTrace",
63                    "(Ljava/io/PrintStream;)V",
64                    Self::print_stack_trace_to_print_stream,
65                    MethodAccessFlags::PUBLIC,
66                ),
67                JavaMethodProto::new(
68                    "printStackTrace",
69                    "(Ljava/io/PrintWriter;)V",
70                    Self::print_stack_trace_to_print_writer,
71                    MethodAccessFlags::PUBLIC,
72                ),
73            ],
74            fields: vec![
75                JavaFieldProto::new("detailMessage", "Ljava/lang/String;", FieldAccessFlags::PRIVATE),
76                JavaFieldProto::new("cause", "Ljava/lang/Throwable;", FieldAccessFlags::PRIVATE),
77                JavaFieldProto::new("stackTrace", "[Ljava/lang/String;", FieldAccessFlags::PRIVATE),
78            ],
79            access_flags: ClassAccessFlags::PUBLIC,
80        }
81    }
82
83    async fn init(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<()> {
84        tracing::debug!("java.lang.Throwable::<init>({this:?})");
85
86        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
87
88        let _: ClassInstanceRef<Self> = jvm
89            .invoke_virtual(&this, "java/lang/Throwable", "fillInStackTrace", "()Ljava/lang/Throwable;", ())
90            .await?;
91
92        Ok(())
93    }
94
95    async fn init_with_message(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>, message: ClassInstanceRef<String>) -> Result<()> {
96        tracing::debug!("java.lang.Throwable::<init>({this:?}, {message:?})");
97
98        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
99
100        jvm.put_field(&mut this, "detailMessage", "Ljava/lang/String;", message).await?;
101
102        let _: ClassInstanceRef<Self> = jvm
103            .invoke_virtual(&this, "java/lang/Throwable", "fillInStackTrace", "()Ljava/lang/Throwable;", ())
104            .await?;
105
106        Ok(())
107    }
108
109    async fn init_with_cause(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>, cause: ClassInstanceRef<Self>) -> Result<()> {
110        tracing::debug!("java.lang.Throwable::<init>({this:?}, {cause:?})");
111
112        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
113
114        let message: ClassInstanceRef<String> = if cause.is_null() {
115            None.into()
116        } else {
117            jvm.invoke_virtual(&cause, "java/lang/Object", "toString", "()Ljava/lang/String;", ())
118                .await?
119        };
120        jvm.put_field(&mut this, "detailMessage", "Ljava/lang/String;", message).await?;
121        jvm.put_field(&mut this, "cause", "Ljava/lang/Throwable;", cause).await?;
122
123        let _: ClassInstanceRef<Self> = jvm
124            .invoke_virtual(&this, "java/lang/Throwable", "fillInStackTrace", "()Ljava/lang/Throwable;", ())
125            .await?;
126
127        Ok(())
128    }
129
130    async fn init_with_message_and_cause(
131        jvm: &Jvm,
132        _: &mut RuntimeContext,
133        mut this: ClassInstanceRef<Self>,
134        message: ClassInstanceRef<String>,
135        cause: ClassInstanceRef<Self>,
136    ) -> Result<()> {
137        tracing::debug!("java.lang.Throwable::<init>({this:?}, {message:?}, {cause:?})");
138
139        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
140
141        jvm.put_field(&mut this, "detailMessage", "Ljava/lang/String;", message).await?;
142        jvm.put_field(&mut this, "cause", "Ljava/lang/Throwable;", cause).await?;
143
144        let _: ClassInstanceRef<Self> = jvm
145            .invoke_virtual(&this, "java/lang/Throwable", "fillInStackTrace", "()Ljava/lang/Throwable;", ())
146            .await?;
147
148        Ok(())
149    }
150
151    async fn get_cause(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<Self>> {
152        tracing::debug!("java.lang.Throwable::getCause({this:?})");
153
154        jvm.get_field(&this, "cause", "Ljava/lang/Throwable;").await
155    }
156
157    async fn get_message(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<String>> {
158        tracing::debug!("java.lang.Throwable::getMessage({this:?})");
159
160        jvm.get_field(&this, "detailMessage", "Ljava/lang/String;").await
161    }
162
163    async fn get_localized_message(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<String>> {
164        tracing::debug!("java.lang.Throwable::getLocalizedMessage({this:?})");
165
166        jvm.invoke_virtual(&this, "java/lang/Throwable", "getMessage", "()Ljava/lang/String;", ())
167            .await
168    }
169
170    async fn init_cause(
171        jvm: &Jvm,
172        _: &mut RuntimeContext,
173        mut this: ClassInstanceRef<Self>,
174        cause: ClassInstanceRef<Self>,
175    ) -> Result<ClassInstanceRef<Self>> {
176        tracing::debug!("java.lang.Throwable::initCause({this:?}, {cause:?})");
177
178        jvm.put_field(&mut this, "cause", "Ljava/lang/Throwable;", cause).await?;
179
180        Ok(this)
181    }
182
183    async fn fill_in_stack_trace(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<Self>> {
184        tracing::debug!("java.lang.Throwable::fillInStackTrace({this:?})");
185
186        let stack_trace = jvm.stack_trace();
187        let mut stack_trace_array = jvm.instantiate_array("Ljava/lang/String;", stack_trace.len()).await?;
188        for (i, line) in stack_trace.iter().enumerate() {
189            let java_line = JavaLangString::from_rust_string(jvm, line).await?;
190            jvm.store_array(&mut stack_trace_array, i, core::iter::once(java_line)).await?;
191        }
192        jvm.put_field(&mut this, "stackTrace", "[Ljava/lang/String;", stack_trace_array).await?;
193
194        Ok(this)
195    }
196
197    async fn print_stack_trace(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<()> {
198        tracing::debug!("java.lang.Throwable::printStackTrace({this:?})");
199
200        let err: ClassInstanceRef<PrintStream> = jvm.get_static_field("java/lang/System", "err", "Ljava/io/PrintStream;").await?;
201
202        let _: () = jvm
203            .invoke_virtual(&this, "java/lang/Throwable", "printStackTrace", "(Ljava/io/PrintStream;)V", (err,))
204            .await?;
205
206        Ok(())
207    }
208
209    async fn print_stack_trace_to_print_stream(
210        jvm: &Jvm,
211        _: &mut RuntimeContext,
212        this: ClassInstanceRef<Self>,
213        stream: ClassInstanceRef<PrintStream>,
214    ) -> Result<()> {
215        tracing::debug!("java.lang.Throwable::printStackTrace({this:?}, {stream:?})");
216
217        Self::do_print_stack_trace(jvm, this, stream.into()).await?;
218
219        Ok(())
220    }
221
222    async fn print_stack_trace_to_print_writer(
223        jvm: &Jvm,
224        _: &mut RuntimeContext,
225        this: ClassInstanceRef<Self>,
226        writer: ClassInstanceRef<PrintWriter>,
227    ) -> Result<()> {
228        tracing::debug!("java.lang.Throwable::printStackTrace({this:?}, {writer:?})");
229
230        Self::do_print_stack_trace(jvm, this, writer.into()).await?;
231
232        Ok(())
233    }
234
235    async fn to_string(jvm: &Jvm, _: &mut RuntimeContext, this: ClassInstanceRef<Self>) -> Result<ClassInstanceRef<String>> {
236        tracing::debug!("java.lang.Throwable::toString({this:?})");
237
238        let class = jvm
239            .invoke_virtual(&this, "java/lang/Object", "getClass", "()Ljava/lang/Class;", ())
240            .await?;
241        let class_name = jvm
242            .invoke_virtual(&class, "java/lang/Class", "getName", "()Ljava/lang/String;", ())
243            .await?;
244
245        let message: ClassInstanceRef<String> = jvm.get_field(&this, "detailMessage", "Ljava/lang/String;").await?;
246
247        let class_name = JavaLangString::to_rust_string(jvm, &class_name).await?;
248        let message = if message.is_null() {
249            class_name
250        } else {
251            let message = JavaLangString::to_rust_string(jvm, &message).await?;
252            if message.is_empty() {
253                class_name
254            } else {
255                format!("{class_name}: {message}")
256            }
257        };
258
259        let message = JavaLangString::from_rust_string(jvm, &message).await?;
260
261        Ok(message.into())
262    }
263
264    async fn do_print_stack_trace(jvm: &Jvm, this: ClassInstanceRef<Self>, stream_or_writer: Box<dyn ClassInstance>) -> Result<()> {
265        let mut current: ClassInstanceRef<Self> = this;
266        let mut header: Option<&str> = None;
267
268        // a malformed initCause could create a cycle, so cap the depth
269        for _ in 0..32 {
270            let string: ClassInstanceRef<String> = jvm
271                .invoke_virtual(&current, "java/lang/Object", "toString", "()Ljava/lang/String;", ())
272                .await?;
273            let prefix: ClassInstanceRef<String> = match header {
274                Some(x) => {
275                    let string = JavaLangString::to_rust_string(jvm, &string).await?;
276                    JavaLangString::from_rust_string(jvm, &format!("{x}{string}")).await?.into()
277                }
278                None => string,
279            };
280            let _: () = jvm
281                .invoke_virtual(
282                    &stream_or_writer,
283                    &stream_or_writer.class_definition().name(),
284                    "println",
285                    "(Ljava/lang/String;)V",
286                    (prefix,),
287                )
288                .await?;
289
290            let stack_trace: ClassInstanceRef<Array<ClassInstanceRef<String>>> = jvm.get_field(&current, "stackTrace", "[Ljava/lang/String;").await?;
291            if !stack_trace.is_null() {
292                let length = jvm.array_length(&stack_trace).await?;
293                let lines: Vec<ClassInstanceRef<String>> = jvm.load_array(&stack_trace, 0, length).await?;
294                for line_ref in lines {
295                    let line = JavaLangString::to_rust_string(jvm, &line_ref).await?;
296                    let line = format!("\tat {line}");
297                    let line = JavaLangString::from_rust_string(jvm, &line).await?;
298                    let _: () = jvm
299                        .invoke_virtual(
300                            &stream_or_writer,
301                            &stream_or_writer.class_definition().name(),
302                            "println",
303                            "(Ljava/lang/String;)V",
304                            (line,),
305                        )
306                        .await?;
307                }
308            }
309
310            let cause: ClassInstanceRef<Self> = jvm
311                .invoke_virtual(&current, "java/lang/Throwable", "getCause", "()Ljava/lang/Throwable;", ())
312                .await?;
313            if cause.is_null() {
314                break;
315            }
316            current = cause;
317            header = Some("Caused by: ");
318        }
319
320        Ok(())
321    }
322}