proposed new API: Q3Memory_GetStatistics

[James W. W. <ja...@fr...>]

One might be curious about Quesa memory usage for performance tuning 
and detecting leaks.  (Some kinds of leaks might not be detected by 
the current leak detector.)  So I propose an API like the following:

#define	kQ3MemoryStatisticsStructureVersion	1

/*!
	@struct		TQ3MemoryStatistics
	@abstract	Parameter structure for Q3Memory_GetStatistics.
	@field		structureVersion	Version of this structure.
						Initialize to 
kQ3MemoryStatisticsStructureVersion.
	@field		currentAllocations	Current number of 
memory blocks allocated by Quesa.
	@field		currentBytes		Current number of 
memory bytes allocated by Quesa.
	@field		maxBytes		Maximum number of 
memory bytes allocated by Quesa
						("high-water mark").
*/
typedef struct TQ3MemoryStatistics
{
	TQ3Uns32	structureVersion;
	TQ3Uns32	currentAllocations;
	TQ3Uns64	currentBytes;
	TQ3Uns64	maxBytes;
} TQ3MemoryStatistics;


/*!
	@function	Q3Memory_GetStatistics
	@abstract	Get information about Quesa memory usage.
	@discussion	This function will only succeed if Quesa was 
compiled with
			Q3_DEBUG defined to be nonzero.
	@param		info		Structure to receive memory 
statistics.  You must initialize
					the structureVersion field.
	@result		Success or failure of the operation.
*/
Q3_EXTERN_API_C( TQ3Status )
Q3Memory_GetStatistics (
	TQ3MemoryStatistics*	info
);


By the way, how widespread is compiler support for long long (64 bit) 
integer types?  I don't see long long in the C++ standard, though it 
is in C99.
-- 
   James W. Walker, ScriptPerfection Enterprises, Inc.
   <http://www.write-brain.com/>