/*
 *  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_int.spl: An encode_int() function for type checks
 */

/**
 * Integer encoder
 */

/**
 * This function gets a text as parameter and returns the portion of the text
 * from the beginning which only consists of numbers. Deciamal numbers and
 * negative numbers are not supported. If there is no number at the beginning
 * of the passed text, 0 is returned.
 *
 * Whitespaces before the integer are ignored.
 *
 * The primary use of this function is to 'quote' integers in those cases where
 * it is not possible to do real quoting but a user input needs to be quoted
 * somehow for security. E.g. SQLite handles an integer differently when it is
 * quoted as text and so quoting using [[sql:encode_sql()]] would work out.
 *
 * This function is designed to be used with the encoding/quoting operator (::).
 */
function encode_int(text)
{
	return text =~ /^\s*([0-9]+)/ ? $1 : 0;
}