state clearly that the entire contents of generated files is generated; put special {{{ and }}} markers around the generated sections (these are special and extra-convenient for ViM but can probably be used to at least go to the end/beginning/other extremeity of the generated block from any other decent editor)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54219 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/stc/stc.h

@@ -1,5 +1,5 @@
 ////////////////////////////////////////////////////////////////////////////
-// Name:        stc.h
+// Name:        wx/stc/stc.h
 // Purpose:     A wxWidgets implementation of Scintilla.  This class is the
 //              one meant to be used directly by wx applications.  It does not
 //              derive directly from the Scintilla classes, and in fact there
@@ -17,6 +17,17 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/*
+    IMPORTANT: include/wx/stc/stc.h is generated by src/stc/gen_iface.py from
+               src/stc/stc.h.in, don't edit stc.h file as your changes will be
+               lost after the next regeneration, edit stc.h.in and rerun the
+               gen_iface.py script instead!
+
+               Parts of this file generated by the script are found in between
+               the special "{{{" and "}}}" markers, the rest of it is copied
+               verbatim from src.h.in.
+ */
+
 #ifndef _WX_STC_STC_H_
 #define _WX_STC_STC_H_
 
@@ -41,9 +52,7 @@ class WXDLLIMPEXP_FWD_CORE wxScrollBar;
 
 
 //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+// STC constants generated section {{{
-//       by gen_iface.py.  Do not edit this file.  Edit stc.h.in instead
-//       and regenerate
 
 #define wxSTC_INVALID_POSITION -1
 
@@ -1676,9 +1685,11 @@ class WXDLLIMPEXP_FWD_CORE wxScrollBar;
 #define wxSTC_R_INFIX 10
 #define wxSTC_R_INFIXEOL 11
 
+//}}}
+//----------------------------------------------------------------------
 
-//-----------------------------------------
+//----------------------------------------------------------------------
-// Commands that can be bound to keystrokes
+// Commands that can be bound to keystrokes section {{{
 
 
 // Redoes the next action on the undo history.
@@ -1954,8 +1965,7 @@ class WXDLLIMPEXP_FWD_CORE wxScrollBar;
 // Move caret right one word, position cursor at end of word, extending selection to new caret position.
 #define wxSTC_CMD_WORDRIGHTENDEXTEND 2442
 
-
+//}}}
-// END of generated section
 //----------------------------------------------------------------------
 
 class  ScintillaWX;                      // forward declare
@@ -2000,10 +2010,8 @@ public:
                 const wxString& name = wxSTCNameStr);
 
 
-//----------------------------------------------------------------------
+    //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+    // Generated method declaration section {{{
-//       by gen_iface.py.  Do not edit this file.  Edit stc.h.in instead
-//       and regenerate
 
 
     // Add text to the document at current position.
@@ -2570,7 +2578,7 @@ public:
                int    startPos,
                int    endPos,
                wxDC*  draw,
-               wxDC*  target, 
+               wxDC*  target,
                wxRect renderRect,
                wxRect pageRect);
 
@@ -3473,10 +3481,10 @@ public:
     // Retrieve the number of bits the current lexer needs for styling.
     int GetStyleBitsNeeded() const;
 
-// END of generated section
+    //}}}
-//----------------------------------------------------------------------
+    //----------------------------------------------------------------------
-// Others...
 
+    // Manually declared methods
 
     // Returns the line number of the line with the caret.
     int GetCurrentLine();
@@ -3520,7 +3528,7 @@ public:
 
     // Set the font encoding to be used by a style.
     void StyleSetFontEncoding(int style, wxFontEncoding encoding);
-    
+
 
     // Perform one of the operations defined by the wxSTC_CMD_* constants.
     void CmdKeyExecute(int cmd);
@@ -3591,13 +3599,13 @@ public:
     bool GetUseAntiAliasing();
 
 
-    
+
     // The following methods are nearly equivallent to their similarly named
     // cousins above.  The difference is that these methods bypass wxString
     // and always use a char* even if used in a unicode build of wxWidgets.
     // In that case the character data will be utf-8 encoded since that is
     // what is used internally by Scintilla in unicode builds.
-    
+
     // Add text to the document at current position.
     void AddTextRaw(const char* text);
 

src/stc/stc.cpp

@@ -15,6 +15,17 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/*
+    IMPORTANT: src/stc/stc.cpp is generated by src/stc/gen_iface.py from
+               src/stc/stc.cpp.in, don't edit stc.cpp file as your changes will be
+               lost after the next regeneration, edit stc.cpp.in and rerun the
+               gen_iface.py script instead!
+
+               Parts of this file generated by the script are found in between
+               the special "{{{" and "}}}" markers, the rest of it is copied
+               verbatim from src.h.in.
+ */
+
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -239,9 +250,7 @@ void wxStyledTextCtrl::SetHScrollBar(wxScrollBar* bar)  {
 }
 
 //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+// Generated methods implementation section {{{
