Release v1.1.0: Enhanced features and Java 11 compatibility

- Added dry-run mode (--dry-run, -n) for previewing operations
- Updated Java compatibility from 8 to 11 with modern build config
- Fixed Mercurial references, now using Git for version info
- Enhanced debug mode with detailed logging
- Improved build system with --release flag
- Updated NetBeans project configuration
- Fixed compiler warnings and version display
- Comprehensive changelog updates

Author: cm45t3r

CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2025-07-25
+
+### Added
+- **Dry-run mode** (`--dry-run`, `-n`) for previewing what will be processed
+- Java 11 compatibility with modern build configuration
+- Git integration for version information (replaces Mercurial)
+- Enhanced debug mode with detailed logging capabilities
+- JSON output format for programmatic consumption
+
+### Changed
+- Updated Java source level from 8 to 11 for better compatibility
+- Improved build system with `--release` flag instead of deprecated `-source`
+- Enhanced error handling and user feedback
+- Updated NetBeans project configuration for Java 11
+
+### Fixed
+- Mercurial references in build scripts (now uses Git)
+- Compiler warnings related to Java version configuration
+- Version information now properly displays Git commit ID
+- Build system compatibility with modern Java toolchains
+
+### Technical Debt
+- Some test failures due to missing resources (non-critical)
+- Minor unchecked operations warning in ProjectScanner.java
+
 ## [1.0.0] - 2025-01-25
 
 ### Added
@@ -82,6 +107,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **0.1-alpha**: Initial release with core functionality
 - **1.0.0**: Modernization and community improvements
+- **1.1.0**: Enhanced features and Java 11 compatibility
 - **Unreleased**: Future enhancements and features
 
 ## Migration Guide

README.md

@@ -44,19 +44,60 @@ This tool is particularly useful when:
 
 Get up and running in 5 minutes:
 
+### 1. Prerequisites
+- Java 8 or later installed
+- Git (for cloning the repository)
+
+### 2. Installation
 ```bash
 # Clone the repository
 git clone https://github.com/cm45t3r/jpf-autodoc-types.git
 cd jpf-autodoc-types
 
-# Build the project
+# Build the project (no external dependencies required)
 ./bin/ant build
+```
 
-# Run on a JPF project
+### 3. Basic Usage
+```bash
+# Analyze a JPF project (if registered in site.properties)
 ./bin/jpfadt jpf-core
 
-# Or analyze a specific directory
+# Analyze a specific directory
 ./bin/jpfadt /path/to/your/jpf/project/build
+
+# Analyze with verbose output
+./bin/jpfadt -v /path/to/your/project
+
+# Generate multiple output formats
+./bin/jpfadt --output-all /path/to/your/project
+```
+
+### 4. Output Formats
+The tool generates documentation in multiple formats:
+- **XML** (default): `jpf-types.xml`
+- **JSON**: `jpf-types.json` (for programmatic consumption)
+- **Markdown**: `jpf-types.md`
+- **Text**: `jpf-types.txt`
+- **Wiki**: `jpf-types.wiki`
+
+### 5. Example Output
+```bash
+# Run the tool
+./bin/jpfadt /path/to/jpf-core/build
+
+# Check the generated files
+ls -la jpf-types.*
+```
+
+### 6. Troubleshooting
+If you encounter issues:
+```bash
+# Enable debug mode for detailed information
+./bin/jpfadt --debug debug.log /path/to/your/project
+
+# Check the error summary at the end of execution
+# The tool will show skipped files and error details
 ```
 
 Navigate to root folder in order to build, run and execute tests:

build.xml

@@ -17,9 +17,10 @@
   <!-- ========================== COMMON SECTION ========================== -->
 
   <!-- compiler settings -->
-  <property name="src_level"     value="8"/>
+  <property name="src_level"     value="11"/>
   <property name="debug"         value="on"/>
   <property name="deprecation"   value="on"/>
+  <property name="release_level" value="11"/>
 
   <uptodate property="build_uptodate" targetfile="build.properties" srcfile="build.properties"/>
 
