Mercurial > emacs
annotate lisp/cedet/semantic/doc.el @ 110523:a5ad4f188e19
Synch Semantic to CEDET 1.0.
Move CEDET ChangeLog entries to new file lisp/cedet/ChangeLog.
* semantic.el (semantic-version): Update to 2.0.
(semantic-mode-map): Add "," and "m" bindings.
(navigate-menu): Update.
* semantic/symref.el (semantic-symref-calculate-rootdir):
New function.
(semantic-symref-detect-symref-tool): Use it.
* semantic/symref/grep.el (semantic-symref-grep-shell): New var.
(semantic-symref-perform-search): Use it. Calculate root dir with
semantic-symref-calculate-rootdir.
(semantic-symref-derive-find-filepatterns): Improve error message.
* semantic/symref/list.el
(semantic-symref-results-mode-map): New bindings.
(semantic-symref-auto-expand-results): New option.
(semantic-symref-results-dump): Obey auto-expand.
(semantic-symref-list-expand-all, semantic-symref-regexp)
(semantic-symref-list-contract-all)
(semantic-symref-list-map-open-hits)
(semantic-symref-list-update-open-hits)
(semantic-symref-list-create-macro-on-open-hit)
(semantic-symref-list-call-macro-on-open-hits): New functions.
(semantic-symref-list-menu-entries)
(semantic-symref-list-menu): New vars.
(semantic-symref-list-map-open-hits): Move cursor to beginning of
match before calling the mapped function.
* semantic/doc.el
(semantic-documentation-comment-preceeding-tag): Do nothing if the
mode doesn't provide comment-start-skip.
* semantic/scope.el
(semantic-analyze-scope-nested-tags-default): Strip duplicates.
(semantic-analyze-scoped-inherited-tag-map): Take the tag we are
looking for as part of the scoped tags list.
* semantic/html.el (semantic-default-html-setup): Add
senator-step-at-tag-classes.
* semantic/decorate/include.el
(semantic-decoration-on-unknown-includes): Change light bgcolor.
(semantic-decoration-on-includes-highlight-default): Check that
the include tag has a postion.
* semantic/complete.el (semantic-collector-local-members):
(semantic-complete-read-tag-local-members)
(semantic-complete-jump-local-members): New class and functions.
(semantic-complete-self-insert): Save excursion before completing.
* semantic/analyze/complete.el
(semantic-analyze-possible-completions-default): If no completions
are found, return the raw by-name-only completion list. Add FLAGS
arguments. Add support for 'no-tc (type constraint) and
'no-unique, or no stripping duplicates.
(semantic-analyze-possible-completions-default): Add FLAGS arg.
* semantic/util-modes.el
(semantic-stickyfunc-show-only-functions-p): New option.
(semantic-stickyfunc-fetch-stickyline): Don't show stickytext for
the very first line in a buffer.
* semantic/util.el (semantic-hack-search)
(semantic-recursive-find-nonterminal-by-name)
(semantic-current-tag-interactive): Deleted.
(semantic-describe-buffer): Fix expand-nonterminal. Add
lex-syntax-mods, type relation separator char, and command
separation char.
(semantic-sanity-check): Only message if called interactively.
* semantic/tag.el (semantic-tag-deep-copy-one-tag): Copy the
:filename property and the tag position.
* semantic/lex-spp.el (semantic-lex-spp-lex-text-string):
Add recursion limit.
* semantic/imenu.el (semantic-imenu-bucketize-type-members):
Make this buffer local, not the obsoleted variable.
* semantic/idle.el: Add breadcrumbs support.
(semantic-idle-summary-current-symbol-info-default)
(semantic-idle-tag-highlight)
(semantic-idle-completion-list-default): Use
semanticdb-without-unloaded-file-searches for speed, and to
conform to the controls that specify if the idle timer is supposed
to be parsing unparsed includes.
(semantic-idle-symbol-highlight-face)
(semantic-idle-symbol-maybe-highlight): Rename from *-summary-*.
Callers changed.
(semantic-idle-work-parse-neighboring-files-flag): Default to nil.
(semantic-idle-work-update-headers-flag): New var.
(semantic-idle-work-for-one-buffer): Use it.
(semantic-idle-local-symbol-highlight): Rename from
semantic-idle-tag-highlight.
(semantic-idle-truncate-long-summaries): New option.
* semantic/ia.el (semantic-ia-cache)
(semantic-ia-get-completions): Deleted. Callers changed.
(semantic-ia-show-variants): New command.
(semantic-ia-show-doc): If doc is empty, don't make a temp buffer.
(semantic-ia-show-summary): If there isn't anything to show, say so.
* semantic/grammar.el (semantic-grammar-create-package):
Save the buffer even in batch mode.
* semantic/fw.el
(semanticdb-without-unloaded-file-searches): New macro.
* semantic/dep.el (semantic-dependency-find-file-on-path):
Fix case dereferencing ede-object when it is a list.
* semantic/db-typecache.el (semanticdb-expand-nested-tag)
(semanticdb-typecache-faux-namespace): New functions.
(semanticdb-typecache-file-tags)
(semanticdb-typecache-merge-streams): Use them.
(semanticdb-typecache-file-tags): When deriving tags from a file,
give the mode a chance to monkey with the tag copy.
(semanticdb-typecache-find-default): Wrap find in save-excursion.
(semanticdb-typecache-find-by-name-helper): Merge found names down.
* semantic/db-global.el
(semanticdb-enable-gnu-global-in-buffer): Don't show messages if
GNU Global is not available and we don't want to throw an error.
* semantic/db-find.el (semanticdb-find-result-nth-in-buffer):
When trying to normalize the tag to a buffer, don't error if
set-buffer method doesn't exist.
* semantic/db-file.el (semanticdb-save-db): Simplify msg.
* semantic/db.el (semanticdb-refresh-table): If forcing a
refresh on a file not in a buffer, use semantic-find-file-noselect
and delete the buffer after use.
(semanticdb-current-database-list): When calculating root via
hooks, force it through true-filename and skip the list of
possible roots.
* semantic/ctxt.el (semantic-ctxt-imported-packages): New.
* semantic/analyze/debug.el
(semantic-analyzer-debug-insert-tag): Reset standard output to
current buffer.
(semantic-analyzer-debug-global-symbol)
(semantic-analyzer-debug-missing-innertype): Change "prefix" to
"symbol" in messages.
* semantic/analyze/refs.el: (semantic-analyze-refs-impl)
(semantic-analyze-refs-proto): When calculating value, make sure
the found tag is 'similar' to the originating tag.
(semantic--analyze-refs-find-tags-with-parent): Attempt to
identify matches via imported symbols of parents.
(semantic--analyze-refs-full-lookup-with-parents): Do a deep
search during the brute search.
* semantic/analyze.el
(semantic-analyze-find-tag-sequence-default): Be robust to
calculated scopes being nil.
* semantic/bovine/c.el (semantic-c-describe-environment): Add
project macro symbol array.
(semantic-c-parse-lexical-token): Add recursion limit.
(semantic-ctxt-imported-packages, semanticdb-expand-nested-tag):
New overrides.
(semantic-expand-c-tag-namelist): Split a full type from a typedef
out to its own tag.
(semantic-expand-c-tag-namelist): Do not split out a typedef'd
inline type if it is an anonymous type.
(semantic-c-reconstitute-token): Use the optional initializers as
a clue that some function is probably a constructor. When
defining the type of these constructors, split the parent name,
and use only the class part, if applicable.
* semantic/bovine/c-by.el:
* semantic/wisent/python-wy.el: Regenerate.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Sat, 18 Sep 2010 22:49:54 -0400 |
parents | 1d1d5d9bd884 |
children | 376148b31b5e |
rev | line source |
---|---|
104442
b22b44e953cb
cedet/semantic/chart.el: Don't require semantic/find.
Chong Yidong <cyd@stupidchicken.com>
parents:
104421
diff
changeset
|
1 ;;; semantic/doc.el --- Routines for documentation strings |
104421 | 2 |
106815 | 3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009, 2010 |
105340 | 4 ;; Free Software Foundation, Inc. |
104421 | 5 |
6 ;; Author: Eric M. Ludlam <zappo@gnu.org> | |
7 ;; Keywords: syntax | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
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. | |
15 | |
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. | |
20 | |
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/>. | |
23 | |
24 ;;; Commentary: | |
25 ;; | |
105340 | 26 ;; It is good practice to write documentation for your functions and |
104421 | 27 ;; variables. These core routines deal with these documentation |
28 ;; comments or strings. They can exist either as a tag property | |
29 ;; (:documentation) or as a comment just before the symbol, or after | |
30 ;; the symbol on the same line. | |
31 | |
32 (require 'semantic/tag) | |
33 | |
34 ;;; Code: | |
35 | |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
36 ;;;###autoload |
104421 | 37 (define-overloadable-function semantic-documentation-for-tag (&optional tag nosnarf) |
38 "Find documentation from TAG and return it as a clean string. | |
39 TAG might have DOCUMENTATION set in it already. If not, there may be | |
40 some documentation in a comment preceding TAG's definition which we | |
41 can look for. When appropriate, this can be overridden by a language specific | |
42 enhancement. | |
43 Optional argument NOSNARF means to only return the lexical analyzer token for it. | |
44 If nosnarf if 'lex, then only return the lex token." | |
45 (if (not tag) (setq tag (semantic-current-tag))) | |
46 (save-excursion | |
47 (when (semantic-tag-with-position-p tag) | |
48 (set-buffer (semantic-tag-buffer tag))) | |
49 (:override | |
50 ;; No override. Try something simple to find documentation nearby | |
51 (save-excursion | |
52 (semantic-go-to-tag tag) | |
53 (let ((doctmp (semantic-tag-docstring tag (current-buffer)))) | |
54 (or | |
55 ;; Is there doc in the tag??? | |
56 doctmp | |
57 ;; Check just before the definition. | |
58 (when (semantic-tag-with-position-p tag) | |
59 (semantic-documentation-comment-preceeding-tag tag nosnarf)) | |
60 ;; Lets look for comments either after the definition, but before code: | |
61 ;; Not sure yet. Fill in something clever later.... | |
62 nil)))))) | |
63 | |
105340 | 64 ;; FIXME this is not how you spell "preceding". |
104421 | 65 (defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf) |
105340 | 66 "Find a comment preceding TAG. |
104421 | 67 If TAG is nil. use the tag under point. |
105340 | 68 Searches the space between TAG and the preceding tag for a comment, |
104421 | 69 and converts the comment into clean documentation. |
70 Optional argument NOSNARF with a value of 'lex means to return | |
71 just the lexical token and not the string." | |
72 (if (not tag) (setq tag (semantic-current-tag))) | |
73 (save-excursion | |
74 ;; Find this tag. | |
75 (semantic-go-to-tag tag) | |
76 (let* ((starttag (semantic-find-tag-by-overlay-prev | |
77 (semantic-tag-start tag))) | |
78 (start (if starttag | |
79 (semantic-tag-end starttag) | |
80 (point-min)))) | |
110523
a5ad4f188e19
Synch Semantic to CEDET 1.0.
Chong Yidong <cyd@stupidchicken.com>
parents:
106815
diff
changeset
|
81 (when (and comment-start-skip |
a5ad4f188e19
Synch Semantic to CEDET 1.0.
Chong Yidong <cyd@stupidchicken.com>
parents:
106815
diff
changeset
|
82 (re-search-backward comment-start-skip start t)) |
104421 | 83 ;; We found a comment that doesn't belong to the body |
84 ;; of a function. | |
85 (semantic-doc-snarf-comment-for-tag nosnarf))) | |
86 )) | |
87 | |
88 (defun semantic-doc-snarf-comment-for-tag (nosnarf) | |
89 "Snarf up the comment at POINT for `semantic-documentation-for-tag'. | |
90 Attempt to strip out comment syntactic sugar. | |
91 Argument NOSNARF means don't modify the found text. | |
92 If NOSNARF is 'lex, then return the lex token." | |
93 (let* ((semantic-ignore-comments nil) | |
94 (semantic-lex-analyzer #'semantic-comment-lexer)) | |
95 (if (memq nosnarf '(lex flex)) ;; keep `flex' for compatibility | |
96 (car (semantic-lex (point) (1+ (point)))) | |
97 (let ((ct (semantic-lex-token-text | |
98 (car (semantic-lex (point) (1+ (point))))))) | |
99 (if nosnarf | |
100 nil | |
101 ;; ok, try to clean the text up. | |
102 ;; Comment start thingy | |
103 (while (string-match (concat "^\\s-*" comment-start-skip) ct) | |
104 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
105 (substring ct (match-end 0))))) | |
106 ;; Arbitrary punctuation at the beginning of each line. | |
107 (while (string-match "^\\s-*\\s.+\\s-*" ct) | |
108 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
109 (substring ct (match-end 0))))) | |
110 ;; End of a block comment. | |
111 (if (and (boundp 'block-comment-end) | |
112 block-comment-end | |
113 (string-match block-comment-end ct)) | |
114 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
115 (substring ct (match-end 0))))) | |
116 ;; In case it's a real string, STRIPIT. | |
117 (while (string-match "\\s-*\\s\"+\\s-*" ct) | |
118 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
119 (substring ct (match-end 0)))))) | |
120 ;; Now return the text. | |
121 ct)))) | |
122 | |
123 (provide 'semantic/doc) | |
124 | |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
125 ;; Local variables: |
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
126 ;; generated-autoload-file: "loaddefs.el" |
104447
273e528a9f9b
* emacs-lisp/autoload.el (generated-autoload-load-name): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
104444
diff
changeset
|
127 ;; generated-autoload-load-name: "semantic/doc" |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
128 ;; End: |
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
129 |
105377 | 130 ;; arch-tag: fe6e965b-4a81-4304-aab8-22ca113194ca |
104442
b22b44e953cb
cedet/semantic/chart.el: Don't require semantic/find.
Chong Yidong <cyd@stupidchicken.com>
parents:
104421
diff
changeset
|
131 ;;; semantic/doc.el ends here |