summaryrefslogtreecommitdiff
path: root/amiga/agclass/amigaguide_class.c
blob: dfac7ad7ae5fb38e31190bbf736a6e4936c31ab3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*
 *   AmigaGuide Class
 *   A BOOPSI class for displaying AmigaGuide files.
 *   by Daniel "Trixie" Jedlicka
 */

#undef __USE_INLINE__

#include "amigaguide_class.h"

struct localObjectData
{
 struct NewAmigaGuide  nag;
 struct AmigaGuideMsg *agm;
 AMIGAGUIDECONTEXT     agHandle;
 uint32                agContextID;
 uint32                agSignal;
 BOOL                  agActive;
};

struct Library         *AmigaGuideBase = NULL;
struct AmigaGuideIFace *IAmigaGuide = NULL;


/* **********************************  function prototypes   ************************************ */

static uint32 dispatchAGClass(Class *, Object *, Msg);
BOOL          freeAGClass(Class *);

// class methods
uint32 om_new(Class *, Object *, struct opSet *);
uint32 om_dispose(Class *, Object *, Msg);
uint32 om_set(Class *, Object *, struct opSet *);
uint32 om_get(Class *, Object *, struct opGet *);
uint32 agm_open(Class *, Object *, Msg);
uint32 agm_close(Class *, Object *, Msg);


/* ***************************  class initialization and disposal   ***************************** */


Class *initAGClass(void)
{
 Class *cl = NULL;


 // Open amigaguide.library and its interface.
 if ( (AmigaGuideBase = IExec->OpenLibrary("amigaguide.library", 52)) )
  {
   if ( (IAmigaGuide  = (struct AmigaGuideIFace *)IExec->GetInterface(AmigaGuideBase, "main", 1L, NULL)) )
    {
     if ( (cl = IIntuition->MakeClass(NULL, "rootclass", NULL, sizeof(struct localObjectData), 0)) )
      {
       cl->cl_Dispatcher.h_Entry = (HOOKFUNC)dispatchAGClass;
       IIntuition->AddClass(cl);
      }
     else freeAGClass(NULL);
    }
   else freeAGClass(NULL);
  }

 return cl;

}



BOOL freeAGClass(Class *cl)
{
 BOOL retVal = FALSE;


 // Close amigaguide.library and free the class.
 if (IAmigaGuide)    IExec->DropInterface((struct Interface *)IAmigaGuide);
 if (AmigaGuideBase) IExec->CloseLibrary(AmigaGuideBase);
 if (cl)             retVal = IIntuition->FreeClass(cl);

 return retVal;
}



/* **************************************  class dispatcher  ************************************ */


static uint32 dispatchAGClass(Class *cl, Object *o, Msg msg)
{

 switch (msg->MethodID)
  {
   case OM_NEW:
     return om_new(cl, o, (struct opSet *)msg);

   case OM_DISPOSE:
     return om_dispose(cl, o, msg);

   case OM_UPDATE:
   case OM_SET:
     return om_set(cl, o, (struct opSet *)msg);

   case OM_GET:
     return om_get(cl, o, (struct opGet *)msg);

   case AGM_OPEN:
     return agm_open(cl, o, msg);

   case AGM_CLOSE:
     return agm_close(cl, o, msg);

   default:
     return IIntuition->IDoSuperMethodA(cl, o, msg);
  }

}


/* ***************************************  class methods  ************************************** */

uint32 om_new(Class *cl, Object *o, struct opSet *msg)
{
 struct localObjectData *lod = NULL;
 uint32 retVal = 0L;


 if ( (retVal = IIntuition->IDoSuperMethodA(cl, o, (Msg)msg)) )
  {
   // Obtain pointer to our object's local instance data.
   if ( (lod = (struct localObjectData *)INST_DATA(cl, retVal)) )
    {
     // Initialize values.
     lod->agActive          = FALSE;
     lod->agHandle          = NULL;
     lod->agContextID       = 0;
     lod->nag.nag_Name      = NULL;
     lod->nag.nag_Screen    = NULL;
     lod->nag.nag_PubScreen = NULL;
     lod->nag.nag_BaseName  = NULL;
     lod->nag.nag_Context   = NULL;
     lod->nag.nag_Client    = NULL; // private, must be NULL!

     // Set initial object attributes based on the tags from NewObject().
     om_set(cl, (Object *)retVal, msg);
    }
  }

 return retVal;

}





uint32 om_dispose(Class *cl, Object *o, Msg msg)
{

 // Close the document, should it still be opened.
 agm_close(cl, o, msg);

 // Let superclass dispose of the object.
 return IIntuition->IDoSuperMethodA(cl, o, msg);

}





