/*

 * 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.  Sun designates this

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

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

#ifndef AWT_COMPONENT_H

#define AWT_COMPONENT_H

#include "awtmsg.h"

#include "awt_Object.h"

#include "awt_Font.h"

#include "awt_Brush.h"

#include "awt_Pen.h"

#include "awt_Win32GraphicsDevice.h"

#include "GDIWindowSurfaceData.h"

#include "java_awt_Component.h"

#include "sun_awt_windows_WComponentPeer.h"

#include "java_awt_event_KeyEvent.h"

#include "java_awt_event_FocusEvent.h"

#include "java_awt_event_MouseEvent.h"

#include "java_awt_event_WindowEvent.h"

#include "java_awt_Dimension.h"

extern LPCTSTR szAwtComponentClassName;

static LPCTSTR DrawingStateProp = TEXT("SunAwtDrawingStateProp");

const UINT IGNORE_KEY = (UINT)-1;

const UINT MAX_ACP_STR_LEN = 7; // ANSI CP identifiers are no longer than this

#define LEFT_BUTTON 1

#define MIDDLE_BUTTON 2

#define RIGHT_BUTTON 4

#define DBL_CLICK 8

// Whether to check for embedded frame and adjust location

#define CHECK_EMBEDDED 0

#define DONT_CHECK_EMBEDDED 1

class AwtPopupMenu;

class AwtDropTarget;

struct WmComponentSetFocusData;

/*

 * Message routing codes

 */

enum MsgRouting {

    mrPassAlong,    /* pass along to next in chain */

    mrDoDefault,    /* skip right to underlying default behavior */

    mrConsume,      /* consume msg & terminate routing immediatly,

                     * don't pass anywhere

                     */

};

/************************************************************************

 * AwtComponent class

 */

class AwtComponent : public AwtObject {

public:

    enum {

        // combination of all mouse button flags

        ALL_MK_BUTTONS = MK_LBUTTON|MK_MBUTTON|MK_RBUTTON

    };

    /* java.awt.Component fields and method IDs */

    static jfieldID peerID;

    static jfieldID xID;

    static jfieldID yID;

    static jfieldID widthID;

    static jfieldID heightID;

    static jfieldID visibleID;

    static jfieldID backgroundID;

    static jfieldID foregroundID;

    static jfieldID enabledID;

    static jfieldID parentID;

    static jfieldID cursorID;

    static jfieldID graphicsConfigID;

    static jfieldID peerGCID;

    static jfieldID focusableID;

    static jfieldID appContextID;

    static jfieldID hwndID;

    static jmethodID getFontMID;

    static jmethodID getToolkitMID;

    static jmethodID isEnabledMID;

    static jmethodID getLocationOnScreenMID;

    static jmethodID replaceSurfaceDataMID;

    static jmethodID replaceSurfaceDataLaterMID;

    static const UINT WmAwtIsComponent;

    AwtComponent();

    virtual ~AwtComponent();

    /*

     * Dynamic class registration & creation

     */

    virtual LPCTSTR GetClassName() = 0;

    /*

     * Fix for 4964237: Win XP: Changing theme changes java dialogs title icon

     * WNDCLASS structure has been superseded by the WNDCLASSEX in Win32

     */

    virtual void FillClassInfo(WNDCLASSEX *lpwc);

    virtual void RegisterClass();

    virtual void UnregisterClass();

    void CreateHWnd(JNIEnv *env, LPCWSTR title,

                    DWORD windowStyle, DWORD windowExStyle,

                    int x, int y, int w, int h,

                    HWND hWndParent, HMENU hMenu,

                    COLORREF colorForeground, COLORREF colorBackground,

                    jobject peer);

    void InitPeerGraphicsConfig(JNIEnv *env, jobject peer);

    virtual void Dispose();

    void UpdateBackground(JNIEnv *env, jobject target);

    virtual void SubclassHWND();

    virtual void UnsubclassHWND();

    static LRESULT CALLBACK WndProc(HWND hWnd, UINT message,

        WPARAM wParam, LPARAM lParam);

    /*

     * Access to the various objects of this aggregate component

     */

    INLINE HWND GetHWnd() { return m_hwnd; }

    INLINE void SetHWnd(HWND hwnd) { m_hwnd = hwnd; }

    static AwtComponent* GetComponent(HWND hWnd);

    /*

     * Access to the properties of the component

     */

    INLINE COLORREF GetColor() { return m_colorForeground; }

    virtual void SetColor(COLORREF c);

    HPEN GetForegroundPen();

    COLORREF GetBackgroundColor();

    virtual void SetBackgroundColor(COLORREF c);

    HBRUSH GetBackgroundBrush();

    INLINE BOOL IsBackgroundColorSet() { return m_backgroundColorSet; }

