From: Alexander Kriegisch <Alexander@Kriegisch.name>
Date: Thu, 22 Feb 2024 03:20:45 +0000 (+0700)
Subject: Document AJC option '-xmlConfigured'
X-Git-Tag: V1_9_21_2~17
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=38e175b1575649d690a95994e1b5b812cec1cdda;p=aspectj.git

Document AJC option '-xmlConfigured'

- Add short description to AJC usage message via
  messages_aspectj.properties
- Add longer description to ajc.adoc in the AspectJ Development
  Environment Guide

Closes https://bugs.eclipse.org/bugs/show_bug.cgi?id=455014.

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
---

diff --git a/docs/devguide/ajc.adoc b/docs/devguide/ajc.adoc
index 5e47018e1..ea482aed6 100644
--- a/docs/devguide/ajc.adoc
+++ b/docs/devguide/ajc.adoc
@@ -82,8 +82,47 @@ destination directory on the inpath and rebuild.)
 `-sourceroots <DirPaths>`::
   Find and build all .java or .aj source files under any directory
   listed in DirPaths. DirPaths, like classpath, is a single argument
-  containing a list of paths to directories, delimited by the platform-
-  specific classpath delimiter. Required by -incremental.
+  containing a list of paths to directories, delimited by the platform-specific
+  classpath delimiter. Required by `-incremental`.
+`-xmlConfig <files>`::
+  Configure the weaving process, if you wish to impose non-standard limitations, e.g.
+  a list of aspects to use (if not all), global and per-aspect scopes for the weaver
+  (target packages and classes to exclude or include). This option also needs an .xml
+  file on the command line, optionally multiple ones to be logically merged into one
+  weaver configuration. Example:
++
+[source, xml]
+....
+<aspectj>
+  <!-- From all aspects found, only use the ones listed here -->
+  <aspects>
+    <!-- Only weave class org.acme.app.B -->
+    <aspect name="a.b.FooAspect" scope="org.acme.app.B"/>
+    <!-- Only weave classes in package orc.acme and its sub-packages -->
+    <aspect name="c.d.BarAspect" scope="orc.acme..*"/>
+    <!-- Weave all classes, unless globally excluded -->
+    <aspect name="e.f.ZotAspect"/>
+  </aspects>
+  <weaver>
+    <!-- Globally exclude classes in package org.acme.internal and its sub-packages from weaving -->
+    <exclude within="org.acme.internal..*"/>
+    <!-- This has **no effect**, use per-aspect scopes instead -->
+    <include within="com.xyz..*"/>
+  </weaver>
+</aspectj>
+....
+Please note that `-xmlConfigured` only supports a subset of options available to
+load-time weaving configuration by _aop.xml_. Current limitations include:
+  * There is **no magical file name** like _aop.xml_ for the load-time weaver,
+    i.e. an XML configuration file for the compiler needs to be listed explicitly
+    on the command line.
+  * Scopes and excludes only affect method interception pointcuts, not ITDs.
+    The latter will always be applied and are unaffected by XML configuration.
+  * There is no global `<include within="..."/>` (see example above).
+  * Lists in aspect scope expressions are not supported, i.e. an expression like
+    `scope="A,B,C"` will be treated like `scope="A"`, using only the first element.
+  * If you want to apply a scope to an aspect extending an abstract base aspect,
+    you need to list and scope both aspects in the XML file.
 `-crossrefs`::
   Generate a build .ajsym file into the output directory. Used for
   viewing crosscutting references by tools like the AspectJ Browser.
diff --git a/org.aspectj.ajdt.core/src/main/resources/org/aspectj/org/eclipse/jdt/internal/compiler/batch/messages_aspectj.properties b/org.aspectj.ajdt.core/src/main/resources/org/aspectj/org/eclipse/jdt/internal/compiler/batch/messages_aspectj.properties
index be66883e8..c1e9ad481 100644
--- a/org.aspectj.ajdt.core/src/main/resources/org/aspectj/org/eclipse/jdt/internal/compiler/batch/messages_aspectj.properties
+++ b/org.aspectj.ajdt.core/src/main/resources/org/aspectj/org/eclipse/jdt/internal/compiler/batch/messages_aspectj.properties
@@ -32,6 +32,8 @@ misc.usage.aspectj = AspectJ-specific options:\n\
 \                        (reads stdin: enter to recompile and ''q'' to quit)\n\
 \    -sourceroots <dirs> compile all .aj and .java files in <dirs>\n\
 \                        (<dirs> uses classpath delimiter)\n\
+\    -xmlConfig <files>  configure weaving process (aspects to use, aspect scopes, weaving targets)\n\
+\                        (<files> are usually one, optionally multiple .xml files)\n\
 \    -crossrefs          generate .ajsym file into the output directory\n\
 \    -emacssym           generate .ajesym symbol files for emacs support\n\
 \    -Xlint              same as ''-Xlint:warning''\n\