Mercurial > emacs

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lisp/emacs-lisp/syntax.el	Thu Oct 11 00:50:53 2001 +0000
@@ -0,0 +1,281 @@
+;;; syntax.el --- Helper functions to find syntactic context
+
+;; Copyright (C) 2000 Free Software Foundation, Inc.
+
+;; 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:
+
+;; The main exported function is `syntax-ppss'.  You might also need
+;; to call `syntax-ppss-after-change-function' or to add it to
+;; after-change-functions'(although this is automatically done by
+;; syntax-ppss when needed, but that might fail if syntax-ppss is
+;; called in a context where after-change-functions is temporarily
+;; let-bound to nil).
+
+;;; Todo:
+
+;; - do something about the case where the syntax-table is changed.
+;;   This typically happens with tex-mode and its `$' operator.
+;; - move font-lock-syntactic-keywords in here.  Then again, maybe not.
+;; - new functions `syntax-state', ... to replace uses of parse-partial-state
+;;   with something higher-level (similar to syntax-ppss-context).
+;; - interaction with mmm-mode.
+;; - what to do when the buffer is narrowed ?
+
+;;; Code:
+
+;; Note: PPSS stands for `parse-partial-sexp state'
+
+(eval-when-compile (require 'cl))
+
+(defsubst syntax-ppss-depth (ppss)
+  (nth 0 ppss))
+
+(defsubst syntax-ppss-context (ppss)
+  (cond
+   ((nth 3 ppss) 'string)
+   ((nth 4 ppss) 'comment)
+   (t nil)))
+
+(defvar syntax-ppss-max-span 20000
+  "Threshold below which cache info is deemed unnecessary.
+We try to make sure that cache entries are at least this far apart
+from each other, to avoid keeping too much useless info.")
+
+(defvar syntax-begin-function nil
+  "Function to move back outside of any comment/string/paren.
+This function should move the cursor back to some syntactically safe
+point (where the PPSS is equivalent to nil).")
+
+(defvar syntax-ppss-cache nil
+  "List of (POS . PPSS) pairs, in decreasing POS order.")
+(make-variable-buffer-local 'syntax-ppss-cache)
+(defvar syntax-ppss-last nil
+  "Cache of (LAST-POS . LAST-PPSS).")
+(make-variable-buffer-local 'syntax-ppss-last)
+
+(defun syntax-ppss-after-change-function (beg &rest ignored)
+  ;; Flush invalid cache entries.
+  (while (and syntax-ppss-cache (> (caar syntax-ppss-cache) beg))
+    (setq syntax-ppss-cache (cdr syntax-ppss-cache)))
+  ;; Throw away `last' value if made invalid.
+  (when (< beg (or (car syntax-ppss-last) 0))
+    (if (< beg (or (car (nth 10 syntax-ppss-last))
+		   (nth 9 syntax-ppss-last)
+		   (nth 2 syntax-ppss-last)
+		   0))
+	(setq syntax-ppss-last nil)
+      (setcar syntax-ppss-last nil)))
+  ;; Unregister if there's no cache left.  Sadly this doesn't work
+  ;; because `after-change-functions' is temporarily bound to nil here.
+  ;; (unless syntax-ppss-cache
+  ;;   (remove-hook 'after-change-functions
+  ;; 		 'syntax-ppss-after-change-function t))
+  )
+
+(defvar syntax-ppss-stats
+  [(0 . 0.0) (0 . 0.0) (0 . 0.0) (0 . 0.0) (0 . 0.0) (1 . 2500.0)])
+(defun syntax-ppss-stats ()
+  (mapcar (lambda (x) (cons (car x) (truncate (/ (cdr x) (car x)))))
+	  syntax-ppss-stats))
+
+(defun syntax-ppss (&optional pos)
+  "Parse-Partial-Sexp State at POS.
+The returned value is the same as `parse-partial-sexp' except that
+the 2nd and 6th values of the returned state cannot be relied upon.
+
+If the caller knows the PPSS of a nearby position, she can pass it
+in OLP-PPSS (with or without its corresponding OLD-POS) to try and
+avoid a more expansive scan.
+Point is at POS when this function returns."
+  ;; Default values.
+  (unless pos (setq pos (point)))
+  ;;
+  (let ((old-ppss (cdr syntax-ppss-last))
+	(old-pos (car syntax-ppss-last))
+	(ppss nil)
+	(pt-min (point-min)))
+    (if (and old-pos (> old-pos pos)) (setq old-pos nil))
+    ;; Use the OLD-POS if usable and close.  Don't update the `last' cache.
+    (if (and old-pos (< (- pos old-pos)
+			;; The time to find PPSS using syntax-begin-function
+			;; is assumed to be about 2 * distance.
+			(* 2 (/ (cdr (aref syntax-ppss-stats 5))
+				(1+ (car (aref syntax-ppss-stats 5)))))))
+	(progn
+	  (incf (car (aref syntax-ppss-stats 0)))
+	  (incf (cdr (aref syntax-ppss-stats 0)) (- pos old-pos))
+	  (parse-partial-sexp old-pos pos nil nil old-ppss))
+
+      (cond
+       ;; Use OLD-PPSS if possible and close enough.
+       ((and (not old-pos) old-ppss
+	     ;; BEWARE! We rely on the undocumented 9th field.
+	     ;; The 9th field currently contains the list of positions
+	     ;; of open-parens of the enclosing parens.  I.e.  those positions
+	     ;; are outside of any string/comment and the first of those is
+	     ;; outside of any paren (i.e. corresponds to a nil ppss).
+	     ;; If this list is empty but we are in a string or comment,
+	     ;; then the 8th field contains a similar "toplevel" position.
+	     ;; If `pt-min' is too far from `pos', we could try to use
+	     ;; other positions in (nth 9 old-ppss), but that doesn't seem
+	     ;; to happen in practice and it would complicate this code
+	     ;; (and the after-change-function code even more).  But maybe it
+	     ;; would be useful in "degenerate" cases such as when the whole
+	     ;; file is wrapped in a set of parenthesis.
+	     (setq pt-min (or (car (nth 9 old-ppss))
+			      (nth 8 old-ppss)
+			      (nth 2 old-ppss)))
+	     (<= pt-min pos) (< (- pos pt-min) syntax-ppss-max-span))
+	(incf (car (aref syntax-ppss-stats 1)))
+	(incf (cdr (aref syntax-ppss-stats 1)) (- pos pt-min))
+	(setq ppss (parse-partial-sexp pt-min pos)))
+       ;; The OLD-* data can't be used.  Consult the cache.
+       (t
+	(let ((cache-pred nil)
+	      (cache syntax-ppss-cache)
+	      (pt-min (point-min))
+	      ;; I differentiate between PT-MIN and PT-BEST because I feel
+	      ;; like it might be important to ensure that the cache is only
+	      ;; filled with 100% sure data (whereas syntax-begin-function
+	      ;; might return incorrect data).  Maybe that's just stupid.
+	      (pt-best (point-min))
+	      (ppss-best nil))
+	  ;; look for a usable cache entry.
+	  (while (and cache (< pos (caar cache)))
+	    (setq cache-pred cache)
+	    (setq cache (cdr cache)))
+	  (if cache (setq pt-min (caar cache) ppss (cdar cache)))
+
+	  ;; Setup the after-change function if necessary.
+	  (unless (or syntax-ppss-cache syntax-ppss-last)
+	    (add-hook 'after-change-functions
+		      'syntax-ppss-after-change-function nil t))
+
+	  ;; Use the best of OLD-POS and CACHE.
+	  (if (or (not old-pos) (< old-pos pt-min))
+	      (setq pt-best pt-min ppss-best ppss)
+	    (incf (car (aref syntax-ppss-stats 4)))
+	    (incf (cdr (aref syntax-ppss-stats 4)) (- pos old-pos))
+	    (setq pt-best old-pos ppss-best old-ppss))
+
+	  ;; Use the `syntax-begin-function' if available.
+	  ;; We could try using that function earlier, but:
+	  ;; - The result might not be 100% reliable, so it's better to use
+	  ;;   the cache if available.
+	  ;; - The function might be slow.
+	  ;; - If this function almost always finds a safe nearby spot,
+	  ;;   the cache won't be populated, so consulting it is cheap.
+	  (unless (or syntax-begin-function
+		      (not (boundp 'font-lock-beginning-of-syntax-function))
+		      (not font-lock-beginning-of-syntax-function))
+	    (set (make-local-variable 'syntax-begin-function)
+		 font-lock-beginning-of-syntax-function))
+	  (when (and syntax-begin-function
+		     (progn (goto-char pos)
+			    (funcall syntax-begin-function)
+			    ;; Make sure it's better.
+			    (> (point) pt-best))
+		     ;; Simple sanity check.
+		     (not (memq (get-text-property (point) 'face)
+				'(font-lock-string-face font-lock-comment-face
+				  font-lock-doc-face))))
+	    (incf (car (aref syntax-ppss-stats 5)))
+	    (incf (cdr (aref syntax-ppss-stats 5)) (- pos (point)))
+	    (setq pt-best (point) ppss-best nil))
+
+	  (cond
+	   ;; Quick case when we found a nearby pos.
+	   ((< (- pos pt-best) syntax-ppss-max-span)
+	    (incf (car (aref syntax-ppss-stats 2)))
+	    (incf (cdr (aref syntax-ppss-stats 2)) (- pos pt-best))
+	    (setq ppss (parse-partial-sexp pt-best pos nil nil ppss-best)))
+	   ;; Slow case: compute the state from some known position and
+	   ;; populate the cache so we won't need to do it again soon.
+	   (t
+	    (incf (car (aref syntax-ppss-stats 3)))
+	    (incf (cdr (aref syntax-ppss-stats 3)) (- pos pt-min))
+
+	    ;; If `pt-min' is too far, add a few intermediate entries.
+	    (while (> (- pos pt-min) (* 2 syntax-ppss-max-span))
+	      (setq ppss (parse-partial-sexp
+			  pt-min (setq pt-min (/ (+ pt-min pos) 2))
+			  nil nil ppss))
+	      (let ((pair (cons pt-min ppss)))
+		(if cache-pred
+		    (push pair (cdr cache-pred))
+		  (push pair syntax-ppss-cache))))
+
+	    ;; Compute the actual return value.
+	    (setq ppss (parse-partial-sexp pt-min pos nil nil ppss))
+
+	    ;; Debugging check.
+	    ;; (let ((real-ppss (parse-partial-sexp (point-min) pos)))
+	    ;;   (setcar (last ppss 4) 0)
+	    ;;   (setcar (last real-ppss 4) 0)
+	    ;;   (setcar (last ppss 8) nil)
+	    ;;   (setcar (last real-ppss 8) nil)
+	    ;;   (unless (equal ppss real-ppss)
+	    ;;     (message "!!Syntax: %s != %s" ppss real-ppss)
+	    ;;     (setq ppss real-ppss)))
+
+	    ;; Store it in the cache.
+	    (let ((pair (cons pos ppss)))
+	      (if cache-pred
+		  (if (> (- (caar cache-pred) pos) syntax-ppss-max-span)
+		      (push pair (cdr cache-pred))
+		    (setcar cache-pred pair))
+		(if (or (null syntax-ppss-cache)
+			(> (- (caar syntax-ppss-cache) pos)
+			   syntax-ppss-max-span))
+		    (push pair syntax-ppss-cache)
+		  (setcar syntax-ppss-cache pair)))))))))
+
+      (setq syntax-ppss-last (cons pos ppss))
+      ppss)))
+
+;; Debugging functions
+
+(defun syntax-ppss-debug ()
+  (let ((pt nil)
+	(min-diffs nil))
+    (dolist (x (append syntax-ppss-cache (list (cons (point-min) nil))))
+      (when pt (push (- pt (car x)) min-diffs))
+      (setq pt (car x)))
+    min-diffs))
+
+;; XEmacs compatibility functions
+
+;; (defun buffer-syntactic-context (&optional buffer)
+;;   "Syntactic context at point in BUFFER.
+;; Either of `string', `comment' or `nil'.
+;; This is an XEmacs compatibility function."
+;;   (with-current-buffer (or buffer (current-buffer))
+;;     (syntax-ppss-context (syntax-ppss))))
+
+;; (defun buffer-syntactic-context-depth (&optional buffer)
+;;   "Syntactic parenthesis depth at point in BUFFER.
+;; This is an XEmacs compatibility function."
+;;   (with-current-buffer (or buffer (current-buffer))
+;;     (syntax-ppss-depth (syntax-ppss))))
+
+(elp-instrument-list '(syntax-ppss))
+
+(provide 'syntax)
+;;; syntax.el ends here