/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/**

 * Ported from awt_wm.c, SCCS v1.11, author Valeriy Ushakov

 * Author: Denis Mikhalkin

 */

package sun.awt.X11;

import sun.misc.Unsafe;

import java.awt.Insets;

import java.awt.Frame;

import java.awt.Rectangle;

import java.util.Collection;

import java.util.HashMap;

import java.util.LinkedList;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import sun.util.logging.PlatformLogger;

/**

 * Class incapsulating knowledge about window managers in general

 * Descendants should provide some information about specific window manager.

 */

final class XWM

{

    private final static PlatformLogger log = PlatformLogger.getLogger("sun.awt.X11.XWM");

    private final static PlatformLogger insLog = PlatformLogger.getLogger("sun.awt.X11.insets.XWM");

    private final static PlatformLogger stateLog = PlatformLogger.getLogger("sun.awt.X11.states.XWM");

    static final XAtom XA_MWM_HINTS = new XAtom();

    private static Unsafe unsafe = XlibWrapper.unsafe;

/* Good old ICCCM */

    static XAtom XA_WM_STATE = new XAtom();

    XAtom XA_UTF8_STRING = XAtom.get("UTF8_STRING");    /* like STRING but encoding is UTF-8 */

/* Currently we only care about max_v and max_h in _NET_WM_STATE */

    final static int AWT_NET_N_KNOWN_STATES=2;

/* Enlightenment */

    final static XAtom XA_E_FRAME_SIZE = new XAtom();

/* KWin (KDE2) */

    final static XAtom XA_KDE_NET_WM_FRAME_STRUT = new XAtom();

/* KWM (KDE 1.x) OBSOLETE??? */

    final static XAtom XA_KWM_WIN_ICONIFIED = new XAtom();

    final static XAtom XA_KWM_WIN_MAXIMIZED = new XAtom();

/* OpenLook */

    final static XAtom XA_OL_DECOR_DEL = new XAtom();

    final static XAtom XA_OL_DECOR_HEADER = new XAtom();

    final static XAtom XA_OL_DECOR_RESIZE = new XAtom();

    final static XAtom XA_OL_DECOR_PIN = new XAtom();

    final static XAtom XA_OL_DECOR_CLOSE = new XAtom();

/* EWMH */

    final static XAtom XA_NET_FRAME_EXTENTS = new XAtom();

    final static XAtom XA_NET_REQUEST_FRAME_EXTENTS = new XAtom();

    final static int

        UNDETERMINED_WM = 1,

        NO_WM = 2,

        OTHER_WM = 3,

        OPENLOOK_WM = 4,

        MOTIF_WM = 5,

        CDE_WM = 6,

        ENLIGHTEN_WM = 7,

        KDE2_WM = 8,

        SAWFISH_WM = 9,

        ICE_WM = 10,

        METACITY_WM = 11,

        COMPIZ_WM = 12,

        LG3D_WM = 13,

        CWM_WM = 14,

        MUTTER_WM = 15;

    public String toString() {

        switch  (WMID) {

          case NO_WM:

              return "NO WM";

          case OTHER_WM:

              return "Other WM";

          case OPENLOOK_WM:

              return "OPENLOOK";

          case MOTIF_WM:

              return "MWM";

          case CDE_WM:

              return "DTWM";

          case ENLIGHTEN_WM:

              return "Enlightenment";

          case KDE2_WM:

              return "KWM2";

          case SAWFISH_WM:

              return "Sawfish";

          case ICE_WM:

              return "IceWM";

          case METACITY_WM:

              return "Metacity";

          case COMPIZ_WM:

              return "Compiz";

          case LG3D_WM:

              return "LookingGlass";

          case CWM_WM:

              return "CWM";

          case MUTTER_WM:

              return "Mutter";

          case UNDETERMINED_WM:

          default:

              return "Undetermined WM";

        }

    }

    int WMID;

    static final Insets zeroInsets = new Insets(0, 0, 0, 0);

    static final Insets defaultInsets = new Insets(25, 5, 5, 5);

    XWM(int WMID) {

        this.WMID = WMID;

        initializeProtocols();

        if (log.isLoggable(PlatformLogger.FINE)) {

            log.fine("Window manager: " + toString());

        }

    }

    int getID() {

        return WMID;

    }

