DIRECTORY
IO USING [ STREAM ],
Lark USING [
CommandEvents, ConnectionSpec, disabled, enabled, Event, KeyTable, LarkModel, o3i1, StatusEvent, ToneSpec, ts0 ],
LarkPlay USING [ ToneList, ToneSpec ],
LarkRpcControl USING [ InterfaceRecord ],
MBQueue USING [ Queue ],
Rope USING [ROPE],
BasicTime USING [ GMT ],
Thrush USING [
ConversationID, ConvEvent, ConvEventBody, NB, NetAddress, nullID, nullConvID, PartyID, ProseSpec, ProseSpecs, Reason, ROPE, SHHH, SmartsID, StateInConv ],
ThParty USING [ PartyInfo ],
ThPartyPrivate USING [ SmartsData ],
ThSmartsRpcControl USING [ InterfaceRecord ]
;

ThSmartsPrivate: CEDAR DEFINITIONS = {
SHHH: TYPE = Thrush.SHHH;
SmartsData: TYPE = ThPartyPrivate.SmartsData;

ParseState: TYPE = {
idle,  getStr, getSeq, getFeep, getNum,  inStr, inSeq, inFeep, inNum,  inTossStr };

LarkState: TYPE = {
none,					-- Initial state
idle,					-- Phone not in use
talking,				-- Etherphone conversation in progress
trunkSignalling,		-- "Feeping"
trunkTalking,		-- Standard telephone conversation in progress
trunkForwarding, -- Like trunkTalking, but call is forwarded to some other Lark
trunkFlashing,		-- Implementing special switchhook flash
failed,				-- This Lark has died and its brain is dying, too.
recovering,			-- Lark is presumed not to work, but use attempts don't raise ERRORS
ringing,				-- Ringing loudly through Lark speaker
silence,				-- Dial tone has been broken, dialing in progress.
dialTone,				-- Caller hears dial tone.
ringBack,				-- Caller hears ringing.
busyTone,			-- Caller hears busy signal.
errorTone				-- Caller hears fast busy signal.
};
ProgressTones: TYPE = LarkState[dialTone..errorTone];

HookState: TYPE = { onhook, telset, spkr, sPkr, spKr, both, bOth, monitor };

TerminalType: TYPE = {std, spkr, monitor, radio};

RingDetState: TYPE = { idle, maybe, ring, between };

Orig: TYPE = { unknown, us, them };

click: Lark.Event = Lark.ts0; -- Momentary closure of speaker box switch.

LSwitches: TYPE = {
xBarAll, hook, aSwitch, sideTone, ringO, revert, revertHook, led, spMode, none };
LState: TYPE = RECORD [
voiceMode: Lark.Event_Lark.o3i1,
echoStyle: [0..3]_0,
xbar: PACKED ARRAY[0..8) OF [0..256) _ ALL[0],
lSw: ARRAY LSwitches OF Lark.Event _ ALL[Lark.disabled]
];

SmartsInfo: TYPE = REF SmartsInfoBody;
SmartsInfoBody: TYPE = MONITORED RECORD
[
smartsID: Thrush.SmartsID, -- back pointer to my smarts.
otherSmartsID: Thrush.SmartsID_Thrush.nullID,
larkInfo: LarkInfo,
conversations: OpenConversations_NIL,
currentConvID: Thrush.ConversationID_Thrush.nullConvID, -- the one we're dealing with.
requests: MBQueue.Queue_NIL, -- serialize progress reports, requests for actions
ParseEvent: PROC[smartsInfo: SmartsInfo, sEvent: Lark.StatusEvent],
Command: PROC[info: SmartsInfo, val: INT_0]_NIL,
NoteNewStateP: PROC[cDesc: ConvDesc, convEvent: Thrush.ConvEvent]_NIL,
lastTouchpadChar: Lark.Event _ '\000,
parseState: ParseState _ $idle,
arguments: Rope.ROPE_NIL,
argLength: NAT_0,
offset: NAT_0,	-- kludge allowing more than ten touchpad commands
haveArguments, cmdOrRecip, haveOne: BOOLEAN_FALSE
];

OpenConversations: TYPE = LIST OF ConvDesc;
ConvDesc: TYPE = REF ConvDescBody;
ConvDescBody: TYPE = RECORD [
info: SmartsInfo,								-- corresponding to credentials.smartsID (or else!)
situation: Thrush.ConvEventBody, 		-- .self describes current state in conv.
keyTable: Lark.KeyTable _ NIL
];
ConvRequest: TYPE = REF ConvRequestBody;
ConvRequestBody: TYPE = RECORD [
cDesc: ConvDesc, -- present state,
desiredSituation: Thrush.ConvEventBody _ []
];

TrunkBundle: TYPE= RECORD [
spec: ThParty.PartyInfo, -- connection specifications
ropeSpec:  Rope.ROPE
];

LarkInfo: TYPE = REF LarkInfoBody;
LarkInfoBody: TYPE = MONITORED RECORD
[
interface: LarkRpcControl.InterfaceRecord, -- here's how you make calls to Lark --
shh: SHHH, -- here's what you use to encrypt them --
larkSmartsInfo: SmartsInfo,		-- back pointers
larkTrunkSmartsInfo: SmartsInfo,		-- back pointers
netAddress: Thrush.NetAddress,	-- <<needed when creating socket numbers?>> --
model: Lark.LarkModel,	-- what does this Lark look like? --
debugIn: IO.STREAM,  debugPrint: IO.STREAM_NIL,

larkState: LarkState _ $none, 	-- tone/crossbar/connect state of actual Lark hardware
newActions: LIST OF REF_NIL, -- queue of low-level requests to supervisor process
lastAction: LIST OF REF_NIL, -- used in request-queue maintenance,
larkProcess: PROCESS_NIL,	-- maintains same
stateChange: CONDITION,		-- larkProcess should notice change
hookState: HookState _ $onhook, -- state of switchhook/speakerphone switch...
terminalType: TerminalType _ $std, -- telset, speakerphone, or monitor switching.
textToSpeech: BOOL_FALSE,	-- Prose 2000 synthesizer is available on this Lark.

forwardedCall: BOOL_FALSE,
spec: ThParty.PartyInfo_NIL,
cSpec: Lark.ConnectionSpec_NIL,
keyTable: Lark.KeyTable _ NIL,
toneSpec: LarkPlay.ToneSpec_NIL,
nextToneList: LIST OF LarkPlay.ToneList_NIL,
larkToneSpec: Lark.ToneSpec_NIL,
proseResponse: Rope.ROPE_NIL,  -- holds incomplete Prose responses
flushJustFinished: BOOL_FALSE,  -- can expect to have to flush proseQueue next time thru LarkInImpl.HandleProseOutput
proseQueue: LarkProseQueue_NIL,  -- holds queue of client markers and proseSpecs
pTail: LarkProseQueue_NIL,
textToSpeak: Rope.ROPE_NIL,
clientMarker: INT_maxClientMarker,
controlMarker: INT_maxControlMarker,
ctrlMarkerQueue: LIST OF REF ANY_NIL,  -- holds queue of control markers
pktsOutstanding: INT_0,
flushInProgress: BOOL_FALSE,  -- consider combining w flushJustFinished?
swOnTime: CARDINAL_0,

ringChangeTime: CARDINAL_0,
ringDetState: RingDetState _ $idle,
ringDetCondition: CONDITION,
ringDetInstance: INT_0,	-- timeout routine is relevant only if this matches

expectedNotification: Lark.Event _ 'z,
receivedNotification: Lark.Event _ 'Y, 

lastTerminalType: TerminalType _ $std,
lState: LState _ [lSw: ALL[Lark.enabled]],
scratchEv:  Lark.CommandEvents _ NIL
];
LarkProseQueue: TYPE = LIST OF LarkProseSpecBody;
LarkProseSpecBody: TYPE = RECORD [
proseSpec: Thrush.ProseSpec_NIL,
proseMarker: INT_0
];

ProseCmd: TYPE = Rope.ROPE;
indexMarkerEnd: CHAR = 'i;
maxClientMarker: INT = 199;
maxControlMarker: INT = 250;
pReset: ProseCmd; -- = "\022" (ControlR)
pResetConfirmEnd: CHAR = 'R;
stopAndFlush: ProseCmd;  -- = "\033[S" (\033 is ESC)
stopAndFlushEnd: CHAR = 'S;
flushMarker: INT = 1000;
proseFailure: INT = 1001;


EnterLarkState: PROC
[ info: LarkInfo, newState: LarkState, data: REF_NIL ];

EnterLarkSt: PROC
[ info: LarkInfo, newState: LarkState, data: REF_NIL ];

TonesDone: PROC[ info: LarkInfo, commandEvent: Lark.StatusEvent ];

QueueFeeps: PROC
[ sInfo: SmartsInfo, feeps: Thrush.ProseSpecs ];

ProseControlDone: PROC[info: LarkInfo, marker: INT];

ReportProseDone: PROC[info: SmartsInfo, proseSpec: Thrush.ProseSpec];

InterpretHookState: PROC
[ info: LarkInfo, rawEvent: Lark.StatusEvent, sInfo: SmartsInfo ]
RETURNS [ processedEvent: Lark.StatusEvent ];

CheckHookState: PROC
[ info: LarkInfo]
RETURNS [ onHook: BOOL_TRUE ];

RegisterTrunk: PROC[
hostSmartsID: Thrush.SmartsID, hostInfo: SmartsInfo, partyRname: Thrush.ROPE ]
RETURNS [ nb: Thrush.NB, smartsID: Thrush.SmartsID ];

EnableSmarts: PROC[info: SmartsInfo] RETURNS[enabled: BOOL];

Deregister: PROC[smartsID: Thrush.SmartsID];

LarkParseEvent: -- INTERNAL -- PROC[smartsInfo: SmartsInfo, sEvent: Lark.StatusEvent];

NoteNewState: PROC[cDesc: ConvDesc, convEvent: Thrush.ConvEvent];

ComputeConnection: PROC[cDesc: ConvDesc] RETURNS [pInfo: ThParty.PartyInfo _ NIL];

LarkProgress: PROC[
interface: ThSmartsRpcControl.InterfaceRecord,
shh: SHHH,
convEvent: Thrush.ConvEvent
];


LarkFailed: ERROR[sInfo: SmartsInfo];

GetSmartsInfo: PROC[smartsID: Thrush.SmartsID] RETURNS [info: SmartsInfo];  

GetSIC: PROC[info: SmartsInfo] RETURNS [ state: Thrush.StateInConv ];

ChangeState: PROC[
cDesc: ConvDesc,
state: Thrush.StateInConv _ $idle,
reason: Thrush.Reason _ NIL, -- $wontSay
comment: Thrush.ROPE_NIL
] RETURNS [nb: Thrush.NB]; -- advisory only, by this point

AssessDamage: PROC [nb: Thrush.NB, cDesc: ConvDesc, convEvent: Thrush.ConvEvent];

ForgetConv: PROC[cDesc: ConvDesc];

GetConvDesc: PROC[info: SmartsInfo] RETURNS [ cDesc: ConvDesc_NIL ];

GetConv: PROC[info: SmartsInfo, convID: Thrush.ConversationID, createOK: BOOL_FALSE]
RETURNS [ cDesc: ConvDesc ];

DBInfo: PROC[partyID: Thrush.PartyID, attribute: ATOM_NIL]
RETURNS [ dbRname: Rope.ROPE, dbAtom: ATOM, value: Rope.ROPE ];

}.

