about summary refs log tree commit diff stats
path: root/js/games/nluqo.github.io/~bh/v3ch1/fsm.html
blob: 278984a3dd8b3322a2c46eef304798158b18a7e4 (plain) (blame)
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
<HTML>
<HEAD>
<TITLE>Computer Science Logo Style vol 3 ch 1: Automata Theory</TITLE>
</HEAD>
<BODY>
<CITE>Computer Science Logo Style</CITE> volume 3:
<CITE>Beyond Programming</CITE> 2/e Copyright (C) 1997 MIT
<H1>Automata Theory</H1>

<TABLE width="100%"><TR><TD>
<IMG SRC="../csls3.jpg" ALT="cover photo">
<TD><TABLE>
<TR><TD align="right"><CITE><A HREF="http://www.cs.berkeley.edu/~bh/">Brian
Harvey</A><BR>University of California, Berkeley</CITE>
<TR><TD align="right"><BR>
<TR><TD align="right"><A HREF="../pdf/v3ch01.pdf">Download PDF version</A>
<TR><TD align="right"><A HREF="../v3-toc2.html">Back to Table of Contents</A>
<TR><TD align="right"><A HREF="../v3ch0/v3ch0.html"><STRONG>BACK</STRONG></A>
chapter thread <A HREF="../v3ch2/v3ch2.html"><STRONG>NEXT</STRONG></A>
<TR><TD align="right"><A HREF="https://mitpress.mit.edu/books/computer-science-logo-style-second-edition-volume-3">MIT
Press web page for <CITE>Computer Science Logo Style</CITE></A>
</TABLE></TABLE>

<HR><P>Program file for this chapter: <A HREF="fsm.lg"><CODE>fsm</CODE></A>



<P>As I explained in the preface to the first volume, one of my purposes in
writing this series of books has been to urge computer hobbyists away from
the view of computer expertise as the knowledge of obscure characteristics
of some particular computer--how to program it in machine language, what
magic numbers can be found where in its memory, how to overcome the copy
protection schemes on its disks, and so on.  The trouble with this sort of
machine-specific expertise is that it becomes obsolete when your favorite
computer does.  From my point of view, one of the virtues of Logo as a
programming language is that its high level data structures direct your
attention away from questions about what goes where in memory,
allowing you to focus instead on a more abstract description of your problem.

<P>Automata theory is a further step in abstracting your attention away from any
particular kind of computer or particular programming language.  In automata
theory we consider a <EM>mathematical model</EM> of computing.  Such a model
strips the computational machinery--the &quot;programming language&quot;--down to
the bare minimum, so that it's easy to manipulate these
theoretical machines
(there are several such models, for different purposes, as you'll soon see)
mathematically to prove things about their capabilities.  For the most part,
these mathematical models are not used for practical programming problems.
Real programming languages are much more convenient to use.  But the very
flexibility that makes real languages easier to use also makes them harder
to talk about in a formal way.  The stripped-down theoretical machines are
designed to be examined mathematically.

<P>What's a mathematical model?  You'll see one shortly, called a
&quot;finite-state machine.&quot;

<P>The point of this study is that the mathematical models are, in some
important ways, <EM>equivalent</EM> to real computers and real programming
languages.  What this means is that any problem that can be solved on a real
computer can be solved using these models, and vice versa.  Anything we can
prove about the models sheds light on the real problems of computer
programming as well.

<P>The questions asked in automata theory include these:  Are there any
problems that no computer can solve, no matter how much time and memory it
has?  Is it possible to <EM>prove</EM> that a particular computer program
will actually solve a particular problem?  If a computer can use two
different external storage devices (disks or tapes) at the same time,
does that extend the range of problems it can solve compared to a
machine with only one such device?

<P>There is also a larger question lurking in the background of automata
theory:  Does the human mind solve problems in the same way that a
computer does?  Are people subject to the same limitations as computers?
Automata theory does not actually answer this question, but the insights
of automata theory can be helpful in trying to work out an answer.
We'll have more to say about this in the chapter on artificial intelligence.

<P><H2>What is a Computation?</H2>

<P>What kinds of problems can we give to our abstract computers?  In
automata theory we want to focus our attention on computation itself,
not on details of input and output devices.  So we won't try creating
a mathematical model of a video game.

<P>We will play a game, though.  In this game the computer has a rule in mind.
You type in strings of letters, using only the letters <CODE>A</CODE>, <CODE>B</CODE>, and
<CODE>C</CODE>.  The computer tells you whether each string follows the rule or
not.  Your job is to guess the rule.  For example, suppose you have done
these experiments:

<P><TABLE><TR><TH align="left"><U>accepted</U>
<TH align="left">&nbsp;&nbsp;&nbsp;&nbsp;<U>rejected</U>
<TR><TD><CODE>ABC</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>CBA</CODE>
<TR><TD><CODE>AAA</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>BBB</CODE>
<TR><TD><CODE>ABCABCABC</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>BCABCABC</CODE>
<TR><TD><CODE>A</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>BBBBBBB</CODE>
<TR><TD><CODE>ACCCCCCCCC</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>CAAAAAAAAA</CODE>
</TABLE>

<P>You might guess, from these examples, that the rule is
&quot;The string must begin with <CODE>A</CODE>.&quot;  Once you've made a guess you can
test it out by trying more examples.

<P>The program to play the game is called <CODE>game</CODE>.  It takes one input,
a number from 1 to 10.  I've provided ten different rules.  Rules 1 to 3
should be pretty easy to guess; rules 8 to 10 should be nearly impossible.
(Don't feel too frustrated if you don't get them.)

<P>A string can be any length, including length zero (the empty string).  Each
time you type a letter the program lets you know whether the string you've
typed so far obeys the rule.  The program indicates whether the string is
accepted or rejected by displaying the word <CODE>accept</CODE> or <CODE>reject</CODE> on
the screen.  In particular, as soon
as you start <CODE>game</CODE> the program will tell you whether or not the empty
string is accepted by this rule.  If you type the string <CODE>ABC</CODE> you'll
really be testing three strings: <CODE>A</CODE>, <CODE>AB</CODE>, and <CODE>ABC</CODE>.  You
should type one letter at a time to make sure the program has a chance to
respond to it before going on to the next letter.  To start over again with
a different string, press the Return key.

<P>You should stop reading now and try the game.  In the following paragraphs
I'm going to talk about some of the answers, so this is your last
chance.  After you've figured out at least some of the rules, come
back to the book.

<P><H2>Finite-State Machines</H2>

<P>The point of studying this game is that we're going to look at a way to design
a special-purpose abstract computer that understands one particular
rule.  We can then ask questions about how much information the computer
needs to handle the job.

<P>You've seen the word <EM>state</EM> before in connection with the Logo
turtle.  Its state includes its position and its heading.  So one turtle
state might be &quot;position <CODE>[17 82]</CODE>, heading <CODE>90</CODE>.&quot; In principle,
the turtle has an <EM>infinite</EM> number of possible states, because its
position and heading don't have to be integers.  Its position might be <CODE>
[14.142 14.142]</CODE>, for instance.

<P>Anything that holds information can be in different states.  As another
example, an on-off light switch has two states.  Some lamps have four states:
off, low, medium, and high.  A computer, too, has a certain number of states.
The state of a computer includes all the information in its memory at some
particular time.

<P>A machine that has only a limited number of states, like the example of the
light switch, is called a <EM>finite-state machine.</EM>  For almost all of
this chapter we'll be dealing with finite-state machines.  You might think
that that imposes a very severe limit on the kinds of computations we can
do.  But note that in the game I asked you to play, a rule can accept an
infinite number of possible strings and reject an infinite number of
others.  The accepted or rejected strings can be of any length.  (Some rules
restrict the length of a string, but others allow any length at all.)  In
some sense, a finite-state machine can still perform infinitely varied
computations.

<P>Consider the third game as an example.  The rule is &quot;Accept
any string that starts with <CODE>AB</CODE>.&quot;  Here is a picture of a finite-state
machine that implements that rule:

<P><CENTER><IMG SRC="https://people.eecs.berkeley.edu/~bh/v3ch1/fsm3.gif" ALT="figure: fsm3"></CENTER>

<P>Each numbered circle represents a state.  This machine has three
states.  The <CODE>start</CODE> arrow indicates that the machine starts out in state
1.  State 3 is shown with a <EM>double</EM> circle to indicate that it is an
<EM>accepting</EM> state.  In other words, when the machine is in state 3 the
screen says <CODE>accept</CODE>.  The other two states are not
accepting states.
Every time you type a character the machine switches from one state to
another.  The arrow from state 1 to state 2 has an <CODE>A</CODE> next to its
tail.  This indicates that when the machine is in state 1, an input of <CODE>
A</CODE> switches it to state 2.  (The arrow from state 3 to itself has the
three letters <CODE>ABC</CODE> at its tail.  This is a shorthand notation for
three separate arrows with heads and tails in the same place, one for each
letter.)

<P>This picture is actually incomplete.  For a full description of the machine
we have to indicate what happens on any input in any state.  In other words,
each circle should have <EM>three</EM> arrows coming out from it, one each
for <CODE>A</CODE>, <CODE>B</CODE>, and <CODE>C</CODE>.  I've chosen to adopt the convention that
every machine has an unmarked state called <CODE>reject</CODE>.  Any missing arrow
goes to that state; once the machine is in the reject state it stays
there forever.  Here, then, is the complete diagram of the machine for game
3:

<P><CENTER><IMG SRC="fsm3-reject.gif" ALT="figure: fsm3-reject"></CENTER>

<P>From now on I won't draw the <CODE>reject</CODE> state, but you should
remember that it's really part of the machine description.  So this machine
requires four states, not three.

<P>If the first input letter isn't <CODE>A</CODE>, the machine goes to the <CODE>reject</CODE>
state.  If the first letter is <CODE>A</CODE>, the machine goes to state 2.  Then,
if the second letter is <CODE>B</CODE>, the machine ends up in state 3 and accepts
the string <CODE>AB</CODE>.  This is the shortest acceptable string.

<P>Each of the three arrows from state 3 loops right back into state
3 itself.  (Remember, although only one arrow appears in the picture,
it is labeled with three letters, so officially it represents three
arrows.)  This means that once the machine is in state 3 it stays
there no matter what inputs it gets.  Any string that starts <CODE>AB</CODE> is
acceptable.

<P>Here is a machine for game number 2:

<P><CENTER><IMG SRC="fsm2.gif" ALT="figure: fsm2"></CENTER>

<P>In this machine the <EM>start state</EM> is also an <EM>accepting
state.</EM>  (Every machine has exactly one start state, but it may have any
number of accepting states.)  This machine never gets into the <CODE>reject</CODE>
state.  That doesn't mean it doesn't reject any strings; all odd-length
strings are rejected in state 2.  But a rejected string can redeem itself by
adding another input character, so state 2 allows a return to the accepting
state 1.

<P>Here is a machine for game number 5.  (Notice that I'm saying &quot;a
machine&quot; and not &quot;the machine&quot;; it is always possible to design
other machines that would follow the same rule.)

<P><CENTER><IMG SRC="fsm5.gif" ALT="figure: fsm5"></CENTER>

<P>You probably had more trouble discovering rule 5 than rule
2, and it takes longer to say the rule in English words.  But the
<EM>machines</EM> for the two rules are almost identical.  (Remember,
though, that the rule-5 machine really has a third state, the <CODE>reject</CODE>
state, which is not shown in the diagram.)

<P>Here are machines for rules 7 and 9.  With these machines as hints,
can you figure out the rules?  Go back to the <CODE>game</CODE> program to test
your hypotheses.

<P><CENTER><IMG SRC="fsm79.gif" ALT="figure: fsm79"></CENTER>

<P>You should also get some practice translating in the other direction, from
English rules to machine diagrams.  Here are a couple to work on:  Rule 4 is
&quot;To be accepted a string must be composed of doubled letters (<CODE>AA</CODE>,
<CODE>BB</CODE>, and <CODE>CC</CODE>) strung together.&quot; Rule 8 is &quot;To be accepted a
string must contain an even number of <CODE>A</CODE>s.&quot;

<P><H2>Nondeterministic Machines</H2>


<P>Here is rule 6: &quot;To be accepted a string must begin with <CODE>A</CODE> and end
with <CODE>C</CODE>.&quot; Strings accepted by this rule include <CODE>AC</CODE> (the shortest
possible), <CODE>ABC</CODE>, <CODE>AACC</CODE>, <CODE>ACAC</CODE>, <CODE>ABCABC</CODE>, and so on.
Between the initial <CODE>A</CODE> and the final <CODE>C</CODE> an accepted string can
have any combination of <CODE>A</CODE>s, <CODE>B</CODE>s, and <CODE>C</CODE>s.  It's natural to
think of the string as having three parts: a fixed beginning, a variable
middle, and a fixed end.  The three parts of the input strings can be
represented conveniently with three states in the machine, like this:

<P><CENTER><IMG SRC="fsm6nd.gif" ALT="figure: fsm6nd"></CENTER>

<P>The machine starts in state 1.  To be accepted a string must start
with <CODE>A</CODE>.  Therefore, an <CODE>A</CODE> arrow leads from state 1 to state 2.  Any
other input at state 1 leads to the <CODE>reject</CODE> state.

<P>Once the machine is in state 2 it is ready for the middle part of
the string.  In this middle part any combination of letters is allowed.
Therefore, there are three arrows from state 2 to itself, one for
every possible letter.

<P>Finally, a <CODE>C</CODE> arrow leads from state 2 to state 3, signaling the end
of an acceptable string.  A string must end with <CODE>C</CODE> to be accepted.

<P>There is a problem with this machine:  There are <EM>two</EM> <CODE>C</CODE> arrows
leading out from state 2.  One is a loop back into state 2; the other
goes on to state 3.  This situation reflects the fact that <CODE>C</CODE> serves
two different functions in this rule: <CODE>C</CODE> is an optional part of the
middle section of the string, and it's also the required final input
in the string.

<P>A machine with two arrows from the same state for the same input is
called a <EM>nondeterministic</EM> machine.  Here is how such a machine
could work:  Whenever there are two choices for the machine's
current state and input, the machine clones itself.  One of the copies
follows each arrow.  From then on, if <EM>either</EM> machine is in an
accepting state the string is accepted.

<P>Nondeterministic finite-state machines are more complicated
than deterministic ones.  Does the added complexity &quot;buy&quot; any added
power?  In other words, can a nondeterministic machine solve problems
that a deterministic machine can't?  It turns out that the answer
to this question is no.  Deterministic machines are just as powerful
as nondeterministic ones.  This is an important theorem in automata
theory.  I'm not going to prove it formally in this book, but to illustrate
the theorem, here is a deterministic machine that carries out game
6:

<P><CENTER><IMG SRC="https://people.eecs.berkeley.edu/~bh/v3ch1/fsm6d.gif" ALT="figure: fsm6d"></CENTER>

<P>This machine is similar to the nondeterministic version.  It has the
same number of states and some of the connections are identical.
State 3 is more complicated, though.  Also, in this machine, it is
no longer the case that each state of the machine corresponds exactly
to one of three parts of the input string.  Specifically, when the machine is
in state 3 the string may or may not be finished.

<P><H2>Representing Machines as Logo Lists</H2>

<P>The <CODE>game</CODE> program uses finite-state machines to represent the rules
by which it accepts or rejects strings.  (The machines must be deterministic
for the program to work.)  Logo programs can't read circles and arrows,
so a machine is represented as a list.  What information is actually
contained in an FSM diagram?  The diagram shows that there are a certain
number of states (the circles), that there are certain transitions from one
state to another (the arrows), that one particular state is the start state
(the start arrow), and that certain states are accepting ones (the double
circles).  As in any programming project, I could have chosen many different
ways to represent that information in the program.

<P>In the particular representation I chose, the list form of a machine
has three members.  The first member is the number of the start state.
The second member is a list of arrows; each arrow is itself a list,
as I'll explain in a moment.  The third member of a machine list is
a list of the accepting states of the machine.  For example, here
is the machine for game 3 again, in both forms:

<P><CENTER><IMG SRC="https://people.eecs.berkeley.edu/~bh/v3ch1/fsm3.gif" ALT="figure: fsm3"></CENTER>
<PRE>[1 [[1 A 2] [2 B 3] [3 ABC 3]] [3]]
</PRE>

<P>The number <CODE>1</CODE> is the start state; the list <CODE>[3]</CODE> is the
list of accepting states.  (This machine happens to have only one accepting
state.)  Everything else is the list of arrows.  Each arrow is also a list
with three members: the initial state (the tail of the arrow), the input
letter or letters, and the final state (the head of the arrow).  The first arrow in
this machine is

<P><PRE>[1 A 2]
</PRE>

<P>This is the arrow from state 1 to state 2 associated with
the input <CODE>A</CODE>.

<P>The list <CODE>[3 ABC 3]</CODE> in this machine represents three arrows, using
the same shorthand as in the circle-and-arrow diagrams.  I could equally
well have represented these arrows separately:

<P><PRE>[1 [[1 A 2] [2 B 3] <U>[3 A 3] [3 B 3] [3 C 3]</U>] [3]]
</PRE>

<P>As in the circle-and-arrow diagrams, I haven't explicitly represented the
transitions to the <CODE>reject</CODE> state in these lists.  The program is
written so that if it doesn't find a transition for the current state and
input in the list of transitions, it goes into state number &minus;1, its
representation for the <CODE>reject</CODE> state.

<P>Here are some more machine lists:

<P><PRE>Game 2:  [1 [[1 ABC 2] [2 ABC 1]] [1]]
Game 7:  [1 [[1 AB 1] [1 C 2] [2 C 1]] [1]]
Game 9:  [1 [[1 AB 1] [1 C 2] [2 A 3] [2 B 1] [3 A 1]] [1]]
</PRE>

<P>At this point you should stop and play with the program.  Make up
your own rules.  The procedure <CODE>fsm</CODE> takes a machine list as input
and accepts strings based on that machine.  (<CODE>Game</CODE> uses <CODE>fsm</CODE>
with particular
machines as inputs.)  Try out your new rules to make sure you've designed
the machines correctly.  Then get a friend to play with your rules.
If both of you are reading this book together you can have a competition.
(It's easy to design rules that are impossible to guess because there
are too many details.  If you have a competition you should limit
yourselves to three states per machine.)

<P>You might be interested in reading through the
<A HREF="fsm.html#fsm"><CODE>fsm</CODE></A> program, which
simulates a finite-state machine when given the machine's description
as its input.  It's a pretty simple program.  If you think of a machine's
state diagram as a kind of &quot;wiring diagram&quot; that might be used
in building a real version of that particular machine, this Logo program
is a kind of <EM>universal</EM> finite-state machine implementation.

<P><H2>Text Editors: a Use for Acceptors</H2>

<P>It may seem to you that accepting or rejecting strings isn't much
like what you usually do with computers.  You may wonder how this
mathematical model is related to real computer programming.  There
are two answers to this question.  One is that it's possible to design
finite-state machines that have more versatile outputs than simply
yes or no.  I'll give an example shortly.  But the other answer is
that there are real situations in which accepting or rejecting a string
of symbols does come up in practical computation.

<P>One example is in the implementation of programming languages.  When
you say that

<P><PRE>print 2+2
</PRE>

<P>is a legal Logo instruction but

<P><PRE>print 2+
</PRE>

<P>is illegal, you're doing a more complicated version of what
a finite-state acceptor does.

<P>The <EM>search</EM> command in a good text editor uses
finite-state machines.  Most text editors have a command that allows
you to look through a file for a particular string of characters.  Fancier
editors allow searching not just for one particular string, but for any
string that follows a rule the user can provide.  The editor finds a string that
matches the rule using a finite-state machine.  Of course, people who use
editors don't have to specify their search rules in the <EM>form</EM> of a
finite-state machine!  The editing program accepts search rules in a simpler
form and translates them into FSM form.  Here is an example, the notation
used by <EM>ed,</EM> a standard editor in the Unix operating system.

<P>A string like

<P><PRE>spaghetti
</PRE>

<P>just matches an identical string in the file you're editing.  A
slightly more interesting case is

<P><PRE>[Ss]paghetti
</PRE>

<P>which matches either &quot;Spaghetti&quot; or &quot;spaghetti&quot;
(with a capital or lower case &quot;s&quot;).  The square brackets indicate that
<EM>any</EM> of the letters inside the brackets will be accepted.
In the expression

<P><PRE>[Ss]paghet*i
</PRE>

<P>the asterisk matches <EM>any number</EM> (including zero) of the
letter before it (in this case, the letter <CODE>t</CODE>).  This example
would match any of these:

<P><PRE>Spaghei
Spaghettttti
spaghetti
spagheti
</PRE>

<P>You might use this in a search command if you're a bad speller!
The bracket and asterisk can be combined;

<P><PRE>C[AD]*R
</PRE>

<P>will match any of

<P><PRE>CAR
CDR
CADDR
CR
</PRE>

<P>Or you could use

<P><PRE>M[is]*p*i
</PRE>

<P>to match the name of a famous river.

<P>Some of the rules from the game I presented earlier can be represented as
<EM>ed</EM> search strings according to these rules.  In the first game the
machine accepted any string made up of <CODE>A</CODE>s and <CODE>B</CODE>s.  The
corresponding <EM>ed</EM> expression is

<P><PRE>[AB]*
</PRE>

<P>The third game called for strings beginning with the sequence
<CODE>AB</CODE>, followed by whatever you like.  This can be represented as

<P><PRE>AB[ABC]*
</PRE>

<P>Game 10, which I'm sure you didn't solve, accepts any string that
includes the sequence <CODE>ABCBA</CODE> within it.  In <EM>ed</EM> terms, that's

<P><PRE>[ABC]*ABCBA[ABC]*
</PRE>

<P>I haven't given you a complete description of the <EM>ed</EM> search rules.
I included this much only because I want you to see how a &quot;real&quot; program
uses the idea of finite-state machines.  But in the remaining part of this
chapter I want to use a different notation based on Logo words and lists.

<P><H2>Regular Expressions</H2>

<P>The notation I'm about to describe allows an acceptance rule, like the rules
in the <CODE>game</CODE> program or the rules for <EM>ed</EM> searches, to be
represented in Logo.  The representation of such a rule is called a <EM>
regular expression.</EM>  I'm going to tell you some rules for what a regular
expression can look like.  Don't be confused:  Any particular regular
expression is a rule that accepts strings of letters.  I'm giving you rules
that accept regular expressions--rules about rules.  As a rough analogy,
&quot;one player is <CODE>X</CODE> and the other is <CODE>O</CODE>&quot; is a rule about the
specific game Tic Tac Toe; &quot;each player should have a fair chance to win&quot;
is a rule about what kinds of game rules are acceptable.

<P> <EM>Alphabet rule.</EM> Any symbol in a machine's
alphabet is a regular expression.  We represent the symbol as a one-letter
Logo word.  In our guessing game the alphabet contains three symbols: <CODE>
A</CODE>, <CODE>B</CODE>, and <CODE>C</CODE>.  So

<P><PRE>B
</PRE>

<P>is a regular expression.

<P>
<EM>Concatenation rule.</EM>  A list whose members are regular expressions
represents those expressions one after another.  For example, since <CODE>A</CODE>
is a regular expression and <CODE>B</CODE> is a regular expression,

<P><PRE>[A B]
</PRE>

<P>is a regular expression representing the string <CODE>AB</CODE>.  (Notice
that the Logo word <CODE>AB</CODE> does <EM>not</EM> represent that string; the
alphabet rule requires that each letter be represented as a separate word.)

<P>
<EM>Alternatives rule.</EM>  A list whose first member is the word <CODE>or</CODE> and
whose remaining members are regular expressions represents any string that
matches <EM>any</EM> of those expressions.  For example,

<P><PRE>[OR [A A] B]
</PRE>

<P>matches either the sequence <CODE>AA</CODE> or the single symbol <CODE>B</CODE>.
As a convenience, a Logo word containing more than one letter (other
than the word <CODE>or</CODE>) is taken as an abbreviation for the <CODE>or</CODE>ing
of the individual letters.  For example, <CODE>ABC</CODE> is equivalent to
<CODE>[OR A B C]</CODE>.

<P>
<EM>Repetition rule.</EM>  A list containing exactly two members, in which the
first is the asterisk (<CODE>*</CODE>) symbol and the second is a regular
expression, represents a string containing any number (including zero) of
substrings that match the regular expression.  So

<P><PRE>[* [OR [A A] B]]
</PRE>

<P>matches any of these:

<P><TABLE>
<TR><TD><CODE>B</CODE>
<TR><TD><CODE>BB</CODE>
<TR><TD><CODE>BAAB</CODE>
<TR><TD><CODE>AAAAAA</CODE>
<TR><TD><CODE>AABAA</CODE>
<TR><TD>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(the empty string)
<TR><TD><CODE>AABBBBBAA</CODE>
</TABLE>

<P>The number of consecutive <CODE>A</CODE>s must be even for a string of
<CODE>A</CODE>s and <CODE>B</CODE>s to match this expression.

<P>These four rules constitute the definition of a regular expression.
It's a <EM>recursive definition.</EM>  Just as the effect of a recursive
Logo procedure is defined in terms of a simpler case of the same procedure,
a complex regular expression is defined in terms of simpler ones.

<P>Here are the ten game rules from the beginning of this chapter in
the form of regular expressions:

<P><P>
<TABLE><TR><TH align="right">1.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[* AB]</CODE>
<TR><TH align="right">2.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[* [ABC ABC]]</CODE>
<TR><TH align="right">3.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[A B [* ABC]]</CODE>
<TR><TH align="right">4.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[* [OR [A A] [B B] [C C]]]</CODE>
<TR><TH align="right">5.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[* [ABC B]]</CODE>
<TR><TH align="right">6.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[A [* ABC] C]</CODE>
<TR><TH align="right">7.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[* [OR A B [C C]]]</CODE>
<TR><TH align="right">8.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[[* BC] [* [A [* BC] A [* BC]]]]</CODE>
<TR><TH align="right">9.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[[* AB] [* [C [OR B [A A]]] [* AB]]]</CODE>
<TR><TH align="right">10.<TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[[* ABC] A B C B A [* ABC]]</CODE>
</TABLE>

<P><TD>&nbsp;&nbsp;&nbsp;&nbsp;<P>

<P>You should go through these examples carefully, making sure
you understand how the regular expression represents the same idea
as the English description or the machine diagram you saw earlier.

<P><H2>Rules That Aren't Regular</H2>

<P>You may be thinking that <EM>any</EM> rule for accepting or rejecting
strings of symbols can be represented as a regular expression.  But
that's not so.  For example, consider the rules for recognizing ordinary
arithmetic expressions:

<P><TABLE><TR><TH align="left"><U>accepted</U>
<TH align="left">&nbsp;&nbsp;&nbsp;&nbsp;<U>rejected</U>
<TR><TD><CODE>2+3</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>23+</CODE>
<TR><TD><CODE>2*(3+4)</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>2*)3+4(</CODE>
<TR><TD><CODE>-5</CODE><TD>&nbsp;&nbsp;&nbsp;&nbsp;<CODE>/6</CODE>
</TABLE>

<P>Think for a moment just about the matter of
balancing parentheses.
Sometimes you have parentheses within parentheses, as in

<P><PRE>((3+4)/(5+6))
</PRE>

<P>How would you represent this part of the arithmetic expression
rule in the form of a regular expression?  You can't just say something like

<P><PRE>[[* (] something-or-other [* )]]
</PRE>

<P>to mean &quot;any number of open parentheses, something, then
any number of close parentheses.&quot;  That would allow strings like

<P><PRE>(((7)))))
</PRE>

