source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube, open source software quality management tool.
   3  * Copyright (C) 2008-2014 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * SonarQube is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * SonarQube is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.api.batch.sensor.highlighting.internal;
  21
  22 import com.google.common.base.Preconditions;
  23 import java.util.ArrayList;
  24 import java.util.Collections;
  25 import java.util.Comparator;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import org.sonar.api.batch.fs.InputFile;
  29 import org.sonar.api.batch.fs.TextRange;
  30 import org.sonar.api.batch.fs.internal.DefaultInputFile;
  31 import org.sonar.api.batch.sensor.highlighting.NewHighlighting;
  32 import org.sonar.api.batch.sensor.highlighting.TypeOfText;
  33 import org.sonar.api.batch.sensor.internal.DefaultStorable;
  34 import org.sonar.api.batch.sensor.internal.SensorStorage;
  35
  36 public class DefaultHighlighting extends DefaultStorable implements NewHighlighting {
  37
  38   private final List<SyntaxHighlightingRule> syntaxHighlightingRules;
  39   private DefaultInputFile inputFile;
  40
  41   public DefaultHighlighting(SensorStorage storage) {
  42     super(storage);
  43     syntaxHighlightingRules = new ArrayList<>();
  44   }
  45
  46   public List<SyntaxHighlightingRule> getSyntaxHighlightingRuleSet() {
  47     return syntaxHighlightingRules;
  48   }
  49
  50   private void checkOverlappingBoudaries() {
  51     if (syntaxHighlightingRules.size() > 1) {
  52       Iterator<SyntaxHighlightingRule> it = syntaxHighlightingRules.iterator();
  53       SyntaxHighlightingRule previous = it.next();
  54       while (it.hasNext()) {
  55         SyntaxHighlightingRule current = it.next();
  56         if (previous.range().end().compareTo(current.range().start()) > 0 && (previous.range().end().compareTo(current.range().end()) < 0)) {
  57           String errorMsg = String.format("Cannot register highlighting rule for characters at %s as it " +
  58             "overlaps at least one existing rule", current.range());
  59           throw new IllegalStateException(errorMsg);
  60         }
  61         previous = current;
  62       }
  63     }
  64   }
  65
  66   @Override
  67   public DefaultHighlighting onFile(InputFile inputFile) {
  68     Preconditions.checkNotNull(inputFile, "file can't be null");
  69     this.inputFile = (DefaultInputFile) inputFile;
  70     return this;
  71   }
  72
  73   public InputFile inputFile() {
  74     return inputFile;
  75   }
  76
  77   @Override
  78   public DefaultHighlighting highlight(int startOffset, int endOffset, TypeOfText typeOfText) {
  79     Preconditions.checkState(inputFile != null, "Call onFile() first");
  80     TextRange newRange;
  81     try {
  82       newRange = inputFile.newRange(startOffset, endOffset);
  83     } catch (Exception e) {
  84       throw new IllegalArgumentException("Unable to highlight file " + inputFile + " from offset " + startOffset + " to offset " + endOffset, e);
  85     }
  86     SyntaxHighlightingRule syntaxHighlightingRule = SyntaxHighlightingRule.create(newRange, typeOfText);
  87     this.syntaxHighlightingRules.add(syntaxHighlightingRule);
  88     return this;
  89   }
  90
  91   @Override
  92   protected void doSave() {
  93     Preconditions.checkState(inputFile != null, "Call onFile() first");
  94     // Sort rules to avoid variation during consecutive runs
  95     Collections.sort(syntaxHighlightingRules, new Comparator<SyntaxHighlightingRule>() {
  96       @Override
  97       public int compare(SyntaxHighlightingRule left, SyntaxHighlightingRule right) {
  98         int result = left.range().start().compareTo(right.range().start());
  99         if (result == 0) {
 100           result = right.range().end().compareTo(left.range().end());
 101         }
 102         return result;
 103       }
 104     });
 105     checkOverlappingBoudaries();
 106     storage.store(this);
 107   }
 108 }