luars 0.17.0

A library for lua 5.5 runtime implementation in Rust
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
// Tests for the user-facing Ref API and related features
use crate::lua_value::userdata_trait::LuaMethodProvider;
use crate::lua_vm::SafeOption;
use crate::{LuaUserData, LuaVM, LuaValue, Stdlib, UserDataRef};

#[derive(LuaUserData)]
struct ApiCounter {
    pub count: i64,
}

// ============================================================================
// LuaTableRef tests
// ============================================================================

#[test]
fn test_table_ref_basic() {
    let mut vm = LuaVM::new(SafeOption::default());
    let tbl = vm.create_table_ref(0, 4).unwrap();

    // Set and get string keys
    let hello = vm.create_string("hello").unwrap();
    tbl.set("greeting", hello).unwrap();
    let val = tbl.get("greeting").unwrap();
    assert_eq!(val.as_str(), Some("hello"));

    // Set and get integer keys
    tbl.seti(1, LuaValue::integer(42)).unwrap();
    let val = tbl.geti(1).unwrap();
    assert_eq!(val.as_integer(), Some(42));

    // Set and get via LuaValue key
    let key = vm.create_string("key2").unwrap();
    tbl.set_value(key, LuaValue::boolean(true)).unwrap();
    let val = tbl.get_value(&key).unwrap();
    assert_eq!(val.as_boolean(), Some(true));
}

#[test]
fn test_table_ref_get_as() {
    let mut vm = LuaVM::new(SafeOption::default());
    let tbl = vm.create_table_ref(0, 4).unwrap();

    tbl.set("count", LuaValue::integer(99)).unwrap();
    let count: i64 = tbl.get_as("count").unwrap();
    assert_eq!(count, 99);

    tbl.set("pi", LuaValue::float(3.15)).unwrap();
    let pi: f64 = tbl.get_as("pi").unwrap();
    assert!((pi - 3.15).abs() < 1e-10);
}

#[test]
fn test_table_ref_pairs_and_len() {
    let mut vm = LuaVM::new(SafeOption::default());
    let tbl = vm.create_table_ref(4, 0).unwrap();

    tbl.seti(1, LuaValue::integer(10)).unwrap();
    tbl.seti(2, LuaValue::integer(20)).unwrap();
    tbl.seti(3, LuaValue::integer(30)).unwrap();

    assert_eq!(tbl.len().unwrap(), 3);

    let pairs = tbl.pairs().unwrap();
    assert_eq!(pairs.len(), 3);
}

#[test]
fn test_table_ref_push() {
    let mut vm = LuaVM::new(SafeOption::default());
    let tbl = vm.create_table_ref(4, 0).unwrap();

    tbl.push(LuaValue::integer(100)).unwrap();
    tbl.push(LuaValue::integer(200)).unwrap();

    assert_eq!(tbl.len().unwrap(), 2);
    assert_eq!(tbl.geti(1).unwrap().as_integer(), Some(100));
    assert_eq!(tbl.geti(2).unwrap().as_integer(), Some(200));
}

#[test]
fn test_table_ref_from_global() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        config = { host = "localhost", port = 8080 }
    "#,
    )
    .unwrap();

    let config = vm.get_global_table("config").unwrap().unwrap();
    let host: String = config.get_as("host").unwrap();
    assert_eq!(host, "localhost");
    let port: i64 = config.get_as("port").unwrap();
    assert_eq!(port, 8080);

    // Modify through ref and verify from Lua
    config.set("port", LuaValue::integer(9090)).unwrap();
    let results = vm.execute("return config.port").unwrap();
    assert_eq!(results[0].as_integer(), Some(9090));
}

#[test]
fn test_table_ref_auto_drop() {
    let mut vm = LuaVM::new(SafeOption::default());

    // Create and drop a table ref — should not leak registry entries
    let ref_id;
    {
        let tbl = vm.create_table_ref(0, 0).unwrap();
        ref_id = tbl.ref_id();
        tbl.set("x", LuaValue::integer(1)).unwrap();
    }
    // After drop, the registry entry should be cleared
    let val = vm.get_ref_value_by_id(ref_id);
    assert!(val.is_nil(), "Registry entry should be released on drop");
}

// ============================================================================
// LuaFunctionRef tests
// ============================================================================

