org.sonar.plugins.php.duplications.PhpTokenProducer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-php-plugin Show documentation

Sonar PHP Plugin is set of tools that brings PHP support to sonar. It relies on Sonar core, PHP Depend, PHPMD, PHP_CodeSniffer and PHPUnit

There is a newer version: 2.4.1

Show newest version

/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010 SonarSource and Akram Ben Aissi
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.php.duplications;

import org.sonar.duplications.token.TokenChunker;

/**
 * No PHP language specification document could be found to help produce this tokenizer. So http://php.net/manual/en/langref.php was used
 * for that purpose.
 */
public final class PhpTokenProducer {

  private static final String NORMALIZED_CHARACTER_LITERAL = "$CHARS";
  private static final String NORMALIZED_NUMERIC_LITERAL = "$NUMBER";

  private static final String LABEL = "[a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*+";
  private static final String NEWLINE = "(?:\\n\\r|\\r|\\n)";
  private static final String EXP = "([Ee][+-]?+[0-9]++)";

  private PhpTokenProducer() {
  }

  /**
   * Creates a {@link TokenChunker} for the PHP language.
   *
   * @return a TokenChunker
   */
  public static TokenChunker build() {
    return TokenChunker.builder()
      // White Space
      .ignore("\\s")
        // Comments
      .ignore("//[^\\n\\r]*+")
      .ignore("#[^\\n\\r]*+")
      .ignore("/\\*[\\s\\S]*?\\*/")
        // String Literals
      .token("<<<(['\"]?)(" + LABEL + ")+\\1[\\s\\S]*?" + NEWLINE + "\\2", NORMALIZED_CHARACTER_LITERAL)
      .token("\"([^\"\\\\]*+(\\\\[\\s\\S])?+)*+\"", NORMALIZED_CHARACTER_LITERAL)
        // Character Literals
      .token("'([^'\\n\\\\]*+(\\\\.)?+)*+'", NORMALIZED_CHARACTER_LITERAL)
        // Identifiers, Keywords, Boolean Literals, The Null Literal
      .token(LABEL)
        // Floating-Point Literals
        // - Decimal
      .token("[+-]?[0-9]++\\.([0-9]++)?+" + EXP + "?+", NORMALIZED_NUMERIC_LITERAL)
        // - Decimal
      .token("[+-]?\\.[0-9]++" + EXP + "?+", NORMALIZED_NUMERIC_LITERAL)
        // - Decimal
      .token("[+-]?[0-9]++" + EXP, NORMALIZED_NUMERIC_LITERAL)
        // Integer Literals
        // - Hexadecimal
      .token("[+-]?0[xX][0-9a-fA-F]++", NORMALIZED_NUMERIC_LITERAL)
        // - Binary
      .token("[+-]?0[b][01]++", NORMALIZED_NUMERIC_LITERAL)
        // - Decimal and Octal
      .token("[+-]?[0-9]++", NORMALIZED_NUMERIC_LITERAL)
        // Any other character
      .token(".")
      .build();
  }

}