<P>But this string should be rejected because it has too many close
parentheses.  You're not allowed to use a close parenthesis unless you've
already used a matching open parenthesis.  You can have any number of nested
parentheses you want as long as they're balanced.

<P>It is possible to invent other kinds of formal notation, more powerful than
regular expressions, that will allow us to give the rules for well-formed
arithmetic expressions.  In this section I'll introduce briefly a formal
notation called <EM>production rules</EM> that's powerful enough to describe
arithmetic expressions.  For now, in this chapter, I don't want to discuss
production rules in great detail; my only reason for introducing them at
this point is to give you a sense of how regular expressions fit into a
larger universe of possible formal systems.  In the following sections I'll
have more to say about regular expressions and finite-state machines.  But
we'll return to production rules in Chapters 5 and 6, in which we'll need
formal notations with which to discuss more interesting languages than the
<CODE>A</CODE>-<CODE>B</CODE>-<CODE>C</CODE> language of this chapter.  (In Chapter 5 we'll be
talking about Pascal; in Chapter 6 we'll take on English.)

<P>The key ingredient that's missing from regular expression notation is a way
to <EM>name</EM> a kind of sub-expression so that the name can be used in
defining more complex expressions.  In particular, a sub-expression name can
be used in its own definition to allow a <EM>recursive</EM> definition of the
rule.

<P>A production rule has the form

<P><PRE>name      :  expansion
</PRE>

<P>Each rule is a definition of the name on the left in terms of
smaller units, analogous to the definition of a Logo procedure in terms
of subprocedures.  The expansion part of the rule is a string of symbols
including both members of the &quot;alphabet&quot; of the system (like the alphabet
that underlies a regular expression language) and names defined by
production rules.

<P>As an example, here is a set of production rules that defines the language of
arithmetic expressions.  These rules take into account the &quot;order of
operations&quot; for arithmetic that you learned in elementary school:
multiplication before addition.  An expression like

<P><PRE>2/3+1/6
</PRE>

<P>is ordinarily interpreted as the sum of two <EM>terms,</EM> namely
two thirds and one sixth.  An expression can be a single term, a sum of
terms, or a difference of terms.  Here's how that idea is expressed in a set
of production rules; I'll discuss the notation in more detail in a moment.

<P><CENTER><IMG SRC="xx1.gif"></CENTER>

<P>The vertical bars separate alternatives.  The first rule, the one
that defines <CODE>expr</CODE>, contains three alternatives.  First, an expression
can be just a single term.  Second, an expression can be a smaller
expression plus a term.  Third, an expression can be a smaller expression
minus a term.  The symbols inside boxes are the members of the alphabet of
the arithmetic expression language.  (I've put them in boxes to make it
easier not to confuse them with the punctuation characters--the colons and
vertical bars--that are part of the production rule notation itself.)

<P>Do you see how parentheses fit in?  If a string like <CODE>4+5</CODE> is an
expression, then <CODE>(4+5)</CODE> is a factor, so <CODE>3*(4+5)</CODE> is a term,
and so on.  Since a factor is a kind of term, and a term is a kind of
expression, the factor <CODE>(4+5)</CODE> can be considered an expression, and
so it too can be put inside parentheses.  So <CODE>((4+5))</CODE> is also
acceptable as a factor.

<P><H2>Regular Expressions and Finite-State Machines</H2>

<P>I've hinted at something that I haven't actually made explicit:  Regular
expressions are equivalent to finite-state machines.  In other words,
if you can express a rule as a regular expression, you can design
a finite-state machine that carries out the rule.  If you can't write
a regular expression for the rule, you can't design a finite-state
machine either.

<P>You may be thinking, &quot;so what?&quot;  I've introduced two different formal
notations, finite-state machines and regular expressions, and now I'm
telling you that the two are equivalent.  So why didn't I just pick one in
the first place and forget about the other?  I have a general answer and a
specific answer to these questions.

<P>The general answer is that comparing different formal systems is what
automata theory is all about.  By the end of this book you'll have been
introduced to half a dozen or so different formal systems.  Some are more
powerful than others.  The bare assertion that one formal system is
equivalent to another, or more powerful than another, isn't very interesting;
but if we can understand the <EM>reasons</EM> behind those assertions then
we may be able to put the knowledge to work in practical situations.  At the
very end of this book, in Chapter 6, we'll talk about a particular formal
system that's often used in artificial intelligence programs to recognize
English sentences.  By then you should know enough about formal systems to
be able to understand why that particular one is a good choice.

<P>The specific answer is that finite-state machines and regular expressions
are <EM>different</EM> from each other in an interesting way.  A finite-state
machine is an <EM>algorithm,</EM> a sequence of steps, or a procedure that can
be followed to test whether some string matches a given rule.  It says,
&quot;start here, then if this happens do this, then...&quot; just like a procedure
in Logo or most other programming languages.  (But we've seen that a
finite-state machine is like a procedure written in a restricted programming
language that isn't as flexible as Logo.)  A regular expression, though, is
<EM>not</EM> a sequence of steps.  It's more like a description of the <EM>
result</EM> that we want, leaving open the precise recipe for how to get there.
People often pose problems in a similar way.  They call the plumber and say,
&quot;the drain in my bathtub is backing up.&quot;  Part of the plumber's expertise is
to be able to translate that <EM>declarative</EM> problem statement into a
<EM>procedural</EM> form, a sequence of steps needed to clear up the problem.
An early stumbling block in artificial intelligence research was the seeming
gulf between the procedural knowledge embodied in a computer program and the
declarative knowledge needed for human-like behavior.  Recently people have
invented <EM>declarative programming languages</EM> (the best known
is Prolog, but any commercial spreadsheet program is also
in this category) that
allow the user to state a problem in declarative form.  The programming
language interpreter then automatically translates this problem statement
into a sequence of steps for the computer to perform.

<P>Writing a Prolog interpreter raises many issues beyond the scope of this
book.  But we can take a smaller step in the realm of translation from
a declarative notation to a procedural one.  I've written a Logo program,
listed at the end of the chapter, that translates from a regular
expression to an equivalent finite-state machine.  Its top-level procedure,
<CODE>machine</CODE>, takes a regular expression as input and outputs a machine
list in the format I showed earlier.

<P><H2>How to Translate</H2>

<P>The general claim that regular expressions are equivalent in power
to finite-state machines is called Kleene's Theorem, named after the
mathematician Stephen C. Kleene, its discoverer.  You can find a proof
of this theorem in any textbook on automata theory.  I'm not going
to give a proof here, but I'll indicate how the translation is done
in my program.  The same kinds of ideas are used in the proof.

<P>Remember that there are four parts to the definition of a regular expression.
The alphabet rule provides the fundamental building blocks; the
concatenation, alternatives, and repetition rules build large regular
expressions recursively out of smaller ones.  The translation process
follows the same pattern:  We start with a procedure to build a trivial
two-state machine that only accepts a single letter, then we add three
rules for combining smaller machines into a large machine.  In the following
paragraphs I'll show how each rule is reflected in the
<A HREF="fsm.html#machine"><CODE>machine</CODE></A> program.

<P>This construction process often produces machines with more states than
necessary.  The <CODE>machine</CODE> program eliminates redundant states as its
final step.

<P>The alphabet rule says that any member of the machine's alphabet is
a regular expression.  In the program, a symbol can be any one-letter word other
than <CODE>*</CODE>.  The symbol <CODE>X</CODE> is translated into the machine

<P><PRE>[1 [[1 X 2]] [2]]
</PRE>

<P>(You'll see that the program works by combining little machines
into bigger ones.  Every time the program has to invent a new machine
state it uses the next free number.  So the state numbers might not
be 1 and 2 in a real example.)  The procedure
<A HREF="fsm.html#ndletter"><CODE>ndletter</CODE></A> handles this
rule.

<P>Next comes the <EM>concatenation rule.</EM>  The regular expression

<P><PRE>[A B]
</PRE>

<P>matches a string with two parts; the
first substring matches the <CODE>A</CODE> and the second matches the <CODE>
B</CODE>.  In this simple example each &quot;substring&quot; matches only a single
letter.  In a more complicated concatenation like

<P><PRE>[[OR A C] [* B]]
</PRE>

<P>there are different choices for each substring.  For example, that
regular expression is matched by the string

<P><PRE>CBBB
</PRE>

<P>in which the letter <CODE>C</CODE> matches the first part of the
expression and the substring <CODE>BBB</CODE> matches the second part.

<P>To translate a regular expression of this kind (a concatenation) into a
finite-state machine, we begin by recursively translating the subexpressions
into smaller machines.  Then we have to &quot;splice&quot; the two machines together.
Procedure <A HREF="fsm.html#ndconcat"><CODE>ndconcat</CODE></A> does this splicing.

<P>We'll begin with the simplest possible example.  Suppose we want to
translate the regular expression

<P><PRE>[A B]
</PRE>

<P>We have already translated the two symbols <CODE>A</CODE> and <CODE>B</CODE> into
machines:

<P><CENTER><IMG SRC="concat-before.gif" ALT="figure: concat-before"></CENTER>

<P>The combined machine must start at the start state of the first
component machine, state 1.  The combined machine should be in an accepting
state when <EM>both</EM> component machines have been satisfied; in other
words, the accepting states of the combined machine should be those of the
<EM>second</EM> component machine.  In this case that means only state 4.

<P>To splice the component machines together we must add transitions (arrows)
between them.  Specifically, whenever the first component machine gets into
an accepting state, the combined machine should follow the same transitions
that apply to the start state of the second component machine.  In this
case, when the combined machine gets into state 2 (the accepting state of
the first component machine) it should follow the same transitions that
apply to state 3 (the start state of the second machine).  There is only one
such transition, a <CODE>B</CODE> arrow into state 4.  That means we must add the
arrow

<P><PRE>[2 B 4]
</PRE>

<P>to the combined machine.

<P><CENTER><IMG SRC="concat-after.gif" ALT="figure: concat-after"></CENTER>

<P>State 3, although it is still in the machine, is now useless.
There is no way for the machine to get into state 3.  Later
in the translation process another procedure removes
such &quot;orphaned&quot; states from the machine.

<P>As a slightly more complicated example, consider the translation of the
regular expression

<P><PRE>[[OR A C] [* B]]
</PRE>

<P>We start by supposing that we've already translated the two
subexpressions separately:

<P><CENTER><IMG SRC="concat2-before.gif" ALT="figure: concat2-before"></CENTER>

<P>(We haven't yet discussed the alternatives rule or the repetition
rule, so I haven't yet explained how these subexpressions are translated.
For now, please just take on faith that this picture is correct.  We'll get
to those other rules shortly.)

<P>The start state of the combined machine is the start state of the first
component, state 1.  At every accepting state of the first machine we must
duplicate the transitions from the start state of the second machine.  In
this example the start state of the second machine has only the transition

<P><PRE>[4 B 5]
</PRE>

<P>but there are two accepting states in the first machine, so we
must add two new arrows:

<P><PRE>[2 B 5]    [3 B 5]
</PRE>

<P>A final detail is that in this example the start state of the
second component machine, state 4, is an accepting state.  That means that
the second substring can be empty.  Therefore the accepting states of the
first component machine should also be accepting states of the combined
machine.  Here is the result:

<P><CENTER><IMG SRC="concat2-after.gif" ALT="figure: concat2-after"></CENTER>

<P>Again, state 4 is now an &quot;orphan&quot; and will be eliminated
later in the program.

<P>The <EM>alternatives rule</EM> combines two machines in parallel, so to speak,
rather than in series.  It works by inventing a new state
that becomes the start state of the combined machine.  Arrows leaving
from the new state duplicate the arrows from the start states of the
component machines.  Procedure <A HREF="fsm.html#ndor"><CODE>ndor</CODE></A> handles this rule.

<P>As an example, here is the translation process for

<P><PRE>[OR A B]
</PRE>

<P>(or its abbreviation <CODE>AB</CODE>).  We start with two separate machines:

<P><CENTER><IMG SRC="https://people.eecs.berkeley.edu/~bh/v3ch1/alter-before.gif" ALT="figure: alter-before"></CENTER>

<P>We combine them by inventing a new state 5:

<P><CENTER><IMG SRC="alter-after.gif" ALT="figure: alter-after"></CENTER>

<P>I haven't explained all the details of the construction process.
For example, should the new state, state 5, be an accepting state?  In this
example it shouldn't be.  See if you can think of a case where it might be;
then read the program listing to see the exact algorithm that makes this
decision.  Again, this construction process may leave unused states for
later cleanup.

<P>A much more serious problem is that an <CODE>or</CODE> construction is likely to
produce a nondeterministic machine.  For example, here is the machine
for

<P><PRE>[OR [A B] [A C]]
</PRE>

<P><CENTER><IMG SRC="or-nondet.gif" ALT="figure: or-nondet"></CENTER>

<P>Like the unused states, the problem of nondeterminism is
left for the end of the program, when procedure <CODE>determine</CODE> translates
the nondeterministic machine into a deterministic one.
(The concatenation rule can also make nondeterministic machines, although
it's not as likely.)

<P>The final case to be considered is the <EM>repetition rule.</EM>  This rule
acts on only one smaller machine, not two machines as in the previous
two cases.  The rule doesn't require any new states.  It has two effects.
One is to add the start state to the list of accepting states.  The
second is to add arrows from the (old) accepting states that mimic
the arrows from the start state.  (This is exactly like the splicing
of two machines in the concatenation rule, but in this case we concatenate
a single machine with itself!)  Procedure <A HREF="fsm.html#ndmany"><CODE>ndmany</CODE></A>
makes this transformation.
It, too, can result in a nondeterministic machine.

<P>Here is an example of the rule:

<P><CENTER><IMG SRC="repetition.gif" ALT="figure: repetition"></CENTER>

<P>These four rules are combined by <A HREF="fsm.html#nondet"><CODE>nondet</CODE></A>,
a procedure whose input is
a regular expression and whose output is a (possibly nondeterministic) machine.

<P><PRE>to nondet :regexp
if and (wordp :regexp) (equalp count :regexp 1) [output ndletter :regexp]
if wordp :regexp [output ndor reduce &quot;sentence :regexp]
if equalp first :regexp &quot;or [output ndor butfirst :regexp]
if equalp first :regexp &quot;* [output ndmany last :regexp]
output ndconcat :regexp
end
</PRE>

<P>The top-level procedure <A HREF="fsm.html#machine"><CODE>machine</CODE></A>
does a little initialization
and then does its work with the instruction

<P><PRE>output optimize determine nondet :regexp
</PRE>

<P>That is, first it creates what may be a
nondeterministic machine,
then if necessary it translates that into a deterministic one (eliminating
orphan states in the process), then it gets
rid of any redundant states that may have been created.

<P><H2>Making the Machine Deterministic</H2>

<P>In the first volume of this series we explored the techniques of depth-first
and breadth-first tree traversal.  Given a tree structure, these algorithms
allow us to &quot;visit&quot; every node of the tree once.

<P>A finite state machine can be viewed as a structure almost like a tree.
The machine's start state corresponds to the root node; the states that
can be reached by an arrow from a given state are the children of that state.
But there is one important difference between trees and machines:  In a tree,
every node (except for the root node) has exactly one parent.  The tree
search algorithms depend on that fact to ensure that each node is visited
only once.  In a machine, arrows from several different states can lead to
the same state, so a state may have several &quot;parents.&quot;  The technical name
for an arbitrary collection of nodes with connections among them is a
<EM>graph.</EM>  If the connections are one-way, as in the finite
state machine diagrams, it's called a <EM>directed graph.</EM>

<P>Searching a graph is just like searching a tree, except that we have to
keep track of which nodes we've already visited, to avoid examining the
same node twice.  Procedure <A HREF="fsm.html#determine"><CODE>determine</CODE></A>
creates a list named <CODE>states</CODE>, initially
empty, into which each state number is added as the
program examines that state.  The depth first traversal of the machine
is carried out by procedure <A HREF="fsm.html#nd.traverse"><CODE>nd.traverse</CODE></A>;
although this procedure looks different from the
<A HREF="../v1ch14/v1ch14.html#depth.first"><CODE>depth.first</CODE></A>
procedure in Volume 1, it
uses the same basic algorithm.  Given a state as input, it processes
that state and invokes itself recursively for all of the children of
that state--the states reachable by arrows from the input state.  Unlike
<CODE>depth.first</CODE>, though, <CODE>nd.traverse</CODE> is an operation.  It
outputs a new list of moves (arrows) for the deterministic version of
the machine.

<P>What does it mean to process a state?  <CODE>Nd.traverse</CODE> first checks
whether this state has already been processed; if so, it outputs an empty
list, because this state will contribute no new moves to the machine.
Otherwise, it remembers this state number as having been processed, finds
all the moves starting from this state, and calls
<A HREF="fsm.html#check.nd"><CODE>check.nd</CODE></A> to look for
nondeterminism.  <CODE>Check.nd</CODE> takes the first available arrow whose tail
is at the state we're processing, and looks for all arrows with the same
tail and with the same letter.<SUP>*</SUP>
The local variable <CODE>heads</CODE> will contain a list of all the state numbers
reachable by these arrows.  (The state numbers are sorted into increasing
order, and duplicates eliminated.  If the machine has two completely
identical arrows, that doesn't result in nondeterminism.)

<P><SMALL><BLOCKQUOTE><SMALL><SUP>*</SUP>By the way, <CODE>nondet</CODE> always
creates arrows with only a single letter; if two or more letters lead from
the same state to the same state, a separate arrow is created for each of
them.  This makes for a longer machine list, but makes steps like this
one--looking for two arrows with the same letter--easier.  Once the
deterministic machine has been created, procedure <CODE>optimize</CODE> will combine
such arrows into the abbreviated form with
more than one letter per arrow.</SMALL></BLOCKQUOTE></SMALL>

<P>There are
three cases for what <CODE>check.nd</CODE> must do.  First, if there is
only one state number in <CODE>:heads</CODE>, then there is no nondeterminism for
this letter, and <CODE>check.nd</CODE> includes the arrow from the original
machine as part of the deterministic machine.  Second, if there is more
than one state number, <CODE>check.nd</CODE> looks to see if we've already seen
the same combination of result states.  If so, then we've already created
a new state equivalent to that combination of old states, and <CODE>check.nd</CODE>
creates a new arrow pointing to that existing new state.  Finally, the third
case is that this combination of states is one we haven't seen before.  In
that case, <CODE>check.nd</CODE> must create a new state, with arrows duplicating
those from all of the original states.

<P>In other words, if there are arrows

<P><PRE>[[3 B 4] [3 B 7]]
</PRE>

<P>then <CODE>check.nd</CODE> will invent a new state that is an &quot;alias&quot;
for &quot;four-and-seven.&quot;  If the same machine also contains arrows

<P><PRE>[[8 C 4] [8 C 7]]
</PRE>

<P>then <CODE>check.nd</CODE> will use the <EM>same</EM> alias state for this
pair, not inventing a new one.  The new
state is given arrows matching those of all its component states (4
and 7 in this example).  The new state might itself contain a nondeterministic
branch, but that's okay because the new state will eventually be processed
as we continue to traverse the machine graph.

<P>You might think that this process could go on forever: that each new
state <CODE>check.nd</CODE> invents will turn out to include nondeterminism, which
will require yet another new state to resolve.  Fortunately, that
doesn't happen; the process does always end eventually.  (In the next
chapter we'll see what the limit is on the number of necessary states
for the deterministic machine.)

<P>Because <CODE>determine</CODE> uses a graph traversal algorithm to examine
the original machine's states, it will never find &quot;orphan&quot; states
that can't be reached by arrows from some other state.  That's why
the process of making the machine deterministic also eliminates orphan
states, with no extra effort.

<P><H2>Eliminating Redundant States</H2>

<P>The machines produced by <CODE>determine</CODE> are runnable, but often ugly;
they contain many more states than necessary.  Procedure
<A HREF="fsm.html#optimize"><CODE>optimize</CODE></A>
eliminates many redundancies and also combines arrows with the same
head and tail but with different letters.
First it goes through the machine's arrow list,
creating a list for each state representing the exits from that state:

<P><CENTER><IMG SRC="optimize.gif" ALT="figure: optimize"></CENTER>
<PRE>   [[* [A B]] C]
State 1: [[A 2] [C 4]]
State 2: [[B 3]]
State 3: [[A 2] [C 4]]
State 4: []
</PRE>

<P>In this machine, states 1 and 3 have the same exit list.
(In these lists, each arrow is represented with only two members; the
arrow's tail is not included.  That's because states 1 and 3 would <EM>
not</EM> have identical lists if the tails were included.  State 1's list
would be

<P><PRE>[[1 A 2] [1 C 4]]
</PRE>

<P>and state 3's list would have arrows starting with 3.  In the
program, the two-member form of an arrow is called a <EM>stub.</EM>)

<P>The program must be careful about the order in which it puts stubs
in each state's list, so it doesn't end up with

<P><PRE>[[C 4] [A 2]]
</PRE>

<P>for one of the states.  That's why <A HREF="fsm.html#stub.add"><CODE>stub.add</CODE></A>
takes trouble
to insert each stub in a well-defined position, rather than just adding
each new stub at the beginning or end of the list.  It's also in
<CODE>stub.add</CODE> that arrows connecting the same two states but with different
letters are combined into a single arrow.

<P>Since states 1 and 3 also agree in their acceptingness (namely they aren't
accepting states), they can be combined into one state.  <CODE>
Optimize.state</CODE> can replace every reference to state 3 with a reference to
state 1.

<P><H2>A Finite-State Adder</H2>


<P>I promised earlier to show you a use for finite-state machines other
than accepting or rejecting strings.  In this section I'll fulfill
that promise by designing a machine to add two numbers.  We'll represent
the numbers in binary notation, in which each digit represents a power
of 2 instead of a power of 10.

<P>If you've come across binary numbers before, you can skip this paragraph.
Just as the ordinary notation for numbers is based on the ten digits 0 to 9,
binary notation is based on <EM>two</EM> digits, 0 and 1.  In ordinary
(&quot;decimal&quot;) notation, the amount that each digit contributes to the total
depends on where it is in the number.  For example, in the number 247, the
digit 2 contributes two hundred, not just two, because it's in the third
position counting from the right.  Each digit's contribution is the value of
the digit itself multiplied by a power of ten:
<P><CENTER>2&times;10<SUP><SMALL>2</SMALL></SUP>
+ 4&times;10<SUP><SMALL>1</SMALL></SUP>
+ 7&times;10<SUP><SMALL>0</SMALL></SUP></CENTER><P>
(10<SUP><SMALL>2</SMALL></SUP> is 100; 10<SUP><SMALL>1</SMALL></SUP> is 10; 10<SUP><SMALL>0</SMALL></SUP> is just 1.)  In binary, the
contribution of each digit is multiplied by a power of <EM>two,</EM> so the
binary number 10101 represents
<P><CENTER>1&times;2<SUP><SMALL>4</SMALL></SUP>
+ 0&times;2<SUP><SMALL>3</SMALL></SUP>
+ 1&times;2<SUP><SMALL>2</SMALL></SUP>
+ 0&times;2<SUP><SMALL>1</SMALL></SUP>
+ 1&times;2<SUP><SMALL>0</SMALL></SUP></CENTER><P>
which is 16+4+1 (2<SUP><SMALL>4</SMALL></SUP>+2<SUP><SMALL>2</SMALL></SUP>+2<SUP><SMALL>0</SMALL></SUP>) or 21.  Computers use binary notation
because it's easy to build electrical circuits in which each wire is either
on or off.  In Chapter 2 we'll talk about an example.  Right now I want to
show something different--not an actual electronic machine but an abstract
machine based on the ideas we've been using in this chapter.

<P>The machine will add two binary numbers, one digit position at a time, just
the way you add multi-digit numbers yourself.  When you see a problem like
<P><CENTER><TABLE><TR><TD align="right">376
<TR><TD align="right"><U>+572</U></TABLE></CENTER><P>
you start at the right and say, &quot;6 plus 2 is 8; 7 plus 7 is 14, which is
4 carry 1; 1 plus 3 plus 5 is 9.&quot;  The finite-state adder works the same
way except that the digits are always 0 or 1.

<P>The machine will add any numbers, but to explain how it works I want to
consider a specific example.  Let's say we want to add 52 and 21.  (By the
way, I didn't pick these numbers because they name card games, but because
the pattern of digits in their binary forms is convenient for the
explanation I want to give.)  52 in binary is 110100 (32+16+4) and 21 is
10101 (16+4+1).  I'm going to write these one above the other, with a couple
of extra zeros on the left to leave room for a possible carry:

<P><PRE>          0 0 1 1 0 1 0 0
          0 0 0 1 0 1 0 1
</PRE>

<P>Remember how a finite-state machine works:  At a given moment it's
in some <EM>state,</EM> then it reads some <EM>input</EM> symbol and goes to
another state.  In this problem, since we have two numbers to add, the most
natural way to think about it would be to give the machine <EM>two</EM> inputs
at a time.  This idea doesn't quite fit in with the formal definition of a
finite-state machine, but we can let the machine's &quot;alphabet&quot; consist of
<EM>pairs</EM> of digits, so something like <CODE>01</CODE> would be a single input.
(By the way, the word <EM>bit</EM> is commonly used as an abbreviation for
&quot;binary digit.&quot;)  Just as you added vertical pairs of digits (first 6 and 2,
then 7 and 7, and so on) in the earlier example, we'll use vertical pairs of
bits as the inputs to the finite-state adder, starting from the right end.
So the first input will be 01, then 00, then 11, then 00, then 11 again,
then 10, and then 00 twice.  From now on, in this section, when you see
something like 10 you should remember that it is a <EM>single</EM> input to
the finite-state machine, a single symbol, not two in a row.
(In the diagram below, an arrow labeled <CODE>01/10</CODE> represents two
arrows, one for the input <CODE>01</CODE> and one for the input <CODE>10</CODE>.  These
two arrows will always go to the same state because 0+1=1+0.)

<P>We need to make one change in the notation used in machine diagrams.
We no longer want to mark each state as accepting (double circle)
or rejecting (single circle).  Instead, each state produces an <EM>
output</EM> that can be any arbitrary symbol.  In this machine the outputs
will be 0 or 1, representing the binary digits of the sum.  Inside
each state circle, instead of just a state number you'll see something
like &quot;3/1&quot;; this means that it's state number 3 and that the output
from that state is 1.

<P>Here is the machine:

<P><CENTER><IMG SRC="fsm-add.gif" ALT="figure: fsm-add"></CENTER>

<P>State 1, the start state, has no output.  When the machine is in start
state it hasn't seen any digits of the addends yet, so it can't compute
a digit of the sum.  States 2 and 4 output a zero digit, while states
3 and 5 output a one.  (Like the inputs, the number that the machine
outputs is presented with its rightmost bit first.  The machine works
this way for the same reason that <EM>you</EM> add numbers from right
to left:  That's the direction in which a &quot;carry&quot; digit moves from
one column to another.)

<P>Why are there <EM>two</EM> zero-output states and <EM>two</EM> one-output
states?  The reason is that the machine is in state 4 or 5 when there
is a carry into the next digit of the sum.

<P>Let's trace through my example.  We start in state 1.  The first input
symbol is 01, representing a 0 in the rightmost (binary) digit of 52
and a 1 in the rightmost digit of 21.  The machine enters state 3
and outputs a 1.

<P>The next input is 00 because both numbers have zero as the second
digit.  The machine enters state 2 and outputs 0.

<P>The next input is 11.  The machine enters state 4 and outputs 0.  Being in
state 4 means that there is a carry from this position into the next.

<P>You can finish the example yourself.  The sum should be 01001001,
or 73.

<P><H2>Counting and Finite-State Machines</H2>

<P>Earlier we saw that you can't write a regular expression for a rule
that requires balanced parentheses.  Since regular expressions are
equivalent to finite-state machines, you won't be surprised to learn
that finite-state machines can't count.

<P>
Actually, they can count up to a point; it's just that each finite-state
machine can only count up to a fixed limit.  For example, here is
a finite-state machine that accepts strings of balanced parentheses
up to four deep:

<P><CENTER><IMG SRC="https://people.eecs.berkeley.edu/~bh/v3ch1/fourdeep.gif" ALT="figure: fourdeep"></CENTER>

<P>This machine will accept strings like these:

<P><PRE>          ()        (())      ()()
          (()())    (((())))  (((())))(())
</PRE>

<P>There is no limit to the <EM>length</EM> of the string this
machine can handle.  For example, it will accept this:

<P><PRE>          ()()()()()()()()()()()()()()
</PRE>

<P>But there can be no more than four parentheses open <EM>
at once</EM>; the machine will reject

<P><PRE>          ((((()))))
</PRE>

<P>Even this limited counting ability of finite-state machines is of great
practical value.  Real computers, after all, are finite-state
machines.  Any real computer has a finite amount of memory, and this
memory can be in a finite number of states.  But the number is quite
huge.  If a real computer includes a parenthesis-counting program
that is limited to, say, 20,000 levels of parentheses, nobody will
ever notice that the limit isn't infinite.

<P>(The number of states in a real computer may be even larger than you're
thinking.  Each bit of computer memory isn't a state.  Instead, if
a computer has <EM>n</EM> bits of memory it has 2<SUP><SMALL>n</SMALL></SUP> states!  For
example, a computer with three bits of memory can use those bits to
represent <EM>eight</EM> states:

<P><PRE>0 0 0
0 0 1
0 1 0
0 1 1
1 0 0
1 0 1
1 1 0
1 1 1
</PRE>

<P>The number of possible states in a typical large computer
is greater than the number of atoms in the galaxy.)

<P>In a moment I'm going to talk about a theoretical model of a machine
with infinite memory.  You might wonder why it pays to study such
machines, since any real machine has to be limited in memory.  The
answer has to do with my example about the 20,000 levels of parentheses.
It is theoretically possible to write a regular expression for such
strings.  To show you how it's done, here is a regular expression
for up to three levels:

<P><CENTER><IMG SRC="xx2.gif"></CENTER>

<P>(I've drawn boxes around the actual alphabet-rule symbols just to
make it a little easier for you to distinguish between the parentheses,
which are symbols in the input strings, and the brackets, which are part of
the glue that holds a regular expression together.)

<P>There is no theoretical problem about extending this regular expression
to allow up to 20,000 parentheses.  But a machine based on this technique
would be very large and complicated.  Instead, it makes more sense to
<EM>pretend</EM> that the computer has an infinite amount of memory available
and use a formal system (like the production rules I mentioned briefly)
that depends on an infinite memory.  Such a formal system leads to
a shorter, more elegant expression of the balanced parentheses rule.
In practice, we can provide enough memory for any of the strings our
program will actually meet.

<P><H2>Turing Machines</H2>

<P>One way we might explore infinite machines is to imagine that they're
represented by state diagrams, like those of finite-state machines,
but with an infinite number of states.  For example, here is a picture
of an infinite-capacity parenthesis counter:

<P><CENTER><IMG SRC="waydeep.gif" ALT="figure: waydeep"></CENTER>

<P>The trouble with this idea is that it's hard to model precisely what's
meant by that row of dots on the right.  There's no way we can have
a <EM>complete</EM> formal description of an infinitely complex machine.

<P>Instead, consider what <EM>you</EM> do when you have to solve a problem
too complex to fit in your own memory.  You don't build yourself a
bigger brain; you get a pencil and some paper.  That is, you use <EM>
external</EM> storage.  You can imagine that your brain is a finite-state
machine but that it has access to an infinite supply of paper.

<P>Of course, this division of a problem's necessary information into
a finite <EM>internal</EM> state and an infinite <EM>external</EM> memory
also models actual computers in an obvious way.  The internal state
in the model represents the internal memory of the computer, while
the external memory in the model represents such storage devices as
disks and tapes.  To solve a bigger problem you don't have to buy
a bigger computer; you just have to switch floppy disks occasionally.

<P>You might think that the mathematical model I'm talking about was
based on the analogy with real computers and that my story about the finite-state
brain is just a coincidence.  But in fact this model was invented
by Alan M. Turing in 1936, before there were any computers!  It was
<EM>human</EM> problem-solving that Turing wanted to model with a machine.

<P>What is a Turing machine?  Start by imagining a finite-state machine
with different possible outputs, like the adder we saw earlier.  Attached
to this machine is a tape of limitless length.  Symbols from some
alphabet, like the machine's input and output symbols, can be written
on the tape.  There is a reading and writing mechanism, like the heads
of a magnetic tape recorder, that can travel along the tape.

<P>Just as each state of the machine can have an output associated with
it, each state can also take action to affect the tape:  It can move
the head by one symbol in either direction and it can change the
symbol at the head's current position.

<P>In fact, we simplify the formal description of the machine by
using the tape as the input/output device as well as the storage device.
That is, we can start with some sequence of symbols already written
on the tape.  That sequence serves as the input to the machine; state
transitions are based on the symbol under the tape head, not a symbol
from some other source.  Likewise, the output from a state (if any)
is written on the tape.

<P>Somewhat analogous to the concept of an accepting state in our earlier
examples, a Turing machine can have <EM>halting</EM> states.  When the
machine enters a halting state it stops its operation.  There are
no more state transitions.  The output from the machine is whatever
sequence of symbols it leaves written on the tape.

<P><H2>Turing's Thesis</H2>


<P>Turing invented his abstract machine because he was trying to formalize
the idea of an <EM>effective procedure</EM>:  What does it mean to specify
a technique for solving some problem well enough that we can be sure
it will really work?  As an analogy, think about directions for driving
from here to somewhere.  Someone can hand you a piece of paper with
a list of instructions like &quot;When you get to the gas station
on the left, turn right.&quot;  But sometimes you get directions that
weren't careful enough.  There may be a sharp right turn and a mild
right turn available near the gas station.  There may be a fork in
the road before you even get to the gas station.

<P>Turing's idea is that any problem for which there is <EM>any</EM> effective
procedure can be modeled by a Turing machine.  The phrase &quot;any effective
procedure&quot; is taken to include the workings of the human mind.  If
Turing is right, any problem that a person can solve can be programmed
for a computer.

<P>This claim isn't something that can be proved or disproved mathematically
because there is no prior formal definition of &quot;effective procedure&quot;
to which Turing machines can be compared.  Also, it may be that the
idea of a procedure somehow doesn't cover all the different kinds
of thinking that people do.  Maybe it's true, for example, that computers
are potentially as powerful as people at solving problems, but &quot;solving
problems&quot; might not turn out to be an appropriate description of
what's going on when we feel emotions.  If that turned
out to be true, we <EM>should</EM> expect a computer to become the world's
chess champion someday, but we <EM>shouldn't</EM> expect one to become
the world's champion poet.

<P>But this possible conclusion has been attacked from both sides.  Some
people think that emotions really <EM>are</EM> a matter of computable
procedures.  Kenneth Colby's program called Parry attempts to model
the behavior of a paranoid human being by manipulating variables
for emotions like anger and fear.  On the other hand, some people
think that even chess doesn't fall within the realm of things that
people do by carrying out effective procedures in Turing's sense.
A chess master, these people say, doesn't analyze the chess board
in a step-by-step fashion like a computer.  He looks at the board
as a single, whole entity, and the important features just spring
to mind by some process that is still rather mysterious.

<P>What <EM>is</EM> known is that several other mathematical models of effective
procedures have been shown to be equivalent to Turing machines, in
the same sense in which regular expressions are equivalent to finite-state
machines.  For example, all of the popular programming languages are
Turing-equivalent.  There's no such thing as a computation that can
be done in Logo but not in Pascal, or vice versa.  (Of course, one
language may be more <EM>convenient</EM> than another for a given problem.)

<P><H2>The Halting Theorem</H2>


<P>I'm not going to get into specific examples of Turing machine programming
here.  That would take too much space for a single chapter; if you're
interested you should pursue the topic in a book on automata theory.
But I want to give one example of the theoretical value of Turing machines.

<P>You've undoubtedly had the experience of writing a Logo program with a bug
that causes an &quot;infinite loop&quot;--you run the program and it just sits there
forever, when instead it's supposed to compute and print some results.
That's a frustrating kind of bug because you're never quite sure if the
program is really broken or if it's just very slow.  Maybe if you waited
another minute it would come up with the answer.  Wouldn't it be great if,
when you started the program running, Logo could print an error message like
<CODE>This program has an infinite loop</CODE>, just as it does for other errors?

<P>It turns out that infinite loops can't, in general, be detected
automatically.  Certainly <EM>some</EM> infinite loops are very easy to spot,
and we can write programs that catch certain categories of infinite loop.
But we can't write a program that's <EM>guaranteed</EM> to catch infinite
loops in programs, in Logo or any other Turing-equivalent language.  The
fact that it's impossible is called the <EM>halting theorem.</EM>

<P>It's a little tricky understanding just what the halting theorem says because
it involves Turing machines that manipulate Turing machines as data, which
is a kind of self-reference akin to recursion.  Self-reference is always hard
to talk about and can lead to paradoxes like the classic &quot;This statement
is false.&quot; (Is the sentence in quotes true or false?  If it's true, then it
must be false, because it says so.  But if it's false, and it <EM>says</EM>
it's false, it must really be true!)  So let's proceed carefully.

<P>The data recorded on a Turing machine's tape is a string of symbols.
Generally we choose the symbols to represent something meaningful; for
example, a string of digits can represent a number.  Earlier in this chapter
we used strings of symbols like

<P><PRE>[1 [[1 A 2] [2 B 3] [3 A 2]] [1 3]]
</PRE>

<P>to represent a finite-state machine.  There's no reason we
couldn't put <EM>that</EM> string of symbols on the tape of a Turing machine
as its input.  For example, we could build a Turing machine that would work
like my <CODE>fsm</CODE> program, simulating the finite-state machine that it found
written on its tape when it started.

<P>Letting a Turing machine simulate a finite-state machine doesn't raise
questions of self-reference.  But a Turing machine, too, is a formal
structure; it, too, can be represented as a string of symbols.

<P>Because a representation of a Turing machine can be the input to another
Turing machine, we can design Turing machines that answer questions about
Turing machines.  For example, we can write a <EM>universal</EM> Turing
machine, one that simulates any Turing machine the way <CODE>fsm</CODE> simulates
any finite-state machine.

<P>A universal Turing machine (a Turing machine simulator) sort of half-solves
the halting problem.  Suppose we want to know whether a given machine will
halt after it is started with a given input.  (This is like asking whether a
certain Logo procedure will terminate if it's invoked with a particular
input.)  We can use the universal Turing machine to simulate the one we're
interested in.  If the machine <EM>does</EM> halt, we'll find out about it.
But if the machine in question <EM>doesn't</EM> halt, then the simulator
won't halt either.  We'll still have the problem we had in the first
place--how can we be sure it won't finally halt if we give it another
minute?

<P>To solve the halting problem, what we need is a Turing machine that accepts
a representation of any Turing machine as input, just like the universal
Turing machine.  But this one has to be guaranteed to halt, even if the
input machine wouldn't halt.  That's what the halting theorem says we can't
do.

<P><H2>Proving the Halting Theorem in Logo</H2>

<P>What makes it possible to raise the question of whether a Turing machine can
decide whether another Turing machine would halt for a given input tape is
the fact that one Turing machine's &quot;program&quot; can be represented as data
for another Turing machine.  This is also true of Logo procedures.  In
particular, the higher-order procedures like <CODE>map</CODE> and <CODE>filter</CODE>
manipulate other procedures by accepting their names as inputs.
We can, therefore, use Logo
procedures to illustrate the proof of the halting theorem.

<P>We'll consider a Logo procedure with an input as analogous to a Turing
machine with its input tape.  We want to prove that there can't be a Logo
procedure that could tell whether such a procedure stops for a given input.
The technique we use is called <EM>proof by contradiction.</EM>  In this
technique we assume that there <EM>is</EM> such a procedure, then show that
this assumption leads to a paradox.

<P>So let's imagine that someone has written a Logo predicate <CODE>haltp</CODE> that
takes two inputs: the name of a procedure and an input value for that
procedure.  <CODE>Haltp</CODE> will output <CODE>true</CODE> if the procedure it's testing
would eventually stop, given the specified input; <CODE>haltp</CODE> outputs <CODE>
false</CODE> if the procedure it's testing would get into an infinite loop, like a
recursive procedure without a stop rule.  (In practice, if you think about
your own experience debugging programs, it's easy to tell if a procedure
doesn't have a stop rule at all, but not so easy to be sure that the stop
rule will always eventually be satisfied.  Think about a Pig Latin program
given a word of all consonants as input.  We want

<P><PRE>to piglatin :word
if memberp first :word [a e i o u] [output word :word &quot;ay]
output piglatin word bf :word first :word
end

? <U>print haltp &quot;piglatin &quot;salami</U>
true
? <U>print haltp &quot;piglatin &quot;mxyzptlk</U>
false
</PRE>

<P>Remember that <CODE>haltp</CODE> itself must <EM>always</EM> stop, even
in the case where <CODE>piglatin</CODE> wouldn't stop.)

<P>Now consider this Logo procedure:

<P><PRE>to try :proc
if haltp :proc :proc [loop]
end

to loop
loop
end
</PRE>

<P>Since <CODE>haltp</CODE> works, we're assuming, on <EM>any</EM> Logo
procedure with one input, it must work on <CODE>try</CODE> in particular.
What happens if we say

<P><PRE>? <U>try &quot;try</U>
</PRE>

<P>Does this stop or loop?  Suppose it stops.  <CODE>try</CODE> begins its
work by evaluating the expression

<P><PRE>haltp &quot;try &quot;try
</PRE>

<P>Since we've said <CODE>try</CODE> will stop, given <CODE>try</CODE> as input,
<CODE>haltp</CODE> will output <CODE>true</CODE>.  It follows, from the definition of <CODE>
try</CODE>, that <CODE>try</CODE> will invoke <CODE>loop</CODE> and will <EM>not</EM> stop.
Similarly, if we start with the assumption that <CODE>try</CODE> will loop, then
<CODE>haltp</CODE> must output <CODE>false</CODE> and so, from the definition of <CODE>
try</CODE>, you can see that <CODE>try</CODE> <EM>will</EM> stop.  Whatever value <CODE>
haltp</CODE> outputs turns out to be incorrect.

<P>It was the assumption that we could write an infallible <CODE>haltp</CODE> that led
us into this contradiction, so that assumption must be wrong.  We can't write
a Logo procedure that will automatically detect infinite loops in our
programs.  A similar proof could be made in any language in which one program
can manipulate another program as data--that is, in any Turing-equivalent
language.

<P>
<TABLE width="100%"><TR><TD><A HREF="../v3-toc2.html">(back to Table of Contents)</A>
<TD align="right"><A HREF="../v3ch0/v3ch0.html"><STRONG>BACK</STRONG></A>
chapter thread <A HREF="../v3ch2/v3ch2.html"><STRONG>NEXT</STRONG></A>
</TABLE>

<P><H2>Program Listing</H2>

<P><P>
<P><PRE>
;;; Finite State Machine Interpreter (<A NAME="fsm">FSM</A>)

to game :which
fsm thing word "mach :which
end

to fsm :machine
cleartext
setcursor [0 3]
localmake "start startpart :machine
localmake "moves movepart :machine
localmake "accept acceptpart :machine
fsm1 :start
end

to fsm1 :here
ifelse memberp :here :accept [accept] [reject]
fsm1 (fsmnext :here readchar)
end

to fsmnext :here :input
blank
if memberp :input (list char 13 char 10) ~
   [print ifelse memberp :here :accept ["| ACCEPT|] ["| REJECT|]
    output :start]
type :input
catch "error [output last find [fsmtest :here :input ?] :moves]
output -1
end

to fsmtest :here :input :move
output and (equalp :here arrowtail :move) ~
           (memberp :input arrowtext :move)
end

;; Display machine state

to accept
display "accept
end

to reject
display "reject
end

to blank
display "|      |
end

to display :text
localmake "oldpos cursor
setcursor [15 1]
type :text
setcursor :oldpos
end

;; Data abstraction for machines

to startpart :machine
output first :machine
end

to movepart :machine
output first bf :machine
end

to acceptpart :machine
output last :machine
end

to make.machine :start :moves :accept
output (list :start :moves :accept)
end

;; Data abstraction for arrows

to arrowtail :arrow
output first :arrow
end

to arrowtext :arrow
output first butfirst :arrow
end

to arrowhead :arrow
output last :arrow
end

to make.arrow :tail :text :head
output (list :tail :text :head)
end

;; Machine descriptions for the guessing game

make "mach1 [1 [[1 AB 1]] [1]]
make "mach2 [1 [[1 ABC 2] [2 ABC 1]] [1]]
make "mach3 [1 [[1 A 2] [2 B 3] [3 ABC 3]] [3]]
make "mach4 [1 [[1 A 2] [1 B 3] [1 C 4] [2 A 1] [3 B 1] [4 C 1]] [1]]
make "mach5 [1 [[1 ABC 2] [2 B 1]] [1]]
make "mach6 [1 [[1 A 2] [2 AB 2] [2 C 3] [3 AB 2] [3 C 3]] [3]]
make "mach7 [1 [[1 AB 1] [1 C 2] [2 C 1]] [1]]
make "mach8 [1 [[1 A 2] [1 BC 1] [2 A 1] [2 BC 2]] [1]]
make "mach9 [1 [[1 AB 1] [1 C 2] [2 A 3] [2 B 1] [3 A 1]] [1]]
make "mach10 [1 [[1 A 2] [1 BC 1] [2 A 2] [2 B 3] [2 C 1]
                 [3 A 2] [3 B 1] [3 C 4] [4 A 2] [4 B 5] [4 C 1]
                 [5 A 6] [5 BC 1] [6 ABC 6]]
              [6]]


;;; Regular Expression to FSM Translation (<A NAME="machine">MACHINE</A>)

to machine :regexp
localmake "nextstate 0
output optimize determine nondet :regexp
end

;; First step: make a possibly <A NAME="nondet">nondeterministic</A> machine

to nondet :regexp
if and (wordp :regexp) (equalp count :regexp 1) ~
   [output ndletter :regexp]
if wordp :regexp [output ndor reduce "sentence :regexp]
if equalp first :regexp "or [output ndor butfirst :regexp]
if equalp first :regexp "* [output ndmany last :regexp]
output ndconcat :regexp
end

;; <A NAME="ndletter">Alphabet</A> rule

to ndletter :letter
localmake "from newstate
localmake "to newstate
output (make.machine :from
                     (list (make.arrow :from :letter :to))
                     (list :to))
end

;; <A NAME="ndconcat">Concatenation</A> rule

to ndconcat :exprs
output reduce "string (map "nondet :exprs)
end

to string :machine1 :machine2
output (make.machine (startpart :machine1)
                     (sentence (movepart :machine1)
                               (splice acceptpart :machine1 :machine2)
                               (movepart :machine2))
                     (stringa (acceptpart :machine1)
                              (startpart :machine2)
                              (acceptpart :machine2)))
end

to stringa :accept1 :start2 :accept2
if memberp :start2 :accept2 [output sentence :accept1 :accept2]
output :accept2
end

;; <A NAME="ndor">Alternatives</A> rule

to ndor :exprs
localmake "newstart newstate
localmake "machines (map "nondet :exprs)
localmake "accepts map.se "acceptpart :machines
output (make.machine :newstart
                     (sentence map.se "movepart :machines
                               map.se "or.splice :machines)
                     ifelse not emptyp find [memberp (startpart ?)
                                                     (acceptpart ?)]
                                            :machines
                            [fput :newstart :accepts]
                            [:accepts])
end

to or.splice :machine
output map [newtail ? :newstart] (arrows.from.start :machine)
end

;; <A NAME="ndmany">Repetition</A> rule

to ndmany :regexp
localmake "machine nondet :regexp
output (make.machine (startpart :machine)
                     sentence (movepart :machine)
                              (splice (acceptpart :machine) :machine)
                     fput (startpart :machine) (acceptpart :machine))
end

;; <A NAME="splice">Generate</A> moves from a bunch of given states (:accepts) duplicating
;; the moves from the start state of some machine (:machine).
;; Used for concatenation rule to splice two formerly separate machines;
;; used for repetition rule to "splice" a machine to itself.

to splice :accepts :machine
output map.se [copy.to.accepts ?] (arrows.from.start :machine)
end

to arrows.from.start :machine
output filter [equalp startpart :machine arrowtail ?] movepart :machine
end

to copy.to.accepts :move
output map [newtail :move ?] :accepts
end

to newtail :arrow :tail
output make.arrow :tail (arrowtext :arrow) (arrowhead :arrow)
end

;; <A NAME="newstate">Make</A> a new state number

to newstate
make "nextstate :nextstate+1
output :nextstate
end

;; Second step: Turn nondeterministic FSM into a <A NAME="determine">deterministic</A> one
;; Also eliminates "orphan" (unreachable) states.

to determine :machine
localmake "moves movepart :machine
localmake "accepts acceptpart :machine
localmake "states []
localmake "join.state.list []
localmake "newmoves nd.traverse (startpart :machine)
output make.machine (startpart :machine) ~
                    :newmoves ~
                    filter [memberp ? :states] :accepts
end

to <A NAME="nd.traverse">nd.traverse</A> :state
if memberp :state :states [output []]
make "states fput :state :states
localmake "newmoves (check.nd filter [equalp arrowtail ? :state] :moves)
output sentence :newmoves map.se "nd.traverse (map "arrowhead :newmoves)
end

to <A NAME="check.nd">check.nd</A> :movelist
if emptyp :movelist [output []]
localmake "letter arrowtext first :movelist
localmake "heads sort map "arrowhead ~
                          filter [equalp :letter arrowtext ?] :movelist
if emptyp butfirst :heads ~
   [output fput first :movelist
                check.nd filter [not equalp :letter arrowtext ?]
                                :movelist]
localmake "check.heads member :heads :join.state.list
if not emptyp :check.heads ~
   [output fput make.arrow :state :letter first butfirst :check.heads ~
                check.nd filter [not equalp :letter arrowtext ?]
                                :movelist]
localmake "join.state newstate
make "join.state.list fput :heads fput :join.state :join.state.list
make "moves sentence :moves ~
                     map [make.arrow :join.state
                                     arrowtext ?
                                     arrowhead ?] ~
                         filter [memberp arrowtail ? :heads] :moves
if not emptyp find [memberp ? :accepts] :heads ~
   [make "accepts sentence :accepts :join.state]
output fput make.arrow :state :letter :join.state ~
            check.nd filter [not equalp :letter arrowtext ?] :movelist
end

to sort :list
if emptyp :list [output []]
output insert first :list sort butfirst :list
end

to insert :value :sorted
if emptyp :sorted [output (list :value)]
if :value = first :sorted [output :sorted]
if :value < first :sorted [output fput :value :sorted]
output fput first :sorted insert :value butfirst :sorted
end

;; Third step: <A NAME="optimize">Combine</A> redundant states.
;; Also combines arrows with same head and tail: 
;;   [1 A 2] [1 B 2] -> [1 AB 2].

to optimize :machine
localmake "stubarray array :nextstate
foreach (movepart :machine) "array.save
localmake "states sort fput (startpart :machine) ~
                            map "arrowhead movepart :machine
localmake "start startpart :machine
foreach reverse :states [optimize.state ? ?rest]
output (make.machine :start
                     map.se [fix.arrows ? item ? :stubarray] :states
                     filter [memberp ? :states] acceptpart :machine)
end

to array.save :move
setitem (arrowtail :move) :stubarray ~
        stub.add (arrow.stub :move) (item (arrowtail :move) :stubarray)
end

to <A NAME="stub.add">stub.add</A> :stub :stublist
if emptyp :stublist [output (list :stub)]
if (stub.head :stub) < (stub.head first :stublist) ~
   [output fput :stub :stublist]
if (stub.head :stub) = (stub.head first :stublist) ~
   [output fput make.stub letter.join (stub.text :stub)
                                      (stub.text first :stublist)
                          stub.head :stub
                butfirst :stublist]
output fput first :stublist (stub.add :stub butfirst :stublist)
end

to letter.join :this :those
if emptyp :those [output :this]
if beforep :this first :those [output word :this :those]
output word (first :those) (letter.join :this butfirst :those)
end

to optimize.state :state :others
localmake "candidates ~
          filter (ifelse memberp :state acceptpart :machine
                         [[memberp ? acceptpart :machine]]
                         [[not memberp ? acceptpart :machine]]) ~
                 :others
localmake "mymoves item :state :stubarray
localmake "twin find [equalp (item ? :stubarray) :mymoves] :candidates
if emptyp :twin [stop]
make "states remove :state :states
if equalp :start :state [make "start :twin]
foreach :states ~
        [setitem ? :stubarray 
                 (cascade [emptyp ?2]
                          [stub.add (change.head :state :twin first ?2)
                                    ?1]
                          filter [not equalp stub.head ? :state]
                                 item ? :stubarray
                          [butfirst ?2]
                          filter [equalp stub.head ? :state]
                                 item ? :stubarray)]
end

to change.head :from :to :stub
if not equalp (stub.head :stub) :from [output :stub]
output list (stub.text :stub) :to
end

to fix.arrows :state :stublist
output map [stub.arrow :state ?] :stublist
end

;; Data abstraction for "stub" arrow (no tail)

to arrow.stub :arrow
output butfirst :arrow
end

to make.stub :text :head
output list :text :head
end

to stub.text :stub
output first :stub
end

to stub.head :stub
output last :stub
end

to stub.arrow :tail :stub
output fput :tail :stub
end
</PRE><P>

<P><A HREF="../v3-toc2.html">(back to Table of Contents)</A>
<P><A HREF="../v3ch0/v3ch0.html"><STRONG>BACK</STRONG></A>
chapter thread <A HREF="../v3ch2/v3ch2.html"><STRONG>NEXT</STRONG></A>

<P>
<ADDRESS>
<A HREF="../index.html">Brian Harvey</A>, 
<CODE>bh@cs.berkeley.edu</CODE>
</ADDRESS>
</BODY>
</HTML>
6 20:43:59 +0100 committer James Booth <boothj5@gmail.com> 2015-07-26 20:43:59 +0100 Use command definition macros for remaining commands' href='/danisanti/profani-tty/commit/src/command/command.c?id=59d5dd73a77b2a85e199ad43e9ba4591b2bfbe08'>59d5dd73 ^
90dda0e9 ^


59d5dd73 ^

15cdc69f ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^

59d5dd73 ^








4f4f780e ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^


59d5dd73 ^
90dda0e9 ^


59d5dd73 ^



90dda0e9 ^






59d5dd73 ^

90dda0e9 ^



b33f4777 ^
59d5dd73 ^

4f4f780e ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^
2e99df1a ^






59d5dd73 ^

90dda0e9 ^
59d5dd73 ^

2e99df1a ^







59d5dd73 ^

9fd7b2b3 ^
be379afa ^
0ff29b3d ^


08f43bee ^

59d5dd73 ^






be379afa ^
6bad38c2 ^
0ff29b3d ^


08f43bee ^
59d5dd73 ^






22102bdd ^
fc049c9e ^
0ff29b3d ^


eb550eed ^
08f43bee ^
eb550eed ^
59d5dd73 ^







fc049c9e ^
8f6b37f6 ^
0ff29b3d ^


8f6b37f6 ^


e3471fbf ^
8f6b37f6 ^





4f4f780e ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^


90dda0e9 ^

59d5dd73 ^




2f8a53fa ^
6a8656a0 ^
0ff29b3d ^


6a8656a0 ^

bab75cae ^
6a8656a0 ^

003cdcf3 ^
bab75cae ^

6a8656a0 ^
003cdcf3 ^

6a8656a0 ^
bab75cae ^








6a8656a0 ^


446027b9 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
eb550eed ^
59d5dd73 ^




29bc58f5 ^
59d5dd73 ^

446027b9 ^
373b3a2d ^
52c01a8e ^
0ff29b3d ^

eb550eed ^
08f43bee ^
52c01a8e ^


383e601f ^



52c01a8e ^
383e601f ^
52c01a8e ^
383e601f ^









52c01a8e ^
383e601f ^



52c01a8e ^

46583839 ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^







46583839 ^
40dc8e2c ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^
a952776b ^

90dda0e9 ^
99fc70bd ^

59d5dd73 ^
90dda0e9 ^



59d5dd73 ^

b9948a4c ^





4d703c7e ^

b9948a4c ^



99fc70bd ^


59d5dd73 ^
6feaa122 ^


99fc70bd ^
6feaa122 ^
59d5dd73 ^
40dc8e2c ^
c249a60c ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^
90dda0e9 ^
59d5dd73 ^



90dda0e9 ^
59d5dd73 ^


13f73a30 ^
d3cc5bd7 ^


































720dce86 ^
d3cc5bd7 ^




6f5c0eb5 ^

a957c545 ^
d6e7f389 ^
95b639a2 ^
59382984 ^

d3cc5bd7 ^


720dce86 ^
d3cc5bd7 ^
95b639a2 ^
d6e7f389 ^
95b639a2 ^







720dce86 ^
d6e7f389 ^

95b639a2 ^
59382984 ^
720dce86 ^
d3cc5bd7 ^

0aa758cb ^
d3cc5bd7 ^
0aa758cb ^




d3cc5bd7 ^

0aa758cb ^
d3cc5bd7 ^
0aa758cb ^
d3cc5bd7 ^

0aa758cb ^


4f4f780e ^
0ff29b3d ^


eb550eed ^
08f43bee ^


59d5dd73 ^
3fbee402 ^


20e63e36 ^

f243e333 ^

90dda0e9 ^

b79d7740 ^



60305de0 ^

3fbee402 ^

90dda0e9 ^



59d5dd73 ^

e758f74e ^

59d5dd73 ^
f243e333 ^


f14a3e07 ^

f243e333 ^


















59d5dd73 ^
3fbee402 ^

20e63e36 ^
2fc984e6 ^

90dda0e9 ^

3fbee402 ^
90dda0e9 ^
59d5dd73 ^

f4882004 ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^


90dda0e9 ^
59d5dd73 ^




4f4f780e ^
4cb1d73a ^
d00615be ^
0ff29b3d ^

4cb1d73a ^


d00615be ^
c6a6e3a5 ^

4cb1d73a ^


c6a6e3a5 ^


4cb1d73a ^

4cb1d73a ^
8258e7a3 ^
0ff29b3d ^


eb550eed ^
08f43bee ^

59d5dd73 ^







8258e7a3 ^
9d700f3f ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^







852112cd ^
2b0108e6 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^
90dda0e9 ^
59d5dd73 ^

90dda0e9 ^
59d5dd73 ^

90dda0e9 ^
59d5dd73 ^

90dda0e9 ^
59d5dd73 ^

2b0108e6 ^
2ca8f5b6 ^
0ff29b3d ^


eb550eed ^
eb550eed ^
59d5dd73 ^







4f4f780e ^
3983ee1d ^

0ff29b3d ^
3983ee1d ^
eb550eed ^

59d5dd73 ^
3983ee1d ^

59d5dd73 ^


90dda0e9 ^
59d5dd73 ^


90dda0e9 ^
8ba2d269 ^
0ff29b3d ^


08f43bee ^
59d5dd73 ^
cb7504e6 ^

59d5dd73 ^



cb7504e6 ^

59d5dd73 ^

cb7504e6 ^

8978f809 ^
cb7504e6 ^
59d5dd73 ^

8ba2d269 ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^


cb7504e6 ^


59d5dd73 ^




8c5866ff ^

0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




7982d706 ^

0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^







acb152d4 ^
2490c3ed ^
0ff29b3d ^


eb550eed ^
98ea7446 ^

59d5dd73 ^
cb7504e6 ^

fc1ee791 ^
cb7504e6 ^


98ea7446 ^

59d5dd73 ^
cb7504e6 ^
59d5dd73 ^

cb7504e6 ^
fc1ee791 ^
55c2d1cc ^

cb7504e6 ^


98ea7446 ^

59d5dd73 ^
cb7504e6 ^


98ea7446 ^

59d5dd73 ^
2490c3ed ^
d9395daa ^
0ff29b3d ^
















eb550eed ^
98ea7446 ^

59d5dd73 ^
cb7504e6 ^








9f4e2c03 ^
98ea7446 ^

59d5dd73 ^


9f4e2c03 ^


















59d5dd73 ^
cb7504e6 ^

9f4e2c03 ^
cb7504e6 ^




98ea7446 ^

59d5dd73 ^
d9395daa ^
4be7833e ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^







7982d706 ^
3d6ebf48 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




3d6ebf48 ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^

59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




e559c33d ^

0ff29b3d ^


08f43bee ^
59d5dd73 ^
cb7504e6 ^


59d5dd73 ^



cb7504e6 ^


f14a3e07 ^
59d5dd73 ^

a114fe88 ^
48f9f3b3 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




48f9f3b3 ^
2762f18a ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^
cb7504e6 ^
59d5dd73 ^



cb7504e6 ^
59d5dd73 ^


2762f18a ^
921f026c ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^







921f026c ^
213ccc01 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^
f27cae68 ^

59d5dd73 ^


f27cae68 ^

59d5dd73 ^

213ccc01 ^
4ba33cb1 ^
0ff29b3d ^


08f43bee ^

59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




4ba33cb1 ^
5a625dd8 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^
cb7504e6 ^
54e225aa ^

59d5dd73 ^

0c07b7cf ^
59d5dd73 ^
54e225aa ^









59d5dd73 ^
54e225aa ^




59d5dd73 ^

5a625dd8 ^
a114fe88 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^


cb7504e6 ^
59d5dd73 ^




a0a1f901 ^
b52dcfe5 ^
0ff29b3d ^












eb550eed ^
926d935e ^
08f43bee ^


59d5dd73 ^
cb7504e6 ^











091a23fc ^


cb7504e6 ^




091a23fc ^
cb7504e6 ^
904a5a81 ^
7f65aaa9 ^
53fc89f7 ^
cb7504e6 ^




904a5a81 ^
609d0536 ^
e043029a ^

59d5dd73 ^
cb7504e6 ^
59d5dd73 ^

091a23fc ^














f14a3e07 ^
091a23fc ^

609d0536 ^
091a23fc ^


904a5a81 ^
6640a089 ^

7f65aaa9 ^
1012e112 ^
6640a089 ^
53fc89f7 ^
091a23fc ^




904a5a81 ^
53fc89f7 ^
609d0536 ^
e043029a ^
609d0536 ^
59d5dd73 ^
cb7504e6 ^







f14a3e07 ^
59d5dd73 ^
b52dcfe5 ^
41fe8c22 ^
5f1ba08f ^
a9fab9ed ^
5f1ba08f ^
a9fab9ed ^
cd86f5bc ^
a5a7db9e ^
a9fab9ed ^



0ff29b3d ^
41fe8c22 ^

03ab8baf ^
5f1ba08f ^


cd86f5bc ^
a5a7db9e ^
a9fab9ed ^
c405367d ^
4209b1cf ^

41fe8c22 ^
03ab8baf ^

5f1ba08f ^


cd86f5bc ^
a5a7db9e ^
5f1ba08f ^



03ab8baf ^
5f1ba08f ^

74942da0 ^
a5a7db9e ^
cd86f5bc ^
74942da0 ^


41fe8c22 ^

b52dcfe5 ^
0ff29b3d ^


08f43bee ^
59d5dd73 ^
232cc760 ^
59d5dd73 ^
cb7504e6 ^
59d5dd73 ^

cb7504e6 ^




232cc760 ^


59d5dd73 ^

b52dcfe5 ^

0ff29b3d ^


eb550eed ^

59d5dd73 ^
cb7504e6 ^

adb470c4 ^

59d5dd73 ^


2df622f9 ^



59d5dd73 ^
cb7504e6 ^
59d5dd73 ^

b52dcfe5 ^
e6e0a13e ^
0ff29b3d ^


eb550eed ^

59d5dd73 ^






e6e0a13e ^
4f4f780e ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^






cb7504e6 ^
59d5dd73 ^

4f4f780e ^

0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^






cb7504e6 ^
59d5dd73 ^

4f4f780e ^

0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^






cb7504e6 ^
59d5dd73 ^

4f4f780e ^
6bad38c2 ^
0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^






cb7504e6 ^
59d5dd73 ^

4f4f780e ^

0ff29b3d ^


eb550eed ^
08f43bee ^
59d5dd73 ^






cb7504e6 ^
59d5dd73 ^

0769fc6b ^

0ff29b3d ^


0769fc6b ^


0769fc6b ^


a35cbea7 ^
0769fc6b ^


0769fc6b ^






fa6a26c6 ^

0ff29b3d ^


fa6a26c6 ^







f73f88c5 ^
fa6a26c6 ^
ca022ec7 ^

c9f6a78f ^





ca022ec7 ^

ec5fc361 ^

ca022ec7 ^
c9f6a78f ^
ca022ec7 ^
c9f6a78f ^

ca022ec7 ^
c9f6a78f ^

4a5b672f ^


063a5d1c ^
4a5b672f ^
f9216fdd ^
b3be504e ^
063a5d1c ^
b3be504e ^
4a5b672f ^




2602cbf7 ^
b3be504e ^
063a5d1c ^
b3be504e ^
4a5b672f ^


2602cbf7 ^
b3be504e ^

4a5b672f ^
2602cbf7 ^
063a5d1c ^

4a5b672f ^
467b5cce ^
6bad38c2 ^
fd6620a9 ^




























68cb8c9a ^
fd6620a9 ^






68cb8c9a ^
fd6620a9 ^







2fafaec8 ^



























fd6620a9 ^


a39440b6 ^












fd6620a9 ^
fd6620a9 ^
a39440b6 ^



fd6620a9 ^

a39440b6 ^

68cb8c9a ^
fd6620a9 ^

22102bdd ^
0f7f0a25 ^


279737ba ^
b3f60232 ^
1730372e ^
2bbac1c8 ^
7aa177c6 ^
eaf2901b ^
c8567cd7 ^
da51d998 ^
fd6620a9 ^
c8567cd7 ^








fd6620a9 ^
da51d998 ^
fd6620a9 ^
c8567cd7 ^
eaf2901b ^
c8567cd7 ^
527e739a ^
5d85974b ^


2b3cc65b ^
5d85974b ^
eaf2901b ^
5d85974b ^

d668d150 ^
1730372e ^

3f8813bb ^
2490f5b4 ^
3f8813bb ^
eaf2901b ^
68cb8c9a ^
7e26fcdf ^

eb550eed ^
cded90bc ^
eb550eed ^
08f43bee ^
eb550eed ^
08f43bee ^



0ed3b53b ^

eb550eed ^

eb105e91 ^

3656c782 ^
eb105e91 ^

3656c782 ^
eb105e91 ^
3656c782 ^
3656c782 ^

eb105e91 ^

4e18d659 ^
eb105e91 ^









d0117cda ^
eb105e91 ^
0ff29b3d ^
66631308 ^
eb105e91 ^
66631308 ^

eb105e91 ^

66631308 ^

d0117cda ^












e0dfe483 ^

























36ebf0fc ^


e0dfe483 ^
36ebf0fc ^


































19fb907b ^
36ebf0fc ^

19fb907b ^

36ebf0fc ^

19fb907b ^


36ebf0fc ^
19fb907b ^
36ebf0fc ^

19fb907b ^
e0dfe483 ^






36ebf0fc ^
e0dfe483 ^
129af0ea ^
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
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
  
             
  
                                                            
  












                                                                       
                                                                      
  











                                                                                

   

                     
                   
 
                   

                   
                   
                  
                   
                   

                      


                 


                      


                              


                               
                            
                           
                            
                               
                         
                          
                  
                           





                              
 


                    
 


                    
 
                                  
                                       



                                        
                                
                                     
 




                                                            


                                                    
                                 
                                               
                                                            
                                      
                                                   
 

                            

                                                                   
  
               
   
                                    
 
              
                                             

                              
                  
                
                                                                              
                 
                                                                             

                                                                                                            

                                                                                      
                 



                                                                                                                            
                     
                                               

                             

                        

               


                               
                  



                                                    

                      
      
 
                 


                                 
                 
                               
                
                                   
                                                                                                        
                 

                                                                                    

                                                                                                

                                                                                                                              


                                                                                                                               
                                                                                            
                                                                                                                                                                               
                                                                       
                     



                                                                   
                                                                          
                                                             

          
             








                                               
                 

                               

                         
                          
                        
                                        
                         
                           
                                        

                                       
                                  
                                    
                               


                                        


                                                                                             
                                                                            
                                                                               
                                                                                                            
                                                                                                                              


                                                                                                   
                                                                              
                                                                                                   
                                                                                          


                      
                    


                                    
                 
                               



                                                        

                      
      
 
             


                                             
                 
                         
                
                                         

                                      

                                                                                                     

                                                          
                                                                                              
                                                                                        
                                                                                             

                                                                                           


                                                              

                                                  
 
                


                                             
                 
                           
                       
                

                             

                                                                                            
                                             

                                             
                                          
                                              
                                            
                                                    
                                               
                                           
                                             
                                                   

                                       
                                             
                                               





                                                
                                           
                                     
                                  



                                          




                                                                      
                                                                                     
                                                                       





                                                                                                    
                                                                               
                                                                                 
                                                                       





                                                                                                    
                                                                               
                                                                                 



                                                                                                

                                                                                           










                                                                                                                            

                                                                            

                                                                             




                                                                                                  

                                                                                                  
                                                                                       
                                                                                                    


                                                                                                                                     
                                                                                                
                                                                                       
                                                                                                 

                                                                                                  
                                                                                                  

                                                                                                   
                                                                                                                   
                                                                                                                                                           
                                                                                                        
                                                                                                 




                                                                                 
                     



                                                     
                                                           
                                               

                              
 













                                                                                                       
                                                                                                                                                       




                                                                                          
               


                                             
                 

                           
                

                                  
                                          




                                                               
                                                                                
                                                                        

                                                                             



                                                      

                                                     
 
              


                               



                              
                
                    





                                                                                          
                                                                               

                                                                                                     
                                            

                        
 
              


                               
                 


                              
                
                    

                                     
                                                                                 

                                                                                       
                                                                                                                        

                                                                                                   

                                                   

                          
 
                  


                                  
                 


                              
                
                        





                                                                                                               
                                                                                                                                

                                                                                                           

                                                       

                              
 
                


                                


                              
                
                      




                                                                                                     
                                                                            

                                                                                               
                                       

                          
 
                  


                                                 
                 
                         
                       
                


                                       



                                                                                    


                                                                                               
                                                                                                
                      
      
 
              


                               
                 
                              
                
                    

                                                               



                                                                                                                                        


                                                                                              
                                                                      

                                                                            



                                                                                  

                         
 
               


                               
                 
                              


                     
                                              

                      
      
 
                


                                             

                              




                                                                     
                                                               
                                                                            
                      
      
 
                 


                                             

                              



                                                                                          

                      
      

                 


                                             

                              





                                                                         
                      
      
 
              


                               

                              




                                          

                                                                                      
                                                      
                      
      
 
              


                                             

                              




                                            
                                                                              
                                                                        
                      
      
 
             


                                             

                              




                                       
                                                                         
                                                                    
                      
      
 
                 


                                             

                              
                
                                     
                                      
                                      
                                     

                             
                                                  
                 
                                                          
                                                                                                                        
                                                                                                                               
                                                                                                                               
                                                            
                      
      
 
                     


                                             

                              
                
                                                              
                                                
                 
                                        

                                                                               
                                                                                                                       
                                                                                                                                 
                      
      

              


                                             

                              
                
                                                 
                                  
                 
                                 

                                                                          
                                                                                                               
                                                                                                                        
                      
      
 
                   


                                                 
                 
                              
                       
                

                                                 



                                                                                 





                                                                                                     
                                                                                                                 
                      
      

              


                               

                              
                


                           



                                  


                                                                      
                                                                              
                      
      
 
               
                               

                               

                              
                
                     
                                   
                                       

                                                     
                 
                                                                                 
                                                                                                                               
                                                                                                     
                 

                                                                         
                                                                                                             
                                                                                  
                     
                     
                                        
                                                   
                                                                        
      
 
                  


                                  

                              
                

                             
                                                                                           
                                                                                            
                                        

                                       
                 
                                                          

                                                                                                       
                                              

                                                                                                                                      



                                                                                                          

                                                                                                       

                      
 
               


                               
                 
                              
                
                                  

                                   
                                                                         

                                                                                              
                                                                                      

                                                                         


                                                 

                                                     
 
                  


                                             













                                                             
                      


                                      


                             
                                   

                                    
                                                                                     
                 

                                                                                                     

                            
                                




                                                        
              


                                             
                 
                              







                                                             
 
             


                               
                 
                       
                





                                     

                              


                                            







                                                                                            





                                               

                                                     
      
 
              


                                              
                                             
                                            
                              
                 
                       
                

                           
                          

                                           
                              

                                                                                                            
                                                                               
                                                                                       


                                                                                           
 
             


                               
                 
                           
                




                                   

                            
                                                        

                                                                            




                                                                                             

                                                                                                     


                                               

                        
 
              


                               
                 

                              








                                                     
 
             


                               
                 


                              
                


                                                                                       



                                                                                      






                                                                                                             

                                                                                       



                                  
                               

                         
 
               


                               
                 
                       
                






                                       

                              
                             

                                                             







                                                                                            

                      
 
               


                               

                       






                                        
 
              


                               
                  






                                                                 
 
                    


                                                   
                 
                              
                       







                                                                                      
 
                 


                                 


                       
                       





                                                                                              
              


                                             

                       


                           

                                                                       




                                                                                                   
 
                 


                                                

                       
                         

                              
                                           

                                              
                 

                                                                                            
                 








                                                                                                     


                      
                 


                                                
                 
                         
                       




                                           
                                                                                               

                      
 
                  
                                                 

                                  
                 
                       


                              



                                                
                 
                                                                                                                    
                 









                                                                                                        
                     



                                     

      
              


                                             

                       







                                                                                
 
              


                                             

                       
                

                                                                     
                                           

                                              
                 



                                                                                                                   

                                                                                       





                                                                                      

                                                                                   



                                                                                         


                                                                                     
                     


                                                   
                                        
                                                           
      
 
                  


                                                 

                       
                
                                         



                                                                                                                                 
                                                                                                                                          


                                                                                                                              
 


































                                                                
                                                  




                                   

                                          
                                         
                                        
                                                       

                                       


                              
                                                    
                 
                                                                                                                            
                                                                                                                                   







                                                                                                                     
                     

                                   
                                   
                                  
                                   

      
                  
                                               




                                  

                             
                 
                                     
                 

                                                                 


                      
                


                                             
                 


                              
                


                                          

                                          

                                                                   

                                          



                                                 

                                     

                                     



                                            

                                 

                                                                                                                      
                 


                                                                                                                                    

                                                                                                                      


















                                                                                                                                                              
                     

                                   
                                      

                                            

                                       
                                
                                

                                
 
               


                                              

                       


                            
                                                                                             




                                                                                
 
              
                                             

                              


                       
                           

                                    


                                                                           


                                                                                          

                      
 
                


                                               
                 

                         







                                                                                          
 
                


                                               

                       







                                                                                                 
 
                     


                                                    
                 
                               
                
                                         

                               
                                                         

                                                                                       
                                                                     

                                                        
                                                

                               
 
                  


                                  
                 
                       







                                                                                                
 

                                                 
                      
                                  

                       
                

                                       


                                                              
                                                                                                          


                                                                                        
 
               


                                             
                  
                

                                        



                                                   

                                                                 

                                                                

                                                     
                                                       
                              

                          
 
               


                                              
                 
                         


                            


                                                                          




                                                                                             

               


                                              
                 
                              


                            
                                                  




                                                                              

                


                                               
                 
                         







                                                                                                                     
 
             


                               
                 

                         
                

                          
                            


                                            

                                     
                 
                                                                                                 

                                                                
                                                                                                        
                                                                                 

                                                                                              


                                                                                                                       

                                                                                                                                         
                     


                                                               

                          
      
 
             
















                                               
                 

                         
                








                                                
                                                                  

                                     


                                                                                                             


















                                                                                                                                                                                        
                     

                                 
                                                              




                                                                     

                          
      
 
                 


                                                
                 
                         







                                                                                                           
 
              


                                             
                 
                         


                              
                                                                                          




                                                                                                                                              
 
                 


                                                
                 

                         


                              
                                                                                                           




                                                                                    

             


                                            
                  
                


                                   



                                             


                                                                                                                 
                                                                                                                                                   

                      
 
                 


                                                
                 
                         


                              
                                                 




                                                                                                                                               
 
                  


                                                 
                 
                         
                
                                       



                                                                                                                         
                                                                                                


                                                                                                                        
 
                   


                                                  
                 
                               







                                                                                                                  
 
                  


                                                 
                 
                               
                

                                          


                                                                                                                   

                                                                                                                                 

                      
 
              


                               

                               


                            
                                                            




                                                                      
 
                  


                                                               
                 
                             
                
                                           

                                                      

                                     
                                                      
                 









                                                                                                                      
                     




                                                                           

                                  
 
                  


                                  
                 
                             


                                   
                                                    




                                                                                           
 
                 












                                                  
                 
                               


                              
                











                                                     


                                                           




                                                             
                                                  
                                                         
                                                          
                                                                          
                                                   




                                                     
                                                
                                                   

                                                
                 
                                                           

                                                                                          














                                                                                                                                           
                                                                                                                               

                                                                                                                                                                         
                                                                                                                                              


                                                                                                                   
                                                                                                        

                                                                                                                                                    
                                                                                                                 
                                                                                                                                                                                                    
                                                                                            
                                                                                              




                                                                                                               
                                                                                                          
                                                                                                             
                                                                                                                                    
                                                                                                         
                                                                                                   
                     







                                                            
                                          
      
 
                 
                               
                     
                                                         
                                                      
                                                        
                                                     



                                                             
                                 

                  
                       


                                             
                                            
                                       
                                         
                                       

                                         
                 

                                                                                   


                                                                                                                                                                          
                                                                
                                                                        



                                                                                                                                                    
                     

                                                                            
                                                                    
                                                                   
                                            


                                           

      
               


                               
                  
                
                                                                 
                 
                                                                     

                                                          




                                                                


                                                          

                      

               


                                              

                       
                

                                  

                                


                                                             



                                                                                                         
                     
                          

                                 
 
                    


                                    

                       






                                                                               
 
              


                                             
                 
                             






                                                                         
                    

                                   

              


                                             
                 
                             






                                                                         
                    

                                       

             


                                             
                 
                             






                                                                         
                   

                                   
 
                


                                             
                 
                             






                                                                         
                      

                                    

            


                                             
                 
                             






                                                                         
                  

                                                         

                


                                


                                   


                                    
                                   


                                                                                                                              






                                                                              

                


                                







                                                         
                                          
                                     

      





                                         

                  

                                          
                 
                                       
                 

                                                                    
                     

                             


               
                               
                     
                                     
                                         
                                         
                                                     




                         
                         
                                       
                                                     
                                 


                                                                                          
                                                                                                  

                                                                                                             
                     
                         

                                                                                                   
      
  
 




























                                                                            
                                      






                                                  
                       







                                



























                                                                              


                          












                                                                             
             
         



                                                      

     

                          
 

                   
 


                                               
    
              
 
                                      
 
                  
 
                                                                                
 








                                                         
                              
                                                                               
 
                                                  
                             
     
 


                                         
                  
                                      
                                

                                 
                                

 
    
                
 
                    
                                       

 
        
                                    
 
                                                  
                                                   



                                                    

                                                

 

                                  
 

                                                      
            
                    
     

 

                                      
 









                                                         
                                          
                                                                                                              
             
                
                                                                                                          

         

                            

 












                                                      

























                                                                            


                                                                                     
 


































                                                                             
 

                                                             

                                                   

                                                                       


                                                        
         
 

                                                                                    
 






                                        
                                                                
                      
 
/*
 * cmd_defs.c
 *
 * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
 *
 * This file is part of Profanity.
 *
 * Profanity is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Profanity is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Profanity.  If not, see <https://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link the code of portions of this program with the OpenSSL library under
 * certain conditions as described in each individual source file, and
 * distribute linked combinations including the two.
 *
 * You must obey the GNU General Public License in all respects for all of the
 * code used other than OpenSSL. If you modify file(s) with this exception, you
 * may extend this exception to your version of the file(s), but you are not
 * obligated to do so. If you do not wish to do so, delete this exception
 * statement from your version. If you delete this exception statement from all
 * source files in the program, then also delete it here.
 *
 */

#define _GNU_SOURCE 1

#include "config.h"

#include <assert.h>
#include <errno.h>
#include <limits.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <libgen.h>
#include <dirent.h>
#include <sys/types.h>

#include <glib.h>

#include "profanity.h"
#include "log.h"
#include "common.h"
#include "command/cmd_defs.h"
#include "command/cmd_funcs.h"
#include "command/cmd_ac.h"
#include "config/accounts.h"
#include "config/preferences.h"
#include "config/theme.h"
#include "config/tlscerts.h"
#include "config/scripts.h"
#include "plugins/plugins.h"
#include "tools/autocomplete.h"
#include "tools/parser.h"
#include "tools/tinyurl.h"
#include "ui/ui.h"
#include "ui/window_list.h"
#include "xmpp/xmpp.h"
#include "xmpp/contact.h"
#include "xmpp/roster_list.h"
#include "xmpp/jid.h"
#include "xmpp/chat_session.h"
#include "xmpp/muc.h"

#ifdef HAVE_LIBOTR
#include "otr/otr.h"
#endif

#ifdef HAVE_LIBGPGME
#include "pgp/gpg.h"
#endif

#define CMD_TAG_CHAT        "chat"
#define CMD_TAG_GROUPCHAT   "groupchat"
#define CMD_TAG_ROSTER      "roster"
#define CMD_TAG_PRESENCE    "presence"
#define CMD_TAG_CONNECTION  "connection"
#define CMD_TAG_DISCOVERY   "discovery"
#define CMD_TAG_UI          "ui"
#define CMD_TAG_PLUGINS     "plugins"

#define CMD_MAINFUNC(func)  func,
#define CMD_NOMAINFUNC      NULL,
#define CMD_SUBFUNCS(...)   { __VA_ARGS__, { NULL, NULL } },
#define CMD_NOSUBFUNCS      { { NULL, NULL } },

#define CMD_NOTAGS          { { NULL },
#define CMD_TAGS(...)       { { __VA_ARGS__, NULL },
#define CMD_SYN(...)        { __VA_ARGS__, NULL },
#define CMD_DESC(desc)      desc,
#define CMD_NOARGS          { { NULL, NULL } },
#define CMD_ARGS(...)       { __VA_ARGS__, { NULL, NULL } },
#define CMD_NOEXAMPLES      { NULL } }
#define CMD_EXAMPLES(...)   { __VA_ARGS__, NULL } }

GHashTable *commands = NULL;

static gboolean _cmd_has_tag(Command *pcmd, const char *const tag);

/*
 * Command list
 */
static struct cmd_t command_defs[] =
{
    { "/help",
        parse_args_with_freetext, 0, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_help)
        CMD_NOTAGS
        CMD_SYN(
            "/help [<area>|<command>|search_all|search_any] [<search_terms>]")
        CMD_DESC(
            "Help on using Profanity. Passing no arguments list help areas. "
            "For command help, optional arguments are shown using square brackets, "
            "arguments representing variables rather than a literal name are surrounded by angle brackets. "
            "Arguments that may be one of a number of values are separated by a pipe "
            "e.g. val1|val2|val3.")
        CMD_ARGS(
            { "<area>",                     "Summary help for commands in a certain area of functionality." },
            { "<command>",                  "Full help for a specific command, for example '/help connect'." },
            { "search_all <search_terms>",  "Search commands for returning matches that contain all of the search terms." },
            { "search_any <search_terms>",  "Search commands for returning matches that contain any of the search terms." })
        CMD_EXAMPLES(
            "/help search_all presence online",
            "/help commands",
            "/help presence",
            "/help who")
    },

    { "/about",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_about)
        CMD_NOTAGS
        CMD_SYN(
            "/about")
        CMD_DESC(
            "Show version and license information.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/connect",
        parse_args, 0, 7, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_connect)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/connect [<account>]",
            "/connect <account> [server <server>] [port <port>] [tls force|allow|trust|legacy|disable]")
        CMD_DESC(
            "Login to a chat service. "
            "If no account is specified, the default is used if one is configured. "
            "A local account is created with the JID as it's name if it doesn't already exist.")
        CMD_ARGS(
            { "<account>",         "The local account you wish to connect with, or a JID if connecting for the first time." },
            { "server <server>",   "Supply a server if it is different to the domain part of your JID." },
            { "port <port>",       "The port to use if different to the default (5222, or 5223 for SSL)." },
            { "tls force",         "Force TLS connection, and fail if one cannot be established, this is default behaviour." },
            { "tls allow",         "Use TLS for the connection if it is available." },
            { "tls trust",         "Force TLS connection and trust server's certificate." },
            { "tls legacy",        "Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established." },
            { "tls disable",       "Disable TLS for the connection." })
        CMD_EXAMPLES(
            "/connect",
            "/connect myuser@gmail.com",
            "/connect myuser@mycompany.com server talk.google.com",
            "/connect bob@someplace port 5678",
            "/connect me@localhost.test.org server 127.0.0.1 tls disable",
            "/connect me@chatty server chatty.com port 5443")
        },

    { "/tls",
        parse_args, 1, 3, NULL,
        CMD_SUBFUNCS(
            { "certpath",   cmd_tls_certpath },
            { "trust",      cmd_tls_trust },
            { "trusted",    cmd_tls_trusted },
            { "revoke",     cmd_tls_revoke },
            { "show",       cmd_tls_show },
            { "cert",       cmd_tls_cert })
        CMD_NOMAINFUNC
        CMD_TAGS(
            CMD_TAG_CONNECTION,
            CMD_TAG_UI)
        CMD_SYN(
            "/tls allow",
            "/tls always",
            "/tls deny",
            "/tls cert [<fingerprint>]",
            "/tls trust",
            "/tls trusted",
            "/tls revoke <fingerprint>",
            "/tls certpath",
            "/tls certpath set <path>",
            "/tls certpath clear",
            "/tls certpath default",
            "/tls show on|off")
        CMD_DESC(
            "Handle TLS certificates. ")
        CMD_ARGS(
            { "allow",                "Allow connection to continue with TLS certificate." },
            { "always",               "Always allow connections with TLS certificate." },
            { "deny",                 "Abort connection." },
            { "cert",                 "Show the current TLS certificate." },
            { "cert <fingerprint>",   "Show details of trusted certificate." },
            { "trust",                "Add the current TLS certificate to manually trusted certificates." },
            { "trusted",              "List summary of manually trusted certificates (with '/tls always' or '/tls trust')." },
            { "revoke <fingerprint>", "Remove a manually trusted certificate." },
            { "certpath",             "Show the trusted certificate path." },
            { "certpath set <path>",  "Specify filesystem path containing trusted certificates." },
            { "certpath clear",       "Clear the trusted certificate path." },
            { "certpath default",     "Use default system certificate path, if it can be found." },
            { "show on|off",          "Show or hide the TLS indicator in the titlebar." })
        CMD_NOEXAMPLES
    },

    { "/disconnect",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_disconnect)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/disconnect")
        CMD_DESC(
            "Disconnect from the current chat service.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/msg",
        parse_args_with_freetext, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_msg)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/msg <contact> [<message>]",
            "/msg <nick> [<message>]")
        CMD_DESC(
            "Send a one to one chat message, or a private message to a chat room occupant. "
            "If the message is omitted, a new chat window will be opened without sending a message. "
            "Use quotes if the nickname includes spaces.")
        CMD_ARGS(
            { "<contact>",             "Open chat window with contact, by JID or nickname." },
            { "<contact> [<message>]", "Send message to contact, by JID or nickname." },
            { "<nick>",                "Open private chat window with chat room occupant." },
            { "<nick> [<message>]",    "Send a private message to a chat room occupant." })
        CMD_EXAMPLES(
            "/msg myfriend@server.com Hey, here's a message!",
            "/msg otherfriend@server.com",
            "/msg Bob Here is a private message",
            "/msg \"My Friend\" Hi, how are you?")
    },

    { "/roster",
        parse_args_with_freetext, 0, 4, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_roster)
        CMD_TAGS(
            CMD_TAG_ROSTER,
            CMD_TAG_UI)
        CMD_SYN(
            "/roster",
            "/roster online",
            "/roster show [offline|resource|presence|status|empty|priority|contacts|rooms]",
            "/roster hide [offline|resource|presence|status|empty|priority|contacts|rooms]",
            "/roster by group|presence|none",
            "/roster count unread|items|off",
            "/roster count zero on|off",
            "/roster order name|presence",
            "/roster unread before|after|off",
            "/roster room char <char>|none",
            "/roster room private char <char>|none",
            "/roster room position first|last",
            "/roster room by service|none",
            "/roster room order name|unread",
            "/roster room unread before|after|off",
            "/roster room show server",
            "/roster room hide server",
            "/roster private room|group|off",
            "/roster private char <char>|none",
            "/roster header char <char>|none",
            "/roster presence indent <indent>",
            "/roster contact char <char>|none",
            "/roster contact indent <indent>",
            "/roster resource char <char>|none",
            "/roster resource indent <indent>",
            "/roster resource join on|off",
            "/roster size <percent>",
            "/roster wrap on|off",
            "/roster add <jid> [<nick>]",
            "/roster remove <jid>",
            "/roster remove_all contacts",
            "/roster nick <jid> <nick>",
            "/roster clearnick <jid>")
        CMD_DESC(
            "Manage your roster, and roster display settings. "
            "Passing no arguments lists all contacts in your roster.")
        CMD_ARGS(
            { "online",                     "Show all online contacts in console." },
            { "show",                       "Show the roster panel." },
            { "show offline",               "Show offline contacts in roster panel." },
            { "show resource",              "Show contact's connected resources in roster panel." },
            { "show presence",              "Show contact's presence in roster panel." },
            { "show status",                "Show contact's status message in roster panel." },
            { "show empty",                 "Show empty groups in roster panel." },
            { "show priority",              "Show resource priority in roster panel." },
            { "show contacts",              "Show contacts in roster panel." },
            { "show rooms",                 "Show chat rooms in roster panel." },
            { "hide",                       "Hide the roster panel." },
            { "hide offline",               "Hide offline contacts in roster panel." },
            { "hide resource",              "Hide contact's connected resources in roster panel." },
            { "hide presence",              "Hide contact's presence in roster panel." },
            { "hide status",                "Hide contact's status message in roster panel." },
            { "hide empty",                 "Hide empty groups in roster panel." },
            { "hide priority",              "Hide resource priority in roster panel." },
            { "hide contacts",              "Hide contacts in roster panel." },
            { "hide rooms",                 "Hide chat rooms in roster panel." },
            { "by group",                   "Group contacts in roster panel by roster group." },
            { "by presence",                "Group contacts in roster panel by presence." },
            { "by none",                    "No grouping in roster panel." },
            { "count unread",               "Show unread message count with roster headers." },
            { "count items",                "Show item count with roster headers." },
            { "count off",                  "Do not show any count with roster headers." },
            { "count zero on",              "Show roster header count when 0." },
            { "count zero off",             "Hide roster header count when 0." },
            { "order name",                 "Order roster contacts by name only." },
            { "order presence",             "Order roster contacts by presence, and then by name." },
            { "unread before",              "Show unread message count before contact." },
            { "unread after",               "Show unread message count after contact." },
            { "unread off",                 "Do not show unread message count for contacts." },
            { "room char <char>",           "Prefix rooms with specified character." },
            { "room char none",             "Remove room character prefix." },
            { "room private char <char>",   "Prefix private room chat with specified character when displayed with room." },
            { "room private char none",     "Remove private room chat character prefix when displayed with room." },
            { "room position first",        "Show rooms first in roster." },
            { "room position last",         "Show rooms last in roster." },
            { "room by service",            "Group rooms by chat service." },
            { "room by none",               "Do not group rooms." },
            { "room order name",            "Order rooms by name." },
            { "room order unread",          "Order rooms by unread messages, and then by name." },
            { "room unread before",         "Show unread message count before room." },
            { "room unread after",          "Show unread message count after room." },
            { "room unread off",            "Do not show unread message count for rooms." },
            { "room show server",           "Show the conference server with room JIDs." },
            { "room hide server",           "Do not show the conference server with room JIDs." },
            { "private room",               "Show room private chats with the room." },
            { "private group",              "Show room private chats as a separate roster group." },
            { "private off",                "Do not show room private chats." },
            { "private char <char>",        "Prefix private room chats with specified character when displayed in separate group." },
            { "private char none",          "Remove private room chat character prefix." },
            { "header char <char>",         "Prefix roster headers with specified character." },
            { "header char none",           "Remove roster header character prefix." },
            { "contact char <char>",        "Prefix roster contacts with specified character." },
            { "contact char none",          "Remove roster contact character prefix." },
            { "contact indent <indent>",    "Indent contact line by <indent> spaces (0 to 10)." },
            { "resource char <char>",       "Prefix roster resources with specified character." },
            { "resource char none",         "Remove roster resource character prefix." },
            { "resource indent <indent>",   "Indent resource line by <indent> spaces (0 to 10)." },
            { "resource join on|off",       "Join resource with previous line when only one available resource." },
            { "presence indent <indent>",   "Indent presence line by <indent> spaces (-1 to 10), a value of -1 will show presence on the previous line." },
            { "size <precent>",             "Percentage of the screen taken up by the roster (1-99)." },
            { "wrap on|off",                "Enable or disable line wrapping in roster panel." },
            { "add <jid> [<nick>]",         "Add a new item to the roster." },
            { "remove <jid>",               "Removes an item from the roster." },
            { "remove_all contacts",        "Remove all items from roster." },
            { "nick <jid> <nick>",          "Change a contacts nickname." },
            { "clearnick <jid>",            "Removes the current nickname." })
        CMD_EXAMPLES(
            "/roster",
            "/roster add someone@contacts.org",
            "/roster add someone@contacts.org Buddy",
            "/roster remove someone@contacts.org",
            "/roster nick myfriend@chat.org \"My Friend\"",
            "/roster clearnick kai@server.com",
            "/roster size 15")
    },

    { "/blocked",
        parse_args, 0, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_blocked)
        CMD_TAGS(
            CMD_TAG_ROSTER,
            CMD_TAG_CHAT)
        CMD_SYN(
            "/blocked",
            "/blocked add [<jid>]",
            "/blocked remove <jid>")
        CMD_DESC(
            "Manage blocked users, calling with no arguments shows the current list of blocked users.")
        CMD_ARGS(
            { "add [<jid>]",    "Block the specified Jabber ID. If in a chat window and no jid is specified, the current recipient will be blocked." },
            { "remove <jid>",   "Remove the specified Jabber ID from the blocked list." })
        CMD_EXAMPLES(
            "/blocked add spammer@spam.org")
    },

    { "/group",
        parse_args_with_freetext, 0, 3, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_group)
        CMD_TAGS(
            CMD_TAG_ROSTER,
            CMD_TAG_UI)
        CMD_SYN(
            "/group",
            "/group show <group>",
            "/group add <group> <contat>",
            "/group remove <group> <contact>")
        CMD_DESC(
            "View, add to, and remove from roster groups. "
            "Passing no argument will list all roster groups.")
        CMD_ARGS(
            { "show <group>",             "List all roster items in a group." },
            { "add <group> <contact>",    "Add a contact to a group." },
            { "remove <group> <contact>", "Remove a contact from a group." })
        CMD_EXAMPLES(
            "/group",
            "/group show friends",
            "/group add friends newfriend@server.org",
            "/group add family Brother",
            "/group remove colleagues boss@work.com")
    },

    { "/info",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_info)
        CMD_TAGS(
            CMD_TAG_ROSTER,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/info",
            "/info <contact>|<nick>")
        CMD_DESC(
            "Show information about a contact, room, or room member. "
            "Passing no argument in a chat window will use the current recipient. "
            "Passing no argument in a chat room will display information about the room.")
        CMD_ARGS(
            { "<contact>", "The contact you wish to view information about." },
            { "<nick>",    "When in a chat room, the occupant you wish to view information about." })
        CMD_EXAMPLES(
            "/info mybuddy@chat.server.org",
            "/info kai")
    },

    { "/caps",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_caps)
        CMD_TAGS(
            CMD_TAG_DISCOVERY,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/caps",
            "/caps <fulljid>|<nick>")
        CMD_DESC(
            "Find out a contacts, or room members client software capabilities. "
            "If in private chat initiated from a chat room, no parameter is required.")
        CMD_ARGS(
            { "<fulljid>", "If in the console or a chat window, the full JID for which you wish to see capabilities." },
            { "<nick>",    "If in a chat room, nickname for which you wish to see capabilities." })
        CMD_EXAMPLES(
            "/caps mybuddy@chat.server.org/laptop",
            "/caps mybuddy@chat.server.org/phone",
            "/caps bruce")
    },

    { "/software",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_software)
        CMD_TAGS(
            CMD_TAG_DISCOVERY,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/software",
            "/software <fulljid>|<nick>")
        CMD_DESC(
            "Find out a contact, or room members software version information. "
            "If in private chat initiated from a chat room, no parameter is required. "
            "If the contact's software does not support software version requests, nothing will be displayed.")
        CMD_ARGS(
            { "<fulljid>", "If in the console or a chat window, the full JID for which you wish to see software information." },
            { "<nick>",    "If in a chat room, nickname for which you wish to see software information." })
        CMD_EXAMPLES(
            "/software mybuddy@chat.server.org/laptop",
            "/software mybuddy@chat.server.org/phone",
            "/software bruce")
    },

    { "/status",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_status)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/status",
            "/status <contact>|<nick>")
        CMD_DESC(
            "Find out a contact, or room members presence information. "
            "If in a chat window the parameter is not required, the current recipient will be used.")
        CMD_ARGS(
            { "<contact>", "The contact who's presence you which to see." },
            { "<nick>",    "If in a chat room, the occupant who's presence you wish to see." })
        CMD_EXAMPLES(
            "/status buddy@server.com",
            "/status jon")
    },

    { "/resource",
        parse_args, 1, 2, &cons_resource_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_resource)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/resource set <resource>",
            "/resource off",
            "/resource title on|off",
            "/resource message on|off")
        CMD_DESC(
            "Override chat session resource, and manage resource display settings.")
        CMD_ARGS(
            { "set <resource>", "Set the resource to which messages will be sent." },
            { "off",            "Let the server choose which resource to route messages to." },
            { "title on|off",   "Show or hide the current resource in the titlebar." },
            { "message on|off", "Show or hide the resource when showing an incoming message." })
        CMD_NOEXAMPLES
    },

    { "/join",
        parse_args, 0, 5, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_join)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/join",
            "/join <room> [nick <nick>] [password <password>]")
        CMD_DESC(
            "Join a chat room at the conference server. "
            "If no room is supplied, a generated name will be used with the format private-chat-[UUID]. "
            "If the domain part is not included in the room name, the account preference 'muc.service' will be used. "
            "If no nickname is specified the account preference 'muc.nick' will be used which by default is the localpart of your JID. "
            "If the room doesn't exist, and the server allows it, a new one will be created.")
        CMD_ARGS(
            { "<room>",              "The chat room to join." },
            { "nick <nick>",         "Nickname to use in the room." },
            { "password <password>", "Password if the room requires one." })
        CMD_EXAMPLES(
            "/join",
            "/join jdev@conference.jabber.org",
            "/join jdev@conference.jabber.org nick mynick",
            "/join private@conference.jabber.org nick mynick password mypassword",
            "/join jdev")
    },

    { "/leave",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_leave)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/leave")
        CMD_DESC(
            "Leave the current chat or room.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/invite",
        parse_args_with_freetext, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_invite)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/invite <contact> [<message>]")
        CMD_DESC(
            "Send an invite to a contact for the current chat room.")
        CMD_ARGS(
            { "<contact>", "The contact you wish to invite." },
            { "<message>", "An optional message to send with the invite." })
        CMD_NOEXAMPLES
    },

    { "/invites",
        parse_args_with_freetext, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_invites)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/invites")
        CMD_DESC(
            "Show all rooms that you have been invited to, and not accepted or declined.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/decline",
        parse_args_with_freetext, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_decline)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/decline <room>")
        CMD_DESC(
            "Decline a chat room invitation.")
        CMD_ARGS(
            { "<room>", "The room for the invite you wish to decline." })
        CMD_NOEXAMPLES
    },

    { "/room",
        parse_args, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_room)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/room accept|destroy|config")
        CMD_DESC(
            "Chat room configuration.")
        CMD_ARGS(
            { "accept",  "Accept default room configuration." },
            { "destroy", "Reject default room configuration, and destroy the room." },
            { "config",  "Edit room configuration." })
        CMD_NOEXAMPLES
    },

    { "/kick",
        parse_args_with_freetext, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_kick)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/kick <nick> [<reason>]")
        CMD_DESC(
            "Kick occupant from chat room.")
        CMD_ARGS(
            { "<nick>",   "Nickname of the occupant to kick from the room." },
            { "<reason>", "Optional reason for kicking the occupant." })
        CMD_NOEXAMPLES
    },

    { "/ban",
        parse_args_with_freetext, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_ban)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/ban <jid> [<reason>]")
        CMD_DESC(
            "Ban user from chat room.")
        CMD_ARGS(
            { "<jid>",    "Bare JID of the user to ban from the room." },
            { "<reason>", "Optional reason for banning the user." })
        CMD_NOEXAMPLES
    },

    { "/subject",
        parse_args_with_freetext, 0, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_subject)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/subject set <subject>",
            "/subject edit <subject>",
            "/subject prepend <text>",
            "/subject append <text>",
            "/subject clear")
        CMD_DESC(
            "Set, modify, or clear room subject.")
        CMD_ARGS(
            { "set <subject>",  "Set the room subject." },
            { "edit <subject>", "Edit the current room subject, tab autocompletion will display the subject to edit." },
            { "prepend <text>", "Prepend text to the current room subject, use double quotes if a trailing space is needed." },
            { "append <text>",  "Append text to the current room subject, use double quotes if a preceding space is needed." },
            { "clear",          "Clear the room subject." })
        CMD_NOEXAMPLES
    },

    { "/affiliation",
        parse_args_with_freetext, 1, 4, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_affiliation)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/affiliation set <affiliation> <jid> [<reason>]",
            "/affiliation list [<affiliation>]")
        CMD_DESC(
            "Manage room affiliations. "
            "Affiliation may be one of owner, admin, member, outcast or none.")
        CMD_ARGS(
            { "set <affiliation> <jid> [<reason>]", "Set the affiliation of user with jid, with an optional reason." },
            { "list [<affiliation>]",               "List all users with the specified affiliation, or all if none specified." })
        CMD_NOEXAMPLES
    },

    { "/role",
        parse_args_with_freetext, 1, 4, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_role)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/role set <role> <nick> [<reason>]",
            "/role list [<role>]")
        CMD_DESC(
            "Manage room roles. "
            "Role may be one of moderator, participant, visitor or none.")
        CMD_ARGS(
            { "set <role> <nick> [<reason>]", "Set the role of occupant with nick, with an optional reason." },
            { "list [<role>]",                "List all occupants with the specified role, or all if none specified." })
        CMD_NOEXAMPLES
    },

    { "/occupants",
        parse_args, 1, 3, cons_occupants_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_occupants)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/occupants show|hide [jid]",
            "/occupants default show|hide [jid]",
            "/occupants size [<percent>]")
        CMD_DESC(
            "Show or hide room occupants, and occupants panel display settings.")
        CMD_ARGS(
            { "show",                  "Show the occupants panel in current room." },
            { "hide",                  "Hide the occupants panel in current room." },
            { "show jid",              "Show jid in the occupants panel in current room." },
            { "hide jid",              "Hide jid in the occupants panel in current room." },
            { "default show|hide",     "Whether occupants are shown by default in new rooms." },
            { "default show|hide jid", "Whether occupants jids are shown by default in new rooms." },
            { "size <percent>",        "Percentage of the screen taken by the occupants list in rooms (1-99)." })
        CMD_NOEXAMPLES
    },

    { "/form",
        parse_args, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_form)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/form show",
            "/form submit",
            "/form cancel",
            "/form help [<tag>]")
        CMD_DESC(
            "Form configuration.")
        CMD_ARGS(
            { "show",         "Show the current form." },
            { "submit",       "Submit the current form." },
            { "cancel",       "Cancel changes to the current form." },
            { "help [<tag>]", "Display help for form, or a specific field." })
        CMD_NOEXAMPLES
    },

    { "/rooms",
        parse_args, 0, 4, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_rooms)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/rooms",
            "/rooms filter <text>",
            "/rooms service <service>",
            "/rooms service <service> filter <text>",
            "/rooms cache on|off|clear")
        CMD_DESC(
            "List the chat rooms available at the specified conference service. "
            "If no argument is supplied, the account preference 'muc.service' is used, 'conference.<domain-part>' by default. "
            "The filter argument only shows rooms that contain the provided text, case insensitive.")
        CMD_ARGS(
            { "service <service>",  "The conference service to query." },
            { "filter <text>",      "The text to filter results by."},
            { "cache on|off",       "Enable or disable caching of rooms list response, enabled by default."},
            { "cache clear",        "Clear the rooms response cache if enabled."})
        CMD_EXAMPLES(
            "/rooms",
            "/rooms filter development",
            "/rooms service conference.jabber.org",
            "/rooms service conference.jabber.org filter \"News Room\"")
    },

    { "/bookmark",
        parse_args, 0, 8, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_bookmark)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/bookmark",
            "/bookmark list",
            "/bookmark add [<room>] [nick <nick>] [password <password>] [autojoin on|off]",
            "/bookmark update <room> [nick <nick>] [password <password>] [autojoin on|off]",
            "/bookmark remove [<room>]",
            "/bookmark join <room>",
            "/bookmark invites on|off")
        CMD_DESC(
            "Manage bookmarks and join bookmarked rooms. "
            "In a chat room, no arguments will bookmark the current room, setting autojoin to \"on\".")
        CMD_ARGS(
            { "list", "List all bookmarks." },
            { "add [<room>]", "Add a bookmark, passing no room will bookmark the current room, setting autojoin to \"on\"." },
            { "remove [<room>]", "Remove a bookmark, passing no room will remove the bookmark for the current room, if one exists." },
            { "update <room>", "Update the properties associated with a bookmark." },
            { "nick <nick>", "Nickname used in the chat room." },
            { "password <password>", "Password if required, may be stored in plaintext on your server." },
            { "autojoin on|off", "Whether to join the room automatically on login." },
            { "join <room>", "Join room using the properties associated with the bookmark." },
            { "invites on|off", "Whether or not to bookmark accepted room invites, defaults to 'on'."})
        CMD_NOEXAMPLES
    },

    { "/disco",
        parse_args, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_disco)
        CMD_TAGS(
            CMD_TAG_DISCOVERY)
        CMD_SYN(
            "/disco info [<jid>]",
            "/disco items [<jid>]")
        CMD_DESC(
            "Find out information about an entities supported services. "
            "Calling with no arguments will query the server you are currently connected to.")
        CMD_ARGS(
            { "info [<jid>]", "List protocols and features supported by an entity." },
            { "items [<jid>]", "List items associated with an entity." })
        CMD_EXAMPLES(
            "/disco info",
            "/disco items myserver.org",
            "/disco items conference.jabber.org",
            "/disco info myfriend@server.com/laptop")
    },

    { "/sendfile",
        parse_args_with_freetext, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_sendfile)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/sendfile <file>")
        CMD_DESC(
            "Send a file using XEP-0363 HTTP file transfer.")
        CMD_ARGS(
            { "<file>", "Path to the file." })
        CMD_EXAMPLES(
            "/sendfile /etc/hosts",
            "/sendfile ~/images/sweet_cat.jpg")
    },

    { "/lastactivity",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_lastactivity)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/lastactivity on|off",
            "/lastactivity [<jid>]")
        CMD_DESC(
            "Enable/disable sending last activity, and send last activity requests.")
        CMD_ARGS(
            { "on|off", "Enable or disable sending of last activity." },
            { "<jid>",  "The JID of the entity to query, omitting the JID will query your server." })
        CMD_EXAMPLES(
            "/lastactivity",
            "/lastactivity off",
            "/lastactivity alice@securechat.org",
            "/lastactivity alice@securechat.org/laptop",
            "/lastactivity someserver.com")
    },

    { "/nick",
        parse_args_with_freetext, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_nick)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/nick <nickname>")
        CMD_DESC(
            "Change your nickname in the current chat room.")
        CMD_ARGS(
            { "<nickname>", "Your new nickname." })
        CMD_NOEXAMPLES
    },

    { "/win",
        parse_args, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_win)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/win console",
            "/win <num>",
            "/win <barejid>",
            "/win <nick>",
            "/win <roomjid>",
            "/win <roomoccupantjid>",
            "/win xmlconsole",
            "/win <plugin>")
        CMD_DESC(
            "Move to the specified window.")
        CMD_ARGS(
            { "console",            "Focus the Console window." },
            { "<num>",              "Focus specified window number." },
            { "<barejid>",          "Focus chat window with contact by JID if open." },
            { "<nick>",             "Focus chat window with contact by nickname if open." },
            { "<roomjid>",          "Focus chat room window with roomjid if open." },
            { "<roomoccupantjid>",  "Focus private chat roomoccupantjid if open." },
            { "xmlconsole",         "Focus the XML Console window if open." },
            { "<plugin>",           "Focus the plugin window."})
        CMD_EXAMPLES(
            "/win console",
            "/win 4",
            "/win friend@chat.org",
            "/win Eddie",
            "/win bigroom@conference.chat.org",
            "/win bigroom@conference.chat.org/bruce",
            "/win wikipedia")
    },

    { "/wins",
        parse_args, 0, 3, NULL,
        CMD_SUBFUNCS(
            { "unread",     cmd_wins_unread },
            { "prune",      cmd_wins_prune },
            { "swap",       cmd_wins_swap })
        CMD_MAINFUNC(cmd_wins)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/wins",
            "/wins unread",
            "/wins prune",
            "/wins swap <source> <target>")
        CMD_DESC(
            "Manage windows. "
            "Passing no argument will list all currently active windows and information about their usage.")
        CMD_ARGS(
            { "unread",                 "List windows with unread messages." },
            { "prune",                  "Close all windows with no unread messages." },
            { "swap <source> <target>", "Swap windows, target may be an empty position." })
        CMD_NOEXAMPLES
    },

    { "/sub",
        parse_args, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_sub)
        CMD_TAGS(
            CMD_TAG_ROSTER)
        CMD_SYN(
            "/sub request [<jid>]",
            "/sub allow [<jid>]",
            "/sub deny [<jid>]",
            "/sub show [<jid>]",
            "/sub sent",
            "/sub received")
        CMD_DESC(
            "Manage subscriptions to contact presence. "
            "If jid is omitted, the contact of the current window is used.")
        CMD_ARGS(
            { "request [<jid>]", "Send a subscription request to the user." },
            { "allow [<jid>]",   "Approve a contact's subscription request." },
            { "deny [<jid>]",    "Remove subscription for a contact, or deny a request." },
            { "show [<jid>]",    "Show subscription status for a contact." },
            { "sent",            "Show all sent subscription requests pending a response." },
            { "received",        "Show all received subscription requests awaiting your response." })
        CMD_EXAMPLES(
            "/sub request myfriend@jabber.org",
            "/sub allow myfriend@jabber.org",
            "/sub request",
            "/sub sent")
    },

    { "/tiny",
        parse_args, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_tiny)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/tiny <url>")
        CMD_DESC(
            "Send url as tinyurl in current chat.")
        CMD_ARGS(
            { "<url>", "The url to make tiny." })
        CMD_EXAMPLES(
            "Example: /tiny http://www.profanity.im")
    },

    { "/who",
        parse_args, 0, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_who)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT,
            CMD_TAG_ROSTER)
        CMD_SYN(
            "/who",
            "/who online|offline|away|dnd|xa|chat|available|unavailable|any [<group>]",
            "/who moderator|participant|visitor",
            "/who owner|admin|member")
        CMD_DESC(
            "Show contacts or room occupants with chosen status, role or affiliation")
        CMD_ARGS(
            { "offline|away|dnd|xa|chat", "Show contacts or room occupants with specified presence." },
            { "online", "Contacts that are online, chat, away, xa, dnd." },
            { "available", "Contacts that are available for chat - online, chat." },
            { "unavailable", "Contacts that are not available for chat - offline, away, xa, dnd." },
            { "any", "Contacts with any status (same as calling with no argument)." },
            { "<group>", "Filter the results by the specified roster group, not applicable in chat rooms." },
            { "moderator|participant|visitor", "Room occupants with the specified role." },
            { "owner|admin|member", "Room occupants with the specified affiliation." })
        CMD_EXAMPLES(
            "/who",
            "/who xa",
            "/who online friends",
            "/who any family",
            "/who participant",
            "/who admin")
    },

    { "/close",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_close)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/close",
            "/close <num>",
            "/close <barejid>",
            "/close <nick>",
            "/close <roomjid>",
            "/close <roomoccupantjid>",
            "/close xmlconsole",
            "/close all|read")
        CMD_DESC(
            "Close windows. "
            "Passing no argument closes the current window.")
        CMD_ARGS(
            { "<num>",              "Close specified window number." },
            { "<barejid>",          "Close chat window with contact by JID if open." },
            { "<nick>",             "Close chat window with contact by nickname if open." },
            { "<roomjid>",          "Close chat room window with roomjid if open." },
            { "<roomoccupantjid>",  "Close private chat roomoccupantjid if open." },
            { "xmlconsole",         "Close the XML Console window if open." },
            { "all",                "Close all windows." },
            { "read",               "Close all windows that have no unread messages." })
        CMD_NOEXAMPLES
    },

    { "/clear",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_clear)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/clear")
        CMD_DESC(
            "Clear the current window.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/quit",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_quit)
        CMD_NOTAGS
        CMD_SYN(
            "/quit")
        CMD_DESC(
            "Logout of any current session, and quit Profanity.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/privileges",
        parse_args, 1, 1, &cons_privileges_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_privileges)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/privileges on|off")
        CMD_DESC(
            "Group occupants panel by role, and show role information in chat rooms.")
        CMD_ARGS(
            { "on|off", "Enable or disable privilege information." })
        CMD_NOEXAMPLES
    },

    { "/charset",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_charset)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/charset")
        CMD_DESC(
            "Display information about the current character set supported by the terminal. ")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/beep",
        parse_args, 1, 1, &cons_beep_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_beep)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/beep on|off")
        CMD_DESC(
            "Switch the terminal bell on or off. "
            "The bell will sound when incoming messages are received. "
            "If the terminal does not support sounds, it may attempt to flash the screen instead.")
        CMD_ARGS(
            { "on|off", "Enable or disable terminal bell." })
        CMD_NOEXAMPLES
    },

    { "/console",
        parse_args, 2, 2, &cons_console_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_console)
        CMD_TAGS(
            CMD_TAG_UI,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/console chat all|first|none",
            "/console muc all|first|none",
            "/console private all|first|none")
        CMD_DESC(
            "Configure what is displayed in the console window when messages are received. "
            "The default is set to 'all' for all types of messages.")
        CMD_ARGS(
            { "chat all",       "Indicate all new chat messages in the console." },
            { "chat first",     "Indicate only the first new message per chat in the console." },
            { "chat none",      "Do not show any new chat messages in the console window." },
            { "muc all",        "Indicate all new chat room messages in the console." },
            { "muc first",      "Indicate only the first new message in each room in the console." },
            { "muc none",       "Do not show any new chat room messages in the console window." },
            { "private all",    "Indicate all new private room messages in the console." },
            { "private first",  "Indicate only the first private room message in the console." },
            { "private none",   "Do not show any new private room messages in the console window." })
        CMD_NOEXAMPLES
    },

    { "/encwarn",
        parse_args, 1, 1, &cons_encwarn_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_encwarn)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/encwarn on|off")
        CMD_DESC(
            "Titlebar encryption warning.")
        CMD_ARGS(
            { "on|off", "Enable or disable the unencrypted warning message in the titlebar." })
        CMD_NOEXAMPLES
    },

    { "/presence",
        parse_args, 2, 2, &cons_presence_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_presence)
        CMD_TAGS(
            CMD_TAG_UI,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/presence titlebar on|off",
            "/presence console all|online|none",
            "/presence chat all|online|none",
            "/presence room all|online|none")
        CMD_DESC(
            "Show the contacts presence in the titlebar and configure presence messages in different window types.")
        CMD_ARGS(
            { "titlebar on|off", "Switch display of the contacts presence in the titlebar on or off." },
            { "console all",     "Show all presence changes in the console window." },
            { "console online",  "Show only online/offline presence changes in the console window." },
            { "console none",    "Don't show any presence changes in the console window." },
            { "chat all",        "Show all presence changes in the chat windows." },
            { "chat online",     "Show only online/offline presence changes in chat windows." },
            { "chat none",       "Don't show any presence changes in chat windows." },
            { "room all",        "Show all presence changes in chat room windows." },
            { "room online",     "Show only online/offline presence changes in chat room windows." },
            { "room none",       "Don't show any presence changes in chat room windows." })
        CMD_EXAMPLES(
            "/presence titlebar off",
            "/presence console none",
            "/presence chat online",
            "/presence room all")
    },

    { "/wrap",
        parse_args, 1, 1, &cons_wrap_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_wrap)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/wrap on|off")
        CMD_DESC(
            "Word wrapping.")
        CMD_ARGS(
            { "on|off", "Enable or disable word wrapping in the main window." })
        CMD_NOEXAMPLES
    },

    { "/time",
        parse_args, 1, 3, &cons_time_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_time)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/time console|chat|muc|config|private|xml set <format>",
            "/time console|chat|muc|config|private|xml off",
            "/time statusbar set <format>",
            "/time statusbar off",
            "/time lastactivity set <format>")
        CMD_DESC(
            "Configure time display preferences. "
            "Time formats are strings supported by g_date_time_format. "
            "See https://developer.gnome.org/glib/stable/glib-GDateTime.html#g-date-time-format for more details. "
            "Setting the format to an unsupported string, will display the string. "
            "If the format contains spaces, it must be surrounded with double quotes.")
        CMD_ARGS(
            { "console set <format>",      "Set time format for console window." },
            { "console off",               "Do not show time in console window." },
            { "chat set <format>",         "Set time format for chat windows." },
            { "chat off",                  "Do not show time in chat windows." },
            { "muc set <format>",          "Set time format for chat room windows." },
            { "muc off",                   "Do not show time in chat room windows." },
            { "config set <format>",       "Set time format for config windows." },
            { "config off",                "Do not show time in config windows." },
            { "private set <format>",      "Set time format for private chat windows." },
            { "private off",               "Do not show time in private chat windows." },
            { "xml set <format>",          "Set time format for XML console window." },
            { "xml off",                   "Do not show time in XML console window." },
            { "statusbar set <format>",    "Change time format in statusbar." },
            { "statusbar off",             "Do not show time in status bar." },
            { "lastactivity set <format>", "Change time format for last activity." })
        CMD_EXAMPLES(
            "/time console set %H:%M:%S",
            "/time chat set \"%d-%m-%y %H:%M:%S\"",
            "/time xml off",
            "/time statusbar set %H:%M",
            "/time lastactivity set \"%d-%m-%y %H:%M:%S\"")
    },

    { "/inpblock",
        parse_args, 2, 2, &cons_inpblock_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_inpblock)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/inpblock timeout <millis>",
            "/inpblock dynamic on|off")
        CMD_DESC(
            "How long to wait for keyboard input before checking for new messages or checking for state changes such as 'idle'.")
        CMD_ARGS(
            { "timeout <millis>", "Time to wait (1-1000) in milliseconds before reading input from the terminal buffer, default: 1000." },
            { "dynamic on|off", "Start with 0 millis and dynamically increase up to timeout when no activity, default: on." })
        CMD_NOEXAMPLES
    },

    { "/titlebar",
        parse_args, 1, 1, &cons_winpos_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_titlebar)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/titlebar up",
            "/titlebar down")
        CMD_DESC(
            "Move the title bar.")
        CMD_ARGS(
            { "up", "Move the title bar up the screen." },
            { "down", "Move the title bar down the screen." })
        CMD_NOEXAMPLES
    },

    { "/mainwin",
        parse_args, 1, 1, &cons_winpos_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_mainwin)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/mainwin up",
            "/mainwin down")
        CMD_DESC(
            "Move the main window.")
        CMD_ARGS(
            { "up", "Move the main window up the screen." },
            { "down", "Move the main window down the screen." })
        CMD_NOEXAMPLES
    },

    { "/statusbar",
        parse_args, 1, 2, &cons_statusbar_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_statusbar)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/statusbar show name|number",
            "/statusbar hide name|number",
            "/statusbar maxtabs <value>",
            "/statusbar tablen <value>",
            "/statusbar self user|barejid|fulljid|off",
            "/statusbar chat user|jid",
            "/statusbar room room|jid",
            "/statusbar up",
            "/statusbar down")
        CMD_DESC(
            "Manage statusbar display preferences.")
        CMD_ARGS(
            { "maxtabs <value>",            "Set the maximum number of tabs to display, <value> must be between 0 and 10" },
            { "tablen <value>",             "Set the maximum number of characters to show as the tab name, 0 sets to unlimited." },
            { "show|hide name",             "Show or hide names in tabs." },
            { "show|hide number",           "Show or hide numbers in tabs." },
            { "self user|barejid|fulljid",  "Show account user name, barejid, fulljid as status bar title." },
            { "self off",                   "Disable showing self as status bar title." },
            { "chat user|jid",              "Show users name, or the fulljid if no nick is present for chat tabs." },
            { "room room|jid",              "Show room name, or the fulljid for room tabs." },
            { "up",                         "Move the status bar up the screen." },
            { "down",                       "Move the status bar down the screen." })
        CMD_EXAMPLES(
            "/statusbar maxtabs 8",
            "/statusbar tablen 5",
            "/statusbar self user",
            "/statusbar chat jid",
            "/statusbar hide name")
    },

    { "/inputwin",
        parse_args, 1, 1, &cons_winpos_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_inputwin)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/inputwin up",
            "/inputwin down")
        CMD_DESC(
            "Move the input window.")
        CMD_ARGS(
            { "up", "Move the input window up the screen." },
            { "down", "Move the input window down the screen." })
        CMD_NOEXAMPLES
    },

    { "/notify",
        parse_args_with_freetext, 0, 4, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_notify)
        CMD_TAGS(
            CMD_TAG_UI,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/notify chat on|off",
            "/notify chat current on|off",
            "/notify chat text on|off",
            "/notify room on|off",
            "/notify room mention on|off",
            "/notify room mention case_sensitive|case_insensitive",
            "/notify room mention word_whole|word_part",
            "/notify room current on|off",
            "/notify room text on|off",
            "/notify room trigger add <text>",
            "/notify room trigger remove <text>",
            "/notify room trigger list",
            "/notify room trigger on|off",
            "/notify on|off",
            "/notify mention on|off",
            "/notify trigger on|off",
            "/notify reset",
            "/notify remind <seconds>",
            "/notify typing on|off",
            "/notify typing current on|off",
            "/notify invite on|off",
            "/notify sub on|off")
        CMD_DESC(
            "Configure desktop notifications. "
            "To configure presence update messages in the console, chat and chat room windows, see '/help presence'.")
        CMD_ARGS(
            { "chat on|off",                    "Notifications for regular chat messages." },
            { "chat current on|off",            "Whether to show regular chat message notifications when the window is focussed." },
            { "chat text on|off",               "Show message text in regular message notifications." },
            { "room on|off",                    "Notifications for all chat room messages." },
            { "room mention on|off",            "Notifications for chat room messages when your nick is mentioned." },
            { "room mention case_sensitive",    "Set room mention notifications as case sensitive." },
            { "room mention case_insensitive",  "Set room mention notifications as case insensitive." },
            { "room mention word_whole",        "Set room mention notifications only on whole word match, i.e. when nickname is not part of a larger word." },
            { "room mention word_part",         "Set room mention notifications on partial word match, i.e. nickname may be part of a larger word." },
            { "room current on|off",            "Whether to show all chat room messages notifications when the window is focussed." },
            { "room text on|off",               "Show message text in chat room message notifications." },
            { "room trigger add <text>",        "Notify when specified text included in all chat room messages." },
            { "room trigger remove <text>",     "Remove chat room notification trigger." },
            { "room trigger list",              "List all chat room triggers." },
            { "room trigger on|off",            "Enable or disable all chat room notification triggers." },
            { "on|off",                         "Override the global message setting for the current chat room." },
            { "mention on|off",                 "Override the global 'mention' setting for the current chat room." },
            { "trigger on|off",                 "Override the global 'trigger' setting for the current chat room." },
            { "reset",                          "Reset to global notification settings for the current chat room." },
            { "remind <seconds>",               "Notification reminder period for unread messages, use 0 to disable." },
            { "typing on|off",                  "Notifications when contacts are typing." },
            { "typing current on|off",          "Whether typing notifications are triggered for the current window." },
            { "invite on|off",                  "Notifications for chat room invites." },
            { "sub on|off",                     "Notifications for subscription requests." })
        CMD_EXAMPLES(
            "/notify chat on",
            "/notify chat text on",
            "/notify room mention on",
            "/notify room trigger add beer",
            "/notify room trigger on",
            "/notify room current off",
            "/notify room text off",
            "/notify remind 60",
            "/notify typing on",
            "/notify invite on")
    },

    { "/flash",
        parse_args, 1, 1, &cons_flash_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_flash)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/flash on|off")
        CMD_DESC(
            "Make the terminal flash when incoming messages are received in another window. "
            "If the terminal doesn't support flashing, it may attempt to beep.")
        CMD_ARGS(
            { "on|off", "Enable or disable terminal flash." })
        CMD_NOEXAMPLES
    },

    { "/tray",
        parse_args, 1, 2, &cons_tray_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_tray)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/tray on|off",
            "/tray read on|off",
            "/tray timer <seconds>")
        CMD_DESC(
            "Display an icon in the tray that will indicate new messages.")
        CMD_ARGS(
            { "on|off",             "Show tray icon." },
            { "read on|off",        "Show tray icon when no unread messages." },
            { "timer <seconds>",    "Set tray icon timer, seconds must be between 1-10" })
        CMD_NOEXAMPLES
    },

    { "/intype",
        parse_args, 1, 1, &cons_intype_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_intype)
        CMD_TAGS(
            CMD_TAG_UI,
            CMD_TAG_CHAT)
        CMD_SYN(
            "/intype on|off")
        CMD_DESC(
            "Show when a contact is typing in the console, and in active message window.")
        CMD_ARGS(
            { "on|off", "Enable or disable contact typing messages." })
        CMD_NOEXAMPLES
    },

    { "/splash",
        parse_args, 1, 1, &cons_splash_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_splash)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/splash on|off")
        CMD_DESC(
            "Switch on or off the ascii logo on start up and when the /about command is called.")
        CMD_ARGS(
            { "on|off", "Enable or disable splash logo." })
        CMD_NOEXAMPLES
    },

    { "/autoconnect",
        parse_args, 1, 2, &cons_autoconnect_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_autoconnect)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/autoconnect set <account>",
            "/autoconnect off")
        CMD_DESC(
            "Enable or disable autoconnect on start up. "
            "The setting can be overridden by the -a (--account) command line option.")
        CMD_ARGS(
            { "set <account>", "Connect with account on start up." },
            { "off",           "Disable autoconnect." })
        CMD_EXAMPLES(
            "/autoconnect set jc@stuntteam.org",
            "/autoconnect off")
    },

    { "/vercheck",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_vercheck)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/vercheck on|off")
        CMD_DESC(
            "Check for new versions when Profanity starts, and when the /about command is run.")
        CMD_ARGS(
            { "on|off", "Enable or disable the version check." })
        CMD_NOEXAMPLES
    },

    { "/wintitle",
        parse_args, 2, 2, &cons_wintitle_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_wintitle)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/wintitle show on|off",
            "/wintitle goodbye on|off")
        CMD_DESC(
            "Allow Profanity to modify the window title bar.")
        CMD_ARGS(
            { "show on|off",    "Show current logged in user, and unread messages as the window title." },
            { "goodbye on|off", "Show a message in the title when exiting profanity." })
        CMD_NOEXAMPLES
    },

    { "/alias",
        parse_args_with_freetext, 1, 3, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_alias)
        CMD_NOTAGS
        CMD_SYN(
            "/alias list",
            "/alias add <name> <value>",
            "/alias remove <name>")
        CMD_DESC(
            "Add, remove or list command aliases.")
        CMD_ARGS(
            { "list",               "List all aliases." },
            { "add <name> <value>", "Add a new command alias." },
            { "remove <name>",      "Remove a command alias." })
        CMD_EXAMPLES(
            "/alias add friends /who online friends",
            "/alias add /q /quit",
            "/alias add a /away \"I'm in a meeting.\"",
            "/alias remove q",
            "/alias list")
    },

    { "/chlog",
        parse_args, 1, 1, &cons_chlog_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_chlog)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/chlog on|off")
        CMD_DESC(
            "Switch chat logging on or off. "
            "This setting will be enabled if /history is set to on. "
            "When disabling this option, /history will also be disabled. "
            "See the /grlog setting for enabling logging of chat room (groupchat) messages.")
        CMD_ARGS(
            { "on|off", "Enable or disable chat logging." })
        CMD_NOEXAMPLES
    },

    { "/grlog",
        parse_args, 1, 1, &cons_grlog_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_grlog)
        CMD_TAGS(
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/grlog on|off")
        CMD_DESC(
            "Switch chat room logging on or off. "
            "See the /chlog setting for enabling logging of one to one chat.")
        CMD_ARGS(
            { "on|off", "Enable or disable chat room logging." })
        CMD_NOEXAMPLES
    },

    { "/states",
        parse_args, 1, 1, &cons_states_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_states)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/states on|off")
        CMD_DESC(
            "Send chat state notifications to recipient during chat sessions, such as typing, paused, active, gone.")
        CMD_ARGS(
            { "on|off", "Enable or disable sending of chat state notifications." })
        CMD_NOEXAMPLES
    },

    { "/pgp",
        parse_args, 1, 3, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_pgp)
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/pgp libver",
            "/pgp keys",
            "/pgp contacts",
            "/pgp setkey <contact> <keyid>",
            "/pgp start [<contact>]",
            "/pgp end",
            "/pgp log on|off|redact",
            "/pgp char <char>")
        CMD_DESC(
            "Open PGP commands to manage keys, and perform PGP encryption during chat sessions. "
            "See the /account command to set your own PGP key.")
        CMD_ARGS(
            { "libver",                   "Show which version of the libgpgme library is being used." },
            { "keys",                     "List all keys known to the system." },
            { "contacts",                 "Show contacts with assigned public keys." },
            { "setkey <contact> <keyid>", "Manually associate a contact with a public key." },
            { "start [<contact>]",        "Start PGP encrypted chat, current contact will be used if not specified." },
            { "end",                      "End PGP encrypted chat with the current recipient." },
            { "log on|off",               "Enable or disable plaintext logging of PGP encrypted messages." },
            { "log redact",               "Log PGP encrypted messages, but replace the contents with [redacted]. This is the default." },
            { "char <char>",              "Set the character to be displayed next to PGP encrypted messages." })
        CMD_EXAMPLES(
            "/pgp log off",
            "/pgp setkey buddy@buddychat.org BA19CACE5A9592C5",
            "/pgp start buddy@buddychat.org",
            "/pgp end",
            "/pgp char P")
    },

    { "/otr",
        parse_args, 1, 3, NULL,
        CMD_SUBFUNCS(
            { "char",       cmd_otr_char },
            { "log",        cmd_otr_log },
            { "libver",     cmd_otr_libver },
            { "policy",     cmd_otr_policy },
            { "gen",        cmd_otr_gen },
            { "myfp",       cmd_otr_myfp },
            { "theirfp",    cmd_otr_theirfp },
            { "start",      cmd_otr_start },
            { "end",        cmd_otr_end },
            { "trust",      cmd_otr_trust },
            { "untrust",    cmd_otr_untrust },
            { "secret",     cmd_otr_secret },
            { "question",   cmd_otr_question },
            { "answer",     cmd_otr_answer })
        CMD_NOMAINFUNC
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/otr libver",
            "/otr gen",
            "/otr myfp|theirfp",
            "/otr start [<contact>]",
            "/otr end",
            "/otr trust|untrust",
            "/otr secret <secret>",
            "/otr question <question> <answer>",
            "/otr answer <answer>",
            "/otr policy manual|opportunistic|always [<contact>]",
            "/otr log on|off|redact",
            "/otr char <char>")
        CMD_DESC(
            "Off The Record (OTR) commands to manage keys, and perform OTR encryption during chat sessions.")
        CMD_ARGS(
            { "libver",                         "Show which version of the libotr library is being used." },
            { "gen",                            "Generate your private key." },
            { "myfp",                           "Show your fingerprint." },
            { "theirfp",                        "Show contacts fingerprint." },
            { "start [<contact>]",              "Start an OTR session with contact, or current recipient if omitted." },
            { "end",                            "End the current OTR session," },
            { "trust|untrust",                  "Indicate whether or not you trust the contact's fingerprint." },
            { "secret <secret>",                "Verify a contact's identity using a shared secret." },
            { "question <question> <answer>",   "Verify a contact's identity using a question and expected answer." },
            { "answer <answer>",                "Respond to a question answer verification request with your answer." },
            { "policy manual",                  "Set the global OTR policy to manual, OTR sessions must be started manually." },
            { "policy manual <contact>",        "Set the OTR policy to manual for a specific contact." },
            { "policy opportunistic",           "Set the global OTR policy to opportunistic, an OTR session will be attempted upon starting a conversation." },
            { "policy opportunistic <contact>", "Set the OTR policy to opportunistic for a specific contact." },
            { "policy always",                  "Set the global OTR policy to always, an error will be displayed if an OTR session cannot be initiated upon starting a conversation." },
            { "policy always <contact>",        "Set the OTR policy to always for a specific contact." },
            { "log on|off",                     "Enable or disable plaintext logging of OTR encrypted messages." },
            { "log redact",                     "Log OTR encrypted messages, but replace the contents with [redacted]. This is the default." },
            { "char <char>",                    "Set the character to be displayed next to OTR encrypted messages." })
        CMD_EXAMPLES(
            "/otr log off",
            "/otr policy manual",
            "/otr policy opportunistic mrfriend@workchat.org",
            "/otr gen",
            "/otr start buddy@buddychat.org",
            "/otr myfp",
            "/otr theirfp",
            "/otr question \"What is the name of my rabbit?\" fiffi",
            "/otr end",
            "/otr char *")
    },

    { "/outtype",
        parse_args, 1, 1, &cons_outtype_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_outtype)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/outtype on|off")
        CMD_DESC(
            "Send typing notifications, chat states (/states) will be enabled if this setting is enabled.")
        CMD_ARGS(
            { "on|off", "Enable or disable sending typing notifications." })
        CMD_NOEXAMPLES
    },

    { "/gone",
        parse_args, 1, 1, &cons_gone_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_gone)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/gone <minutes>")
        CMD_DESC(
            "Send a 'gone' state to the recipient after the specified number of minutes. "
            "Chat states (/states) will be enabled if this setting is set.")
        CMD_ARGS(
            { "<minutes>", "Number of minutes of inactivity before sending the 'gone' state, a value of 0 will disable sending this state." })
        CMD_NOEXAMPLES
    },

    { "/history",
        parse_args, 1, 1, &cons_history_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_history)
        CMD_TAGS(
            CMD_TAG_UI,
            CMD_TAG_CHAT)
        CMD_SYN(
            "/history on|off")
        CMD_DESC(
            "Switch chat history on or off, /chlog will automatically be enabled when this setting is on. "
            "When history is enabled, previous messages are shown in chat windows.")
        CMD_ARGS(
            { "on|off", "Enable or disable showing chat history." })
        CMD_NOEXAMPLES
    },

    { "/log",
        parse_args, 1, 2, &cons_log_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_log)
        CMD_NOTAGS
        CMD_SYN(
            "/log where",
            "/log rotate on|off",
            "/log maxsize <bytes>",
            "/log shared on|off")
        CMD_DESC(
            "Manage profanity log settings.")
        CMD_ARGS(
            { "where",           "Show the current log file location." },
            { "rotate on|off",   "Rotate log, default on." },
            { "maxsize <bytes>", "With rotate enabled, specifies the max log size, defaults to 1048580 (1MB)." },
            { "shared on|off",   "Share logs between all instances, default: on. When off, the process id will be included in the log filename." })
        CMD_NOEXAMPLES
    },

    { "/carbons",
        parse_args, 1, 1, &cons_carbons_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_carbons)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/carbons on|off")
        CMD_DESC(
            "Enable or disable message carbons. "
            "Message carbons ensure that both sides of all conversations are shared with all the user's clients that implement this protocol.")
        CMD_ARGS(
            { "on|off", "Enable or disable message carbons." })
        CMD_NOEXAMPLES
    },

    { "/receipts",
        parse_args, 2, 2, &cons_receipts_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_receipts)
        CMD_TAGS(
            CMD_TAG_CHAT)
        CMD_SYN(
            "/receipts request on|off",
            "/receipts send on|off")
        CMD_DESC(
            "Enable or disable message delivery receipts. The interface will indicate when a message has been received.")
        CMD_ARGS(
            { "request on|off", "Whether or not to request a receipt upon sending a message." },
            { "send on|off",    "Whether or not to send a receipt if one has been requested with a received message." })
        CMD_NOEXAMPLES
    },

    { "/reconnect",
        parse_args, 1, 1, &cons_reconnect_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_reconnect)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/reconnect <seconds>")
        CMD_DESC(
            "Set the reconnect attempt interval for when the connection is lost.")
        CMD_ARGS(
            { "<seconds>", "Number of seconds before attempting to reconnect, a value of 0 disables reconnect." })
        CMD_NOEXAMPLES
    },

    { "/autoping",
        parse_args, 2, 2, &cons_autoping_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_autoping)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/autoping set <seconds>",
            "/autoping timeout <seconds>")
        CMD_DESC(
            "Set the interval between sending ping requests to the server to ensure the connection is kept alive.")
        CMD_ARGS(
            { "set <seconds>",      "Number of seconds between sending pings, a value of 0 disables autoping." },
            { "timeout <seconds>",  "Seconds to wait for autoping responses, after which the connection is considered broken." })
        CMD_NOEXAMPLES
    },

    { "/ping",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_ping)
        CMD_TAGS(
            CMD_TAG_CONNECTION)
        CMD_SYN(
            "/ping [<jid>]")
        CMD_DESC(
            "Sends an IQ ping stanza to the specified JID. "
            "If no JID is supplied, your chat server will be pinged.")
        CMD_ARGS(
            { "<jid>", "The Jabber ID to send the ping request to." })
        CMD_NOEXAMPLES
    },

    { "/autoaway",
        parse_args_with_freetext, 2, 3, &cons_autoaway_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_autoaway)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/autoaway mode idle|away|off",
            "/autoaway time away|xa <minutes>",
            "/autoaway message away|xa <message>|off",
            "/autoaway check on|off")
        CMD_DESC(
            "Manage autoaway settings for idle time.")
        CMD_ARGS(
            { "mode idle",              "Sends idle time, status remains online." },
            { "mode away",              "Sends away and xa presence as well as idle time." },
            { "mode off",               "Disabled (default)." },
            { "time away <minutes>",    "Number of minutes before the away presence is sent, default: 15." },
            { "time xa <minutes>",      "Number of minutes before the xa presence is sent, default: 0 (disabled)." },
            { "message away <message>", "Optional message to send with the away presence, default: off (disabled)." },
            { "message xa <message>",   "Optional message to send with the xa presence, default: off (disabled)." },
            { "message away off",       "Send no message with away presence." },
            { "message xa off",         "Send no message with xa presence." },
            { "check on|off",           "When enabled, checks for activity and sends online presence, default: on." })
        CMD_EXAMPLES(
            "/autoaway mode away",
            "/autoaway time away 30",
            "/autoaway message away Away from computer for a while",
            "/autoaway time xa 120",
            "/autoaway message xa Away from computer for a very long time",
            "/autoaway check off")
    },

    { "/priority",
        parse_args, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_priority)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/priority <priority>")
        CMD_DESC(
            "Set priority for the current account. "
            "See the /account command for specific priority settings per presence status.")
        CMD_ARGS(
            { "<priority>", "Number between -128 and 127, default: 0." })
        CMD_NOEXAMPLES
    },

    { "/account",
        parse_args, 0, 4, NULL,
        CMD_SUBFUNCS(
            { "list",       cmd_account_list },
            { "show",       cmd_account_show },
            { "add",        cmd_account_add },
            { "remove",     cmd_account_remove },
            { "enable",     cmd_account_enable },
            { "disable",    cmd_account_disable },
            { "rename",     cmd_account_rename },
            { "default",    cmd_account_default },
            { "set",        cmd_account_set },
            { "clear",      cmd_account_clear })
        CMD_MAINFUNC(cmd_account)
        CMD_TAGS(
            CMD_TAG_CONNECTION,
            CMD_TAG_PRESENCE,
            CMD_TAG_CHAT,
            CMD_TAG_GROUPCHAT)
        CMD_SYN(
            "/account",
            "/account list",
            "/account show <account>",
            "/account enable|disable <account>",
            "/account default set <account>",
            "/account default off",
            "/account add <account>",
            "/account remove <account>",
            "/account rename <account> <newaccount>",
            "/account set <account> jid <jid>",
            "/account set <account> server <server>",
            "/account set <account> port <port>",
            "/account set <account> status <presence>",
            "/account set <account> status last",
            "/account set <account> <presence> <priority>",
            "/account set <account> resource <resource>",
            "/account set <account> password <password>",
            "/account set <account> eval_password <command>",
            "/account set <account> muc <service>",
            "/account set <account> nick <nick>",
            "/account set <account> otr <policy>",
            "/account set <account> pgpkeyid <pgpkeyid>",
            "/account set <account> startscript <script>",
            "/account set <account> tls force|allow|trust|legacy|disable",
            "/account set <account> theme <theme>",
            "/account clear <account> password",
            "/account clear <account> eval_password",
            "/account clear <account> server",
            "/account clear <account> port",
            "/account clear <account> otr",
            "/account clear <account> pgpkeyid",
            "/account clear <account> startscript",
            "/account clear <account> muc",
            "/account clear <account> resource")
        CMD_DESC(
            "Commands for creating and managing accounts. "
            "Calling with no arguments will display information for the current account.")
        CMD_ARGS(
            { "list",                                   "List all accounts." },
            { "enable <account>",                       "Enable the account, it will be used for autocompletion." },
            { "show <account>",                         "Show details for the specified account." },
            { "disable <account>",                      "Disable the account." },
            { "default set <account>",                  "Set the default account, used when no argument passed to the /connect command." },
            { "default off",                            "Clear the default account setting." },
            { "add <account>",                          "Create a new account." },
            { "remove <account>",                       "Remove an account." },
            { "rename <account> <newaccount>",          "Rename 'account' to 'newaccount'." },
            { "set <account> jid <jid>",                "Set the Jabber ID for the account, account name will be used if not set." },
            { "set <account> server <server>",          "The chat server, if different to the domainpart of the JID." },
            { "set <account> port <port>",              "The port used for connecting if not the default (5222, or 5223 for SSL)." },
            { "set <account> status <presence>",        "The presence status to use on login." },
            { "set <account> status last",              "Use your last status before logging out, when logging in." },
            { "set <account> <presence> <priority>",    "Set the priority (-128..127) to use for the specified presence." },
            { "set <account> resource <resource>",      "The resource to be used for this account, defaults to 'profanity'." },
            { "set <account> password <password>",      "Password for the account, note this is currently stored in plaintext if set." },
            { "set <account> eval_password <command>",  "Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring." },
            { "set <account> muc <service>",            "The default MUC chat service to use, defaults to the servers disco info response." },
            { "set <account> nick <nick>",              "The default nickname to use when joining chat rooms." },
            { "set <account> otr <policy>",             "Override global OTR policy for this account, see /otr." },
            { "set <account> pgpkeyid <pgpkeyid>",      "Set the ID of the PGP key for this account, see /pgp." },
            { "set <account> startscript <script>",     "Set the script to execute after connecting." },
            { "set <account> tls force",                "Force TLS connection, and fail if one cannot be established, this is default behaviour." },
            { "set <account> tls allow",                "Use TLS for the connection if it is available." },
            { "set <account> tls trust",                "Force TLS connection and trust server's certificate." },
            { "set <account> tls legacy",               "Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established." },
            { "set <account> tls disable",              "Disable TLS for the connection." },
            { "set <account> <theme>",                  "Set the UI theme for the account." },
            { "clear <account> server",                 "Remove the server setting for this account." },
            { "clear <account> port",                   "Remove the port setting for this account." },
            { "clear <account> password",               "Remove the password setting for this account." },
            { "clear <account> eval_password",          "Remove the eval_password setting for this account." },
            { "clear <account> otr",                    "Remove the OTR policy setting for this account." },
            { "clear <account> pgpkeyid",               "Remove pgpkeyid associated with this account." },
            { "clear <account> startscript",            "Remove startscript associated with this account." },
            { "clear <account> theme",                  "Clear the theme setting for the account, the global theme will be used." },
            { "clear <account> resource",               "Remove the resource setting for this account."},
            { "clear <account> muc",                    "Remove the default MUC service setting."})
        CMD_EXAMPLES(
            "/account add me",
            "/account set me jid me@chatty",
            "/account set me server talk.chat.com",
            "/account set me port 5111",
            "/account set me muc chatservice.mycompany.com",
            "/account set me nick dennis",
            "/account set me status dnd",
            "/account set me dnd -1",
            "/account rename me chattyme")
    },

    { "/plugins",
        parse_args, 0, 3, NULL,
        CMD_SUBFUNCS(
            { "sourcepath",     cmd_plugins_sourcepath },
            { "install",        cmd_plugins_install },
            { "uninstall",      cmd_plugins_uninstall },
            { "update",         cmd_plugins_update },
            { "load",           cmd_plugins_load },
            { "unload",         cmd_plugins_unload },
            { "reload",         cmd_plugins_reload },
            { "python_version", cmd_plugins_python_version })
        CMD_MAINFUNC(cmd_plugins)
        CMD_NOTAGS
        CMD_SYN(
            "/plugins",
            "/plugins sourcepath set <path>",
            "/plugins sourcepath clear",
            "/plugins install [<path>]",
            "/plugins uninstall [<plugin>]",
            "/plugins update [<path>]",
            "/plugins unload [<plugin>]",
            "/plugins load [<plugin>]",
            "/plugins reload [<plugin>]",
            "/plugins python_version")
        CMD_DESC(
            "Manage plugins. Passing no arguments lists currently loaded plugins.")
        CMD_ARGS(
            { "sourcepath set <path>",  "Set the default path to install plugins from, will be used if no arg is passed to /plugins install." },
            { "sourcepath clear",       "Clear the default plugins source path." },
            { "install [<path>]",       "Install a plugin, or all plugins found in a directory (recursive). Passing no argument will use the sourcepath if one is set." },
            { "uninstall [<plugin>]",   "Uninstall a plugin." },
            { "update [<path>]",        "Updates an installed plugin" },
            { "load [<plugin>]",        "Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins." },
            { "unload [<plugin>]",      "Unload a loaded plugin, passing no argument will unload all plugins." },
            { "reload [<plugin>]",      "Reload a plugin, passing no argument will reload all plugins." },
            { "python_version",         "Show the Python interpreter version." })
        CMD_EXAMPLES(
            "/plugins sourcepath set /home/meee/projects/profanity-plugins",
            "/plugins install",
            "/plugins install /home/steveharris/Downloads/metal.py",
            "/plugins update /home/steveharris/Downloads/metal.py",
            "/plugins uninstall browser.py",
            "/plugins load browser.py",
            "/plugins unload say.py",
            "/plugins reload wikipedia.py")
    },

    { "/prefs",
        parse_args, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_prefs)
        CMD_NOTAGS
        CMD_SYN(
            "/prefs [ui|desktop|chat|log|conn|presence|otr|pgp]")
        CMD_DESC(
            "Show preferences for different areas of functionality. "
            "Passing no arguments shows all preferences.")
        CMD_ARGS(
            { "ui",       "User interface preferences." },
            { "desktop",  "Desktop notification preferences." },
            { "chat",     "Chat state preferences." },
            { "log",      "Logging preferences." },
            { "conn",     "Connection handling preferences." },
            { "presence", "Chat presence preferences." },
            { "otr",      "Off The Record preferences." },
            { "pgp",      "OpenPGP preferences." })
        CMD_NOEXAMPLES
    },

    { "/theme",
        parse_args, 1, 2, &cons_theme_setting,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_theme)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/theme list",
            "/theme load <theme>",
            "/theme colours",
            "/theme properties")
        CMD_DESC(
            "Load a theme, includes colours and UI options.")
        CMD_ARGS(
            { "list",           "List all available themes." },
            { "load <theme>",   "Load the specified theme. 'default' will reset to the default theme." },
            { "colours",        "Show colour values as rendered by the terminal." },
            { "properties",     "Show colour settings for current theme." })
        CMD_EXAMPLES(
            "/theme list",
            "/theme load forest")
    },

    { "/xmlconsole",
        parse_args, 0, 0, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_xmlconsole)
        CMD_TAGS(
            CMD_TAG_UI)
        CMD_SYN(
            "/xmlconsole")
        CMD_DESC(
            "Open the XML console to view incoming and outgoing XMPP traffic.")
        CMD_NOARGS
        CMD_NOEXAMPLES
    },

    { "/away",
        parse_args_with_freetext, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_away)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/away [<message>]")
        CMD_DESC(
            "Set your status to 'away'.")
        CMD_ARGS(
            { "<message>",  "Optional message to use with the status." })
        CMD_EXAMPLES(
            "/away",
            "/away Gone for lunch")
    },

    { "/chat",
        parse_args_with_freetext, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_chat)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/chat [<message>]")
        CMD_DESC(
            "Set your status to 'chat' (available for chat).")
        CMD_ARGS(
            { "<message>",  "Optional message to use with the status." })
        CMD_EXAMPLES(
            "/chat",
            "/chat Please talk to me!")
    },

    { "/dnd",
        parse_args_with_freetext, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_dnd)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/dnd [<message>]")
        CMD_DESC(
            "Set your status to 'dnd' (do not disturb).")
        CMD_ARGS(
            { "<message>",  "Optional message to use with the status." })
        CMD_EXAMPLES(
            "/dnd",
            "/dnd I'm in the zone")
    },

    { "/online",
        parse_args_with_freetext, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_online)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/online [<message>]")
        CMD_DESC(
            "Set your status to 'online'.")
        CMD_ARGS(
            { "<message>",  "Optional message to use with the status." })
        CMD_EXAMPLES(
            "/online",
            "/online Up the Irons!")
    },

    { "/xa",
        parse_args_with_freetext, 0, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_xa)
        CMD_TAGS(
            CMD_TAG_PRESENCE)
        CMD_SYN(
            "/xa [<message>]")
        CMD_DESC(
            "Set your status to 'xa' (extended away).")
        CMD_ARGS(
            { "<message>",  "Optional message to use with the status." })
        CMD_EXAMPLES(
            "/xa",
            "/xa This meeting is going to be a long one")
    },

    { "/script",
        parse_args, 1, 2, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_script)
        CMD_NOTAGS
        CMD_SYN(
            "/script run <script>",
            "/script list",
            "/script show <script>")
        CMD_DESC(
            "Run command scripts. "
            "Scripts are stored in $XDG_DATA_HOME/profanity/scripts/ which is usually $HOME/.local/share/profanity/scripts/.")
        CMD_ARGS(
            { "script run <script>",    "Execute a script." },
            { "script list",            "List all scripts TODO." },
            { "script show <script>",   "Show the commands in script TODO." })
        CMD_EXAMPLES(
            "/script list",
            "/script run myscript",
            "/script show somescript")
    },

    { "/export",
        parse_args, 1, 1, NULL,
        CMD_NOSUBFUNCS
        CMD_MAINFUNC(cmd_export)
        CMD_NOTAGS
        CMD_SYN(
            "/export <filepath>")
        CMD_DESC(
            "Exports contacts to a csv file.")
        CMD_ARGS(
            { "<filepath>", "Path to the output file." })
        CMD_EXAMPLES(
            "/export /path/to/output.csv",
            "/export ~/contacts.csv")
    },

    { "/cmd",
        parse_args, 1, 3, NULL,
        CMD_SUBFUNCS(
            { "list", cmd_command_list },
            { "exec", cmd_command_exec })
        CMD_NOMAINFUNC
        CMD_NOTAGS
        CMD_SYN(
            "/cmd list [<jid>]",
            "/cmd exec <command> [<jid>]")
        CMD_DESC(
            "Execute ad hoc commands.")
        CMD_ARGS(
            { "list",           "List supported ad hoc commands." },
            { "exec <command>", "Execute a command." })
        CMD_EXAMPLES(
            "/cmd list",
            "/cmd exec ping")
    },

    { "/omemo",
        parse_args, 1, 3, NULL,
        CMD_SUBFUNCS(
            { "gen", cmd_omemo_gen },
            { "start", cmd_omemo_start },
            { "trust", cmd_omemo_trust },
            { "fingerprint", cmd_omemo_fingerprint })
        CMD_NOMAINFUNC
        CMD_TAGS(
            CMD_TAG_CHAT,
            CMD_TAG_UI)
        CMD_SYN(
            "/omemo gen",
            "/omemo start [<contact>]",
            "/omemo trust [<contact>] <fingerprint>",
            "/omemo fingerprint")
        CMD_DESC(
            "Omemo commands to manage keys, and perform encryption during chat sessions.")
        CMD_ARGS(
            { "gen",               "Generate OMEMO crytographic materials for current account." },
            { "start [<contact>]", "Start an OMEMO session with contact, or current recipient if omitted." },
            { "fingerprint",       "Show current device fingerprint." })
        CMD_EXAMPLES(
            "/omemo gen",
            "/omemo start buddy@buddychat.org",
            "/omemo trust c4f9c875-144d7a3b-0c4a05b6-ca3be51a-a037f329-0bd3ae62-07f99719-55559d2a")
    },
};

