plugins/InspectionGadgets/src/com/siyeh/ig/portability/HardcodedLineSeparatorsInspection.java

   1 /*
   2  * Copyright 2003-2007 Dave Griffith, Bas Leijdekkers
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.siyeh.ig.portability;
  17
  18 import com.intellij.psi.PsiLiteralExpression;
  19 import com.intellij.psi.PsiType;
  20 import com.siyeh.InspectionGadgetsBundle;
  21 import com.siyeh.ig.BaseInspection;
  22 import com.siyeh.ig.BaseInspectionVisitor;
  23 import com.siyeh.ig.psiutils.TypeUtils;
  24 import org.jetbrains.annotations.NotNull;
  25
  26 public class HardcodedLineSeparatorsInspection extends BaseInspection {
  27
  28     @NotNull
  29     public String getDisplayName() {
  30         return InspectionGadgetsBundle.message(
  31                 "hardcoded.line.separator.display.name");
  32     }
  33
  34     @NotNull
  35     public String getID(){
  36         return "HardcodedLineSeparator";
  37     }
  38
  39     @NotNull
  40     public String buildErrorString(Object... infos) {
  41         return InspectionGadgetsBundle.message(
  42                 "hardcoded.line.separator.problem.descriptor");
  43     }
  44
  45     public BaseInspectionVisitor buildVisitor() {
  46         return new HardcodedLineSeparatorsVisitor();
  47     }
  48
  49     private static class HardcodedLineSeparatorsVisitor
  50             extends BaseInspectionVisitor {
  51
  52         private static final char NEW_LINE_CHAR = '\n';
  53         private static final char RETURN_CHAR = '\r';
  54
  55         @Override public void visitLiteralExpression(
  56                 @NotNull PsiLiteralExpression expression) {
  57             super.visitLiteralExpression(expression);
  58             final PsiType type = expression.getType();
  59             if (type == null) {
  60                 return;
  61             }
  62             if (TypeUtils.isJavaLangString(type)) {
  63                 final String value = (String) expression.getValue();
  64                 if (value == null) {
  65                     return;
  66                 }
  67                 if (value.indexOf(NEW_LINE_CHAR) >= 0 ||
  68                         value.indexOf(RETURN_CHAR) >= 0) {
  69                     registerError(expression);
  70                 }
  71             } else if (type.equals(PsiType.CHAR)) {
  72                 final Character value = (Character) expression.getValue();
  73                 if (value == null) {
  74                     return;
  75                 }
  76                 final char unboxedValue = value.charValue();
  77                 if (unboxedValue == NEW_LINE_CHAR
  78                         || unboxedValue == RETURN_CHAR) {
  79                     registerError(expression);
  80                 }
  81             }
  82         }
  83     }
  84 }