support pseudocolor and greyscale displays by, using solid colors instead of gradients
[mikachu/openbox.git] / src / openbox.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 #ifndef   __openbox_hh
3 #define   __openbox_hh
4
5 /*! @file openbox.hh
6   @brief The main class for the Openbox window manager
7 */
8
9 extern "C" {
10 #include <X11/Xlib.h>
11 }
12
13 #include <string>
14 #include <vector>
15 #include <map>
16
17 #include "otk/display.hh"
18 #include "otk/screeninfo.hh"
19 #include "otk/eventdispatcher.hh"
20 #include "otk/eventhandler.hh"
21
22 namespace ob {
23
24 class Screen;
25 class Client;
26 class Actions;
27 class Bindings;
28
29 //! Mouse cursors used throughout Openbox
30 struct Cursors {
31   Cursor session;  //!< The default mouse cursor
32   Cursor move;     //!< For moving a window
33   Cursor ll_angle; //!< For resizing the bottom left corner of a window
34   Cursor lr_angle; //!< For resizing the bottom right corner of a window
35   Cursor ul_angle; //!< For resizing the top left corner of a window
36   Cursor ur_angle; //!< For resizing the right corner of a window
37 };
38
39 class Openbox;
40
41 //! The single instance of the Openbox class for the application
42 /*!
43   Since this variable is globally available in the application, the Openbox
44   class does not need to be passed around to any of the other classes.
45 */
46 extern Openbox *openbox;
47
48 //! The main class for the Openbox window manager
49 /*!
50   Only a single instance of the Openbox class may be used in the application. A
51   pointer to this instance is held in the Openbox::instance static member
52   variable.
53   Instantiation of this class begins the window manager. After instantiation,
54   the Openbox::eventLoop function should be called. The eventLoop method does
55   not exit until the window manager is ready to be destroyed. Destruction of
56   the Openbox class instance will shutdown the window manager.
57 */
58 class Openbox : public otk::EventDispatcher, public otk::EventHandler
59 {
60 public:
61   //! The posible running states of the window manager
62   enum RunState {
63     State_Starting, //!< The window manager is starting up (being created)
64     State_Normal,   //!< The window manager is running in its normal state
65     State_Exiting   //!< The window manager is exiting (being destroyed)
66   };
67
68   //! A map for looking up a specific client class from the window id
69   typedef std::map<Window, Client *> ClientMap;
70
71   //! A list of Screen classes
72   typedef std::vector<Screen *> ScreenList;
73   
74 private:
75   //! The display on which Openbox is running
76   otk::Display _display;
77   
78   // stuff that can be passed on the command line
79   //! Path to the config file to use/in use
80   /*!
81     Defaults to $(HOME)/.openbox/rc3
82   */
83   std::string _rcfilepath;
84   //! Path to the menu file to use/in use
85   /*!
86     Defaults to $(HOME)/.openbox/menu3
87   */
88   std::string _menufilepath;
89   //! Path to the script file to execute on startup
90   /*!
91     Defaults to $(HOME)/.openbox/user.py
92   */
93   std::string _scriptfilepath;
94   //! The display requested by the user, or null to use the DISPLAY env var
95   char *_displayreq;
96   //! The value of argv, i.e. how this application was executed
97   char **_argv;
98   //! Run the application in synchronous mode? (for debugging)
99   bool _sync;
100   //! Should Openbox run on a single screen or on all available screens?
101   bool _single;
102
103   //! A list of all managed clients
104   ClientMap _clients;
105
106   //! A list of all the managed screens
107   ScreenList _screens;
108   
109   //! The action interface through which all user-available actions occur
110   Actions *_actions;
111
112   //! The interface through which keys/buttons are grabbed and handled
113   Bindings *_bindings;
114
115   //! The running state of the window manager
116   RunState _state;
117
118   //! Mouse cursors used throughout Openbox
119   Cursors _cursors;
120
121   //! When set to true, the Openbox::eventLoop function will stop and return
122   bool _shutdown;
123
124   //! When set to true, and Openbox is about to exit, it will spawn a new
125   //! process
126   bool _restart;
127
128   //! If this contains anything, a restart will try to execute the program in
129   //! this variable, and will fallback to reexec'ing itself if that fails
130   std::string _restart_prog;
131
132   //! The client with input focus
133   /*!
134     Updated by the clients themselves.
135   */
136   Client *_focused_client;
137
138   //! The screen with input focus
139   /*!
140     Updated by the clients when they update the Openbox::focused_client
141     property.
142   */
143   Screen *_focused_screen;
144   
145   //! Parses the command line used when executing this application
146   void parseCommandLine(int argv, char **argv);
147   //! Displays the version string to stdout
148   void showVersion();
149   //! Displays usage information and help to stdout
150   void showHelp();
151
152   //! Handles signal events for the application
153   static void signalHandler(int signal);
154
155 public:
156 #ifndef SWIG
157   //! Openbox constructor.
158   /*!
159     \param argc Number of command line arguments, as received in main()
160     \param argv The command line arguments, as received in main()
161   */
162   Openbox(int argc, char **argv);
163   //! Openbox destructor.
164   virtual ~Openbox();
165 #endif
166
167   //! Returns the state of the window manager (starting, exiting, etc)
168   inline RunState state() const { return _state; }
169
170   //! Returns the Actions instance for the window manager
171   inline Actions *actions() const { return _actions; }
172
173   //! Returns the Bindings instance for the window manager
174   inline Bindings *bindings() const { return _bindings; }
175
176   //! Returns a managed screen or a null pointer
177   /*!
178     ALWAYS check the return value for a non-null, as any unmanaged screens
179     will return one. This includes screen(0) if the first managed screen is 1.
180   */
181   inline Screen *screen(int num) {
182     assert(num >= 0); assert(num < (signed)ScreenCount(**otk::display));
183     if (num >= (signed)_screens.size()) return 0;
184     return _screens[num];
185   }
186
187   //! Returns the mouse cursors used throughout Openbox
188   inline const Cursors &cursors() const { return _cursors; }
189
190 #ifndef SWIG
191   //! The main function of the Openbox class
192   /*!
193     This function should be called after instantiating the Openbox class.
194     It loops indefinately while handling all events for the application.
195     The Openbox::shutdown method will cause this function to exit.
196   */
197   void eventLoop();
198 #endif
199
200   //! Adds an Client to the client list for lookups
201   void addClient(Window window, Client *client);
202
203   //! Removes an Client from the client list for lookups
204   void removeClient(Window window);
205
206   //! Finds an Client based on its window id
207   Client *findClient(Window window);
208
209   //! The client with input focus
210   inline Client *focusedClient() { return _focused_client; }
211
212   //! Change the client which has focus.
213   /*!
214     This is called by the clients themselves when their focus state changes.
215   */
216   void setFocusedClient(Client *c);
217
218   //! The screen with input focus
219   inline Screen *focusedScreen() { return _focused_screen; }
220   
221   //! Requests that the window manager exit
222   /*!
223     Causes the Openbox::eventLoop function to stop looping, so that the window
224     manager can be destroyed.
225   */
226   inline void shutdown() { _shutdown = true; }
227
228   inline void restart(const std::string &bin = "") {
229     _shutdown = true; _restart = true; _restart_prog = bin;
230   }
231
232   //! True if Openbox should be restarted instead of exiting
233   inline bool doRestart() const { return _restart; }
234
235   //! The command line requested to be executed in place of restarting
236   //! Openbox the way it was run previously.
237   inline const std::string &restartProgram() const { return _restart_prog; }
238 };
239
240 }
241
242 #endif // __openbox_hh