static GHashTable *search_index;

char*
_cmd_index(Command *cmd) {
    GString *index_source = g_string_new("");
    index_source = g_string_append(index_source, cmd->cmd);
    index_source = g_string_append(index_source, " ");
    index_source = g_string_append(index_source, cmd->help.desc);
    index_source = g_string_append(index_source, " ");

    int len = g_strv_length(cmd->help.tags);
    int i = 0;
    for (i = 0; i < len; i++) {
        index_source = g_string_append(index_source, cmd->help.tags[i]);
        index_source = g_string_append(index_source, " ");
    }
    len = g_strv_length(cmd->help.synopsis);
    for (i = 0; i < len; i++) {
        index_source = g_string_append(index_source, cmd->help.synopsis[i]);
        index_source = g_string_append(index_source, " ");
    }
    for (i = 0; cmd->help.args[i][0] != NULL; i++) {
        index_source = g_string_append(index_source, cmd->help.args[i][0]);
        index_source = g_string_append(index_source, " ");
        index_source = g_string_append(index_source, cmd->help.args[i][1]);
        index_source = g_string_append(index_source, " ");
    }

    gchar **tokens = g_str_tokenize_and_fold(index_source->str, NULL, NULL);
    g_string_free(index_source, TRUE);

    GString *index = g_string_new("");
    i = 0;
    for (i = 0; i < g_strv_length(tokens); i++) {
        index = g_string_append(index, tokens[i]);
        index = g_string_append(index, " ");
    }
    g_strfreev(tokens);

    char *res = index->str;
    g_string_free(index, FALSE);

    return res;
}

