Added function 'Bookmark' to let scripts bookmark lines

Author: nickgammon

doc.cpp

@@ -610,6 +610,7 @@ BEGIN_DISPATCH_MAP(CMUSHclientDoc, CDocument)
 	DISP_FUNCTION(CMUSHclientDoc, "DatabaseGetField", DatabaseGetField, VT_VARIANT, VTS_BSTR VTS_BSTR)
 	DISP_FUNCTION(CMUSHclientDoc, "WindowSetZOrder", WindowSetZOrder, VT_I4, VTS_BSTR VTS_I4)
 	DISP_FUNCTION(CMUSHclientDoc, "UnloadPlugin", UnloadPlugin, VT_I4, VTS_BSTR)
+	DISP_FUNCTION(CMUSHclientDoc, "Bookmark", Bookmark, VT_EMPTY, VTS_I4 VTS_BOOL)
 	DISP_PROPERTY_PARAM(CMUSHclientDoc, "NormalColour", GetNormalColour, SetNormalColour, VT_I4, VTS_I2)
 	DISP_PROPERTY_PARAM(CMUSHclientDoc, "BoldColour", GetBoldColour, SetBoldColour, VT_I4, VTS_I2)
 	DISP_PROPERTY_PARAM(CMUSHclientDoc, "CustomColourText", GetCustomColourText, SetCustomColourText, VT_I4, VTS_I2)

doc.h

@@ -2754,6 +2754,7 @@ class CMUSHclientDoc : public CDocument
 	afx_msg VARIANT DatabaseGetField(LPCTSTR Name, LPCTSTR Sql);
 	afx_msg long WindowSetZOrder(LPCTSTR Name, long Order);
 	afx_msg long UnloadPlugin(LPCTSTR PluginID);
+	afx_msg void Bookmark(long LineNumber, BOOL Set);
 	afx_msg long GetNormalColour(short WhichColour);
 	afx_msg void SetNormalColour(short WhichColour, long nNewValue);
 	afx_msg long GetBoldColour(short WhichColour);

mushclient.cnt

@@ -197,6 +197,7 @@
 3 Base64Decode=FNC_Base64Decode 
 3 Base64Encode=FNC_Base64Encode 
 3 BlendPixel=FNC_BlendPixel
+3 Bookmark=FNC_Bookmark
 3 BoldColour=FNC_BoldColour 
 3 BroadcastPlugin=FNC_BroadcastPlugin 
 3 CallPlugin=FNC_CallPlugin 

mushclient.odl

@@ -70,14 +70,14 @@ library MUSHclient
 			[id(44)] long SetCommand(BSTR Message);
 			[id(45)] BSTR GetNotes();
 			[id(46)] void SetNotes(BSTR Message);
-			[id(408), propget] long NormalColour(short WhichColour);
-			[id(408), propput] void NormalColour(short WhichColour, long nNewValue);
-			[id(409), propget] long BoldColour(short WhichColour);
-			[id(409), propput] void BoldColour(short WhichColour, long nNewValue);
-			[id(410), propget] long CustomColourText(short WhichColour);
-			[id(410), propput] void CustomColourText(short WhichColour, long nNewValue);
-			[id(411), propget] long CustomColourBackground(short WhichColour);
-			[id(411), propput] void CustomColourBackground(short WhichColour, long nNewValue);
+			[id(409), propget] long NormalColour(short WhichColour);
+			[id(409), propput] void NormalColour(short WhichColour, long nNewValue);
+			[id(410), propget] long BoldColour(short WhichColour);
+			[id(410), propput] void BoldColour(short WhichColour, long nNewValue);
+			[id(411), propget] long CustomColourText(short WhichColour);
+			[id(411), propput] void CustomColourText(short WhichColour, long nNewValue);
+			[id(412), propget] long CustomColourBackground(short WhichColour);
+			[id(412), propput] void CustomColourBackground(short WhichColour, long nNewValue);
 			[id(47)] void Redraw();
 			[id(48)] long ResetTimer(BSTR TimerName);
 			[id(49)] void SetOutputFont(BSTR FontName, short PointSize);
