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: Mon, 30 Sep 2024 22:59:25 +0530 Message-ID: <87ikuddp8q.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> 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="30650"; 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 Mon Sep 30 19:31:51 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 1svKFS-0007pp-OA for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 30 Sep 2024 19:31:50 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1svKFE-0006Qu-F0; Mon, 30 Sep 2024 13:31:36 -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 1svKF7-0006Pp-I3 for bug-gnu-emacs@gnu.org; Mon, 30 Sep 2024 13:31:33 -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 1svKF7-0004ST-9Y for bug-gnu-emacs@gnu.org; Mon, 30 Sep 2024 13:31:29 -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=c1b/PdYIy8QVxUO9EyQEXyukKmKkH/0Q3rPafjy2tS0=; b=YSrDXuCVMEn5aZ0y4H809eZdDcvKATBpG5sJ24VNCXcdDyFPrKPESIyutNj2kiNgD77VSdyg8va5fPewYmTVBhFJGIhf6E9exzcd8g1HybvSVAdv7WxU+8s+bc8jZEW85r0tKxLBCmimlWwXCc767LfbVnwBEosNB4s2aKGqvz086kX/KTEgLjY0sc487Dm2yTHmJ6u7qHZDUiwLv9mvvXc7ISEKeBUc1vbidw3uxNDFir73UsrH4F2kc+hOz2+yyAkUV92w2QkwIR14P7aS8+0N9YC54Yu43zMWGTiL0CdVhBDdujqwS+Xl7LI6CuE9ljCnLbjY5l1Pf45GDhHVqw==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1svKFd-00080G-Va for bug-gnu-emacs@gnu.org; Mon, 30 Sep 2024 13:32:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Visuwesh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 30 Sep 2024 17:32:01 +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.172771747330736 (code B ref 73530); Mon, 30 Sep 2024 17:32:01 +0000 Original-Received: (at 73530) by debbugs.gnu.org; 30 Sep 2024 17:31:13 +0000 Original-Received: from localhost ([127.0.0.1]:46012 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1svKEq-0007zg-Ao for submit@debbugs.gnu.org; Mon, 30 Sep 2024 13:31:13 -0400 Original-Received: from mail-pf1-f196.google.com ([209.85.210.196]:57524) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1svKEn-0007zW-6v for 73530@debbugs.gnu.org; Mon, 30 Sep 2024 13:31:10 -0400 Original-Received: by mail-pf1-f196.google.com with SMTP id d2e1a72fcca58-718e6299191so2435771b3a.2 for <73530@debbugs.gnu.org>; Mon, 30 Sep 2024 10:30:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1727717370; x=1728322170; 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=c1b/PdYIy8QVxUO9EyQEXyukKmKkH/0Q3rPafjy2tS0=; b=XX/ymjz9IJ1NYQz0Hhi9hO+AmDYFpa2KE5AG2sc+M0pp23/crLW43iUpW7zOVqWALq 7sWNvX71Pg/kC1EkUQPOaDXZGg7ZWiwBLwMJZpmZtSETIU1uQowyQ5NkxpYvL27zX0qS vyWGtdUArr3aFPIhlrbGbJbnCYw4+/zkM8X7wLVd6EQGVo51Of4nzWlbijjifGXZ5sMo 6nePj6SkIWzJxhh4fW0WuBSmUCExfWI4xcCWoA6DbSTGeWoVFe2c98bz0ZslPwPwDjyT 7a0zjz3YGYRhGiiiJqQc9nfyUNgoPAf8aCLSQynOqE2s/HocEfoqW0OezcRJMUs02OM0 xVGQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727717370; x=1728322170; 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=c1b/PdYIy8QVxUO9EyQEXyukKmKkH/0Q3rPafjy2tS0=; b=Olj3WJELtF1XZRxKcQ96AfZ0J+rpQnD+lscVU9SOameRPV7k+fEmm3ERY+p62PCNFU Ov3aJXHXPWkVWUndGqOgnrJgfWHfOXNoosaHqIePl5O/UPajoMxuc4MfEz3Jl6lm7ou5 gRQQ8n3iouooO2BSMPYnf+15AWf0xEH9L51lW8Lk/6MmUFVR3C5fgb/cF6Cbta+tEh6g PHrOSfGT2xUdejXR52+MerYgNNVZccCqjZW2TqIGrhYRV8joXrJwSNCH+CsTfX1D3a74 kzAGt44VHvyr+/oZEatKDKVtmZAkHcbeW3vE6PSvRcOxdrnbEApEc6LlPlVLJFGLPvPo dsfA== X-Forwarded-Encrypted: i=1; AJvYcCWPk5V3D0n2wcWctpr9uYlMLfVhXMISqGzxf1leQ7W3kAjttY3H+qLQ39kLV6/vlwlwenVGrg==@debbugs.gnu.org X-Gm-Message-State: AOJu0YwYKz698A0q0tgXXabKkcamFYoC2RcVbZ4wmSb+7icOtcKeyiJJ eoJAyUYP9pPIrtkerLewuu2apTIt2JnLe0B4wD+XIJCfKxHy2w8b X-Google-Smtp-Source: AGHT+IENLx+bxecGlBgqTcOT2m3Qx8YxRKLVKpCcCdinWm0TzxDJNpEeHAk2CTvs59wi80UOE26F+w== X-Received: by 2002:a05:6a00:4f84:b0:714:1bcf:3d93 with SMTP id d2e1a72fcca58-71b25f28701mr18201888b3a.5.1727717370008; Mon, 30 Sep 2024 10:29:30 -0700 (PDT) Original-Received: from localhost ([1.7.159.70]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7e6db2c8007sm6805709a12.51.2024.09.30.10.29.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Sep 2024 10:29:29 -0700 (PDT) In-Reply-To: (Tassilo Horn's message of "Sun, 29 Sep 2024 19:15:25 +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:292732 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9E=E0=AE=BE=E0=AE=AF=E0=AE=BF=E0=AE=B1=E0=AF=81 =E0=AE=9A=E0=AF=86= =E0=AE=AA=E0=AF=8D=E0=AE=9F=E0=AE=AE=E0=AF=8D=E0=AE=AA=E0=AE=B0=E0=AF=8D 29= , 2024] Tassilo Horn wrote: > Am So, 29. Sep 2024, um 18:38, schrieb Visuwesh: >> [=E0=AE=9E=E0=AE=BE=E0=AE=AF=E0=AE=BF=E0=AE=B1=E0=AF=81 =E0=AE=9A=E0=AF= =86=E0=AE=AA=E0=AF=8D=E0=AE=9F=E0=AE=AE=E0=AF=8D=E0=AE=AA=E0=AE=B0=E0=AF=8D= 29, 2024] Tassilo Horn wrote: >> >>>> Imenu calls the index function only when it finds that the index >>>> hasn't been created yet so we can rely on that mechanism instead. >>>> This would be simpler than using an idle timer. WDYT? >>> >>> Then let's do it the simple way and then test how long the index >>> building actually takes on reasonable large PDFs/DjVu files. >> >> OK, I will send an updated patch in a few days. > > Great, thank you!=20 Please review the attached. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-imenu-index-function-for-Djvu-files-in-doc-view.patch >From 8ccfe9440363569d6624153177d724bbcf2a122f Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Sat, 28 Sep 2024 20:37:50 +0530 Subject: [PATCH] Add imenu index function for Djvu files in doc-view * lisp/doc-view.el (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 | 15 +++---- etc/NEWS | 7 ++++ lisp/doc-view.el | 99 ++++++++++++++++++++++++++++++++++++++------- 3 files changed, 98 insertions(+), 23 deletions(-) diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index e19e554fb26..332d5b1468f 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -581,17 +581,14 @@ 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}. + 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}. @findex doc-view-page-to-register @findex doc-view-jump-to-register diff --git a/etc/NEWS b/etc/NEWS index 607665a71bb..b6035e13639 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -268,6 +268,13 @@ Docview can store current page to buffer local registers with the new command 'doc-view-page-to-register' (bound to 'm'), and later 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 395993e6263..1c8bcaee2f1 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el @@ -29,6 +29,8 @@ ;; and OXPS documents require `mutool' which comes with mupdf ;; (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 files when available. ;;; Commentary: @@ -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. @@ -1953,7 +1968,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. @@ -1968,6 +1985,7 @@ doc-view--pdf-outline (fn (expand-file-name fn))) (with-temp-buffer (unless (eql 0 (call-process "mutool" 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) @@ -1978,6 +1996,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. @@ -2010,19 +2064,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 --=-=-=--