/* Copyright 2015 Samsung Electronics Co., Ltd.
 * Copyright 2015 University of Szeged.
 *
 * 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.
 */

#ifndef RE_COMPILER_H
#define RE_COMPILER_H

#ifndef CONFIG_ECMA_COMPACT_PROFILE_DISABLE_REGEXP_BUILTIN

#include "ecma-globals.h"
#include "re-parser.h"

/**
 * RegExp opcodes
 */
typedef enum
{
  RE_OP_EOF,
  /* Group opcode order is important, because RE_IS_CAPTURE_GROUP is based on it.
   * Change it carefully. Capture opcodes should be at first.
   */
  RE_OP_CAPTURE_GROUP_START,
  RE_OP_CAPTURE_GREEDY_ZERO_GROUP_START,
  RE_OP_CAPTURE_NON_GREEDY_ZERO_GROUP_START,
  RE_OP_CAPTURE_GREEDY_GROUP_END,
  RE_OP_CAPTURE_NON_GREEDY_GROUP_END,
  RE_OP_NON_CAPTURE_GROUP_START,
  RE_OP_NON_CAPTURE_GREEDY_ZERO_GROUP_START,
  RE_OP_NON_CAPTURE_NON_GREEDY_ZERO_GROUP_START,
  RE_OP_NON_CAPTURE_GREEDY_GROUP_END,
  RE_OP_NON_CAPTURE_NON_GREEDY_GROUP_END,

  RE_OP_MATCH,
  RE_OP_CHAR,
  RE_OP_SAVE_AT_START,
  RE_OP_SAVE_AND_MATCH,
  RE_OP_PERIOD,
  RE_OP_ALTERNATIVE,
  RE_OP_GREEDY_ITERATOR,
  RE_OP_NON_GREEDY_ITERATOR,
  RE_OP_ASSERT_START,
  RE_OP_ASSERT_END,
  RE_OP_ASSERT_WORD_BOUNDARY,
  RE_OP_ASSERT_NOT_WORD_BOUNDARY,
  RE_OP_LOOKAHEAD_POS,
  RE_OP_LOOKAHEAD_NEG,
  RE_OP_BACKREFERENCE,
  RE_OP_CHAR_CLASS,
  RE_OP_INV_CHAR_CLASS
} re_opcode_t;

/**
 * Recursion limit of RegExp compiler
 */
#define RE_COMPILE_RECURSION_LIMIT  100

/**
 * Check if a RegExp opcode is a capture group or not
 */
#define RE_IS_CAPTURE_GROUP(x) (((x) < RE_OP_NON_CAPTURE_GROUP_START) ? 1 : 0)

/**
 * Type of bytecode elements
 */
typedef uint8_t re_bytecode_t;

/**
 * Context of RegExp bytecode container
 */
typedef struct
{
  re_bytecode_t *block_start_p; /**< start of bytecode block */
  re_bytecode_t *block_end_p; /**< end of bytecode block */
  re_bytecode_t *current_p; /**< current position in bytecode */
} re_bytecode_ctx_t;

/**
 * Context of RegExp compiler
 */
typedef struct
{
  uint8_t flags; /**< RegExp flags */
  uint32_t recursion_depth; /**< recursion depth */
  uint32_t num_of_captures; /**< number of capture groups */
  uint32_t num_of_non_captures; /**< number of non-capture groups */
  uint32_t highest_backref; /**< highest backreference */
  re_bytecode_ctx_t *bytecode_ctx_p; /**< pointer of RegExp bytecode context */
  re_token_t current_token; /**< current token */
  re_parser_ctx_t *parser_ctx_p; /**< pointer of RegExp parser context */
} re_compiler_ctx_t;

ecma_completion_value_t
re_compile_bytecode (ecma_property_t *bytecode_p, ecma_string_t *pattern_str_p, uint8_t flags);

re_opcode_t
re_get_opcode (re_bytecode_t **bc_p);

uint32_t
re_get_value (re_bytecode_t **bc_p);

#endif /* CONFIG_ECMA_COMPACT_PROFILE_DISABLE_REGEXP_BUILTIN */
#endif /* RE_COMPILER_H */
