;;; vlf.el --- View Large Files -*- lexical-binding: t -*-
-;; Copyright (C) 2006, 2012-2014 Free Software Foundation, Inc.
+;; Copyright (C) 2006, 2012-2015 Free Software Foundation, Inc.
-;; Version: 1.5
+;; Version: 1.7
;; Keywords: large files, utilities
;; Maintainer: Andrey Kotlarski <m00naticus@gmail.com>
;; Authors: 2006 Mathias Dahl <mathias.dahl@gmail.com>
;; 2012 Sam Steingold <sds@gnu.org>
-;; 2013-2014 Andrey Kotlarski <m00naticus@gmail.com>
+;; 2013-2015 Andrey Kotlarski <m00naticus@gmail.com>
;; URL: https://github.com/m00natic/vlfi
;; This file is free software; you can redistribute it and/or modify
;; 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)
+;; (require 'vlf-setup)
;; This package was inspired by a snippet posted by Kevin Rodgers,
;; showing how to use `insert-file-contents' to extract part of a
;;; Code:
-(defgroup vlf nil "View Large Files in Emacs."
- :prefix "vlf-" :group 'files)
+(require 'vlf-base)
(defcustom vlf-before-batch-functions nil
"Hook that runs before multiple batch operations.
values are: `write', `ediff', `occur', `search', `goto-line'."
:group 'vlf :type 'hook)
-(require 'vlf-base)
+(defvar hexl-bits)
(autoload 'vlf-write "vlf-write" "Write current chunk to file." t)
(autoload 'vlf-re-search-forward "vlf-search"
(autoload 'vlf-re-search-backward "vlf-search"
"Search backward for REGEXP prefix COUNT number of times." t)
(autoload 'vlf-goto-line "vlf-search" "Go to line." t)
+(autoload 'vlf-query-replace "vlf-search"
+ "Query replace regexp over whole file." t)
(autoload 'vlf-occur "vlf-occur"
"Make whole file occur style index for REGEXP." t)
(autoload 'vlf-toggle-follow "vlf-follow"
(vlf-change-batch-size t)))
(define-key map "s" 'vlf-re-search-forward)
(define-key map "r" 'vlf-re-search-backward)
+ (define-key map "%" 'vlf-query-replace)
(define-key map "o" 'vlf-occur)
(define-key map "[" 'vlf-beginning-of-file)
(define-key map "]" 'vlf-end-of-file)
(define-minor-mode vlf-mode
"Mode to browse large files in."
- :lighter " VLF" :group 'vlf :keymap vlf-prefix-map
+ :group 'vlf :keymap vlf-prefix-map
+ :lighter (:eval (format " VLF[%d/%d](%s)"
+ (/ vlf-end-pos vlf-batch-size)
+ (/ vlf-file-size vlf-batch-size)
+ (file-size-human-readable vlf-file-size)))
(cond (vlf-mode
(set (make-local-variable 'require-final-newline) nil)
(add-hook 'write-file-functions 'vlf-write nil t)
(remove-hook 'write-file-functions 'vlf-write t)
(remove-hook 'after-change-major-mode-hook
'vlf-keep-alive t)
- (let ((hexl (eq major-mode 'hexl-mode)))
- (if hexl (hexl-mode-exit))
- (let ((pos (+ vlf-start-pos (position-bytes (point)))))
+ (if (derived-mode-p 'hexl-mode)
+ (let ((line (/ (1+ vlf-start-pos) hexl-bits))
+ (pos (point)))
+ (if (consp buffer-undo-list)
+ (setq buffer-undo-list nil))
+ (vlf-with-undo-disabled
+ (let ((inhibit-read-only t))
+ (insert-file-contents-literally buffer-file-name
+ t nil nil t)
+ (hexlify-buffer)))
+ (set-buffer-modified-p nil)
+ (goto-char (point-min))
+ (forward-line line)
+ (forward-char pos))
+ (let ((pos (+ vlf-start-pos (position-bytes (point))))
+ (inhibit-read-only t))
(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))
+ (goto-char (byte-to-position pos)))))
(t (setq vlf-mode t))))
(defun vlf-keep-alive ()
"Keep `vlf-mode' on major mode change."
- (if (eq major-mode 'hexl-mode)
+ (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.
+(defun vlf (file &optional minimal)
+ "View Large FILE in batches. When MINIMAL load just a few bytes.
You can customize number of bytes displayed by customizing
`vlf-batch-size'.
Return newly created buffer."
- (interactive "fFile to open: ")
+ (interactive (list (read-file-name "File to open: ") nil))
(let ((vlf-buffer (generate-new-buffer "*vlf*")))
(set-buffer vlf-buffer)
(set-visited-file-name file)
(set-buffer-modified-p nil)
+ (if (or minimal (file-remote-p file))
+ (set (make-local-variable 'vlf-batch-size) 1024))
(vlf-mode 1)
+ (when minimal ;restore batch size to default value
+ (kill-local-variable 'vlf-batch-size)
+ (make-local-variable 'vlf-batch-size))
(switch-to-buffer vlf-buffer)
vlf-buffer))
append next APPEND number of batches to the existing buffer."
(interactive "p")
(vlf-verify-size)
+ (vlf-tune-load (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode)))
(let* ((end (min (+ vlf-end-pos (* vlf-batch-size (abs append)))
vlf-file-size))
(start (if (< append 0)
(interactive "p")
(if (zerop vlf-start-pos)
(error "Already at BOF"))
+ (vlf-tune-load (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode)))
(let* ((start (max 0 (- vlf-start-pos (* vlf-batch-size (abs prepend)))))
(end (if (< prepend 0)
vlf-end-pos
(goto-char (point-max)))
ad-do-it))
-;; hexl mode integration
-(defun vlf-hexl-before (&optional operation)
- "Temporarily disable `hexl-mode' for OPERATION."
- (when (eq major-mode '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)
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; hexl mode integration
(eval-after-load "hexl"
'(progn
(if (and vlf-mode (pos-visible-in-window-p (point-min)))
(progn (vlf-prev-batch 1)
(goto-char (point-max)))
+ ad-do-it))
+
+ (defadvice hexl-mode-exit (around vlf-hexl-mode-exit
+ activate compile)
+ "Exit `hexl-mode' gracefully in case `vlf-mode' is active."
+ (if (and vlf-mode (not (buffer-modified-p)))
+ (vlf-with-undo-disabled
+ (erase-buffer)
+ ad-do-it
+ (vlf-move-to-chunk-2 vlf-start-pos vlf-end-pos))
ad-do-it))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun vlf-set-batch-size (size)
"Set batch to SIZE bytes and update chunk."
- (interactive (list (read-number "Size in bytes: " vlf-batch-size)))
+ (interactive
+ (list (read-number "Size in bytes: "
+ (vlf-tune-optimal-load
+ (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode))))))
(setq vlf-batch-size size)
(vlf-move-to-batch vlf-start-pos))
(defun vlf-beginning-of-file ()
"Jump to beginning of file content."
(interactive)
+ (vlf-tune-load (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode)))
(vlf-move-to-batch 0))
(defun vlf-end-of-file ()
"Jump to end of file content."
(interactive)
(vlf-verify-size)
+ (vlf-tune-load (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode)))
(vlf-move-to-batch vlf-file-size))
-(defun vlf-revert (&optional _ignore-auto noconfirm)
- "Revert current chunk. Ignore _IGNORE-AUTO.
+(defun vlf-revert (&optional _auto noconfirm)
+ "Revert current chunk. Ignore _AUTO.
Ask for confirmation if NOCONFIRM is nil."
(interactive)
(when (or noconfirm
(defun vlf-jump-to-chunk (n)
"Go to to chunk N."
(interactive "nGoto to chunk: ")
+ (vlf-tune-load (if (derived-mode-p 'hexl-mode)
+ '(:hexl :raw)
+ '(:insert :encode)))
(vlf-move-to-batch (* (1- n) vlf-batch-size)))
(defun vlf-no-modifications ()
(error "Save or discard your changes first")
t))
-(defun vlf-move-to-batch (start &optional minimal)
+(defun vlf-move-to-batch (start)
"Move to batch determined by START.
-Adjust according to file start/end and show `vlf-batch-size' bytes.
-When given MINIMAL flag, skip non important operations."
+Adjust according to file start/end and show `vlf-batch-size' bytes."
(vlf-verify-size)
(let* ((start (max 0 start))
(end (min (+ start vlf-batch-size) vlf-file-size)))
(if (= vlf-file-size end) ; re-adjust start
(setq start (max 0 (- end vlf-batch-size))))
- (vlf-move-to-chunk start end minimal)))
+ (vlf-move-to-chunk start end)))
(defun vlf-next-batch-from-point ()
"Display batch of file data starting from current point."