Fixes to comments.
[AROS.git] / workbench / system / Wanderer / panel_toolbar.c
blob6e293dd403b676584aa1e19617b5f5527a29c43d
1 /*
2 Copyright 2004-2010, The AROS Development Team. All rights reserved.
3 $Id$
4 */
6 #include "portable_macros.h"
7 #ifdef __AROS__
8 #define MUIMASTER_YES_INLINE_STDARG
9 #endif
11 #define ICONWINDOW_OPTION_NOSEARCHBUTTON
13 #ifdef __AROS__
14 #define DEBUG 0
15 #include <aros/debug.h>
16 #endif
18 #include <exec/types.h>
19 #include <libraries/mui.h>
21 #ifdef __AROS__
22 #include <zune/customclasses.h>
23 #else
24 #include <zune_AROS/customclasses.h>
25 #endif
27 #include <proto/utility.h>
29 #include <proto/graphics.h>
31 #include <proto/exec.h>
32 #include <proto/datatypes.h>
34 #include <dos/dos.h>
35 #include <proto/dos.h>
37 #include <proto/icon.h>
39 #include <stdio.h>
40 #include <string.h>
42 #include <intuition/screens.h>
43 #include <datatypes/pictureclass.h>
44 #include <clib/macros.h>
46 #ifdef __AROS__
47 #include <clib/alib_protos.h>
49 #include <prefs/wanderer.h>
50 #else
51 #include <prefs_AROS/wanderer.h>
52 #endif
54 #if defined(__AMIGA__) && !defined(__PPC__)
55 #define NO_INLINE_STDARG
56 #endif
57 #ifndef _PROTO_INTUITION_H
58 #include <proto/intuition.h>
59 #endif
60 #include <proto/muimaster.h>
62 #include "Classes/iconlist.h"
63 #include "Classes/iconlistview.h"
64 #include "Classes/iconlist_attributes.h"
65 #include "wanderer.h"
66 #include "wandererprefs.h"
68 #include "iconwindow.h"
69 #include "iconwindow_attributes.h"
71 extern struct List iconwindow_Extensions;
73 /*** Private Data *********************************************************/
75 static CONST_STRPTR extension_Name = "IconWindow ToolBar Extension";
76 static CONST_STRPTR extension_PrefsFile = "ENV:SYS/Wanderer/toolbar.prefs";
77 static STRPTR extension_PrefsData;
78 static struct iconWindow_Extension panelToolBar__Extension;
79 struct List panelToolBar__ToolBars;
80 struct NotifyRequest panelToolBar__PrefsNotifyRequest;
81 Object *panelToolBar__PrefsNotificationObject;
83 struct panel_ToolBar_DATA
85 struct Node iwp_Node;
87 Object *iwp_ToolBar_ToolBarObj;
88 Object *iwp_ToolBar_LocationStringObj;
89 #ifdef __AROS__
90 struct Hook iwp_ToolBar_LocationStrHook;
91 #else
92 struct Hook *iwp_ToolBar_LocationStrHook;
93 #endif
96 ///ExpandEnvName()
97 /* Expand a passed in env: string to its full location */
98 /* Wanderer doesnt free this mem at the moment but should
99 incase it is every closed */
100 STRPTR ExpandEnvName(CONST_STRPTR env_path)
102 BOOL ok = FALSE;
103 char tmp_envbuff[1024];
104 STRPTR fullpath = NULL;
105 BPTR env_lock = (BPTR) NULL;
107 env_lock = Lock("ENV:", SHARED_LOCK);
108 if (env_lock)
110 if (NameFromLock(env_lock, tmp_envbuff, 256)) ok = TRUE;
111 UnLock(env_lock);
114 if (ok)
116 if ((fullpath = AllocVec(strlen(tmp_envbuff) + strlen(env_path) + 1 + 1 - 4, MEMF_CLEAR | MEMF_PUBLIC)) != NULL)
118 strcpy(fullpath, tmp_envbuff);
119 AddPart(fullpath, env_path + 4, 1019);
120 return fullpath;
124 // We couldn't expand it so just use as is, but the
125 // caller is expecting a newly allocated string...
126 fullpath = AllocVec(strlen(env_path) + 1, MEMF_PUBLIC);
127 CopyMem(env_path, fullpath, strlen(env_path) + 1);
129 return fullpath;
133 /*** Hook functions *********************************************************/
135 ///panelToolBar__HookFunc_LocationStringFunc()
136 #ifdef __AROS__
137 AROS_UFH3(
138 void, panelToolBar__HookFunc_LocationStringFunc,
139 AROS_UFHA(struct Hook *, hook, A0),
140 AROS_UFHA(APTR *, obj, A2),
141 AROS_UFHA(APTR, param, A1)
144 #else
145 HOOKPROTO(panelToolBar__HookFunc_LocationStringFunc, void, APTR *obj, APTR param)
147 #endif
148 AROS_USERFUNC_INIT
150 /* Get data */
151 Object *self = ( Object *)obj;
152 Class *CLASS = *( Class **)param;
153 STRPTR str = NULL;
154 BPTR fp = (BPTR) NULL;
155 struct FileInfoBlock *fib;
156 struct panel_ToolBar_DATA *panelToolBarPrivate = NULL;
158 SETUP_ICONWINDOW_INST_DATA;
160 /* Only change dir if it is a valid directory/volume */
161 if ((panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate) != NULL)
163 if (panelToolBarPrivate->iwp_Node.ln_Name != (char *)extension_Name)
164 return;
166 GET(panelToolBarPrivate->iwp_ToolBar_LocationStringObj, MUIA_String_Contents, &str);
168 /* TODO: Signal that it is a wrong path */
169 /* so that the user understands (here where we abort with return) */
171 fib = AllocDosObject(DOS_FIB, NULL);
172 if (!fib)
173 return;
175 if (!(fp = Lock(str, ACCESS_READ)))
177 FreeDosObject(DOS_FIB, fib);
178 return;
181 if (!(Examine(fp, fib)))
183 UnLock (fp );
184 FreeDosObject(DOS_FIB, fib);
185 return;
188 /* Change directory! */
189 if (fib->fib_DirEntryType >= 0)
191 SET(self, MUIA_IconWindow_Location, (IPTR)str);
194 UnLock(fp);
196 FreeDosObject(DOS_FIB, fib);
199 AROS_USERFUNC_EXIT
201 #ifndef __AROS__
202 MakeStaticHook(ToolBar_locationstrHook, panelToolBar__HookFunc_LocationStringFunc);
203 #endif
205 #define TOOLBAR_PREFSSIZE 1024
206 IPTR panelToolBar__HandleFSUpdate(Object *WandererObj, struct NotifyMessage *msg)
208 if (GetVar(extension_PrefsFile, extension_PrefsData, TOOLBAR_PREFSSIZE, GVF_GLOBAL_ONLY) != -1)
210 D(bug("[IW.toolbar] %s: Prefs contain '%s'\n", __PRETTY_FUNCTION__, extension_PrefsData));
211 if ((strcasecmp(extension_PrefsData, "True")) == 0)
213 SET(panelToolBar__PrefsNotificationObject, MUIA_ShowMe, TRUE);
215 else
217 SET(panelToolBar__PrefsNotificationObject, MUIA_ShowMe, FALSE);
220 return 0;
223 /*** Main Functions ****************************************************************/
225 ///panelToolBar__PrefsSetup()
226 IPTR panelToolBar__PrefsSetup(Class *CLASS, Object *self, struct opSet *message)
228 IPTR panelToolBarFSNotifyPort = 0;
229 struct panel_ToolBar_DATA *panelToolBarPrivate = NULL;
230 struct List *panelToolBarFSNotifyList = NULL;
232 SETUP_ICONWINDOW_INST_DATA;
234 panelToolBarFSNotifyPort = GetTagData(MUIA_Wanderer_FileSysNotifyPort, (IPTR) NULL, message->ops_AttrList);
235 panelToolBarFSNotifyList = (APTR)GetTagData(MUIA_Wanderer_FileSysNotifyList, (IPTR) NULL, message->ops_AttrList);
237 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
239 if ((panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate) != NULL)
241 if (panelToolBarPrivate->iwp_Node.ln_Name != (char *)extension_Name)
242 return 0;
244 extension_PrefsData = AllocVec(TOOLBAR_PREFSSIZE, MEMF_CLEAR);
246 /* Setup notification on prefs file --------------------------------*/
247 struct Wanderer_FSHandler *_prefsNotifyHandler = NULL;
249 if ((_prefsNotifyHandler = AllocMem(sizeof(struct Wanderer_FSHandler), MEMF_CLEAR)) != NULL)
251 _prefsNotifyHandler->fshn_Node.ln_Name = ExpandEnvName(extension_PrefsFile);
252 panelToolBar__PrefsNotifyRequest.nr_Name = _prefsNotifyHandler->fshn_Node.ln_Name;
253 panelToolBar__PrefsNotifyRequest.nr_Flags = NRF_SEND_MESSAGE;
254 panelToolBar__PrefsNotifyRequest.nr_stuff.nr_Msg.nr_Port = (struct MsgPort *)panelToolBarFSNotifyPort;
255 _prefsNotifyHandler->HandleFSUpdate = panelToolBar__HandleFSUpdate;
257 if (StartNotify(&panelToolBar__PrefsNotifyRequest))
259 D(bug("[IW.toolbar]%s: Prefs-notification setup on '%s'\n", __PRETTY_FUNCTION__, panelToolBar__PrefsNotifyRequest.nr_Name));
261 else
263 D(bug("[IW.toolbar] %s: FAILED to setup Prefs-notification!\n", __PRETTY_FUNCTION__));
265 AddTail(panelToolBarFSNotifyList, &_prefsNotifyHandler->fshn_Node);
267 #ifdef __AROS__
268 panelToolBar__PrefsNotificationObject = (Object *)NotifyObject, End;
269 #else
270 panelToolBar__PrefsNotificationObject = MUI_NewObject(MUIC_Notify, TAG_DONE);
271 #endif
272 if (GetVar(extension_PrefsFile, extension_PrefsData, TOOLBAR_PREFSSIZE, GVF_GLOBAL_ONLY) != -1)
274 D(bug("[IW.toolbar] %s: Prefs contain '%s'\n", __PRETTY_FUNCTION__, extension_PrefsData));
277 return 0;
281 ///panelToolBar__Setup()
282 IPTR panelToolBar__Setup(Class *CLASS, Object *self, struct opSet *message)
284 SETUP_ICONWINDOW_INST_DATA;
286 Object *panel_ToolBar;
287 Object *panelToolBar_ButtonDirUp = NULL,
288 *panelToolBar_ButtonSearch = NULL,
289 *panelToolBar_StringLocation = NULL;
291 struct panel_ToolBar_DATA *panelToolBarPrivate = NULL;
293 if (!(!(data->iwd_Flags & IWDFLAG_ISROOT) && data->iwd_TopPanel.iwp_PanelContainerObj))
294 return (IPTR)NULL;
296 #if !defined(ICONWINDOW_OPTION_NOSEARCHBUTTON)
297 panelToolBar_ButtonSearch = ImageButton("", "THEME:Images/Gadgets/Prefs/Test");
298 #endif
300 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
302 if (data->iwd_TopPanel.iwp_PanelPrivate == (IPTR)NULL)
304 if ((data->iwd_TopPanel.iwp_PanelPrivate = (IPTR)AllocVec(sizeof(struct panel_ToolBar_DATA), MEMF_CLEAR)) == (IPTR)NULL)
305 return 0;
307 panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate;
308 panelToolBarPrivate->iwp_Node.ln_Name = (char *)extension_Name;
310 /* Create the "ToolBar" panel object .. */
311 panel_ToolBar = MUI_NewObject(MUIC_Group,
312 MUIA_InnerLeft,(0),
313 MUIA_InnerRight,(0),
314 MUIA_InnerTop,(0),
315 MUIA_InnerBottom,(0),
316 MUIA_Frame, MUIV_Frame_None,
317 Child, (IPTR)MUI_NewObject(MUIC_Group, MUIA_Group_Horiz, TRUE ,
318 MUIA_InnerLeft,(4),
319 MUIA_InnerRight,(4),
320 MUIA_InnerTop,(4),
321 MUIA_InnerBottom,(4),
322 MUIA_Frame, MUIV_Frame_None,
323 MUIA_Weight, 100,
324 Child, (IPTR)MUI_NewObject(MUIC_Group, MUIA_Group_Horiz, TRUE ,
325 MUIA_InnerLeft,(0),
326 MUIA_InnerRight,(0),
327 MUIA_InnerTop,(0),
328 MUIA_InnerBottom,(0),
329 MUIA_Weight, 100,
330 Child, (IPTR)( panelToolBar_StringLocation = MUI_NewObject(MUIC_String,
331 MUIA_String_Contents, (IPTR)"",
332 MUIA_CycleChain, 1,
333 MUIA_Frame, MUIV_Frame_String,
334 TAG_DONE) ),
335 TAG_DONE),
336 Child, (IPTR)MUI_NewObject(MUIC_Group, MUIA_Group_Horiz, TRUE ,
337 MUIA_InnerLeft,(0),
338 MUIA_InnerRight,(0),
339 MUIA_InnerTop,(0),
340 MUIA_InnerBottom,(0),
341 MUIA_HorizWeight, 0,
342 MUIA_VertWeight, 100,
343 Child, (IPTR) (panelToolBar_ButtonDirUp = ImageButton("", "THEME:Images/Gadgets/Prefs/Revert")),
344 (panelToolBar_ButtonSearch ? Child : TAG_IGNORE), (IPTR) (panelToolBar_ButtonSearch),
345 TAG_DONE),
346 TAG_DONE),
347 Child, (IPTR)MUI_NewObject(MUIC_Group, MUIA_Group_Horiz, TRUE ,
348 MUIA_InnerLeft,(0),
349 MUIA_InnerRight,(0),
350 MUIA_InnerTop,(0),
351 MUIA_InnerBottom,(0),
352 MUIA_Group_Spacing, 0,
353 MUIA_FixHeight, 1,
354 MUIA_Frame, MUIV_Frame_None,
355 MUIA_Background, MUII_SHADOW,
356 Child, (IPTR)MUI_NewObject(MUIC_Rectangle,
357 MUIA_Frame, MUIV_Frame_None,
358 TAG_DONE),
359 TAG_DONE),
360 TAG_DONE);
362 /* Got a toolbarpanel? setup notifies and other values are
363 copied to the data of the object */
364 if ( panel_ToolBar != NULL )
366 D(bug("[IW.toolbar] %s: ToolBar Obj @ 0x%p\n", __PRETTY_FUNCTION__, panel_ToolBar));
368 SET(panelToolBar_ButtonDirUp, MUIA_Background, XGET( panel_ToolBar, MUIA_Background ) );
369 SET(panelToolBar_ButtonDirUp, MUIA_CycleChain, 1);
370 SET(panelToolBar_ButtonDirUp, MUIA_Frame, MUIV_Frame_None );
371 #if !defined(ICONWINDOW_OPTION_NOSEARCHBUTTON)
372 SET(panelToolBar_ButtonSearch, MUIA_Background, XGET( panel_ToolBar, MUIA_Background ) );
373 SET(panelToolBar_ButtonSearch, MUIA_CycleChain, 1);
374 SET(panelToolBar_ButtonSearch, MUIA_Frame, MUIV_Frame_None );
375 #endif
376 panelToolBarPrivate->iwp_ToolBar_ToolBarObj = panel_ToolBar;
378 if (DoMethod(data->iwd_TopPanel.iwp_PanelGroupObj, MUIM_Group_InitChange ))
380 DoMethod(data->iwd_TopPanel.iwp_PanelGroupObj, OM_ADDMEMBER, (IPTR)panel_ToolBar);
381 if (data->iwd_TopPanel.iwp_PanelGroupSpacerObj)
383 DoMethod(data->iwd_TopPanel.iwp_PanelGroupObj, OM_REMMEMBER, (IPTR)data->iwd_TopPanel.iwp_PanelGroupSpacerObj);
384 data->iwd_TopPanel.iwp_PanelGroupSpacerObj = NULL;
387 DoMethod(data->iwd_TopPanel.iwp_PanelGroupObj, MUIM_Group_ExitChange);
390 if (panelToolBarPrivate->iwp_ToolBar_ToolBarObj)
392 DoMethod(
393 panelToolBar_ButtonDirUp, MUIM_Notify, MUIA_Pressed, FALSE,
394 (IPTR)self, 1, MUIM_IconWindow_DirectoryUp
397 panelToolBarPrivate->iwp_ToolBar_LocationStringObj = panelToolBar_StringLocation;
398 #ifdef __AROS__
399 panelToolBarPrivate->iwp_ToolBar_LocationStrHook.h_Entry = ( HOOKFUNC )panelToolBar__HookFunc_LocationStringFunc;
400 #else
401 panelToolBarPrivate->iwp_ToolBar_LocationStrHook= &ToolBar_locationstrHook;
402 #endif
404 NNSET(
405 panelToolBarPrivate->iwp_ToolBar_LocationStringObj, MUIA_String_Contents,
406 XGET(data->iwd_IconListObj, MUIA_IconDrawerList_Drawer)
409 /* Make changes to string contents change dir on enter */
410 DoMethod (
411 panelToolBarPrivate->iwp_ToolBar_LocationStringObj, MUIM_Notify, MUIA_String_Acknowledge, MUIV_EveryTime,
412 (IPTR)self, 3, MUIM_CallHook, &panelToolBarPrivate->iwp_ToolBar_LocationStrHook, (IPTR)CLASS
415 if (!(panelToolBar__PrefsNotificationObject))
416 panelToolBar__PrefsSetup(CLASS, self, message);
418 DoMethod
420 panelToolBar__PrefsNotificationObject, MUIM_Notify, MUIA_ShowMe, MUIV_EveryTime,
421 (IPTR)data->iwd_TopPanel.iwp_PanelContainerObj, 3, MUIM_Set, MUIA_ShowMe, MUIV_TriggerValue
424 if ((strcasecmp(extension_PrefsData, "True")) == 0)
426 SET(data->iwd_TopPanel.iwp_PanelContainerObj, MUIA_ShowMe, TRUE);
429 AddTail(&panelToolBar__ToolBars, &panelToolBarPrivate->iwp_Node);
432 else
434 panelToolBarPrivate->iwp_ToolBar_ToolBarObj = NULL;
437 return 0;
441 IPTR panelToolBar__Cleanup(Class *CLASS, Object *self, Msg msg)
443 SETUP_ICONWINDOW_INST_DATA;
445 struct panel_ToolBar_DATA *panelToolBarPrivate;
447 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
449 if ((panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate) != NULL)
451 if (panelToolBarPrivate->iwp_Node.ln_Name != (char *)extension_Name)
452 return 0;
454 if (panelToolBar__PrefsNotificationObject)
456 DoMethod
458 panelToolBar__PrefsNotificationObject, MUIM_KillNotifyObj, MUIA_ShowMe,
459 (IPTR)data->iwd_TopPanel.iwp_PanelContainerObj
462 if (panelToolBarPrivate->iwp_ToolBar_LocationStringObj)
464 DoMethod
466 panelToolBarPrivate->iwp_ToolBar_LocationStringObj, MUIM_KillNotifyObj, MUIA_String_Acknowledge,
467 (IPTR)self
471 return 0;
474 ///OM_GET()
475 IPTR panelToolBar__OM_GET(Class *CLASS, Object *self, struct opGet *message)
477 SETUP_ICONWINDOW_INST_DATA;
479 struct panel_ToolBar_DATA *panelToolBarPrivate = NULL;
480 // IPTR *store = message->opg_Storage;
481 IPTR rv = FALSE;
483 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
485 if ((panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate) != NULL)
487 if (panelToolBarPrivate->iwp_Node.ln_Name != (char *)extension_Name)
488 return rv;
490 switch (message->opg_AttrID)
495 return rv;
498 ///OM_SET()
499 IPTR panelToolBar__OM_SET(Class *CLASS, Object *self, struct opSet *message)
501 SETUP_ICONWINDOW_INST_DATA;
503 struct panel_ToolBar_DATA *panelToolBarPrivate = NULL;
504 struct TagItem *tstate = message->ops_AttrList, *tag;
505 // BOOL UpdateIconlist = FALSE;
506 // IPTR focusicon = (IPTR) NULL;
507 IPTR rv = FALSE;
509 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
511 if ((panelToolBarPrivate = (struct panel_ToolBar_DATA *)data->iwd_TopPanel.iwp_PanelPrivate) != NULL)
513 if (panelToolBarPrivate->iwp_Node.ln_Name != (char *)extension_Name)
514 return rv;
516 while ((tag = NextTagItem((TAGITEM)&tstate)) != NULL)
518 switch (tag->ti_Tag)
520 case MUIA_IconWindow_Location:
521 D(bug("[IW.toolbar] %s: MUIA_IconWindow_Location '%s'\n", __PRETTY_FUNCTION__, data->iwd_DirectoryPath));
523 SET(panelToolBarPrivate->iwp_ToolBar_LocationStringObj, MUIA_String_Contents, (IPTR)data->iwd_DirectoryPath);
525 break;
530 return rv;
533 #define PANELTOOLBAR_PRIORITY 10
535 IPTR panelToolBar__Init()
537 D(bug("[IW.toolbar]: %s()\n", __PRETTY_FUNCTION__));
539 panelToolBar__Extension.iwe_Node.ln_Pri = PANELTOOLBAR_PRIORITY;
540 panelToolBar__Extension.iwe_Node.ln_Name = (char *)extension_Name;
541 panelToolBar__Extension.iwe_Setup = panelToolBar__Setup;
542 panelToolBar__Extension.iwe_Cleanup = panelToolBar__Cleanup;
543 panelToolBar__Extension.iwe_Set = panelToolBar__OM_SET;
544 panelToolBar__Extension.iwe_Get = panelToolBar__OM_GET;
546 NewList(&panelToolBar__ToolBars);
548 Enqueue(&iconwindow_Extensions, (struct Node *)&panelToolBar__Extension);
550 D(bug("[IconWindow] %s: Added Extension '%s' @ %p to list @ %p\n", __PRETTY_FUNCTION__, panelToolBar__Extension.iwe_Node.ln_Name, &panelToolBar__Extension.iwe_Node, &iconwindow_Extensions));
552 return TRUE;
555 ADD2INIT(panelToolBar__Init, PANELTOOLBAR_PRIORITY);