src/Screen.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // Screen.hh for Blackbox - an X11 Window manager
   3 // Copyright (c) 2001 - 2002 Sean 'Shaleh' Perry <shaleh@debian.org>
   4 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
   5 //
   6 // Permission is hereby granted, free of charge, to any person obtaining a
   7 // copy of this software and associated documentation files (the "Software"),
   8 // to deal in the Software without restriction, including without limitation
   9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10 // and/or sell copies of the Software, and to permit persons to whom the
  11 // Software is furnished to do so, subject to the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be included in
  14 // all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22 // DEALINGS IN THE SOFTWARE.
  23
  24 #ifndef   __Screen_hh
  25 #define   __Screen_hh
  26
  27 extern "C" {
  28 #include <X11/Xlib.h>
  29
  30 #ifdef    TIME_WITH_SYS_TIME
  31 #  include <sys/time.h>
  32 #  include <time.h>
  33 #else // !TIME_WITH_SYS_TIME
  34 #  ifdef    HAVE_SYS_TIME_H
  35 #    include <sys/time.h>
  36 #  else // !HAVE_SYS_TIME_H
  37 #    include <time.h>
  38 #  endif // HAVE_SYS_TIME_H
  39 #endif // TIME_WITH_SYS_TIME
  40 }
  41
  42 #include <list>
  43 #include <vector>
  44
  45 #include "Color.hh"
  46 #include "Texture.hh"
  47 #include "Image.hh"
  48 #include "Configmenu.hh"
  49 #include "Iconmenu.hh"
  50 #include "Netizen.hh"
  51 #include "Rootmenu.hh"
  52 #include "Timer.hh"
  53 #include "Workspace.hh"
  54 #include "Workspacemenu.hh"
  55 #include "blackbox.hh"
  56
  57 class Slit; // forward reference
  58 class BFont;
  59 class XAtom;
  60 struct Strut;
  61
  62 enum TextJustify { LeftJustify = 1, RightJustify, CenterJustify };
  63
  64 struct WindowStyle {
  65   BColor f_focus, f_unfocus, l_text_focus, l_text_unfocus, b_pic_focus,
  66     b_pic_unfocus;
  67   BTexture t_focus, t_unfocus, l_focus, l_unfocus, h_focus, h_unfocus,
  68     b_focus, b_unfocus, b_pressed, g_focus, g_unfocus;
  69
  70   BFont *font;
  71
  72   TextJustify justify;
  73
  74   void doJustify(const std::string &text, int &start_pos,
  75                  unsigned int max_length, unsigned int modifier) const;
  76 };
  77
  78 struct ToolbarStyle {
  79   BColor l_text, w_text, c_text, b_pic;
  80   BTexture toolbar, label, window, button, pressed, clock;
  81
  82   BFont *font;
  83
  84   TextJustify justify;
  85
  86   void doJustify(const std::string &text, int &start_pos,
  87                  unsigned int max_length, unsigned int modifier) const;
  88 };
  89
  90 struct MenuStyle {
  91   BColor t_text, f_text, h_text, d_text;
  92   BTexture title, frame, hilite;
  93
  94   BFont *t_font, *f_font;
  95
  96   TextJustify t_justify, f_justify;
  97   int bullet, bullet_pos;
  98 };
  99
 100 class BScreen : public ScreenInfo {
 101 private:
 102   bool root_colormap_installed, managed, geom_visible;
 103   GC opGC;
 104   Pixmap geom_pixmap;
 105   Window geom_window;
 106
 107   Blackbox *blackbox;
 108   BImageControl *image_control;
 109   Configmenu *configmenu;
 110   Iconmenu *iconmenu;
 111   Rootmenu *rootmenu;
 112   Configuration *config;
 113   XAtom *xatom;
 114
 115   typedef std::list<Rootmenu*> RootmenuList;
 116   RootmenuList rootmenuList;
 117
 118   typedef std::list<Netizen*> NetizenList;
 119   NetizenList netizenList;
 120   BlackboxWindowList iconList, windowList;
 121
 122   typedef std::vector<Window> WindowList;
 123   WindowList desktopWindowList, systrayWindowList;
 124
 125   Slit *slit;
 126   Toolbar *toolbar;
 127   Workspace *current_workspace;
 128   Workspacemenu *workspacemenu;
 129
 130   unsigned int geom_w, geom_h;
 131   unsigned long event_mask;
 132
 133   Rect usableArea;
 134 #ifdef    XINERAMA
 135   RectList xineramaUsableArea;
 136 #endif // XINERAMA
 137
 138   typedef std::list<Strut*> StrutList;
 139   StrutList strutList;
 140   typedef std::vector<Workspace*> WorkspaceList;
 141   WorkspaceList workspacesList;
 142
 143   struct screen_resource {
 144     WindowStyle wstyle;
 145     ToolbarStyle tstyle;
 146     MenuStyle mstyle;
 147
 148     bool sloppy_focus, auto_raise, auto_edge_balance, ordered_dither,
 149       opaque_move, full_max, focus_new, focus_last, click_raise,
 150       allow_scroll_lock, hide_toolbar, window_to_window_snap,
 151       window_corner_snap, aa_fonts, ignore_shaded, ignore_maximized;
 152     BColor border_color;
 153
 154     unsigned int workspaces;
 155     int toolbar_placement, toolbar_width_percent, placement_policy,
 156       edge_snap_threshold, row_direction, col_direction;
 157
 158     unsigned int handle_width, bevel_width, frame_width, border_width,
 159       resize_zones;
 160
 161 #ifdef    HAVE_STRFTIME
 162     std::string strftime_format;
 163 #else // !HAVE_STRFTIME
 164     bool clock24hour;
 165     int date_format;
 166 #endif // HAVE_STRFTIME
 167
 168   } resource;
 169   std::string screenstr;
 170
 171   BScreen(const BScreen&);
 172   BScreen& operator=(const BScreen&);
 173
 174   bool parseMenuFile(FILE *file, Rootmenu *menu);
 175
 176   BTexture readDatabaseTexture(const std::string &rname,
 177                                const std::string &default_color,
 178                                const Configuration &style);
 179   BColor readDatabaseColor(const std::string &rname,
 180                            const std::string &default_color,
 181                            const Configuration &style);
 182   BFont *readDatabaseFont(const std::string &rbasename,
 183                           const Configuration &style);
 184
 185   void InitMenu(void);
 186   void LoadStyle(void);
 187
 188   void updateWorkArea(void);
 189 public:
 190   enum { RowSmartPlacement = 1, ColSmartPlacement, CascadePlacement,
 191          UnderMousePlacement, ClickMousePlacement, LeftRight, RightLeft,
 192          TopBottom, BottomTop, IgnoreShaded, IgnoreMaximized };
 193   enum { RoundBullet = 1, TriangleBullet, SquareBullet, NoBullet };
 194   enum { Restart = 1, RestartOther, Exit, Shutdown, Execute, Reconfigure,
 195          WindowShade, WindowIconify, WindowMaximize, WindowClose, WindowRaise,
 196          WindowLower, WindowStick, WindowKill, SetStyle };
 197   enum FocusModel { SloppyFocus, ClickToFocus };
 198
 199   BScreen(Blackbox *bb, unsigned int scrn);
 200   ~BScreen(void);
 201
 202   inline bool isSloppyFocus(void) const { return resource.sloppy_focus; }
 203   inline bool isRootColormapInstalled(void) const
 204   { return root_colormap_installed; }
 205   inline bool doAutoRaise(void) const { return resource.auto_raise; }
 206   inline bool doClickRaise(void) const { return resource.click_raise; }
 207   inline bool isScreenManaged(void) const { return managed; }
 208   inline bool doAAFonts(void) const { return resource.aa_fonts; }
 209   inline bool doImageDither(void) const { return image_control->doDither(); }
 210   inline bool doOrderedDither(void) const { return resource.ordered_dither; }
 211   inline bool doOpaqueMove(void) const { return resource.opaque_move; }
 212   inline bool doFullMax(void) const { return resource.full_max; }
 213   inline bool doFocusNew(void) const { return resource.focus_new; }
 214   inline bool doFocusLast(void) const { return resource.focus_last; }
 215   inline bool doHideToolbar(void) const { return resource.hide_toolbar; }
 216   inline bool getWindowToWindowSnap(void) const
 217     { return resource.window_to_window_snap; }
 218   inline bool getWindowCornerSnap(void) const
 219     { return resource.window_corner_snap; }
 220   inline bool allowScrollLock(void) const { return resource.allow_scroll_lock; }
 221
 222   inline const GC &getOpGC(void) const { return opGC; }
 223
 224   inline Blackbox *getBlackbox(void) { return blackbox; }
 225   inline BColor *getBorderColor(void) { return &resource.border_color; }
 226   inline BImageControl *getImageControl(void) { return image_control; }
 227   inline Rootmenu *getRootmenu(void) { return rootmenu; }
 228
 229   inline Slit *getSlit(void) { return slit; }
 230   inline Toolbar *getToolbar(void) { return toolbar; }
 231
 232   Workspace *getWorkspace(unsigned int index);
 233
 234   inline Workspace *getCurrentWorkspace(void) { return current_workspace; }
 235
 236   inline Workspacemenu *getWorkspacemenu(void) { return workspacemenu; }
 237
 238   inline unsigned int getHandleWidth(void) const
 239   { return resource.handle_width; }
 240   inline unsigned int getBevelWidth(void) const
 241   { return resource.bevel_width; }
 242   inline unsigned int getFrameWidth(void) const
 243   { return resource.frame_width; }
 244   inline unsigned int getBorderWidth(void) const
 245   { return resource.border_width; }
 246   inline unsigned int getResizeZones(void) const
 247   { return resource.resize_zones; }
 248   inline bool getPlaceIgnoreShaded(void) const
 249   { return resource.ignore_shaded; }
 250   inline bool getPlaceIgnoreMaximized(void) const
 251   { return resource.ignore_maximized; }
 252
 253   inline unsigned int getCurrentWorkspaceID(void) const
 254   { return current_workspace->getID(); }
 255   inline unsigned int getWorkspaceCount(void) const
 256   { return workspacesList.size(); }
 257   inline unsigned int getIconCount(void) const { return iconList.size(); }
 258   inline unsigned int getNumberOfWorkspaces(void) const
 259   { return resource.workspaces; }
 260   inline int getPlacementPolicy(void) const
 261   { return resource.placement_policy; }
 262   inline int getEdgeSnapThreshold(void) const
 263   { return resource.edge_snap_threshold; }
 264   inline int getRowPlacementDirection(void) const
 265   { return resource.row_direction; }
 266   inline int getColPlacementDirection(void) const
 267   { return resource.col_direction; }
 268
 269   void changeWorkspaceCount(unsigned int new_count);
 270
 271   inline void setRootColormapInstalled(bool r) { root_colormap_installed = r; }
 272   void saveSloppyFocus(bool s);
 273   void saveAutoRaise(bool a);
 274   void saveClickRaise(bool c);
 275   void saveWorkspaces(unsigned int w);
 276   void savePlacementPolicy(int p);
 277   void saveRowPlacementDirection(int d);
 278   void saveColPlacementDirection(int d);
 279   void saveEdgeSnapThreshold(int t);
 280   void saveImageDither(bool d);
 281   void saveAAFonts(bool f);
 282   void saveOpaqueMove(bool o);
 283   void saveFullMax(bool f);
 284   void saveFocusNew(bool f);
 285   void saveFocusLast(bool f);
 286   void saveHideToolbar(bool h);
 287   void saveWindowToWindowSnap(bool s);
 288   void saveWindowCornerSnap(bool s);
 289   void saveResizeZones(unsigned int z);
 290   void savePlaceIgnoreShaded(bool i);
 291   void savePlaceIgnoreMaximized(bool i);
 292   void saveAllowScrollLock(bool a);
 293   inline void iconUpdate(void) { iconmenu->update(); }
 294
 295 #ifdef    HAVE_STRFTIME
 296   inline const char *getStrftimeFormat(void)
 297   { return resource.strftime_format.c_str(); }
 298   void saveStrftimeFormat(const std::string& format);
 299 #else // !HAVE_STRFTIME
 300   inline int getDateFormat(void) { return resource.date_format; }
 301   inline void saveDateFormat(int f);
 302   inline bool isClock24Hour(void) { return resource.clock24hour; }
 303   inline void saveClock24Hour(bool c);
 304 #endif // HAVE_STRFTIME
 305
 306   inline WindowStyle *getWindowStyle(void) { return &resource.wstyle; }
 307   inline MenuStyle *getMenuStyle(void) { return &resource.mstyle; }
 308   inline ToolbarStyle *getToolbarStyle(void) { return &resource.tstyle; }
 309
 310   BlackboxWindow *getIcon(unsigned int index);
 311
 312   // allAvailableAreas should be used whenever possible instead of this function
 313   // as then Xinerama will work correctly.
 314   const Rect& availableArea(void) const;
 315   RectList allAvailableAreas(void) const;
 316   void updateAvailableArea(void);
 317   void addStrut(Strut *strut);
 318   void removeStrut(Strut *strut);
 319
 320   unsigned int addWorkspace(void);
 321   unsigned int removeLastWorkspace(void);
 322   void changeWorkspaceID(unsigned int id);
 323   void saveWorkspaceNames(void);
 324
 325   void addNetizen(Netizen *n);
 326   void removeNetizen(Window w);
 327
 328   void addSystrayWindow(Window window);
 329   void removeSystrayWindow(Window window);
 330
 331   void addIcon(BlackboxWindow *w);
 332   void removeIcon(BlackboxWindow *w);
 333
 334   void updateClientList(void);
 335   void updateStackingList(void);
 336   void manageWindow(Window w);
 337   void unmanageWindow(BlackboxWindow *w, bool remap);
 338   void raiseWindows(Window *workspace_stack, unsigned int num);
 339   void lowerWindows(Window *workspace_stack, unsigned int num);
 340   void reassociateWindow(BlackboxWindow *w, unsigned int wkspc_id,
 341                          bool ignore_sticky);
 342   void propagateWindowName(const BlackboxWindow *bw);
 343   void prevFocus(void);
 344   void nextFocus(void);
 345   void raiseFocus(void);
 346   void load_rc(void);
 347   void save_rc(void);
 348   void reconfigure(void);
 349   void toggleFocusModel(FocusModel model);
 350   void rereadMenu(void);
 351   void shutdown(void);
 352   void showPosition(int x, int y);
 353   void showGeometry(unsigned int gx, unsigned int gy);
 354   void hideGeometry(void);
 355
 356   void buttonPressEvent(const XButtonEvent *xbutton);
 357   void propertyNotifyEvent(const XPropertyEvent *pe);
 358
 359   void updateNetizenCurrentWorkspace(void);
 360   void updateNetizenWorkspaceCount(void);
 361   void updateNetizenWindowFocus(void);
 362   void updateNetizenWindowAdd(Window w, unsigned long p);
 363   void updateNetizenWindowDel(Window w);
 364   void updateNetizenConfigNotify(XEvent *e);
 365   void updateNetizenWindowRaise(Window w);
 366   void updateNetizenWindowLower(Window w);
 367 };
 368
 369
 370 #endif // __Screen_hh