@@ -439,6 +439,7 @@ library MUSHclient
 			[id(405)] VARIANT DatabaseGetField(BSTR Name, BSTR Sql);
 			[id(406)] long WindowSetZOrder(BSTR Name, long Order);
 			[id(407)] long UnloadPlugin(BSTR PluginID);
+			[id(408)] void Bookmark(long LineNumber, BOOL Set);
 			//}}AFX_ODL_METHOD
 
 	};

mushview.cpp

@@ -4826,12 +4826,20 @@ int nNewLine = m_selstart_line,
 
   startpos = pos;
   pInitialLine = pDoc->m_LineList.GetNext (pos);   // skip current position
+  // if we were at the end, loop back to the start
+  if (!pos)
+    {
+    pos = pDoc->m_LineList.GetHeadPosition ();
+    nNewLine = -1;
+    }
+
   nInitialLine = nNewLine;
 
   while (pos)
     {
     nNewLine++;
     pLine = pDoc->m_LineList.GetNext (pos);
+
     if (pLine->flags & BOOKMARK)
       break;
     else
@@ -4846,11 +4854,11 @@ int nNewLine = m_selstart_line,
 
     if (startpos == pos)
       break;  // reached start again? don't loop forever
-    }   // end of loop
+    }; // end of loop
 
   // if we didn't find one *but* we were on one anyway, re-go to it
 
-  if (!pLine && pInitialLine->flags & BOOKMARK)
+  if (!pLine && (pInitialLine->flags & BOOKMARK))
     {
     pLine = pInitialLine;
     nNewLine = nInitialLine;
@@ -4871,13 +4879,6 @@ ASSERT_VALID(pDoc);
   if (pDoc->m_LineList.IsEmpty ())
     return;
 
-  CRgn oldrgn;
-  CRgn newrgn;
-
-// Get old selection region
-
-  get_selection (oldrgn);
-
   // if no selection (or out of range) select last line in display
   if (m_selstart_line <= 0 || m_selstart_line >= pDoc->m_LineList.GetCount ())
     m_selstart_line = pDoc->GetLastLine () - 1;
@@ -4886,10 +4887,30 @@ ASSERT_VALID(pDoc);
 
   pLine->flags ^= BOOKMARK;   // toggle bookmark
 
+  BookmarkLine (m_selstart_line);
+ 
+}   // end of CMUSHView::OnDisplayBookmarkselection
+
+
+void CMUSHView::BookmarkLine (const long iLine)
+  {
+CMUSHclientDoc* pDoc = GetDocument();
+ASSERT_VALID(pDoc);
+
+  CRgn oldrgn;
+  CRgn newrgn;
+
+// Get old selection region
+
+  get_selection (oldrgn);
+
+  m_selstart_line = iLine;
   m_selstart_col = 0;
   m_selend_col = 0;
   m_selend_line = m_selstart_line;    
 
+  CLine * pLine = pDoc->m_LineList.GetAt (pDoc->GetLinePosition (m_selstart_line));
+
   if (pLine->flags & BOOKMARK)
     m_selend_col = pLine->len;
 
@@ -4913,8 +4934,7 @@ ASSERT_VALID(pDoc);
   newrgn.DeleteObject ();
   oldrgn.DeleteObject ();
 
-  
-}   // end of CMUSHView::OnDisplayBookmarkselection
+  }   // end of CMUSHView::BookmarkLine 
 
 
 void CMUSHView::doBookmark (void)

mushview.h

@@ -158,6 +158,7 @@ bool GetSelection(CString & s);
 void SendMacro (int whichone);
 void SelectionChanged (void);
 void AutoWrapWindowWidth (CMUSHclientDoc* pDoc);
+void BookmarkLine (const long iLine);
 
 // Overrides
 	// ClassWizard generated virtual function overrides

