2 # SUMMARY: What's new in this version of the OO-Browser?
7 # LAST-MOD: 3-Jan-02 at 18:18:42 by Bob Weiner
9 # Copyright (C) 2000-2001 Bob Weiner
10 # Copyright (C) 1990-1999 BeOpen.com
11 # See the file BR-COPY for license information.
13 # This file is part of the OO-Browser.
15 ---------------------------------------------------------------------------
18 * V4.07 was released as a sourceforge.net project. Updated the mailing list
19 and support e-mail addresses to point to the sourceforge lists. See
20 "www.sf.net/projects/oo-browser" for more details.
22 * Added support for the GNU General Public License Version 2. See "BR-COPY".
24 * Clarified installation instructions in "BR-README".
26 * If help-mode is available, can now use {q} to exit from OO-Browser
27 information display buffers shown in the viewer window.
29 * Many bug fixes for initial version of the Python support code and
30 elsewhere, notably a regexp overflow bug when scanning C++ code.
31 See "ChangeLog" for details.
35 ** See the `Python Specifics' section of the OO-Browser user manual,
36 "(oo-browser)Python Specifics", for how to use the following new
39 ** Added global variable browsing support.
41 ** Added module and package browsing support.
43 ** Added support for Python OO-Browser Environments which include C or C++
46 ** Support for source file lookup within directories listed in the
47 PYTHONPATH environment variable.
49 ** Added support for all docstring types, not just method docstrings.
51 ** Improved class scanning.
53 ** Integration with Python's pydoc self-documentation module when the
54 separate pydoc.el interface package is available. Download pydoc.el
55 from: "www.deepware.com/pub/python".
57 ** Support for browsing Java-type interfaces within Python. The add-on
58 Python module, bwcto_interface, lets you define interfaces within Python
59 which the OO-Browser will then browse. Download bwcto_interface from
60 "www.deepware.com/pub/python".
62 ----------------------------------------------------------------------------------
67 * Integrated OO-Browser Options with InfoDock's Options menu.
69 * Fix startup time library dependency failure.
71 * Java OO-Browser: Fixed handling of classes with no `extends' or
72 `implements' clauses. When edit a class, point is now left at the
73 beginning of the class def line as expected, not after initial modifiers
76 * Windows Graphical OO-Browser: Fixed bug in source code which failed to
77 deselect a node before deleting it. (The binary is not fixed yet so
78 if you want this fix, you will have to build the binary yourself for
81 ---------------------------------------------------------------------------
86 * Separated binary distributions from the rest of the OO-Browser distribution
87 so that parties who use it on multiple platforms don't have to download
88 the Lisp and documentation multiple times.
90 ---------------------------------------------------------------------------
93 * Open Sourced the commercial-quality multi-language OO-Browser.
95 * Added C construct support for Python and Eiffel.
97 * Added support for building the Texinfo version of the OO-Browser Manual.
99 * Improved function handling.
101 * Added support for HP-UX distributions.
103 ---------------------------------------------------------------------------
106 * Improved selection and error reporting within *Implementors* buffers that
107 list potential implementors of a method. These are displayed when multiple
108 implementations of a method name are detected after an Action Key click on
109 the method name within a code buffer.
111 * The Use-Vi-as-Editor option worked only if an xterm was used as the
112 shell from which vi is run. Now other shells work.
114 * Improved handling when a dedicated frame is used to display the OO-Browser
115 and the frame is deleted. It now is recreated.
117 ---------------------------------------------------------------------------
120 * Added support for the pop-tag-mark command {M-*} available in some editors
121 to move back to prior code locations displayed from clicking the Action Key
122 on an identifier or other cross-reference.
124 * Fixed Action Key support for selecting an overloaded method within an
125 *Implementors* buffer. Such a buffer is generated by the OO-Browser in
126 response to an Action Key click on an overloaded method call.
130 ** Eliminated rare false matches within conditional statements that look like
131 function calls and eliminated processing of ::function references within
134 ** Improved matching between declaration and definition of a function where
135 the two have different whitespace or contain * characters within
138 ** Added .inc and .hpp as C++ header file suffix types since some libraries
141 ** Eliminated substring problem where searching for implementors of `func'
142 would include entries such as `function'.
146 ** Added potential support for background building of Environments.
148 * Many subtle bug fixes.
150 ---------------------------------------------------------------------------
155 ** Improved handling of nested template class and parent declarations.
157 ** Improved handling of complex method declarations.
159 ** Support for the `typename' keyword.
161 ---------------------------------------------------------------------------
166 ** Improved recognition of C++ template and array constructs.
168 ** Modified listing prefix for structs and enums from "- " to "= " for now.
172 ** Multiple attribute declarations such as: `a,b,c: TYPE' may now be viewed
173 individually within the browser. Multiple routines definitions were
174 already handled by the browser.
176 ** Improved recognition of Eiffel inherit clauses, external features and
177 Windows-based Eiffel files.
179 ** Made the class `ANY' a parent of any class without an inheritance
180 clause (lacking any explicit parents).
182 ** The OO-Browser now browses ISE's publicly released BASE data
183 structures library and the SmallEiffel class libraries as well.
187 ** Corrected comment recognition and improved expression matches.
189 ** Added Action Key clicking on import modules or the specific classes,
190 methods, functions or variables that they reference. A click on
191 any such name locates the associated definition and displays it.
195 ** Improved recognition of Java attributes.
197 * Eliminated invalid association of an existing Env name with a newly created
200 * With XEmacs under the X Window System, the Backspace key now works just
201 like the Delete key in listing buffers, scrolling the viewer window back a
206 ---------------------------------------------------------------------------
209 * An OO-Browser menubar entry has been added to the global menubar under
210 XEmacs and GNU Emacs to simplify invocation of the OO-Browser for new
211 users. (InfoDock has long had this feature.)
213 * The Action Key part of whose function is to display classes and features
214 when clicked upon in listing buffers is now bound to the middle mouse
215 button on 3-button systems and the left mouse button on typically 2-button
216 systems. (InfoDock has long had this feature.)
218 * Environments are now named, with a full suite of menu and keyboard commands
219 for adding, removing, renaming, listing and changing Environment
220 associations to names. Environment names eliminate the need to remember
221 where each Environment is stored within a file system. You are prompted to
222 add a name to an Environment when trying to load an Environment to which
223 you have not yet assigned a name.
225 Names are user-specific so that each user can have names that are most
226 memorable and easiest to use according to their own tastes. Names may
227 however be copied for sharing and site-wide commonality; BeOpen.com support
228 programs can help you with such configuration.
230 * Within OO-Browser listing windows, the title bar above the frame displays
231 both the name and full pathname of the Environment being browsed for easy
232 reference. It also shows the version of the OO-Browser in use.
234 * Redesigned all feature handling code to speed feature queries.
235 A test Environment of 586 C++ classes on a Pentium II 350 Mhz
236 Linux system required only 1.5 seconds to list all of its features
237 (9859 entries including classes). The time went from 15 seconds in V3.07
238 to 1.5 seconds for a 10-fold speedup.
240 A user-visible side-effect of this speedup under MS operating systems
241 only (due to their lack of the -d option to their builtin sort function),
242 is that features are alphabetized by category, e.g. regular methods in one
243 group, special methods in other groups, followed by attributes.
245 * Restructured internals for improved efficiency and reliability.
247 * When scanning trees of code directories, symbolic link subdirectories are
248 now ignored since these sometimes cause circularities that can produce an
249 infinite recursion. If any code lives within another tree, the Environment
250 can specify inclusion of its root directory. If a root directory given as
251 an Environment search path is a symbolic link, it is scanned, only
252 subdirectory symbolic links are ignored.
254 * Features in a graphical OO-Browser display may now be edited or viewed
255 read-only rather than just viewed.
257 * PC files ending with carriage-return and linefeed characters are now
258 handled without any need for conversion.
260 * The {@} command which shows a class within its textual inheritance graph no
261 longer hides all other entries within the current listing. This brings it
262 into conformance with other OO-Browser commands.
266 ** Pure virtual functions are now shown properly within feature listings.
268 ** C constructs of enumerations, structures, typedefs, and unions declared
269 within classes are now recognized. Their type definitions are listed
270 under associated default classes, e.g. [enumeration]. Any variable
271 names associated with these declarations are shown as attributes under
272 the class in which they are declared.
274 ** Fixed to handle unsigned attribute declarations.
278 ** Added support for multiple routine definitions with a single definition
281 ** Made {i} show class info binding work automatically without the need to
282 call another setup command.
284 * Lisp/CLOS OO-Browser
286 ** Improved implementors listings involving default classes.
288 ** All feature listings now have categorizing prefixes as in other
289 languages. Constants and variables are now preceded by "= "; for now,
290 other features all are preceded by "- ".
292 * Eliminated Rebuild-Lib-Part and Rebuild-Sys-Part from the
293 OO-Browser/Environment menu since these are seldom used.
297 ---------------------------------------------------------------------------
300 * When an Environment is reloaded within the OO-Browser (using {C-c C-l}),
301 the browser display is completely refreshed to its beginning state as if
302 a different Environment had been loaded. This eliminates any issue of
303 having stale data in a listing window after an Environment load.
305 * Improved the output of `br-where' {w} to include the class name of any
306 feature being displayed.
308 * When prompted to load or to create an Environment, completion now occurs in
309 the current directory rather than the directory of the last used
310 Environment. Thus, by moving to the directory in which you want your
311 Environment to be saved and then using {C-c C-o} or {M-x oo-browser RET},
312 you will be able to just hit return when promted for an Environment name.
314 * Switching from one language Environment to another now automatically
315 updates the Environment feature file in use.
319 ** Updated feature handling to latest OO-Browser standards. This fixed
320 problems with a number of Eiffel operations.
322 ** Classes are now shown in upper case as they are in Eiffel code.
324 ** Speeded up feature scanning when building Environments.
326 ** Eiffel Environments built with earlier versions of the OO-Browser are
327 now obsolete. You will be prompted to rebuild them whenever out-of-date
328 Environments are loaded.
332 ---------------------------------------------------------------------------
335 * The emacs-related editor in use and other current environment information
336 is now included within the output of {M-e} (br-env-stats) when within a
337 browser listing window.
341 * Improved feature listings to leave same named features in the same order as
342 they occur within the source file.
346 ** Static data members (attributes for which one copy is shared by all
347 instances of a class) are now prefixed with an "& " prefix to
348 distinguish them from replicated attributes which are prefixed with
351 ** Improved C++ declaration recognition.
353 ** Improved case-sensitivity when locating features.
355 ** Improved constructor recognition.
357 ** Method argument lists may contain either :: scoped operators or ()
358 operator related parentheses. The browser will properly recognize such
359 methods if they contain one or the other but not both embedded
360 parentheses and scoping operators. This limitation is related to poor
361 design in the C++ language that reuses the : and parentheses characters
362 within method declarations for multiple purposes.
364 ** Class declarations conditionalized with #ifdef preprocessor constructs
365 are now handled better; only one version of such a class declaration
366 will appear within an Environment.
371 ** Constructs from C files found within Java Environment source directories
372 are now listed within Java Environmens as they are within C++ and
373 Objective-C Environments.
375 ---------------------------------------------------------------------------
378 * Up to 6-fold improvement in the speed of building C++ and other
379 language environments under InfoDock and XEmacs; 14-fold speedup
382 * C++ OO-Browser: Improved attribute matching including array support.
384 * Support for viewing and editing elements/features with external
385 viewers/editors. (Earlier versions support external viewing of classes
388 * New menu item, Options/Use-Vi-as-Editor to toggle the setting of whether
389 the internal editor or Vi is used when edit commands are issued in the
390 OO-Browser listing windows. Viewing commands remain unaffected.
394 ---------------------------------------------------------------------------
396 * Windows OO-Browser:
398 ** Added a version of the graphical OO-Browser for use under MS Windows-based
399 OSes and window systems. It works in the same way as the X OO-Browser.
400 The textual OO-Browser automatically selects the appropriate graphical
401 browser to use under each OS.
403 ** Added Windows support under GNU Emacs major release 20.
405 * C functions are now found using a variant of the etags program called
406 `ootags' to prevent any naming conflicts with other versions of etags
409 ---------------------------------------------------------------------------
412 * The OO-Browser program directory is now called oo-browser.
414 * C++ OO-Browser: Fixed support for global operator+ and operator- functions.
415 Be sure to not leave whitespace between the `operator' and its type
416 symbol, e.g. =, when writing global operators or the browser may
417 not browse it properly. Whitespace is handled in scoped :: operators.
419 * Many bug fixes, notably a fix for the problem where the OO-Browser reports
420 that a class is not defined in the Environment even though its definition
421 was found. (This occurred only when a class was referenced in one part of
422 the Environment, e.g. System, and then defined in the other part,
425 ---------------------------------------------------------------------------
426 VERSION 3.01 and 3.02
428 * C++ OO-Browser: Reduced large Environment build times by approximately 36%
429 through a number of optimizations.
431 * Environments now store the start and end times of the last build of the
432 Environment. When in the OO-Browser, {M-e} (br-env-stats) will show
433 these times. It will also show an improved summary of the number of
434 classes and interfaces in the Environment.
438 * If you have a problem building an Environment in the background under
439 XEmacs or InfoDock, you can now use {C-u M-x br-env-rebuild RET} to
440 build an Environment and to generate a stack backtrace when errors
443 ---------------------------------------------------------------------------
447 * New key bindings and commands:
449 ==========================================================
450 OO-Browser Listing Menu Item
452 ==========================================================
456 < View-Window/To-Buffer-Beginning
457 > View-Window/To-Buffer-End
458 , View-Window/Scroll-Backward-One-Line
459 . View-Window/Scroll-Forward-One-Line
461 M-0 P Options/List-Protocols-with-Classes
464 Standalone browser features (those useful in code buffers outside of the
465 browser user interface) are now bound to keys by default (which differ from
466 the previously recommended bindings to prevent conflicts with other
469 ==========================================================
472 ==========================================================
475 Prompt with completion for a class or element name from the
476 current Environment and display its definition for editing.
478 C-c M-j (C++ only) br-feature-edit-declaration
479 Prompt with completion for a CLASS::FEATURE argument and then edit
480 the associated declaration. If point is on a feature definition
481 signature in a code buffer (prior to any of its arguments), the
482 default is to edit that feature's declaration. An error is
483 signaled if the declaration is not found.
486 Display in the viewer window and return the full path of the
487 defining file for a browser listing entry. Optional prefix arg
488 PROMPT means prompt for the entry name; automatically prompts if
489 called interactively outside of a listing window (in standalone
490 mode), e.g. within a source code buffer when the browser user
491 interface is not displayed. If called in standalone mode with a
492 prefix argument, the command inserts the defining path at point
493 rather than displaying it elsewhere.
495 M-TAB br-complete-symbol
496 Complete an OO-Browser type or element or an Emacs Lisp symbol
497 preceding point. The symbol is compared against current
498 Environment entries (or Emacs symbol table entries) and any needed
499 characters are inserted.
501 * Redesigned menus for clarity and ease of use. Added Graphical Menu to
502 centralize graphical browser commands. Also added documentation
503 entries that display help for each menu and each menu concept, such as
504 `Feature'. Added an item on the OO-Browser menu that e-mails pre-paid
505 support issues directly to BeOpen.com.
507 * Made Ancestor menu entries behave exactly as the {a} and {C-u a} keys do,
508 rather than inverting ancestor listings, since the difference could be
511 * Simplified the (br-add-class-file) command bound to {C-c ^}. It now
512 tries to determine by itself whether to add the class to the Library or
513 System part of the Environment.
515 * Eliminated the load of an Environment after it is built in batch mode since
516 the editor session is terminated immediately after the build.
518 * Fixed so that when switch Environment languages, the new Environment is
519 always properly loaded.
521 * Simplified installation and batch usage of the OO-Browser.
526 ** Attributes (data members) declared within class definitions are now
527 included in Environments. Environments will take a bit longer to build
528 but will be more complete.
530 ** Friend classes are now included in Environments (previously only
531 individual friend features were included).
533 ** Because of the above changes, Environments built with versions of the
534 OO-Browser prior to 3.00 are now obsolete. The browser will prompt you
535 to rebuild such Environments when they are loaded.
537 ** Action Key presses at the start of feature declarations and definitions
538 jump back and forth between matching definitions and declarations.
540 ** Action Key presses on types found within method signature argument lists
541 try to display the definitions of the types.
543 ** Improved default feature name computed for various commands when point
544 is within the pre-argument part of a declaration or definition of a
547 ** Allow single-line C or C++-style comments between method arguments when
548 searching for matching definitions and declarations.
550 ** Numerous special case fixes for optimum performance.
552 ** Fixed parsing of global `operator' features which ootags mishandles.
557 ** Require types for all feature declarations and definitions.
559 ** Action Key presses on types found within method signature argument lists
560 try to display the definitions of the types.
562 ** Eliminated false matches to statements that look like method signatures,
563 e.g. if (expr) { body }.
565 ** Eliminated failure of feature and ancestor queries made when point was
566 in the middle of an <interface> entry name.
568 ** Clarified the message display when a feature definition is found.
570 ** Made br-find work for Java features.
573 * Graphical OO-Browser
575 ** Fixed so that the selected tree node is highlighted in red on
576 16-bit-plane and higher displays. (Previously, no highlight was seen.)
578 ** ANSIfied the C source code and added initial multi-platform
579 configuration support.
581 ** Eliminated jumping between windows within the textual browser to display
582 entries selected within the graphical browser.
584 ** Coming soon: A native Windows port of the graphical browser.
586 ---------------------------------------------------------------------------
589 * Java OO-Browser: Fixed regexp scanning bug that could cause a hang when
590 scanning Java class files that contain multiple blank lines at the end
593 * New menu item Option/List-Protocols-with-Classes which is on by default
594 includes protocols (interfaces) in the listings of all classes or top-level
595 classes under Java and Objective-C. If you want to turn this off in your
596 editor initialization file, add the expression:
597 (setq br-protocols-with-classes-flag nil)
599 * Listing buffers have been renamed from `Inher-Lvl-' to `OO-Browse-' and
600 now contain both the key binding that generated the listing and the listing
601 number (sequential from 1). So if the third listing command that you use
602 is the ancestors command bound to {a}, its output would be shown in a
603 buffer named `OO-Browse-a3'.
605 * Each command that displays its output in a new listing window uses the next
606 window to the right (and then wraps back to the first window on the left).
607 Some commands used to use the prior left window and so could obscur
608 recently generated information.
610 * New key bindings in listing buffers:
611 {A} = list all classes (this used to be {C-u t} which still works)
612 {T} = list top-level classes (this used to be {t} which still works)
614 ---------------------------------------------------------------------------
617 * C++ OO-Browser: Allow for #define replacement keyword between the `class'
618 literal and the class name, a technique used in some class libraries.
620 ---------------------------------------------------------------------------
623 * Eliminated issues with running the OO-Browser under Microsoft
624 OSes which lack typical UNIX executables like sort and make used
627 * Eliminated `file has changed' messages when browse an Env after
628 building it in the background.
632 ** Improved handling of variable declarations with template args.
634 ** Improved recognition of "type var1, var2, var3;" declarations.
636 ** Made feature matches work under GNU Emacs 20 (in prior versions
637 could signal an error).
639 ---------------------------------------------------------------------------
642 * C++ OO-Browser bug fixes and addition of class name display when a feature
643 definition is found since the class name may not be on the screen
646 ---------------------------------------------------------------------------
649 * All Environment handling commands now prompt with a full pathname of the
650 most recent Environment as a default and beep if an attempt to enter a
651 directory name is made.
653 * Modified installation instructions to require loading of initial browser
654 files at startup, rather than autoloading. This avoids any undefined
655 Action/Assist Key autoloads.
657 * Added support for Action Key selection of identifiers within the body of
658 features defined within the class declaration itself. In earlier releases,
659 a click anywhere on the first line of an in-class method definition would
660 just move the first line of the definition to the top of the window. Now
661 that happens only if you click before the opening brace. This applies to
662 C++, Java and Objective-C files.
664 * Background builds should now reload and redisplay the Environment properly
665 after finishing. If the Environment built is the same one currently being
666 browsed, the Environment is reloaded and the browser reinitialized
667 automatically when the build finishes.
671 ** Fixed recognition of C++ feature definitions.
673 ** When Action Key press on a C++ member reference, if no possible
674 definitions are found within the Environment, it will try to display a
675 matching declaration instead.
677 ** Declaration recognition is much improved.
679 ** {j} and {J} commands now work when used on entries from [default
680 classes], i.e. C constructs. They also will now find a declaration for
681 which no definition exists within the Environment.
683 ** References that start with the pseudo-variable `this->' now work
684 properly when the Action Key is pressed on them.
686 ** Made commands that display declarations and definitions of features
687 show the class of the feature in the minibuffer message since it may not
688 be visible on screen.
690 ** Significantly improved default prompting based on a feature name or
691 feature reference at point, whether in code or within a listing buffer.
692 Also corrected several bugs.
694 ---------------------------------------------------------------------------
697 * Simplified listing display of implementor signatures when the browser
698 produces more than one feature entry as possible matches for a feature
701 * Action and Assist Mouse Keys work under GNU Emacs 20.
703 * Action and Assist Key direct selection of entities has been greatly
704 expanded. See the Hyperbole Manual for a superset of the things that
705 can be clicked upon for action.
709 ** You should rebuild any C++ Environments built with earlier versions of
710 the browser as this may improve commands which work with feature
713 ** New {j} key binding to jump to (view) the declaration (header) of the
714 entry at point. {C-u j} prompts with completion for the name of the
715 feature declaration to view.
717 ** New {J} key binding to edit the declaration of the entry at point.
718 {C-u J} prompts with completion for the name of the feature declaration
721 ** Feature name completion when used in source buffers prompts with
722 much more intelligent defaults than in prior versions.
724 ** Action Key clicks on var.attribute or var->attribute feature references
725 display the attribute definition for editing if var is declared
726 within the current bufffer and the attribute is lexically defined within
727 the class given by the type of var. Inherited attributes will be
728 supported in the future. Action Key clicks on method calls also work
731 ---------------------------------------------------------------------------
734 * Added support independent of a full Hyperbole for Action Key clicks within C,
735 C++, Java, Lisp and Objective-C buffers as documented in the OO-Browser
738 * When the browser is invoked and a background build is initiated, the buffer
739 showing the status of the build is displayed in the viewer window.
741 * When a background Environment finishes, the built Environment is loaded
742 if it is the current Environment or the user asks to browse it.
744 * Improved Environment loading if user aborts during some of the Environment
747 * Selection of completions with the Action Key is much more reliable.
748 * In-buffer and minibuffer completion lists of classes, features and elements
751 ---------------------------------------------------------------------------
754 * Clarified prompts sent to the user when building an Environment to reduce
755 the need for reading the manual before getting started.
757 * Now works with GNU Emacs 20.
759 * Background building under GNU Emacs now works.
761 * Now works without a full distribution of Hyperbole installed.
763 * Reloading the same Environment after a {C-u q} now works without error.
765 ---------------------------------------------------------------------------
768 * OO-Browser Multi-language Changes
770 ** New class and protocol-oriented menu items "Protocols" and
771 "All-Protocols" plus "Implementors" and "All-Implementors".
773 ** Action Key clicks within the whitespace preceding classes or
774 interface/protocols displays their ancestors; an Assist Key click in the
775 same context displays descendants. The same click on a feature line
776 displays the implementors of the feature.
778 ** Action or Assist Key clicks on default class names (those delimited by
779 square brackets, []) lists the instances of the default class, e.g. the
780 instances of [interface] are all interface names within the Environment.
782 ** Added text to help the user identify and correct the problem when an
783 OO-Browser Environment is moved from one location to another but the
784 pathnames it refers to are not updated.
786 ** The {I} (br-implementors) command has been extended to work on
787 interfaces (Java) and protocols (Objective-C), each of which are
788 shown in the browser delimited by <>. The implementors of an
789 interface/protocol are those classes which lexically define the methods
790 specified by the interfaces. Classes that inherit such method
791 definitions are not list as implementors. Use {d} (br-descendants) on
792 an interface/protocol entry to see all classes that conform to the
793 entry. Implementors are now shown in the next listing window rather
794 than the prior one since they are more like descendant relations than
797 ** {P} (br-protocols) on a class entry now shows all interfaces/protocols
798 to which a class conforms (including those it inherits), not just those
799 referenced within the class declaration. Also changed this command when
800 on an interface/protocol entry to display the interfaces to which the
801 entry conforms, just as it does for regular classes. Use {v} or {e} to
802 display the interface declaration itself for viewing or editing. The
803 OO-Browser command/help menu bound to {h} now documents the {P} key.
805 ** Method implementors no longer include entries from interfaces/protocols
806 since these are abstract entries, not implementations.
808 ** The Action Key, when pressed on individual class or interface/protocol
809 names referenced for inheritance purposes within the initial line of a
810 class declaration, jumps to their associated declarations.
812 ** Modified the way the browser displays definitions/declarations. Point
813 is now left on the first line of the definition, not on preceding
814 comments, although the preceding comments are also displayed. Comments
815 that do not begin a line are ignored, so that lines such as:
817 are not considered preceding comments.
821 ** Navigating from method declarations to their definitions now works
822 when classes are declared within the same files as the methods rather
823 than in header files.
827 ** Added full support for browsing interfaces just like classes;
828 additionally, implementors of interfaces may be listed. Use the {f}
829 (br-features) command on the top-level default class, [interface], to
830 see all interfaces defined within the Environment. Interface entries
831 are shown delimited by <>.
833 ** Interface method declarations are now properly categorized as abstract
834 methods within OO-Browser listings.
836 ** Due to changes in the handling of interfaces, Java OO-Browser Environments
837 built prior to V2.12 are obsolete. The browser now prompts the user
838 to rebuild such Environments whenever they are loaded.
840 * Objective-C OO-Browser
842 ** Fixed so {I} (br-implementors) works when used on feature entries
843 or class category entries.
845 ** Added support for method signatures which end with ,...
846 This syntax is used within GNUstep libraries.
848 ** Due to changes in the handling of interfaces, Objective-C OO-Browser
849 Environments built prior to V2.12 are obsolete. The browser now prompts
850 the user to rebuild such Environments whenever they are loaded.
852 ---------------------------------------------------------------------------
855 * OO-Browser Multi-language Changes
857 ** When using OO-Browser Environments outside of the browser user interface
858 to click on identifiers and jump to their definitions, the location of
859 display of new files and buffers is controlled by Hyperbole's
860 `hpath:display-buffer' function which allows user-level control of where
863 ** The browser now skips CVS subdirectories by default when scanning source
864 code. See the documentation for `br-skip-dir-regexps' for more details.
868 ** Support for .CXX and .HXX suffixes from case-insensitive platforms.
870 ** Eliminated false #define macro listings when a simple constant contains
873 ** Method and function call browsing is now supported by pressing the
874 Action Key on a call after an Environment has been loaded. The
875 OO-Browser deals with much of the complexity of C++'s calling
876 syntax so you need not (though it doesn't yet account for method
877 overloading). In cases where it cannot determine a unique definition
878 (e.g. where dynamic binding is involved), it pops up a list of possible
879 definitions (method signatures). An Action Key click on any of these
880 (or on the class names separating these signature lines) will display
881 the definition within the source code.
883 ** An Action Key press on pretty much any class name, including those
884 preceeding the :: scoping operator in a method call, jumps to the
889 ** All interfaces and classes mentioned within `implements' and `extends'
890 clauses are now properly recorded. Interfaces give Java a limited form
891 of multiple inheritance which is reflected by the OO-Browser. There is
892 as yet no visual distinction within listing buffers between interface
895 ** Classes which are referenced but not defined in the Environment
896 are now assumed to inherit directly from Object so that it remains
897 the sole top-level class.
899 ---------------------------------------------------------------------------
902 * Added support for new C++ `restrict' keyword.
904 * Added hmouse-tag.el file to support jumping from C-based headers to
905 their definitions when a full Hyperbole distribution is not available.
907 * Added support for rebuilding C constructs when just the System or
908 Library part of an Environment is rebuilt. You must first rebuild
909 in its entirety any Environment built with an earlier version of the
910 OO-Browser; then rebuilding either part of it will work properly.
912 ---------------------------------------------------------------------------
915 * Case-sensitive feature name lookup in C++, C, Java, Python, and
918 * Added support for running the OO-Browser in a dedicated frame under
921 ---------------------------------------------------------------------------
924 * OO-Browser Multi-language Changes
926 ** {M-x oo-browser RET} now prompts to return to the previously browsed
929 ** Errors in redrawing trees in the X OO-Browser when collapse a node
930 are gone (double buffering during redrawing had to be disabled).
932 ** Fixed a number of bugs. See the "ChangeLog" file.
934 ** Edited whole OO-Browser Manual.
936 ** Long comments preceding an element definition no longer scroll the
937 element outside of the window bounds.
939 ** The {br-where} command now displays its output in the viewer window so
940 that it is never truncated and the results can be more easily reused.
942 * C++ and Objective-C OO-Browser
944 ** C functions are included in Environments only if `br-c-tags-flag' is t,
945 which is the default.
947 ** C constructs whose name comes at the end of a multi-line { list }, such
948 as an enum, now are displayed in their entirety. (The old behavior
949 displayed just the final line of the construct.
951 ** Action Key presses on global C identifier references within code jumps
952 to their definitions.
954 ** Global variables and individual enumeration labels are now listed in
955 default classes [variable] and [enum_label] respectively.
959 ** Added details to the OO-Browser Manual concerning the br-entry-info
960 command bound to {i} under Eiffel.
962 ---------------------------------------------------------------------------
965 * OO-Browser Multi-language Changes
967 ** Added Show-Inherited-Features toggle button to the OO-Browser Options
968 menu. This determines whether or not inherited features are shown
969 when listing class features. (The default is `on'.)
971 ** Adding a single class to an Environment with the br-add-class command
972 now properly adds its features too. Similarly, the br-delete command
973 deletes associated features.
975 ** X OO-Browser bug on some platforms that blackened the whole window after
976 drawing the tree may be eliminated on some platforms, but not all.
978 ** br-edit-feature is now more flexible, permitting separate specification of
979 class and feature name arguments.
981 ** Fixed br-find-file to never display a file in a browser listing window.
983 ** Eliminated unnecessary execution of mode-specific hooks when scanning
984 class files. For example, invocation of syntax highlighting could
985 slow down scanning dramatically.
987 ** Added BeOpen.com contact info to version/credit screen that
988 appears on startup or when using the {C-c #} command in the browser
989 to make it easy for people to get commercial support or custom
990 develpment for the OO-Browser.
994 ** Added support for multi-line virtual method declarations.
998 ** Attributes are now included as features of a class (you must rebuild
999 any existing Environment to have them included). They are prefaced
1000 with "= " when shown in a browser listing buffer.
1002 ** Array return values from methods are now handled properly by the
1005 ** Feature name completion now works properly, whenever the browser
1006 prompts for a feature name.
1008 ** Added support for .jav files for 3-character suffix impaired users.
1010 ** Cleaned up a number of areas of the code that were improperly carried
1011 over from the C++ OO-Browser.
1013 ** Removed support for threadsafe keyword since it has been deleted from
1014 the language specification.
1016 * Objective-C OO-Browser
1018 ** objc-feature-matches can now take a regular expression and return
1019 all matching features.
1023 ** Included support for the Python object-oriented scripting language.
1025 ---------------------------------------------------------------------------
1028 * Added man/br-design.texi to document the design rationale of the
1031 * Java: The OO-Browser now works on code with the new Java exception syntax:
1032 public Connection(String host, int port)
1033 throws UnknownHostException, InputOutputException {}
1035 * Fixed mouse key initialization bug.
1037 * C: Fixed bug in displaying structure or enum definitions.
1039 * Emacs 19: Fixed bug that caused OO-Browser menubar menu not to appear.
1041 * BR-README: Rewrote Installation / Configuration section.
1043 ---------------------------------------------------------------------------
1046 * {M-x br-report-bug RET} bound to {C-c C-b} in OO-Browser listing buffers
1047 can be used to send mail to the OO-Browser discussion list.
1049 * A number of significant bug fixes, including errors triggered when scanning
1050 source directories and encountering an unreadable file. See "ChangeLog".
1052 * .icc and .I C++ inline definition file suffixes are now supported.
1054 * Any time an Environment is built interactively, you are queried whether or
1055 not to build it in the background.
1057 * If you try to load an Environment which has not yet been built and you
1058 decide not to build it, then the load is aborted rather than prompting you
1059 for another Environment to load.
1061 ---------------------------------------------------------------------------
1064 * Standard OO-Browser invocation command renamed to `oo-browser' for clarity.
1065 `oobr' still exists for backward compatibility. Invocation is now much
1066 simpler and cleaner. You are always prompted for the Environment to
1067 browse, but if you hit {RET} immediately or if you give a prefix argument
1068 to the command, then you jump right into browsing the previous Environment.
1069 This eliminates the problem new users had in not knowing how to switch
1070 Environments. See "(oo-browser.info)Loading Environments".
1072 * {q} to quit from the OO-Browser now always puts the browser buffers at the
1073 bottom of the buffer list, as it should.
1075 * Subdirectories whose names are a single character long now are scanned
1078 * br-skip-dir-regexps and br-file-dir-regexp are now documented in the
1079 manual, see "(oo-browser.info)Customization".
1081 ---------------------------------------------------------------------------
1084 * Improved tree-x/Makefile support for building under UNIX System V.
1086 * Fixed bugs in Java Environment building.
1088 * Added Java Specifics section to the OO-Browser manual.
1089 ---------------------------------------------------------------------------
1090 VERSIONS 2.9.6 and 2.9.7
1092 * Added support for browsing Java code.
1094 * A number of bug fixes.
1095 ---------------------------------------------------------------------------
1096 VERSIONS 2.9.4 and 2.9.5
1098 * Eiffel: Added some new Eiffel V3 keywords.
1100 * Added information on the new oo-browser mailing list in the "BR-README"
1101 file. Also added menu items to subscribe to / unsubscribe from the list
1102 and to send mail to it.
1104 * CLOS: Changed language name to Lisp, since the browser is useful on
1107 ---------------------------------------------------------------------------
1110 * Environment files now contain the version of the OO-Browser which was used
1111 to build them. If the Environment file format is obsolete, the OO-Browser
1112 will automatically prompt you to rebuild it whenever you load it.
1114 * {C-c C-s} now properly saves Environment features, when the Environment is
1117 * The browser user interface will now display within a frame even if you have
1118 set the unsplittable frame property.
1120 * Eiffel: Fixed bug that prevented display of a feature from its listing
1121 entry when using {f}.
1122 ---------------------------------------------------------------------------
1125 * Added pulldown and popup menu support for Emacs 19.
1127 * `make install' now installs OO-Browser documentation in an Emacs tree.
1129 ---------------------------------------------------------------------------
1132 * C++/C/Objective-C:
1134 NOTE: You must rebuild any Objective-C Environments that you have
1135 built with earlier versions of the browser. If you want the
1136 new C default classes described below to appear in C++
1137 Environments, you must rebuild them, too.
1139 The OO-Browser now supports browsing the following C constructs
1140 within C++ and Objective-C Environments via default classes:
1142 DEFAULT CLASS C CONSTRUCT
1143 --------------------------------------
1144 [constant] #define constant
1145 [enumeration] enum {}
1146 [function] non-member function()
1147 [macro] #define macro()
1148 [structure] struct {}
1152 You may now define a C++ Environment which contains only C code.
1153 The above default classes are the only ones that will appear in such
1156 * C++: Added recognition of keywords, `mutable' and `explicit', newly added
1159 * Removed key binding of br-toggle-keep-viewed since this is little used and
1160 reused its key, {V}, for br-view-friend, which views the definition of a
1161 C++ friend declaration. This was mistakenly formerly bound to {M-v} which
1162 conflicted with a basic scrolling command.
1164 * C++: Recognition of new array operators, `operator new [] ()' and 'operator
1167 * The X OO-Browser can now be built on systems without the usleep system call
1168 (see oo-browser/tree-x/Makefile).
1170 * {M-e}, br-env-stats, now shows the names of any classes which are defined
1171 multiple times within the Environment, to help you eliminate duplicates.
1172 It also shows a list of undefined classes, those which are referenced,
1173 e.g. as parents of another class, but not defined within the Environment.
1175 ---------------------------------------------------------------------------
1178 * C++: See the C++ Specifics section of the OO-Browser manual for user
1179 documentation on all of these changes.
1181 * C++: friend declarations now appear in class feature listings, prefixed by
1182 `% '. {V} views the definition of a friend.
1184 * C++: pure virtual functions now appear in listings as `> func' instead of
1185 `func = 0'. Object creation and deletion functions appear as `+ func'
1186 instead of `- func'.
1188 * C++: Overloading of operator[] and operator() is now supported.
1190 * C++: Greatly speeded up feature listings by caching feature names.
1192 * C++: Expanded variety of complex declarations/definitions that the browser
1195 * Eiffel: Added full feature browsing as in other languages along with Eiffel
1198 ---------------------------------------------------------------------------
1201 * Added KEYWORDS: header to all *.el files, so the Emacs finder
1202 program, {C-h p}, can now include them in its indices for lookup.
1204 * C++: Added support for browsing pure virtual function interfaces declared
1205 within classes. Given a pure virtual function named, f, it appears as, f =
1206 0, in a browser listing buffer to distinguish it from a member definition.
1208 * C++: Improved scanning of a broader range of C++ definitions.
1210 * {C-u F} now works properly. It shows the signatures/tags of all features
1211 in the current listing buffer.
1213 * CLOS: Added proper support for &keywords in argument lists.
1215 * CLOS: All methods which do not contain any specialized parameters (those
1216 of a specific type) are considered members of the root CLOS class `t'.
1218 ---------------------------------------------------------------------------
1221 * Documented InfoDock/XEmacs menus in the manual.
1223 * Improved Makefile support for adding custom load-path entries.
1225 * Emacs 19 versions now run site-start.el when batch compiling files.
1227 ---------------------------------------------------------------------------
1230 * Added autoload comments so that autoloaded OO-Browser commands are
1231 automatically picked up under V19.
1233 * The default display of class features/elements, bound to {f}, now includes
1234 all inherited features. Use {M-0 f} to turn off display of inherited
1237 * Under XEmacs when mouse support is available, there is an OO-Browser
1238 pulldown menu and the same menu as a popup, bound to the right mouse button
1239 when in a browser listing buffer.
1241 * Instantiation of templates is handled well now, especially when a parent
1242 class is a template instantiation.
1244 * Action Key press on a C++ class feature declaration now properly jumps to
1247 ---------------------------------------------------------------------------
1248 VERSIONS 2.8.2 and 2.8.3
1250 * New version of the X OO-Browser with more reliable display updates after a
1251 node is collapsed and a color X resource file.
1253 * Support for C++ template class and method browsing.
1255 * Under C++, non-class functions are now found and added to the default
1256 [function] class for easy browsing. This includes both C and C++ functions.
1258 * Br-unique, {u}, and br-order, {o}, now work on all entry types, not just
1261 * New command, br-match-entries, bound to {M}. Permits filtering of the set
1262 of entries in a listing buffer. Under Emacs 19, you can still browse
1263 entries after filtering them. Emacs 18 doesn't permit this since each
1264 entry name is not necessarily unique.
1266 * Many bug fixes and many fewer invalid method tag matches under C++.
1268 * Much faster compilation of the OO-Browser Emacs Lisp source code since all
1269 files are compiled with one invocation of Emacs, rather than one per file.
1271 * Environment builds may now be done in the background. (You are prompted
1272 for whether to build in the background, each time you build an
1273 Environment. When the build finishes, you are asked if you would like to
1274 browse the built Environment.)
1276 * Eiffel 3 inheritance clause support.
1278 ---------------------------------------------------------------------------
1281 * Much faster C++ feature lookups. You *must* rebuild any C++ Environments
1282 built with earlier versions of the OO-Browser before trying to browse
1283 features within the Environment. Load such an Environment and use {C-c
1286 * XEmacs 19.12 mouse support.
1289 ---------------------------------------------------------------------------
1292 * Command and Key Binding Improvements
1294 ** Action Key press on an OO-Browser environment file named OOBR or
1295 OOBR-FTR, automatically determines the language of the Environment and
1296 loads it for browsing.
1298 ** Common Lisp and Emacs Lisp element browsing support added. Standard
1299 language element types are added as default classes to Environment, so
1300 one can browse functions, variables, methods and more. See
1301 "(oo-browser.info)CLOS Specifics" for details.
1303 ** The feature listing command, br-routines, previously bound to {r}, has
1304 been renamed br-features and bound to {f}. {f} used to run br-find; use
1305 {C-u e} (br-edit-entry) for that command instead. This makes the
1306 bindings of {f} and {F}, which lists feature signatures, more uniform.
1307 {r} still works for backwards compatibility in this release.
1309 ** {f} if applied to a single class for which there are no feature
1310 definitions within the Environment, displays the associated class
1311 definition so that you may browse its feature declarations. This
1312 improves browsing in Environments where you have only interface
1313 specifications, e.g. *.h files, but no source code.
1315 ** Fixed {I}, br-implementors command. Also, now an Action Key press on
1316 an implementor class shows the implemented element.
1318 ** {C} lists class categories. Presently only supported under Objective-C.
1319 {v} or {e} views or edits the class category definition.
1320 {I} shows the classes which implement a category.
1321 The [category] default class displays all Environment categories as its
1322 features. {v} or {e} then displays the associated category definition.
1324 ** {P} lists class protocols. Presently only supported under Objective-C.
1325 {v} or {e} views or edits the class definition which directly conforms
1327 {I} shows the classes which implement a protocol.
1328 The [protocol] default class displays all Environment protocols as its
1329 features. {v} or {e} then displays the associated protocol definition.
1332 * Graphical Browser Improvements
1334 ** Motif version of the X OO-Browser interface redone using the Athena
1335 toolkit, so that only free X libraries are required. Thanks to Torgeir
1336 Veimo for this conversion work.
1341 ** The browser will no longer scan SCCS revision subdirectories by default.
1343 ** Better support for the wide variety of C++ coding styles and file naming
1347 * User Manual Improvements
1349 ** Reorganized and renamed sections for clarity.
1353 *** "(oo-browser.info)Browsing Categories"
1354 *** "(oo-browser.info)Browsing Elements"
1355 *** "(oo-browser.info)Browsing Implementors"
1356 *** "(oo-browser.info)Browsing Protocols"
1358 ** Expanded glossary in user manual.
1361 * Installation Improvements
1363 ** Improved Makefile to support all common Emacs versions.
1365 ** More detailed installation notes in "BR-README".