    static Insets normalize(Insets insets) {

        if (insets.top > 64 || insets.top < 0) {

            insets.top = 28;

        }

        if (insets.left > 32 || insets.left < 0) {

            insets.left = 6;

        }

        if (insets.right > 32 || insets.right < 0) {

            insets.right = 6;

        }

        if (insets.bottom > 32 || insets.bottom < 0) {

            insets.bottom = 6;

        }

        return insets;

    }

    static XNETProtocol g_net_protocol = null;

    static XWINProtocol g_win_protocol = null;

    static boolean isNetWMName(String name) {

        if (g_net_protocol != null) {

            return g_net_protocol.isWMName(name);

        } else {

            return false;

        }

    }

    static void initAtoms() {

        final Object[][] atomInitList ={

            { XA_WM_STATE,                      "WM_STATE"                  },

            { XA_KDE_NET_WM_FRAME_STRUT,    "_KDE_NET_WM_FRAME_STRUT"       },

            { XA_E_FRAME_SIZE,              "_E_FRAME_SIZE"                 },

            { XA_KWM_WIN_ICONIFIED,          "KWM_WIN_ICONIFIED"             },

            { XA_KWM_WIN_MAXIMIZED,          "KWM_WIN_MAXIMIZED"             },

            { XA_OL_DECOR_DEL,               "_OL_DECOR_DEL"                 },

            { XA_OL_DECOR_HEADER,            "_OL_DECOR_HEADER"              },

            { XA_OL_DECOR_RESIZE,            "_OL_DECOR_RESIZE"              },

            { XA_OL_DECOR_PIN,               "_OL_DECOR_PIN"                 },

            { XA_OL_DECOR_CLOSE,             "_OL_DECOR_CLOSE"               },

            { XA_MWM_HINTS,                  "_MOTIF_WM_HINTS"               },

            { XA_NET_FRAME_EXTENTS,          "_NET_FRAME_EXTENTS"            },

            { XA_NET_REQUEST_FRAME_EXTENTS,  "_NET_REQUEST_FRAME_EXTENTS"    },

        };

        String[] names = new String[atomInitList.length];

        for (int index = 0; index < names.length; index++) {

            names[index] = (String)atomInitList[index][1];

        }

        int atomSize = XAtom.getAtomSize();

        long atoms = unsafe.allocateMemory(names.length*atomSize);

        XToolkit.awtLock();

        try {

            int status = XlibWrapper.XInternAtoms(XToolkit.getDisplay(), names, false, atoms);

            if (status == 0) {

                return;

            }

            for (int atom = 0, atomPtr = 0; atom < names.length; atom++, atomPtr += atomSize) {

                ((XAtom)(atomInitList[atom][0])).setValues(XToolkit.getDisplay(), names[atom], XAtom.getAtom(atoms + atomPtr));

            }

        } finally {

            XToolkit.awtUnlock();

            unsafe.freeMemory(atoms);

        }

    }

    /*

     * MUST BE CALLED UNDER AWTLOCK.

     *

     * If *any* window manager is running?

     *

     * According to ICCCM 2.0 section 4.3.

     * WM will acquire ownership of a selection named WM_Sn, where n is

     * the screen number.

     *

     * No selection owner, but, perhaps it is not ICCCM compliant WM

     * (e.g. CDE/Sawfish).

     * Try selecting for SubstructureRedirect, that only one client

     * can select for, and if the request fails, than some other WM is

     * already running.

     *

     * We also treat eXcursion as NO_WM.

     */

    private static boolean isNoWM() {

        /*

         * Quick checks for specific servers.

         */

        String vendor_string = XlibWrapper.ServerVendor(XToolkit.getDisplay());

        if (vendor_string.indexOf("eXcursion") != -1) {

            /*

             * Use NO_WM since in all other aspects eXcursion is like not

             * having a window manager running. I.e. it does not reparent

             * top level shells.

             */

            if (insLog.isLoggable(PlatformLogger.FINER)) {

                insLog.finer("eXcursion means NO_WM");

            }

            return true;

        }

        XSetWindowAttributes substruct = new XSetWindowAttributes();

        try {

            /*

             * Let's check an owner of WM_Sn selection for the default screen.

             */

            final long default_screen_number =

                XlibWrapper.DefaultScreen(XToolkit.getDisplay());

            final String selection_name = "WM_S" + default_screen_number;

            long selection_owner =

                XlibWrapper.XGetSelectionOwner(XToolkit.getDisplay(),

                                               XAtom.get(selection_name).getAtom());

            if (insLog.isLoggable(PlatformLogger.FINER)) {

                insLog.finer("selection owner of " + selection_name

                             + " is " + selection_owner);

            }

            if (selection_owner != XConstants.None) {

                return false;

            }

            winmgr_running = false;

            substruct.set_event_mask(XConstants.SubstructureRedirectMask);

            XlibWrapper.XChangeWindowAttributes(XToolkit.getDisplay(),

                                                XToolkit.getDefaultRootWindow(),

                                                XConstants.CWEventMask,

                                                substruct.pData);

            /*

             * If no WM is running then our selection for SubstructureRedirect

             * succeeded and needs to be undone (hey we are *not* a WM ;-).

             */

            if (!winmgr_running) {

                substruct.set_event_mask(0);

                XlibWrapper.XChangeWindowAttributes(XToolkit.getDisplay(),

                                                    XToolkit.getDefaultRootWindow(),

                                                    XConstants.CWEventMask,

                                                    substruct.pData);

                if (insLog.isLoggable(PlatformLogger.FINER)) {

                    insLog.finer("It looks like there is no WM thus NO_WM");

                }

            }

            return !winmgr_running;

        } finally {

            substruct.dispose();

        }

    }

