summaryrefslogtreecommitdiff
path: root/lisp/cedet/srecode/table.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2009-09-20 21:06:41 +0000
committerChong Yidong <cyd@stupidchicken.com>2009-09-20 21:06:41 +0000
commit4d902e6f13f6bf5d304a0cbcff33e2780a825206 (patch)
tree20c5dbf4febbaff55e22b4fa0e950cf552e88e70 /lisp/cedet/srecode/table.el
parent70702e9b0ea781fb955c66320c935bc0a8e1d0f1 (diff)
downloademacs-4d902e6f13f6bf5d304a0cbcff33e2780a825206.tar.gz
lisp/cedet/srecode.el:
lisp/cedet/srecode/*.el: test/cedet/srecode-tests.el: New files lisp/files.el (auto-mode-alist): Use srecode-template-mode for .srt files. lisp/cedet/semantic/bovine/scm.el: Add local vars section for autoloading.
Diffstat (limited to 'lisp/cedet/srecode/table.el')
-rw-r--r--lisp/cedet/srecode/table.el248
1 files changed, 248 insertions, 0 deletions
diff --git a/lisp/cedet/srecode/table.el b/lisp/cedet/srecode/table.el
new file mode 100644
index 00000000000..2591983c7a6
--- /dev/null
+++ b/lisp/cedet/srecode/table.el
@@ -0,0 +1,248 @@
+;;; srecode/table.el --- Tables of Semantic Recoders
+
+;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+
+;; Author: Eric M. Ludlam <eric@siege-engine.com>
+
+;; 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 3 of the License, 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. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; Semantic Recoder tables manage lists of templates and the major
+;; modes they are associated with.
+;;
+
+(require 'eieio)
+(require 'eieio-base)
+(require 'mode-local)
+(require 'srecode)
+
+(declare-function srecode-load-tables-for-mode "srecode/find")
+
+;;; Code:
+
+;;; TEMPLATE TABLE
+;;
+(defclass srecode-template-table ()
+ (;;
+ ;; Raw file tracking
+ ;;
+ (file :initarg :file
+ :type string
+ :documentation
+ "The name of the file this table was built from.")
+ (filesize :initarg :filesize
+ :type number
+ :documentation
+ "The size of the file when it was parsed.")
+ (filedate :initarg :filedate
+ :type cons
+ :documentation
+ "Date from the inode of the file when it was last edited.
+Format is from the `file-attributes' function.")
+ (major-mode :initarg :major-mode
+ :documentation
+ "The major mode this table of templates is associated with.")
+ ;;
+ ;; Template file sorting data
+ ;;
+ (application :initarg :application
+ :type symbol
+ :documentation
+ "Tracks the name of the application these templates belong to.
+If this is nil, then this template table belongs to a set of generic
+templates that can be used with no additional dictionary values.
+When it is non-nil, it is assumed the template macros need specialized
+Emacs Lisp code to fill in the dictoinary.")
+ (priority :initarg :priority
+ :type number
+ :documentation
+ "For file of this Major Mode, what is the priority of this file.
+When there are multiple template files with similar names, templates with
+the highest priority are scanned last, allowing them to override values in
+previous template files.")
+ ;;
+ ;; Parsed Data from the template file
+ ;;
+ (templates :initarg :templates
+ :type list
+ :documentation
+ "The list of templates compiled into this table.")
+ (namehash :initarg :namehash
+ :documentation
+ "Hash table containing the names of all the templates.")
+ (contexthash :initarg :contexthash
+ :documentation
+ "")
+ (variables :initarg :variables
+ :documentation
+ "AList of variables.
+These variables are used to initialize dictionaries.")
+ )
+ "Semantic recoder template table.
+A Table contains all templates from a single .srt file.
+Tracks various lookup hash tables.")
+
+;;; MODE TABLE
+;;
+(defvar srecode-mode-table-list nil
+ "List of all the SRecode mode table classes that have been built.")
+
+(defclass srecode-mode-table (eieio-instance-tracker)
+ ((tracking-symbol :initform 'srecode-mode-table-list)
+ (major-mode :initarg :major-mode
+ :documentation
+ "Table of template tables for this major-mode.")
+ (tables :initarg :tables
+ :documentation
+ "All the tables that have been defined for this major mode.")
+ )
+ "Track template tables for a particular major mode.
+Tracks all the template-tables for a specific major mode.")
+
+(defun srecode-get-mode-table (mode)
+ "Get the SRecoder mode table for the major mode MODE.
+Optional argument SOFT indicates to not make a new one if a table
+was not found."
+ (let ((ans nil))
+ (while (and (not ans) mode)
+ (setq ans (eieio-instance-tracker-find
+ mode 'major-mode 'srecode-mode-table-list)
+ mode (get-mode-local-parent mode)))
+ ans))
+
+(defun srecode-make-mode-table (mode)
+ "Get the SRecoder mode table for the major mode MODE."
+ (let ((old (eieio-instance-tracker-find
+ mode 'major-mode 'srecode-mode-table-list)))
+ (if old
+ old
+ (let* ((ms (if (stringp mode) mode (symbol-name mode)))
+ (new (srecode-mode-table ms
+ :major-mode mode
+ :tables nil)))
+ ;; Save this new mode table in that mode's variable.
+ (eval `(setq-mode-local ,mode srecode-table ,new))
+
+ new))))
+
+(defmethod srecode-mode-table-find ((mt srecode-mode-table) file)
+ "Look in the mode table MT for a template table from FILE.
+Return nil if there was none."
+ (object-assoc file 'file (oref mt tables)))
+
+(defun srecode-mode-table-new (mode file &rest init)
+ "Create a new template table for MODE in FILE.
+INIT are the initialization parametrs for the new template table."
+ (let* ((mt (srecode-make-mode-table mode))
+ (old (srecode-mode-table-find mt file))
+ (attr (file-attributes file))
+ (new (apply 'srecode-template-table
+ (file-name-nondirectory file)
+ :file file
+ :filesize (nth 7 attr)
+ :filedate (nth 5 attr)
+ :major-mode mode
+ init
+ )))
+ ;; Whack the old table.
+ (when old (object-remove-from-list mt 'tables old))
+ ;; Add the new table
+ (object-add-to-list mt 'tables new)
+ ;; Sort the list in reverse order. When other routines
+ ;; go front-to-back, the highest priority items are put
+ ;; into the search table first, allowing lower priority items
+ ;; to be the items found in the search table.
+ (object-sort-list mt 'tables (lambda (a b)
+ (> (oref a :priority)
+ (oref b :priority))))
+ ;; Return it.
+ new))
+
+(defun object-sort-list (object slot predicate)
+ "Sort the items in OBJECT's SLOT.
+Use PREDICATE is the same as for the `sort' function."
+ (when (slot-boundp object slot)
+ (when (listp (eieio-oref object slot))
+ (eieio-oset object slot (sort (eieio-oref object slot) predicate)))))
+
+;;; DEBUG
+;;
+;; Dump out information about the current srecoder compiled templates.
+;;
+(defun srecode-dump-templates (mode)
+ "Dump a list of the current templates for MODE."
+ (interactive "sMode: ")
+ (require 'srecode/find)
+ (let ((modesym (cond ((string= mode "")
+ major-mode)
+ ((not (string-match "-mode" mode))
+ (intern-soft (concat mode "-mode")))
+ (t
+ (intern-soft mode)))))
+ (srecode-load-tables-for-mode modesym)
+ (let ((tmp (srecode-get-mode-table modesym))
+ )
+ (if (not tmp)
+ (error "No table found for mode %S" modesym))
+ (with-output-to-temp-buffer "*SRECODE DUMP*"
+ (srecode-dump tmp))
+ )))
+
+(defmethod srecode-dump ((tab srecode-mode-table))
+ "Dump the contents of the SRecode mode table TAB."
+ (princ "MODE TABLE FOR ")
+ (princ (oref tab :major-mode))
+ (princ "\n--------------------------------------------\n\nNumber of tables: ")
+ (let ((subtab (oref tab :tables)))
+ (princ (length subtab))
+ (princ "\n\n")
+ (while subtab
+ (srecode-dump (car subtab))
+ (setq subtab (cdr subtab)))
+ ))
+
+(defmethod srecode-dump ((tab srecode-template-table))
+ "Dump the contents of the SRecode template table TAB."
+ (princ "Template Table for ")
+ (princ (object-name-string tab))
+ (princ "\nPriority: ")
+ (prin1 (oref tab :priority))
+ (when (oref tab :application)
+ (princ "\nApplication: ")
+ (princ (oref tab :application)))
+ (princ "\n\nVariables:\n")
+ (let ((vars (oref tab variables)))
+ (while vars
+ (princ (car (car vars)))
+ (princ "\t")
+ (if (< (length (car (car vars))) 9)
+ (princ "\t"))
+ (prin1 (cdr (car vars)))
+ (princ "\n")
+ (setq vars (cdr vars))))
+ (princ "\n\nTemplates:\n")
+ (let ((temp (oref tab templates)))
+ (while temp
+ (srecode-dump (car temp))
+ (setq temp (cdr temp))))
+ )
+
+
+(provide 'srecode/table)
+
+;;; srecode/table.el ends here
+