8305100: [REDO] Clean up JavadocTokenizer

Reviewed-by: jjg

Author: Jim Laskey

src/jdk.compiler/share/classes/com/sun/tools/javac/parser/JavaTokenizer.java

@@ -307,15 +307,6 @@ protected boolean acceptOneOfThenPut(char ch1, char ch2) {
         return false;
     }
 
-    /**
-     * Test if the current character is a line terminator.
-     *
-     * @return true if current character is a line terminator.
-     */
-    private boolean isEOLN() {
-        return isOneOf('\n', '\r');
-    }
-
     /**
      * Skip and process a line terminator sequence.
      */
@@ -1094,7 +1085,7 @@ public Token readToken() {
             if (scannerDebug) {
                     System.out.println("nextToken(" + pos
                                        + "," + endPos + ")=|" +
-                                       new String(getRawCharacters(pos, endPos))
+                                       getRawString(pos, endPos)
                                        + "|");
             }
         }
@@ -1146,13 +1137,11 @@ protected Tokens.Comment processComment(int pos, int endPos, CommentStyle style)
         if (scannerDebug) {
             System.out.println("processComment(" + pos
                                 + "," + endPos + "," + style + ")=|"
-                                + new String(getRawCharacters(pos, endPos))
+                                + getRawString(pos, endPos)
                                 + "|");
         }
 
-        char[] buf = getRawCharacters(pos, endPos);
-
-        return new BasicComment(style, fac, buf, pos);
+        return new BasicComment(style,this, pos, endPos);
     }
 
     /**
@@ -1167,8 +1156,8 @@ protected Tokens.Comment processComment(int pos, int endPos, CommentStyle style)
     protected void processWhiteSpace(int pos, int endPos) {
         if (scannerDebug) {
             System.out.println("processWhitespace(" + pos
-                                + "," + endPos + ")=|" +
-                                new String(getRawCharacters(pos, endPos))
+                                + "," + endPos + ")=|"
+                                + getRawString(pos, endPos)
                                 + "|");
         }
     }
@@ -1182,8 +1171,8 @@ protected void processWhiteSpace(int pos, int endPos) {
     protected void processLineTerminator(int pos, int endPos) {
         if (scannerDebug) {
             System.out.println("processTerminator(" + pos
-                                + "," + endPos + ")=|" +
-                                new String(getRawCharacters(pos, endPos))
+                                + "," + endPos + ")=|"
+                                + getRawString(pos, endPos)
                                 + "|");
         }
     }
@@ -1206,9 +1195,6 @@ public Position.LineMap getLineMap() {
     protected static class BasicComment extends PositionTrackingReader implements Comment {
         /**
          * Style of comment
-         *   LINE starting with //
-         *   BLOCK starting with /*
-         *   JAVADOC starting with /**
          */
         CommentStyle cs;
 
@@ -1225,13 +1211,13 @@ protected static class BasicComment extends PositionTrackingReader implements Co
         /**
          * Constructor.
          *
-         * @param cs      comment style
-         * @param sf      Scan factory.
-         * @param array   Array containing contents of source.
-         * @param offset  Position offset in original source buffer.
+         * @param cs     comment style
+         * @param reader existing reader
+         * @param pos    start of meaningful content in buffer.
+         * @param endPos end of meaningful content in buffer.
          */
