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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>DC - Скрипты Lua</title>
<link rel="stylesheet" type="text/css" href="doublecmd.css">
<link rel="shortcut icon" href="../../pixmaps/common/favicon.ico">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<a name="topofpage"></a>
<div class="header"><a href="index.html"><img src="../../pixmaps/common/dclogo2017.png" alt="Double Commander" height="48" width="374"></a>
<div id="global-nav" class="nav"><a title="Домашняя страница Double Commander" href="https://doublecmd.sourceforge.io/" target="_blank">Домашняя страница</a> | <a title="Вики Double Commander" href="https://github.com/doublecmd/doublecmd/wiki" target="_blank">Вики</a></div>
</div>
<div class="footer"><div class="nav"><a title="Начало" href="index.html">Начало</a> | <a title="Предыдущая страница" href="regexp.html">Пред.</a> | <a title="Следующая страница" href="commandline.html">След.</a></div></div>
<div class="dchelpage">
<div>
<h1>2.15. Скрипты Lua</h1>
</div>
<div>
<h2>Содержание</h2>
<dl>
<dt>1. <a href="#preface">Введение</a></dt>
<dt>2. <a href="#dllrequired">Необходимая DLL</a></dt>
<dt>3. <a href="#libraries">Библиотеки функций Double Commander</a></dt>
<dd>
<dl>
<dt>3.1. <a href="#libdc">Библиотека DC</a></dt>
<dd>
<dl>
<dt>3.1.1. <a href="#exampleex">Пример с DC.ExecuteCommand</a></dt>
</dl>
</dd>
<dt>3.2. <a href="#librarysystem">Библиотека System</a></dt>
<dd>
<dl>
<dt>3.2.1. <a href="#detailattr">Описание возвращаемого значения SysUtils.FileGetAttr</a></dt>
<dt>3.2.2. <a href="#exampleattr">Пример с SysUtils.FileGetAttr</a></dt>
<dt>3.2.3. <a href="#examplefind">Пример использования FindFirst, FindNext и FindClose</a></dt>
</dl>
</dd>
<dt>3.3. <a href="#libraryclip">Библиотека Clipboard</a></dt>
<dd>
<dl>
<dt>3.3.1. <a href="#exampleclip">Пример работы с буфером обмена</a></dt>
</dl>
</dd>
<dt>3.4. <a href="#librarydialogs">Библиотека Dialogs</a></dt>
<dd>
<dl>
<dt>3.4.1. <a href="#dlgbuts">Кнопки Dialogs.MessageBox</a></dt>
<dt>3.4.2. <a href="#dlgstyle">Стиль окна Dialogs.MessageBox</a></dt>
<dt>3.4.3. <a href="#dlgdefbut">Кнопка по умолчанию в Dialogs.MessageBox</a></dt>
<dt>3.4.4. <a href="#msgreturn">Возвращаемое значение Dialogs.MessageBox</a></dt>
<dt>3.4.5. <a href="#mesgboxsample">Пример использования Dialogs.MessageBox</a></dt>
<dt>3.4.6. <a href="#querysample">Пример использования Dialogs.InputQuery</a></dt>
</dl>
</dd>
<dt>3.5. <a href="#libraryutf8">Библиотека UTF-8</a></dt>
<dt>3.6. <a href="#librarychar">Библиотека Char</a></dt>
<dt>3.7. <a href="#libraryos">Библиотека OS</a></dt>
</dl>
</dd>
<dt>4. <a href="#index">Индекс</a></dt>
</dl>
</div>
<div>
<h2><a name="preface">1. Введение</a></h2>
<p>Подробную информацию о скриптовом языке программирования Lua можно найти на <a href="https://www.lua.org/" target="_blank">веб-сайте Lua</a>.</p>
<p>Double Commander может выполнять скрипты Lua с помощью команды <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a>.<br>
Параметры скриптов должны передаваться как есть, без экранирования (без кавычек или "\"), для этого необходимо использовать переменную <a href="variables.html#quotation">%"0</a>: например, <code>%"0%p0</code> для файла под курсором вместо <code>%p0</code> или <code>%"0%D</code> для текущего каталога вместо <code>%D</code>. В противном случае, если Double Commander автоматически добавит кавычки, они будут переданы как часть параметра и вам придётся их учитывать.<br>
Для получения списка всех выделенных файлов мы можем использовать <a href="variables.html#listoffiles">переменные</a> (<code>%LU</code>, <code>%FU</code> или <code>%RU</code>) или внутренние команды (<a href="cmds.html#cm_SaveSelectionToFile">cm_SaveSelectionToFile</a>, <a href="cmds.html#cm_SaveFileDetailsToFile">cm_SaveFileDetailsToFile</a>, <a href="cmds.html#cm_CopyFullNamesToClip">cm_CopyFullNamesToClip</a> или <a href="cmds.html#cm_CopyFileDetailsToClip">cm_CopyFileDetailsToClip</a>).
Мы можем использовать, например, <code>%p</code>: в этом случае Double Commander передаст имена всех выделенных файлов одной строкой, разделяя имена пробелом.</p>
<p>Также на языке Lua можно писать информационные плагины, примеры можно найти в папке программы (<tt>plugins/wdx/scripts</tt>).
В Вики есть <a href="https://github.com/doublecmd/doublecmd/wiki/Plugins-development" target="_blank">страница</a>, посвящённая написанию плагинов.
Ограничения: поддерживаются только следующие типы данных</p>
<ul>
<li><i>ft_numeric_32</i> (1) – 32-битное целое число со знаком;</li>
<li><i>ft_numeric_64</i> (2) – 64-битное целое число со знаком;</li>
<li><i>ft_numeric_floating</i> (3) – число с плавающей запятой;</li>
<li><i>ft_boolean</i> (6) – логический (булев) тип: <i>true</i> или <i>false</i>;</li>
<li><i>ft_multiplechoice</i> (7) – значение, допускающее ограниченное количество вариантов выбора;</li>
<li><i>ft_string</i> (8) – текстовая строка;</li>
<li><i>ft_fulltext</i> (9) – полный текст (многострочный текст), используется только для поиска с помощью плагинов;</li>
<li><i>ft_datetime</i> (10) – для даты/времени: возвращаемая дата будет сконвертирована в отформатированную строку даты и времени (значение зависит от ваших региональных настроек).<br>
Дата должна быть в формате Windows, но в Lua и в функциях, которые Double Commander предоставляет для поиска файлов, используется время в формате Unix. Для конвертации мы можем использовать формулу:<br>
= UnixTime * 10000000 + 116444736000000000<br>
Это большое число, поэтому потребуется 64-битная версия Double Commander или Lua 5.3+.</li>
</ul>
<p>Список выше содержит имена из заголовочных файлов, в скриптах Lua мы должны использовать цифровые значения, которые указаны в скобках.</p>
<br>
<p><span class="bold">О кодировке текста</span></p>
<p>Все дополнительные функции, описанные ниже, принимают строковые параметры в кодировке UTF-8 и возвращают строки в этой кодировке (за исключением функции <a href="#libraryutf8">LazUtf8.ConvertEncoding</a>).</p>
<p>Часть функций из стандартных библиотек Lua заменены на функции из Double Commander или Free Pascal/Lazarus (или написаны новые), это обеспечивает поддержку UTF-8.</p>
<p>При написании плагинов мы также должны использовать UTF-8 для текстовых данных (<i>ft_multiplechoice</i>, <i>ft_string</i> и <i>ft_fulltext</i>).</p>
<p>При сохранении скриптов используйте кодировку UTF-8 без BOM.</p>
<br>
<p><span class="bold">Примечания</span></p>
<p>Автоматизация с помощью Lua имеет большие возможности, но могут быть нюансы, которые в некоторых случаях необходимо иметь в виду. Давайте попробуем собрать их в этом подразделе.</p>
<p>1. Если включено <a href="configuration.html#ConfigRefresh">автообновление</a> и опция <a href="configuration.html#ConfigViewEx">Загружать список файлов в отдельном потоке</a>, то функция обновления будет работать асинхронно. При этом скрипты выполняются в основном потоке Double Commander и поэтому в некоторых случаях всё это может отразиться на работе вашего скрипта. Например, иногда последовательное выполнение <a href="cmds.html#catnavigation">команд для навигации</a> может не сработать (например, большие каталоги, медленный диск), в этом случае попробуйте отключить <i>Загружать список файлов в отдельном потоке</i> или поискать альтернативное решение.</p>
<p>Если ваш скрипт создаёт новые файлы в текущей панели или переименовывает существующие файлы, но после этого не завершается и выполняет некоторые дополнительные действия (например, выделение файов или перемещение курсора), то в некоторых случаях эти действия не будут иметь эффекта: ещё не все файлы могут быть в панели и вам потребуется предварительно вызвать команду <a href="cmds.html#cm_Refresh">cm_Refresh</a>. При описываемых условиях <tt>cm_Refresh</tt> также будет выполняться асинхронно и Double Commander может не успеть полностью обновить список файлов после ваших изменений.</p>
<p>Автообновление и загрузка списка файлов в отдельном потоке – это удобные функции для файлового менеджера, поэтому экспериментально был найден стабильно работающий способ на время вернуть управление программе и позволить полностью завершить обновление списка файлов:</p>
<pre>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_Refresh"</span><span class="luasbl">)</span>
i <span class="luasbl">=</span> <span class="luanum">10</span>
<span class="luakyw">while</span> i <span class="luasbl">></span> <span class="luanum">0</span> <span class="luakyw">do</span>
SysUtils.Sleep<span class="luasbl">(</span><span class="luanum">10</span><span class="luasbl">)</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">""</span><span class="luasbl">)</span>
i <span class="luasbl">=</span> i <span class="luasbl">-</span> <span class="luanum">1</span>
<span class="luakyw">end</span></pre>
<p>2. Функция Lua <code>io.open</code> использует стандартную функцию C <code>fopen</code>: в текстовом режиме эта функция может преобразовывать тип окончания строк (CRLF, LF или CR) при чтении и записи, что может привести к неожиданному результату. Если вам попадаются файлы с разным типом окончания строк или вы пишете кроссплатформенный скрипт, это необходимо учитывать или может быть практичнее отдать предпочтение бинарному режиму.</p>
<p>3. Для диалога <a href="help.html#cm_FileProperties">свойств файла</a> в Linux и других Unix-подобных операционных системах функция <code>ContentGetValue</code> вызывается с флагом <code>CONTENT_DELAYIFSLOW</code> (четвёртый параметр, значение равно 1), это позволяет избежать задержки открытия окна: если получение данных медленное, мы можем эти данные исключить, просто добавляем проверку значения флага и возвращаем <code>nil</code> для таких полей или плагина.</p>
<p>4. Если плагин должен вернуть пустую строку, то более быстрым будет передать <code>nil</code> вместо <code>""</code>.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="dllrequired">2. Необходимая DLL</a></h2>
<p>Чтобы использовать скрипты Lua, нам требуется интерпретатор Lua, Double Commander поддерживает версии 5.1 - 5.4.</p>
<p>Мы можем использовать DLL-файл <a href="https://luajit.org/" target="_blank">проекта LuaJIT</a>. LuaJIT сочетает в себе высокоскоростной интерпретатор, написанный на ассемблере, и JIT-компилятор. Также мы получаем библиотеку FFI: с её помощью в скриптах можно будет вызывать внешние функции C и использовать структуры данных C.</p>
<p>Дистрибутивы DC для Windows включают в себя DLL-файл Lua (в DC 0.9.7 и новее из проекта LuaJIT), в иных случаях мы можем найти и установить его с помощью менеджера пакетов или скомпилировать. Если используем 64-битную версию DC, то DLL-файл также должен быть 64-битным.</p>
<p>По умолчанию DC ищет файл с именем <tt>lua5.1.dll</tt> (Windows), <tt>liblua5.1.so.0</tt> (Unix или GNU/Linux) или <tt>liblua5.1.dylib</tt> (macOS) в своём каталоге и в системном. Мы можем изменить имя файла (и путь) в параметре <a href="configuration.html#luapathtolibrary">Библиотека Lua</a>.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="libraries">3. Библиотеки функций Double Commander</a></h2>
<p>Double Commander предлагает несколько библиотек функций для скриптов Lua, список представлен ниже.</p>
<table>
<tr class="rowcategorytitle"><th colspan="3">Список библиотек</th></tr>
<tr class="rowsubtitle"><th class="namecolumn">Библиотека</th><th class="namecolumn">Имя функции</th><th class="categorydesccolumn">Краткое описание</th></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#libdc">Double Commander</a></div></td><td class="hintcell">DC</td><td class="hintcell">Специфические функции Double Commander</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#librarysystem">System</a></div></td><td class="hintcell">SysUtils</td><td class="hintcell">Различные системные функции</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#libraryclip">Clipboard</a></div></td><td class="hintcell">Clipbrd</td><td class="hintcell">Различные функции для работы с буфером обмена</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#librarydialogs">Dialogs</a></div></td><td class="hintcell">Dialogs</td><td class="hintcell">Взаимодействие с пользователем</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#libraryutf8">UTF-8</a></div></td><td class="hintcell">LazUtf8</td><td class="hintcell">Строковые функции для работы с UTF-8</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#librarychar">Char</a></div></td><td class="hintcell">Char</td><td class="hintcell">Получение информации о символах</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft"><a href="#libraryos">OS</a></div></td><td class="hintcell">os</td><td class="hintcell">Функции, связанные с операционной системой</td></tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="libdc">3.1. Библиотека DC</a></h2>
<p>Эта библиотека содержит специфические функции Double Commander, все функции представлены в таблице <code>DC</code>.</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека DC</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_logwrite">DC.LogWrite</a></div></td>
<td class="hintcell">
<p class="definition">DC.LogWrite(sMessage, iMsgType, bForce, bLogFile)</p>
<p>Пишет сообщение в окно протокола:</p>
<ul>
<li><var>sMessage</var> : Текст сообщения.</li>
<li><var>iMsgType</var> : Тип сообщения: 0 - информационное, 1 - успешная операция, 2 - ошибка.</li>
<li><var>bForce</var> : Логическое (булево) значение, если <code>true</code>, то показать окно протокола (если оно скрыто).</li>
<li><var>bLogFile</var> : Логическое (булево) значение, если <code>true</code>, то сообщение будет записано и в файл протокола.</li>
</ul>
<p>Внутренняя функция Double Commander для записи в протокол работает асинхронно (смотрите примечания во <a href="#preface">введении</a>), поэтому сообщения из <code>DC.LogWrite</code> будут записаны в протокол не сразу, а после завершения работы скрипта. Если необходимо записать текст сообщения сразу, мы можем попробовать добавить вызов <code>DC.ExecuteCommand("")</code> после <code>DC.LogWrite</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_currentpanel">DC.CurrentPanel</a></div></td>
<td class="hintcell">
<p class="definition">iPanel = DC.CurrentPanel()</p>
<p>Получить активную панель: возвращает 0, если активна левая панель, или 1, если правая.</p>
<p class="definition">DC.CurrentPanel(iPanel)</p>
<p>Сделать активной: левую панель, если <var>iPanel</var> равно 0, или правую, если равно 1.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_executecommand">DC.ExecuteCommand</a></div></td>
<td class="hintcell">
<p class="definition">DC.ExecuteCommand(sCommand, Param1, Param2,...,ParamX)</p>
<p>Вызывает <a href="cmds.html">внутреннюю команду</a> Double Commander <var>sCommand</var> с параметрами <var>Param1</var>..<var>ParamX</var>.</p>
<p>Мы можем указать столько <var>Param...</var>, сколько поддерживает команда <var>Command</var>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_gotofile">DC.GoToFile</a></div></td>
<td class="hintcell">
<p class="definition">DC.GoToFile(sFileName, bActive)</p>
<p>Открывает каталог, в котором расположен <var>sFileName</var>, и ставит на <var>sFileName</var> курсор. Чтобы открыть каталог, используйте <a href="cmds.html#cm_ChangeDir">cm_ChangeDir</a> или попробуйте добавить к <var>sFileName</var> разделитель каталогов и ".." (без кавычек).</p>
<p><var>bActive</var> – это опциональный параметр: функция может работать в активной файловой панели (<code>true</code>) или неактивной (<code>false</code>). По умолчанию <code>true</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_getpluginfield">DC.GetPluginField</a></div></td>
<td class="hintcell">
<p class="definition">Result = DC.GetPluginField(sFileName, sPlugin, iField, iUnit)</p>
<p>Позволяет получить данные с помощью установленного информационного (или контентного) плагина (WDX):</p>
<ul>
<li><var>sFileName</var> : Полное (абсолютное) имя файла.</li>
<li><var>sPlugin</var> : Имя плагина, как оно сохранено в соответствующем <a href="configuration.html#ConfigPlugins">разделе настроек</a>.</li>
<li><var>iField</var> : Индекс поля плагина (отсчёт от 0).</li>
<li><var>iUnit</var> : Индекс единицы измерения (отсчёт от 0); укажите 0, если отсутствует.</li>
<li><var>Result</var> : Возвращаемое значение: целое число со знаком (включая время в формате Unix), число с плавающей запятой, логическое (булево) значение, текстовая строка или <code>nil</code>.</li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dc_expandvar">DC.ExpandVar</a></div></td>
<td class="hintcell">
<p class="definition">sResult = DC.ExpandVar(String)</p>
<p>Возвращает строку, в которой все <a href="variables.html">переменные</a> заменены на их значения (исключая переменные окружения, для них используйте <a href="#sysutils_expandenv">SysUtils.ExpandEnv</a>).</p>
</td>
</tr>
</table>
<p>Помимо внутренних команд, в скриптах мы можем использовать специальную команду <tt>cm_ExecuteToolBarItem</tt>, эта команда позволяет вызывать кнопки панелей инструментов по их идентификатору (в программе эта функция обеспечивает использование горячих клавиш для кнопок панелей инструментов). Команда используется аналогично обычным внутренним командам (смотрите примеры ниже) и имеет следующие параметры:</p>
<table class="innercmddesc">
<tr class="rowinnerdesc">
<th class="innerdescheader">Параметр</th>
<th class="innerdescheader">Значение</th>
<th class="innerdescheader">Описание</th>
</tr>
<tr>
<td class="innerdescparamcell" rowspan="3">ToolBarID</td>
<td class="innerdescvaluecell">TfrmOptionsToolbar</td>
<td class="innerdescdesccell">кнопка основной панели инструментов</td>
</tr>
<tr>
<td class="innerdescvaluecell">TfrmOptionsToolbarMiddle</td>
<td class="innerdescdesccell">кнопка центральной панели инструментов</td>
</tr>
<tr>
<td class="innerdescvaluecell"><i>(отсутствует)</i></td>
<td class="innerdescdesccell">кнопка основной панели инструментов</td>
</tr>
<tr>
<td class="innerdescparamcell">ToolItemID</td>
<td class="innerdescvaluecell"><i>идентификатор</i></td>
<td class="innerdescdesccell">уникальный идентификатор кнопки</td>
</tr>
</table>
<p>Уникальный идентификатор хранится в теге <code>ID</code> и у нас есть несколько способов его получить: мы можем найти кнопку в файле <tt>doublecmd.xml</tt>, в файле резервной копии панели инструментов или просто скопировать кнопку в буфер обмена и вставить её код в текстовый редактор.</p>
<p>Примечание: Идентификаторы генерируются автоматически и не обязаны совпадать с индентификаторами аналогичных кнопок другой копии программы, но при необходимости мы можем вручную задать своё значение.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="exampleex">3.1.1. Пример с DC.ExecuteCommand</a></h2>
<p>В этом примере мы написали простой скрипт, который сделает следующее:</p>
<ol>
<li>перенесёт фокус на правую панель</li>
<li>закроет все открытые вкладки</li>
<li>перейдёт в указанную папку</li>
<li>перенесёт фокус на левую панель</li>
<li>закроет все открытые вкладки</li>
<li>перейдёт в указанный каталог</li>
<li>откроет новую вкладку</li>
<li>перейдёт в указанный каталог</li>
</ol>
<pre>
<span class="luacmt">-- 1. Перенести фокус на правую панель.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_FocusSwap"</span><span class="luasbl">,</span> <span class="luastr">"side=right"</span><span class="luasbl">)</span>
<span class="luacmt">-- 2. Закрыть все вкладки.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_CloseAllTabs"</span><span class="luasbl">)</span>
<span class="luacmt">-- 3. Перейти в указанный каталог.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_ChangeDir"</span><span class="luasbl">,</span> <span class="luastr">"E:\\FakeKey\\Documents\\Music"</span><span class="luasbl">)</span>
<span class="luacmt">-- 4. Перенести фокус на левую панель.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_FocusSwap"</span><span class="luasbl">,</span> <span class="luastr">"side=left"</span><span class="luasbl">)</span>
<span class="luacmt">-- 5. Закрыть все вкладки.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_CloseAllTabs"</span><span class="luasbl">)</span>
<span class="luacmt">-- 6. Перейти в указанный каталог.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_ChangeDir"</span><span class="luasbl">,</span> <span class="luastr">"C:\\Users\\Public\\Music"</span><span class="luasbl">)</span>
<span class="luacmt">-- 7. Открыть новую вкладку.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_NewTab"</span><span class="luasbl">)</span>
<span class="luacmt">-- 8. Перейти в указанный каталог.</span>
<span class="mark">DC.ExecuteCommand</span><span class="luasbl">(</span><span class="luastr">"cm_ChangeDir"</span><span class="luasbl">,</span> <span class="luastr">"E:\\VirtualMachines\\ShareFolder"</span><span class="luasbl">)</span></pre>
<p>Для выполнения нашего скрипта мы можем создать кнопку на панели инструментов с внутренней командой <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a>.</p>
<p>Предположим, наш скрипт <code>E:\scripts\lua\music.lua</code>, мы можем настроить эту кнопку следующим образом:</p>
<p class="figure"><img class="largeimage" title="Вызов скрипта Lua кнопкой панели инструментов" alt="Вызов скрипта Lua кнопкой панели инструментов" src="images/imgDC/luaimg1.png" width="610" height="289"></p>
<p>Кроме того, для редактирования наших скриптов мы можем использовать встроенный редактор Double Commander. Если файл имеет расширение <code>.lua</code>, то он будет распознан редактором и открыт с подсветкой синтаксиса, специфичного для языка Lua:</p>
<p class="figure"><img class="largeimage" title="Подсветка синтаксиса Lua во встроенном редакторе" alt="Подсветка синтаксиса Lua во встроенном редакторе" src="images/imgDC/luaimg2.png" width="660" height="480"></p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="librarysystem">3.2. Библиотека System</a></h2>
<p>Эта библиотека содержит различные системные функции, все они представлены в таблице <code>SysUtils</code>.</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека System</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_sleep">SysUtils.Sleep</a></div></td>
<td class="hintcell">
<p class="definition">SysUtils.Sleep(iMilliseconds)</p>
<p>Приостанавливает выполнение скрипта на указанное количество миллисекунд (<var>iMilliseconds</var>), выполнение сценария будет продолжено после истечения указанного времени.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_gettickcount">SysUtils.GetTickCount</a></div></td>
<td class="hintcell">
<p class="definition">SysUtils.GetTickCount()</p>
<p>Возвращает количество интервалов времени (тиков) с момента старта системы. Это полезно для измерения времени, но не следует делать каких-либо предположений относительно количества времени в интервале между тиками.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_fileexists">SysUtils.FileExists</a></div></td>
<td class="hintcell">
<p class="definition">bExists = SysUtils.FileExists(sFileName)</p>
<p>Проверяет, существует ли в файловой системе определённый файл.</p>
<p><code>FileExists</code> возвращает <code>true</code>, если файл с именем <var>sFileName</var> существует на диске, и <code>false</code> в противном случае.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_directoryexists">SysUtils.DirectoryExists</a></div></td>
<td class="hintcell">
<p class="definition">bExists = SysUtils.DirectoryExists(sDirectory)</p>
<p>Проверяет существование <var>sDirectory</var> в файловой системе и что это действительно каталог.</p>
<p>Если это так, то функция возвращает <code>true</code>, иначе возвращает <code>false</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_filegetattr">SysUtils.FileGetAttr</a></div></td>
<td class="hintcell">
<p class="definition">iAttr = SysUtils.FileGetAttr(sFileName)</p>
<p>Возвращает в <var>iAttr</var> атрибуты файла <var>sFileName</var>.</p>
<p>Подробное описание возвращаемого значения смотрите <a href="#detailattr">здесь</a>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_findfirst">SysUtils.FindFirst</a></div></td>
<td class="hintcell">
<p class="definition">Handle, FindData = SysUtils.FindFirst(sPath)</p>
<p>Ищет файлы, совпадающие с <var>sPath</var> (можно использовать маски).</p>
<p>Если файл не найден, <var>Handle</var> будет равно <code>nil</code>.</p>
<p>В случае успеха функция вернёт дескриптор поиска <var>Handle</var> для последующих вызовов <code>SysUtils.FindNext</code> и поиска других совпадений с паттерном.</p>
<p>Таблица <var>FindData</var> содержит информацию о найденном файле или каталоге.</p>
<p>Поля таблицы <var>FindData</var>:</p>
<ul>
<li><var>Name</var> : Имя файла (без пути).</li>
<li><var>Attr</var> : Атрибуты файла (подробнее смотрите <a href="#detailattr">здесь</a>).</li>
<li><var>Size</var> : Размер файла в байтах.</li>
<li><var>Time</var> : Отметка времени файла (в формате POSIX, так называемое Unix-время: количество секунд, прошедших с 1 января 1970 г.)</li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_findnext">SysUtils.FindNext</a></div></td>
<td class="hintcell">
<p class="definition">Result, FindData = SysUtils.FindNext(Handle)</p>
<p>Находит следующее вхождение поиска, инициированного <code>FindFirst</code>, <var>Handle</var> – дескриптор поиска, возвращённый функцией <code>FindFirst</code>.</p>
<p>В случае успеха функция вернёт <var>Result</var> не равный <code>nil</code> и таблицу <var>FindData</var>, содержащую информацию о найденном файле или каталоге.</p>
<p><b><span class="uline">Замечание:</span> За последним вызовом <code>SysUtils.FindNext</code> всегда должен следовать вызов <code>SysUtils.FindClose</code> с тем же <var>Handle</var>. Несоблюдение этого приведёт к утечке памяти.</b></p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_findclose">SysUtils.FindClose</a></div></td>
<td class="hintcell">
<p class="definition">SysUtils.FindClose(Handle)</p>
<p>Завершает серию вызовов <code>SysUtils.FindFirst</code>/<code>SysUtils.FindNext</code> и освобождает использованную память.</p>
<p>Вызов этой функции <em>абсолютно</em> необходим, иначе могут возникнуть большие утечки памяти.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_createdirectory">SysUtils.CreateDirectory</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.CreateDirectory(sDirectory)</p>
<p>Создаёт цепочку каталогов, <var>sDirectory</var> - полный путь каталога.</p>
<p>Возвращает <code>true</code>, если <var>sDirectory</var> уже существует или был успешно создан, или <code>false</code>, если не удалось создать какую-либо часть пути.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_removedirectory">SysUtils.RemoveDirectory</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.RemoveDirectory(sDirectory)</p>
<p>Удалить каталог с именем <var>sDirectory</var>. Возвращает <code>true</code> в случае успеха, иначе возвращает <code>false</code>.</p>
<p>В отличие от <a href="#os_remove">os.remove</a>, эта функция при ошибке не возвращает описание, но зато может удалять непустые каталоги.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_createhardlink">SysUtils.CreateHardLink</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.CreateHardLink(sFileName, sLinkName)</p>
<p>Создаёт жёсткую ссылку <var>sLinkName</var> на файл <var>sFileName</var>.</p>
<p>Возвращает <code>true</code> в случае успеха, иначе возвращает <code>false</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_createsymboliclink">SysUtils.CreateSymbolicLink</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.CreateSymbolicLink(sFileName, sLinkName)</p>
<p>Создаёт символьную ссылку <var>sLinkName</var> на файл <var>sFileName</var>.</p>
<p>Возвращает <code>true</code> в случае успеха, иначе возвращает <code>false</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_readsymboliclink">SysUtils.ReadSymbolicLink</a></div></td>
<td class="hintcell">
<p class="definition">sTarget = SysUtils.ReadSymbolicLink(sLinkName, bRecursive)</p>
<p>Читает имя файла, на который указывает символьная ссылка <var>sLinkName</var>.</p>
<p>Если <var>bRecursive</var> равно <code>true</code> и ссылка указывает на ссылку, то она разрешается рекурсивно до тех пор, пока не будет найдено допустимое имя файла, не являющееся ссылкой.</p>
<p>Возвращает путь, на который указывает символьная ссылка <var>sLinkName</var>, или пустую строку, если ссылка недействительна или файл, на который она указывает, не существует и значение <var>bRecursive</var> равно <code>true</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_extractfilename">SysUtils.ExtractFileName</a></div></td>
<td class="hintcell">
<p class="definition">sName = SysUtils.ExtractFileName(sFileName)</p>
<p>Возвращает имя файла из полного (имя+путь) имени файла.</p>
<p>Имя файла содержит все символы после последнего символа разделителя каталогов ("/" или "\") или буквы диска.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_extractfileext">SysUtils.ExtractFileExt</a></div></td>
<td class="hintcell">
<p class="definition">sExt = SysUtils.ExtractFileExt(sFileName)</p>
<p>Возвращает расширение файла (все символы после последней точки, включая сам символ ".").</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_extractfilepath">SysUtils.ExtractFilePath</a></div></td>
<td class="hintcell">
<p class="definition">sPath = SysUtils.ExtractFilePath(sFileName)</p>
<p>Возвращает путь из полного имени файла (включая букву диска).</p>
<p>Путь содержит все символы до последнего символа разделителя каталогов ("/" или "\"), включая сам разделитель каталогов.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_extractfiledir">SysUtils.ExtractFileDir</a></div></td>
<td class="hintcell">
<p class="definition">sDir = SysUtils.ExtractFileDir(sFileName)</p>
<p>Возвращает только каталог из <var>sFileName</var>, включая букву диска.</p>
<p>Результат НЕ содержит разделитель каталогов в конце, в отличие от <code>SysUtils.ExtractFilePath</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_extractfiledrive">SysUtils.ExtractFileDrive</a></div></td>
<td class="hintcell">
<p class="definition">sDrive = SysUtils.ExtractFileDrive(sFileName)</p>
<p>Возвращает диск из полного имени файла.</p>
<p>Обратите внимание, некоторые операционные системы не поддерживают буквы дисков.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_getabsolutepath">SysUtils.GetAbsolutePath</a></div></td>
<td class="hintcell">
<p class="definition">sName = SysUtils.GetAbsolutePath(sFileName, sBaseDirectory)</p>
<p>Возвращает абсолютный (полный) путь к файлу:</p>
<ul>
<li><var>sFileName</var> : Имя файла с относительным путём.</li>
<li><var>sBaseDirectory</var> : Каталог, который использовался как базовый каталог для <var>sFileName</var>.</li>
</ul>
<p>Если не удалось получить абсолютный путь, функция вернёт значение <var>sFileName</var>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_getrelativepath">SysUtils.GetRelativePath</a></div></td>
<td class="hintcell">
<p class="definition">sName = SysUtils.GetRelativePath(sFileName, sBaseDirectory)</p>
<p>Возвращает имя файла относительно указанного каталога:</p>
<ul>
<li><var>sFileName</var> : Полное (абсолютное) имя файла.</li>
<li><var>sBaseDirectory</var> : Каталог, который будет использоваться как базовый каталог для <var>sFileName</var>.</li>
</ul>
<p>Если <var>sFileName</var> и <var>sBaseDirectory</var> содержат одно и то же значение, функция вернёт пустую строку (""). Если не удалось получить имя файла с относительным путём, функция вернёт значение <var>sFileName</var>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_matchesmask">SysUtils.MatchesMask</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.MatchesMask(sFileName, sMask, iMaskOptions)</p>
<p>Возвращает <code>true</code>, если <var>sFileName</var> совпадает с переданной маской <var>sMask</var>.</p>
<p><var>iMaskOptions</var> (необязательный параметр, по умолчанию 0) задаётся как сумма следующих значений:</p>
<table class="innercmddesc">
<tr class="rowinnerdesc">
<th class="innerdescheader">Значение</th>
<th class="innerdescheader">Описание</th>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">1</div></td>
<td class="hintcell">с учётом регистра</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">2</div></td>
<td class="hintcell">игнорировать акценты и лигатуры</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">4</div></td>
<td class="hintcell">фильтр в стиле Windows: "*.*" также совпадает с файлами без расширения и т.д.</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">8</div></td>
<td class="hintcell">включить поддержку пиньинь (будет использоваться файл <tt>pinyin.tbl</tt>)</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_matchesmasklist">SysUtils.MatchesMaskList</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.MatchesMaskList(sFileName, sMaskList, sSeparator, iMaskOptions)</p>
<p>Возвращает <code>true</code>, если <var>sFileName</var> совпадает с хотя бы одной из переданных масок <var>sMaskList</var>, разделённых <var>sSeparator</var> (по умолчанию ";").</p>
<p><var>sSeparator</var> и <var>iMaskOptions</var> (см. выше) – необязательные параметры.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_execute">SysUtils.Execute</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.Execute(sCommand)</p>
<p>Выполнить <var>sCommand</var>, аналогично введённой в командной строке. Вернёт <code>true</code> в случае успеха и <code>false</code> в противном случае (функция не ожидает завершения запущенной команды).</p>
<p>Примечание: В Windows при использовании функции <a href="#os_execute">os.execute</a> каждый раз открывается окно терминала, функция <code>SysUtils.Execute</code> лишена этого недостатка.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_expandenv">SysUtils.ExpandEnv</a></div></td>
<td class="hintcell">
<p class="definition">sResult = SysUtils.ExpandEnv(String, bSpecial)</p>
<p>Возвращает строку, в которой все переменные окружения заменены на их значения для текущего пользователя.</p>
<p><var>bSpecial</var> – это опциональный параметр: если <code>true</code>, то также будут раскрыты псевдопеременные окружения (подробнее смотрите <a href="variables.html#envvariables">здесь</a>). По умолчанию <code>false</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_gettempname">SysUtils.GetTempName</a></div></td>
<td class="hintcell">
<p class="definition">sTempFileName = SysUtils.GetTempName()</p>
<p>Возвращает строку с именем файла, который может быть использован в качестве временного файла (в системном каталоге для временных файлов), подобно функции <a href="#libraryos">os.tmpname</a>, но файл будет создан в подкаталоге <tt>_dc~~~</tt>, который автоматически удаляется при закрытии Double Commander.<br>Если функции не удалось создать уникальное имя, то она вернёт пустую строку.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_getfileproperty">SysUtils.GetFileProperty</a></div></td>
<td class="hintcell">
<p class="definition">Result = SysUtils.GetFileProperty(sFileName, iValue)</p>
<p>Возвращает свойство файла, соответствующее <var>iValue</var>:</p>
<table class="innercmddesc">
<tr class="rowinnerdesc"><th class="innerdescheader">Значение</th><th class="innerdescheader">Описание</th></tr>
<tr><td class="innerdescvaluecell">0</td><td class="innerdescdesccell">Размер файла в байтах</td></tr>
<tr><td class="innerdescvaluecell">1</td><td class="innerdescdesccell">Строка атрибутов как в файловой панели (подробное описание строкового значения смотрите <a href="configuration.html#ConfigColorFiles">здесь</a>)</td></tr>
<tr><td class="innerdescvaluecell">2</td><td class="innerdescdesccell">Группа владельца файла</td></tr>
<tr><td class="innerdescvaluecell">3</td><td class="innerdescdesccell">Владелец файла</td></tr>
<tr><td class="innerdescvaluecell">4</td><td class="innerdescdesccell">Дата модификации</td></tr>
<tr><td class="innerdescvaluecell">5</td><td class="innerdescdesccell">Дата создания</td></tr>
<tr><td class="innerdescvaluecell">6</td><td class="innerdescdesccell">Дата последнего доступа</td></tr>
<tr><td class="innerdescvaluecell">7</td><td class="innerdescdesccell">Дата изменения статуса</td></tr>
<tr><td class="innerdescvaluecell">8</td><td class="innerdescdesccell">Тип файла (как в Проводнике Windows или MIME-тип)</td></tr>
<tr><td class="innerdescvaluecell">9</td><td class="innerdescdesccell">Описание (комментарий) из <tt>descript.ion</tt> (подробнее смотрите <a href="help.html#cm_EditComment">здесь</a>)</td></tr>
</table>
<p>Возвращает число (размер файла, отметки времени) или строку (в остальных случаях). В случае неудачи функция возвращает <code>nil</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_filesettime">SysUtils.FileSetTime</a></div></td>
<td class="hintcell">
<p class="definition">bResult = SysUtils.FileSetTime(sFileName, iModification, iCreation, iLastAccess)</p>
<p>Позволяет задать отметки времени (время в формате Unix) для <var>sFileName</var>: дата модификации, дата создания и дата последнего доступа. Укажите ноль для тех отметок времени, которые должны быть проигнорированы.</p>
<p>Возвращает <code>true</code> в случае успеха, иначе возвращает <code>false</code>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="sysutils_pathdelim">SysUtils.PathDelim</a></div></td>
<td class="hintcell">
<p class="definition">SysUtils.PathDelim</p>
<p>Символ, используемый в текущей операционной системе для разделения имён каталогов в полном имени файла.</p>
<p>В системах Unix/Linux разделителем каталогов будет "/" и "\" в Windows.</p>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="detailattr">3.2.1. Описание возвращаемого значения SysUtils.FileGetAttr</a></h2>
<p><code>FileGetAttr</code> возвращает атрибуты <var>sFileName</var> в виде ИЛИ-совокупности следующих констант:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Константы, используемые в возвращаемом значении SysUtils.FileGetAttr</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Значение</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000001<br><small class="firstcolumnaleft">faReadOnly</small></div></td>
<td class="hintcell">Файл только для чтения.</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000002<br><small class="firstcolumnaleft">faHidden</small></div></td>
<td class="hintcell">Скрытый файл.<br>В Unix/Linux это значит, что имя файла начинается с точки.</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000004<br><small class="firstcolumnaleft">faSysFile</small></div></td>
<td class="hintcell">Системный файл.<br>В Unix/Linux это может быть символьное или блочное физическое устройство, именованный канал (FIFO).</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000008<br><small class="firstcolumnaleft">faVolumeId</small></div></td>
<td class="hintcell">Метка тома (означает, что файл содержит идентификатор (ID) тома).<br>Только для DOS/Windows 9x на обычной файловой системе FAT (не VFAT или FAT32).</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000010<br><small class="firstcolumnaleft">faDirectory</small></div></td>
<td class="hintcell">Каталог.</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000020<br><small class="firstcolumnaleft">faArchive</small></div></td>
<td class="hintcell">Архивный.<br>Не используется в Unix/Linux.</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft">0x00000400<br><small class="firstcolumnaleft">faSymLink</small></div></td>
<td class="hintcell">Символьная ссылка.</td>
</tr>
<tr>
<td colspan="2"><b>Примечание: В случае ошибки функция возвращает -1.</b>
</tr>
</table>
<p>Смотрите пример в <a href="#exampleattr">следующей секции</a>.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="exampleattr">3.2.2. Пример с SysUtils.FileGetAttr</a></h2>
<p>Пример скрипта ниже использует <code>SysUtils.FileGetAttr</code>.</p>
<p>Если параметр окажется каталогом, то скрипт откроет его в новой вкладке активной панели и переключится на неё.</p>
<pre>
<span class="luakyw">local</span> params <span class="luasbl">=</span> <span class="luasbl">{...}</span>
<span class="luakyw">local</span> iAttr
<span class="luakyw">if</span> <span class="luasbl">#</span>params <span class="luasbl">==</span> <span class="luanum">1</span> <span class="luakyw">then</span> <span class="luacmt">-- Мы получили один параметр?</span>
iAttr <span class="luasbl">=</span> <span class="mark">SysUtils.FileGetAttr</span><span class="luasbl">(</span>params<span class="luasbl">[</span><span class="luanum">1</span><span class="luasbl">])</span>
<span class="luakyw">if</span> iAttr <span class="luasbl">></span> <span class="luanum">0</span> <span class="luakyw">then</span> <span class="luacmt">-- Получили значение атрибута?</span>
<span class="luakyw">if</span> math.floor<span class="luasbl">(</span>iAttr <span class="luasbl">/</span> <span class="luanum">0x00000010</span><span class="luasbl">)</span> <span class="luastr">%</span> <span class="luanum">2</span> <span class="luasbl">~=</span> <span class="luanum">0</span> <span class="luakyw">then</span>
<span class="luacmt">-- 0x00000010 присутствует? Тогда это каталог.</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_NewTab"</span><span class="luasbl">)</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_ChangeDir"</span><span class="luasbl">,</span> params<span class="luasbl">[</span><span class="luanum">1</span><span class="luasbl">])</span>
<span class="luakyw">end</span>
<span class="luakyw">end</span>
<span class="luakyw">end</span></pre>
<p>В приведённом выше примере <var>params[1]</var> является первым параметром, переданным скрипту.</p>
<p>При использовании внутренней команды <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a> это будет первый параметр, переданный после имени файла скрипта.</p>
<p>Итак, в нашем примере мы можем создать на панели инструментов кнопку, как показано ниже:</p>
<p class="figure"><img class="largeimage" title="Параметр с cm_ExecuteScript" alt="Параметр с cm_ExecuteScript" src="images/imgDC/luaimg3.png" width="610" height="289"></p>
<p>В этом примере скрипту будет передан параметр <code>%"0%p</code>: имя выделенного в активной панели файла или папки, без кавычек.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="examplefind">3.2.3. Пример использования FindFirst, FindNext и FindClose</a></h2>
<p>В следующем примере мы просканируем содержимое каталога, переданного первым параметром, и сохраним полученные данные в текстовый файл с именем, переданным вторым параметром.</p>
<p>Это даст нам хорошее представление об использовании <code>FindFirst</code>, <code>FindNext</code> и <code>FindClose</code>.</p>
<pre>
<span class="luakyw">local</span> params <span class="luasbl">=</span> <span class="luasbl">{...}</span>
<span class="luakyw">if</span> <span class="luasbl">#</span>params <span class="luasbl">==</span> <span class="luanum">2</span> <span class="luakyw">then</span> <span class="luacmt">-- У нас есть два параметра?</span>
<span class="luakyw">local</span> Result <span class="luasbl">=</span> <span class="luakyw">nil</span>
<span class="luacmt">local</span> hOutputFile <span class="luasbl">=</span> <span class="luakyw">nil</span>
hOutputFile <span class="luasbl">=</span> io.output(params<span class="luasbl">[</span><span class="luanum">2</span><span class="luasbl">])</span>
<span class="luakyw">local</span> Handle<span class="luasbl">,</span> FindData <span class="luasbl">=</span> <span class="mark">SysUtils.FindFirst</span><span class="luasbl">(</span>params<span class="luasbl">[</span><span class="luanum">1</span><span class="luasbl">]</span> <span class="luasbl">..</span> <span class="luastr">"\\*"</span><span class="luasbl">)</span>
<span class="luakyw">if</span> Handle <span class="luasbl">~=</span> <span class="luakyw">nil</span> <span class="luakyw">then</span>
<span class="luakyw">repeat</span>
io.write<span class="luasbl">(</span>FindData.Name <span class="luasbl">..</span> <span class="luastr">"\r"</span><span class="luasbl">)</span>
io.write<span class="luasbl">(</span>FindData.Size <span class="luasbl">..</span> <span class="luastr">"\r"</span><span class="luasbl">)</span>
io.write<span class="luasbl">(</span><span class="luastr">"---------------\r"</span><span class="luasbl">)</span>
Result<span class="luasbl">,</span> FindData <span class="luasbl">=</span> <span class="mark">SysUtils.FindNext</span><span class="luasbl">(</span>Handle<span class="luasbl">)</span>
<span class="luakyw">until</span> Result <span class="luasbl">==</span> <span class="luakyw">nil</span>
<span class="mark">SysUtils.FindClose</span><span class="luasbl">(</span>Handle<span class="luasbl">)</span>
io.close<span class="luasbl">(</span>hOutputFile<span class="luasbl">)</span>
<span class="luakyw">end</span>
<span class="luakyw">end</span></pre>
<p>В приведённом выше примере нам нужно передать скрипту два параметра:</p>
<ol>
<li><var>params[1]</var> - каталог, содержимое которого мы хотим получить</li>
<li><var>params[2]</var> - имя файла для сохранения результата работы скрипта</li>
</ol>
<p>Настраиваем кнопку на панели инструментов с внутренней командой <a href="cmds.html#cm_ExecuteScript">cm_ExecuteScript</a> и передаём параметрами всё необходимое:</p>
<p class="figure"><img class="largeimage" title="Параметр с cm_ExecuteScript" alt="Параметр с cm_ExecuteScript" src="images/imgDC/luaimg4.png" width="610" height="289"></p>
<p>В этом примере скрипту в качестве первого параметра будет передано <code>%"0%Ds</code>: имя каталога активной панели, без кавычек.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="libraryclip">3.3. Библиотека Clipboard</a></h2>
<p>Double Commander предоставляет скриптам Lua библиотеку функций для работы с буфером обмена.</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека Clipboard</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="clipbrd_clear">Clipbrd.Clear</a></div></td>
<td class="hintcell">
<p class="definition">Clipbrd.Clear()</p>
<p>Очищает содержимое буфера обмена.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="clipbrd_getastext">Clipbrd.GetAsText</a></div></td>
<td class="hintcell">
<p class="definition">sVar = Clipbrd.GetAsText()</p>
<p>Получает содержимое буфера обмена как строку <var>sVar</var>. Если буфер обмена не содержит текст, то функция вернёт пустую строку.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="clipbrd_setastext">Clipbrd.SetAsText</a></div></td>
<td class="hintcell">
<p class="definition">Clipbrd.SetAsText(sVar)</p>
<p>Помещает в буфер обмена строку текста <var>sVar</var>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="clipbrd_setashtml">Clipbrd.SetAsHtml</a></div></td>
<td class="hintcell">
<p class="definition">Clipbrd.SetAsHtml(sHtml)</p>
<p>Добавляет в буфер обмена текст <var>sHtml</var> в формате HTML (формат буфера обмена <code>CF_HTML</code>).</p>
<p>Содержимое может быть вставлено в приложения, поддерживающие этот формат буфера обмена, такие как MS Word, LO Writer и другие.</p>
<p>Правильным будет сохранять данные с помощью и <code>Clipbrd.SetAsText</code>, и <code>Clipbrd.SetAsHtml</code>: приложение будет использовать тот формат, который поддерживает.</p>
<p>Например, у нас может быть следующее:</p>
<ul>
<li><code>Clipbrd.SetAsText("Добро пожаловать в Double Commander!")</code></li>
<li><code>Clipbrd.SetAsHtml("Добро пожаловать в <b>Double Commander</b>!")</code></li>
</ul>
<p>Если мы запустим Блокнот и попытаемся вставить текст из буфера обмена, то будет вставлен текст, скопированный с помощью <code>Clipbrd.SetAsText</code>. Но если мы перейдём к Microsoft Word, то будет вставлена строка с выделенным жирным шрифтом <b>Double Commander</b>, потому что Microsoft Word распознаёт и поддерживает этот формат буфера обмена.</p>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="exampleclip">3.3.1. Пример работы с буфером обмена</a></h2>
<p>В следующем примере используются три функции, связанные с буфером обмена: <code>Clear</code>, <code>GetAsText</code> и <code>SetAsText</code>.</p>
<p>Это относительно большой скрипт, но было бы неплохо собрать вместе несколько функций, с которыми мы познакомились ранее.</p>
<p>Предполагается, что в нашей активной панели открыт каталог с большим количеством текстовых файлов.</p>
<p>Также предполагается, что в настоящее время в буфере обмена одно слово и что скрипт в качестве единственного параметра получит текущий каталог активной панели.</p>
<p>Скрипт будет сканировать папку, читать содержимое файлов, один за другим, и искать слово из буфера обмена.</p>
<p>Затем имена файлов, которые содержат это словом, будут скопированы в буфер обмена.</p>
<p>Далее скрипт вызовет внутреннюю команду <a href="cmds.html#cm_LoadSelectionFromClip">cm_LoadSelectionFromClip</a> и все эти файлы будут выделены.</p>
<p>Кроме того, в конце вернём обратно в буфер обмена слово, которое мы искали.</p>
<pre>
<span class="luakyw">local</span> params <span class="luasbl">=</span> <span class="luasbl">{...}</span>
<span class="luakyw">local</span> Result <span class="luasbl">=</span> <span class="luakyw">nil</span>
<span class="luakyw">local</span> iAttr
<span class="luakyw">local</span> bFound <span class="luasbl">=</span> <span class="luakyw">false</span>
<span class="luakyw">local</span> sCompleteFilename <span class="luasbl">=</span> <span class="luastr">""</span>
<span class="luakyw">local</span> hInputFile <span class="luasbl">=</span> <span class="luakyw">nil</span>
<span class="luakyw">local</span> sLine <span class="luasbl">=</span> <span class="luastr">""</span>
<span class="luakyw">local</span> iPosS
<span class="luakyw">local</span> iPosE
<span class="luakyw">local</span> sFileToSelect <span class="luasbl">=</span> <span class="luastr">""</span>
<span class="luakyw">local</span> sSearchString <span class="luasbl">=</span> <span class="luastr">""</span>
<span class="luakyw">if</span> <span class="luasbl">#</span>params <span class="luasbl">==</span> <span class="luanum">1</span> <span class="luakyw">then</span> <span class="luacmt">-- Мы получили наш параметр?</span>
sSearchString <span class="luasbl">=</span> <span class="mark">Clipbrd.GetAsText</span><span class="luasbl">()</span> <span class="luacmt">-- Получаем выражение для поиска.</span>
<span class="mark">Clipbrd.Clear</span><span class="luasbl">()</span> <span class="luacmt">-- Очищаем буфер обмена.</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_MarkUnmarkAll"</span><span class="luasbl">)</span> <span class="luacmt">-- Убедимся, что ничего не выделено.</span>
<span class="luacmt">-- Начинаем сканировать все файлы нашего каталога один за другим.</span>
<span class="luakyw">local</span> Handle<span class="luasbl">,</span> FindData <span class="luasbl">=</span> SysUtils.FindFirst<span class="luasbl">(</span>params<span class="luasbl">[</span><span class="luanum">1</span><span class="luasbl">]</span> <span class="luasbl">..</span> <span class="luastr">"\\*"</span><span class="luasbl">)</span>
<span class="luakyw">if</span> Handle <span class="luasbl">~=</span> <span class="luakyw">nil</span> <span class="luakyw">then</span>
<span class="luakyw">repeat</span>
sCompleteFilename <span class="luasbl">=</span> params<span class="luasbl">[</span><span class="luanum">1</span><span class="luasbl">]</span> <span class="luasbl">..</span> <span class="luastr">"\\"</span> <span class="luasbl">..</span> FindData.Name
iAttr <span class="luasbl">=</span> SysUtils.FileGetAttr<span class="luasbl">(</span>sCompleteFilename<span class="luasbl">)</span>
<span class="luakyw">if</span> iAttr > <span class="luanum">0</span> <span class="luakyw">then</span> <span class="luacmt">-- Получили значение атрибута?</span>
<span class="luacmt">-- Нам нужен файл, не каталог!</span>
<span class="luakyw">if</span> math.floor<span class="luasbl">(</span>iAttr <span class="luasbl">/</span> <span class="luanum">0x00000010</span><span class="luasbl">)</span> <span class="luasbl">%</span> <span class="luanum">2</span> <span class="luasbl">==</span> <span class="luanum">0</span> <span class="luakyw">then</span>
<span class="luacmt">-- Начинаем читать файл построчно, до конца файла ИЛИ до совпадения.</span>
hInputFile <span class="luasbl">=</span> io.open<span class="luasbl">(</span>sCompleteFilename<span class="luasbl">,</span> <span class="luastr">"r"</span><span class="luasbl">)</span>
bFound <span class="luasbl">=</span> <span class="luakyw">false</span>
<span class="luakyw">while</span> bFound <span class="luasbl">==</span> <span class="luakyw">false</span> <span class="luakyw">do</span>
sLine <span class="luasbl">=</span> hInputFile:read<span class="luasbl">()</span>
<span class="luakyw">if</span> sLine <span class="luasbl">==</span> <span class="luakyw">nil</span> <span class="luakyw">then</span> <span class="luakyw">break</span> <span class="luakyw">end</span>
iPosS<span class="luasbl">,</span> iPosE <span class="luasbl">=</span> string.find<span class="luasbl">(</span>sLine<span class="luasbl">,</span> sSearchString<span class="luasbl">)</span>
<span class="luakyw">if</span> iPosS <span class="luasbl">~=</span> <span class="luakyw">nil</span> <span class="luakyw">then</span> bFound <span class="luasbl">=</span> <span class="luakyw">true</span> <span class="luakyw">end</span>
<span class="luakyw">end</span>
<span class="luakyw">if</span> bFound <span class="luasbl">==</span> <span class="luakyw">true</span> <span class="luakyw">then</span>
sFileToSelect <span class="luasbl">=</span> sFileToSelect <span class="luasbl">..</span> FindData.Name <span class="luasbl">..</span> <span class="luastr">"\n"</span>
<span class="luakyw">end</span>
io.close<span class="luasbl">(</span>hInputFile<span class="luasbl">)</span>
<span class="luakyw">end</span>
<span class="luakyw">end</span>
Result<span class="luasbl">,</span> FindData <span class="luasbl">=</span> SysUtils.FindNext<span class="luasbl">(</span>Handle<span class="luasbl">)</span>
<span class="luakyw">until</span> Result <span class="luasbl">==</span> <span class="luakyw">nil</span>
SysUtils.FindClose<span class="luasbl">(</span>Handle<span class="luasbl">)</span>
<span class="luakyw">end</span>
<span class="luacmt">-- Если что-то нашли, то выделяем!</span>
<span class="luakyw">if</span> sFileToSelect <span class="luasbl">~=</span> <span class="luastr">""</span> <span class="luakyw">then</span>
<span class="mark">Clipbrd.SetAsText</span><span class="luasbl">(</span>sFileToSelect<span class="luasbl">)</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_LoadSelectionFromClip"</span><span class="luasbl">)</span>
<span class="luakyw">end</span>
<span class="mark">Clipbrd.SetAsText</span><span class="luasbl">(</span>sSearchString<span class="luasbl">)</span> <span class="luacmt">-- Восстанавливаем содержимое буфера обмена.</span>
<span class="luakyw">end</span></pre>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="librarydialogs">3.4. Библиотека Dialogs</a></h2>
<p>Эта библиотека позволяет нашим скриптам взаимодействовать с пользователем, показывая сообщения, выдавая запросы и т.д.</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека Dialogs</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dialogs_messagebox">Dialogs.MessageBox</a></div></td>
<td class="hintcell">
<p class="definition">iButton = Dialogs.MessageBox(sMessage, sTitle, iFlags)</p>
<p>Показывает окно сообщения, функция вернёт нажатую пользователем кнопку:</p>
<ul>
<li><var>sMessage</var> : Сообщение окна.</li>
<li><var>sTitle</var> : Текст в заголовке окна.</li>
<li><var>iFlags</var> : Сумма констант, задающих отображаемые кнопки, стиль окна и кнопку по умолчанию. Смотрите ниже таблицы с <a href="#dlgbuts">кнопками</a>, <a href="#dlgstyle">стилями</a> и <a href="#dlgdefbut">кнопкой по умолчанию</a>.</li>
<li><var>iButton</var> : Возвращаемое значение, указывающее нажатую кнопку (смотрите <a href="#msgreturn">эту таблицу</a>).</li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dialogs_inputquery">Dialogs.InputQuery</a></div></td>
<td class="hintcell">
<p class="definition">bResult, sAnswer = Dialogs.InputQuery(sTitle, sMessage, bMask, sDefault)</p>
<p>Показывает диалоговое окно с полем ввода текста:</p>
<ul>
<li><var>sTitle</var> : Текст в заголовке окна.</li>
<li><var>sMessage</var> : Сообщение окна.</li>
<li><var>bMask</var> : Логическое (булево) значение, если <code>true</code>, то вводимый текст будет скрываться "звёздочками".</li>
<li><var>sDefault</var> : Текст, который будет отображаться в строке ввода при появлении окна.</li>
<li><var>bResult</var> : Возвращаемое логическое (булево) значение, указывающее, ввёл ли что-то пользователь или нет.</li>
<li><var>sAnswer</var> : Возвращаемая строка, если пользователь что-то ввёл, а затем нажал ОК.</li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="dialogs_inputlistbox">Dialogs.InputListBox</a></div></td>
<td class="hintcell">
<p class="definition">sItem, iItem = Dialogs.InputListBox(sTitle, sMessage, aItems, sDefault)</p>
<p>Показывает диалоговое окно с возможностью выбора из списка элементов:</p>
<ul>
<li><var>sTitle</var> : Текст в заголовке окна.</li>
<li><var>sMessage</var> : Сообщение окна.</li>
<li><var>aItems</var> : Таблица Lua, каждый элемент таблицы должен быть строкой.</li>
<li><var>sDefault</var> : Пункт списка, выделенный по умолчанию.</li>
<li><var>sItem</var> : Возвращаемая строка с выбранным пунктом или <code>nil</code> в случае отмены.</li>
<li><var>iItem</var> : Индекс выделенного пункта (отсчёт от единицы, как принято в таблицах Lua).</li>
</ul>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="dlgbuts">3.4.1. Кнопки Dialogs.MessageBox</a></h2>
<p>Кнопки, отображаемые в окне <code>Dialogs.MessageBox</code>, задаются одним из следующих значений:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Константы для кнопок в Dialogs.MessageBox</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Значение константы</th><th class="categorydesccolumn">Отображаемые кнопки, слева направо</th></tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0000<br><small class="firstcolumnaleft">MB_OK</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка OK" alt="Кнопка OK" src="images/imgDC/luaimg11.png" width="72" height="21">
</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0001<br><small class="firstcolumnaleft">MB_OKCANCEL</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка OK" alt="Кнопка OK" src="images/imgDC/luaimg11.png" width="72" height="21">
<img class="largeimage" title="Кнопка ОТМЕНА" alt="Кнопка ОТМЕНА" src="images/imgDC/luaimg12.png" width="72" height="21">
</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0002<br><small class="firstcolumnaleft">MB_ABORTRETRYIGNORE</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка ПРЕРВАТЬ" alt="Кнопка ПРЕРВАТЬ" src="images/imgDC/luaimg15.png" width="66" height="21">
<img class="largeimage" title="Кнопка ПОВТОР" alt="Кнопка ПОВТОР" src="images/imgDC/luaimg14.png" width="66" height="21">
<img class="largeimage" title="Кнопка ПРОПУСТИТЬ" alt="Кнопка ПРОПУСТИТЬ" src="images/imgDC/luaimg13.png" width="66" height="21">
</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0003<br><small class="firstcolumnaleft">MB_YESNOCANCEL</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка ДА" alt="Кнопка ДА" src="images/imgDC/luaimg16.png" width="72" height="21">
<img class="largeimage" title="Кнопка НЕТ" alt="Кнопка НЕТ" src="images/imgDC/luaimg17.png" width="72" height="21">
<img class="largeimage" title="Кнопка ОТМЕНА" alt="Кнопка ОТМЕНА" src="images/imgDC/luaimg12.png" width="72" height="21">
</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0004<br><small class="firstcolumnaleft">MB_YESNO</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка ДА" alt="Кнопка ДА" src="images/imgDC/luaimg16.png" width="72" height="21">
<img class="largeimage" title="Кнопка НЕТ" alt="Кнопка НЕТ" src="images/imgDC/luaimg17.png" width="72" height="21">
</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0005<br><small class="firstcolumnaleft">MB_RETRYCANCEL</small></div></td>
<td class="hintcell">
<img class="largeimage" title="Кнопка ПОВТОР" alt="Кнопка ПОВТОР" src="images/imgDC/luaimg14.png" width="66" height="21">
<img class="largeimage" title="Кнопка ОТМЕНА" alt="Кнопка ОТМЕНА" src="images/imgDC/luaimg12.png" width="72" height="21">
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="dlgstyle">3.4.2. Стиль окна Dialogs.MessageBox</a></h2>
<p>Стиль окна <code>Dialogs.MessageBox</code> задаётся одним из следующих значений:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Константы, задающие значок и стиль окна Dialogs.MessageBox</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Значение константы</th><th class="categorydesccolumn">Стиль окна</th></tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0040<br><small class="firstcolumnaleft">MB_ICONINFORMATION</small></div></td>
<td class="hintcell"><img class="largeimage" title="Значок ИНФОРМАЦИЯ" alt="Значок ИНФОРМАЦИЯ" src="images/imgDC/luaimg8.png" width="32" height="32"> Информационное окно</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0030<br><small class="firstcolumnaleft">MB_ICONWARNING</small></div></td>
<td class="hintcell"><img class="largeimage" title="Значок ПРЕДУПРЕЖДЕНИЕ" alt="Значок ПРЕДУПРЕЖДЕНИЕ" src="images/imgDC/luaimg9.png" width="32" height="32"> Окно предупреждения</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0020<br><small class="firstcolumnaleft">MB_ICONQUESTION</small></div></td>
<td class="hintcell"><img class="largeimage" title="Значок ВОПРОС" alt="Значок ВОПРОС" src="images/imgDC/luaimg7.png" width="32" height="32"> Окно подтверждения</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0010<br><small class="firstcolumnaleft">MB_ICONERROR</small></div></td>
<td class="hintcell"><img class="largeimage" title="Значок ОШИБКА" alt="Значок ОШИБКА" src="images/imgDC/luaimg10.png" width="32" height="32"> Окно ошибки</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="dlgdefbut">3.4.3. Кнопка по умолчанию в Dialogs.MessageBox</a></h2>
<p>Кнопка по умолчанию (активная) в <code>Dialogs.MessageBox</code> задаётся одним из следующих значений:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Константы, задающие кнопку по умолчанию в Dialogs.MessageBox</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Значение константы</th><th class="categorydesccolumn">Кнопка по умолчанию</th></tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0000<br><small class="firstcolumnaleft">MB_DEFBUTTON1</small></div></td>
<td class="hintcell">Первая кнопка слева</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0100<br><small class="firstcolumnaleft">MB_DEFBUTTON2</small></div></td>
<td class="hintcell">Вторая кнопка слева</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0200<br><small class="firstcolumnaleft">MB_DEFBUTTON3</small></div></td>
<td class="hintcell">Третья кнопка слева</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="msgreturn">3.4.4. Возвращаемое значение Dialogs.MessageBox</a></h2>
<p>Число, возвращаемое функцией <code>Dialogs.MessageBox</code>, указывает на кнопку, которую нажал пользователь, и может быть одним из следующих:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Возвращаемое значение Dialogs.MessageBox</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Значение константы</th><th class="categorydesccolumn">Нажатая кнопка</th></tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0000<br><small class="firstcolumnaleft">mrNone</small></div></td>
<td class="hintcell">Кнопка не нажата</td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0001<br><small class="firstcolumnaleft">mrOK</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: OK" alt="Результат: OK" src="images/imgDC/luaimg11.png" width="72" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0002<br><small class="firstcolumnaleft">mrCancel</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: ОТМЕНА" alt="Результат: ОТМЕНА" src="images/imgDC/luaimg12.png" width="72" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0003<br><small class="firstcolumnaleft">mrAbort</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: ПРЕРВАТЬ" alt="Результат: ПРЕРВАТЬ" src="images/imgDC/luaimg15.png" width="66" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0004<br><small class="firstcolumnaleft">mrRetry</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: ПОВТОР" alt="Результат: ПОВТОР" src="images/imgDC/luaimg14.png" width="66" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0005<br><small class="firstcolumnaleft">mrIgnore</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: ПРОПУСТИТЬ" alt="Результат: ПРОПУСТИТЬ" src="images/imgDC/luaimg13.png" width="66" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0006<br><small class="firstcolumnaleft">mrYes</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: ДА" alt="Результат: ДА" src="images/imgDC/luaimg16.png" width="72" height="21"></td>
</tr>
<tr>
<td class="varcell"><div class="firstcolumnaleft">0x0007<br><small class="firstcolumnaleft">mrNo</small></div></td>
<td class="hintcell"><img class="largeimage" title="Результат: НЕТ" alt="Результат: НЕТ" src="images/imgDC/luaimg17.png" width="72" height="21"></td>
</tr>
</table>
<p>Примечание: Если закрыть окно, нажав крестик "x" в углу окна или клавишу <kbd>Esc</kbd>, то функция вернёт <code>0x0002</code>, как нажатие кнопки Отмена.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="mesgboxsample">3.4.5. Пример использования Dialogs.MessageBox</a></h2>
<p>Маленький скрипт, использующий <code>Dialogs.MessageBox</code>:</p>
<pre>
<span class="luacmt">-- Отображаемые кнопки</span>
MB_OK <span class="luasbl">=</span> <span class="luanum">0x0000</span>
MB_OKCANCEL <span class="luasbl">=</span> <span class="luanum">0x0001</span>
MB_ABORTRETRYIGNORE <span class="luasbl">=</span> <span class="luanum">0x0002</span>
MB_YESNOCANCEL <span class="luasbl">=</span> <span class="luanum">0x0003</span>
MB_YESNO <span class="luasbl">=</span> <span class="luanum">0x0004</span>
MB_RETRYCANCEL <span class="luasbl">=</span> <span class="luanum">0x0005</span>
<span class="luacmt">-- Стиль окна</span>
MB_ICONINFORMATION <span class="luasbl">=</span> <span class="luanum">0x0040</span>
MB_ICONWARNING <span class="luasbl">=</span> <span class="luanum">0x0030</span>
MB_ICONQUESTION <span class="luasbl">=</span> <span class="luanum">0x0020</span>
MB_ICONERROR <span class="luasbl">=</span> <span class="luanum">0x0010</span>
<span class="luacmt">-- Кнопка по умолчанию</span>
MB_DEFBUTTON1 <span class="luasbl">=</span> <span class="luanum">0x0000</span>
MB_DEFBUTTON2 <span class="luasbl">=</span> <span class="luanum">0x0100</span>
MB_DEFBUTTON3 <span class="luasbl">=</span> <span class="luanum">0x0200</span>
<span class="luacmt">-- Возвращаемое значение</span>
mrNone <span class="luasbl">=</span> <span class="luanum">0x0000</span>
mrOK <span class="luasbl">=</span> <span class="luanum">0x0001</span>
mrCancel <span class="luasbl">=</span> <span class="luanum">0x0002</span>
mrAbort <span class="luasbl">=</span> <span class="luanum">0x0003</span>
mrRetry <span class="luasbl">=</span> <span class="luanum">0x0004</span>
mrIgnore <span class="luasbl">=</span> <span class="luanum">0x0005</span>
mrYes <span class="luasbl">=</span> <span class="luanum">0x0006</span>
mrNo <span class="luasbl">=</span> <span class="luanum">0x0007</span>
iFlags <span class="luasbl">=</span> MB_YESNO <span class="luasbl">+</span> MB_ICONQUESTION <span class="luasbl">+</span> MB_DEFBUTTON2
iButton <span class="luasbl">=</span> <span class="mark">Dialogs.MessageBox</span><span class="luasbl">(</span><span class="luastr">"Хотите завершить?"</span><span class="luasbl">,</span> <span class="luastr">"Вопрос"</span><span class="luasbl">,</span> iFlags<span class="luasbl">)</span>
<span class="luakyw">if</span> iButton <span class="luasbl">==</span> mrYes <span class="luakyw">then</span>
DC.ExecuteCommand<span class="luasbl">(</span><span class="luastr">"cm_Exit"</span><span class="luasbl">)</span>
<span class="luakyw">end</span></pre>
<p class="figure"><img class="largeimage" title="Пример использования Dialogs.MessageBox" alt="Пример использования Dialogs.MessageBox" src="images/imgDC/luaimg6.png" width="362" height="120"></p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="querysample">3.4.6. Пример использования Dialogs.InputQuery</a></h2>
<p>Маленький скрипт, использующий <code>Dialogs.InputQuery</code>:</p>
<pre>
bResult<span class="luasbl">,</span> sAnswer <span class="luasbl">=</span> <span class="mark">Dialogs.InputQuery</span><span class="luasbl">(</span><span class="luastr">"Идентификация"</span><span class="luasbl">,</span> <span class="luastr">"Введите ваше имя:"</span><span class="luasbl">,</span> <span class="luakyw">false</span><span class="luasbl">,</span> <span class="luastr">"Иван"</span><span class="luasbl">)</span>
<span class="luakyw">if</span> bResult <span class="luasbl">==</span> <span class="luakyw">true</span> <span class="luakyw">then</span>
Dialogs.MessageBox<span class="luasbl">(</span><span class="luastr">"Привет, "</span> <span class="luasbl">..</span> sAnswer <span class="luasbl">..</span> <span class="luastr">"!"</span><span class="luasbl">,</span> <span class="luastr">"Добро пожаловать!"</span><span class="luasbl">,</span> <span class="luanum">0x0040</span><span class="luasbl">)</span>
<span class="luakyw">end</span></pre>
<p class="figure"><img class="largeimage" title="Пример использования Dialogs.InputQuery" alt="Пример использования Dialogs.InputQuery" src="images/imgDC/luaimg5.png" width="364" height="112"></p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="libraryutf8">3.5. Библиотека UTF-8</a></h2>
<p>Эта библиотека обеспечивает базовую поддержку кодировки UTF-8.</p>
<p>Все функции представлены в таблице <code>LazUtf8</code>.</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека UTF-8</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_pos">LazUtf8.Pos</a></div></td>
<td class="hintcell">
<p class="definition">iResult = LazUtf8.Pos(SearchText, SourceText, Offset)</p>
<p>Поиск подстроки в строке, начиная с определённой позиции. Поиск чувствителен к регистру.</p>
<p>Возвращает позицию первого вхождения подстроки <var>SearchText</var> в строке <var>SourceText</var>, поиск начинается с позиции <var>Offset</var> (по умолчанию 1).</p>
<p>Если в <var>SourceText</var> не найдено совпадение с <var>SearchText</var> после заданного <var>Offset</var>, то функция возвращает ноль.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_next">LazUtf8.Next</a></div></td>
<td class="hintcell">
<p class="definition">LazUtf8.Next(String)</p>
<p>Функция-итератор, которая при каждом вызове возвращает следующий символ в строке <var>String</var> и позицию начала этого символа (в байтах).</p>
<p>Пример:</p>
<pre>
<span class="luacmt">-- Выведем пары значений в виде "позиция : символ"</span>
<span class="luakyw">for</span> iPos<span class="luasbl">,</span> sChar <span class="luakyw">in</span> <span class="mark">LazUtf8.Next</span><span class="luasbl">(</span>String<span class="luasbl">)</span> <span class="luakyw">do</span>
DC.LogWrite<span class="luasbl">(</span>iPos <span class="luasbl">..</span> <span class="luastr">" : "</span> <span class="luasbl">..</span> sChar<span class="luasbl">)</span>
<span class="luakyw">end</span></pre>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_copy">LazUtf8.Copy</a></div></td>
<td class="hintcell">
<p class="definition">sResult = LazUtf8.Copy(String, iIndex, iCount)</p>
<p>Копирует (извлекает) часть строки.</p>
<p>Функция возвращает <var>iCount</var> символов из строки <var>String</var>, начиная с позиции <var>iIndex</var>.</p>
<p>Если <var>iCount</var> больше длины строки <var>String</var>, то результат усекается. Если <var>iIndex</var> больше длины строки <var>String</var>, то возвращается пустая строка.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_length">LazUtf8.Length</a></div></td>
<td class="hintcell">
<p class="definition">iResult = LazUtf8.Length(String)</p>
<p>Возвращает количество символов в строке с учётом кодировки UTF-8.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_uppercase">LazUtf8.UpperCase</a></div></td>
<td class="hintcell">
<p class="definition">sResult = LazUtf8.UpperCase(String)</p>
<p>Возвращает строку, в которой все буквы в нижнем регистре (строчные) заменены на буквы в верхнем регистре (прописные или заглавные).</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_lowercase">LazUtf8.LowerCase</a></div></td>
<td class="hintcell">
<p class="definition">sResult = LazUtf8.LowerCase(String)</p>
<p>Возвращает строку, в которой все буквы в верхнем регистре (прописные или заглавные) заменены на буквы в нижнем регистре (строчные).</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_convertencoding">LazUtf8.ConvertEncoding</a></div></td>
<td class="hintcell">
<p class="definition">sResult = LazUtf8.ConvertEncoding(String, FromEnc, ToEnc)</p>
<p>Конвертирует кодировку <var>String</var> из <var>FromEnc</var> в <var>ToEnc</var>.</p>
<p>Список поддерживаемых значений кодировок:</p>
<ul>
<li>Системная кодировка по умолчанию (зависит от языковых стандартов системы): "default".</li>
<li>Кодировка ANSI (Windows) по умолчанию (зависит от языковых стандартов системы): "ansi".</li>
<li>Кодировка OEM (DOS) по умолчанию (зависит от языковых стандартов системы): "oem".</li>
<li>Юникод: "utf8", "utf8bom", "ucs2le", "ucs2be".</li>
<li>ANSI (Windows): "cp1250", "cp1251", "cp1252", "cp1253", "cp1254", "cp1255", "cp1256", "cp1257", "cp1258".</li>
<li>OEM (DOS): "cp437", "cp850", "cp852", "cp865", "cp866", "cp874", "cp932", "cp936", "cp949", "cp950".</li>
<li>ISO 8859: "iso88591", "iso88592", "iso88593", "iso88594", "iso88595", "iso88597", "iso88599", "iso885910", "iso885913", "iso885914", "iso885915", "iso885916".</li>
<li>Другие: "macintosh", "koi8r", "koi8u", "koi8ru".</li>
</ul>
Специальные значения кодировок (примеры).
<br><br>
В Windows (английкий или русский языки):
<ul>
<li>"default" - cp1252 или cp1251</li>
<li>"ansi" - cp1252 или cp1251</li>
<li>"oem" - cp850 или cp866</li>
</ul>
В Linux (английкий или русский языки):
<ul>
<li>"default" - utf8</li>
<li>"ansi" - cp1252 или cp1251</li>
<li>"oem" - cp850 или cp866</li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="lazutf8_detectencoding">LazUtf8.DetectEncoding</a></div></td>
<td class="hintcell">
<p class="definition">sEnc = LazUtf8.DetectEncoding(String)</p>
<p>Возвращает значение кодировки переданного текста.<br>Список поддерживаемых кодировок аналогичен тем, которые используются в функции <code>LazUtf8.ConvertEncoding</code>.</p>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="librarychar">3.6. Библиотека Char</a></h2>
<p>Эта библиотека содержит функции для проверки принадлежности символа к определённой категории юникода, а также для получения категории символа.</p>
<p>Список доступных функций:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека Char</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_getunicodecategory">Char.GetUnicodeCategory</a></div></td>
<td class="hintcell">
<p class="definition">iResult = Char.GetUnicodeCategory(Character)</p>
<p>Возвращает категорию юникода символа <code>Character</code>, одно из следующих значений:</p>
<table class="innercmddesc">
<tr class="rowinnerdesc"><th class="innerdescheader">Значение</th><th class="innerdescheader">Описание</th></tr>
<tr><td colspan="2"> Буква:</td></tr>
<tr><td class="innerdescvaluecell">0</td><td class="innerdescdesccell">Буква в верхнем регистре (Lu)</td></tr>
<tr><td class="innerdescvaluecell">1</td><td class="innerdescdesccell">Буква в нижнем регистре (Ll)</td></tr>
<tr><td class="innerdescvaluecell">2</td><td class="innerdescdesccell">Заглавная буква (Lt)</td></tr>
<tr><td class="innerdescvaluecell">3</td><td class="innerdescdesccell">Модификатор (Lm)</td></tr>
<tr><td class="innerdescvaluecell">4</td><td class="innerdescdesccell">Прочие буквы (Lo)</td></tr>
<tr><td colspan="2"> Отметки:</td></tr>
<tr><td class="innerdescvaluecell">5</td><td class="innerdescdesccell">Символ нулевой ширины, указывающий на изменение базового символа (Mn)</td></tr>
<tr><td class="innerdescvaluecell">6</td><td class="innerdescdesccell">Символ ненулевой ширины, указывающий на изменение базового символа (Mc)</td></tr>
<tr><td class="innerdescvaluecell">7</td><td class="innerdescdesccell">Вложенный символ (Me)</td></tr>
<tr><td colspan="2"> Цифра:</td></tr>
<tr><td class="innerdescvaluecell">8</td><td class="innerdescdesccell">Десятичная цифра (Nd)</td></tr>
<tr><td class="innerdescvaluecell">9</td><td class="innerdescdesccell">Цифра, обозначаемая буквами (Nl)</td></tr>
<tr><td class="innerdescvaluecell">10</td><td class="innerdescdesccell">Прочие цифры (No)</td></tr>
<tr><td colspan="2"> Знак пунктуации:</td></tr>
<tr><td class="innerdescvaluecell">11</td><td class="innerdescdesccell">Соединитель (Pc)</td></tr>
<tr><td class="innerdescvaluecell">12</td><td class="innerdescdesccell">Тире (Pd)</td></tr>
<tr><td class="innerdescvaluecell">13</td><td class="innerdescdesccell">Открывающий знак пунктуации (скобки) (Ps)</td></tr>
<tr><td class="innerdescvaluecell">14</td><td class="innerdescdesccell">Закрывающий знак пунктуации (скобки) (Pe)</td></tr>
<tr><td class="innerdescvaluecell">15</td><td class="innerdescdesccell">Знак открывающей кавычки (Pi)</td></tr>
<tr><td class="innerdescvaluecell">16</td><td class="innerdescdesccell">Знак закрывающей кавычки (Pf)</td></tr>
<tr><td class="innerdescvaluecell">17</td><td class="innerdescdesccell">Прочие знаки пунктуации (Po)</td></tr>
<tr><td colspan="2"> Символ:</td></tr>
<tr><td class="innerdescvaluecell">18</td><td class="innerdescdesccell">Математический символ (Sm)</td></tr>
<tr><td class="innerdescvaluecell">19</td><td class="innerdescdesccell">Денежная единица (Sc)</td></tr>
<tr><td class="innerdescvaluecell">20</td><td class="innerdescdesccell">Модификатор (Sk)</td></tr>
<tr><td class="innerdescvaluecell">21</td><td class="innerdescdesccell">Прочие символы (So)</td></tr>
<tr><td colspan="2"> Разделитель:</td></tr>
<tr><td class="innerdescvaluecell">22</td><td class="innerdescdesccell">Пробел (Zs)</td></tr>
<tr><td class="innerdescvaluecell">23</td><td class="innerdescdesccell">Разделитель строк (Zl)</td></tr>
<tr><td class="innerdescvaluecell">24</td><td class="innerdescdesccell">Разделитель параграфов (Zp)</td></tr>
<tr><td colspan="2"> Прочее:</td></tr>
<tr><td class="innerdescvaluecell">25</td><td class="innerdescdesccell">Управляющий символ (Cc)</td></tr>
<tr><td class="innerdescvaluecell">26</td><td class="innerdescdesccell">Символ форматирования (Cf)</td></tr>
<tr><td class="innerdescvaluecell">27</td><td class="innerdescdesccell">Символ-заместитель (суррогат) (Cs)</td></tr>
<tr><td class="innerdescvaluecell">28</td><td class="innerdescdesccell">Для частного использования (Co)</td></tr>
<tr><td class="innerdescvaluecell">29</td><td class="innerdescdesccell">Не определён (Cn)</td></tr>
</table>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_isdigit">Char.IsDigit</a></div></td>
<td class="hintcell">
<p class="definition">bResult = Char.IsDigit(Character)</p>
<p>Возвращает <code>true</code>, если символ <var>Character</var> входит в категорию <i>Nd</i>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_isletter">Char.IsLetter</a></div></td>
<td class="hintcell">
<p class="definition">bResult = Char.IsLetter(Character)</p>
<p>Возвращает <code>true</code>, если символ <var>Character</var> входит в категорию <i>Lu</i>, <i>Ll</i>, <i>Lt</i>, <i>Lm</i> или <i>Lo</i>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_isletterordigit">Char.IsLetterOrDigit</a></div></td>
<td class="hintcell">
<p class="definition">bResult = Char.IsLetterOrDigit(Character)</p>
<p>Возвращает <code>true</code>, если символ <var>Character</var> входит в категорию <i>Lu</i>, <i>Ll</i>, <i>Lt</i>, <i>Lm</i> <i>Lo</i>, <i>Nd</i> или <i>Nl</i>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_islower">Char.IsLower</a></div></td>
<td class="hintcell">
<p class="definition">bResult = Char.IsLower(Character)</p>
<p>Возвращает <code>true</code>, если символ <var>Character</var> входит в категорию <i>Ll</i>.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="char_isupper">Char.IsUpper</a></div></td>
<td class="hintcell">
<p class="definition">bResult = Char.IsUpper(Character)</p>
<p>Возвращает <code>true</code>, если символ <var>Character</var> входит в категорию <i>Lu</i>.</p>
</td>
</tr>
</table>
<p>Также эти функции поддерживают работу с двумя параметрами: вместо одного символа мы можем указать строку и позицию символа в этой строке.</p>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="libraryos">3.7. Библиотека OS</a></h2>
<p>Эта библиотека содержит функции, связанные с операционной системой, в которой запущен Double Commander.</p>
<p>Список доступных функций:</p>
<table>
<tr class="rowcategorytitle"><th colspan="2">Библиотека OS</th></tr>
<tr class="rowsubtitle"><th class="categorynamecolumn">Функция</th><th class="categorydesccolumn">Описание</th></tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_execute">os.execute</a></div></td>
<td class="hintcell">
<p class="definition">iResultCode = os.execute(sCommand)</p>
<p>Выполнить <var>sCommand</var>, аналогично введённой в командной строке, будет возвращён код завершения.</p>
<p><var>sCommand</var> может быть:</p>
<ul>
<li>Команда терминала, например, <code>os.execute("dir > all.txt")</code></li>
<li>Исполняемый файл, например, <code>os.execute("C:\\Windows\\System32\\calc.exe")</code></li>
<li>Исполняемый файл с параметрами:<br><code>os.execute("C:\\Utils\\fsum.exe -md5 test.bin > md5.txt")</code></li>
</ul>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_tmpname">os.tmpname</a></div></td>
<td class="hintcell">
<p class="definition">sTempFileName = os.tmpname()</p>
<p>Возвращает строку с именем файла, который может быть использован в качестве временного файла (в системном каталоге для временных файлов).<br>Если функции не удалось создать уникальное имя, то она вернёт пустую строку.</p>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_remove">os.remove</a></div></td>
<td class="hintcell">
<p class="definition">bResult, sError, iError = os.remove(sFileName)</p>
<p>Удалить файл или каталог с именем <var>sFileName</var>.</p>
<p>Если удалось, функция вернёт <code>true</code>.</p>
<p>Если не удалось, функция вернёт:</p>
<ol>
<li><code>nil</code> как индикатор неудачи</li>
<li><var>sError</var> с описанием ошибки</li>
<li><var>iError</var> в виде кода ошибки (число)</li>
</ol>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_rename">os.rename</a></div></td>
<td class="hintcell">
<p class="definition">bResult, sError, iError = os.rename(sOldName, sNewName)</p>
<p>Переименовать файл <var>sOldName</var> в <var>sNewName</var>.</p>
<p><b><span class="uline">Примечание:</span> Если файл с именем <var>sNewName</var> уже существует, он будет заменён!</b></p>
<p>Если удалось, функция вернёт <code>true</code>.</p>
<p>Если не удалось, функция вернёт:</p>
<ol>
<li><code>nil</code> как индикатор неудачи</li>
<li><var>sError</var> с описанием ошибки</li>
<li><var>iError</var> в виде кода ошибки (число)</li>
</ol>
</td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_getenv">os.getenv</a></div></td>
<td class="hintcell">
<p class="definition">Value = os.getenv(VariableName)</p>
<p>Получить в <var>Value</var> значение переменной окружения <var>VariableName</var>.<br>Если переменная не существует, то функция вернёт <code>nil</code>.</p></td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_setenv">os.setenv</a></div></td>
<td class="hintcell">
<p class="definition">os.setenv(VariableName, Value)</p>
<p>Добавить или изменить переменную окружения <var>VariableName</var>. В случае ошибки функция возвращает -1.</p></td>
</tr>
<tr>
<td class="cmdcell"><div class="firstcolumnaleft"><a name="os_unsetenv">os.unsetenv</a></div></td>
<td class="hintcell">
<p class="definition">os.unsetenv(VariableName)</p>
<p>Удалить переменную окружения <var>VariableName</var>. В случае ошибки функция возвращает -1.</p></td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
</div>
<div>
<h2><a name="index">4. Индекс</a></h2>
<table class="index">
<tr>
<td class="indexcell">
<p><span class="bold"><a href="#libdc">Библиотека DC</a></span></p>
<p>
<a href="#dc_currentpanel">DC.CurrentPanel</a><br>
<a href="#dc_executecommand">DC.ExecuteCommand</a><br>
<a href="#dc_expandvar">DC.ExpandVar</a><br>
<a href="#dc_getpluginfield">DC.GetPluginField</a><br>
<a href="#dc_gotofile">DC.GoToFile</a><br>
<a href="#dc_logwrite">DC.LogWrite</a>
</p>
<br>
<p><span class="bold"><a href="#librarysystem">Библиотека System</a></span></p>
<p>
<a href="#sysutils_createdirectory">SysUtils.CreateDirectory</a><br>
<a href="#sysutils_createhardlink">SysUtils.CreateHardLink</a><br>
<a href="#sysutils_createsymboliclink">SysUtils.CreateSymbolicLink</a><br>
<a href="#sysutils_directoryexists">SysUtils.DirectoryExists</a><br>
<a href="#sysutils_execute">SysUtils.Execute</a><br>
<a href="#sysutils_expandenv">SysUtils.ExpandEnv</a><br>
<a href="#sysutils_extractfiledir">SysUtils.ExtractFileDir</a><br>
<a href="#sysutils_extractfiledrive">SysUtils.ExtractFileDrive</a><br>
<a href="#sysutils_extractfileext">SysUtils.ExtractFileExt</a><br>
<a href="#sysutils_extractfilename">SysUtils.ExtractFileName</a><br>
<a href="#sysutils_extractfilepath">SysUtils.ExtractFilePath</a><br>
<a href="#sysutils_fileexists">SysUtils.FileExists</a><br>
<a href="#sysutils_filegetattr">SysUtils.FileGetAttr</a><br>
<a href="#sysutils_filesettime">SysUtils.FileSetTime</a><br>
<a href="#sysutils_findclose">SysUtils.FindClose</a><br>
<a href="#sysutils_findfirst">SysUtils.FindFirst</a><br>
<a href="#sysutils_findnext">SysUtils.FindNext</a><br>
<a href="#sysutils_getabsolutepath">SysUtils.GetAbsolutePath</a><br>
<a href="#sysutils_getfileproperty">SysUtils.GetFileProperty</a><br>
<a href="#sysutils_getrelativepath">SysUtils.GetRelativePath</a><br>
<a href="#sysutils_gettempname">SysUtils.GetTempName</a><br>
<a href="#sysutils_gettickcount">SysUtils.GetTickCount</a><br>
<a href="#sysutils_matchesmask">SysUtils.MatchesMask</a><br>
<a href="#sysutils_matchesmasklist">SysUtils.MatchesMaskList</a><br>
<a href="#sysutils_pathdelim">SysUtils.PathDelim</a><br>
<a href="#sysutils_readsymboliclink">SysUtils.ReadSymbolicLink</a><br>
<a href="#sysutils_removedirectory">SysUtils.RemoveDirectory</a><br>
<a href="#sysutils_sleep">SysUtils.Sleep</a>
</p>
<br>
</td>
<td class="indexcell">
<p><span class="bold"><a href="#libraryclip">Библиотека Clipboard</a></span></p>
<p>
<a href="#clipbrd_clear">Clipbrd.Clear</a><br>
<a href="#clipbrd_getastext">Clipbrd.GetAsText</a><br>
<a href="#clipbrd_setashtml">Clipbrd.SetAsHtml</a><br>
<a href="#clipbrd_setastext">Clipbrd.SetAsText</a>
</p>
<br>
<p><span class="bold"><a href="#librarydialogs">Библиотека Dialogs</a></span></p>
<p>
<a href="#dialogs_inputlistbox">Dialogs.InputListBox</a><br>
<a href="#dialogs_inputquery">Dialogs.InputQuery</a><br>
<a href="#dialogs_messagebox">Dialogs.MessageBox</a>
</p>
<br>
<p><span class="bold"><a href="#libraryutf8">Библиотека UTF-8</a></span></p>
<p>
<a href="#lazutf8_convertencoding">LazUtf8.ConvertEncoding</a><br>
<a href="#lazutf8_copy">LazUtf8.Copy</a><br>
<a href="#lazutf8_detectencoding">LazUtf8.DetectEncoding</a><br>
<a href="#lazutf8_length">LazUtf8.Length</a><br>
<a href="#lazutf8_lowercase">LazUtf8.LowerCase</a><br>
<a href="#lazutf8_next">LazUtf8.Next</a><br>
<a href="#lazutf8_pos">LazUtf8.Pos</a><br>
<a href="#lazutf8_uppercase">LazUtf8.UpperCase</a>
</p>
<br>
<p><span class="bold"><a href="#librarychar">Библиотека Char</a></span></p>
<p>
<a href="#char_getunicodecategory">Char.GetUnicodeCategory</a><br>
<a href="#char_isdigit">Char.IsDigit</a><br>
<a href="#char_isletter">Char.IsLetter</a><br>
<a href="#char_isletterordigit">Char.IsLetterOrDigit</a><br>
<a href="#char_islower">Char.IsLower</a><br>
<a href="#char_isupper">Char.IsUpper</a>
</p>
<br>
</td>
<td class="indexcell">
<p><span class="bold"><a href="#libraryos">Библиотека OS</a></span></p>
<p>
<a href="#os_execute">os.execute</a><br>
<a href="#os_getenv">os.getenv</a><br>
<a href="#os_remove">os.remove</a><br>
<a href="#os_rename">os.rename</a><br>
<a href="#os_setenv">os.setenv</a><br>
<a href="#os_tmpname">os.tmpname</a><br>
<a href="#os_unsetenv">os.unsetenv</a>
</p>
</td>
</tr>
</table>
<p class="navback"><a href="#topofpage">(наверх)</a></p>
<br>
</div>
</div>
<div class="footer"><div class="nav"><a title="Начало" href="index.html">Начало</a> | <a title="Предыдущая страница" href="regexp.html">Пред.</a> | <a title="Следующая страница" href="commandline.html">След.</a></div></div>
<div class="checker">
<a href="https://validator.w3.org/check?uri=referer" target="_blank"><img src="https://www.w3.org/Icons/valid-html40" alt="Valid HTML 4.0 Transitional" height="31" width="88"></a>
<a href="https://jigsaw.w3.org/css-validator/check/referer" target="_blank"><img style="border:0;width:88px;height:31px" src="https://jigsaw.w3.org/css-validator/images/vcss" alt="CSS Valid!"></a>
</div>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
</body>
</html>
|