    static XAtom XA_ENLIGHTENMENT_COMMS = new XAtom("ENLIGHTENMENT_COMMS", false);

    /*

     * Helper function for isEnlightenment().

     * Enlightenment uses STRING property for its comms window id.  Gaaa!

     * The property is ENLIGHTENMENT_COMMS, STRING/8 and the string format

     * is "WINID %8x".  Gee, I haven't been using scanf for *ages*... :-)

     */

    static long getECommsWindowIDProperty(long window) {

        if (!XA_ENLIGHTENMENT_COMMS.isInterned()) {

            return 0;

        }

        WindowPropertyGetter getter =

            new WindowPropertyGetter(window, XA_ENLIGHTENMENT_COMMS, 0, 14, false,

                                     XAtom.XA_STRING);

        try {

            int status = getter.execute(XErrorHandler.IgnoreBadWindowHandler.getInstance());

            if (status != XConstants.Success || getter.getData() == 0) {

                return 0;

            }

            if (getter.getActualType() != XAtom.XA_STRING

                || getter.getActualFormat() != 8

                || getter.getNumberOfItems() != 14 || getter.getBytesAfter() != 0)

            {

                return 0;

            }

            // Convert data to String, ASCII

            byte[] bytes = XlibWrapper.getStringBytes(getter.getData());

            String id = new String(bytes);

            if (log.isLoggable(PlatformLogger.FINER)) {

                log.finer("ENLIGHTENMENT_COMMS is " + id);

            }

            // Parse WINID

            Pattern winIdPat = Pattern.compile("WINID\\s+(\\p{XDigit}{0,8})");

            try {

                Matcher match = winIdPat.matcher(id);

                if (match.matches()) {

                    if (log.isLoggable(PlatformLogger.FINEST)) {

                        log.finest("Match group count: " + match.groupCount());

                    }

                    String longId = match.group(1);

                    if (log.isLoggable(PlatformLogger.FINEST)) {

                        log.finest("Match group 1 " + longId);

                    }

                    long winid = Long.parseLong(longId, 16);

                    if (log.isLoggable(PlatformLogger.FINER)) {

                        log.finer("Enlightenment communication window " + winid);

                    }

                    return winid;

                } else {

                    log.finer("ENLIGHTENMENT_COMMS has wrong format");

                    return 0;

                }

            } catch (Exception e) {

                if (log.isLoggable(PlatformLogger.FINER)) {

                    e.printStackTrace();

                }

                return 0;

            }

        } finally {

            getter.dispose();

        }

    }

    /*

     * Is Enlightenment WM running?  Congruent to awt_wm_checkAnchor, but

     * uses STRING property peculiar to Enlightenment.

     */

    static boolean isEnlightenment() {

        long root_xref = getECommsWindowIDProperty(XToolkit.getDefaultRootWindow());

        if (root_xref == 0) {

            return false;

        }

        long self_xref = getECommsWindowIDProperty(root_xref);

        if (self_xref != root_xref) {

            return false;

        }

        return true;

    }

    /*

     * Is CDE running?

     *

     * XXX: This is hairy...  CDE is MWM as well.  It seems we simply test

     * for default setup and will be bitten if user changes things...

     *

     * Check for _DT_SM_WINDOW_INFO(_DT_SM_WINDOW_INFO) on root.  Take the

     * second element of the property and check for presence of

     * _DT_SM_STATE_INFO(_DT_SM_STATE_INFO) on that window.

     *

     * XXX: Any header that defines this structures???

     */

