Source

pymag-emacs / vendor / doctest-mode.el

Full commit
   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
;;; doctest-mode.el --- Major mode for editing Python doctest files

;; Copyright (C) 2004-2007  Edward Loper

;; Author:     Edward Loper
;; Maintainer: edloper@alum.mit.edu
;; Created:    Aug 2004
;; Keywords:   python doctest unittest test docstring

(defconst doctest-version "0.4"
  "`doctest-mode' version number.")

;; This software is provided as-is, without express or implied
;; warranty.  Permission to use, copy, modify, distribute or sell this
;; software, without fee, for any purpose and by any individual or
;; organization, is hereby granted, provided that the above copyright
;; notice and this paragraph appear in all copies.

;; This is a major mode for editing text files that contain Python
;; doctest examples.  Doctest is a testing framework for Python that
;; emulates an interactive session, and checks the result of each
;; command.  For more information, see the Python library reference:
;; <http://docs.python.org/lib/module-doctest.html>

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Table of Contents
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;  1. Customization: use-editable variables to customize
;;     doctest-mode.
;;
;;  2. Fonts: defines new font-lock faces.
;;
;;  3. Constants: various consts (mainly regexps) used by the rest
;;     of the code.
;;
;;  4. Syntax Highlighting: defines variables and functions used by
;;     font-lock-mode to perform syntax highlighting.
;;
;;  5. Source code editing & indentation: commands used to
;;     automatically indent, dedent, & handle prompts.
;;
;;  6. Code Execution: commands used to start doctest processes,
;;     and handle their output.
;;
;;  7. Markers: functions used to insert markers at the start of
;;     doctest examples.  These are used to keep track of the
;;     correspondence between examples in the source buffer and
;;     results in the output buffer.
;;
;;  8. Navigation: commands used to navigate between failed examples.
;;
;;  9. Replace Output: command used to replace a doctest example's
;;     expected output with its actual output.
;;
;; 10. Helper functions: various helper functions used by the rest
;;     of the code.
;;
;; 11. Emacs compatibility functions: defines compatible versions of
;;     functions that are defined for some versions of emacs but not
;;     others.
;;
;; 12. Doctest Results Mode: defines doctest-results-mode, which is
;;     used for the output generated by doctest.
;;
;; 13. Doctest Mode: defines doctest-mode itself.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Customizable Constants
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defgroup doctest nil
  "Support for the Python doctest framework"
  :group 'languages
  :prefix "doctest-")

(defcustom doctest-default-margin 4
  "The default pre-prompt margin for doctest examples."
  :type 'integer
  :group 'doctest)

(defcustom doctest-avoid-trailing-whitespace t
  "If true, then delete trailing whitespace when inserting a newline."
  :type 'boolean
  :group 'doctest)

(defcustom doctest-temp-directory
  (let ((ok '(lambda (x)
	       (and x
		    (setq x (expand-file-name x)) ; always true
		    (file-directory-p x)
		    (file-writable-p x)
		    x))))
    (or (funcall ok (getenv "TMPDIR"))
	(funcall ok "/usr/tmp")
	(funcall ok "/tmp")
	(funcall ok "/var/tmp")
	(funcall ok  ".")
	(error (concat "Couldn't find a usable temp directory -- "
		       "set `doctest-temp-directory'"))))	 
  "Directory used for temporary files created when running doctest.
By default, the first directory from this list that exists and that you
can write into: the value (if any) of the environment variable TMPDIR,
/usr/tmp, /tmp, /var/tmp, or the current directory."
  :type 'string
  :group 'doctest)

(defcustom doctest-hide-example-source nil
  "If true, then don't display the example source code for each 
failure in the results buffer."
  :type 'boolean
  :group 'doctest)

(defcustom doctest-python-command "python"
  "Shell command used to start the python interpreter"
  :type 'string
  :group 'doctest)

(defcustom doctest-results-buffer-name "*doctest-output (%N)*"
  "The name of the buffer used to store the output of the doctest
command.  This name can contain the following special sequences:
  %n -- replaced by the doctest buffer's name.
  %N -- replaced by the doctest buffer's name, with '.doctest'
        stripped off.
  %f -- replaced by the doctest buffer's filename."
  :type 'string
  :group 'doctest)

(defcustom doctest-optionflags '()
  "Option flags for doctest"
  :group 'doctest
  :type '(repeat (choice (const :tag "Select an option..." "")
                         (const :tag "Normalize whitespace"
                                "NORMALIZE_WHITESPACE")
                         (const :tag "Ellipsis"
                                "ELLIPSIS")
                         (const :tag "Don't accept True for 1"
                                "DONT_ACCEPT_TRUE_FOR_1")
                         (const :tag "Don't accept <BLANKLINE>"
                                "DONT_ACCEPT_BLANKLINE")
                         (const :tag "Ignore Exception detail"
                                "IGNORE_EXCEPTION_DETAIL")
                         (const :tag "Report only first failure"
                                "REPORT_ONLY_FIRST_FAILURE")
                         )))

(defcustom doctest-async t
  "If true, then doctest will be run asynchronously."
  :type 'boolean
  :group 'doctest)

(defcustom doctest-trim-exceptions t
  "If true, then any exceptions inserted by doctest-replace-output
will have the stack trace lines trimmed."
  :type 'boolean
  :group 'doctest)

(defcustom doctest-highlight-strings t
  "If true, then highlight strings.  If you find that doctest-mode
is responding slowly when you type, turning this off might help."
  :type 'boolean
  :group 'doctest)

(defcustom doctest-follow-output t
  "If true, then when doctest is run asynchronously, the output buffer
will scroll to display its output as it is generated.  If false, then
the output buffer not scroll."
  :type 'boolean
  :group 'doctest)

(defvar doctest-mode-hook nil
  "Hook called by `doctest-mode'.")

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Fonts
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defface doctest-prompt-face
  '((((class color) (background dark))
     (:foreground "#68f"))
    (t (:foreground "#226")))
  "Face for Python prompts in doctest examples."
  :group 'doctest)

(defface doctest-output-face
  '((((class color) (background dark))
     (:foreground "#afd"))
    (t (:foreground "#262")))
  "Face for the output of doctest examples."
  :group 'doctest)

(defface doctest-output-marker-face
  '((((class color) (background dark))
     (:foreground "#0f0"))
    (t (:foreground "#080")))
  "Face for markers in the output of doctest examples."
  :group 'doctest)

(defface doctest-output-traceback-face
  '((((class color) (background dark))
     (:foreground "#f88"))
    (t (:foreground "#622")))
  "Face for traceback headers in the output of doctest examples."
  :group 'doctest)

(defface doctest-results-divider-face
  '((((class color) (background dark))
     (:foreground "#08f"))
    (t (:foreground "#00f")))
  "Face for dividers in the doctest results window."
  :group 'doctest)

(defface doctest-results-loc-face
  '((((class color) (background dark))
     (:foreground "#0f8"))
    (t (:foreground "#084")))
  "Face for location headers in the doctest results window."
  :group 'doctest)

(defface doctest-results-header-face
  '((((class color) (background dark))
     (:foreground "#8ff"))
    (t (:foreground "#088")))
  "Face for sub-headers in the doctest results window."
  :group 'doctest)

(defface doctest-results-selection-face
  '((((class color) (background dark))
     (:foreground "#ff0" :background "#008"))
    (t (:background "#088" :foreground "#fff")))
  "Face for selected failure's location header in the results window."
  :group 'doctest)

(defface doctest-selection-face
  '((((class color) (background dark))
     (:foreground "#ff0" :background "#00f" :bold t))
    (t (:foreground "#f00")))
  "Face for selected example's prompt"
  :group 'doctest)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Constants
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defconst doctest-prompt-re
  "^\\(?:\\([ \t]*\\)\\(>>> ?\\|[.][.][.] ?\\)\\([ \t]*\\)\\)"
  "Regular expression for doctest prompts.  It defines three groups:
the pre-prompt margin; the prompt; and the post-prompt indentation.")

(defconst doctest-open-block-re
  "[^\n]+:[ \t]*\\(#.*\\)?$"
  "Regular expression for a line that opens a block")

(defconst doctest-close-block-re
  "\\(return\\|raise\\|break\\|continue\\|pass\\)\\b"
  "Regular expression for a line that closes a block")

(defconst doctest-example-source-re 
  "^Failed example:\n\\(\n\\|    [^\n]*\n\\)+"
  "Regular expression for example source in doctest's output.")

(defconst doctest-results-divider-re
  "^\\([*]\\{60,\\}\\)$"
  "Regular expression for example dividers in doctest's output.")

(defconst doctest-py24-results-loc-re
  "^File \"[^\"]+\", line \\([0-9]+\\), in [^\n]+"
  "Regular expression for example location markers in doctest's output.")

