-
Notifications
You must be signed in to change notification settings - Fork 14
/
pandoc-mode-utils.el
1334 lines (1195 loc) · 66.7 KB
/
pandoc-mode-utils.el
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
;;; pandoc-mode-utils.el --- Part of `pandoc-mode' -*- lexical-binding: t -*-
;; Copyright (c) 2009-2022 Joost Kremers
;; Author: Joost Kremers <[email protected]>
;; Maintainer: Joost Kremers <[email protected]>
;; Created: 31 Oct 2009
;; Version: 2.33
;; Keywords: text, pandoc
;; Package-Requires: ((hydra "0.10.0") (dash "2.10.0"))
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions
;; are met:
;;
;; 1. Redistributions of source code must retain the above copyright
;; notice, this list of conditions and the following disclaimer.
;; 2. Redistributions in binary form must reproduce the above copyright
;; notice, this list of conditions and the following disclaimer in the
;; documentation and/or other materials provided with the distribution.
;; 3. The name of the author may not be used to endorse or promote products
;; derived from this software without specific prior written permission.
;;
;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
;; IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
;; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
;; IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
;; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
;; NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES ; LOSS OF USE,
;; DATA, OR PROFITS ; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
;; THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
;;; Commentary:
;; This file is part of `pandoc-mode'.
;;
;; Pandoc-mode is a minor mode for interacting with Pandoc, a 'universal
;; document converter': <http://johnmacfarlane.net/pandoc/>.
;;
;; See the pandoc-mode manual for usage and installation instructions.
;;; Code:
(require 'dash)
(require 'cl-lib)
(defgroup pandoc nil
"Minor mode for interacting with pandoc."
:group 'text)
(defcustom pandoc-binary "pandoc"
"The name of the pandoc binary.
You can specify a full path here or a relative path (the
default). In the latter case, the value of `exec-path` is used
to search the binary."
:group 'pandoc
:type 'file)
(defcustom pandoc-use-async t
"If non-NIL, use an asynchronous process to run pandoc.
Using an asynchronous subprocess avoids freezing Emacs, but can
cause problems sometimes. Setting this option to nil runs pandoc
in a synchronous subprocess."
:group 'pandoc
:type 'boolean)
(defcustom pandoc-process-connection-type (default-value process-connection-type)
"Control type of device used to communicate with the pandoc subprocess.
This option only takes effect if `pandoc-use-async' is set to t.
The variable `process-connection-type' is set to the value of
this option before calling pandoc. See the doc string of that
variable for details."
:group 'pandoc
:type '(choice (const :tag "Use a pty" t)
(const :tag "Use a pipe" nil)))
(defcustom pandoc-async-success-hook nil
"List of functions to call when `pandoc' returns successfully.
This hook is only run when `pandoc-use-async' is set to t."
:group 'pandoc
:type 'hook)
(defcustom pandoc-data-dir "~/.emacs.d/pandoc-mode/"
"Default `pandoc-mode' data dir.
This is where `pandoc-mode' looks for global settings files."
:group 'pandoc
:type 'directory)
(defcustom pandoc-directives '(("include" . pandoc--process-include-directive)
("lisp" . pandoc--process-lisp-directive))
"List of directives to be processed before pandoc is called.
The directive must be given without `@@'; the function should
return a string that will replace the directive and its
argument (if any).
The directives are processed in the order in which they appear in
this list. If a directive produces output that contains another
directive, the new directive will only be processed if it is of
the same type (i.e., an @@include directive loading a text that
also contains @@include directives) or if it is lower on the
list, not if it appears higher on the list."
:group 'pandoc
:type '(alist :key-type (string :tag "Directive") :value-type function))
(defcustom pandoc-directives-hook nil
"List of functions to call before the directives are processed."
:group 'pandoc
:type '(repeat function))
(defcustom pandoc-extension-active-marker "X"
"Marker used to indicate an active extension."
:group 'pandoc
:type 'string)
(defcustom pandoc-extension-inactive-marker " "
"Marker used to indicate an inactive extension."
:group 'pandoc
:type 'string)
(defcustom pandoc-citation-jump-function 'pandoc-goto-citation-reference
"Action to take when locating a BibTeX reference from a citation key.
Three actions have been predefined: Open the BibTeX file in Emacs
and jump to the location of the key (the default option), open
the BibTeX file in Ebib and show the key, or show the key's entry
in a *Help* buffer.
It is also possible to use a custom function. This function must
take two arguments:
1) The string that matches the citation KEY at point
2) A list of BIBLIOGRAPHY files
It should direct the user to a bibliographic reference that
matches KEY."
:group 'pandoc
:type '(choice (const :tag "Open BibTeX file" pandoc-goto-citation-reference)
(const :tag "Open Ebib" pandoc-open-in-ebib)
(const :tag "Show entry in *Help* buffer" pandoc-show-citation-as-help)
(function :tag "Use a custom function")))
(defcustom pandoc-major-modes
'((gfm-mode . "gfm")
(haskell-mode . "native")
(html-mode . "html")
(json-mode . "json")
(latex-mode . "latex")
(markdown-mode . "markdown")
(mediawiki-mode . "mediawiki")
(muse-mode . "muse")
(org-mode . "org")
(rst-mode . "rst")
(text-mode . "plain")
(textile-mode . "textile"))
"List of major modes and their default pandoc input formats."
:group 'pandoc
:type '(repeat (cons (symbol :tag "Major mode") (string :tag "Input format"))))
;; The formats known to Pandoc are defined in `pandoc--formats'. They are divided
;; into different categories. From this list, the input and output format menus
;; are created, which both consist of a main menu listing the categories and
;; submenus for each category.
;;
;; Note: the keys "b" and "q" cannot be used, because they are used in the
;; hydras for returning to the higher level menu and for quiting, respectively.
(defvar pandoc--formats
'(("markdown" "Markdown Formats" "m"
("markdown" "Pandoc Markdown" "m" both)
("markdown_mmd" "Markdown (MMD)" "M" both)
("markdown_phpextra" "Markdown (PHPExtra)" "P" both)
("markdown_strict" "Markdown (Strict)" "S" both)
("commonmark" "CommonMark" "C" both)
("gfm" "GitHub-flavoured Markdown" "g" both)
("markdown_github" "Markdown (Github; obsolete)" "G" both))
("html" "HTML Formats" "h"
("html" "HTML (default)" "h" both)
("html4" "HTML4" "t" output)
("html5" "HTML5" "H" output))
("slide-show" "Slide Show Formats" "s"
("beamer" "Beamer" "B" output) ; Also under TeX
("dzslides" "DZSlides" "d" output)
("revealjs" "RevealJS" "j" output)
("pptx" "MS PowerPoint" "p" output)
("s5" "S5 HTML/JS" "s" output)
("slideous" "Slideous" "u" output)
("slidy" "Slidy" "y" output))
("wiki" "Wiki Formats" "w"
("creole" "Creole 1.0" "c" both)
("dokuwiki" "DokuWiki" "d" both)
("jira" "JiraWiki" "j" both)
("mediawiki" "MediaWiki" "m" both)
("tikiwiki" "TikiWiki" "t" both)
("twiki" "Twiki" "T" input)
("vimwiki" "Vimwiki" "v" both)
("xwiki" "Xwiki" "x" output)
("zimwiki" "ZimWiki" "z" both))
("wordprocessor" "Wordprocessor Formats" "W"
("docx" "MS Word (docx)" "d" both)
("icml" "InDesign ICML" "i" output)
("odt" "LibreOffice Text Document" "l" both)
("opendocument" "OpenDocument XML" "o" output)
("rtf" "Rich Text Format" "r" output))
("tex" "TeX-based Formats" "t"
("beamer" "Beamer Slide Show" "B" output) ; Also under Slide Shows Formats.
("context" "ConTeXt" "c" output)
("latex" "LaTeX" "l" both)
("texinfo" "TeXinfo" "i" output)) ; Also under Documentation Formats.
("ebook" "E-Book Formats" "e"
("epub" "EPUB (default)" "e" both)
("epub2" "EPUB2 E-Book" "p" output)
("epub3" "EPUB3 E-Book" "E" output)
("fb2" "FictionBook2" "f" both))
("text" "Text-Based Formats" "T"
("asciidoc" "AsciiDoc" "a" output)
("csv" "CSV" "c" input)
("plain" "Plain Text" "p" output)
("rst" "reStructuredText" "r" both)
("textile" "Textile" "t" both)
("t2t" "txt2tags" "T" both))
("documentation" "Documentation Formats" "d"
("docbook" "DocBook XML" "d" input) ; docbook and docbook4 share the same key.
("docbook4" "DocBook XML v.4" "d" output) ; They won't appear in the same menu anyway.
("docbook5" "DocBook XML v.5" "D" output)
("haddock" "Haddock" "h" both)
("man" "Man Page" "m" output)
("ms" "Groff MS" "g" output)
("tei" "TEI" "t" output)
("texinfo" "TeXinfo" "i" output)) ; Also under TeX Formats.
("emacs" "Emacs-based Formats" "E"
("muse" "Muse" "m" both)
("org" "Org-mode" "o" both))
("jats" "JATS formats" "j"
("jats" "Archiving Tag Set" "j" both)
("jats_articleauthoring" "Article Authoring Tag Set" "a" both)
("jats_publishing" "Publishing Tag Set" "p" both)
("jats_archiving" "Archiving Tag Set" "x" both))
("misc" "Miscellaneous Formats" "v"
("ipynb" "Jupyter Notebook" "p" both)
("json" "JSON" "j" both)
("native" "Native Haskell" "n" both)
("opml" "OPML" "o" both)))
"List of Pandoc formats, their descriptions and hydra shortcut keys.")
(defun pandoc--extract-formats (io)
"Extract the input or output formats in `pandoc--formats'.
IO is a symbol, either `input' or `output'. Return a list of formats."
(-flatten-n 1 (-map (-lambda ((_name _descr _key . formats))
(--filter (memq (-last-item it) `(,io both)) formats))
pandoc--formats)))
(defvar pandoc--input-formats-menu
(mapcar (lambda (f)
(cons (cadr f) (car f)))
(pandoc--extract-formats 'input))
"List of items in pandoc-mode's input format menu.")
(defcustom pandoc-output-format-extensions
'(("asciidoc" ".txt")
("beamer" ".tex")
("commonmark" ".md")
("context" ".tex")
("docbook" ".xml")
("docbook4" ".xml")
("docbook5" ".xml")
("docx" ".docx")
("dokuwiki" ".txt")
("dzslides" ".html")
("epub" ".epub")
("epub2" ".epub")
("epub3" ".epub")
("fb2" ".fb2")
("gfm" ".md")
("haddock" ".hs")
("html" ".html")
("html4" ".html")
("html5" ".html")
("icml" ".icml")
("ipynb" ".ipynb")
("jats" ".xml")
("json" ".json")
("latex" ".tex")
("man" "")
("markdown" ".md")
("markdown_github" ".md")
("markdown_mmd" ".md")
("markdown_phpextra" ".md")
("markdown_strict" ".md")
("mediawiki" ".mw")
("ms" ".ms")
("muse" ".muse")
("native" ".hs")
("odt" ".odt")
("opendocument" ".odf")
("opml" ".opml")
("org" ".org")
("plain" ".txt")
("pptx" ".pptx")
("revealjs" ".html")
("rst" ".rst")
("rtf" ".rtf")
("s5" ".html")
("slideous" ".html")
("slidy" ".html")
("tei" ".xml")
("texinfo" ".texi")
("textile" ".textile")
("zimwiki" ".txt"))
"List of Pandoc output formats and their associated file extensions.
These extensions are used when pandoc-mode creates an output
file. The file extension should include a dot. Note that it does
not make sense to change the names of the output formats, since
Pandoc only recognizes the ones listed here. However, it is
possible to customize the extensions."
:group 'pandoc
:type '(repeat :tag "Output Format" (list (string :tag "Format") (string :tag "Extension"))))
(defcustom pandoc-viewers
'(("asciidoc" emacs)
("beamer" emacs)
("commonmark" emacs)
("context" emacs)
("docbook" nil)
("docbook4" nil)
("docbook5" nil)
("docx" "libreoffice")
("dokuwiki" emacs)
("dzslides" browe-url)
("epub" nil)
("epub2" nil)
("epub3" nil)
("fb2" nil)
("gfm" emacs)
("haddock" emacs)
("html" browse-url)
("html4" browse-url)
("html5" browse-url)
("icml" nil)
("ipynb" nil)
("jats" nil)
("json" emacs)
("latex" emacs)
("man" emacs)
("markdown" emacs)
("markdown_github" emacs)
("markdown_mmd" emacs)
("markdown_phpextra" emacs)
("markdown_strict" emacs)
("mediawiki" emacs)
("ms" emacs)
("muse" emacs)
("native" emacs)
("odt" "libreoffice")
("opendocument" "libreoffice")
("opml" nil)
("org" emacs)
("plain" emacs)
("pptx" "libreoffice")
("revealjs" browse-url)
("rst" emacs)
("rtf" "libreoffice")
("s5" browse-url)
("slideous" browse-url)
("slidy" browse-url)
("tei" nil)
("texinfo" emacs)
("textile" emacs)
("zimwiki" emacs))
"List of Pandoc output formats and their associated file viewers.
This option defines the viewers used in `pandoc-view-output'.
The viewer can be a string, in which case it is assumed to be a
shell command, which is executed through `start-process'. The
viewer can also be an Emacs function, which is passed the full
file name of the output file. Lastly, the viewer can be the
symbol `emacs', in which case the output file is opened in Emacs
with `find-file-noselect' and displayed with `display-buffer'."
:group 'pandoc
:type '(repeat :tag "File viewers" (list (string :tag "Format") (choice (const :tag "No viewer defined" nil)
(string :tag "Use External viewer")
(const :tag "Use Emacs" emacs)
(function :tag "Use a specific function")))))
(defcustom pandoc-pdf-viewer 'emacs
"Viewer for pdf files.
This can be the symbol `emacs', in which case the pdf file is
opened with `find-file-noselect' and displayed with
`display-buffer'. The value can also be a string, in which case
it is assumed to be an external viewer, which is called with
`start-process'."
:group 'pandoc
:type '(choice (const :tag "Use Emacs" emacs)
(string :tag "Use external viewer")))
(defvar pandoc--pdf-able-formats '("latex" "context" "beamer" "html" "ms")
"List of output formats that can be used to generate pdf output.")
(defvar pandoc--extensions
'(("abbreviations" ("markdown_phpextra"))
("all_symbols_escapable" ("markdown" "markdown_mmd"))
("amuse" ())
("angle_brackets_escapable" ("markdown_github"))
("ascii_identifiers" ("markdown_github"))
("auto_identifiers" ("markdown" "markdown_github" "markdown_mmd" "latex" "rst" "mediawiki" "textile"))
("autolink_bare_uris" ("markdown_github"))
("backtick_code_blocks" ("markdown" "markdown_github"))
("blank_before_blockquote" ("markdown"))
("blank_before_header" ("markdown"))
("bracketed_spans" ("markdown"))
("citations" ("markdown"))
("compact_definition_lists" ())
("definition_lists" ("markdown" "markdown_phpextra" "markdown_mmd"))
("east_asian_line_breaks" ())
("emoji" ("markdown_github"))
("empty_paragraphs" ())
("epub_html_exts" ())
("escaped_line_breaks" ("markdown"))
("example_lists" ("markdown"))
("fancy_lists" ("markdown"))
("fenced_code_attributes" ("markdown" "markdown_github"))
("fenced_code_blocks" ("markdown" "markdown_phpextra" "markdown_github"))
("fenced_divs" ("markdown"))
("footnotes" ("markdown" "markdown_phpextra" "markdown_mmd"))
("four_space_rule" ())
("gfm_auto_identifiers" ())
("grid_tables" ("markdown"))
("hard_line_breaks" ("markdown_github"))
("header_attributes" ("markdown" "markdown_phpextra"))
("ignore_line_breaks" ())
("implicit_figures" ("markdown"))
("implicit_header_references" ("markdown" "markdown_mmd"))
("inline_code_attributes" ("markdown"))
("inline_notes" ("markdown"))
("intraword_underscores" ("markdown" "markdown_phpextra" "markdown_github" "markdown_mmd"))
("latex_macros" ("markdown"))
("line_blocks" ("markdown"))
("link_attributes" ("markdown" "markdown_phpextra")) ; TODO check
("lists_without_preceding_blankline" ("markdown_github"))
("literate_haskell" ())
("markdown_attribute" ("markdown_phpextra" "markdown_mmd"))
("markdown_in_html_blocks" ("markdown"))
("mmd_header_identifiers" ("markdown_mmd"))
("mmd_link_attributes" ("markdown_mmd"))
("mmd_title_block" ("markdown_mmd"))
("multiline_tables" ("markdown"))
("native_divs" ("markdown"))
("native_spans" ("markdown"))
("ntb" ())
("old_dashes" ())
("pandoc_title_block" ("markdown"))
("pipe_tables" ("markdown" "markdown_phpextra" "markdown_github" "markdown_mmd"))
("raw_attribute" ("markdown"))
("raw_html" ("markdown" "markdown_phpextra" "markdown_github" "markdown_mmd" "markdown_strict"))
("raw_tex" ("markdown" "markdown_mmd"))
("shortcut_reference_links" ("markdown" "markdown_strict" "markdown_github" "markdown_phpextra" "markdown_mmd"))
("simple_tables" ("markdown"))
("smart" ("markdown"))
("space_in_atx_header" ("markdown"))
("spaced_reference_links" ())
("startnum" ("markdown"))
("strikeout" ("markdown" "markdown_github"))
("subscript" ("markdown"))
("superscript" ("markdown"))
("styles" ())
("table_captions" ("markdown"))
("task_lists" ("markdown" "gfm" "org"))
("tex_math_dollars" ("markdown" "markdown_mmd" "html"))
("tex_math_double_backslash" ("markdown_mmd" "html"))
("tex_math_single_backslash" ("markdown_github" "html"))
("yaml_metadata_block" ("markdown")))
"List of Markdown extensions supported by Pandoc.")
(defvar pandoc--cli-options '(defaults)
"List of Pandoc command line options that do not need special treatment.
This includes all command line options except the list and alist
options, because they need to be handled separately in
`pandoc--format-all-options'.")
(defvar pandoc--filepath-options
'(data-dir
extract-media)
"List of options that have a file path as value.
These file paths are expanded before they are sent to Pandoc.
For relative paths, the file's working directory is used as base
directory. Two options are preset, others are added by
`define-pandoc-file-option'.")
(defvar pandoc--switches '(("Use File Scope" . file-scope))
"List of binary options.
These are set by `define-pandoc-switch'.")
(defvar pandoc--list-options nil
"List of options that have a list as value.
These are set by `define-pandoc-list-option'.")
(defvar pandoc--alist-options nil
"List of options that have an alist as value.
These are set by `define-pandoc-alist-option'.")
(defvar pandoc--options
`((read)
(read-lhs)
(read-extensions ,@(mapcar 'list (sort (mapcar #'car pandoc--extensions) #'string<)))
(write . "native")
(write-lhs)
(write-extensions ,@(mapcar 'list (sort (mapcar #'car pandoc--extensions) #'string<)))
(output)
(data-dir)
(defaults)
(extract-media)
(file-scope)
(output-dir)
(master-file)) ; the last two are not actually pandoc options
"Pandoc option alist.
List of options and their default values. For each buffer in
which pandoc-mode is activated, a buffer-local copy of this list
is made that stores the local values of the options. The
`define-pandoc-*-option' functions add their options to this list
with the default value nil.")
(defvar-local pandoc--local-settings nil "A buffer-local variable holding a file's pandoc options.")
(defvar-local pandoc--settings-modified-flag nil "Non-nil means the current settings were modified and not saved.")
(defvar-local pandoc--latest-run nil
"The output format and the output file created in the most recent call to Pandoc.")
(defvar pandoc--output-buffer-name " *Pandoc output*")
(defvar pandoc--log-buffer-name " *Pandoc log*")
(defvar pandoc--viewer-buffer-name " *Pandoc viewer*")
(defvar pandoc--options-menu nil
"Auxiliary variable for creating the options menu.")
(defvar pandoc--files-menu nil
"Auxiliary variable for creating the file menu.")
(defun pandoc--read-file-name (prompt dir relative)
"Read a file name using PROMPT.
DIR is the directory used for completing file names. If RELATIVE
is non-nil, return the file path as a relative path starting from
DIR, otherwise return the full path."
;; we inhibit inserting the default directory, though not all completion
;; systems honor this.
(let* ((insert-default-directory (not relative))
(file (read-file-name prompt dir)))
(if relative
(file-relative-name file dir)
file)))
(defun pandoc--expand-absolute-path (filename)
"Expand FILENAME if it is an absolute path.
If FILENAME is a relative path, return it unchanged."
(if (file-name-absolute-p filename)
(expand-file-name filename)
filename))
(defun pandoc--create-file-name-from-buffer (buffer-name)
"Create a file name from BUFFER-NAME.
The file name is formed from BUFFER-NAME by removing any
characters that might be problematic in a file name. Characters
that are retained are alphabetic characters, digits and the
characters `+' (plus sign), `_' (underscore), `.' (dot) and
`-' (minus sign). All other characters are removed."
(cl-remove-if-not (lambda (c)
(string-match-p "[[:alpha:][:digit:]+_.-]" (char-to-string c)))
buffer-name))
(defun pandoc--log (type format-string &rest args)
"Write a message to the *Pandoc log* buffer.
If TYPE is `message', also display the message in the echo area.
Any other value just logs the message, adding an empty line after
it. The arguments FORMAT-STRING and ARGS function as with
`message'."
(with-current-buffer (get-buffer-create pandoc--log-buffer-name)
(goto-char (point-max))
(insert (apply #'format format-string args) "\n\n"))
(when (eq type 'message)
(apply #'message format-string args)))
(defun pandoc--pp-switch (switch)
"Return a pretty-printed representation of SWITCH."
(if (pandoc--get switch)
"yes"
"no"))
(defun pandoc--pp-option (option)
"Return a pretty-printed representation of OPTION."
(or (pandoc--get option)
""))
(defun pandoc--get (option &optional buffer)
"Return the value of OPTION.
Optional argument BUFFER is the buffer from which the value is to
be retrieved."
(or buffer (setq buffer (current-buffer)))
(let ((var (intern (concat "pandoc/" (symbol-name option)))))
(if (local-variable-p var buffer)
(buffer-local-value var buffer)
(cdr (assq option (buffer-local-value 'pandoc--local-settings buffer))))))
(defun pandoc--set (option value)
"Set the local value of OPTION to VALUE."
(when (assq option pandoc--options) ; check if the option is licit
(unless (assq option pandoc--local-settings) ; add the option if it's not there
(push (list option) pandoc--local-settings)
;; in case of extensions, also add the list of extensions themselves.
(if (memq option '(read-extensions write-extensions))
(setcdr (assq option pandoc--local-settings) (mapcar #'list (sort (mapcar #'car pandoc--extensions) #'string<)))))
(cond
((memq option pandoc--alist-options)
(pandoc--set-alist-option option value))
((memq option pandoc--list-options)
(pandoc--set-list-option option value))
((eq option 'read-extensions)
(pandoc--set-extension (car value) 'read (cdr value)))
((eq option 'write-extensions)
(pandoc--set-extension (car value) 'write (cdr value)))
(t (setcdr (assq option pandoc--local-settings) value)))
(setq pandoc--settings-modified-flag t)))
(defun pandoc--set-alist-option (option new-elem)
"Set an alist OPTION.
NEW-ELEM is a cons (<name> . <value>), which is added to the alist
for OPTION in `pandoc--local-settings'. If an element with <name>
already exists, it is replaced, or removed if <value> is NIL.
If NEW-ELEM is nil, OPTION is unset entirely."
(let* ((value (cdr new-elem))
(items (pandoc--get option))
(item (assoc (car new-elem) items)))
(cond
((null new-elem)
(setq items nil))
((and item value) ; if <name> exists and we have a new value
(setcdr item value)) ; replace the existing value
((and item (not value)) ; if <name> exists but we have no new value
(setq items (delq item items))) ; remove <name>
((and (not item) value) ; if <name> does not exist
(setq items (append items (list new-elem))))) ; add it
(setcdr (assoc option pandoc--local-settings) items)))
(defun pandoc--set-list-option (option value)
"Add VALUE to list option OPTION.
If VALUE is nil, OPTION is unset entirely."
(let* ((values (pandoc--get option)))
(setcdr (assoc option pandoc--local-settings)
(if value
(append values (list value))
nil)))) ; if VALUE was nil, we unset the option
(defun pandoc--remove-from-list-option (option value)
"Remove VALUE from the list of OPTION."
(let* ((values (pandoc--get option))
(new-values (remove value values)))
(setcdr (assoc option pandoc--local-settings) new-values)))
(defun pandoc--toggle (switch)
"Toggle the value of SWITCH."
(pandoc--set switch (not (pandoc--get switch))))
;; Note: the extensions appear to be binary options, but they are not:
;; they're really (balanced) ternary options. They can be on or off, but
;; that doesn't tell us whether they're on or off because the user set them
;; that way or because that's the default setting for the relevant format.
;;
;; What we do is we create an alist of the extensions, where each extension
;; can have one of three values: nil, meaning default, the symbol -,
;; meaning switched off by the user, or the symbol +, meaning switched on
;; by the user.
(defun pandoc--extension-in-format-p (extension format &optional rw)
"Check if EXTENSION is a default extension for FORMAT.
RW must be either `read' or `write', indicating whether FORMAT is
being considered as an input or an output format."
(let ((formats (cadr (assoc extension pandoc--extensions))))
(or (member format formats)
(member format (cadr (assoc rw formats))))))
(defun pandoc--extension-active-p (extension rw)
"Return T if EXTENSION is active in the current buffer.
RW is either `read' or `write', indicating whether to test for the
input or the output format.
An extension is active either if it's part of the in/output
format and hasn't been deactivated by the user, or if the user
has activated it."
(let ((value (pandoc--get-extension extension rw)))
(or (eq value '+)
(and (not value)
(pandoc--extension-in-format-p extension (pandoc--get rw) rw)))))
(defun pandoc--set-extension (extension rw value)
"Set the value of EXTENSION for RW to VALUE.
RW is either `read' or `write', indicating whether the read or
write extension is to be set."
(setcdr (assoc extension (if (eq rw 'read)
(pandoc--get 'read-extensions)
(pandoc--get 'write-extensions)))
value))
(defun pandoc--get-extension (extension rw)
"Return the value of EXTENSION for RW.
RW is either `read' or `write', indicating whether the read or
write extension is to be queried."
(cdr (assoc extension (if (eq rw 'read)
(pandoc--get 'read-extensions)
(pandoc--get 'write-extensions)))))
;; hydra variables
(defvar pandoc--reader-hydra-list nil)
(defvar pandoc--writer-hydra-list nil)
(defvar pandoc--specific-hydra-list nil)
(defvar pandoc--html-hydra-list nil)
(defvar pandoc--tex-hydra-list nil)
(defvar pandoc--epub-hydra-list nil)
(defvar pandoc--citations-hydra-list nil)
(defvar pandoc--math-hydra-list nil)
;; menu variables
(defvar pandoc--reader-menu-list nil)
(defvar pandoc--writer-menu-list nil)
(defvar pandoc--specific-menu-list nil)
(defvar pandoc--html-menu-list nil)
(defvar pandoc--tex-menu-list nil)
(defvar pandoc--epub-menu-list nil)
(defvar pandoc--citations-menu-list nil)
(defvar pandoc--math-menu-list nil)
(defmacro define-pandoc-switch (option hydra description)
"Create a binary option.
OPTION must be a symbol and must be identical to the long form of
the pandoc option (without dashes).
HYDRA is a list describing how the option must be added to one of
the hydras. The first element is a symbol naming the hydra (and
menu) to which the option must be added, The second element is a
string of one character, the key by which the option will be
available in the hydra, and the third is a format string
describing the width of the option (which must be the same for
all options in a single hydra).
DESCRIPTION is the description of the option as it will appear in
the menu."
(declare (indent defun))
`(progn
(push ,(vector description `(pandoc--toggle (quote ,option))
:active t
:style 'toggle
:selected `(pandoc--get (quote ,option)))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-menu-list")))
(push (cons ,description (quote ,option)) pandoc--switches)
(push (quote ,option) pandoc--cli-options)
(push (list (quote ,option)) pandoc--options)
(push (quote ,(list (concat "_" (cadr hydra) "_: " (format (cl-caddr hydra) description) (format " [%%s(pandoc--pp-switch '%s)]" option))
(cadr hydra)
`(pandoc--toggle (quote ,option))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-hydra-list")))))
(defmacro define-pandoc-file-option (option hydra prompt &optional default)
"Define OPTION as a file option.
The option is added to `pandoc--options', `pandoc--cli-options',
and to `pandoc--filepath-options'. Furthermore, a menu entry is
created and a function to set/unset the option.
The function to set the option can be called with the prefix
argument `\\[universal-argument] -' (or `\\[negative-argument]')
to unset the option. It can also be called with the prefix
argument \\[universal-argument], in which case the file's full
path is stored.
HYDRA is a list describing how the option must be added to one of
the hydras. The first element is a symbol naming the hydra (and
menu) to which the option must be added, The second element is a
string of one character, the key by which the option will be
available in the hydra, and the third is a format string
describing the width of the option (which must be the same for
all options in a single hydra).
OPTION must be a symbol and must be identical to the long form of
the pandoc option (without dashes). PROMPT is a string that is
used to prompt for setting and unsetting the option. It must be
formulated in such a way that the strings \"No \", \"Set \" and
\"Default \" can be added before it. DEFAULT must be either NIL
or T and indicates whether the option can have a default value."
(declare (indent defun))
`(progn
(push (quote ,option) pandoc--filepath-options)
(push (quote ,option) pandoc--cli-options)
(push (list (quote ,option)) pandoc--options)
(push (list ,@(delq nil ; if DEFAULT is nil, we need to remove it from the list.
(list prompt
(vector (concat "No " prompt) `(pandoc--set (quote ,option) nil)
:active t
:style 'radio
:selected `(null (pandoc--get (quote ,option))))
(when default
(vector (concat "Default " prompt) `(pandoc--set (quote ,option) t)
:active t
:style 'radio
:selected `(eq (pandoc--get (quote ,option)) t)))
(vector (concat "Set " prompt "...") (intern (concat "pandoc-set-"
(symbol-name option)))
:active t
:style 'radio
:selected `(stringp (pandoc--get (quote ,option)))))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-menu-list")))
(push (quote ,(list (concat "_" (cadr hydra) "_: " (format (cl-caddr hydra) prompt) (format " [%%s(pandoc--pp-option '%s)]" option))
(cadr hydra)
(intern (concat "pandoc-set-" (symbol-name option)))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-hydra-list")))
(fset (quote ,(intern (concat "pandoc-set-" (symbol-name option))))
(lambda (prefix)
(interactive "P")
(pandoc--set (quote ,option)
(cond
((eq prefix '-) nil) ; C-u - or M--
((listp prefix) ; no prefix or C-u
(pandoc--read-file-name (concat ,prompt ": ") default-directory (not prefix)))
(t ,default))))))) ; any other prefix
(defmacro define-pandoc-number-option (option hydra prompt)
"Define OPTION as a numeric option.
The option is added to `pandoc--options' and to
`pandoc--cli-options'. Furthermore, a menu entry is created and
a function to set/unset the option.
The function to set the option can be called with the prefix
argument `\\[universal-argument] -' (or `\\[negative-argument]')
to unset the option. If no prefix argument is given, the user is
prompted for a value.
HYDRA is a list describing how the option must be added to one of
the hydras. The first element is a symbol naming the hydra (and
menu) to which the option must be added, The second element is a
string of one character, the key by which the option will be
available in the hydra, and the third is a format string
describing the width of the option (which must be the same for
all options in a single hydra).
OPTION must be a symbol and must be identical to the long form of
the pandoc option (without dashes). PROMPT is a string that is
used to prompt for setting and unsetting the option. It must be
formulated in such a way that the strings \"Default \" and \"Set
\" can be added before it."
(declare (indent defun))
`(progn
(push (list (quote ,option)) pandoc--options)
(push (quote ,option) pandoc--cli-options)
(push (list ,prompt
,(vector (concat "Default " prompt) `(pandoc--set (quote ,option) nil)
:active t
:style 'radio
:selected `(null (pandoc--get (quote ,option))))
,(vector (concat "Set " prompt "...") (intern (concat "pandoc-set-" (symbol-name option)))
:active t
:style 'radio
:selected `(pandoc--get (quote ,option))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-menu-list")))
(push (quote ,(list (concat "_" (cadr hydra) "_: " (format (cl-caddr hydra) prompt) (format " [%%s(pandoc--pp-option '%s)]" option))
(cadr hydra)
(intern (concat "pandoc-set-" (symbol-name option)))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-hydra-list")))
(fset (quote ,(intern (concat "pandoc-set-" (symbol-name option))))
(lambda (prefix)
(interactive "P")
(pandoc--set (quote ,option)
(if (eq prefix '-)
nil
(string-to-number (read-string ,(concat prompt ": ")))))))))
(defmacro define-pandoc-string-option (option hydra prompt &optional default)
"Define OPTION as a string option.
The option is added to `pandoc--options' and to
`pandoc--cli-options'. Furthermore, a menu entry is created and a
function to set the option.
The function to set the option can be called with the prefix
argument `\\[universal-argument] -' (or `\\[negative-argument]')
to unset the option. A default value (if any) can be set by
calling the function with any other prefix argument. If no
prefix argument is given, the user is prompted for a value.
HYDRA is a list describing how the option must be added to one of
the hydras. The first element is a symbol naming the hydra (and
menu) to which the option must be added, The second element is a
string of one character, the key by which the option will be
available in the hydra, and the third is a format string
describing the width of the option (which must be the same for
all options in a single hydra).
OPTION must be a symbol and must be identical to the long form of
the pandoc option (without dashes). PROMPT is a string that is
used to prompt for setting and unsetting the option. It must be
formulated in such a way that the strings \"No \", \"Set \" and
\"Default \" can be added before it. DEFAULT must be either NIL
or T and indicates whether the option can have a default value."
`(progn
(push (list (quote ,option)) pandoc--options)
(push (quote ,option) pandoc--cli-options)
(push (list ,@(delq nil ; if DEFAULT is nil, we need to remove it from the list.
(list prompt
(vector (concat "No " prompt) `(pandoc--set (quote ,option) nil)
:active t
:style 'radio
:selected `(null (pandoc--get (quote ,option))))
(when default
(vector (concat "Default " prompt) `(pandoc--set (quote ,option) t)
:active t
:style 'radio
:selected `(eq (pandoc--get (quote ,option)) t)))
(vector (concat "Set " prompt "...") (intern (concat "pandoc-set-" (symbol-name option)))
:active t
:style 'radio
:selected `(stringp (pandoc--get (quote ,option)))))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-menu-list")))
(push (quote ,(list (concat "_" (cadr hydra) "_: " (format (cl-caddr hydra) prompt) (format " [%%s(pandoc--pp-option '%s)]" option))
(cadr hydra)
(intern (concat "pandoc-set-" (symbol-name option)))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-hydra-list")))
(fset (quote ,(intern (concat "pandoc-set-" (symbol-name option))))
(lambda (prefix)
(interactive "P")
(pandoc--set (quote ,option)
(cond
((eq prefix '-) nil)
((null prefix) (read-string ,(concat prompt ": ")))
(t ,default)))))))
(defmacro define-pandoc-list-option (option hydra type description prompt)
"Define OPTION as a list option.
The option is added to `pandoc--options' and `pandoc--list-options'.
Furthermore, a menu entry is created and a function to set the
option. This function can also be called with the prefix
argument `\\[universal-argument] -' (or `\\[negative-argument]') to remove an item from the list,
or with the prefix argument `\\[universal-argument] \\[universal-argument]' to clear the entire list.
If the list is a list of files, the function can also be called
with the prefix argument `\\[universal-argument]' to store the full path.
HYDRA is a list describing how the option must be added to one of
the hydras. The first element is a symbol naming the hydra (and
menu) to which the option must be added, The second element is a
string of one character, the key by which the option will be
available in the hydra, and the third is a format string
describing the width of the option (which must be the same for
all options in a single hydra).
OPTION must be a symbol and must be identical to the long form of
the pandoc option (without dashes). TYPE specifies the kind of
data that is stored in the list. Currently, possible values are
`string' and `file'. DESCRIPTION is the description for the
option's submenu. PROMPT is a string that is used to prompt for
setting and unsetting the option. It must be formulated in such a
way that the strings \"Add \", \"Remove \" can be added before
it."
`(progn
(push (list (quote ,option)) pandoc--options)
(push (quote ,option) pandoc--list-options)
(put (quote ,option) (quote pandoc-list-type) (quote ,type))
(push (list ,description
,(vector (concat "Add " prompt) (intern (concat "pandoc-set-" (symbol-name option)))
:active t)
,(vector (concat "Remove " prompt) (list (intern (concat "pandoc-set-" (symbol-name option))) `(quote -))
:active `(pandoc--get (quote ,option))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-menu-list")))
(push (quote ,(list (concat "_" (cadr hydra) "_: " (format (cl-caddr hydra) description) (format " [%%s(pandoc--pp-option '%s)]" option))
(cadr hydra)
(intern (concat "pandoc-set-" (symbol-name option)))))
,(intern (concat "pandoc--" (symbol-name (car hydra)) "-hydra-list")))
(fset (quote ,(intern (concat "pandoc-set-" (symbol-name option))))
(lambda (prefix)
(interactive "P")
(cond
((and (listp prefix)
(eq (car prefix) 16)) ; C-u C-u
(pandoc--set (quote ,option) nil)
(message ,(concat description " removed.")))
((listp prefix) ; C-u or no prefix arg
(let ((value ,(cond