Text Utilities Interfaces. More...

#include <MacTypes.h>
#include <NumberFormatting.h>
#include <StringCompare.h>
#include <DateTimeUtils.h>

Data Structures
struct	ScriptRunStatus

struct	BreakTable

struct	NBreakTable

Macros
#define	C2PStr(a) (StringPtr) c2pstr((Ptr)(a))

#define	P2CStr(a) (Ptr) p2cstr(a)

#define	CopyPascalStringToC(src, dst) p2cstrcpy(dst, src)

#define	CopyCStringToPascal(src, dst) c2pstrcpy(dst, src)

#define	C2PStr(a) (StringPtr) c2pstr((Ptr)(a))

#define	P2CStr(a) (Ptr) p2cstr(a)

Typedefs
typedef struct ScriptRunStatus	ScriptRunStatus

typedef struct BreakTable	BreakTable

typedef BreakTable *	BreakTablePtr

typedef struct NBreakTable	NBreakTable

typedef NBreakTable *	NBreakTablePtr

Functions
long	Munger (Handle h, long offset, const void ptr1, long len1, const void ptr2, long len2)

StringHandle	NewString (ConstStr255Param theString)

void	SetString (StringHandle theString, ConstStr255Param strNew)

StringHandle	GetString (short stringID)

void	GetIndString (Str255 theString, short strListID, short index)

void	setstring (StringHandle theString, const char *strNew)

StringHandle	newstring (const char *theString)

void	getindstring (char *theString, short strListID, short index)

void	FindWordBreaks (Ptr textPtr, short textLength, short offset, Boolean leadingEdge, BreakTablePtr breaks, OffsetTable offsets, ScriptCode script)

void	LowercaseText (Ptr textPtr, short len, ScriptCode script)

void	UppercaseText (Ptr textPtr, short len, ScriptCode script)

void	StripDiacritics (Ptr textPtr, short len, ScriptCode script)

void	UppercaseStripDiacritics (Ptr textPtr, short len, ScriptCode script)

ScriptRunStatus	FindScriptRun (Ptr textPtr, long textLen, long *lenUsed)

void	FindWord (Ptr textPtr, short textLength, short offset, Boolean leadingEdge, BreakTablePtr breaks, OffsetTable offsets)

void	NFindWord (Ptr textPtr, short textLength, short offset, Boolean leadingEdge, NBreakTablePtr nbreaks, OffsetTable offsets)

void	LwrText (Ptr textPtr, short len)

void	LowerText (Ptr textPtr, short len)

void	StripText (Ptr textPtr, short len)

void	UpperText (Ptr textPtr, short len)

void	StripUpperText (Ptr textPtr, short len)

void	UpperString (Str255 theString, Boolean diacSensitive)

void	upperstring (char *theString, Boolean diacSensitive)

void	UprText (Ptr textPtr, short len)
	Provide non-localizable uppercasing. More...

void	c2pstrcpy (Str255 dst, const char *src)

void	p2cstrcpy (char *dst, ConstStr255Param src)

void	CopyPascalStringToC (ConstStr255Param src, char *dst)

void	CopyCStringToPascal (const char *src, Str255 dst)

StringPtr	c2pstr (char *aStr)

StringPtr	C2PStr (Ptr cString)

char *	p2cstr (StringPtr aStr)

Ptr	P2CStr (StringPtr pString)

Detailed Description

Text Utilities Interfaces.

Introduced In: Mac OS 8

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1985-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ C2PStr [1/2]

#define C2PStr ( a ) (StringPtr) c2pstr((Ptr)(a))

CALL_NOT_IN_CARBON Added for QuickTime 3.0

◆ C2PStr [2/2]

#define C2PStr ( a ) (StringPtr) c2pstr((Ptr)(a))

CALL_NOT_IN_CARBON Added for QuickTime 3.0

Function Documentation

◆ c2pstr()

StringPtr c2pstr ( char * aStr )

c2pstr()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ C2PStr()

StringPtr C2PStr ( Ptr cString )

C2PStr()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ c2pstrcpy()

void c2pstrcpy	(	Str255	dst,
		const char *	src
	)

CALL_NOT_IN_CARBON Functions for converting between C and Pascal Strings (Previously in Strings.h)

Note: CopyPascalStringToC, CopyCStringToPascal, c2pstrcpy, and p2cstrcpy are written to allow inplace conversion. That is, the src and dst parameters can point to the memory location. These functions are available in CarbonLib and CarbonAccessors.o.

Note: c2pstr, C2PStr, p2cstr, and P2CStr are all deprecated. These functions only do inplace conversion and often require casts to call them. This can cause bugs because you can easily cast away a const and change the contents of a read-only buffer. These functions are available in InterfaceLib, or when building for Carbon if you #define OLDP2C, then they are available as a macro. c2pstrcpy()

Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ CopyCStringToPascal()

