/*!
 * V4Fire Client Core
 * https://github.com/V4Fire/Client
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Client/blob/master/LICENSE
 */

export interface SyncMaskWithTextOptions {
	/**
	 * A starting position of the masked text to synchronize.
	 * The position should be provided to a Unicode symbol, but not a UTF 16 char.
	 */
	from?: Nullable<number>;

	/**
	 * An ending position of the masked text to synchronize.
	 * The position should be provided to a Unicode symbol, but not a UTF 16 char.
	 */
	to?: Nullable<number>;

	/**
	 * An original text from the input (by default it takes from the DOM node).
	 * The parameter can be provided as a list of Unicode symbols.
	 */
	inputText?: CanArray<string>;

	/**
	 * If false, the mask won't try to fit its size to the specified text to sync
	 * @default `true`
	 */
	fitMask?: boolean;

	/**
	 * A starting position of the selection cursor.
	 * The position should be provided to a Unicode symbol, but not a UTF 16 char.
	 *
	 * @default `from`
	 */
	cursorPos?: number;

	/**
	 * If true, the cursor position will be preserved to the left bound of selection to synchronize
	 * @default `false`
	 */
	preserveCursor?: boolean;

	/**
	 * If true, all symbols from the specified text that are matched as mask placeholders won't be skipped
	 * @default `false`
	 */
	preservePlaceholders?: boolean;
}

export interface CompiledMask {
	/**
	 * List of symbols of the compiled mask
	 *
	 * @example
	 * ```
	 * // mask = '+%d (%d%d%d)'
	 * ['+', /\d/, ' ', '(', /\d/, /\d/, /\d/, ')']
	 * ```
	 */
	symbols: Array<string | RegExp>;

	/**
	 * List of non-terminal symbols of the compiled mask
	 *
	 * @example
	 * ```
	 * // mask = '+%d (%d%d%d)'
	 * [/\d/, /\d/, /\d/, /\d/]
	 * ```
	 */
	nonTerminals: RegExp[];

	/**
	 * Last value of the masked input
	 */
	text: string;

	/**
	 * Value of the whole mask placeholder
	 *
	 * @example
	 * ```
	 * // mask = '+%d (%d%d%d) %d%d%d-%d%d-%d%d'
	 * // maskPlaceholder = '_'
	 * '+_ (___) ___-__-__'
	 * ```
	 */
	placeholder: string;

	/**
	 * A starting position of the last input selection.
	 * The position refers to a Unicode symbol, but not a UTF 16 char.
	 */
	selectionStart: Nullable<number>;

	/**
	 * An ending position of the last input selection.
	 * The position refers to a Unicode symbol, but not a UTF 16 char.
	 */
	selectionEnd: Nullable<number>;
}