/*
 	File:		NumberFormatting.h
 
 	Contains:	Utilites for formatting numbers
 
 	Version:	Technology:	
 				Release:	QuickTime 4.0
 
 	Copyright:	(c) 1996-1998 by Apple Computer, Inc., all rights reserved.
 
 	Bugs?:		For bug reports, consult the following page on
 				the World Wide Web:
 
 					http://developer.apple.com/bugreporter/
 
*/
#ifndef __NUMBERFORMATTING__
#define __NUMBERFORMATTING__

#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __INTLRESOURCES__
#include <IntlResources.h>
#endif




#if PRAGMA_ONCE
#pragma once
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if PRAGMA_IMPORT
#pragma import on
#endif

#if PRAGMA_STRUCT_ALIGN
	#pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
	#pragma pack(2)
#endif

/*

	Here are the current System 7 routine names and the translations to the older forms.
	Please use the newer forms in all new code and migrate the older names out of existing
	code as maintainance permits.
	
	New Name					Old Name(s)
	
	ExtendedToString			FormatX2Str
	FormatRecToString			Format2Str
	NumToString				
	StringToExtended			FormatStr2X
	StringToFormatRec			Str2Format
	StringToNum				

*/

struct NumFormatString {
	UInt8 							fLength;
	UInt8 							fVersion;
	char 							data[254];					/* private data */
};
typedef struct NumFormatString			NumFormatString;
typedef NumFormatString 				NumFormatStringRec;

typedef short 							FormatStatus;

enum {
	fVNumber					= 0								/* first version of NumFormatString */
};

typedef SInt8 							FormatClass;

enum {
	fPositive					= 0,
	fNegative					= 1,
	fZero						= 2
};

typedef SInt8 							FormatResultType;

enum {
	fFormatOK					= 0,
	fBestGuess					= 1,
	fOutOfSynch					= 2,
	fSpuriousChars				= 3,
	fMissingDelimiter			= 4,
	fExtraDecimal				= 5,
	fMissingLiteral				= 6,
	fExtraExp					= 7,
	fFormatOverflow				= 8,
	fFormStrIsNAN				= 9,
	fBadPartsTable				= 10,
	fExtraPercent				= 11,
	fExtraSeparator				= 12,
	fEmptyFormatString			= 13
};


struct FVector {
	short 							start;
	short 							length;
};
typedef struct FVector					FVector;
/* index by [fPositive..fZero] */

typedef FVector 						TripleInt[3];
#if CGLUESUPPORTED
EXTERN_API_C( void )
stringtonum						(const char *			theString,
								 long *					theNum);

EXTERN_API_C( void )
numtostring						(long 					theNum,
								 char *					theString);

#endif  /* CGLUESUPPORTED */

EXTERN_API( void )
StringToNum						(ConstStr255Param 		theString,
								 long *					theNum);

EXTERN_API( void )
NumToString						(long 					theNum,
								 Str255 				theString);


EXTERN_API( FormatStatus )
ExtendedToString				(const extended80 *		x,
								 const NumFormatString * myCanonical,
								 const NumberParts *	partsTable,
								 Str255 				outString)							FOURWORDINLINE(0x2F3C, 0x8210, 0xFFE8, 0xA8B5);

EXTERN_API( FormatStatus )
StringToExtended				(ConstStr255Param 		source,
								 const NumFormatString * myCanonical,
								 const NumberParts *	partsTable,
								 extended80 *			x)									FOURWORDINLINE(0x2F3C, 0x8210, 0xFFE6, 0xA8B5);

EXTERN_API( FormatStatus )
StringToFormatRec				(ConstStr255Param 		inString,
								 const NumberParts *	partsTable,
								 NumFormatString *		outString)							FOURWORDINLINE(0x2F3C, 0x820C, 0xFFEC, 0xA8B5);

EXTERN_API( FormatStatus )
FormatRecToString				(const NumFormatString * myCanonical,
								 const NumberParts *	partsTable,
								 Str255 				outString,
								 TripleInt 				positions)							FOURWORDINLINE(0x2F3C, 0x8210, 0xFFEA, 0xA8B5);


#if OLDROUTINENAMES
#define FormatX2Str(x, myCanonical, partsTable, outString)  \
		 ExtendedToString( x, myCanonical, partsTable, outString)
#define FormatStr2X(source, myCanonical, partsTable, x)  \
		 StringToExtended( source, myCanonical, partsTable, x)
#define Str2Format(inString, partsTable, outString)  \
		 StringToFormatRec(inString, partsTable, outString)
#define Format2Str(myCanonical, partsTable, outString, positions)  \
		 FormatRecToString(myCanonical, partsTable, outString, positions)
#endif  /* OLDROUTINENAMES */


#if PRAGMA_STRUCT_ALIGN
	#pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
	#pragma pack()
#endif

#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif

#ifdef __cplusplus
}
#endif

#endif /* __NUMBERFORMATTING__ */