diff options
Diffstat (limited to 'apt-sources.el')
| -rw-r--r-- | apt-sources.el | 411 |
1 files changed, 411 insertions, 0 deletions
diff --git a/apt-sources.el b/apt-sources.el new file mode 100644 index 0000000..d3c1d4b --- /dev/null +++ b/apt-sources.el @@ -0,0 +1,411 @@ +;;; apt-sources.el --- Mode for editing apt source.list file +;; +;; Time-stamp: "2002-07-16 18:18:08 drs" +;; Version: 0.9.5 +;; $Revision: +;; $Id: +;; $Source: + +;; Author: Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx> +;; Mantainer: Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx> + +;; Copyright (C) 2001-2002, Dr. Rafael Sepúlveda <drs@gnulinux.org.mx> + +;; This program 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. + +;; This program 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 this program; if not, write to the Free Software Foundation, +;; Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. + +;;; Commentary: + +;; This mode is for editing '/etc/apt/sources.list', the APT (Advanced +;; Package Tool) configuration file found on Debian systems starting +;; with Debian 2.0 'slink'. This mode font-locks the file and add some +;; things including new source lines and modifying existing source +;; lines. +;; +;; This mode can be costumized in diferent parts. You can (interactively) +;; change if you want blank lines around a new source line and comment +;; with `apt-sources-around-lines'. Also you can change the way that +;; this mode names each source line, with variable`apt-sources-source-name'; +;; if no name is entered, no commente name will be inserted. +;; +;; You can modify existing parts of the source line; check the mode +;; documentation for mor details. Another thing that this mode can do is to +;; replicate an existing line (`C-c C-r') that will be changed to the 'deb' or +;; 'deb-src' corresponding line. If it replicates a 'deb' line, an identical +;; 'deb-src' source line will be created. +;; +;; To load this mode, because it is very file specific, is recomended to be +;; loaded with variables at the end of the file. This variables can be inserted +;; with `C-c C-v' after you change the file's mode to 'apt-sources'. +;; +;; You can always find the latest version of this mode on +;; 'http://www.gnulinux.org.mx/~drs/emacs/apt-sources.el' + +;;; TODO: + +;;; History: + +;; 0.9.5 -- Fixed typo in docstring of function `apt-sources-around-lines'. +;; -- Rewrite function `apt-sources-around-lines' with a better algorithm. +;; (John Paul Wallington <jpw@shootybangbang.com>) +;; -- Added a description to apt and sources.list +;; (David Combs <dkcombs@panix.com>) +;; -- Added name and email from contributors. :) +;; (Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx>) +;; 0.9.4 -- Added a missing option in function `apt-sources-insert-source' to +;; select 'ftp' type. +;; -- Added URI-type 'https'. +;; -- Fix some function's documentation mistakes. +;; (Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx>) +;; 0.9.3 -- Fix a recently introduced bug that prevents keybindings work under +;; Xemacs. +;; (John Paul Wallington <jpw@shootybangbang.com>) +;; 0.9.2 -- Fix a bug with a keybinding that called a function with another name. +;; -- Make variable `comment-start' buffer-local. +;; -- Change the keybinding zone to be more compact and portable. +;; (John Paul Wallington <jpw@shootybangbang.com>) +;; -- Change some keybindings. +;; (Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx>) +;; +;; 0.9.1 -- Corrected a bug in the 'cond' clauses that prevented to byte-compile. +;; (Perkens-Golomb, Burkhard <burkhard.perkens-golomb@sdm.de>)' +;; -- Make variable `comment-start-skip' buffer-local. +;; (Stefan Monnier <monnier+gnu.emacs.sources/news/@flint.cs.yale.edu>) +;; 0.9 -- first release. +;; (Dr. Rafael Sepúlveda. <drs@gnulinux.org.mx>) + +;;; Code: + +(require 'autoinsert) + +(defvar apt-sources-mode-hook nil + "*Hook for customising apt-sources mode.") + +(defvar apt-sources-load-hook nil + "*Hook run when the `apt-sources-mode' is loaded.") + +(defvar apt-sources-around-lines t + "Put blank lines around the inserted source lines. +This variable can be changed by function `apt-sources-around-lines'") + +(defvar apt-sources-source-name "##\n## %s\n##\n\n" + "Format used in the name of a new source line. +This line is inserted by `apt-source-insert-source' function. You can +use ANSI quoting as described in the info elisp manual, chapter +'Character Type'. The '%s' is where the name of the source line will be +inserted.") + + +;;Regexps for identifying source line parts for font-lock. +(defvar apt-sources-font-lock-deb-regexp "\\(deb \\|deb-src \\)" + "A regexp that matches 'deb' or 'deb-src' at the begining of line.") + +(defvar apt-sources-font-lock-uri-regexp + "\\([^ ]*\\)" + "A regexp that matches the URI part of the source line.") + +(defvar apt-sources-font-lock-distribution-regexp + "\\( [^ \n]*\\)" + "A regexp that matches the distribution name part of the source line.") + + +(defvar apt-sources-font-lock-keywords + (list + ;; Comments + '("^#.*$" . font-lock-comment-face) + ;; sources.list lines: + ;; deb http://http.us.debian.org/debian unstable main contrib + (cons + (concat "^" + apt-sources-font-lock-deb-regexp + apt-sources-font-lock-uri-regexp + apt-sources-font-lock-distribution-regexp + "\\(.*\\)$") + '( + (1 font-lock-constant-face) + (2 font-lock-variable-name-face) + (3 font-lock-type-face) + (4 font-lock-keyword-face)))) + "Info for function `font-lock-mode'.") + + + +(defvar apt-sources-mode-map nil + "Keymap used in apt-sources mode.") + +(unless apt-sources-mode-map + (let ((map (make-sparse-keymap))) + (define-key map (kbd "C-c C-i") 'apt-sources-insert-source) + (define-key map (kbd "C-c C-l") 'apt-sources-around-lines) + (define-key map (kbd "C-c C-v") 'apt-sources-insert-local-var) + (define-key map (kbd "C-c C-r") 'apt-sources-deb-or-src-replicate) + + (define-key map (kbd "C-c C-s") 'apt-sources-change-source-type) + (define-key map (kbd "C-c C-t") 'apt-sources-change-uri-type) + (define-key map (kbd "C-c C-a") 'apt-sources-change-uri-address) + (define-key map (kbd "C-c C-d") 'apt-sources-change-distribution) + (define-key map (kbd "C-c C-c") 'apt-sources-change-components) + + (define-key map (kbd "C-c C-n") 'apt-sources-next-source-line) + (define-key map (kbd "C-c C-p") 'apt-sources-previous-source-line) + (setq apt-sources-mode-map map))) + + + +;;;###autoload +(defun apt-sources-mode () + "Major mode for editing apt's sources.list file. +Sets up command `font-lock-mode'. + +\\{apt-sources-mode-map}" + (interactive) + ;; + (kill-all-local-variables) + (setq mode-name "apt-sources") + (setq major-mode 'apt-sources-mode) + (use-local-map apt-sources-mode-map) + ;; + (set (make-local-variable 'comment-start) "#") + (set (make-local-variable 'comment-start-skip) "#+ *") + ;; + (make-local-variable 'font-lock-defaults) + (setq font-lock-defaults '(apt-sources-font-lock-keywords)) + ;; + (run-hooks 'apt-sources-mode-hook)) + + + +(defun apt-sources-insert-source (name type uri-type uri-address distribution &rest components) + "Insert interactively a source line into the current buffer. +This will insert a source line in the current line. + +The variables used by the function are: +NAME is the name you want to this source line; it will be a comment. + If no NAME is entered, only the line will be inserted. +TYPE is one of 'd' or 's' that equal to 'deb' or 'deb-src'. +URI-TYPE is the type used to retrieve the URI; like http, ftp, etc. +URI-ADDRESS is the URI that will be used to specify the base of the + Debian distribution, from which APT will find the information it + needs. +DISTRIBUTION is used for specific arquitecture or an exact path. +COMPONENTS are a list of components used by APT. + +You should read sources.list documentation for further explanation." + (interactive "*sName: \nc'deb' or 'deb-src' type (d, s): \n\ +cURI type 'file', 'cdrom', 'http', 'https', 'ftp', 'copy', 'rsh', 'ssh' \ +(f, c, p, s, t, o, r, h): \nsURI address: \nsDistribution: \nsComponents: ") + (let ((real-type (if (char-equal type ?d) + "deb" + "deb-src")) + (real-uri-type (cond ((char-equal uri-type ?f) "file:/") + ((char-equal uri-type ?c) "cdrom://") + ((char-equal uri-type ?s) "https://") + ((char-equal uri-type ?t) "ftp://") + ((char-equal uri-type ?o) "copy://") + ((char-equal uri-type ?r) "rsh://") + ((char-equal uri-type ?h) "ssh://") + (t "http://"))) + (blank-line (if apt-sources-around-lines "\n" ""))) + + (save-excursion + (beginning-of-line) + (insert blank-line) ;insert line if `apt-sources-around-lines' + (and (< 0 (length name)) + (insert (format apt-sources-source-name name))) + (insert ;insert rest of arguments except components + (format "%s %s%s %s" real-type real-uri-type uri-address distribution)) + + ;if `distribution' ends in '/', then don't process components. + (if (string-match "/$" distribution) + distribution + (insert " ") + (while components ;insert all components + (insert (format "%s" (car components))) + (setq components (cdr components))) + (insert blank-line))))) ;insert line if `apt-sources-around-lines' + + +(defun apt-sources-around-lines () + "Toggle insertion of newlines around a future creation of source lines. +This modifies the state of variable `apt-sources-around-lines'." + (interactive) + (setq apt-sources-around-lines (not apt-sources-around-lines)) + (message "Surrounding blank lines %s" + (if apt-sources-around-lines "On" "Off"))) + + +(defun apt-sources-insert-local-var () + "Insert the current values of buffer local variables." + (interactive) + (end-of-buffer) + (and (not (bolp)) + (insert "\n")) ;insert a newline if the file doesn't end in a blank line. + (insert "\n" + comment-start " Local " "Variables:\n" + comment-start " mode: " (format "%s\n" (or mode-name "apt-sources")) + comment-start " End:\n")) + + +(defun apt-sources-next-source-line (arg) + "Go to the next source line. + +ARG is the prefix argument." + (interactive "p") + (let ((source-line-search (if (> arg 0) + (progn + (end-of-line) + 're-search-forward) + 're-search-backward))) + (and (apply source-line-search + '("^\\(deb \\|deb-src \\)" nil)) + (beginning-of-line)))) + + +(defun apt-sources-previous-source-line () + "Go to the previous source line." + (interactive) + (apt-sources-next-source-line -1)) + + +;;Modifying functions +(defun apt-sources-source-line-p () + "Return t if we are in an apt source line." + (save-excursion + (if (progn (beginning-of-line) + (re-search-forward "^deb[^ ]*" (line-end-position) t 1)) + t ;return t if we are in an apt source line + (message "Not in a source line!") + nil))) ;return nil if we aren't in an apt source line + + +(defun apt-sources-change-source-type (type) + "Change the type of the source line. +TYPE is either 'd' or 's' to change the type to 'deb' or 'deb-src'. + +This function will rise an error if we are not in a source line." + (interactive "c'deb' or 'deb-src' type (d, s): ") + + (save-excursion + (and (apt-sources-source-line-p) + (let ((new-type (if (char-equal type ?d) + "deb" + "deb-src"))) + (beginning-of-line) + (delete-region (point) (re-search-forward "^deb[^ ]*" (line-end-position) nil 1)) + (insert new-type))))) + + +(defun apt-sources-change-uri-type (uri-type) + "Change the URI type of the source line. +URI-TYPE can be 'file', 'cdrom', 'http', 'ftp', 'copy', 'rsh' or 'ssh' + (f, c, h, t, o, r, s) respectively. + +This function will rise an error if we are not in a source line." + (interactive "cURI-type 'file', 'cdrom', 'http', 'https', 'ftp', 'copy', \ +'rsh', 'ssh' (f, c, p, s, t, o, r, h): ") + + (save-excursion + (and (apt-sources-source-line-p) + (let ((new-uri-type + (cond ((char-equal uri-type ?f) "file:/") + ((char-equal uri-type ?c) "cdrom://") + ((char-equal uri-type ?s) "https://") + ((char-equal uri-type ?t) "ftp://") + ((char-equal uri-type ?o) "copy://") + ((char-equal uri-type ?r) "rsh://") + ((char-equal uri-type ?h) "ssh://") + (t "http://")))) + (beginning-of-line) + (delete-region (re-search-forward "^deb[^ ]*." (line-end-position) nil 1) + (re-search-forward ":/*" (line-end-position) nil 1)) + (insert new-uri-type))))) + + +(defun apt-sources-change-uri-address (uri-address) + "Change the URI address of the source line. +String URI-ADDRESS is the address (without the type of address, +ex: 'http://'). + +This function will rise an error if we are not in a source line." + (interactive "sURI address: ") + + (save-excursion + (and (apt-sources-source-line-p) + (progn + (beginning-of-line) + (delete-region (re-search-forward ":/*" (line-end-position) nil 1) + (re-search-forward "[^ ]*" (line-end-position) nil 1)) + (insert uri-address))))) + + +(defun apt-sources-change-distribution (distribution) + "Change the distribution of the source line. +String DISTRIBUTION is the distribution to be used by APT. + +This function will rise an error if we are not in a source line." + (interactive "sDistribution: ") + + (save-excursion + (and (apt-sources-source-line-p) + (progn + (beginning-of-line) + (delete-region (re-search-forward ":/*[^ ]*." (line-end-position) t 1) + (re-search-forward "[^ ]*" (line-end-position) t 1)) + (insert distribution))))) + + +(defun apt-sources-change-components (&rest components) + "Change the components of the source line. +String COMPONENTS are the components to be used by APT. + +This function will rise an error if we are not in a source line." + (interactive "sComponents: ") + + (save-excursion + (and (apt-sources-source-line-p) + (progn + (beginning-of-line) + (delete-region (re-search-forward ":/*[^ ]* [^ ]*." (line-end-position) t 1) + (line-end-position)) + (while components ;insert all components + (insert (format "%s" (car components))) + (setq components (cdr components))))))) + + +(defun apt-sources-deb-or-src-replicate () + "Copy the source line and change the 'deb' to 'deb-src' or viceversa. + +This function will rise an error if we are not on a source line." + (interactive) + + (save-excursion + (and (apt-sources-source-line-p) + (let ((copy (buffer-substring (line-beginning-position) + (line-end-position)))) + (end-of-line) + (insert (concat "\n" copy)) + (beginning-of-line) + (if (re-search-forward "^deb " (line-end-position) t 1) + (progn + (backward-char) + (insert "-src")) + (delete-region (line-beginning-position) + (re-search-forward "^deb[^ ]*" (line-end-position) t 1)) + (insert "deb")))))) + + + +(provide 'apt-sources) +(run-hooks 'apt-sources-load-hook) + +;;; apt-sources.el ends here |