    virtual void SetFont(AwtFont *pFont);

    INLINE void SetText(LPCTSTR text) { ::SetWindowText(GetHWnd(), text); }

    INLINE int GetText(LPTSTR buffer, int size) {

        return ::GetWindowText(GetHWnd(), buffer, size);

    }

    INLINE int GetTextLength() { return ::GetWindowTextLength(GetHWnd()); }

    virtual void GetInsets(RECT* rect) {

        VERIFY(::SetRectEmpty(rect));

    }

    BOOL IsVisible() { return m_visible;};

    HDC GetDCFromComponent();

    /*

     * Enable/disable component

     */

    virtual void Enable(BOOL bEnable);

    /*

     * Validate and call handleExpose on rects of UpdateRgn

     */

    void PaintUpdateRgn(const RECT *insets);

    static HWND GetTopLevelParentForWindow(HWND hwndDescendant);

    static jobject FindHeavyweightUnderCursor(BOOL useCache);

    /*

     * Returns the parent component.  If no parent window, or the

     * parent window isn't an AwtComponent, returns NULL.

     */

    AwtComponent* GetParent();

    /* Get the component's immediate container. Note: may return NULL while

       the component is being reparented in full-screen mode by Direct3D */

    class AwtWindow* GetContainer();

    /* Is a component a container? Used by above method */

    virtual BOOL IsContainer() { return FALSE;} // Plain components can't

    /**

     * Perform some actions which by default are being performed by Default Window procedure of

     * this window class

     * For detailed comments see implementation in awt_Component.cpp

     */

    virtual BOOL ActMouseMessage(MSG * pMsg);

    /**

     * Returns TRUE if this message will this component to become focused. Returns FALSE otherwise.

     */

    inline BOOL IsFocusingMessage(UINT message) {

        return message == WM_LBUTTONDOWN || message == WM_LBUTTONUP || message == WM_LBUTTONDBLCLK;

    }

    BOOL IsFocusable();

    /*

     * Returns an increasing unsigned value used for child control IDs.

     * There is no attempt to reclaim command ID's.

     */

    INLINE UINT CreateControlID() { return m_nextControlID++; }

    // returns the current keyboard layout

    INLINE static HKL GetKeyboardLayout() {

        return m_hkl;

    }

    // returns the current code page that should be used in

    // all MultiByteToWideChar and WideCharToMultiByte calls.

    // This code page should also be use in IsDBCSLeadByteEx.

    INLINE static UINT GetCodePage()

    {

        return m_CodePage;

    }

// Added by waleed for BIDI Support

    // returns the right to left status

    INLINE static BOOL GetRTLReadingOrder() {

        return sm_rtlReadingOrder;

    }

    // returns the right to left status

    INLINE static BOOL GetRTL() {

        return sm_rtl;

    }

    // returns the current sub language

    INLINE static LANGID GetSubLanguage() {

        return SUBLANGID(m_idLang);

    }

// end waleed

    // returns the current input language

    INLINE static LANGID GetInputLanguage()

    {

        return m_idLang;

    }

    // Convert Language ID to CodePage

    static UINT LangToCodePage(LANGID idLang);

    /*

     * methods on this component

     */

    virtual void Show();

    virtual void Hide();

    virtual void Reshape(int x, int y, int w, int h);

    /*

     * Fix for 4046446.

     * Component size/position helper, for the values above the short int limit.

     */

    static BOOL SetWindowPos(HWND wnd, HWND after,

                             int x, int y, int w, int h, UINT flags);

    /*

     * Sets the scrollbar values.  'bar' can be either SB_VERT or

     * SB_HORZ.  'min', 'value', and 'max' can have the value INT_MAX

     * which means that the value should not be changed.

     */

    void SetScrollValues(UINT bar, int min, int value, int max);

    INLINE LRESULT SendMessage(UINT msg, WPARAM wParam=0, LPARAM lParam=0) {

        DASSERT(GetHWnd());

        return ::SendMessage(GetHWnd(), msg, wParam, lParam);

    }

    void PostUngrabEvent();

    INLINE virtual LONG GetStyle() {

        DASSERT(GetHWnd());

        return ::GetWindowLong(GetHWnd(), GWL_STYLE);

    }

    INLINE virtual void SetStyle(LONG style) {

        DASSERT(GetHWnd());

        // SetWindowLong() error handling as recommended by Win32 API doc.

        ::SetLastError(0);

        DWORD ret = ::SetWindowLong(GetHWnd(), GWL_STYLE, style);

        DASSERT(ret != 0 || ::GetLastError() == 0);

    }

    INLINE virtual LONG GetStyleEx() {

        DASSERT(GetHWnd());

        return ::GetWindowLong(GetHWnd(), GWL_EXSTYLE);

    }