uint32 om_set(Class *cl, Object *o, struct opSet *msg)
{
 struct localObjectData *lod = (struct localObjectData *)INST_DATA(cl, o);
 struct TagItem *tags, *ti;


 tags = msg->ops_AttrList;

 while ((ti = IUtility->NextTagItem (&tags)))
  {
   switch (ti->ti_Tag)
    {
     case AMIGAGUIDE_Name:
       lod->nag.nag_Name = (STRPTR)ti->ti_Data;
       lod->agActive = FALSE; // Database name has changed, we must setup the help system again.
     break;

     case AMIGAGUIDE_Screen:
       lod->nag.nag_Screen = (struct Screen *)ti->ti_Data;
       lod->agActive = FALSE; // Screen pointer has changed, we must setup the help system again.
     break;

     case AMIGAGUIDE_PubScreen:
       lod->nag.nag_PubScreen = (STRPTR)ti->ti_Data;
       lod->agActive = FALSE; // Pubscreen name has changed, we must setup the help system again.
     break;

     case AMIGAGUIDE_BaseName:
       lod->nag.nag_BaseName = (STRPTR)ti->ti_Data;
       lod->agActive = FALSE; // Application basename has changed, we must setup the help system again.
     break;

     case AMIGAGUIDE_ContextArray:
       lod->nag.nag_Context = (STRPTR *)ti->ti_Data;
       lod->agActive = FALSE; // Context array has changed, we must setup the help system again.
     break;

     case AMIGAGUIDE_ContextID:
       lod->agContextID = (uint32)ti->ti_Data;
     break;

     default:
     break;
    }
  }


 // Setup the help system, if not ready yet or needs changing.
 if ( lod->agActive == FALSE )
  {
   // Shut down help system should it already be running.
   if ( lod->agHandle ) agm_close(cl, o, (Msg)msg);

   // (Re)establish the AmigaGuide context and open the database asynchronously.
   if ( (lod->agHandle = IAmigaGuide->OpenAmigaGuideAsync(&(lod->nag), NULL)) )
    {
     if ( (lod->agSignal = IAmigaGuide->AmigaGuideSignal(lod->agHandle)) )
      {
       // Wait until the help system is up and running.
       IExec->Wait(lod->agSignal);
       while ( !(lod->agActive) )
        {
         while ( (lod->agm = IAmigaGuide->GetAmigaGuideMsg(lod->agHandle)) )
          {
           // The AmigaGuide process started OK.
           if ( lod->agm->agm_Type == ActiveToolID ) lod->agActive = TRUE;

           // Opening the guide file failed for some reason, continue as usual.
           if ( lod->agm->agm_Type == ToolStatusID && lod->agm->agm_Pri_Ret ) lod->agActive = TRUE;

           IAmigaGuide->ReplyAmigaGuideMsg(lod->agm);
          }
        }
      }
    }
  }

 return (uint32)lod->agHandle;

}





uint32 om_get(Class *cl, Object *o, struct opGet *msg)
{
 struct localObjectData *lod = (struct localObjectData *)INST_DATA(cl, o);
 uint32 retVal = 0L;


 switch (msg->opg_AttrID)
  {
   case AMIGAGUIDE_Name:
     *(msg->opg_Storage) = (uint32)lod->nag.nag_Name;
     retVal = 1;
   break;

   case AMIGAGUIDE_Screen:
     *(msg->opg_Storage) = (uint32)lod->nag.nag_Screen;
     retVal = 1;
   break;

   case AMIGAGUIDE_PubScreen:
     *(msg->opg_Storage) = (uint32)lod->nag.nag_PubScreen;
     retVal = 1;
   break;

   case AMIGAGUIDE_BaseName:
     *(msg->opg_Storage) = (uint32)lod->nag.nag_BaseName;
     retVal = 1;
   break;

   case AMIGAGUIDE_ContextArray:
     *(msg->opg_Storage) = (uint32)lod->nag.nag_Context;
     retVal = 1;
   break;

   case AMIGAGUIDE_ContextID:
     *(msg->opg_Storage) = (uint32)lod->agContextID;
     retVal = 1;
   break;

   default:
     retVal = IIntuition->IDoSuperMethodA(cl, o, (Msg)msg);
  }

 return retVal;

}





uint32 agm_open(Class *cl, Object *o, Msg msg)
{
 struct localObjectData *lod = (struct localObjectData *)INST_DATA(cl, o);
 uint32 retVal = 0;


 if ( (lod->agHandle) && (lod->agActive) )
  {
   if ( lod->nag.nag_Context )
    {
     // A context node array is provided = open the current context node.
     IAmigaGuide->SetAmigaGuideContext(lod->agHandle, lod->agContextID, NULL);
     retVal = IAmigaGuide->SendAmigaGuideContext(lod->agHandle, NULL);
    }
   else
    {
     // No context array is provided = open the main node.
     retVal = IAmigaGuide->SendAmigaGuideCmd(lod->agHandle, "LINK MAIN", TAG_DONE);
    }
  }

 return retVal;
}





uint32 agm_close(Class *cl, Object *o, Msg msg)
{
 struct localObjectData *lod = (struct localObjectData *)INST_DATA(cl, o);


 if ( lod->agHandle )
  {
   IAmigaGuide->CloseAmigaGuide(lod->agHandle);
   lod->agHandle = NULL;
   lod->agActive = FALSE;
  }

 return (uint32)lod->agHandle;

}