Soup Functions

Soup Defs

A registered soup def frame is stored in memory. In addition, soup defs are stored in the soup itself (as part of an info frame stored with the soup). In this way, as long as one member soup of a union soup exists, other members can be created on other stores.

Here are the slots of a soup def:

name
A string that represents the name of your soup. This should be unique (see "Creating Unique Application Symbols and Names" on page 419 for more details). An example is "Pigs:Calliope".

userName
Optional. A user-visible string that is the name of your soup. This need not be unique. An example is "Pigs".

ownerApp
The application symbol of the owner of this soup. An example is '|Pigs:Calliope|.

ownerAppName
Optional. A user-visible string that is the name of the application which owns this soup. An example is "Pig Management".

userDescr
Optional. A user-visible string describing the soup. An example is "This soup contains pigs and is used by the Pig Management application".

indexes
Optional. An array of index specification frames (see "Index Specification Frames" on page 245). An example is [{structure: 'slot, path: 'pigName, type: 'string}].

initHook
Optional. A function which is called when the soup is created. Or, this can be a symbol specifying a message to send to the base view of the ownerApp application. This is one way to initialize a new soup.


An online version of Programming for the Newton using Macintosh, 2nd ed. ©1996, 1994, Julie McKeehan and Neil Rhodes.

Last modified: 1 DEC 1996