From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Visuwesh Newsgroups: gmane.emacs.bugs Subject: bug#73530: [PATCH] Add imenu index function for Djvu files in doc-view Date: Thu, 03 Oct 2024 20:21:46 +0530 Message-ID: <87ldz5ck8t.fsf@gmail.com> References: <8734ljg6f5.fsf@gmail.com> <86msjr6ayu.fsf@gnu.org> <874j5ziudn.fsf@gnu.org> <87y13bel5m.fsf@gmail.com> <-wirQcNBR0cpaXo0jL0sp8CxUkFsFX_iWUm_BoGq4ChYLccOyN7QJN53eHf0Q-AncT65owrhqfPWYnnQO3gRHw==@protonmail.internalid> <87setjhcm6.fsf@gnu.org> <87zfnrzjl7.fsf@mail.jao.io> <87h69zh9nw.fsf@gnu.org> <87v7yfzhfz.fsf@mail.jao.io> <87h69yh7zp.fsf@gnu.org> <87ttdyedga.fsf@gmail.com> <87y13ae8it.fsf@gnu.org> <87plome7oc.fsf@gmail.com> <87ikuddp8q.fsf@gmail.com> <875xqb2efq.fsf@gnu.org> <87y136dihg.fsf@gmail.com> <87ttdu1rpu.fsf@gnu.org> <87bk01obpf.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38540"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Eli Zaretskii , "Jose A. Ortega Ruiz" , 73530@debbugs.gnu.org To: Tassilo Horn Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Oct 03 16:53:29 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1swNCr-0009ps-2c for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 03 Oct 2024 16:53:29 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1swNCR-0006cX-HB; Thu, 03 Oct 2024 10:53:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1swNCP-0006bv-G3 for bug-gnu-emacs@gnu.org; Thu, 03 Oct 2024 10:53:01 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1swNCO-0003ft-RY for bug-gnu-emacs@gnu.org; Thu, 03 Oct 2024 10:53:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:References:In-Reply-To:From:To:Subject; bh=u2jBTm3VImokDIKus0aCqqff6Z+SI1QOnvFK6Axf/a8=; b=QvyIt3NH5S/g8H1et7fcQlyc2z0iZYK2VaY5poYHxMAJAdxL8CgiBdOIOe6KScYg5YDE24l6J87sodwwOztCIaQ+VljHeIDb2y2BZybS7ICnw2utnoxOBPMLY7wGcAF03KzrKe/k5d6/hduL5BvzaMoXn25losb7dxBR2os3m75pqpjU1JTEXi76M/Zxgg+G/txtGc49V7MqI8OuthZR1j3v9RGNvHnQp5mfbdz2dAgnVf0rXMeSifx2nAEZm4dEIcAhlMV1xEu5D4pQWEbBSu9mTKiVF58zRnJXAEsd8NZ++Ow5nAvd5x+5Rtzc9qi0xMu2YG36qqE/AhNAUKwRrQ==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1swNCQ-0000GU-FD for bug-gnu-emacs@gnu.org; Thu, 03 Oct 2024 10:53:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Visuwesh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 03 Oct 2024 14:53:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 73530 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 73530-submit@debbugs.gnu.org id=B73530.17279671781006 (code B ref 73530); Thu, 03 Oct 2024 14:53:02 +0000 Original-Received: (at 73530) by debbugs.gnu.org; 3 Oct 2024 14:52:58 +0000 Original-Received: from localhost ([127.0.0.1]:33705 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1swNCK-0000G9-VM for submit@debbugs.gnu.org; Thu, 03 Oct 2024 10:52:57 -0400 Original-Received: from mail-pl1-f194.google.com ([209.85.214.194]:56755) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1swNCI-0000G0-Lu for 73530@debbugs.gnu.org; Thu, 03 Oct 2024 10:52:55 -0400 Original-Received: by mail-pl1-f194.google.com with SMTP id d9443c01a7336-20b86298710so8666385ad.1 for <73530@debbugs.gnu.org>; Thu, 03 Oct 2024 07:52:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1727967112; x=1728571912; darn=debbugs.gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=u2jBTm3VImokDIKus0aCqqff6Z+SI1QOnvFK6Axf/a8=; b=BOHhzQJM/9I36eSKr3olOvwiwftC6mzanHp4UxxIf9mW1t9mG4YBQ9+zizLiAIeTf5 cNh4VKVwzWzp0jmLUiiQmeuva1u+qnNz88mOP/2rjLpALXnXOwmWkX5j3P5EOHSMqNXl s+uZipMTb7Ga9xrVoJjN2QXsdVfj0Ed15GOTuFx3fdPphbqiiVc7O0cHUK+orDYAB2K/ ygmQkMG2nVPw5/9qtQbFYrMNyn7P/SC8CiGnfb2aIp3besbNoGJAr7srmH6NLIqyY78z JBkjjV4BUvs80w2ldwAI8QVIYsUL3PMWfo7m4J2PiBtbaEk9HUFAhZqYmk8G6wOA9Q5Z M5Fw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727967112; x=1728571912; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=u2jBTm3VImokDIKus0aCqqff6Z+SI1QOnvFK6Axf/a8=; b=luYqfBg8J/PwtEtwnjAllOChH/WuDywX7TxtzQ00HbgbhCoPYEciRa4KEOaqb8LSsa YlLT8OmhGaKSwbPGVxYdATvXqS6UpYMHZmeKtebxGLjwJ/8E/At7T96j10Q5dPpNhk4D Sdn9b0tx7f1t8KesktOeyo5szVKl5WL12eHcx1d8FmFf06TQZymojl+lgwSzebfOzAWP 1925hICZKSWihzRv7PzwyBa9PgJobkM0uaNdu0fmbOILAHl4i698nf0iJUZqKaulkoDr Jio8di8wC+E18JMoThiv+3Di+nzg/CiKbkQHQqkK7e6vffqIbw+vFZf1wnJTvZU6OpZT VJZA== X-Forwarded-Encrypted: i=1; AJvYcCXcLmsKTN0Dgv8S7tyifvJOyuYvzgYcrNZ3N2TqA4f2HxjlIbbypYA2F+4iSUwe0Gt30/JVhw==@debbugs.gnu.org X-Gm-Message-State: AOJu0YyCdNILdD5vXqwcPz6R8P2UjFdbAZzWTKcSzukPz71qTqCsrOpq xm72vLhqctbGXrf/P7Y7ac4YXccfg1Kc7OlJl8iJIXgmIyI9IXbw X-Google-Smtp-Source: AGHT+IHi6WAyd/t7sF+14YXppI02E7BJJIvNjMZ74P4JLqWer/NbHAM4aFSfqXyPUDa/C5eM7ha0Cg== X-Received: by 2002:a17:902:e848:b0:20b:9d96:622c with SMTP id d9443c01a7336-20bc59bc452mr108909575ad.8.1727967111674; Thu, 03 Oct 2024 07:51:51 -0700 (PDT) Original-Received: from localhost ([1.7.159.70]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20beefb0d9dsm9819045ad.231.2024.10.03.07.51.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 03 Oct 2024 07:51:51 -0700 (PDT) In-Reply-To: <87bk01obpf.fsf@gnu.org> (Tassilo Horn's message of "Thu, 03 Oct 2024 10:03:08 +0200") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:292908 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE=85= =E0=AE=95=E0=AF=8D=E0=AE=9F=E0=AF=8B=E0=AE=AA=E0=AE=B0=E0=AF=8D 03, 2024] T= assilo Horn wrote: >>>> For DjVu, my sample size is 1, and that's a presentation, so at least >>>> here I'm not sure if there should be an index available... >>> >>> I will send the link to the DjVu file that I wrote the feature for >>> off-list. I will send a link to a PDF file too. >> >> Thanks, will try with those two files. > > I did so now and it is blazingly fast for those 80+mb PDF/DjVu files > even on my almost 10 years old laptop, so I'd say your simpler approach > is the right choice. > >>> On this note, should we use doc-view-pdfdraw-program in place of >>> mutool in doc-view--pdf-outline? >> >> Yes, but only if the older names pdfdraw and mudraw already had the >> "show outline" feature. > > I revert the "but only if" part. If mupdf is old and comes with, e.g., > the pdfdraw executable, chances are almost zero that mutool is > installed, too. And if it is, then we should prefer it anywhere. So I > think the way to go is to (executable-find "mutool") in > doc-view-pdfdraw-program first so that it takes precedence and use > doc-view-pdfdraw-program in doc-view--pdf-outline. > >>>> Well, I actually have no strong opinion here. Technically, I like >>>> your approach better because of its simplicity. I would like to test >>>> with some larger documents to see how long index building takes, >>>> though. >>> >>> I tried the function with a large PDF file: >> >> Will try with the large two you've linked later. > > As said above, it's more than fast enough, so let's take your approach. I have now attached a patch with the above change. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-imenu-index-function-for-DjVu-files-in-doc-view.patch >From 441f0e9339a853ac011d08c8754fc5c9217d146f Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 2 Oct 2024 13:48:25 +0530 Subject: [PATCH] Add imenu index function for DjVu files in doc-view * lisp/doc-view.el (doc-view-pdfdraw-program): Prefer mutool over other names. (doc-view-imenu-enabled): Tweak the default value to check for 'djvused', and make it obsolete. (doc-view--djvu-outline, doc-view--parse-djvu-outline): Add new functions to return imenu index for a Djvu file. (doc-view--outline): Add new function to create the imenu index depending on the file type. (doc-view--outline): Document new possible variable value. (doc-view-imenu-index): Use the above function instead. (doc-view-imenu-setup): Try to create the imenu index unconditionally. * doc/emacs/misc.texi (DocView Navigation): Mention index creation using 'djvused' too. * etc/NEWS: Announce the change. (Bug#73530) --- doc/emacs/misc.texi | 18 ++++---- etc/NEWS | 7 +++ lisp/doc-view.el | 108 ++++++++++++++++++++++++++++++++++++-------- 3 files changed, 106 insertions(+), 27 deletions(-) diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index b074eb034b2..7b11a829b0b 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -581,17 +581,17 @@ DocView Navigation default size for DocView, customize the variable @code{doc-view-resolution}. -@vindex doc-view-imenu-enabled @vindex doc-view-imenu-flatten @vindex doc-view-imenu-format - When the @command{mutool} program is available, DocView will use it -to generate entries for an outline menu, making it accessible via the -@code{imenu} facility (@pxref{Imenu}). To disable this functionality -even when @command{mutool} can be found on your system, customize the -variable @code{doc-view-imenu-enabled} to the @code{nil} value. You -can further customize how @code{imenu} items are formatted and -displayed using the variables @code{doc-view-imenu-format} and -@code{doc-view-imenu-flatten}. +@vindex doc-view-djvused-program + DocView can generate an outline menu for PDF and DjVu documents using +the @command{mutool} and the @command{djvused} programs respectively +when they are available. This is made accessible via the @code{imenu} +facility (@pxref{Imenu}). You can customize how @code{imenu} items are +formatted and displayed using the variables @code{doc-view-imenu-format} +and @code{doc-view-imenu-flatten}. The filename of the +@command{djvused} program can be customized by changing the +@code{doc-view-djvused-program} user option. @cindex registers, in DocView mode @findex doc-view-page-to-register diff --git a/etc/NEWS b/etc/NEWS index abe316547aa..bbcef80b762 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -351,6 +351,13 @@ Docview can store current page to buffer-local registers with the new command 'doc-view-page-to-register' (bound to 'm'), and later the stored page can be restored with 'doc-view-jump-to-register' (bound to '''). ++++ +*** Docview can generate imenu index for DjVu files. +When the 'djvused' program is available, Docview can now generate imenu +index for DjVu files from its outline. +The name of the 'djvused' program can be customized by changing the user +option 'doc-view-djvused-program'. + ** Tramp +++ diff --git a/lisp/doc-view.el b/lisp/doc-view.el index e79295a8b01..3683f1f60d4 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el @@ -27,8 +27,10 @@ ;; `pdftotext', which comes with xpdf (https://www.foolabs.com/xpdf/) ;; or poppler (https://poppler.freedesktop.org/). EPUB, CBZ, FB2, XPS ;; and OXPS documents require `mutool' which comes with mupdf -;; (https://mupdf.com/index.html). Djvu documents require `ddjvu' +;; (https://mupdf.com/index.html). DjVu documents require `ddjvu' ;; (from DjVuLibre). ODF files require `soffice' (from LibreOffice). +;; `djvused' (from DjVuLibre) can be optionally used to generate imenu +;; outline for DjVu documents when available. ;;; Commentary: @@ -185,13 +187,13 @@ doc-view-ghostscript-program (defcustom doc-view-pdfdraw-program (cond + ((executable-find "mutool") "mutool") ((executable-find "pdfdraw") "pdfdraw") ((executable-find "mudraw") "mudraw") - ((executable-find "mutool") "mutool") (t "mudraw")) "Name of MuPDF's program to convert PDF files to PNG." :type 'file - :version "24.4") + :version "31.1") (defcustom doc-view-pdftotext-program-args '("-raw") "Parameters to give to the pdftotext command." @@ -216,10 +218,23 @@ doc-view-mupdf-use-svg :type 'boolean :version "30.1") -(defcustom doc-view-imenu-enabled (and (executable-find "mutool") t) - "Whether to generate an imenu outline when \"mutool\" is available." +(defcustom doc-view-djvused-program (and (executable-find "djvused") + "djvused") + "Name of \"djvused\" program to generate imenu outline for DjVu files. +This is part of DjVuLibre." + :type 'file + :version "31.1") + +(defcustom doc-view-imenu-enabled (and (or (executable-find "mutool") + (executable-find "djvused")) + t) + "Whether to generate imenu outline for PDF and DjVu files. +This uses \"mutool\" for PDF files and \"djvused\" for DjVu files." :type 'boolean - :version "29.1") + :version "31.1") +(make-obsolete-variable 'doc-view-imenu-enabled + "Imenu index is generated unconditionally when available." + "31.1") (defcustom doc-view-imenu-title-format "%t (%p)" "Format spec for imenu's display of section titles from docview documents. @@ -1958,7 +1973,9 @@ doc-view--outline-rx "[^\t]+\\(\t+\\)\"\\(.+\\)\"\t#\\(?:page=\\)?\\([0-9]+\\)") (defvar-local doc-view--outline nil - "Cached PDF outline, so that it is only computed once per document.") + "Cached PDF outline, so that it is only computed once per document. +It can be the symbol `unavailable' to indicate that outline is +unavailable for the document.") (defun doc-view--pdf-outline (&optional file-name) "Return a list describing the outline of FILE-NAME. @@ -1972,7 +1989,9 @@ doc-view--pdf-outline (let ((outline nil) (fn (expand-file-name fn))) (with-temp-buffer - (unless (eql 0 (call-process "mutool" nil (current-buffer) nil "show" fn "outline")) + (unless (eql 0 (call-process doc-view-pdfdraw-program nil + (current-buffer) nil "show" fn "outline")) + (setq doc-view--outline 'unavailable) (imenu-unavailable-error "Unable to create imenu index using `mutool'")) (goto-char (point-min)) (while (re-search-forward doc-view--outline-rx nil t) @@ -1983,6 +2002,42 @@ doc-view--pdf-outline outline))) (nreverse outline))))) +(defun doc-view--djvu-outline (&optional file-name) + "Return a list describing the outline of FILE-NAME. +If FILE-NAME is nil or omitted, it defaults to the current buffer's file +name. + +For the format, see `doc-view--pdf-outline'." + (unless file-name (setq file-name (buffer-file-name))) + (with-temp-buffer + (call-process doc-view-djvused-program nil (current-buffer) nil + "-e" "print-outline" file-name) + (goto-char (point-min)) + (when (eobp) + (setq doc-view--outline 'unavailable) + (imenu-unavailable-error "Unable to create imenu index using `djvused'")) + (nreverse (doc-view--parse-djvu-outline (read (current-buffer)))))) + +(defun doc-view--parse-djvu-outline (bookmark &optional level) + "Return a list describing the djvu outline from BOOKMARK. +Optional argument LEVEL is the current heading level, which defaults to 1." + (unless level (setq level 1)) + (let ((res)) + (unless (eq (car bookmark) 'bookmarks) + (user-error "Unknown outline type: %S" (car bookmark))) + (pcase-dolist (`(,title ,page . ,rest) (cdr bookmark)) + (push `((level . ,level) + (title . ,title) + (page . ,(string-to-number (string-remove-prefix "#" page)))) + res) + (when (and rest (listp (car rest))) + (setq res (append + (doc-view--parse-djvu-outline + (cons 'bookmarks rest) + (+ level 1)) + res)))) + res)) + (defun doc-view--imenu-subtree (outline act) "Construct a tree of imenu items for the given outline list and action. @@ -2015,19 +2070,36 @@ doc-view-imenu-index For extensibility, callers can specify a FILE-NAME to indicate the buffer other than the current buffer, and a jumping function GOTO-PAGE-FN other than `doc-view-goto-page'." - (let* ((goto (or goto-page-fn 'doc-view-goto-page)) - (act (lambda (_name _pos page) (funcall goto page))) - (outline (or doc-view--outline (doc-view--pdf-outline file-name)))) - (car (doc-view--imenu-subtree outline act)))) + (unless doc-view--outline + (setq doc-view--outline (doc-view--outline file-name))) + (unless (eq doc-view--outline 'unavailable) + (let* ((goto (or goto-page-fn #'doc-view-goto-page)) + (act (lambda (_name _pos page) (funcall goto page))) + (outline doc-view--outline)) + (car (doc-view--imenu-subtree outline act))))) + +(defun doc-view--outline (&optional file-name) + "Return the outline for the file FILE-NAME. +If FILE-NAME is nil, use the current file instead." + (unless file-name (setq file-name (buffer-file-name))) + (let ((outline + (pcase doc-view-doc-type + ('djvu + (when doc-view-djvused-program + (doc-view--djvu-outline file-name))) + (_ + (doc-view--pdf-outline file-name))))) + (when outline (imenu-add-to-menubar "Outline")) + ;; When the outline could not be made due to unavailability of the + ;; required program, or its absency from the document, return + ;; 'unavailable'. + (or outline 'unavailable))) (defun doc-view-imenu-setup () "Set up local state in the current buffer for imenu, if needed." - (when doc-view-imenu-enabled - (setq-local imenu-create-index-function #'doc-view-imenu-index - imenu-submenus-on-top nil - imenu-sort-function nil - doc-view--outline (doc-view--pdf-outline)) - (when doc-view--outline (imenu-add-to-menubar "Outline")))) + (setq-local imenu-create-index-function #'doc-view-imenu-index + imenu-submenus-on-top nil + imenu-sort-function nil)) ;;;; User interface commands and the mode -- 2.45.2 --=-=-=--