1 /* 2 * Copyright 2003-2009 Sun Microsystems, Inc. All Rights Reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Sun designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Sun in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 22 * CA 95054 USA or visit www.sun.com if you need additional information or 23 * have any questions. 24 */ 25 26 27 package sun.awt.X11; 28 29 import java.awt.Frame; 30 import java.util.logging.Level; 31 import java.util.logging.Logger; 32 33 final class XNETProtocol extends XProtocol implements XStateProtocol, XLayerProtocol 34 { 35 private final static Logger log = Logger.getLogger("sun.awt.X11.XNETProtocol"); 36 private final static Logger iconLog = Logger.getLogger("sun.awt.X11.icon.XNETProtocol"); 37 private static Logger stateLog = Logger.getLogger("sun.awt.X11.states.XNETProtocol"); 38 39 /** 40 * XStateProtocol 41 */ 42 public boolean supportsState(int state) { 43 return doStateProtocol() ; // TODO - check for Frame constants 44 } 45 46 public void setState(XWindowPeer window, int state) { 47 if (log.isLoggable(Level.FINE)) log.fine("Setting state of " + window + " to " + state); 48 if (window.isShowing()) { 49 requestState(window, state); 50 } else { 51 setInitialState(window, state); 52 } 53 } 54 55 private void setInitialState(XWindowPeer window, int state) { 56 XAtomList old_state = window.getNETWMState(); 57 log.log(Level.FINE, "Current state of the window {0} is {1}", new Object[] {window, old_state}); 58 if ((state & Frame.MAXIMIZED_VERT) != 0) { 59 old_state.add(XA_NET_WM_STATE_MAXIMIZED_VERT); 60 } else { 61 old_state.remove(XA_NET_WM_STATE_MAXIMIZED_VERT); 62 } 63 if ((state & Frame.MAXIMIZED_HORIZ) != 0) { 64 old_state.add(XA_NET_WM_STATE_MAXIMIZED_HORZ); 65 } else { 66 old_state.remove(XA_NET_WM_STATE_MAXIMIZED_HORZ); 67 } 68 log.log(Level.FINE, "Setting initial state of the window {0} to {1}", new Object[] {window, old_state}); 69 window.setNETWMState(old_state); 70 } 71 72 private void requestState(XWindowPeer window, int state) { 73 /* 74 * We have to use toggle for maximization because of transitions 75 * from maximization in one direction only to maximization in the 76 * other direction only. 77 */ 78 int old_net_state = getState(window); 79 int max_changed = (state ^ old_net_state) & (Frame.MAXIMIZED_BOTH); 80 81 XClientMessageEvent req = new XClientMessageEvent(); 82 try { 83 switch(max_changed) { 84 case 0: 85 return; 86 case Frame.MAXIMIZED_HORIZ: 87 req.set_data(1, XA_NET_WM_STATE_MAXIMIZED_HORZ.getAtom()); 88 req.set_data(2, 0); 89 break; 90 case Frame.MAXIMIZED_VERT: 91 req.set_data(1, XA_NET_WM_STATE_MAXIMIZED_VERT.getAtom()); 92 req.set_data(2, 0); 93 break; 94 case Frame.MAXIMIZED_BOTH: 95 req.set_data(1, XA_NET_WM_STATE_MAXIMIZED_HORZ.getAtom()); 96 req.set_data(2, XA_NET_WM_STATE_MAXIMIZED_VERT.getAtom()); 97 break; 98 default: 99 return; 100 } 101 if (log.isLoggable(Level.FINE)) log.fine("Requesting state on " + window + " for " + state); 102 req.set_type((int)XConstants.ClientMessage); 103 req.set_window(window.getWindow()); 104 req.set_message_type(XA_NET_WM_STATE.getAtom()); 105 req.set_format(32); 106 req.set_data(0, _NET_WM_STATE_TOGGLE); 107 XToolkit.awtLock(); 108 try { 109 XlibWrapper.XSendEvent(XToolkit.getDisplay(), 110 XlibWrapper.RootWindow(XToolkit.getDisplay(), window.getScreenNumber()), 111 false, 112 XConstants.SubstructureRedirectMask | XConstants.SubstructureNotifyMask, 113 req.pData); 114 } 115 finally { 116 XToolkit.awtUnlock(); 117 } 118 } finally { 119 req.dispose(); 120 } 121 } 122 123 public int getState(XWindowPeer window) { 124 return getStateImpl(window); 125 } 126 127 /* 128 * New "NET" WM spec: _NET_WM_STATE/Atom[] 129 */ 130 int getStateImpl(XWindowPeer window) { 131 XAtomList net_wm_state = window.getNETWMState(); 132 if (net_wm_state.size() == 0) { 133 return Frame.NORMAL; 134 } 135 int java_state = Frame.NORMAL; 136 if (net_wm_state.contains(XA_NET_WM_STATE_MAXIMIZED_VERT)) { 137 java_state |= Frame.MAXIMIZED_VERT; 138 } 139 if (net_wm_state.contains(XA_NET_WM_STATE_MAXIMIZED_HORZ)) { 140 java_state |= Frame.MAXIMIZED_HORIZ; 141 } 142 return java_state; 143 } 144 145 public boolean isStateChange(XPropertyEvent e) { 146 boolean res = doStateProtocol() && (e.get_atom() == XA_NET_WM_STATE.getAtom()) ; 147 148 if (res) { 149 // Since state change happened, reset our cached state. It will be re-read by getState 150 XWindowPeer wpeer = (XWindowPeer)XToolkit.windowToXWindow(e.get_window()); 151 wpeer.setNETWMState(null); 152 } 153 return res; 154 } 155 156 /* 157 * Work around for 4775545. 158 */ 159 public void unshadeKludge(XWindowPeer window) { 160 XAtomList net_wm_state = window.getNETWMState(); 161 net_wm_state.remove(XA_NET_WM_STATE_SHADED); 162 window.setNETWMState(net_wm_state); 163 } 164 165 /** 166 * XLayerProtocol 167 */ 168 public boolean supportsLayer(int layer) { 169 return ((layer == LAYER_ALWAYS_ON_TOP) || (layer == LAYER_NORMAL)) && doLayerProtocol(); 170 } 171 172 public void requestState(XWindow window, XAtom state, boolean isAdd) { 173 XClientMessageEvent req = new XClientMessageEvent(); 174 try { 175 req.set_type((int)XConstants.ClientMessage); 176 req.set_window(window.getWindow()); 177 req.set_message_type(XA_NET_WM_STATE.getAtom()); 178 req.set_format(32); 179 req.set_data(0, isAdd ? _NET_WM_STATE_ADD : _NET_WM_STATE_REMOVE); 180 req.set_data(1, state.getAtom()); 181 // Fix for 6735584: req.data[2] must be set to 0 when only one property is changed 182 req.set_data(2, 0); 183 log.log(Level.FINE, "Setting _NET_STATE atom {0} on {1} for {2}", new Object[] {state, window, Boolean.valueOf(isAdd)}); 184 XToolkit.awtLock(); 185 try { 186 XlibWrapper.XSendEvent(XToolkit.getDisplay(), 187 XlibWrapper.RootWindow(XToolkit.getDisplay(), window.getScreenNumber()), 188 false, 189 XConstants.SubstructureRedirectMask | XConstants.SubstructureNotifyMask, 190 req.pData); 191 } 192 finally { 193 XToolkit.awtUnlock(); 194 } 195 } finally { 196 req.dispose(); 197 } 198 } 199 200 /** 201 * Helper function to set/reset one state in NET_WM_STATE 202 * If window is showing then it uses ClientMessage, otherwise adjusts NET_WM_STATE list 203 * @param window Window which NET_WM_STATE property is being modified 204 * @param state State atom to be set/reset 205 * @param reset Indicates operation, 'set' if false, 'reset' if true 206 */ 207 private void setStateHelper(XWindowPeer window, XAtom state, boolean set) { 208 log.log(Level.FINER, "Window visibility is: withdrawn={0}, visible={1}, mapped={2} showing={3}", 209 new Object[] {Boolean.valueOf(window.isWithdrawn()), Boolean.valueOf(window.isVisible()), 210 Boolean.valueOf(window.isMapped()), Boolean.valueOf(window.isShowing())}); 211 if (window.isShowing()) { 212 requestState(window, state, set); 213 } else { 214 XAtomList net_wm_state = window.getNETWMState(); 215 log.log(Level.FINE, "Current state on {0} is {1}", new Object[] {window, net_wm_state}); 216 if (!set) { 217 net_wm_state.remove(state); 218 } else { 219 net_wm_state.add(state); 220 } 221 log.log(Level.FINE, "Setting states on {0} to {1}", new Object[] {window, net_wm_state}); 222 window.setNETWMState(net_wm_state); 223 } 224 XToolkit.XSync(); 225 } 226 227 public void setLayer(XWindowPeer window, int layer) { 228 setStateHelper(window, XA_NET_WM_STATE_ABOVE, layer == LAYER_ALWAYS_ON_TOP); 229 } 230 231 /* New "netwm" spec from www.freedesktop.org */ 232 XAtom XA_UTF8_STRING = XAtom.get("UTF8_STRING"); /* like STRING but encoding is UTF-8 */ 233 XAtom XA_NET_SUPPORTING_WM_CHECK = XAtom.get("_NET_SUPPORTING_WM_CHECK"); 234 XAtom XA_NET_SUPPORTED = XAtom.get("_NET_SUPPORTED"); /* list of protocols (property of root) */ 235 XAtom XA_NET_WM_NAME = XAtom.get("_NET_WM_NAME"); /* window property */ 236 XAtom XA_NET_WM_STATE = XAtom.get("_NET_WM_STATE");/* both window property and request */ 237 238 /* 239 * _NET_WM_STATE is a list of atoms. 240 * NB: Standard spelling is "HORZ" (yes, without an 'I'), but KDE2 241 * uses misspelled "HORIZ" (see KDE bug #20229). This was fixed in 242 * KDE 2.2. Under earlier versions of KDE2 horizontal and full 243 * maximization doesn't work . 244 */ 245 XAtom XA_NET_WM_STATE_MAXIMIZED_HORZ = XAtom.get("_NET_WM_STATE_MAXIMIZED_HORZ"); 246 XAtom XA_NET_WM_STATE_MAXIMIZED_VERT = XAtom.get("_NET_WM_STATE_MAXIMIZED_VERT"); 247 XAtom XA_NET_WM_STATE_SHADED = XAtom.get("_NET_WM_STATE_SHADED"); 248 XAtom XA_NET_WM_STATE_ABOVE = XAtom.get("_NET_WM_STATE_ABOVE"); 249 XAtom XA_NET_WM_STATE_MODAL = XAtom.get("_NET_WM_STATE_MODAL"); 250 XAtom XA_NET_WM_STATE_FULLSCREEN = XAtom.get("_NET_WM_STATE_FULLSCREEN"); 251 XAtom XA_NET_WM_STATE_BELOW = XAtom.get("_NET_WM_STATE_BELOW"); 252 XAtom XA_NET_WM_STATE_HIDDEN = XAtom.get("_NET_WM_STATE_HIDDEN"); 253 XAtom XA_NET_WM_STATE_SKIP_TASKBAR = XAtom.get("_NET_WM_STATE_SKIP_TASKBAR"); 254 XAtom XA_NET_WM_STATE_SKIP_PAGER = XAtom.get("_NET_WM_STATE_SKIP_PAGER"); 255 256 XAtom XA_NET_WM_WINDOW_TYPE = XAtom.get("_NET_WM_WINDOW_TYPE"); 257 XAtom XA_NET_WM_WINDOW_TYPE_DIALOG = XAtom.get("_NET_WM_WINDOW_TYPE_DIALOG"); 258 259 XAtom XA_NET_WM_WINDOW_OPACITY = XAtom.get("_NET_WM_WINDOW_OPACITY"); 260 261 /* For _NET_WM_STATE ClientMessage requests */ 262 final static int _NET_WM_STATE_REMOVE =0; /* remove/unset property */ 263 final static int _NET_WM_STATE_ADD =1; /* add/set property */ 264 final static int _NET_WM_STATE_TOGGLE =2; /* toggle property */ 265 266 boolean supportChecked = false; 267 long NetWindow = 0; 268 void detect() { 269 if (supportChecked) { 270 // TODO: How about detecting WM-restart or exit? 271 return; 272 } 273 NetWindow = checkAnchor(XA_NET_SUPPORTING_WM_CHECK, XAtom.XA_WINDOW); 274 supportChecked = true; 275 if (log.isLoggable(Level.FINE)) log.fine("### " + this + " is active: " + (NetWindow != 0)); 276 } 277 278 boolean active() { 279 detect(); 280 return NetWindow != 0; 281 } 282 283 boolean doStateProtocol() { 284 boolean res = active() && checkProtocol(XA_NET_SUPPORTED, XA_NET_WM_STATE); 285 stateLog.finer("doStateProtocol() returns " + res); 286 return res; 287 } 288 289 boolean doLayerProtocol() { 290 boolean res = active() && checkProtocol(XA_NET_SUPPORTED, XA_NET_WM_STATE_ABOVE); 291 return res; 292 } 293 294 boolean doModalityProtocol() { 295 boolean res = active() && checkProtocol(XA_NET_SUPPORTED, XA_NET_WM_STATE_MODAL); 296 return res; 297 } 298 299 boolean doOpacityProtocol() { 300 boolean res = active() && checkProtocol(XA_NET_SUPPORTED, XA_NET_WM_WINDOW_OPACITY); 301 return res; 302 } 303 304 boolean isWMName(String name) { 305 if (!active()) { 306 return false; 307 } 308 String net_wm_name_string = getWMName(); 309 if (net_wm_name_string == null) { 310 return false; 311 } 312 if (log.isLoggable(Level.FINE)) log.fine("### WM_NAME = " + net_wm_name_string); 313 return net_wm_name_string.startsWith(name); 314 } 315 316 String net_wm_name_cache; 317 public String getWMName() { 318 if (!active()) { 319 return null; 320 } 321 322 if (net_wm_name_cache != null) { 323 return net_wm_name_cache; 324 } 325 326 /* 327 * Check both UTF8_STRING and STRING. We only call this function 328 * with ASCII names and UTF8 preserves ASCII bit-wise. wm-spec 329 * mandates UTF8_STRING for _NET_WM_NAME but at least sawfish-1.0 330 * still uses STRING. (mmm, moving targets...). 331 */ 332 String charSet = "UTF8"; 333 byte[] net_wm_name = XA_NET_WM_NAME.getByteArrayProperty(NetWindow, XA_UTF8_STRING.getAtom()); 334 if (net_wm_name == null) { 335 net_wm_name = XA_NET_WM_NAME.getByteArrayProperty(NetWindow, XAtom.XA_STRING); 336 charSet = "ASCII"; 337 } 338 339 if (net_wm_name == null) { 340 return null; 341 } 342 try { 343 net_wm_name_cache = new String(net_wm_name, charSet); 344 return net_wm_name_cache; 345 } catch (java.io.UnsupportedEncodingException uex) { 346 return null; 347 } 348 } 349 350 /** 351 * Sets _NET_WM_ICON property on the window using the List of XIconInfo 352 * If icons is null or empty list, removes _NET_WM_ICON property 353 */ 354 public void setWMIcons(XWindowPeer window, java.util.List<XIconInfo> icons) { 355 if (window == null) return; 356 357 XAtom iconsAtom = XAtom.get("_NET_WM_ICON"); 358 if (icons == null) { 359 iconsAtom.DeleteProperty(window); 360 return; 361 } 362 363 int length = 0; 364 for (XIconInfo ii : icons) { 365 length += ii.getRawLength(); 366 } 367 int cardinalSize = (XlibWrapper.dataModel == 32) ? 4 : 8; 368 int bufferSize = length * cardinalSize; 369 370 if (bufferSize != 0) { 371 long buffer = XlibWrapper.unsafe.allocateMemory(bufferSize); 372 try { 373 long ptr = buffer; 374 for (XIconInfo ii : icons) { 375 int size = ii.getRawLength() * cardinalSize; 376 if (XlibWrapper.dataModel == 32) { 377 XlibWrapper.copyIntArray(ptr, ii.getIntData(), size); 378 } else { 379 XlibWrapper.copyLongArray(ptr, ii.getLongData(), size); 380 } 381 ptr += size; 382 } 383 iconsAtom.setAtomData(window.getWindow(), XAtom.XA_CARDINAL, buffer, bufferSize/Native.getCard32Size()); 384 } finally { 385 XlibWrapper.unsafe.freeMemory(buffer); 386 } 387 } else { 388 iconsAtom.DeleteProperty(window); 389 } 390 } 391 392 public boolean isWMStateNetHidden(XWindowPeer window) { 393 if (!doStateProtocol()) { 394 return false; 395 } 396 XAtomList state = window.getNETWMState(); 397 return (state != null && state.size() != 0 && state.contains(XA_NET_WM_STATE_HIDDEN)); 398 } 399 }