1 ;;; semantic/db.el --- Semantic tag database manager
3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
4 ;; 2009 Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Maintain a database of tags for a group of files and enable
27 ;; queries into the database.
29 ;; By default, assume one database per directory.
37 (declare-function semantic-lex-spp-save-table "semantic/lex-spp")
40 (defgroup semanticdb nil
41 "Parser Generator Persistent Database interface."
44 (defvar semanticdb-database-list nil
45 "List of all active databases.")
47 (defvar semanticdb-new-database-class 'semanticdb-project-database-file
48 "The default type of database created for new files.
49 This can be changed on a per file basis, so that some directories
50 are saved using one mechanism, and some directories via a different
52 (make-variable-buffer-local 'semanticdb-new-database-class)
54 (defvar semanticdb-default-find-index-class 'semanticdb-find-search-index
55 "The default type of search index to use for a `semanticdb-table's.
56 This can be changed to try out new types of search indices.")
57 (make-variable-buffer-local 'semanticdb-default-find=index-class)
60 (defvar semanticdb-current-database nil
61 "For a given buffer, this is the currently active database.")
62 (make-variable-buffer-local 'semanticdb-current-database)
65 (defvar semanticdb-current-table nil
66 "For a given buffer, this is the currently active database table.")
67 (make-variable-buffer-local 'semanticdb-current-table)
71 (defclass semanticdb-abstract-table ()
72 ((parent-db ;; :initarg :parent-db
73 ;; Do not set an initarg, or you get circular writes to disk.
74 :documentation "Database Object containing this table.")
75 (major-mode :initarg :major-mode
77 :documentation "Major mode this table belongs to.
78 Sometimes it is important for a program to know if a given table has the
79 same major mode as the current buffer.")
81 :accessor semanticdb-get-tags
82 :printer semantic-tag-write-list-slot-value
83 :documentation "The tags belonging to this table.")
84 (index :type semanticdb-abstract-search-index
85 :documentation "The search index.
86 Used by semanticdb-find to store additional information about
87 this table for searching purposes.
89 Note: This index will not be saved in a persistent file.")
92 :documentation "List of cache information for tools.
93 Any particular tool can cache data to a database at runtime
94 with `semanticdb-cache-get'.
96 Using a semanticdb cache does not save any information to a file,
97 so your cache will need to be recalculated at runtime. Caches can be
98 referenced even when the file is not in a buffer.
100 Note: This index will not be saved in a persistent file.")
102 "A simple table for semantic tags.
103 This table is the root of tables, and contains the minimum needed
104 for a new table not associated with a buffer."
107 (defmethod semanticdb-in-buffer-p ((obj semanticdb-abstract-table))
108 "Return a nil, meaning abstract table OBJ is not in a buffer."
111 (defmethod semanticdb-get-buffer ((obj semanticdb-abstract-table))
112 "Return a buffer associated with OBJ.
113 If the buffer is not in memory, load it with `find-file-noselect'."
116 (defmethod semanticdb-full-filename ((obj semanticdb-abstract-table))
117 "Fetch the full filename that OBJ refers to.
118 Abstract tables do not have file names associated with them."
121 (defmethod semanticdb-dirty-p ((obj semanticdb-abstract-table))
122 "Return non-nil if OBJ is 'dirty'."
125 (defmethod semanticdb-set-dirty ((obj semanticdb-abstract-table))
126 "Mark the abstract table OBJ dirty.
127 Abstract tables can not be marked dirty, as there is nothing
128 for them to synchronize against."
129 ;; The abstract table can not be dirty.
132 (defmethod semanticdb-normalize-tags ((obj semanticdb-abstract-table) tags)
133 "For the table OBJ, convert a list of TAGS, into standardized form.
134 The default is to return TAGS.
135 Some databases may default to searching and providing simplified tags
136 based on whichever technique used. This method provides a hook for
137 them to convert TAG into a more complete form."
140 (defmethod semanticdb-normalize-one-tag ((obj semanticdb-abstract-table) tag)
141 "For the table OBJ, convert a TAG, into standardized form.
142 This method returns a list of the form (DATABASE . NEWTAG).
144 The default is to just return (OBJ TAG).
146 Some databases may default to searching and providing simplified tags
147 based on whichever technique used. This method provides a hook for
148 them to convert TAG into a more complete form."
151 (defmethod object-print ((obj semanticdb-abstract-table) &rest strings)
152 "Pretty printer extension for `semanticdb-table'.
153 Adds the number of tags in this file to the object print name."
154 (apply 'call-next-method obj
155 (cons (format " (%d tags)"
156 (length (semanticdb-get-tags obj))
162 (defclass semanticdb-abstract-search-index ()
163 ((table :initarg :table
164 :type semanticdb-abstract-table
165 :documentation "XRef to the table this belongs to.")
167 "A place where semanticdb-find can store search index information.
168 The search index will store data about which other tables might be
169 needed, or perhaps create hash or index tables for the current buffer."
172 (defmethod semanticdb-get-table-index ((obj semanticdb-abstract-table))
173 "Return the search index for the table OBJ.
174 If one doesn't exist, create it."
175 (if (slot-boundp obj 'index)
178 (setq idx (funcall semanticdb-default-find-index-class
179 (concat (object-name obj) " index")
180 ;; Fill in the defaults
186 (defmethod semanticdb-synchronize ((idx semanticdb-abstract-search-index)
188 "Synchronize the search index IDX with some NEW-TAGS."
189 ;; The abstract class will do... NOTHING!
192 (defmethod semanticdb-partial-synchronize ((idx semanticdb-abstract-search-index)
194 "Synchronize the search index IDX with some changed NEW-TAGS."
195 ;; The abstract class will do... NOTHING!
199 ;;; SEARCH RESULTS TABLE
201 ;; Needed for system databases that may not provide
202 ;; a semanticdb-table associated with a file.
204 (defclass semanticdb-search-results-table (semanticdb-abstract-table)
207 "Table used for search results when there is no file or table association.
208 Examples include search results from external sources such as from
209 Emacs' own symbol table, or from external libraries.")
211 (defmethod semanticdb-refresh-table ((obj semanticdb-search-results-table) &optional force)
212 "If the tag list associated with OBJ is loaded, refresh it.
213 This will call `semantic-fetch-tags' if that file is in memory."
216 ;;; CONCRETE TABLE CLASSES
218 (defclass semanticdb-table (semanticdb-abstract-table)
219 ((file :initarg :file
220 :documentation "File name relative to the parent database.
221 This is for the file whose tags are stored in this TABLE object.")
222 (buffer :initform nil
223 :documentation "The buffer associated with this table.
224 If nil, the table's buffer is no in Emacs. If it has a value, then
228 "Non nil if this table needs to be `Saved'.")
229 (db-refs :initform nil
231 "List of `semanticdb-table' objects refering to this one.
232 These aren't saved, but are instead recalculated after load.
233 See the file semanticdb-ref.el for how this slot is used.")
234 (pointmax :initarg :pointmax
236 :documentation "Size of buffer when written to disk.
237 Checked on retrieval to make sure the file is the same.")
238 (fsize :initarg :fsize
240 :documentation "Size of the file when it was last referenced.
241 Checked when deciding if a loaded table needs updating from changes
242 outside of Semantic's control.")
243 (lastmodtime :initarg :lastmodtime
245 :documentation "Last modification time of the file referenced.
246 Checked when deciding if a loaded table needs updating from changes outside of
247 Semantic's control.")
248 ;; @todo - need to add `last parsed time', so we can also have
249 ;; refresh checks if spp tables or the parser gets rebuilt.
250 (unmatched-syntax :initarg :unmatched-syntax
252 "List of vectors specifying unmatched syntax.")
254 (lexical-table :initarg :lexical-table
256 :printer semantic-lex-spp-table-write-slot-value
258 "Table that might be needed by the lexical analyzer.
259 For C/C++, the C preprocessor macros can be saved here.")
261 "A single table of tags derived from file.")
263 (defmethod semanticdb-in-buffer-p ((obj semanticdb-table))
264 "Return a buffer associated with OBJ.
265 If the buffer is in memory, return that buffer."
266 (let ((buff (oref obj buffer)))
267 (if (buffer-live-p buff)
269 (oset obj buffer nil))))
271 (defmethod semanticdb-get-buffer ((obj semanticdb-table))
272 "Return a buffer associated with OBJ.
273 If the buffer is in memory, return that buffer.
274 If the buffer is not in memory, load it with `find-file-noselect'."
275 (or (semanticdb-in-buffer-p obj)
276 ;; Save match data to protect against odd stuff in mode hooks.
278 (find-file-noselect (semanticdb-full-filename obj) t))))
280 (defmethod semanticdb-set-buffer ((obj semanticdb-table))
281 "Set the current buffer to be a buffer owned by OBJ.
282 If OBJ's file is not loaded, read it in first."
283 (set-buffer (semanticdb-get-buffer obj)))
285 (defmethod semanticdb-full-filename ((obj semanticdb-table))
286 "Fetch the full filename that OBJ refers to."
287 (expand-file-name (oref obj file)
288 (oref (oref obj parent-db) reference-directory)))
290 (defmethod semanticdb-dirty-p ((obj semanticdb-table))
291 "Return non-nil if OBJ is 'dirty'."
294 (defmethod semanticdb-set-dirty ((obj semanticdb-table))
295 "Mark the abstract table OBJ dirty."
299 (defmethod object-print ((obj semanticdb-table) &rest strings)
300 "Pretty printer extension for `semanticdb-table'.
301 Adds the number of tags in this file to the object print name."
302 (apply 'call-next-method obj
303 (cons (if (oref obj dirty) ", DIRTY" "") strings)))
305 ;;; DATABASE BASE CLASS
307 (defclass semanticdb-project-database (eieio-instance-tracker)
308 ((tracking-symbol :initform semanticdb-database-list)
309 (reference-directory :type string
310 :documentation "Directory this database refers to.
311 When a cache directory is specified, then this refers to the directory
312 this database contains symbols for.")
313 (new-table-class :initform semanticdb-table
316 "New tables created for this database are of this class.")
319 :documentation "List of cache information for tools.
320 Any particular tool can cache data to a database at runtime
321 with `semanticdb-cache-get'.
323 Using a semanticdb cache does not save any information to a file,
324 so your cache will need to be recalculated at runtime.
326 Note: This index will not be saved in a persistent file.")
327 (tables :initarg :tables
329 ;; Need this protection so apps don't try to access
330 ;; the tables without using the accessor.
331 :accessor semanticdb-get-database-tables
332 :protection :protected
333 :documentation "List of `semantic-db-table' objects."))
334 "Database of file tables.")
336 (defmethod semanticdb-full-filename ((obj semanticdb-project-database))
337 "Fetch the full filename that OBJ refers to.
338 Abstract tables do not have file names associated with them."
341 (defmethod semanticdb-dirty-p ((DB semanticdb-project-database))
342 "Return non-nil if DB is 'dirty'.
343 A database is dirty if the state of the database changed in a way
344 where it may need to resynchronize with some persistent storage."
346 (tabs (oref DB tables)))
347 (while (and (not dirty) tabs)
348 (setq dirty (semanticdb-dirty-p (car tabs)))
349 (setq tabs (cdr tabs)))
352 (defmethod object-print ((obj semanticdb-project-database) &rest strings)
353 "Pretty printer extension for `semanticdb-project-database'.
354 Adds the number of tables in this file to the object print name."
355 (apply 'call-next-method obj
356 (cons (format " (%d tables%s)"
357 (length (semanticdb-get-database-tables obj))
358 (if (semanticdb-dirty-p obj)
363 (defmethod semanticdb-create-database :STATIC ((dbc semanticdb-project-database) directory)
364 "Create a new semantic database of class DBC for DIRECTORY and return it.
365 If a database for DIRECTORY has already been created, return it.
366 If DIRECTORY doesn't exist, create a new one."
367 (let ((db (semanticdb-directory-loaded-p directory)))
369 (setq db (semanticdb-project-database
370 (file-name-nondirectory directory)
372 ;; Set this up here. We can't put it in the constructor because it
373 ;; would be saved, and we want DB files to be portable.
374 (oset db reference-directory (file-truename directory)))
377 (defmethod semanticdb-flush-database-tables ((db semanticdb-project-database))
378 "Reset the tables in DB to be empty."
379 (oset db tables nil))
381 (defmethod semanticdb-create-table ((db semanticdb-project-database) file)
382 "Create a new table in DB for FILE and return it.
383 The class of DB contains the class name for the type of table to create.
384 If the table for FILE exists, return it.
385 If the table for FILE does not exist, create one."
386 (let ((newtab (semanticdb-file-table db file)))
388 ;; This implementation will satisfy autoloaded classes
390 (setq newtab (funcall (oref db new-table-class)
391 (file-name-nondirectory file)
392 :file (file-name-nondirectory file)
394 (oset newtab parent-db db)
395 (object-add-to-list db 'tables newtab t))
398 (defmethod semanticdb-file-table ((obj semanticdb-project-database) filename)
399 "From OBJ, return FILENAME's associated table object."
400 (object-assoc (file-relative-name (file-truename filename)
401 (oref obj reference-directory))
402 'file (oref obj tables)))
404 ;; DATABASE FUNCTIONS
405 (defun semanticdb-get-database (filename)
406 "Get a database for FILENAME.
407 If one isn't found, create one."
408 (semanticdb-create-database semanticdb-new-database-class (file-truename filename)))
410 (defun semanticdb-directory-loaded-p (path)
411 "Return the project belonging to PATH if it was already loaded."
412 (eieio-instance-tracker-find path 'reference-directory 'semanticdb-database-list))
414 (defun semanticdb-create-table-for-file (filename)
415 "Initialize a database table for FILENAME, and return it.
416 If FILENAME exists in the database already, return that.
417 If there is no database for the table to live in, create one."
420 (dd (file-name-directory filename))
422 ;; Allow a database override function
423 (setq cdb (semanticdb-create-database semanticdb-new-database-class
425 ;; Get a table for this file.
426 (setq tbl (semanticdb-create-table cdb filename))
434 (defclass semanticdb-abstract-cache ()
435 ((table :initarg :table
436 :type semanticdb-abstract-table
438 "Cross reference to the table this belongs to.")
440 "Abstract baseclass for tools to use to cache information in semanticdb.
441 Tools needing a per-file cache must subclass this, and then get one as
442 needed. Cache objects are identified in semanticdb by subclass.
443 In order to keep your cache up to date, be sure to implement
444 `semanticdb-synchronize', and `semanticdb-partial-synchronize'.
445 See the file semantic-scope.el for an example."
448 (defmethod semanticdb-cache-get ((table semanticdb-abstract-table)
450 "Get a cache object on TABLE of class DESIRED-CLASS.
451 This method will create one if none exists with no init arguments
453 (unless (child-of-class-p desired-class 'semanticdb-abstract-cache)
454 (error "Invalid SemanticDB cache"))
455 (let ((cache (oref table cache))
457 (while (and (not obj) cache)
458 (if (eq (object-class-fast (car cache)) desired-class)
459 (setq obj (car cache)))
460 (setq cache (cdr cache)))
462 obj ;; Just return it.
463 ;; No object, lets create a new one and return that.
464 (setq obj (funcall desired-class "Cache" :table table))
465 (object-add-to-list table 'cache obj)
468 (defmethod semanticdb-cache-remove ((table semanticdb-abstract-table)
470 "Remove from TABLE the cache object CACHE."
471 (object-remove-from-list table 'cache cache))
473 (defmethod semanticdb-synchronize ((cache semanticdb-abstract-cache)
475 "Synchronize a CACHE with some NEW-TAGS."
476 ;; The abstract class will do... NOTHING!
479 (defmethod semanticdb-partial-synchronize ((cache semanticdb-abstract-cache)
481 "Synchronize a CACHE with some changed NEW-TAGS."
482 ;; The abstract class will do... NOTHING!
485 (defclass semanticdb-abstract-db-cache ()
487 :type semanticdb-project-database
489 "Cross reference to the database this belongs to.")
491 "Abstract baseclass for tools to use to cache information in semanticdb.
492 Tools needing a database cache must subclass this, and then get one as
493 needed. Cache objects are identified in semanticdb by subclass.
494 In order to keep your cache up to date, be sure to implement
495 `semanticdb-synchronize', and `semanticdb-partial-synchronize'.
496 See the file semantic-scope.el for an example."
499 (defmethod semanticdb-cache-get ((db semanticdb-project-database)
501 "Get a cache object on DB of class DESIRED-CLASS.
502 This method will create one if none exists with no init arguments
504 (unless (child-of-class-p desired-class 'semanticdb-abstract-cache)
505 (error "Invalid SemanticDB cache"))
506 (let ((cache (oref db cache))
508 (while (and (not obj) cache)
509 (if (eq (object-class-fast (car cache)) desired-class)
510 (setq obj (car cache)))
511 (setq cache (cdr cache)))
513 obj ;; Just return it.
514 ;; No object, lets create a new one and return that.
515 (setq obj (funcall desired-class "Cache" :db db))
516 (object-add-to-list db 'cache obj)
519 (defmethod semanticdb-cache-remove ((db semanticdb-project-database)
521 "Remove from TABLE the cache object CACHE."
522 (object-remove-from-list db 'cache cache))
525 (defmethod semanticdb-synchronize ((cache semanticdb-abstract-db-cache)
527 "Synchronize a CACHE with some NEW-TAGS."
528 ;; The abstract class will do... NOTHING!
531 (defmethod semanticdb-partial-synchronize ((cache semanticdb-abstract-db-cache)
533 "Synchronize a CACHE with some changed NEW-TAGS."
534 ;; The abstract class will do... NOTHING!
539 (defmethod semanticdb-refresh-table ((obj semanticdb-table) &optional force)
540 "If the tag list associated with OBJ is loaded, refresh it.
541 Optional argument FORCE will force a refresh even if the file in question
542 is not in a buffer. Avoid using FORCE for most uses, as an old cache
543 may be sufficient for the general case. Forced updates can be slow.
544 This will call `semantic-fetch-tags' if that file is in memory."
545 (when (or (semanticdb-in-buffer-p obj) force)
547 (semanticdb-set-buffer obj)
548 (semantic-fetch-tags))))
550 (defmethod semanticdb-needs-refresh-p ((obj semanticdb-table))
551 "Return non-nil of OBJ's tag list is out of date.
552 The file associated with OBJ does not need to be in a buffer."
553 (let* ((ff (semanticdb-full-filename obj))
554 (buff (semanticdb-in-buffer-p obj))
557 (with-current-buffer buff
558 ;; Use semantic's magic tracker to determine of the buffer is up
560 (not (semantic-parse-tree-up-to-date-p))
561 ;; We assume that semanticdb is keeping itself up to date.
562 ;; via all the clever hooks
564 ;; Buffer isn't loaded. The only clue we have is if the file
565 ;; is somehow different from our mark in the semanticdb table.
566 (let* ((stats (file-attributes ff))
567 (actualsize (nth 7 stats))
568 (actualmod (nth 5 stats))
571 (or (not (slot-boundp obj 'tags))
572 ;; (not (oref obj tags)) --> not needed anymore?
573 (/= (or (oref obj fsize) 0) actualsize)
574 (not (equal (oref obj lastmodtime) actualmod))
581 (defmethod semanticdb-synchronize ((table semanticdb-abstract-table)
583 "Synchronize the table TABLE with some NEW-TAGS."
584 (oset table tags new-tags)
585 (oset table pointmax (point-max))
586 (let ((fattr (file-attributes (semanticdb-full-filename table))))
587 (oset table fsize (nth 7 fattr))
588 (oset table lastmodtime (nth 5 fattr))
590 ;; Assume it is now up to date.
591 (oset table unmatched-syntax semantic-unmatched-syntax-cache)
592 ;; The lexical table should be good too.
593 (when (featurep 'semantic/lex-spp)
594 (oset table lexical-table (semantic-lex-spp-save-table)))
595 ;; this implies dirtyness
596 (semanticdb-set-dirty table)
598 ;; Synchronize the index
599 (when (slot-boundp table 'index)
600 (let ((idx (oref table index)))
601 (when idx (semanticdb-synchronize idx new-tags))))
603 ;; Synchronize application caches.
604 (dolist (C (oref table cache))
605 (semanticdb-synchronize C new-tags)
608 ;; Update cross references
609 ;; (semanticdb-refresh-references table)
612 (defmethod semanticdb-partial-synchronize ((table semanticdb-abstract-table)
614 "Synchronize the table TABLE where some NEW-TAGS changed."
615 ;; You might think we need to reset the tags, but since the partial
616 ;; parser splices the lists, we don't need to do anything
617 ;;(oset table tags new-tags)
618 ;; We do need to mark ourselves dirty.
619 (semanticdb-set-dirty table)
621 ;; The lexical table may be modified.
622 (when (featurep 'semantic/lex-spp)
623 (oset table lexical-table (semantic-lex-spp-save-table)))
625 ;; Incremental parser doesn't mokey around with this.
626 (oset table unmatched-syntax semantic-unmatched-syntax-cache)
628 ;; Synchronize the index
629 (when (slot-boundp table 'index)
630 (let ((idx (oref table index)))
631 (when idx (semanticdb-partial-synchronize idx new-tags))))
633 ;; Synchronize application caches.
634 (dolist (C (oref table cache))
635 (semanticdb-synchronize C new-tags)
638 ;; Update cross references
639 ;;(when (semantic-find-tags-by-class 'include new-tags)
640 ;; (semanticdb-refresh-references table))
645 (defmethod semanticdb-save-db ((DB semanticdb-project-database)
646 &optional supress-questions)
647 "Cause a database to save itself.
648 The database base class does not save itself persistently.
649 Subclasses could save themselves to a file, or to a database, or other
653 (defun semanticdb-save-current-db ()
654 "Save the current tag database."
656 (message "Saving current tag summaries...")
657 (semanticdb-save-db semanticdb-current-database)
658 (message "Saving current tag summaries...done"))
660 ;; This prevents Semanticdb from querying multiple times if the users
661 ;; answers "no" to creating the Semanticdb directory.
662 (defvar semanticdb--inhibit-create-file-directory)
664 (defun semanticdb-save-all-db ()
665 "Save all semantic tag databases."
667 (message "Saving tag summaries...")
668 (let ((semanticdb--inhibit-make-directory nil))
669 (mapc 'semanticdb-save-db semanticdb-database-list))
670 (message "Saving tag summaries...done"))
672 (defun semanticdb-save-all-db-idle ()
673 "Save all semantic tag databases from idle time.
674 Exit the save between databases if there is user input."
675 (semantic-safe "Auto-DB Save: %S"
676 (semantic-exit-on-input 'semanticdb-idle-save
678 (semantic-throw-on-input 'semanticdb-idle-save)
679 (semanticdb-save-db db t))
680 semanticdb-database-list))
683 ;;; Directory Project support
685 (defvar semanticdb-project-predicate-functions nil
686 "List of predicates to try that indicate a directory belongs to a project.
687 This list is used when `semanticdb-persistent-path' contains the value
688 'project. If the predicate list is nil, then presume all paths are valid.
690 Project Management software (such as EDE and JDE) should add their own
691 predicates with `add-hook' to this variable, and semanticdb will save tag
692 caches in directories controlled by them.")
694 (defmethod semanticdb-write-directory-p ((obj semanticdb-project-database))
695 "Return non-nil if OBJ should be written to disk.
696 Uses `semanticdb-persistent-path' to determine the return value."
701 ;; What is the current database, are two tables of an equivalent mode,
702 ;; and what databases are a part of the same project.
703 (defun semanticdb-current-database ()
704 "Return the currently active database."
705 (or semanticdb-current-database
706 (and default-directory
707 (semanticdb-create-database semanticdb-new-database-class
712 (defvar semanticdb-match-any-mode nil
713 "Non-nil to temporarily search any major mode for a tag.
714 If a particular major mode wants to search any mode, put the
715 `semantic-match-any-mode' symbol onto the symbol of that major mode.
716 Do not set the value of this variable permanently.")
718 (defmacro semanticdb-with-match-any-mode (&rest body)
719 "A Semanticdb search occurring withing BODY will search tags in all modes.
720 This temporarily sets `semanticdb-match-any-mode' while executing BODY."
721 `(let ((semanticdb-match-any-mode t))
723 (put 'semanticdb-with-match-any-mode 'lisp-indent-function 0)
725 (defmethod semanticdb-equivalent-mode-for-search (table &optional buffer)
726 "Return non-nil if TABLE's mode is equivalent to BUFFER.
727 See `semanticdb-equivalent-mode' for details.
728 This version is used during searches. Major-modes that opt
729 to set the `semantic-match-any-mode' property will be able to search
730 all files of any type."
731 (or (get major-mode 'semantic-match-any-mode)
732 semanticdb-match-any-mode
733 (semanticdb-equivalent-mode table buffer))
736 (defmethod semanticdb-equivalent-mode ((table semanticdb-abstract-table) &optional buffer)
737 "Return non-nil if TABLE's mode is equivalent to BUFFER.
738 Equivalent modes are specified by by `semantic-equivalent-major-modes'
742 (defmethod semanticdb-equivalent-mode ((table semanticdb-table) &optional buffer)
743 "Return non-nil if TABLE's mode is equivalent to BUFFER.
744 Equivalent modes are specified by by `semantic-equivalent-major-modes'
747 (if buffer (set-buffer buffer))
749 ;; nil major mode in table means we don't know yet. Assume yes for now?
750 (null (oref table major-mode))
751 ;; nil means the same as major-mode
752 (and (not semantic-equivalent-major-modes)
753 (mode-local-use-bindings-p major-mode (oref table major-mode)))
754 (and semantic-equivalent-major-modes
755 (member (oref table major-mode) semantic-equivalent-major-modes))
762 ;; These routines determine associations between a file, and multiple
763 ;; associated databases.
765 (defcustom semanticdb-project-roots nil
766 "*List of directories, where each directory is the root of some project.
767 All subdirectories of a root project are considered a part of one project.
768 Values in this string can be overridden by project management programs
769 via the `semanticdb-project-root-functions' variable."
771 :type '(repeat string))
773 (defvar semanticdb-project-root-functions nil
774 "List of functions used to determine a given directories project root.
775 Functions in this variable can override `semanticdb-project-roots'.
776 Functions set in the variable are given one argument (a directory) and
777 must return a string, (the root directory) or a list of strings (multiple
778 root directories in a more complex system). This variable should be used
779 by project management programs like EDE or JDE.")
781 (defvar semanticdb-project-system-databases nil
782 "List of databases containing system library information.
783 Mode authors can create their own system databases which know
784 detailed information about the system libraries for querying purposes.
785 Put those into this variable as a buffer-local, or mode-local
787 (make-variable-buffer-local 'semanticdb-project-system-databases)
789 (defvar semanticdb-search-system-databases t
790 "Non nil if search routines are to include a system database.")
792 (defun semanticdb-current-database-list (&optional dir)
793 "Return a list of databases associated with the current buffer.
794 If optional argument DIR is non-nil, then use DIR as the starting directory.
795 If this buffer has a database, but doesn't have a project associated
797 First, it checks `semanticdb-project-root-functions', and if that
798 has no results, it checks `semanticdb-project-roots'. If that fails,
799 it returns the results of function `semanticdb-current-database'.
800 Always append `semanticdb-project-system-databases' if
801 `semanticdb-search-system' is non-nil."
802 (let ((root nil) ; found root directory
803 (dbs nil) ; collected databases
804 (roots semanticdb-project-roots) ;all user roots
805 (dir (file-truename (or dir default-directory)))
807 ;; Find the root based on project functions.
808 (setq root (run-hook-with-args-until-success
809 'semanticdb-project-root-functions
811 ;; Find roots based on strings
812 (while (and roots (not root))
813 (let ((r (file-truename (car roots))))
814 (if (string-match (concat "^" (regexp-quote r)) dir)
816 (setq roots (cdr roots)))
818 ;; If no roots are found, use this directory.
819 (unless root (setq root dir))
821 ;; Find databases based on the root directory.
823 ;; The rootlist allows the root functions to possibly
824 ;; return several roots which are in different areas but
825 ;; all apart of the same system.
826 (let ((regexp (concat "^" (regexp-quote root)))
827 (adb semanticdb-database-list) ; all databases
830 ;; I don't like this part, but close enough.
831 (if (and (slot-boundp (car adb) 'reference-directory)
832 (string-match regexp (oref (car adb) reference-directory)))
833 (setq dbs (cons (car adb) dbs)))
834 (setq adb (cdr adb))))
836 ;; Add in system databases
837 (when semanticdb-search-system-databases
838 (setq dbs (nconc dbs semanticdb-project-system-databases)))
843 ;;; Generic Accessor Routines
845 ;; These routines can be used to get at tags in files w/out
846 ;; having to know a lot about semanticDB.
847 (defvar semanticdb-file-table-hash (make-hash-table :test 'equal)
848 "Hash table mapping file names to database tables.")
850 (defun semanticdb-file-table-object-from-hash (file)
851 "Retrieve a DB table from the hash for FILE.
852 Does not use `file-truename'."
853 (gethash file semanticdb-file-table-hash 'no-hit))
855 (defun semanticdb-file-table-object-put-hash (file dbtable)
856 "For FILE, associate DBTABLE in the hash table."
857 (puthash file dbtable semanticdb-file-table-hash))
860 (defun semanticdb-file-table-object (file &optional dontload)
861 "Return a semanticdb table belonging to FILE, make it up to date.
862 If file has database tags available in the database, return it.
863 If file does not have tags available, and DONTLOAD is nil,
864 then load the tags for FILE, and create a new table object for it.
865 DONTLOAD does not affect the creation of new database objects."
866 ;; (message "Object Translate: %s" file)
867 (when (file-exists-p file)
868 (let* ((default-directory (file-name-directory file))
869 (tab (semanticdb-file-table-object-from-hash file))
872 ;; If it is not in the cache, then extract the more traditional
873 ;; way by getting the database, and finding a table in that database.
874 ;; Once we have a table, add it to the hash.
875 (when (eq tab 'no-hit)
876 (setq fullfile (file-truename file))
877 (let ((db (or ;; This line will pick up system databases.
878 (semanticdb-directory-loaded-p default-directory)
879 ;; this line will make a new one if needed.
880 (semanticdb-get-database default-directory))))
881 (setq tab (semanticdb-file-table db fullfile))
883 (semanticdb-file-table-object-put-hash file tab)
884 (when (not (string= fullfile file))
885 (semanticdb-file-table-object-put-hash fullfile tab)
891 ;; Is this in a buffer?
892 ;;(find-buffer-visiting (semanticdb-full-filename tab))
893 (semanticdb-in-buffer-p tab)
896 ;;(set-buffer (find-buffer-visiting (semanticdb-full-filename tab)))
897 (semanticdb-set-buffer tab)
898 (semantic-fetch-tags)
902 ;; If we have table, and we don't want to load it, just return it.
905 ;; Is table fully loaded, or just a proxy?
906 (number-or-marker-p (oref tab pointmax))
907 ;; Is this table up to date with the file?
908 (not (semanticdb-needs-refresh-p tab)))
911 ((or (and fullfile (get-file-buffer fullfile))
912 (get-file-buffer file))
913 ;; are these two calls this faster than `find-buffer-visiting'?
915 ;; If FILE is being visited, but none of the above state is
916 ;; true (meaning, there is no table object associated with it)
917 ;; then it is a file not supported by Semantic, and can be safely
920 ((not dontload) ;; We must load the file.
921 ;; Full file should have been set by now. Debug why not?
922 (when (and (not tab) (not fullfile))
923 ;; This case is if a 'nil is erroneously put into the hash table. This
925 (setq fullfile (file-truename file))
928 ;; If we have a table, but no fullfile, that's ok. Lets get the filename
929 ;; from the table which is pre-truenamed.
930 (when (and (not fullfile) tab)
931 (setq fullfile (semanticdb-full-filename tab)))
933 (setq tab (semanticdb-create-table-for-file-not-in-buffer fullfile))
935 ;; Save the new table.
936 (semanticdb-file-table-object-put-hash file tab)
937 (when (not (string= fullfile file))
938 (semanticdb-file-table-object-put-hash fullfile tab)
943 ;; Full file should have been set by now. Debug why not?
944 ;; One person found this. Is it a file that failed to parse
947 (setq fullfile (file-truename file)))
949 ;; We were asked not to load the file in and parse it.
950 ;; Instead just create a database table with no tags
951 ;; and a claim of being empty.
953 ;; This will give us a starting point for storing
954 ;; database cross-references so when it is loaded,
955 ;; the cross-references will fire and caches will
957 (let ((ans (semanticdb-create-table-for-file file)))
960 ;; Save the new table.
961 (semanticdb-file-table-object-put-hash file tab)
962 (when (not (string= fullfile file))
963 (semanticdb-file-table-object-put-hash fullfile tab)
970 (defvar semanticdb-out-of-buffer-create-table-fcn nil
971 "When non-nil, a function for creating a semanticdb table.
972 This should take a filename to be parsed.")
973 (make-variable-buffer-local 'semanticdb-out-of-buffer-create-table-fcn)
975 (defun semanticdb-create-table-for-file-not-in-buffer (filename)
976 "Create a table for the file FILENAME.
977 If there are no language specific configurations, this
978 function will read in the buffer, parse it, and kill the buffer."
979 (if (and semanticdb-out-of-buffer-create-table-fcn
980 (not (file-remote-p filename)))
981 ;; Use external parser only of the file is accessible to the
982 ;; local file system.
983 (funcall semanticdb-out-of-buffer-create-table-fcn filename)
985 (let* ( ;; Remember the buffer to kill
986 (kill-buffer-flag (find-buffer-visiting filename))
987 (buffer-to-kill (or kill-buffer-flag
988 (semantic-find-file-noselect filename t))))
990 ;; This shouldn't ever be set. Debug some issue here?
991 ;; (when kill-buffer-flag (debug))
993 (set-buffer buffer-to-kill)
994 ;; Find file should automatically do this for us.
995 ;; Sometimes the DB table doesn't contains tags and needs
996 ;; a refresh. For example, when the file is loaded for
997 ;; the first time, and the idle scheduler didn't get a
998 ;; chance to trigger a parse before the file buffer is
1000 (when semanticdb-current-table
1001 (semantic-fetch-tags))
1003 semanticdb-current-table
1004 (when (not kill-buffer-flag)
1005 ;; If we had to find the file, then we should kill it
1006 ;; to keep the master buffer list clean.
1007 (kill-buffer buffer-to-kill)
1011 (defun semanticdb-file-stream (file)
1012 "Return a list of tags belonging to FILE.
1013 If file has database tags available in the database, return them.
1014 If file does not have tags available, then load the file, and create them."
1015 (let ((table (semanticdb-file-table-object file)))
1017 (semanticdb-get-tags table))))
1019 (provide 'semantic/db)
1022 ;; generated-autoload-file: "loaddefs.el"
1023 ;; generated-autoload-load-name: "semantic/db"
1026 ;; arch-tag: d9f75280-737d-494f-9f70-09a649d27433
1027 ;;; semantic/db.el ends here