Fix Doxygen warnings due to documenting overloaded functions together.

[wxWidgets.git] / src / stc / stc.cpp

diff --git a/src/stc/stc.cpp b/src/stc/stc.cpp
index 3b5561be8b3802efe9f75a78574211b89a60ad18..625694fee4ee9aa3a40498a17c850c5a4386f226 100644 (file)
--- a/src/stc/stc.cpp
+++ b/src/stc/stc.cpp
@@ -10,7 +10,6 @@
 // Author:      Robin Dunn
 //
 // Created:     13-Jan-2000
 // Author:      Robin Dunn
 //
 // Created:     13-Jan-2000

-// RCS-ID:      $Id$

 // Copyright:   (c) 2000 by Total Control Software
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 2000 by Total Control Software
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -47,7 +46,15 @@
 #include "wx/tokenzr.h"
 #include "wx/mstream.h"
 #include "wx/image.h"
 #include "wx/tokenzr.h"
 #include "wx/mstream.h"
 #include "wx/image.h"

-#include "wx/ffile.h"
+#if wxUSE_FFILE
+    #include "wx/ffile.h"
+#elif wxUSE_FILE
+    #include "wx/file.h"
+#endif
+
+#ifdef __WXGTK__
+    #include "wx/dcbuffer.h"
+#endif

 
 #include "ScintillaWX.h"
 
 
 #include "ScintillaWX.h"
 