    INLINE virtual void SetStyleEx(LONG style) {

        DASSERT(GetHWnd());

        // SetWindowLong() error handling as recommended by Win32 API doc.

        ::SetLastError(0);

        DWORD ret = ::SetWindowLong(GetHWnd(), GWL_EXSTYLE, style);

        DASSERT(ret != 0 || ::GetLastError() == 0);

    }

    virtual BOOL NeedDblClick() { return FALSE; }

    /* for multifont component */

    static void DrawWindowText(HDC hDC, jobject font, jstring text,

                               int x, int y);

    static void DrawGrayText(HDC hDC, jobject font, jstring text,

                             int x, int y);

    void DrawListItem(JNIEnv *env, DRAWITEMSTRUCT &drawInfo);

    void MeasureListItem(JNIEnv *env, MEASUREITEMSTRUCT &measureInfo);

    jstring GetItemString(JNIEnv *env, jobject target, jint index);

    jint GetFontHeight(JNIEnv *env);

    virtual jobject PreferredItemSize(JNIEnv *env) {DASSERT(FALSE); return NULL; }

    INLINE BOOL isEnabled() {

        JNIEnv *env = (JNIEnv *)JNU_GetEnv(jvm, JNI_VERSION_1_2);

        if (env->EnsureLocalCapacity(2) < 0) {

            return NULL;

        }

        jobject self = GetPeer(env);

        jobject target = env->GetObjectField(self, AwtObject::targetID);

        BOOL e = env->CallBooleanMethod(target, AwtComponent::isEnabledMID);

        DASSERT(!safe_ExceptionOccurred(env));

        env->DeleteLocalRef(target);

        return e;

    }

    INLINE BOOL isRecursivelyEnabled() {

        AwtComponent* p = this;

        do {

            if (!p->isEnabled()) {

                return FALSE;

            }

        } while (!p->IsTopLevel() &&

            (p = p->GetParent()) != NULL);

        return TRUE;

    }

    void SendKeyEventToFocusOwner(jint id, jlong when, jint raw, jint cooked,

                                  jint modifiers, jint keyLocation,

                                  MSG *msg = NULL);

    /*

     * Allocate and initialize a new java.awt.event.KeyEvent, and

     * post it to the peer's target object.  No response is expected

     * from the target.

     */

    void SendKeyEvent(jint id, jlong when, jint raw, jint cooked,

                      jint modifiers, jint keyLocation,

                      MSG *msg = NULL);

    /*

     * Allocate and initialize a new java.awt.event.MouseEvent, and

     * post it to the peer's target object.  No response is expected

     * from the target.

     */

    void SendMouseEvent(jint id, jlong when, jint x, jint y,

                        jint modifiers, jint clickCount,

                        jboolean popupTrigger, jint button = 0,

                        MSG *msg = NULL);

    /*

     * Allocate and initialize a new java.awt.event.MouseWheelEvent, and

     * post it to the peer's target object.  No response is expected

     * from the target.

     */

    void SendMouseWheelEvent(jint id, jlong when, jint x, jint y,

                             jint modifiers, jint clickCount,

                             jboolean popupTrigger, jint scrollType,

                             jint scrollAmount, jint wheelRotation,

                             jdouble preciseWheelRotation, MSG *msg = NULL);

    /*

     * Allocate and initialize a new java.awt.event.FocusEvent, and

     * post it to the peer's target object.  No response is expected

     * from the target.

     */

    void SendFocusEvent(jint id, HWND opposite);

    /* Forward a filtered event directly to the subclassed window.

       synthetic should be TRUE iff the message was generated because

       of a synthetic Java event, rather than a native event. */

    virtual MsgRouting HandleEvent(MSG *msg, BOOL synthetic);

    /* Post a WM_AWT_HANDLE_EVENT message which invokes HandleEvent

       on the toolkit thread. This method may pre-filter the messages. */

    virtual BOOL PostHandleEventMessage(MSG *msg, BOOL synthetic);

    /* Event->message synthesizer methods. */

    void SynthesizeKeyMessage(JNIEnv *env, jobject keyEvent);

    void SynthesizeMouseMessage(JNIEnv *env, jobject mouseEvent);

    /* Components which inherit native mouse wheel behavior will

     * return TRUE.  These are TextArea, Choice, FileDialog, and

     * List.  All other Components return FALSE.

     */

    virtual BOOL InheritsNativeMouseWheelBehavior();

    /* Functions for MouseWheel support on Windows95

     * These should only be called if running on 95

     */

    static void Wheel95Init();

    INLINE static UINT Wheel95GetMsg() {return sm_95WheelMessage;}

    static UINT Wheel95GetScrLines();

    /* Determines whether the component is obscured by another window */

    // Called on Toolkit thread

    static jboolean _IsObscured(void *param);

    /* Invalidate the specified rectangle. */

