misc/fuel/fuel-log.el

   1 ;;; fuel-log.el -- logging utilities
   2
   3 ;; Copyright (C) 2008 Jose Antonio Ortega Ruiz
   4 ;; See http://factorcode.org/license.txt for BSD license.
   5
   6 ;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
   7 ;; Keywords: languages, fuel, factor
   8 ;; Start date: Sun Dec 14, 2008 01:00
   9
  10 ;;; Comentary:
  11
  12 ;; Some utilities for maintaining a simple log buffer, mainly for
  13 ;; debugging purposes.
  14
  15 ;;; Code:
  16
  17 (require 'fuel-base)
  18
  19 \f
  20 ;;; Customization:
  21
  22 (defvar fuel-log--buffer-name "*fuel messages*"
  23   "Name of the log buffer")
  24
  25 (defvar fuel-log--max-buffer-size 32000
  26   "Maximum size of the Factor messages log")
  27
  28 (defvar fuel-log--max-message-size 512
  29   "Maximum size of individual log messages")
  30
  31 (defvar fuel-log--verbose-p t
  32   "Log level for Factor messages")
  33
  34 (define-derived-mode factor-messages-mode fundamental-mode "FUEL Messages"
  35   "Simple mode to log interactions with the factor listener"
  36   (kill-all-local-variables)
  37   (buffer-disable-undo)
  38   (set (make-local-variable 'comint-redirect-subvert-readonly) t)
  39   (add-hook 'after-change-functions
  40             '(lambda (b e len)
  41                (let ((inhibit-read-only t))
  42                  (when (> b fuel-log--max-buffer-size)
  43                    (delete-region (point-min) b))))
  44             nil t)
  45   (setq buffer-read-only t))
  46
  47 (defun fuel-log--buffer ()
  48   (or (get-buffer fuel-log--buffer-name)
  49       (save-current-buffer
  50         (set-buffer (get-buffer-create fuel-log--buffer-name))
  51         (factor-messages-mode)
  52         (current-buffer))))
  53
  54 (defun fuel-log--msg (type &rest args)
  55   (with-current-buffer (fuel-log--buffer)
  56     (let ((inhibit-read-only t))
  57       (insert
  58        (fuel--shorten-str (format "\n%s: %s\n" type (apply 'format args))
  59                           fuel-log--max-message-size)))))
  60
  61 (defsubst fuel-log--warn (&rest args)
  62   (apply 'fuel-log--msg 'WARNING args))
  63
  64 (defsubst fuel-log--error (&rest args)
  65   (apply 'fuel-log--msg 'ERROR args))
  66
  67 (defsubst fuel-log--info (&rest args)
  68   (if fuel-log--verbose-p (apply 'fuel-log--msg 'INFO args) ""))
  69
  70 \f
  71 (provide 'fuel-log)
  72 ;;; fuel-log.el ends here