/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* 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 the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "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 AUTHORS BE HELD 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.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/

/**
	@file
	@author Andrew D. Zonenberg
	@brief Declaration of ExportFilter
 */
#ifndef ExportFilter_h
#define ExportFilter_h

#include "../scopehal/ActionProvider.h"

/**
	@brief Base class for filters providing file-export functionality
 */
class ExportFilter
	: public Filter
	, public ActionProvider
{
public:
	ExportFilter(const std::string& color);
	virtual ~ExportFilter();

	virtual void Refresh() override;

	virtual std::vector<std::string> EnumActions() override;
	virtual bool PerformAction(const std::string& id) override;

protected:

	/**
		@brief Clears the output file
	 */
	virtual void Clear();

	/**
		@brief Writes the current inputs to the output file in the appropriate format
	 */
	virtual void Export() =0;

	enum ExportMode_t
	{
		MODE_CONTINUOUS_APPEND,
		MODE_CONTINUOUS_OVERWRITE,
		MODE_MANUAL_APPEND,
		MODE_MANUAL_OVERWRITE
	};

	std::string m_fname;
	std::string m_mode;

	FILE* m_fp;

	void OnFileNameChanged();
};

#endif
