updated readme and TODO

tec-leo · tec-leo · commit 2c2bb9ab426a · 2025-07-14T07:33:04.000+02:00
removed some warnings
diff --git a/README b/README
@@ -1,72 +1,29 @@
-README for the Emacs Code Browser (ECB) version 2.40.1
+README for the Emacs Code Browser (ECB) version 2.51.0
 
 
 About
 -----
 
 This package contains a code browser for several programming-languages for
-(X)Emacs. For instructions on how to use the browser read the online-help
+Emacs. For instructions on how to use the browser read the online-help
 either with the shipped info-manual (see "Usage" below) or direct from the
-ECB-Homepage at http://ecb.sourceforge.net.
+new github ECB-Homepage at https://github.com/ecb-new-home/ecb
 
-The latest version can be found at: http://ecb.sourceforge.net
+The latest version can be found at: https://github.com/ecb-new-home/ecb
 
 ------------
 Requirements
 ------------
 
-The short story:
-
-With Emacs >= 23.2 there is nothing to do. With XEmacs or Emacs < 23.2 you
-have to install the CEDET-suite by hand.
-
-The long story:
-
-1. Emacs-version: ECB works only with (X)Emacs >= 21! If you have an older
-   one, please upgrade.
-
-2. CEDET-suite: If Emacs >= 23.2 is used then CEDET is already integrated
-   into Emacs and there is nothing to do.
-
-   For users of any XEmacs-version, any Emacs-version < 23.2 or the latest
-   author CEDET version: Get it from http://cedet.sourceforge.net, read
-   the setup-instructions in http://cedet.sourceforge.net/setup.shtml and
-   read also the shipped file `INSTALL'.
-
-   *Please note*: If ECB detects an author version of CEDET (as available
-   at http://cedet.sourceforge.net) then ECB will ALWAYS try to use that
-   one even if you use Emacs >= 23.2! This is for users who want to use
-   latest Emacs >= 23.2 but still prefer using the latest author version of
-   CEDET instead of the Emacs-integrated one.
-
-   So if you want to use the Emacs-integrated CEDET-suite of Emacs >= 23.2
-   you have to ensure that no author-version of CEDET is in the `load-path'!
-   This means that the library cedet.el of the author-version MUST NOT be
-   loaded into Emacs (as described in the file INSTALL of CEDET)! This is a
-   valid check: (locate-library "semantic-ctxt") must return nil!
-
-3. Only for XEmacs-users: If you use XEmacs you must have installed the
-   package c-support (contains hideshow.el). If you want to read the
-   online-help of ECB in HTML-format you must have the library browse-url
-   (part of the mail-lib XEmacs package) installed; this package is also
-   needed for submitting problem-reports to the ECB-maintainers!
-
-4. Optional for Java-coding: ECB works very well with the JDEE package (
-   http://jdee.sourceforge.net) but JDEE is not required by ECB.
-
-
-Do not install ECB before you have successfully installed the requirements!
+With Emacs >= 29.x there is nothing to do. Older version will not work.
 
+*IMPORTANT*: ECB is no longer runnable as XEmacs-package
+Support for XEmacs is gone.
 
 ------------
 Installation
 ------------
 
-*IMPORTANT*: ECB is no longer runnable as XEmacs-package via the
-package-manager of XEmacs. This is because CEDET is not available as
-XEmacs-package. Therefore ECB can also not be run as XEmacs-package. If CEDET
-will later become a XEmacs-package then probably ECB will come back as
-XEmacs-package. But in the meanwhile you have to install ECB "by hand".
 
   1. Fulfill all requirements ECB needs (s.a. Requirements)
 
@@ -130,7 +87,7 @@ XEmacs-package. But in the meanwhile you have to install ECB "by hand".
      CEDET into Emacs must be placed somewhere before the statements needed for
      loading ECB (s.a.)!
 
-  5. Restart (X)Emacs.
+  5. Restart Emacs.
 
 ECB is now ready for use and can be activated by calling `M-x ecb-activate'
 or `ecb-minor-mode'. Now you can either starting using ECB or you can do
@@ -181,15 +138,16 @@ these optional installation steps:
 --------------
 Using Makefile
 --------------
+
 Makefile can be configured using Makefile.conf, for which there is a template in
 Makefile.conf.template. Usually it's enough to set a path to CEDET (if you use
 repo version) and EMACSINFOPATH to local (e.g. ~/.emacs.d/info).
 
 For Linux, Makefile tries to use reasonable defaults.
 
 You can print configuration used in Makefile using `make printconf'.
-     
------   
+
+-----
 Usage
 -----
 
@@ -205,16 +163,12 @@ using ECB the first time you should read the online help accurately!
 Contacts
 --------
 
-Send comments, bug reports and improvement suggestions to:
+For comments, bug reports and improvement suggestions make an issue in:
+
+https://github.com/ecb-new-home/ecb
 
-ecb-list@lists.sourceforge.net
+Do not use the "Mailing-list" ecb-list@lists.sourceforge.net
+at the ECB-website at http://ecb.sourceforge.net any more
 
-*IMPORTANT*: Cause of extra appearance of SPAM in the mailing-lists,
-SourceForge has changed its policy: Now it is only possible to post to the
-mailing-list for users who have subscribed this mailing-list.
 
-So please be aware you will not be able to send comments, bug reports and
-improvement suggestions before you have subscribed the ECB-mailing-list. See
-the section "Mailing-list" at the ECB-website at http://ecb.sourceforge.net
-how to do this.
 
diff --git a/TODO b/TODO
@@ -1,7 +1,15 @@
+- decide if ecb should use lexical binding
+
+- a lot of warning must be solved
+
+- remove some obsolete functions or macros like defadvice
+
+- check if semantic and cedet wrapper functions are necessary
+
 - Distinction of include-tags by "" or <>. This can be done via
   (semantic-tag-include-system-p TAG). Thanks to Markus grietsch.
   But probably it would be the best if semantic itself does this special
-  formating! 
+  formating!
 
 - Prevent layout-engine from splitting windows when smaller than
   window-min-height/width.
diff --git a/ecb-analyse.el b/ecb-analyse.el
@@ -35,6 +35,7 @@
 (require 'ecb-common-browser)
 (require 'ecb-method-browser)
 (require 'ecb-cedet-wrapper)
+(require 'ecb-semantic-wrapper)
 
 (eval-when-compile
   (require 'silentcomp))
@@ -75,7 +76,7 @@ key-bindings only for the analyse-buffer of ECB."
 (defcustom ecb-analyse-show-node-info '(if-too-long . name)
   "*When to display which node-info in the analyse-buffer.
 Define which node info should displayed after moving the mouse over a node
-\(or after a shift click onto the node) in the analyse-buffer.
+(or after a shift click onto the node) in the analyse-buffer.
 
 You can define \"when\" a node-info should be displayed:
 See `ecb-directories-show-node-info' for the possible choices.
