man/man3/Tcl_MacEvalResource.3 - toolchains/skids - Git at Google

 '\"
 '\" Copyright (c) 1997-1998 Sun Microsystems, Inc.
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
 '\" RCS: @(#) $Id: Macintosh.3,v 1.3 2003/01/21 19:39:59 hunt Exp $
 '\"
 '\" The definitions below are for supplemental macros used in Tcl/Tk
 '\" manual entries.
 '\"
 '\" .AP type name in/out ?indent?
 '\"	Start paragraph describing an argument to a library procedure.
 '\"	type is type of argument (int, etc.), in/out is either "in", "out",
 '\"	or "in/out" to describe whether procedure reads or modifies arg,
 '\"	and indent is equivalent to second arg of .IP (shouldn't ever be
 '\"	needed;  use .AS below instead)
 '\"
 '\" .AS ?type? ?name?
 '\"	Give maximum sizes of arguments for setting tab stops.  Type and
 '\"	name are examples of largest possible arguments that will be passed
 '\"	to .AP later.  If args are omitted, default tab stops are used.
 '\"
 '\" .BS
 '\"	Start box enclosure.  From here until next .BE, everything will be
 '\"	enclosed in one large box.
 '\"
 '\" .BE
 '\"	End of box enclosure.
 '\"
 '\" .CS
 '\"	Begin code excerpt.
 '\"
 '\" .CE
 '\"	End code excerpt.
 '\"
 '\" .VS ?version? ?br?
 '\"	Begin vertical sidebar, for use in marking newly-changed parts
 '\"	of man pages.  The first argument is ignored and used for recording
 '\"	the version when the .VS was added, so that the sidebars can be
 '\"	found and removed when they reach a certain age.  If another argument
 '\"	is present, then a line break is forced before starting the sidebar.
 '\"
 '\" .VE
 '\"	End of vertical sidebar.
 '\"
 '\" .DS
 '\"	Begin an indented unfilled display.
 '\"
 '\" .DE
 '\"	End of indented unfilled display.
 '\"
 '\" .SO
 '\"	Start of list of standard options for a Tk widget.  The
 '\"	options follow on successive lines, in four columns separated
 '\"	by tabs.
 '\"
 '\" .SE
 '\"	End of list of standard options for a Tk widget.
 '\"
 '\" .OP cmdName dbName dbClass
 '\"	Start of description of a specific option.  cmdName gives the
 '\"	option's name as specified in the class command, dbName gives
 '\"	the option's name in the option database, and dbClass gives
 '\"	the option's class in the option database.
 '\"
 '\" .UL arg1 arg2
 '\"	Print arg1 underlined, then print arg2 normally.
 '\"
 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
 '\"
 '\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 .if t .wh -1.3i ^B
 .nr ^l \n(.l
 .ad b
 '\"	# Start an argument description
 .de AP
 .ie !"\\$4"" .TP \\$4
 .el \{\
 .   ie !"\\$2"" .TP \\n()Cu
 .   el          .TP 15
 .\}
 .ta \\n()Au \\n()Bu
 .ie !"\\$3"" \{\
 \&\\$1	\\fI\\$2\\fP	(\\$3)
 .\".b
 .\}
 .el \{\
 .br
 .ie !"\\$2"" \{\
 \&\\$1	\\fI\\$2\\fP
 .\}
 .el \{\
 \&\\fI\\$1\\fP
 .\}
 .\}
 ..
 '\"	# define tabbing values for .AP
 .de AS
 .nr )A 10n
 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 .nr )B \\n()Au+15n
 .\"
 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 ..
 .AS Tcl_Interp Tcl_CreateInterp in/out
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
 .de BS
 .br
 .mk ^y
 .nr ^b 1u
 .if n .nf
 .if n .ti 0
 .if n \l'\\n(.lu\(ul'
 .if n .fi
 ..
 '\"	# BE - end boxed text (draw box now)
 .de BE
 .nf
 .ti 0
 .mk ^t
 .ie n \l'\\n(^lu\(ul'
 .el \{\
 .\"	Draw four-sided box normally, but don't draw top of
 .\"	box if the box started on an earlier page.
 .ie !\\n(^b-1 \{\
 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .el \}\
 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .\}
 .fi
 .br
 .nr ^b 0
 ..
 '\"	# VS - start vertical sidebar
 '\"	# ^Y = starting y location
 '\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
 .de VS
 .if !"\\$2"" .br
 .mk ^Y
 .ie n 'mc \s12\(br\s0
 .el .nr ^v 1u
 ..
 '\"	# VE - end of vertical sidebar
 .de VE
 .ie n 'mc
 .el \{\
 .ev 2
 .nf
 .ti 0
 .mk ^t
 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 .sp -1
 .fi
 .ev
 .\}
 .nr ^v 0
 ..
 '\"	# Special macro to handle page bottom:  finish off current
 '\"	# box/sidebar if in box/sidebar mode, then invoked standard
 '\"	# page bottom macro.
 .de ^B
 .ev 2
 'ti 0
 'nf
 .mk ^t
 .if \\n(^b \{\
 .\"	Draw three-sided box if this is the box's first page,
 .\"	draw two sides but no top otherwise.
 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .\}
 .if \\n(^v \{\
 .nr ^x \\n(^tu+1v-\\n(^Yu
 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 .\}
 .bp
 'fi
 .ev
 .if \\n(^b \{\
 .mk ^y
 .nr ^b 2
 .\}
 .if \\n(^v \{\
 .mk ^Y
 .\}
 ..
 '\"	# DS - begin display
 .de DS
 .RS
 .nf
 .sp
 ..
 '\"	# DE - end display
 .de DE
 .fi
 .RE
 .sp
 ..
 '\"	# SO - start of list of standard options
 .de SO
 .SH "STANDARD OPTIONS"
 .LP
 .nf
 .ta 5.5c 11c
 .ft B
 ..
 '\"	# SE - end of list of standard options
 .de SE
 .fi
 .ft R
 .LP
 See the \\fBoptions\\fR manual entry for details on the standard options.
 ..
 '\"	# OP - start of full description for a single option
 .de OP
 .LP
 .nf
 .ta 4c
 Command-Line Name:	\\fB\\$1\\fR
 Database Name:	\\fB\\$2\\fR
 Database Class:	\\fB\\$3\\fR
 .fi
 .IP
 ..
 '\"	# CS - begin code excerpt
 .de CS
 .RS
 .nf
 .ta .25i .5i .75i 1i
 ..
 '\"	# CE - end code excerpt
 .de CE
 .fi
 .RE
 ..
 .de UL
 \\$1\l'|0\(ul'\\$2
 ..
 .TH Tcl_MacSetEventProc 3 "8.1" Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
 Tcl_MacSetEventProc, Tcl_MacConvertTextResource, Tcl_MacEvalResource, Tcl_MacFindResource, Tcl_GetOSTypeFromObj, Tcl_SetOSTypeObj, Tcl_NewOSTypeObj \- procedures to handle Macintosh resources and other Macintosh specifics
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
 .sp
 int
 \fBTcl_MacEvalResource\fR(\fIinterp, resourceName, resourceNumber, fileName\fR)
 .sp
 char*
 \fBTcl_MacConvertTextResource\fR(\fIresource\fR)
 .sp
 Handle
 \fBTcl_MacFindResource\fR(\fIinterp, resourceType, resourceName, resourceNumber, resFileRef, releaseIt\fR)
 .sp
 Tcl_Obj*
 \fBTcl_NewOSTypeObj\fR(\fInewOSType\fR)
 .sp
 void
 \fBTcl_SetOSTypeObj\fR(\fIobjPtr, newOSType\fR)
 .sp
 int
 \fBTcl_GetOSTypeFromObj\fR(\fIinterp, objPtr, osTypePtr\fR)
 .sp
 void
 \fBTcl_MacSetEventProc\fR(\fIprocPtr\fR)
 .SH ARGUMENTS
 .AP Tcl_Interp *interp in
 Interpreter to use for error reporting, or NULL if no error reporting is
 desired.
 .AP "CONST char" *resourceName in
 Name of TEXT resource to source, NULL if number should be used.
 .AP int resourceNumber in
 Resource id of source.
 .AP "CONST char" *fileName in
 Name of file to process. NULL if application resource.
 .AP Handle resource in
 Handle to TEXT resource.
 .AP long resourceType in
 Type of resource to load.
 .AP "CONST char" *resFileRef in
 Registered resource file reference, NULL if searching all open resource files.
 .AP int *releaseIt out
 Should we release this resource when done.
 .AP int newOSType in
 Int used to initialize the new object or set the object's value.
 .AP Tcl_Obj *objPtr in
 Object whose internal representation is to be set or retrieved.
 .AP osTypePtr out
 Place to store the resulting integer.
 .AP Tcl_MacConvertEventPtr procPtr in
 Reference to the new function to handle all incoming Mac events.

 .BE
 .SH INTRODUCTION
 .PP
 The described routines are used to implement the Macintosh specific
 \fBresource\fR command and the Mac specific notifier.. They manipulate
 or use Macintosh resources and provide administration for open
 resource file references.

 .SH DESCRIPTION
 .PP
 \fBTcl_MacEvalResource\fR extends the \fBsource\fR command to
 Macintosh resources.  It sources Tcl code from a Text resource.
 Currently only sources the resource by name, file IDs may be supported
 at a later date.
 .PP
 \fBTcl_MacConvertTextResource\fR converts a TEXT resource into a Tcl
 suitable string. It mallocs the returned memory, converts ``\\r'' to
 ``\\n'', and appends a NULL. The caller has the responsibility for
 freeing the memory.
 .PP
 \fBTcl_MacFindResource\fR provides a higher level interface for
 loading resources. It is used by \fBresource read\fR.
 .PP
 \fBTcl_NewOSTypeObj\fR is used to create a new resource name type
 object. The object type is "ostype".
 .PP
 \fBTcl_SetOSTypeObj\fR modifies an object to be a resource type and to
 have the specified long value.
 .PP
 \fBTcl_GetOSTypeFromObj\fR attempts to return an int from the Tcl
 object "objPtr". If the object is not already an int, an attempt will
 be made to convert it to one.
 .PP
 \fBTcl_MacSetEventProc\fR sets the event handling procedure for the
 application. This function will be passed all incoming Mac events.
 This function usually controls the console or some other entity like
 Tk.

 .SH RESOURCE TYPES
 .PP
 Resource types are 4-byte values used by the macintosh resource
 facility to tag parts of the resource fork in a file so that the OS
 knows how to handle them. As all 4 bytes are restricted to printable
 characters such a type can be interpreted as a 4 character string too.

 .SH KEYWORDS
 macintosh, mac, resource, notifier
	'\"
	'\" Copyright (c) 1997-1998 Sun Microsystems, Inc.
	'\"
	'\" See the file "license.terms" for information on usage and redistribution
	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	'\"
	'\" RCS: @(#) $Id: Macintosh.3,v 1.3 2003/01/21 19:39:59 hunt Exp $
	'\"
	'\" The definitions below are for supplemental macros used in Tcl/Tk
	'\" manual entries.
	'\"
	'\" .AP type name in/out ?indent?
	'\" Start paragraph describing an argument to a library procedure.
	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	'\" or "in/out" to describe whether procedure reads or modifies arg,
	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	'\" needed; use .AS below instead)
	'\"
	'\" .AS ?type? ?name?
	'\" Give maximum sizes of arguments for setting tab stops. Type and
	'\" name are examples of largest possible arguments that will be passed
	'\" to .AP later. If args are omitted, default tab stops are used.
	'\"
	'\" .BS
	'\" Start box enclosure. From here until next .BE, everything will be
	'\" enclosed in one large box.
	'\"
	'\" .BE
	'\" End of box enclosure.
	'\"
	'\" .CS
	'\" Begin code excerpt.
	'\"
	'\" .CE
	'\" End code excerpt.
	'\"
	'\" .VS ?version? ?br?
	'\" Begin vertical sidebar, for use in marking newly-changed parts
	'\" of man pages. The first argument is ignored and used for recording
	'\" the version when the .VS was added, so that the sidebars can be
	'\" found and removed when they reach a certain age. If another argument
	'\" is present, then a line break is forced before starting the sidebar.
	'\"
	'\" .VE
	'\" End of vertical sidebar.
	'\"
	'\" .DS
	'\" Begin an indented unfilled display.
	'\"
	'\" .DE
	'\" End of indented unfilled display.
	'\"
	'\" .SO
	'\" Start of list of standard options for a Tk widget. The
	'\" options follow on successive lines, in four columns separated
	'\" by tabs.
	'\"
	'\" .SE
	'\" End of list of standard options for a Tk widget.
	'\"
	'\" .OP cmdName dbName dbClass
	'\" Start of description of a specific option. cmdName gives the
	'\" option's name as specified in the class command, dbName gives
	'\" the option's name in the option database, and dbClass gives
	'\" the option's class in the option database.
	'\"
	'\" .UL arg1 arg2
	'\" Print arg1 underlined, then print arg2 normally.
	'\"
	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
	'\"
	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
	.if t .wh -1.3i ^B
	.nr ^l \n(.l
	.ad b
	'\" # Start an argument description
	.de AP
	.ie !"\\$4"" .TP \\$4
	.el \{\
	. ie !"\\$2"" .TP \\n()Cu
	. el .TP 15
	.\}
	.ta \\n()Au \\n()Bu
	.ie !"\\$3"" \{\
	\&\\$1 \\fI\\$2\\fP (\\$3)
	.\".b
	.\}
	.el \{\
	.br
	.ie !"\\$2"" \{\
	\&\\$1 \\fI\\$2\\fP
	.\}
	.el \{\
	\&\\fI\\$1\\fP
	.\}
	.\}
	..
	'\" # define tabbing values for .AP
	.de AS
	.nr )A 10n
	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
	.nr )B \\n()Au+15n
	.\"
	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
	.nr )C \\n()Bu+\\w'(in/out)'u+2n
	..
	.AS Tcl_Interp Tcl_CreateInterp in/out
	'\" # BS - start boxed text
	'\" # ^y = starting y location
	'\" # ^b = 1
	.de BS
	.br
	.mk ^y
	.nr ^b 1u
	.if n .nf
	.if n .ti 0
	.if n \l'\\n(.lu\(ul'
	.if n .fi
	..
	'\" # BE - end boxed text (draw box now)
	.de BE
	.nf
	.ti 0
	.mk ^t
	.ie n \l'\\n(^lu\(ul'
	.el \{\
	.\" Draw four-sided box normally, but don't draw top of
	.\" box if the box started on an earlier page.
	.ie !\\n(^b-1 \{\
	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.el \}\
	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.\}
	.fi
	.br
	.nr ^b 0
	..
	'\" # VS - start vertical sidebar
	'\" # ^Y = starting y location
	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
	.de VS
	.if !"\\$2"" .br
	.mk ^Y
	.ie n 'mc \s12\(br\s0
	.el .nr ^v 1u
	..
	'\" # VE - end of vertical sidebar
	.de VE
	.ie n 'mc
	.el \{\
	.ev 2
	.nf
	.ti 0
	.mk ^t
	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
	.sp -1
	.fi
	.ev
	.\}
	.nr ^v 0
	..
	'\" # Special macro to handle page bottom: finish off current
	'\" # box/sidebar if in box/sidebar mode, then invoked standard
	'\" # page bottom macro.
	.de ^B
	.ev 2
	'ti 0
	'nf
	.mk ^t
	.if \\n(^b \{\
	.\" Draw three-sided box if this is the box's first page,
	.\" draw two sides but no top otherwise.
	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.\}
	.if \\n(^v \{\
	.nr ^x \\n(^tu+1v-\\n(^Yu
	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
	.\}
	.bp
	'fi
	.ev
	.if \\n(^b \{\
	.mk ^y
	.nr ^b 2
	.\}
	.if \\n(^v \{\
	.mk ^Y
	.\}
	..
	'\" # DS - begin display
	.de DS
	.RS
	.nf
	.sp
	..
	'\" # DE - end display
	.de DE
	.fi
	.RE
	.sp
	..
	'\" # SO - start of list of standard options
	.de SO
	.SH "STANDARD OPTIONS"
	.LP
	.nf
	.ta 5.5c 11c
	.ft B
	..
	'\" # SE - end of list of standard options
	.de SE
	.fi
	.ft R
	.LP
	See the \\fBoptions\\fR manual entry for details on the standard options.
	..
	'\" # OP - start of full description for a single option
	.de OP
	.LP
	.nf
	.ta 4c
	Command-Line Name: \\fB\\$1\\fR
	Database Name: \\fB\\$2\\fR
	Database Class: \\fB\\$3\\fR
	.fi
	.IP
	..
	'\" # CS - begin code excerpt
	.de CS
	.RS
	.nf
	.ta .25i .5i .75i 1i
	..
	'\" # CE - end code excerpt
	.de CE
	.fi
	.RE
	..
	.de UL
	\\$1\l'\|0\(ul'\\$2
	..
	.TH Tcl_MacSetEventProc 3 "8.1" Tcl "Tcl Library Procedures"
	.BS
	.SH NAME
	Tcl_MacSetEventProc, Tcl_MacConvertTextResource, Tcl_MacEvalResource, Tcl_MacFindResource, Tcl_GetOSTypeFromObj, Tcl_SetOSTypeObj, Tcl_NewOSTypeObj \- procedures to handle Macintosh resources and other Macintosh specifics
	.SH SYNOPSIS
	.nf
	\fB#include <tcl.h>\fR
	.sp
	int
	\fBTcl_MacEvalResource\fR(\fIinterp, resourceName, resourceNumber, fileName\fR)
	.sp
	char*
	\fBTcl_MacConvertTextResource\fR(\fIresource\fR)
	.sp
	Handle
	\fBTcl_MacFindResource\fR(\fIinterp, resourceType, resourceName, resourceNumber, resFileRef, releaseIt\fR)
	.sp
	Tcl_Obj*
	\fBTcl_NewOSTypeObj\fR(\fInewOSType\fR)
	.sp
	void
	\fBTcl_SetOSTypeObj\fR(\fIobjPtr, newOSType\fR)
	.sp
	int
	\fBTcl_GetOSTypeFromObj\fR(\fIinterp, objPtr, osTypePtr\fR)
	.sp
	void
	\fBTcl_MacSetEventProc\fR(\fIprocPtr\fR)
	.SH ARGUMENTS
	.AP Tcl_Interp *interp in
	Interpreter to use for error reporting, or NULL if no error reporting is
	desired.
	.AP "CONST char" *resourceName in
	Name of TEXT resource to source, NULL if number should be used.
	.AP int resourceNumber in
	Resource id of source.
	.AP "CONST char" *fileName in
	Name of file to process. NULL if application resource.
	.AP Handle resource in
	Handle to TEXT resource.
	.AP long resourceType in
	Type of resource to load.
	.AP "CONST char" *resFileRef in
	Registered resource file reference, NULL if searching all open resource files.
	.AP int *releaseIt out
	Should we release this resource when done.
	.AP int newOSType in
	Int used to initialize the new object or set the object's value.
	.AP Tcl_Obj *objPtr in
	Object whose internal representation is to be set or retrieved.
	.AP osTypePtr out
	Place to store the resulting integer.
	.AP Tcl_MacConvertEventPtr procPtr in
	Reference to the new function to handle all incoming Mac events.

	.BE
	.SH INTRODUCTION
	.PP
	The described routines are used to implement the Macintosh specific
	\fBresource\fR command and the Mac specific notifier.. They manipulate
	or use Macintosh resources and provide administration for open
	resource file references.

	.SH DESCRIPTION
	.PP
	\fBTcl_MacEvalResource\fR extends the \fBsource\fR command to
	Macintosh resources. It sources Tcl code from a Text resource.
	Currently only sources the resource by name, file IDs may be supported
	at a later date.
	.PP
	\fBTcl_MacConvertTextResource\fR converts a TEXT resource into a Tcl
	suitable string. It mallocs the returned memory, converts ``\\r'' to
	``\\n'', and appends a NULL. The caller has the responsibility for
	freeing the memory.
	.PP
	\fBTcl_MacFindResource\fR provides a higher level interface for
	loading resources. It is used by \fBresource read\fR.
	.PP
	\fBTcl_NewOSTypeObj\fR is used to create a new resource name type
	object. The object type is "ostype".
	.PP
	\fBTcl_SetOSTypeObj\fR modifies an object to be a resource type and to
	have the specified long value.
	.PP
	\fBTcl_GetOSTypeFromObj\fR attempts to return an int from the Tcl
	object "objPtr". If the object is not already an int, an attempt will
	be made to convert it to one.
	.PP
	\fBTcl_MacSetEventProc\fR sets the event handling procedure for the
	application. This function will be passed all incoming Mac events.
	This function usually controls the console or some other entity like
	Tk.

	.SH RESOURCE TYPES
	.PP
	Resource types are 4-byte values used by the macintosh resource
	facility to tag parts of the resource fork in a file so that the OS
	knows how to handle them. As all 4 bytes are restricted to printable
	characters such a type can be interpreted as a 4 character string too.

	.SH KEYWORDS
	macintosh, mac, resource, notifier