(defconst doctest-py21-results-loc-re
  "^from line #\\([0-9]+\\) of [^\n]*"
  "Regular expression for example location markers in doctest's output,
when the output was generated by an old version of doctest.")

(defconst doctest-results-header-re
  "^\\([^ \n\t].+:\\|Expected nothing\\|Got nothing\\)$"
  "Regular expression for example headers in doctest's output.")

(defconst doctest-traceback-header-re
  "^[ \t]*Traceback (\\(most recent call last\\|innermost last\\)):"
  "Regular expression for Python traceback headers.")

(defconst doctest-py21-results-re
  "^from line #"
  "Regular expression used to test which version of doctest was used.")

;; nb: There's a bug in Python's traceback.print_exception function
;; which causes SyntaxError exceptions to be displayed incorrectly;
;; which prevents this regexp from matching.  But there shouldn't be
;; too many people testing for SyntaxErrors, so I won't worry about
;; it.
(defconst doctest-traceback-re
  (let ((nonprompt
         ;; This matches any non-blank line that doesn't start with
         ;; a prompt (... or >>>).
         (concat 
          "\\(?:[.][.][^.\n]\\|[>][>][^>\n]\\|"
          "[.][^.\n]\\|[>][^>\n]\\|[^.>\n \t]\\)[^\n]*")))
    (concat
     "^\\(\\([ \t]*\\)Traceback "
     "(\\(?:most recent call last\\|innermost last\\)):\n\\)"
     "\\(?:\\2[ \t]+[^ \t\n][^\n]*\n\\)*"
     "\\(\\(?:\\2" nonprompt "\n\\)"
        "\\(?:\\2[ \t]*" nonprompt "\n\\)*\\)"))
  "Regular expression that matches a complete exception traceback.
It contains three groups: group 1 is the header line; group 2 is
the indentation; and group 3 is the exception message.")
  
(defconst doctest-blankline-re
  "^[ \t]*<BLANKLINE>"
  "Regular expression that matches blank line markers in doctest
output.")

(defconst doctest-outdent-re
  (concat "\\(" (mapconcat 'identity
			   '("else:"
			     "except\\(\\s +.*\\)?:"
			     "finally:"
			     "elif\\s +.*:")
			   "\\|")
	  "\\)")
  "Regular expression for a line that should be outdented.  Any line
that matches `doctest-outdent-re', but does not follow a line matching
`doctest-no-outdent-re', will be outdented.")

;; It's not clear to me *why* the behavior given by this definition of
;; doctest-no-outdent-re is desirable; but it's basically just copied
;; from python-mode.
(defconst doctest-no-outdent-re
  (concat
   "\\("
   (mapconcat 'identity
	      (list "try:"
		    "except\\(\\s +.*\\)?:"
		    "while\\s +.*:"
		    "for\\s +.*:"
		    "if\\s +.*:"
		    "elif\\s +.*:"
                    "\\(return\\|raise\\|break\\|continue\\|pass\\)[ \t\n]"
		    )
	      "\\|")
	  "\\)")
  "Regular expression matching lines not to outdent after.  Any line
that matches `doctest-outdent-re', but does not follow a line matching
`doctest-no-outdent-re', will be outdented.")

(defconst doctest-script
  (concat "from doctest import *\n"
          "import sys\n"
          "doc = open('%s').read()\n"
          "if sys.version_info[:2] >= (2,4):\n"
          "    test = DocTestParser().get_doctest(doc, {}, '%s', '%s', 0)\n"
          "    r = DocTestRunner(optionflags=%s)\n"
          "    r.run(test)\n"
          "else:\n"
          "    Tester(globs={}).runstring(doc, '%s')\n"
;;;          "print\n";; <- so the buffer won't be empty
          )
  "Python script used to run doctest.  It takes the following arguments,
supplied by `format': TEMPFILE, BUFFER-NAME, BUFFER-FILE-NAME, FLAGS,
BUFFER-FILE-NAME.")

(defconst doctest-keyword-re
  (let* ((kw1 (mapconcat 'identity
                         '("and"      "assert"   "break"   "class"
                           "continue" "def"      "del"     "elif"
                           "else"     "except"   "exec"    "for"
                           "from"     "global"   "if"      "import"
                           "in"       "is"       "lambda"  "not"
                           "or"       "pass"     "print"   "raise"
                           "return"   "while"    "yield"
                           )
                         "\\|"))
         (kw2 (mapconcat 'identity
                         '("else:" "except:" "finally:" "try:")
                         "\\|"))
         (kw3 (mapconcat 'identity
                         '("ArithmeticError" "AssertionError"
                           "AttributeError" "DeprecationWarning" "EOFError"
                           "Ellipsis" "EnvironmentError" "Exception" "False"
                           "FloatingPointError" "FutureWarning" "IOError"
                           "ImportError" "IndentationError" "IndexError"
                           "KeyError" "KeyboardInterrupt" "LookupError"
                           "MemoryError" "NameError" "None" "NotImplemented"
                           "NotImplementedError" "OSError" "OverflowError"
                           "OverflowWarning" "PendingDeprecationWarning"
                           "ReferenceError" "RuntimeError" "RuntimeWarning"
                           "StandardError" "StopIteration" "SyntaxError"
                           "SyntaxWarning" "SystemError" "SystemExit"
                           "TabError" "True" "TypeError" "UnboundLocalError"
                           "UnicodeDecodeError" "UnicodeEncodeError"
                           "UnicodeError" "UnicodeTranslateError"
                           "UserWarning" "ValueError" "Warning"
                           "ZeroDivisionError" "__debug__"
                           "__import__" "__name__" "abs" "apply" "basestring"
                           "bool" "buffer" "callable" "chr" "classmethod"
                           "cmp" "coerce" "compile" "complex" "copyright"
                           "delattr" "dict" "dir" "divmod"
                           "enumerate" "eval" "execfile" "exit" "file"
                           "filter" "float" "getattr" "globals" "hasattr"
                           "hash" "hex" "id" "input" "int" "intern"
                           "isinstance" "issubclass" "iter" "len" "license"
                           "list" "locals" "long" "map" "max" "min" "object"
                           "oct" "open" "ord" "pow" "property" "range"
                           "raw_input" "reduce" "reload" "repr" "round"
                           "setattr" "slice" "staticmethod" "str" "sum"
                           "super" "tuple" "type" "unichr" "unicode" "vars"
                           "xrange" "zip")
                         "\\|"))
         (pseudokw (mapconcat 'identity
                              '("self" "None" "True" "False" "Ellipsis")
                              "\\|"))
         (string (concat "'\\(?:\\\\[^\n]\\|[^\n']*\\)'" "\\|"
                         "\"\\(?:\\\\[^\n]\\|[^\n\"]*\\)\""))
         (brk "\\(?:[ \t(]\\|$\\)"))
    (concat
     ;; Comments (group 1)
     "\\(#.*\\)"
     ;; Function & Class Definitions (groups 2-3)
     "\\|\\b\\(class\\|def\\)"
     "[ \t]+\\([a-zA-Z_][a-zA-Z0-9_]*\\)"
     ;; Builtins preceeded by '.'(group 4)
     "\\|[.][\t ]*\\(" kw3 "\\)"
     ;; Keywords & builtins (group 5)
     "\\|\\b\\(" kw1 "\\|" kw2 "\\|"
     kw3 "\\|" pseudokw "\\)" brk
     ;; Decorators (group 6)
     "\\|\\(@[a-zA-Z_][a-zA-Z0-9_]*\\)"
     ))
  "A regular expression used for syntax highlighting of Python
source code.")

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Syntax Highlighting (font-lock mode)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; Define the font-lock keyword table.
(defconst doctest-font-lock-keywords
  `(
    ;; The following pattern colorizes source lines.  In particular,
    ;; it first matches prompts, and then looks for any of the
    ;; following matches *on the same line* as the prompt.  It uses
    ;; the form:
    ;;
    ;;   (MATCHER MATCH-HIGHLIGHT
    ;;            (ANCHOR-MATCHER nil nil MATCH-HIGHLIGHT))
    ;;
    ;; See the variable documentation for font-lock-keywords for a
    ;; description of what each of those means.
    ("^[ \t]*\\(>>>\\|\\.\\.\\.\\)"
     (1 'doctest-prompt-face)
     (doctest-source-matcher
      nil nil
      (1 'font-lock-comment-face t t)         ; comments
      (2 'font-lock-keyword-face t t)         ; def/class
      (3 'font-lock-type-face t t)            ; func/class name
      ;; group 4 (builtins preceeded by '.') gets no colorization.
      (5 'font-lock-keyword-face t t)         ; keywords & builtins
      (6 'font-lock-preprocessor-face t t)    ; decorators
      (7 'font-lock-string-face t t)          ; strings
      ))
      
    ;; The following pattern colorizes output lines.  In particular,
    ;; it uses doctest-output-line-matcher to check if this is an
    ;; output line, and if so, it colorizes it, and any special
    ;; markers it contains.
    (doctest-output-line-matcher
     (0 'doctest-output-face t)
     ("\\.\\.\\." (beginning-of-line) (end-of-line)
      (0 'doctest-output-marker-face t))
     (,doctest-blankline-re (beginning-of-line) (end-of-line)
                            (0 'doctest-output-marker-face t))
     (doctest-traceback-line-matcher (beginning-of-line) (end-of-line)
                                     (0 'doctest-output-traceback-face t))
     (,doctest-traceback-header-re (beginning-of-line) (end-of-line)
                                   (0 'doctest-output-traceback-face t))
     )

    ;; A PS1 prompt followed by a non-space is an error.
    ("^[ \t]*\\(>>>[^ \t\n][^\n]*\\)" (1 'font-lock-warning-face t))
    )
  "Expressions to highlight in doctest-mode.")

(defconst doctest-results-font-lock-keywords
  `((,doctest-results-divider-re 
     (0 'doctest-results-divider-face))
    (,doctest-py24-results-loc-re 
     (0 'doctest-results-loc-face))
    (,doctest-results-header-re 
     (0 'doctest-results-header-face))
    (doctest-results-selection-matcher 
     (0 'doctest-results-selection-face t)))
  "Expressions to highlight in doctest-results-mode.")

(defun doctest-output-line-matcher (limit)
  "A `font-lock-keyword' MATCHER that returns t if the current 
line is the expected output for a doctest example, and if so, 
sets `match-data' so that group 0 spans the current line."
  ;; The real work is done by doctest-find-output-line.
  (when (doctest-find-output-line limit)
    ;; If we found one, then mark the entire line.
    (beginning-of-line)
    (re-search-forward "[^\n]*" limit)))

(defun doctest-traceback-line-matcher (limit)
  "A `font-lock-keyword' MATCHER that returns t if the current line is
the beginning of a traceback, and if so, sets `match-data' so that
group 0 spans the entire traceback.  n.b.: limit is ignored."
  (beginning-of-line)
  (when (looking-at doctest-traceback-re)
      (goto-char (match-end 0))
      t))

(defun doctest-source-matcher (limit)
  "A `font-lock-keyword' MATCHER that returns t if the current line
contains a Python source expression that should be highlighted
after the point.  If so, it sets `match-data' to cover the string
literal.  The groups in `match-data' should be interpreted as follows:

  Group 1: comments
  Group 2: def/class
  Group 3: function/class name
  Group 4: builtins preceeded by '.'
  Group 5: keywords & builtins
  Group 6: decorators
  Group 7: strings
"
  (let ((matchdata nil))
    ;; First, look for string literals.
    (when doctest-highlight-strings
      (save-excursion
        (when (doctest-string-literal-matcher limit)
          (setq matchdata
                (list (match-beginning 0) (match-end 0)
                      nil nil nil nil nil nil nil nil nil nil nil nil
                      (match-beginning 0) (match-end 0))))))
    ;; Then, look for other keywords.  If they occur before the
    ;; string literal, then they take precedence.
    (save-excursion
      (when (and (re-search-forward doctest-keyword-re limit t)
                 (or (null matchdata)
                     (< (match-beginning 0) (car matchdata))))
        (setq matchdata (match-data))))
    (when matchdata
      (set-match-data matchdata)
      (goto-char (match-end 0))
      t)))
          
(defun doctest-string-literal-matcher (limit &optional debug)
  "A `font-lock-keyword' MATCHER that returns t if the current line
contains a string literal starting at or after the point.  If so, it
expands `match-data' to cover the string literal.  This matcher uses
`doctest-statement-info' to collect information about strings that
continue over multiple lines.  It therefore might be a little slow for
very large statements."
  (let* ((stmt-info (doctest-statement-info))
         (quotes (reverse (nth 5 stmt-info)))
         (result nil))
    (if debug (doctest-debug "quotes %s" quotes))
    (while (and quotes (null result))
      (let* ((quote (pop quotes))
             (start (car quote))
             (end (min limit (or (cdr quote) limit))))
        (if debug (doctest-debug "quote %s-%s pt=%s lim=%s"
                                 start end (point) limit))
        (when (or (and (<= (point) start) (< start limit))
                  (and (< start (point)) (< (point) end)))
          (setq start (max start (point)))
          (set-match-data (list start end))
          (if debug (doctest-debug "marking string %s" (match-data)))
          (goto-char end)
          (setq result t))))
    result))
   
(defun doctest-results-selection-matcher (limit)
  "Matches from `doctest-selected-failure' to the end of the
line.  This is used to highlight the currently selected failure."
  (when (and doctest-selected-failure
	     (<= (point) doctest-selected-failure)
	     (< doctest-selected-failure limit))
    (goto-char doctest-selected-failure)
    (re-search-forward "[^\n]+" limit)))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Source code editing & indentation
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-indent-source-line (&optional dedent-only)
  "Re-indent the current line, as doctest source code.  I.e., add a
prompt to the current line if it doesn't have one, and re-indent the
source code (to the right of the prompt).  If `dedent-only' is true,
then don't increase the indentation level any."
  (interactive "*")
  (let ((indent-end nil))
    (save-excursion
      (beginning-of-line)
      (let ((new-indent (doctest-current-source-line-indentation dedent-only))
            (new-margin (doctest-current-source-line-margin))
            (line-had-prompt (looking-at doctest-prompt-re)))
        ;; Delete the old prompt (if any).
        (when line-had-prompt
          (goto-char (match-end 1))
          (delete-char 4))
        ;; Delete the old indentation.
        (delete-backward-char (skip-chars-forward " \t"))
        ;; If it's a continuation line, or a new PS1 prompt,
        ;; then copy the margin.
        (when (or new-indent (not line-had-prompt))
          (beginning-of-line)
          (delete-backward-char (skip-chars-forward " \t"))
          (insert-char ?\  new-margin))
        ;; Add the new prompt.
        (insert-string (if new-indent "... " ">>> "))
        ;; Add the new indentation
        (if new-indent (insert-char ?\  new-indent))
        (setq indent-end (point))))
    ;; If we're left of the indentation end, then move up to the
    ;; indentation end.
    (if (< (point) indent-end) (goto-char indent-end))))

(defun doctest-current-source-line-indentation (&optional dedent-only)
  "Return the post-prompt indent to use for this line.  This is an
integer for a continuation lines, and nil for non-continuation lines."
  (save-excursion
    ;; Examine the previous doctest line (if present).
    (let* ((prev-stmt-info (doctest-prev-statement-info))
           (prev-stmt-indent (nth 0 prev-stmt-info)) 
           (continuation-indent (nth 1 prev-stmt-info))
           (prev-stmt-opens-block (nth 2 prev-stmt-info))
           (prev-stmt-closes-block (nth 3 prev-stmt-info))
           (prev-stmt-blocks-outdent (nth 4 prev-stmt-info))
           )
      ;; Examine this doctest line.
      (let* ((curr-line-indent 0)
             (curr-line-outdented nil))
        (beginning-of-line)
        (when (looking-at doctest-prompt-re)
          (setq curr-line-indent (- (match-end 3) (match-beginning 3)))
          (goto-char (match-end 3)))
        (setq curr-line-outdented (and (looking-at doctest-outdent-re)
                                       (not prev-stmt-blocks-outdent)))
        ;; Compute the overall indent.
        (let ((indent (or continuation-indent 
                          (+ prev-stmt-indent
                             (if curr-line-outdented -4 0)
                             (if prev-stmt-opens-block 4 0)
                             (if prev-stmt-closes-block -4 0)))))
          ;; If dedent-only is true, then make sure we don't indent.
          (when dedent-only 
            (setq indent (min indent curr-line-indent)))
          ;; If indent=0 and we're not outdented, then set indent to
          ;; nil (to signify the start of a new source example).
          (when (and (= indent 0)
                     (not (or curr-line-outdented continuation-indent)))
            (setq indent nil))
          ;; Return the indentation.
          indent)))))

(defun doctest-prev-statement-info (&optional debug)
  (save-excursion
    (forward-line -1)
    (doctest-statement-info debug)))

(defun doctest-statement-info (&optional debug)
  "Collect info about the previous statement, and return it as a list:

  (INDENT, CONTINUATION, OPENS-BLOCK, CLOSES-BLOCK, BLOCKS-OUTDENT,
   QUOTES)

INDENT -- The indentation of the previous statement (after the prompt)

CONTINUATION -- If the previous statement is incomplete (e.g., has an
open paren or quote), then this is the appropriate indentation
level; otherwise, it's nil.

OPENS-BLOCK -- True if the previous statement opens a Python control
block.

CLOSES-BLOCK -- True if the previous statement closes a Python control
block.

BLOCKS-OUTDENT -- True if the previous statement should 'block the
next statement from being considered an outdent.

QUOTES -- A list of (START . END) pairs for all quotation strings.
"
  (save-excursion
    (end-of-line)
    (let ((end (point)))
      (while (and (doctest-on-source-line-p "...") (= (forward-line -1) 0)))
      (cond
       ;; If there's no previous >>> line, then give up.
       ((not (doctest-on-source-line-p ">>>"))
        '(0 nil nil nil nil))
       
       ;; If there is a previous statement, walk through the source
       ;; code, checking for operators that may be of interest.
       (t 
        (beginning-of-line)
        (let* ((quote-mark nil) (nesting 0) (indent-stack '())
               (stmt-indent 0)
               (stmt-opens-block nil)
               (stmt-closes-block nil)
               (stmt-blocks-outdent nil)
               (quotes '())
               (elt-re (concat "\\\\[^\n]\\|"
                               "(\\|)\\|\\[\\|\\]\\|{\\|}\\|"
                               "\"\"\"\\|\'\'\'\\|\"\\|\'\\|"
                               "#[^\n]*\\|" doctest-prompt-re)))
          (while (re-search-forward elt-re end t)
            (let* ((elt (match-string 0))
                   (elt-first-char (substring elt 0 1)))
              (if debug (doctest-debug "Debug: %s" elt))
              (cond
               ;; Close quote -- set quote-mark back to nil.  The
               ;; second case is for cases like: '  '''
               (quote-mark
                (cond
                 ((equal quote-mark elt)
                  (setq quote-mark nil)
                  (setcdr (car quotes) (point)))
                 ((equal quote-mark elt-first-char)
                  (setq quote-mark nil)
                  (setcdr (car quotes) (point))
                  (backward-char 2))))
               ;; Prompt -- check if we're starting a new stmt.  If so,
               ;; then collect various info about it.
               ((string-match doctest-prompt-re elt)
                (when (and (null quote-mark) (= nesting 0))
                  (let ((indent (- (match-end 3) (match-end 2))))
                    (unless (looking-at "[ \t]*\n")
                      (setq stmt-indent indent)
                      (setq stmt-opens-block
                            (looking-at doctest-open-block-re))
                      (setq stmt-closes-block
                            (looking-at doctest-close-block-re))
                      (setq stmt-blocks-outdent
                            (looking-at doctest-no-outdent-re))))))
               ;; Open paren -- increment nesting, and update indent-stack.
               ((string-match "(\\|\\[\\|{" elt-first-char)
                (let ((elt-pos (point))
                      (at-eol (looking-at "[ \t]*\n"))
                      (indent 0))
                  (save-excursion 
                    (re-search-backward doctest-prompt-re)
                    (if at-eol
                        (setq indent (+ 4 (- (match-end 3) (match-end 2))))
                      (setq indent (- elt-pos (match-end 2))))
                    (push indent indent-stack)))
                (setq nesting (+ nesting 1)))
               ;; Close paren -- decrement nesting, and pop indent-stack.
               ((string-match ")\\|\\]\\|}" elt-first-char)
                (setq indent-stack (cdr indent-stack))
                (setq nesting (max 0 (- nesting 1))))
               ;; Open quote -- set quote-mark.
               ((string-match "\"\\|\'" elt-first-char)
                (push (cons (- (point) (length elt)) nil) quotes)
                (setq quote-mark elt)))))
        
          (let* ((continuation-indent
                 (cond
                  (quote-mark 0)
                  ((> nesting 0) (if (null indent-stack) 0 (car indent-stack)))
                  (t nil)))
                 (result 
                  (list stmt-indent continuation-indent
                        stmt-opens-block stmt-closes-block
                        stmt-blocks-outdent quotes)))
            (if debug (doctest-debug "Debug: %s" result))
            result)))))))

(defun doctest-current-source-line-margin ()
  "Return the pre-prompt margin to use for this source line.  This is
copied from the most recent source line, or set to
`doctest-default-margin' if there are no preceeding source lines."
  (save-excursion
    (beginning-of-line)
    (forward-line -1)
    (while (and (not (doctest-on-source-line-p))
                (re-search-backward doctest-prompt-re nil t)))
    (if (looking-at doctest-prompt-re)
        (- (match-end 1) (match-beginning 1))
      doctest-default-margin)))

(defun doctest-electric-backspace ()
  "Delete the preceeding character, level of indentation, or
prompt.  

If point is at the leftmost column, delete the preceding newline.

Otherwise, if point is at the first non-whitespace character
following an indented source line's prompt, then reduce the
indentation to the next multiple of 4; and update the source line's
prompt, when necessary.

Otherwise, if point is at the first non-whitespace character
following an unindented source line's prompt, then remove the
prompt (converting the line to an output line or text line).

Otherwise, if point is at the first non-whitespace character of a
line, the delete the line's indentation.

Otherwise, delete the preceeding character.
"
  (interactive "*")
  (cond 
   ;; Beginning of line: delete preceeding newline.
   ((bolp) (backward-delete-char 1))
      
   ;; First non-ws char following prompt: dedent or remove prompt.
   ((and (looking-at "[^ \t\n]\\|$") (doctest-looking-back doctest-prompt-re))
    (let* ((prompt-beg (match-beginning 2))
	   (indent-beg (match-beginning 3)) (indent-end (match-end 3))
	   (old-indent (- indent-end indent-beg))
	   (new-indent (* (/ (- old-indent 1) 4) 4)))
      (cond
       ;; Indented source line: dedent it.
       ((> old-indent 0)
	(goto-char indent-beg)
	(delete-region indent-beg indent-end)
	(insert-char ?\  new-indent)
	;; Change prompt to PS1, when appropriate.
	(when (and (= new-indent 0) (not (looking-at doctest-outdent-re)))
	  (delete-backward-char 4)
	  (insert-string ">>> ")))
       ;; Non-indented source line: remove prompt.
       (t
	(goto-char indent-end)
	(delete-region prompt-beg indent-end)))))

   ;; First non-ws char of a line: delete all indentation.
   ((and (looking-at "[^ \n\t]\\|$") (doctest-looking-back "^[ \t]+"))
    (delete-region (match-beginning 0) (match-end 0)))

   ;; Otherwise: delete a character.
   (t
    (backward-delete-char 1))))

(defun doctest-newline-and-indent ()
  "Insert a newline, and indent the new line appropriately.

If the current line is a source line containing a bare prompt,
then clear the current line, and insert a newline.

Otherwise, if the current line is a source line, then insert a
newline, and add an appropriately indented prompt to the new
line.

Otherwise, if the current line is an output line, then insert a
newline and indent the new line to match the example's margin.

Otherwise, insert a newline.

If `doctest-avoid-trailing-whitespace' is true, then clear any
whitespace to the left of the point before inserting a newline.
"
  (interactive "*")
  ;; If we're avoiding trailing spaces, then delete WS before point.
  (if doctest-avoid-trailing-whitespace
      (delete-char (- (skip-chars-backward " \t"))))     
  (cond 
   ;; If we're on an empty prompt, delete it.
   ((doctest-on-empty-source-line-p)
    (delete-region (match-beginning 0) (match-end 0))
    (insert-char ?\n 1))
   ;; If we're on a doctest line, add a new prompt.
   ((doctest-on-source-line-p)
    (insert-char ?\n 1)
    (doctest-indent-source-line))
   ;; If we're in doctest output, indent to the margin.
   ((doctest-on-output-line-p)
    (insert-char ?\n 1)
    (insert-char ?\  (doctest-current-source-line-margin)))
   ;; Otherwise, just add a newline.
   (t (insert-char ?\n 1))))

(defun doctest-electric-colon ()
  "Insert a colon, and dedent the line when appropriate."
  (interactive "*")
  (insert-char ?: 1)
  (when (doctest-on-source-line-p)
    (doctest-indent-source-line t)))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Code Execution
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-execute-buffer-with-diff ()
  "Run doctest on the current buffer, and display the results in the 
*doctest-output* buffer, using the diff format."
  (interactive)
  (doctest-execute-buffer t))

(defun doctest-execute-buffer (&optional diff)
  "Run doctest on the current buffer, and display the results in the 
*doctest-output* buffer."
  (interactive)
  (doctest-execute-region (point-min) (point-max) diff))
  
(defun doctest-execute-region (start end &optional diff)
  "Run doctest on the current buffer, and display the results in the 
*doctest-output* buffer."
  (interactive "r")
  ;; If it's already running, give the user a chance to restart it.
  (when (doctest-process-live-p doctest-async-process)
    (when (y-or-n-p "Doctest is already running.  Restart it? ")
      (doctest-cancel-async-process)
      (message "Killing doctest...")))
  (cond
   ((and doctest-async (doctest-process-live-p doctest-async-process))
    (message "Can't run two doctest processes at once!"))
   (t
    (let* ((results-buf-name (doctest-results-buffer-name))
           (temp (concat (doctest-temp-name) ".py"))
           (tempfile (expand-file-name temp doctest-temp-directory))
           (cur-buf (current-buffer))
           (in-buf (get-buffer-create "*doctest-input*"))
           ;(beg (point-min)) (end (point-max))
           (script (format doctest-script tempfile (buffer-name)
                           (buffer-file-name) (doctest-optionflags diff)
                           (buffer-file-name))))
      ;; Write buffer to a file.
      (save-excursion
        (goto-char (min start end))
        (let ((lineno (doctest-line-number)))
          (set-buffer in-buf)
          ;; Add blank lines, to keep line numbers the same:
          (dotimes (n (- lineno 1)) (insert-string "\n"))
          ;; Add the selected region
          (insert-buffer-substring cur-buf start end)
          ;; Write it to a file
          (write-file tempfile)
          ;; Dispose of the buffer
          (kill-buffer in-buf)))
      ;; Prepare the results buffer.  Clear it, if it contains
      ;; anything, and set its mode.
      (setq doctest-results-buffer (get-buffer-create results-buf-name))
      (save-excursion
        (set-buffer doctest-results-buffer)
        (toggle-read-only 0)
        (delete-region (point-min) (point-max))
        (doctest-results-mode)
        (setq doctest-source-buffer cur-buf)
        )
      ;; Add markers to examples, and record what line number each one
      ;; starts at.  That way, if the input buffer is edited, we can
      ;; still find corresponding examples in the output.
      (doctest-mark-examples)
      ;; Run doctest
      (cond (doctest-async
             ;; Asynchronous mode:
             (let ((process (start-process "*doctest*" doctest-results-buffer
                                           doctest-python-command
                                           "-c" script)))
               ;; Store some information about the process.
               (setq doctest-async-process-tempfile tempfile)
               (setq doctest-async-process-buffer cur-buf)
               (setq doctest-async-process process)
               
               ;; Set up a sentinel to respond when it's done running.
               (set-process-sentinel process 'doctest-async-process-sentinel)

               ;; Show the output window.
               (let ((w (display-buffer doctest-results-buffer)))
                 (when doctest-follow-output
                   ;; Insert a newline, which will move the buffer's
                   ;; point past the process's mark -- this causes the
                   ;; window to scroll as new output is generated.
                   (save-current-buffer
                     (set-buffer doctest-results-buffer)
                     (insert-string "\n")
                     (set-window-point w (point)))))

               ;; Let the user know the process is running.
               (doctest-update-mode-line ":running")
               (message "Running doctest...")))
            (t
             ;; Synchronous mode:
             (call-process doctest-python-command nil
                           doctest-results-buffer t "-c" script)
             (doctest-handle-output)
             (delete-file tempfile)))))))

(defun doctest-handle-output ()
  "This function, which is called after the 'doctest' process spawned
by doctest-execute-buffer has finished, checks the doctest results
buffer.  If that buffer is empty, it reports no errors and hides it;
if that buffer is not empty, it reports that errors occured, displays
the buffer, and runs doctest-postprocess-results."
  ;; If any tests failed, display them.
  (cond ((not (buffer-live-p doctest-results-buffer))
         (doctest-warn "Results buffer not found!"))
        ((> (buffer-size doctest-results-buffer) 1)
         (display-buffer doctest-results-buffer)
         (doctest-postprocess-results)
         (let ((num (length doctest-example-markers)))
           (message "%d doctest example%s failed!" num
                    (if (= num 1) "" "s"))))
        (t
         (display-buffer doctest-results-buffer)
         (delete-windows-on doctest-results-buffer)
         (message "All doctest examples passed!"))))
         
(defun doctest-async-process-sentinel (process state)
  "A process sentinel, called when the asynchronous doctest process
completes, which calls doctest-handle-output."
  ;; Check to make sure we got the process we're expecting.  On
  ;; some operating systems, this will end up getting called twice
  ;; when we use doctest-cancel-async-process; this check keeps us
  ;; from trying to clean up after the same process twice (since we
  ;; set doctest-async-process to nil when we're done).
  (when (and (equal process doctest-async-process)
             (buffer-live-p doctest-async-process-buffer))
    (save-current-buffer
      (set-buffer doctest-async-process-buffer)
      (cond ((not (buffer-live-p doctest-results-buffer))
             (doctest-warn "Results buffer not found!"))
            ((equal state "finished\n")
             (doctest-handle-output)
             (let ((window (get-buffer-window
                            doctest-async-process-buffer t)))
               (when window (set-window-point window (point)))))
            ((equal state "killed\n")
             (message "Doctest killed."))
            (t
             (message "Doctest failed -- %s" state)
             (display-buffer doctest-results-buffer)))
      (doctest-update-mode-line "")
      (when doctest-async-process-tempfile
        (delete-file doctest-async-process-tempfile)
        (setq doctest-async-process-tempfile nil))
      (setq doctest-async-process nil))))

(defun doctest-cancel-async-process ()
  "If a doctest process is running, then kill it."
  (interactive "")
  (when (doctest-process-live-p doctest-async-process)
    ;; Update the modeline
    (doctest-update-mode-line ":killing")
    ;; Kill the process.
    (kill-process doctest-async-process)
    ;; Run the sentinel.  (Depending on what OS we're on, the sentinel
    ;; may end up getting called once or twice.)
    (doctest-async-process-sentinel doctest-async-process "killed\n")
    ))

(defun doctest-postprocess-results ()
  "Post-process the doctest results buffer: check what version of
doctest was used, and set doctest-results-py-version accordingly;
turn on read-only mode; filter the example markers; hide the example
source (if `doctest-hide-example-source' is non-nil); and select the
first failure."
  (save-excursion
    (set-buffer doctest-results-buffer)
    ;; Check if we're using an old doctest version.
    (goto-char (point-min))
    (if (re-search-forward doctest-py21-results-re nil t)
        (setq doctest-results-py-version 'py21)
      (setq doctest-results-py-version 'py24))
    ;; Turn on read-only mode.
    (toggle-read-only t))
  
  (doctest-filter-example-markers)
  (if doctest-hide-example-source
      (doctest-hide-example-source))
  (doctest-next-failure 1))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Markers
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-mark-examples ()
  "Add a marker at the beginning of every (likely) example in the
input buffer; and create a list, `doctest-example-markers',
which maps from markers to the line numbers they originally occured
on.  This will allow us to find the corresponding example in the
doctest output, even if the input buffer is edited."
  (dolist (marker-info doctest-example-markers)
    (set-marker (car marker-info) nil))
  (setq doctest-example-markers '())
  (save-excursion
    (goto-char (point-min))
    (while (re-search-forward "^ *>>> " nil t)
      (backward-char 4)
      (push (cons (point-marker) (doctest-line-number))
            doctest-example-markers))))

(defun doctest-filter-example-markers ()
  "Remove any entries from `doctest-example-markers' that do not
correspond to a failed example."
  (let ((filtered nil) (markers doctest-example-markers))
    (save-excursion
      (set-buffer doctest-results-buffer)
      (goto-char (point-max))
      (while (re-search-backward (doctest-results-loc-re) nil t)
        (let ((lineno (string-to-int (match-string 1))))
          (when (equal doctest-results-py-version 'py21)
            (setq lineno (+ lineno 1)))
          (while (and markers (< lineno (cdar markers)))
            (set-marker (caar markers) nil)
            (setq markers (cdr markers)))
          (if (and markers (= lineno (cdar markers)))
              (push (pop markers) filtered)
            (doctest-warn "Example expected on line %d but not found %s"
                          lineno markers)))))
    (dolist (marker-info markers)
      (set-marker (car marker-info) nil))
    (setq doctest-example-markers filtered)))
                       
(defun doctest-prev-example-marker ()
  "Helper for doctest-replace-output: move to the preceeding example
marker, and return the corresponding 'original' lineno.  If none is
found, return nil."
  (let ((lineno nil)
        (pos nil))
    (save-excursion
      (end-of-line)
      (when (re-search-backward "^\\( *\\)>>> " nil t)
        (goto-char (match-end 1))
        (dolist (marker-info doctest-example-markers)
          (when (= (marker-position (car marker-info)) (point))
            (setq lineno (cdr marker-info))
            (setq pos (point))))))
    (unless (null lineno)
      (goto-char pos)
      lineno)))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Navigation
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-next-failure (count)
  "Move to the top of the next failing example, and highlight the
example's failure description in *doctest-output*."
  (interactive "p")
  (cond
   ((and doctest-async (doctest-process-live-p doctest-async-process))
    (message "Wait for doctest to finish running!"))
   ((not (doctest-results-buffer-valid-p))
    (message "Run doctest first! (C-c C-c)"))
   ((equal count 0)
    t)
   (t
    (let ((marker nil) (example-markers doctest-example-markers)
          (results-window (display-buffer doctest-results-buffer)))
      (save-excursion
        (set-buffer doctest-results-buffer)
        ;; Pick up where we left off.
        ;; (nb: doctest-selected-failure is buffer-local)
        (goto-char (or doctest-selected-failure (point-min)))
        ;; Skip past anything on *this* line.
        (if (>= count 0) (end-of-line) (beginning-of-line))
        ;; Look for the next failure
        (when 
            (if (>= count 0)
                (re-search-forward (doctest-results-loc-re) nil t count)
              (re-search-backward (doctest-results-loc-re) nil t (- count)))
          ;; We found a failure:
          (let ((old-selected-failure doctest-selected-failure))
            (beginning-of-line)
            ;; Extract the line number for the doctest file.
            (let ((orig-lineno (string-to-int (match-string 1))))
              (when (equal doctest-results-py-version 'py21)
                (setq orig-lineno (+ orig-lineno 1)))
              (dolist (marker-info example-markers)
                (when (= orig-lineno (cdr marker-info))
                  (setq marker (car marker-info)))))
              
            ;; Update the window cursor.
            (beginning-of-line)
            (set-window-point results-window (point))
            ;; Store our position for next time.
            (setq doctest-selected-failure (point))
            ;; Update selection.
            (doctest-fontify-line old-selected-failure)
            (doctest-fontify-line doctest-selected-failure))))
      
      (cond
       ;; We found a failure -- move point to the selected failure.
       (marker
        (goto-char (marker-position marker))
        (beginning-of-line))
       ;; We didn't find a failure, but there is one -- wrap.
       ((> (length doctest-example-markers) 0)
        (if (>= count 0) (doctest-first-failure) (doctest-last-failure)))
       ;; We didn't find a failure -- alert the user.
       (t (message "No failures found!")))))))

(defun doctest-prev-failure (count)
  "Move to the top of the previous failing example, and highlight
the example's failure description in *doctest-output*."
  (interactive "p")
  (doctest-next-failure (- count)))

(defun doctest-first-failure ()
  "Move to the top of the first failing example, and highlight
the example's failure description in *doctest-output*."
  (interactive)
  (if (buffer-live-p doctest-results-buffer)
      (save-excursion
        (set-buffer doctest-results-buffer)
        (let ((old-selected-failure doctest-selected-failure))
          (setq doctest-selected-failure (point-min))
          (doctest-fontify-line old-selected-failure))))
  (doctest-next-failure 1))

(defun doctest-last-failure ()
  "Move to the top of the last failing example, and highlight
the example's failure description in *doctest-output*."
  (interactive)
  (if (buffer-live-p doctest-results-buffer)
      (save-excursion
        (set-buffer doctest-results-buffer)
        (let ((old-selected-failure doctest-selected-failure))
          (setq doctest-selected-failure (point-max))
          (doctest-fontify-line old-selected-failure))))
  (doctest-next-failure -1))

(defun doctest-select-failure ()
  "Move to the top of the currently selected example, and select that
example in the source buffer.  Intended for use in the results
buffer."
  (interactive)
  (re-search-backward doctest-results-divider-re)
  (let ((old-selected-failure doctest-selected-failure))
    (setq doctest-selected-failure (point))
    (doctest-fontify-line doctest-selected-failure)
    (doctest-fontify-line old-selected-failure))
  (pop-to-buffer doctest-source-buffer)
  (doctest-next-failure 1))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Replace Output
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-replace-output ()
  "Move to the top of the closest example, and replace its output
with the 'got' output from the *doctest-output* buffer.  An error is
displayed if the chosen example is not listed in *doctest-output*, or
if the 'expected' output for the example does not exactly match the
output listed in the source buffer.  The user is asked to confirm the
replacement."
  (interactive)
  ;; Move to the beginning of the example.
  (cond
   ((and doctest-async (doctest-process-live-p doctest-async-process))
    (message "Wait for doctest to finish running!"))
   ((not (doctest-results-buffer-valid-p))
    (message "Run doctest first! (C-c C-c)"))
   ((save-excursion (set-buffer doctest-results-buffer)
                    (equal doctest-results-py-version 'py21))
    (error "doctest-replace-output requires python 2.4+"))
   (t
    (save-excursion
      (let* ((orig-buffer (current-buffer))
             ;; Find an example, and look up its original lineno.
             (lineno (doctest-prev-example-marker))
             ;; Find the example's indentation.
             (prompt-indent (doctest-line-indentation)))
        
        ;; Switch to the output buffer, and look for the example.
        ;; If we don't find one, complain.
        (cond
         ((null lineno) (message "Doctest example not found"))
          (t
           (set-buffer doctest-results-buffer)
           (goto-char (point-min))
           (let ((output-re (format "^File .*, line %s," lineno)))
             (when (not (re-search-forward output-re nil t))
               (message "This doctest example did not fail")
               (setq lineno nil)))))

        ;; If we didn't find an example, give up.
        (when (not (null lineno))
                   
          ;; Get the output's 'expected' & 'got' texts.
          (let ((doctest-got nil) (doctest-expected nil) (header nil))
            (while (setq header (doctest-results-next-header))
              (cond
               ((equal header "Failed example:")
                t)
               ((equal header "Expected nothing")
                (setq doctest-expected ""))
               ((equal header "Expected:")
                (unless (re-search-forward "^\\(\\(    \\).*\n\\)*" nil t)
                  (error "Error parsing doctest output"))
                (setq doctest-expected (doctest-replace-regexp-in-string
                                        "^    " prompt-indent
                                        (match-string 0))))
               ((equal header "Got nothing")
                (setq doctest-got ""))
               ((or (equal header "Got:") (equal header "Exception raised:"))
                (unless (re-search-forward "^\\(\\(    \\).*\n\\)*" nil t)
                  (error "Error parsing doctest output"))
                (setq doctest-got (doctest-replace-regexp-in-string
                                   "^    " prompt-indent (match-string 0))))
               ((string-match "^Differences" header)
                (error (concat "doctest-replace-output can not be used "
                               "with diff style output")))
               (t (error "Unexpected header %s" header))))

            ;; Go back to the source buffer.
            (set-buffer orig-buffer)
          
            ;; Skip ahead to the output.
            (beginning-of-line)
            (unless (re-search-forward "^ *>>>.*")
              (error "Error parsing doctest output"))
            (re-search-forward "\\(\n *\\.\\.\\..*\\)*\n?")
            (if (not (looking-at "^"))
                (insert-string "\n"))

            ;; Check that the output matches.
            (let ((start (point)) end)
              (cond ((re-search-forward "^ *\\(>>>.*\\|$\\)" nil t)
                     (setq end (match-beginning 0)))
                    (t
                     (goto-char (point-max))
                     (insert-string "\n")
                     (setq end (point-max))))
              (when (and doctest-expected
                         (not (equal (buffer-substring start end)
                                     doctest-expected)))
                (error (concat "This example's output has been modified "
                               "since doctest was last run")))
              (setq doctest-expected (buffer-substring start end))
              (goto-char end))

            ;; Trim exceptions
            (when (and doctest-trim-exceptions
                       (string-match doctest-traceback-re
                                     doctest-got))
              (let ((s1 0) (e1 (match-end 1))
                    (s2 (match-beginning 2)) (e2 (match-end 2))
                    (s3 (match-beginning 3)) (e3 (length doctest-got)))
                (setq doctest-got
                    (concat (substring doctest-got s1 e1)
                            (substring doctest-got s2 e2) "  . . .\n"
                            (substring doctest-got s3 e3)))))
              
            ;; Confirm it with the user.
            (let ((confirm-buffer (get-buffer-create "*doctest-confirm*")))
              (set-buffer confirm-buffer)
              ;; Erase anything left over in the buffer.
              (delete-region (point-min) (point-max))
              ;; Write a confirmation message
              (if (equal doctest-expected "")
                  (insert-string "Replace nothing\n")
                (insert-string (concat "Replace:\n" doctest-expected)))
              (if (equal doctest-got "")
                  (insert-string "With nothing\n")
                (insert-string (concat "With:\n" doctest-got)))
              (let ((confirm-window (display-buffer confirm-buffer)))
                ;; Shrink the confirm window.
                (shrink-window-if-larger-than-buffer confirm-window)
                ;; Return to the original buffer.
                (set-buffer orig-buffer)
                ;; Match the old expected region.
                (when doctest-expected
                    (search-backward doctest-expected))
                (when (equal doctest-expected "") (backward-char 1))
                ;; Get confirmation & do the replacement
                (cond ((y-or-n-p "Ok to replace? ")
                       (when (equal doctest-expected "") (forward-char 1))
                       (replace-match doctest-got t t)
                       (message "Replaced."))
                      (t
                       (message "Replace cancelled.")))
                ;; Clean up our confirm window
                (kill-buffer confirm-buffer)
                (delete-window confirm-window))))))))))

(defun doctest-results-next-header ()
  "Move to the next header in the doctest results buffer, and return
the string contents of that header.  If no header is found, return
nil."
  (if (re-search-forward (concat doctest-results-header-re "\\|"
                                 doctest-results-divider-re) nil t)
      (let ((result (match-string 0)))
        (if (string-match doctest-results-header-re result)
            result
          nil))
    nil))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Helper functions
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun doctest-on-source-line-p (&optional prompt)
  "Return true if the current line is a source line.  The optional
argument prompt can be used to specify which type of source
line (... or >>>)."
  (save-excursion
    (beginning-of-line)
    ;; Check if we're looking at a prompt (of the right type).
    (when (and (looking-at doctest-prompt-re)
               (or (null prompt)
                   (equal prompt (substring (match-string 2) 0 3))))
      ;; Scan backwards to make sure there's a >>> somewhere.  Otherwise,
      ;; this might be a '...' in the text or in an example's output.
      (while (looking-at "^[ \t]*[.][.][.]")
        (forward-line -1))
      (looking-at "^[ \t]*>>>"))))

(defun doctest-on-empty-source-line-p ()
  "Return true if the current line contains a bare prompt."
  (save-excursion
    (beginning-of-line)
    (and (doctest-on-source-line-p)
         (looking-at (concat doctest-prompt-re "$")))))

(defun doctest-on-output-line-p ()
  "Return true if the current line is an output line."
  (save-excursion
    (beginning-of-line)
    ;; The line must not be blank or a source line.
    (when (not (or (doctest-on-source-line-p) (looking-at "[ \t]*$")))
      ;; The line must follow a source line, with no intervening blank
      ;; lines.
      (while (not (or (doctest-on-source-line-p) (looking-at "[ \t]*$")
                      (= (point) (point-min))))
        (forward-line -1))
      (doctest-on-source-line-p))))

(defun doctest-find-output-line (&optional limit)
  "Move forward to the next doctest output line (staying within
the given bounds).  Return the character position of the doctest
output line if one was found, and false otherwise."
  (let ((found-it nil) ; point where we found an output line
	(limit (or limit (point-max)))) ; default value for limit
    (save-excursion
      ;; Keep moving forward, one line at a time, until we find a
      ;; doctest output line.
      (while (and (not found-it) (< (point) limit) (not (eobp)))
	(if (and (not (eolp)) (doctest-on-output-line-p))
	    (setq found-it (point))
	  (forward-line))))
    ;; If we found a doctest output line, then go to it.
    (if found-it (goto-char found-it))))

(defun doctest-line-indentation ()
  "Helper for doctest-replace-output: return the whitespace indentation
at the beginning of this line."
  (save-excursion
    (end-of-line)
    (re-search-backward "^\\( *\\)" nil t)
    (match-string 1)))

(defun doctest-optionflags (&optional diff)
  "Return a string describing the optionflags that should be used
by doctest.  If DIFF is non-nil, then add the REPORT_UDIFF flag."
  (let ((flags "0"))
    (dolist (flag doctest-optionflags)
      (setq flags (concat flags "|" flag)))
    (if diff (concat flags "|" "REPORT_UDIFF") flags)))
  
(defun doctest-results-loc-re ()
  "Return the regexp that should be used to look for doctest example
location markers in doctest's output (based on which version of
doctest was used"
  (cond
   ((equal doctest-results-py-version 'py21)
    doctest-py21-results-loc-re)
   ((equal doctest-results-py-version 'py24)
    doctest-py24-results-loc-re)
   (t (error "bad value for doctest-results-py-version"))))

(defun doctest-results-buffer-name ()
  "Return the buffer name that should be used for the doctest results
buffer.  This is computed from the variable
`doctest-results-buffer-name'."
  (doctest-replace-regexp-in-string
   "%[nfN]"
   (lambda (sym)
     (cond ((equal sym "%n") (buffer-name))
           ((equal sym "%N") (doctest-replace-regexp-in-string
                              "[.]doctest$" "" (buffer-name) t))
           ((equal sym "%f") (buffer-file-name))))
   doctest-results-buffer-name t))

(defun doctest-hide-example-source ()
  "Delete the source code listings from the results buffer (since it's
easy enough to see them in the original buffer)"
  (save-excursion
    (set-buffer doctest-results-buffer)
    (toggle-read-only 0)
    (goto-char (point-min))
    (while (re-search-forward doctest-example-source-re nil t)
      (replace-match "" nil nil))
    (toggle-read-only t)))

(defun doctest-results-buffer-valid-p ()
  "Return true if this buffer has a live results buffer; and that
results buffer reports this buffer as its source buffer.  (Two
buffers in doctest-mode might point to the same results buffer;
but only one of them will be equal to that results buffer's
source buffer."
  (let ((cur-buf (current-buffer)))
    (and (buffer-live-p doctest-results-buffer)
         (save-excursion
           (set-buffer doctest-results-buffer)
           (equal cur-buf doctest-source-buffer)))))

(defun doctest-update-mode-line (value)
  "Update the doctest mode line with the given string value.  This
is used to display information about asynchronous processes that
are run by doctest-mode."
  (setq doctest-mode-line-process
        value)
  (force-mode-line-update t))

(defun doctest-version ()
  "Echo the current version of `doctest-mode' in the minibuffer."
  (interactive)
  (message "Using `doctest-mode' version %s" doctest-version))

(defun doctest-warn (msg &rest args)
  "Display a doctest warning message."
  (if (fboundp 'display-warning)
      (display-warning 'doctest (apply 'format msg args))
    (apply 'message msg args)))

(defun doctest-debug (msg &rest args)
  "Display a doctest debug message."
  (if (fboundp 'display-warning)
      (display-warning 'doctest (apply 'format msg args) 'debug)
    (apply 'message msg args)))

(defvar doctest-serial-number 0) ;used if broken-temp-names.
(defun doctest-temp-name ()
  "Return a new temporary filename, for use in calling doctest."
  (if (memq 'broken-temp-names features)
      (let
	  ((sn doctest-serial-number)
	   (pid (and (fboundp 'emacs-pid) (emacs-pid))))
	(setq doctest-serial-number (1+ doctest-serial-number))
	(if pid
	    (format "doctest-%d-%d" sn pid)
	  (format "doctest-%d" sn)))
    (make-temp-name "doctest-")))

(defun doctest-fontify-line (charpos)
  "Run font-lock-fontify-region on the line containing the given
position."
  (if (and charpos (functionp 'font-lock-fontify-region))
      (save-excursion
        (goto-char charpos)
        (let ((beg (progn (beginning-of-line) (point)))
              (end (progn (end-of-line) (point))))
          (font-lock-fontify-region beg end)))))

(defun doctest-do-auto-fill ()
  "If the current line is a soucre line or an output line, do nothing.
Otherwise, call (do-auto-fill)."
  (cond
   ;; Don't wrap source lines.
   ((doctest-on-source-line-p) nil)
   ;; Don't wrap output lines
   ((doctest-on-output-line-p) nil)
   ;; Wrap all other lines
   (t (do-auto-fill))))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Emacs Compatibility Functions
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Define compatible versions of functions that are defined
;; for some versions of emacs but not others.

;; Backwards compatibility: looking-back
(cond ((fboundp 'looking-back) ;; Emacs 22.x
       (defalias 'doctest-looking-back 'looking-back))
      (t
       (defun doctest-looking-back (regexp)
         "Return true if text before point matches REGEXP."
         (save-excursion
           (let ((orig-pos (point)))
             ;; Search backwards for the regexp.
             (if (re-search-backward regexp nil t)
                 ;; Check if it ends at the original point.
                 (= orig-pos (match-end 0))))))))

;; Backwards compatibility: replace-regexp-in-string
(cond ((fboundp 'replace-regexp-in-string)
       (defalias 'doctest-replace-regexp-in-string 'replace-regexp-in-string))
      (t ;; XEmacs 21.x or Emacs 20.x
       (defun doctest-replace-regexp-in-string
         (regexp rep string &optional fixedcase literal)
         "Replace all matches for REGEXP with REP in STRING."
         (let ((start 0))
           (while (and (< start (length string))
                       (string-match regexp string start))
             (setq start (+ (match-end 0) 1))
             (let ((newtext (if (functionp rep)
                                (save-match-data
                                  (funcall rep (match-string 0 string)))
                              rep)))
               (setq string (replace-match newtext fixedcase
                                           literal string)))))
         string)))

;; Backwards compatibility: line-number
(cond ((fboundp 'line-number) ;; XEmacs
       (defalias 'doctest-line-number 'line-number))
      ((fboundp 'line-number-at-pos) ;; Emacs 22.x
       (defalias 'doctest-line-number 'line-number-at-pos))
      (t ;; Emacs 21.x
       (defun doctest-line-number (&optional pos)
         "Return the line number of POS (default=point)."
         (1+ (count-lines 1
               (save-excursion (progn (beginning-of-line)
                                      (or pos (point)))))))))

;; Backwards compatibility: process-live-p
(cond ((fboundp 'process-live-p) ;; XEmacs
       (defalias 'doctest-process-live-p 'process-live-p))
      (t ;; Emacs
       (defun doctest-process-live-p (process)
         (and (processp process)
              (equal (process-status process) 'run)))))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Doctest Results Mode (output of doctest-execute-buffer)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; Register the font-lock keywords (xemacs)
(put 'doctest-results-mode 'font-lock-defaults 
     '(doctest-results-font-lock-keywords))

;; Register the font-lock keywords (older versions of gnu emacs)
(when (boundp 'font-lock-defaults-alist)
  (add-to-list 'font-lock-defaults-alist
               '(doctest-results-mode doctest-results-font-lock-keywords 
                                      nil nil nil nil)))

(defvar doctest-selected-failure nil
  "The location of the currently selected failure.
This variable is uffer-local to doctest-results-mode buffers.")

(defvar doctest-source-buffer nil
  "The buffer that spawned this one.
This variable is uffer-local to doctest-results-mode buffers.")

(defvar doctest-results-py-version nil
  "A symbol indicating which version of Python was used to generate
the results in a doctest-results-mode buffer.  Can be either the
symbol `py21' or the symbol `py24'.
This variable is uffer-local to doctest-results-mode buffers.")

;; Keymap for doctest-results-mode.
(defconst doctest-results-mode-map 
  (let ((map (make-keymap)))
    (define-key map [return] 'doctest-select-failure)
    map) 
  "Keymap for doctest-results-mode.")

;; Syntax table for doctest-results-mode.
(defvar doctest-results-mode-syntax-table nil
  "Syntax table used in `doctest-results-mode' buffers.")
(when (not doctest-results-mode-syntax-table)
  (setq doctest-results-mode-syntax-table (make-syntax-table))
  (dolist (entry '(("(" . "()") ("[" . "(]") ("{" . "(}")
                   (")" . ")(") ("]" . ")[") ("}" . "){")
                   ("$%&*+-/<=>|'\"`" . ".") ("_" . "w")))
    (dolist (char (string-to-list (car entry)))
      (modify-syntax-entry char (cdr entry)
                           doctest-results-mode-syntax-table))))

;; Define the mode
(defun doctest-results-mode ()
  "A major mode used to display the results of running doctest.
See `doctest-mode'.

\\{doctest-results-mode-map}"
  (interactive)
  
  ;; Declare local variables.
  (kill-all-local-variables)
  (make-local-variable 'font-lock-defaults)
  (make-local-variable 'doctest-selected-failure)
  (make-local-variable 'doctest-source-buffer)
  (make-local-variable 'doctest-results-py-version)
  
  ;; Define local variables.
  (setq major-mode              'doctest-results-mode
	mode-name               "Doctest-Results"
        mode-line-process       'doctest-mode-line-process
        font-lock-defaults      '(doctest-results-font-lock-keywords
                                  nil nil nil nil))
  ;; Define keymap.
  (use-local-map doctest-results-mode-map)
  
  ;; Define the syntax table.
  (set-syntax-table doctest-results-mode-syntax-table)
  
  ;; Enable font-lock mode.
  (if (featurep 'font-lock) (font-lock-mode 1)))

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Doctest Mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; Register the font-lock keywords (xemacs)
(put 'doctest-mode 'font-lock-defaults '(doctest-font-lock-keywords
                                         nil nil nil nil))

;; Register the font-lock keywords (older versions of gnu emacs)
(when (boundp 'font-lock-defaults-alist)
  (add-to-list 'font-lock-defaults-alist
               '(doctest-mode doctest-font-lock-keywords
                              nil nil nil nil)))
  
(defvar doctest-results-buffer nil
  "The output buffer for doctest-mode.
This variable is buffer-local to doctest-mode buffers.")

(defvar doctest-example-markers nil
  "A list mapping markers to the line numbers at which they appeared
in the buffer at the time doctest was last run.  This is used to find
'original' line numbers, which can be used to search the doctest
output buffer.  It's encoded as a list of (MARKER . POS) tuples, in
reverse POS order.
This variable is buffer-local to doctest-mode buffers.")

;; These are global, since we only one run process at a time:
(defvar doctest-async-process nil
  "The process object created by the asynchronous doctest process")
(defvar doctest-async-process-tempfile nil
  "The name of the tempfile created by the asynchronous doctest process")
(defvar doctest-async-process-buffer nil
  "The source buffer for the asynchronous doctest process")
(defvar doctest-mode-line-process ""
  "A string displayed on the modeline, to indicate when doctest is
running asynchronously.")

;; Keymap for doctest-mode.  n.b.: we intentionally define [tab]
;; rather than overriding indent-line-function, since we don't want
;; doctest-indent-source-line to be called by do-auto-fill.
(defconst doctest-mode-map 
  (let ((map (make-keymap)))
    (define-key map [backspace] 'doctest-electric-backspace)
    (define-key map [return] 'doctest-newline-and-indent)
    (define-key map [tab] 'doctest-indent-source-line)
    (define-key map ":" 'doctest-electric-colon)
    (define-key map "\C-c\C-v" 'doctest-version)
    (define-key map "\C-c\C-c" 'doctest-execute-buffer)
    (define-key map "\C-c\C-d" 'doctest-execute-buffer-with-diff)
    (define-key map "\C-c\C-n" 'doctest-next-failure)
    (define-key map "\C-c\C-p" 'doctest-prev-failure)
    (define-key map "\C-c\C-a" 'doctest-first-failure)
    (define-key map "\C-c\C-e" 'doctest-last-failure)
    (define-key map "\C-c\C-z" 'doctest-last-failure)
    (define-key map "\C-c\C-r" 'doctest-replace-output)
    (define-key map "\C-c|" 'doctest-execute-region)
    map) 
  "Keymap for doctest-mode.")

;; Syntax table for doctest-mode.
(defvar doctest-mode-syntax-table nil
  "Syntax table used in `doctest-mode' buffers.")
(when (not doctest-mode-syntax-table)
  (setq doctest-mode-syntax-table (make-syntax-table))
  (dolist (entry '(("(" . "()") ("[" . "(]") ("{" . "(}")
                   (")" . ")(") ("]" . ")[") ("}" . "){")
                   ("$%&*+-/<=>|'\"`" . ".") ("_" . "w")))
    (dolist (char (string-to-list (car entry)))
      (modify-syntax-entry char (cdr entry) doctest-mode-syntax-table))))

;; Use doctest mode for files ending in .doctest
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.doctest$" . doctest-mode))

;;;###autoload
(defun doctest-mode ()
  "A major mode for editing text files that contain Python
doctest examples.  Doctest is a testing framework for Python that
emulates an interactive session, and checks the result of each
command.  For more information, see the Python library reference:
<http://docs.python.org/lib/module-doctest.html>

`doctest-mode' defines three kinds of line, each of which is
treated differently:

  - 'Source lines' are lines consisting of a Python prompt
    ('>>>' or '...'), followed by source code.  Source lines are
    colored (similarly to `python-mode') and auto-indented.

  - 'Output lines' are non-blank lines immediately following
    source lines.  They are colored using several doctest-
    specific output faces.

  - 'Text lines' are any other lines.  They are not processed in
    any special way.

\\{doctest-mode-map}"
  (interactive)
  
  ;; Declare local variables.
  (kill-all-local-variables)
  (make-local-variable 'font-lock-defaults)
  (make-local-variable 'doctest-results-buffer)
  (make-local-variable 'doctest-example-markers)
  
  ;; Define local variables.
  (setq major-mode              'python-mode
        mode-name               "Doctest"
        mode-line-process       'doctest-mode-line-process
        font-lock-defaults      '(doctest-font-lock-keywords
                                  nil nil nil nil))
  
  ;; Define keymap.
  (use-local-map doctest-mode-map)

  ;; Define the syntax table.
  (set-syntax-table doctest-mode-syntax-table)
  
  ;; Enable auto-fill mode.
  (auto-fill-mode 1)
  (setq auto-fill-function 'doctest-do-auto-fill)

  ;; Enable font-lock mode.
  (if (featurep 'font-lock) (font-lock-mode 1))

  ;; Run the mode hook.
  (run-hooks 'doctest-mode-hook))

(provide 'doctest-mode)
;;; doctest-mode.el ends here