@@ -102,7 +103,7 @@ The semantic analyse-modul offers several categories of analysis which are
 called buckets here. These are for example:
 
 Context: The current context, which is the current function/method, variable,
-class etc. \(what exactly depends on the programming language) point is in.
+class etc. (what exactly depends on the programming language) point is in.
 This means not the current function/method/variable/class-name point stand on
 but the current surrounding context. Example: If point stays somewhere within
 a defun-definition in emacs-lisp or within a java-method then this defun rsp.
@@ -123,11 +124,11 @@ Function: Current function-name point stands on.
 Argument #: When point is located within a function-call then this is the
 number of the argument point stands on.
 
-Completions: All possible completions for current prefix \(see above). This is
+Completions: All possible completions for current prefix (see above). This is
 probably the most helpful bucket.
 
 If one of these categories/buckets are not needed per default then add the
-bucket-name \(s.a.) to this option and ECB will per default collapse this
+bucket-name (s.a.) to this option and ECB will per default collapse this
 bucket. So most needed buckets are better visible in the analyse-buffer."
   :group 'ecb-analyse
   :type '(repeat (choice :tag "Bucket" :menu-tag "Bucket"
@@ -174,7 +175,7 @@ fontified see the options `ecb-analyse-bucket-node-face' rsp.
 If nil then the default information about a tag will be displayed. If a
 function then this function gets as argument the tag for which tag-information
 should be displayed. This function has to return a string which will be then
-display as tag-info. This string has to be fully formatted \(e.g. must already
+display as tag-info. This string has to be fully formatted (e.g. must already
 include line-breaks if the tag-info should be displayed in several lines).
 
 See `ecb-analyse-show-tag-info-fn' how the tag-info is displayed."
