rustjava-runtime 0.5.1

A Java standard library implementation for RustJava
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use alloc::{format, vec, vec::Vec};

use jvm::{Array, ClassInstanceRef, Jvm, Result, runtime::JavaLangString};
use jvm_class_proto::{JavaFieldProto, JavaMethodProto};
use jvm_types::{ClassAccessFlags, FieldAccessFlags, MethodAccessFlags};

use crate::{
    RuntimeClassProto, RuntimeContext,
    classes::java::{
        lang::{Class, String},
        net::URL,
    },
};

// class java.lang.ClassLoader
pub struct ClassLoader;

impl ClassLoader {
    pub fn as_proto() -> RuntimeClassProto {
        RuntimeClassProto {
            name: "java/lang/ClassLoader",
            parent_class: Some("java/lang/Object"),
            interfaces: vec![],
            methods: vec![
                JavaMethodProto::new("<init>", "(Ljava/lang/ClassLoader;)V", Self::init, MethodAccessFlags::PROTECTED),
                JavaMethodProto::new(
                    "loadClass",
                    "(Ljava/lang/String;)Ljava/lang/Class;",
                    Self::load_class,
                    MethodAccessFlags::PUBLIC,
                ),
                JavaMethodProto::new(
                    "findClass",
                    "(Ljava/lang/String;)Ljava/lang/Class;",
                    Self::find_class,
                    MethodAccessFlags::PROTECTED,
                ),
                JavaMethodProto::new(
                    "findLoadedClass",
                    "(Ljava/lang/String;)Ljava/lang/Class;",
                    Self::find_loaded_class,
                    MethodAccessFlags::PROTECTED | MethodAccessFlags::FINAL,
                ),
                JavaMethodProto::new(
                    "getSystemClassLoader",
                    "()Ljava/lang/ClassLoader;",
                    Self::get_system_class_loader,
                    MethodAccessFlags::PUBLIC | MethodAccessFlags::STATIC,
                ),
                JavaMethodProto::new(
                    "getResource",
                    "(Ljava/lang/String;)Ljava/net/URL;",
                    Self::get_resource,
                    MethodAccessFlags::PUBLIC,
                ),
                JavaMethodProto::new(
                    "getResourceAsStream",
                    "(Ljava/lang/String;)Ljava/io/InputStream;",
                    Self::get_resource_as_stream,
                    MethodAccessFlags::PUBLIC,
                ),
                JavaMethodProto::new(
                    "findResource",
                    "(Ljava/lang/String;)Ljava/net/URL;",
                    Self::find_resource,
                    MethodAccessFlags::PROTECTED,
                ),
                JavaMethodProto::new(
                    "defineClass",
                    "(Ljava/lang/String;[BII)Ljava/lang/Class;",
                    Self::define_class,
                    MethodAccessFlags::PROTECTED | MethodAccessFlags::FINAL,
                ),
            ],
            fields: vec![
                JavaFieldProto::new("systemClassLoader", "Ljava/lang/ClassLoader;", FieldAccessFlags::STATIC),
                JavaFieldProto::new("parent", "Ljava/lang/ClassLoader;", FieldAccessFlags::PRIVATE | FieldAccessFlags::FINAL),
            ],
            access_flags: ClassAccessFlags::PUBLIC | ClassAccessFlags::ABSTRACT,
        }
    }

