MLWorks Reference Manual (version 1.0)

Copyright and Trademarks

1 - Introducing the MLWorks Libraries

1.1 - Introduction
1.2 - The top level of the MLWorks interactive environment
1.3 - The MLWorks pervasive library
1.4 - The MLWorks interactive environment library
1.5 - The MLWorks Motif interface library
1.6 - The MLWorks Windows interface library
1.7 - The MLWorks foreign interface library

2 - The MLWorks Interactive Environment Top Level

2.1 - Introduction

2.2 - The MLWorks and Shell structures

2.3 - The General structure

2.4 - Unqualified top-level items

use

3 - The MLWorks Pervasive Library

3.1 - Introduction

3.1.1 - Deprecated and undocumented features
3.1.2 - Supported features

3.2 - Top-level items: Interrupt and arguments

Interrupt
arguments

3.3 - Delivery tools: the Deliver structure

deliverer
delivery_hook
deliver
with_delivery_hook

3.4 - Profiling: the Profile structure

3.4.1 - Code items

3.4.2 - Invoking the profiler

3.4.3 - Profiling manners

3.4.4 - Specifying scan frequency and profiling manner details

3.4.5 - Profiling results

3.4.6 - Time profiling

3.4.7 - Space profiling

3.4.8 - Profiler performance data

3.4.9 - Profile structure values

profile
make_manner
profile
'a result
manner
options
function_profile
function_time_profile
function_caller
function_space_profile
object_kind
object_count
large_size
call_header
space_header
time_header
general_header
ProfileError

3.5 - Threads: the Threads structure

Threads
'a thread
thread_id
'a result
fork
result
sleep
wake
yield
all
children
get_id
get_num
id
kill
parent
raise_in
state
yield_to
set_handler
reset_fatal_status
get_interval
set_interval
on
start
stop

3.6 - Timing facilities: The Time structure

4 - The MLWorks Interactive Environment Library

4.1 - Introduction

4.2 - Top-level items: exit, saveImage and startGUI

exit
saveImage
startGUI

4.3 - Compilation: the Build, File, and Path structures

4.3.1 - Projects and program units

4.3.2 - Describing the location of a program unit on the file system

4.3.2.1 - Shell.Build's portable unit-location notation
4.3.2.2 - Shell.File's unit-location notation

4.3.3 - The Build structure

compile
compileAndLoad
delete
loadObject
loadSource
queryCompile
queryLoadObject
queryLoadSource
readDependencies
touchLoaded
touchSource
touchAllLoaded

4.3.4 - The File structure

4.3.5 - The Path structure

PathError
sourcePath
setSourcePath
pervasive
setPervasive

4.4 - Debugging interface: the Debug structure

4.4.1 - The Debug structure

clear
clearAll
info
infoAll
status
stepThrough

4.4.2 - Trace

breakpoint
unbreakpoint
unbreakAll
trace
untrace
untraceAll
traceFull

4.5 - Profiling: the Profile structure

profile
profileFull
profileSpace
profileTime
profileTool

4.6 - Timing: the Timer structure

time
timeIterations
printTiming

4.7 - Environment options: the Options structure

4.7.1 - Top-level items: 'a option, get and set

'a option
get
set

4.7.2 - The Compiler structure

generateDebugInfo
generateTraceProfileCode
generateVariableDebugInfo
interruptTightLoops
optimizeHandlers
optimizeLeaffns
optimizeSelfTailCalls
optimizeTailCalls
printCompilerMessages

4.7.3 - The Debugger structure

hideAnonymousFrames
hideCFrames
hideDeliveredFrames
hideDuplicateFrames
hideHandlerFrames
hideSetupFrames

4.7.4 - The Internals structure

showAbsyn
showLambda
showOptLambda
showEnviron
showMir
showOptMir
showMach

4.7.5 - The Language structure

oldDefinition
abstractions
opOptional
limitedOpen
weakTyvars
fixityInSignatures
fixityInOpen
requireReservedWord
typeDynamic

4.7.6 - The Mode structure

sml'96
sml'90
compatibility
optimizing
debugging

4.7.7 - The Preferences structure

customEditorName
editor
externalEditorCommand
maximumHistorySize
maximumErrors
useCompletionMenu
useDebugger
useErrorBrowser
useWindowDebugger

4.7.8 - The ValuePrinter structure

showFnDetails
showExnDetails
floatPrecision
maximumSeqSize
maximumStringSize
maximumDepth
maximumRefDepth
maximumStrDepth

4.8 - Editor support: The Editor structure

addCommand
addConnectDialog
names
remove
EditError
editDefinition
editFile

4.9 - Inspecing values: the Inspector structure

InspectError
addInspectMethod
deleteInspectMethod
deleteAllInspectMethods
inspectIt

4.10 - Dynamic types: the Dynamic structure

EvalError
dynamic
type_rep
eval
getType
printType
printValue
inspect

5 - The MLWorks Motif Interface Library

5.1 - Introduction

5.2 - Type conventions

5.3 - Naming conventions

5.4 - Abstract types

5.5 - Exceptions

5.6 - Resources

argument_name
argument_value

5.7 - Initialization

5.8 - Callbacks

5.9 - Events

5.10 - Identifier reference

6 - The MLWorks Windows Interface Library

6.1 - Introduction

6.2 - Type conventions

6.3 - Naming conventions

6.4 - Exceptions

WindowSystemError

6.5 - Data types

word
rect
point
message
window_style
sw_arg
gw_arg
gwl_value
sb_value
esb_value
sc_value
menu_value
menu_flag

6.6 - Type conversion utilities

windowToWord
messageToWord
intToWord
nullWord
wordToString
wordToInt
wordToSignedInt
hiword
loword
nullWindow
isNullWindow
mainLoop
mainInit
doInput
convertSbValue
convertScValue
newControlId

6.7 - Identifier reference

7 - The MLWorks Foreign Interface Library

7.1 - Introduction

7.1.1 - Terminology

7.2 - Overview of the FI

7.2.1 - Loading the FI into MLWorks
7.2.2 - On the C side ...
7.2.3 - On the ML side...
7.2.4 - Summary

7.3 - Some limitations and future extensions

7.4 - The top-level structure: Interface

7.5 - The Store structure

7.5.1 - Machine pointers and stores
7.5.2 - Stores
store
store_status
ReadOnly
WriteOnly
storeStatus
setStoreStatus
alloc_policy
overflow_policy
store
storeSize
storeAlloc
storeOverflow
isStandardStore
isEphemeralStore
ExpandStore
expand

7.6 - The Object structure

object
ReadOnly
WriteOnly
object_mode
objectMode
object_status
objectStatus
OutOfBounds
Currency
objectCurrency
objectSize
objectLocation
objectAddress

7.7 - The Aliens structure

ensureAliens
resetAliens
refreshAliens

7.8 - The LibML structure

registerExternalValue
deleteExternalValue
externalValues
clearExternalValues

7.9 - The Diagnostic structure

viewStore
dispStore
storeInfo
storeData
storeDataHex
storeDataAscii
diffAddr
incrAddr

7.10 - The C structure

MLWorks Reference Manual (version 1.0) - 3 DEC 1996

Generated with Harlequin WebMaker