Muf Reference

• Muf Data Types
  • Data Types Overview
  • Booleans
  • Characters
  • Strings
  • Integers
  • Floats
  • Lists
  • Vectors
  • Structures
  • Symbols
  • Data Type Ownership
  • Data Type Comparisons
  • Data Type Efficiency Considerations
• Muq Classes
  • Muf Classes Overview
  • Class Plain
  • Class Assembler
  • Class MosClass
  • Class MosKey
  • Class CompiledFunction
  • Class Data Stack
  • Class Function
  • Class Hash
  • Class Index
  • Class Job
  • Class JobQueue
  • Class JobSet
  • Class LambdaList
  • Class Lock
  • Class Loop Stack
  • Class MessageStream
  • Class Method
  • Class Muq
  • Class MuqConfiguration
  • Class Package
  • Class Proxy
  • Class Stream
  • Class Session
  • Class Set
  • Class Socket
  • Class Stack
  • Class StructureDefinition
  • Class System
  • Class User
  • Muq Object Efficiency Considerations
• Muq Events
  • Muq Events Motivation
  • Muq Event System Overview
  • Handlers
  • Signalling Events
  • error fn
  • cerror
  • signal
  • Restarts
  • Predefined Events
    • event
    • warning
    • event printJobs
    • seriousEvent
    • abort
    • debug
    • kill
    • error
    • serverError
    • simpleEvent
    • simpleWarning
    • simpleError
    • storageEvent
    • typeError
    • simpleTypeError
    • programError
    • controlError
    • packageError
    • streamError
    • endOfFile
    • fileError
    • cellError
    • unboundVariable
    • undefinedFunction
    • arithmeticError
    • divisionByZero
    • floatingPointOverflow
    • floatingPointUnderflow
    • brokenPipeWarning
    • readFromDeadStreamWarning
    • writeToDeadStreamWarning
  • Muq Event System Wrapup
