Emacs: Hervorhebung TODO * nur * in Kommentaren

Question

Diese Frage steht im Zusammenhang mit einer anderen, Emacs :TODO indicator at left side. Ich bin kürzlich auf einen kleinen Modus gestoßen, den ich sehr gerne FixmeMode nenne. Es unterstützt die automatische Markierung von TODO Marken und die Navigation zwischen ihnen. Ich denke jedoch, dass es sinnvoller ist, die "TODO" -Strings nur in Kommentaren zu erkennen, anstatt die gesamte Datei zu verschmutzen. Ist es möglich?

Answer 1

Schauen Sie sich die Bibliothek fic-mode.el, wurde in C++ und Emacs-Lisp verifiziert.

Es wurde speziell zur Beantwortung dieser Frage geschrieben.

Die Installation ist wie jedes Standard-Paket:

(require 'fic-mode) 
(add-hook 'c++-mode-hook 'turn-on-fic-mode) 

Obwohl Wei Hu hat für eine einfache Möglichkeit zu bitten, es zu mehreren Modi hinzuzufügen, geht so hier:

(defun add-something-to-mode-hooks (mode-list something) 
    "helper function to add a callback to multiple hooks" 
    (dolist (mode mode-list) 
    (add-hook (intern (concat (symbol-name mode) "-mode-hook")) something))) 

(add-something-to-mode-hooks '(c++ tcl emacs-lisp) 'turn-on-fic-mode) 

Answer 2

Es ist möglich, aber ein bisschen schwieriger. Der Fixme-Modus verwendet font-lock, um seine Hervorhebung vorzunehmen. Daher arbeitet er auf einer "as-you-type" -Basis, um die Schlüsselwörter hervorzuheben. Die Font-Lock-Funktion schaltet sich auf einem sehr niedrigen Level ein und läuft im Grunde nach jeder Änderung des Pufferinhalts. Es ist jedoch sehr optimiert, wodurch es auf modernen Computern augenblicklich erscheint.

Der TODO-Indikator im linken Rand ist statisch. Führe die Funktion aus und alle aktuellen TODOs sind hervorgehoben; Ändern Sie den Puffer (Hinzufügen oder Entfernen von TODOs) ändert nicht den Interferenzstreifen; das wird nur geändert, wenn die Funktion erneut ausgeführt wird.

Ihr Ansatz müsste in Syntaxtabellen gehen, zuerst bestimmen, wenn Sie in einem Kommentar sind und dann nach den Schlüsselwörtern suchen. Der schwierige Teil kommt dabei interaktiv (d. H. Beim Tippen). Sie sollten in der Lage sein, in die font-lock Konstrukte einhaken, um dies zu tun, aber die Funktion, die Sie für die Suche nach der Kommentarsyntaxtabelle und dann für die Schlüsselwörter bieten, ist sehr effizient, da es jedes Mal ausgeführt wird, wenn sich ein Puffer ändert es wird nur auf der veränderten Region laufen, denke ich). Sie würden das alles in font-lock-syntactic-keywords anstelle von font-lock-keywords stopfen, weil das syntaktische Schlüsselwort Pass vor dem syntaktischen Pass passiert (was passiert, bevor das Schlüsselwort pass), und Sie müssen TODO innerhalb von Kommentaren setzen, bevor Kommentare selbst gesetzt werden.

Leider ist es kein voll funktions-Code Antwort .....

Answer 3

Vielleicht wird dies helfen: es gibt eine fn c-in-literal in cc-Modus, und ein ähnliches csharp-in-literal in csharp Modus. Der Rückgabewert ist c, wenn in einem C-style-Kommentar, c++ wenn in einem C++ Stil Kommentar. Sie könnten das dem Code unter Emacs :TODO indicator at left side hinzufügen, um zu bekommen, was Sie wollen.

(defun annotate-todo() 
    "put fringe marker on TODO: lines in the curent buffer" 
    (interactive) 
    (let (lit) 
    (save-excursion 
    (goto-char (point-min)) 
    (while (re-search-forward "TODO:" nil t) 
     (progn 
     (setq lit (c-in-literal)) ;; or csharp-in-literal 
     (if (or (eq lit 'c) (eq lit 'c++)) 
      (let ((overlay (make-overlay (- (point) 5) (point)))) 
       (overlay-put overlay 'before-string 
          (propertize "A" 
             'display 
             '(left-fringe ;; right 
             horizontal-bar 
             better-fringes-important-bitmap))))))))))