    async fn init(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>, parent: ClassInstanceRef<Self>) -> Result<()> {
        tracing::debug!("java.lang.ClassLoader::<init>({this:?}, {parent:?})");

        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;

        jvm.put_field(&mut this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;", parent)
            .await?;

        Ok(())
    }

    async fn get_system_class_loader(jvm: &Jvm, _: &mut RuntimeContext) -> Result<ClassInstanceRef<Self>> {
        tracing::debug!("java.lang.ClassLoader::getSystemClassLoader()");

        let system_class_loader: ClassInstanceRef<Self> = jvm
            .get_static_field("java/lang/ClassLoader", "systemClassLoader", "Ljava/lang/ClassLoader;")
            .await?;

        if system_class_loader.is_null() {
            let class_path: ClassInstanceRef<String> = jvm
                .invoke_static(
                    "java/lang/System",
                    "getProperty",
                    "(Ljava/lang/String;)Ljava/lang/String;",
                    (JavaLangString::from_rust_string(jvm, "java.class.path").await?,),
                )
                .await?;

            let (class_paths, urls) = if !class_path.is_null() {
                let class_path = JavaLangString::to_rust_string(jvm, &class_path).await?;
                let path_separator: ClassInstanceRef<String> = jvm.get_static_field("java/io/File", "pathSeparator", "Ljava/lang/String;").await?;
                let path_separator = JavaLangString::to_rust_string(jvm, &path_separator).await?;

                let mut class_paths = Vec::new();
                let mut urls = Vec::new();
                for path in class_path.split(path_separator.as_str()) {
                    let path = JavaLangString::from_rust_string(jvm, path).await?;
                    class_paths.push(path.clone());
                    let path = jvm
                        .invoke_static("org/rustjava/net/URLPath", "encode", "(Ljava/lang/String;)Ljava/lang/String;", (path,))
                        .await?;
                    let path = JavaLangString::to_rust_string(jvm, &path).await?;
                    let path = JavaLangString::from_rust_string(jvm, &format!("file:{path}")).await?;
                    let url = jvm.new_class("java/net/URL", "(Ljava/lang/String;)V", (path,)).await?;
                    urls.push(url);
                }

                (class_paths, urls)
            } else {
                (Vec::new(), Vec::new())
            };

            let mut class_path_array = jvm.instantiate_array("Ljava/lang/String;", class_paths.len()).await?;
            jvm.store_array(&mut class_path_array, 0, class_paths).await?;
            let rustjar_class_loader = jvm
                .new_class(
                    "org/rustjava/lang/RustJarClassLoader",
                    "([Ljava/lang/String;Ljava/lang/ClassLoader;)V",
                    (class_path_array, None),
                )
                .await?;

            let mut url_array = jvm.instantiate_array("Ljava/net/URL;", urls.len()).await?;
            jvm.store_array(&mut url_array, 0, urls).await?;

            let url_class_loader = jvm
                .new_class(
                    "java/net/URLClassLoader",
                    "([Ljava/net/URL;Ljava/lang/ClassLoader;)V",
                    (url_array, rustjar_class_loader),
                )
                .await?;

            let class_loader_type: ClassInstanceRef<String> = jvm
                .invoke_static(
                    "java/lang/System",
                    "getProperty",
                    "(Ljava/lang/String;)Ljava/lang/String;",
                    (JavaLangString::from_rust_string(jvm, "java.system.class.loader").await?,),
                )
                .await?;

            let system_class_loader = if !class_loader_type.is_null() {
                let class_loader_type_str = JavaLangString::to_rust_string(jvm, &class_loader_type).await?;
                jvm.new_class(&class_loader_type_str, "(Ljava/lang/ClassLoader;)V", (url_class_loader,))
                    .await?
            } else {
                url_class_loader
            };

            jvm.put_static_field(
                "java/lang/ClassLoader",
                "systemClassLoader",
                "Ljava/lang/ClassLoader;",
                system_class_loader.clone(),
            )
            .await?;

            return Ok(system_class_loader.into());
        }

        Ok(system_class_loader)
    }

    async fn load_class(
        jvm: &Jvm,
        runtime: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<Class>> {
        tracing::debug!("java.lang.ClassLoader::loadClass({this:?}, {name:?})");

        if name.is_null() {
            return Err(jvm.exception("java/lang/NullPointerException", "name is null").await);
        }

        let class: ClassInstanceRef<Class> = jvm
            .invoke_virtual(
                &this,
                "java/lang/ClassLoader",
                "findLoadedClass",
                "(Ljava/lang/String;)Ljava/lang/Class;",
                (name.clone(),),
            )
            .await?;

        if !class.is_null() {
            return Ok(class);
        }

        let name_str = JavaLangString::to_rust_string(jvm, &name).await?;
        let internal_name = name_str.replace('.', "/");

        if let Some(element_type_name) = internal_name.strip_prefix('[') {
            let ultimate_element_type = name_str.trim_start_matches('[');
            let defining_loader = if let Some(element_class_name) = ultimate_element_type.strip_prefix('L').and_then(|name| name.strip_suffix(';')) {
                let element_class_name = JavaLangString::from_rust_string(jvm, element_class_name).await?;
                let element_class: ClassInstanceRef<Class> = jvm
                    .invoke_virtual(
                        &this,
                        "java/lang/ClassLoader",
                        "loadClass",
                        "(Ljava/lang/String;)Ljava/lang/Class;",
                        (element_class_name,),
                    )
                    .await?;
                jvm.get_field(&element_class, "java/lang/Class", "classLoader", "Ljava/lang/ClassLoader;")
                    .await?
            } else {
                None
            };

            let class = runtime.define_array_class(jvm, element_type_name).await?;
            let java_class = jvm.register_class(class, defining_loader).await?;

            return Ok(java_class.into());
        }

        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;
        let class: ClassInstanceRef<Class> = if !parent.is_null() {
            jvm.invoke_virtual(
                &parent,
                "java/lang/ClassLoader",
                "loadClass",
                "(Ljava/lang/String;)Ljava/lang/Class;",
                (name.clone(),),
            )
            .await?
        } else {
            jvm.load_bootstrap_class(&internal_name).await?.into()
        };

        if !class.is_null() {
            return Ok(class);
        }

        let class = jvm
            .invoke_virtual(
                &this,
                "java/lang/ClassLoader",
                "findClass",
                "(Ljava/lang/String;)Ljava/lang/Class;",
                (name,),
            )
            .await?;

        Ok(class)
    }

    async fn find_class(
        jvm: &Jvm,
        _: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<Class>> {
        tracing::debug!("java.lang.ClassLoader::findClass({this:?}, {name:?})");

        Err(jvm.exception("java/lang/ClassNotFoundException", "class not found").await)
    }

    async fn find_loaded_class(
        jvm: &Jvm,
        _: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<Class>> {
        tracing::debug!("java.lang.ClassLoader::findLoadedClass({this:?}, {name:?})");

        if name.is_null() {
            return Ok(None.into());
        }

        let internal_name = JavaLangString::to_rust_string(jvm, &name).await?.replace('.', "/");
        if !jvm.has_class(&internal_name) {
            return Ok(None.into());
        }

        let class = jvm.resolve_class(&internal_name).await?;

        Ok(class.java_class().into())
    }

    async fn get_resource(
        jvm: &Jvm,
        _: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<URL>> {
        tracing::debug!("java.lang.ClassLoader::getResource({this:?})");

        if name.is_null() {
            return Err(jvm.exception("java/lang/NullPointerException", "name is null").await);
        }

        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;

        let result: ClassInstanceRef<URL> = if !parent.is_null() {
            jvm.invoke_virtual(
                &parent,
                "java/lang/ClassLoader",
                "getResource",
                "(Ljava/lang/String;)Ljava/net/URL;",
                (name.clone(),),
            )
            .await?
        } else {
            None.into()
        };

        if !result.is_null() {
            return Ok(result);
        }

        let result = jvm
            .invoke_virtual(
                &this,
                "java/lang/ClassLoader",
                "findResource",
                "(Ljava/lang/String;)Ljava/net/URL;",
                (name,),
            )
            .await?;

        Ok(result)
    }

    async fn get_resource_as_stream(
        jvm: &Jvm,
        _: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<URL>> {
        tracing::debug!("java.lang.ClassLoader::getResourceAsStream({this:?})");

        let resource_url: ClassInstanceRef<URL> = jvm
            .invoke_virtual(
                &this,
                "java/lang/ClassLoader",
                "getResource",
                "(Ljava/lang/String;)Ljava/net/URL;",
                (name.clone(),),
            )
            .await?;

        if resource_url.is_null() {
            return Ok(None.into());
        }

        let stream = jvm
            .invoke_virtual(&resource_url, "java/net/URL", "openStream", "()Ljava/io/InputStream;", ())
            .await?;

        Ok(stream)
    }

    async fn find_resource(
        _: &Jvm,
        _: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        _: ClassInstanceRef<String>,
    ) -> Result<ClassInstanceRef<URL>> {
        tracing::debug!("java.lang.ClassLoader::findResource({this:?})");

        Ok(None.into())
    }

    async fn define_class(
        jvm: &Jvm,
        runtime: &mut RuntimeContext,
        this: ClassInstanceRef<Self>,
        name: ClassInstanceRef<String>,
        bytes: ClassInstanceRef<Array<i8>>,
        offset: i32,
        length: i32,
    ) -> Result<ClassInstanceRef<Class>> {
        tracing::debug!("java.lang.ClassLoader::defineClass({this:?}, {name:?}, {bytes:?}, {offset:?}, {length:?})");

        if bytes.is_null() {
            return Err(jvm.exception("java/lang/NullPointerException", "class bytes").await);
        }
        let array_length = jvm.array_length(&bytes).await?;
        if offset < 0 || length < 0 || (offset as usize).checked_add(length as usize).is_none_or(|end| end > array_length) {
            return Err(jvm.exception("java/lang/IndexOutOfBoundsException", "invalid class byte range").await);
        }

        let mut data = vec![0; length as usize];
        jvm.array_raw_buffer(&bytes).await?.read(offset as _, &mut data)?;

        let class = runtime.define_class(jvm, &data).await?;
        let java_class = jvm.register_class(class, Some(this.into())).await?;

        Ok(java_class.into())
    }
}