vb6parse 1.0.1

vb6parse is a library for parsing and analyzing VB6 code, from projects, to controls, to modules, and forms.
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
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
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
//! # `RTrim` Function
//!
//! Returns a String containing a copy of a specified string with trailing spaces removed.
//!
//! ## Syntax
//!
//! ```vb
//! RTrim(string)
//! ```
//!
//! ## Parameters
//!
//! - `string` (Required): String expression from which trailing spaces are to be removed
//!   - Can be any valid string expression
//!   - If string is Null, returns Null
//!   - Empty string returns empty string
//!
//! ## Return Value
//!
//! Returns a String (or Variant):
//! - Copy of string with trailing spaces removed
//! - Removes only spaces (ASCII 32) from the right
//! - Does not remove tabs, newlines, or other whitespace characters
//! - Returns Null if input is Null
//! - Returns empty string if input is empty or all spaces
//! - Leading spaces are preserved
//! - Internal spaces are preserved
//!
//! ## Remarks
//!
//! The `RTrim` function removes trailing spaces:
//!
//! - Removes only space characters (ASCII 32) from the right side
//! - Does not remove tabs (Chr(9)), line feeds (Chr(10)), or carriage returns (Chr(13))
//! - Does not remove non-breaking spaces or other Unicode whitespace
//! - Leading spaces are not affected
//! - Internal spaces between words are preserved
//! - Often used to clean up output formatting
//! - Commonly paired with `LTrim` or used with Trim
//! - Null input returns Null (propagates Null)
//! - Empty string input returns empty string
//! - String of only spaces returns empty string
//! - Does not modify the original string (returns new string)
//! - Can be used with Variant variables
//! - Common in report generation and text alignment
//! - Used to remove padding from fixed-width fields
//! - Essential for cleaning exported data
//! - Part of the VB6 string manipulation library
//! - Available in all VB versions
//! - Related to `LTrim` (removes leading spaces) and Trim (removes both)
//!
//! ## Typical Uses
//!
//! 1. **Remove Trailing Spaces**
//!    ```vb
//!    cleanText = RTrim("Hello   ")
//!    ```
//!
//! 2. **Clean Fixed-Width Output**
//!    ```vb
//!    outputLine = RTrim(paddedField)
//!    ```
//!
//! 3. **Format Display**
//!    ```vb
//!    lblName.Caption = RTrim(recordset("Name"))
//!    ```
//!
//! 4. **Process Data Export**
//!    ```vb
//!    exportValue = RTrim(databaseField)
//!    ```
//!
//! 5. **Normalize Text**
//!    ```vb
//!    normalizedText = LTrim(RTrim(inputText))
//!    ```
//!
//! 6. **String Comparison**
//!    ```vb
//!    If RTrim(text1) = RTrim(text2) Then
//!        ' Equal when ignoring trailing spaces
//!    End If
//!    ```
//!
//! 7. **Write to File**
//!    ```vb
//!    Print #1, RTrim(record.Field1)
//!    ```
//!
//! 8. **Report Generation**
//!    ```vb
//!    reportLine = RTrim(customerName) & " - " & orderID
//!    ```
//!
//! ## Basic Examples
//!
//! ### Example 1: Basic Usage
//! ```vb
//! Dim result As String
//!
//! result = RTrim("Hello   ")           ' Returns "Hello"
//! result = RTrim("   Hello")           ' Returns "   Hello" (leading preserved)
//! result = RTrim("   Hello World   ")  ' Returns "   Hello World"
//! result = RTrim("NoSpaces")           ' Returns "NoSpaces"
//! result = RTrim("     ")              ' Returns ""
//! result = RTrim("")                   ' Returns ""
//! ```
//!
//! ### Example 2: Fixed-Width File Export
//! ```vb
//! Sub ExportToFixedWidth(ByVal filename As String)
//!     Dim rs As ADODB.Recordset
//!     Dim fileNum As Integer
//!     Dim line As String
//!     
//!     Set rs = New ADODB.Recordset
//!     rs.Open "SELECT * FROM Customers", conn
//!     
//!     fileNum = FreeFile
//!     Open filename For Output As #fileNum
//!     
//!     Do While Not rs.EOF
//!         ' Build fixed-width line and remove trailing spaces
//!         line = Left(rs("CustomerID") & Space(10), 10) & _
//!                Left(rs("CompanyName") & Space(40), 40) & _
//!                Left(rs("City") & Space(20), 20)
//!         
//!         ' Write without trailing spaces
//!         Print #fileNum, RTrim(line)
//!         
//!         rs.MoveNext
//!     Loop
//!     
//!     Close #fileNum
//!     rs.Close
//!     Set rs = Nothing
//! End Sub
//! ```
//!
//! ### Example 3: Database Field Cleanup
//! ```vb
//! Function GetCustomerName(ByVal customerID As String) As String
//!     Dim rs As ADODB.Recordset
//!     Dim sql As String
//!     
//!     sql = "SELECT CustomerName FROM Customers WHERE CustomerID = '" & customerID & "'"
//!     
//!     Set rs = New ADODB.Recordset
//!     rs.Open sql, conn
//!     
//!     If Not rs.EOF Then
//!         ' Remove trailing spaces from database field (may be CHAR type)
//!         GetCustomerName = RTrim(rs("CustomerName") & "")
//!     Else
//!         GetCustomerName = ""
//!     End If
//!     
//!     rs.Close
//!     Set rs = Nothing
//! End Function
//! ```
//!
//! ### Example 4: Report Formatting
//! ```vb
//! Sub GenerateReport()
//!     Dim rs As ADODB.Recordset
//!     Dim reportLine As String
//!     
//!     Set rs = New ADODB.Recordset
//!     rs.Open "SELECT * FROM Orders", conn
//!     
//!     lstReport.Clear
//!     
//!     Do While Not rs.EOF
//!         ' Format report line with proper spacing
//!         reportLine = RTrim(rs("CustomerName") & "") & " - " & _
//!                     "Order #" & rs("OrderID") & " - " & _
//!                     Format(rs("OrderDate"), "mm/dd/yyyy")
//!         
//!         lstReport.AddItem reportLine
//!         
//!         rs.MoveNext
//!     Loop
//!     
//!     rs.Close
//!     Set rs = Nothing
//! End Sub
//! ```
//!
//! ## Common Patterns
//!
//! ### Pattern 1: `FullTrim` (combine with `LTrim`)
//! ```vb
//! Function FullTrim(ByVal text As String) As String
//!     FullTrim = LTrim(RTrim(text))
//!     ' Note: Can also use built-in Trim() function
//! End Function
//! ```
//!
//! ### Pattern 2: `SafeRTrim` (handle Null)
//! ```vb
//! Function SafeRTrim(ByVal text As Variant) As String
//!     If IsNull(text) Then
//!         SafeRTrim = ""
//!     Else
//!         SafeRTrim = RTrim(text)
//!     End If
//! End Function
//! ```
//!
//! ### Pattern 3: `CleanDatabaseField`
//! ```vb
//! Function CleanDatabaseField(ByVal rs As Recordset, _
//!                            ByVal fieldName As String) As String
//!     If Not IsNull(rs(fieldName)) Then
//!         CleanDatabaseField = RTrim(rs(fieldName) & "")
//!     Else
//!         CleanDatabaseField = ""
//!     End If
//! End Function
//! ```
//!
//! ### Pattern 4: `TrimTrailingSpaces`
//! ```vb
//! Sub TrimTrailingSpaces(fields() As String)
//!     Dim i As Integer
//!     For i = LBound(fields) To UBound(fields)
//!         fields(i) = RTrim(fields(i))
//!     Next i
//! End Sub
//! ```
//!
//! ### Pattern 5: `CompareIgnoreTrailing`
//! ```vb
//! Function CompareIgnoreTrailing(ByVal str1 As String, _
//!                                ByVal str2 As String) As Boolean
//!     CompareIgnoreTrailing = (RTrim(str1) = RTrim(str2))
//! End Function
//! ```
//!
//! ### Pattern 6: `FormatFixedWidth`
//! ```vb
//! Function FormatFixedWidth(ByVal text As String, _
//!                          ByVal width As Integer) As String
//!     Dim padded As String
//!     padded = Left(text & Space(width), width)
//!     FormatFixedWidth = RTrim(padded)
//! End Function
//! ```
//!
//! ### Pattern 7: `CleanRecordsetField`
//! ```vb
//! Function CleanRecordsetField(ByVal rs As Recordset, _
//!                             ByVal fieldName As String, _
//!                             Optional ByVal defaultValue As String = "") As String
//!     On Error Resume Next
//!     If Not IsNull(rs(fieldName)) Then
//!         CleanRecordsetField = RTrim(CStr(rs(fieldName)))
//!     Else
//!         CleanRecordsetField = defaultValue
//!     End If
//! End Function
//! ```
//!
//! ### Pattern 8: `ExportCleanLine`
//! ```vb
//! Sub ExportCleanLine(ByVal fileNum As Integer, _
//!                     ByVal text As String)
//!     Print #fileNum, RTrim(text)
//! End Sub
//! ```
//!
//! ### Pattern 9: `RemoveTrailingPadding`
//! ```vb
//! Function RemoveTrailingPadding(ByVal paddedText As String) As String
//!     RemoveTrailingPadding = RTrim(paddedText)
//! End Function
//! ```
//!
//! ### Pattern 10: `CleanDisplayText`
//! ```vb
//! Sub CleanDisplayText(ByVal ctrl As Control)
//!     If TypeOf ctrl Is Label Or TypeOf ctrl Is TextBox Then
//!         ctrl.Caption = RTrim(ctrl.Caption)
//!     End If
//! End Sub
//! ```
//!
//! ## Advanced Examples
//!
//! ### Example 1: Fixed-Width File Processor
//! ```vb
//! ' Class: FixedWidthExporter
//! Private m_fileNum As Integer
//! Private m_isOpen As Boolean
//!
//! Public Sub OpenFile(ByVal filename As String)
//!     If m_isOpen Then CloseFile
//!     
//!     m_fileNum = FreeFile
//!     Open filename For Output As #m_fileNum
//!     m_isOpen = True
//! End Sub
//!
//! Public Sub WriteField(ByVal text As String, ByVal width As Integer)
//!     Dim padded As String
//!     
//!     ' Pad to width and remove trailing spaces
//!     padded = Left(text & Space(width), width)
//!     Print #m_fileNum, RTrim(padded);
//! End Sub
//!
//! Public Sub WriteLine()
//!     Print #m_fileNum, ""
//! End Sub
//!
//! Public Sub WriteRecord(ParamArray fields() As Variant)
//!     Dim i As Integer
//!     Dim line As String
//!     
//!     For i = LBound(fields) To UBound(fields)
//!         If i Mod 2 = 0 Then
//!             ' Even index = text
//!             line = line & Left(fields(i) & Space(fields(i + 1)), fields(i + 1))
//!         End If
//!     Next i
//!     
//!     Print #m_fileNum, RTrim(line)
//! End Sub
//!
//! Public Sub CloseFile()
//!     If m_isOpen Then
//!         Close #m_fileNum
//!         m_isOpen = False
//!     End If
//! End Sub
//!
//! Private Sub Class_Terminate()
//!     CloseFile
//! End Sub
//! ```
//!
//! ### Example 2: Database Field Cleaner
//! ```vb
//! ' Class: RecordsetCleaner
//! Private m_trimLeading As Boolean
//! Private m_trimTrailing As Boolean
//!
//! Private Sub Class_Initialize()
//!     m_trimLeading = False
//!     m_trimTrailing = True
//! End Sub
//!
//! Public Property Let TrimLeading(ByVal value As Boolean)
//!     m_trimLeading = value
//! End Property
//!
//! Public Property Let TrimTrailing(ByVal value As Boolean)
//!     m_trimTrailing = value
//! End Property
//!
//! Public Function GetCleanField(ByVal rs As Recordset, _
//!                               ByVal fieldName As String) As String
//!     Dim value As String
//!     
//!     If IsNull(rs(fieldName)) Then
//!         GetCleanField = ""
//!         Exit Function
//!     End If
//!     
//!     value = CStr(rs(fieldName))
//!     
//!     If m_trimTrailing Then
//!         value = RTrim(value)
//!     End If
//!     
//!     If m_trimLeading Then
//!         value = LTrim(value)
//!     End If
//!     
//!     GetCleanField = value
//! End Function
//!
//! Public Sub CleanRecordset(ByVal rs As Recordset)
//!     Dim fld As Field
//!     
//!     If rs.EOF And rs.BOF Then Exit Sub
//!     
//!     rs.MoveFirst
//!     Do While Not rs.EOF
//!         For Each fld In rs.Fields
//!             If fld.Type = adVarChar Or fld.Type = adChar Then
//!                 If Not IsNull(fld.Value) Then
//!                     fld.Value = GetCleanField(rs, fld.Name)
//!                 End If
//!             End If
//!         Next fld
//!         rs.MoveNext
//!     Loop
//! End Sub
//! ```
//!
//! ### Example 3: Report Generator
//! ```vb
//! ' Class: ReportGenerator
//! Private m_lines As Collection
//! Private m_columnWidths() As Integer
//!
//! Public Sub Initialize(columnWidths() As Integer)
//!     Set m_lines = New Collection
//!     m_columnWidths = columnWidths
//! End Sub
//!
//! Public Sub AddRow(ParamArray values() As Variant)
//!     Dim i As Integer
//!     Dim line As String
//!     Dim cellValue As String
//!     
//!     For i = LBound(values) To UBound(values)
//!         If i <= UBound(m_columnWidths) Then
//!             cellValue = CStr(values(i))
//!             line = line & Left(cellValue & Space(m_columnWidths(i)), _
//!                                m_columnWidths(i))
//!         End If
//!     Next i
//!     
//!     ' Remove trailing spaces from line
//!     m_lines.Add RTrim(line)
//! End Sub
//!
//! Public Sub AddSeparator()
//!     Dim i As Integer
//!     Dim line As String
//!     
//!     For i = LBound(m_columnWidths) To UBound(m_columnWidths)
//!         line = line & String(m_columnWidths(i), "-")
//!     Next i
//!     
//!     m_lines.Add RTrim(line)
//! End Sub
//!
//! Public Function GetReport() As String
//!     Dim line As Variant
//!     Dim report As String
//!     
//!     For Each line In m_lines
//!         report = report & line & vbCrLf
//!     Next line
//!     
//!     GetReport = report
//! End Function
//!
//! Public Sub SaveToFile(ByVal filename As String)
//!     Dim fileNum As Integer
//!     Dim line As Variant
//!     
//!     fileNum = FreeFile
//!     Open filename For Output As #fileNum
//!     
//!     For Each line In m_lines
//!         Print #fileNum, line
//!     Next line
//!     
//!     Close #fileNum
//! End Sub
//! ```
//!
//! ### Example 4: Text Utilities Module
//! ```vb
//! ' Module: TextUtils
//!
//! Public Function CleanTrailing(ByVal text As String) As String
//!     CleanTrailing = RTrim(text)
//! End Function
//!
//! Public Function CleanBoth(ByVal text As String) As String
//!     CleanBoth = LTrim(RTrim(text))
//! End Function
//!
//! Public Function CleanArray(arr() As String, _
//!                           ByVal trimType As String) As String()
//!     Dim i As Integer
//!     Dim result() As String
//!     
//!     ReDim result(LBound(arr) To UBound(arr))
//!     
//!     For i = LBound(arr) To UBound(arr)
//!         Select Case LCase(trimType)
//!             Case "trailing", "right"
//!                 result(i) = RTrim(arr(i))
//!             Case "leading", "left"
//!                 result(i) = LTrim(arr(i))
//!             Case "both", "all"
//!                 result(i) = LTrim(RTrim(arr(i)))
//!             Case Else
//!                 result(i) = arr(i)
//!         End Select
//!     Next i
//!     
//!     CleanArray = result
//! End Function
//!
//! Public Function PadAndTrim(ByVal text As String, _
//!                           ByVal width As Integer, _
//!                           Optional ByVal padChar As String = " ") As String
//!     Dim padded As String
//!     
//!     If Len(padChar) = 0 Then padChar = " "
//!     padded = Left(text & String(width, padChar), width)
//!     PadAndTrim = RTrim(padded)
//! End Function
//!
//! Public Function JoinClean(arr() As String, _
//!                          ByVal delimiter As String) As String
//!     Dim i As Integer
//!     Dim result As String
//!     Dim cleanValue As String
//!     
//!     For i = LBound(arr) To UBound(arr)
//!         cleanValue = RTrim(arr(i))
//!         If cleanValue <> "" Then
//!             If result <> "" Then
//!                 result = result & delimiter
//!             End If
//!             result = result & cleanValue
//!         End If
//!     Next i
//!     
//!     JoinClean = result
//! End Function
//! ```
//!
//! ## Error Handling
//!
//! ```vb
//! ' RTrim handles Null gracefully
//! Dim result As Variant
//! result = RTrim(Null)  ' Returns Null
//!
//! ' Safe trimming with Null check
//! Function SafeRTrim(ByVal value As Variant) As String
//!     If IsNull(value) Then
//!         SafeRTrim = ""
//!     Else
//!         SafeRTrim = RTrim(CStr(value))
//!     End If
//! End Function
//! ```
//!
//! ## Performance Considerations
//!
//! - **Fast Operation**: String trimming is highly optimized
//! - **Creates New String**: Does not modify original (immutable)
//! - **Avoid in Tight Loops**: Cache result if using multiple times
//! - **Use `Trim()` for Both**: If removing both leading and trailing spaces
//!
//! ## Best Practices
//!
//! 1. **Use for database CHAR fields** - Remove padding from fixed-length fields
//! 2. **Clean export data** - Remove trailing spaces before writing to files
//! 3. **Combine with `LTrim`** - Use `Trim()` instead for both sides
//! 4. **Validate before use** - Check for Null if using Variant
//! 5. **Cache trimmed values** - Don't call repeatedly in loops
//! 6. **Apply to report output** - Clean formatting in generated reports
//! 7. **Use with fixed-width formats** - Essential for proper alignment
//! 8. **Document expectations** - Clarify if tabs/newlines should be removed
//! 9. **Test edge cases** - Empty strings, all spaces, Null values
//! 10. **Consider Unicode** - `RTrim` only removes ASCII space (32)
//!
//! ## Comparison with Related Functions
//!
//! | Function | Removes Leading | Removes Trailing | Removes Both |
//! |----------|----------------|------------------|--------------|
//! | **`RTrim`** | No | Yes | No |
//! | **`LTrim`** | Yes | No | No |
//! | **Trim** | Yes | Yes | Yes |
//!
//! ## `RTrim` vs `LTrim` vs Trim
//!
//! ```vb
//! Dim text As String
//! text = "   Hello World   "
//!
//! ' RTrim - removes trailing spaces only
//! Debug.Print "[" & RTrim(text) & "]"   ' [   Hello World]
//!
//! ' LTrim - removes leading spaces only
//! Debug.Print "[" & LTrim(text) & "]"   ' [Hello World   ]
//!
//! ' Trim - removes both leading and trailing
//! Debug.Print "[" & Trim(text) & "]"    ' [Hello World]
//!
//! ' Manual equivalent to Trim
//! Debug.Print "[" & LTrim(RTrim(text)) & "]"  ' [Hello World]
//! ```
//!
//! ## Whitespace Characters
//!
//! ```vb
//! ' RTrim only removes space (ASCII 32)
//! Dim text As String
//!
//! text = "Hello   "        ' Spaces - REMOVED
//! text = "Hello" & Chr(9)  ' Tab - NOT REMOVED
//! text = "Hello" & Chr(10) ' Line feed - NOT REMOVED
//! text = "Hello" & Chr(13) ' Carriage return - NOT REMOVED
//! text = "Hello" & Chr(160) ' Non-breaking space - NOT REMOVED
//!
//! ' To remove other whitespace, use custom function
//! Function TrimAllWhitespaceRight(ByVal text As String) As String
//!     Do While Len(text) > 0
//!         Dim ch As String
//!         ch = Right(text, 1)
//!         
//!         If ch = " " Or ch = Chr(9) Or ch = Chr(10) Or ch = Chr(13) Then
//!             text = Left(text, Len(text) - 1)
//!         Else
//!             Exit Do
//!         End If
//!     Loop
//!     
//!     TrimAllWhitespaceRight = text
//! End Function
//! ```
//!
//! ## Platform Notes
//!
//! - Available in all VB6 versions
//! - Part of VBA core library
//! - Works with ANSI and Unicode strings
//! - Only removes ASCII space character (32)
//! - Returns new string (original unchanged)
//! - Handles Null by returning Null
//! - Available in `VBScript`
//! - Same behavior across all Windows versions
//!
//! ## Limitations
//!
//! - **Only Space Character**: Does not remove tabs, line feeds, etc.
//! - **No Unicode Whitespace**: Does not remove non-breaking spaces, em spaces, etc.
//! - **Creates New String**: Cannot modify string in place
//! - **No Custom Characters**: Cannot specify which characters to remove
//! - **Null Propagation**: Returns Null if input is Null
//!
//! ## Related Functions
//!
//! - `LTrim`: Removes leading spaces from string
//! - `Trim`: Removes both leading and trailing spaces
//! - `Right`: Returns rightmost characters
//! - `Left`: Returns leftmost characters
//! - `Mid`: Returns substring from middle
//! - `Replace`: Replaces occurrences of substring
//! - `Space`: Creates string of spaces
//! - `Len`: Returns string length

