/*
 * Copyright (c) 2015 2016, Intel Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * 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.
 *   * Neither the name of Intel Corporation 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 COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
 */

/*
 * Represents the mapping between Features and CommandSpecs
 */

#ifndef _CLI_FRAMEWORK_FEATUREREF_H_
#define _CLI_FRAMEWORK_FEATUREREF_H_

#include <string>
#include "FeatureBase.h"

#include <vector>
#include <iostream>


namespace cli
{
namespace framework
{

/*!
 * featureFactory is a function pointer type.  Points to a function that returns a new feature
 * instance.
 * @param count
 * @param tokens
 * @return
 */
typedef cli::framework::FeatureBase* (*featureFactoryT)();

/*!
 * Function Pointer to get a list of CommandSpecs
 * @param list
 * 		reference to the list to put the commands in
 */
typedef void (*getCmdSpecsT)(CommandSpecList &list);

/*!
 * Represents the mapping between Features and CommandSpecs
 */
typedef struct
{
	/*!
	 * Function pointer
	 * @param count
	 * 		Number of tokens passing
	 * @param tokens
	 * 		tokens
	 * @return
	 */
	featureFactoryT featureFactory;

	/*!
	 * A function pointer that gets the CommandSpecs the Feature supports
	 * @param[out] paths
	 * 		Will point to the paths the Feature supports
	 * @param[out] count
	 * 		size of the paths array
	 */
	getCmdSpecsT getCmdSpecs;

} FeatureRef;

} /* namespace framework*/
} /* namespace cli */
#endif
