;; Copyright (C) 2006, 2012-2014 Free Software Foundation, Inc.
-;; Version: 1.3
+;; Version: 1.5
;; Keywords: large files, utilities
;; Maintainer: Andrey Kotlarski <m00naticus@gmail.com>
;; Authors: 2006 Mathias Dahl <mathias.dahl@gmail.com>
;;; Commentary:
;; This package provides the M-x vlf command, which visits part of
-;; large file without loading it entirely.
-;; The buffer uses VLF mode, which provides several commands for
-;; moving around, searching and editing selected part of file.
+;; large file without loading it entirely. The buffer uses VLF mode,
+;; which provides several commands for moving around, searching,
+;; comparing and editing selected part of file.
;; To have it offered when opening large files:
;; (require 'vlf-integrate)
;;; Code:
+(defgroup vlf nil "View Large Files in Emacs."
+ :prefix "vlf-" :group 'files)
+
+(defcustom vlf-before-batch-functions nil
+ "Hook that runs before multiple batch operations.
+One argument is supplied that specifies current action. Possible
+values are: `write', `ediff', `occur', `search', `goto-line'."
+ :group 'vlf :type 'hook)
+
+(defcustom vlf-after-batch-functions nil
+ "Hook that runs after multiple batch operations.
+One argument is supplied that specifies current action. Possible
+values are: `write', `ediff', `occur', `search', `goto-line'."
+ :group 'vlf :type 'hook)
+
(require 'vlf-base)
-(autoload 'vlf-write "vlf-write" "Write current chunk to file.")
+(autoload 'vlf-write "vlf-write" "Write current chunk to file." t)
(autoload 'vlf-re-search-forward "vlf-search"
- "Search forward for REGEXP prefix COUNT number of times.")
+ "Search forward for REGEXP prefix COUNT number of times." t)
(autoload 'vlf-re-search-backward "vlf-search"
- "Search backward for REGEXP prefix COUNT number of times.")
-(autoload 'vlf-goto-line "vlf-search" "Go to line.")
+ "Search backward for REGEXP prefix COUNT number of times." t)
+(autoload 'vlf-goto-line "vlf-search" "Go to line." t)
(autoload 'vlf-occur "vlf-occur"
- "Make whole file occur style index for REGEXP.")
+ "Make whole file occur style index for REGEXP." t)
(autoload 'vlf-toggle-follow "vlf-follow"
- "Toggle continuous chunk recenter around current point.")
-(autoload 'vlf-stop-follow "vlf-follow"
- "Stop continuous recenter.")
+ "Toggle continuous chunk recenter around current point." t)
+(autoload 'vlf-stop-follow "vlf-follow" "Stop continuous recenter." t)
+(autoload 'vlf-ediff-buffers "vlf-ediff"
+ "Run batch by batch ediff over VLF buffers." t)
(defvar vlf-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "]" 'vlf-end-of-file)
(define-key map "j" 'vlf-jump-to-chunk)
(define-key map "l" 'vlf-goto-line)
+ (define-key map "e" 'vlf-ediff-buffers)
(define-key map "f" 'vlf-toggle-follow)
(define-key map "g" 'vlf-revert)
map)
(define-minor-mode vlf-mode
"Mode to browse large files in."
- :lighter " VLF"
- :group 'vlf
- :keymap vlf-prefix-map
- (if vlf-mode
- (progn
- (set (make-local-variable 'require-final-newline) nil)
- (add-hook 'write-file-functions 'vlf-write nil t)
- (set (make-local-variable 'revert-buffer-function)
- 'vlf-revert)
- (make-local-variable 'vlf-batch-size)
- (setq vlf-file-size (vlf-get-file-size buffer-file-truename)
- vlf-start-pos 0
- vlf-end-pos 0)
- (let* ((pos (position-bytes (point)))
- (start (* (/ pos vlf-batch-size) vlf-batch-size)))
- (goto-char (byte-to-position (- pos start)))
- (vlf-move-to-batch start)))
- (kill-local-variable 'revert-buffer-function)
- (vlf-stop-follow)
- (when (or (not large-file-warning-threshold)
- (< vlf-file-size large-file-warning-threshold)
- (y-or-n-p (format "Load whole file (%s)? "
- (file-size-human-readable
- vlf-file-size))))
- (kill-local-variable 'require-final-newline)
- (remove-hook 'write-file-functions 'vlf-write t)
- (let ((pos (+ vlf-start-pos (position-bytes (point)))))
- (vlf-with-undo-disabled
- (insert-file-contents buffer-file-name t nil nil t))
- (goto-char (byte-to-position pos)))
- (rename-buffer (file-name-nondirectory buffer-file-name) t))))
+ :lighter " VLF" :group 'vlf :keymap vlf-prefix-map
+ (cond (vlf-mode
+ (set (make-local-variable 'require-final-newline) nil)
+ (add-hook 'write-file-functions 'vlf-write nil t)
+ (set (make-local-variable 'revert-buffer-function)
+ 'vlf-revert)
+ (make-local-variable 'vlf-batch-size)
+ (setq vlf-file-size (vlf-get-file-size buffer-file-truename)
+ vlf-start-pos 0
+ vlf-end-pos 0)
+ (let* ((pos (position-bytes (point)))
+ (start (* (/ pos vlf-batch-size) vlf-batch-size)))
+ (goto-char (byte-to-position (- pos start)))
+ (vlf-move-to-batch start))
+ (add-hook 'after-change-major-mode-hook 'vlf-keep-alive t t)
+ (vlf-keep-alive))
+ ((or (not large-file-warning-threshold)
+ (< vlf-file-size large-file-warning-threshold)
+ (y-or-n-p (format "Load whole file (%s)? "
+ (file-size-human-readable
+ vlf-file-size))))
+ (kill-local-variable 'revert-buffer-function)
+ (vlf-stop-follow)
+ (kill-local-variable 'require-final-newline)
+ (remove-hook 'write-file-functions 'vlf-write t)
+ (remove-hook 'after-change-major-mode-hook
+ 'vlf-keep-alive t)
+ (let ((hexl (derived-mode-p 'hexl-mode)))
+ (if hexl (hexl-mode-exit))
+ (let ((pos (+ vlf-start-pos (position-bytes (point)))))
+ (vlf-with-undo-disabled
+ (insert-file-contents buffer-file-name t nil nil t))
+ (goto-char (byte-to-position pos)))
+ (if hexl (hexl-mode)))
+ (rename-buffer (file-name-nondirectory buffer-file-name) t))
+ (t (setq vlf-mode t))))
+
+(defun vlf-keep-alive ()
+ "Keep `vlf-mode' on major mode change."
+ (if (derived-mode-p 'hexl-mode)
+ (set (make-local-variable 'revert-buffer-function) 'vlf-revert))
+ (setq vlf-mode t))
;;;###autoload
(defun vlf (file)
"View Large FILE in batches.
You can customize number of bytes displayed by customizing
-`vlf-batch-size'."
+`vlf-batch-size'.
+Return newly created buffer."
(interactive "fFile to open: ")
(let ((vlf-buffer (generate-new-buffer "*vlf*")))
(set-buffer vlf-buffer)
(goto-char (point-max)))
ad-do-it))
+;; hexl mode integration
+(defun vlf-hexl-before (&optional operation)
+ "Temporarily disable `hexl-mode' for OPERATION."
+ (when (derived-mode-p 'hexl-mode)
+ (hexl-mode-exit)
+ (set (make-local-variable 'vlf-restore-hexl-mode) operation)))
+
+(defun vlf-hexl-after (&optional operation)
+ "Re-enable `hexl-mode' if active before OPERATION."
+ (when (and (boundp 'vlf-restore-hexl-mode)
+ (eq vlf-restore-hexl-mode operation))
+ (hexl-mode)
+ (kill-local-variable 'vlf-restore-hexl-mode)))
+
+(add-hook 'vlf-before-batch-functions 'vlf-hexl-before)
+(add-hook 'vlf-after-batch-functions 'vlf-hexl-after)
+(add-hook 'vlf-before-chunk-update 'vlf-hexl-before)
+(add-hook 'vlf-after-chunk-update 'vlf-hexl-after)
+
+(eval-after-load "hexl"
+ '(progn
+ (defadvice hexl-save-buffer (around vlf-hexl-save
+ activate compile)
+ "Prevent hexl save if `vlf-mode' is active."
+ (if vlf-mode
+ (vlf-write)
+ ad-do-it))
+
+ (defadvice hexl-scroll-up (around vlf-hexl-scroll-up
+ activate compile)
+ "Slide to next batch if at end of buffer in `vlf-mode'."
+ (if (and vlf-mode (pos-visible-in-window-p (point-max))
+ (or (not (numberp arg)) (< 0 arg)))
+ (progn (vlf-next-batch 1)
+ (goto-char (point-min)))
+ ad-do-it))
+
+ (defadvice hexl-scroll-down (around vlf-hexl-scroll-down
+ activate compile)
+ "Slide to previous batch if at beginning of buffer in `vlf-mode'."
+ (if (and vlf-mode (pos-visible-in-window-p (point-min)))
+ (progn (vlf-prev-batch 1)
+ (goto-char (point-max)))
+ ad-do-it))))
+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; utilities
Normally, the value is doubled;
with the prefix argument DECREASE it is halved."
(interactive "P")
- (setq vlf-batch-size (if decrease
- (/ vlf-batch-size 2)
- (* vlf-batch-size 2)))
+ (vlf-set-batch-size (if decrease (/ vlf-batch-size 2)
+ (* vlf-batch-size 2))))
+
+(defun vlf-set-batch-size (size)
+ "Set batch to SIZE bytes and update chunk."
+ (interactive (list (read-number "Size in bytes: " vlf-batch-size)))
+ (setq vlf-batch-size size)
(vlf-move-to-batch vlf-start-pos))
(defun vlf-beginning-of-file ()
(defun vlf-end-of-file ()
"Jump to end of file content."
(interactive)
+ (vlf-verify-size)
(vlf-move-to-batch vlf-file-size))
(defun vlf-revert (&optional _ignore-auto noconfirm)