GList*
cmd_search_index_any(char *term)
{
    GList *results = NULL;

    gchar **processed_terms = g_str_tokenize_and_fold(term, NULL, NULL);
    int terms_len = g_strv_length(processed_terms);

    int i = 0;
    for (i = 0; i < terms_len; i++) {
        GList *index_keys = g_hash_table_get_keys(search_index);
        GList *curr = index_keys;
        while (curr) {
            char *index_entry = g_hash_table_lookup(search_index, curr->data);
            if (g_str_match_string(processed_terms[i], index_entry, FALSE)) {
                results = g_list_append(results, curr->data);
            }
            curr = g_list_next(curr);
        }
        g_list_free(index_keys);
    }

    g_strfreev(processed_terms);

    return results;
}

GList*
cmd_search_index_all(char *term)
{
    GList *results = NULL;

    gchar **terms = g_str_tokenize_and_fold(term, NULL, NULL);
    int terms_len = g_strv_length(terms);

    GList *commands = g_hash_table_get_keys(search_index);
    GList *curr = commands;
    while (curr) {
        char *command = curr->data;
        int matches = 0;
        int i = 0;
        for (i = 0; i < terms_len; i++) {
            char *command_index = g_hash_table_lookup(search_index, command);
            if (g_str_match_string(terms[i], command_index, FALSE)) {
                matches++;
            }
        }
        if (matches == terms_len) {
            results = g_list_append(results, command);
        }
        curr = g_list_next(curr);
    }

    g_list_free(commands);
    g_strfreev(terms);

    return results;
}