@@ -963,7 +970,7 @@ void wxStyledTextCtrl::SetWordChars(const wxString& characters)
 // Get the set of characters making up words for when moving or selecting by word.
 wxString wxStyledTextCtrl::GetWordChars() const {
          int msg = 2646;
 // Get the set of characters making up words for when moving or selecting by word.
 wxString wxStyledTextCtrl::GetWordChars() const {
          int msg = 2646;

-         int len = SendMsg(msg, 0, NULL);
+         int len = SendMsg(msg, 0, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -2212,7 +2219,7 @@ int wxStyledTextCtrl::GetMultiPaste() const
 // Retrieve the value of a tag from a regular expression search.
 wxString wxStyledTextCtrl::GetTag(int tagNumber) const {
          int msg = 2616;
 // Retrieve the value of a tag from a regular expression search.
 wxString wxStyledTextCtrl::GetTag(int tagNumber) const {
          int msg = 2616;

-         int len = SendMsg(msg, tagNumber, NULL);
+         int len = SendMsg(msg, tagNumber, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -3163,7 +3170,7 @@ void wxStyledTextCtrl::SetWhitespaceChars(const wxString& characters)
 // Get the set of characters making up whitespace for when moving or selecting by word.
 wxString wxStyledTextCtrl::GetWhitespaceChars() const {
          int msg = 2647;
 // Get the set of characters making up whitespace for when moving or selecting by word.
 wxString wxStyledTextCtrl::GetWhitespaceChars() const {
          int msg = 2647;

-         int len = SendMsg(msg, 0, NULL);
+         int len = SendMsg(msg, 0, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -3184,7 +3191,7 @@ void wxStyledTextCtrl::SetPunctuationChars(const wxString& characters)
 // Get the set of characters making up punctuation characters
 wxString wxStyledTextCtrl::GetPunctuationChars() const {
          int msg = 2649;
 // Get the set of characters making up punctuation characters
 wxString wxStyledTextCtrl::GetPunctuationChars() const {
          int msg = 2649;

-         int len = SendMsg(msg, 0, NULL);
+         int len = SendMsg(msg, 0, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -4074,7 +4081,7 @@ void* wxStyledTextCtrl::PrivateLexerCall(int operation, void* pointer) {
 // Retrieve a '\n' separated list of properties understood by the current lexer.
 wxString wxStyledTextCtrl::PropertyNames() const {
          int msg = 4014;
 // Retrieve a '\n' separated list of properties understood by the current lexer.
 wxString wxStyledTextCtrl::PropertyNames() const {
          int msg = 4014;

-         int len = SendMsg(msg, 0, NULL);
+         int len = SendMsg(msg, 0, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -4094,7 +4101,7 @@ int wxStyledTextCtrl::PropertyType(const wxString& name)
 // Describe a property.
 wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const {
          int msg = 4016;
 // Describe a property.
 wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const {
          int msg = 4016;

-         int len = SendMsg(msg, (sptr_t)(const char*)wx2stc(name), NULL);
+         int len = SendMsg(msg, (sptr_t)(const char*)wx2stc(name), (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -4108,7 +4115,7 @@ wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const {
 // Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
 wxString wxStyledTextCtrl::DescribeKeyWordSets() const {
          int msg = 4017;
 // Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
 wxString wxStyledTextCtrl::DescribeKeyWordSets() const {
          int msg = 4017;

-         int len = SendMsg(msg, 0, NULL);
+         int len = SendMsg(msg, 0, (sptr_t)NULL);

          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);


@@ -4372,58 +4379,114 @@ void wxStyledTextCtrl::ScrollToColumn(int column) {
 }
 
 
 }
 
 

-#if wxUSE_TEXTCTRL
-bool wxStyledTextCtrl::DoSaveFile(const wxString& filename, int fileType)
+void wxStyledTextCtrl::DoSetValue(const wxString& value, int flags)

 {
 {

-   bool ok = wxTextAreaBase::DoSaveFile(filename, fileType);
-#else
-bool wxStyledTextCtrl::SaveFile(const wxString& filename)
+    if ( flags & SetValue_SelectionOnly )
+        ReplaceSelection(value);
+    else
+        SetText(value);
+
+    // We don't send wxEVT_TEXT anyhow, so ignore the
+    // SetValue_SendEvent bit of the flags
+}
+
+bool
+wxStyledTextCtrl::DoSaveFile(const wxString& filename, int WXUNUSED(fileType))

 {
 {

+#if wxUSE_FFILE || wxUSE_FILE
+

 #if wxUSE_FFILE
 #if wxUSE_FFILE

-    wxFFile file(filename, wxT("w"));
-    bool ok = file.IsOpened() && file.Write(GetValue(), *wxConvCurrent);
-#else
-    bool ok = false;
-#endif // wxUSE_FFILE
+    // Take care to use "b" to ensure that possibly non-native EOLs in the file
+    // contents are not mangled when saving it.
+    wxFFile file(filename, wxS("wb"));
+#elif wxUSE_FILE
+    wxFile file(filename, wxFile::write);

 #endif
 #endif

-    if (ok)
+
+    if ( file.IsOpened() && file.Write(GetValue(), *wxConvCurrent) )

     {
         SetSavePoint();
     {
         SetSavePoint();

+
+        return true;

     }
     }

-    return ok;
+
+#endif // !wxUSE_FFILE && !wxUSE_FILE
+
+    return false;

 }
 
 }
 

-#if wxUSE_TEXTCTRL
-bool wxStyledTextCtrl::DoLoadFile(const wxString& filename, int fileType)
-{
-   bool ok = wxTextAreaBase::DoLoadFile(filename, fileType);
-#else
-bool wxStyledTextCtrl::LoadFile(const wxString& filename)
+bool
+wxStyledTextCtrl::DoLoadFile(const wxString& filename, int WXUNUSED(fileType))

 {
 {

+#if wxUSE_FFILE || wxUSE_FILE
+

 #if wxUSE_FFILE
 #if wxUSE_FFILE

-    wxFFile file(filename);
-    bool ok = file.IsOpened();
-    if (ok)
+    // As above, we want to read the real EOLs from the file, e.g. without
+    // translating them to just LFs under Windows, so that the original CR LF
+    // are preserved when it's written back.
+    wxFFile file(filename, wxS("rb"));
+#else
+    wxFile file(filename);
+#endif
+
+    if ( file.IsOpened() )

     {
         wxString text;
     {
         wxString text;

-        ok = file.ReadAll(&text, *wxConvCurrent);
-        if (ok)
+        if ( file.ReadAll(&text, wxConvAuto()) )

         {
         {

+            // Detect the EOL: we use just the first line because there is not
+            // much we can do if the file uses inconsistent EOLs anyhow, we'd
+            // need to ask the user about the one we should really use and we
+            // don't currently provide a way to do it.
+            //
+            // We also only check for Unix and DOS EOLs but not classic Mac
+            // CR-only one as it's obsolete by now.
+            const wxString::size_type posLF = text.find('\n');
+            if ( posLF != wxString::npos )
+            {
+                // Set EOL mode to ensure that the new lines inserted into the
+                // text use the same EOLs as the existing ones.
+                if ( posLF > 0 && text[posLF - 1] == '\r' )
+                    SetEOLMode(wxSTC_EOL_CRLF);
+                else
+                    SetEOLMode(wxSTC_EOL_LF);
+            }
+            //else: Use the default EOL for the current platform.
+

             SetValue(text);
             SetValue(text);

+            EmptyUndoBuffer();
+            SetSavePoint();
+
+            return true;

         }
     }
         }
     }

-#else
-    bool ok = false;
-#endif // wxUSE_FFILE
-#endif
-   if (ok)
-   {
-       EmptyUndoBuffer();
-       SetSavePoint();
-   }
-   return ok;
+#endif // !wxUSE_FFILE && !wxUSE_FILE
+
+   return false;
+}
+
+// If we don't derive from wxTextAreaBase, we need to implement these methods
+// ourselves, otherwise we already inherit them.
+#if !wxUSE_TEXTCTRL
+
+bool wxStyledTextCtrl::SaveFile(const wxString& filename)
+{
+    if ( filename.empty() )
+        return false;
+
+    return DoSaveFile(filename, wxTEXT_TYPE_ANY);
+}
+
+bool wxStyledTextCtrl::LoadFile(const wxString& filename)
+{
+    if ( filename.empty() )
+        return false;
+
+    return DoLoadFile(filename, wxTEXT_TYPE_ANY);

 }
 
 }
 

+#endif // !wxUSE_TEXTCTRL
+

 #if wxUSE_DRAG_AND_DROP
 wxDragResult wxStyledTextCtrl::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
         return m_swx->DoDragOver(x, y, def);
 #if wxUSE_DRAG_AND_DROP
 wxDragResult wxStyledTextCtrl::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
         return m_swx->DoDragOver(x, y, def);


@@ -4444,6 +4507,9 @@ bool wxStyledTextCtrl::GetUseAntiAliasing() {
     return m_swx->GetUseAntiAliasing();
 }
 
     return m_swx->GetUseAntiAliasing();
 }
 

+void wxStyledTextCtrl::AnnotationClearLine(int line) {
+    SendMsg(SCI_ANNOTATIONSETTEXT, line, (sptr_t)NULL);
+}

 
 
 
 
 
 


@@ -4549,7 +4615,11 @@ void wxStyledTextCtrl::AppendTextRaw(const char* text, int length)
 // Event handlers
 
 void wxStyledTextCtrl::OnPaint(wxPaintEvent& WXUNUSED(evt)) {
 // Event handlers
 
 void wxStyledTextCtrl::OnPaint(wxPaintEvent& WXUNUSED(evt)) {

+#ifdef __WXGTK__
+    wxBufferedPaintDC dc(this);
+#else

     wxPaintDC dc(this);
     wxPaintDC dc(this);

+#endif

     m_swx->DoPaint(&dc, GetUpdateRegion().GetBox());
 }
 
     m_swx->DoPaint(&dc, GetUpdateRegion().GetBox());
 }
 


@@ -4624,9 +4694,11 @@ void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent& evt) {
 
 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt)
 {
 
 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt)
 {

-    m_swx->DoMouseWheel(evt.GetWheelRotation(),
+    m_swx->DoMouseWheel(evt.GetWheelAxis(),
+                        evt.GetWheelRotation(),

                         evt.GetWheelDelta(),
                         evt.GetLinesPerAction(),
                         evt.GetWheelDelta(),
                         evt.GetLinesPerAction(),

+                        evt.GetColumnsPerAction(),

                         evt.ControlDown(),
                         evt.IsPageScroll());
 }
                         evt.ControlDown(),
                         evt.IsPageScroll());
 }


@@ -4933,6 +5005,10 @@ wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType, int id)
     m_listType = 0;
     m_x = 0;
     m_y = 0;
     m_listType = 0;
     m_x = 0;
     m_y = 0;

+    m_token = 0;
+    m_annotationLinesAdded = 0;
+    m_updated = 0;
+

 #if wxUSE_DRAG_AND_DROP
     m_dragFlags = wxDrag_CopyOnly;
     m_dragResult = wxDragNone;
 #if wxUSE_DRAG_AND_DROP
     m_dragFlags = wxDrag_CopyOnly;
     m_dragResult = wxDragNone;


@@ -4968,6 +5044,10 @@ wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
     m_x =            event.m_x;
     m_y =            event.m_y;
 
     m_x =            event.m_x;
     m_y =            event.m_y;
 

+    m_token =        event.m_token;
+    m_annotationLinesAdded = event.m_annotationLinesAdded;
+    m_updated =      event.m_updated;
+

 #if wxUSE_DRAG_AND_DROP
     m_dragText =     event.m_dragText;
     m_dragFlags =    event.m_dragFlags;
 #if wxUSE_DRAG_AND_DROP
     m_dragText =     event.m_dragText;
     m_dragFlags =    event.m_dragFlags;


@@ -4980,7 +5060,7 @@ wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
 
 /*static*/ wxVersionInfo wxStyledTextCtrl::GetLibraryVersionInfo()
 {
 
 /*static*/ wxVersionInfo wxStyledTextCtrl::GetLibraryVersionInfo()
 {

-    return wxVersionInfo("Scintilla", 2, 3, 0, "Scintilla 2.03");
+    return wxVersionInfo("Scintilla", 3, 21, 0, "Scintilla 3.21");

 }
 
 #endif // wxUSE_STC
 }
 
 #endif // wxUSE_STC