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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
use crate::core_types::Variant;
use crate::object::NewRef;
use crate::private::get_api;
use crate::sys;
use std::cmp::Ordering;
use std::ffi::CStr;
use std::fmt;
use std::mem::forget;
use std::ops::{Add, AddAssign, Index, Range};
use std::slice;
use std::str;
pub struct GodotString(pub(crate) sys::godot_string);
macro_rules! impl_methods {
(
$(pub fn $method:ident(&self) -> Self : $gd_method:ident;)*
) => {
$(
#[inline]
pub fn $method(&self) -> Self {
unsafe {
GodotString((get_api().$gd_method)(&self.0))
}
}
)*
};
(
$(pub fn $method:ident(&self) -> $Type:ty : $gd_method:ident;)*
) => {
$(
#[inline]
pub fn $method(&self) -> $Type {
unsafe { (get_api().$gd_method)(&self.0) }
}
)*
};
}
impl GodotString {
#[inline]
pub fn new() -> Self {
GodotString::default()
}
#[inline]
#[allow(clippy::should_implement_trait)]
pub fn from_str<S>(s: S) -> Self
where
S: AsRef<str>,
{
unsafe {
let api = get_api();
let val = s.as_ref();
let godot_s =
(api.godot_string_chars_to_utf8_with_len)(val.as_ptr() as *const _, val.len() as _);
GodotString(godot_s)
}
}
#[inline]
pub fn len(&self) -> usize {
unsafe { (get_api().godot_string_length)(&self.0) as usize }
}
impl_methods!(
pub fn is_empty(&self) -> bool : godot_string_empty;
pub fn is_numeric(&self) -> bool : godot_string_is_numeric;
pub fn is_valid_float(&self) -> bool : godot_string_is_valid_float;
pub fn is_valid_html_color(&self) -> bool : godot_string_is_valid_html_color;
pub fn is_valid_identifier(&self) -> bool : godot_string_is_valid_identifier;
pub fn is_valid_integer(&self) -> bool : godot_string_is_valid_integer;
pub fn is_valid_ip_address(&self) -> bool : godot_string_is_valid_ip_address;
pub fn is_resource_file(&self) -> bool : godot_string_is_resource_file;
pub fn is_absolute_path(&self) -> bool : godot_string_is_abs_path;
pub fn is_relative_path(&self) -> bool : godot_string_is_rel_path;
pub fn to_f32(&self) -> f32 : godot_string_to_float;
pub fn to_f64(&self) -> f64 : godot_string_to_double;
pub fn to_i32(&self) -> i32 : godot_string_to_int;
pub fn u32_hash(&self) -> u32 : godot_string_hash;
pub fn u64_hash(&self) -> u64 : godot_string_hash64;
pub fn hex_to_int(&self) -> i32 : godot_string_hex_to_int;
pub fn hex_to_int_without_prefix(&self) -> i32 : godot_string_hex_to_int_without_prefix;
);
impl_methods!(
pub fn camelcase_to_underscore(&self) -> Self : godot_string_camelcase_to_underscore;
pub fn camelcase_to_underscore_lowercased(&self) -> Self : godot_string_camelcase_to_underscore_lowercased;
pub fn capitalize(&self) -> Self : godot_string_capitalize;
pub fn to_lowercase(&self) -> Self : godot_string_to_lower;
pub fn to_uppercase(&self) -> Self : godot_string_to_upper;
pub fn get_file(&self) -> Self : godot_string_get_file;
pub fn get_base_dir(&self) -> Self : godot_string_get_base_dir;
pub fn get_basename(&self) -> Self : godot_string_get_basename;
pub fn get_extension(&self) -> Self : godot_string_get_extension;
pub fn simplify_path(&self) -> Self : godot_string_simplify_path;
pub fn sha256_text(&self) -> Self : godot_string_sha256_text;
pub fn md5_text(&self) -> Self : godot_string_md5_text;
pub fn c_escape(&self) -> Self : godot_string_c_escape;
pub fn c_escape_multiline(&self) -> Self : godot_string_c_escape_multiline;
pub fn c_unescape(&self) -> Self : godot_string_c_unescape;
pub fn http_escape(&self) -> Self : godot_string_http_escape;
pub fn http_unescape(&self) -> Self: godot_string_http_unescape;
pub fn json_escape(&self) -> Self : godot_string_json_escape;
pub fn xml_escape(&self) -> Self : godot_string_xml_escape;
pub fn xml_escape_with_quotes(&self) -> Self : godot_string_xml_escape_with_quotes;
pub fn xml_unescape(&self) -> Self: godot_string_xml_unescape;
pub fn percent_decode(&self) -> Self : godot_string_percent_decode;
pub fn percent_encode(&self) -> Self : godot_string_percent_encode;
);
#[inline]
pub fn is_valid_hex_number(&self, with_prefix: bool) -> bool {
unsafe { (get_api().godot_string_is_valid_hex_number)(&self.0, with_prefix) }
}
#[inline]
pub fn begins_with(&self, s: &GodotString) -> bool {
unsafe { (get_api().godot_string_begins_with)(&self.0, &s.0) }
}
#[inline]
pub fn ends_with(&self, s: &GodotString) -> bool {
unsafe { (get_api().godot_string_ends_with)(&self.0, &s.0) }
}
#[inline]
pub fn begins_with_c_str(&self, s: &CStr) -> bool {
unsafe { (get_api().godot_string_begins_with_char_array)(&self.0, s.as_ptr()) }
}
#[inline]
pub fn sub_string(&self, range: Range<usize>) -> Self {
unsafe {
let count = range.end - range.start;
GodotString((get_api().godot_string_substr)(
&self.0,
range.start as i32,
count as i32,
))
}
}
#[doc(hidden)]
#[inline]
pub fn to_utf8(&self) -> Utf8String {
unsafe { Utf8String((get_api().godot_string_utf8)(&self.0)) }
}
#[inline]
pub fn find(&self, what: &GodotString) -> i32 {
unsafe { (get_api().godot_string_find)(&self.0, what.0) }
}
#[inline]
pub fn find_from(&self, what: &GodotString, from: i32) -> i32 {
unsafe { (get_api().godot_string_find_from)(&self.0, what.0, from) }
}
#[inline]
pub fn find_last(&self, what: &GodotString) -> i32 {
unsafe { (get_api().godot_string_find_last)(&self.0, what.0) }
}
#[inline]
pub fn format(&self, values: &Variant) -> Self {
Self(unsafe { (get_api().godot_string_format)(&self.0, &values.0) })
}
#[doc(hidden)]
#[inline]
pub fn leak(self) -> sys::godot_string {
let v = self.0;
forget(self);
v
}
#[doc(hidden)]
#[inline]
pub fn to_sys(&self) -> sys::godot_string {
self.0
}
#[doc(hidden)]
#[inline]
pub fn sys(&self) -> *const sys::godot_string {
&self.0
}
#[doc(hidden)]
#[inline]
pub fn sys_mut(&mut self) -> *mut sys::godot_string {
&mut self.0
}
#[doc(hidden)]
#[inline]
pub fn from_sys(sys: sys::godot_string) -> Self {
GodotString(sys)
}
#[doc(hidden)]
#[inline]
pub fn clone_from_sys(sys: sys::godot_string) -> Self {
let sys_string = GodotString(sys);
let this = sys_string.clone();
sys_string.leak();
this
}
}
impl Clone for GodotString {
#[inline]
fn clone(&self) -> Self {
self.new_ref()
}
}
impl_basic_traits_as_sys!(
for GodotString as godot_string {
Drop => godot_string_destroy;
Eq => godot_string_operator_equal;
Ord => godot_string_operator_less;
Default => godot_string_new;
NewRef => godot_string_new_copy;
}
);
impl fmt::Display for GodotString {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let utf8 = self.to_utf8();
f.write_str(utf8.as_str())
}
}
impl fmt::Debug for GodotString {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
self.to_string().fmt(f)
}
}
impl std::hash::Hash for GodotString {
#[inline]
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
state.write_u64(self.u64_hash());
}
}
impl Add<GodotString> for GodotString {
type Output = GodotString;
#[inline]
fn add(self, other: GodotString) -> GodotString {
&self + &other
}
}
impl Add<&GodotString> for &GodotString {
type Output = GodotString;
#[inline]
fn add(self, other: &GodotString) -> GodotString {
GodotString::from_sys(unsafe { (get_api().godot_string_operator_plus)(&self.0, &other.0) })
}
}
impl<S> Add<S> for &GodotString
where
S: AsRef<str>,
{
type Output = GodotString;
#[inline]
fn add(self, other: S) -> GodotString {
self.add(&GodotString::from_str(other))
}
}
impl AddAssign<&GodotString> for GodotString {
#[inline]
fn add_assign(&mut self, other: &Self) {
*self = &*self + other;
}
}
impl AddAssign<GodotString> for GodotString {
#[inline]
fn add_assign(&mut self, other: Self) {
*self += &other;
}
}
impl<S> AddAssign<S> for GodotString
where
S: AsRef<str>,
{
#[inline]
fn add_assign(&mut self, other: S) {
self.add_assign(&GodotString::from_str(other))
}
}
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
#[repr(transparent)]
pub struct GodotChar(libc::wchar_t);
#[derive(Debug)]
pub enum GodotCharError {
InvalidCodePoint,
UnknownEncoding,
IncompleteSequence,
}
impl TryFrom<GodotChar> for char {
type Error = GodotCharError;
#[inline]
fn try_from(c: GodotChar) -> Result<Self, GodotCharError> {
match std::mem::size_of::<libc::wchar_t>() {
1 => std::char::from_u32(c.0 as u32).ok_or(GodotCharError::IncompleteSequence),
4 => std::char::from_u32(c.0 as u32).ok_or(GodotCharError::InvalidCodePoint),
2 => {
let mut iter = std::char::decode_utf16(std::iter::once(c.0 as u16));
let c = iter
.next()
.ok_or(GodotCharError::InvalidCodePoint)?
.map_err(|_| GodotCharError::IncompleteSequence)?;
assert!(
iter.next().is_none(),
"it should be impossible to decode more than one code point from one u16"
);
Ok(c)
}
_ => Err(GodotCharError::UnknownEncoding),
}
}
}
impl PartialEq<char> for GodotChar {
#[inline]
fn eq(&self, other: &char) -> bool {
char::try_from(*self).map_or(false, |this| this == *other)
}
}
impl Index<usize> for GodotString {
type Output = GodotChar;
#[inline]
fn index(&self, index: usize) -> &Self::Output {
unsafe {
let c: *const libc::wchar_t =
(get_api().godot_string_operator_index)(self.sys() as *mut _, index as i32);
&*(c as *const GodotChar)
}
}
}
#[doc(hidden)]
pub struct Utf8String(pub(crate) sys::godot_char_string);
impl Utf8String {
#[inline]
pub fn len(&self) -> i32 {
unsafe { (get_api().godot_char_string_length)(&self.0) }
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[inline]
pub fn as_bytes(&self) -> &[u8] {
unsafe {
let data = (get_api().godot_char_string_get_data)(&self.0) as _;
slice::from_raw_parts(data, self.len() as usize)
}
}
#[inline]
pub fn as_str(&self) -> &str {
unsafe { str::from_utf8_unchecked(self.as_bytes()) }
}
#[doc(hidden)]
#[inline]
pub fn sys(&self) -> *const sys::godot_char_string {
&self.0
}
#[doc(hidden)]
#[inline]
pub fn sys_mut(&mut self) -> *mut sys::godot_char_string {
&mut self.0
}
#[doc(hidden)]
#[inline]
pub fn from_sys(sys: sys::godot_char_string) -> Self {
Self(sys)
}
}
impl ToString for Utf8String {
#[inline]
fn to_string(&self) -> String {
String::from(self.as_str())
}
}
impl_basic_traits_as_sys!(
for Utf8String as godot_char_string {
Drop => godot_char_string_destroy;
}
);
impl fmt::Debug for Utf8String {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
self.to_string().fmt(f)
}
}
pub struct StringName(pub(crate) sys::godot_string_name);
impl StringName {
#[inline]
#[allow(clippy::should_implement_trait)]
pub fn from_str<S>(s: S) -> Self
where
S: AsRef<str>,
{
let gd_string = GodotString::from_str(s);
StringName::from_godot_string(&gd_string)
}
#[inline]
pub fn from_c_str(s: &CStr) -> Self {
unsafe {
let mut result = sys::godot_string_name::default();
(get_api().godot_string_name_new_data)(&mut result, s.as_ptr());
StringName(result)
}
}
#[inline]
pub fn from_godot_string(s: &GodotString) -> Self {
unsafe {
let mut result = sys::godot_string_name::default();
(get_api().godot_string_name_new)(&mut result, &s.0);
StringName(result)
}
}
#[inline]
pub fn get_hash(&self) -> u32 {
unsafe { (get_api().godot_string_name_get_hash)(&self.0) }
}
#[inline]
pub fn to_godot_string(&self) -> GodotString {
unsafe { GodotString((get_api().godot_string_name_get_name)(&self.0)) }
}
#[doc(hidden)]
#[inline]
pub fn sys(&self) -> *const sys::godot_string_name {
&self.0
}
#[doc(hidden)]
#[inline]
pub fn sys_mut(&mut self) -> *mut sys::godot_string_name {
&mut self.0
}
#[doc(hidden)]
#[inline]
pub fn from_sys(sys: sys::godot_string_name) -> Self {
Self(sys)
}
}
impl_basic_traits_as_sys! {
for StringName as godot_string_name {
Drop => godot_string_name_destroy;
}
}
impl PartialEq for StringName {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.to_godot_string() == other.to_godot_string()
}
}
impl Eq for StringName {}
impl PartialOrd for StringName {
#[inline]
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(Ord::cmp(self, other))
}
}
impl Ord for StringName {
#[inline]
fn cmp(&self, other: &Self) -> Ordering {
Ord::cmp(&self.to_godot_string(), &other.to_godot_string())
}
}
impl fmt::Debug for StringName {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
self.to_godot_string().fmt(f)
}
}
impl<S> From<S> for GodotString
where
S: AsRef<str>,
{
#[inline]
fn from(s: S) -> GodotString {
GodotString::from_str(s)
}
}
#[cfg(feature = "serde")]
mod serialize {
use super::*;
use serde::{
de::{Error, Visitor},
Deserialize, Deserializer, Serialize, Serializer,
};
use std::fmt::Formatter;
impl Serialize for GodotString {
#[inline]
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where
S: Serializer,
{
serializer.serialize_str(&self.to_string())
}
}
#[cfg(feature = "serde")]
impl<'de> serialize::Deserialize<'de> for GodotString {
#[inline]
fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
where
D: Deserializer<'de>,
{
struct GodotStringVisitor;
impl<'de> Visitor<'de> for GodotStringVisitor {
type Value = GodotString;
fn expecting(&self, formatter: &mut Formatter) -> fmt::Result {
formatter.write_str("a GodotString")
}
fn visit_str<E>(self, s: &str) -> Result<Self::Value, E>
where
E: Error,
{
Ok(GodotString::from(s))
}
}
deserializer.deserialize_str(GodotStringVisitor)
}
}
}
godot_test!(test_string {
use crate::core_types::{GodotString, Variant, VariantType, ToVariant, VariantArray, Dictionary};
use std::cmp::Ordering;
let foo: GodotString = "foo".into();
assert_eq!(foo.len(), 3);
assert_eq!(foo.to_string(), String::from("foo"));
let foo2 = foo.new_ref();
assert!(foo == foo2);
let bar: GodotString = "bar".into();
let qux: GodotString = "qux".into();
assert_eq!(&bar + &qux, "barqux".into());
let baz: GodotString = "baz".into();
assert_eq!(&baz + "corge", "bazcorge".into());
let mut bar2 = bar.new_ref();
bar2 += &qux;
assert_eq!(bar2, "barqux".into());
let cmp1: GodotString = "foo".into();
let cmp2: GodotString = "foo".into();
let cmp3: GodotString = "bar".into();
assert_eq!(cmp1.cmp(&cmp2), Ordering::Equal, "equal should not be less than");
assert_eq!(cmp1.cmp(&cmp3), Ordering::Greater, "foo should greater than bar");
assert_eq!(cmp3.cmp(&cmp1), Ordering::Less, "bar should be less than foo");
let index_string: GodotString = "bar".into();
assert_eq!(index_string[0], 'b');
assert_eq!(index_string[1], 'a');
assert_eq!(index_string[2], 'r');
let variant = Variant::new(&foo);
assert!(variant.get_type() == VariantType::GodotString);
let variant2: Variant = "foo".to_variant();
assert!(variant == variant2);
if let Ok(foo_variant) = variant.try_to::<GodotString>() {
assert!(foo_variant == foo);
} else {
panic!("variant should be a GodotString");
}
assert_eq!(foo.to_utf8().as_str(), "foo");
let fmt_string = GodotString::from("foo {bar}");
let fmt_data = Dictionary::new();
fmt_data.insert("bar", "baz");
let fmt = fmt_string.format(&fmt_data.into_shared().to_variant());
assert_eq!(fmt, GodotString::from("foo baz"));
assert_eq!(fmt_string, GodotString::from("foo {bar}"));
let fmt_string2 = GodotString::from("{0} {1}");
let fmt_data2 = VariantArray::new();
fmt_data2.push("foo");
fmt_data2.push("bar");
let fmt2 = fmt_string2.format(&fmt_data2.into_shared().to_variant());
assert_eq!(fmt2, GodotString::from("foo bar"));
assert_eq!(fmt_string2, GodotString::from("{0} {1}"));
});
godot_test!(test_string_name_eq {
use crate::core_types::{GodotString, StringName};
let a: StringName = StringName::from_str("some string");
let b: StringName = StringName::from_godot_string(&GodotString::from("some string"));
let c: StringName = StringName::from_str(String::from("some other string"));
let d: StringName = StringName::from_str("yet another one");
assert_eq!(a, b);
assert_ne!(a, c);
assert_ne!(a, d);
assert_ne!(b, c);
assert_ne!(b, d);
assert_ne!(c, d);
let back = b.to_godot_string();
assert_eq!(back, GodotString::from("some string"));
});
godot_test!(test_string_name_ord {
use crate::core_types::{GodotString, StringName};
let a: StringName = StringName::from_str("some string");
let b: StringName = StringName::from_godot_string(&GodotString::from("some string"));
let c: StringName = StringName::from_str(String::from("some other string"));
let a_b = Ord::cmp(&a, &b);
let b_a = Ord::cmp(&b, &a);
assert_eq!(a_b, Ordering::Equal);
assert_eq!(b_a, Ordering::Equal);
let a_c = Ord::cmp(&a, &c);
let c_a = Ord::cmp(&c, &a);
let b_c = Ord::cmp(&b, &c);
let c_b = Ord::cmp(&c, &b);
assert_ne!(a_c, Ordering::Equal);
assert_eq!(a_c, b_c);
assert_eq!(c_a, c_b);
assert_eq!(a_c, c_a.reverse());
assert_eq!(b_c, c_b.reverse());
});