1 ;;; ebrowse.el --- Emacs C++ class browser & tags facility
3 ;; Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;; Free Software Foundation Inc.
6 ;; Author: Gerd Moellmann <gerd@gnu.org>
8 ;; Keywords: C++ tags tools
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
28 ;; This package implements
30 ;; - A class browser for C++
31 ;; - A complete set of tags-like functions working on class trees
32 ;; - An electric buffer list showing class browser buffers only
34 ;; Documentation is found in a separate Info file.
50 "Settings for the C++ class browser."
54 (defcustom ebrowse-search-path nil
55 "*List of directories to search for source files in a class tree.
56 Elements should be directory names; nil as an element means to try
57 to find source files relative to the location of the BROWSE file loaded."
59 :type '(repeat (choice (const :tag "Default" nil)
60 (string :tag "Directory"))))
63 (defcustom ebrowse-view/find-hook nil
64 "*Hooks run after finding or viewing a member or class."
69 (defcustom ebrowse-not-found-hook nil
70 "*Hooks run when finding or viewing a member or class was not successful."
75 (defcustom ebrowse-electric-list-mode-hook nil
76 "*Hook called by `ebrowse-electric-position-mode'."
81 (defcustom ebrowse-max-positions 50
82 "*Number of markers saved on electric position stack."
88 (defgroup ebrowse-tree nil
89 "Settings for class tree buffers."
93 (defcustom ebrowse-tree-mode-hook nil
94 "*Hook run in each new tree buffer."
99 (defcustom ebrowse-tree-buffer-name "*Tree*"
100 "*The default name of class tree buffers."
105 (defcustom ebrowse--indentation 4
106 "*The amount by which subclasses are indented in the tree."
111 (defcustom ebrowse-source-file-column 40
112 "*The column in which source file names are displayed in the tree."
117 (defcustom ebrowse-tree-left-margin 2
118 "*Amount of space left at the left side of the tree display.
119 This space is used to display markers."
125 (defgroup ebrowse-member nil
126 "Settings for member buffers."
130 (defcustom ebrowse-default-declaration-column 25
131 "*The column in which member declarations are displayed in member buffers."
132 :group 'ebrowse-member
136 (defcustom ebrowse-default-column-width 25
137 "*The width of the columns in member buffers (short display form)."
138 :group 'ebrowse-member
142 (defcustom ebrowse-member-buffer-name "*Members*"
143 "*The name of the buffer for member display."
144 :group 'ebrowse-member
148 (defcustom ebrowse-member-mode-hook nil
149 "*Run in each new member buffer."
150 :group 'ebrowse-member
155 (defgroup ebrowse-faces nil
156 "Faces used by Ebrowse."
160 (defface ebrowse-tree-mark-face
161 '((t (:foreground "red")))
162 "*The face used for the mark character in the tree."
163 :group 'ebrowse-faces)
166 (defface ebrowse-root-class-face
167 '((t (:weight bold :foreground "blue")))
168 "*The face used for root classes in the tree."
169 :group 'ebrowse-faces)
172 (defface ebrowse-file-name-face
174 "*The face for filenames displayed in the tree."
175 :group 'ebrowse-faces)
178 (defface ebrowse-default-face
180 "*Face for everything else in the tree not having other faces."
181 :group 'ebrowse-faces)
184 (defface ebrowse-member-attribute-face
185 '((t (:foreground "red")))
186 "*Face used to display member attributes."
187 :group 'ebrowse-faces)
190 (defface ebrowse-member-class-face
191 '((t (:foreground "purple")))
192 "*Face used to display the class title in member buffers."
193 :group 'ebrowse-faces)
196 (defface ebrowse-progress-face
197 '((t (:background "blue")))
198 "*Face for progress indicator."
199 :group 'ebrowse-faces)
205 (defun ebrowse-some (predicate vector)
206 "Return true if PREDICATE is true of some element of VECTOR.
207 If so, return the value returned by PREDICATE."
208 (let ((length (length vector))
211 (while (and (< i length) (not result))
212 (setq result (funcall predicate (aref vector i))
217 (defun ebrowse-every (predicate vector)
218 "Return true if PREDICATE is true of every element of VECTOR."
219 (let ((length (length vector))
222 (while (and (< i length) result)
223 (setq result (funcall predicate (aref vector i))
228 (defun ebrowse-position (item list &optional test)
229 "Return the position of ITEM in LIST or nil if not found.
230 Compare items with `eq' or TEST if specified."
234 (when (funcall test item (car list))
235 (setq found i list nil))
236 (setq list (cdr list) i (1+ i))))
239 (when (eq item (car list))
240 (setq found i list nil))
241 (setq list (cdr list) i (1+ i)))))
245 (defun ebrowse-delete-if-not (predicate list)
246 "Remove elements not satisfying PREDICATE from LIST and return the result.
247 This is a destructive operation."
250 (let ((next (cdr list)))
251 (when (funcall predicate (car list))
252 (setq result (nconc result list))
253 (setf (cdr list) nil))
258 (defmacro ebrowse-output (&rest body)
259 "Eval BODY with a writable current buffer.
260 Preserve buffer's modified state."
261 (let ((modified (gensym "--ebrowse-output--")))
262 `(let (buffer-read-only (,modified (buffer-modified-p)))
265 (set-buffer-modified-p ,modified)))))
268 (defmacro ebrowse-ignoring-completion-case (&rest body)
269 "Eval BODY with `completion-ignore-case' bound to t."
270 `(let ((completion-ignore-case t))
274 (defmacro ebrowse-save-selective (&rest body)
275 "Eval BODY with `selective-display' restored at the end."
276 (let ((var (make-symbol "var")))
277 `(let ((,var selective-display))
280 (setq selective-display ,var)))))
283 (defmacro ebrowse-for-all-trees (spec &rest body)
284 "For all trees in SPEC, eval BODY."
285 (let ((var (make-symbol "var"))
286 (spec-var (car spec))
288 `(loop for ,var being the symbols of ,array
289 as ,spec-var = (get ,var 'ebrowse-root) do
290 (when (vectorp ,spec-var)
293 ;;; Set indentation for macros above.
295 (put 'ebrowse-output 'lisp-indent-hook 0)
296 (put 'ebrowse-ignoring-completion-case 'lisp-indent-hook 0)
297 (put 'ebrowse-save-selective 'lisp-indent-hook 0)
298 (put 'ebrowse-for-all-trees 'lisp-indent-hook 1)
301 (defsubst ebrowse-set-face (start end face)
302 "Set face of a region START END to FACE."
303 (overlay-put (make-overlay start end) 'face face))
306 (defun ebrowse-completing-read-value (prompt table initial-input)
307 "Read a string in the minibuffer, with completion.
308 Case is ignored in completions.
310 PROMPT is a string to prompt with; normally it ends in a colon and a space.
311 TABLE is an alist whose elements' cars are strings, or an obarray.
312 TABLE can also be a function to do the completion itself.
313 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
314 If it is (STRING . POSITION), the initial input
315 is STRING, but point is placed POSITION characters into the string."
316 (ebrowse-ignoring-completion-case
317 (completing-read prompt table nil t initial-input)))
320 (defun ebrowse-value-in-buffer (sym buffer)
321 "Return the value of SYM in BUFFER."
322 (let ((old-buffer (current-buffer)))
327 (set-buffer old-buffer))))
330 (defun ebrowse-rename-buffer (new-name)
331 "Rename current buffer to NEW-NAME.
332 If a buffer with name NEW-NAME already exists, delete it first."
333 (let ((old-buffer (get-buffer new-name)))
334 (unless (eq old-buffer (current-buffer))
336 (save-excursion (kill-buffer old-buffer)))
337 (rename-buffer new-name))))
340 (defun ebrowse-trim-string (string)
341 "Return a copy of STRING with leading white space removed.
342 Replace sequences of newlines with a single space."
343 (when (string-match "^[ \t\n\r]+" string)
344 (setq string (substring string (match-end 0))))
345 (loop while (string-match "[\n]+" string)
346 finally return string do
347 (setq string (replace-match " " nil t string))))
350 (defun ebrowse-width-of-drawable-area ()
351 "Return the width of the display area for the current buffer.
352 If buffer is displayed in a window, use that window's width,
353 otherwise use the current frame's width."
354 (let ((window (get-buffer-window (current-buffer))))
356 (window-width window)
360 ;;; Structure definitions
362 (defstruct (ebrowse-hs (:type vector) :named)
363 "Header structure found at the head of BROWSE files."
364 ;; A version string that is compared against the version number of
365 ;; the Lisp package when the file is loaded. This is done to
366 ;; detect file format changes.
368 ;; Command line options used for producing the BROWSE file.
370 ;; The following slot is currently not used. It's kept to keep
371 ;; the file format compatible.
373 ;; A slot that is filled out after the tree is loaded. This slot is
374 ;; set to a hash table mapping members to lists of classes in which
379 (defstruct (ebrowse-ts (:type vector) :named)
381 Following the header structure, a BROWSE file contains a number
382 of `ebrowse-ts' structures, each one describing one root class of
383 the class hierarchy with all its subclasses."
384 ;; A `ebrowse-cs' structure describing the root class.
386 ;; A list of `ebrowse-ts' structures for all subclasses.
388 ;; Lists of `ebrowse-ms' structures for each member in a group of
390 member-variables member-functions static-variables static-functions
392 ;; List of `ebrowse-ts' structures for base classes. This slot is
393 ;; filled at load time.
395 ;; A marker slot used in the tree buffer (can be saved back to disk.
399 (defstruct (ebrowse-bs (:type vector) :named)
400 "Common sub-structure.
401 A common structure defining an occurrence of some name in the
403 ;; The class or member name as a string constant
405 ;; An optional string for the scope of nested classes or for
408 ;; Various flags describing properties of classes/members, e.g. is
409 ;; template, is const etc.
411 ;; File in which the entity is found. If this is part of a
412 ;; `ebrowse-ms' member description structure, and FILE is nil, then
413 ;; search for the name in the SOURCE-FILE of the members class.
415 ;; Regular expression to search for. This slot can be a number in
416 ;; which case the number is the file position at which the regular
417 ;; expression is found in a separate regexp file (see the header
418 ;; structure). This slot can be nil in which case the regular
419 ;; expression will be generated from the class/member name.
421 ;; The buffer position at which the search for the class or member
426 (defstruct (ebrowse-cs (:include ebrowse-bs) (:type vector) :named)
428 This is the structure stored in the CLASS slot of a `ebrowse-ts'
429 structure. It describes the location of the class declaration."
433 (defstruct (ebrowse-ms (:include ebrowse-bs) (:type vector) :named)
435 This is the structure describing a single member. The `ebrowse-ts'
436 structure contains various lists for the different types of
438 ;; Public, protected, private
440 ;; The file in which the member's definition can be found.
442 ;; Same as PATTERN above, but for the member definition.
444 ;; Same as POINT above but for member definition.
449 ;;; Some macros to access the FLAGS slot of a MEMBER.
451 (defsubst ebrowse-member-bit-set-p (member bit)
452 "Value is non-nil if MEMBER's bit BIT is set."
453 (/= 0 (logand (ebrowse-bs-flags member) bit)))
456 (defsubst ebrowse-virtual-p (member)
457 "Value is non-nil if MEMBER is virtual."
458 (ebrowse-member-bit-set-p member 1))
461 (defsubst ebrowse-inline-p (member)
462 "Value is non-nil if MEMBER is inline."
463 (ebrowse-member-bit-set-p member 2))
466 (defsubst ebrowse-const-p (member)
467 "Value is non-nil if MEMBER is const."
468 (ebrowse-member-bit-set-p member 4))
471 (defsubst ebrowse-pure-virtual-p (member)
472 "Value is non-nil if MEMBER is a pure virtual function."
473 (ebrowse-member-bit-set-p member 8))
476 (defsubst ebrowse-mutable-p (member)
477 "Value is non-nil if MEMBER is mutable."
478 (ebrowse-member-bit-set-p member 16))
481 (defsubst ebrowse-template-p (member)
482 "Value is non-nil if MEMBER is a template."
483 (ebrowse-member-bit-set-p member 32))
486 (defsubst ebrowse-explicit-p (member)
487 "Value is non-nil if MEMBER is explicit."
488 (ebrowse-member-bit-set-p member 64))
491 (defsubst ebrowse-throw-list-p (member)
492 "Value is non-nil if MEMBER has a throw specification."
493 (ebrowse-member-bit-set-p member 128))
496 (defsubst ebrowse-extern-c-p (member)
497 "Value is non-nil if MEMBER.is `extern \"C\"'."
498 (ebrowse-member-bit-set-p member 256))
501 (defsubst ebrowse-define-p (member)
502 "Value is non-nil if MEMBER is a define."
503 (ebrowse-member-bit-set-p member 512))
506 (defconst ebrowse-version-string "ebrowse 5.0"
507 "Version string expected in BROWSE files.")
510 (defconst ebrowse-globals-name "*Globals*"
511 "The name used for the surrogate class.containing global entities.
512 This must be the same that `ebrowse' uses.")
515 (defvar ebrowse--last-regexp nil
516 "Last regular expression searched for in tree and member buffers.
517 Each tree and member buffer maintains its own search history.")
518 (make-variable-buffer-local 'ebrowse--last-regexp)
521 (defconst ebrowse-member-list-accessors
522 '(ebrowse-ts-member-variables
523 ebrowse-ts-member-functions
524 ebrowse-ts-static-variables
525 ebrowse-ts-static-functions
528 "List of accessors for member lists.
529 Each element is the symbol of an accessor function.
530 The nth element must be the accessor for the nth member list
531 in an `ebrowse-ts' structure.")
534 ;;; FIXME: Add more doc strings for the buffer-local variables below.
536 (defvar ebrowse--tree-obarray nil
537 "Obarray holding all `ebrowse-ts' structures of a class tree.
538 Buffer-local in Ebrowse buffers.")
541 (defvar ebrowse--tags-file-name nil
542 "File from which BROWSE file was loaded.
543 Buffer-local in Ebrowse buffers.")
546 (defvar ebrowse--header nil
547 "Header structure of type `ebrowse-hs' of a class tree.
548 Buffer-local in Ebrowse buffers.")
551 (defvar ebrowse--frozen-flag nil
552 "Non-nil means an Ebrowse buffer won't be reused.
553 Buffer-local in Ebrowse buffers.")
556 (defvar ebrowse--show-file-names-flag nil
557 "Non-nil means show file names in a tree buffer.
558 Buffer-local in Ebrowse tree buffers.")
561 (defvar ebrowse--long-display-flag nil
562 "Non-nil means show members in long display form.
563 Buffer-local in Ebrowse member buffers.")
566 (defvar ebrowse--n-columns nil
567 "Number of columns to display for short member display form.
568 Buffer-local in Ebrowse member buffers.")
571 (defvar ebrowse--column-width nil
572 "Width of a columns to display for short member display form.
573 Buffer-local in Ebrowse member buffers.")
576 (defvar ebrowse--virtual-display-flag nil
577 "Non-nil means display virtual members in a member buffer.
578 Buffer-local in Ebrowse member buffers.")
581 (defvar ebrowse--inline-display-flag nil
582 "Non-nil means display inline members in a member buffer.
583 Buffer-local in Ebrowse member buffers.")
586 (defvar ebrowse--const-display-flag nil
587 "Non-nil means display const members in a member buffer.
588 Buffer-local in Ebrowse member buffers.")
591 (defvar ebrowse--pure-display-flag nil
592 "Non-nil means display pure virtual members in a member buffer.
593 Buffer-local in Ebrowse member buffers.")
596 (defvar ebrowse--filters nil
597 "Filter for display of public, protected, and private members.
598 This is a vector of three elements. An element nil means the
599 corresponding members are not shown.
600 Buffer-local in Ebrowse member buffers.")
603 (defvar ebrowse--show-inherited-flag nil
604 "Non-nil means display inherited members in a member buffer.
605 Buffer-local in Ebrowse member buffers.")
608 (defvar ebrowse--attributes-flag nil
609 "Non-nil means display member attributes in a member buffer.
610 Buffer-local in Ebrowse member buffers.")
613 (defvar ebrowse--source-regexp-flag nil
614 "Non-nil means display member regexps in a member buffer.
615 Buffer-local in Ebrowse member buffers.")
618 (defvar ebrowse--displayed-class nil
619 "Class displayed in a member buffer, a `ebrowse-ts' structure.
620 Buffer-local in Ebrowse member buffers.")
623 (defvar ebrowse--accessor nil
624 "Member list displayed in a member buffer.
625 This is a symbol whose function definition is an accessor for the
626 member list in `ebrowse-cs' structures.
627 Buffer-local in Ebrowse member buffers.")
630 (defvar ebrowse--member-list nil
631 "The list of `ebrowse-ms' structures displayed in a member buffer.
632 Buffer-local in Ebrowse member buffers.")
635 (defvar ebrowse--decl-column nil
636 "Column in which declarations are displayed in member buffers.
637 Buffer-local in Ebrowse member buffers.")
640 (defvar ebrowse--frame-configuration nil
641 "Frame configuration saved when viewing a class/member in another frame.
642 Buffer-local in Ebrowse buffers.")
645 (defvar ebrowse--view-exit-action nil
646 "Action to perform after viewing a class/member.
647 Either `kill-buffer' or nil.
648 Buffer-local in Ebrowse buffers.")
651 (defvar ebrowse--tree nil
653 Buffer-local in Ebrowse buffers.")
656 ;;; Temporaries used to communicate with `ebrowse-find-pattern'.
658 (defvar ebrowse-temp-position-to-view nil)
659 (defvar ebrowse-temp-info-to-view nil)
662 (defvar ebrowse-tree-mode-map ()
663 "The keymap used in tree mode buffers.")
666 (defvar ebrowse--member-mode-strings nil
667 "Strings displayed in the mode line of member buffers.")
670 (defvar ebrowse-member-mode-map ()
671 "The keymap used in the member buffers.")
674 ;;; Define mode line titles for each member list.
676 (put 'ebrowse-ts-member-variables 'ebrowse-title "Member Variables")
677 (put 'ebrowse-ts-member-functions 'ebrowse-title "Member Functions")
678 (put 'ebrowse-ts-static-variables 'ebrowse-title "Static Variables")
679 (put 'ebrowse-ts-static-functions 'ebrowse-title "Static Functions")
680 (put 'ebrowse-ts-friends 'ebrowse-title "Friends")
681 (put 'ebrowse-ts-types 'ebrowse-title "Types")
683 (put 'ebrowse-ts-member-variables 'ebrowse-global-title "Global Variables")
684 (put 'ebrowse-ts-member-functions 'ebrowse-global-title "Global Functions")
685 (put 'ebrowse-ts-static-variables 'ebrowse-global-title "Static Variables")
686 (put 'ebrowse-ts-static-functions 'ebrowse-global-title "Static Functions")
687 (put 'ebrowse-ts-friends 'ebrowse-global-title "Defines")
688 (put 'ebrowse-ts-types 'ebrowse-global-title "Types")
692 ;;; Operations on `ebrowse-ts' structures
694 (defun ebrowse-files-table (&optional marked-only)
695 "Return an obarray containing all files mentioned in the current tree.
696 The tree is expected in the buffer-local variable `ebrowse--tree-obarray'.
697 MARKED-ONLY non-nil means include marked classes only."
698 (let ((files (make-hash-table :test 'equal))
700 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
701 (when (or (not marked-only) (ebrowse-ts-mark tree))
702 (let ((class (ebrowse-ts-class tree)))
703 (when (zerop (% (incf i) 20))
704 (ebrowse-show-progress "Preparing file list" (zerop i)))
705 ;; Add files mentioned in class description
706 (let ((source-file (ebrowse-cs-source-file class))
707 (file (ebrowse-cs-file class)))
709 (puthash source-file source-file files))
711 (puthash file file files))
712 ;; For all member lists in this class
713 (loop for accessor in ebrowse-member-list-accessors do
714 (loop for m in (funcall accessor tree)
715 for file = (ebrowse-ms-file m)
716 for def-file = (ebrowse-ms-definition-file m) do
718 (puthash file file files))
720 (puthash def-file def-file files))))))))
724 (defun ebrowse-files-list (&optional marked-only)
725 "Return a list containing all files mentioned in a tree.
726 MARKED-ONLY non-nil means include marked classes only."
728 (maphash #'(lambda (file dummy) (setq list (cons file list)))
729 (ebrowse-files-table marked-only))
733 (defun* ebrowse-marked-classes-p ()
734 "Value is non-nil if any class in the current class tree is marked."
735 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
736 (when (ebrowse-ts-mark tree)
737 (return-from ebrowse-marked-classes-p tree))))
740 (defsubst ebrowse-globals-tree-p (tree)
741 "Return t if TREE is the one for global entities."
742 (string= (ebrowse-bs-name (ebrowse-ts-class tree))
743 ebrowse-globals-name))
746 (defsubst ebrowse-qualified-class-name (class)
747 "Return the name of CLASS with scope prepended, if any."
748 (if (ebrowse-cs-scope class)
749 (concat (ebrowse-cs-scope class) "::" (ebrowse-cs-name class))
750 (ebrowse-cs-name class)))
753 (defun ebrowse-tree-obarray-as-alist (&optional qualified-names-p)
754 "Return an alist describing all classes in a tree.
755 Each elements in the list has the form (CLASS-NAME . TREE).
756 CLASS-NAME is the name of the class. TREE is the
757 class tree whose root is QUALIFIED-CLASS-NAME.
758 QUALIFIED-NAMES-P non-nil means return qualified names as CLASS-NAME.
759 The class tree is found in the buffer-local variable `ebrowse--tree-obarray'."
761 (if qualified-names-p
762 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
764 (acons (ebrowse-qualified-class-name (ebrowse-ts-class tree))
766 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
768 (acons (ebrowse-cs-name (ebrowse-ts-class tree))
773 (defun ebrowse-sort-tree-list (list)
774 "Sort a LIST of `ebrowse-ts' structures by qualified class names."
777 (string< (ebrowse-qualified-class-name (ebrowse-ts-class a))
778 (ebrowse-qualified-class-name (ebrowse-ts-class b))))))
781 (defun ebrowse-class-in-tree (class tree)
782 "Search for a class with name CLASS in TREE.
783 Return the class found, if any. This function is used during the load
784 phase where classes appended to a file replace older class
786 (let ((tclass (ebrowse-ts-class class))
788 (while (and tree (not found))
789 (let ((root (car tree)))
790 (when (string= (ebrowse-qualified-class-name (ebrowse-ts-class root))
791 (ebrowse-qualified-class-name tclass))
793 (setq tree (cdr tree))))
797 (defun ebrowse-base-classes (tree)
798 "Return list of base-classes of TREE by searching subclass lists.
799 This function must be used instead of the struct slot
800 `base-classes' to access the base-class list directly because it
801 computes this information lazily."
802 (or (ebrowse-ts-base-classes tree)
803 (setf (ebrowse-ts-base-classes tree)
804 (loop with to-search = (list tree)
806 as search = (pop to-search)
807 while search finally return result
808 do (ebrowse-for-all-trees (ti ebrowse--tree-obarray)
809 (when (memq search (ebrowse-ts-subclasses ti))
810 (unless (memq ti result)
811 (setq result (nconc result (list ti))))
812 (push ti to-search)))))))
815 (defun ebrowse-direct-base-classes (tree)
816 "Return the list of direct super classes of TREE."
818 (dolist (s (ebrowse-base-classes tree))
819 (when (memq tree (ebrowse-ts-subclasses s))
820 (setq result (cons s result))))
825 ;;; Operations on MEMBER structures/lists
827 (defun ebrowse-name/accessor-alist (tree accessor)
828 "Return an alist containing all members of TREE in group ACCESSOR.
829 ACCESSOR is the accessor function for the member list.
830 Elements of the result have the form (NAME . ACCESSOR), where NAME
832 (loop for member in (funcall accessor tree)
833 collect (cons (ebrowse-ms-name member) accessor)))
836 (defun ebrowse-name/accessor-alist-for-visible-members ()
837 "Return an alist describing all members visible in the current buffer.
838 Each element of the list has the form (MEMBER-NAME . ACCESSOR),
839 where MEMBER-NAME is the member's name, and ACCESSOR is the struct
840 accessor with which the member's list can be accessed in an `ebrowse-ts'
841 structure. The list includes inherited members if these are visible."
842 (let* ((list (ebrowse-name/accessor-alist ebrowse--displayed-class
844 (if ebrowse--show-inherited-flag
846 (loop for tree in (ebrowse-base-classes
847 ebrowse--displayed-class)
848 nconc (ebrowse-name/accessor-alist
849 tree ebrowse--accessor)))
853 (defun ebrowse-name/accessor-alist-for-class-members ()
854 "Like `ebrowse-name/accessor-alist-for-visible-members'.
855 This function includes members of base classes if base class members
856 are visible in the buffer."
858 (dolist (func ebrowse-member-list-accessors list)
859 (setq list (nconc list (ebrowse-name/accessor-alist
860 ebrowse--displayed-class func)))
861 (when ebrowse--show-inherited-flag
862 (dolist (class (ebrowse-base-classes ebrowse--displayed-class))
864 (nconc list (ebrowse-name/accessor-alist class func))))))))
867 ;;; Progress indication
869 (defvar ebrowse-n-boxes 0)
870 (defconst ebrowse-max-boxes 60)
872 (defun ebrowse-show-progress (title &optional start)
873 "Display a progress indicator.
874 TITLE is the title of the progress message. START non-nil means
875 this is the first progress message displayed."
876 (let (message-log-max)
877 (when start (setq ebrowse-n-boxes 0))
878 (setq ebrowse-n-boxes (mod (1+ ebrowse-n-boxes) ebrowse-max-boxes))
879 (message (concat title ": "
880 (propertize (make-string ebrowse-n-boxes
881 (if (display-color-p) ?\ ?+))
882 'face 'ebrowse-progress-face)))))
885 ;;; Reading a tree from disk
887 (defun ebrowse-read ()
888 "Read `ebrowse-hs' and `ebrowse-ts' structures in the current buffer.
889 Return a list (HEADER TREE) where HEADER is the file header read
890 and TREE is a list of `ebrowse-ts' structures forming the class tree."
891 (let ((header (condition-case nil
892 (read (current-buffer))
893 (error (error "No Ebrowse file header found"))))
895 ;; Check file format.
896 (unless (ebrowse-hs-p header)
897 (error "No Ebrowse file header found"))
898 (unless (string= (ebrowse-hs-version header) ebrowse-version-string)
899 (error "File has wrong version `%s' (`%s' expected)"
900 (ebrowse-hs-version header) ebrowse-version-string))
901 ;; Read Lisp objects. Temporarily increase `gc-cons-threshold' to
902 ;; prevent a GC that would not free any memory.
903 (let ((gc-cons-threshold 2000000))
904 (while (not (progn (skip-chars-forward " \t\n\r") (eobp)))
905 (let* ((root (read (current-buffer)))
906 (old-root (ebrowse-class-in-tree root tree)))
907 (ebrowse-show-progress "Reading data" (null tree))
909 (setf (car old-root) root)
915 (defun ebrowse-revert-tree-buffer-from-file (ignore-auto-save noconfirm)
916 "Function installed as `revert-buffer-function' in tree buffers.
917 See that variable's documentation for the meaning of IGNORE-AUTO-SAVE and
919 (when (or noconfirm (yes-or-no-p "Revert tree from disk? "))
920 (loop for member-buffer in (ebrowse-same-tree-member-buffer-list)
921 do (kill-buffer member-buffer))
923 (insert-file (or buffer-file-name ebrowse--tags-file-name))
928 (defun ebrowse-create-tree-buffer (tree tags-file header obarray pop)
929 "Create a new tree buffer for tree TREE.
930 The tree was loaded from file TAGS-FILE.
931 HEADER is the header structure of the file.
932 OBARRAY is an obarray with a symbol for each class in the tree.
933 POP non-nil means popup the buffer up at the end.
934 Return the buffer created."
935 (let ((name ebrowse-tree-buffer-name))
936 (set-buffer (get-buffer-create name))
938 (setq ebrowse--tree tree
939 ebrowse--tags-file-name tags-file
940 ebrowse--tree-obarray obarray
941 ebrowse--header header
942 ebrowse--frozen-flag nil)
943 (ebrowse-redraw-tree)
944 (set-buffer-modified-p nil)
946 (switch (switch-to-buffer name))
947 (pop (pop-to-buffer name)))
952 ;;; Operations for member obarrays
954 (defun ebrowse-fill-member-table ()
955 "Return an obarray holding all members of all classes in the current tree.
957 For each member, a symbol is added to the obarray. Members are
958 extracted from the buffer-local tree `ebrowse--tree-obarray'.
960 Each symbol has its property `ebrowse-info' set to a list (TREE MEMBER-LIST
961 MEMBER) where TREE is the tree in which the member is defined,
962 MEMBER-LIST is a symbol describing the member list in which the member
963 is found, and MEMBER is a MEMBER structure describing the member.
965 The slot `member-table' of the buffer-local header structure of
966 type `ebrowse-hs' is set to the resulting obarray."
967 (let ((members (make-hash-table :test 'equal))
969 (setf (ebrowse-hs-member-table ebrowse--header) nil)
971 ;; For all classes...
972 (ebrowse-for-all-trees (c ebrowse--tree-obarray)
973 (when (zerop (% (incf i) 10))
974 (ebrowse-show-progress "Preparing member lookup" (zerop i)))
975 (loop for f in ebrowse-member-list-accessors do
976 (loop for m in (funcall f c) do
977 (let* ((member-name (ebrowse-ms-name m))
978 (value (gethash member-name members)))
979 (push (list c f m) value)
980 (puthash member-name value members)))))
981 (setf (ebrowse-hs-member-table ebrowse--header) members)))
984 (defun ebrowse-member-table (header)
985 "Return the member obarray. Build it it hasn't been set up yet.
986 HEADER is the tree header structure of the class tree."
987 (when (null (ebrowse-hs-member-table header))
988 (loop for buffer in (ebrowse-browser-buffer-list)
989 until (eq header (ebrowse-value-in-buffer 'ebrowse--header buffer))
993 (ebrowse-fill-member-table))))
994 (ebrowse-hs-member-table header))
998 ;;; Operations on TREE obarrays
1000 (defun ebrowse-build-tree-obarray (tree)
1001 "Make sure every class in TREE is represented by a unique object.
1002 Build obarray of all classes in TREE."
1003 (let ((classes (make-vector 127 0)))
1004 ;; Add root classes...
1005 (loop for root in tree
1007 (intern (ebrowse-qualified-class-name (ebrowse-ts-class root)) classes)
1008 do (unless (get sym 'ebrowse-root)
1009 (setf (get sym 'ebrowse-root) root)))
1010 ;; Process subclasses
1011 (ebrowse-insert-supers tree classes)
1015 (defun ebrowse-insert-supers (tree classes)
1016 "Build base class lists in class tree TREE.
1017 CLASSES is an obarray used to collect classes.
1019 Helper function for `ebrowse-build-tree-obarray'. Base classes should
1020 be ordered so that immediate base classes come first, then the base
1021 class of the immediate base class and so on. This means that we must
1022 construct the base-class list top down with adding each level at the
1023 beginning of the base-class list.
1025 We have to be cautious here not to end up in an infinite recursion
1026 if for some reason a circle is in the inheritance graph."
1027 (loop for class in tree
1028 as subclasses = (ebrowse-ts-subclasses class) do
1029 ;; Make sure every class is represented by a unique object
1030 (loop for subclass on subclasses
1032 (ebrowse-qualified-class-name (ebrowse-ts-class (car subclass)))
1036 ;; Replace the subclass tree with the one found in
1037 ;; CLASSES if there is already an entry for that class
1038 ;; in it. Otherwise make a new entry.
1040 ;; CAVEAT: If by some means (e.g., use of the
1041 ;; preprocessor in class declarations, a name is marked
1042 ;; as a subclass of itself on some path, we would end up
1043 ;; in an endless loop. We have to omit subclasses from
1044 ;; the recursion that already have been processed.
1045 (if (get sym 'ebrowse-root)
1046 (setf (car subclass) (get sym 'ebrowse-root))
1047 (setf (get sym 'ebrowse-root) (car subclass))))
1048 ;; Process subclasses
1049 (ebrowse-insert-supers subclasses classes)))
1054 (unless ebrowse-tree-mode-map
1055 (let ((map (make-keymap)))
1056 (setf ebrowse-tree-mode-map map)
1057 (suppress-keymap map)
1059 (when (display-mouse-p)
1060 (define-key map [down-mouse-3] 'ebrowse-mouse-3-in-tree-buffer)
1061 (define-key map [mouse-2] 'ebrowse-mouse-2-in-tree-buffer)
1062 (define-key map [down-mouse-1] 'ebrowse-mouse-1-in-tree-buffer))
1064 (let ((map1 (make-sparse-keymap)))
1065 (suppress-keymap map1 t)
1066 (define-key map "L" map1)
1067 (define-key map1 "d" 'ebrowse-tree-command:show-friends)
1068 (define-key map1 "f" 'ebrowse-tree-command:show-member-functions)
1069 (define-key map1 "F" 'ebrowse-tree-command:show-static-member-functions)
1070 (define-key map1 "t" 'ebrowse-tree-command:show-types)
1071 (define-key map1 "v" 'ebrowse-tree-command:show-member-variables)
1072 (define-key map1 "V" 'ebrowse-tree-command:show-static-member-variables))
1074 (let ((map1 (make-sparse-keymap)))
1075 (suppress-keymap map1 t)
1076 (define-key map "M" map1)
1077 (define-key map1 "a" 'ebrowse-mark-all-classes)
1078 (define-key map1 "t" 'ebrowse-toggle-mark-at-point))
1080 (let ((map1 (make-sparse-keymap)))
1081 (suppress-keymap map1 t)
1082 (define-key map "T" map1)
1083 (define-key map1 "f" 'ebrowse-toggle-file-name-display)
1084 (define-key map1 "s" 'ebrowse-show-file-name-at-point)
1085 (define-key map1 "w" 'ebrowse-set-tree-indentation)
1086 (define-key map "x" 'ebrowse-statistics))
1088 (define-key map "n" 'ebrowse-repeat-member-search)
1089 (define-key map "q" 'bury-buffer)
1090 (define-key map "*" 'ebrowse-expand-all)
1091 (define-key map "+" 'ebrowse-expand-branch)
1092 (define-key map "-" 'ebrowse-collapse-branch)
1093 (define-key map "/" 'ebrowse-read-class-name-and-go)
1094 (define-key map " " 'ebrowse-view-class-declaration)
1095 (define-key map "?" 'describe-mode)
1096 (define-key map "\C-i" 'ebrowse-pop/switch-to-member-buffer-for-same-tree)
1097 (define-key map "\C-k" 'ebrowse-remove-class-at-point)
1098 (define-key map "\C-l" 'ebrowse-redraw-tree)
1099 (define-key map "\C-m" 'ebrowse-find-class-declaration)))
1103 ;;; Tree-mode - mode for tree buffers
1106 (defun ebrowse-tree-mode ()
1107 "Major mode for Ebrowse class tree buffers.
1108 Each line corresponds to a class in a class tree.
1109 Letters do not insert themselves, they are commands.
1110 File operations in the tree buffer work on class tree data structures.
1111 E.g.\\[save-buffer] writes the tree to the file it was loaded from.
1113 Tree mode key bindings:
1114 \\{ebrowse-tree-mode-map}"
1116 (let* ((ident (propertized-buffer-identification "C++ Tree"))
1117 header tree buffer-read-only)
1119 (kill-all-local-variables)
1120 (use-local-map ebrowse-tree-mode-map)
1122 (unless (zerop (buffer-size))
1123 (goto-char (point-min))
1124 (multiple-value-setq (header tree) (ebrowse-read))
1125 (message "Sorting. Please be patient...")
1126 (setq tree (ebrowse-sort-tree-list tree))
1130 (mapcar 'make-local-variable
1131 '(ebrowse--tags-file-name
1132 ebrowse--indentation
1135 ebrowse--show-file-names-flag
1136 ebrowse--frozen-flag
1137 ebrowse--tree-obarray
1138 revert-buffer-function))
1140 (setf ebrowse--show-file-names-flag nil
1141 ebrowse--tree-obarray (make-vector 127 0)
1142 ebrowse--frozen-flag nil
1143 major-mode 'ebrowse-tree-mode
1144 mode-name "Ebrowse-Tree"
1145 mode-line-buffer-identification ident
1148 selective-display-ellipses t
1149 revert-buffer-function 'ebrowse-revert-tree-buffer-from-file
1150 ebrowse--header header
1152 ebrowse--tags-file-name (buffer-file-name)
1153 ebrowse--tree-obarray (and tree (ebrowse-build-tree-obarray tree))
1154 ebrowse--frozen-flag nil)
1156 (add-hook 'local-write-file-hooks 'ebrowse-write-file-hook-fn)
1157 (modify-syntax-entry ?_ (char-to-string (char-syntax ?a)))
1159 (ebrowse-redraw-tree)
1160 (set-buffer-modified-p nil))
1161 (run-hooks 'ebrowse-tree-mode-hook)))
1165 (defun ebrowse-update-tree-buffer-mode-line ()
1166 "Update the tree buffer mode line."
1167 (ebrowse-rename-buffer (if ebrowse--frozen-flag
1168 (ebrowse-frozen-tree-buffer-name
1169 ebrowse--tags-file-name)
1170 ebrowse-tree-buffer-name))
1171 (force-mode-line-update))
1175 ;;; Removing classes from trees
1177 (defun ebrowse-remove-class-and-kill-member-buffers (tree class)
1178 "Remove from TREE class CLASS.
1179 Kill all member buffers still containing a reference to the class."
1180 (let ((sym (intern-soft (ebrowse-cs-name (ebrowse-ts-class class))
1181 ebrowse--tree-obarray)))
1182 (setf tree (delq class tree)
1183 (get sym 'ebrowse-root) nil)
1185 (setf (ebrowse-ts-subclasses root)
1186 (delq class (ebrowse-ts-subclasses root))
1187 (ebrowse-ts-base-classes root) nil)
1188 (ebrowse-remove-class-and-kill-member-buffers
1189 (ebrowse-ts-subclasses root) class))
1190 (ebrowse-kill-member-buffers-displaying class)
1194 (defun ebrowse-remove-class-at-point (forced)
1195 "Remove the class point is on from the class tree.
1196 Do not ask for confirmation if FORCED is non-nil."
1198 (let* ((class (ebrowse-tree-at-point))
1199 (class-name (ebrowse-cs-name (ebrowse-ts-class class)))
1200 (subclasses (ebrowse-ts-subclasses class)))
1202 (y-or-n-p (concat "Delete class " class-name "? ")))
1203 (setf ebrowse--tree (ebrowse-remove-class-and-kill-member-buffers
1204 ebrowse--tree class))
1205 (set-buffer-modified-p t)
1206 (message "%s %sdeleted." class-name
1207 (if subclasses "and derived classes " ""))
1208 (ebrowse-redraw-tree))
1209 (t (message "Aborted")))))
1213 ;;; Marking classes in the tree buffer
1215 (defun ebrowse-toggle-mark-at-point (&optional n-times)
1216 "Toggle mark for class cursor is on.
1217 If given a numeric N-TIMES argument, mark that many classes."
1219 (let (to-change pnt)
1220 ;; Get the classes whose mark must be toggled. Note that
1221 ;; ebrowse-tree-at-point might issue an error.
1222 (condition-case error
1223 (loop repeat (or n-times 1)
1224 as tree = (ebrowse-tree-at-point)
1226 (setf (ebrowse-ts-mark tree) (not (ebrowse-ts-mark tree)))
1228 (push tree to-change)))
1231 ;; For all these classes, reverse the mark char in the display
1232 ;; by a regexp replace over the whole buffer. The reason for this
1233 ;; is that classes might have multiple base classes. If this is
1234 ;; the case, they are displayed more than once in the tree.
1236 (loop for tree in to-change
1237 as regexp = (concat "^.*\\b"
1239 (ebrowse-cs-name (ebrowse-ts-class tree)))
1242 (goto-char (point-min))
1243 (loop while (re-search-forward regexp nil t)
1245 (goto-char (match-beginning 0))
1247 (insert-char (if (ebrowse-ts-mark tree) ?> ? ) 1)
1248 (ebrowse-set-mark-props (1- (point)) (point) tree)
1249 (goto-char (match-end 0)))))))))
1252 (defun ebrowse-mark-all-classes (prefix)
1253 "Unmark, with PREFIX mark, all classes in the tree."
1255 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
1256 (setf (ebrowse-ts-mark tree) prefix))
1257 (ebrowse-redraw-marks (point-min) (point-max)))
1260 (defun ebrowse-redraw-marks (start end)
1261 "Display class marker signs in the tree between START and END."
1266 (goto-char (point-min))
1267 (dolist (root ebrowse--tree)
1268 (ebrowse-draw-marks-fn root start end))))
1269 (ebrowse-update-tree-buffer-mode-line)))
1272 (defun ebrowse-draw-marks-fn (tree start end)
1273 "Display class marker signs in TREE between START and END."
1274 (when (>= (point) start)
1276 (insert (if (ebrowse-ts-mark tree) ?> ? ))
1277 (ebrowse-set-mark-props (1- (point)) (point) tree))
1279 (when (> (point) end)
1281 (dolist (sub (ebrowse-ts-subclasses tree))
1282 (ebrowse-draw-marks-fn sub start end)))
1286 ;;; File name display in tree buffers
1288 (defun ebrowse-show-file-name-at-point (prefix)
1289 "Show filename in the line point is in.
1290 With PREFIX, insert that many filenames."
1292 (unless ebrowse--show-file-names-flag
1295 (let ((tree (ebrowse-tree-at-point))
1298 (unless tree return)
1300 (skip-chars-forward " \t*a-zA-Z0-9_")
1302 file-name-existing (looking-at "("))
1303 (delete-region start (save-excursion (end-of-line) (point)))
1304 (unless file-name-existing
1305 (indent-to ebrowse-source-file-column)
1306 (insert "(" (or (ebrowse-cs-file
1307 (ebrowse-ts-class tree))
1310 (ebrowse-set-face start (point) 'ebrowse-file-name-face)
1312 (forward-line 1))))))
1315 (defun ebrowse-toggle-file-name-display ()
1316 "Toggle display of filenames in tree buffer."
1318 (setf ebrowse--show-file-names-flag (not ebrowse--show-file-names-flag))
1319 (let ((old-line (count-lines (point-min) (point))))
1320 (ebrowse-redraw-tree)
1321 (goto-line old-line)))
1325 ;;; General member and tree buffer functions
1327 (defun ebrowse-member-buffer-p (buffer)
1328 "Value is non-nil if BUFFER is a member buffer."
1329 (eq (cdr (assoc 'major-mode (buffer-local-variables buffer)))
1330 'ebrowse-member-mode))
1333 (defun ebrowse-tree-buffer-p (buffer)
1334 "Value is non-nil if BUFFER is a class tree buffer."
1335 (eq (cdr (assoc 'major-mode (buffer-local-variables buffer)))
1336 'ebrowse-tree-mode))
1339 (defun ebrowse-buffer-p (buffer)
1340 "Value is non-nil if BUFFER is a tree or member buffer."
1341 (memq (cdr (assoc 'major-mode (buffer-local-variables buffer)))
1342 '(ebrowse-tree-mode ebrowse-member-mode)))
1345 (defun ebrowse-browser-buffer-list ()
1346 "Return a list of all tree or member buffers."
1347 (ebrowse-delete-if-not 'ebrowse-buffer-p (buffer-list)))
1350 (defun ebrowse-member-buffer-list ()
1351 "Return a list of all member buffers."
1352 (ebrowse-delete-if-not 'ebrowse-member-buffer-p (buffer-list)))
1355 (defun ebrowse-tree-buffer-list ()
1356 "Return a list of all tree buffers."
1357 (ebrowse-delete-if-not 'ebrowse-tree-buffer-p (buffer-list)))
1360 (defun ebrowse-known-class-trees-buffer-list ()
1361 "Return a list of buffers containing class trees.
1362 The list will contain, for each class tree loaded,
1363 one buffer. Prefer tree buffers over member buffers."
1364 (let ((buffers (nconc (ebrowse-tree-buffer-list)
1365 (ebrowse-member-buffer-list)))
1366 (set (make-hash-table))
1368 (dolist (buffer buffers)
1369 (let ((tree (ebrowse-value-in-buffer 'ebrowse--tree buffer)))
1370 (unless (gethash tree set)
1371 (push buffer result))
1372 (puthash tree t set)))
1376 (defun ebrowse-same-tree-member-buffer-list ()
1377 "Return a list of members buffers with same tree as current buffer."
1378 (ebrowse-delete-if-not
1380 (eq (ebrowse-value-in-buffer 'ebrowse--tree buffer)
1382 (ebrowse-member-buffer-list)))
1386 (defun ebrowse-pop/switch-to-member-buffer-for-same-tree (arg)
1387 "Pop to the buffer displaying members.
1388 Switch to buffer if prefix ARG.
1389 If no member buffer exists, make one."
1391 (let ((buf (or (first (ebrowse-same-tree-member-buffer-list))
1392 (get-buffer ebrowse-member-buffer-name)
1393 (ebrowse-tree-command:show-member-functions))))
1396 (switch-to-buffer buf)
1397 (pop-to-buffer buf)))
1401 (defun ebrowse-switch-to-next-member-buffer ()
1402 "Switch to next member buffer."
1404 (let* ((list (ebrowse-member-buffer-list))
1405 (next-list (cdr (memq (current-buffer) list)))
1406 (next-buffer (if next-list (car next-list) (car list))))
1407 (if (eq next-buffer (current-buffer))
1408 (error "No next buffer")
1410 (switch-to-buffer next-buffer))))
1413 (defun ebrowse-kill-member-buffers-displaying (tree)
1414 "Kill all member buffers displaying TREE."
1415 (loop for buffer in (ebrowse-member-buffer-list)
1416 as class = (ebrowse-value-in-buffer 'ebrowse--displayed-class buffer)
1417 when (eq class tree) do (kill-buffer buffer)))
1420 (defun ebrowse-frozen-tree-buffer-name (tags-file-name)
1421 "Return the buffer name of a tree which is associated TAGS-FILE-NAME."
1422 (concat ebrowse-tree-buffer-name " (" tags-file-name ")"))
1425 (defun ebrowse-pop-to-browser-buffer (arg)
1426 "Pop to a browser buffer from any other buffer.
1427 Pop to member buffer if no prefix ARG, to tree buffer otherwise."
1429 (let ((buffer (get-buffer (if arg
1430 ebrowse-tree-buffer-name
1431 ebrowse-member-buffer-name))))
1435 ebrowse-member-buffer-name
1436 ebrowse-tree-buffer-name))))
1438 (error "No browser buffer found"))
1439 (pop-to-buffer buffer)))
1443 ;;; Misc tree buffer commands
1445 (defun ebrowse-set-tree-indentation ()
1446 "Set the indentation width of the tree display."
1448 (let ((width (string-to-int (read-from-minibuffer
1449 (concat "Indentation ("
1450 (int-to-string ebrowse--indentation)
1453 (setf ebrowse--indentation width)
1454 (ebrowse-redraw-tree))))
1457 (defun ebrowse-read-class-name-and-go (&optional class)
1458 "Position cursor on CLASS.
1459 Read a class name from the minibuffer if CLASS is nil."
1461 (ebrowse-ignoring-completion-case
1462 ;; If no class specified, read the class name from mini-buffer
1465 (completing-read "Goto class: "
1466 (ebrowse-tree-obarray-as-alist) nil t)))
1467 (ebrowse-save-selective
1468 (goto-char (point-min))
1470 (setf selective-display nil)
1471 (setq ebrowse--last-regexp (concat "\\b" class "\\b"))
1472 (if (re-search-forward ebrowse--last-regexp nil t)
1474 (goto-char (match-beginning 0))
1475 (ebrowse-unhide-base-classes))
1476 (error "Not found")))))
1480 ;;; Showing various kinds of member buffers
1482 (defun ebrowse-tree-command:show-member-variables (arg)
1483 "Display member variables; with prefix ARG in frozen member buffer."
1485 (ebrowse-display-member-buffer 'ebrowse-ts-member-variables arg))
1488 (defun ebrowse-tree-command:show-member-functions (&optional arg)
1489 "Display member functions; with prefix ARG in frozen member buffer."
1491 (ebrowse-display-member-buffer 'ebrowse-ts-member-functions arg))
1494 (defun ebrowse-tree-command:show-static-member-variables (arg)
1495 "Display static member variables; with prefix ARG in frozen member buffer."
1497 (ebrowse-display-member-buffer 'ebrowse-ts-static-variables arg))
1500 (defun ebrowse-tree-command:show-static-member-functions (arg)
1501 "Display static member functions; with prefix ARG in frozen member buffer."
1503 (ebrowse-display-member-buffer 'ebrowse-ts-static-functions arg))
1506 (defun ebrowse-tree-command:show-friends (arg)
1507 "Display friend functions; with prefix ARG in frozen member buffer."
1509 (ebrowse-display-member-buffer 'ebrowse-ts-friends arg))
1512 (defun ebrowse-tree-command:show-types (arg)
1513 "Display types defined in a class; with prefix ARG in frozen member buffer."
1515 (ebrowse-display-member-buffer 'ebrowse-ts-types arg))
1519 ;;; Viewing or finding a class declaration
1521 (defun ebrowse-tree-at-point ()
1522 "Return the class structure for the class point is on."
1523 (or (get-text-property (point) 'ebrowse-tree)
1524 (error "Not on a class")))
1527 (defun* ebrowse-view/find-class-declaration (&key view where)
1528 "View or find the declarator of the class point is on.
1529 VIEW non-nil means view it. WHERE is additional position info."
1530 (let* ((class (ebrowse-ts-class (ebrowse-tree-at-point)))
1531 (file (ebrowse-cs-file class))
1532 (browse-struct (make-ebrowse-bs
1533 :name (ebrowse-cs-name class)
1534 :pattern (ebrowse-cs-pattern class)
1535 :flags (ebrowse-cs-flags class)
1536 :file (ebrowse-cs-file class)
1537 :point (ebrowse-cs-point class))))
1538 (ebrowse-view/find-file-and-search-pattern
1540 (list ebrowse--header class nil)
1542 ebrowse--tags-file-name
1547 (defun ebrowse-find-class-declaration (prefix-arg)
1548 "Find a class declaration and position cursor on it.
1549 PREFIX-ARG 4 means find it in another window.
1550 PREFIX-ARG 5 means find it in another frame."
1552 (ebrowse-view/find-class-declaration
1554 :where (cond ((= prefix-arg 4) 'other-window)
1555 ((= prefix-arg 5) 'other-frame)
1559 (defun ebrowse-view-class-declaration (prefix-arg)
1560 "View class declaration and position cursor on it.
1561 PREFIX-ARG 4 means view it in another window.
1562 PREFIX-ARG 5 means view it in another frame."
1564 (ebrowse-view/find-class-declaration
1566 :where (cond ((= prefix-arg 4) 'other-window)
1567 ((= prefix-arg 5) 'other-frame)
1574 (defun ebrowse-find-source-file (file tags-file-name)
1575 "Find source file FILE.
1576 Source files are searched for (a) relative to TAGS-FILE-NAME
1577 which is the path of the BROWSE file from which the class tree was loaded,
1578 and (b) in the directories named in `ebrowse-search-path'."
1580 (try-file (expand-file-name file
1581 (file-name-directory tags-file-name))))
1582 (if (file-readable-p try-file)
1583 (setq file-name try-file)
1584 (let ((search-in ebrowse-search-path))
1585 (while (and search-in
1587 (let ((try-file (expand-file-name file (car search-in))))
1588 (if (file-readable-p try-file)
1589 (setq file-name try-file))
1590 (setq search-in (cdr search-in))))))
1592 (error "File `%s' not found" file))
1596 (defun ebrowse-view-file-other-window (file)
1597 "View a file FILE in another window.
1598 This is a replacement for `view-file-other-window' which does not
1599 seem to work. It should be removed when `view.el' is fixed."
1601 (let ((old-arrangement (current-window-configuration))
1602 (had-a-buf (get-file-buffer file))
1603 (buf-to-view (find-file-noselect file)))
1604 (switch-to-buffer-other-window buf-to-view)
1605 (view-mode-enter old-arrangement
1606 (and (not had-a-buf)
1607 (not (buffer-modified-p buf-to-view))
1611 (defun ebrowse-view-exit-fn (buffer)
1612 "Function called when exiting View mode in BUFFER.
1613 Restore frame configuration active before viewing the file,
1614 and possibly kill the viewed buffer."
1615 (let (exit-action original-frame-configuration)
1618 (setq original-frame-configuration ebrowse--frame-configuration
1619 exit-action ebrowse--view-exit-action))
1620 ;; Delete the frame in which we viewed.
1621 (mapcar 'delete-frame
1622 (loop for frame in (frame-list)
1623 when (not (assq frame original-frame-configuration))
1626 (funcall exit-action buffer))))
1629 (defun ebrowse-view-file-other-frame (file)
1630 "View a file FILE in another frame.
1631 The new frame is deleted when it is no longer used."
1633 (let ((old-frame-configuration (current-frame-configuration))
1634 (old-arrangement (current-window-configuration))
1635 (had-a-buf (get-file-buffer file))
1636 (buf-to-view (find-file-noselect file)))
1637 (switch-to-buffer-other-frame buf-to-view)
1638 (make-local-variable 'ebrowse--frame-configuration)
1639 (setq ebrowse--frame-configuration old-frame-configuration)
1640 (make-local-variable 'ebrowse--view-exit-action)
1641 (setq ebrowse--view-exit-action
1642 (and (not had-a-buf)
1643 (not (buffer-modified-p buf-to-view))
1645 (view-mode-enter old-arrangement 'ebrowse-view-exit-fn)))
1648 (defun ebrowse-view/find-file-and-search-pattern
1649 (struc info file tags-file-name &optional view where)
1650 "Find or view a member or class.
1651 STRUC is an `ebrowse-bs' structure (or a structure including that)
1652 describing what to search.
1653 INFO is a list (HEADER MEMBER-OR-CLASS ACCESSOR). HEADER is the
1654 header structure of a class tree. MEMBER-OR-CLASS is either an
1655 `ebrowse-ms' or `ebrowse-cs' structure depending on what is searched.
1656 ACCESSOR is an accessor function for the member list of a member
1657 if MEMBER-OR-CLASS is an `ebrowse-ms'.
1658 FILE is the file to search the member in.
1659 FILE is not taken out of STRUC here because the filename in STRUC
1660 may be nil in which case the filename of the class description is used.
1661 TAGS-FILE-NAME is the name of the BROWSE file from which the
1663 If VIEW is non-nil, view file else find the file.
1664 WHERE is either `other-window', `other-frame' or `this-window' and
1665 specifies where to find/view the result."
1667 (error "Sorry, no file information available for %s"
1668 (ebrowse-bs-name struc)))
1669 ;; Get the source file to view or find.
1670 (setf file (ebrowse-find-source-file file tags-file-name))
1671 ;; If current window is dedicated, use another frame.
1672 (when (window-dedicated-p (selected-window))
1673 (setf where 'other-window))
1675 (setf ebrowse-temp-position-to-view struc
1676 ebrowse-temp-info-to-view info)
1677 (unless (boundp 'view-mode-hook)
1678 (setq view-mode-hook nil))
1679 (push 'ebrowse-find-pattern view-mode-hook)
1681 (other-window (ebrowse-view-file-other-window file))
1682 (other-frame (ebrowse-view-file-other-frame file))
1683 (t (view-file file))))
1686 (other-window (find-file-other-window file))
1687 (other-frame (find-file-other-frame file))
1688 (t (find-file file)))
1689 (ebrowse-find-pattern struc info))))
1692 (defun ebrowse-symbol-regexp (name)
1693 "Generate a suitable regular expression for a member or class NAME.
1694 This is `regexp-quote' for most symbols, except for operator names
1695 which may contain whitespace. For these symbols, replace white
1696 space in the symbol name (generated by BROWSE) with a regular
1697 expression matching any number of whitespace characters."
1698 (loop with regexp = (regexp-quote name)
1700 finally return regexp
1701 while (string-match "[ \t]+" regexp start)
1702 do (setq regexp (concat (substring regexp 0 (match-beginning 0))
1704 (substring regexp (match-end 0)))
1705 start (+ (match-beginning 0) 5))))
1708 (defun ebrowse-class-declaration-regexp (name)
1709 "Construct a regexp for a declaration of class NAME."
1710 (concat "^[ \t]*\\(template[ \t\n]*<.*>\\)?"
1711 "[ \t\n]*\\(class\\|struct\\|union\\).*\\S_"
1712 (ebrowse-symbol-regexp name)
1716 (defun ebrowse-variable-declaration-regexp (name)
1717 "Construct a regexp for matching a variable NAME."
1718 (concat "\\S_" (ebrowse-symbol-regexp name) "\\S_"))
1721 (defun ebrowse-function-declaration/definition-regexp (name)
1722 "Construct a regexp for matching a function NAME."
1723 (concat "^[a-zA-Z0-9_:*&<>, \t]*\\S_"
1724 (ebrowse-symbol-regexp name)
1728 (defun ebrowse-pp-define-regexp (name)
1729 "Construct a regexp matching a define of NAME."
1730 (concat "^[ \t]*#[ \t]*define[ \t]+" (regexp-quote name)))
1733 (defun* ebrowse-find-pattern (&optional position info &aux viewing)
1736 This is a kluge: Ebrowse allows you to find or view a file containing
1737 a pattern. To be able to do a search in a viewed buffer,
1738 `view-mode-hook' is temporarily set to this function;
1739 `ebrowse-temp-position-to-view' holds what to search for.
1741 INFO is a list (TREE-HEADER TREE-OR-MEMBER MEMBER-LIST)."
1743 (pop view-mode-hook)
1745 position ebrowse-temp-position-to-view
1746 info ebrowse-temp-info-to-view))
1748 (let* ((pattern (ebrowse-bs-pattern position))
1749 (start (ebrowse-bs-point position))
1752 (destructuring-bind (header class-or-member member-list) info
1753 ;; If no pattern is specified, construct one from the member name.
1754 (when (stringp pattern)
1755 (setq pattern (concat "^.*" (regexp-quote pattern))))
1756 ;; Construct a regular expression if none given.
1758 (typecase class-or-member
1761 ((ebrowse-ts-member-variables
1762 ebrowse-ts-static-variables
1764 (setf pattern (ebrowse-variable-declaration-regexp
1765 (ebrowse-bs-name position))))
1767 (if (ebrowse-define-p class-or-member)
1768 (setf pattern (ebrowse-pp-define-regexp (ebrowse-bs-name position)))
1769 (setf pattern (ebrowse-function-declaration/definition-regexp
1770 (ebrowse-bs-name position)))))))
1772 (setf pattern (ebrowse-class-declaration-regexp
1773 (ebrowse-bs-name position))))))
1774 ;; Begin searching some OFFSET from the original point where the
1775 ;; regular expression was found by the parse, and step forward.
1776 ;; When there is no regular expression in the database and a
1777 ;; member definition/declaration was not seen by the parser,
1779 (when (and (boundp 'ebrowse-debug)
1780 (symbol-value 'ebrowse-debug))
1781 (y-or-n-p (format "start = %d" start))
1784 (loop do (goto-char (max (point-min) (- start offset)))
1785 when (re-search-forward pattern (+ start offset) t) return t
1787 do (incf offset offset)))
1790 (run-hooks 'ebrowse-view/find-hook))
1791 ((numberp (ebrowse-bs-pattern position))
1793 (if ebrowse-not-found-hook
1794 (run-hooks 'ebrowse-not-found-hook)
1795 (message "Not found")
1798 (if ebrowse-not-found-hook
1799 (run-hooks 'ebrowse-not-found-hook)
1801 (error "Not found"))
1802 (message "Not found")
1806 ;;; Drawing the tree
1808 (defun ebrowse-redraw-tree (&optional quietly)
1809 "Redisplay the complete tree.
1810 QUIETLY non-nil means don't display progress messages."
1812 (or quietly (message "Displaying..."))
1816 (ebrowse-draw-tree-fn)))
1817 (ebrowse-update-tree-buffer-mode-line)
1818 (or quietly (message nil)))
1821 (defun ebrowse-set-mark-props (start end tree)
1822 "Set text properties for class marker signs between START and END.
1823 TREE denotes the class shown."
1824 (add-text-properties
1826 `(mouse-face highlight ebrowse-what mark ebrowse-tree ,tree
1827 help-echo "double-mouse-1: mark/unmark"))
1828 (ebrowse-set-face start end 'ebrowse-tree-mark-face))
1831 (defun* ebrowse-draw-tree-fn (&aux stack1 stack2 start)
1832 "Display a single class and recursively it's subclasses.
1833 This function may look weird, but this is faster than recursion."
1834 (setq stack1 (make-list (length ebrowse--tree) 0)
1835 stack2 (copy-sequence ebrowse--tree))
1837 as level = (pop stack1)
1838 as tree = (pop stack2)
1839 as class = (ebrowse-ts-class tree) do
1840 (let ((start-of-line (point))
1841 start-of-class-name end-of-class-name)
1843 (insert (if (ebrowse-ts-mark tree) ">" " "))
1845 ;; Indent and insert class name
1846 (indent-to (+ (* level ebrowse--indentation)
1847 ebrowse-tree-left-margin))
1848 (setq start (point))
1849 (insert (ebrowse-qualified-class-name class))
1851 ;; If template class, add <>
1852 (when (ebrowse-template-p class)
1854 (ebrowse-set-face start (point) (if (zerop level)
1855 'ebrowse-root-class-face
1856 'ebrowse-default-face))
1857 (setf start-of-class-name start
1858 end-of-class-name (point))
1859 ;; If filenames are to be displayed...
1860 (when ebrowse--show-file-names-flag
1861 (indent-to ebrowse-source-file-column)
1862 (setq start (point))
1864 (or (ebrowse-cs-file class)
1867 (ebrowse-set-face start (point) 'ebrowse-file-name-face))
1868 (ebrowse-set-mark-props start-of-line (1+ start-of-line) tree)
1869 (add-text-properties
1870 start-of-class-name end-of-class-name
1871 `(mouse-face highlight ebrowse-what class-name
1873 help-echo "double-mouse-1: (un)expand tree; mouse-2: member functions, mouse-3: menu"))
1875 ;; Push subclasses, if any.
1876 (when (ebrowse-ts-subclasses tree)
1878 (nconc (copy-sequence (ebrowse-ts-subclasses tree)) stack2)
1880 (nconc (make-list (length (ebrowse-ts-subclasses tree))
1881 (1+ level)) stack1)))))
1885 ;;; Expanding/ collapsing tree branches
1887 (defun ebrowse-expand-branch (arg)
1888 "Expand a sub-tree that has been previously collapsed.
1889 With prefix ARG, expand all sub-trees."
1892 (ebrowse-expand-all arg)
1893 (ebrowse-collapse-fn nil)))
1896 (defun ebrowse-collapse-branch (arg)
1897 "Fold (do no longer display) the subclasses of the current class.
1898 \(The class cursor is on.) With prefix ARG, fold all trees in the buffer."
1901 (ebrowse-expand-all (not arg))
1902 (ebrowse-collapse-fn t)))
1905 (defun ebrowse-expand-all (collapse)
1906 "Expand or fold all trees in the buffer.
1907 COLLAPSE non-nil means fold them."
1909 (let ((line-end (if collapse "^\n" "^\r"))
1910 (insertion (if collapse "\r" "\n")))
1913 (goto-char (point-min))
1914 (while (not (progn (skip-chars-forward line-end) (eobp)))
1915 (when (or (not collapse)
1920 (skip-chars-forward "\n ")))))))
1923 (defun ebrowse-unhide-base-classes ()
1924 "Unhide the line the cursor is on and all base classes."
1927 (let (indent last-indent)
1928 (skip-chars-backward "^\r\n")
1929 (when (not (looking-at "[\r\n][^ \t]"))
1930 (skip-chars-forward "\r\n \t")
1931 (while (and (or (null last-indent) ;first time
1932 (> indent 1)) ;not root class
1933 (re-search-backward "[\r\n][ \t]*" nil t))
1934 (setf indent (- (match-end 0)
1935 (match-beginning 0)))
1936 (when (or (null last-indent)
1937 (< indent last-indent))
1938 (setf last-indent indent)
1939 (when (looking-at "\r")
1942 (backward-char 1)))))))
1945 (defun ebrowse-hide-line (collapse)
1946 "Hide/show a single line in the tree.
1947 COLLAPSE non-nil means hide."
1950 (skip-chars-forward "^\r\n")
1952 (insert (if collapse 13 10)))))
1955 (defun ebrowse-collapse-fn (collapse)
1956 "Collapse or expand a branch of the tree.
1957 COLLAPSE non-nil means collapse the branch."
1961 (skip-chars-forward "> \t")
1962 (let ((indentation (current-column)))
1963 (while (and (not (eobp))
1965 (skip-chars-forward "^\r\n")
1966 (goto-char (1+ (point)))
1967 (skip-chars-forward "> \t")
1968 (> (current-column) indentation)))
1969 (ebrowse-hide-line collapse)
1970 (skip-chars-forward "^\r\n")
1971 (goto-char (1+ (point))))))))
1974 ;;; Electric tree selection
1976 (defvar ebrowse-electric-list-mode-map ()
1977 "Keymap used in electric Ebrowse buffer list window.")
1980 (unless ebrowse-electric-list-mode-map
1981 (let ((map (make-keymap))
1982 (submap (make-keymap)))
1983 (setq ebrowse-electric-list-mode-map map)
1984 (fillarray (car (cdr map)) 'ebrowse-electric-list-undefined)
1985 (fillarray (car (cdr submap)) 'ebrowse-electric-list-undefined)
1986 (define-key map "\e" submap)
1987 (define-key map "\C-z" 'suspend-emacs)
1988 (define-key map "\C-h" 'Helper-help)
1989 (define-key map "?" 'Helper-describe-bindings)
1990 (define-key map "\C-c" nil)
1991 (define-key map "\C-c\C-c" 'ebrowse-electric-list-quit)
1992 (define-key map "q" 'ebrowse-electric-list-quit)
1993 (define-key map " " 'ebrowse-electric-list-select)
1994 (define-key map "\C-l" 'recenter)
1995 (define-key map "\C-u" 'universal-argument)
1996 (define-key map "\C-p" 'previous-line)
1997 (define-key map "\C-n" 'next-line)
1998 (define-key map "p" 'previous-line)
1999 (define-key map "n" 'next-line)
2000 (define-key map "v" 'ebrowse-electric-view-buffer)
2001 (define-key map "\C-v" 'scroll-up)
2002 (define-key map "\ev" 'scroll-down)
2003 (define-key map "\e\C-v" 'scroll-other-window)
2004 (define-key map "\e>" 'end-of-buffer)
2005 (define-key map "\e<" 'beginning-of-buffer)
2006 (define-key map "\e>" 'end-of-buffer)))
2008 (put 'ebrowse-electric-list-mode 'mode-class 'special)
2009 (put 'ebrowse-electric-list-undefined 'suppress-keymap t)
2012 (defun ebrowse-electric-list-mode ()
2013 "Mode for electric tree list mode."
2014 (kill-all-local-variables)
2015 (use-local-map ebrowse-electric-list-mode-map)
2016 (setq mode-name "Electric Position Menu"
2017 mode-line-buffer-identification "Electric Tree Menu")
2018 (when (memq 'mode-name mode-line-format)
2019 (setq mode-line-format (copy-sequence mode-line-format))
2020 (setcar (memq 'mode-name mode-line-format) "Tree Buffers"))
2021 (make-local-variable 'Helper-return-blurb)
2022 (setq Helper-return-blurb "return to buffer editing"
2025 major-mode 'ebrowse-electric-list-mode)
2026 (run-hooks 'ebrowse-electric-list-mode-hook))
2029 (defun ebrowse-list-tree-buffers ()
2030 "Display a list of all tree buffers."
2031 (set-buffer (get-buffer-create "*Tree Buffers*"))
2032 (setq buffer-read-only nil)
2034 (insert "Tree\n" "----\n")
2035 (dolist (buffer (ebrowse-known-class-trees-buffer-list))
2036 (insert (buffer-name buffer) "\n"))
2037 (setq buffer-read-only t))
2041 (defun ebrowse-electric-choose-tree ()
2042 "Return a buffer containing a tree or nil if no tree found or canceled."
2044 (unless (car (ebrowse-known-class-trees-buffer-list))
2045 (error "No tree buffers"))
2046 (let (select buffer window)
2047 (save-window-excursion
2048 (save-window-excursion (ebrowse-list-tree-buffers))
2049 (setq window (Electric-pop-up-window "*Tree Buffers*")
2050 buffer (window-buffer window))
2051 (shrink-window-if-larger-than-buffer window)
2055 (ebrowse-electric-list-mode)
2057 (catch 'ebrowse-electric-list-select
2058 (message "<<< Press Space to bury the list >>>")
2059 (let ((first (progn (goto-char (point-min))
2062 (last (progn (goto-char (point-max))
2067 (Electric-command-loop 'ebrowse-electric-list-select
2070 'ebrowse-electric-list-looper
2071 (cons first last))))))
2073 (bury-buffer buffer)
2077 (setq select (ebrowse-electric-get-buffer select)))
2078 (kill-buffer buffer)
2082 (defun ebrowse-electric-list-looper (state condition)
2083 "Prevent cursor from moving beyond the buffer end.
2084 Don't let it move into the title lines.
2085 See 'Electric-command-loop' for a description of STATE and CONDITION."
2086 (cond ((and condition
2087 (not (memq (car condition)
2088 '(buffer-read-only end-of-buffer
2089 beginning-of-buffer))))
2090 (signal (car condition) (cdr condition)))
2091 ((< (point) (car state))
2092 (goto-char (point-min))
2094 ((> (point) (cdr state))
2095 (goto-char (point-max))
2097 (if (pos-visible-in-window-p (point-max))
2101 (defun ebrowse-electric-list-undefined ()
2102 "Function called for keys that are undefined."
2104 (message "Type C-h for help, ? for commands, q to quit, Space to select.")
2108 (defun ebrowse-electric-list-quit ()
2109 "Discard the buffer list."
2111 (throw 'ebrowse-electric-list-select nil))
2114 (defun ebrowse-electric-list-select ()
2115 "Select a buffer from the buffer list."
2117 (throw 'ebrowse-electric-list-select (point)))
2120 (defun ebrowse-electric-get-buffer (point)
2121 "Get a buffer corresponding to the line POINT is in."
2122 (let ((index (- (count-lines (point-min) point) 2)))
2123 (nth index (ebrowse-known-class-trees-buffer-list))))
2126 ;;; View a buffer for a tree.
2128 (defun ebrowse-electric-view-buffer ()
2129 "View buffer point is on."
2131 (let ((buffer (ebrowse-electric-get-buffer (point))))
2133 (view-buffer buffer))
2135 (error "Buffer no longer exists")))))
2138 (defun ebrowse-choose-from-browser-buffers ()
2139 "Read a browser buffer name from the minibuffer and return that buffer."
2140 (let* ((buffers (ebrowse-known-class-trees-buffer-list)))
2142 (if (not (second buffers))
2144 (or (ebrowse-electric-choose-tree) (error "No tree buffer")))
2145 (let* ((insert-default-directory t)
2146 (file (read-file-name "Find tree: " nil nil t)))
2149 (find-buffer-visiting file)))))
2154 (unless ebrowse-member-mode-map
2155 (let ((map (make-keymap)))
2156 (setf ebrowse-member-mode-map map)
2157 (suppress-keymap map)
2159 (when (display-mouse-p)
2160 (define-key map [down-mouse-3] 'ebrowse-member-mouse-3)
2161 (define-key map [mouse-2] 'ebrowse-member-mouse-2))
2163 (let ((map1 (make-sparse-keymap)))
2164 (suppress-keymap map1 t)
2165 (define-key map "C" map1)
2166 (define-key map1 "b" 'ebrowse-switch-member-buffer-to-base-class)
2167 (define-key map1 "c" 'ebrowse-switch-member-buffer-to-any-class)
2168 (define-key map1 "d" 'ebrowse-switch-member-buffer-to-derived-class)
2169 (define-key map1 "n" 'ebrowse-switch-member-buffer-to-next-sibling-class)
2170 (define-key map1 "p" 'ebrowse-switch-member-buffer-to-previous-sibling-class))
2172 (let ((map1 (make-sparse-keymap)))
2173 (suppress-keymap map1 t)
2174 (define-key map "D" map1)
2175 (define-key map1 "a" 'ebrowse-toggle-member-attributes-display)
2176 (define-key map1 "b" 'ebrowse-toggle-base-class-display)
2177 (define-key map1 "f" 'ebrowse-freeze-member-buffer)
2178 (define-key map1 "l" 'ebrowse-toggle-long-short-display)
2179 (define-key map1 "r" 'ebrowse-toggle-regexp-display)
2180 (define-key map1 "w" 'ebrowse-set-member-buffer-column-width))
2182 (let ((map1 (make-sparse-keymap)))
2183 (suppress-keymap map1 t)
2184 (define-key map "F" map1)
2185 (let ((map2 (make-sparse-keymap)))
2186 (suppress-keymap map2 t)
2187 (define-key map1 "a" map2)
2188 (define-key map2 "i" 'ebrowse-toggle-private-member-filter)
2189 (define-key map2 "o" 'ebrowse-toggle-protected-member-filter)
2190 (define-key map2 "u" 'ebrowse-toggle-public-member-filter))
2191 (define-key map1 "c" 'ebrowse-toggle-const-member-filter)
2192 (define-key map1 "i" 'ebrowse-toggle-inline-member-filter)
2193 (define-key map1 "p" 'ebrowse-toggle-pure-member-filter)
2194 (define-key map1 "r" 'ebrowse-remove-all-member-filters)
2195 (define-key map1 "v" 'ebrowse-toggle-virtual-member-filter))
2197 (let ((map1 (make-sparse-keymap)))
2198 (suppress-keymap map1 t)
2199 (define-key map "L" map1)
2200 (define-key map1 "d" 'ebrowse-display-friends-member-list)
2201 (define-key map1 "f" 'ebrowse-display-function-member-list)
2202 (define-key map1 "F" 'ebrowse-display-static-functions-member-list)
2203 (define-key map1 "n" 'ebrowse-display-next-member-list)
2204 (define-key map1 "p" 'ebrowse-display-previous-member-list)
2205 (define-key map1 "t" 'ebrowse-display-types-member-list)
2206 (define-key map1 "v" 'ebrowse-display-variables-member-list)
2207 (define-key map1 "V" 'ebrowse-display-static-variables-member-list))
2209 (let ((map1 (make-sparse-keymap)))
2210 (suppress-keymap map1 t)
2211 (define-key map "G" map1)
2212 (define-key map1 "m" 'ebrowse-goto-visible-member/all-member-lists)
2213 (define-key map1 "n" 'ebrowse-repeat-member-search)
2214 (define-key map1 "v" 'ebrowse-goto-visible-member))
2216 (define-key map "f" 'ebrowse-find-member-declaration)
2217 (define-key map "m" 'ebrowse-switch-to-next-member-buffer)
2218 (define-key map "q" 'bury-buffer)
2219 (define-key map "t" 'ebrowse-show-displayed-class-in-tree)
2220 (define-key map "v" 'ebrowse-view-member-declaration)
2221 (define-key map " " 'ebrowse-view-member-definition)
2222 (define-key map "?" 'describe-mode)
2223 (define-key map "\C-i" 'ebrowse-pop-from-member-to-tree-buffer)
2224 (define-key map "\C-l" 'ebrowse-redisplay-member-buffer)
2225 (define-key map "\C-m" 'ebrowse-find-member-definition)))
2232 (defun ebrowse-member-mode ()
2233 "Major mode for Ebrowse member buffers.
2235 \\{ebrowse-member-mode-map}"
2236 (kill-all-local-variables)
2237 (use-local-map ebrowse-member-mode-map)
2238 (setq major-mode 'ebrowse-member-mode)
2239 (mapcar 'make-local-variable
2240 '(ebrowse--decl-column ;display column
2241 ebrowse--n-columns ;number of short columns
2242 ebrowse--column-width ;width of columns above
2243 ebrowse--show-inherited-flag ;include inherited members?
2244 ebrowse--filters ;public, protected, private
2245 ebrowse--accessor ;vars, functions, friends
2246 ebrowse--displayed-class ;class displayed
2247 ebrowse--long-display-flag ;display with regexps?
2248 ebrowse--source-regexp-flag ;show source regexp?
2249 ebrowse--attributes-flag ;show `virtual' and `inline'
2250 ebrowse--member-list ;list of members displayed
2251 ebrowse--tree ;the class tree
2252 ebrowse--member-mode-strings ;part of mode line
2253 ebrowse--tags-file-name ;
2255 ebrowse--tree-obarray
2256 ebrowse--virtual-display-flag
2257 ebrowse--inline-display-flag
2258 ebrowse--const-display-flag
2259 ebrowse--pure-display-flag
2260 ebrowse--frozen-flag)) ;buffer not automagically reused
2261 (setq mode-name "Ebrowse-Members"
2262 mode-line-buffer-identification
2263 (propertized-buffer-identification "C++ Members")
2265 ebrowse--long-display-flag nil
2266 ebrowse--attributes-flag t
2267 ebrowse--show-inherited-flag t
2268 ebrowse--source-regexp-flag nil
2269 ebrowse--filters [0 1 2]
2270 ebrowse--decl-column ebrowse-default-declaration-column
2271 ebrowse--column-width ebrowse-default-column-width
2272 ebrowse--virtual-display-flag nil
2273 ebrowse--inline-display-flag nil
2274 ebrowse--const-display-flag nil
2275 ebrowse--pure-display-flag nil)
2276 (modify-syntax-entry ?_ (char-to-string (char-syntax ?a)))
2277 (run-hooks 'ebrowse-member-mode-hook))
2281 ;;; Member mode mode line
2283 (defsubst ebrowse-class-name-displayed-in-member-buffer ()
2284 "Return the name of the class displayed in the member buffer."
2285 (ebrowse-cs-name (ebrowse-ts-class ebrowse--displayed-class)))
2288 (defsubst ebrowse-member-list-name ()
2289 "Return a string describing what is displayed in the member buffer."
2290 (get ebrowse--accessor (if (ebrowse-globals-tree-p ebrowse--displayed-class)
2291 'ebrowse-global-title
2295 (defun ebrowse-update-member-buffer-mode-line ()
2296 "Update the mode line of member buffers."
2297 (let* ((name (when ebrowse--frozen-flag
2298 (concat (ebrowse-class-name-displayed-in-member-buffer)
2300 (ident (concat name (ebrowse-member-list-name))))
2301 (setq mode-line-buffer-identification
2302 (propertized-buffer-identification ident))
2303 (ebrowse-rename-buffer (if name ident ebrowse-member-buffer-name))
2304 (force-mode-line-update)))
2307 ;;; Misc member buffer commands
2309 (defun ebrowse-freeze-member-buffer ()
2310 "Toggle frozen status of current buffer."
2312 (setq ebrowse--frozen-flag (not ebrowse--frozen-flag))
2313 (ebrowse-redisplay-member-buffer))
2316 (defun ebrowse-show-displayed-class-in-tree (arg)
2317 "Show the currently displayed class in the tree window.
2318 With prefix ARG, switch to the tree buffer else pop to it."
2320 (let ((class-name (ebrowse-class-name-displayed-in-member-buffer)))
2321 (when (ebrowse-pop-from-member-to-tree-buffer arg)
2322 (ebrowse-read-class-name-and-go class-name))))
2325 (defun ebrowse-set-member-buffer-column-width ()
2326 "Set the column width of the member display.
2327 The new width is read from the minibuffer."
2329 (let ((width (string-to-int
2330 (read-from-minibuffer
2331 (concat "Column width ("
2332 (int-to-string (if ebrowse--long-display-flag
2333 ebrowse--decl-column
2334 ebrowse--column-width))
2337 (if ebrowse--long-display-flag
2338 (setq ebrowse--decl-column width)
2339 (setq ebrowse--column-width width))
2340 (ebrowse-redisplay-member-buffer))))
2343 (defun ebrowse-pop-from-member-to-tree-buffer (arg)
2344 "Pop from a member buffer to the matching tree buffer.
2345 Switch to the buffer if prefix ARG. If no tree buffer exists,
2348 (let ((buf (or (get-buffer (ebrowse-frozen-tree-buffer-name
2349 ebrowse--tags-file-name))
2350 (get-buffer ebrowse-tree-buffer-name)
2351 (ebrowse-create-tree-buffer ebrowse--tree
2352 ebrowse--tags-file-name
2354 ebrowse--tree-obarray
2357 (funcall (if arg 'switch-to-buffer 'pop-to-buffer) buf))
2362 ;;; Switching between member lists
2364 (defun ebrowse-display-member-list-for-accessor (accessor)
2365 "Switch the member buffer to display the member list for ACCESSOR."
2366 (setf ebrowse--accessor accessor
2367 ebrowse--member-list (funcall accessor ebrowse--displayed-class))
2368 (ebrowse-redisplay-member-buffer))
2371 (defun ebrowse-cyclic-display-next/previous-member-list (incr)
2372 "Switch buffer to INCR'th next/previous list of members."
2373 (let ((index (ebrowse-position ebrowse--accessor
2374 ebrowse-member-list-accessors)))
2375 (setf ebrowse--accessor
2378 ebrowse-member-list-accessors)
2379 (first ebrowse-member-list-accessors)))
2381 (or (and (>= (decf index) 0)
2383 ebrowse-member-list-accessors))
2384 (first (last ebrowse-member-list-accessors))))))
2385 (ebrowse-display-member-list-for-accessor ebrowse--accessor)))
2388 (defun ebrowse-display-next-member-list ()
2389 "Switch buffer to next member list."
2391 (ebrowse-cyclic-display-next/previous-member-list 1))
2394 (defun ebrowse-display-previous-member-list ()
2395 "Switch buffer to previous member list."
2397 (ebrowse-cyclic-display-next/previous-member-list -1))
2400 (defun ebrowse-display-function-member-list ()
2401 "Display the list of member functions."
2403 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-member-functions))
2406 (defun ebrowse-display-variables-member-list ()
2407 "Display the list of member variables."
2409 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-member-variables))
2412 (defun ebrowse-display-static-variables-member-list ()
2413 "Display the list of static member variables."
2415 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-static-variables))
2418 (defun ebrowse-display-static-functions-member-list ()
2419 "Display the list of static member functions."
2421 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-static-functions))
2424 (defun ebrowse-display-friends-member-list ()
2425 "Display the list of friends."
2427 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-friends))
2430 (defun ebrowse-display-types-member-list ()
2431 "Display the list of types."
2433 (ebrowse-display-member-list-for-accessor 'ebrowse-ts-types))
2437 ;;; Filters and other display attributes
2439 (defun ebrowse-toggle-member-attributes-display ()
2440 "Toggle display of `virtual', `inline', `const' etc."
2442 (setq ebrowse--attributes-flag (not ebrowse--attributes-flag))
2443 (ebrowse-redisplay-member-buffer))
2446 (defun ebrowse-toggle-base-class-display ()
2447 "Toggle the display of members inherited from base classes."
2449 (setf ebrowse--show-inherited-flag (not ebrowse--show-inherited-flag))
2450 (ebrowse-redisplay-member-buffer))
2453 (defun ebrowse-toggle-pure-member-filter ()
2454 "Toggle display of pure virtual members."
2456 (setf ebrowse--pure-display-flag (not ebrowse--pure-display-flag))
2457 (ebrowse-redisplay-member-buffer))
2460 (defun ebrowse-toggle-const-member-filter ()
2461 "Toggle display of const members."
2463 (setf ebrowse--const-display-flag (not ebrowse--const-display-flag))
2464 (ebrowse-redisplay-member-buffer))
2467 (defun ebrowse-toggle-inline-member-filter ()
2468 "Toggle display of inline members."
2470 (setf ebrowse--inline-display-flag (not ebrowse--inline-display-flag))
2471 (ebrowse-redisplay-member-buffer))
2474 (defun ebrowse-toggle-virtual-member-filter ()
2475 "Toggle display of virtual members."
2477 (setf ebrowse--virtual-display-flag (not ebrowse--virtual-display-flag))
2478 (ebrowse-redisplay-member-buffer))
2481 (defun ebrowse-remove-all-member-filters ()
2482 "Remove all filters."
2485 (aset ebrowse--filters i i))
2486 (setq ebrowse--pure-display-flag nil
2487 ebrowse--const-display-flag nil
2488 ebrowse--virtual-display-flag nil
2489 ebrowse--inline-display-flag nil)
2490 (ebrowse-redisplay-member-buffer))
2493 (defun ebrowse-toggle-public-member-filter ()
2494 "Toggle visibility of public members."
2496 (ebrowse-set-member-access-visibility 0)
2497 (ebrowse-redisplay-member-buffer))
2500 (defun ebrowse-toggle-protected-member-filter ()
2501 "Toggle visibility of protected members."
2503 (ebrowse-set-member-access-visibility 1)
2504 (ebrowse-redisplay-member-buffer))
2507 (defun ebrowse-toggle-private-member-filter ()
2508 "Toggle visibility of private members."
2510 (ebrowse-set-member-access-visibility 2)
2511 (ebrowse-redisplay-member-buffer))
2514 (defun ebrowse-set-member-access-visibility (vis)
2515 (setf (aref ebrowse--filters vis)
2516 (if (aref ebrowse--filters vis) nil vis)))
2519 (defun ebrowse-toggle-long-short-display ()
2520 "Toggle between long and short display form of member buffers."
2522 (setf ebrowse--long-display-flag (not ebrowse--long-display-flag))
2523 (ebrowse-redisplay-member-buffer))
2526 (defun ebrowse-toggle-regexp-display ()
2527 "Toggle declaration/definition regular expression display.
2528 Used in member buffers showing the long display form."
2530 (setf ebrowse--source-regexp-flag (not ebrowse--source-regexp-flag))
2531 (ebrowse-redisplay-member-buffer))
2535 ;;; Viewing/finding members
2537 (defun ebrowse-find-member-definition (&optional prefix)
2538 "Find the file containing a member definition.
2539 With PREFIX 4. find file in another window, with prefix 5
2540 find file in another frame."
2542 (ebrowse-view/find-member-declaration/definition prefix nil t))
2545 (defun ebrowse-view-member-definition (prefix)
2546 "View the file containing a member definition.
2547 With PREFIX 4. find file in another window, with prefix 5
2548 find file in another frame."
2550 (ebrowse-view/find-member-declaration/definition prefix t t))
2553 (defun ebrowse-find-member-declaration (prefix)
2554 "Find the file containing a member's declaration.
2555 With PREFIX 4. find file in another window, with prefix 5
2556 find file in another frame."
2558 (ebrowse-view/find-member-declaration/definition prefix nil))
2561 (defun ebrowse-view-member-declaration (prefix)
2562 "View the file containing a member's declaration.
2563 With PREFIX 4. find file in another window, with prefix 5
2564 find file in another frame."
2566 (ebrowse-view/find-member-declaration/definition prefix t))
2569 (defun* ebrowse-view/find-member-declaration/definition
2570 (prefix view &optional definition info header tags-file-name)
2571 "Find or view a member declaration or definition.
2572 With PREFIX 4. find file in another window, with prefix 5
2573 find file in another frame.
2574 DEFINITION non-nil means find the definition, otherwise find the
2576 INFO is a list (TREE ACCESSOR MEMBER) describing the member to
2578 TAGS-FILE-NAME is the file name of the BROWSE file."
2580 (setq header ebrowse--header))
2581 (unless tags-file-name
2582 (setq tags-file-name ebrowse--tags-file-name))
2583 (let (tree member accessor file on-class
2584 (where (if (= prefix 4) 'other-window
2585 (if (= prefix 5) 'other-frame 'this-window))))
2586 ;; If not given as parameters, get the necessary information
2587 ;; out of the member buffer.
2589 (setq tree (first info)
2590 accessor (second info)
2591 member (third info))
2592 (multiple-value-setq (tree member on-class)
2593 (ebrowse-member-info-from-point))
2594 (setq accessor ebrowse--accessor))
2595 ;; View/find class if on a line containing a class name.
2597 (return-from ebrowse-view/find-member-declaration/definition
2598 (ebrowse-view/find-file-and-search-pattern
2599 (ebrowse-ts-class tree)
2600 (list ebrowse--header (ebrowse-ts-class tree) nil)
2601 (ebrowse-cs-file (ebrowse-ts-class tree))
2602 tags-file-name view where)))
2603 ;; For some member lists, it doesn't make sense to search for
2604 ;; a definition. If this is requested, silently search for the
2606 (when (and definition
2607 (eq accessor 'ebrowse-ts-member-variables))
2608 (setq definition nil))
2609 ;; Construct a suitable `browse' struct for definitions.
2611 (setf member (make-ebrowse-ms
2612 :name (ebrowse-ms-name member)
2613 :file (ebrowse-ms-definition-file member)
2614 :pattern (ebrowse-ms-definition-pattern
2616 :flags (ebrowse-ms-flags member)
2617 :point (ebrowse-ms-definition-point
2619 ;; When no file information in member, use that of the class
2620 (setf file (or (ebrowse-ms-file member)
2622 (ebrowse-cs-source-file (ebrowse-ts-class tree))
2623 (ebrowse-cs-file (ebrowse-ts-class tree)))))
2624 ;; When we have no regular expressions in the database the only
2625 ;; indication that the parser hasn't seen a definition/declaration
2626 ;; is that the search start point will be zero.
2627 (if (or (null file) (zerop (ebrowse-ms-point member)))
2628 (if (y-or-n-p (concat "No information about "
2629 (if definition "definition" "declaration")
2631 (if definition "declaration" "definition")
2633 (ebrowse-ms-name member)
2637 ;; Recurse with new info.
2638 (ebrowse-view/find-member-declaration/definition
2639 prefix view (not definition) info header tags-file-name))
2640 (error "Search canceled"))
2642 (ebrowse-view/find-file-and-search-pattern
2643 (make-ebrowse-bs :name (ebrowse-ms-name member)
2644 :pattern (ebrowse-ms-pattern member)
2645 :file (ebrowse-ms-file member)
2646 :flags (ebrowse-ms-flags member)
2647 :point (ebrowse-ms-point member))
2648 (list header member accessor)
2656 ;;; Drawing the member buffer
2658 (defun ebrowse-redisplay-member-buffer ()
2659 "Force buffer redisplay."
2661 (let ((display-fn (if ebrowse--long-display-flag
2662 'ebrowse-draw-member-long-fn
2663 'ebrowse-draw-member-short-fn)))
2667 (ebrowse-draw-member-buffer-class-line)
2668 (funcall display-fn ebrowse--member-list ebrowse--displayed-class)
2669 ;; Show inherited members if corresponding switch is on
2670 (when ebrowse--show-inherited-flag
2671 (dolist (super (ebrowse-base-classes ebrowse--displayed-class))
2672 (goto-char (point-max))
2673 (insert (if (bolp) "\n\n" "\n"))
2674 (ebrowse-draw-member-buffer-class-line super)
2675 (funcall display-fn (funcall ebrowse--accessor super) super)))
2676 (ebrowse-update-member-buffer-mode-line))))
2679 (defun ebrowse-draw-member-buffer-class-line (&optional class)
2680 "Display the title line for a class section in the member buffer.
2681 CLASS non-nil means display that class' title. Otherwise use
2682 the class cursor is on."
2683 (let ((start (point))
2684 (tree (or class ebrowse--displayed-class))
2688 (setq class-name-start (point))
2689 (insert (ebrowse-qualified-class-name (ebrowse-ts-class tree)))
2690 (when (ebrowse-template-p (ebrowse-ts-class tree))
2692 (setq class-name-end (point))
2694 (ebrowse-set-face start (point) 'ebrowse-member-class-face)
2695 (add-text-properties
2696 class-name-start class-name-end
2697 '(ebrowse-what class-name
2698 mouse-face highlight
2699 help-echo "mouse-3: menu"))
2700 (put-text-property start class-name-end 'ebrowse-tree tree)))
2703 (defun ebrowse-display-member-buffer (list &optional stand-alone class)
2704 "Start point for member buffer creation.
2705 LIST is the member list to display. STAND-ALONE non-nil
2706 means the member buffer is standalone. CLASS is its class."
2707 (let* ((classes ebrowse--tree-obarray)
2708 (tree ebrowse--tree)
2709 (tags-file-name ebrowse--tags-file-name)
2710 (header ebrowse--header)
2711 temp-buffer-setup-hook
2712 (temp-buffer (get-buffer ebrowse-member-buffer-name)))
2713 ;; Get the class description from the name the cursor
2714 ;; is on if not specified as an argument.
2716 (setq class (ebrowse-tree-at-point)))
2717 (with-output-to-temp-buffer ebrowse-member-buffer-name
2719 (set-buffer standard-output)
2720 ;; If new buffer, set the mode and initial values of locals
2722 (ebrowse-member-mode))
2723 ;; Set local variables
2724 (setq ebrowse--member-list (funcall list class)
2725 ebrowse--displayed-class class
2726 ebrowse--accessor list
2727 ebrowse--tree-obarray classes
2728 ebrowse--frozen-flag stand-alone
2729 ebrowse--tags-file-name tags-file-name
2730 ebrowse--header header
2733 (ebrowse-redisplay-member-buffer)
2734 (current-buffer)))))
2737 (defun ebrowse-member-display-p (member)
2738 "Return t if MEMBER must be displayed under the current filter settings."
2739 (if (and (aref ebrowse--filters (ebrowse-ms-visibility member))
2740 (or (null ebrowse--const-display-flag)
2741 (ebrowse-const-p member))
2742 (or (null ebrowse--inline-display-flag)
2743 (ebrowse-inline-p member))
2744 (or (null ebrowse--pure-display-flag)
2745 (ebrowse-bs-p member))
2746 (or (null ebrowse--virtual-display-flag)
2747 (ebrowse-virtual-p member)))
2751 (defun ebrowse-draw-member-attributes (member)
2752 "Insert a string for the attributes of MEMBER."
2753 (insert (if (ebrowse-template-p member) "T" "-")
2754 (if (ebrowse-extern-c-p member) "C" "-")
2755 (if (ebrowse-virtual-p member) "v" "-")
2756 (if (ebrowse-inline-p member) "i" "-")
2757 (if (ebrowse-const-p member) "c" "-")
2758 (if (ebrowse-pure-virtual-p member) "0" "-")
2759 (if (ebrowse-mutable-p member) "m" "-")
2760 (if (ebrowse-explicit-p member) "e" "-")
2761 (if (ebrowse-throw-list-p member) "t" "-")))
2764 (defun ebrowse-draw-member-regexp (member-struc)
2765 "Insert a string for the regular expression matching MEMBER-STRUC."
2766 (let ((pattern (if ebrowse--source-regexp-flag
2767 (ebrowse-ms-definition-pattern
2769 (ebrowse-ms-pattern member-struc))))
2770 (cond ((stringp pattern)
2771 (insert (ebrowse-trim-string pattern) "...\n")
2772 (beginning-of-line 0)
2773 (move-to-column (+ 4 ebrowse--decl-column))
2774 (while (re-search-forward "[ \t]+" nil t)
2775 (delete-region (match-beginning 0) (match-end 0))
2777 (beginning-of-line 2))
2779 (insert "[not recorded or unknown]\n")))))
2782 (defun ebrowse-draw-member-long-fn (member-list tree)
2783 "Display member buffer for MEMBER-LIST in long form.
2784 TREE is the class tree of MEMBER-LIST."
2785 (dolist (member-struc (mapcar 'ebrowse-member-display-p member-list))
2787 (let ((name (ebrowse-ms-name member-struc))
2789 ;; Insert member name truncated to the right length
2790 (insert (substring name
2793 (1- ebrowse--decl-column))))
2794 (add-text-properties
2796 `(mouse-face highlight ebrowse-what member-name
2797 ebrowse-member ,member-struc
2799 help-echo "mouse-2: view definition; mouse-3: menu"))
2800 ;; Display virtual, inline, and const status
2801 (setf start (point))
2802 (indent-to ebrowse--decl-column)
2803 (put-text-property start (point) 'mouse-face nil)
2804 (when ebrowse--attributes-flag
2805 (let ((start (point)))
2807 (ebrowse-draw-member-attributes member-struc)
2809 (ebrowse-set-face start (point)
2810 'ebrowse-member-attribute-face)))
2812 (ebrowse-draw-member-regexp member-struc))))
2814 (goto-char (point-min)))
2817 (defun ebrowse-draw-member-short-fn (member-list tree)
2818 "Display MEMBER-LIST in short form.
2819 TREE is the class tree in which the members are found."
2821 (column-width (+ ebrowse--column-width
2822 (if ebrowse--attributes-flag 12 0))))
2823 ;; Get the number of columns to draw.
2824 (setq ebrowse--n-columns
2825 (max 1 (/ (ebrowse-width-of-drawable-area) column-width)))
2826 (dolist (member (mapcar #'ebrowse-member-display-p member-list))
2828 (let ((name (ebrowse-ms-name member))
2830 (start-of-column (point))
2832 (indent-to (* i column-width))
2833 (put-text-property start-of-column (point) 'mouse-face nil)
2834 (setq start-of-entry (point))
2835 ;; Show various attributes
2836 (when ebrowse--attributes-flag
2838 (ebrowse-draw-member-attributes member)
2840 (ebrowse-set-face start-of-entry (point)
2841 'ebrowse-member-attribute-face))
2842 ;; insert member name truncated to column width
2843 (setq start-of-name (point))
2844 (insert (substring name 0
2846 (1- ebrowse--column-width))))
2847 ;; set text properties
2848 (add-text-properties
2849 start-of-name (point)
2850 `(ebrowse-what member-name
2851 ebrowse-member ,member
2852 mouse-face highlight
2854 help-echo "mouse-2: view definition; mouse-3: menu"))
2856 (when (>= i ebrowse--n-columns)
2861 (goto-char (point-min))))
2865 ;;; Killing members from tree
2867 (defun ebrowse-member-info-from-point ()
2868 "Ger information about the member at point.
2869 The result has the form (TREE MEMBER NULL-P). TREE is the tree
2870 we're in, MEMBER is the member we're on. NULL-P is t if MEMBER
2872 (let ((tree (or (get-text-property (point) 'ebrowse-tree)
2873 (error "No information at point")))
2874 (member (get-text-property (point) 'ebrowse-member)))
2875 (list tree member (null member))))
2879 ;;; Switching member buffer to display a selected member
2881 (defun ebrowse-goto-visible-member/all-member-lists (prefix)
2882 "Position cursor on a member read from the minibuffer.
2883 With PREFIX, search all members in the tree. Otherwise consider
2884 only members visible in the buffer."
2886 (ebrowse-ignoring-completion-case
2887 (let* ((completion-list (ebrowse-name/accessor-alist-for-class-members))
2888 (member (completing-read "Goto member: " completion-list nil t))
2889 (accessor (cdr (assoc member completion-list))))
2891 (error "`%s' not found" member))
2892 (unless (eq accessor ebrowse--accessor)
2893 (setf ebrowse--accessor accessor
2894 ebrowse--member-list (funcall accessor ebrowse--displayed-class))
2895 (ebrowse-redisplay-member-buffer))
2896 (ebrowse-move-point-to-member member))))
2899 (defun ebrowse-goto-visible-member (repeat)
2900 "Position point on a member.
2901 Read the member's name from the minibuffer. Consider only members
2902 visible in the member buffer.
2903 REPEAT non-nil means repeat the search that number of times."
2905 (ebrowse-ignoring-completion-case
2907 (let* ((completion-list (ebrowse-name/accessor-alist-for-visible-members))
2908 (member (completing-read "Goto member: " completion-list nil t)))
2909 (ebrowse-move-point-to-member member repeat))))
2913 ;;; Searching a member in the member buffer
2915 (defun ebrowse-repeat-member-search (repeat)
2916 "Repeat the last regular expression search.
2917 REPEAT, if specified, says repeat the search REPEAT times."
2919 (unless ebrowse--last-regexp
2920 (error "No regular expression remembered"))
2921 ;; Skip over word the point is on
2922 (skip-chars-forward "^ \t\n")
2923 ;; Search for regexp from point
2924 (if (re-search-forward ebrowse--last-regexp nil t repeat)
2926 (goto-char (match-beginning 0))
2927 (skip-chars-forward " \t\n"))
2928 ;; If not found above, repeat search from buffer start
2929 (goto-char (point-min))
2930 (if (re-search-forward ebrowse--last-regexp nil t)
2932 (goto-char (match-beginning 0))
2933 (skip-chars-forward " \t\n"))
2934 (error "Not found"))))
2937 (defun* ebrowse-move-point-to-member (name &optional count &aux member)
2938 "Set point on member NAME in the member buffer
2939 COUNT, if specified, says search the COUNT'th member with the same name."
2940 (goto-char (point-min))
2943 (substring name 0 (min (length name) (1- ebrowse--column-width)))
2944 ebrowse--last-regexp
2945 (concat "[ \t\n]" (regexp-quote member) "[ \n\t]"))
2946 (if (re-search-forward ebrowse--last-regexp nil t count)
2947 (goto-char (1+ (match-beginning 0)))
2948 (error "Not found")))
2952 ;;; Switching member buffer to another class.
2954 (defun ebrowse-switch-member-buffer-to-other-class (title compl-list)
2955 "Switch member buffer to a class read from the minibuffer.
2956 Use TITLE as minibuffer prompt.
2957 COMPL-LIST is a completion list to use."
2958 (let* ((initial (unless (second compl-list)
2959 (first (first compl-list))))
2960 (class (or (ebrowse-completing-read-value title compl-list initial)
2961 (error "Not found"))))
2962 (setf ebrowse--displayed-class class
2963 ebrowse--member-list (funcall ebrowse--accessor ebrowse--displayed-class))
2964 (ebrowse-redisplay-member-buffer)))
2967 (defun ebrowse-switch-member-buffer-to-any-class ()
2968 "Switch member buffer to a class read from the minibuffer."
2970 (ebrowse-switch-member-buffer-to-other-class
2971 "Goto class: " (ebrowse-tree-obarray-as-alist)))
2974 (defun ebrowse-switch-member-buffer-to-base-class (arg)
2975 "Switch buffer to ARG'th base class."
2977 (let ((supers (or (ebrowse-direct-base-classes ebrowse--displayed-class)
2978 (error "No base classes"))))
2979 (if (and arg (second supers))
2980 (let ((alist (loop for s in supers
2981 collect (cons (ebrowse-qualified-class-name
2982 (ebrowse-ts-class s))
2984 (ebrowse-switch-member-buffer-to-other-class
2985 "Goto base class: " alist))
2986 (setq ebrowse--displayed-class (first supers)
2987 ebrowse--member-list
2988 (funcall ebrowse--accessor ebrowse--displayed-class))
2989 (ebrowse-redisplay-member-buffer))))
2991 (defun ebrowse-switch-member-buffer-to-next-sibling-class (arg)
2992 "Move to ARG'th next sibling."
2994 (ebrowse-switch-member-buffer-to-sibling-class arg))
2997 (defun ebrowse-switch-member-buffer-to-previous-sibling-class (arg)
2998 "Move to ARG'th previous sibling."
3000 (ebrowse-switch-member-buffer-to-sibling-class (- arg)))
3003 (defun ebrowse-switch-member-buffer-to-sibling-class (inc)
3004 "Switch member display to nth sibling class.
3005 Prefix arg INC specifies which one."
3007 (let ((containing-list ebrowse--tree)
3009 (supers (ebrowse-direct-base-classes ebrowse--displayed-class)))
3010 (flet ((trees-alist (trees)
3011 (loop for tr in trees
3012 collect (cons (ebrowse-cs-name
3013 (ebrowse-ts-class tr)) tr))))
3015 (let ((tree (if (second supers)
3016 (ebrowse-completing-read-value
3017 "Relative to base class: "
3018 (trees-alist supers) nil)
3020 (unless tree (error "Not found"))
3021 (setq containing-list (ebrowse-ts-subclasses tree)))))
3022 (setq index (+ inc (ebrowse-position ebrowse--displayed-class
3024 (cond ((minusp index) (message "No previous class"))
3025 ((null (nth index containing-list)) (message "No next class")))
3026 (setq index (max 0 (min index (1- (length containing-list)))))
3027 (setq cls (nth index containing-list))
3028 (setf ebrowse--displayed-class cls
3029 ebrowse--member-list (funcall ebrowse--accessor cls))
3030 (ebrowse-redisplay-member-buffer)))
3033 (defun ebrowse-switch-member-buffer-to-derived-class (arg)
3034 "Switch member display to nth derived class.
3035 Prefix arg ARG says which class should be displayed. Default is
3036 the first derived class."
3038 (flet ((ebrowse-tree-obarray-as-alist ()
3039 (loop for s in (ebrowse-ts-subclasses
3040 ebrowse--displayed-class)
3041 collect (cons (ebrowse-cs-name
3042 (ebrowse-ts-class s)) s))))
3043 (let ((subs (or (ebrowse-ts-subclasses ebrowse--displayed-class)
3044 (error "No derived classes"))))
3045 (if (and arg (second subs))
3046 (ebrowse-switch-member-buffer-to-other-class
3047 "Goto derived class: " (ebrowse-tree-obarray-as-alist))
3048 (setq ebrowse--displayed-class (first subs)
3049 ebrowse--member-list
3050 (funcall ebrowse--accessor ebrowse--displayed-class))
3051 (ebrowse-redisplay-member-buffer)))))
3055 ;;; Member buffer mouse functions
3057 (defun ebrowse-displaying-functions ()
3058 (eq ebrowse--accessor 'ebrowse-ts-member-functions))
3059 (defun ebrowse-displaying-variables ()
3060 (eq ebrowse--accessor 'ebrowse-ts-member-variables))
3061 (defun ebrowse-displaying-static-functions ()
3063 (defun ebrowse-displaying-static-variables ()
3065 (defun ebrowse-displaying-types ()
3066 (eq ebrowse--accessor 'ebrowse-ts-types))
3067 (defun ebrowse-displaying-friends ()
3068 (eq ebrowse--accessor 'ebrowse-ts-friends))
3071 ebrowse-member-buffer-object-menu ebrowse-member-mode-map
3072 "Object menu for the member buffer itself."
3075 ["Functions" ebrowse-display-function-member-list
3076 :help "Show the list of member functions"
3078 :selected (eq ebrowse--accessor 'ebrowse-ts-member-functions)
3080 ["Variables" ebrowse-display-variables-member-list
3081 :help "Show the list of member variables"
3083 :selected (eq ebrowse--accessor 'ebrowse-ts-member-variables)
3085 ["Static Functions" ebrowse-display-static-functions-member-list
3086 :help "Show the list of static member functions"
3088 :selected (eq ebrowse--accessor 'ebrowse-ts-static-functions)
3090 ["Static Variables" ebrowse-display-static-variables-member-list
3091 :help "Show the list of static member variables"
3093 :selected (eq ebrowse--accessor 'ebrowse-ts-static-variables)
3095 ["Types" ebrowse-display-types-member-list
3096 :help "Show the list of nested types"
3098 :selected (eq ebrowse--accessor 'ebrowse-ts-types)
3100 ["Friends/Defines" ebrowse-display-friends-member-list
3101 :help "Show the list of friends or defines"
3103 :selected (eq ebrowse--accessor 'ebrowse-ts-friends)
3106 ["Up" ebrowse-switch-member-buffer-to-base-class
3107 :help "Show the base class of this class"
3109 ["Down" ebrowse-switch-member-buffer-to-derived-class
3110 :help "Show a derived class class of this class"
3112 ["Next Sibling" ebrowse-switch-member-buffer-to-next-sibling-class
3113 :help "Show the next sibling class"
3115 ["Previous Sibling" ebrowse-switch-member-buffer-to-previous-sibling-class
3116 :help "Show the previous sibling class"
3119 ["Show in Tree" ebrowse-show-displayed-class-in-tree
3120 :help "Show this class in the class tree"
3122 ["Find in this Class" ebrowse-goto-visible-member
3123 :help "Search for a member of this class"
3125 ["Find in Tree" ebrowse-goto-visible-member/all-member-lists
3126 :help "Search for a member in any class"
3129 ["Inherited" ebrowse-toggle-base-class-display
3130 :help "Toggle display of inherited members"
3132 :selected ebrowse--show-inherited-flag
3134 ["Attributes" ebrowse-toggle-member-attributes-display
3135 :help "Show member attributes"
3137 :selected ebrowse--attributes-flag
3139 ["Long Display" ebrowse-toggle-long-short-display
3140 :help "Toggle the member display format"
3142 :selected ebrowse--long-display-flag
3144 ["Column Width" ebrowse-set-member-buffer-column-width
3145 :help "Set the display's column width"
3148 ["Public" ebrowse-toggle-public-member-filter
3149 :help "Toggle the visibility of public members"
3151 :selected (not (aref ebrowse--filters 0))
3153 ["Protected" ebrowse-toggle-protected-member-filter
3154 :help "Toggle the visibility of protected members"
3156 :selected (not (aref ebrowse--filters 1))
3158 ["Private" ebrowse-toggle-private-member-filter
3159 :help "Toggle the visibility of private members"
3161 :selected (not (aref ebrowse--filters 2))
3163 ["Virtual" ebrowse-toggle-virtual-member-filter
3164 :help "Toggle the visibility of virtual members"
3166 :selected ebrowse--virtual-display-flag
3168 ["Inline" ebrowse-toggle-inline-member-filter
3169 :help "Toggle the visibility of inline members"
3171 :selected ebrowse--inline-display-flag
3173 ["Const" ebrowse-toggle-const-member-filter
3174 :help "Toggle the visibility of const members"
3176 :selected ebrowse--const-display-flag
3178 ["Pure" ebrowse-toggle-pure-member-filter
3179 :help "Toggle the visibility of pure virtual members"
3181 :selected ebrowse--pure-display-flag
3184 ["Show all" ebrowse-remove-all-member-filters
3185 :help "Remove any display filters"
3188 ["Tree" ebrowse-pop-from-member-to-tree-buffer
3189 :help "Pop to the class tree buffer"
3191 ["Next Member Buffer" ebrowse-switch-to-next-member-buffer
3192 :help "Switch to the next member buffer of this class tree"
3194 ["Freeze" ebrowse-freeze-member-buffer
3195 :help "Freeze (do not reuse) this member buffer"
3199 (defun ebrowse-on-class-name ()
3200 "Value is non-nil if point is on a class name."
3201 (eq (get-text-property (point) 'ebrowse-what) 'class-name))
3204 (defun ebrowse-on-member-name ()
3205 "Value is non-nil if point is on a member name."
3206 (eq (get-text-property (point) 'ebrowse-what) 'member-name))
3210 ebrowse-member-class-name-object-menu ebrowse-member-mode-map
3211 "Object menu for class names in member buffer."
3213 ["Find" ebrowse-find-member-definition
3214 :help "Find this class in the source files"
3215 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]
3216 ["View" ebrowse-view-member-definition
3217 :help "View this class in the source files"
3218 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]))
3222 ebrowse-member-name-object-menu ebrowse-member-mode-map
3223 "Object menu for member names"
3225 ["Find Definition" ebrowse-find-member-definition
3226 :help "Find this member's definition in the source files"
3227 :active (ebrowse-on-member-name)]
3228 ["Find Declaration" ebrowse-find-member-declaration
3229 :help "Find this member's declaration in the source files"
3230 :active (ebrowse-on-member-name)]
3231 ["View Definition" ebrowse-view-member-definition
3232 :help "View this member's definition in the source files"
3233 :active (ebrowse-on-member-name)]
3234 ["View Declaration" ebrowse-view-member-declaration
3235 :help "View this member's declaration in the source files"
3236 :active (ebrowse-on-member-name)]))
3239 (defun ebrowse-member-mouse-3 (event)
3240 "Handle `mouse-3' events in member buffers.
3241 EVENT is the mouse event."
3243 (mouse-set-point event)
3244 (case (event-click-count event)
3245 (2 (ebrowse-find-member-definition))
3246 (1 (case (get-text-property (posn-point (event-start event))
3249 (ebrowse-popup-menu ebrowse-member-name-object-menu event))
3251 (ebrowse-popup-menu ebrowse-member-class-name-object-menu event))
3253 (ebrowse-popup-menu ebrowse-member-buffer-object-menu event))))))
3256 (defun ebrowse-member-mouse-2 (event)
3257 "Handle `mouse-2' events in member buffers.
3258 EVENT is the mouse event."
3260 (mouse-set-point event)
3261 (case (event-click-count event)
3262 (2 (ebrowse-find-member-definition))
3263 (1 (case (get-text-property (posn-point (event-start event))
3266 (ebrowse-view-member-definition 0))))))
3272 (defun ebrowse-class-alist-for-member (tree-header name)
3273 "Return information about a member in a class tree.
3274 TREE-HEADER is the header structure of the class tree.
3275 NAME is the name of the member.
3276 Value is an alist of elements (CLASS-NAME . (CLASS LIST NAME)),
3277 where each element describes one occurrence of member NAME in the tree.
3278 CLASS-NAME is the qualified name of the class in which the
3279 member was found. The CDR of the acons is described in function
3280 `ebrowse-class/index/member-for-member'."
3281 (let ((table (ebrowse-member-table tree-header))
3285 (dolist (info (gethash name table) alist)
3286 (unless (memq (first info) known-classes)
3287 (setf alist (acons (ebrowse-qualified-class-name
3288 (ebrowse-ts-class (first info)))
3290 known-classes (cons (first info) known-classes)))))))
3293 (defun ebrowse-choose-tree ()
3294 "Choose a class tree to use.
3295 If there's more than one class tree loaded, let the user choose
3296 the one he wants. Value is (TREE HEADER BUFFER), with TREE being
3297 the class tree, HEADER the header structure of the tree, and BUFFER
3298 being the tree or member buffer containing the tree."
3299 (let* ((buffer (ebrowse-choose-from-browser-buffers)))
3300 (if buffer (list (ebrowse-value-in-buffer 'ebrowse--tree buffer)
3301 (ebrowse-value-in-buffer 'ebrowse--header buffer)
3305 (defun ebrowse-tags-read-name (header prompt)
3306 "Read a C++ identifier from the minibuffer.
3307 HEADER is the `ebrowse-hs' structure of the class tree.
3308 Prompt with PROMPT. Insert into the minibuffer a C++ identifier read
3309 from point as default. Value is a list (CLASS-NAME MEMBER-NAME)."
3311 (let* (start member-info (members (ebrowse-member-table header)))
3312 (multiple-value-bind (class-name member-name)
3313 (ebrowse-tags-read-member+class-name)
3315 (error "No member name at point"))
3317 (let* ((name (ebrowse-ignoring-completion-case
3318 (completing-read prompt members nil nil member-name)))
3319 (completion-result (try-completion name members)))
3320 ;; Cannot rely on `try-completion' returning t for exact
3321 ;; matches! It returns the name as a string.
3322 (unless (setq member-info (gethash name members))
3323 (if (y-or-n-p "No exact match found. Try substrings? ")
3325 (or (first (ebrowse-list-of-matching-members
3326 members (regexp-quote name) name))
3327 (error "Sorry, nothing found")))
3328 (error "Canceled")))
3329 (list class-name name))
3330 (list class-name (read-from-minibuffer prompt member-name)))))))
3333 (defun ebrowse-tags-read-member+class-name ()
3334 "Read a C++ identifier from point.
3335 Value is (CLASS-NAME MEMBER-NAME).
3336 CLASS-NAME is the name of the class if the identifier was qualified.
3337 It is nil otherwise.
3338 MEMBER-NAME is the name of the member found."
3340 (skip-chars-backward "a-zA-Z0-9_")
3341 (let* ((start (point))
3342 (name (progn (skip-chars-forward "a-zA-Z0-9_")
3343 (buffer-substring start (point))))
3345 (list class name))))
3348 (defun ebrowse-tags-choose-class (tree header name initial-class-name)
3349 "Read a class name for a member from the minibuffer.
3350 TREE is the class tree we operate on.
3351 HEADER is its header structure.
3352 NAME is the name of the member.
3353 INITIAL-CLASS-NAME is an initial class name to insert in the minibuffer.
3354 Value is a list (TREE ACCESSOR MEMBER) for the member."
3355 (let ((alist (or (ebrowse-class-alist-for-member header name)
3356 (error "No classes with member `%s' found" name))))
3357 (ebrowse-ignoring-completion-case
3358 (if (null (second alist))
3360 (push ?\? unread-command-events)
3361 (cdr (assoc (completing-read "In class: "
3362 alist nil t initial-class-name)
3366 (defun* ebrowse-tags-view/find-member-decl/defn
3367 (prefix &key view definition member-name)
3368 "If VIEW is t, view, else find an occurrence of MEMBER-NAME.
3370 If DEFINITION is t, find or view the member definition else its
3371 declaration. This function reads the member's name from the
3372 current buffer like FIND-TAG. It then prepares a completion list
3373 of all classes containing a member with the given name and lets
3374 the user choose the class to use. As a last step, a tags search
3375 is performed that positions point on the member declaration or
3377 (multiple-value-bind
3378 (tree header tree-buffer) (ebrowse-choose-tree)
3379 (unless tree (error "No class tree"))
3380 (let* ((marker (point-marker))
3385 (multiple-value-setq (class-name name)
3386 (ebrowse-tags-read-name
3388 (concat (if view "View" "Find") " member "
3389 (if definition "definition" "declaration") ": "))))
3390 (setq info (ebrowse-tags-choose-class tree header name class-name))
3391 (ebrowse-push-position marker info)
3392 ;; Goto the occurrence of the member
3393 (ebrowse-view/find-member-declaration/definition
3394 prefix view definition info
3396 (ebrowse-value-in-buffer 'ebrowse--tags-file-name tree-buffer))
3397 ;; Record position jumped to
3398 (ebrowse-push-position (point-marker) info t))))
3402 (defun ebrowse-tags-view-declaration ()
3403 "View declaration of member at point."
3405 (ebrowse-tags-view/find-member-decl/defn 0 :view t :definition nil))
3409 (defun ebrowse-tags-find-declaration ()
3410 "Find declaration of member at point."
3412 (ebrowse-tags-view/find-member-decl/defn 0 :view nil :definition nil))
3416 (defun ebrowse-tags-view-definition ()
3417 "View definition of member at point."
3419 (ebrowse-tags-view/find-member-decl/defn 0 :view t :definition t))
3423 (defun ebrowse-tags-find-definition ()
3424 "Find definition of member at point."
3426 (ebrowse-tags-view/find-member-decl/defn 0 :view nil :definition t))
3429 (defun ebrowse-tags-view-declaration-other-window ()
3430 "View declaration of member at point in other window."
3432 (ebrowse-tags-view/find-member-decl/defn 4 :view t :definition nil))
3436 (defun ebrowse-tags-find-declaration-other-window ()
3437 "Find declaration of member at point in other window."
3439 (ebrowse-tags-view/find-member-decl/defn 4 :view nil :definition nil))
3443 (defun ebrowse-tags-view-definition-other-window ()
3444 "View definition of member at point in other window."
3446 (ebrowse-tags-view/find-member-decl/defn 4 :view t :definition t))
3450 (defun ebrowse-tags-find-definition-other-window ()
3451 "Find definition of member at point in other window."
3453 (ebrowse-tags-view/find-member-decl/defn 4 :view nil :definition t))
3456 (defun ebrowse-tags-view-declaration-other-frame ()
3457 "View definition of member at point in other frame."
3459 (ebrowse-tags-view/find-member-decl/defn 5 :view t :definition nil))
3463 (defun ebrowse-tags-find-declaration-other-frame ()
3464 "Find definition of member at point in other frame."
3466 (ebrowse-tags-view/find-member-decl/defn 5 :view nil :definition nil))
3470 (defun ebrowse-tags-view-definition-other-frame ()
3471 "View definition of member at point in other frame."
3473 (ebrowse-tags-view/find-member-decl/defn 5 :view t :definition t))
3477 (defun ebrowse-tags-find-definition-other-frame ()
3478 "Find definition of member at point in other frame."
3480 (ebrowse-tags-view/find-member-decl/defn 5 :view nil :definition t))
3483 (defun ebrowse-tags-select/create-member-buffer (tree-buffer info)
3484 "Select or create member buffer.
3485 TREE-BUFFER specifies the tree to use. INFO describes the member.
3486 It is a list (TREE ACCESSOR MEMBER)."
3487 (let ((buffer (get-buffer ebrowse-member-buffer-name)))
3488 (cond ((null buffer)
3489 (set-buffer tree-buffer)
3490 (switch-to-buffer (ebrowse-display-member-buffer
3491 (second info) nil (first info))))
3493 (switch-to-buffer buffer)
3494 (setq ebrowse--displayed-class (first info)
3495 ebrowse--accessor (second info)
3496 ebrowse--member-list (funcall ebrowse--accessor ebrowse--displayed-class))
3497 (ebrowse-redisplay-member-buffer)))
3498 (ebrowse-move-point-to-member (ebrowse-ms-name (third info)))))
3501 (defun ebrowse-tags-display-member-buffer (&optional fix-name)
3502 "Display a member buffer for a member.
3503 FIX-NAME non-nil means display the buffer for that member.
3504 Otherwise read a member name from point."
3506 (multiple-value-bind
3507 (tree header tree-buffer) (ebrowse-choose-tree)
3508 (unless tree (error "No class tree"))
3509 (let* ((marker (point-marker)) class-name (name fix-name) info)
3511 (multiple-value-setq (class-name name)
3512 (ebrowse-tags-read-name header
3513 (concat "Find member list of: "))))
3514 (setq info (ebrowse-tags-choose-class tree header name class-name))
3515 (ebrowse-push-position marker info)
3516 (ebrowse-tags-select/create-member-buffer tree-buffer info))))
3519 (defun ebrowse-list-of-matching-members (members regexp &optional name)
3520 "Return a list of members in table MEMBERS matching REGEXP or NAME.
3521 Both NAME and REGEXP may be nil in which case exact or regexp matches
3524 (when (or name regexp)
3525 (maphash #'(lambda (member-name info)
3526 (when (or (and name (string= name member-name))
3527 (and regexp (string-match regexp member-name)))
3528 (setq list (cons member-name list))))
3533 (defun ebrowse-tags-apropos ()
3534 "Display a list of members matching a regexp read from the minibuffer."
3536 (let* ((buffer (or (ebrowse-choose-from-browser-buffers)
3537 (error "No tree buffer")))
3538 (header (ebrowse-value-in-buffer 'ebrowse--header buffer))
3539 (members (ebrowse-member-table header))
3540 temp-buffer-setup-hook
3541 (regexp (read-from-minibuffer "List members matching regexp: ")))
3542 (with-output-to-temp-buffer (concat "*Apropos Members*")
3543 (set-buffer standard-output)
3545 (insert "Members matching `" regexp "'\n\n")
3546 (loop for s in (ebrowse-list-of-matching-members members regexp) do
3547 (loop for info in (gethash s members) do
3548 (ebrowse-draw-file-member-info info))))))
3551 (defun ebrowse-tags-list-members-in-file ()
3552 "Display a list of members found in a file.
3553 The file name is read from the minibuffer."
3555 (let* ((buffer (or (ebrowse-choose-from-browser-buffers)
3556 (error "No tree buffer")))
3557 (files (save-excursion (set-buffer buffer) (ebrowse-files-table)))
3558 (file (completing-read "List members in file: " files nil t))
3559 (header (ebrowse-value-in-buffer 'ebrowse--header buffer))
3560 temp-buffer-setup-hook
3561 (members (ebrowse-member-table header)))
3562 (with-output-to-temp-buffer (concat "*Members in file " file "*")
3563 (set-buffer standard-output)
3565 #'(lambda (member-name list)
3566 (loop for info in list
3567 as member = (third info)
3568 as class = (ebrowse-ts-class (first info))
3569 when (or (and (null (ebrowse-ms-file member))
3570 (string= (ebrowse-cs-file class) file))
3571 (string= file (ebrowse-ms-file member)))
3572 do (ebrowse-draw-file-member-info info "decl.")
3573 when (or (and (null (ebrowse-ms-definition-file member))
3574 (string= (ebrowse-cs-source-file class) file))
3575 (string= file (ebrowse-ms-definition-file member)))
3576 do (ebrowse-draw-file-member-info info "defn.")))
3580 (defun* ebrowse-draw-file-member-info (info &optional (kind ""))
3581 "Display a line in an the members per file info buffer.
3582 INFO describes the member. It has the form (TREE ACCESSOR MEMBER).
3583 TREE is the class of the member to display.
3584 ACCESSOR is the accessor symbol of its member list.
3585 MEMBER is the member structure.
3586 KIND is an additional string printed in the buffer."
3587 (let* ((tree (first info))
3588 (globals-p (ebrowse-globals-tree-p tree)))
3590 (insert (ebrowse-cs-name (ebrowse-ts-class tree))))
3591 (insert "::" (ebrowse-ms-name (third info)))
3595 (insert (case (second info)
3596 ('ebrowse-ts-member-functions "member function")
3597 ('ebrowse-ts-member-variables "member variable")
3598 ('ebrowse-ts-static-functions "static function")
3599 ('ebrowse-ts-static-variables "static variable")
3600 ('ebrowse-ts-friends (if globals-p "define" "friend"))
3601 ('ebrowse-ts-types "type")
3605 (defvar ebrowse-last-completion nil
3606 "Text inserted by the last completion operation.")
3609 (defvar ebrowse-last-completion-start nil
3610 "String which was the basis for the last completion operation.")
3613 (defvar ebrowse-last-completion-location nil
3614 "Buffer position at which the last completion operation was initiated.")
3617 (defvar ebrowse-last-completion-obarray nil
3618 "Member used in last completion operation.")
3621 (make-variable-buffer-local 'ebrowse-last-completion-obarray)
3622 (make-variable-buffer-local 'ebrowse-last-completion-location)
3623 (make-variable-buffer-local 'ebrowse-last-completion)
3624 (make-variable-buffer-local 'ebrowse-last-completion-start)
3628 (defun ebrowse-some-member-table ()
3629 "Return a hash table containing all member of a tree.
3630 If there's only one tree loaded, use that. Otherwise let the
3632 (let* ((buffers (ebrowse-known-class-trees-buffer-list))
3633 (buffer (cond ((and (first buffers) (not (second buffers)))
3635 (t (or (ebrowse-electric-choose-tree)
3636 (error "No tree buffer")))))
3637 (header (ebrowse-value-in-buffer 'ebrowse--header buffer)))
3638 (ebrowse-member-table header)))
3641 (defun ebrowse-cyclic-successor-in-string-list (string list)
3642 "Return the item following STRING in LIST.
3643 If STRING is the last element, return the first element as successor."
3644 (or (nth (1+ (ebrowse-position string list 'string=)) list)
3648 ;;; Symbol completion
3651 (defun* ebrowse-tags-complete-symbol (prefix)
3652 "Perform completion on the C++ symbol preceding point.
3653 A second call of this function without changing point inserts the next match.
3654 A call with prefix PREFIX reads the symbol to insert from the minibuffer with
3657 (let* ((end (point))
3658 (begin (save-excursion (skip-chars-backward "a-zA-Z_0-9") (point)))
3659 (pattern (buffer-substring begin end))
3662 ;; With prefix, read name from minibuffer with completion.
3664 (let* ((members (ebrowse-some-member-table))
3665 (completion (completing-read "Insert member: "
3666 members nil t pattern)))
3668 (setf ebrowse-last-completion-location nil)
3669 (delete-region begin end)
3670 (insert completion))))
3671 ;; If this function is called at the same point the last
3672 ;; expansion ended, insert the next expansion.
3673 ((eq (point) ebrowse-last-completion-location)
3674 (setf list (all-completions ebrowse-last-completion-start
3675 ebrowse-last-completion-obarray)
3676 completion (ebrowse-cyclic-successor-in-string-list
3677 ebrowse-last-completion list))
3678 (cond ((null completion)
3679 (error "No completion"))
3680 ((string= completion pattern)
3681 (error "No further completion"))
3683 (delete-region begin end)
3685 (setf ebrowse-last-completion completion
3686 ebrowse-last-completion-location (point)))))
3687 ;; First time the function is called at some position in the
3688 ;; buffer: Start new completion.
3690 (let* ((members (ebrowse-some-member-table))
3691 (completion (first (all-completions pattern members nil))))
3692 (cond ((eq completion t))
3694 (error "Can't find completion for `%s'" pattern))
3696 (delete-region begin end)
3699 (setf ebrowse-last-completion-location (point)
3700 ebrowse-last-completion-start pattern
3701 ebrowse-last-completion completion
3702 ebrowse-last-completion-obarray members))))))))
3705 ;;; Tags query replace & search
3707 (defvar ebrowse-tags-loop-form ()
3708 "Form for `ebrowse-loop-continue'.
3709 Evaluated for each file in the tree. If it returns nil, proceed
3710 with the next file.")
3712 (defvar ebrowse-tags-next-file-list ()
3713 "A list of files to be processed.")
3716 (defvar ebrowse-tags-next-file-path nil
3717 "The path relative to which files have to be searched.")
3720 (defvar ebrowse-tags-loop-last-file nil
3721 "The last file visited via `ebrowse-tags-loop'.")
3724 (defun ebrowse-tags-next-file (&optional initialize tree-buffer)
3725 "Select next file among files in current tag table.
3726 Non-nil argument INITIALIZE (prefix arg, if interactive) initializes
3727 to the beginning of the list of files in the tag table.
3728 TREE-BUFFER specifies the class tree we operate on."
3730 ;; Call with INITIALIZE non-nil initializes the files list.
3731 ;; If more than one tree buffer is loaded, let the user choose
3732 ;; on which tree (s)he wants to operate.
3734 (let ((buffer (or tree-buffer (ebrowse-choose-from-browser-buffers))))
3737 (setq ebrowse-tags-next-file-list
3738 (ebrowse-files-list (ebrowse-marked-classes-p))
3739 ebrowse-tags-loop-last-file
3741 ebrowse-tags-next-file-path
3742 (file-name-directory ebrowse--tags-file-name)))))
3743 ;; End of the loop if the stack of files is empty.
3744 (unless ebrowse-tags-next-file-list
3745 (error "All files processed"))
3746 ;; ebrowse-tags-loop-last-file is the last file that was visited due
3747 ;; to a call to BROWSE-LOOP (see below). If that file is still
3748 ;; in memory, and it wasn't modified, throw its buffer away to
3749 ;; prevent cluttering up the buffer list.
3750 (when ebrowse-tags-loop-last-file
3751 (let ((buffer (get-file-buffer ebrowse-tags-loop-last-file)))
3753 (not (buffer-modified-p buffer)))
3754 (kill-buffer buffer))))
3755 ;; Remember this buffer file name for later deletion, if it
3756 ;; wasn't visited by other means.
3757 (let ((file (expand-file-name (car ebrowse-tags-next-file-list)
3758 ebrowse-tags-next-file-path)))
3759 (setq ebrowse-tags-loop-last-file (if (get-file-buffer file) nil file))
3760 ;; Find the file and pop the file list. Pop has to be done
3761 ;; before the file is loaded because FIND-FILE might encounter
3762 ;; an error, and we want to be able to proceed with the next
3763 ;; file in this case.
3764 (pop ebrowse-tags-next-file-list)
3769 (defun ebrowse-tags-loop-continue (&optional first-time tree-buffer)
3770 "Repeat last operation on files in tree.
3771 FIRST-TIME non-nil means this is not a repetition, but the first time.
3772 TREE-BUFFER if indirectly specifies which files to loop over."
3775 (ebrowse-tags-next-file first-time tree-buffer)
3776 (goto-char (point-min)))
3777 (while (not (eval ebrowse-tags-loop-form))
3778 (ebrowse-tags-next-file)
3779 (message "Scanning file `%s'..." buffer-file-name)
3780 (goto-char (point-min))))
3784 (defun ebrowse-tags-search (regexp)
3785 "Search for REGEXP in all files in a tree.
3786 If marked classes exist, process marked classes, only.
3787 If regular expression is nil, repeat last search."
3788 (interactive "sTree search (regexp): ")
3789 (if (and (string= regexp "")
3790 (eq (car ebrowse-tags-loop-form) 're-search-forward))
3791 (ebrowse-tags-loop-continue)
3792 (setq ebrowse-tags-loop-form (list 're-search-forward regexp nil t))
3793 (ebrowse-tags-loop-continue 'first-time)))
3797 (defun ebrowse-tags-query-replace (from to)
3798 "Query replace FROM with TO in all files of a class tree.
3799 With prefix arg, process files of marked classes only."
3801 "sTree query replace (regexp): \nsTree query replace %s by: ")
3802 (setq ebrowse-tags-loop-form
3803 (list 'and (list 'save-excursion
3804 (list 're-search-forward from nil t))
3805 (list 'not (list 'perform-replace from to t t nil))))
3806 (ebrowse-tags-loop-continue 'first-time))
3810 (defun ebrowse-tags-search-member-use (&optional fix-name)
3811 "Search for call sites of a member.
3812 If FIX-NAME is specified, search uses of that member.
3813 Otherwise, read a member name from the minibuffer.
3814 Searches in all files mentioned in a class tree for something that
3815 looks like a function call to the member."
3817 ;; Choose the tree to use if there is more than one.
3818 (multiple-value-bind (tree header tree-buffer)
3819 (ebrowse-choose-tree)
3821 (error "No class tree"))
3822 ;; Get the member name NAME (class-name is ignored).
3823 (let ((name fix-name) class-name regexp)
3825 (multiple-value-setq (class-name name)
3826 (ebrowse-tags-read-name header "Find calls of: ")))
3827 ;; Set tags loop form to search for member and begin loop.
3828 (setq regexp (concat "\\<" name "[ \t]*(")
3829 ebrowse-tags-loop-form (list 're-search-forward regexp nil t))
3830 (ebrowse-tags-loop-continue 'first-time tree-buffer))))
3834 ;;; Tags position management
3836 ;;; Structures of this kind are the elements of the position stack.
3838 (defstruct (ebrowse-position (:type vector) :named)
3839 file-name ; in which file
3840 point ; point in file
3841 target ; t if target of a jump
3842 info) ; (CLASS FUNC MEMBER) jumped to
3845 (defvar ebrowse-position-stack ()
3846 "Stack of `ebrowse-position' structured.")
3849 (defvar ebrowse-position-index 0
3850 "Current position in position stack.")
3853 (defun ebrowse-position-name (position)
3854 "Return an identifying string for POSITION.
3855 The string is printed in the electric position list buffer."
3856 (let ((info (ebrowse-position-info position)))
3857 (concat (if (ebrowse-position-target position) "at " "to ")
3858 (ebrowse-cs-name (ebrowse-ts-class (first info)))
3859 "::" (ebrowse-ms-name (third info)))))
3862 (defun ebrowse-view/find-position (position &optional view)
3863 "Position point on POSITION.
3864 If VIEW is non-nil, view the position, otherwise find it."
3866 (find-file (ebrowse-position-file-name position))
3867 (goto-char (ebrowse-position-point position)))
3873 (goto-char (ebrowse-position-point position))))
3875 (view-file (ebrowse-position-file-name position)))
3876 (pop view-mode-hook)))))
3879 (defun ebrowse-push-position (marker info &optional target)
3880 "Push current position on position stack.
3881 MARKER is the marker to remember as position.
3882 INFO is a list (CLASS FUNC MEMBER) specifying what we jumped to.
3883 TARGET non-nil means we performed a jump.
3884 Positions in buffers that have no file names are not saved."
3885 (when (buffer-file-name (marker-buffer marker))
3886 (let ((too-much (- (length ebrowse-position-stack)
3887 ebrowse-max-positions)))
3888 ;; Do not let the stack grow to infinity.
3889 (when (plusp too-much)
3890 (setq ebrowse-position-stack
3891 (butlast ebrowse-position-stack too-much)))
3892 ;; Push the position.
3893 (push (make-ebrowse-position
3894 :file-name (buffer-file-name (marker-buffer marker))
3895 :point (marker-position marker)
3898 ebrowse-position-stack))))
3901 (defun ebrowse-move-in-position-stack (increment)
3902 "Move by INCREMENT in the position stack."
3903 (let ((length (length ebrowse-position-stack)))
3904 (when (zerop length)
3905 (error "No positions remembered"))
3906 (setq ebrowse-position-index
3907 (mod (+ increment ebrowse-position-index) length))
3908 (message "Position %d of %d " ebrowse-position-index length)
3909 (ebrowse-view/find-position (nth ebrowse-position-index
3910 ebrowse-position-stack))))
3914 (defun ebrowse-back-in-position-stack (arg)
3915 "Move backward in the position stack.
3916 Prefix arg ARG says how much."
3918 (ebrowse-move-in-position-stack (max 1 arg)))
3922 (defun ebrowse-forward-in-position-stack (arg)
3923 "Move forward in the position stack.
3924 Prefix arg ARG says how much."
3926 (ebrowse-move-in-position-stack (min -1 (- arg))))
3930 ;;; Electric position list
3932 (defvar ebrowse-electric-position-mode-map ()
3933 "Keymap used in electric position stack window.")
3936 (defvar ebrowse-electric-position-mode-hook nil
3937 "If non-nil, its value is called by ebrowse-electric-position-mode.")
3940 (unless ebrowse-electric-position-mode-map
3941 (let ((map (make-keymap))
3942 (submap (make-keymap)))
3943 (setq ebrowse-electric-position-mode-map map)
3944 (fillarray (car (cdr map)) 'ebrowse-electric-position-undefined)
3945 (fillarray (car (cdr submap)) 'ebrowse-electric-position-undefined)
3946 (define-key map "\e" submap)
3947 (define-key map "\C-z" 'suspend-emacs)
3948 (define-key map "\C-h" 'Helper-help)
3949 (define-key map "?" 'Helper-describe-bindings)
3950 (define-key map "\C-c" nil)
3951 (define-key map "\C-c\C-c" 'ebrowse-electric-position-quit)
3952 (define-key map "q" 'ebrowse-electric-position-quit)
3953 (define-key map " " 'ebrowse-electric-select-position)
3954 (define-key map "\C-l" 'recenter)
3955 (define-key map "\C-u" 'universal-argument)
3956 (define-key map "\C-p" 'previous-line)
3957 (define-key map "\C-n" 'next-line)
3958 (define-key map "p" 'previous-line)
3959 (define-key map "n" 'next-line)
3960 (define-key map "v" 'ebrowse-electric-view-position)
3961 (define-key map "\C-v" 'scroll-up)
3962 (define-key map "\ev" 'scroll-down)
3963 (define-key map "\e\C-v" 'scroll-other-window)
3964 (define-key map "\e>" 'end-of-buffer)
3965 (define-key map "\e<" 'beginning-of-buffer)
3966 (define-key map "\e>" 'end-of-buffer)))
3968 (put 'ebrowse-electric-position-mode 'mode-class 'special)
3969 (put 'ebrowse-electric-position-undefined 'suppress-keymap t)
3972 (defun ebrowse-electric-position-mode ()
3973 "Mode for electric position buffers.
3974 Runs the hook `ebrowse-electric-position-mode-hook'."
3975 (kill-all-local-variables)
3976 (use-local-map ebrowse-electric-position-mode-map)
3977 (setq mode-name "Electric Position Menu"
3978 mode-line-buffer-identification "Electric Position Menu")
3979 (when (memq 'mode-name mode-line-format)
3980 (setq mode-line-format (copy-sequence mode-line-format))
3981 (setcar (memq 'mode-name mode-line-format) "Positions"))
3982 (make-local-variable 'Helper-return-blurb)
3983 (setq Helper-return-blurb "return to buffer editing"
3986 major-mode 'ebrowse-electric-position-mode)
3987 (run-hooks 'ebrowse-electric-position-mode-hook))
3990 (defun ebrowse-draw-position-buffer ()
3991 "Display positions in buffer *Positions*."
3992 (set-buffer (get-buffer-create "*Positions*"))
3993 (setq buffer-read-only nil)
3995 (insert "File Point Description\n"
3996 "---- ----- -----------\n")
3997 (dolist (position ebrowse-position-stack)
3998 (insert (file-name-nondirectory (ebrowse-position-file-name position)))
4000 (insert (int-to-string (ebrowse-position-point position)))
4002 (insert (ebrowse-position-name position) "\n"))
4003 (setq buffer-read-only t))
4007 (defun ebrowse-electric-position-menu ()
4008 "List positions in the position stack in an electric buffer."
4010 (unless ebrowse-position-stack
4011 (error "No positions remembered"))
4012 (let (select buffer window)
4013 (save-window-excursion
4014 (save-window-excursion (ebrowse-draw-position-buffer))
4015 (setq window (Electric-pop-up-window "*Positions*")
4016 buffer (window-buffer window))
4017 (shrink-window-if-larger-than-buffer window)
4021 (ebrowse-electric-position-mode)
4023 (catch 'ebrowse-electric-select-position
4024 (message "<<< Press Space to bury the list >>>")
4025 (let ((first (progn (goto-char (point-min))
4028 (last (progn (goto-char (point-max))
4033 (Electric-command-loop 'ebrowse-electric-select-position
4035 'ebrowse-electric-position-looper
4036 (cons first last))))))
4038 (bury-buffer buffer)
4042 (ebrowse-electric-find-position select))
4043 (kill-buffer buffer)))
4046 (defun ebrowse-electric-position-looper (state condition)
4047 "Prevent moving point on invalid lines.
4048 Called from `Electric-command-loop'. See there for the meaning
4049 of STATE and CONDITION."
4050 (cond ((and condition
4051 (not (memq (car condition) '(buffer-read-only
4053 beginning-of-buffer))))
4054 (signal (car condition) (cdr condition)))
4055 ((< (point) (car state))
4056 (goto-char (point-min))
4058 ((> (point) (cdr state))
4059 (goto-char (point-max))
4061 (if (pos-visible-in-window-p (point-max))
4065 (defun ebrowse-electric-position-undefined ()
4066 "Function called for undefined keys."
4068 (message "Type C-h for help, ? for commands, q to quit, Space to execute")
4072 (defun ebrowse-electric-position-quit ()
4073 "Leave the electric position list."
4075 (throw 'ebrowse-electric-select-position nil))
4078 (defun ebrowse-electric-select-position ()
4079 "Select a position from the list."
4081 (throw 'ebrowse-electric-select-position (point)))
4084 (defun ebrowse-electric-find-position (point &optional view)
4085 "View/find what is described by the line at POINT.
4086 If VIEW is non-nil, view else find source files."
4087 (let ((index (- (count-lines (point-min) point) 2)))
4088 (ebrowse-view/find-position (nth index
4089 ebrowse-position-stack) view)))
4092 (defun ebrowse-electric-view-position ()
4093 "View the position described by the line point is in."
4095 (ebrowse-electric-find-position (point) t))
4099 ;;; Saving trees to disk
4101 (defun ebrowse-write-file-hook-fn ()
4102 "Write current buffer as a class tree.
4103 Installed on `local-write-file-hooks'."
4109 (defun ebrowse-save-tree ()
4110 "Save current tree in same file it was loaded from."
4112 (ebrowse-save-tree-as (or buffer-file-name ebrowse--tags-file-name)))
4116 (defun ebrowse-save-tree-as (&optional file-name)
4117 "Write the current tree data structure to a file.
4118 Read the file name from the minibuffer if interactive.
4119 Otherwise, FILE-NAME specifies the file to save the tree in."
4120 (interactive "FSave tree as: ")
4121 (let ((temp-buffer (get-buffer-create "*Tree Output"))
4122 (old-standard-output standard-output)
4123 (header (copy-ebrowse-hs ebrowse--header))
4124 (tree ebrowse--tree))
4127 (set-buffer (setq standard-output temp-buffer))
4129 (setf (ebrowse-hs-member-table header) nil)
4130 (insert (prin1-to-string header) " ")
4131 (mapcar 'ebrowse-save-class tree)
4132 (write-file file-name)
4133 (message "Tree written to file `%s'" file-name))
4134 (kill-buffer temp-buffer)
4135 (set-buffer-modified-p nil)
4136 (ebrowse-update-tree-buffer-mode-line)
4137 (setq standard-output old-standard-output))))
4140 (defun ebrowse-save-class (class)
4141 "Write single class CLASS to current buffer."
4142 (message "%s..." (ebrowse-cs-name (ebrowse-ts-class class)))
4143 (insert "[ebrowse-ts ")
4144 (prin1 (ebrowse-ts-class class)) ;class name
4145 (insert "(") ;list of subclasses
4146 (mapcar 'ebrowse-save-class (ebrowse-ts-subclasses class))
4148 (dolist (func ebrowse-member-list-accessors)
4149 (prin1 (funcall func class))
4151 (insert "()") ;base-classes slot
4152 (prin1 (ebrowse-ts-mark class))
4160 (defun ebrowse-statistics ()
4161 "Display statistics for a class tree."
4163 (let ((tree-file (buffer-file-name))
4164 temp-buffer-setup-hook)
4165 (with-output-to-temp-buffer "*Tree Statistics*"
4166 (multiple-value-bind (classes member-functions member-variables
4167 static-functions static-variables)
4168 (ebrowse-gather-statistics)
4169 (set-buffer standard-output)
4171 (insert "STATISTICS FOR TREE " (or tree-file "unknown") ":\n\n")
4172 (ebrowse-print-statistics-line "Number of classes:" classes)
4173 (ebrowse-print-statistics-line "Number of member functions:"
4175 (ebrowse-print-statistics-line "Number of member variables:"
4177 (ebrowse-print-statistics-line "Number of static functions:"
4179 (ebrowse-print-statistics-line "Number of static variables:"
4180 static-variables)))))
4183 (defun ebrowse-print-statistics-line (title value)
4184 "Print a line in the statistics buffer.
4185 TITLE is the title of the line, VALUE is number to be printed
4189 (insert (format "%d\n" value)))
4192 (defun ebrowse-gather-statistics ()
4193 "Return statistics for a class tree.
4194 The result is a list (NUMBER-OF-CLASSES NUMBER-OF-MEMBER-FUNCTIONS
4195 NUMBER-OF-INSTANCE-VARIABLES NUMBER-OF-STATIC-FUNCTIONS
4196 NUMBER-OF-STATIC-VARIABLES:"
4197 (let ((classes 0) (member-functions 0) (member-variables 0)
4198 (static-functions 0) (static-variables 0))
4199 (ebrowse-for-all-trees (tree ebrowse--tree-obarray)
4201 (incf member-functions (length (ebrowse-ts-member-functions tree)))
4202 (incf member-variables (length (ebrowse-ts-member-variables tree)))
4203 (incf static-functions (length (ebrowse-ts-static-functions tree)))
4204 (incf static-variables (length (ebrowse-ts-static-variables tree))))
4205 (list classes member-functions member-variables
4206 static-functions static-variables)))
4210 ;;; Global key bindings
4212 ;;; The following can be used to bind key sequences starting with
4213 ;;; prefix `\C-cb' to browse commands.
4215 (defvar ebrowse-global-map nil
4216 "*Keymap for Ebrowse commands.")
4219 (defvar ebrowse-global-prefix-key "\C-cb"
4220 "Prefix key for Ebrowse commands.")
4223 (defvar ebrowse-global-submap-4 nil
4224 "Keymap used for `ebrowse-global-prefix' followed by `4'.")
4227 (defvar ebrowse-global-submap-5 nil
4228 "Keymap used for `ebrowse-global-prefix' followed by `5'.")
4231 (unless ebrowse-global-map
4232 (setq ebrowse-global-map (make-sparse-keymap))
4233 (setq ebrowse-global-submap-4 (make-sparse-keymap))
4234 (setq ebrowse-global-submap-5 (make-sparse-keymap))
4235 (define-key ebrowse-global-map "a" 'ebrowse-tags-apropos)
4236 (define-key ebrowse-global-map "b" 'ebrowse-pop-to-browser-buffer)
4237 (define-key ebrowse-global-map "-" 'ebrowse-back-in-position-stack)
4238 (define-key ebrowse-global-map "+" 'ebrowse-forward-in-position-stack)
4239 (define-key ebrowse-global-map "l" 'ebrowse-tags-list-members-in-file)
4240 (define-key ebrowse-global-map "m" 'ebrowse-tags-display-member-buffer)
4241 (define-key ebrowse-global-map "n" 'ebrowse-tags-next-file)
4242 (define-key ebrowse-global-map "p" 'ebrowse-electric-position-menu)
4243 (define-key ebrowse-global-map "s" 'ebrowse-tags-search)
4244 (define-key ebrowse-global-map "u" 'ebrowse-tags-search-member-use)
4245 (define-key ebrowse-global-map "v" 'ebrowse-tags-view-definition)
4246 (define-key ebrowse-global-map "V" 'ebrowse-tags-view-declaration)
4247 (define-key ebrowse-global-map "%" 'ebrowse-tags-query-replace)
4248 (define-key ebrowse-global-map "." 'ebrowse-tags-find-definition)
4249 (define-key ebrowse-global-map "f" 'ebrowse-tags-find-definition)
4250 (define-key ebrowse-global-map "F" 'ebrowse-tags-find-declaration)
4251 (define-key ebrowse-global-map "," 'ebrowse-tags-loop-continue)
4252 (define-key ebrowse-global-map " " 'ebrowse-electric-buffer-list)
4253 (define-key ebrowse-global-map "\t" 'ebrowse-tags-complete-symbol)
4254 (define-key ebrowse-global-map "4" ebrowse-global-submap-4)
4255 (define-key ebrowse-global-submap-4 "." 'ebrowse-tags-find-definition-other-window)
4256 (define-key ebrowse-global-submap-4 "f" 'ebrowse-tags-find-definition-other-window)
4257 (define-key ebrowse-global-submap-4 "v" 'ebrowse-tags-find-declaration-other-window)
4258 (define-key ebrowse-global-submap-4 "F" 'ebrowse-tags-view-definition-other-window)
4259 (define-key ebrowse-global-submap-4 "V" 'ebrowse-tags-view-declaration-other-window)
4260 (define-key ebrowse-global-map "5" ebrowse-global-submap-5)
4261 (define-key ebrowse-global-submap-5 "." 'ebrowse-tags-find-definition-other-frame)
4262 (define-key ebrowse-global-submap-5 "f" 'ebrowse-tags-find-definition-other-frame)
4263 (define-key ebrowse-global-submap-5 "v" 'ebrowse-tags-find-declaration-other-frame)
4264 (define-key ebrowse-global-submap-5 "F" 'ebrowse-tags-view-definition-other-frame)
4265 (define-key ebrowse-global-submap-5 "V" 'ebrowse-tags-view-declaration-other-frame)
4266 (define-key global-map ebrowse-global-prefix-key ebrowse-global-map))
4270 ;;; Electric C++ browser buffer menu
4272 ;;; Electric buffer menu customization to display only some buffers
4273 ;;; (in this case Tree buffers). There is only one problem with this:
4274 ;;; If the very first character typed in the buffer menu is a space,
4275 ;;; this will select the buffer from which the buffer menu was
4276 ;;; invoked. But this buffer is not displayed in the buffer list if
4277 ;;; it isn't a tree buffer. I therefore let the buffer menu command
4278 ;;; loop read the command `p' via `unread-command-char'. This command
4279 ;;; has no effect since we are on the first line of the buffer.
4281 (defvar electric-buffer-menu-mode-hook nil)
4284 (defun ebrowse-hack-electric-buffer-menu ()
4285 "Hack the electric buffer menu to display browser buffers."
4289 (setq buffer-read-only nil)
4293 (let ((b (Buffer-menu-buffer nil)))
4294 (if (or (ebrowse-buffer-p b)
4295 (string= (buffer-name b) "*Apropos Members*"))
4296 (progn (forward-line 1)
4298 (delete-region (point)
4299 (save-excursion (end-of-line)
4303 (error "No tree buffers"))
4304 (setf unread-command-events (listify-key-sequence "p"))
4305 (shrink-window-if-larger-than-buffer (selected-window))
4306 (setq buffer-read-only t))))
4309 (defun ebrowse-select-1st-to-9nth ()
4310 "Select the nth entry in the list by the keys 1..9."
4312 (let* ((maxlin (count-lines (point-min) (point-max)))
4313 (n (min maxlin (+ 2 (string-to-int (this-command-keys))))))
4315 (throw 'electric-buffer-menu-select (point))))
4318 (defun ebrowse-install-1-to-9-keys ()
4319 "Define keys 1..9 to select the 1st to 0nth entry in the list."
4321 (define-key (current-local-map) (char-to-string (+ i ?1))
4322 'ebrowse-select-1st-to-9nth)))
4325 (defun ebrowse-electric-buffer-list ()
4326 "Display an electric list of Ebrowse buffers."
4330 (add-hook 'electric-buffer-menu-mode-hook
4331 'ebrowse-hack-electric-buffer-menu)
4332 (add-hook 'electric-buffer-menu-mode-hook
4333 'ebrowse-install-1-to-9-keys)
4334 (call-interactively 'electric-buffer-list))
4335 (remove-hook 'electric-buffer-menu-mode-hook
4336 'ebrowse-hack-electric-buffer-menu)))
4341 (defun ebrowse-mouse-find-member (event)
4342 "Find the member clicked on in another frame.
4343 EVENT is a mouse button event."
4345 (mouse-set-point event)
4348 (skip-chars-backward "a-zA-Z0-9_")
4349 (setq start (point))
4350 (skip-chars-forward "a-zA-Z0-9_")
4351 (setq name (buffer-substring start (point))))
4352 (ebrowse-tags-view/find-member-decl/defn
4353 5 :view nil :definition t :member-name name)))
4356 (defun ebrowse-popup-menu (menu event)
4357 "Pop up MENU and perform an action if something was selected.
4358 EVENT is the mouse event."
4359 (save-selected-window
4360 (select-window (posn-window (event-start event)))
4361 (let ((selection (x-popup-menu event menu)) binding)
4363 (setq binding (lookup-key (or binding menu) (vector (car selection)))
4364 selection (cdr selection)))
4366 (call-interactively binding)))))
4370 ebrowse-tree-buffer-class-object-menu ebrowse-tree-mode-map
4371 "Object menu for classes in the tree buffer"
4373 ["Functions" ebrowse-tree-command:show-member-functions
4374 :help "Display a list of member functions"
4376 ["Variables" ebrowse-tree-command:show-member-variables
4377 :help "Display a list of member variables"
4379 ["Static Functions" ebrowse-tree-command:show-static-member-functions
4380 :help "Display a list of static member functions"
4382 ["Static Variables" ebrowse-tree-command:show-static-member-variables
4383 :help "Display a list of static member variables"
4385 ["Friends/ Defines" ebrowse-tree-command:show-friends
4386 :help "Display a list of friends of a class"
4388 ["Types" ebrowse-tree-command:show-types
4389 :help "Display a list of types defined in a class"
4392 ["View" ebrowse-view-class-declaration
4393 :help "View class declaration"
4394 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]
4395 ["Find" ebrowse-find-class-declaration
4396 :help "Find class declaration in file"
4397 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]
4399 ["Mark" ebrowse-toggle-mark-at-point
4400 :help "Mark class point is on"
4401 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]
4403 ["Collapse" ebrowse-collapse-branch
4404 :help "Collapse subtree under class point is on"
4405 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]
4406 ["Expand" ebrowse-expand-branch
4407 :help "Expand subtree under class point is on"
4408 :active (eq (get-text-property (point) 'ebrowse-what) 'class-name)]))
4412 ebrowse-tree-buffer-object-menu ebrowse-tree-mode-map
4413 "Object menu for tree buffers"
4415 ["Filename Display" ebrowse-toggle-file-name-display
4416 :help "Toggle display of source files names"
4418 :selected ebrowse--show-file-names-flag
4420 ["Tree Indentation" ebrowse-set-tree-indentation
4421 :help "Set the tree's indentation"
4423 ["Unmark All Classes" ebrowse-mark-all-classes
4424 :help "Unmark all classes in the class tree"
4426 ["Expand All" ebrowse-expand-all
4427 :help "Expand all subtrees in the class tree"
4429 ["Statistics" ebrowse-statistics
4430 :help "Show a buffer with class hierarchy statistics"
4432 ["Find Class" ebrowse-read-class-name-and-go
4433 :help "Find a class in the tree"
4435 ["Member Buffer" ebrowse-pop/switch-to-member-buffer-for-same-tree
4436 :help "Show a member buffer for this class tree"
4440 (defun ebrowse-mouse-3-in-tree-buffer (event)
4441 "Perform mouse actions in tree buffers.
4442 EVENT is the mouse event."
4444 (mouse-set-point event)
4445 (let* ((where (posn-point (event-start event)))
4446 (property (get-text-property where 'ebrowse-what)))
4447 (case (event-click-count event)
4451 (ebrowse-popup-menu ebrowse-tree-buffer-class-object-menu event))
4453 (ebrowse-popup-menu ebrowse-tree-buffer-object-menu event)))))))
4456 (defun ebrowse-mouse-2-in-tree-buffer (event)
4457 "Perform mouse actions in tree buffers.
4458 EVENT is the mouse event."
4460 (mouse-set-point event)
4461 (let* ((where (posn-point (event-start event)))
4462 (property (get-text-property where 'ebrowse-what)))
4463 (case (event-click-count event)
4466 (ebrowse-tree-command:show-member-functions)))))))
4469 (defun ebrowse-mouse-1-in-tree-buffer (event)
4470 "Perform mouse actions in tree buffers.
4471 EVENT is the mouse event."
4473 (mouse-set-point event)
4474 (let* ((where (posn-point (event-start event)))
4475 (property (get-text-property where 'ebrowse-what)))
4476 (case (event-click-count event)
4479 (let ((collapsed (save-excursion (skip-chars-forward "^\r\n")
4480 (looking-at "\r"))))
4481 (ebrowse-collapse-fn (not collapsed))))
4483 (ebrowse-toggle-mark-at-point 1)))))))
4489 ;;; Local variables:
4490 ;;; eval:(put 'ebrowse-output 'lisp-indent-hook 0)
4491 ;;; eval:(put 'ebrowse-ignoring-completion-case 'lisp-indent-hook 0)
4492 ;;; eval:(put 'ebrowse-save-selective 'lisp-indent-hook 0)
4493 ;;; eval:(put 'ebrowse-for-all-trees 'lisp-indent-hook 1)
4496 ;;; ebrowse.el ends here