/*
 *  SPL - The SPL Programming Language
 *  Copyright (C) 2004, 2005  Clifford Wolf <clifford@clifford.at>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  mod_encode_regex.spl: An encode_regex() function
 */

/**
 * Regex encoder
 */

/**
 * This function gets a text as parameter and returns the same text with all
 * characters escaped which do have a special meaning in regular expressions.
 *
 * The primary use of this function is to include a text in a regular
 * expression as it is.
 *
 * This function is designed to be used with the encoding/quoting operator (::).
 */
function encode_regex(text)
{
	return text =~ s/([ \\ \^ \$ \. \[ \| \( \) \? \* \+ \{ ])/\\$1/Rxg;
}