@@ -69,28 +70,28 @@
   <target name="-compile-annotations" if="have_annotations">
     <mkdir dir="build/annotations"/>
     <javac srcdir="src/annotations" destdir="build/annotations" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}" classpath=""/>
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}" classpath=""/>
   </target>
 
   <target name="-compile-main" if="have_main">
     <mkdir dir="build/main"/>
     <javac srcdir="src/main" destdir="build/main" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}"
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}"
            classpathref="lib.path"/>
 
   </target>
 
   <target name="-compile-peers" if="have_peers" depends="-compile-main" >
     <mkdir dir="build/peers"/>
     <javac srcdir="src/peers" destdir="build/peers" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}"
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}"
            classpathref="lib.path"/>
   </target>
 
   <target name="-compile-classes" if="have_classes" depends="-compile-annotations,-compile-main" >
     <mkdir dir="build/classes"/>
     <javac srcdir="src/classes" destdir="build/classes" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}">
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}">
       <classpath>
         <path refid="lib.path"/>
         <pathelement location="build/annotations"/>
@@ -101,7 +102,7 @@
   <target name="-compile-tests" if="have_tests" depends="-compile-annotations,-compile-main">
     <mkdir dir="build/tests"/>
     <javac srcdir="src/tests" destdir="build/tests" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}"
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}"
            includes="*,gov/nasa/jpf/**">
       <classpath>
         <path refid="lib.path"/>
@@ -113,7 +114,7 @@
   <target name="-compile-examples" if="have_examples" depends="-compile-annotations,-compile-main">
     <mkdir dir="build/examples" />
     <javac srcdir="src/examples" destdir="build/examples" includeantruntime="false"
-           debug="${debug}" source="${src_level}" deprecation="${deprecation}"
+           debug="${debug}" release="${release_level}" deprecation="${deprecation}"
            classpathref="lib.path"/>
   </target>
 
@@ -124,7 +125,7 @@
   <property name="system.name" value="JPF autodoc types"/>
   <property name="system.vendor" value="FLA/NASA Ames Research Center"/>
   <property name="system.release" value="stable"/>
-  <property name="major.version" value="1.0"/>
+  <property name="major.version" value="1.1.0"/>
 
   <!-- include all lib/*.jar for classpath -->
   <path id="lib.classpath">
@@ -288,7 +289,7 @@
       </not>
     </condition>
 
-    <junit printsummary="on" showoutput="off" haltonfailure="no" dir="${basedir}"
+    <junit printsummary="on" showoutput="on" haltonfailure="no" dir="${basedir}"
            fork="yes" forkmode="perTest" maxmemory="1024m" outputtoformatters="true">
       <formatter type="plain" usefile="${junit.usefile}"/>
 

nbproject/project.xml

@@ -118,13 +118,13 @@
             <compilation-unit>
                 <package-root>src/main</package-root>
                 <classpath mode="compile">lib/jpf.jar;lib/castor-1.3.2.jar;lib/castor-1.3.2-core.jar;lib/castor-1.3.2-xml.jar;lib/commons-lang-2.1.jar;lib/commons-logging-1.1.1.jar</classpath>
-                <source-level>1.6</source-level>
+                <source-level>11</source-level>
             </compilation-unit>
             <compilation-unit>
                 <package-root>src/tests</package-root>
                 <unit-tests/>
                 <classpath mode="compile">build/jpf-autodoc-types.jar;lib/jpf.jar;lib/junit-4.9.jar;lib/xmlunit-1.3.jar</classpath>
-                <source-level>1.6</source-level>
+                <source-level>11</source-level>
             </compilation-unit>
         </java-data>
         <preferences xmlns="http://www.netbeans.org/ns/auxiliary-configuration-preferences/1">

src/main/gov/nasa/jpf/autodoc/types/AutoDocTool.java

@@ -115,7 +115,9 @@ public enum Options {
     /** Enable automated scan output integrity check. */
     CHECK_DSCAN   (0x400000,  true,  "-cS,-check-scan,--check-scan"),
     /** Enable automated xml integrity check. */
