• Compile spacewar.

• Change into the spacewar directory.

• Type emacs Ship.java.

• Pull down the JDEE menu and select the Speedbar entry to show the AspectJ files in the directory. Note that Ship.java is shown in red to denote that it is currently shown in the main buffer.

• Double-click with the left mouse button on the + in front of the Ship.java entry. It should display an entry for the class Ship.

• Double-clicking on Ship will navigate to its declaration in the buffer. Note that declarations of advice are annotated to note the types of objects that they advise, declarations of methods that are advised are annotated with the aspects that advise them, and so forth.

• Double-clicking on the + in front of either will show the declared fields, methods, inter-type declarations, and advice. A + in front of any field or method means that it is introduced or advised; double-clicking will list entries for the introducers/advisers; double-clicking on them will navigate to their declarations. A + in front of any inter-type declarations or advice will will display its targets.

Installation and Compatibility

AJDEE requires the installation of JDEE 2.2.9beta4 or higher and small edits to your .emacs file to configure AJDEE and enable autoloading AJDEE when a .java file is loaded.

Installation for enhancement of JDEE mode

The first and last steps, with enhancements, can be found in the example Emacs initialization file sample.emacs and the sample JDEE project file sample.prj in the distribution. The latter also demonstrates a way to enable AspectJ mode on a per-project basis.

1. Make sure AJDEE , aspectj-mode, JDE, and supporting packages are on your load-path and are ``required''. This is an example for the 1.0 release:

       	  ;; I keep my emacs packages in C:/Emacs
       	  (setq load-path
       	  (append
   	   '(
   	    "C:/Emacs/aspectj-emacsMode-1.0"	; for AJDEE 
   	    "C:/Emacs/aspectj-emacsAJDEE -1.0"
   	    "C:/Emacs/jde-2.2.9beta6/lisp"
   	    "C:/Emacs/elib-1.0"			; for JDEE 
   	    "C:/Emacs/speedbar-0.14beta2"	; for JDEE 
   	    "C:/Emacs/semantic-1.4beta12"	; for JDEE /speedbar
   	    "C:/Emacs/eieio-0.17beta3"		; for JDEE 
   	    )
   	   load-path))
   
       	  (require 'jde)
       	  (require 'ajdee) ; can also appear in prj.el

2. [Optional] add -emacssym switch to the ajc and ajc.bat files in your AspectJ tools installations (in the /bin directory). If you invoke the compiler outside Emacs, this will ensure that your compiles always generate information for annotations and the jump menu in the form of .ajesym files.

3. Customize AJDEE 's compile options by putting a version of the following in your .emacs file or in a JDEE project file prj.el in your project's hierarchy (see the JDEE Project File Name option for the latter). Here is a simple example:

       	  ;; A default version for simple projects, maybe good for
       	  ;;; .emacs file.
       	  (custom-set-variables
       	  '(jde-compiler '("ajc" "ajc"))
       	  '(jde-javadoc-command-path "ajdoc")
   
       	  ;; ajc requires all files to be named for a compile
       	  '(aspectj-compile-file-specification "*.java"))

   Here is an example for spacewar, in examples/spacewar.

       	  ;;; These options are for the spacewar, in examples/spacewar.
       	  (custom-set-variables
       	  '(jde-compiler '("ajc" "ajc"))
       	  '(jde-javadoc-command-path "ajdoc")
   
       	  ;; ajc provides an ``argfile'' mechanism for specifying all files.
       	  '(aspectj-compile-file-specification "-argfile demo.lst")
   
       	  ;; *if* compiling packages, name root dir for package hierarchy
       	  ;; to tell ajc where .class files should go.
       	  '(jde-compile-option-directory "..")
       	  '(jde-run-working-directory ".."))
       	  '(jde-run-application-class "spacewar.Game")

4. [XEmacs only] If you're installing JDE yourself, be sure to closely follow the JDEE installation directions for XEmacs, otherwise you may get out of date JDE .jar files.

• Symptom: Get standard speedbar menus in JDE; no annotations display. Message:

  AspectJ Mode Warning: Can't find declarations file for...
  

  AspectJ file has not been compiled with ajc and the -emacssym flag, or was compiled with an obsolete version of ajc. After compilation, there should be a <file>.ajesym for every <file>.java in the build. If .ajsym files are present but error persists, recompile. Note that aspectj-mode for JDEE has a fallback view for uncompiled files.

• Symptom: Navigations via the speedbar and the jump menu are off, annotations are misplaced in the code.

  AspectJ mode operates by querying data derived from the most recent compile that includes the -emacssym flag. Recompile the entire program with ajc including the switch. Consider permanently installing the switch by editing the ajc and ajc.bat files in the /bin file in your distribution.

• Symptom: Java files that are part of a Java project not written in AspectJ come up in aspectj-mode.

  Emacs uses the file suffix (.java) to determine which mode to invoke. You can either globally toggle the AspectJ features from the AspectJ menu, or you can prevent AJDEE from coming up by moving the (require 'ajdee) expression from your .emacs file to a prj.el file in each AspectJ project's directory (see sample.prj in the distribution).

• Symptom: Reported bug fixes and new features to AJDEE are not seen, or ajdee.el cannot be found or loaded, with message:

  Error in init file: File error: "Cannot open load file", "ajdee"
  

  Your load-path variable (set in your .emacs) is referring to an old release. Change your load-path to point at the directory for the current release. See the sample.emacs files in the distribution, for example.