    static final XAtom XA_DT_SM_WINDOW_INFO = new XAtom("_DT_SM_WINDOW_INFO", false);

    static final XAtom XA_DT_SM_STATE_INFO = new XAtom("_DT_SM_STATE_INFO", false);

    static boolean isCDE() {

        if (!XA_DT_SM_WINDOW_INFO.isInterned()) {

            if (log.isLoggable(PlatformLogger.FINER)) {

                log.finer("{0} is not interned", XA_DT_SM_WINDOW_INFO);

            }

            return false;

        }

        WindowPropertyGetter getter =

            new WindowPropertyGetter(XToolkit.getDefaultRootWindow(),

                                     XA_DT_SM_WINDOW_INFO, 0, 2,

                                     false, XA_DT_SM_WINDOW_INFO);

        try {

            int status = getter.execute();

            if (status != XConstants.Success || getter.getData() == 0) {

                log.finer("Getting of _DT_SM_WINDOW_INFO is not successfull");

                return false;

            }

            if (getter.getActualType() != XA_DT_SM_WINDOW_INFO.getAtom()

                || getter.getActualFormat() != 32

                || getter.getNumberOfItems() != 2 || getter.getBytesAfter() != 0)

            {

                log.finer("Wrong format of _DT_SM_WINDOW_INFO");

                return false;

            }

            long wmwin = Native.getWindow(getter.getData(), 1); //unsafe.getInt(getter.getData()+4);

            if (wmwin == 0) {

                log.fine("WARNING: DT_SM_WINDOW_INFO exists but returns zero windows");

                return false;

            }

            /* Now check that this window has _DT_SM_STATE_INFO (ignore contents) */

            if (!XA_DT_SM_STATE_INFO.isInterned()) {

                if (log.isLoggable(PlatformLogger.FINER)) {

                    log.finer("{0} is not interned", XA_DT_SM_STATE_INFO);

                }

                return false;

            }

            WindowPropertyGetter getter2 =

                new WindowPropertyGetter(wmwin, XA_DT_SM_STATE_INFO, 0, 1,

                                         false, XA_DT_SM_STATE_INFO);

            try {

                status = getter2.execute(XErrorHandler.IgnoreBadWindowHandler.getInstance());

                if (status != XConstants.Success || getter2.getData() == 0) {

                    log.finer("Getting of _DT_SM_STATE_INFO is not successfull");

                    return false;

                }

                if (getter2.getActualType() != XA_DT_SM_STATE_INFO.getAtom()

                    || getter2.getActualFormat() != 32)

                {

                    log.finer("Wrong format of _DT_SM_STATE_INFO");

                    return false;

                }

                return true;

            } finally {

                getter2.dispose();

            }

        } finally {

            getter.dispose();

        }

    }

    /*

     * Is MWM running?  (Note that CDE will test positive as well).

     *

     * Check for _MOTIF_WM_INFO(_MOTIF_WM_INFO) on root.  Take the

     * second element of the property and check for presence of

     * _DT_SM_STATE_INFO(_DT_SM_STATE_INFO) on that window.

     */

    static final XAtom XA_MOTIF_WM_INFO = new XAtom("_MOTIF_WM_INFO", false);

    static final XAtom XA_DT_WORKSPACE_CURRENT = new XAtom("_DT_WORKSPACE_CURRENT", false);

    static boolean isMotif() {

        if (!(XA_MOTIF_WM_INFO.isInterned()/* && XA_DT_WORKSPACE_CURRENT.isInterned()*/) ) {

            return false;

        }

        WindowPropertyGetter getter =

            new WindowPropertyGetter(XToolkit.getDefaultRootWindow(),

                                     XA_MOTIF_WM_INFO, 0,

                                     MWMConstants.PROP_MOTIF_WM_INFO_ELEMENTS,

                                     false, XA_MOTIF_WM_INFO);

        try {

            int status = getter.execute();

            if (status != XConstants.Success || getter.getData() == 0) {

                return false;

            }

            if (getter.getActualType() != XA_MOTIF_WM_INFO.getAtom()

                || getter.getActualFormat() != 32

                || getter.getNumberOfItems() != MWMConstants.PROP_MOTIF_WM_INFO_ELEMENTS

                || getter.getBytesAfter() != 0)

            {

                return false;

            }