diff options
author | Dave Love <fx@gnu.org> | 1999-10-23 18:18:03 +0000 |
---|---|---|
committer | Dave Love <fx@gnu.org> | 1999-10-23 18:18:03 +0000 |
commit | af372af632bb21749e858350200e13b3e9c10057 (patch) | |
tree | 3c497c15c65802c9657ebc6c7833c50685620ca2 /lisp/elide-head.el | |
parent | 6bfff0646b32006bed96d41bba6de0596263d93d (diff) | |
download | emacs-af372af632bb21749e858350200e13b3e9c10057.tar.gz |
*** empty log message ***
Diffstat (limited to 'lisp/elide-head.el')
-rw-r--r-- | lisp/elide-head.el | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/lisp/elide-head.el b/lisp/elide-head.el new file mode 100644 index 00000000000..db26eb8f9ea --- /dev/null +++ b/lisp/elide-head.el @@ -0,0 +1,116 @@ +;;; elid-head.el --- hide headers in files + +;; Copyright (C) 1999 Free Software Foundation, Inc. + +;; Author: Dave Love <fx@gnu.org> +;; Keywords: outlines tools + +;; This file is part of GNU Emacs. + +;; GNU Emacs 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 2, or (at your option) +;; any later version. + +;; GNU Emacs 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 GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. + +;;; Commentary: + +;; Functionality for eliding boilerplate text (normally copyright +;; notices) in file headers to avoid clutter when you know what it +;; says. +;; +;; `elide-head-headers-to-hide' controls what is elided by the command +;; `elide-head'. A buffer-local invisible overlay manages the +;; elision. + +;; Please don't turn this on in site init files so that information +;; isn't hidden from users who may not know what it says. + +;; Inspired by jwz's hide-copyleft.el, for which we don't have an +;; assignment. + +;;; Code: + +(defgroup elide-head nil + "Eliding copyright headers and the like in source files." + :prefix "elide-head" + :group 'tools) + +(defcustom elide-head-headers-to-hide + '(("is free software; you can redistribute it" . ; GNU boilerplate + "Boston, MA 02111-1307, USA\\.") + ("The Regents of the University of California\\. All rights reserved\\." . + "SUCH DAMAGE\\.") ; BSD + ("Permission is hereby granted, free of charge" . ; X11 + "authorization from the X Consortium\\.")) + "Alist of regexps defining start end end of text to elide. + +The cars of elements of the list are searched for in order. Text is +elided with an invisible overlay from the end of the line where the +first match is found to the end of the match for the corresponding +cdr." + :group 'elide-head + :type '(alist :key-type (string :tag "Start regexp") + :value-type (string :tag "End regexp"))) + +(defvar elide-head-overlay nil) +(make-variable-buffer-local 'elide-head-overlay) + +;;;###autoload +(defun elide-head (&optional arg) + "Hide header material in buffer according to `elide-head-headers-to-hide'. + +The header is made invisible with an overlay. With a prefix arg, show +an elided material again. + +This is suitable as an entry on `find-file-hooks' or appropriate mode hooks." + (interactive "P") + (if arg + (elide-head-show) + (save-excursion + (save-restriction + (let ((rest elide-head-headers-to-hide) + beg end) + (widen) + (goto-char (point-min)) + (while rest + (save-excursion + (when (re-search-forward (caar rest) nil t) + (setq beg (point)) + (when (re-search-forward (cdar rest) nil t) + (setq end (point) + rest nil)))) + (if rest (setq rest (cdr rest)))) + (if (not (and beg end)) + (if (interactive-p) + (error "No header found")) + (goto-char beg) + (end-of-line) + (if (overlayp elide-head-overlay) + (move-overlay elide-head-overlay (point) end) + (setq elide-head-overlay (make-overlay (point) end))) + (overlay-put elide-head-overlay 'invisible t) + (overlay-put elide-head-overlay 'intangible t) + (overlay-put elide-head-overlay 'after-string "..."))))))) + +(defun elide-head-show () + "Show a header elided current buffer by \\[elide-head]." + (interactive) + (if (and (overlayp elide-head-overlay) + (overlay-buffer elide-head-overlay)) + (delete-overlay elide-head-overlay) + (if (interactive-p) + (error "No header hidden")))) + +(provide 'elide-head) + +;;; elide-head.el ends here |