org.sonarsource.analyzer.commons.regex.ast.AutomatonState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-regex-parsing Show documentation

Logic useful to read and analyze regular expressions

The newest version!

/*
 * SonarSource Analyzers Regex Parsing Commons
 * Copyright (C) 2009-2024 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.sonarsource.analyzer.commons.regex.ast;

import java.util.Collections;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public interface AutomatonState {

  /**
   * This will only return null when called on the end-of-regex state
   */
  @Nullable
  AutomatonState continuation();

  @Nonnull
  default List successors() {
    return Collections.singletonList(continuation());
  }

  default Optional toRegexTree() {
    return Optional.empty();
  }

  @Nonnull
  TransitionType incomingTransitionType();

  @Nonnull
  FlagSet activeFlags();

  enum TransitionType {
    EPSILON, CHARACTER, BACK_REFERENCE, LOOKAROUND_BACKTRACKING, NEGATION
  }

}