-//       by gen_iface.py from the contents of Scintilla.iface.  Do not edit
-//       this file.  Edit stc.cpp.in or gen_iface.py instead and regenerate.
 
 
 // Add text to the document at current position.
@@ -1397,7 +1406,7 @@ int wxStyledTextCtrl::FindText(int minPos, int maxPos,
                 int    startPos,
                 int    endPos,
                 wxDC*  draw,
-                wxDC*  target, 
+                wxDC*  target,
                 wxRect renderRect,
                 wxRect pageRect) {
              RangeToFormat fr;
@@ -3242,7 +3251,7 @@ int wxStyledTextCtrl::GetStyleBitsNeeded() const
     return SendMsg(4011, 0, 0);
 }
 
-// END of generated section
+//}}}
 //----------------------------------------------------------------------
 
 

src/stc/stc.cpp.in

@@ -15,6 +15,17 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/*
+    IMPORTANT: src/stc/stc.cpp is generated by src/stc/gen_iface.py from
+               src/stc/stc.cpp.in, don't edit stc.cpp file as your changes will be
+               lost after the next regeneration, edit stc.cpp.in and rerun the
+               gen_iface.py script instead!
+
+               Parts of this file generated by the script are found in between
+               the special "{{{" and "}}}" markers, the rest of it is copied
+               verbatim from src.h.in.
+ */
+
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -239,13 +250,11 @@ void wxStyledTextCtrl::SetHScrollBar(wxScrollBar* bar)  {
 }
 
 //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+// Generated methods implementation section {{{
-//       by gen_iface.py from the contents of Scintilla.iface.  Do not edit
-//       this file.  Edit stc.cpp.in or gen_iface.py instead and regenerate.
 
 %(METHOD_IMPS)s
 
-// END of generated section
+//}}}
 //----------------------------------------------------------------------
 
 

src/stc/stc.h.in

@@ -1,5 +1,5 @@
 ////////////////////////////////////////////////////////////////////////////
-// Name:        stc.h
+// Name:        wx/stc/stc.h
 // Purpose:     A wxWidgets implementation of Scintilla.  This class is the
 //              one meant to be used directly by wx applications.  It does not
 //              derive directly from the Scintilla classes, and in fact there
@@ -17,6 +17,17 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/*
+    IMPORTANT: include/wx/stc/stc.h is generated by src/stc/gen_iface.py from
+               src/stc/stc.h.in, don't edit stc.h file as your changes will be
+               lost after the next regeneration, edit stc.h.in and rerun the
+               gen_iface.py script instead!
+
+               Parts of this file generated by the script are found in between
+               the special "{{{" and "}}}" markers, the rest of it is copied
+               verbatim from src.h.in.
+ */
+
 #ifndef _WX_STC_STC_H_
 #define _WX_STC_STC_H_
 
@@ -41,20 +52,19 @@ class WXDLLIMPEXP_FWD_CORE wxScrollBar;
 
 
 //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+// STC constants generated section {{{
-//       by gen_iface.py.  Do not edit this file.  Edit stc.h.in instead
-//       and regenerate
 
 %(VALUES)s
 
+//}}}
+//----------------------------------------------------------------------
 
-//-----------------------------------------
+//----------------------------------------------------------------------
-// Commands that can be bound to keystrokes
+// Commands that can be bound to keystrokes section {{{
 
 %(CMDS)s
 
-
+//}}}
-// END of generated section
 //----------------------------------------------------------------------
 
 class  ScintillaWX;                      // forward declare
@@ -99,17 +109,15 @@ public:
                 const wxString& name = wxSTCNameStr);
 
 
-//----------------------------------------------------------------------
+    //----------------------------------------------------------------------
-// BEGIN generated section.  The following code is automatically generated
+    // Generated method declaration section {{{
-//       by gen_iface.py.  Do not edit this file.  Edit stc.h.in instead
-//       and regenerate
 
 %(METHOD_DEFS)s
 
-// END of generated section
+    //}}}
-//----------------------------------------------------------------------
+    //----------------------------------------------------------------------
-// Others...
 
+    // Manually declared methods
 
     // Returns the line number of the line with the caret.
     int GetCurrentLine();
@@ -153,7 +161,7 @@ public:
 
     // Set the font encoding to be used by a style.
     void StyleSetFontEncoding(int style, wxFontEncoding encoding);
-    
+
 
     // Perform one of the operations defined by the wxSTC_CMD_* constants.
     void CmdKeyExecute(int cmd);
@@ -224,13 +232,13 @@ public:
     bool GetUseAntiAliasing();
 
 
-    
+
     // The following methods are nearly equivallent to their similarly named
     // cousins above.  The difference is that these methods bypass wxString
     // and always use a char* even if used in a unicode build of wxWidgets.
     // In that case the character data will be utf-8 encoded since that is
     // what is used internally by Scintilla in unicode builds.
-    
+
     // Add text to the document at current position.
     void AddTextRaw(const char* text);