/*
 * Initialise command autocompleter and history
 */
void
cmd_init(void)
{
    log_info("Initialising commands");

    cmd_ac_init();

    search_index = g_hash_table_new_full(g_str_hash, g_str_equal, free, g_free);

    // load command defs into hash table
    commands = g_hash_table_new(g_str_hash, g_str_equal);
    unsigned int i;
    for (i = 0; i < ARRAY_SIZE(command_defs); i++) {
        Command *pcmd = command_defs+i;

        // add to hash
        g_hash_table_insert(commands, pcmd->cmd, pcmd);

        // add to search index
        g_hash_table_insert(search_index, strdup(pcmd->cmd), _cmd_index(pcmd));

        // add to commands and help autocompleters
        cmd_ac_add_cmd(pcmd);
    }

    // load aliases
    GList *aliases = prefs_get_aliases();
    GList *curr = aliases;
    while (curr) {
        ProfAlias *alias = curr->data;
        cmd_ac_add_alias(alias);
        curr = g_list_next(curr);
    }
    prefs_free_aliases(aliases);
}

void
cmd_uninit(void)
{
    cmd_ac_uninit();
    g_hash_table_destroy(search_index);
}

gboolean
cmd_valid_tag(const char *const str)
{
    return ((g_strcmp0(str, CMD_TAG_CHAT) == 0) ||
        (g_strcmp0(str, CMD_TAG_GROUPCHAT) == 0) ||
        (g_strcmp0(str, CMD_TAG_PRESENCE) == 0) ||
        (g_strcmp0(str, CMD_TAG_ROSTER) == 0) ||
        (g_strcmp0(str, CMD_TAG_DISCOVERY) == 0) ||
        (g_strcmp0(str, CMD_TAG_CONNECTION) == 0) ||
        (g_strcmp0(str, CMD_TAG_UI) == 0) ||
        (g_strcmp0(str, CMD_TAG_PLUGINS) == 0));
}

