elisp/geiser-log.el

   1 ;; geiser-log.el -- logging utilities
   2
   3 ;; Copyright (C) 2009, 2010 Jose Antonio Ortega Ruiz
   4
   5 ;; This program is free software; you can redistribute it and/or
   6 ;; modify it under the terms of the Modified BSD License. You should
   7 ;; have received a copy of the license along with this program. If
   8 ;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
   9
  10 ;; Start date: Sat Feb 07, 2009 12:07
  11
  12 \f
  13
  14 ;; Some utilities for maintaining a simple log buffer, mainly for
  15 ;; debugging purposes.
  16
  17 (require 'geiser-popup)
  18 (require 'geiser-base)
  19
  20 (require 'comint)
  21
  22 \f
  23 ;;; Customization:
  24
  25 (defvar geiser-log--buffer-name "*geiser messages*"
  26   "Name of the Geiser log buffer.")
  27
  28 (defvar geiser-log--max-buffer-size 32000
  29   "Maximum size of the Geiser messages log.")
  30
  31 (defvar geiser-log--max-message-size 2048
  32   "Maximum size of individual Geiser log messages.")
  33
  34 (defvar geiser-log-verbose-p nil
  35   "Log purely informational messages. Useful for debugging.")
  36
  37 (defvar geiser-log--inhibit-p nil
  38   "Set this to t to inhibit all log messages")
  39
  40 \f
  41 ;;; Log buffer and mode:
  42
  43 (define-derived-mode geiser-messages-mode fundamental-mode "Geiser Messages"
  44   "Simple mode for Geiser log messages buffer."
  45   (kill-all-local-variables)
  46   (buffer-disable-undo)
  47   (set (make-local-variable 'comint-redirect-subvert-readonly) t)
  48   (add-hook 'after-change-functions
  49             '(lambda (b e len)
  50                (let ((inhibit-read-only t))
  51                  (when (> b geiser-log--max-buffer-size)
  52                    (delete-region (point-min) b))))
  53             nil t)
  54   (setq buffer-read-only t))
  55
  56 (geiser-popup--define log geiser-log--buffer-name geiser-messages-mode)
  57
  58 \f
  59 ;;; Logging functions:
  60
  61 (defun geiser-log--msg (type &rest args)
  62   (unless geiser-log--inhibit-p
  63     (geiser-log--with-buffer
  64       (goto-char (point-max))
  65       (insert (geiser--shorten-str (format "\n%s: %s\n" type
  66                                            (apply 'format args))
  67                                    geiser-log--max-message-size)))))
  68
  69 (defsubst geiser-log--warn (&rest args)
  70   (apply 'geiser-log--msg 'WARNING args))
  71
  72 (defsubst geiser-log--error (&rest args)
  73   (apply 'geiser-log--msg 'ERROR args))
  74
  75 (defsubst geiser-log--info (&rest args)
  76   (when geiser-log-verbose-p
  77     (apply 'geiser-log--msg 'INFO args) ""))
  78
  79 \f
  80 ;;; User commands:
  81
  82 (defun geiser-show-logs (&optional arg)
  83   "Show Geiser log messages.
  84 With prefix, activates all logging levels."
  85   (interactive "P")
  86   (when arg (setq geiser-log-verbose-p t))
  87   (geiser-log--pop-to-buffer))
  88
  89 (defun geiser-log-clear ()
  90   "Clean all logs."
  91   (interactive)
  92   (geiser-log--with-buffer (delete-region (point-min) (point-max))))
  93
  94 \f
  95 (provide 'geiser-log)
  96 ;;; geiser-log.el ends here