/*-
 * Copyright (c) 2005 - 2011 CAS Dev Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the CAS Dev. Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      ASGetOpt.hpp
 *
 * $CAS$
 */
#ifndef _AS_GET_OPT_HPP__
#define _AS_GET_OPT_HPP__ 1

/**
  @file ASGetOpt.hpp
  @brief Application server command-line options
*/
#include "ASTypes.hpp"

namespace CAS // C++ Application Server
{

#define C_NO_ARG    0
#define C_HAS_ARG   1
#define C_OPT_ARG   2

/**
  @class ASGetOpt ASGetOpt.hpp <ASGetOpt.hpp>
  @brief Application server command-line options
*/
struct Options
{
	/** Short option name */
	UCHAR_8     short_opt;
	/** Long option name  */
	CCHAR_P     long_opt;
	/** Argument          */
	UINT_32     has_arg;
};

/**
  @fn INT_32 GetOpt(const Options * aOptions, UINT_32 & iArgNum, const UINT_32 & iMaxArgNum, CHAR_P * aArgList, CCHAR_P & szArgValue)
  @brief Parse command-line options
  @param aOptions - array with options properties
  @param iArgNum - current argument number
  @param iMaxArgNum - number of arguments
  @param aArgList - list of arguments
  @param szArgValue - argument value
*/
INT_32 GetOpt(const Options  * aOptions,
              UINT_32        & iArgNum,
              const UINT_32    iMaxArgNum,
              CHAR_P         * aArgList,
              CCHAR_P        & szArgValue);

} // namespace CAS
#endif // _AS_GET_OPT_HPP__
// End.
