rom/workbench/workbench_intern.h

   1 #ifndef __WORKBENCH_INTERN_H__
   2 #define __WORKBENCH_INTERN_H__
   3
   4 /*
   5     Copyright  1995-2006, The AROS Development Team. All rights reserved.
   6     $Id$
   7
   8     Internal header file for workbench.library.
   9 */
  10
  11 #include <exec/types.h>
  12 #include <exec/nodes.h>
  13 #include <exec/lists.h>
  14 #include <exec/semaphores.h>
  15 #include <exec/memory.h>
  16 #include <exec/libraries.h>
  17 #include <exec/execbase.h>
  18 #include <dos/dos.h>
  19 #include <dos/dostags.h>
  20 #include <utility/utility.h>
  21 #include <intuition/intuition.h>
  22
  23 #include <workbench/icon.h>
  24 #include <workbench/workbench.h>
  25 #include <workbench/startup.h>
  26 #include <workbench/handler.h>
  27
  28 #include <proto/intuition.h>
  29 #include <proto/exec.h>
  30 #include <proto/dos.h>
  31 #include <proto/icon.h>
  32
  33 /*
  34     This is the WorkbenchBase structure. It is defined here because it is
  35     completely private. Applications should treat it as a struct Library, and
  36     use the workbench.library functions to get information.
  37 */
  38
  39 struct WorkbenchBase
  40 {
  41     struct Library          LibNode;
  42
  43     struct MsgPort          wb_HandlerPort;            /* The handler's message port */
  44     struct MsgPort         *wb_WorkbenchPort;          /* The workbench application's message port */
  45     struct SignalSemaphore  wb_WorkbenchPortSemaphore; /* Arbitrates initializetion access to the port above */
  46
  47     struct List             wb_AppWindows;
  48     struct List             wb_AppIcons;
  49     struct List             wb_AppMenuItems;
  50
  51     BPTR                    wb_SearchPath;
  52     struct List             wb_HiddenDevices;           /* List of devices that Workbench will not show */
  53     ULONG                   wb_DefaultStackSize;
  54     ULONG                   wb_TypeRestartTime;
  55
  56     struct SignalSemaphore  wb_InitializationSemaphore; /* Arbitrates library initialization */
  57     struct SignalSemaphore  wb_BaseSemaphore;           /* Arbitrates library base access */
  58
  59     BOOL                    wb_Initialized;             /* Has the library been intialized in libOpen? */
  60 };
  61
  62 #define LB(lb)          ((struct WorkbenchBase *) (lb))
  63
  64 #define LockWorkbench()   ObtainSemaphore(&(WorkbenchBase->wb_BaseSemaphore))
  65 #define LockWorkbenchShared()   ObtainSemaphoreShared(&(WorkbenchBase->wb_BaseSemaphore))
  66 #define UnlockWorkbench() ReleaseSemaphore(&(WorkbenchBase->wb_BaseSemaphore))
  67
  68 /*
  69  * Defintion of internal structures.
  70  */
  71
  72 struct AppIcon
  73 {
  74     struct Node        ai_Node;
  75
  76     ULONG              ai_ID;
  77     ULONG              ai_UserData;
  78
  79     ULONG              ai_Flags;
  80     STRPTR             ai_Text;
  81     struct DiskObject *ai_DiskObject;
  82
  83     struct Hook       *ai_RenderHook;
  84     struct MsgPort    *ai_MsgPort;
  85 };
  86
  87 /* Valid values for ai_Flags. These correspond to the tag items
  88  * in <workbench/workbench.h>. */
  89
  90 #define WBAPPICONF_SupportsOpen            (1<<1)
  91 #define WBAPPICONF_SupportsCopy            (1<<2)
  92 #define WBAPPICONF_SupportsRename          (1<<3)
  93 #define WBAPPICONF_SupportsInformation     (1<<4)
  94 #define WBAPPICONF_SupportsSnapshot        (1<<5)
  95 #define WBAPPICONF_SupportsUnSnapshot      (1<<6)
  96 #define WBAPPICONF_SupportsLeaveOut        (1<<7)
  97 #define WBAPPICONF_SupportsPutAway         (1<<8)
  98 #define WBAPPICONF_SupportsDelete          (1<<9)
  99 #define WBAPPICONF_SupportsFormatDisk      (1<<10)
 100 #define WBAPPICONF_SupportsEmptyTrash      (1<<11)
 101 #define WBAPPICONF_PropagatePosition       (1<<12)
 102 #define WBAPPICONF_NotifySelectState       (1<<13)
 103
 104 struct AppWindow
 105 {
 106     struct Node     aw_Node;
 107
 108     ULONG           aw_ID;
 109     ULONG           aw_UserData;
 110
 111     struct Window  *aw_Window;
 112     struct List     aw_DropZones;   // List of AppWindowDropZones for this AppWindow.
 113
 114     struct MsgPort *aw_MsgPort;
 115 };
 116
 117 #define  AWDZFlag_fix        0  /* IBox value is actual coordinate */
 118 #define  AWDZFlag_relLeft    1
 119 #define  AWDZFlag_relRight   2
 120 #define  AWDZFlag_relTop     3
 121 #define  AWDZFlag_relBottom  4
 122 #define  AWDZFlag_relWidth   5
 123 #define  AWDZFlag_relHeight  6
 124
 125
 126 struct AppWindowDropZone
 127 {
 128     struct Node       awdz_Node;
 129
 130     ULONG             awdz_ID;
 131     ULONG             awdz_UserData;
 132
 133     struct IBox       awdz_Box;
 134
 135     /* These four tells how to compute the drop zone size and position */
 136     UWORD             awdz_leftSpecifier;
 137     UWORD             awdz_topSpecifier;
 138     UWORD             awdz_widthSpecifier;
 139     UWORD             awdz_heightSpecifier;
 140     struct Hook      *awdz_Hook;
 141 };
 142
 143 struct AppMenuItem
 144 {
 145     struct Node     ami_Node;
 146
 147     ULONG           ami_ID;
 148     ULONG           ami_UserData;
 149
 150     STRPTR          ami_Text;
 151     STRPTR          ami_CommandKey;
 152
 153     struct MsgPort *ami_MsgPort;
 154 };
 155
 156 /* Internal WBHM structure, used to hold data which the user doesn't
 157    have to know about.  */
 158 struct IntWBHandlerMessage
 159 {
 160     struct WBHandlerMessage iwbhm_wbhm;
 161     union
 162     {
 163         struct
 164         {
 165             struct IntuiMessage *imsg;
 166         } Hide;
 167     } iwbhm_Data;
 168 };
 169 #endif /* __WORKBENCH_INTERN_H__ */