-        protected BasicComment(CommentStyle cs, ScannerFactory sf, char[] array, int offset) {
-            super(sf, array, offset);
+        protected BasicComment(CommentStyle cs, UnicodeReader reader, int pos, int endPos) {
+            super(reader, pos, endPos);
             this.cs = cs;
         }
 
@@ -1247,8 +1233,7 @@ public String getText() {
         /**
          * Return buffer position in original buffer mapped from buffer position in comment.
          *
-         * @param pos  buffer position in comment.
-         *
+         * @param pos buffer position in comment.
          * @return buffer position in original buffer.
          */
         public int getSourcePos(int pos) {
@@ -1257,11 +1242,8 @@ public int getSourcePos(int pos) {
 
         /**
          * Return style of comment.
-         *   LINE starting with //
-         *   BLOCK starting with /*
-         *   JAVADOC starting with /**
          *
-         * @return
+         * @return style of comment.
          */
         public CommentStyle getStyle() {
             return cs;
@@ -1273,76 +1255,110 @@ public CommentStyle getStyle() {
          * @return true if comment contains @deprecated.
          */
         public boolean isDeprecated() {
-            if (!scanned && cs == CommentStyle.JAVADOC) {
+            if (!scanned) {
                 scanDocComment();
             }
-
             return deprecatedFlag;
         }
 
         /**
-         * Scan JAVADOC comment for details.
+         * Remove closing star(s) slash from comment.
+         *
+         * @param line line reader
+         *
+         * @return new line reader if detected otherwise original line reader.
          */
-        protected void scanDocComment() {
-            try {
-                boolean deprecatedPrefix = false;
-                accept("/**");
+        UnicodeReader trimEndOfComment(UnicodeReader line) {
+            int pos = line.position();
+            boolean allWhitespace = true;
 
-                forEachLine:
-                while (isAvailable()) {
-                    // Skip optional WhiteSpace at beginning of line
-                    skipWhitespace();
+            while (line.isAvailable()) {
+                int endPos = line.position();
 
-                    // Skip optional consecutive Stars
-                    while (accept('*')) {
-                        if (is('/')) {
-                            return;
-                        }
-                    }
+                if (line.skip('*') != 0 && line.is('/')) {
+                    return line.lineReader(allWhitespace ? endPos : pos, endPos);
+                } else {
+                    allWhitespace = allWhitespace && line.isWhitespace();
+                    line.next();
+                }
+            }
 
-                    // Skip optional WhiteSpace after Stars
-                    skipWhitespace();
+            line.reset(pos);
 
-                    // At beginning of line in the JavaDoc sense.
-                    deprecatedPrefix = deprecatedFlag || accept("@deprecated");
+            return line;
+        }
 
-                    if (deprecatedPrefix && isAvailable()) {
-                        if (Character.isWhitespace(get())) {
-                            deprecatedFlag = true;
-                        } else if (accept('*')) {
-                            if (is('/')) {
-                                deprecatedFlag = true;
-                                return;
-                            }
-                        }
-                    }
+        /**
+         * Trim the first part of the JavaDoc comment.
+         *
+         * @param line line reader
+         *
+         * @return modified line reader
+         */
+        UnicodeReader trimJavadocComment(UnicodeReader line) {
+            line = trimEndOfComment(line);
+            int pos = line.position();
+            line.skipWhitespace();
 
-                    // Skip rest of line
-                    while (isAvailable()) {
-                        switch (get()) {
-                            case '*':
-                                next();
+            if (!line.isAvailable()) {
+                return line;
+            }
 
-                                if (is('/')) {
-                                    return;
-                                }
+            if (line.skip('*') == 0) {
+                line.reset(pos);
+            }
 
-                                break;
-                            case '\r': // (Spec 3.4)
-                            case '\n': // (Spec 3.4)
-                                accept('\r');
-                                accept('\n');
-                                continue forEachLine;
+            return line;
+        }
 
-                            default:
-                                next();
-                                break;
-                        }
-                    } // rest of line
-                } // forEachLine
-                return;
-            } finally {
+        /**
+         * Put the line into the buffer.
+         *
+         * @param line line reader
+         */
+        protected void putLine(UnicodeReader line) {
+            // ignore, overridden in subclass
+        }
+
+        /**
+         * Scan document comment for content.
+         */
+        protected void scanDocComment() {
+            if (!scanned) {
+                deprecatedFlag = false;
                 scanned = true;
+
+                if (!accept("/**")) {
+                    return;
+                }
+
+                skip('*');
+                skipWhitespace();
+
+                if (isEOLN()) {
+                    accept('\r');
+                    accept('\n');
+                }
+
+                while (isAvailable()) {
+                    UnicodeReader line = lineReader();
+                    line = trimJavadocComment(line);
+
+                    // If standalone @deprecated tag
+                    int pos = line.position();
+                    line.skipWhitespace();
+
+                    if (line.accept("@deprecated") &&
+                            (!line.isAvailable() ||
+                                    line.isWhitespace() ||
+                                    line.isEOLN() ||
+                                    line.get() == EOI)) {
+                        deprecatedFlag = true;
+                    }
+
+                    line.reset(pos);
+                    putLine(line);
+                }
             }
         }
     }