œThSmartsPrivate.mesa
Copyright c 1985 by Xerox Corporation.  All rights reserved.
Last modified by D. Swinehart, December 8, 1985 2:52:08 pm PST
Polle Zellweger (PTZ) August 29, 1985 5:35:30 pm PDT
Last Edited by: Pier, May 3, 1984 1:04:49 pm PDT

Copies


Types

States (enumerated types) and other scalars
Parser is controlled by state sequence that's largely independent of the state of the smarts in any conversation.  Parser represents the user's wishes.  After parsing is complete, other processing determines whether these wishes can be granted.

This state is essentially a superset of Thrush.StateInConv.  It is used to express the user's wishes; when wish and reality coincide, it is set to the corresponding StateInConv, and quiescence follows, at least temporarily.
Control of the Lark hardware state (remaining types)
no ring, glitch interval, in-a-ring, break

Structures

Information used by LarkSmarts and LarkTrunkSmarts implementations
They require similar information, although the trunk does not use all of it.
Trunk or station smarts, depending on which this is.
State of Lark hardware, shared between Lark and Trunk

Parsing control fields
Allows Lark, Lark trunk, Radio, ... smarts to parse different command languages
Command procedure to act on results of completely parsed command
Procedure to update conversation description based on event: smarts-specific
Independent of any notion of what's going on in eventInfo; desire of local user