@@ -190,8 +191,8 @@ must do all things necessary for displaying this info. When this function is
 called the window stored in `ecb-last-edit-window-with-point' is the selected
 window!
 
-ECB offers two builtin ways: Display the info in the echo-area \(via the
-function `message') or in a temp-buffer in the edit-area \(via the function
+ECB offers two builtin ways: Display the info in the echo-area (via the
+function `message') or in a temp-buffer in the edit-area (via the function
 `ecb-analyse-show-tag-info-in-temp-buffer'). Default is echo-area-display.
 
 See also `ecb-analyse-gen-tag-info-fn'."
@@ -258,17 +259,17 @@ Preconditions for such a hook:
 - Current buffer is the buffer of the currently selected
   edit-window.
 - The analyse-buffer is displayed in a visible window of the
-  ecb-frame \(so no check for visibilty of the analyse-buffer in
+  ecb-frame (so no check for visibilty of the analyse-buffer in
   the ecb-frame is necessary in a hook function)
 
 Postcondition for such a hook:
 Point must stay in the same edit-window as before evaluating the hook.
 
 Important note: If the option `ecb-analyse-buffer-sync' is not
 nil the function `ecb-analyse-buffer-sync' is running either
-every time Emacs is idle or even after every command \(see
+every time Emacs is idle or even after every command (see
 `ecb-analyse-buffer-sync-delay'). So if the anaylse-buffer is
-displayed in a window of the ecb-frame \(see preconditions above)
+displayed in a window of the ecb-frame (see preconditions above)
 these hooks can be really called very often! Therefore each
 function of this hook should/must check in an efficient way at
 beginning if its task have to be really performed and then do
@@ -518,7 +519,7 @@ used as window."
 (defun ecb-maximize-window-analyse ()
   "Maximize the ECB-analyse-window.
 I.e. delete all other ECB-windows, so only one ECB-window and the
-edit-window\(s) are visible \(and maybe a compile-window). Works also if the
+edit-window(s) are visible (and maybe a compile-window). Works also if the
 ECB-analyse-window is not visible in current layout."
   (interactive)
   (ecb-maximize-ecb-buffer ecb-analyse-buffer-name t))
diff --git a/ecb-compatibility.el b/ecb-compatibility.el
@@ -114,19 +114,19 @@ BUFFER is displayed in an edit-window!"
              (ecb-point-in-dedicated-special-buffer))
     (ecb-select-edit-window)))
 
-(defecb-advice electric-buffer-list before ecb-compatibility-advices
-  "Ensures that the electric-* commands work well with ECB."
-  (when (and ecb-minor-mode
-             (equal (selected-frame) ecb-frame)
-             (ecb-point-in-dedicated-special-buffer))
-    (ecb-select-edit-window)))
-
-(defecb-advice electric-buffer-list after ecb-compatibility-advices
-  "Ensures that the electric-* commands work well with ECB."
-  (when (and ecb-minor-mode
-             (equal (selected-frame) ecb-frame))
-    (if (ecb-buffer-obj "*Buffer List*")
-        (bury-buffer (ecb-buffer-obj "*Buffer List*")))))
+;(defecb-advice electric-buffer-list before ecb-compatibility-advices
+;  "Ensures that the electric-* commands work well with ECB."
+;  (when (and ecb-minor-mode
+;             (equal (selected-frame) ecb-frame)
+;             (ecb-point-in-dedicated-special-buffer))
+;    (ecb-select-edit-window)))
+;
+;(defecb-advice electric-buffer-list after ecb-compatibility-advices
+;  "Ensures that the electric-* commands work well with ECB."
+;  (when (and ecb-minor-mode
+;             (equal (selected-frame) ecb-frame))
+;    (if (ecb-buffer-obj "*Buffer List*")
+;        (bury-buffer (ecb-buffer-obj "*Buffer List*")))))
 
 ;; package master.el
 
diff --git a/ecb-face.el b/ecb-face.el
@@ -112,17 +112,6 @@ tree-buffer can be very easily changed with face 'ecb-default-general-face'."
   :type 'face
   :group 'ecb-face-options)
 
