org.sonar.iac.docker.parser.grammar.DockerLexicalConstant Maven / Gradle / Ivy

Go to download
/*
 * SonarQube IaC Plugin
 * Copyright (C) 2021-2023 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.iac.docker.parser.grammar;

import org.sonar.iac.common.parser.grammar.LexicalConstant;

public class DockerLexicalConstant {

  public static final String COMMENT = "(?:" + LexicalConstant.SINGLE_LINE_COMMENT_HASH + ")";
  public static final String EOL = "(?:\\r\\n|[" + LexicalConstant.LINE_TERMINATOR + "])";
  public static final String LINE_BREAK = "(?:\\\\[" + LexicalConstant.WHITESPACE + "]*+" + EOL + ")";
  public static final String STRING_LITERAL_WITH_QUOTES = "\"(?:[^\"\\\\]*+(?:\\\\[\\s\\S])?+)*+\"";
  public static final String STRING_LITERAL_WITHOUT_QUOTES = "(?:(?!" + LINE_BREAK + ")[^\\s])++";
  public static final String STRING_LITERAL_OLD = "(?:(?:" + STRING_LITERAL_WITH_QUOTES + ")|(?:" + STRING_LITERAL_WITHOUT_QUOTES + "))+";
  public static final String EQUALS_OPERATOR = "=";

  /**
   * IDENTIFIERS
   */
  private static final String VAR_IDENTIFIER_START = "[a-zA-Z_0-9]";
  public static final String VAR_IDENTIFIER = VAR_IDENTIFIER_START + "++";
  public static final String ENCAPS_VAR_MODIFIER_SEPARATOR = ":(-|\\+)";
  public static final String ENCAPS_VAR_MODIFIER_GENERIC = "(\\\\}|[^}])+";
  public static final String FLAG_NAME = "[a-z][-a-z]*+";

  /**
   * LITERAL
   */
  /**
   * '$' sign is allowed in double quoted string and heredoc only when it does not conflict with the
   * encapsulated variable expression, i.e when it not followed with '{' or a starting identifier character.
   */
  private static final String PERMITTED_EMBEDDED_DOLAR = "(?:\\$(?!\\{|" + VAR_IDENTIFIER_START + "))";

  private static final String NON_SPECIAL_CHARACTERS = "(?:[^\"\\\\$]|(?Docker reference.
   * It starts with the heredoc indicator (2 Less-than signs), followed by an optional minus, followed by an optional double quote
   * then the 1st capturing group (the heredoc block name), followed again by an optional double quote.
   * In 1st capturing group: one or more (possessive) uppercase/lowercase letters, numbers, or underscore.
   * The key part is the reference to the heredoc block name which end the heredoc block by having this element alone in a line.
   * This regex also allow having multiple heredoc block name, it will then end until the last matched block.
   */
  public static final String HEREDOC_NAME = "<<-?\"?([a-zA-Z0-9_]++)\"?";
  public static final String HEREDOC_EXPRESSION = "(?:" + HEREDOC_NAME + "\\s+)+[\\s\\S]*?([\\n\\r])\\1(?=[\\n\\r]|$)";

  public static final String IMAGE_ALIAS = "[-a-zA-Z0-9_\\.]+";

  private DockerLexicalConstant() {
  }
}