#[cfg(test)]
mod tests {
    use crate::*;

    #[test]
    fn rtrim_basic() {
        let source = r#"
            Dim result As String
            result = RTrim("Hello   ")
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_variable() {
        let source = r"
            cleaned = RTrim(userInput)
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_database_field() {
        let source = r#"
            customerName = RTrim(rs("CustomerName"))
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_if_statement() {
        let source = r#"
            If RTrim(text) = "" Then
                MsgBox "Empty"
            End If
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_function_return() {
        let source = r"
            Function CleanText(s As String) As String
                CleanText = RTrim(s)
            End Function
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_with_ltrim() {
        let source = r"
            fullTrim = LTrim(RTrim(text))
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_print_statement() {
        let source = r"
            Print #1, RTrim(line)
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_debug_print() {
        let source = r"
            Debug.Print RTrim(text)
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_with_statement() {
        let source = r"
            With record
                .Name = RTrim(.Name)
            End With
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_select_case() {
        let source = r#"
            Select Case RTrim(input)
                Case ""
                    MsgBox "Empty"
                Case Else
                    Process input
            End Select
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_elseif() {
        let source = r#"
            If text = "" Then
                status = "Empty"
            ElseIf RTrim(text) = "" Then
                status = "Whitespace only"
            End If
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_parentheses() {
        let source = r"
            result = (RTrim(text))
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_iif() {
        let source = r#"
            result = IIf(RTrim(text) = "", "Empty", "Has data")
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_in_class() {
        let source = r"
            Private Sub Class_Method()
                m_cleanValue = RTrim(m_rawValue)
            End Sub
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_function_argument() {
        let source = r"
            Call ProcessText(RTrim(input))
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_property_assignment() {
        let source = r"
            MyObject.CleanText = RTrim(dirtyText)
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_array_assignment() {
        let source = r"
            cleanValues(i) = RTrim(rawValues(i))
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_for_loop() {
        let source = r"
            For i = 1 To 10
                fields(i) = RTrim(fields(i))
            Next i
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_while_wend() {
        let source = r"
            While Not EOF(1)
                Line Input #1, line
                line = RTrim(line)
            Wend
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_do_while() {
        let source = r"
            Do While i < count
                text = RTrim(dataArray(i))
                i = i + 1
            Loop
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_do_until() {
        let source = r#"
            Do Until RTrim(input) <> ""
                input = InputBox("Enter text")
            Loop
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_msgbox() {
        let source = r"
            MsgBox RTrim(message)
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_concatenation() {
        let source = r#"
            reportLine = RTrim(customerName) & " - " & orderID
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_comparison() {
        let source = r#"
            If RTrim(text1) = RTrim(text2) Then
                MsgBox "Equal"
            End If
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_label_caption() {
        let source = r#"
            lblName.Caption = RTrim(recordset("Name"))
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_fixed_width() {
        let source = r"
            outputLine = RTrim(Left(field & Space(20), 20))
        ";
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }

    #[test]
    fn rtrim_additem() {
        let source = r#"
            lstCustomers.AddItem RTrim(rs("CompanyName"))
        "#;
        let (cst_opt, _failures) = ConcreteSyntaxTree::from_text("test.bas", source).unpack();
        let cst = cst_opt.expect("CST should be parsed");

        let tree = cst.to_serializable();

        let mut settings = insta::Settings::clone_current();
        settings
            .set_snapshot_path("../../../../../snapshots/syntax/library/functions/string/rtrim");
        settings.set_prepend_module_to_snapshot(false);
        let _guard = settings.bind_to_scope();
        insta::assert_yaml_snapshot!(tree);
    }
}