-(defface ecb-tree-buffer-face (ecb-face-default 1.0 nil nil
-                                                    'ecb-default-general-face
-                                                    "blue" "black")
-  "*Face for the tree-buffers."
-  :group 'ecb-faces)
-
-(defcustom ecb-tree-buffer-face 'ecb-tree-buffer-face
-  "*Face for the tree-buffers."
-  :type 'face
-  :group 'ecb-face-options)
-
 (defface ecb-directories-general-face (ecb-face-default 1.0 nil nil
                                                         'ecb-default-general-face)
   "*Basic face for the ECB directories buffer.
diff --git a/ecb-method-browser.el b/ecb-method-browser.el
@@ -1910,7 +1910,7 @@ This function MUST be called with the source-buffer as current buffer!"
 
 (defun ecb-children-tags (parent-tag)
   "Return a list of children-tags of PARENT-TAG. If a child is not a
-semantic-tag \(but a plain string) then it will be converted to a positionless
+semantic-tag (but a plain string) then it will be converted to a positionless
 tag of class 'variable."
   (mapcar (function (lambda (c)
                       (cl-typecase c
@@ -2966,7 +2966,7 @@ not enabled for current source-buffer and the option
 `ecb-force-reparse-when-semantic-idle-scheduler-off' is not nil then use
 `ecb--semantic-fetch-tags' otherwise use `ecb--semantic-fetch-available-tags'.
 The latter always returns just the currently available tags in the
-semantic-cache \(reparsing is done completely by the idle-scheduler of
+semantic-cache (reparsing is done completely by the idle-scheduler of
 semantic if necessary). The former one triggers immediate parsing if
 necessary!"
   (if (or full
diff --git a/ecb-semantic-wrapper.el b/ecb-semantic-wrapper.el
@@ -49,6 +49,11 @@
 (eval-when-compile
   (require 'silentcomp))
 
+(eval-when-compile
+  ;; For the semantic-find-tags-for-completion macro.
+  (require 'semantic/find))
+(require 'semantic/db-find)          ;For type semanticdb-find-result-with-nil.
+
 (eval-when-compile
   ;; to avoid compiler grips
   (require 'cl-lib))
diff --git a/ecb-semantic.el b/ecb-semantic.el
@@ -32,6 +32,12 @@
 (require 'ecb-cedet-wrapper)
 (require 'ecb-util)
 
+(eval-when-compile
+  ;; For the semantic-find-tags-for-completion macro.
+  (require 'semantic/find))
+
+(require 'semantic/db-find)          ;For type semanticdb-find-result-with-nil.
+
 (eval-when-compile
   (require 'silentcomp))
 
diff --git a/ecb-speedbar.el b/ecb-speedbar.el
@@ -78,9 +78,6 @@
 ;; imenu
 (silentcomp-defvar imenu--rescan-item)
 (silentcomp-defvar imenu--index-alist)
-;; XEmacs
-(silentcomp-defun event-button)
-(silentcomp-defvar mouse-motion-handler)
 
 (defgroup ecb-speedbar nil
   "Settings for the speedbar-integration of ECB."
diff --git a/ecb-upgrade.el b/ecb-upgrade.el
@@ -156,7 +156,7 @@
 ;; change it here!
 ;; TODO: Makefile frobbing broken
 
-(defconst ecb-version "2.50"
+(defconst ecb-version "2.51"
   "Current ECB version.")
 
 (eval-when-compile
@@ -174,7 +174,11 @@
 
 ;; Each NEWS-string should be a one-liner shorter than 70 chars
 (defconst ecb-upgrade-news
-  '(("2.50" . ("ECB now requires full CEDET being installed (at least 2.0)."
+  '(("2.51" . ("By default ECB now utilizes CEDET distributed as part of Emacs."
+	       "ECB now requires Emacs 29.x (though previous versions may work."
+               "This release includes numerous fixes related to moving to the latest Emacs"
+               ))
+    ("2.50" . ("ECB now requires full CEDET being installed (at least 2.0)."
 	       "By default ECB now utilizes CEDET distributed as part of Emacs."
 	       "ECB now requires Emacs 24.4 (though previous versions may work."
                "This release includes numerous fixes related to moving to the latest Emacs"
diff --git a/tree-buffer.el b/tree-buffer.el
