Ludolph Filer Application Communication Protocol

< FnerComm.text, 3-Ja.n..,a3, F.Ludolph l < Copyright 1·983, Apple Compubr lnc. > UN l T F i1 erCornra f INTRINSlC; INTERrAt:E USES {$U obj:$ysCall <-.u obj :.PSysCa:11 ) SysCall, ) PSy$Ca l 1 , (.$0 obj :Uni tStd ) Utt i t:Std, (:S\J obJ tUn it Hz > Un i tttz, ($U obj JStorage l Storage 1_ ($U obhrontMgr J FontMgr, ('$1J obj:Qu i ck Draw } Qui ckl)rw, {$UobJ:WM.Event• > Ev:enb, <SU C)bJ;WM.fo.lders l Folders; ($6£'TC fcDebug = +DbgOk j {$SETC f.cS)'mbOls == +$)'1110k l ( Th.is unit contains the record dtflni ti on used for Fiter-Appli~ation communications. It is uslKI in both receiving ev.ent• fram and s.ndtng ennh to the Filer. · An applicatio11 is t.h.rted by tbe Fiter- via the OS call 'Hak.tt...Procn'.s". The application should ex·ecuh· I ts i'nitl al i:atio11 code and then .. cal 1 GetEvent. The inJtiHalinHon code should Hrst call 'Open~' (to $It up the Filer-Appl icatfort cotlli'llunicatiotl channel> and then dwclare I: Sys~T•rminah uccttption handler. H thtt txeeption handhr cannot.bt declared or H initilltation c:annot be completed, the a9pl icaHon should 'Te HF Iler" that ifdni tF~JhcV and the ruson <se-e th• stet ion on unsoli c i te d message& in the tab le belO'W >. See the Sounc t nQ Balls 'In it i a Hu' procedure for an e-xainple. The f::ilu• sef!ds a FilerEvent to an application. The GHAddParams procedure is used to o.bhfn the additional parameters at;,$.Qciated with this •vent. TwO: parameters are pas.$td.f a fllerOp that dt'.fin&s the operation to be performed, and an optional patl;t11ame, fDocName, 1.1Jhicb Ls usitd to open, create, al\d destroy the .di skfl tes that make up the document. An application 1.1s:ts 'fDocName a-s a preiix for disk-file patbnames. It consist-s of ·a dis.k volume n·ame and the initial characters of a disl(file name. Thel'"e are currently 9 f'.i1er0ps., thou that .open a document, t,hose that 1nose or c:apy an open document, on• that tells an application tn tlo$e a di s.IH ile 1 arid one tha·t tel h tht prous5 to termina. te. Those ttiat Qpen= fc:None1. No doc: to open! The us.er pulled a tool .ra.thtr• than a doc. +cResume: Open the doc, or c:rute a new do.c if n<>.dhkfiles exist, and display conhnh. in window. H the ddt was ~u~:pended, restore its state·. Thou that close; 'fcCl Qse: Page 1 Update doc into new disKiiles and close. The source doc is unchar1ged and remains open. fcPu·t: Update and close doc to new location (fl)ocName). Destl"OY the old version. fcShredi Close the .doc as In fcSus.pend, if possible, or just close the diskfiles, if possible. Filer will delete them later. fcSuspend: Close doc, keep edits stpera.te, uve docu!"ent., state. fcCopy: fcDf.Close: Close the disl<file <not document> using the refnum provided else app will be terminatid. <User is removing a diskette.) Terminate; fcTerminate: Terminate the process and suspend any open docs (act.ua11y there shouldn't be art'Y open when this is received). An fcResume/fcNone is sent when: 1) the user pul 1s a docu…