1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
|
-- Copyright 2007-2020 Mitchell mitchell.att.foicica.com. See LICENSE.
-- This is a DUMMY FILE used for making LuaDoc for Buffers.
---
-- A Textadept buffer object.
-- Constants are documented in the fields they apply to.
-- While you can work with individual buffer instances, it is really only useful
-- to work with the global one.
-- Many of these functions and fields are derived from buffer-specific
-- functionality of the Scintilla editing component, and additional information
-- can be found on the
-- [Scintilla website](https://scintilla.org/ScintillaDoc.html).
-- Note that with regard to Scintilla-specific functionality, this API is a
-- _suggestion_, not a hard requirement. All of that functionality also exists
-- in [`view`](), even if undocumented.
-- Any buffer fields set on startup (e.g. in *~/.textadept/init.lua*) will be
-- the default, initial values for all buffers.
-- @field additional_selection_typing (bool)
-- Type into multiple selections.
-- The default value is `false`.
-- @field anchor (number)
-- The anchor's position.
-- @field annotation_lines (table, Read-only)
-- Table of the number of annotation text lines per line number.
-- @field annotation_style (table)
-- Table of style numbers for annotation text per line number.
-- Only some style attributes are active in annotations: font,
-- size/size_fractional, bold/weight, italics, fore, back, and character_set.
-- @field annotation_text (table)
-- Table of annotation text per line number.
-- @field auto_c_auto_hide (bool)
-- Automatically cancel an autocompletion or user list when no entries match
-- typed text.
-- The default value is `true`.
-- @field auto_c_cancel_at_start (bool)
-- Cancel an autocompletion list when backspacing to a position before where
-- autocompletion started (instead of before the word being completed).
-- This option has no effect for a user list.
-- The default value is `true`.
-- @field auto_c_case_insensitive_behavior (number)
-- The behavior mode for a case insensitive autocompletion or user list when
-- [`buffer.auto_c_ignore_case`]() is `true`.
--
-- * `buffer.CASEINSENSITIVEBEHAVIOR_RESPECTCASE`
-- Prefer to select case-sensitive matches.
-- * `buffer.CASEINSENSITIVEBEHAVIOR_IGNORECASE`
-- No preference.
--
-- The default value is `buffer.CASEINSENSITIVEBEHAVIOR_RESPECTCASE`.
-- @field auto_c_choose_single (bool)
-- Automatically choose the item in a single-item autocompletion list.
-- This option has no effect for a user list.
-- The default value is `false`.
-- @field auto_c_current (number, Read-only)
-- The index of the currently selected item in an autocompletion or user list.
-- @field auto_c_current_text (string, Read-only)
-- The text of the currently selected item in an autocompletion or user list.
-- @field auto_c_drop_rest_of_word (bool)
-- Delete any word characters immediately to the right of autocompleted text.
-- The default value is `false`.
-- @field auto_c_fill_ups (string, Write-only)
-- The set of characters that choose the currently selected item in an
-- autocompletion or user list when the user types one of them.
-- The default value is `''`.
-- @field auto_c_ignore_case (bool)
-- Ignore case when searching an autocompletion or user list for matches.
-- The default value is `false`.
-- @field auto_c_multi (number)
-- The multiple selection autocomplete mode.
--
-- * `buffer.MULTIAUTOC_ONCE`
-- Autocomplete into only the main selection.
-- * `buffer.MULTIAUTOC_EACH`
-- Autocomplete into all selections.
--
-- The default value is `buffer.MULTIAUTOC_ONCE`.
-- @field auto_c_order (number)
-- The order setting for autocompletion and user lists.
--
-- * `buffer.ORDER_PRESORTED`
-- Lists passed to [`buffer.auto_c_show()`]() are in sorted, alphabetical
-- order.
-- * `buffer.ORDER_PERFORMSORT`
-- Sort autocompletion lists passed to [`buffer.auto_c_show()`]().
-- * `buffer.ORDER_CUSTOM`
-- Lists passed to [`buffer.auto_c_show()`]() are already in a custom order.
--
-- The default value is `buffer.ORDER_PRESORTED`.
-- @field auto_c_separator (number)
-- The byte value of the character that separates autocompletion and user list
-- list items.
-- The default value is `32` (' ').
-- @field auto_c_type_separator (number)
-- The character byte that separates autocompletion and user list items and
-- their image types.
-- Autocompletion and user list items can display both an image and text.
-- Register images and their types using [`view.register_image()`]() or
-- [`view.register_rgba_image()`]() before appending image types to list
-- items after type separator characters.
-- The default value is 63 ('?').
-- @field back_space_un_indents (bool)
-- Un-indent text when backspacing within indentation.
-- The default value is `false`.
-- @field caret_sticky (number)
-- The caret's preferred horizontal position when moving between lines.
--
-- * `buffer.CARETSTICKY_OFF`
-- Use the same position the caret had on the previous line.
-- * `buffer.CARETSTICKY_ON`
-- Use the last position the caret was moved to via the mouse, left/right
-- arrow keys, home/end keys, etc. Typing text does not affect the position.
-- * `buffer.CARETSTICKY_WHITESPACE`
-- Use the position the caret had on the previous line, but prior to any
-- inserted indentation.
--
-- The default value is `buffer.CARETSTICKY_OFF`.
-- @field char_at (table, Read-only)
-- Table of character bytes per position.
-- @field column (table, Read-only)
-- Table of column numbers (taking tab widths into account) per position.
-- Multi-byte characters count as single characters.
-- @field current_pos (number)
-- The caret's position.
-- When set, does not scroll the caret into view.
-- @field encoding (string or nil)
-- The string encoding of the file, or `nil` for binary files.
-- @field end_styled (number, Read-only)
-- The current styling position or the last correctly styled character's
-- position.
-- @field eol_annotation_style (table)
-- Table of style numbers for EOL annotation text per line number.
-- Only some style attributes are active in annotations: font,
-- size/size_fractional, bold/weight, italics, fore, back, and character_set.
-- @field eol_annotation_text (table)
-- Table of EOL annotation text per line number.
-- @field eol_mode (number)
-- The current end of line mode. Changing the current mode does not convert
-- any of the buffer's existing end of line characters.
-- Use [`buffer.convert_eols()`]() to do so.
--
-- * `buffer.EOL_CRLF`
-- Carriage return with line feed ("\r\n").
-- * `buffer.EOL_CR`
-- Carriage return ("\r").
-- * `buffer.EOL_LF`
-- Line feed ("\n").
--
-- The default value is `buffer.EOL_CRLF` on Windows platforms,
-- `buffer.EOL_LF` otherwise.
-- @field filename (string)
-- The absolute file path associated with the buffer.
-- @field fold_level (table)
-- Table of fold level bit-masks per line number.
-- Fold level masks comprise of an integer level combined with any of the
-- following bit flags:
--
-- * `buffer.FOLDLEVELBASE`
-- The initial fold level.
-- * `buffer.FOLDLEVELWHITEFLAG`
-- The line is blank.
-- * `buffer.FOLDLEVELHEADERFLAG`
-- The line is a header, or fold point.
-- @field fold_parent (table, Read-only)
-- Table of fold point line numbers per child line number.
-- A line number of `-1` means no line was found.
-- @field indent (number)
-- The number of spaces in one level of indentation.
-- The default value is `0`, which uses the value of [`buffer.tab_width`]().
-- @field indicator_current (number)
-- The indicator number in the range of `1` to `32` used by
-- [`buffer.indicator_fill_range()`]() and
-- [`buffer.indicator_clear_range()`]().
-- @field length (number, Read-only)
-- The number of bytes in the buffer.
-- @field line_count (number, Read-only)
-- The number of lines in the buffer.
-- There is always at least one.
-- @field line_end_position (table, Read-only)
-- Table of positions at the ends of lines, but before any end of line
-- characters, per line number.
-- @field line_indent_position (table, Read-only)
-- Table of positions at the ends of indentation per line number.
-- @field line_indentation (table)
-- Table of column indentation amounts per line number.
-- @field main_selection (number)
-- The number of the main or most recent selection.
-- Only an existing selection can be made main.
-- @field margin_text (table)
-- Table of text displayed in text margins per line number.
-- @field margin_style (table)
-- Table of style numbers in the text margin per line number.
-- Only some style attributes are active in text margins: font, size, bold,
-- italics, fore, and back.
-- @field modify (bool, Read-only)
-- Whether or not the buffer has unsaved changes.
-- @field move_extends_selection (bool, Read-only)
-- Whether or not regular caret movement alters the selected text.
-- [`buffer.selection_mode`]() dictates this property.
-- @field multi_edge_column (table, Read-only)
-- Table of edge column positions per edge column number.
-- A position of `-1` means no edge column was found.
-- @field multi_paste (number)
-- The multiple selection paste mode.
--
-- * `buffer.MULTIPASTE_ONCE`
-- Paste into only the main selection.
-- * `buffer.MULTIPASTE_EACH`
-- Paste into all selections.
--
-- The default value is `buffer.MULTIPASTE_ONCE`.
-- @field multiple_selection (bool)
-- Enable multiple selection.
-- The default value is `false`.
-- @field overtype (bool)
-- Enable overtype mode, where typed characters overwrite existing ones.
-- The default value is `false`.
-- @field punctuation_chars (string)
-- The string set of characters recognized as punctuation characters.
-- Set this only after setting [`buffer.word_chars`]().
-- The default value is a string that contains all non-word and non-whitespace
-- characters.
-- @field read_only (bool)
-- Whether or not the buffer is read-only.
-- The default value is `false`.
-- @field rectangular_selection_anchor (number)
-- The rectangular selection's anchor position.
-- @field rectangular_selection_anchor_virtual_space (number)
-- The amount of virtual space for the rectangular selection's anchor.
-- @field rectangular_selection_caret (number)
-- The rectangular selection's caret position.
-- @field rectangular_selection_caret_virtual_space (number)
-- The amount of virtual space for the rectangular selection's caret.
-- @field search_flags (number)
-- The bit-mask of search flags used by [`buffer.search_in_target()`]().
--
-- * `buffer.FIND_WHOLEWORD`
-- Match search text only when it is surrounded by non-word characters.
-- * `buffer.FIND_MATCHCASE`
-- Match search text case sensitively.
-- * `buffer.FIND_WORDSTART`
-- Match search text only when the previous character is a non-word
-- character.
-- * `buffer.FIND_REGEXP`
-- Interpret search text as a regular expression.
--
-- The default value is `0`.
-- @field selection_empty (bool, Read-only)
-- Whether or not no text is selected.
-- @field selection_end (number)
-- The position of the end of the selected text.
-- When set, becomes the current position, but is not scrolled into view.
-- @field selection_is_rectangle (bool, Read-only)
-- Whether or not the selection is a rectangular selection.
-- @field selection_mode (number)
-- The selection mode.
--
-- * `buffer.SEL_STREAM`
-- Character selection.
-- * `buffer.SEL_RECTANGLE`
-- Rectangular selection.
-- * `buffer.SEL_LINES`
-- Line selection.
-- * `buffer.SEL_THIN`
-- Thin rectangular selection. This is the mode after a rectangular
-- selection has been typed into and ensures that no characters are
-- selected.
--
-- When set, caret movement alters the selected text until this field is set
-- again to the same value or until [`buffer.cancel()`]() is called.
-- @field selection_n_anchor (table)
-- Table of positions at the beginning of existing selections numbered from
-- `1`, the main selection.
-- @field selection_n_anchor_virtual_space (table)
-- Table of positions at the beginning of virtual space selected in existing
-- selections numbered from `1`, the main selection.
-- @field selection_n_caret (table)
-- Table of positions at the end of existing selections numbered from `1`,
-- the main selection.
-- @field selection_n_caret_virtual_space (table)
-- Table of positions at the end of virtual space selected in existing
-- selections numbered from `1`, the main selection.
-- @field selection_n_end (table)
-- Table of positions at the end of existing selections numbered from `1`,
-- the main selection.
-- @field selection_n_start (table)
-- Table of positions at the beginning of existing selections numbered from
-- `1`, the main selection.
-- @field selection_n_end_virtual_space (number, Read-only)
-- Table of positions at the end of virtual space selected in existing
-- selections numbered from `1`, the main selection.
-- @field selection_n_start_virtual_space (number, Read-only)
-- Table of positions at the beginning of virtual space selected in existing
-- selections numbered from `1`, the main selection.
-- @field selection_start (number)
-- The position of the beginning of the selected text.
-- When set, becomes the anchor, but is not scrolled into view.
-- @field selections (number, Read-only)
-- The number of active selections. There is always at least one selection.
-- @field style_at (table, Read-only)
-- Table of style numbers per position.
-- @field tab_indents (bool)
-- Indent text when tabbing within indentation.
-- The default value is `false`.
-- @field tab_label (string)
-- The buffer's tab label in the tab bar.
-- @field tab_width (number)
-- The number of space characters represented by a tab character.
-- The default value is `8`.
-- @field tag (table, Read-only)
-- List of capture text for capture numbers from a regular expression search.
-- @field target_end (number)
-- The position of the end of the target range.
-- This is also set by a successful [`buffer.search_in_target()`]().
-- @field target_end_virtual_space (number)
-- The position of the end of virtual space in the target range.
-- This is set to `1` when [`buffer.target_start`]() or
-- [`buffer.target_end`]() is set, or when [`buffer.set_target_range()`]() is
-- called.
-- @field target_start (number)
-- The position of the beginning of the target range.
-- This is also set by a successful [`buffer.search_in_target()`]().
-- @field target_start_virtual_space (number)
-- The position of the beginning of virtual space in the target range.
-- This is set to `1` when [`buffer.target_start`]() or
-- [`buffer.target_end`]() is set, or when [`buffer.set_target_range()`]() is
-- called.
-- @field target_text (string, Read-only)
-- The text in the target range.
-- @field text_length (number, Read-only)
-- The number of bytes in the buffer.
-- @field use_tabs (bool)
-- Use tabs instead of spaces in indentation. Changing the current setting
-- does not convert any of the buffer's existing indentation. Use
-- [`textadept.editing.convert_indentation()`]() to do so.
-- The default value is `true`.
-- @field virtual_space_options (number)
-- The virtual space mode.
--
-- * `buffer.VS_NONE`
-- Disable virtual space.
-- * `buffer.VS_RECTANGULARSELECTION`
-- Enable virtual space only for rectangular selections.
-- * `buffer.VS_USERACCESSIBLE`
-- Enable virtual space.
-- * `buffer.VS_NOWRAPLINESTART`
-- Prevent the caret from wrapping to the previous line via
-- `buffer:char_left()` and `buffer:char_left_extend()`. This option is not
-- restricted to virtual space and should be added to any of the above
-- options.
--
-- When virtual space is enabled, the caret may move into the space past end
-- of line characters.
-- The default value is `buffer.VS_NONE`.
-- @field whitespace_chars (string)
-- The string set of characters recognized as whitespace characters.
-- Set this only after setting [`buffer.word_chars`]().
-- The default value is a string that contains all non-newline characters less
-- than ASCII value 33.
-- @field word_chars (string)
-- The string set of characters recognized as word characters.
-- The default value is a string that contains alphanumeric characters, an
-- underscore, and all characters greater than ASCII value 127.
-- @field FIND_MATCHCASE (number, Read-only)
--
-- @field FIND_REGEXP (number, Read-only)
--
-- @field FIND_WHOLEWORD (number, Read-only)
--
-- @field FIND_WORDSTART (number, Read-only)
--
-- @field VS_NONE (number, Read-only)
--
-- @field VS_RECTANGULARSELECTION (number, Read-only)
--
-- @field VS_USERACCESSIBLE (number, Read-only)
--
-- @field CARETSTICKY_OFF (number, Read-only)
--
-- @field CARETSTICKY_ON (number, Read-only)
--
-- @field CARETSTICKY_WHITESPACE (number, Read-only)
--
-- @field CASEINSENSITIVEBEHAVIOR_IGNORECASE (number, Read-only)
--
-- @field CASEINSENSITIVEBEHAVIOR_RESPECTCASE (number, Read-only)
--
-- @field EOL_CR (number, Read-only)
--
-- @field EOL_CRLF (number, Read-only)
--
-- @field EOL_LF (number, Read-only)
--
-- @field FOLDLEVELBASE (number, Read-only)
--
-- @field FOLDLEVELHEADERFLAG (number, Read-only)
--
-- @field FOLDLEVELNUMBERMASK (number, Read-only)
--
-- @field FOLDLEVELWHITEFLAG (number, Read-only)
--
-- @field INDICATOR_MAX (number, Read-only)
--
-- @field MARK_AVAILABLE (number, Read-only)
--
-- @field MARKER_MAX (number, Read-only)
--
-- @field MARKNUM_FOLDER (number, Read-only)
--
-- @field MARKNUM_FOLDEREND (number, Read-only)
--
-- @field MARKNUM_FOLDERMIDTAIL (number, Read-only)
--
-- @field MARKNUM_FOLDEROPEN (number, Read-only)
--
-- @field MARKNUM_FOLDEROPENMID (number, Read-only)
--
-- @field MARKNUM_FOLDERSUB (number, Read-only)
--
-- @field MARKNUM_FOLDERTAIL (number, Read-only)
--
-- @field MULTIAUTOC_EACH (number, Read-only)
--
-- @field MULTIAUTOC_ONCE (number, Read-only)
--
-- @field MULTIPASTE_EACH (number, Read-only)
--
-- @field MULTIPASTE_ONCE (number, Read-only)
--
-- @field ORDER_CUSTOM (number, Read-only)
--
-- @field ORDER_PERFORMSORT (number, Read-only)
--
-- @field ORDER_PRESORTED (number, Read-only)
--
-- @field SEL_LINES (number, Read-only)
--
-- @field SEL_RECTANGLE (number, Read-only)
--
-- @field SEL_STREAM (number, Read-only)
--
-- @field SEL_THIN (number, Read-only)
--
-- @field UPDATE_CONTENT (number, Read-only)
--
-- @field UPDATE_SELECTION (number, Read-only)
--
module('buffer')
---
-- Selects the range of text between positions *start_pos* to *end_pos* as the
-- main selection, retaining all other selections as additional selections.
-- Since an empty selection (i.e. the current position) still counts as a
-- selection, use `buffer.set_selection()` first when setting a list of
-- selections.
-- @param buffer A buffer.
-- @param end_pos The caret position of the range of text to select in *buffer*.
-- @param start_pos The anchor position of the range of text to select in
-- *buffer*.
-- @see set_selection
function add_selection(buffer, end_pos, start_pos) end
---
-- Adds string *text* to the buffer at the caret position and moves the caret to
-- the end of the added text without scrolling it into view.
-- @param buffer A buffer.
-- @param text The text to add.
function add_text(buffer, text) end
---
-- Clears annotations from all lines.
-- @param buffer A buffer.
function annotation_clear_all(buffer) end
---
-- Appends string *text* to the end of the buffer without modifying any existing
-- selections or scrolling the text into view.
-- @param buffer A buffer.
-- @param text The text to append.
function append_text(buffer, text) end
---
-- Returns whether or not an autocompletion or user list is visible.
-- @param buffer A buffer.
-- @return bool
function auto_c_active(buffer) end
---
-- Cancels the displayed autocompletion or user list.
-- @param buffer A buffer.
function auto_c_cancel(buffer) end
---
-- Completes the current word with the one selected in an autocompletion list.
-- @param buffer A buffer.
function auto_c_complete(buffer) end
---
-- Returns the position where autocompletion started or where a user list was
-- shown.
-- @param buffer A buffer.
-- @return number
function auto_c_pos_start(buffer) end
---
-- Selects the first item that starts with string *prefix* in an autocompletion
-- or user list, using the case sensitivity setting `buffer.auto_c_ignore_case`.
-- @param buffer A buffer.
-- @param prefix The item in the list to select.
function auto_c_select(buffer, prefix) end
---
-- Displays an autocompletion list constructed from string *items* (whose items
-- are delimited by `buffer.auto_c_separator` characters) using *len_entered*
-- number of characters behind the caret as the prefix of the word to be
-- autocompleted.
-- The sorted order of *items* (`buffer.auto_c_order`) must have already been
-- defined.
-- @param buffer A buffer.
-- @param len_entered The number of characters before the caret used to provide
-- the context.
-- @param items The sorted string of words to show, separated by
-- `buffer.auto_c_separator` characters (initially spaces).
-- @see auto_c_separator
-- @see auto_c_order
function auto_c_show(buffer, len_entered, items) end
---
-- Allows the user to type any character in string set *chars* in order to
-- cancel an autocompletion or user list.
-- The default set is empty.
-- @param buffer A buffer.
-- @param chars The string of characters that cancel autocompletion. This string
-- is empty by default.
function auto_c_stops(buffer, chars) end
---
-- Un-indents the text on the selected lines.
-- @param buffer A buffer.
function back_tab(buffer) end
---
-- Starts a sequence of actions to be undone or redone as a single action.
-- May be nested.
-- @param buffer A buffer.
function begin_undo_action(buffer) end
---
-- Returns the position of the matching brace for the brace character at
-- position *pos*, taking nested braces into account, or `-1`.
-- The brace characters recognized are '(', ')', '[', ']', '{', '}', '<', and
-- '>' and must have the same style.
-- @param buffer A buffer.
-- @param pos The position of the brace in *buffer* to match.
-- @param max_re_style Must be `0`. Reserved for expansion.
-- @return number
function brace_match(buffer, pos, max_re_style) end
---
-- Returns whether or not there is an action to be redone.
-- @param buffer A buffer.
-- @return bool
function can_redo(buffer) end
---
-- Returns whether or not there is an action to be undone.
-- @param buffer A buffer.
-- @return bool
function can_undo(buffer) end
---
-- Cancels the active selection mode, autocompletion or user list, call tip,
-- etc.
-- @param buffer A buffer.
function cancel(buffer) end
---
-- Moves the caret left one character.
-- @param buffer A buffer.
function char_left(buffer) end
---
-- Moves the caret left one character, extending the selected text to the new
-- position.
-- @param buffer A buffer.
function char_left_extend(buffer) end
---
-- Moves the caret left one character, extending the rectangular selection to
-- the new position.
-- @param buffer A buffer.
function char_left_rect_extend(buffer) end
---
-- Moves the caret right one character.
-- @param buffer A buffer.
function char_right(buffer) end
---
-- Moves the caret right one character, extending the selected text to the new
-- position.
-- @param buffer A buffer.
function char_right_extend(buffer) end
---
-- Moves the caret right one character, extending the rectangular selection to
-- the new position.
-- @param buffer A buffer.
function char_right_rect_extend(buffer) end
---
-- Identifies the current horizontal caret position as the caret's preferred
-- horizontal position when moving between lines.
-- @param buffer A buffer.
-- @see caret_sticky
function choose_caret_x(buffer) end
---
-- Deletes the selected text or the character at the caret.
-- @param buffer A buffer.
function clear(buffer) end
---
-- Deletes the buffer's text.
-- @param buffer A buffer.
function clear_all(buffer) end
---
-- Clears all styling and folding information.
-- @param buffer A buffer.
function clear_document_style(buffer) end
---
-- Instructs the lexer to style and mark fold points in the range of text
-- between *start_pos* and *end_pos*.
-- If *end_pos* is `-1`, styles and marks to the end of the buffer.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to
-- process.
-- @param end_pos The end position of the range of text in *buffer* to process,
-- or `-1` to process from *start_pos* to the end of *buffer*.
function colorize(buffer, start_pos, end_pos) end
---
-- Converts all end of line characters to those in end of line mode *mode*.
-- @param buffer A buffer.
-- @param mode The end of line mode to convert to. Valid values are:
-- * `buffer.EOL_CRLF`
-- * `buffer.EOL_CR`
-- * `buffer.EOL_LF`
function convert_eols(buffer, mode) end
---
-- Copies the selected text to the clipboard.
-- Multiple selections are copied in order with no delimiters. Rectangular
-- selections are copied from top to bottom with end of line characters. Virtual
-- space is not copied.
-- @param buffer A buffer.
function copy(buffer) end
---
-- Copies the range of text between positions *start_pos* and *end_pos* to the
-- clipboard.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to copy.
-- @param end_pos The end position of the range of text in *buffer* to copy.
function copy_range(buffer, start_pos, end_pos) end
---
-- Copies string *text* to the clipboard.
-- @param buffer A buffer.
-- @param text The text to copy.
function copy_text(buffer, text) end
---
-- Returns the number of whole characters (taking multi-byte characters into
-- account) between positions *start_pos* and *end_pos*.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to start
-- counting at.
-- @param end_pos The end position of the range of text in *buffer* to stop
-- counting at.
-- @return number
function count_characters(buffer, start_pos, end_pos) end
---
-- Cuts the selected text to the clipboard.
-- Multiple selections are copied in order with no delimiters. Rectangular
-- selections are copied from top to bottom with end of line characters. Virtual
-- space is not copied.
-- @param buffer A buffer.
function cut(buffer) end
---
-- Deletes the range of text from the caret to the beginning of the current
-- line.
-- @param buffer A buffer.
function del_line_left(buffer) end
---
-- Deletes the range of text from the caret to the end of the current line.
-- @param buffer A buffer.
function del_line_right(buffer) end
---
-- Deletes the word to the left of the caret, including any leading non-word
-- characters.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function del_word_left(buffer) end
---
-- Deletes the word to the right of the caret, including any trailing non-word
-- characters.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function del_word_right(buffer) end
---
-- Deletes the word to the right of the caret, excluding any trailing non-word
-- characters.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function del_word_right_end(buffer) end
---
-- Deletes the character behind the caret if no text is selected.
-- Otherwise, deletes the selected text.
-- @param buffer A buffer.
function delete_back(buffer) end
---
-- Deletes the character behind the caret unless either the caret is at the
-- beginning of a line or text is selected.
-- If text is selected, deletes it.
-- @param buffer A buffer.
function delete_back_not_line(buffer) end
---
-- Deletes the range of text from position *pos* to *pos* + *length*.
-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to delete.
-- @param length The number of characters in the range of text to delete.
function delete_range(buffer, pos, length) end
---
-- Moves the caret to the end of the buffer.
-- @param buffer A buffer.
function document_end(buffer) end
---
-- Moves the caret to the end of the buffer, extending the selected text to the
-- new position.
-- @param buffer A buffer.
function document_end_extend(buffer) end
---
-- Moves the caret to the beginning of the buffer.
-- @param buffer A buffer.
function document_start(buffer) end
---
-- Moves the caret to the beginning of the buffer, extending the selected text
-- to the new position.
-- @param buffer A buffer.
function document_start_extend(buffer) end
---
-- Drops existing selection number *n*.
-- @param buffer A buffer.
-- @param n The number of the existing selection.
function drop_selection_n(buffer, n) end
---
-- Toggles `buffer.overtype`.
-- @param buffer A buffer.
function edit_toggle_overtype(buffer) end
---
-- Deletes the undo and redo history.
-- @param buffer A buffer.
function empty_undo_buffer(buffer) end
---
-- Ends a sequence of actions to be undone or redone as a single action.
-- @param buffer A buffer.
function end_undo_action(buffer) end
---
-- Clears EOL annotations from all lines.
-- @param buffer A buffer.
function eol_annotation_clear_all(buffer) end
---
-- Returns the position of column number *column* on line number *line* (taking
-- tab and multi-byte characters into account), or the position at the end of
-- line *line*.
-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @param column The column number to use.
function find_column(buffer, line, column) end
---
-- Returns the current line's text and the caret's position on that line.
-- @param buffer A buffer.
-- @return string, number
function get_cur_line(buffer) end
---
-- Returns the line number of the last line after line number *line* whose fold
-- level is greater than *level*.
-- If *level* is `-1`, returns the level of *line*.
-- @param buffer A buffer.
-- @param line The line number in *buffer* of a header line.
-- @param level The fold level, or `-1` for the level of *line*.
function get_last_child(buffer, line, level) end
---
-- Returns the text on line number *line*, including end of line characters.
-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @return string, number
function get_line(buffer, line) end
---
-- Returns the selected text.
-- Multiple selections are included in order with no delimiters. Rectangular
-- selections are included from top to bottom with end of line characters.
-- Virtual space is not included.
-- @param buffer A buffer.
-- @return string, number
function get_sel_text(buffer) end
---
-- Returns the buffer's text.
-- @param buffer A buffer.
function get_text(buffer) end
---
-- Moves the caret to the beginning of line number *line* and scrolls it into
-- view, regardless of whether or not *line* is hidden.
-- @param buffer A buffer.
-- @param line The line number in *buffer* to go to.
function goto_line(buffer, line) end
---
-- Moves the caret to position *pos* and scrolls it into view.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to go to.
function goto_pos(buffer, pos) end
---
-- Moves the caret to the beginning of the current line.
-- @param buffer A buffer.
function home(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line.
-- @param buffer A buffer.
function home_display(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line, extending the
-- selected text to the new position.
-- @param buffer A buffer.
function home_display_extend(buffer) end
---
-- Moves the caret to the beginning of the current line, extending the selected
-- text to the new position.
-- @param buffer A buffer.
function home_extend(buffer) end
---
-- Moves the caret to the beginning of the current line, extending the
-- rectangular selection to the new position.
-- @param buffer A buffer.
function home_rect_extend(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line or, if already
-- there, to the beginning of the actual line.
-- @param buffer A buffer.
function home_wrap(buffer) end
---
-- Like `buffer.home_wrap()`, but extends the selected text to the new position.
-- @param buffer A buffer.
function home_wrap_extend(buffer) end
---
-- Returns a bit-mask that represents which indicators are on at position *pos*.
-- The first bit is set if indicator 1 is on, the second bit for indicator 2,
-- etc.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get indicators at.
-- @return number
function indicator_all_on_for(buffer, pos) end
---
-- Clears indicator number `buffer.indicator_current` over the range of text
-- from position *pos* to *pos* + *length*.
-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to clear
-- indicators over.
-- @param length The number of characters in the range of text to clear
-- indicators over.
function indicator_clear_range(buffer, pos, length) end
---
-- Returns the next boundary position, starting from position *pos*, of
-- indicator number *indicator*, in the range of `1` to `32`.
-- Returns `1` if *indicator* was not found.
-- @param buffer A buffer.
-- @param indicator An indicator number in the range of `1` to `32`.
-- @param pos The position in *buffer* of the indicator.
function indicator_end(buffer, indicator, pos) end
---
-- Fills the range of text from position *pos* to *pos* + *length* with
-- indicator number `buffer.indicator_current`.
-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to set
-- indicators over.
-- @param length The number of characters in the range of text to set indicators
-- over.
function indicator_fill_range(buffer, pos, length) end
---
-- Returns the previous boundary position, starting from position *pos*, of
-- indicator number *indicator*, in the range of `1` to `32`.
-- Returns `1` if *indicator* was not found.
-- @param buffer A buffer.
-- @param indicator An indicator number in the range of `1` to `32`.
-- @param pos The position in *buffer* of the indicator.
function indicator_start(buffer, indicator, pos) end
---
-- Inserts string *text* at position *pos*, removing any selections.
-- If *pos* is `-1`, inserts *text* at the caret position.
-- If the caret is after the *pos*, it is moved appropriately, but not scrolled
-- into view.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to insert text at, or `-1` for the
-- current position.
-- @param text The text to insert.
function insert_text(buffer, pos, text) end
---
-- Returns whether or not the the positions *start_pos* and *end_pos* are at
-- word boundaries.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to
-- check for a word boundary at.
-- @param end_pos The end position of the range of text in *buffer* to check for
-- a word boundary at.
function is_range_word(buffer, start_pos, end_pos) end
---
-- Copies the current line to the clipboard.
-- @param buffer A buffer.
function line_copy(buffer) end
---
-- Cuts the current line to the clipboard.
-- @param buffer A buffer.
function line_cut(buffer) end
---
-- Deletes the current line.
-- @param buffer A buffer.
function line_delete(buffer) end
---
-- Moves the caret down one line.
-- @param buffer A buffer.
function line_down(buffer) end
---
-- Moves the caret down one line, extending the selected text to the new
-- position.
-- @param buffer A buffer.
function line_down_extend(buffer) end
---
-- Moves the caret down one line, extending the rectangular selection to the new
-- position.
-- @param buffer A buffer.
function line_down_rect_extend(buffer) end
---
-- Duplicates the current line on a new line below.
-- @param buffer A buffer.
function line_duplicate(buffer) end
---
-- Moves the caret to the end of the current line.
-- @param buffer A buffer.
function line_end(buffer) end
---
-- Moves the caret to the end of the current wrapped line.
-- @param buffer A buffer.
function line_end_display(buffer) end
---
-- Moves the caret to the end of the current wrapped line, extending the
-- selected text to the new position.
-- @param buffer A buffer.
function line_end_display_extend(buffer) end
---
-- Moves the caret to the end of the current line, extending the selected text
-- to the new position.
-- @param buffer A buffer.
function line_end_extend(buffer) end
---
-- Moves the caret to the end of the current line, extending the rectangular
-- selection to the new position.
-- @param buffer A buffer.
function line_end_rect_extend(buffer) end
---
-- Moves the caret to the end of the current wrapped line or, if already there,
-- to the end of the actual line.
-- @param buffer A buffer.
function line_end_wrap(buffer) end
---
-- Like `buffer.line_end_wrap()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function line_end_wrap_extend(buffer) end
---
-- Returns the line number of the line that contains position *pos*.
-- Returns `1` if *pos* is less than 1 or `buffer.line_count` if *pos* is
-- greater than `buffer.length + 1`.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the line number of.
-- @return number
function line_from_position(buffer, pos) end
---
-- Returns the number of bytes on line number *line*, including end of line
-- characters.
-- To get line length excluding end of line characters, use
-- `buffer.line_end_position[line] - buffer.position_from_line(line)`.
-- @param buffer A buffer.
-- @param line The line number in *buffer* to get the length of.
-- @return number
function line_length(buffer, line) end
---
-- Reverses the order of the selected lines.
-- @param buffer A buffer.
function line_reverse(buffer) end
---
-- Swaps the current line with the previous one.
-- @param buffer A buffer.
function line_transpose(buffer) end
---
-- Moves the caret up one line.
-- @param buffer A buffer.
function line_up(buffer) end
---
-- Moves the caret up one line, extending the selected text to the new position.
-- @param buffer A buffer.
function line_up_extend(buffer) end
---
-- Moves the caret up one line, extending the rectangular selection to the new
-- position.
-- @param buffer A buffer.
function line_up_rect_extend(buffer) end
---
-- Joins the lines in the target range, inserting spaces between the words
-- joined at line boundaries.
-- @param buffer A buffer.
function lines_join(buffer) end
---
-- Splits the lines in the target range into lines *width* pixels wide.
-- If *width* is `0`, splits the lines in the target range into lines as wide as
-- the view.
-- @param buffer A buffer.
-- @param width The pixel width to split lines at. When `0`, uses the width of
-- the view.
function lines_split(buffer, pixel_width) end
---
-- Converts the selected text to lower case letters.
-- @param buffer A buffer.
function lower_case(buffer) end
---
-- Clears all text in text margins.
-- @param buffer A buffer.
function margin_text_clear_all(buffer) end
---
-- Adds marker number *marker*, in the range of `1` to `32`, to line number
-- *line*, returning the added marker's handle which can be used in
-- `buffer.marker_delete_handle()` and `buffer.marker_line_from_handle()`, or
-- `-1` if *line* is invalid.
-- @param buffer A buffer.
-- @param line The line number to add the marker on.
-- @param marker The marker number in the range of `1` to `32` to add.
-- @return number
function marker_add(buffer, line, marker) end
---
-- Adds the markers specified in marker bit-mask *marker_mask* to line number
-- *line*.
-- The first bit is set to add marker number 1, the second bit for marker number
-- 2, and so on up to marker number 32.
-- @param buffer A buffer.
-- @param line The line number to add the markers on.
-- @param marker_mask The mask of markers to set. Set the first bit to set
-- marker 1, the second bit for marker 2 and so on.
function marker_add_set(buffer, line, marker_mask) end
---
-- Deletes marker number *marker*, in the range of `1` to `32`, from line number
-- *line*. If *marker* is `-1`, deletes all markers from *line*.
-- @param buffer A buffer.
-- @param line The line number to delete the marker on.
-- @param marker The marker number in the range of `1` to `32` to delete from
-- *line*, or `-1` to delete all markers from the line.
function marker_delete(buffer, line, marker) end
---
-- Deletes marker number *marker*, in the range of `1` to `32`, from any line
-- that has it.
-- If *marker* is `-1`, deletes all markers from all lines.
-- @param buffer A buffer.
-- @param marker The marker number in the range of `1` to `32` to delete from
-- all lines, or `-1` to delete all markers from all lines.
function marker_delete_all(buffer, marker) end
---
-- Deletes the marker with handle *handle* returned by `buffer.marker_add()`.
-- @param buffer A buffer.
-- @param handle The identifier of a marker returned by `buffer.marker_add()`.
function marker_delete_handle(buffer, handle) end
---
-- Returns a bit-mask that represents the markers on line number *line*.
-- The first bit is set if marker number 1 is present, the second bit for marker
-- number 2, and so on.
-- @param buffer A buffer.
-- @param line The line number to get markers on.
-- @return number
function marker_get(buffer, line) end
---
-- Returns the handle of the *n*th marker on line number *line*, or `-1` if no
-- such marker exists.
-- @param buffer A buffer.
-- @param line The line number to get markers on.
-- @param n The marker to get the handle of.
function marker_handle_from_line(buffer, line, n) end
---
-- Returns the line number of the line that contains the marker with handle
-- *handle* (returned `buffer.marker_add()`), or `-1` if the line was not found.
-- @param buffer A buffer.
-- @param handle The identifier of a marker returned by `buffer.marker_add()`.
-- @return number
function marker_line_from_handle(buffer, handle) end
---
-- Returns the first line number, starting at line number *line*, that contains
-- all of the markers represented by marker bit-mask *marker_mask*.
-- Returns `-1` if no line was found.
-- The first bit is set if marker 1 is set, the second bit for marker 2, etc.,
-- up to marker 32.
-- @param buffer A buffer.
-- @param line The start line to search from.
-- @param marker_mask The mask of markers to find. Set the first bit to find
-- marker 1, the second bit for marker 2, and so on.
-- @return number
function marker_next(buffer, line, marker_mask) end
---
-- Returns the number of the *n*th marker on line number *line*, or `-1` if no
-- such marker exists.
-- @param buffer A buffer.
-- @param line The line number to get markers on.
-- @param n The marker to get the number of.
function marker_number_from_line(buffer, line, n) end
---
-- Returns the last line number, before or on line number *line*, that contains
-- all of the markers represented by marker bit-mask *marker_mask*.
-- Returns `-1` if no line was found.
-- The first bit is set if marker 1 is set, the second bit for marker 2, etc.,
-- up to marker 32.
-- @param buffer A buffer.
-- @param line The start line to search from.
-- @param marker_mask The mask of markers to find. Set the first bit to find
-- marker 1, the second bit for marker 2, and so on.
-- @return number
function marker_previous(buffer, line, marker_mask) end
---
-- Moves the caret into view if it is not already, removing any selections.
-- @param buffer A buffer.
function move_caret_inside_view(buffer) end
---
-- Shifts the selected lines down one line.
-- @param buffer A buffer.
function move_selected_lines_down(buffer) end
---
-- Shifts the selected lines up one line.
-- @param buffer A buffer.
function move_selected_lines_up(buffer) end
---
-- Adds to the set of selections each occurrence of the main selection within
-- the target range.
-- If there is no selected text, the current word is used.
-- @param buffer A buffer.
function multiple_select_add_each(buffer) end
---
-- Adds to the set of selections the next occurrence of the main selection
-- within the target range, makes that occurrence the new main selection, and
-- scrolls it into view.
-- If there is no selected text, the current word is used.
-- @param buffer A buffer.
function multiple_select_add_next(buffer) end
---
-- Returns the name of style number *style*, which is between `1` and `256`.
-- @param buffer A buffer.
-- @param style The style number between `1` and `256` to get the name of.
-- @return string
function name_of_style(buffer, style) end
---
-- Types a new line at the caret position according to [`buffer.eol_mode`]().
-- @param buffer A buffer.
function new_line(buffer) end
---
-- Moves the caret down one page.
-- @param buffer A buffer.
function page_down(buffer) end
---
-- Moves the caret down one page, extending the selected text to the new
-- position.
-- @param buffer A buffer.
function page_down_extend(buffer) end
---
-- Moves the caret down one page, extending the rectangular selection to the new
-- position.
-- @param buffer A buffer.
function page_down_rect_extend(buffer) end
---
-- Moves the caret up one page.
-- @param buffer A buffer.
function page_up(buffer) end
---
-- Moves the caret up one page, extending the selected text to the new position.
-- @param buffer A buffer.
function page_up_extend(buffer) end
---
-- Moves the caret up one page, extending the rectangular selection to the new
-- position.
-- @param buffer A buffer.
function page_up_rect_extend(buffer) end
---
-- Moves the caret down one paragraph.
-- Paragraphs are surrounded by one or more blank lines.
-- @param buffer A buffer.
function para_down(buffer) end
---
-- Moves the caret down one paragraph, extending the selected text to the new
-- position.
-- Paragraphs are surrounded by one or more blank lines.
-- @param buffer A buffer.
function para_down_extend(buffer) end
---
-- Moves the caret up one paragraph.
-- Paragraphs are surrounded by one or more blank lines.
-- @param buffer A buffer.
function para_up(buffer) end
---
-- Moves the caret up one paragraph, extending the selected text to the new
-- position.
-- Paragraphs are surrounded by one or more blank lines.
-- @param buffer A buffer.
function para_up_extend(buffer) end
---
-- Pastes the clipboard's contents into the buffer, replacing any selected text
-- according to `buffer.multi_paste`.
-- @param buffer A buffer.
function paste(buffer) end
---
-- Returns the position of the character after position *pos* (taking multi-byte
-- characters into account), or `buffer.length + 1` if there is no character
-- after *pos*.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the position after from.
function position_after(buffer, pos) end
---
-- Returns the position of the character before position *pos* (taking
-- multi-byte characters into account), or `1` if there is no character before
-- *pos*.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the position before from.
-- @return number
function position_before(buffer, pos) end
---
-- Returns the position at the beginning of line number *line*.
-- Returns `-1` if *line* is greater than `buffer.line_count + 1`.
-- @param buffer A buffer.
-- @param line The line number in *buffer* to get the beginning position for.
-- @return number
function position_from_line(buffer, line) end
---
-- Returns the position *n* characters before or after position *pos* (taking
-- multi-byte characters into account).
-- Returns `1` if the position is less than 1 or greater than
-- `buffer.length + 1`.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the relative position from.
-- @param n The relative number of characters to get the position for. A
-- negative number indicates a position before while a positive number
-- indicates a position after.
-- @return number
function position_relative(buffer, pos, n) end
---
-- Redoes the next undone action.
-- @param buffer A buffer.
function redo(buffer) end
---
-- Replaces the selected text with string *text*, scrolling the caret into view.
-- @param buffer A buffer.
-- @param text The text to replace the selected text with.
function replace_sel(buffer, text) end
---
-- Replaces the text in the target range with string *text* sans modifying any
-- selections or scrolling the view.
-- Setting the target and calling this function with an empty string is another
-- way to delete text.
-- @param buffer A buffer.
-- @param text The text to replace the target range with.
-- @return number
function replace_target(buffer, text) end
---
-- Replaces the text in the target range with string *text* but first replaces
-- any "\d" sequences with the text of capture number *d* from the regular
-- expression (or the entire match for *d* = 0), and then returns the
-- replacement text's length.
-- @param buffer A buffer.
-- @param text The text to replace the target range with.
-- @return number
function replace_target_re(buffer, text) end
---
-- Designates the next additional selection to be the main selection.
-- @param buffer A buffer.
function rotate_selection(buffer) end
---
-- Anchors the position that `buffer.search_next()` and `buffer.search_prev()`
-- start at to the beginning of the current selection or caret position.
-- @param buffer A buffer.
function search_anchor(buffer) end
---
-- Searches for the first occurrence of string *text* in the target range
-- bounded by `buffer.target_start` and `buffer.target_end` using search flags
-- `buffer.search_flags` and, if found, sets the new target range to that
-- occurrence, returning its position or `-1` if *text* was not found.
-- @param buffer A buffer.
-- @param text The text to search the target range for.
-- @return number
-- @see search_flags
function search_in_target(buffer, text) end
---
-- Searches for and selects the first occurrence of string *text* starting at
-- the search anchor using search flags *flags*, returning that occurrence's
-- position or `-1` if *text* was not found.
-- Selected text is not scrolled into view.
-- @param buffer A buffer.
-- @param flags The search flags to use. See `buffer.search_flags`.
-- @param text The text to search for.
-- @return number
-- @see search_flags
function search_next(buffer, flags, text) end
---
-- Searches for and selects the last occurrence of string *text* before the
-- search anchor using search flags *flags*, returning that occurrence's
-- position or `-1` if *text* was not found.
-- @param buffer A buffer.
-- @param flags The search flags to use. See `buffer.search_flags`.
-- @param text The text to search for.
-- @return number
-- @see search_flags
function search_prev(buffer, flags, text) end
---
-- Selects all of the buffer's text without scrolling the view.
-- @param buffer A buffer.
function select_all(buffer) end
---
-- Duplicates the selected text to its right.
-- If no text is selected, duplicates the current line on a new line below.
-- @param buffer A buffer.
function selection_duplicate(buffer) end
---
-- Resets `buffer.word_chars`, `buffer.whitespace_chars`, and
-- `buffer.punctuation_chars` to their respective defaults.
-- @param buffer A buffer.
-- @see word_chars
-- @see whitespace_chars
-- @see punctuation_chars
function set_chars_default(buffer) end
---
-- Moves the caret to position *pos* without scrolling the view and removes any
-- selections.
-- @param buffer A buffer
-- @param pos The position in *buffer* to move to.
function set_empty_selection(buffer, pos) end
---
-- Indicates the buffer has no unsaved changes.
-- @param buffer A buffer.
function set_save_point(buffer) end
---
-- Selects the range of text between positions *start_pos* and *end_pos*,
-- scrolling the selected text into view.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to
-- select. If negative, it means the end of the buffer.
-- @param end_pos The end position of the range of text in *buffer* to select.
-- If negative, it means remove any selection (i.e. set the `anchor` to the
-- same position as `current_pos`).
function set_sel(buffer, start_pos, end_pos) end
---
-- Selects the range of text between positions *start_pos* to *end_pos*,
-- removing all other selections.
-- @param buffer A buffer.
-- @param end_pos The caret position of the range of text to select in *buffer*.
-- @param start_pos The anchor position of the range of text to select in
-- *buffer*.
function set_selection(buffer, end_pos, start_pos) end
---
-- Assigns style number *style*, in the range from `1` to `256`, to the next
-- *length* characters, starting from the current styling position, and
-- increments the styling position by *length*.
-- [`buffer:start_styling`]() should be called before `buffer:set_styling()`.
-- @param buffer A buffer.
-- @param length The number of characters to style.
-- @param style The style number to set.
function set_styling(buffer, length, style) end
---
-- Defines the target range's beginning and end positions as *start_pos* and
-- *end_pos*, respectively.
-- @param buffer A buffer.
-- @param start_pos The position of the beginning of the target range.
-- @param end_pos The position of the end of the target range.
function set_target_range(buffer, start_pos, end_pos) end
---
-- Replaces the buffer's text with string *text*.
-- @param buffer A buffer.
-- @param text The text to set.
function set_text(buffer, text) end
---
-- Begins styling at position *position* with styling bit-mask *style_mask*.
-- *style_mask* specifies which style bits can be set with
-- `buffer.set_styling()`.
-- @param buffer A buffer.
-- @param position The position in *buffer* to start styling at.
-- @param unused Unused number. `0` can be safely used.
-- @usage buffer:start_styling(1, 0)
-- @see set_styling
function start_styling(buffer, position, unused) end
---
-- Moves the caret to the bottom of the page or, if already there, down one
-- page.
-- @param buffer A buffer.
function stuttered_page_down(buffer) end
---
-- Like `buffer.stuttered_page_down()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function stuttered_page_down_extend(buffer) end
---
-- Moves the caret to the top of the page or, if already there, up one page.
-- @param buffer A buffer.
function stuttered_page_up(buffer) end
---
-- Like `buffer.stuttered_page_up()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function stuttered_page_up_extend(buffer) end
---
-- Swaps the main selection's beginning and end positions.
-- @param buffer A buffer.
function swap_main_anchor_caret(buffer) end
---
-- Indents the text on the selected lines or types a Tab character ("\t") at
-- the caret position.
-- @param buffer A buffer.
function tab(buffer) end
---
-- Defines the target range's beginning and end positions as the beginning and
-- end positions of the main selection, respectively.
-- @param buffer A buffer.
function target_from_selection(buffer) end
---
-- Defines the target range's beginning and end positions as the beginning and
-- end positions of the document, respectively.
-- @param buffer A buffer.
function target_whole_document(buffer) end
---
-- Cycles between `buffer.caret_sticky` option settings `buffer.CARETSTICKY_ON`
-- and `buffer.CARETSTICKY_OFF`.
-- @param buffer A buffer.
-- @see caret_sticky
function toggle_caret_sticky(buffer) end
---
-- Undoes the most recent action.
-- @param buffer A buffer.
function undo(buffer) end
---
-- Converts the selected text to upper case letters.
-- @param buffer A buffer.
function upper_case(buffer) end
---
-- Displays a user list identified by list identifier number *id* and
-- constructed from string *items* (whose items are delimited by
-- `buffer.auto_c_separator` characters).
-- The sorted order of *items* (`buffer.auto_c_order`) must have already been
-- defined. When the user selects an item, *id* is sent in a
-- `USER_LIST_SELECTION` event along with the selection.
-- @param buffer A buffer.
-- @param id The list identifier number greater than zero to use.
-- @param items The sorted string of words to show, separated by
-- `buffer.auto_c_separator` characters (initially spaces).
-- @see _SCINTILLA.next_user_list_type
-- @see events.USER_LIST_SELECTION
function user_list_show(buffer, id, items) end
---
-- Moves the caret to the first visible character on the current line or, if
-- already there, to the beginning of the current line.
-- @param buffer A buffer.
function vc_home(buffer) end
---
-- Moves the caret to the first visible character on the current wrapped line
-- or, if already there, to the beginning of the current wrapped line.
-- @param buffer A buffer.
function vc_home_display(buffer) end
---
-- Like `buffer.vc_home_display()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function vc_home_display_extend(buffer) end
---
-- Like `buffer.vc_home()`, but extends the selected text to the new position.
-- @param buffer A buffer.
function vc_home_extend(buffer) end
---
-- Like `buffer.vc_home()`, but extends the rectangular selection to the new
-- position.
-- @param buffer A buffer.
function vc_home_rect_extend(buffer) end
---
-- Moves the caret to the first visible character on the current wrapped line
-- or, if already there, to the beginning of the actual line.
-- @param buffer A buffer.
function vc_home_wrap(buffer) end
---
-- Like `buffer.vc_home_wrap()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function vc_home_wrap_extend(buffer) end
---
-- Returns the position of the end of the word at position *pos*.
-- `buffer.word_chars` contains the set of characters that constitute words. If
-- *pos* has a non-word character to its right and *only_word_chars* is `false`,
-- returns the first word character's position.
-- @param buffer A buffer.
-- @param pos The position in *buffer* of the word.
-- @param only_word_chars If `true`, stops searching at the first non-word
-- character in the search direction. Otherwise, the first character in the
-- search direction sets the type of the search as word or non-word and the
-- search stops at the first non-matching character. Searches are also
-- terminated by the start or end of the buffer.
function word_end_position(buffer, pos, only_word_chars) end
---
-- Moves the caret left one word.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_left(buffer) end
---
-- Moves the caret left one word, positioning it at the end of the previous
-- word.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_left_end(buffer) end
---
-- Like `buffer.word_left_end()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function word_left_end_extend(buffer) end
---
-- Moves the caret left one word, extending the selected text to the new
-- position.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_left_extend(buffer) end
---
-- Moves the caret to the previous part of the current word.
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_part_left(buffer) end
---
-- Moves the caret to the previous part of the current word, extending the
-- selected text to the new position.
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_part_left_extend(buffer) end
---
-- Moves the caret to the next part of the current word.
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_part_right(buffer) end
---
-- Moves the caret to the next part of the current word, extending the selected
-- text to the new position.
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_part_right_extend(buffer) end
---
-- Moves the caret right one word.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_right(buffer) end
---
-- Moves the caret right one word, positioning it at the end of the current
-- word.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_right_end(buffer) end
---
-- Like `buffer.word_right_end()`, but extends the selected text to the new
-- position.
-- @param buffer A buffer.
function word_right_end_extend(buffer) end
---
-- Moves the caret right one word, extending the selected text to the new
-- position.
-- `buffer.word_chars` contains the set of characters that constitute words.
-- @param buffer A buffer.
function word_right_extend(buffer) end
---
-- Returns the position of the beginning of the word at position *pos*.
-- `buffer.word_chars` contains the set of characters that constitute words. If
-- *pos* has a non-word character to its left and *only_word_chars* is `false`,
-- returns the last word character's position.
-- @param buffer A buffer.
-- @param pos The position in *buffer* of the word.
-- @param only_word_chars If `true`, stops searching at the first non-word
-- character in the search direction. Otherwise, the first character in the
-- search direction sets the type of the search as word or non-word and the
-- search stops at the first non-matching character. Searches are also
-- terminated by the start or end of the buffer.
function word_start_position(buffer, pos, only_word_chars) end
-- External functions.
---
-- Deletes the buffer.
-- **Do not call this function.** Call `buffer:close()` instead. Emits a
-- `BUFFER_DELETED` event.
-- @param buffer A buffer.
-- @see events.BUFFER_DELETED
function delete(buffer) end
---
-- Creates a new buffer, displays it in the current view, and returns it.
-- Emits a `BUFFER_NEW` event.
-- @return the new buffer.
-- @class function
-- @see events.BUFFER_NEW
function new() end
---
-- Returns the range of text between positions *start_pos* and *end_pos*.
-- @param buffer A buffer.
-- @param start_pos The start position of the range of text to get in *buffer*.
-- @param end_pos The end position of the range of text to get in *buffer*.
function text_range(buffer, start_pos, end_pos) end
---
-- Returns the style number associated with string *style_name*, or
-- `view.STYLE_DEFAULT` if *style_name* is not in use.
-- @param buffer A buffer.
-- @param string The style name to get the number of.
-- @return style number, between `1` and `256`.
-- @see name_of_style
function style_of_name(buffer, style_name) end
---
-- Reloads the buffer's file contents, discarding any changes.
-- Emits `FILE_BEFORE_RELOAD` and `FILE_AFTER_RELOAD` events if the buffer is
-- the current one.
-- @param buffer A buffer.
-- @name reload
function reload(buffer) end
---
-- Saves the buffer to its file.
-- Emits `FILE_BEFORE_SAVE` and `FILE_AFTER_SAVE` events.
-- @param buffer A buffer.
-- @name save
function save(buffer) end
---
-- Saves the buffer to file *filename* or the user-specified filename.
-- Emits a `FILE_AFTER_SAVE` event.
-- @param buffer A buffer.
-- @param filename Optional new filepath to save the buffer to. If `nil`, the
-- user is prompted for one.
-- @name save_as
function save_as(buffer, filename) end
---
-- Closes the buffer, prompting the user to continue if there are unsaved
-- changes (unless *force* is `true`), and returns `true` if the buffer was
-- closed.
-- @param buffer A buffer.
-- @param force Optional flag that discards unsaved changes without prompting
-- the user. The default value is `false`.
-- @return `true` if the buffer was closed; `nil` otherwise.
-- @name close
function close(buffer, force) end
---
-- Converts the current buffer's contents to encoding *encoding*.
-- @param buffer A buffer.
-- @param encoding The string encoding to set. Valid encodings are ones that GNU
-- iconv accepts. If `nil`, assumes a binary encoding.
-- @usage buffer:set_encoding('CP1252')
function set_encoding(buffer, encoding) end
---
-- Returns the buffer's lexer name.
-- If *current* is `true`, returns the name of the lexer under the caret in
-- a multiple-language lexer.
-- @param buffer A buffer.
-- @param current Whether or not to get the lexer at the current caret position
-- in multi-language lexers. The default is `false` and returns the parent
-- lexer.
function get_lexer(buffer, current) end
---
-- Associates string lexer name *name* or the auto-detected lexer name with the
-- buffer and then loads the appropriate language module if that module exists.
-- @param buffer A buffer.
-- @param name Optional string lexer name to set. If `nil`, attempts to
-- auto-detect the buffer's lexer.
-- @usage buffer:set_lexer('lexer_name')
function set_lexer(buffer, name) end
-- Unused Fields.
-- * accessibility
-- * annotation_style_offset
-- * annotation_styles
-- * automatic_fold
-- * call_tip_back
-- * call_tip_fore
-- * character_category_optimization
-- * character_pointer
-- * code_page
-- * command_events
-- * control_char_symbol
-- * direct_function
-- * direct_pointer
-- * distance_to_secondary_styles
-- * doc_pointer
-- * eol_annotation_style_offset
-- * focus
-- * font_quality
-- * gap_position
-- * hotspot_active_underline
-- * hotspot_single_line
-- * identifier
-- * identifiers
-- * ime_interaction
-- * indic_flags
-- * indicator_value
-- * key_words
-- * layout_cache
-- * lexer
-- * lexer_language
-- * line_character_index
-- * line_end_types_active
-- * line_end_types_allowed
-- * line_end_types_supported
-- * line_state
-- * margin_style_offset
-- * margin_styles
-- * max_line_state
-- * mod_event_mask
-- * mouse_down_captures
-- * paste_convert_endings
-- * phases_draw
-- * position_cache
-- * primary_style_from_style
-- * print_color_mode
-- * print_magnification
-- * print_wrap_mode
-- * status
-- * style_character_set
-- * style_from_sub_style
-- * style_hotspot
-- * style_size_fractional
-- * style_weight
-- * sub_style_bases
-- * sub_styles_length
-- * sub_styles_start
-- * tab_minimum_width
-- * technology
-- * two_phase_draw
-- * undo_collection
-- * INDICATOR_CONTAINER
-- * MOD_NORM
-- * CP_UTF8
-- * LASTSTEPINUNDOREDO
-- * MAX_MARGIN
-- * MODEVENTMASKALL
-- * MOD_BEFOREDELETE
-- * MOD_BEFOREINSERT
-- * MOD_CHANGEANNOTATION
-- * MOD_CHANGEFOLD
-- * MOD_CHANGEINDICATOR
-- * MOD_CHANGELINESTATE
-- * MOD_CHANGEMARGIN
-- * MOD_CHANGEMARKER
-- * MOD_CHANGESTYLE
-- * MOD_CONTAINER
-- * MOD_DELETETEXT
-- * MOD_INSERTCHECK
-- * MOD_INSERTTEXT
-- * MOD_LEXERSTATE
-- * MULTILINEUNDOREDO
-- * MULTISTEPUNDOREDO
-- * PERFORMED_REDO
-- * PERFORMED_UNDO
-- * PERFORMED_USER
-- * STARTACTION
-- * STYLE_LASTPREDEFINED
-- Unused Functions.
-- * add_ref_document
-- * add_styled_text
-- * add_tab_stop
-- * add_undo_action
-- * allocate
-- * allocate_extended_styles
-- * allocate_line_character_index
-- * allocate_sub_styles
-- * assign_cmd_key
-- * brace_match_next
-- * buffered_draw
-- * can_paste
-- * change_insertion
-- * change_lexer_state
-- * char_position_from_point
-- * char_position_from_point_close
-- * character_category_optimization
-- * clear_all_cmd_keys
-- * clear_cmd_key
-- * clear_selections
-- * clear_tab_stops
-- * copy_allow_line
-- * count_code_units
-- * create_document
-- * create_loader
-- * describe_key_word_sets
-- * describe_property
-- * description_of_style
-- * encoded_from_utf8
-- * expand_children
-- * find_indicator_flash
-- * find_indicator_hide
-- * find_indicator_show
-- * find_text
-- * form_feed
-- * format_range
-- * free_sub_styles
-- * get_hotspot_active_back
-- * get_hotspot_active_fore
-- * get_line_sel_end_position
-- * get_line_sel_start_position
-- * get_next_tab_stop
-- * get_range_pointer
-- * get_styled_text
-- * grab_focus
-- * hide_selection
-- * index_position_from_line
-- * indicator_value_at
-- * line_from_index_position
-- * load_lexer_library
-- * mouse_wheel_captures
-- * named_styles
-- * null
-- * point_x_from_position
-- * point_y_from_position
-- * position_from_point
-- * position_from_point_close
-- * position_relative_code_units
-- * private_lexer_call
-- * property_names
-- * property_type
-- * release_all_extended_styles
-- * release_document
-- * release_line_character_index
-- * set_hotspot_active_back
-- * set_hotspot_active_fore
-- * set_length_for_encode
-- * set_styling_ex
-- * start_record
-- * stop_record
-- * tags_of_style
-- * target_as_utf8
-- * use_pop_up
|