plugins/properties/testSrc/com/intellij/lang/properties/PropertiesLexerTest.java

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.lang.properties;

import com.intellij.lang.properties.parsing.PropertiesLexer;
import com.intellij.lexer.Lexer;
import com.intellij.testFramework.LightPlatformTestCase;
import com.intellij.testFramework.PlatformTestCase;
import org.jetbrains.annotations.NonNls;

/**
 * @author max
 */
public class PropertiesLexerTest extends LightPlatformTestCase {

  public PropertiesLexerTest() {
    PlatformTestCase.initPlatformLangPrefix();    
  }

  private static void doTest(@NonNls String text, @NonNls String[] expectedTokens) {
    Lexer lexer = new PropertiesLexer();
    doTest(text, expectedTokens, lexer);
  }

  private static void doTestHL(@NonNls String text, @NonNls String[] expectedTokens) {
    Lexer lexer = new PropertiesHighlightingLexer();
    doTest(text, expectedTokens, lexer);
  }

  private static void doTest(String text, String[] expectedTokens,Lexer lexer) {
    lexer.start(text);
    int idx = 0;
    while (lexer.getTokenType() != null) {
      if (idx >= expectedTokens.length) fail("Too many tokens");
      String tokenName = lexer.getTokenType().toString();
      String expectedTokenType = expectedTokens[idx++];
      String expectedTokenText = expectedTokens[idx++];
      assertEquals(expectedTokenType, tokenName);
      String tokenText = lexer.getBufferSequence().subSequence(lexer.getTokenStart(), lexer.getTokenEnd()).toString();
      assertEquals(expectedTokenText, tokenText);
      lexer.advance();
    }

    if (idx < expectedTokens.length) fail("Not enough tokens");
  }

  public void testSimple() throws Exception {
    doTest("xxx=yyy", new String[]{
      "Properties:KEY_CHARACTERS", "xxx",
      "Properties:KEY_VALUE_SEPARATOR", "=",
      "Properties:VALUE_CHARACTERS", "yyy",
    });
  }

  public void testTwoWords() throws Exception {
    doTest("xxx=yyy zzz", new String[]{
      "Properties:KEY_CHARACTERS", "xxx",
      "Properties:KEY_VALUE_SEPARATOR", "=",
      "Properties:VALUE_CHARACTERS", "yyy zzz",
    });
  }

  public void testMulti() throws Exception {
    doTest("a  b\n \nx\ty", new String[]{
      "Properties:KEY_CHARACTERS", "a",
      "Properties:KEY_VALUE_SEPARATOR", "  ",
      "Properties:VALUE_CHARACTERS", "b",
      "WHITE_SPACE", "\n \n",
      "Properties:KEY_CHARACTERS", "x",
      "Properties:KEY_VALUE_SEPARATOR", "\t",
      "Properties:VALUE_CHARACTERS", "y"
    });
  }

  public void testIncompleteProperty() throws Exception {
    doTest("a", new String[]{
      "Properties:KEY_CHARACTERS", "a"
    });
  }

  public void testIncompleteProperty2() throws Exception {
    doTest("a.2=", new String[]{
      "Properties:KEY_CHARACTERS", "a.2",
      "Properties:KEY_VALUE_SEPARATOR", "="
    });
  }

  public void testEscaping() throws Exception {
    doTest("sdlfkjsd\\l\\\\\\:\\=gk   =   s\\nsssd", new String[]{
      "Properties:KEY_CHARACTERS", "sdlfkjsd\\l\\\\\\:\\=gk",
      "Properties:KEY_VALUE_SEPARATOR", "   =   ",
      "Properties:VALUE_CHARACTERS", "s\\nsssd"
    });
  }

  public void testCRLFEscaping() throws Exception {
    doTest("sdlfkjsdsssd:a\\\nb", new String[]{
      "Properties:KEY_CHARACTERS", "sdlfkjsdsssd",
      "Properties:KEY_VALUE_SEPARATOR", ":",
      "Properties:VALUE_CHARACTERS", "a\\\nb"
    });
  }

  public void testCRLFEscapingKey() throws Exception {
    doTest("x\\\ny:z", new String[]{
      "Properties:KEY_CHARACTERS", "x\\\ny",
      "Properties:KEY_VALUE_SEPARATOR", ":",
      "Properties:VALUE_CHARACTERS", "z"
    });
  }

