platform/lang-api/src/com/intellij/psi/LiteralTextEscaper.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   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
  17 package com.intellij.psi;
  18
  19 import com.intellij.openapi.util.TextRange;
  20 import org.jetbrains.annotations.NotNull;
  21
  22 /**
  23  * @author cdr
  24 */
  25 public abstract class LiteralTextEscaper<T extends PsiLanguageInjectionHost> {
  26   protected final T myHost;
  27
  28   protected LiteralTextEscaper(@NotNull T host) {
  29     myHost = host;
  30   }
  31
  32   public abstract boolean decode(@NotNull TextRange rangeInsideHost, @NotNull StringBuilder outChars);
  33
  34   /**
  35    * @param offsetInDecoded offset in the parsed injected file
  36    * @param rangeInsideHost
  37    * @return offset in the host PSI element, or -1 if offset is out of host range
  38    */
  39   public abstract int getOffsetInHost(int offsetInDecoded, @NotNull TextRange rangeInsideHost);
  40
  41   @NotNull
  42   public TextRange getRelevantTextRange() {
  43     return TextRange.from(0, myHost.getTextLength());
  44   }
  45
  46   public abstract boolean isOneLine();
  47
  48 }