]> git.saurik.com Git - wxWidgets.git/blobdiff - src/stc/ScintillaWX.cpp
only remap the disabled bitmap of a toolbarbutton when allowed by system (settings...
[wxWidgets.git] / src / stc / ScintillaWX.cpp
index ea1dfda78c024d176d9d2ff52679d61a65dc5096..07d8349199d693e5284c15f1cc56893547b7b527 100644 (file)
@@ -1,6 +1,6 @@
 ////////////////////////////////////////////////////////////////////////////
 // Name:        ScintillaWX.cxx
-// Purpose:     A wxWindows implementation of Scintilla.  A class derived
+// Purpose:     A wxWidgets implementation of Scintilla.  A class derived
 //              from ScintillaBase that uses the "wx platform" defined in
 //              PlatformWX.cxx  This class is one end of a bridge between
 //              the wx world and the Scintilla world.  It needs a peer
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+#include "wx/wx.h"
+#include "wx/textbuf.h"
+#include "wx/dataobj.h"
+#include "wx/clipbrd.h"
+#include "wx/dnd.h"
 
 #include "ScintillaWX.h"
 #include "ExternalLexer.h"
 #include "wx/stc/stc.h"
 #include "PlatWX.h"
-#include <wx/textbuf.h>
+
+#ifdef __WXMSW__
+    // GetHwndOf()
+    #include "wx/msw/private.h"
+#endif
 
 //----------------------------------------------------------------------
 // Helper classes
@@ -58,11 +67,6 @@ void  wxSTCDropTarget::OnLeave() {
 #endif
 
 
-#ifdef __WXGTK__
-#undef wxSTC_USE_POPUP
-#define wxSTC_USE_POPUP 0
-#endif
-
 #if wxUSE_POPUPWIN && wxSTC_USE_POPUP
 #include <wx/popupwin.h>
 #define wxSTCCallTipBase wxPopupWindow
@@ -72,21 +76,29 @@ void  wxSTCDropTarget::OnLeave() {
 #define param2 -1 // wxWindow's 2nd param is ID
 #endif
 
+#include <wx/dcbuffer.h>
+
 class wxSTCCallTip : public wxSTCCallTipBase {
 public:
     wxSTCCallTip(wxWindow* parent, CallTip* ct, ScintillaWX* swx)
         : wxSTCCallTipBase(parent, param2),
-          m_ct(ct), m_swx(swx)
+          m_ct(ct), m_swx(swx), m_cx(wxDefaultCoord), m_cy(wxDefaultCoord)
         {
         }
 
     ~wxSTCCallTip() {
+#if wxUSE_POPUPWIN && wxSTC_USE_POPUP && defined(__WXGTK__)
+        wxRect rect = GetRect();
+        rect.x = m_cx;
+        rect.y = m_cy;
+        GetParent()->Refresh(false, &rect);
+#endif
     }
 
-    bool AcceptsFocus() const { return FALSE; }
+    bool AcceptsFocus() const { return false; }
 
     void OnPaint(wxPaintEvent& WXUNUSED(evt)) {
-        wxPaintDC dc(this);
+        wxBufferedPaintDC dc(this);
         Surface* surfaceWindow = Surface::Allocate();
         surfaceWindow->Init(&dc, m_ct->wDraw.GetID());
         m_ct->PaintCT(surfaceWindow);
@@ -110,17 +122,26 @@ public:
     virtual void DoSetSize(int x, int y,
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO) {
-        if (x != -1)
+        if (x != wxDefaultCoord) {
+            m_cx = x;
             GetParent()->ClientToScreen(&x, NULL);
-        if (y != -1)
+        }
+        if (y != wxDefaultCoord) {
+            m_cy = y;
             GetParent()->ClientToScreen(NULL, &y);
+        }
         wxSTCCallTipBase::DoSetSize(x, y, width, height, sizeFlags);
     }
 #endif
 
+    wxPoint GetMyPosition() {
+        return wxPoint(m_cx, m_cy);
+    }
+
 private:
     CallTip*      m_ct;
     ScintillaWX*  m_swx;
+    int           m_cx, m_cy;
     DECLARE_EVENT_TABLE()
 };
 
@@ -131,6 +152,35 @@ BEGIN_EVENT_TABLE(wxSTCCallTip, wxSTCCallTipBase)
 END_EVENT_TABLE()
 
 
+//----------------------------------------------------------------------
+
+#if wxUSE_DATAOBJ
+static wxTextFileType wxConvertEOLMode(int scintillaMode)
+{
+    wxTextFileType type;
+
+    switch (scintillaMode) {
+        case wxSTC_EOL_CRLF:
+            type = wxTextFileType_Dos;
+            break;
+
+        case wxSTC_EOL_CR:
+            type = wxTextFileType_Mac;
+            break;
+
+        case wxSTC_EOL_LF:
+            type = wxTextFileType_Unix;
+            break;
+
+        default:
+            type = wxTextBuffer::typeDefault;
+            break;
+    }
+    return type;
+}
+#endif // wxUSE_DATAOBJ
+
+
 //----------------------------------------------------------------------
 // Constructor/Destructor
 
@@ -142,6 +192,11 @@ ScintillaWX::ScintillaWX(wxStyledTextCtrl* win) {
     stc   = win;
     wheelRotation = 0;
     Initialise();
+#ifdef __WXMSW__
+    sysCaretBitmap = 0;
+    sysCaretWidth = 0;
+    sysCaretHeight = 0;
+#endif
 }
 
 
@@ -172,6 +227,7 @@ void ScintillaWX::Finalise() {
     ScintillaBase::Finalise();
     SetTicking(false);
     SetIdle(false);
+    DestroySystemCaret();
 }
 
 
@@ -183,7 +239,7 @@ void ScintillaWX::StartDrag() {
     wxStyledTextEvent evt(wxEVT_STC_START_DRAG, stc->GetId());
     evt.SetEventObject(stc);
     evt.SetDragText(dragText);
-    evt.SetDragAllowMove(TRUE);
+    evt.SetDragAllowMove(true);
     evt.SetPosition(wxMin(stc->GetSelectionStart(),
                           stc->GetSelectionEnd()));
     stc->GetEventHandler()->ProcessEvent(evt);
@@ -195,11 +251,11 @@ void ScintillaWX::StartDrag() {
         wxDragResult        result;
 
         source.SetData(data);
-        dropWentOutside = TRUE;
+        dropWentOutside = true;
         result = source.DoDragDrop(evt.GetDragAllowMove());
         if (result == wxDragMove && dropWentOutside)
             ClearSelection();
-        inDragDrop = FALSE;
+        inDragDrop = false;
         SetDragPosition(invalidPosition);
     }
 #endif
@@ -209,18 +265,18 @@ void ScintillaWX::StartDrag() {
 bool ScintillaWX::SetIdle(bool on) {
     if (idler.state != on) {
         // connect or disconnect the EVT_IDLE handler
-        if (on) 
-            stc->Connect(-1, wxEVT_IDLE,
+        if (on)
+            stc->Connect(wxID_ANY, wxEVT_IDLE,
                          (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) &wxStyledTextCtrl::OnIdle);
         else
-            stc->Disconnect(-1, wxEVT_IDLE,
+            stc->Disconnect(wxID_ANY, wxEVT_IDLE,
                             (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) &wxStyledTextCtrl::OnIdle);
         idler.state = on;
     }
     return idler.state;
 }
 
-    
+
 void ScintillaWX::SetTicking(bool on) {
     wxSTCTimer* steTimer;
     if (timer.ticking != on) {
@@ -385,20 +441,24 @@ void ScintillaWX::Paste() {
     pdoc->BeginUndoAction();
     ClearSelection();
 
+#if wxUSE_DATAOBJ
     wxTextDataObject data;
-    bool gotData = FALSE;
+    bool gotData = false;
 
     if (wxTheClipboard->Open()) {
-        wxTheClipboard->UsePrimarySelection(FALSE);
+        wxTheClipboard->UsePrimarySelection(false);
         gotData = wxTheClipboard->GetData(data);
         wxTheClipboard->Close();
     }
     if (gotData) {
-        wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(data.GetText());
+        wxString   text = wxTextBuffer::Translate(data.GetText(),
+                                                  wxConvertEOLMode(pdoc->eolMode));
+        wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
         int        len = strlen(buf);
         pdoc->InsertString(currentPos, buf, len);
         SetEmptySelection(currentPos + len);
     }
+#endif // wxUSE_DATAOBJ
 
     pdoc->EndUndoAction();
     NotifyChange();
@@ -407,17 +467,22 @@ void ScintillaWX::Paste() {
 
 
 void ScintillaWX::CopyToClipboard(const SelectionText& st) {
+#if wxUSE_CLIPBOARD
     if (wxTheClipboard->Open()) {
-        wxTheClipboard->UsePrimarySelection(FALSE);
-        wxString text = wxTextBuffer::Translate(stc2wx(st.s, st.len));
+        wxTheClipboard->UsePrimarySelection(false);
+        wxString text = wxTextBuffer::Translate(stc2wx(st.s, st.len-1));
         wxTheClipboard->SetData(new wxTextDataObject(text));
         wxTheClipboard->Close();
     }
+#else
+    wxUnusedVar(st);
+#endif // wxUSE_CLIPBOARD
 }
 
 
 bool ScintillaWX::CanPaste() {
-    bool canPaste = FALSE;
+#if wxUSE_CLIPBOARD
+    bool canPaste = false;
     bool didOpen;
 
     if (Editor::CanPaste()) {
@@ -426,13 +491,16 @@ bool ScintillaWX::CanPaste() {
             wxTheClipboard->Open();
 
         if (wxTheClipboard->IsOpened()) {
-            wxTheClipboard->UsePrimarySelection(FALSE);
+            wxTheClipboard->UsePrimarySelection(false);
             canPaste = wxTheClipboard->IsSupported(wxUSE_UNICODE ? wxDF_UNICODETEXT : wxDF_TEXT);
             if (didOpen)
                 wxTheClipboard->Close();
         }
     }
     return canPaste;
+#else
+    return false;
+#endif // wxUSE_CLIPBOARD
 }
 
 void ScintillaWX::CreateCallTipWindow(PRectangle) {
@@ -467,10 +535,10 @@ void ScintillaWX::ClaimSelection() {
         SelectionText st;
         CopySelectionRange(&st);
         if (wxTheClipboard->Open()) {
-            wxTheClipboard->UsePrimarySelection(TRUE);
+            wxTheClipboard->UsePrimarySelection(true);
             wxString text = stc2wx(st.s, st.len);
             wxTheClipboard->SetData(new wxTextDataObject(text));
-            wxTheClipboard->UsePrimarySelection(FALSE);
+            wxTheClipboard->UsePrimarySelection(false);
             wxTheClipboard->Close();
         }
     }
@@ -479,6 +547,70 @@ void ScintillaWX::ClaimSelection() {
 }
 
 
+void ScintillaWX::UpdateSystemCaret() {
+#ifdef __WXMSW__
+    if (hasFocus) {
+        if (HasCaretSizeChanged()) {
+            DestroySystemCaret();
+            CreateSystemCaret();
+        }
+        Point pos = LocationFromPosition(currentPos);
+        ::SetCaretPos(pos.x, pos.y);
+    }
+#endif
+}
+
+
+bool ScintillaWX::HasCaretSizeChanged() {
+#ifdef __WXMSW__
+    if (( (0 != vs.caretWidth) && (sysCaretWidth != vs.caretWidth) )
+        || (0 != vs.lineHeight) && (sysCaretHeight != vs.lineHeight)) {
+        return true;
+    }
+#endif
+    return false;
+}
+
+bool ScintillaWX::CreateSystemCaret() {
+#ifdef __WXMSW__
+    sysCaretWidth = vs.caretWidth;
+    if (0 == sysCaretWidth) {
+        sysCaretWidth = 1;
+    }
+    sysCaretHeight = vs.lineHeight;
+    int bitmapSize = (((sysCaretWidth + 15) & ~15) >> 3) * sysCaretHeight;
+    char *bits = new char[bitmapSize];
+    memset(bits, 0, bitmapSize);
+    sysCaretBitmap = ::CreateBitmap(sysCaretWidth, sysCaretHeight, 1,
+                                    1, reinterpret_cast<BYTE *>(bits));
+    delete [] bits;
+    BOOL retval = ::CreateCaret(GetHwndOf(stc), sysCaretBitmap,
+                                sysCaretWidth, sysCaretHeight);
+    ::ShowCaret(GetHwndOf(stc));
+    return retval != 0;
+#else
+    return false;
+#endif
+}
+
+bool ScintillaWX::DestroySystemCaret() {
+#ifdef __WXMSW__
+    ::HideCaret(GetHwndOf(stc));
+    BOOL retval = ::DestroyCaret();
+    if (sysCaretBitmap) {
+        ::DeleteObject(sysCaretBitmap);
+        sysCaretBitmap = 0;
+    }
+    return retval != 0;
+#else
+    return false;
+#endif
+}
+
+
+//----------------------------------------------------------------------
+
+
 long ScintillaWX::DefWndProc(unsigned int /*iMessage*/, unsigned long /*wParam*/, long /*lParam*/) {
     return 0;
 }
@@ -498,7 +630,8 @@ long ScintillaWX::WndProc(unsigned int iMessage, unsigned long wParam, long lPar
                                           defn,
                                           vs.styles[STYLE_DEFAULT].fontName,
                                           vs.styles[STYLE_DEFAULT].sizeZoomed,
-                                          IsUnicodeMode(),
+                                          CodePage(),
+                                          vs.styles[STYLE_DEFAULT].characterSet,
                                           wMain);
           // If the call-tip window would be out of the client
           // space, adjust so it displays above the text.
@@ -520,10 +653,11 @@ long ScintillaWX::WndProc(unsigned int iMessage, unsigned long wParam, long lPar
       }
 
 #ifdef SCI_LEXER
-       case SCI_LOADLEXERLIBRARY:
+      case SCI_LOADLEXERLIBRARY:
             LexerManager::GetInstance()->Load((const char*)lParam);
             break;
 #endif
+
       default:
           return ScintillaBase::WndProc(iMessage, wParam, lParam);
       }
@@ -547,14 +681,15 @@ void ScintillaWX::DoPaint(wxDC* dc, wxRect rect) {
     dc->BeginDrawing();
     ClipChildren(*dc, rcPaint);
     Paint(surfaceWindow, rcPaint);
-    dc->EndDrawing();
 
     delete surfaceWindow;
     if (paintState == paintAbandoned) {
-        // Painting area was insufficient to cover new styling or brace highlight positions
-        FullPaint(dc);
+        // Painting area was insufficient to cover new styling or brace
+        // highlight positions
+        FullPaint();
     }
     paintState = notPainting;
+    dc->EndDrawing();
 }
 
 
@@ -637,9 +772,6 @@ void ScintillaWX::DoMouseWheel(int rotation, int delta,
 
 
 void ScintillaWX::DoSize(int WXUNUSED(width), int WXUNUSED(height)) {
-//      PRectangle rcClient(0,0,width,height);
-//      SetScrollBarsTo(rcClient);
-//      DropGraphics();
     ChangeSize();
 }
 
@@ -647,12 +779,15 @@ void ScintillaWX::DoLoseFocus(){
     focusEvent = true;
     SetFocusState(false);
     focusEvent = false;
+    DestroySystemCaret();
 }
 
 void ScintillaWX::DoGainFocus(){
     focusEvent = true;
     SetFocusState(true);
     focusEvent = false;
+    DestroySystemCaret();
+    CreateSystemCaret();
 }
 
 void ScintillaWX::DoSysColourChange() {
@@ -680,15 +815,17 @@ void ScintillaWX::DoMiddleButtonUp(Point pt) {
 
     pdoc->BeginUndoAction();
     wxTextDataObject data;
-    bool gotData = FALSE;
+    bool gotData = false;
     if (wxTheClipboard->Open()) {
-        wxTheClipboard->UsePrimarySelection(TRUE);
+        wxTheClipboard->UsePrimarySelection(true);
         gotData = wxTheClipboard->GetData(data);
-        wxTheClipboard->UsePrimarySelection(FALSE);
+        wxTheClipboard->UsePrimarySelection(false);
         wxTheClipboard->Close();
     }
     if (gotData) {
-        wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(data.GetText());
+        wxString   text = wxTextBuffer::Translate(data.GetText(),
+                                                  wxConvertEOLMode(pdoc->eolMode));
+        wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
         int        len = strlen(buf);
         pdoc->InsertString(currentPos, buf, len);
         SetEmptySelection(currentPos + len);
@@ -709,27 +846,25 @@ void ScintillaWX::DoMiddleButtonUp(Point WXUNUSED(pt)) {
 void ScintillaWX::DoAddChar(int key) {
 #if wxUSE_UNICODE
     wxChar wszChars[2];
-    wszChars[0] = key;
+    wszChars[0] = (wxChar)key;
     wszChars[1] = 0;
     wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(wszChars);
     AddCharUTF((char*)buf.data(), strlen(buf));
 #else
-    AddChar(key);
+    AddChar((char)key);
 #endif
 }
 
 
-#ifdef __WXMAC__
-int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool meta, bool* consumed) {
-#else
-int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool WXUNUSED(meta), bool* consumed) {
-#endif
-#if defined(__WXGTK__) || defined(__WXMAC__)
-    // Ctrl chars (A-Z) end up with the wrong keycode on wxGTK
-    // TODO:  Check this, it shouldn't be true any longer.
-    if (ctrl && key >= 1 && key <= 26)
+int  ScintillaWX::DoKeyDown(const wxKeyEvent& evt, bool* consumed)
+{
+    int key = evt.GetKeyCode();
+    bool shift = evt.ShiftDown(),
+         ctrl  = evt.ControlDown(),
+         alt   = evt.AltDown();
+
+    if (ctrl && key >= 1 && key <= 26 && key != WXK_BACK)
         key += 'A' - 1;
-#endif
 
     switch (key) {
     case WXK_DOWN:              key = SCK_DOWN;     break;
@@ -747,6 +882,7 @@ int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool WXUNU
     case WXK_ESCAPE:            key = SCK_ESCAPE;   break;
     case WXK_BACK:              key = SCK_BACK;     break;
     case WXK_TAB:               key = SCK_TAB;      break;
+    case WXK_NUMPAD_ENTER:      // fall through
     case WXK_RETURN:            key = SCK_RETURN;   break;
     case WXK_ADD:               // fall through
     case WXK_NUMPAD_ADD:        key = SCK_ADD;      break;
@@ -761,7 +897,7 @@ int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool WXUNU
     }
 
 #ifdef __WXMAC__
-    if ( meta ) {
+    if ( evt.MetaDown() ) {
         // check for a few common Mac Meta-key combos and remap them to Ctrl
         // for Scintilla
         switch ( key ) {
@@ -775,7 +911,7 @@ int  ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool WXUNU
         }
     }
 #endif
-    
+
     int rv = KeyDown(key, shift, ctrl, alt, consumed);
 
     if (key)
@@ -799,7 +935,7 @@ void ScintillaWX::DoOnListBox() {
     AutoCompleteCompleted();
 }
 
+
 void ScintillaWX::DoOnIdle(wxIdleEvent& evt) {
 
     if ( Idle() )
@@ -807,13 +943,16 @@ void ScintillaWX::DoOnIdle(wxIdleEvent& evt) {
     else
         SetIdle(false);
 }
+
 //----------------------------------------------------------------------
 
 #if wxUSE_DRAG_AND_DROP
 bool ScintillaWX::DoDropText(long x, long y, const wxString& data) {
     SetDragPosition(invalidPosition);
 
+    wxString text = wxTextBuffer::Translate(data,
+                                            wxConvertEOLMode(pdoc->eolMode));
+
     // Send an event to allow the drag details to be changed
     wxStyledTextEvent evt(wxEVT_STC_DO_DROP, stc->GetId());
     evt.SetEventObject(stc);
@@ -821,7 +960,7 @@ bool ScintillaWX::DoDropText(long x, long y, const wxString& data) {
     evt.SetX(x);
     evt.SetY(y);
     evt.SetPosition(PositionFromLocation(Point(x,y)));
-    evt.SetDragText(data);
+    evt.SetDragText(text);
     stc->GetEventHandler()->ProcessEvent(evt);
 
     dragResult = evt.GetDragResult();
@@ -829,10 +968,10 @@ bool ScintillaWX::DoDropText(long x, long y, const wxString& data) {
         DropAt(evt.GetPosition(),
                wx2stc(evt.GetDragText()),
                dragResult == wxDragMove,
-               FALSE); // TODO: rectangular?
-        return TRUE;
+               false); // TODO: rectangular?
+        return true;
     }
-    return FALSE;
+    return false;
 }
 
 
@@ -865,22 +1004,12 @@ void ScintillaWX::DoDragLeave() {
 #endif
 //----------------------------------------------------------------------
 
-// Redraw all of text area. This paint will not be abandoned.
-void ScintillaWX::FullPaint(wxDC *dc) {
-    wxCHECK_RET(dc != NULL, wxT("Invalid wxDC in ScintillaWX::FillPaint"));
-    paintState = painting;
-    rcPaint = GetClientRectangle();
-    paintingAllText = true;
-    Surface* surfaceWindow = Surface::Allocate();
-    surfaceWindow->Init(dc, wMain.GetID());
-
-    dc->BeginDrawing();
-    ClipChildren(*dc, rcPaint);
-    Paint(surfaceWindow, rcPaint);
-    dc->EndDrawing();
-
-    delete surfaceWindow;
-    paintState = notPainting;
+// Force the whole window to be repainted
+void ScintillaWX::FullPaint() {
+#ifndef __WXMAC__
+    stc->Refresh(false);
+#endif
+    stc->Update();
 }
 
 
@@ -893,24 +1022,25 @@ void ScintillaWX::DoScrollToColumn(int column) {
     HorizontalScrollTo(column * vs.spaceWidth);
 }
 
-#ifdef __WXGTK__
-void ScintillaWX::ClipChildren(wxDC& dc, PRectangle rect) {
-    wxRegion rgn(wxRectFromPRectangle(rect));
-    if (ac.Active()) {
-        wxRect childRect = ((wxWindow*)ac.lb->GetID())->GetRect();
-        rgn.Subtract(childRect);
-    }
-    if (ct.inCallTipMode) {
-        wxRect childRect = ((wxWindow*)ct.wCallTip.GetID())->GetRect();
-        rgn.Subtract(childRect);
-    }
-
-    dc.SetClippingRegion(rgn);
-}
-#else
-void ScintillaWX::ClipChildren(wxDC& WXUNUSED(dc), PRectangle WXUNUSED(rect)) {
+// wxGTK doesn't appear to need this explicit clipping code any longer, but I
+// will leave it here commented out for a while just in case...
+void ScintillaWX::ClipChildren(wxDC& WXUNUSED(dc), PRectangle WXUNUSED(rect))
+{
+//     wxRegion rgn(wxRectFromPRectangle(rect));
+//     if (ac.Active()) {
+//         wxRect childRect = ((wxWindow*)ac.lb->GetID())->GetRect();
+//         rgn.Subtract(childRect);
+//     }
+//     if (ct.inCallTipMode) {
+//         wxSTCCallTip* tip = (wxSTCCallTip*)ct.wCallTip.GetID();
+//         wxRect childRect = tip->GetRect();
+// #if wxUSE_POPUPWIN && wxSTC_USE_POPUP
+//         childRect.SetPosition(tip->GetMyPosition());
+// #endif
+//         rgn.Subtract(childRect);
+//     }
+//     dc.SetClippingRegion(rgn);
 }
-#endif
 
 
 void ScintillaWX::SetUseAntiAliasing(bool useAA) {
@@ -921,6 +1051,6 @@ void ScintillaWX::SetUseAntiAliasing(bool useAA) {
 bool ScintillaWX::GetUseAntiAliasing() {
     return vs.extraFontFlag;
 }
+
 //----------------------------------------------------------------------
 //----------------------------------------------------------------------