/*
 * Copyright (C)2005-2019 Haxe Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

package lua.lib.lrexlib;

import haxe.extern.EitherType;

@:luaRequire("rex_pcre")
extern class Rex {
	inline static function create(expr:String, flag:EitherType<Int, String>):Rex {
		return untyped Rex['new'](expr, flag);
	}

	/**
		The function searches for the first match of the regexp `patt` in the
		string `subj`, starting from offset `init`, subject to flags `cf` and `ef`.

		@return matched string, or array of strings.
	**/
	static function match(patt:EitherType<Rex, String>, subj:String, ?init:Int, ?ef:Int):Dynamic;

	/**
		The function searches for the first match of the regexp patt in the string
		`subj`, starting from offset `init`, subject to flags `cf` and `ef`.
	**/
	static function find(patt:EitherType<Rex, String>, subj:String, ?init:Int, ?ef:Int):Dynamic;

	/**
		The function is intended for use in the generic for Lua construct. It is
		used for splitting a subject string `subj` into parts (sections). The `sep`
		parameter is a regular expression pattern representing separators between
		the sections.
	**/
	static function split(subj:String, sep:EitherType<Rex, String>, ?cf:Int, ?ef:Int):Void->String;

	/**
		This function counts matches of the pattern `patt` in the string `subj`.
	**/
	static function count(subj:String, patt:EitherType<Rex, String>, cf:Int, ef:Int):Dynamic;

	static function flags(?tb:Dynamic):Dynamic;

	/**
		The function searches for the first match of the regexp in the string
		`subj`, starting from offset `init`, subject to execution flags `ef`.
	**/
	function tfind(subj:String, ?init:Int, ?ef:Int):Dynamic;

	/**
		This function searches for the first match of the regexp in the string
		`subj`, starting from offset `init`, subject to execution flags `ef`.
	**/
	function exec(subj:String, ?init:Int, ?ef:Int):Dynamic;

	/**
		The function is intended for use in the generic for Lua construct. It
		returns an iterator for repeated matching of the pattern patt in the
		string `subj`, subject to flags `cf` and `ef`.
	**/
	static function gmatch(subj:String, patt:EitherType<Rex, String>, ?cf:Int, ?ef:Int):Void->String;

	/**
		  This function searches for all matches of the pattern `patt` in the string
		`subj` and replaces them according to the parameters `repl` and `n`.
	**/
	static function gsub(subj:String, patt:EitherType<Rex, String>, repl:Dynamic, ?n:Int, ?cf:Int, ?ef:Int):String;
}
