;;; semantic-ctxt.el --- Context calculations for Semantic tools.

;;; Copyright (C) 1999, 2000, 2001, 2002 Eric M. Ludlam

;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
;; X-RCS: $Id: semantic-ctxt.el,v 1.20 2002/05/07 01:31:15 zappo Exp $

;; This file is not part of GNU Emacs.

;; Semantic 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.

;; This software 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:
;;
;; Semantic, as a tool, provides a nice list of searchable tokens.
;; That information can provide some very accurate answers if the current
;; context of a position is known.
;;
;; This library provides the hooks needed for a language to specify how
;; the current context is calculated.
;;
(require 'semantic)
(eval-when-compile (require 'semanticdb))

;;; Code:
;;
(defvar semantic-command-separation-character
 ";"
  "String which indicates the end of a command.
Used for identifying the end of a single command.")
(make-variable-buffer-local 'semantic-command-separation-character)

(defvar semantic-function-argument-separation-character
 ","
  "String which indicates the end of an argument.
Used for identifying arguments to functions.")
(make-variable-buffer-local 'semantic-function-argument-separation-character)

;;; Local variable parsing.
;;
(defun semantic-up-context (&optional point bounds-type)
  "Move point up one context from POINT.
Return non-nil if there are no more context levels.
Overloaded functions using `up-context' take no parameters.
BOUNDS-TYPE is a symbol representing a token type to restrict
movement to.  If this is nil, 'function is used.
This will find the smallest token of that type (function, variable,
type, etc) and make sure non-nil is returned if you cannot
go up past the bounds of that token."
  (if point (goto-char point))
  (let ((nar (semantic-current-nonterminal-of-type (or bounds-type 'function)))
	(s (semantic-fetch-overload 'up-context)))
    (if nar
	(semantic-with-buffer-narrowed-to-token
	    nar
	  (if s (funcall s)
	    (semantic-up-context-default)))
      (if bounds-type (error "No context of type %s to advance in" bounds-type))
      (if s (funcall s)
	(semantic-up-context-default)))))

(defun semantic-up-context-default ()
  "Move the point up and out one context level.
Works with languages that use parenthetical grouping."
  ;; By default, assume that the language uses some form of parenthetical
  ;; do dads for their context.
  (condition-case nil
      (progn
	(up-list -1)
	nil)
    (error t)))

(defun semantic-beginning-of-context (&optional point)
  "Move POINT to the beginning of the current context.
Return non-nil if there is no upper context.
The default behavior uses `semantic-up-context'.  It can
be overridden with `beginning-of-context'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'beginning-of-context)))
    (if s (funcall s)
      (semantic-beginning-of-context-default)
      )))

(defun semantic-beginning-of-context-default ()
  "Move point to the beginning of the current context via parenthisis.
Return non-nil if there is no upper context."
  (if (semantic-up-context)
      t
    (forward-char 1)
    nil))

(defun semantic-end-of-context (&optional point)
  "Move POINT to the end of the current context.
Return non-nil if there is no upper context.
Be default, this uses `semantic-up-context', and assumes parenthetical
block delimiters.  This can be overridden with `end-of-context'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'end-of-context)))
    (if s (funcall s)
      (semantic-end-of-context-default)
      )))

(defun semantic-end-of-context-default ()
  "Move point to the end of the current context via parenthisis.
Return non-nil if there is no upper context."
  (if (semantic-up-context)
      t
    ;; Go over the list, and back over the end parenthisis.
    (forward-sexp 1)
    (forward-char -1)
    nil))

(defun semantic-narrow-to-context ()
  "Narrow the buffer to the extent of the current context."
  (let (b e)
    (save-excursion
      (if (semantic-beginning-of-context)
	  nil
	(setq b (point))))
    (save-excursion
      (if (semantic-end-of-context)
	  nil
	(setq e (point))))
    (if (and b e) (narrow-to-region b e))))

(defmacro semantic-with-buffer-narrowed-to-context (&rest body)
  "Execute BODY with the buffer narrowed to the current context."
  `(save-restriction
     (semantic-narrow-to-context)
     ,@body))
(put 'semantic-with-buffer-narrowed-to-context 'lisp-indent-function 1)
(add-hook 'edebug-setup-hook
	  (lambda ()
	    (def-edebug-spec semantic-with-buffer-narrowed-to-context
	      (def-body))))

(defun semantic-get-local-variables (&optional point)
  "Get the local variables based on POINT's context.
Local variables are returned in Semantic token format.
Be default, this calculates the current bounds using context blocks
navigation, then uses the parser with `bovine-inner-scope' to
parse tokens at the beginning of the context.
This can be overriden with `get-local-variables'."
  (save-excursion
    (if point (goto-char point))
    (let ((vars
	   (let ((s (semantic-fetch-overload 'get-local-variables))
		 (case-fold-search semantic-case-fold))
	     (if s (funcall s)
	       (semantic-get-local-variables-default)
	       ))))
      (semantic-deoverlay-list vars)
      vars)))

(defun semantic-get-local-variables-default ()
  "Get local values from a specific context.
Uses the bovinator with the special top-symbol `bovine-inner-scope'
to collect tokens, such as local variables or prototypes."
  ;; The working status is to let the parser work properly
  (working-status-forms "Local" "done"
    (let ((semantic-bovination-working-type nil)
	  ;; We want nothing to do with funny syntaxing while doing this.
	  (semantic-unmatched-syntax-hook nil)
	  ;; Disable parsing messages
	  (working-status-dynamic-type nil)
	  (vars nil))
      (while (not (semantic-up-context (point) 'function))
	(save-excursion
	  (forward-char 1)
	  (setq vars
		(append (semantic-bovinate-region-until-error
			 (point)
			 (save-excursion (semantic-end-of-context) (point))
			 'bovine-inner-scope)
			vars))))
      vars)))

(defun semantic-get-local-arguments (&optional point)
  "Get arguments (variables) from the current context at POINT.
Parameters are available if the point is in a function or method.
This function returns a list of tokens.  If the local token returns
just a list of strings, then this function will convert them to tokens.
Part of this behavior can be overridden with `get-local-arguments'."
  (if point (goto-char point))
  (let* ((s (semantic-fetch-overload 'get-local-arguments))
	 (case-fold-search semantic-case-fold)
	 (params (if s (funcall s)
		   (semantic-get-local-arguments-default)))
	 (rparams nil)
         tok)
    ;; convert unsafe params to the right thing.
    (while params
      (setq tok     (car params)
            params  (cdr params)
            rparams (cons
                     (cond
                      ((semantic-token-p tok)
                       (when (semantic-overlay-p
                              (semantic-token-overlay tok))
                         ;; Return a copy of token without overlay.
                         ;; Don't use `semantic-deoverlay-token' here
                         ;; because the original overlay must be kept!
                         (setq tok (copy-sequence tok))
                         (setcar (semantic-token-overlay-cdr tok)
                                 (vector (semantic-token-start tok)
                                         (semantic-token-end tok))))
                       tok)
                      ((stringp (car params))
                       (list (car params) 'variable))
                      (t
                       (error "Unknown parameter element")))
                     rparams)))
    (nreverse rparams)))

(defun semantic-get-local-arguments-default ()
  "Get arguments (variables) from the current context.
Parameters are available if the point is in a function or method."
  (let ((tok (semantic-current-nonterminal)))
    (if (and tok (eq (semantic-token-token tok) 'function))
	(semantic-token-function-args tok))))

(defun semantic-get-all-local-variables (&optional point)
  "Get all local variables for this context, and parent contexts.
Local variables are returned in Semantic token format.
Be default, this gets local variables, and local arguments.
This can be overridden with `get-all-local-variables'.
Optional argument POINT is the location to start getting the variables from."
  (save-excursion
    (if point (goto-char point))
    (let ((s (semantic-fetch-overload 'get-all-local-variables))
	  (case-fold-search semantic-case-fold))
      (if s (funcall s)
	(semantic-get-all-local-variables-default)
	))))

(defun semantic-get-all-local-variables-default ()
  "Get all local variables for this context.
That is a cons (LOCAL-ARGUMENTS . LOCAL-VARIABLES) where:

- LOCAL-ARGUMENTS is collected by `semantic-get-local-arguments'.
- LOCAL-VARIABLES is collected by `semantic-get-local-variables'."
  (cons (semantic-get-local-arguments)
        (semantic-get-local-variables)))

;;; Local context parsing
;;
;; Context parsing assumes a series of language independent commonalities.
;; These terms are used to describe those contexts:
;;
;; command      - One command in the language.
;; symbol       - The symbol the cursor is on.
;;                This would include a series of type/field when applicable.
;; assignment   - The variable currently being assigned to
;; function     - The function call the cursor is on/in
;; argument     - The index to the argument the cursor is on.
;;
;;
(defun semantic-end-of-command ()
  "Move to the end of the current command.
Be default, uses `semantic-command-separation-character'.
Override with `end-of-command'."
  (semantic-with-buffer-narrowed-to-context
      (let ((s (semantic-fetch-overload 'end-of-command))
	    (case-fold-search semantic-case-fold))
	(if s (funcall s)
	  (semantic-end-of-command-default)
	  ))))

(defun semantic-end-of-command-default ()
  "Move to the beginning of the current command.
Depends on `semantic-command-separation-character' to find the
beginning and end of a command."
  (if (re-search-forward (regexp-quote semantic-command-separation-character)
			 nil t)
      (forward-char -1)
    ;; If there wasn't a command after this, we are the last
    ;; command, and we are incomplete.
    (goto-char (point-max))))

(defun semantic-beginning-of-command ()
  "Move to the beginning of the current command.
Be default, users `semantic-command-separation-character'.
Override with `beginning-of-command'."
  (semantic-with-buffer-narrowed-to-context
      (let ((s (semantic-fetch-overload 'beginning-of-command))
	    (case-fold-search semantic-case-fold))
	(if s (funcall s)
	  (semantic-beginning-of-command-default)
	  ))))

(defun semantic-beginning-of-command-default ()
  "Move to the beginning of the current command.
Depends on `semantic-command-separation-character' to find the
beginning and end of a command."
  (skip-chars-backward semantic-command-separation-character)
  (if (re-search-backward (regexp-quote semantic-command-separation-character)
			  nil t)
      (goto-char (match-end 0))
    ;; If there wasn't a command after this, we are the last
    ;; command, and we are incomplete.
    (goto-char (point-min)))
  (skip-chars-forward " \t\n")
  )


(defsubst semantic-point-at-beginning-of-command ()
  "Return the point at the beginning of the current command."
  (save-excursion (semantic-beginning-of-command) (point)))

(defsubst semantic-point-at-end-of-command ()
  "Return the point at the beginning of the current command."
  (save-excursion (semantic-end-of-command) (point)))

(defsubst semantic-narrow-to-command ()
  "Narrow the current buffer to the current command."
  (narrow-to-region (semantic-point-at-beginning-of-command)
		    (semantic-point-at-end-of-command)))

(defmacro semantic-with-buffer-narrowed-to-command (&rest body)
  "Execute BODY with the buffer narrowed to the current command."
  `(save-restriction
     (semantic-narrow-to-command)
     ,@body))
(put 'semantic-with-buffer-narrowed-to-command 'lisp-indent-function 1)
(add-hook 'edebug-setup-hook
	  (lambda ()
	    (def-edebug-spec semantic-with-buffer-narrowed-to-command
	      (def-body))))


(defun semantic-ctxt-current-symbol (&optional point)
  "Return the current symbol the cursor is on at POINT in a list.
This will include a list of type/field names when applicable.
This can be overridden using `ctxt-current-symbol'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'ctxt-current-symbol))
	(case-fold-search semantic-case-fold))
    (if s (funcall s)
      (semantic-ctxt-current-symbol-default)
      )))

(defun semantic-ctxt-current-symbol-default ()
  "Return the current symbol the cursor is on at POINT in a list.
This will include a list of type/field names when applicable.
Depends on `semantic-type-relation-separator-character'."
  (let* ((fieldsep1 (mapconcat (lambda (a) (regexp-quote a))
			       semantic-type-relation-separator-character
			       "\\|"))
	 (fieldsep (concat "\\(" fieldsep1 "\\)\\(\\w\\|\\s_\\)"))
	 (symlist nil)
	 end)
    (save-excursion
      (if (looking-at "\\w\\|\\s_")
	  (forward-sexp 1)
	;; Not on a sym, are we at a separator char with no field
	;; specified yet?
	(when (or (looking-at fieldsep1)
		  (save-excursion
		    (and (condition-case nil
			     (progn (forward-sexp -1)
				    (forward-sexp 1)
				    t)
			   (error nil))
			 (looking-at fieldsep1))))
	  (setq symlist (list ""))
	  (forward-sexp -1)
	  (forward-sexp 1)))
      (setq end (point))
      (condition-case nil
	  (while (save-excursion
		   (forward-char -1)
		   (looking-at "\\w\\|\\s_"))
	    ;; We have a symbol.. Do symbol things
	    (forward-sexp -1)
	    (setq symlist (cons (buffer-substring-no-properties (point) end)
				symlist))
	    ;; Skip the next syntactic expression backwards, then go forwards.
	    (let ((cp (point)))
	      (forward-sexp -1)
	      (forward-sexp 1)
	      ;; If we end up at the same place we started, we are at the
	      ;; beginning of a buffer, or narrowed to a command and
	      ;; have to stop.
	      (if (<= cp (point)) (error nil)))
	    (if (looking-at fieldsep)
		(setq end (point))
	      (error nil))
	    )
	(error nil)))
    symlist))

(defun semantic-ctxt-current-assignment (&optional point)
  "Return the current assignment near the cursor at POINT.
Return a list as per `semantic-ctxt-current-symbol'.
Return nil if there is nothing relevant.
Override with `ctxt-current-assignment'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'ctxt-current-assignment))
	(case-fold-search semantic-case-fold))
    (if s (funcall s)
      (semantic-ctxt-current-assignment-default)
      )))

(defun semantic-ctxt-current-assignment-default ()
  "Return the current assignment near the cursor at POINT.
By default, assume that \"=\" indicates an assignment."
  (condition-case nil
      (semantic-with-buffer-narrowed-to-command
	  (save-excursion
	    (skip-chars-forward " \t=")
	    (condition-case nil (forward-char 1) (error nil))
	    (re-search-backward "[^=]=\\([^=]\\|$\\)")
	    ;; We are at an equals sign.  Go backwards a sexp, and
	    ;; we'll have the variable.  Otherwise we threw an error
	    (forward-sexp -1)
	    (semantic-ctxt-current-symbol)))
    (error nil)))

(defun semantic-ctxt-current-function (&optional point)
  "Return the current function the cursor is in at POINT.
The function returned is the one accepting the arguments that
the cursor is currently in.  It will not return function symbol if the
cursor is on the text representing that function.
This can be overridden with `ctxt-current-function'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'ctxt-current-function))
	(case-fold-search semantic-case-fold))
    (if s (funcall s)
      (semantic-ctxt-current-function-default)
      )))

(defun semantic-ctxt-current-function-default ()
  "Default function for `semantic-ctxt-current-function'."
  (save-excursion
    (semantic-up-context)
    (when (looking-at "(")
      (semantic-ctxt-current-symbol)))
  )

(defun semantic-ctxt-current-argument (&optional point)
  "Return the index of the argument position the cursor is on at POINT.
Override with `ctxt-current-argument'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'ctxt-current-argument))
	(case-fold-search semantic-case-fold))
    (if s (funcall s)
      (semantic-ctxt-current-argument-default)
      )))

 (defun semantic-ctxt-current-argument-default ()
  "Return the index of the argument the cursor is on.
Depends on `semantic-function-argument-separation-character'."
  (when (semantic-ctxt-current-function)
    (save-excursion
      ;; Only get the current arg index if we are in function args.
      (let ((p (point))
	    (idx 1))
	(semantic-up-context)
	(while (re-search-forward
		(regexp-quote semantic-function-argument-separation-character)
		p t)
	  (setq idx (1+ idx)))
	idx))))

(defun semantic-ctxt-scoped-types (&optional point)
  "Return a list of type names currently in scope at POINT.
Override with `ctxt-scoped-types'."
  (if point (goto-char point))
  (let ((s (semantic-fetch-overload 'ctxt-scoped-types))
	(case-fold-search semantic-case-fold))
    (if s (funcall s)
      (semantic-ctxt-scoped-types-default)
      )))

(defun semantic-ctxt-scoped-types-default ()
  "Return a list of scoped types by name for the current context.
This is very different for various languages, and does nothing unless
overriden."
  nil)

(provide 'semantic-ctxt)

;;; semantic-ctxt.el ends here