resource.h

@@ -1562,7 +1562,7 @@
 #ifdef APSTUDIO_INVOKED
 #ifndef APSTUDIO_READONLY_SYMBOLS
 #define _APS_3D_CONTROLS                     1
-#define _APS_NEXT_RESOURCE_VALUE        366
+#define _APS_NEXT_RESOURCE_VALUE        367
 #define _APS_NEXT_COMMAND_VALUE         33054
 #define _APS_NEXT_CONTROL_VALUE         2897
 #define _APS_NEXT_SYMED_VALUE           312

scripting/functionlist.cpp

@@ -56,6 +56,7 @@ tInternalFunctionsTable InternalFunctionsTable [] = {
 { "Base64Decode" ,               "( Text )" } ,
 { "Base64Encode" ,               "( Text , MultiLine )" } ,
 { "BlendPixel" ,                 "( Blend , Base , Mode , Opacity )" } ,
+{ "Bookmark" ,                   "( LineNumber , Set )" } ,
 { "BoldColour" ,                 "( WhichColour , NewValue )" } ,
 { "BroadcastPlugin" ,            "( Message , Text )" } ,
 { "CallPlugin" ,                 "( PluginID , Routine , Argument )" } ,

scripting/lua_methods.cpp

@@ -943,6 +943,18 @@ static int L_SetBoldColour (lua_State *L)
   return 0;  // number of result fields
   } // end of SetBoldColour
 
+//----------------------------------------
+//  world.Bookmark
+//----------------------------------------
+static int L_Bookmark (lua_State *L)
+  {
+  CMUSHclientDoc *pDoc = doc (L);
+  pDoc->Bookmark (
+                  my_checknumber (L, 1),  // LineNumber
+                  optboolean (L, 2, 1)    // Set flag, defaults to true
+      );
+  return 0;  // number of result fields
+  } // end of L_Bookmark
 
 //----------------------------------------
 //  world.BroadcastPlugin
@@ -6655,6 +6667,7 @@ static const struct luaL_Reg worldlib [] =
   {"Base64Decode", L_Base64Decode},
   {"Base64Encode", L_Base64Encode},
   {"BlendPixel", L_BlendPixel},
+  {"Bookmark", L_Bookmark},
   {"GetBoldColour", L_GetBoldColour},
   {"SetBoldColour", L_SetBoldColour},
   {"BroadcastPlugin", L_BroadcastPlugin},

scripting/methods/methods_output.cpp

@@ -18,6 +18,7 @@
 
 //    ActivateClient
 //    AddFont
+//    Bookmark
 //    DeleteLines
 //    DeleteOutput
 //    FlashIcon
@@ -780,3 +781,39 @@ void windowPositionHelper (CString & str, const RECT & r)
   } // end of windowPositionHelper
 
 
+
+void CMUSHclientDoc::Bookmark(long LineNumber, BOOL Set) 
+{
+  // check line exists
+  if (LineNumber <= 0 || LineNumber > m_LineList.GetCount ())
+    return;
+
+  LineNumber--;  // zero relative
+  // get pointer to line in question
+
+CLine * pLine = m_LineList.GetAt (GetLinePosition (LineNumber));
+
+
+  if (Set)
+    pLine->flags |= BOOKMARK;
+  else
+    pLine->flags &= ~BOOKMARK;
+
+  // alter appearance of all output windows
+
+  for(POSITION pos = GetFirstViewPosition(); pos != NULL; )
+	  {
+	  CView* pView = GetNextView(pos);
+	  
+	  if (pView->IsKindOf(RUNTIME_CLASS(CMUSHView)))
+  	  {
+		  CMUSHView* pmyView = (CMUSHView*)pView;
+
+      pmyView->BookmarkLine (LineNumber);
+
+	    }	  // end of being a CMUSHView
+    }   // end of loop through views
+
+}  // end of CMUSHclientDoc::Bookmark
+
+