#[test]
fn test_function_ref_call() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        function add(a, b)
            return a + b
        end
    "#,
    )
    .unwrap();

    let add = vm.get_global_function("add").unwrap().unwrap();
    let results = add
        .call_raw(vec![LuaValue::integer(3), LuaValue::integer(4)])
        .unwrap();
    assert_eq!(results[0].as_integer(), Some(7));
}

#[test]
fn test_function_ref_call1() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        function greet(name)
            return "Hello, " .. name
        end
    "#,
    )
    .unwrap();

    let greet = vm.get_global_function("greet").unwrap().unwrap();
    let name = vm.create_string("World").unwrap();
    let result = greet.call1_raw(vec![name]).unwrap();
    assert_eq!(result.as_str(), Some("Hello, World"));
}

#[test]
fn test_function_ref_call1_typed() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        function greet(name)
            return "Hello, " .. name
        end
    "#,
    )
    .unwrap();

    let greet = vm.get_global_function("greet").unwrap().unwrap();
    let result: String = greet.call1("World").unwrap();
    assert_eq!(result, "Hello, World");
}

#[test]
fn test_function_ref_call_typed_multi_return() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        function stats(a, b)
            return a + b, a * b, a - b
        end
    "#,
    )
    .unwrap();

    let stats = vm.get_global_function("stats").unwrap().unwrap();
    let result: (i64, i64, i64) = stats.call((7, 3)).unwrap();
    assert_eq!(result, (10, 21, 4));
}

#[test]
fn test_function_ref_call_typed_no_args() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        function ping()
            return 42
        end
    "#,
    )
    .unwrap();

    let ping = vm.get_global_function("ping").unwrap().unwrap();
    let result: i64 = ping.call1(()).unwrap();
    assert_eq!(result, 42);
}

#[test]
fn test_function_ref_multiple_calls() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute(
        r#"
        counter = 0
        function inc()
            counter = counter + 1
            return counter
        end
    "#,
    )
    .unwrap();

    let inc = vm.get_global_function("inc").unwrap().unwrap();
    assert_eq!(inc.call1_raw(vec![]).unwrap().as_integer(), Some(1));
    assert_eq!(inc.call1_raw(vec![]).unwrap().as_integer(), Some(2));
    assert_eq!(inc.call1_raw(vec![]).unwrap().as_integer(), Some(3));
}

#[test]
fn test_function_ref_auto_drop() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute("function noop() end").unwrap();

    let ref_id;
    {
        let f = vm.get_global_function("noop").unwrap().unwrap();
        ref_id = f.ref_id();
    }
    let val = vm.get_ref_value_by_id(ref_id);
    assert!(val.is_nil(), "Function ref should be released on drop");
}

// ============================================================================
// LuaStringRef tests
// ============================================================================

#[test]
fn test_string_ref_basic() {
    let mut vm = LuaVM::new(SafeOption::default());
    let s = vm.create_string("hello world").unwrap();
    let sref = vm.to_string_ref(s).unwrap();

    assert_eq!(sref.as_str(), Some("hello world"));
    assert_eq!(sref.byte_len(), 11);
    assert_eq!(sref.to_string_lossy(), "hello world");
    assert_eq!(format!("{}", sref), "hello world");
}

#[test]
fn test_string_ref_auto_drop() {
    let mut vm = LuaVM::new(SafeOption::default());
    let s = vm.create_string("test_drop").unwrap();
    let ref_id;
    {
        let sref = vm.to_string_ref(s).unwrap();
        ref_id = sref.ref_id();
    }
    let val = vm.get_ref_value_by_id(ref_id);
    assert!(val.is_nil());
}

// ============================================================================
// LuaAnyRef tests
// ============================================================================

#[test]
fn test_any_ref_table() {
    let mut vm = LuaVM::new(SafeOption::default());
    let table = vm.create_table(0, 2).unwrap();
    let any = vm.to_ref(table);

    assert!(matches!(any.kind(), crate::lua_value::LuaValueKind::Table));
    let tbl = any.as_table().unwrap();
    tbl.set("x", LuaValue::integer(42)).unwrap();
    assert_eq!(tbl.get("x").unwrap().as_integer(), Some(42));
}

#[test]
fn test_any_ref_function() {
    let mut vm = LuaVM::new(SafeOption::default());
    vm.execute("function f() return 99 end").unwrap();

    let val = vm.get_global("f").unwrap().unwrap();
    let any = vm.to_ref(val);
    let func = any.as_function().unwrap();
    let result = func.call1_raw(vec![]).unwrap();
    assert_eq!(result.as_integer(), Some(99));
}

