Home » openjdk-7 » com.sun.tools » javac » parser » [javadoc | source]

com.sun.tools.javac.parser
public class: DocCommentScanner [javadoc | source]

java.lang.Object
   com.sun.tools.javac.parser.Scanner
      com.sun.tools.javac.parser.DocCommentScanner

All Implemented Interfaces:
    Lexer

An extension to the base lexical analyzer that captures and processes the contents of doc comments. It does so by translating Unicode escape sequences and by stripping the leading whitespace and starts from each line of the comment.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Fields inherited from com.sun.tools.javac.parser.Scanner:
deprecatedFlag,  surrogatesSupported

Constructor:
protected DocCommentScanner(ScannerFactory fac, CharBuffer buffer) { super(fac, buffer); } Create a scanner from the input buffer. buffer must implement array() and compact(), and remaining() must be less than limit().
protected DocCommentScanner(ScannerFactory fac, char[] input, int inputLength) { super(fac, input, inputLength); } Create a scanner from the input array. The array must have at least a single character of extra space.

Method from com.sun.tools.javac.parser.DocCommentScanner Summary:
docComment,   getLineMap,   nextToken,   processComment

Methods from com.sun.tools.javac.parser.Scanner:
deprecatedFlag,   docComment,   endPos,   errPos,   errPos,   getLineMap,   getRawCharacters,   getRawCharacters,   name,   nextToken,   pos,   prevEndPos,   processComment,   processLineTerminator,   processWhiteSpace,   radix,   resetDeprecatedFlag,   stringVal,   token,   token

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from com.sun.tools.javac.parser.DocCommentScanner Detail:
public String docComment() { return docComment; } Returns the documentation string of the current token.
public LineMap getLineMap() { char[] buf = getRawCharacters(); return Position.makeLineMap(buf, buf.length, true); } Build a map for translating between line numbers and positions in the input.
public void nextToken() { docComment = null; super.nextToken(); }
protected void processComment(CommentStyle style) { if (style != CommentStyle.JAVADOC) { return; } pos = pos(); buf = getRawCharacters(pos, endPos()); buflen = buf.length; bp = 0; col = 0; docCommentCount = 0; boolean firstLine = true; // Skip over first slash scanDocCommentChar(); // Skip over first star scanDocCommentChar(); // consume any number of stars while (bp < buflen && ch == '*') { scanDocCommentChar(); } // is the comment in the form /**/, /***/, /****/, etc. ? if (bp < buflen && ch == '/') { docComment = ""; return; } // skip a newline on the first line of the comment. if (bp < buflen) { if (ch == LF) { scanDocCommentChar(); firstLine = false; } else if (ch == CR) { scanDocCommentChar(); if (ch == LF) { scanDocCommentChar(); firstLine = false; } } } outerLoop: // The outerLoop processes the doc comment, looping once // for each line. For each line, it first strips off // whitespace, then it consumes any stars, then it // puts the rest of the line into our buffer. while (bp < buflen) { // The wsLoop consumes whitespace from the beginning // of each line. wsLoop: while (bp < buflen) { switch(ch) { case ' ': scanDocCommentChar(); break; case '\t': col = ((col - 1) / TabInc * TabInc) + TabInc; scanDocCommentChar(); break; case FF: col = 0; scanDocCommentChar(); break; // Treat newline at beginning of line (blank line, no star) // as comment text. Old Javadoc compatibility requires this. /*---------------------------------* case CR: // (Spec 3.4) scanDocCommentChar(); if (ch == LF) { col = 0; scanDocCommentChar(); } break; case LF: // (Spec 3.4) scanDocCommentChar(); break; *---------------------------------*/ default: // we've seen something that isn't whitespace; // jump out. break wsLoop; } } // Are there stars here? If so, consume them all // and check for the end of comment. if (ch == '*') { // skip all of the stars do { scanDocCommentChar(); } while (ch == '*'); // check for the closing slash. if (ch == '/') { // We're done with the doc comment // scanChar() and breakout. break outerLoop; } } else if (! firstLine) { //The current line does not begin with a '*' so we will indent it. for (int i = 1; i < col; i++) { if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = ' '; } } // The textLoop processes the rest of the characters // on the line, adding them to our buffer. textLoop: while (bp < buflen) { switch (ch) { case '*': // Is this just a star? Or is this the // end of a comment? scanDocCommentChar(); if (ch == '/') { // This is the end of the comment, // set ch and return our buffer. break outerLoop; } // This is just an ordinary star. Add it to // the buffer. if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = '*'; break; case ' ': case '\t': if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = ch; scanDocCommentChar(); break; case FF: scanDocCommentChar(); break textLoop; // treat as end of line case CR: // (Spec 3.4) scanDocCommentChar(); if (ch != LF) { // Canonicalize CR-only line terminator to LF if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = (char)LF; break textLoop; } /* fall through to LF case */ case LF: // (Spec 3.4) // We've seen a newline. Add it to our // buffer and break out of this loop, // starting fresh on a new line. if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = ch; scanDocCommentChar(); break textLoop; default: // Add the character to our buffer. if (docCommentCount == docCommentBuffer.length) expandCommentBuffer(); docCommentBuffer[docCommentCount++] = ch; scanDocCommentChar(); } } // end textLoop firstLine = false; } // end outerLoop if (docCommentCount > 0) { int i = docCommentCount - 1; trailLoop: while (i > -1) { switch (docCommentBuffer[i]) { case '*': i--; break; default: break trailLoop; } } docCommentCount = i + 1; // Store the text of the doc comment docComment = new String(docCommentBuffer, 0 , docCommentCount); } else { docComment = ""; } } Process a doc comment and make the string content available. Strips leading whitespace and stars.