Command*
cmd_get(const char *const command)
{
    if (commands) {
        return g_hash_table_lookup(commands, command);
    } else {
        return NULL;
    }
}

GList*
cmd_get_ordered(const char *const tag)
{
    GList *ordered_commands = NULL;

    GHashTableIter iter;
    gpointer key;
    gpointer value;

    g_hash_table_iter_init(&iter, commands);
    while (g_hash_table_iter_next(&iter, &key, &value)) {
        Command *pcmd = (Command *)value;
        if (tag) {
            if (_cmd_has_tag(pcmd, tag)) {
                ordered_commands = g_list_insert_sorted(ordered_commands, pcmd->cmd, (GCompareFunc)g_strcmp0);
            }
        } else {
            ordered_commands = g_list_insert_sorted(ordered_commands, pcmd->cmd, (GCompareFunc)g_strcmp0);
        }
    }

    return ordered_commands;
}

static gboolean
_cmd_has_tag(Command *pcmd, const char *const tag)
{
    int i = 0;
    for (i = 0; pcmd->help.tags[i] != NULL; i++) {
        if (g_strcmp0(tag, pcmd->help.tags[i]) == 0) {
            return TRUE;
        }
    }

    return FALSE;
}

static int
_cmp_command(Command *cmd1, Command *cmd2)
{
    return g_strcmp0(cmd1->cmd, cmd2->cmd);
}

