;;; soar.el --- Soar code editing commands for Emacs ;; Copyright (C) 1994, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. ;; Maintainer: FSF ;; Author: Tom Tromey ;; Chris Lindblad ;; Keywords: languages soar modes ;; Version: $Revision: 1.2 $ ;; 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. ;; BEFORE USE: ;; ;; If you plan to use the interface to the SoarX help files, you must ;; set the variable soar-help-directory-list to point to the topmost ;; directories containing the SoarX help files. Eg: ;; ;; (setq soar-help-directory-list '("/usr/local/lib/soarx/help")) ;; ;;; Commentary: ;; CUSTOMIZATION NOTES: ;; * soar-proc-list can be used to customize a list of things that ;; "define" other things. Eg in my project I put "defvar" in this ;; list. ;; * soar-typeword-list is similar, but uses font-lock-type-face. ;; * soar-keyword-list is a list of keywords. I've generally used this ;; for flow-control words. Eg I add "unwind_protect" to this list. ;; * soar-type-alist can be used to minimally customize indentation ;; according to context. ;; THANKS FOR CRITICISM AND SUGGESTIONS TO: ;; Guido Bosch ;; pgs1002@esc.cam.ac.uk (Dr P.G. Sjoerdsma) ;; Mike Scheidler ;; Matt Newman ;; rwhitby@research.canon.oz.au (Rod Whitby) ;; h9118101@hkuxa.hku.hk (Yip Chi Lap [Beta]) ;; Pertti Tapio Kasanen ;; schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid) ;; warsaw@nlm.nih.gov (Barry A. Warsaw) ;; Carl Witty ;; T. V. Raman ;; Jesper Pedersen ;; dfarmer@evolving.com (Doug Farmer) ;; "Chris Alfeld" ;; Ben Wing ;; KNOWN BUGS: ;; * In Soar "#" is not always a comment character. This can confuse soar.el ;; in certain circumstances. For now the only workaround is to use ;; font-lock which will mark the # chars accordingly or enclose offending ;; hash characters in quotes or precede them with a backslash. Note that ;; using braces won't work -- quotes change the syntax class of characters ;; between them, while braces do not. If you don't use font-lock, the ;; electric-# mode helps alleviate this problem somewhat. ;; * indent-soar-exp is untested. ;; TODO: ;; * make add-log-soar-defun smarter. should notice if we are in the ;; middle of a defun, or between defuns. should notice if point is ;; on first line of defun (or maybe even in comments before defun). ;; * Allow continuation lines to be indented under the first argument ;; of the preceding line, like this: ;; [list something \ ;; something-else] ;; * There is a request that indentation work like this: ;; button .fred -label Fred \ ;; -command {puts fred} ;; * Should have soar-complete-symbol that queries the inferior process. ;; * Should have describe-symbol that works by sending the magic ;; command to a soarX process. ;; * Need C-x C-e binding (soar-eval-last-exp). ;; * Write indent-region function that is faster than indenting each ;; line individually. ;; * soar-figure-type should stop at "beginning of line" (only ws ;; before point, and no "\" on previous line). (see soar-real-command-p). ;; * overrides some comint keybindings; fix. ;; * Trailing \ will eat blank lines. Should deal with this. ;; (this would help catch some potential bugs). ;; * Inferior should display in half the screen, not the whole screen. ;; * Indentation should deal with "switch". ;; * Consider writing code to find help files automatically (for ;; common cases). ;; * `#' shouldn't insert `\#' when point is in string. ;;; Code: (eval-when-compile (require 'imenu) (require 'outline) (require 'dabbrev) (require 'add-log)) (require 'comint) ;; ;; User variables. ;; (defgroup soar nil "Major mode for editing Soar source in Emacs" :group 'languages) (defcustom soar-indent-level 4 "*Indentation of Soar statements with respect to containing block." :group 'soar :type 'integer) (defcustom soar-continued-indent-level 4 "*Indentation of continuation line relative to first line of command." :group 'soar :type 'integer) (defcustom soar-auto-newline nil "*Non-nil means automatically newline before and after braces you insert." :group 'soar :type 'boolean) (defcustom soar-tab-always-indent t "*Control effect of TAB key. If t (the default), always indent current line. If nil and point is not in the indentation area at the beginning of the line, a TAB is inserted. Other values cause the first possible action from the following list to take place: 1. Move from beginning of line to correct indentation. 2. Delete an empty comment. 3. Move forward to start of comment, indenting if necessary. 4. Move forward to end of line, indenting if necessary. 5. Create an empty comment. 6. Move backward to start of comment, indenting if necessary." :group 'soar :type '(choice (const :tag "Always" t) (const :tag "Beginning only" nil) (const :tag "Maybe move or make or delete comment" 'soar))) (defcustom soar-electric-hash-style nil ;; 'smart "*Style of electric hash insertion to use. Possible values are `backslash', meaning that `\\' quoting should be done; `quote', meaning that `\"' quoting should be done; `smart', meaning that the choice between `backslash' and `quote' should be made depending on the number of hashes inserted; or nil, meaning that no quoting should be done. Any other value for this variable is taken to mean `smart'. The default is nil." :group 'soar :type '(choice (const backslash) (const quote) (const smart) (const nil))) (defcustom soar-help-directory-list nil "*List of topmost directories containing SoarX help files." :group 'soar :type '(repeat directory)) (defcustom soar-use-smart-word-finder t "*If not nil, use smart way to find current word, for Soar help feature." :group 'soar :type 'boolean) (defcustom soar-application "wish" "*Name of Soar program to run in inferior Soar mode." :group 'soar :type 'string) (defcustom soar-command-switches nil "*List of switches to supply to the `soar-application' program." :group 'soar :type '(repeat string)) (defcustom soar-prompt-regexp "^\\(% \\|\\)" "*If not nil, a regexp that will match the prompt in the inferior process. If nil, the prompt is the name of the application with \">\" appended. The default is \"^\\(% \\|\\)\", which will match the default primary and secondary prompts for soarsh and wish." :group 'soar :type 'regexp) (defcustom inferior-soar-source-command "source %s\n" "*Format-string for building a Soar command to load a file. This format string should use `%s' to substitute a file name and should result in a Soar expression that will command the inferior Soar to load that file. The filename will be appropriately quoted for Soar." :group 'soar :type 'string) ;; ;; Keymaps, abbrevs, syntax tables. ;; (defvar soar-mode-map (let ((map (make-sparse-keymap))) (define-key map "{" 'soar-electric-char) (define-key map "}" 'soar-electric-brace) (define-key map "[" 'soar-electric-char) (define-key map "]" 'soar-electric-char) (define-key map ";" 'soar-electric-char) (define-key map "#" 'soar-electric-hash) ;Remove? -stef (define-key map "\e\C-q" 'soar-indent-exp) (define-key map "\177" 'backward-delete-char-untabify) (define-key map "\t" 'soar-indent-command) (define-key map "\M-\C-x" 'soar-eval-defun) (define-key map "\C-c\C-i" 'soar-help-on-word) (define-key map "\C-c\C-v" 'soar-eval-defun) (define-key map "\C-c\C-f" 'soar-load-file) (define-key map "\C-c\C-t" 'inferior-soar) (define-key map "\C-c\C-x" 'soar-eval-region) (define-key map "\C-c\C-s" 'switch-to-soar) map) "Keymap used in `soar-mode'.") (defvar soar-mode-syntax-table (let ((st (make-syntax-table))) (modify-syntax-entry ?% "_" st) (modify-syntax-entry ?@ "_" st) (modify-syntax-entry ?& "_" st) (modify-syntax-entry ?* "_" st) (modify-syntax-entry ?+ "_" st) (modify-syntax-entry ?- "_" st) (modify-syntax-entry ?. "_" st) (modify-syntax-entry ?: "_" st) (modify-syntax-entry ?! "_" st) (modify-syntax-entry ?$ "_" st) ; FIXME use "'"? (modify-syntax-entry ?/ "_" st) (modify-syntax-entry ?~ "_" st) (modify-syntax-entry ?< "_" st) (modify-syntax-entry ?= "_" st) (modify-syntax-entry ?> "_" st) (modify-syntax-entry ?| "_" st) (modify-syntax-entry ?\( "()" st) (modify-syntax-entry ?\) ")(" st) (modify-syntax-entry ?\; "." st) (modify-syntax-entry ?\n ">" st) ;; (modify-syntax-entry ?\f ">" st) (modify-syntax-entry ?# "<" st) st) "Syntax table in use in `soar-mode' buffers.") (defvar inferior-soar-mode-map ;; FIXME we override comint keybindings here. ;; Maybe someone has a better set? (let ((map (make-sparse-keymap))) ;; Will inherit from `comint-mode-map' thanks to define-derived-mode. (define-key map "\t" 'comint-dynamic-complete) (define-key map "\M-?" 'comint-dynamic-list-filename-completions) (define-key map "\177" 'backward-delete-char-untabify) (define-key map "\M-\C-x" 'soar-eval-defun) (define-key map "\C-c\C-i" 'soar-help-on-word) (define-key map "\C-c\C-v" 'soar-eval-defun) (define-key map "\C-c\C-f" 'soar-load-file) (define-key map "\C-c\C-t" 'inferior-soar) (define-key map "\C-c\C-x" 'soar-eval-region) (define-key map "\C-c\C-s" 'switch-to-soar) (define-key map "\C-c\C-n" 'soar-run-decision) map) "Keymap used in `inferior-soar-mode'.") (easy-menu-define soar-mode-menu soar-mode-map "Menu used in `soar-mode'." '("Soar" ["Beginning of function" beginning-of-defun t] ["End of function" end-of-defun t] ["Mark function" mark-defun t] ["Indent region" indent-region (mark t)] ["Comment region" comment-region (mark t)] ["Uncomment region" uncomment-region (mark t)] "----" ["Show Soar process buffer" inferior-soar t] ["Send function to Soar process" soar-eval-defun (and inferior-soar-buffer (get-buffer inferior-soar-buffer))] ["Send region to Soar process" soar-eval-region (and inferior-soar-buffer (get-buffer inferior-soar-buffer))] ["Send file to Soar process" soar-load-file (and inferior-soar-buffer (get-buffer inferior-soar-buffer))] ["Restart Soar process with file" soar-restart-with-file t] "----" ["Soar help" soar-help-on-word soar-help-directory-list])) (defvar inferior-soar-buffer nil "*The current inferior-soar process buffer. MULTIPLE PROCESS SUPPORT =========================================================================== To run multiple Soar processes, you start the first up with \\[inferior-soar]. It will be in a buffer named `*inferior-soar*'. Rename this buffer with \\[rename-buffer]. You may now start up a new process with another \\[inferior-soar]. It will be in a new buffer, named `*inferior-soar*'. You can switch between the different process buffers with \\[switch-to-buffer]. Commands that send text from source buffers to Soar processes -- like `soar-eval-defun' or `soar-load-file' -- have to choose a process to send to, when you have more than one Soar process around. This is determined by the global variable `inferior-soar-buffer'. Suppose you have three inferior Lisps running: Buffer Process foo inferior-soar bar inferior-soar<2> *inferior-soar* inferior-soar<3> If you do a \\[soar-eval-defun] command on some Lisp source code, what process do you send it to? - If you're in a process buffer (foo, bar, or *inferior-soar*), you send it to that process. - If you're in some other buffer (e.g., a source file), you send it to the process attached to buffer `inferior-soar-buffer'. This process selection is performed by function `inferior-soar-proc'. Whenever \\[inferior-soar] fires up a new process, it resets `inferior-soar-buffer' to be the new process's buffer. If you only run one process, this does the right thing. If you run multiple processes, you can change `inferior-soar-buffer' to another process buffer with \\[set-variable].") ;; ;; Hooks and other customization. ;; (defvar soar-mode-hook nil "Hook run on entry to Soar mode. Several functions exist which are useful to run from your `soar-mode-hook' (see each function's documentation for more information): `soar-guess-application' Guesses a default setting for `soar-application' based on any \"#!\" line at the top of the file. `soar-hashify-buffer' Quotes all \"#\" characters that don't correspond to actual Soar comments. (Useful when editing code not originally created with this mode). `soar-auto-fill-mode' Auto-filling of Soar comments. Add functions to the hook with `add-hook': (add-hook 'soar-mode-hook 'soar-guess-application)") (defvar soar-proc-list '("sp" "method" "isoar_class" "body" "configbody" "class") "List of commands whose first argument defines something. This exists because some people (eg, me) use `defvar' et al. Call `soar-set-proc-regexp' and `soar-set-font-lock-keywords' after changing this list.") (defvar soar-proc-regexp nil "Regexp to use when matching proc headers.") (defvar soar-rule-regexp nil "Regexp to use when matching rules.") (defvar soar-typeword-list '("global" "upvar" "inherit" "public" "protected" "private" "common" "itk_option" "variable") "List of Soar keywords denoting \"type\". Used only for highlighting. Call `soar-set-font-lock-keywords' after changing this list.") ;; Generally I've picked control operators to be keywords. (defvar soar-keyword-list '("if" "then" "else" "elseif" "for" "foreach" "break" "continue" "while" "eval" "case" "in" "switch" "default" "exit" "error" "proc" "return" "sp" "uplevel" "constructor" "destructor" "isoar_class" "loop" "for_array_keys" "for_recursive_glob" "for_file" "method" "body" "configbody" "class" "chain") "List of Soar keywords. Used only for highlighting. Default list includes some SoarX keywords. Call `soar-set-font-lock-keywords' after changing this list.") (defvar soar-font-lock-keywords nil "Keywords to highlight for Soar. See variable `font-lock-keywords'. This variable is generally set from `soar-proc-regexp', `soar-typeword-list', and `soar-keyword-list' by the function `soar-set-font-lock-keywords'.") (defvar soar-font-lock-syntactic-keywords ;; Mark the few `#' that are not comment-markers. '(("[^;[{ \t\n][ \t]*\\(#\\)" (1 "."))) "Syntactic keywords for `soar-mode'.") ;; FIXME need some way to recognize variables because array refs look ;; like 2 sexps. (defvar soar-type-alist '(("sp" nil soar-expr soar-rule-body) ("proc" nil soar-expr soar-commands) ("method" nil soar-expr soar-commands) ("destructor" soar-commands) ("constructor" soar-commands) ("expr" soar-expr) ("catch" soar-commands) ("if" soar-expr "then" soar-commands) ("elseif" soar-expr "then" soar-commands) ("elseif" soar-expr soar-commands) ("if" soar-expr soar-commands) ("while" soar-expr soar-commands) ("for" soar-commands soar-expr soar-commands soar-commands) ("foreach" nil nil soar-commands) ("for_file" nil nil soar-commands) ("for_array_keys" nil nil soar-commands) ("for_recursive_glob" nil nil nil soar-commands) ;; Loop handling is not perfect, because the third argument can be ;; either a command or an expr, and there is no real way to look ;; forward. ("loop" nil soar-expr soar-expr soar-commands) ("loop" nil soar-expr soar-commands)) "Alist that controls indentation. \(Actually, this really only controls what happens on continuation lines). Each entry looks like `(KEYWORD TYPE ...)'. Each type entry describes a sexp after the keyword, and can be one of: * nil, meaning that this sexp has no particular type. * soar-expr, meaning that this sexp is an arithmetic expression. * soar-commands, meaning that this sexp holds Soar commands. * soar-rule-body, meaning that this sexp is a Soar rule body. * a string, which must exactly match the string at the corresponding position for a match to be made. For example, the entry for the \"loop\" command is: (\"loop\" nil soar-expr soar-commands) This means that the \"loop\" command has three arguments. The first argument is ignored (for indentation purposes). The second argument is a Soar expression, and the last argument is Soar commands.") (defvar soar-explain-indentation nil "If not `nil', debugging message will be printed during indentation.") ;; Its pretty bogus to have to do this, but there is no easier way to ;; say "match not syntax-1 and not syntax-2". Too bad you can't put ;; \s in [...]. This sickness is used in Emacs 19 to match a defun ;; starter. (It is used for this in v18 as well). ;;(defconst soar-omit-ws-regexp ;; (concat "^\\(\\s" ;; (mapconcat 'char-to-string "w_.()\"\\$'/" "\\|\\s") ;; "\\)\\S(*") ;; "Regular expression that matches everything except space, comment ;;starter, and comment ender syntax codes.") ;; FIXME? Instead of using the hairy regexp above, we just use a ;; simple one. ;;(defconst soar-omit-ws-regexp "^[^] \t\n#}]\\S(*" ;; "Regular expression used in locating function definitions.") ;; Here's another stab. I think this one actually works. Now the ;; problem seems to be that there is a bug in Emacs 19.22 where ;; end-of-defun doesn't really use the brace matching the one that ;; trails defun-prompt-regexp. ;; ?? Is there a bug now ?? (defconst soar-omit-ws-regexp "^[^ \t\n#}][^\n}]+}*[ \t]+") ;; ;; Some helper functions. ;; (defun soar-set-proc-regexp () "Set `soar-proc-regexp' from variable `soar-proc-list'." (setq soar-proc-regexp (concat "^\\s-*" (regexp-opt soar-proc-list t) "[ \t]+"))) (defun soar-set-rule-regexp () "Set `soar-rule-regexp'." (setq soar-rule-regexp (concat "^\\s-*" (regexp-opt '("sp") t) "[ \t{\"]+"))) (defun soar-set-font-lock-keywords () "Set `soar-font-lock-keywords'. Uses variables `soar-proc-regexp' and `soar-keyword-list'." (setq soar-font-lock-keywords (list ;; Names of rules (list (concat soar-rule-regexp "\\([^ \t\n]+\\)") 2 'font-lock-function-name-face) ;; Names of functions (and other "defining things"). (list (concat soar-proc-regexp "\\([^ \t\n]+\\)") 2 'font-lock-function-name-face) ;; Names of type-defining things. (list (concat "\\(\\s-\\|^\\)" (regexp-opt soar-typeword-list t) "\\(\\s-\\|$\\)") 2 'font-lock-type-face) ;; Variables (should qualify to be inside rules...) (list "\\(<[^ \t>]+>\\)" 1 'font-lock-variable-name-face) ;; Keywords. Only recognized if surrounded by whitespace. ;; FIXME consider using "not word or symbol", not ;; "whitespace". (cons (concat "\\(\\s-\\|^\\)" ;; FIXME Use regexp-quote? (regexp-opt soar-keyword-list t) "\\(\\s-\\|$\\)") 2)))) (if soar-proc-regexp () (soar-set-proc-regexp)) (if soar-rule-regexp () (soar-set-rule-regexp)) (if soar-font-lock-keywords () (soar-set-font-lock-keywords)) (defvar soar-imenu-generic-expression `((nil ,(concat soar-proc-regexp "\\([-A-Za-z0-9_:+*]+\\)") 2)) "Imenu generic expression for `soar-mode'. See `imenu-generic-expression'.") ;; ;; The mode itself. ;; ;;;###autoload (define-derived-mode soar-mode nil "Soar" "Major mode for editing Soar code. Expression and list commands understand all Soar brackets. Tab indents for Soar code. Paragraphs are separated by blank lines only. Delete converts tabs to spaces as it moves back. Variables controlling indentation style: `soar-indent-level' Indentation of Soar statements within surrounding block. `soar-continued-indent-level' Indentation of continuation line relative to first line of command. Variables controlling user interaction with mode (see variable documentation for details): `soar-tab-always-indent' Controls action of TAB key. `soar-auto-newline' Non-nil means automatically newline before and after braces, brackets, and semicolons inserted in Soar code. `soar-use-smart-word-finder' If not nil, use a smarter, Soar-specific way to find the current word when looking up help on a Soar command. Turning on Soar mode calls the value of the variable `soar-mode-hook' with no args, if that value is non-nil. Read the documentation for `soar-mode-hook' to see what kinds of interesting hook functions already exist. Commands: \\{soar-mode-map}" (set (make-local-variable 'paragraph-start) "$\\| ") (set (make-local-variable 'paragraph-separate) paragraph-start) (unless (and (boundp 'filladapt-mode) filladapt-mode) (set (make-local-variable 'paragraph-ignore-fill-prefix) t) (set (make-local-variable 'fill-paragraph-function) 'soar-do-fill-paragraph)) (set (make-local-variable 'indent-line-function) 'soar-indent-line) (set (make-local-variable 'comment-indent-function) 'soar-comment-indent) ;; Soar doesn't require a final newline. ;; (make-local-variable 'require-final-newline) ;; (setq require-final-newline t) (set (make-local-variable 'comment-start) "# ") (set (make-local-variable 'comment-start-skip) "#+ *") (set (make-local-variable 'comment-column) 40) ;why? -stef (set (make-local-variable 'comment-end) "") (set (make-local-variable 'outline-regexp) "[^\n\^M]") (set (make-local-variable 'outline-level) 'soar-outline-level) (set (make-local-variable 'font-lock-defaults) '(soar-font-lock-keywords nil nil nil beginning-of-defun (font-lock-syntactic-keywords . soar-font-lock-syntactic-keywords) (parse-sexp-lookup-properties . t))) (set (make-local-variable 'imenu-generic-expression) 'soar-imenu-generic-expression) ;; Settings for new dabbrev code. (set (make-local-variable 'dabbrev-case-fold-search) nil) (set (make-local-variable 'dabbrev-case-replace) nil) (set (make-local-variable 'dabbrev-abbrev-skip-leading-regexp) "[$!]") (set (make-local-variable 'dabbrev-abbrev-char-regexp) "\\sw\\|\\s_") ;; This can only be set to t in Emacs 19 and XEmacs. ;; Emacs 18 and Epoch lose. (set (make-local-variable 'parse-sexp-ignore-comments) t) ;; XEmacs has defun-prompt-regexp, but I don't believe ;; that it works for end-of-defun -- only for ;; beginning-of-defun. (set (make-local-variable 'defun-prompt-regexp) soar-omit-ws-regexp) ;; The following doesn't work in Lucid Emacs 19.6, but maybe ;; it will appear in later versions. (set (make-local-variable 'add-log-current-defun-function) 'soar-add-log-defun) (easy-menu-add soar-mode-menu) ;; Append Soar menu to popup menu for XEmacs. (if (boundp 'mode-popup-menu) (setq mode-popup-menu (cons (concat mode-name " Mode Commands") soar-mode-menu)))) ;; This is used for braces, brackets, and semi (except for closing ;; braces, which are handled specially). (defun soar-electric-char (arg) "Insert character and correct line's indentation." (interactive "p") ;; Indent line first; this looks better if parens blink. (soar-indent-line) (self-insert-command arg) (if (and soar-auto-newline (= last-command-char ?\;)) (progn (newline) (soar-indent-line)))) ;; This is used for closing braces. If soar-auto-newline is set, can ;; insert a newline both before and after the brace, depending on ;; context. FIXME should this be configurable? Does anyone use this? (defun soar-electric-brace (arg) "Insert character and correct line's indentation." (interactive "p") ;; If auto-newlining and there is stuff on the same line, insert a ;; newline first. (if soar-auto-newline (progn (if (save-excursion (skip-chars-backward " \t") (bolp)) () (soar-indent-line) (newline)) ;; In auto-newline case, must insert a newline after each ;; brace. So an explicit loop is needed. (while (> arg 0) (insert last-command-char) (soar-indent-line) (newline) (setq arg (1- arg)))) (self-insert-command arg)) (soar-indent-line)) (defun soar-indent-command (&optional arg) "Indent current line as Soar code, or in some cases insert a tab character. If `soar-tab-always-indent' is t (the default), always indent current line. If `soar-tab-always-indent' is nil and point is not in the indentation area at the beginning of the line, a TAB is inserted. Other values of `soar-tab-always-indent' cause the first possible action from the following list to take place: 1. Move from beginning of line to correct indentation. 2. Delete an empty comment. 3. Move forward to start of comment, indenting if necessary. 4. Move forward to end of line, indenting if necessary. 5. Create an empty comment. 6. Move backward to start of comment, indenting if necessary." (interactive "p") (cond ((not soar-tab-always-indent) ;; Indent if in indentation area, otherwise insert TAB. (if (<= (current-column) (current-indentation)) (soar-indent-line) (insert-tab arg))) ((eq soar-tab-always-indent t) ;; Always indent. (soar-indent-line)) (t ;; "Perl-mode" style TAB command. (let* ((ipoint (point)) (eolpoint (progn (end-of-line) (point))) (comment-p (soar-in-comment))) (cond ((= ipoint (line-beginning-position)) (beginning-of-line) (soar-indent-line) ;; If indenting didn't leave us in column 0, go to the ;; indentation. Otherwise leave point at end of line. This ;; is a hack. (if (= (point) (line-beginning-position)) (end-of-line) (back-to-indentation))) ((and comment-p (looking-at "[ \t]*$")) ;; Empty comment, so delete it. We also delete any ";" ;; characters at the end of the line. I think this is ;; friendlier, but I don't know how other people will feel. (backward-char) (skip-chars-backward " \t;") (delete-region (point) eolpoint)) ((and comment-p (< ipoint (point))) ;; Before comment, so skip to it. (soar-indent-line) (indent-for-comment)) ((/= ipoint eolpoint) ;; Go to end of line (since we're not there yet). (goto-char eolpoint) (soar-indent-line)) ((not comment-p) (soar-indent-line) (comment-indent)) (t ;; Go to start of comment. We don't leave point where it is ;; because we want to skip comment-start-skip. (soar-indent-line) (indent-for-comment))))))) (defun soar-indent-line () "Indent current line as Soar code. Return the amount the indentation changed by." (let ((indent (soar-calculate-indent nil)) beg shift-amt (case-fold-search nil) (pos (- (point-max) (point)))) (beginning-of-line) (setq beg (point)) (cond ((eq indent nil) (setq indent (current-indentation))) (t (skip-chars-forward " \t") (if (listp indent) (setq indent (car indent))) (cond ((= (following-char) ?}) (setq indent (- indent soar-indent-level))) ((= (following-char) ?\]) (setq indent (- indent 1)))))) (skip-chars-forward " \t") (setq shift-amt (- indent (current-column))) (if (zerop shift-amt) (if (> (- (point-max) pos) (point)) (goto-char (- (point-max) pos))) (delete-region beg (point)) (indent-to indent) ;; If initial point was within line's indentation, ;; position after the indentation. Else stay at same point in text. (if (> (- (point-max) pos) (point)) (goto-char (- (point-max) pos)))) shift-amt)) (defun soar-figure-type () "Determine type of sexp at point. This is either `soar-expr', `soar-commands', `soar-rule-body', or nil. Puts point at start of sexp that indicates types. See documentation for variable `soar-type-alist' for more information." (let ((count 0) result word-stack) (while (and (< count 5) (not result)) (condition-case nil (progn ;; FIXME should use "soar-backward-sexp", which would skip ;; over entire variables, etc. (backward-sexp) (if (looking-at "[a-zA-Z_]+") (let ((list soar-type-alist) entry) (setq word-stack (cons (soar-word-no-props) word-stack)) (while (and list (not result)) (setq entry (car list)) (setq list (cdr list)) (let ((index 0)) (while (and entry (<= index count)) ;; Abort loop if string does not match word on ;; stack. (and (stringp (car entry)) (not (string= (car entry) (nth index word-stack))) (setq entry nil)) (setq entry (cdr entry)) (setq index (1+ index))) (and (> index count) (not (stringp (car entry))) (setq result (car entry))) ))) (setq word-stack (cons nil word-stack)))) (error nil)) (setq count (1+ count))) (and soar-explain-indentation (message "Indentation type %s" result)) result)) (defun soar-calculate-indent (&optional parse-start) "Return appropriate indentation for current line as Soar code. In usual case returns an integer: the column to indent to. Returns nil if line starts inside a string, t if in a comment." (save-excursion (beginning-of-line) (let* ((indent-point (point)) (case-fold-search nil) (continued-line (save-excursion (if (bobp) nil (backward-char) (= ?\\ (preceding-char))))) (continued-indent-value (if continued-line soar-continued-indent-level 0)) state containing-sexp found-next-line) (if parse-start (goto-char parse-start) (beginning-of-defun)) (while (< (point) indent-point) (setq parse-start (point)) (setq state (parse-partial-sexp (point) indent-point 0)) (setq containing-sexp (car (cdr state)))) (cond ((or (nth 3 state) (nth 4 state)) ;; Inside comment or string. Return nil or t if should ;; not change this line (nth 4 state)) ((null containing-sexp) ;; Line is at top level. continued-indent-value) (t ;; Set expr-p if we are looking at the expression part of ;; an "if", "expr", etc statement. Set commands-p if we ;; are looking at the body part of an if, while, etc ;; statement. FIXME Should check for "for" loops here. (goto-char containing-sexp) (let* ((sexpr-type (soar-figure-type)) (expr-p (eq sexpr-type 'soar-expr)) (commands-p (eq sexpr-type 'soar-commands)) (rule-body-p (eq sexpr-type 'soar-rule-body)) (expr-start (point))) ;; Find the first statement in the block and indent ;; like it. The first statement in the block might be ;; on the same line, so what we do is skip all ;; "virtually blank" lines, looking for a non-blank ;; one. A line is virtually blank if it only contains ;; a comment and whitespace. FIXME continued comments ;; aren't supported. They are a wart on Soar anyway. ;; We do it this funky way because we want to know if ;; we've found a statement on some line _after_ the ;; line holding the sexp opener. (goto-char containing-sexp) (forward-char) (if (and (< (point) indent-point) (looking-at "[ \t]*\\(#.*\\)?$")) (progn (forward-line) (while (and (< (point) indent-point) (looking-at "[ \t]*\\(#.*\\)?$")) (setq found-next-line t) (forward-line)))) (if (or continued-line (/= (char-after containing-sexp) ?{) expr-p) (progn ;; Line is continuation line, or the sexp opener ;; is not a curly brace, or we are are looking at ;; an `expr' expression (which must be split ;; specially). So indentation is column of first ;; good spot after sexp opener (with some added ;; in the continued-line case). If there is no ;; nonempty line before the indentation point, we ;; use the column of the character after the sexp ;; opener. (if (>= (point) indent-point) (progn (goto-char containing-sexp) (forward-char)) (skip-chars-forward " \t")) (+ (current-column) continued-indent-value)) ;; After a curly brace, and not a continuation line. ;; So take indentation from first good line after ;; start of block, unless that line is on the same ;; line as the opening brace. In this case use the ;; indentation of the opening brace's line, plus ;; another indent step. If we are in the body part ;; of an "if" or "while" then the indentation is ;; taken from the line holding the start of the ;; statement. (if (and (< (point) indent-point) found-next-line) (current-indentation) (if commands-p (goto-char expr-start) (goto-char containing-sexp)) (+ (current-indentation) soar-indent-level))))))))) (defun soar-indent-exp () "Indent each line of the Soar grouping following point." (interactive) (let ((indent-stack (list nil)) (contain-stack (list (point))) (case-fold-search nil) outer-loop-done inner-loop-done state ostate this-indent last-sexp continued-line (next-depth 0) last-depth) (save-excursion (forward-sexp 1)) (save-excursion (setq outer-loop-done nil) (while (and (not (eobp)) (not outer-loop-done)) (setq last-depth next-depth) ;; Compute how depth changes over this line ;; plus enough other lines to get to one that ;; does not end inside a comment or string. ;; Meanwhile, do appropriate indentation on comment lines. (setq inner-loop-done nil) (while (and (not inner-loop-done) (not (and (eobp) (setq outer-loop-done t)))) (setq ostate state) (setq state (parse-partial-sexp (point) (progn (end-of-line) (point)) nil nil state)) (setq next-depth (car state)) (if (and (car (cdr (cdr state))) (>= (car (cdr (cdr state))) 0)) (setq last-sexp (car (cdr (cdr state))))) (if (or (nth 4 ostate)) (soar-indent-line)) (if (or (nth 3 state)) (forward-line 1) (setq inner-loop-done t))) (if (<= next-depth 0) (setq outer-loop-done t)) (if outer-loop-done nil ;; If this line had ..))) (((.. in it, pop out of the levels ;; that ended anywhere in this line, even if the final depth ;; doesn't indicate that they ended. (while (> last-depth (nth 6 state)) (setq indent-stack (cdr indent-stack) contain-stack (cdr contain-stack) last-depth (1- last-depth))) (if (/= last-depth next-depth) (setq last-sexp nil)) ;; Add levels for any parens that were started in this line. (while (< last-depth next-depth) (setq indent-stack (cons nil indent-stack) contain-stack (cons nil contain-stack) last-depth (1+ last-depth))) (if (null (car contain-stack)) (setcar contain-stack (or (car (cdr state)) (save-excursion (forward-sexp -1) (point))))) (forward-line 1) (setq continued-line (save-excursion (backward-char) (= (preceding-char) ?\\))) (skip-chars-forward " \t") (if (eolp) nil (if (and (car indent-stack) (>= (car indent-stack) 0)) ;; Line is on an existing nesting level. (setq this-indent (car indent-stack)) ;; Just started a new nesting level. ;; Compute the standard indent for this level. (let ((val (soar-calculate-indent (if (car indent-stack) (- (car indent-stack)))))) (setcar indent-stack (setq this-indent val)) (setq continued-line nil))) (cond ((not (numberp this-indent))) ((= (following-char) ?}) (setq this-indent (- this-indent soar-indent-level))) ((= (following-char) ?\]) (setq this-indent (- this-indent 1)))) ;; Put chosen indentation into effect. (or (null this-indent) (= (current-column) (if continued-line (+ this-indent soar-indent-level) this-indent)) (progn (delete-region (point) (progn (beginning-of-line) (point))) (indent-to (if continued-line (+ this-indent soar-indent-level) this-indent))))))))) ) ;; ;; Interfaces to other packages. ;; ;; FIXME Definition of function is very ad-hoc. Should use ;; beginning-of-defun. Also has incestuous knowledge about the ;; format of soar-proc-regexp. (defun soar-add-log-defun () "Return name of Soar function point is in, or nil." (save-excursion (end-of-line) (if (re-search-backward (concat soar-proc-regexp "\\([^ \t\n{]+\\)") nil t) (match-string 2)))) (defun soar-outline-level () (save-excursion (skip-chars-forward " \t") (current-column))) ;; ;; Helper functions for inferior Soar mode. ;; ;; This exists to let us delete the prompt when commands are sent ;; directly to the inferior Soar. See gud.el for an explanation of how ;; it all works (I took it from there). This stuff doesn't really ;; work as well as I'd like it to. But I don't believe there is ;; anything useful that can be done. (defvar inferior-soar-delete-prompt-marker nil) (defun soar-filter (proc string) (let ((inhibit-quit t)) (with-current-buffer (process-buffer proc) (goto-char (process-mark proc)) ;; Delete prompt if requested. (if (marker-buffer inferior-soar-delete-prompt-marker) (progn (delete-region (point) inferior-soar-delete-prompt-marker) (set-marker inferior-soar-delete-prompt-marker nil))))) (comint-output-filter proc string)) (defun soar-send-string (proc string) (with-current-buffer (process-buffer proc) (goto-char (process-mark proc)) (beginning-of-line) (if (looking-at comint-prompt-regexp) (set-marker inferior-soar-delete-prompt-marker (point)))) (comint-send-string proc string)) (defun soar-send-region (proc start end) (with-current-buffer (process-buffer proc) (goto-char (process-mark proc)) (beginning-of-line) (if (looking-at comint-prompt-regexp) (set-marker inferior-soar-delete-prompt-marker (point)))) (comint-send-region proc start end)) (defun switch-to-soar (eob-p) "Switch to inferior Soar process buffer. With argument, positions cursor at end of buffer." (interactive "P") (if (get-buffer inferior-soar-buffer) (pop-to-buffer inferior-soar-buffer) (error "No current inferior Soar buffer")) (cond (eob-p (push-mark) (goto-char (point-max))))) (defun inferior-soar-proc () "Return current inferior Soar process. See variable `inferior-soar-buffer'." (let ((proc (get-buffer-process (if (eq major-mode 'inferior-soar-mode) (current-buffer) inferior-soar-buffer)))) (or proc (error "No Soar process; see variable `inferior-soar-buffer'")))) (defun soar-eval-region (start end &optional and-go) "Send the current region to the inferior Soar process. Prefix argument means switch to the Soar buffer afterwards." (interactive "r\nP") (let ((proc (inferior-soar-proc))) (soar-send-region proc start end) (soar-send-string proc "\n") (if and-go (switch-to-soar t)))) (defun soar-eval-defun (&optional and-go) "Send the current defun to the inferior Soar process. Prefix argument means switch to the Soar buffer afterwards." (interactive "P") (save-excursion (end-of-defun) (let ((end (point))) (beginning-of-defun) (soar-eval-region (point) end))) (if and-go (switch-to-soar t))) (defun soar-run-decision (&optional and-go) "Run the current soar process for a single decision cycle." (interactive) (let ((proc (inferior-soar-proc))) (soar-send-string proc "run 1 d\n") (if and-go (switch-to-soar t)))) ;; ;; Inferior Soar mode itself. ;; (define-derived-mode inferior-soar-mode comint-mode "Inferior Soar" "Major mode for interacting with Soar interpreter. You can start a Soar process with \\[inferior-soar]. Entry to this mode runs the normal hooks `comint-mode-hook' and `inferior-soar-mode-hook', in that order. You can send text to the inferior Soar process from other buffers containing Soar source. Variables controlling Inferior Soar mode: `soar-application' Name of program to run. `soar-command-switches' Command line arguments to `soar-application'. `soar-prompt-regexp' Matches prompt. `inferior-soar-source-command' Command to use to read Soar file in running application. `inferior-soar-buffer' The current inferior Soar process buffer. See variable documentation for details on multiple-process support. The following commands are available: \\{inferior-soar-mode-map}" (set (make-local-variable 'comint-prompt-regexp) (or soar-prompt-regexp (concat "^" (regexp-quote soar-application) ">"))) (setq mode-line-process '(": %s")) (setq local-abbrev-table soar-mode-abbrev-table) (set-syntax-table soar-mode-syntax-table) (set (make-local-variable 'defun-prompt-regexp) soar-omit-ws-regexp) (set (make-local-variable 'inferior-soar-delete-prompt-marker) (make-marker)) (set-process-filter (get-buffer-process (current-buffer)) 'soar-filter)) ;;;###autoload (defun inferior-soar (cmd) "Run inferior Soar process. Prefix arg means enter program name interactively. See documentation for function `inferior-soar-mode' for more information." (interactive (list (if current-prefix-arg (read-string "Run Soar: " soar-application) soar-application))) (if (not (comint-check-proc "*inferior-soar*")) (progn (set-buffer (apply (function make-comint) "inferior-soar" cmd nil soar-command-switches)) (inferior-soar-mode))) (make-local-variable 'soar-application) (setq soar-application cmd) (setq inferior-soar-buffer "*inferior-soar*") (switch-to-buffer "*inferior-soar*")) (defalias 'run-soar 'inferior-soar) ;; ;; Auto-fill support. ;; (defun soar-real-command-p () "Return nil if point is not at the beginning of a command. A command is the first word on an otherwise empty line, or the first word following a semicolon, opening brace, or opening bracket." (save-excursion (skip-chars-backward " \t") (cond ((bobp) t) ((bolp) (backward-char) ;; Note -- continued comments are not supported here. I ;; consider those to be a wart on the language. (not (eq ?\\ (preceding-char)))) (t (memq (preceding-char) '(?\; ?{ ?\[)))))) ;; FIXME doesn't actually return t. See last case. (defun soar-real-comment-p () "Return t if point is just after the `#' beginning a real comment. Does not check to see if previous char is actually `#'. A real comment is either at the beginning of the buffer, preceded only by whitespace on the line, or has a preceding semicolon, opening brace, or opening bracket on the same line." (save-excursion (backward-char) (soar-real-command-p))) (defun soar-hairy-scan-for-comment (state end always-stop) "Determine if point is in a comment. Returns a list of the form `(FLAG . STATE)'. STATE can be used as input to future invocations. FLAG is nil if not in comment, t otherwise. If in comment, leaves point at beginning of comment. This function does not work in Emacs 18. See also `soar-simple-scan-for-comment', a simpler version that is often right, and works in Emacs 18." (let ((bol (save-excursion (goto-char end) (beginning-of-line) (point))) real-comment last-cstart) (while (and (not last-cstart) (< (point) end)) (setq real-comment nil) ;In case we've looped around and it is set. (setq state (parse-partial-sexp (point) end nil nil state t)) (if (nth 4 state) (progn ;; If ALWAYS-STOP is set, stop even if we don't have a ;; real comment, or if the comment isn't on the same line ;; as the end. (if always-stop (setq last-cstart (point))) ;; If we have a real comment, then set the comment ;; starting point if we are on the same line as the ending ;; location. (setq real-comment (soar-real-comment-p)) (if real-comment (progn (and (> (point) bol) (setq last-cstart (point))) ;; NOTE Emacs 19 has a misfeature whereby calling ;; parse-partial-sexp with COMMENTSTOP set and with ;; an initial list that says point is in a comment ;; will cause an immediate return. So we must skip ;; over the comment ourselves. (beginning-of-line 2))) ;; Frob the state to make it look like we aren't in a ;; comment. (setcar (nthcdr 4 state) nil)))) (and last-cstart (goto-char last-cstart)) (cons real-comment state))) (defun soar-in-comment () "Return t if point is in a comment, and leave point at beginning of comment." (let ((save (point))) (beginning-of-defun) (car (soar-hairy-scan-for-comment nil save nil)))) (defun soar-do-fill-paragraph (ignore) "fill-paragraph function for Soar mode. Only fills in a comment." (let (in-comment col where) (save-excursion (end-of-line) (setq in-comment (soar-in-comment)) (if in-comment (progn (setq where (1+ (point))) (setq col (1- (current-column)))))) (and in-comment (save-excursion (back-to-indentation) (= col (current-column))) ;; In a comment. Set the fill prefix, and find the paragraph ;; boundaries by searching for lines that look like ;; comment-only lines. (let ((fill-prefix (buffer-substring (progn (beginning-of-line) (point)) where)) p-start p-end) ;; Search backwards. (save-excursion (while (and (looking-at "^[ \t]*#[ \t]*[^ \t\n]") (not (bobp))) (forward-line -1)) (setq p-start (point))) ;; Search forwards. (save-excursion (while (looking-at "^[ \t]*#[ \t]*[^ \t\n]") (forward-line)) (setq p-end (point))) ;; Narrow and do the fill. (save-restriction (narrow-to-region p-start p-end) (fill-paragraph ignore))))) t) ;; ;; Help-related code. ;; (defvar soar-help-saved-dirs nil "Saved help directories. If `soar-help-directory-list' changes, this allows `soar-help-on-word' to update the alist.") (defvar soar-help-alist nil "Alist with command names as keys and filenames as values.") (defun soar-files-alist (dir &optional alist) "Recursively add all pairs (FILE . PATH) under DIR to ALIST." (dolist (file (directory-files dir t) alist) (cond ((not (file-directory-p file)) (push (cons (file-name-nondirectory file) file) alist)) ((member (file-name-nondirectory file) '("." ".."))) (t (setq alist (soar-files-alist file alist)))))) (defun soar-help-snarf-commands (dirlist) "Return alist of commands and filenames." (let ((alist nil)) (dolist (dir dirlist alist) (when (file-directory-p dir) (setq alist (soar-files-alist dir alist)))))) (defun soar-reread-help-files () "Set up to re-read files, and then do it." (interactive) (message "Building Soar help file index...") (setq soar-help-saved-dirs soar-help-directory-list) (setq soar-help-alist (soar-help-snarf-commands soar-help-directory-list)) (message "Building Soar help file index...done")) (defun soar-word-no-props () "Like `current-word', but strips properties." (let ((word (current-word))) (set-text-properties 0 (length word) nil word) word)) (defun soar-current-word (flag) "Return current command word, or nil. If FLAG is nil, just uses `current-word'. Otherwise scans backward for most likely Soar command word." (if (and flag (memq major-mode '(soar-mode inferior-soar-mode))) (condition-case nil (save-excursion ;; Look backward for first word actually in alist. (if (bobp) () (while (and (not (bobp)) (not (soar-real-command-p))) (backward-sexp))) (if (assoc (soar-word-no-props) soar-help-alist) (soar-word-no-props))) (error nil)) (soar-word-no-props))) ;;;###autoload (defun soar-help-on-word (command &optional arg) "Get help on Soar command. Default is word at point. Prefix argument means invert sense of `soar-use-smart-word-finder'." (interactive (list (progn (if (not (equal soar-help-directory-list soar-help-saved-dirs)) (soar-reread-help-files)) (let ((word (soar-current-word (if current-prefix-arg (not soar-use-smart-word-finder) soar-use-smart-word-finder)))) (completing-read (if (or (null word) (string= word "")) "Help on Soar command: " (format "Help on Soar command (default %s): " word)) soar-help-alist nil t nil nil word))) current-prefix-arg)) (if (not (equal soar-help-directory-list soar-help-saved-dirs)) (soar-reread-help-files)) (if (string= command "") (setq command (soar-current-word (if arg (not soar-use-smart-word-finder) soar-use-smart-word-finder)))) (let* ((help (get-buffer-create "*Soar help*")) (cell (assoc command soar-help-alist)) (file (and cell (cdr cell)))) (set-buffer help) (delete-region (point-min) (point-max)) (if file (progn (insert "*** " command "\n\n") (insert-file-contents file)) (if (string= command "") (insert "Magical Pig!") (insert "Soar command " command " not in help\n"))) (set-buffer-modified-p nil) (goto-char (point-min)) (display-buffer help))) ;; ;; Other interactive stuff. ;; (defvar soar-previous-dir/file nil "Record last directory and file used in loading. This holds a cons cell of the form `(DIRECTORY . FILE)' describing the last `soar-load-file' command.") (defun soar-load-file (file &optional and-go) "Load a Soar file into the inferior Soar process. Prefix argument means switch to the Soar buffer afterwards." (interactive (list ;; car because comint-get-source returns a list holding the ;; filename. (car (comint-get-source "Load Soar file: " (or (and (eq major-mode 'soar-mode) (buffer-file-name)) soar-previous-dir/file) '(soar-mode) t)) current-prefix-arg)) (comint-check-source file) (setq soar-previous-dir/file (cons (file-name-directory file) (file-name-nondirectory file))) (soar-send-string (inferior-soar-proc) (format inferior-soar-source-command (soar-quote file))) (if and-go (switch-to-soar t))) (defun soar-restart-with-file (file &optional and-go) "Restart inferior Soar with file. If an inferior Soar process exists, it is killed first. Prefix argument means switch to the Soar buffer afterwards." (interactive (list (car (comint-get-source "Restart with Soar file: " (or (and (eq major-mode 'soar-mode) (buffer-file-name)) soar-previous-dir/file) '(soar-mode) t)) current-prefix-arg)) (let* ((buf (if (eq major-mode 'inferior-soar-mode) (current-buffer) inferior-soar-buffer)) (proc (and buf (get-process buf)))) (cond ((not (and buf (get-buffer buf))) ;; I think this will be ok. (inferior-soar soar-application) (soar-load-file file and-go)) ((or (not (comint-check-proc buf)) (yes-or-no-p "A Soar process is running, are you sure you want to reset it? ")) (save-excursion (comint-check-source file) (setq soar-previous-dir/file (cons (file-name-directory file) (file-name-nondirectory file))) (comint-exec (get-buffer-create buf) (if proc (process-name proc) "inferior-soar") soar-application file soar-command-switches) (if and-go (switch-to-soar t))))))) (defun soar-auto-fill-mode (&optional arg) "Like `auto-fill-mode', but sets `comment-auto-fill-only-comments'." (interactive "P") (auto-fill-mode arg) (if auto-fill-function (set (make-local-variable 'comment-auto-fill-only-comments) t) (kill-local-variable 'comment-auto-fill-only-comments))) (defun soar-electric-hash (&optional count) "Insert a `#' and quote if it does not start a real comment. Prefix arg is number of `#'s to insert. See variable `soar-electric-hash-style' for description of quoting styles." (interactive "p") (or count (setq count 1)) (if (> count 0) (let ((type (if (eq soar-electric-hash-style 'smart) (if (> count 3) ; FIXME what is "smart"? 'quote 'backslash) soar-electric-hash-style)) comment) (if type (progn (save-excursion (insert "#") (setq comment (soar-in-comment))) (delete-char 1) (and soar-explain-indentation (message "comment: %s" comment)) (cond ((eq type 'quote) (if (not comment) (insert "\""))) ((eq type 'backslash) ;; The following will set count to 0, so the ;; insert-char can still be run. (if (not comment) (while (> count 0) (insert "\\#") (setq count (1- count))))) (t nil)))) (insert-char ?# count)))) (defun soar-hashify-buffer () "Quote all `#'s in current buffer that aren't Soar comments." (interactive) (save-excursion (goto-char (point-min)) (let (state result) (while (< (point) (point-max)) (setq result (soar-hairy-scan-for-comment state (point-max) t)) (if (car result) (beginning-of-line 2) (backward-char) (if (eq ?# (following-char)) (insert "\\")) (forward-char)) (setq state (cdr result)))))) (defun soar-comment-indent () "Return the desired indentation, but be careful to add a `;' if needed." (save-excursion ;; If line is not blank, make sure we insert a ";" first. (skip-chars-backward " \t") (unless (or (bolp) (soar-real-command-p)) (insert ";") ;; Try and erase a non-significant char to keep charpos identical. (if (memq (char-after) '(?\t ?\ )) (delete-char 1)))) (funcall (default-value 'comment-indent-function))) ;; The following was inspired by the Soar editing mode written by ;; Gregor Schmid . His version also ;; attempts to snarf the command line options from the command line, ;; but I didn't think that would really be that helpful (doesn't seem ;; like it would be right enough. His version also looks for the ;; "#!/bin/csh ... exec" hack, but that seemed even less useful. ;; FIXME should make sure that the application mentioned actually ;; exists. (defun soar-guess-application () "Attempt to guess Soar application by looking at first line. The first line is assumed to look like \"#!.../program ...\"." (save-excursion (goto-char (point-min)) (if (looking-at "#![^ \t]*/\\([^ \t\n/]+\\)\\([ \t]\\|$\\)") (set (make-local-variable 'soar-application) (match-string 1))))) ;; ;; XEmacs menu support. ;; Taken from schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid), ;; who wrote a different Soar mode. ;; We also have support for menus in Emacs. We do this by ;; loading the XEmacs menu emulation code. ;; (defun soar-popup-menu (e) (interactive "@e") (popup-menu soar-mode-menu)) ;; ;; Quoting and unquoting functions. ;; ;; This quoting is sufficient to protect eg a filename from any sort ;; of expansion or splitting. Soar quoting sure sucks. (defun soar-quote (string) "Quote STRING according to Soar rules." (mapconcat (lambda (char) (if (memq char '(?[ ?] ?{ ?} ?\\ ?\" ?$ ? ?\;)) (concat "\\" (char-to-string char)) (char-to-string char))) string "")) ;; ;; Bug reporting. ;; ;; These are relics kept "just in case". (defalias 'soar-uncomment-region 'uncomment-region) (defalias 'soar-indent-for-comment 'comment-indent) (defalias 'add-log-soar-defun 'soar-add-log-defun) (defalias 'indent-soar-exp 'soar-indent-exp) (defalias 'calculate-soar-indent 'soar-calculate-indent) (defalias 'soar-beginning-of-defun 'beginning-of-defun) (defalias 'soar-end-of-defun 'end-of-defun) (defalias 'soar-mark-defun 'mark-defun) (defun soar-mark () (mark t)) (provide 'soar) ;;; soar.el ends here