/* 
 * Copyright (C) 2002 - David W. Durham
 * 
 * This file is part of ReZound, an audio editing application.
 * 
 * ReZound 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.
 * 
 * ReZound 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
 */

#ifndef __AStatusComm_H__
#define __AStatusComm_H__


#include "../../config/common.h"

/*
 * This class is used to communicate status to and from the 
 * user the platform specific frontend should implement these
 * pure virtual methods to display error messages and ask
 * them question via popup windows
 */


/******************************************
- Error Message Philosophy:
   If an error code is retrived from a
   function, and that function was written
   SPECIFICALLY for this application, then
   that function should have displayed the
   error message.  However if the error
   occured within a function that was
   written to be used by other applications
   (i.e. DirectSound Class, other libraries)
   then an exception should have been raised
   and the exception caught by the caller
   and then the code specific to this
   application should display the error
   message with respect to the exception.
******************************************/

#include <string>

enum VSeverity {none,light,medium,hard,fatal};
enum VQuestion {yesnoQues=1,cancelQues=2};
enum VAnswer {yesAns,noAns,cancelAns,defaultAns};

class AStatusComm
{
public:
	virtual ~AStatusComm();

	virtual void error(const string &message,VSeverity severity=none,bool reformatIfNeeded=true)=0;
	virtual void warning(const string &message,bool reformatIfNeeded=true)=0;
	virtual void message(const string &message,bool reformatIfNeeded=true)=0;
	virtual VAnswer question(const string &message,VQuestion options,bool reformatIfNeeded=true)=0;

	virtual void beep()=0;

	virtual int beginProgressBar(const string &title,bool showCancelButton=false)=0;
	virtual bool updateProgressBar(int handle,int progress,const string timeElapsed,const string timeRemaining)=0; // progress is 0 to 100 .. returns if 'cancel' was pressed
	virtual void endProgressBar(int handle)=0;
	virtual void endAllProgressBars()=0;

	// breaks "msg -- msg -- msg" into "msg\n-- msg\n-- msg"
	static const string breakIntoLines(const string s);
};

extern AStatusComm *gStatusComm;

// Easy Coders
void Error(const string &message,VSeverity severity=none,bool reformatIfNeeded=true);
void Warning(const string &message,bool reformatIfNeeded=true);
void Message(const string &message,bool reformatIfNeeded=true);
VAnswer Question(const string &message,VQuestion options,bool reformatIfNeeded=true);



/*
	I made this class to make adding status bars to actions relatively painless. 

        Just construct an object at the beginning of the action giving it a very 
	short description of what is going on and the first and last value of some 
	counter.  Then in the action's loop, invoke the update() method giving it 
	that counter value which goes from firstValue to lastValue.  Finally, the 
	progress bar will go away when the destructor is invoked.
*/
#include "CSound_defs.h" // just for sample_pos_t
#include <time.h> // for time_t
class CStatusBar
{
public:
	CStatusBar(const string title,const sample_pos_t firstValue,const sample_pos_t lastValue,const bool showCancelButton=false);
	virtual ~CStatusBar();

	inline bool update(const sample_pos_t value) { const sample_pos_t progress=(value-sub)/div; return progress!=lastProgress && handle!=-1 && gStatusComm->updateProgressBar(handle,(int)((lastProgress=progress)*mul),getTimeElapsed(),getTimeRemaining()); }

	void reset();
	void hide();
	
private:
	int handle;
	const sample_pos_t sub;
	const sample_pos_t valueDiff;
	const sample_pos_t div;
	const float mul;
	sample_pos_t lastProgress;
	unsigned long initialTime;

	const string getTimeElapsed();
	const string getTimeRemaining();
};

#endif