    virtual void Invalidate(RECT* r);

    /* Begin and end deferred window positioning. */

    virtual void BeginValidate();

    virtual void EndValidate();

    /* Keyboard conversion routines. */

    static void InitDynamicKeyMapTable();

    static void BuildDynamicKeyMapTable();

    static jint GetJavaModifiers();

    static jint GetButton(int mouseButton);

    static UINT GetButtonMK(int mouseButton);

    static UINT WindowsKeyToJavaKey(UINT windowsKey, UINT modifiers);

    static void JavaKeyToWindowsKey(UINT javaKey, UINT *windowsKey, UINT *modifiers, UINT originalWindowsKey);

    INLINE static void AwtComponent::JavaKeyToWindowsKey(UINT javaKey,

                                       UINT *windowsKey, UINT *modifiers)

    {

        JavaKeyToWindowsKey(javaKey, windowsKey, modifiers, IGNORE_KEY);

    }

    enum TransOps {NONE, LOAD, SAVE};

    UINT WindowsKeyToJavaChar(UINT wkey, UINT modifiers, TransOps ops);

    /* routines used for input method support */

    void SetInputMethod(jobject im, BOOL useNativeCompWindow);

    void SendInputMethodEvent(jint id, jstring text, int cClause,

                              int *rgClauseBoundary, jstring *rgClauseReading,

                              int cAttrBlock, int *rgAttrBoundary,

                              BYTE *rgAttrValue, int commitedTextLength,

                              int caretPos, int visiblePos);

    void InquireCandidatePosition();

    INLINE LPARAM GetCandidateType() { return m_bitsCandType; }

    HIMC ImmGetContext();

    HIMC ImmAssociateContext(HIMC himc);

    HWND GetProxyFocusOwner();

    void CallProxyDefWindowProc(UINT message,

                                WPARAM wParam,

                                LPARAM lParam,

                                LRESULT &retVal,

                                MsgRouting &mr);

    /*

     * Windows message handler functions

     */

    virtual LRESULT WindowProc(UINT message, WPARAM wParam, LPARAM lParam);

    virtual LRESULT DefWindowProc(UINT msg, WPARAM wParam, LPARAM lParam);

    /* return true if msg is processed */

    virtual MsgRouting PreProcessMsg(MSG& msg);

    virtual MsgRouting WmCreate() {return mrDoDefault;}

    virtual MsgRouting WmClose() {return mrDoDefault;}

    virtual MsgRouting WmDestroy();

    virtual MsgRouting WmActivate(UINT nState, BOOL fMinimized, HWND opposite)

    {

        return mrDoDefault;

    }

    virtual MsgRouting WmEraseBkgnd(HDC hDC, BOOL& didErase)

    {

        return mrDoDefault;

    }

    virtual MsgRouting WmPaint(HDC hDC);

    virtual MsgRouting WmGetMinMaxInfo(LPMINMAXINFO lpmmi);

    virtual MsgRouting WmMove(int x, int y);

    virtual MsgRouting WmSize(UINT type, int w, int h);

    virtual MsgRouting WmSizing();

    virtual MsgRouting WmShowWindow(BOOL show, UINT status);

    virtual MsgRouting WmSetFocus(HWND hWndLost);

    virtual MsgRouting WmKillFocus(HWND hWndGot);

    jboolean WmComponentSetFocus(WmComponentSetFocusData *data);

    // Use instead of ::SetFocus to maintain special focusing semantics for

    // Windows which are not Frames/Dialogs.

    BOOL AwtSetFocus();

    virtual MsgRouting WmCtlColor(HDC hDC, HWND hCtrl,

                                  UINT ctlColor, HBRUSH& retBrush);

    virtual MsgRouting WmHScroll(UINT scrollCode, UINT pos, HWND hScrollBar);

    virtual MsgRouting WmVScroll(UINT scrollCode, UINT pos, HWND hScrollBar);

    virtual MsgRouting WmMouseEnter(UINT flags, int x, int y);

    virtual MsgRouting WmMouseDown(UINT flags, int x, int y, int button);

    virtual MsgRouting WmMouseUp(UINT flags, int x, int y, int button);

    virtual MsgRouting WmMouseMove(UINT flags, int x, int y);

    virtual MsgRouting WmMouseExit(UINT flags, int x, int y);

    virtual MsgRouting WmMouseWheel(UINT flags, int x, int y,

                                    int wheelRotation);

    virtual MsgRouting WmNcMouseDown(WPARAM hitTest, int x, int y, int button);

    virtual MsgRouting WmNcMouseUp(WPARAM hitTest, int x, int y, int button);

    virtual MsgRouting WmWindowPosChanging(LPARAM windowPos);

    virtual MsgRouting WmWindowPosChanged(LPARAM windowPos);