// Copyright 2011 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_REGEXP_REGEXP_INTERPRETER_H_
#define V8_REGEXP_REGEXP_INTERPRETER_H_

// A simple interpreter for the Irregexp byte code.

#include "src/regexp/regexp.h"

namespace v8 {
namespace internal {

class TrustedByteArray;

namespace regexp {

class V8_EXPORT_PRIVATE IrregexpInterpreter : public AllStatic {
 public:
  enum Result {
    FAILURE = RegExp::kInternalRegExpFailure,
    SUCCESS = RegExp::kInternalRegExpSuccess,
    EXCEPTION = RegExp::kInternalRegExpException,
    RETRY = RegExp::kInternalRegExpRetry,
    FALLBACK_TO_EXPERIMENTAL = RegExp::kInternalRegExpFallbackToExperimental,
  };

  // In case a StackOverflow occurs, a StackOverflowException is created and
  // EXCEPTION is returned.
  static int MatchForCallFromRuntime(Isolate* isolate,
                                     DirectHandle<IrRegExpData> regexp_data,
                                     DirectHandle<String> subject_string,
                                     int* output_registers,
                                     int output_register_count,
                                     int start_position);

  // In case a StackOverflow occurs, EXCEPTION is returned. The caller is
  // responsible for creating the exception.
  //
  // RETRY is returned if a retry through the runtime is needed (e.g. when
  // interrupts have been scheduled or the regexp is marked for tier-up).
  //
  // Arguments input_start and input_end are unused. They are only passed to
  // match the signature of the native irregex code.
  //
  // Arguments output_registers and output_register_count describe the results
  // array, which will contain register values of all captures if one or more
  // matches were found. In this case, the return value is the number of
  // matches. For all other return codes, the results array remains unmodified.
  static int MatchForCallFromJs(Address subject, int32_t start_position,
                                Address input_start, Address input_end,
                                int* output_registers,
                                int32_t output_register_count,
                                RegExp::CallOrigin call_origin,
                                Isolate* isolate, Address regexp_data);

  static Result MatchInternal(Isolate* isolate,
                              Tagged<TrustedByteArray>* code_array,
                              Tagged<String>* subject_string,
                              int* output_registers, int output_register_count,
                              int total_register_count, int start_position,
                              RegExp::CallOrigin call_origin,
                              uint32_t backtrack_limit);

 private:
  static int Match(Isolate* isolate, Tagged<IrRegExpData> regexp_data,
                   Tagged<String> subject_string, int* output_registers,
                   int output_register_count, int start_position,
                   RegExp::CallOrigin call_origin);
};

}  // namespace regexp
}  // namespace internal
}  // namespace v8

#endif  // V8_REGEXP_REGEXP_INTERPRETER_H_
