workbench/tools/SysExplorer/main.c

   1 /*
   2     Copyright (C) 2013, The AROS Development Team.
   3     $Id$
   4 */
   5
   6 #include <aros/debug.h>
   7
   8 #define MUIMASTER_YES_INLINE_STDARG
   9
  10 #include <exec/memory.h>
  11 #include <hidd/hidd.h>
  12 #include <hidd/system.h>
  13 #include <hidd/graphics.h>
  14 #include <hidd/storage.h>
  15 #include <libraries/asl.h>
  16 #include <mui/NListtree_mcc.h>
  17 #include <mui/NListview_mcc.h>
  18 #include <utility/tagitem.h>
  19 #include <utility/hooks.h>
  20
  21 #include <proto/alib.h>
  22 #include <proto/dos.h>
  23 #include <proto/exec.h>
  24 #include <proto/muimaster.h>
  25 #include <proto/oop.h>
  26 #include <proto/utility.h>
  27 #include <proto/intuition.h>
  28
  29 #include <ctype.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32
  33 #include "locale.h"
  34 #include "classes.h"
  35
  36 #include "enums.h"
  37
  38 #define APPNAME "SysExplorer"
  39 #define VERSION "SysExplorer 0.2"
  40
  41 const char version[] = "$VER: " VERSION " (" ADATE ")\n";
  42
  43 static Object *app, *main_window, *property_window;
  44 static Object *property_menu, *expand_menu, *collapse_menu, *quit_menu;
  45 Object *hidd_tree;
  46
  47 OOP_AttrBase HiddAttrBase;
  48 OOP_AttrBase HWAttrBase;
  49
  50 const struct OOP_ABDescr abd[] =
  51 {
  52     {IID_Hidd        ,  &HiddAttrBase },
  53     {IID_HW          ,  &HWAttrBase   },
  54     {NULL            ,  NULL          }
  55 };
  56
  57 /*
  58  * This lists contains handlers for known public classes.
  59  * It specifies information window class, as well as function
  60  * to enumerate children objects for the class.
  61  *
  62  * For proper operation CLIDs in this list should
  63  * be sorted from subclasses to superclasses.
  64  */
  65 struct List seClassHandlers;
  66
  67 AROS_UFH3S(BOOL, enumFunc,
  68     AROS_UFHA(struct Hook *, h,  A0),
  69     AROS_UFHA(OOP_Object*, obj, A2),
  70     AROS_UFHA(void *, parent, A1))
  71 {
  72     AROS_USERFUNC_INIT
  73
  74     BOOL objValid = TRUE;
  75     CONST_STRPTR name = NULL;
  76     struct MUI_NListtree_TreeNode *tn;
  77     ULONG flags = 0;
  78     struct InsertObjectMsg msg =
  79     {
  80         .obj = obj,
  81         .winClass = NULL
  82     };
  83     struct ClassHandlerNode *clHandlers = FindObjectHandler(obj, h->h_Data);
  84
  85     if (clHandlers)
  86     {
  87         if (clHandlers->muiClass)
  88             msg.winClass = *(clHandlers->muiClass);
  89         if (clHandlers->enumFunc)
  90             flags = TNF_LIST|TNF_OPEN;
  91         if (clHandlers->validFunc)
  92             objValid = clHandlers->validFunc(obj, &flags);
  93     }
  94
  95     if (objValid)
  96     {
  97         /* This is either HW or HIDD subclass */
  98         OOP_GetAttr(obj, aHW_ClassName, (IPTR *)&name);
  99         if (!name)
 100             OOP_GetAttr(obj, aHidd_HardwareName, (IPTR *)&name);
 101
 102         tn = (APTR)DoMethod(hidd_tree, MUIM_NListtree_Insert, name, &msg,
 103                             parent, MUIV_NListtree_Insert_PrevNode_Sorted, flags);
 104         D(bug("Inserted TreeNode 0x%p <%s> UserData 0x%p\n", tn, tn->tn_Name, tn->tn_User));
 105
 106         /* If we have enumerator for this class, call it now */
 107         if (clHandlers && clHandlers->enumFunc && (flags & TNF_LIST))
 108             clHandlers->enumFunc(obj, tn);
 109     }
 110     return FALSE; /* Continue enumeration */
 111
 112     AROS_USERFUNC_EXIT
 113 }
 114
 115 static struct Hook enum_hook =
 116 {
 117     .h_Entry = enumFunc,
 118     .h_Data = &seClassHandlers
 119 };
 120
 121 void hwEnum(OOP_Object *obj, struct MUI_NListtree_TreeNode *tn)
 122 {
 123     HW_EnumDrivers(obj, &enum_hook, tn);
 124 }
 125
 126 struct ClassHandlerNode *FindClassHandler(CONST_STRPTR classid, struct List *_handlers)
 127 {
 128     struct ClassHandlerNode *curHandler;
 129
 130     ForeachNode(_handlers, curHandler)
 131     {
 132         if (!strncmp(classid, curHandler->ch_Node.ln_Name, strlen(classid)))
 133         {
 134             bug("[SysExplorer] Returning class '%s'\n", curHandler->ch_Node.ln_Name);
 135             return curHandler;
 136         }
 137     }
 138     return NULL;
 139 }
 140
 141 struct ClassHandlerNode *FindObjectHandler(OOP_Object *obj, struct List *_handlers)
 142 {
 143     struct ClassHandlerNode *curHandler;
 144
 145     ForeachNode(_handlers, curHandler)
 146     {
 147         OOP_Class *cl;
 148         bug("[SysExplorer]    class '%s'\n", curHandler->ch_Node.ln_Name);
 149
 150         for (cl = OOP_OCLASS(obj); cl ; cl = cl->superclass)
 151         {
 152             bug("[SysExplorer]        obj '%s'\n", cl->ClassNode.ln_Name);
 153             if (!strncmp(cl->ClassNode.ln_Name, curHandler->ch_Node.ln_Name, strlen(curHandler->ch_Node.ln_Name)))
 154             {
 155                 bug("[SysExplorer] Returning obj class '%s'\n", curHandler->ch_Node.ln_Name);
 156                 return curHandler;
 157             }
 158         }
 159     }
 160     return NULL;
 161 }
 162
 163 AROS_UFH3S(void, closeFunc,
 164     AROS_UFHA(struct Hook *, h,  A0),
 165     AROS_UFHA(Object*, obj, A2),
 166     AROS_UFHA(struct ObjectUserData **, msg, A1))
 167 {
 168     AROS_USERFUNC_INIT
 169
 170     D(bug("closeFunc address 0x%p\n", closeFunc));
 171     D(bug("Close window 0x%p, ObjectUserData 0x%p\n", obj, *msg));
 172
 173     SET(obj, MUIA_Window_Open, FALSE);
 174     DoMethod(app, OM_REMMEMBER, obj);
 175     DoMethod(app, MUIM_Application_PushMethod, obj, 1, OM_DISPOSE);
 176
 177     (*msg)->win = NULL;
 178
 179     AROS_USERFUNC_EXIT
 180 };
 181
 182 static const struct Hook close_hook =
 183 {
 184     .h_Entry = closeFunc
 185 };
 186
 187 AROS_UFH3S(APTR, constructFunc,
 188     AROS_UFHA(struct Hook *, h,  A0),
 189     AROS_UFHA(Object*, obj, A2),
 190     AROS_UFHA(struct MUIP_NListtree_ConstructMessage *, msg, A1))
 191 {
 192     AROS_USERFUNC_INIT
 193
 194     struct InsertObjectMsg *insertMsg = msg->UserData;
 195     struct ObjectUserData *data = AllocPooled(msg->MemPool, sizeof(struct ObjectUserData));
 196
 197     D(bug("%s: insertMsg 0x%p ObjectUserData 0x%p\n", msg->Name, insertMsg, data));
 198     if (data)
 199     {
 200         data->obj      = insertMsg->obj;
 201         data->winClass = insertMsg->winClass;
 202         data->win      = NULL;
 203     }
 204     return data;
 205
 206     AROS_USERFUNC_EXIT
 207 }
 208
 209 AROS_UFH3S(void, destructFunc,
 210     AROS_UFHA(struct Hook *, h,  A0),
 211     AROS_UFHA(Object*, obj, A2),
 212     AROS_UFHA(struct MUIP_NListtree_DestructMessage *, msg, A1))
 213 {
 214     AROS_USERFUNC_INIT
 215
 216     FreePooled(msg->MemPool, msg->UserData, sizeof(struct ObjectUserData));
 217
 218     AROS_USERFUNC_EXIT
 219 }
 220
 221 static const struct Hook constructHook =
 222 {
 223     .h_Entry = constructFunc
 224 };
 225
 226 static const struct Hook destructHook =
 227 {
 228     .h_Entry = destructFunc
 229 };
 230
 231 AROS_UFH3S(void, propertyFunc,
 232     AROS_UFHA(struct Hook *, h,  A0),
 233     AROS_UFHA(Object*, obj, A2),
 234     AROS_UFHA(struct MUI_NListtree_TreeNode **, tn, A1))
 235 {
 236     AROS_USERFUNC_INIT
 237
 238     struct MUI_NListtree_TreeNode *node = *tn;
 239     struct ObjectUserData *data;
 240
 241     if (node == NULL)
 242     {
 243         /* if we were called from menu we must 1st find the current entry */
 244         node = (struct MUI_NListtree_TreeNode *)XGET(hidd_tree, MUIA_NListtree_Active);
 245     }
 246
 247     if (node == NULL)
 248     {
 249         /* Do nothing if still no current entry */
 250         return;
 251     }
 252
 253     data = node->tn_User;
 254     D(bug("propertyFunc called: TreeNode 0x%p <%s> UserData 0x%p\n", node, node->tn_Name, data));
 255     D(bug("Window 0x%p\n", data->win));
 256
 257     if (data->win)
 258     {
 259         /* The window is already open, show it to the user */
 260         DoMethod(data->win, MUIM_Window_ToFront);
 261         SET(data->win, MUIA_Window_Activate, TRUE);
 262         return;
 263     }
 264
 265     if (data->winClass)
 266     {
 267         /* We have information window class. Open the window. */
 268         data->win = NewObject(data->winClass->mcc_Class, NULL,
 269                               MUIA_PropertyWin_Object, (IPTR)data->obj,
 270                               TAG_DONE);
 271         D(bug("Created window 0x%p\n", data->win));
 272
 273         if (data->win)
 274         {
 275             DoMethod(app, OM_ADDMEMBER, data->win);
 276             DoMethod(data->win, MUIM_Notify, MUIA_Window_CloseRequest, TRUE,
 277                      data->win, 3,
 278                      MUIM_CallHook, &close_hook, data);
 279             SET(data->win, MUIA_Window_Open, TRUE);
 280         }
 281     }
 282
 283     AROS_USERFUNC_EXIT
 284 }
 285
 286 static const struct Hook property_hook =
 287 {
 288     .h_Entry = propertyFunc
 289 };
 290
 291 static BOOL GUIinit()
 292 {
 293     BOOL retval = FALSE;
 294
 295     app = ApplicationObject,
 296         MUIA_Application_Title,         (IPTR)APPNAME,
 297         MUIA_Application_Version,       (IPTR)VERSION,
 298         MUIA_Application_Copyright,     (IPTR)"(C) 2013, The AROS Development Team",
 299         MUIA_Application_Author,        (IPTR)"Pavel Fedin",
 300         MUIA_Application_Base,          (IPTR)APPNAME,
 301         MUIA_Application_Description,   __(MSG_DESCRIPTION),
 302
 303         MUIA_Application_Menustrip, (IPTR)(MenustripObject,
 304             MUIA_Family_Child, (IPTR)(MenuObject,
 305                 MUIA_Menu_Title, __(MSG_MENU_PROJECT),
 306                 MUIA_Family_Child, (IPTR)(property_menu = MenuitemObject,
 307                     MUIA_Menuitem_Title, __(MSG_MENU_PROPERTIES),
 308                 End),
 309                 MUIA_Family_Child, (IPTR)(expand_menu = MenuitemObject,
 310                     MUIA_Menuitem_Title, __(MSG_MENU_EXPANDALL),
 311                 End),
 312                 MUIA_Family_Child, (IPTR)(collapse_menu = MenuitemObject,
 313                     MUIA_Menuitem_Title, __(MSG_MENU_COLLAPSEALL),
 314                 End),
 315                 MUIA_Family_Child, (IPTR)(quit_menu = MenuitemObject,
 316                     MUIA_Menuitem_Title, __(MSG_MENU_QUIT),
 317                 End),
 318             End),
 319         End),
 320
 321         SubWindow, (IPTR)(main_window = WindowObject,
 322             MUIA_Window_Title,  __(MSG_WINTITLE),
 323             MUIA_Window_ID, MAKE_ID('S', 'Y', 'E', 'X'),
 324             WindowContents, (IPTR)(HGroup,
 325                 Child, (IPTR)(NListviewObject,
 326                     MUIA_NListview_NList, (IPTR)(hidd_tree = NListtreeObject,
 327                         ReadListFrame,
 328                         MUIA_CycleChain, TRUE,
 329                         MUIA_NListtree_ConstructHook, (IPTR)&constructHook,
 330                         MUIA_NListtree_DestructHook, (IPTR)&destructHook,
 331                         MUIA_NListtree_DragDropSort, FALSE, /* forbid sorting by drag'n'drop */
 332                     End),
 333                 End),
 334             End),
 335         End),
 336     End;
 337
 338     if (app)
 339     {
 340         OOP_Object *hwRoot = OOP_NewObject(NULL, CLID_HW_Root, NULL);
 341
 342         if (hwRoot)
 343         {
 344             /* This will kick our recursive enumeration into action */
 345             CALLHOOKPKT((struct Hook *)&enum_hook, hwRoot, MUIV_NListtree_Insert_ListNode_Root);
 346         }
 347
 348         /* Quit application if the main window's closegadget or the esc key is pressed. */
 349         DoMethod(main_window, MUIM_Notify, MUIA_Window_CloseRequest, TRUE,
 350                  app, 2,
 351                  MUIM_Application_ReturnID, MUIV_Application_ReturnID_Quit);
 352
 353         DoMethod(property_window, MUIM_Notify, MUIA_Window_CloseRequest, TRUE,
 354                  property_window, 3,
 355                  MUIM_Set, MUIA_Window_Open, FALSE);
 356
 357
 358         DoMethod(property_menu, MUIM_Notify, MUIA_Menuitem_Trigger, MUIV_EveryTime,
 359                  app, 3,
 360                  MUIM_CallHook, &property_hook, 0);
 361
 362         DoMethod(expand_menu, MUIM_Notify, MUIA_Menuitem_Trigger, MUIV_EveryTime,
 363                  hidd_tree, 4,
 364                  MUIM_NListtree_Open, MUIV_NListtree_Open_ListNode_Root, MUIV_NListtree_Open_TreeNode_All, 0);
 365
 366         DoMethod(collapse_menu, MUIM_Notify, MUIA_Menuitem_Trigger, MUIV_EveryTime,
 367                  hidd_tree, 4,
 368                  MUIM_NListtree_Close, MUIV_NListtree_Close_ListNode_Root, MUIV_NListtree_Close_TreeNode_All, 0);
 369
 370         DoMethod(quit_menu, MUIM_Notify, MUIA_Menuitem_Trigger, MUIV_EveryTime,
 371                  app, 2,
 372                  MUIM_Application_ReturnID, MUIV_Application_ReturnID_Quit);
 373
 374         DoMethod(hidd_tree, MUIM_Notify, MUIA_NListtree_DoubleClick, MUIV_EveryTime,
 375                  app, 3,
 376                  MUIM_CallHook, &property_hook, MUIV_TriggerValue);
 377
 378         retval = TRUE;
 379     }
 380
 381     return retval;
 382 }
 383
 384 int __nocommandline = 1;
 385
 386 int main(void)
 387 {
 388     if (!Locale_Initialize())
 389         return 20;
 390
 391     if (!OOP_ObtainAttrBases(abd))
 392     {
 393         Locale_Deinitialize();
 394         return 20;
 395     }
 396
 397     if (GUIinit())
 398     {
 399         SET(main_window, MUIA_Window_Open, TRUE);
 400
 401         if (XGET(main_window, MUIA_Window_Open))
 402         {
 403             DoMethod(app, MUIM_Application_Execute);
 404             SET(main_window, MUIA_Window_Open, FALSE);
 405         }
 406
 407         DisposeObject(app);
 408     }
 409
 410     OOP_ReleaseAttrBases(abd);
 411
 412     Locale_Deinitialize();
 413     return 0;
 414 }
 415
 416 BOOL RegisterClassHandler(CONST_STRPTR classid, BYTE pri, struct MUI_CustomClass ** customwinclass, CLASS_ENUMFUNC enumfunc, CLASS_VALIDFUNC validfunc)
 417 {
 418     struct ClassHandlerNode *newClass;
 419     BOOL add = TRUE;
 420     if ((newClass = FindClassHandler(classid, &seClassHandlers)))
 421     {
 422         if (newClass->enumFunc != hwEnum)
 423             return FALSE;
 424
 425         bug("[SysExplorer] Updating '%s'..\n", classid);
 426         add = FALSE;
 427     }
 428
 429     if (add)
 430     {
 431         bug("[SysExplorer] Registering '%s'..\n", classid);
 432         newClass = AllocMem(sizeof(struct ClassHandlerNode), MEMF_CLEAR);
 433     }
 434
 435     if (newClass)
 436     {
 437         newClass->ch_Node.ln_Name = (char *)classid;
 438         newClass->ch_Node.ln_Pri = pri;
 439         newClass->muiClass = customwinclass;
 440         newClass->enumFunc = enumfunc;
 441         newClass->validFunc = validfunc;
 442
 443         if (add)
 444             Enqueue(&seClassHandlers, &newClass->ch_Node);
 445
 446         return TRUE;
 447     }
 448     return FALSE;
 449 }
 450
 451 BOOL sysexplorer_init(void)
 452 {
 453     bug("[SysExplorer] Initialising..\n");
 454     NEWLIST(&seClassHandlers);
 455
 456     RegisterClassHandler(CLID_Hidd_Storage, 90, NULL, hwEnum, NULL);
 457     RegisterClassHandler(CLID_Hidd_Gfx, 60, NULL, hwEnum, NULL);
 458     RegisterClassHandler(CLID_Hidd_System, 30, NULL, hwEnum, NULL);
 459     RegisterClassHandler(CLID_HW_Root, 0, &ComputerWindow_CLASS,  hwEnum, NULL);
 460     RegisterClassHandler(CLID_HW, -30, NULL, hwEnum, NULL);
 461     RegisterClassHandler(CLID_Hidd, -60, &GenericWindow_CLASS, NULL, NULL);
 462
 463     return TRUE;
 464 }
 465
 466 ADD2INIT(sysexplorer_init, 0);