void CopyCStringToPascal	(	const char *	src,
		Str255	dst
	)

CopyCStringToPascal()

Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ CopyPascalStringToC()

void CopyPascalStringToC	(	ConstStr255Param	src,
		char *	dst
	)

CopyPascalStringToC()

Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ FindScriptRun()

ScriptRunStatus FindScriptRun	(	Ptr	textPtr,
		long	textLen,
		long *	lenUsed
	)

FindScriptRun()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ FindWord()

void FindWord	(	Ptr	textPtr,
		short	textLength,
		short	offset,
		Boolean	leadingEdge,
		BreakTablePtr	breaks,
		OffsetTable	offsets
	)

The following functions are old names, but are required for PowerPC builds because InterfaceLib exports these names, instead of the new ones. FindWord()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ FindWordBreaks()

void FindWordBreaks	(	Ptr	textPtr,
		short	textLength,
		short	offset,
		Boolean	leadingEdge,
		BreakTablePtr	breaks,
		OffsetTable	offsets,
		ScriptCode	script
	)

CALL_NOT_IN_CARBON FindWordBreaks()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ getindstring()

void getindstring	(	char *	theString,
		short	strListID,
		short	index
	)

getindstring()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ GetIndString()

void GetIndString	(	Str255	theString,
		short	strListID,
		short	index
	)

GetIndString()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetString()

StringHandle GetString ( short stringID )

GetString()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ LowercaseText()

void LowercaseText	(	Ptr	textPtr,
		short	len,
		ScriptCode	script
	)

LowercaseText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ LowerText()

void LowerText	(	Ptr	textPtr,
		short	len
	)

LowerText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ LwrText()

void LwrText	(	Ptr	textPtr,
		short	len
	)

On 68K machines, LwrText, LowerText, StripText, UpperText and StripUpperText return an error code in register D0, but System 7 PowerMacs do not emulate this properly, so checking D0 is unreliable. LwrText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ Munger()

long Munger	(	Handle	h,
		long	offset,
		const void *	ptr1,
		long	len1,
		const void *	ptr2,
		long	len2
	)

The following functions are new names that work on 68k and PowerPC Munger()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ newstring()

StringHandle newstring ( const char * theString )

newstring()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ NewString()

StringHandle NewString ( ConstStr255Param theString )

NewString()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NFindWord()

void NFindWord	(	Ptr	textPtr,
		short	textLength,
		short	offset,
		Boolean	leadingEdge,
		NBreakTablePtr	nbreaks,
		OffsetTable	offsets
	)

NFindWord()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ p2cstr()

char* p2cstr ( StringPtr aStr )

p2cstr()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ P2CStr()

Ptr P2CStr ( StringPtr pString )

P2CStr()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ p2cstrcpy()

void p2cstrcpy	(	char *	dst,
		ConstStr255Param	src
	)

p2cstrcpy()

Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ setstring()

void setstring	(	StringHandle	theString,
		const char *	strNew
	)

setstring()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ SetString()

void SetString	(	StringHandle	theString,
		ConstStr255Param	strNew
	)

SetString()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ StripDiacritics()

void StripDiacritics	(	Ptr	textPtr,
		short	len,
		ScriptCode	script
	)

StripDiacritics()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ StripText()

void StripText	(	Ptr	textPtr,
		short	len
	)

StripText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ StripUpperText()

void StripUpperText	(	Ptr	textPtr,
		short	len
	)

StripUpperText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ UppercaseStripDiacritics()

void UppercaseStripDiacritics	(	Ptr	textPtr,
		short	len,
		ScriptCode	script
	)

UppercaseStripDiacritics()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ UppercaseText()

void UppercaseText	(	Ptr	textPtr,
		short	len,
		ScriptCode	script
	)

UppercaseText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ upperstring()

void upperstring	(	char *	theString,
		Boolean	diacSensitive
	)

upperstring()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ UpperString()

void UpperString	(	Str255	theString,
		Boolean	diacSensitive
	)

The following are new names which are exported by InterfaceLib CALL_NOT_IN_CARBON UpperString()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ UpperText()

void UpperText	(	Ptr	textPtr,
		short	len
	)

UpperText()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ UprText()

void UprText	(	Ptr	textPtr,
		short	len
	)

Provide non-localizable uppercasing.

The following are macros which map old names to the names exported by InterfaceLib OLDROUTINENAMES Old routine name but no new names are mapped to it:

Parameters

textPtr

a pointer to the text to be upper cased

  @par Non-Carbon CFM:   in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

Data Structures

Macros

Typedefs

Functions