#[test]
fn test_any_ref_string() {
    let mut vm = LuaVM::new(SafeOption::default());
    let s = vm.create_string("any_string").unwrap();
    let any = vm.to_ref(s);
    let sref = any.as_string().unwrap();
    assert_eq!(sref.as_str(), Some("any_string"));
}

#[test]
fn test_any_ref_wrong_type() {
    let mut vm = LuaVM::new(SafeOption::default());
    let table = vm.create_table(0, 0).unwrap();
    let any = vm.to_ref(table);

    assert!(any.as_function().is_none());
    assert!(any.as_string().is_none());
    assert!(any.as_table().is_some());
}

#[test]
fn test_any_ref_userdata_typed() {
    let mut vm = LuaVM::new(SafeOption::default());
    let userdata = vm
        .create_userdata(crate::lua_value::LuaUserdata::new(ApiCounter { count: 5 }))
        .unwrap();

    let any = vm.to_ref(userdata);
    let counter = any.as_userdata::<ApiCounter>().unwrap();
    assert_eq!(counter.get().unwrap().count, 5);
    assert_eq!(counter.type_name().unwrap(), "ApiCounter");
}

#[test]
fn test_userdata_ref_from_lua_and_mutate() {
    let mut vm = LuaVM::new(SafeOption::default());
    let userdata = vm
        .create_userdata(crate::lua_value::LuaUserdata::new(ApiCounter { count: 11 }))
        .unwrap();
    vm.set_global("counter", userdata).unwrap();

    let mut counter: UserDataRef<ApiCounter> = vm.get_global_as("counter").unwrap().unwrap();
    assert_eq!(counter.get().unwrap().count, 11);

    counter.get_mut().unwrap().count += 9;

    let results = vm.execute("return counter.count").unwrap();
    assert_eq!(results[0].as_integer(), Some(20));
}

// ============================================================================
// OpaqueUserData tests
// ============================================================================

#[test]
fn test_push_any_basic() {
    let mut vm = LuaVM::new(SafeOption::default());
    #[allow(dead_code)]
    // Push an arbitrary Rust struct as opaque userdata
    struct MyConfig {
        name: String,
        value: i32,
    }

    let config = MyConfig {
        name: "test".to_string(),
        value: 42,
    };

    let ud = vm.push_any(config).unwrap();
    assert!(ud.is_userdata());
    vm.set_global("my_config", ud).unwrap();

    // Verify type() in Lua shows the Rust type name
    vm.open_stdlib(Stdlib::Basic).unwrap();
    let results = vm.execute("return type(my_config)").unwrap();
    assert_eq!(results[0].as_str(), Some("userdata"));
}

#[test]
fn test_push_any_downcast() {
    let mut vm = LuaVM::new(SafeOption::default());

    #[derive(Debug, PartialEq)]
    struct Point {
        x: f64,
        y: f64,
    }

    let point = Point { x: 3.0, y: 4.0 };
    let ud = vm.push_any(point).unwrap();
    vm.set_global("pt", ud).unwrap();

    // Retrieve via Rust and downcast
    let val = vm.get_global("pt").unwrap().unwrap();
    let ud_data = val.as_userdata_mut().unwrap();
    let recovered = ud_data.downcast_ref::<Point>().unwrap();
    assert_eq!(recovered.x, 3.0);
    assert_eq!(recovered.y, 4.0);
}

#[test]
fn test_push_any_in_callback() {
    let mut vm = LuaVM::new(SafeOption::default());

    struct Counter {
        count: i32,
    }

    let counter = Counter { count: 0 };
    let ud = vm.push_any(counter).unwrap();
    vm.set_global("counter", ud).unwrap();

    // Register a function that mutates the opaque userdata
    vm.register_function("increment", |state| {
        let ud_val = state.get_arg(1).unwrap();
        let ud = ud_val.as_userdata_mut().unwrap();
        let c = ud.downcast_mut::<Counter>().unwrap();
        c.count += 1;
        state.push_value(LuaValue::integer(c.count as i64))?;
        Ok(1)
    })
    .unwrap();

    let results = vm.execute("return increment(counter)").unwrap();
    assert_eq!(results[0].as_integer(), Some(1));

    let results = vm.execute("return increment(counter)").unwrap();
    assert_eq!(results[0].as_integer(), Some(2));
}

