/*
Copyright (C) 2001,2006 StrmnNrmn

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.

*/

#ifndef HLEGRAPHICS_DLDEBUG_H_
#define HLEGRAPHICS_DLDEBUG_H_

#include "Ultra/ultra_sptask.h" // Ugh, could just fwd-decl OSTask, if it wasn't a crazy typedef union.
#include "System/DataSink.h"
#include "Base/Macros.h"

struct RDP_OtherMode;

#ifdef DAEDALUS_DEBUG_DISPLAYLIST

class DLDebugOutput
{
public:
	virtual ~DLDebugOutput();

	void Print(const char * fmt, ...);
	void PrintLine(const char * fmt, ...);	// Automatically appends a newline.

	virtual size_t Write(const void * p, size_t len) = 0;

	virtual void BeginInstruction(u32 idx, u32 cmd0, u32 cmd1, u32 depth, const char * name) = 0;
	virtual void EndInstruction() = 0;

private:
	static const u32 kBufferLen = 1024;
	char	mBuffer[kBufferLen];
};


extern DLDebugOutput * gDLDebugOutput;

inline bool DLDebug_IsActive() { return gDLDebugOutput != nullptr; }

#define DL_PF(...)										\
	do {												\
		if( gDLDebugOutput )							\
			gDLDebugOutput->PrintLine( __VA_ARGS__ );	\
	} while(0)


// Ugh - print out without newlines (needed for HTML <pre> output)
#define DL_PF_(...)									\
	do {											\
		if( gDLDebugOutput )						\
			gDLDebugOutput->Print( __VA_ARGS__ );	\
	} while(0)

#define DL_BEGIN_INSTR(idx, c0, c1, depth, nm) 		\
	do {											\
		if (gDLDebugOutput)							\
			gDLDebugOutput->BeginInstruction(idx, c0, c1, depth, nm);	\
	} while(0)

#define DL_END_INSTR() 								\
	do {											\
		if (gDLDebugOutput) 						\
			gDLDebugOutput->EndInstruction();		\
	} while(0)


DLDebugOutput *	DLDebug_CreateFileOutput();

void 		DLDebug_SetOutput(DLDebugOutput * output);

void		DLDebug_DumpTaskInfo( const OSTask * pTask );
void		DLDebug_DumpMux(u64 mux);
void		DLDebug_PrintMux( FILE * fh, u64 mux );
void		DLDebug_DumpRDPOtherMode(const RDP_OtherMode & mode);

void		DLDebug_DumpRDPOtherModeL(u32 mask, u32 data);
void		DLDebug_DumpRDPOtherModeH(u32 mask, u32 data);


#else

#define DL_PF(...)								do { DAEDALUS_USE(__VA_ARGS__); } while(0)
#define DL_PF_(...)								do { DAEDALUS_USE(__VA_ARGS__); } while(0)

#define DL_BEGIN_INSTR(idx, c0, c1, depth, nm)  do { } while(0)
#define DL_END_INSTR()							do { } while(0)

#endif



// Provide some special assert macros to allow display list debugging
#if defined(DAEDALUS_DEBUG_DISPLAYLIST) && defined( DAEDALUS_ENABLE_ASSERTS )

extern void DLDebugger_RequestDebug();

//
//	Assert a condition is valid
//
#define DAEDALUS_DL_ASSERT( e, ... )										\
{																			\
	static bool ignore = false;												\
	if ( !(e) && !ignore )													\
	{																		\
		DL_PF( __VA_ARGS__ );												\
		EAssertResult i = DaedalusAssert( #e,  __FILE__, __LINE__, __VA_ARGS__  );	\
		if ( i == AR_BREAK )												\
		{																	\
			DLDebugger_RequestDebug();										\
		}																	\
		else if ( i == AR_IGNORE )											\
		{																	\
			ignore = true;	/* Ignore throughout session */					\
		}																	\
	}																		\
}

//
// Use this to assert unconditionally - e.g. for unhandled cases
//
#define DAEDALUS_DL_ERROR( ... )											\
{																			\
	static bool ignore = false;												\
	if ( !ignore )															\
	{																		\
		DL_PF( __VA_ARGS__ );												\
		EAssertResult i = DaedalusAssert( "", __FILE__, __LINE__, __VA_ARGS__ );		\
		if ( i == AR_BREAK )												\
		{																	\
			DLDebugger_RequestDebug();										\
		}																	\
		else if ( i == AR_IGNORE )											\
		{																	\
			ignore = true;	/* Ignore throughout session */					\
		}																	\
	}																		\
}

#else

#define DAEDALUS_DL_ASSERT( e, ... )		DAEDALUS_ASSERT( e, __VA_ARGS__ )
#define DAEDALUS_DL_ERROR( ... )			DAEDALUS_ERROR( __VA_ARGS__ )

#endif

#endif // HLEGRAPHICS_DLDEBUG_H_