  public void testWhitespace() throws Exception {
    doTest("x y", new String[]{
      "Properties:KEY_CHARACTERS", "x",
      "Properties:KEY_VALUE_SEPARATOR", " ",
      "Properties:VALUE_CHARACTERS", "y"
    });
  }
  public void testHashInValue() throws Exception {
    doTest("x=# y", new String[]{
      "Properties:KEY_CHARACTERS", "x",
      "Properties:KEY_VALUE_SEPARATOR", "=",
      "Properties:VALUE_CHARACTERS", "# y"
    });
  }
  public void testComments() throws Exception {
    doTest("#hhhh kkkk \n\n", new String[]{
      "Properties:END_OF_LINE_COMMENT", "#hhhh kkkk ",
      "WHITE_SPACE", "\n\n",
    });
  }
  public void testTabs() throws Exception {
    doTest("install/htdocs/imcms/html/link_editor.jsp/1002 = URL\\n\\\n" +
           "\t\\t\\teller meta_id:", new String[]{
      "Properties:KEY_CHARACTERS", "install/htdocs/imcms/html/link_editor.jsp/1002",
      "Properties:KEY_VALUE_SEPARATOR", " = ",
      "Properties:VALUE_CHARACTERS", "URL\\n\\\n" + "\t\\t\\teller meta_id:"
    });
  }
  public void testIndentedComments() throws Exception {
    doTest("   #comm1\n#comm2=n\n\t#comm3", new String[]{
      "WHITE_SPACE", "   ",
      "Properties:END_OF_LINE_COMMENT", "#comm1",
      "WHITE_SPACE", "\n",
      "Properties:END_OF_LINE_COMMENT", "#comm2=n",
      "WHITE_SPACE", "\n\t",
      "Properties:END_OF_LINE_COMMENT", "#comm3",
    });
  }

  public void testHighlighting() throws Exception {
    doTestHL("x y", new String[]{
      "Properties:KEY_CHARACTERS", "x",
      "Properties:KEY_VALUE_SEPARATOR", " ",
      "Properties:VALUE_CHARACTERS", "y"
    });
  }

  public void testHighlighting2() throws Exception {
    doTestHL("x\\n\\kz y", new String[]{
      "Properties:KEY_CHARACTERS", "x",
      "VALID_STRING_ESCAPE_TOKEN", "\\n",
      "INVALID_CHARACTER_ESCAPE_TOKEN", "\\k",
      "Properties:KEY_CHARACTERS", "z",
      "Properties:KEY_VALUE_SEPARATOR", " ",
      "Properties:VALUE_CHARACTERS", "y"
    });
  }

  public void testHighlighting3() throws Exception {
    doTestHL("x  \\uxyzt\\pz\\tp", new String[]{
      "Properties:KEY_CHARACTERS", "x",
      "Properties:KEY_VALUE_SEPARATOR", "  ",
      "INVALID_UNICODE_ESCAPE_TOKEN", "\\uxyzt",
      "INVALID_CHARACTER_ESCAPE_TOKEN", "\\p",
      "Properties:VALUE_CHARACTERS", "z",
      "VALID_STRING_ESCAPE_TOKEN", "\\t",
      "Properties:VALUE_CHARACTERS", "p",
    });
  }
  public void testFramingSpaces() throws Exception {
    doTestHL("\\ x\\ y\\ =\\ z\\ t\\ \\ ", new String[]{
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "Properties:KEY_CHARACTERS", "x",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "Properties:KEY_CHARACTERS", "y",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "Properties:KEY_VALUE_SEPARATOR", "=",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "Properties:VALUE_CHARACTERS", "z",
      "INVALID_CHARACTER_ESCAPE_TOKEN", "\\ ",
      "Properties:VALUE_CHARACTERS", "t",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
    });
  }
  public void testSpecialCharsInValue() throws Exception {
    doTestHL("xxx=\\ x\\ y\\!\\=\\#\\:", new String[]{
      "Properties:KEY_CHARACTERS", "xxx",
      "Properties:KEY_VALUE_SEPARATOR", "=",
      "VALID_STRING_ESCAPE_TOKEN", "\\ ",
      "Properties:VALUE_CHARACTERS", "x",
      "INVALID_CHARACTER_ESCAPE_TOKEN", "\\ ",
      "Properties:VALUE_CHARACTERS", "y",
      "VALID_STRING_ESCAPE_TOKEN", "\\!",
      "VALID_STRING_ESCAPE_TOKEN", "\\=",
      "VALID_STRING_ESCAPE_TOKEN", "\\#",
      "VALID_STRING_ESCAPE_TOKEN", "\\:",
    });
  }

}