// ============================================================================
// UserDataBuilder tests
// ============================================================================

#[test]
fn test_userdata_builder_fields() {
    use crate::lua_value::UserDataBuilder;

    let mut vm = LuaVM::new(SafeOption::default());
    vm.open_stdlib(Stdlib::Basic).unwrap();

    struct Address {
        ip: String,
        port: u16,
    }

    let addr = Address {
        ip: "127.0.0.1".to_owned(),
        port: 8080,
    };

    let ud = UserDataBuilder::new(addr)
        .set_type_name("Address")
        .add_field_getter("ip", |a| crate::UdValue::Str(a.ip.clone()))
        .add_field_getter("port", |a| crate::UdValue::Integer(a.port as i64))
        .build(&mut vm)
        .unwrap();

    vm.set_global("addr", ud).unwrap();

    let results = vm.execute("return addr.ip").unwrap();
    assert_eq!(results[0].as_str(), Some("127.0.0.1"));

    let results = vm.execute("return addr.port").unwrap();
    assert_eq!(results[0].as_integer(), Some(8080));
}

#[test]
fn test_userdata_builder_tostring() {
    use crate::lua_value::UserDataBuilder;

    let mut vm = LuaVM::new(SafeOption::default());
    vm.open_stdlib(Stdlib::Basic).unwrap();

    struct Version {
        major: u32,
        minor: u32,
        patch: u32,
    }

    let ver = Version {
        major: 1,
        minor: 2,
        patch: 3,
    };

    let ud = UserDataBuilder::new(ver)
        .set_type_name("Version")
        .set_tostring(|v| format!("{}.{}.{}", v.major, v.minor, v.patch))
        .build(&mut vm)
        .unwrap();

    vm.set_global("ver", ud).unwrap();

    let results = vm.execute("return tostring(ver)").unwrap();
    assert_eq!(results[0].as_str(), Some("1.2.3"));
}

#[test]
fn test_userdata_builder_setter() {
    use crate::lua_value::UserDataBuilder;

    let mut vm = LuaVM::new(SafeOption::default());

    struct Config {
        debug: bool,
    }

    let cfg = Config { debug: false };

    let ud = UserDataBuilder::new(cfg)
        .add_field_getter("debug", |c| crate::UdValue::Boolean(c.debug))
        .add_field_setter("debug", |c, v| {
            c.debug = v.to_bool();
            Ok(())
        })
        .build(&mut vm)
        .unwrap();

    vm.set_global("cfg", ud).unwrap();

    // Read default
    let results = vm.execute("return cfg.debug").unwrap();
    assert_eq!(results[0].as_boolean(), Some(false));

    // Set and read back
    vm.execute("cfg.debug = true").unwrap();
    let results = vm.execute("return cfg.debug").unwrap();
    assert_eq!(results[0].as_boolean(), Some(true));
}

// ============================================================================
// build_table_ref / TableBuilder integration
// ============================================================================

#[test]
fn test_build_table_ref() {
    use crate::TableBuilder;

    let mut vm = LuaVM::new(SafeOption::default());

    let name_str = vm.create_string("Alice").unwrap();
    let tbl = vm
        .build_table_ref(
            TableBuilder::new()
                .set("name", name_str)
                .set("age", LuaValue::integer(30)),
        )
        .unwrap();

    let name: String = tbl.get_as("name").unwrap();
    assert_eq!(name, "Alice");
    let age: i64 = tbl.get_as("age").unwrap();
    assert_eq!(age, 30);
}

// ============================================================================
// to_ref / to_table_ref / to_function_ref type checks
// ============================================================================

#[test]
fn test_to_ref_type_mismatch() {
    let mut vm = LuaVM::new(SafeOption::default());
    let table = vm.create_table(0, 0).unwrap();

    // Table → to_function_ref should return None
    assert!(vm.to_function_ref(table).is_none());

    // Integer → to_table_ref should return None
    assert!(vm.to_table_ref(LuaValue::integer(42)).is_none());
}

#[test]
fn test_get_global_nonexistent() {
    let mut vm = LuaVM::new(SafeOption::default());
    assert!(vm.get_global_table("nonexistent").unwrap().is_none());
    assert!(vm.get_global_function("nonexistent").unwrap().is_none());
}