• Core Muf
  • Core Muf Overview
  • Function Documentation Conventions
  • arithmetic and bitwise functions
  • assembler functions
    • assembler overview
    • assembler after
    • assembleAfterChild
    • assembleAlwaysDo
    • assembleBeq
    • assembleBne
    • assembleBra
    • assembleTag
    • assembleCall
    • assembleCalla
    • assembleCatch
    • assembleConstant
    • assembleConstantSlot
    • assembleConstantGet
    • assembleLabel
    • assembleLabelGet
    • assembleLineInFn
    • assembleVariableGet
    • assembleVariableSet
    • assembleVariableSlot
    • finishAssembly
    • assembler wrapup
  • assignment functions
  • block functions
    • block functions overview
    • [ ... |
    • jobQueueContents[
    • jobQueues[
    • seq[
    • stack[
    • stringChars[
    • stringInts[
    • stringWords[
    • chopString[
    • |=
    • |charInt
    • |delete
    • |deleteNonchars
    • |doCBackslashes
    • |backslashesToHighbit
    • |downcase
    • |dup
    • |dupNth
    • dup[
    • |dup[
    • |extract[
    • |first
    • |for v i do{ ... }
    • |forPairs k v i do{ ... }
    • |ged
    • |gep
    • |get
    • |intChar
    • |keys
    • |unsort
    • |keysKeysvals
    • |abcAbbc
    • |length
    • |pop
    • |popp
    • |popNth
    • ]popNth
    • |push
    • |pushNth
    • |reverse
    • |keysvalsReverse
    • |bracketPosition
    • |charPosition
    • |position
    • |rotate
    • |secureHash
    • |secureDigest
    • |secureHashCheck
    • |signedDigest
    • |signedDigestCheck
    • |dup
    • |setNth
    • |shift
    • |shiftp
    • |shiftp
    • ]shift
    • |sort
    • |subblock[
    • ||swap
    • |keysvalsSort
    • |pairsSort
    • |tsort
    • |tsortMos
    • |uniq
    • |keysvalsUniq
    • |pairsUniq
    • |unshift
    • |upcase
    • |vals
    • ]glueStrings
    • ]join
    • ]makeNumber
    • |findSymbol?
    • |positionInStack?
    • ]makeSymbol
    • ]makeVector
    • ]makeEphemeralVector
    • ]keysvalsMake
    • ]pop
    • ]print
    • ]rootLogPrint
    • ]setLocalVars
    • |]sum
    • ]words
    • ]|join
    • |enbyte
    • |debyte
    • |debyteMuqnetHeader
  • boolean functions
    • and
    • or
    • not
    • null?
  • browsing functions
    • ls lsh lss lsm lsw
    • pf ps pv pxf pxs plv
    • ph
    • pr
    • pj rootPj
  • comparison functions
    • !=
    • <
    • <=
    • =
    • >
    • >=
    • !=-ci
    • <-ci
    • <=-ci
    • =-ci
    • >-ci
    • >=-ci
    • eq
    • eql
    • equal
  • compiler support functions
    • popCatchframe
    • popEphemeralVector
    • popLockframe
    • popTagframe
    • popTagtopframe
    • pushLockframe
    • pushLockframeChild
    • pushTagtopframe
    • pushTagframe
    • pushUserMeFrame
    • rootPushUserFrame
    • rootPushPrivsOmnipotentFrame
    • pushLockframe
    • pushLockframe
    • popUnwindframe
    • readNextMufToken
    • addMufSource
    • continueMufCompile
    • startMufCompile
    • setMufLineNumber
    • mufShell
    • compileMufFile
    • parameter:
    • |potentialNumber?
    • |unreadTokenChar
    • |readTokenChar
    • |readTokenChars
    • |scanTokenToChar
    • |scanTokenToChars
    • |scanTokenToCharPair
    • |scanTokenToWhitespace
    • |scanTokenToNonwhitespace
  • event system functions
    • getNthRestart
    • getRestart
    • invokeRestart
    • invokeRestartInteractively
    • restartName
    • findRestart
    • computeRestarts[
    • |getAllActiveHandlers[
    • ]invokeHandler
    • ]invokeDebugger
    • mufDebugger
    • ]signal
    • ]doSignal
    • doError
    • abort
    • continue
    • muffleWarning
    • storeValue
    • useValue
    • break
    • ]break
    • ]doBreak
    • ]reportEvent
    • ]cerror
    • ]error
    • ]warn
    • why unreliable signals?
    • control structure syntax
  • control structure overview
    • after
    • call
    • catch
    • compileTime
    • for
    • foreach
    • goto
    • if
    • listfor
    • neverInline
    • pleaseInline
    • until
    • do
    • while
    • withLockDo
    • withRestartDo
    • withHandlersDo
    • withTags
    • return
    • case
    • asMeDo
    • rootAsUserDo
    • rootOmnipotentlyDo
  • conversion functions
    • charInt
    • chars2Int
    • chars4Int
    • intChar
    • intChars2
    • intChars4
    • charString
    • stringInt
    • stringKeyword
    • dbrefToInts3
    • ints3ToDbref
    • dnameToInt
    • intToDbname
    • downcase
    • upcase
  • db functions
    • db functions overview
    • db pragmatics
    • rootMakeDb
    • rootExportDb
    • rootImportDb
    • rootRemoveDb
    • rootReplaceDb
    • db functions wrapup
    • db functions future directions
  • debug support functions
    • disassembleCompiledFunction
    • compiledFunctionBytecodes[
    • compiledFunctionDisassembly
    • compiledFunctionDisassembly
    • programCounterToLineNumber
  • function definition syntax
    • function definition syntax
    • Arity declarations
    • Nested functions
    • Recursive functions
    • Anonymous functions
    • Thunks
    • Promises
  • job control functions
    • job control overview
    • copyJob
    • copyJobset
    • copySession
    • debugOff
    • debugOn
    • endJob
    • switchJob
    • exec
    • forkJob
    • forkJobset
    • forkSession
    • pauseJob
    • pidToJob
    • queueJob
    • runJob
    • sleepJob
    • abortJob
    • killJob
    • killJobMessily
    • exitShell
  • keyval functions
    • keyval functions overview
    • ]keysvalsSet
    • ]keysSet
    • delKey
    • delKey?
    • get
    • getFirstKey?
    • getKey?
    • getKeysByPrefix[
    • getNextKey?
    • get?
    • keys[
    • keys[
    • set
    • vals[
    • functions for nonpublic keyvals
  • lisp library
    • lisp library overview
    • read
    • lisp library wrapup
  • list functions
    • list functions overview
    • ]
    • car
    • cdr
    • cons
    • caar &tc
    • append
    • assoc
    • copyAlist
    • copyList
    • copyTree
    • delete
    • deleteif
    • delete
    • eighth
    • end?
    • fifth
    • first
    • fourth
    • getprop
    • last
    • length
    • length2
    • list
    • dottedList
    • listLength
    • mapc
    • mapcan
    • mapcar
    • mapcon
    • mapl
    • maplist
    • member?
    • nconc
    • ninth
    • nreverse
    • nsublis
    • nsubst
    • nsubstIf
    • nsubstIfNot
    • nth
    • fourth
    • printList
    • putprop
    • rassoc
    • remove
    • removeIf
    • remove
    • remprop
    • rest
    • reverse
    • rplaca
    • rplacd
    • second
    • seventh
    • sixth
    • sublis
    • subseq
    • subst
    • substIf
    • substIfNot
    • tenth
    • third
  • loop stack functions
    • loop stack overview
    • countStackframes
    • getStackframe[
  • math functions
    • math functions overview
    • float to int functions
    • exponential and logarithmic functions
    • trigonometric functions
  • message stream functions
    • message stream functions
    • delimitedWriteToOutputStream
    • flush
    • flushStream
    • readByte
    • readChar
    • readValue
    • readStreamByte
    • readStreamChar
    • readStreamValue
    • unreadChar
    • unreadStreamChar
    • readStreamPacket[
    • |readAnyStreamPacket
    • readLine
    • readStreamLine
    • |writeStreamPacket
    • |rootWriteStreamPacket
    • |maybeWriteStreamPacket
    • |rootMaybeWriteStreamPacket
    • writeOutputStream
    • writeStream
    • writeSubstringToStream
    • ]writeStreamByLines
    • rootWriteStream
  • misc functions
    • class
    • copy
    • copyCfn
    • explodeArity
    • implodeArity
    • getMuqnetIo
    • getUniversalTime
    • hash
    • getSocketCharEvent
    • setSocketCharEvent
    • kitchenSinks
    • proxyInfo
    • reset
    • rootLogString
    • rootShutdown
  • object creation functions
    • makeAssembler
    • makeBignum
    • makeEvent
    • makeFunction
    • makeJobQueue
    • makeMuf
    • makeHash
    • makeIndex
    • makePlain
    • makePackage
    • makeLock
    • makeMessageStream
    • makeBidirectionalMessageStream
    • makeStream
    • makeStack
    • makeString
    • makeSymbol
    • makeVector
    • makeEphemeralVector
    • makeSocket
    • makeProxy
  • package functions
    • ]inPackage
    • ]makePackage
    • ]renamePackage
    • deletePackage
    • export
    • findPackage
    • import
    • inPackage
    • intern
    • unexport
    • unintern
    • unusePackage
    • usePackage
  • path functions
    • actingUser
    • actualUser
    • getHere
    • job
    • currentCompiledFunction
    • root
    • self
    • setHere
  • posix functions
    • Choosing a port number
    • rootAllActiveSockets[
    • ]closeSocket
    • ]listenOnSocket
    • ]openSocket
    • ]rootPopenSocket
      • "write-only-1|"
      • "write-only-2|"
      • "read-only-1|"
      • "|unix-string-upcase-1|"
      • "|unix-string-upcase-2|"
  • predicates
    • [?
    • assembler?
    • bignum?
    • bound?
    • callable?
    • char?
    • childOf?
    • mosClass?
    • mosKey?
    • mosObject?
    • compiledFunction?
    • event?
    • cons?
    • constant?
    • control?
    • dataStack?
    • empty?
    • ephemeral?
    • fixnum?
    • float?
    • function?
    • integer?
    • job?
    • jobIsAlive?
    • jobQueue?
    • jobSet?
    • keyword?
    • lambdaList?
    • list?
    • lock?
    • loopStack?
    • method?
    • number?
    • package?
    • messageStream?
    • remote?
    • guest?
    • folk?
    • root?
    • omnipotent? { -> tOrNil }
    • session?
    • socket?
    • stream?
    • stack?
    • structure?
    • thisMosClass?
    • thisStructure?
    • symbol?
    • string?
    • user?
    • vanilla?
    • vector?
  • assertions
    • isAnAssembler
    • isCallable
    • isAChar
    • isAMosClass
    • isAMosKey
    • isAMosObject
    • isACompiledFunction
    • isAnEvent
    • isACons
    • isAConstant
    • isADataStack
    • isAFloat
    • isAFunction
    • isAnInteger
    • isAJob
    • isAJobQueue
    • isAJobSet
    • isAKeyword
    • isALambdaList
    • isAList
    • isALock
    • isALoopStack
    • isAMethod
    • isANumber
    • isAPackage
    • isAMessageStream
    • isASession
    • isASocket
    • isAStream
    • isAStack
    • isAStructure
    • isThisStructure
    • isThisMosClass
    • isASymbol
    • isAString
    • isAUser
    • isEphemeral
    • isVanilla
    • isAVector
  • predicates on chars
    • alphaChar?
    • controlChar?
    • digitChar?
    • graphicChar?
    • hexDigitChar?
    • lowerCase?
    • punctuation?
    • upperCase?
    • whitespace?
  • regular expressions
    • regular expression syntax
    • rex
    • rexBegin
    • rexCancelParen
    • rexCloseParen
    • rexDone?
    • rexEnd
    • rexGetCursor
    • rexGetParen
    • rexMatchCharClass
    • rexMatchDot
    • rexMatchString
    • rexMatchDigit
    • rexMatchWhitespace
    • rexMatchWordboundary
    • rexMatchWordchar
    • rexMatchNondigit
    • rexMatchNonwhitespace
    • rexMatchNonwordboundary
    • rexMatchNonwordchar
    • rexMatchPreviousMatch
    • rexOpenParen
    • rexSetCursor
  • set and index functions
    • ]set
    • ]index
    • union
    • intersection
    • setDifference
  • stack stream and vector functions
    • deleteBth
    • deleteNth
    • depth
    • dup
    • dup2nd
    • dupBth
    • dupNth
    • pop
    • pull
    • push
    • push
    • rot
    • setBth
    • setNth
    • swap
    • sum
    • product
    • unpull
    • unpush
  • string functions
    • editString
    • findLastSubstringCi?
    • findSubstringCi?
    • findNextSubstringCi?
    • findPreviousSubstringCi?
    • substringCi?
    • countLinesInString
    • date
    • expandCStringEscapes
    • findLastSubstring?
    • findSubstring?
    • findNextSubstring?
    • findPreviousSubstring?
    • getLineFromString
    • join
    • print
    • print1
    • print1DataStack
    • printTime
    • ]replaceSubstrings
    • secureHash
    • secureHashBinary
    • secureHashFixnum
    • substring
    • substring?
    • substring[
    • time
    • toDelimitedString
    • stringDowncase
    • stringMixedcase
    • stringUpcase
    • toString
    • trimString
    • unprintFormatString[
    • unprint[
    • wrapString
  • structure functions
    • structure overview
    • ]defstruct
    • structure wrapup
  • low-level structure functions
    • low-level structure overview
    • copyStructureContents
    • copyStructureContents
    • ]makeStructure
    • getStructureSlotProperty
    • setStructureSlotProperty
    • findMosKeySlot
    • getNthStructureSlot
    • setNthStructureSlot
    • getNamedStructureSlot
    • setNamedStructureSlot
    • |errorIfEphemeral
    • low-level structure wrapup
  • MOS functions
    • structure overview
    • ]defclass
    • subclassOf?
    • MOS wrapup
  • low-level MOS functions
    • low-level MOS overview
    • makeMosClass
    • makeMosKey
    • makeLambdaList
    • makeMethod
    • getMosKey
    • linkMosKeyToAncestor
    • unlinkMosKeyFromAncestor
    • nextMosKeyLink
    • getMosKeyAncestor
    • getMosKeyAncestor?
    • setMosKeyAncestor
    • getMosKeyParent
    • setMosKeyParent
    • getMosKeySlotProperty
    • setMosKeySlotProperty
    • getMosKeyInitarg
    • getMosKeyInitarg
    • getMosKeyMetharg
    • getMosKeyMetharg
    • getMosKeySlotarg
    • getMosKeySlotarg
    • getMosKeyObjectMethod
    • setMosKeyObjectMethod
    • getMosKeyClassMethod
    • setMosKeyClassMethod
    • insertMosKeyClassMethod
    • deleteMosKeyClassMethod
    • insertMosKeyObjectMethod
    • deleteMosKeyObjectMethod
    • findMosKeyClassMethod?
    • findMosKeyObjectMethod?
    • getLambdaSlotProperty
    • setLambdaSlotProperty
    • getMethodSlot
    • setMethodSlot
    • |applicableMethod?
    • methodsMatch?
    • mosKeyUnsharedSlotsMatch?
    • copyMosKeySlot
    • mosPredenceList[
    • |applyLambdaList
    • low-level MOS wrapup
  • low-level MOS functions
    • low-level btree overview
    • makeHashedBtree
    • makeSortedBtree
    • btreeGet
    • btreeSet
    • btreeDelete
    • btreeFirst
    • btreeNext
    • copyBtree
    • low-level btree wrapup
  • symbol functions
    • symbolFunction
    • setSymbolFunction
    • symbolName
    • symbolPlist
    • setSymbolPlist
    • symbolType
    • setSymbolType
    • symbolValue
    • setSymbolValue
    • unbindSymbol
  • sysadmin functions
    • sysadmin overview
    • rootCollectGarbage
    • rootDoBckup
    • rootMakeDbfile
    • rootMakeGuest { [ | -> [ guest | }
    • rootMakeUser { [ proposedDbfileName | -> [ user | }
    • rootMakeAUser
    • rootAddUser
    • rootAcceptLogins
    • rootAcceptLoginsOn
    • rootBecomeUser
    • symbolFunction
  • sysadmin functions
    • sysadmin overview
    • telnet start
    • telnet stop
    • maybeStartTelnetDaemon
    • dontEcho
    • doEcho
    • willEcho
    • wontEcho
    • wantWontTelnetSocketOption
    • wantWillTelnetSocketOption
    • wantDontTelnetSocketOption
    • wantDoTelnetSocketOption
    • ]unsupportedOptionHandler
    • ]supportedOptionHandler
    • telnet wrapup
  • user i/o functions
    • user i/o overview
    • queryForFloat
    • queryForInt
    • queryForString
    • ]queryForChoice
    • user i/o wrapup
  • graphics functions
    • graphics functions overview
    • bias
    • clamp
    • crossProduct
    • distance
    • dotProduct
    • fBm
    • gain
    • gammacorrect
    • gnoise
    • magnitude
    • mix
    • normalize
    • rayHitsSphereAt
    • smoothstep
    • spline
    • step
    • turbulence
    • vcnoise
    • vnoise
    • graphics functions wrapup
  • x functions
    • x overview
    • ]create-gcontext
    • ]create-window
    • ]draw-glyphs
    • ]draw-image-glyphs
    • ]make-event-mask
    • ]text-extents
    • close-display
    • destroy-subwindows
    • destroy-window
    • display-roots[
    • drawable-border-width
    • drawable-depth
    • drawable-display
    • drawable-height
    • drawable-width
    • drawable-x
    • drawable-y
    • flush-display
    • font-ascent
    • font-descent
    • gcontext-background
    • gcontext-font
    • gcontext-foreground
    • map-subwindows
    • map-window
    • open-font
    • query-pointer
    • root-open-display
    • screen-black-pixel
    • screen-root
    • screen-white-pixel
    • unmap-subwindows
    • unmap-window
    • x amples
    • x wrapup
  • Core Muf Wrapup
• Muq Plans
• Function Index
• Variable Index
• Data Type Index
• Concept Index