DebugLogManager.cs
62.1 KB
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
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Text;
using UnityEngine;
using UnityEngine.UI;
using UnityEngine.EventSystems;
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
using UnityEngine.InputSystem;
#endif
#if UNITY_EDITOR && UNITY_2021_1_OR_NEWER
using Screen = UnityEngine.Device.Screen; // To support Device Simulator on Unity 2021.1+
#endif
// Receives debug entries and custom events (e.g. Clear, Collapse, Filter by Type)
// and notifies the recycled list view of changes to the list of debug entries
//
// - Vocabulary -
// Debug/Log entry: a Debug.Log/LogError/LogWarning/LogException/LogAssertion request made by
// the client and intercepted by this manager object
// Debug/Log item: a visual (uGUI) representation of a debug entry
//
// There can be a lot of debug entries in the system but there will only be a handful of log items
// to show their properties on screen (these log items are recycled as the list is scrolled)
// An enum to represent filtered log types
namespace IngameDebugConsole
{
public enum DebugLogFilter
{
None = 0,
Info = 1,
Warning = 2,
Error = 4,
All = ~0
}
public enum PopupVisibility
{
Always = 0,
WhenLogReceived = 1,
Never = 2
}
public class DebugLogManager : MonoBehaviour
{
public static DebugLogManager Instance { get; private set; }
#pragma warning disable 0649
[Header( "Properties" )]
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, console window will persist between scenes (i.e. not be destroyed when scene changes)" )]
private bool singleton = true;
[SerializeField]
[HideInInspector]
[Tooltip( "Minimum height of the console window" )]
private float minimumHeight = 200f;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, console window can be resized horizontally, as well" )]
private bool enableHorizontalResizing = false;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, console window's resize button will be located at bottom-right corner. Otherwise, it will be located at bottom-left corner" )]
private bool resizeFromRight = true;
[SerializeField]
[HideInInspector]
[Tooltip( "Minimum width of the console window" )]
private float minimumWidth = 240f;
[SerializeField]
[HideInInspector]
[Tooltip( "Opacity of the console window" )]
[Range( 0f, 1f )]
private float logWindowOpacity = 1f;
[SerializeField]
[HideInInspector]
[Tooltip( "Opacity of the popup" )]
[Range( 0f, 1f )]
internal float popupOpacity = 1f;
[SerializeField]
[HideInInspector]
[Tooltip( "Determines when the popup will show up (after the console window is closed)" )]
private PopupVisibility popupVisibility = PopupVisibility.Always;
[SerializeField]
[HideInInspector]
[Tooltip( "Determines which log types will show the popup on screen" )]
private DebugLogFilter popupVisibilityLogFilter = DebugLogFilter.All;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, console window will initially be invisible" )]
private bool startMinimized = false;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, pressing the Toggle Key will show/hide (i.e. toggle) the console window at runtime" )]
private bool toggleWithKey = false;
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
[SerializeField]
[HideInInspector]
public InputAction toggleBinding = new InputAction( "Toggle Binding", type: InputActionType.Button, binding: "<Keyboard>/backquote", expectedControlType: "Button" );
#else
[SerializeField]
[HideInInspector]
private KeyCode toggleKey = KeyCode.BackQuote;
#endif
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, the console window will have a searchbar" )]
private bool enableSearchbar = true;
[SerializeField]
[HideInInspector]
[Tooltip( "Width of the canvas determines whether the searchbar will be located inside the menu bar or underneath the menu bar. This way, the menu bar doesn't get too crowded on narrow screens. This value determines the minimum width of the canvas for the searchbar to appear inside the menu bar" )]
private float topSearchbarMinWidth = 360f;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, the console window will continue receiving logs in the background even if its GameObject is inactive. But the console window's GameObject needs to be activated at least once because its Awake function must be triggered for this to work" )]
private bool receiveLogsWhileInactive = false;
[SerializeField]
[HideInInspector]
private bool receiveInfoLogs = true, receiveWarningLogs = true, receiveErrorLogs = true, receiveExceptionLogs = true;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, the arrival times of logs will be recorded and displayed when a log is expanded" )]
private bool captureLogTimestamps = false;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, timestamps will be displayed for logs even if they aren't expanded" )]
internal bool alwaysDisplayTimestamps = false;
[SerializeField]
[HideInInspector]
[Tooltip( "If the number of logs reach this limit, the oldest log(s) will be deleted to limit the RAM usage. It's recommended to set this value as low as possible" )]
private int maxLogCount = int.MaxValue;
[SerializeField]
[HideInInspector]
[Tooltip( "How many log(s) to delete when the threshold is reached (all logs are iterated during this operation so it should neither be too low nor too high)" )]
private int logsToRemoveAfterMaxLogCount = 16;
[SerializeField]
[HideInInspector]
[Tooltip( "While the console window is hidden, incoming logs will be queued but not immediately processed until the console window is opened (to avoid wasting CPU resources). When the log queue exceeds this limit, the first logs in the queue will be processed to enforce this limit. Processed logs won't increase RAM usage if they've been seen before (i.e. collapsible logs) but this is not the case for queued logs, so if a log is spammed every frame, it will fill the whole queue in an instant. Which is why there is a queue limit" )]
private int queuedLogLimit = 256;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, the command input field at the bottom of the console window will automatically be cleared after entering a command" )]
private bool clearCommandAfterExecution = true;
[SerializeField]
[HideInInspector]
[Tooltip( "Console keeps track of the previously entered commands. This value determines the capacity of the command history (you can scroll through the history via up and down arrow keys while the command input field is focused)" )]
private int commandHistorySize = 15;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, while typing a command, all of the matching commands' signatures will be displayed in a popup" )]
private bool showCommandSuggestions = true;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, on Android platform, logcat entries of the application will also be logged to the console with the prefix \"LOGCAT: \". This may come in handy especially if you want to access the native logs of your Android plugins (like Admob)" )]
private bool receiveLogcatLogsInAndroid = false;
#pragma warning disable 0414
#if UNITY_2018_3_OR_NEWER // On older Unity versions, disabling CS0169 is problematic: "Cannot restore warning 'CS0169' because it was disabled globally"
#pragma warning disable 0169
#endif
[SerializeField]
[HideInInspector]
[Tooltip( "Native logs will be filtered using these arguments. If left blank, all native logs of the application will be logged to the console. But if you want to e.g. see Admob's logs only, you can enter \"-s Ads\" (without quotes) here" )]
private string logcatArguments;
#if UNITY_2018_3_OR_NEWER
#pragma warning restore 0169
#endif
#pragma warning restore 0414
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, on Android and iOS devices with notch screens, the console window will be repositioned so that the cutout(s) don't obscure it" )]
private bool avoidScreenCutout = true;
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, on Android and iOS devices with notch screens, the console window's popup won't be obscured by the screen cutouts" )]
internal bool popupAvoidsScreenCutout = false;
[SerializeField]
[Tooltip( "If a log is longer than this limit, it will be truncated. This helps avoid reaching Unity's 65000 vertex limit for UI canvases" )]
private int maxLogLength = 10000;
#if UNITY_EDITOR || UNITY_STANDALONE || UNITY_WEBGL
[SerializeField]
[HideInInspector]
[Tooltip( "If enabled, on standalone platforms, command input field will automatically be focused (start receiving keyboard input) after opening the console window" )]
private bool autoFocusOnCommandInputField = true;
#endif
[Header( "Visuals" )]
[SerializeField]
private DebugLogItem logItemPrefab;
[SerializeField]
private Text commandSuggestionPrefab;
// Visuals for different log types
[SerializeField]
private Sprite infoLog;
[SerializeField]
private Sprite warningLog;
[SerializeField]
private Sprite errorLog;
private Sprite[] logSpriteRepresentations;
// Visuals for resize button
[SerializeField]
private Sprite resizeIconAllDirections;
[SerializeField]
private Sprite resizeIconVerticalOnly;
[SerializeField]
private Color collapseButtonNormalColor;
[SerializeField]
private Color collapseButtonSelectedColor;
[SerializeField]
private Color filterButtonsNormalColor;
[SerializeField]
private Color filterButtonsSelectedColor;
[SerializeField]
private string commandSuggestionHighlightStart = "<color=orange>";
[SerializeField]
private string commandSuggestionHighlightEnd = "</color>";
[Header( "Internal References" )]
[SerializeField]
private RectTransform logWindowTR;
internal RectTransform canvasTR;
[SerializeField]
private RectTransform logItemsContainer;
[SerializeField]
private RectTransform commandSuggestionsContainer;
[SerializeField]
private InputField commandInputField;
[SerializeField]
private Button hideButton;
[SerializeField]
private Button clearButton;
[SerializeField]
private Image collapseButton;
[SerializeField]
private Image filterInfoButton;
[SerializeField]
private Image filterWarningButton;
[SerializeField]
private Image filterErrorButton;
[SerializeField]
private Text infoEntryCountText;
[SerializeField]
private Text warningEntryCountText;
[SerializeField]
private Text errorEntryCountText;
[SerializeField]
private RectTransform searchbar;
[SerializeField]
private RectTransform searchbarSlotTop;
[SerializeField]
private RectTransform searchbarSlotBottom;
[SerializeField]
private Image resizeButton;
[SerializeField]
private GameObject snapToBottomButton;
// Canvas group to modify visibility of the log window
[SerializeField]
private CanvasGroup logWindowCanvasGroup;
[SerializeField]
private DebugLogPopup popupManager;
[SerializeField]
private ScrollRect logItemsScrollRect;
private RectTransform logItemsScrollRectTR;
private Vector2 logItemsScrollRectOriginalSize;
// Recycled list view to handle the log items efficiently
[SerializeField]
private DebugLogRecycledListView recycledListView;
#pragma warning restore 0649
private bool isLogWindowVisible = true;
public bool IsLogWindowVisible { get { return isLogWindowVisible; } }
public bool PopupEnabled
{
get { return popupManager.gameObject.activeSelf; }
set { popupManager.gameObject.SetActive( value ); }
}
private bool screenDimensionsChanged = true;
private float logWindowPreviousWidth;
// Number of entries filtered by their types
private int infoEntryCount = 0, warningEntryCount = 0, errorEntryCount = 0;
private bool entryCountTextsDirty;
// Number of new entries received this frame
private int newInfoEntryCount = 0, newWarningEntryCount = 0, newErrorEntryCount = 0;
// Filters to apply to the list of debug entries to show
private bool isCollapseOn = false;
private DebugLogFilter logFilter = DebugLogFilter.All;
// Search filter
private string searchTerm;
private bool isInSearchMode;
// If the last log item is completely visible (scrollbar is at the bottom),
// scrollbar will remain at the bottom when new debug entries are received
[System.NonSerialized]
public bool SnapToBottom = true;
// List of unique debug entries (duplicates of entries are not kept)
private DynamicCircularBuffer<DebugLogEntry> collapsedLogEntries;
private DynamicCircularBuffer<DebugLogEntryTimestamp> collapsedLogEntriesTimestamps;
// Dictionary to quickly find if a log already exists in collapsedLogEntries
private Dictionary<DebugLogEntry, DebugLogEntry> collapsedLogEntriesMap;
// The order the collapsedLogEntries are received
// (duplicate entries have the same value)
private DynamicCircularBuffer<DebugLogEntry> uncollapsedLogEntries;
private DynamicCircularBuffer<DebugLogEntryTimestamp> uncollapsedLogEntriesTimestamps;
// Filtered list of debug entries to show
private DynamicCircularBuffer<DebugLogEntry> logEntriesToShow;
private DynamicCircularBuffer<DebugLogEntryTimestamp> timestampsOfLogEntriesToShow;
// The log entry that must be focused this frame
private int indexOfLogEntryToSelectAndFocus = -1;
// Whether or not logs list view should be updated this frame
private bool shouldUpdateRecycledListView = true;
// Logs that should be registered in Update-loop
private DynamicCircularBuffer<QueuedDebugLogEntry> queuedLogEntries;
private DynamicCircularBuffer<DebugLogEntryTimestamp> queuedLogEntriesTimestamps;
private object logEntriesLock;
private int pendingLogToAutoExpand;
// Command suggestions that match the currently entered command
private List<Text> commandSuggestionInstances;
private int visibleCommandSuggestionInstances = 0;
private List<ConsoleMethodInfo> matchingCommandSuggestions;
private List<int> commandCaretIndexIncrements;
private string commandInputFieldPrevCommand;
private string commandInputFieldPrevCommandName;
private int commandInputFieldPrevParamCount = -1;
private int commandInputFieldPrevCaretPos = -1;
private int commandInputFieldPrevCaretArgumentIndex = -1;
// Value of the command input field when autocomplete was first requested
private string commandInputFieldAutoCompleteBase;
private bool commandInputFieldAutoCompletedNow;
// Pools for memory efficiency
private Stack<DebugLogEntry> pooledLogEntries;
private Stack<DebugLogItem> pooledLogItems;
/// Variables used by <see cref="RemoveOldestLogs"/>
private bool anyCollapsedLogRemoved;
private int removedLogEntriesToShowCount;
// History of the previously entered commands
private CircularBuffer<string> commandHistory;
private int commandHistoryIndex = -1;
private string unfinishedCommand;
// StringBuilder used by various functions
internal StringBuilder sharedStringBuilder;
// Offset of DateTime.Now from DateTime.UtcNow
private System.TimeSpan localTimeUtcOffset;
// Last recorded values of Time.realtimeSinceStartup and Time.frameCount on the main thread (because these Time properties can't be accessed from other threads)
#if !IDG_OMIT_ELAPSED_TIME
private float lastElapsedSeconds;
#endif
#if !IDG_OMIT_FRAMECOUNT
private int lastFrameCount;
#endif
private DebugLogEntryTimestamp dummyLogEntryTimestamp;
// Required in ValidateScrollPosition() function
private PointerEventData nullPointerEventData;
private System.Action<DebugLogEntry> poolLogEntryAction;
private System.Action<DebugLogEntry> removeUncollapsedLogEntryAction;
private System.Predicate<DebugLogEntry> shouldRemoveCollapsedLogEntryPredicate;
private System.Predicate<DebugLogEntry> shouldRemoveLogEntryToShowPredicate;
private System.Action<DebugLogEntry, int> updateLogEntryCollapsedIndexAction;
// Callbacks for log window show/hide events
public System.Action OnLogWindowShown, OnLogWindowHidden;
#if UNITY_EDITOR
private bool isQuittingApplication;
#endif
#if !UNITY_EDITOR && UNITY_ANDROID
private DebugLogLogcatListener logcatListener;
#endif
private void Awake()
{
// Only one instance of debug console is allowed
if( !Instance )
{
Instance = this;
// If it is a singleton object, don't destroy it between scene changes
if( singleton )
DontDestroyOnLoad( gameObject );
}
else if( Instance != this )
{
Destroy( gameObject );
return;
}
pooledLogEntries = new Stack<DebugLogEntry>( 64 );
pooledLogItems = new Stack<DebugLogItem>( 16 );
commandSuggestionInstances = new List<Text>( 8 );
matchingCommandSuggestions = new List<ConsoleMethodInfo>( 8 );
commandCaretIndexIncrements = new List<int>( 8 );
queuedLogEntries = new DynamicCircularBuffer<QueuedDebugLogEntry>( Mathf.Clamp( queuedLogLimit, 16, 4096 ) );
commandHistory = new CircularBuffer<string>( commandHistorySize );
logEntriesLock = new object();
sharedStringBuilder = new StringBuilder( 1024 );
canvasTR = (RectTransform) transform;
logItemsScrollRectTR = (RectTransform) logItemsScrollRect.transform;
logItemsScrollRectOriginalSize = logItemsScrollRectTR.sizeDelta;
// Associate sprites with log types
logSpriteRepresentations = new Sprite[5];
logSpriteRepresentations[(int) LogType.Log] = infoLog;
logSpriteRepresentations[(int) LogType.Warning] = warningLog;
logSpriteRepresentations[(int) LogType.Error] = errorLog;
logSpriteRepresentations[(int) LogType.Exception] = errorLog;
logSpriteRepresentations[(int) LogType.Assert] = errorLog;
// Initially, all log types are visible
filterInfoButton.color = filterButtonsSelectedColor;
filterWarningButton.color = filterButtonsSelectedColor;
filterErrorButton.color = filterButtonsSelectedColor;
resizeButton.sprite = enableHorizontalResizing ? resizeIconAllDirections : resizeIconVerticalOnly;
collapsedLogEntries = new DynamicCircularBuffer<DebugLogEntry>( 128 );
collapsedLogEntriesMap = new Dictionary<DebugLogEntry, DebugLogEntry>( 128, new DebugLogEntryContentEqualityComparer() );
uncollapsedLogEntries = new DynamicCircularBuffer<DebugLogEntry>( 256 );
logEntriesToShow = new DynamicCircularBuffer<DebugLogEntry>( 256 );
if( captureLogTimestamps )
{
collapsedLogEntriesTimestamps = new DynamicCircularBuffer<DebugLogEntryTimestamp>( 128 );
uncollapsedLogEntriesTimestamps = new DynamicCircularBuffer<DebugLogEntryTimestamp>( 256 );
timestampsOfLogEntriesToShow = new DynamicCircularBuffer<DebugLogEntryTimestamp>( 256 );
queuedLogEntriesTimestamps = new DynamicCircularBuffer<DebugLogEntryTimestamp>( queuedLogEntries.Capacity );
}
recycledListView.Initialize( this, logEntriesToShow, timestampsOfLogEntriesToShow, logItemPrefab.Transform.sizeDelta.y );
if( minimumWidth < 100f )
minimumWidth = 100f;
if( minimumHeight < 200f )
minimumHeight = 200f;
if( !resizeFromRight )
{
RectTransform resizeButtonTR = (RectTransform) resizeButton.GetComponentInParent<DebugLogResizeListener>().transform;
resizeButtonTR.anchorMin = new Vector2( 0f, resizeButtonTR.anchorMin.y );
resizeButtonTR.anchorMax = new Vector2( 0f, resizeButtonTR.anchorMax.y );
resizeButtonTR.pivot = new Vector2( 0f, resizeButtonTR.pivot.y );
( (RectTransform) commandInputField.transform ).anchoredPosition += new Vector2( resizeButtonTR.sizeDelta.x, 0f );
}
if( enableSearchbar )
searchbar.GetComponent<InputField>().onValueChanged.AddListener( SearchTermChanged );
else
{
searchbar = null;
searchbarSlotTop.gameObject.SetActive( false );
searchbarSlotBottom.gameObject.SetActive( false );
}
filterInfoButton.gameObject.SetActive( receiveInfoLogs );
filterWarningButton.gameObject.SetActive( receiveWarningLogs );
filterErrorButton.gameObject.SetActive( receiveErrorLogs || receiveExceptionLogs );
if( commandSuggestionsContainer.gameObject.activeSelf )
commandSuggestionsContainer.gameObject.SetActive( false );
// Register to UI events
commandInputField.onValidateInput += OnValidateCommand;
commandInputField.onValueChanged.AddListener( OnEditCommand );
commandInputField.onEndEdit.AddListener( OnEndEditCommand );
hideButton.onClick.AddListener( HideLogWindow );
clearButton.onClick.AddListener( ClearLogs );
collapseButton.GetComponent<Button>().onClick.AddListener( CollapseButtonPressed );
filterInfoButton.GetComponent<Button>().onClick.AddListener( FilterLogButtonPressed );
filterWarningButton.GetComponent<Button>().onClick.AddListener( FilterWarningButtonPressed );
filterErrorButton.GetComponent<Button>().onClick.AddListener( FilterErrorButtonPressed );
snapToBottomButton.GetComponent<Button>().onClick.AddListener( () => SnapToBottom = true );
localTimeUtcOffset = System.DateTime.Now - System.DateTime.UtcNow;
dummyLogEntryTimestamp = new DebugLogEntryTimestamp();
nullPointerEventData = new PointerEventData( null );
poolLogEntryAction = PoolLogEntry;
removeUncollapsedLogEntryAction = RemoveUncollapsedLogEntry;
shouldRemoveCollapsedLogEntryPredicate = ShouldRemoveCollapsedLogEntry;
shouldRemoveLogEntryToShowPredicate = ShouldRemoveLogEntryToShow;
updateLogEntryCollapsedIndexAction = UpdateLogEntryCollapsedIndex;
if( receiveLogsWhileInactive )
{
Application.logMessageReceivedThreaded -= ReceivedLog;
Application.logMessageReceivedThreaded += ReceivedLog;
}
#if UNITY_EDITOR && UNITY_2018_1_OR_NEWER
// OnApplicationQuit isn't reliable on some Unity versions when Application.wantsToQuit is used; Application.quitting is the only reliable solution on those versions
// https://issuetracker.unity3d.com/issues/onapplicationquit-method-is-called-before-application-dot-wantstoquit-event-is-raised
Application.quitting -= OnApplicationQuitting;
Application.quitting += OnApplicationQuitting;
#endif
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
toggleBinding.performed += ( context ) =>
{
if( toggleWithKey )
{
if( isLogWindowVisible )
HideLogWindow();
else
ShowLogWindow();
}
};
// On new Input System, scroll sensitivity is much higher than legacy Input system
logItemsScrollRect.scrollSensitivity *= 0.25f;
#endif
}
private void OnEnable()
{
if( Instance != this )
return;
if( !receiveLogsWhileInactive )
{
Application.logMessageReceivedThreaded -= ReceivedLog;
Application.logMessageReceivedThreaded += ReceivedLog;
}
if( receiveLogcatLogsInAndroid )
{
#if !UNITY_EDITOR && UNITY_ANDROID
if( logcatListener == null )
logcatListener = new DebugLogLogcatListener();
logcatListener.Start( logcatArguments );
#endif
}
#if IDG_ENABLE_HELPER_COMMANDS || IDG_ENABLE_LOGS_SAVE_COMMAND
DebugLogConsole.AddCommand( "logs.save", "Saves logs to persistentDataPath", SaveLogsToFile );
DebugLogConsole.AddCommand<string>( "logs.save", "Saves logs to the specified file", SaveLogsToFile );
#endif
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
if( toggleWithKey )
toggleBinding.Enable();
#endif
//Debug.LogAssertion( "assert" );
//Debug.LogError( "error" );
//Debug.LogException( new System.IO.EndOfStreamException() );
//Debug.LogWarning( "warning" );
//Debug.Log( "log" );
}
private void OnDisable()
{
if( Instance != this )
return;
if( !receiveLogsWhileInactive )
Application.logMessageReceivedThreaded -= ReceivedLog;
#if !UNITY_EDITOR && UNITY_ANDROID
if( logcatListener != null )
logcatListener.Stop();
#endif
DebugLogConsole.RemoveCommand( "logs.save" );
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
if( toggleBinding.enabled )
toggleBinding.Disable();
#endif
}
private void Start()
{
if( startMinimized )
{
HideLogWindow();
if( popupVisibility != PopupVisibility.Always )
popupManager.Hide();
}
else
ShowLogWindow();
PopupEnabled = ( popupVisibility != PopupVisibility.Never );
}
private void OnDestroy()
{
if( Instance == this )
Instance = null;
if( receiveLogsWhileInactive )
Application.logMessageReceivedThreaded -= ReceivedLog;
#if UNITY_EDITOR && UNITY_2018_1_OR_NEWER
Application.quitting -= OnApplicationQuitting;
#endif
}
#if UNITY_EDITOR
private void OnValidate()
{
maxLogCount = Mathf.Max( 2, maxLogCount );
logsToRemoveAfterMaxLogCount = Mathf.Max( 1, logsToRemoveAfterMaxLogCount );
queuedLogLimit = Mathf.Max( 0, queuedLogLimit );
if( UnityEditor.EditorApplication.isPlaying )
{
resizeButton.sprite = enableHorizontalResizing ? resizeIconAllDirections : resizeIconVerticalOnly;
filterInfoButton.gameObject.SetActive( receiveInfoLogs );
filterWarningButton.gameObject.SetActive( receiveWarningLogs );
filterErrorButton.gameObject.SetActive( receiveErrorLogs || receiveExceptionLogs );
}
}
#if UNITY_2018_1_OR_NEWER
private void OnApplicationQuitting()
#else
private void OnApplicationQuit()
#endif
{
isQuittingApplication = true;
}
#endif
// Window is resized, update the list
private void OnRectTransformDimensionsChange()
{
screenDimensionsChanged = true;
}
private void Update()
{
#if !IDG_OMIT_ELAPSED_TIME
lastElapsedSeconds = Time.realtimeSinceStartup;
#endif
#if !IDG_OMIT_FRAMECOUNT
lastFrameCount = Time.frameCount;
#endif
#if !UNITY_EDITOR && UNITY_ANDROID
if( logcatListener != null )
{
string log;
while( ( log = logcatListener.GetLog() ) != null )
ReceivedLog( "LOGCAT: " + log, string.Empty, LogType.Log );
}
#endif
#if !ENABLE_INPUT_SYSTEM || ENABLE_LEGACY_INPUT_MANAGER
// Toggling the console with toggleKey is handled in Update instead of LateUpdate because
// when we hide the console, we don't want the commandInputField to capture the toggleKey.
// InputField captures input in LateUpdate so deactivating it in Update ensures that
// no further input is captured
if( toggleWithKey )
{
if( Input.GetKeyDown( toggleKey ) )
{
if( isLogWindowVisible )
HideLogWindow();
else
ShowLogWindow();
}
}
#endif
}
private void LateUpdate()
{
#if UNITY_EDITOR
if( isQuittingApplication )
return;
#endif
int numberOfLogsToProcess = isLogWindowVisible ? queuedLogEntries.Count : ( queuedLogEntries.Count - queuedLogLimit );
ProcessQueuedLogs( numberOfLogsToProcess );
if( uncollapsedLogEntries.Count >= maxLogCount )
{
/// If log window isn't visible, remove the logs over time (i.e. don't remove more than <see cref="logsToRemoveAfterMaxLogCount"/>) to avoid performance issues.
int numberOfLogsToRemove = Mathf.Min( !isLogWindowVisible ? logsToRemoveAfterMaxLogCount : ( uncollapsedLogEntries.Count - maxLogCount + logsToRemoveAfterMaxLogCount ), uncollapsedLogEntries.Count );
RemoveOldestLogs( numberOfLogsToRemove );
}
// Don't perform CPU heavy tasks if neither the log window nor the popup is visible
if( !isLogWindowVisible && !PopupEnabled )
return;
int newInfoEntryCount, newWarningEntryCount, newErrorEntryCount;
lock( logEntriesLock )
{
newInfoEntryCount = this.newInfoEntryCount;
newWarningEntryCount = this.newWarningEntryCount;
newErrorEntryCount = this.newErrorEntryCount;
this.newInfoEntryCount = 0;
this.newWarningEntryCount = 0;
this.newErrorEntryCount = 0;
}
// Update entry count texts in a single batch
if( newInfoEntryCount > 0 || newWarningEntryCount > 0 || newErrorEntryCount > 0 )
{
if( newInfoEntryCount > 0 )
{
infoEntryCount += newInfoEntryCount;
if( isLogWindowVisible )
infoEntryCountText.text = infoEntryCount.ToString();
}
if( newWarningEntryCount > 0 )
{
warningEntryCount += newWarningEntryCount;
if( isLogWindowVisible )
warningEntryCountText.text = warningEntryCount.ToString();
}
if( newErrorEntryCount > 0 )
{
errorEntryCount += newErrorEntryCount;
if( isLogWindowVisible )
errorEntryCountText.text = errorEntryCount.ToString();
}
// If debug popup is visible, notify it of the new debug entries
if( !isLogWindowVisible )
{
entryCountTextsDirty = true;
if( popupVisibility == PopupVisibility.WhenLogReceived && !popupManager.IsVisible )
{
if( ( newInfoEntryCount > 0 && ( popupVisibilityLogFilter & DebugLogFilter.Info ) == DebugLogFilter.Info ) ||
( newWarningEntryCount > 0 && ( popupVisibilityLogFilter & DebugLogFilter.Warning ) == DebugLogFilter.Warning ) ||
( newErrorEntryCount > 0 && ( popupVisibilityLogFilter & DebugLogFilter.Error ) == DebugLogFilter.Error ) )
{
popupManager.Show();
}
}
if( popupManager.IsVisible )
popupManager.NewLogsArrived( newInfoEntryCount, newWarningEntryCount, newErrorEntryCount );
}
}
if( isLogWindowVisible )
{
// Update visible logs if necessary
if( shouldUpdateRecycledListView )
OnLogEntriesUpdated( false, false );
// Automatically expand the target log (if any)
if( indexOfLogEntryToSelectAndFocus >= 0 )
{
if( indexOfLogEntryToSelectAndFocus < logEntriesToShow.Count )
recycledListView.SelectAndFocusOnLogItemAtIndex( indexOfLogEntryToSelectAndFocus );
indexOfLogEntryToSelectAndFocus = -1;
}
if( entryCountTextsDirty )
{
infoEntryCountText.text = infoEntryCount.ToString();
warningEntryCountText.text = warningEntryCount.ToString();
errorEntryCountText.text = errorEntryCount.ToString();
entryCountTextsDirty = false;
}
float logWindowWidth = logWindowTR.rect.width;
if( !Mathf.Approximately( logWindowWidth, logWindowPreviousWidth ) )
{
logWindowPreviousWidth = logWindowWidth;
if( searchbar )
{
if( logWindowWidth >= topSearchbarMinWidth )
{
if( searchbar.parent == searchbarSlotBottom )
{
searchbarSlotTop.gameObject.SetActive( true );
searchbar.SetParent( searchbarSlotTop, false );
searchbarSlotBottom.gameObject.SetActive( false );
logItemsScrollRectTR.anchoredPosition = Vector2.zero;
logItemsScrollRectTR.sizeDelta = logItemsScrollRectOriginalSize;
}
}
else
{
if( searchbar.parent == searchbarSlotTop )
{
searchbarSlotBottom.gameObject.SetActive( true );
searchbar.SetParent( searchbarSlotBottom, false );
searchbarSlotTop.gameObject.SetActive( false );
float searchbarHeight = searchbarSlotBottom.sizeDelta.y;
logItemsScrollRectTR.anchoredPosition = new Vector2( 0f, searchbarHeight * -0.5f );
logItemsScrollRectTR.sizeDelta = logItemsScrollRectOriginalSize - new Vector2( 0f, searchbarHeight );
}
}
}
recycledListView.OnViewportWidthChanged();
}
// If SnapToBottom is enabled, force the scrollbar to the bottom
if( SnapToBottom )
{
logItemsScrollRect.verticalNormalizedPosition = 0f;
if( snapToBottomButton.activeSelf )
snapToBottomButton.SetActive( false );
}
else
{
float scrollPos = logItemsScrollRect.verticalNormalizedPosition;
if( snapToBottomButton.activeSelf != ( scrollPos > 1E-6f && scrollPos < 0.9999f ) )
snapToBottomButton.SetActive( !snapToBottomButton.activeSelf );
}
if( showCommandSuggestions && commandInputField.isFocused && commandInputField.caretPosition != commandInputFieldPrevCaretPos )
RefreshCommandSuggestions( commandInputField.text );
if( commandInputField.isFocused && commandHistory.Count > 0 )
{
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
if( Keyboard.current != null )
#endif
{
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
if( Keyboard.current[Key.UpArrow].wasPressedThisFrame )
#else
if( Input.GetKeyDown( KeyCode.UpArrow ) )
#endif
{
if( commandHistoryIndex == -1 )
{
commandHistoryIndex = commandHistory.Count - 1;
unfinishedCommand = commandInputField.text;
}
else if( --commandHistoryIndex < 0 )
commandHistoryIndex = 0;
commandInputField.text = commandHistory[commandHistoryIndex];
commandInputField.caretPosition = commandInputField.text.Length;
}
#if ENABLE_INPUT_SYSTEM && !ENABLE_LEGACY_INPUT_MANAGER
else if( Keyboard.current[Key.DownArrow].wasPressedThisFrame && commandHistoryIndex != -1 )
#else
else if( Input.GetKeyDown( KeyCode.DownArrow ) && commandHistoryIndex != -1 )
#endif
{
if( ++commandHistoryIndex < commandHistory.Count )
commandInputField.text = commandHistory[commandHistoryIndex];
else
{
commandHistoryIndex = -1;
commandInputField.text = unfinishedCommand ?? string.Empty;
}
}
}
}
}
if( screenDimensionsChanged )
{
// Update the recycled list view
if( isLogWindowVisible )
recycledListView.OnViewportHeightChanged();
else
popupManager.UpdatePosition( true );
#if UNITY_EDITOR || UNITY_ANDROID || UNITY_IOS
CheckScreenCutout();
#endif
screenDimensionsChanged = false;
}
}
public void ShowLogWindow()
{
// Show the log window
logWindowCanvasGroup.blocksRaycasts = true;
logWindowCanvasGroup.alpha = logWindowOpacity;
popupManager.Hide();
// Update the recycled list view
// (in case new entries were intercepted while log window was hidden)
OnLogEntriesUpdated( true, true );
#if UNITY_EDITOR || UNITY_STANDALONE || UNITY_WEBGL
// Focus on the command input field on standalone platforms when the console is opened
if( autoFocusOnCommandInputField )
StartCoroutine( ActivateCommandInputFieldCoroutine() );
#endif
isLogWindowVisible = true;
if( OnLogWindowShown != null )
OnLogWindowShown();
}
public void HideLogWindow()
{
// Hide the log window
logWindowCanvasGroup.blocksRaycasts = false;
logWindowCanvasGroup.alpha = 0f;
if( commandInputField.isFocused )
commandInputField.DeactivateInputField();
if( popupVisibility == PopupVisibility.Always )
popupManager.Show();
isLogWindowVisible = false;
// Deselect the currently selected UI object (if any) when the log window is hidden to avoid edge cases: https://github.com/yasirkula/UnityIngameDebugConsole/pull/85
if( EventSystem.current != null )
EventSystem.current.SetSelectedGameObject( null );
if( OnLogWindowHidden != null )
OnLogWindowHidden();
}
// Command field input is changed, check if command is submitted
private char OnValidateCommand( string text, int charIndex, char addedChar )
{
if( addedChar == '\t' ) // Autocomplete attempt
{
if( !string.IsNullOrEmpty( text ) )
{
if( string.IsNullOrEmpty( commandInputFieldAutoCompleteBase ) )
commandInputFieldAutoCompleteBase = text;
string autoCompletedCommand = DebugLogConsole.GetAutoCompleteCommand( commandInputFieldAutoCompleteBase, text );
if( !string.IsNullOrEmpty( autoCompletedCommand ) && autoCompletedCommand != text )
{
commandInputFieldAutoCompletedNow = true;
commandInputField.text = autoCompletedCommand;
}
}
return '\0';
}
else if( addedChar == '\n' ) // Command is submitted
{
// Clear the command field
if( clearCommandAfterExecution )
commandInputField.text = string.Empty;
if( text.Length > 0 )
{
if( commandHistory.Count == 0 || commandHistory[commandHistory.Count - 1] != text )
commandHistory.Add( text );
commandHistoryIndex = -1;
unfinishedCommand = null;
// Execute the command
DebugLogConsole.ExecuteCommand( text );
// Snap to bottom and select the latest entry
SnapToBottom = true;
}
return '\0';
}
return addedChar;
}
// A debug entry is received
public void ReceivedLog( string logString, string stackTrace, LogType logType )
{
#if UNITY_EDITOR
if( isQuittingApplication )
return;
#endif
switch( logType )
{
case LogType.Log: if( !receiveInfoLogs ) return; break;
case LogType.Warning: if( !receiveWarningLogs ) return; break;
case LogType.Error: if( !receiveErrorLogs ) return; break;
case LogType.Assert:
case LogType.Exception: if( !receiveExceptionLogs ) return; break;
}
// Truncate the log if it is longer than maxLogLength
int logLength = logString.Length;
if( stackTrace == null )
{
if( logLength > maxLogLength )
logString = logString.Substring( 0, maxLogLength - 11 ) + "<truncated>";
}
else
{
logLength += stackTrace.Length;
if( logLength > maxLogLength )
{
// Decide which log component(s) to truncate
int halfMaxLogLength = maxLogLength / 2;
if( logString.Length >= halfMaxLogLength )
{
if( stackTrace.Length >= halfMaxLogLength )
{
// Truncate both logString and stackTrace
logString = logString.Substring( 0, halfMaxLogLength - 11 ) + "<truncated>";
// If stackTrace doesn't end with a blank line, its last line won't be visible in the console for some reason
stackTrace = stackTrace.Substring( 0, halfMaxLogLength - 12 ) + "<truncated>\n";
}
else
{
// Truncate logString
logString = logString.Substring( 0, maxLogLength - stackTrace.Length - 11 ) + "<truncated>";
}
}
else
{
// Truncate stackTrace
stackTrace = stackTrace.Substring( 0, maxLogLength - logString.Length - 12 ) + "<truncated>\n";
}
}
}
QueuedDebugLogEntry queuedLogEntry = new QueuedDebugLogEntry( logString, stackTrace, logType );
DebugLogEntryTimestamp queuedLogEntryTimestamp;
if( queuedLogEntriesTimestamps != null )
{
// It is 10 times faster to cache local time's offset from UtcNow and add it to UtcNow to get local time at any time
System.DateTime dateTime = System.DateTime.UtcNow + localTimeUtcOffset;
#if !IDG_OMIT_ELAPSED_TIME && !IDG_OMIT_FRAMECOUNT
queuedLogEntryTimestamp = new DebugLogEntryTimestamp( dateTime, lastElapsedSeconds, lastFrameCount );
#elif !IDG_OMIT_ELAPSED_TIME
queuedLogEntryTimestamp = new DebugLogEntryTimestamp( dateTime, lastElapsedSeconds );
#elif !IDG_OMIT_FRAMECOUNT
queuedLogEntryTimestamp = new DebugLogEntryTimestamp( dateTime, lastFrameCount );
#else
queuedLogEntryTimestamp = new DebugLogEntryTimestamp( dateTime );
#endif
}
else
queuedLogEntryTimestamp = dummyLogEntryTimestamp;
lock( logEntriesLock )
{
/// Enforce <see cref="maxLogCount"/> in queued logs, as well. That's because when it's exceeded, the oldest queued logs will
/// be removed by <see cref="RemoveOldestLogs"/> immediately after they're processed anyways (i.e. waste of CPU and RAM).
if( queuedLogEntries.Count + 1 >= maxLogCount )
{
LogType removedLogType = queuedLogEntries.RemoveFirst().logType;
if( removedLogType == LogType.Log )
newInfoEntryCount--;
else if( removedLogType == LogType.Warning )
newWarningEntryCount--;
else
newErrorEntryCount--;
if( queuedLogEntriesTimestamps != null )
queuedLogEntriesTimestamps.RemoveFirst();
}
queuedLogEntries.Add( queuedLogEntry );
if( queuedLogEntriesTimestamps != null )
queuedLogEntriesTimestamps.Add( queuedLogEntryTimestamp );
if( logType == LogType.Log )
newInfoEntryCount++;
else if( logType == LogType.Warning )
newWarningEntryCount++;
else
newErrorEntryCount++;
}
}
// Process a number of logs waiting in the pending logs queue
private void ProcessQueuedLogs( int numberOfLogsToProcess )
{
for( int i = 0; i < numberOfLogsToProcess; i++ )
{
QueuedDebugLogEntry logEntry;
DebugLogEntryTimestamp timestamp;
lock( logEntriesLock )
{
logEntry = queuedLogEntries.RemoveFirst();
timestamp = queuedLogEntriesTimestamps != null ? queuedLogEntriesTimestamps.RemoveFirst() : dummyLogEntryTimestamp;
}
ProcessLog( logEntry, timestamp );
}
}
// Present the log entry in the console
private void ProcessLog( QueuedDebugLogEntry queuedLogEntry, DebugLogEntryTimestamp timestamp )
{
LogType logType = queuedLogEntry.logType;
DebugLogEntry logEntry;
if( pooledLogEntries.Count > 0 )
logEntry = pooledLogEntries.Pop();
else
logEntry = new DebugLogEntry();
logEntry.Initialize( queuedLogEntry.logString, queuedLogEntry.stackTrace );
// Check if this entry is a duplicate (i.e. has been received before)
DebugLogEntry existingLogEntry;
bool isEntryInCollapsedEntryList = collapsedLogEntriesMap.TryGetValue( logEntry, out existingLogEntry );
if( !isEntryInCollapsedEntryList )
{
// It is not a duplicate,
// add it to the list of unique debug entries
logEntry.logTypeSpriteRepresentation = logSpriteRepresentations[(int) logType];
logEntry.collapsedIndex = collapsedLogEntries.Count;
collapsedLogEntries.Add( logEntry );
collapsedLogEntriesMap[logEntry] = logEntry;
if( collapsedLogEntriesTimestamps != null )
collapsedLogEntriesTimestamps.Add( timestamp );
}
else
{
// It is a duplicate, pool the duplicate log entry and
// increment the original debug item's collapsed count
PoolLogEntry( logEntry );
logEntry = existingLogEntry;
logEntry.count++;
if( collapsedLogEntriesTimestamps != null )
collapsedLogEntriesTimestamps[logEntry.collapsedIndex] = timestamp;
}
uncollapsedLogEntries.Add( logEntry );
if( uncollapsedLogEntriesTimestamps != null )
uncollapsedLogEntriesTimestamps.Add( timestamp );
// If this debug entry matches the current filters,
// add it to the list of debug entries to show
int logEntryIndexInEntriesToShow = -1;
Sprite logTypeSpriteRepresentation = logEntry.logTypeSpriteRepresentation;
if( isCollapseOn && isEntryInCollapsedEntryList )
{
if( isLogWindowVisible || timestampsOfLogEntriesToShow != null )
{
if( !isInSearchMode && logFilter == DebugLogFilter.All )
logEntryIndexInEntriesToShow = logEntry.collapsedIndex;
else
logEntryIndexInEntriesToShow = logEntriesToShow.IndexOf( logEntry );
if( logEntryIndexInEntriesToShow >= 0 )
{
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow[logEntryIndexInEntriesToShow] = timestamp;
if( isLogWindowVisible )
recycledListView.OnCollapsedLogEntryAtIndexUpdated( logEntryIndexInEntriesToShow );
}
}
}
else if( ( !isInSearchMode || queuedLogEntry.MatchesSearchTerm( searchTerm ) ) && ( logFilter == DebugLogFilter.All ||
( logTypeSpriteRepresentation == infoLog && ( ( logFilter & DebugLogFilter.Info ) == DebugLogFilter.Info ) ) ||
( logTypeSpriteRepresentation == warningLog && ( ( logFilter & DebugLogFilter.Warning ) == DebugLogFilter.Warning ) ) ||
( logTypeSpriteRepresentation == errorLog && ( ( logFilter & DebugLogFilter.Error ) == DebugLogFilter.Error ) ) ) )
{
logEntriesToShow.Add( logEntry );
logEntryIndexInEntriesToShow = logEntriesToShow.Count - 1;
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.Add( timestamp );
shouldUpdateRecycledListView = true;
}
// Automatically expand this log if necessary
if( pendingLogToAutoExpand > 0 && --pendingLogToAutoExpand <= 0 && logEntryIndexInEntriesToShow >= 0 )
indexOfLogEntryToSelectAndFocus = logEntryIndexInEntriesToShow;
}
private void RemoveOldestLogs( int numberOfLogsToRemove )
{
if( numberOfLogsToRemove <= 0 )
return;
DebugLogEntry logEntryToSelectAndFocus = ( indexOfLogEntryToSelectAndFocus >= 0 && indexOfLogEntryToSelectAndFocus < logEntriesToShow.Count ) ? logEntriesToShow[indexOfLogEntryToSelectAndFocus] : null;
anyCollapsedLogRemoved = false;
removedLogEntriesToShowCount = 0;
uncollapsedLogEntries.TrimStart( numberOfLogsToRemove, removeUncollapsedLogEntryAction );
if( uncollapsedLogEntriesTimestamps != null )
uncollapsedLogEntriesTimestamps.TrimStart( numberOfLogsToRemove );
if( removedLogEntriesToShowCount > 0 )
{
logEntriesToShow.TrimStart( removedLogEntriesToShowCount );
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.TrimStart( removedLogEntriesToShowCount );
}
if( anyCollapsedLogRemoved )
{
collapsedLogEntries.RemoveAll( shouldRemoveCollapsedLogEntryPredicate, updateLogEntryCollapsedIndexAction, collapsedLogEntriesTimestamps );
if( isCollapseOn )
removedLogEntriesToShowCount = logEntriesToShow.RemoveAll( shouldRemoveLogEntryToShowPredicate, null, timestampsOfLogEntriesToShow );
}
if( removedLogEntriesToShowCount > 0 )
{
if( logEntryToSelectAndFocus == null || logEntryToSelectAndFocus.count == 0 )
indexOfLogEntryToSelectAndFocus = -1;
else
{
for( int i = Mathf.Min( indexOfLogEntryToSelectAndFocus, logEntriesToShow.Count - 1 ); i >= 0; i-- )
{
if( logEntriesToShow[i] == logEntryToSelectAndFocus )
{
indexOfLogEntryToSelectAndFocus = i;
break;
}
}
}
recycledListView.OnLogEntriesRemoved( removedLogEntriesToShowCount );
if( isLogWindowVisible )
OnLogEntriesUpdated( false, true );
}
else if( isLogWindowVisible && isCollapseOn )
recycledListView.RefreshCollapsedLogEntryCounts();
entryCountTextsDirty = true;
}
private void RemoveUncollapsedLogEntry( DebugLogEntry logEntry )
{
if( --logEntry.count <= 0 )
anyCollapsedLogRemoved = true;
if( !isCollapseOn && logEntriesToShow[removedLogEntriesToShowCount] == logEntry )
removedLogEntriesToShowCount++;
if( logEntry.logTypeSpriteRepresentation == infoLog )
infoEntryCount--;
else if( logEntry.logTypeSpriteRepresentation == warningLog )
warningEntryCount--;
else
errorEntryCount--;
}
private bool ShouldRemoveCollapsedLogEntry( DebugLogEntry logEntry )
{
if( logEntry.count <= 0 )
{
PoolLogEntry( logEntry );
collapsedLogEntriesMap.Remove( logEntry );
return true;
}
return false;
}
private bool ShouldRemoveLogEntryToShow( DebugLogEntry logEntry )
{
return logEntry.count <= 0;
}
private void UpdateLogEntryCollapsedIndex( DebugLogEntry logEntry, int collapsedIndex )
{
logEntry.collapsedIndex = collapsedIndex;
}
private void OnLogEntriesUpdated( bool updateAllVisibleItemContents, bool validateScrollPosition )
{
recycledListView.OnLogEntriesUpdated( updateAllVisibleItemContents );
shouldUpdateRecycledListView = false;
if( validateScrollPosition )
ValidateScrollPosition();
}
private void PoolLogEntry( DebugLogEntry logEntry )
{
if( pooledLogEntries.Count < 4096 )
{
logEntry.Clear();
pooledLogEntries.Push( logEntry );
}
}
// Make sure the scroll bar of the scroll rect is adjusted properly
internal void ValidateScrollPosition()
{
// When scrollbar is snapped to the very bottom of the scroll view, sometimes OnScroll alone doesn't work
if( logItemsScrollRect.verticalNormalizedPosition <= Mathf.Epsilon )
logItemsScrollRect.verticalNormalizedPosition = 0.0001f;
logItemsScrollRect.OnScroll( nullPointerEventData );
}
// Modifies certain properties of the most recently received log
public void AdjustLatestPendingLog( bool autoExpand, bool stripStackTrace )
{
lock( logEntriesLock )
{
if( queuedLogEntries.Count == 0 )
return;
if( autoExpand ) // Automatically expand the latest log in queuedLogEntries
pendingLogToAutoExpand = queuedLogEntries.Count;
if( stripStackTrace ) // Omit the latest log's stack trace
{
QueuedDebugLogEntry log = queuedLogEntries[queuedLogEntries.Count - 1];
queuedLogEntries[queuedLogEntries.Count - 1] = new QueuedDebugLogEntry( log.logString, string.Empty, log.logType );
}
}
}
// Clear all the logs
public void ClearLogs()
{
SnapToBottom = true;
indexOfLogEntryToSelectAndFocus = -1;
infoEntryCount = 0;
warningEntryCount = 0;
errorEntryCount = 0;
infoEntryCountText.text = "0";
warningEntryCountText.text = "0";
errorEntryCountText.text = "0";
collapsedLogEntries.ForEach( poolLogEntryAction );
collapsedLogEntries.Clear();
collapsedLogEntriesMap.Clear();
uncollapsedLogEntries.Clear();
logEntriesToShow.Clear();
if( collapsedLogEntriesTimestamps != null )
{
collapsedLogEntriesTimestamps.Clear();
uncollapsedLogEntriesTimestamps.Clear();
timestampsOfLogEntriesToShow.Clear();
}
recycledListView.DeselectSelectedLogItem();
OnLogEntriesUpdated( true, true );
}
// Collapse button is clicked
private void CollapseButtonPressed()
{
// Swap the value of collapse mode
isCollapseOn = !isCollapseOn;
SnapToBottom = true;
collapseButton.color = isCollapseOn ? collapseButtonSelectedColor : collapseButtonNormalColor;
recycledListView.SetCollapseMode( isCollapseOn );
// Determine the new list of debug entries to show
FilterLogs();
}
// Filtering mode of info logs has changed
private void FilterLogButtonPressed()
{
logFilter = logFilter ^ DebugLogFilter.Info;
if( ( logFilter & DebugLogFilter.Info ) == DebugLogFilter.Info )
filterInfoButton.color = filterButtonsSelectedColor;
else
filterInfoButton.color = filterButtonsNormalColor;
FilterLogs();
}
// Filtering mode of warning logs has changed
private void FilterWarningButtonPressed()
{
logFilter = logFilter ^ DebugLogFilter.Warning;
if( ( logFilter & DebugLogFilter.Warning ) == DebugLogFilter.Warning )
filterWarningButton.color = filterButtonsSelectedColor;
else
filterWarningButton.color = filterButtonsNormalColor;
FilterLogs();
}
// Filtering mode of error logs has changed
private void FilterErrorButtonPressed()
{
logFilter = logFilter ^ DebugLogFilter.Error;
if( ( logFilter & DebugLogFilter.Error ) == DebugLogFilter.Error )
filterErrorButton.color = filterButtonsSelectedColor;
else
filterErrorButton.color = filterButtonsNormalColor;
FilterLogs();
}
// Search term has changed
private void SearchTermChanged( string searchTerm )
{
if( searchTerm != null )
searchTerm = searchTerm.Trim();
this.searchTerm = searchTerm;
bool isInSearchMode = !string.IsNullOrEmpty( searchTerm );
if( isInSearchMode || this.isInSearchMode )
{
this.isInSearchMode = isInSearchMode;
FilterLogs();
}
}
// Show suggestions for the currently entered command
private void RefreshCommandSuggestions( string command )
{
if( !showCommandSuggestions )
return;
commandInputFieldPrevCaretPos = commandInputField.caretPosition;
// Don't recalculate the command suggestions if the input command hasn't changed (i.e. only caret's position has changed)
bool commandChanged = command != commandInputFieldPrevCommand;
bool commandNameOrParametersChanged = false;
if( commandChanged )
{
commandInputFieldPrevCommand = command;
matchingCommandSuggestions.Clear();
commandCaretIndexIncrements.Clear();
string prevCommandName = commandInputFieldPrevCommandName;
int numberOfParameters;
DebugLogConsole.GetCommandSuggestions( command, matchingCommandSuggestions, commandCaretIndexIncrements, ref commandInputFieldPrevCommandName, out numberOfParameters );
if( prevCommandName != commandInputFieldPrevCommandName || numberOfParameters != commandInputFieldPrevParamCount )
{
commandInputFieldPrevParamCount = numberOfParameters;
commandNameOrParametersChanged = true;
}
}
int caretArgumentIndex = 0;
int caretPos = commandInputField.caretPosition;
for( int i = 0; i < commandCaretIndexIncrements.Count && caretPos > commandCaretIndexIncrements[i]; i++ )
caretArgumentIndex++;
if( caretArgumentIndex != commandInputFieldPrevCaretArgumentIndex )
commandInputFieldPrevCaretArgumentIndex = caretArgumentIndex;
else if( !commandChanged || !commandNameOrParametersChanged )
{
// Command suggestions don't need to be updated if:
// a) neither the entered command nor the argument that the caret is hovering has changed
// b) entered command has changed but command's name hasn't changed, parameter count hasn't changed and the argument
// that the caret is hovering hasn't changed (i.e. user has continued typing a parameter's value)
return;
}
if( matchingCommandSuggestions.Count == 0 )
OnEndEditCommand( command );
else
{
if( !commandSuggestionsContainer.gameObject.activeSelf )
commandSuggestionsContainer.gameObject.SetActive( true );
int suggestionInstancesCount = commandSuggestionInstances.Count;
int suggestionsCount = matchingCommandSuggestions.Count;
for( int i = 0; i < suggestionsCount; i++ )
{
if( i >= visibleCommandSuggestionInstances )
{
if( i >= suggestionInstancesCount )
commandSuggestionInstances.Add( (Text) Instantiate( commandSuggestionPrefab, commandSuggestionsContainer, false ) );
else
commandSuggestionInstances[i].gameObject.SetActive( true );
visibleCommandSuggestionInstances++;
}
ConsoleMethodInfo suggestedCommand = matchingCommandSuggestions[i];
sharedStringBuilder.Length = 0;
if( caretArgumentIndex > 0 )
sharedStringBuilder.Append( suggestedCommand.command );
else
sharedStringBuilder.Append( commandSuggestionHighlightStart ).Append( matchingCommandSuggestions[i].command ).Append( commandSuggestionHighlightEnd );
if( suggestedCommand.parameters.Length > 0 )
{
sharedStringBuilder.Append( " " );
// If the command name wasn't highlighted, a parameter must always be highlighted
int caretParameterIndex = caretArgumentIndex - 1;
if( caretParameterIndex >= suggestedCommand.parameters.Length )
caretParameterIndex = suggestedCommand.parameters.Length - 1;
for( int j = 0; j < suggestedCommand.parameters.Length; j++ )
{
if( caretParameterIndex != j )
sharedStringBuilder.Append( suggestedCommand.parameters[j] );
else
sharedStringBuilder.Append( commandSuggestionHighlightStart ).Append( suggestedCommand.parameters[j] ).Append( commandSuggestionHighlightEnd );
}
}
commandSuggestionInstances[i].text = sharedStringBuilder.ToString();
}
for( int i = visibleCommandSuggestionInstances - 1; i >= suggestionsCount; i-- )
commandSuggestionInstances[i].gameObject.SetActive( false );
visibleCommandSuggestionInstances = suggestionsCount;
}
}
// Command input field's text has changed
private void OnEditCommand( string command )
{
RefreshCommandSuggestions( command );
if( !commandInputFieldAutoCompletedNow )
commandInputFieldAutoCompleteBase = null;
else // This change was caused by autocomplete
commandInputFieldAutoCompletedNow = false;
}
// Command input field has lost focus
private void OnEndEditCommand( string command )
{
if( commandSuggestionsContainer.gameObject.activeSelf )
commandSuggestionsContainer.gameObject.SetActive( false );
}
// Debug window is being resized,
// Set the sizeDelta property of the window accordingly while
// preventing window dimensions from going below the minimum dimensions
internal void Resize( PointerEventData eventData )
{
Vector2 localPoint;
if( !RectTransformUtility.ScreenPointToLocalPointInRectangle( canvasTR, eventData.position, eventData.pressEventCamera, out localPoint ) )
return;
// To be able to maximize the log window easily:
// - When enableHorizontalResizing is true and resizing horizontally, resize button will be grabbed from its left edge (if resizeFromRight is true) or its right edge
// - While resizing vertically, resize button will be grabbed from its top edge
Rect resizeButtonRect = ( (RectTransform) resizeButton.rectTransform.parent ).rect;
float resizeButtonWidth = resizeButtonRect.width;
float resizeButtonHeight = resizeButtonRect.height;
Vector2 canvasPivot = canvasTR.pivot;
Vector2 canvasSize = canvasTR.rect.size;
Vector2 anchorMin = logWindowTR.anchorMin;
// Horizontal resizing
if( enableHorizontalResizing )
{
if( resizeFromRight )
{
localPoint.x += canvasPivot.x * canvasSize.x + resizeButtonWidth;
if( localPoint.x < minimumWidth )
localPoint.x = minimumWidth;
Vector2 anchorMax = logWindowTR.anchorMax;
anchorMax.x = Mathf.Clamp01( localPoint.x / canvasSize.x );
logWindowTR.anchorMax = anchorMax;
}
else
{
localPoint.x += canvasPivot.x * canvasSize.x - resizeButtonWidth;
if( localPoint.x > canvasSize.x - minimumWidth )
localPoint.x = canvasSize.x - minimumWidth;
anchorMin.x = Mathf.Clamp01( localPoint.x / canvasSize.x );
}
}
// Vertical resizing
float notchHeight = -logWindowTR.sizeDelta.y; // Size of notch screen cutouts at the top of the screen
localPoint.y += canvasPivot.y * canvasSize.y - resizeButtonHeight;
if( localPoint.y > canvasSize.y - minimumHeight - notchHeight )
localPoint.y = canvasSize.y - minimumHeight - notchHeight;
anchorMin.y = Mathf.Clamp01( localPoint.y / canvasSize.y );
logWindowTR.anchorMin = anchorMin;
// Update the recycled list view
recycledListView.OnViewportHeightChanged();
}
// Determine the filtered list of debug entries to show on screen
private void FilterLogs()
{
logEntriesToShow.Clear();
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.Clear();
if( logFilter != DebugLogFilter.None )
{
DynamicCircularBuffer<DebugLogEntry> targetLogEntries = isCollapseOn ? collapsedLogEntries : uncollapsedLogEntries;
DynamicCircularBuffer<DebugLogEntryTimestamp> targetLogEntriesTimestamps = isCollapseOn ? collapsedLogEntriesTimestamps : uncollapsedLogEntriesTimestamps;
if( logFilter == DebugLogFilter.All )
{
if( !isInSearchMode )
{
logEntriesToShow.AddRange( targetLogEntries );
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.AddRange( targetLogEntriesTimestamps );
}
else
{
for( int i = 0, count = targetLogEntries.Count; i < count; i++ )
{
if( targetLogEntries[i].MatchesSearchTerm( searchTerm ) )
{
logEntriesToShow.Add( targetLogEntries[i] );
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.Add( targetLogEntriesTimestamps[i] );
}
}
}
}
else
{
// Show only the debug entries that match the current filter
bool isInfoEnabled = ( logFilter & DebugLogFilter.Info ) == DebugLogFilter.Info;
bool isWarningEnabled = ( logFilter & DebugLogFilter.Warning ) == DebugLogFilter.Warning;
bool isErrorEnabled = ( logFilter & DebugLogFilter.Error ) == DebugLogFilter.Error;
for( int i = 0, count = targetLogEntries.Count; i < count; i++ )
{
DebugLogEntry logEntry = targetLogEntries[i];
if( isInSearchMode && !logEntry.MatchesSearchTerm( searchTerm ) )
continue;
bool shouldShowLog = false;
if( logEntry.logTypeSpriteRepresentation == infoLog )
{
if( isInfoEnabled )
shouldShowLog = true;
}
else if( logEntry.logTypeSpriteRepresentation == warningLog )
{
if( isWarningEnabled )
shouldShowLog = true;
}
else if( isErrorEnabled )
shouldShowLog = true;
if( shouldShowLog )
{
logEntriesToShow.Add( logEntry );
if( timestampsOfLogEntriesToShow != null )
timestampsOfLogEntriesToShow.Add( targetLogEntriesTimestamps[i] );
}
}
}
}
// Update the recycled list view
recycledListView.DeselectSelectedLogItem();
OnLogEntriesUpdated( true, true );
}
public string GetAllLogs()
{
// Process all pending logs since we want to return "all" logs
ProcessQueuedLogs( queuedLogEntries.Count );
int count = uncollapsedLogEntries.Count;
int length = 0;
int newLineLength = System.Environment.NewLine.Length;
for( int i = 0; i < count; i++ )
{
DebugLogEntry entry = uncollapsedLogEntries[i];
length += entry.logString.Length + entry.stackTrace.Length + newLineLength * 3;
}
if( uncollapsedLogEntriesTimestamps != null )
length += count * 12; // Timestamp: "[HH:mm:ss]: "
length += 100; // Just in case...
StringBuilder sb = new StringBuilder( length );
for( int i = 0; i < count; i++ )
{
DebugLogEntry entry = uncollapsedLogEntries[i];
if( uncollapsedLogEntriesTimestamps != null )
{
uncollapsedLogEntriesTimestamps[i].AppendTime( sb );
sb.Append( ": " );
}
sb.AppendLine( entry.logString ).AppendLine( entry.stackTrace ).AppendLine();
}
return sb.ToString();
}
public void SaveLogsToFile()
{
SaveLogsToFile( Path.Combine( Application.persistentDataPath, System.DateTime.Now.ToString( "dd-MM-yyyy--HH-mm-ss" ) + ".txt" ) );
}
public void SaveLogsToFile( string filePath )
{
File.WriteAllText( filePath, GetAllLogs() );
Debug.Log( "Logs saved to: " + filePath );
}
// If a cutout is intersecting with debug window on notch screens, shift the window downwards
private void CheckScreenCutout()
{
if( !avoidScreenCutout )
return;
#if UNITY_2017_2_OR_NEWER && ( UNITY_EDITOR || UNITY_ANDROID || UNITY_IOS )
// Check if there is a cutout at the top of the screen
int screenHeight = Screen.height;
float safeYMax = Screen.safeArea.yMax;
if( safeYMax < screenHeight - 1 ) // 1: a small threshold
{
// There is a cutout, shift the log window downwards
float cutoutPercentage = ( screenHeight - safeYMax ) / Screen.height;
float cutoutLocalSize = cutoutPercentage * canvasTR.rect.height;
logWindowTR.anchoredPosition = new Vector2( 0f, -cutoutLocalSize );
logWindowTR.sizeDelta = new Vector2( 0f, -cutoutLocalSize );
}
else
{
logWindowTR.anchoredPosition = Vector2.zero;
logWindowTR.sizeDelta = Vector2.zero;
}
#endif
}
#if UNITY_EDITOR || UNITY_STANDALONE || UNITY_WEBGL
private IEnumerator ActivateCommandInputFieldCoroutine()
{
// Waiting 1 frame before activating commandInputField ensures that the toggleKey isn't captured by it
yield return null;
commandInputField.ActivateInputField();
yield return null;
commandInputField.MoveTextEnd( false );
}
#endif
// Pool an unused log item
internal void PoolLogItem( DebugLogItem logItem )
{
logItem.CanvasGroup.alpha = 0f;
logItem.CanvasGroup.blocksRaycasts = false;
pooledLogItems.Push( logItem );
}
// Fetch a log item from the pool
internal DebugLogItem PopLogItem()
{
DebugLogItem newLogItem;
// If pool is not empty, fetch a log item from the pool,
// create a new log item otherwise
if( pooledLogItems.Count > 0 )
{
newLogItem = pooledLogItems.Pop();
newLogItem.CanvasGroup.alpha = 1f;
newLogItem.CanvasGroup.blocksRaycasts = true;
}
else
{
newLogItem = (DebugLogItem) Instantiate( logItemPrefab, logItemsContainer, false );
newLogItem.Initialize( recycledListView );
}
return newLogItem;
}
}
}