Temporarily out of service -- please use the circular stairway
newIntervals: Thrush.IntervalSpecs _ NIL,
iTail: Thrush.IntervalSpecs _ NIL,
desiredIntID: Thrush.IntID _ Thrush.nullIntID,
newProses: Thrush.ProseSpecs _ NIL,
pTail: Thrush.ProseSpecs _ NIL,
desiredProseID: Thrush.IntID _ Thrush.nullIntID,
originator: Orig _ $unknown,
newSpec, newKeys, newAddress: BOOL _FALSE,
newEvent: BOOL_FALSE,
signallingStarted: BOOL_FALSE,

Access to the Lark hardware via the Lark interface.  This monitored record is shared by the Smarts info for both the LarkSmarts and LarkTrunkSmarts.  There are also some random shared fields kept here.

Some values that have to be preserved from one larkState to another

Prose control values

Click and ring detect timings
Lark reports the time when a ringing voltage is detected on the telewall, and the time when the voltage goes away.  There can be an on-off glitch when the phone is hung up, and ringing is an alternating thing, so we need to interpret these signals before passing on to higher levels.  See LarkInImpl.
Ringing control information
When a Note in a tune specifies "notify", expectedNotification is incremented (mod the lower-case letters) and sent along to the Lark.  When the Lark finishes that note, it notifies the smarts, and eventually LarkOut, using that value.  It's possible (though not desired) for this notification to precede the "WAIT" that pends notification.  In this case, we mustn't wait.  See LarkOutImpl.DoTones and ditto.WaitQ. receivedNotification is set to a value outside the range just after each WAIT opportunity terminates.
LarkSupervisor Variables

