/*
 *  Copyright (C) 2011-2024 Arnaud Quette (Design and part of implementation)
 *  Copyright (C) 2011 - EATON
 *  Copyright (C) 2020-2024 - Jim Klimov <jimklimov+nut@gmail.com> - support and modernization of codebase
 *
 *  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
 */

/*! \file nutscan-device.h
    \brief definition of a container describing a NUT discovered device
    \author Frederic Bohe <fredericbohe@eaton.com>
	\author Arnaud Quette <arnaudquette@free.fr>
*/

#ifndef SCAN_DEVICE
#define SCAN_DEVICE

#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif

/**
 *  \brief  Device type string getter
 *
 *  \param  type  Device type
 *
 *  \return Type string
 */
#define nutscan_device_type_string(type) \
	(assert(0 < (type) && (type) < TYPE_END), nutscan_device_type_strings[type - 1])
#define nutscan_device_type_lstring(type) \
	(assert(0 < (type) && (type) < TYPE_END), nutscan_device_type_lstrings[type - 1])

typedef enum nutscan_device_type {
	TYPE_NONE = 0,
	TYPE_USB,
	TYPE_SNMP,
	TYPE_XML,
	TYPE_NUT,
	TYPE_NUT_SIMULATION,
	TYPE_IPMI,
	TYPE_AVAHI,
	TYPE_EATON_SERIAL,
	TYPE_UPOWER,
	TYPE_END	/* Sentinel; numeric value serves as array size at compile time */
} nutscan_device_type_t;

/** Device type -> string mapping */
extern const char * nutscan_device_type_strings[TYPE_END];
extern const char * nutscan_device_type_lstrings[TYPE_END];

typedef struct nutscan_options {
	char *		option;
	char *		value;
	char *		comment_tag;	/* if not NULL, this option may be not shown in some output formats, or represented as a comment with this tag in others (and empty string may also be used) */
	struct nutscan_options*	next;
} nutscan_options_t;

typedef struct nutscan_device {
	nutscan_device_type_t	type;
	char *		driver;
	char *		alt_driver_names;
	char *		port;
	nutscan_options_t     * opt;
	struct nutscan_device * prev;
	struct nutscan_device * next;
} nutscan_device_t;

nutscan_device_t * nutscan_new_device(void);
void nutscan_free_device(nutscan_device_t * device);
void nutscan_add_commented_option_to_device(nutscan_device_t * device, char * option, char * value, char * comment_tag);
/* This method calls the one above, using a NULL comment_tag */
void nutscan_add_option_to_device(nutscan_device_t * device, char * option, char * value);
nutscan_device_t * nutscan_add_device_to_device(nutscan_device_t * first, nutscan_device_t * second);

/**
 *  \brief  Rewind device list
 *
 *  \param  device  Device list item
 *
 *  \return Device list head
 */
nutscan_device_t * nutscan_rewind_device(nutscan_device_t * device);

#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif

#endif