void
command_docgen(void)
{
    GList *cmds = NULL;
    unsigned int i;
    for (i = 0; i < ARRAY_SIZE(command_defs); i++) {
        Command *pcmd = command_defs+i;
        cmds = g_list_insert_sorted(cmds, pcmd, (GCompareFunc)_cmp_command);
    }

    FILE *toc_fragment = fopen("toc_fragment.html", "w");
    FILE *main_fragment = fopen("main_fragment.html", "w");

    fputs("<ul><li><ul><li>\n", toc_fragment);
    fputs("<hr>\n", main_fragment);

    GList *curr = cmds;
    while (curr) {
        Command *pcmd = curr->data;

        fprintf(toc_fragment, "<a href=\"#%s\">%s</a>,\n", &pcmd->cmd[1], pcmd->cmd);
        fprintf(main_fragment, "<a name=\"%s\"></a>\n", &pcmd->cmd[1]);
        fprintf(main_fragment, "<h4>%s</h4>\n", pcmd->cmd);

        fputs("<p><b>Synopsis</b></p>\n", main_fragment);
        fputs("<p><pre><code>", main_fragment);
        int i = 0;
        while (pcmd->help.synopsis[i]) {
            char *str1 = str_replace(pcmd->help.synopsis[i], "<", "&lt;");
            char *str2 = str_replace(str1, ">", "&gt;");
            fprintf(main_fragment, "%s\n", str2);
            i++;
        }
        fputs("</code></pre></p>\n", main_fragment);

        fputs("<p><b>Description</b></p>\n", main_fragment);
        fputs("<p>", main_fragment);
        fprintf(main_fragment, "%s\n", pcmd->help.desc);
        fputs("</p>\n", main_fragment);

        if (pcmd->help.args[0][0] != NULL) {
            fputs("<p><b>Arguments</b></p>\n", main_fragment);
            fputs("<table>", main_fragment);
            for (i = 0; pcmd->help.args[i][0] != NULL; i++) {
                fputs("<tr>", main_fragment);
                fputs("<td>", main_fragment);
                fputs("<code>", main_fragment);
                char *str1 = str_replace(pcmd->help.args[i][0], "<", "&lt;");
                char *str2 = str_replace(str1, ">", "&gt;");
                fprintf(main_fragment, "%s", str2);
                fputs("</code>", main_fragment);
                fputs("</td>", main_fragment);
                fputs("<td>", main_fragment);
                fprintf(main_fragment, "%s", pcmd->help.args[i][1]);
                fputs("</td>", main_fragment);
                fputs("</tr>", main_fragment);
            }
            fputs("</table>\n", main_fragment);
        }

        if (pcmd->help.examples[0] != NULL) {
            fputs("<p><b>Examples</b></p>\n", main_fragment);
            fputs("<p><pre><code>", main_fragment);
            int i = 0;
            while (pcmd->help.examples[i]) {
                fprintf(main_fragment, "%s\n", pcmd->help.examples[i]);
                i++;
            }
            fputs("</code></pre></p>\n", main_fragment);
        }

        fputs("<a href=\"#top\"><h5>back to top</h5></a><br><hr>\n", main_fragment);
        fputs("\n", main_fragment);

        curr = g_list_next(curr);
    }

    fputs("</ul></ul>\n", toc_fragment);

    fclose(toc_fragment);
    fclose(main_fragment);
    printf("\nProcessed %d commands.\n\n", g_list_length(cmds));
    g_list_free(cmds);
}