001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.colorizer;
021    
022    import java.util.Arrays;
023    
024    public abstract class MultilinesDocTokenizer extends Tokenizer {
025    
026      private static final String COMMENT_STARTED_ON_PREVIOUS_LINE = "COMMENT_STARTED_ON_PREVIOUS_LINE";
027      private static final String COMMENT_TOKENIZER = "MULTILINE_COMMENT_TOKENIZER";
028      private final char[] startToken;
029    
030      public MultilinesDocTokenizer(String startToken, String tagBefore, String tagAfter) {
031        super(tagBefore, tagAfter);
032        this.startToken = startToken.toCharArray();
033      }
034    
035      public MultilinesDocTokenizer(String startToken) {
036        this("", "", startToken);
037      }
038    
039      @Override
040      public boolean hasNextToken(CodeReader code) {
041        return code.peek() != '\n' && code.peek() != '\r'
042            && (isCommentStartedOnPreviousLine(code) || (code.peek() == startToken[0] && Arrays.equals(code.peek(startToken.length), startToken)));
043      }
044    
045      @Override
046      public String nextToken(CodeReader code) {
047        return code.popTo(new MultilineEndTokenMatcher(code));
048      }
049    
050      private class MultilineEndTokenMatcher implements EndTokenMatcher {
051        CodeReader code;
052    
053        public MultilineEndTokenMatcher(CodeReader code) {
054          this.code = code;
055        }
056    
057        public boolean match(int endFlag) {
058          if (code.lastChar() == '/' && code.lastChar(1) == '*') {
059            setCommentStartedOnPreviousLine(code, Boolean.FALSE);
060            return true;
061          }
062          if (endFlag == '\r' || endFlag == '\n') {
063            setCommentStartedOnPreviousLine(code, Boolean.TRUE);
064            return true;
065          }
066          return false;
067        }
068      }
069    
070      private boolean isCommentStartedOnPreviousLine(CodeReader reader) {
071        Boolean b = (Boolean)reader.getVariable(COMMENT_STARTED_ON_PREVIOUS_LINE, Boolean.FALSE);
072        return (b == Boolean.TRUE) && (getTokenizerId().equals(reader.getVariable(COMMENT_TOKENIZER)));
073      }
074    
075      private void setCommentStartedOnPreviousLine(CodeReader reader, Boolean b) {
076        reader.setVariable(COMMENT_STARTED_ON_PREVIOUS_LINE, b);
077        reader.setVariable(COMMENT_TOKENIZER, b ? getTokenizerId() : null);
078      }
079    
080      private String getTokenizerId() {
081        return getClass().getSimpleName();
082      }
083    }