-    CHECK_DXML    (0x800000,  true,  "-cX,-check-xml,--check-xml");
+    CHECK_DXML    (0x800000,  true,  "-cX,-check-xml,--check-xml"),
+    /** Enable dry-run mode to preview what will be processed. */
+    DRY_RUN       (0x1000000, false, "-n,--dry-run");
 
     private final int weight;
     private final boolean hasParam;
@@ -470,6 +472,22 @@ protected static void startScan(int options)
 
     int opts = (options & 0xF0) >> 0x4;
 
+    if (isOptionEnabled(options, Options.DRY_RUN.weight)) {
+      // Dry-run mode: just show what would be scanned
+      System.out.println("=== DRY RUN MODE ===");
+      System.out.println("Targets to scan:");
+      for (String target : targets) {
+        System.out.println("  - " + target);
+      }
+      System.out.println("Classpath:");
+      for (String cp : classpath) {
+        System.out.println("  - " + cp);
+      }
+      System.out.println("Scan type: " + scanner.getScanType(opts));
+      System.out.println("=== END DRY RUN ===");
+      return;
+    }
+    
     scanner.scan(targets, classpath, scanner.getScanType(opts));
     info.storeParsed(scanner.getScanned());
   }
@@ -482,6 +500,19 @@ protected static void startScan(int options)
    */
   protected static void startAnalyses(int options) 
           throws ClassFileNotFoundException {
+    if (isOptionEnabled(options, Options.DRY_RUN.weight)) {
+      // Dry-run mode: just show what would be analyzed
+      System.out.println("=== DRY RUN MODE - ANALYSIS ===");
+      System.out.println("Analysis options:");
+      int opts = options & 0xF;
+      if ((opts & 0x1) != 0) System.out.println("  - Listeners");
+      if ((opts & 0x2) != 0) System.out.println("  - Instruction Factories");
+      if ((opts & 0x4) != 0) System.out.println("  - Model Classes");
+      if ((opts & 0x8) != 0) System.out.println("  - Native Peer Classes");
+      System.out.println("=== END DRY RUN ===");
+      return;
+    }
+    
     trigger.addModelPath(System.getProperty("sun.boot.class.path"));
 
     trigger.addTypePaths(config.getPropertyVals(
@@ -522,6 +553,22 @@ public boolean accept(File dir, String name) {
   public static void checkOutputOpts(String[] args, int options) 
          throws IOException, MappingException, MarshalException, 
          ValidationException {
+    // Handle dry-run mode for output
+    if (isOptionEnabled(options, Options.DRY_RUN.weight)) {
+      System.out.println("=== DRY RUN MODE - OUTPUT ===");
+      System.out.println("Output options:");
+      if (isOptionEnabled(options, Options.OUT_LEVEL1.weight)) System.out.println("  - Verbosity Level 1");
+      if (isOptionEnabled(options, Options.OUT_LEVEL2.weight)) System.out.println("  - Verbosity Level 2");
+      if (isOptionEnabled(options, Options.TEXTFILE.weight)) System.out.println("  - Text file output");
+      if (isOptionEnabled(options, Options.XML.weight)) System.out.println("  - XML file output");
+      if (isOptionEnabled(options, Options.WIKI.weight)) System.out.println("  - Wiki file output");
+      if (isOptionEnabled(options, Options.MARKDOWN.weight)) System.out.println("  - Markdown file output");
+      if (isOptionEnabled(options, Options.JSON.weight)) System.out.println("  - JSON file output");
+      if (isOptionEnabled(options, Options.OUTPUT_ALL.weight)) System.out.println("  - All output formats");
+      System.out.println("=== END DRY RUN ===");
+      return;
+    }
+    
     String debug = new String();
     String debugFile = new String();
 
@@ -919,6 +966,7 @@ public static void showUsage() {
     console.writeln("  -d | -debug | --debug [<file>] : enable debug mode with "
                     + "detailed logging. | ");
     console.writeln("  -dS | -debug-scan | --debug-scan [<file>] : enable debug "
-                    + "mode for scan operations.");
+                    + "mode for scan operations. | ");
+    console.writeln("  -n | --dry-run : enable dry-run mode to preview what will be processed.");
   }
 }