/
pdf-info.el
1744 lines (1504 loc) · 62.2 KB
/
pdf-info.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
;;; pdf-info.el --- Extract info from pdf-files via a helper process. -*- lexical-binding: t -*-
;; Copyright (C) 2013, 2014 Andreas Politz
;; Author: Andreas Politz <politza@fh-trier.de>
;; Keywords: files, multimedia
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; This library represents the Lisp side of the epdfinfo server. This
;; program works on a command/response basis, but there should be no
;; need to understand the protocol, since every command has a
;; corresponding Lisp-function (see below under `High level
;; interface').
;;
;; Most of these functions receive a file-or-buffer argument, which
;; may be what it says and defaults to the current buffer. Also, most
;; functions return some sort of alist, with, in most cases,
;; straight-forward key-value-pairs. Though some may be only
;; understandable in the context of Adobe's PDF spec \(Adobe
;; PDF32000\) or the poppler documentation (e.g. annotation flags).
;;
;; If the poppler library is fairly recent (>= 0.19.4, older versions
;; have a bug, which may corrupt the document), annotations maybe
;; modified to a certain degree, deleted and text-annotations created.
;; The state of these modifications is held in the server. In order
;; to realize, annotations retrieved or created are referenced by a
;; unique symbol. Saving these changes creates a new file, the
;; original document is never touched.
;;; Todo:
;;
;; + Close documents at some time (e.g. when the buffer is killed)
;;
;;; Code:
(require 'tq)
(require 'cl-lib)
;; * ================================================================== *
;; * Customizations
;; * ================================================================== *
(defgroup pdf-info nil
"Extract infos from pdf-files via a helper process."
:group 'pdf-tools)
(defcustom pdf-info-epdfinfo-program
(let ((executable (if (eq system-type 'windows-nt)
"epdfinfo.exe" "epdfinfo"))
(default-directory
(or (and load-file-name
(file-name-directory load-file-name))
default-directory)))
(cl-labels ((try-directory (directory)
(and (file-directory-p directory)
(file-executable-p (expand-file-name executable directory))
(expand-file-name executable directory))))
(or (executable-find executable)
;; This works if epdfinfo is in the same place as emacs and
;; the editor was started with an absolute path, i.e. it is
;; meant for Windows/Msys2.
(and (stringp (car-safe command-line-args))
(file-name-directory (car command-line-args))
(try-directory
(file-name-directory (car command-line-args))))
;; If we are running directly from the git repo.
(try-directory (expand-file-name "../server"))
;; Fall back to epdfinfo in the directory of this file.
(expand-file-name executable))))
"Filename of the epdfinfo executable."
:group 'pdf-info
:type 'file)
(defcustom pdf-info-epdfinfo-error-filename nil
"Filename for error output of the epdfinfo executable.
If nil, discard any error messages. Useful for debugging."
:group 'pdf-info
:type `(choice (const :tag "None" nil)
,@(when (file-directory-p "/tmp/")
'((const "/tmp/epdfinfo.log")))
(file)))
(defcustom pdf-info-log nil
"Whether to log the communication with the server.
If this is non-nil, all communication with the epdfinfo program
will be logged to the buffer \"*pdf-info-log*\"."
:group 'pdf-info
:type 'boolean)
(defcustom pdf-info-log-entry-max 512
"Maximum number of characters in a single log entry.
This variable has no effect if `pdf-info-log' is nil."
:group 'pdf-info
:type 'integer)
(defcustom pdf-info-restart-process-p 'ask
"What to do when the epdfinfo server died.
This should be one of
nil -- do nothing,
t -- automatically restart it or
ask -- ask whether to restart or not.
If it is `ask', the server quits and you answer no, this variable
is set to nil."
:group 'pdf-info
:type '(choice (const :tag "Do nothing" nil)
(const :tag "Restart silently" t)
(const :tag "Always ask" ask)))
(defcustom pdf-info-close-document-hook nil
"A hook ran after a document was closed in the server.
The hook is run in the documents buffer, if it exists. Otherwise
in a `with-temp-buffer' form."
:group 'pdf-info
:type 'hook)
;; * ================================================================== *
;; * Variables
;; * ================================================================== *
(defvar pdf-info-asynchronous nil
"If non-nil process queries asynchronously.
More specifically the value should be a function of at 2
arguments \(fn STATUS RESPONSE\), where STATUS is either nil, for
a successful query, or the symbol error. RESPONSE is either the
command's response or the error message. This does not work
recursive, i.e. if function wants to make another asynchronous
query it has to rebind this variable.
Alternatively it may be a list \(FN . ARGS\), in which case FN
will be invoked like \(apply FN STATUS RESPONSE ARGS\).
Also, all pdf-info functions normally returning a response return
nil.
This variable should only be let-bound.")
(defconst pdf-info-pdf-date-regexp
;; Adobe PDF32000.book, 7.9.4 Dates
(eval-when-compile
(concat
;; allow for preceding garbage
;;"\\`"
"[dD]:"
"\\([0-9]\\{4\\}\\)" ;year
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;month
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;day
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;hour
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;minutes
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;seconds
"\\)?\\)?\\)?\\)?\\)?"
"\\(?:"
"\\([+-Zz]\\)" ;UT delta char
"\\(?:"
"\\([0-9]\\{2\\}\\)" ;UT delta hours
"\\(?:"
"'"
"\\([0-9]\\{2\\}\\)" ;UT delta minutes
"\\)?\\)?\\)?"
;; "\\'"
;; allow for trailing garbage
)))
(defvar pdf-info--queue t
"Internally used transmission-queue for the server.
This variable is initially `t', telling the code starting the
server, that it never ran.")
;; * ================================================================== *
;; * Process handling
;; * ================================================================== *
(defconst pdf-info-empty-page-data
(eval-when-compile
(concat
"%PDF-1.0\n1 0 obj<</Type/Catalog/Pages 2 0 R>>endobj 2 0"
" obj<</Type/Pages/Kids[3 0 R]/Count 1>>endobj 3 0 obj<</"
"Type/Page/MediaBox[0 0 3 3]>>endobj\nxref\n0 4\n00000000"
"0065535 f\n0000000010 00000 n\n0000000053 00000 n\n00000"
"00102 00000 n\ntrailer<</Size 4/Root 1 0 R>>\nstartxref\n149\n%EOF"))
"PDF data of an empty page.")
(defun pdf-info-process ()
"Return the process object or nil."
(and pdf-info--queue
(not (eq t pdf-info--queue))
(tq-process pdf-info--queue)))
(defun pdf-info-check-epdfinfo (&optional interactive-p)
"Check if the server should be working properly.
Signal an error if some problem was found. Message a
confirmation, if INTERACTIVE-P is non-nil and no problems were
found.
Returns nil."
(interactive "p")
(let ((executable pdf-info-epdfinfo-program))
(unless (stringp executable)
(error "pdf-info-epdfinfo-program is unset or not a string"))
(unless (file-executable-p executable)
(error "pdf-info-epdfinfo-program is not executable"))
(when pdf-info-epdfinfo-error-filename
(unless (and (stringp pdf-info-epdfinfo-error-filename)
(file-writable-p pdf-info-epdfinfo-error-filename))
(error "pdf-info-epdfinfo-error-filename should contain writable filename")))
(let* ((default-directory (expand-file-name "~/"))
(cmdfile (make-temp-file "commands"))
(pdffile (make-temp-file "empty.pdf"))
(tempdir (make-temp-file "tmpdir" t))
(process-environment (cons (concat "TMPDIR=" tempdir)
process-environment)))
(unwind-protect
(with-temp-buffer
(with-temp-file pdffile
(set-buffer-multibyte nil)
(insert pdf-info-empty-page-data))
(with-temp-file cmdfile
(insert (format "renderpage:%s:1:100\nquit\n"
(pdf-info-query--escape pdffile))))
(unless (= 0 (apply #'call-process
executable cmdfile (current-buffer)
nil (when pdf-info-epdfinfo-error-filename
(list pdf-info-epdfinfo-error-filename))))
(error "Error running `%s': %s"
pdf-info-epdfinfo-program
(buffer-string))))
(when (file-exists-p cmdfile)
(delete-file cmdfile))
(when (file-exists-p pdffile)
(delete-file pdffile))
(when (file-exists-p tempdir)
(delete-directory tempdir t)))))
(when interactive-p
(message "The epdfinfo program appears to be working."))
nil)
(defun pdf-info-process-assert-running (&optional force)
"Assert a running process.
If it never ran, i.e. `pdf-info-process' is t, start it
unconditionally.
Otherwise, if FORCE is non-nil start it, if it is not running.
Else restart it with respect to the variable
`pdf-info-restart-process-p', which see.
If getting the process to run fails, this function throws an
error."
(interactive "P")
(unless (and (processp (pdf-info-process))
(eq (process-status (pdf-info-process))
'run))
(when (pdf-info-process)
(tq-close pdf-info--queue)
(setq pdf-info--queue nil))
(unless (or force
(eq pdf-info--queue t)
(and (eq pdf-info-restart-process-p 'ask)
(not noninteractive)
(y-or-n-p "The epdfinfo server quit, restart it ? "))
(and pdf-info-restart-process-p
(not (eq pdf-info-restart-process-p 'ask))))
(when (eq pdf-info-restart-process-p 'ask)
(setq pdf-info-restart-process-p nil))
(error "The epdfinfo server quit"))
(pdf-info-check-epdfinfo)
(let* ((process-connection-type) ;Avoid 4096 Byte bug #12440.
(default-directory "~")
(proc (apply #'start-process
"epdfinfo" " *epdfinfo*" pdf-info-epdfinfo-program
(when pdf-info-epdfinfo-error-filename
(list pdf-info-epdfinfo-error-filename)))))
(with-current-buffer " *epdfinfo*"
(erase-buffer))
(set-process-query-on-exit-flag proc nil)
(set-process-coding-system proc 'utf-8-unix 'utf-8-unix)
(setq pdf-info--queue (tq-create proc))))
pdf-info--queue)
(defadvice tq-process-buffer (around bugfix activate)
"Fix a bug in trunk where the wrong callback gets called."
;; FIXME: Make me iterative.
(let ((tq (ad-get-arg 0)))
(if (not (equal (car (process-command (tq-process tq)))
pdf-info-epdfinfo-program))
ad-do-it
(let ((buffer (tq-buffer tq))
done)
(when (buffer-live-p buffer)
(set-buffer buffer)
(while (and (not done)
(> (buffer-size) 0))
(setq done t)
(if (tq-queue-empty tq)
(let ((buf (generate-new-buffer "*spurious*")))
(copy-to-buffer buf (point-min) (point-max))
(delete-region (point-min) (point))
(pop-to-buffer buf nil)
(error "Spurious communication from process %s, see buffer %s"
(process-name (tq-process tq))
(buffer-name buf)))
(goto-char (point-min))
(when (re-search-forward (tq-queue-head-regexp tq) nil t)
(setq done nil)
(let ((answer (buffer-substring (point-min) (point)))
(fn (tq-queue-head-fn tq))
(closure (tq-queue-head-closure tq)))
(delete-region (point-min) (point))
(tq-queue-pop tq)
(condition-case-unless-debug err
(funcall fn closure answer)
(error
(message "Error while processing tq callback: %s"
(error-message-string err)))))))))))))
;; * ================================================================== *
;; * Sending and receiving
;; * ================================================================== *
(defun pdf-info-query (cmd &rest args)
"Query the server using CMD and ARGS."
(pdf-info-process-assert-running)
(unless (symbolp cmd)
(setq cmd (intern cmd)))
(let* ((query (concat (mapconcat 'pdf-info-query--escape
(cons cmd args) ":") "\n"))
(callback
(lambda (closure response)
(cl-destructuring-bind (status &rest result)
(pdf-info-query--parse-response cmd response)
(pdf-info-query--log response)
(let* (pdf-info-asynchronous)
(if (functionp closure)
(funcall closure status result)
(apply (car closure) status result (cdr closure)))))))
response status done
(closure (or pdf-info-asynchronous
(lambda (s r)
(setq status s response r done t)))))
(pdf-info-query--log query t)
(tq-enqueue
pdf-info--queue query "^\\.\n" closure callback)
(unless pdf-info-asynchronous
(while (and (not done)
(eq (process-status (pdf-info-process))
'run))
(accept-process-output (pdf-info-process) 0.01))
(when (and (not done)
(not (eq (process-status (pdf-info-process))
'run))
(not (eq cmd 'quit)))
(error "The epdfinfo server quit unexpectedly."))
(cond
((null status) response)
((eq status 'error)
(error "epdfinfo: %s" response))
((eq status 'interrupted)
(error "epdfinfo: Command was interrupted"))
(t
(error "internal error: invalid response status"))))))
(defun pdf-info-interrupt ()
"FIXME: This command does currently nothing."
(when (and (processp (pdf-info-process))
(eq (process-status (pdf-info-process))
'run))
(signal-process (pdf-info-process) 'SIGUSR1)))
(defun pdf-info-query--escape (arg)
"Escape ARG for transmission to the server."
(if (null arg)
(string)
(with-current-buffer (get-buffer-create " *pdf-info-query--escape*")
(erase-buffer)
(insert (format "%s" arg))
(goto-char 1)
(while (not (eobp))
(cond
((memq (char-after) '(?\\ ?:))
(insert ?\\))
((eq (char-after) ?\n)
(delete-char 1)
(insert ?\\ ?n)
(backward-char)))
(forward-char))
(buffer-substring-no-properties 1 (point-max)))))
(defmacro pdf-info-query--read-record ()
"Read a single record of the response in current buffer."
`(let (records done (beg (point)))
(while (not done)
(cl-case (char-after)
(?\\
(delete-char 1)
(if (not (eq (char-after) ?n))
(forward-char)
(delete-char 1)
(insert ?\n)))
((?: ?\n)
(push (buffer-substring-no-properties
beg (point)) records)
(forward-char)
(setq beg (point)
done (bolp)))
(t (forward-char))))
(nreverse records)))
(defun pdf-info-query--parse-response (cmd response)
"Parse one epdfinfo RESPONSE to CMD.
Returns a cons \(STATUS . RESULT\), where STATUS is one of nil
for a regular response, error for an error \(RESULT contains the
error message\) or interrupted, i.e. the command was
interrupted."
(with-current-buffer
(get-buffer-create " *pdf-info-query--parse-response*")
(erase-buffer)
(insert response)
(goto-char 1)
(cond
((looking-at "ERR\n")
(forward-line)
(cons 'error (buffer-substring-no-properties
(point)
(progn
(re-search-forward "^\\.\n")
(1- (match-beginning 0))))))
((looking-at "OK\n")
(let (result)
(forward-line)
(while (not (and (= (char-after) ?.)
(= (char-after (1+ (point))) ?\n)))
(push (pdf-info-query--read-record) result))
(cons nil (pdf-info-query--transform-response
cmd (nreverse result)))))
((looking-at "INT\n")
(cons 'interrupted nil))
(t
(cons 'error "Invalid server response")))))
(defun pdf-info-query--transform-response (cmd response)
"Transform a RESPONSE to CMD into a Lisp form."
(cl-case cmd
(open nil)
(close (equal "1" (caar response)))
(number-of-pages (string-to-number (caar response)))
(charlayout
(mapcar (lambda (elt)
(cl-assert (= 1 (length (cadr elt))) t)
`(,(aref (cadr elt) 0)
,(mapcar 'string-to-number
(split-string (car elt) " " t))))
response))
(regexp-flags
(mapcar (lambda (elt)
(cons (intern (car elt))
(string-to-number (cadr elt))))
response))
((search-string search-regexp)
(mapcar
(lambda (r)
`((page . ,(string-to-number (nth 0 r)))
(text . ,(let (case-fold-search)
(pdf-util-highlight-regexp-in-string
(regexp-quote (nth 1 r)) (nth 2 r))))
(edges . ,(mapcar (lambda (m)
(mapcar 'string-to-number
(split-string m " " t)))
(cddr (cdr r))))))
response))
(outline
(mapcar (lambda (r)
`((depth . ,(string-to-number (pop r)))
,@(pdf-info-query--transform-action r)))
response))
(pagelinks
(mapcar (lambda (r)
`((edges .
,(mapcar 'string-to-number ;area
(split-string (pop r) " " t)))
,@(pdf-info-query--transform-action r)))
response))
(metadata
(let ((md (car response)))
(if (= 1 (length md))
(list (cons 'title (car md)))
(list
(cons 'title (pop md))
(cons 'author (pop md))
(cons 'subject (pop md))
(cons 'keywords-raw (car md))
(cons 'keywords (split-string (pop md) "[\t\n ]*,[\t\n ]*" t))
(cons 'creator (pop md))
(cons 'producer (pop md))
(cons 'format (pop md))
(cons 'created (pop md))
(cons 'modified (pop md))))))
(gettext
(or (caar response) ""))
(getselection
(mapcar (lambda (line)
(mapcar 'string-to-number
(split-string (car line) " " t)))
response))
(features (mapcar 'intern (car response)))
(pagesize
(setq response (car response))
(cons (round (string-to-number (car response)))
(round (string-to-number (cadr response)))))
((getannot editannot addannot)
(pdf-info-query--transform-annotation (car response)))
(getannots
(mapcar 'pdf-info-query--transform-annotation response))
(getattachments
(mapcar 'pdf-info-query--transform-attachment response))
((getattachment-from-annot)
(pdf-info-query--transform-attachment (car response)))
(boundingbox
(mapcar 'string-to-number (car response)))
(synctex-forward-search
(let ((list (mapcar 'string-to-number (car response))))
`((page . ,(car list))
(edges . ,(cdr list)))))
(synctex-backward-search
`((filename . ,(caar response))
(line . ,(string-to-number (cadr (car response))))
(column . ,(string-to-number (cadr (cdar response))))))
(delannot nil)
((save) (caar response))
((renderpage renderpage-text-regions renderpage-highlight)
(pdf-util-munch-file (caar response)))
((setoptions getoptions)
(let (options)
(dolist (key-value response)
(let ((key (intern (car key-value)))
(value (cadr key-value)))
(cl-case key
((:render/printed :render/usecolors)
(setq value (equal value "1"))))
(push value options)
(push key options)))
options))
(pagelabels (mapcar 'car response))
(ping (caar response))
(t response)))
(defun pdf-info-query--transform-action (action)
"Transform ACTION response into a Lisp form."
(let ((type (intern (pop action))))
`((type . ,type)
(title . ,(pop action))
,@(cl-case type
(goto-dest
`((page . ,(string-to-number (pop action)))
(top . ,(and (> (length (car action)) 0)
(string-to-number (pop action))))))
(goto-remote
`((filename . ,(pop action))
(page . ,(string-to-number (pop action)))
(top . ,(and (> (length (car action)) 0)
(string-to-number (pop action))))))
(t `((uri . ,(pop action))))))))
(defun pdf-info-query--transform-annotation (a)
(cl-labels ((not-empty (s)
(if (not (equal s "")) s)))
(let (a1 a2 a3)
(cl-destructuring-bind (page edges type id flags color contents modified &rest rest)
a
(setq a1 `((page . ,(string-to-number page))
(edges . ,(mapcar 'string-to-number
(split-string edges " " t)))
(type . ,(intern type))
(id . ,(intern id))
(flags . ,(string-to-number flags))
(color . ,(not-empty color))
(contents . ,contents)
(modified . ,(pdf-info-parse-pdf-date modified))))
(when rest
(cl-destructuring-bind (label subject opacity popup-edges popup-is-open created
&rest rest)
rest
(setq a2
`((label . ,(not-empty label))
(subject . ,(not-empty subject))
(opacity . ,(let ((o (not-empty opacity)))
(and o (string-to-number o))))
(popup-edges . ,(let ((p (not-empty popup-edges)))
(when p
(mapcar 'string-to-number
(split-string p " " t)))))
(popup-is-open . ,(equal popup-is-open "1"))
(created . ,(pdf-info-parse-pdf-date (not-empty created)))))
(cond
((eq (cdr (assoc 'type a1)) 'text)
(cl-destructuring-bind (icon state is-open)
rest
(setq a3
`((icon . ,(not-empty icon))
(state . ,(not-empty state))
(is-open . ,(equal is-open "1"))))))
((memq (cdr (assoc 'type a1))
'(squiggly highlight underline strike-out))
(setq a3 `((markup-edges
. ,(mapcar (lambda (r)
(mapcar 'string-to-number
(split-string r " " t)))
rest)))))))))
(append a1 a2 a3))))
(defun pdf-info-query--transform-attachment (a)
(cl-labels ((not-empty (s)
(if (not (equal s "")) s)))
(cl-destructuring-bind (id filename description size modified
created checksum file)
a
`((id . ,(intern id))
(filename . ,(not-empty filename))
(description . ,(not-empty description))
(size . ,(let ((n (string-to-number size)))
(and (>= n 0) n)))
(modified . ,(not-empty modified))
(created . ,(not-empty created))
(checksum . ,(not-empty checksum))
(file . ,(not-empty file))))))
(defun pdf-info-query--log (string &optional query-p)
"Log STRING as query/response, depending on QUERY-P.
This is a no-op, if `pdf-info-log' is nil."
(when pdf-info-log
(with-current-buffer (get-buffer-create "*pdf-info-log*")
(buffer-disable-undo)
(let ((pos (point-max))
(window (get-buffer-window)))
(save-excursion
(goto-char (point-max))
(unless (bolp)
(insert ?\n))
(insert
(propertize
(format-time-string "%H:%M:%S ")
'face
(if query-p
'font-lock-keyword-face
'font-lock-function-name-face))
(if (and (numberp pdf-info-log-entry-max)
(> (length string)
pdf-info-log-entry-max))
(concat (substring string 0 pdf-info-log-entry-max)
"...[truncated]\n")
string)))
(when (and (window-live-p window)
(= pos (window-point window)))
(set-window-point window (point-max)))))))
;; * ================================================================== *
;; * Utility functions
;; * ================================================================== *
(defvar doc-view-buffer-file-name)
(defvar doc-view--buffer-file-name)
(defun pdf-info--normalize-file-or-buffer (file-or-buffer)
"Return the PDF file corresponding to FILE-OR-BUFFER.
FILE-OR-BUFFER may be nil, a PDF buffer, the name of a PDF buffer
or a PDF file."
(unless file-or-buffer
(setq file-or-buffer
(current-buffer)))
(when (bufferp file-or-buffer)
(unless (buffer-live-p file-or-buffer)
(error "Buffer is not live :%s" file-or-buffer))
(with-current-buffer file-or-buffer
(unless (setq file-or-buffer
(cl-case major-mode
(doc-view-mode
(cond ((boundp 'doc-view-buffer-file-name)
doc-view-buffer-file-name)
((boundp 'doc-view--buffer-file-name)
doc-view--buffer-file-name)))
(pdf-view-mode (pdf-view-buffer-file-name))
(t (buffer-file-name))))
(error "Buffer is not associated with any file :%s" (buffer-name)))))
(unless (stringp file-or-buffer)
(signal 'wrong-type-argument
(list 'stringp 'bufferp 'null file-or-buffer)))
;; is file
(when (file-remote-p file-or-buffer)
(error "Processing remote files not supported :%s"
file-or-buffer))
;; (unless (file-readable-p file-or-buffer)
;; (error "File not readable :%s" file-or-buffer))
(expand-file-name file-or-buffer))
(defun pdf-info-valid-page-spec-p (pages)
"The type predicate for a valid page-spec."
(not (not (ignore-errors (pdf-info-normalize-page-range pages)))))
(defun pdf-info-normalize-page-range (pages)
"Normalize PAGES for sending to the server.
PAGES may be a single page number, a cons \(FIRST . LAST\), or
nil, which stands for all pages.
The result is a cons \(FIRST . LAST\), where LAST may be 0
representing the final page."
(cond
((natnump pages)
(cons pages pages))
((null pages)
(cons 1 0))
((and (natnump (car pages))
(natnump (cdr pages)))
pages)
(t
(signal 'wrong-type-argument
(list 'pdf-info-valid-page-spec-p pages)))))
(defun pdf-info-parse-pdf-date (date)
(when (and date
(string-match pdf-info-pdf-date-regexp date))
(let ((year (match-string 1 date))
(month (match-string 2 date))
(day (match-string 3 date))
(hour (match-string 4 date))
(min (match-string 5 date))
(sec (match-string 6 date))
(ut-char (match-string 7 date))
(ut-hour (match-string 8 date))
(ut-min (match-string 9 date))
(tz 0))
(when (or (equal ut-char "+")
(equal ut-char "-"))
(when ut-hour
(setq tz (* 3600 (string-to-number ut-hour))))
(when ut-min
(setq tz (+ tz (* 60 (string-to-number ut-min)))))
(when (equal ut-char "-")
(setq tz (- tz))))
(encode-time
(if sec (string-to-number sec) 0)
(if min (string-to-number min) 0)
(if hour (string-to-number hour) 0)
(if day (string-to-number day) 1)
(if month (string-to-number month) 1)
(string-to-number year)
tz))))
(defmacro pdf-info-compose-queries (let-forms &rest body)
"Let-bind each VAR to QUERIES results and evaluate BODY.
All queries in each QUERIES form are run by the server in the
order they appear and the results collected in a list, which is
bound to VAR. Then BODY is evaluated and its value becomes the
final result of all queries, unless at least one of them provoked
an error. In this case BODY is ignored and the error is the
result.
This macro handles synchronous and asynchronous calls,
i.e. `pdf-info-asynchronous' is non-nil, transparently.
\(FN \(\(VAR QUERIES\)...\) BODY\)"
(declare (indent 1)
(debug ((&rest &or
(symbolp &optional form)
symbolp)
body)))
(unless (cl-every (lambda (form)
(when (symbolp form)
(setq form (list form)))
(and (consp form)
(symbolp (car form))
(listp (cdr form))))
let-forms)
(error "Invalid let-form: %s" let-forms))
(setq let-forms (mapcar (lambda (form)
(if (symbolp form)
(list form)
form))
let-forms))
(let* ((status (make-symbol "status"))
(response (make-symbol "response"))
(first-error (make-symbol "first-error"))
(done (make-symbol "done"))
(callback (make-symbol "callback"))
(results (make-symbol "results"))
(push-fn (make-symbol "push-fn"))
(terminal-fn (make-symbol "terminal-fn"))
(buffer (make-symbol "buffer")))
`(let* (,status
,response ,first-error ,done
(,buffer (current-buffer))
(,callback pdf-info-asynchronous)
;; Ensure a new alist on every invocation.
(,results (mapcar 'copy-sequence
',(cl-mapcar (lambda (form)
(list (car form)))
let-forms)))
(,push-fn (lambda (status result var)
;; Store result in alist RESULTS under key
;; VAR.
(if status
(unless ,first-error
(setq ,first-error result))
(let ((elt (assq var ,results)))
(setcdr elt (append (cdr elt)
(list result)))))))
(,terminal-fn
(lambda (&rest _)
;; Let-bind responses corresponding to their variables,
;; i.e. keys in alist RESULTS.
(let (,@(mapcar (lambda (var)
(list var (list 'cdr (list 'assq (list 'quote var)
results))))
(mapcar 'car let-forms)))
(setq ,status (not (not ,first-error))
,response (or ,first-error
(with-current-buffer ,buffer
,@body))
,done t)
;; Maybe invoke the CALLBACK (which was bound to
;; pdf-info-asynchronous).
(when ,callback
(if (functionp ,callback)
(funcall ,callback ,status ,response)
(apply (car ,callback)
,status ,response (cdr ,callback))))))))
;; Wrap each query in an asynchronous call, with its VAR as
;; callback argument, so the PUSH-FN can put it in the alist
;; RESULTS.
,@(mapcar (lambda (form)
(list 'let (list
(list 'pdf-info-asynchronous
(list 'list push-fn (list 'quote (car form)))))
(cadr form)))
let-forms)
;; Request a no-op, just so we know that we are finished.
(let ((pdf-info-asynchronous ,terminal-fn))
(pdf-info-ping))
;; CALLBACK is the original value of pdf-info-asynchronous. If
;; nil, this is a synchronous query.
(unless ,callback
(while (and (not ,done)
(eq (process-status (pdf-info-process))
'run))
(accept-process-output (pdf-info-process) 0.01))
(when (and (not ,done)
(not (eq (process-status (pdf-info-process))
'run)))
(error "The epdfinfo server quit unexpectedly."))
(when ,status
(error "epdfinfo: %s" ,response))
,response))))
;; * ================================================================== *
;; * Buffer local server instances
;; * ================================================================== *
(put 'pdf-info--queue 'permanent-local t)
(defun pdf-info-make-local-server (&optional buffer force-restart-p)
"Create a server instance local to BUFFER.
Does nothing if BUFFER already has a local instance. Unless
FORCE-RESTART-P is non-nil, then quit a potential process and
restart it."
(unless buffer
(setq buffer (current-buffer)))
(with-current-buffer buffer
(unless (and
(not force-restart-p)
(local-variable-p 'pdf-info--queue)
(processp (pdf-info-process))
(eq (process-status (pdf-info-process))
'run))
(when (and (local-variable-p 'pdf-info--queue)
(processp (pdf-info-process)))
(tq-close pdf-info--queue))
(set (make-local-variable 'pdf-info--queue) nil)
(pdf-info-process-assert-running t)
(add-hook 'kill-buffer-hook 'pdf-info-kill-local-server nil t)
pdf-info--queue)))
(defun pdf-info-kill-local-server (&optional buffer)
"Kill the local server in BUFFER.
A No-op, if BUFFER has not running server instance."
(save-current-buffer
(when buffer
(set-buffer buffer))
(when (local-variable-p 'pdf-info--queue)
(pdf-info-kill)
(kill-local-variable 'pdf-info--queue)
t)))
(defun pdf-info-local-server-p (&optional buffer)
"Return non-nil, if BUFFER has a running server instance."
(unless buffer
(setq buffer (current-buffer)))
(setq buffer (get-buffer buffer))
(and (buffer-live-p buffer)
(local-variable-p 'pdf-info--queue buffer)))
(defun pdf-info-local-batch-query (producer-fn
consumer-fn
sentinel-fn
args)
"Process a set of queries asynchronously in a local instance."
(unless (pdf-info-local-server-p)
(error "Create a local server first"))
(let* ((buffer (current-buffer))
(producer-symbol (make-symbol "producer"))
(consumer-symbol (make-symbol "consumer"))
(producer
(lambda (args)
(if (null args)
(funcall sentinel-fn 'finished buffer)
(let ((pdf-info-asynchronous
(apply-partially
(symbol-function consumer-symbol)
args)))
(cond
((pdf-info-local-server-p buffer)
(with-current-buffer buffer
(apply producer-fn (car args))))
(t
(funcall sentinel-fn 'error buffer)))))))
(consumer (lambda (args status result)
(if (not (pdf-info-local-server-p buffer))
(funcall sentinel-fn 'error buffer)
(with-current-buffer buffer
(apply consumer-fn status result (car args)))
(funcall (symbol-function producer-symbol)
(cdr args))))))
(fset producer-symbol producer)
(fset consumer-symbol consumer)
(funcall producer args)))
;; * ================================================================== *
;; * High level interface
;; * ================================================================== *
(defvar pdf-info-features nil)
(defun pdf-info-features ()
"Return a list of symbols describing compile-time features."
(or pdf-info-features
(setq pdf-info-features
(let (pdf-info-asynchronous)
(pdf-info-query 'features)))))
(defun pdf-info-writable-annotations-p ()
(not (null (memq 'writable-annotations (pdf-info-features)))))
(defun pdf-info-markup-annotations-p ()
(not (null (memq 'markup-annotations (pdf-info-features)))))