Procedures
ENTRY version
Put this lark into the indicated state, setting tones, crossbar, ethernet connections, whatever else is appropriate to the state.  By this point, the higher levels are supposed to have sorted out any conflicts between the requirements of the two Smarts (Lark and LarkTrunk) that control the Lark.  
A single state may not be enough to do that, in the long run.
Data (at this writing) can be a Party.PartyInfo (containing connection specifications), a Lark.KeyTable, a LarkPlay.toneSpec, a Thrush.ProseSpecs, or a ROPE.  The KeyTable should be accepted and forwarded on to the Lark whenever it appears, while the others will be interpreted relative to newState.
INTERNAL version
INTERNAL version
A way to feed back tone completions, initiated by LarkOut, back to LarkOut.
Feep tones don't go through this path, since higher-levels need to know about the situation.
Reports low-level control marker completion from Prose (thru LarkInImpl) to LarkOutImpl, to trigger sending more text if there is any.  For Prose metering only (to avoid filling Lark and Prose buffers).
Reports client-level marker completion from Prose (thru LarkInImpl) to party level, for conversation mgmt and client completion reports.  Corresponds to the end of a Finch client SpeakText command.
Determines if user terminal appears to be offhook.  May not be able to tell if there's
a "click-mode" speakerphone call in progress.
Registration of Lark trunks (back doors)
LarkSetInterval: PROC[
shh: SHHH,
smartsID: Thrush.SmartsID,
tune: Thrush.Tune,
interval: Thrush.VoiceInterval,
direction: Thrush.VoiceDirection,
queueIt: BOOLEAN
] RETURNS [ d: Thrush.Disposition, u: Thrush.Tune ];
Return current state 
Converts from "Sturgis.pa" to "Sturgis.pa.lark", produces $sturgis.pa as well, and if attribute is given, value _ the selected attribute for "Sturgis.pa.lark" in the GV database
Swinehart, May 21, 1985 4:39:39 pm PDT
Cedar 6.0, adding Text-to-speech service
changes to: LarkInfoBody
Polle Zellweger (PTZ) August 8, 1985 8:11:29 pm PDT
changes to: pResetConfirmEnd, stopAndFlushEnd, incorrectClientMarker, flushMarker
Polle Zellweger (PTZ) August 19, 1985 2:52:15 pm PDT
Handle Prose flushing.
changes to: pResetConfirmEnd, stopAndFlushEnd, incorrectClientMarker, flushMarker, LarkInfoBody (added flushJustFinished)
Polle Zellweger (PTZ) August 20, 1985 7:50:19 pm PDT
changes to: ResetProse, ProseControlDone, ReportProseDone
Polle Zellweger (PTZ) August 29, 1985 5:31:56 pm PDT
Place local variables from LarkOutImpl.LarkSupervisor into LarkInfo record.
changes to: LarkInfoBody, maxClientMarker, indexMarkerEnd, maxControlMarker, pReset, pResetConfirmEnd, stopAndFlush, stopAndFlushEnd, flushMarker, proseFailure
Swinehart, October 25, 1985 6:00:46 pm PDT
Handle => ID
changes to: DIRECTORY, ConversationID, PartyID, SmartsID, SmartsInfoBody, ConvDescBody, LarkInfoBody, RegisterTrunk, LarkProgress, LarkSetInterval, GetSmartsInfo, GetConv

Κy˜š
œ™Icodešœ
Οm
œ1™<Jš
œ>™>K™4J™0—J˜š
Οk	˜	Jšžœ
žœžœ˜šœžœ˜Jš
œq˜q—Jšœ	žœ˜&Jšœžœ˜)Jšœžœ˜Jšœžœžœ˜Jšœ
žœžœ˜šœžœ˜Jšœ*žœJžœžœ˜š
—Jšœžœ˜Jšœžœ˜$J˜,J˜
J˜—šœžœ
žœ˜&J™—š
Οc™J™Jšžœžœ
žœ
˜Jšœžœ˜-J™—š
Ÿ™J™™+J˜J™τ
šœžœ˜J˜S—J™J™ί
J˜Jš
œ4™4šœžœ˜Jšœ
Ÿ˜Jšœ
Ÿ˜JšœŸ&˜2JšœŸ˜JšœŸ.˜=JšœŸ>˜OJšœŸ(˜8JšœŸ2˜=JšœŸD˜RJšœŸ&˜2JšœŸ2˜>Jšœ
Ÿ˜'Jšœ
Ÿ˜%JšœŸ˜(Jšœ
Ÿ!˜.J˜—Jšœžœ"˜5J˜Jšœžœ=˜LJ˜Jšœžœ˜1J˜šœžœ"˜4J™*—J˜Jšœžœ˜#J˜JšœŸ+˜IJ˜šœžœ˜Jš
œQ˜Q—šœžœžœ˜J˜ Jš
œ˜Jš	œžœ
žœžœžœ˜.Jšœžœžœžœ˜7J˜—J™—™
J™Jš
œB™BJš
œL™LJ˜Jšœžœžœ˜&šœžœž	œ
ž˜'J˜
JšœŸ˜8š
œ-˜-Jš
œ4™4—˜J™5—Jšœ!žœ
˜%Jšœ8Ÿ˜VJšœžœŸ3˜PJ™J™šΟn
œžœ3˜CJ™O—š œžœžœžœ
˜0J™@—š 
œžœ/žœ
˜FJ™L—J˜%˜J™O—Jšœžœ
žœ
˜Jšœžœ˜JšœžœŸ2˜AJšœ$žœ
ž˜1J˜—J˜Jšœžœžœ
žœ
˜+Jšœ
žœžœ˜"šœžœžœ˜JšœŸ3˜LJšœ#Ÿ)˜LJšœž˜J˜J™?Jšœ%žœ
™)Jšœžœ
™"J™.Jšœžœ
™#Jšœžœ
™J™0J™Jšœžœž™*Jšœ
žœ
žœ
™Jšœžœ
žœ™—J™Jšœ
žœžœ˜(šœžœžœ˜ JšœŸ˜"J˜+J˜—J˜šœ
žœžœ˜JšœŸ˜5Jšœž˜J˜J˜——š
œΙ
™Ι
J™Jšœ
žœžœ˜"šœžœž	œ
ž˜%J˜
Jšœ+Ÿ'˜RJšœžœŸ)˜4J˜-J˜2JšœŸ.˜MJšœŸ$˜;Jšœ	žœ
žœžœ
žœ
žœ
˜/J˜JšœŸ6˜UJš
œžœ
žœ
žœ
žœŸ4˜QJš
œžœ
žœ
žœ
žœŸ%˜BJšœ
žœ
žœŸ˜+Jšœ
ž	œŸ#˜<Jšœ Ÿ-˜MJšœ#Ÿ.˜QJšœžœ
žœ
Ÿ4˜NJ˜J™CJšœžœ
žœ
˜Jšœžœ
˜Jšœžœ
˜Jšœžœ
˜Jšœžœ
˜ Jšœžœ
žœžœ
˜,Jšœžœ
˜ J™J™Jšœžœ
žœŸ#˜BJšœžœ
žœŸU˜uJšœžœŸ/˜PJšœžœ
˜Jšœžœ
žœ
˜Jšœ
žœ˜"Jšœžœ˜$Jšœžœ
žœ
žœ
žœ
žœŸ!˜HJšœžœ˜Jšœžœ
žœŸ*˜HJ™J™Jšœ
žœ˜J˜J™¬Jšœžœ˜J˜#Jšœž	œ
˜JšœžœŸ3˜KJ˜J™J™„J˜&J˜'J˜J™J˜&J˜*Jšœ!ž˜$J˜—J™Jšœžœžœ
žœ˜1šœžœžœ˜"Jšœžœ
˜ Jšœ
žœ˜J˜J˜—Jšœ
žœžœ
˜Jšœžœ˜Jšœžœ˜Jšœžœ˜JšœŸ˜(Jšœžœ˜JšœŸ˜4Jšœžœ˜Jšœ
žœ˜Jšœžœ˜J˜——š
œ
™
J˜J™
š œž˜Jšœ-žœ
žœ˜7J™ιJšœ Οoœ+‘
œ‘œ‘œΠkoœ
™«J˜—J™š œž˜Jšœ-žœ
žœ˜7J˜—J™š 	œžœ3˜BJ™KJ™\J˜—š 
œž˜Jš
œ0˜0J˜—š œžœžœ˜4J™Κ
J˜—š œžœ0˜EJ™Ε
J˜—š œž˜š
œA˜AJšžœ&˜-J˜——š œž˜˜Jšžœžœ
žœ˜—J™V™-J˜——Jš
œ(™(š 
œžœ
˜JšœHžœ˜NJšžœžœ˜5—J˜Jš œžœžœ
žœ˜<J˜Jš 
œžœ˜,J˜š œŸΠckŸœ
žœ3˜VJ˜—Jš œžœ/˜AJ˜Jš œžœžœžœ˜RJ˜š œžœ
˜J˜.Jšœžœ
˜
Jš
œ˜Jš
œ˜J˜—š œžœ
™Jšœžœ
™
Jš
œ™J™J™Jš
œ!™!Jšœ	ž™Jšœžœ+™4—J˜Jšœžœ˜%J˜Jš
œ™š 
œžœžœ˜LJ˜—Jš œžœžœ˜EJ˜š œžœ
˜J˜J˜"JšœžœŸ˜(Jšœžœ
ž˜Jšœžœ
žœŸ˜:J˜—Kš œžœ
žœ0˜QK˜Jš 
œžœ˜"J˜Jš œžœžœžœ˜DJ˜š œžœ<žœ
žœ
˜TJšžœ˜—J˜š œžœ%žœ
žœ
˜:Jšžœžœ
žœžœ˜?Jšœ¦
žœ	™±
—J˜—J˜J˜™&K™(KšœΟr™—™3Kšœ€E™Q—™4K™Kšœ€Eœ€&™y—™4Kšœ€-™9—™4K™KKšœ€“
™Ÿ
—™*K™Kšœ€ž
™ͺ
—K™—…— ΠCε