Gammon Forum

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE muclient>

<muclient>
<plugin
   name="Text_Capture_Window"
   author="Deacla"
   id="6307d31253862de093c248e4"
   language="Lua"
   purpose="Redirects all output to a miniwindow"
   date_written="2010-02-21"
   requires="4.40"
   version="1.0"
   save_state="y"
   >
<description trim="y">
<![CDATA[

This window captures all text to test the scrollbar function.

The window can be dragged to a new location with the mouse.

Based on code designed by Nick Gammon.
]]>
</description>

</plugin>

<triggers>

  <trigger
   enabled="y"
   match="*"
   script="chat_handler"
   sequence="100"
  >
  </trigger>

</triggers>

<!--  Script  -->


<script>
<![CDATA[

require "copytable"



-- START OF CONFIGURATION OPTIONS

-- window size in pixels
WINDOW_WIDTH = 360
WINDOW_HEIGHT = 150 

MAX_LINES = 1000 -- how many lines to store

-- font
FONT_NAME = "Dina"
FONT_SIZE = 10

-- where to put the window if a position has not been stored
WINDOW_POSITION = 8  

-- colours
WINDOW_BACKGROUND_COLOUR = 0x000000
WINDOW_BORDER_COLOUR = 0x335533

-- offset of text from edge
TEXT_INSET = 5

-- where to store the chat line
lines = {}  -- table of recent chat lines

-- END OF CONFIGURATION OPTIONS




--START OF MOUSE FUNCTIONS 

function scroll_up (flags, hotspot_id)

	if #lines > visible_lines then 
		scrolling = scrolling + 1
		if #lines - visible_lines - scrolling < 1 then
			scrolling = scrolling - 1
		end -- if
		display_all ()
	end  -- if

    scroll_up_md = 0

end   -- scroll_up



function scroll_down (flags, hotspot_id)

	if scrolling > 0 then
		scrolling = scrolling - 1
        display_all ()
	end  -- if

end   -- scroll_down



function mousedown(flags, hotspot_id)

  -- find where mouse is so we can adjust window relative to mouse
  startx, starty = WindowInfo (win, 14), WindowInfo (win, 15)
  
  -- find where window is in case we drag it offscreen
  origx, origy = WindowInfo (win, 10), WindowInfo (win, 11)
end -- mousedown

function dragmove(flags, hotspot_id)

  -- find where it is now
  local posx, posy = WindowInfo (win, 17),
                     WindowInfo (win, 18)

  -- move the window to the new location
  WindowPosition(win, posx - startx, posy - starty, 0, 2);
  
  -- change the mouse cursor shape appropriately
  if posx < 0 or posx > GetInfo (281) or
     posy < 0 or posy > GetInfo (280) then
    check (SetCursor ( 11))   -- X cursor
  else
    check (SetCursor ( 1))   -- hand cursor
  end -- if
  
end -- dragmove

function dragrelease(flags, hotspot_id)
  local newx, newy = WindowInfo (win, 17), WindowInfo (win, 18)
  
  -- don't let them drag it out of view
  if newx < 0 or newx > GetInfo (281) or
     newy < 0 or newy > GetInfo (280) then
     -- put it back
    WindowPosition(win, origx, origy, 0, 2);
  end -- if out of bounds
  
end -- dragrelease

-- END OF MOUSE FUNTIONS





--START OF CHAT HANDLING FUNCTIONS

function chat_handler (name, line, wildcards, styles)

  
  local avail = 0
  local line_styles
  
  -- blank line? force one entry
  if #styles == 0 then
    -- remove first line if filled up
    if #lines >= MAX_LINES then
      table.remove (lines, 1)
    end -- if 
    table.insert (lines, {})
  end -- if
  
  -- keep pulling out styles and trying to fit them on the current line
  
  while #styles > 0 do
	

  
    -- no room available? start new line
    
    if avail <= 0 then
      -- remove first line if filled up
      if #lines >= MAX_LINES then
        table.remove (lines, 1)
      end -- if 
      avail = WINDOW_WIDTH - (TEXT_INSET * 2)
      line_styles = {}
      table.insert (lines, line_styles)
    end -- line full

    -- get first style, work out how long it is
    local style = table.remove (styles, 1)  -- pull out first style
    local width = WindowTextWidth (win, "f", style.text)  -- how long this style is

    -- if it fits, copy whole style in
    if width <= avail then
      table.insert (line_styles, style)
      avail = avail - width
    else -- otherwise, have to split style
    
      -- look for trailing space (work backwards)
      -- remember where space is
      
      local col = style.length - 1
      local split_col
      
      -- keep going until out of columns
      
      while col > 1 do
        width = WindowTextWidth (win, "f", style.text:sub (1, col))
        if width <= avail then
          if not split_col then
            split_col = col  -- in case no space found, this is where we can split
          end -- if
          
          -- see if space here
          if style.text:sub (col, col) == " " then
            split_col = col
            break
          end -- if space
        end -- if will now fit
        col = col - 1

      end -- while
          
      -- if we found a place to split, use old style, and make it shorter
      -- also make a copy and put the rest in that
      if split_col then
        table.insert (line_styles, style)
        local style_copy = copytable.shallow (style)
        style.text = style.text:sub (1, split_col)
        style.length = split_col 
        style_copy.text = style_copy.text:sub (split_col + 1)
        style_copy.length = #style_copy.text
        table.insert (styles, 1, style_copy)
      else
        if next (line_styles) == nil then
          table.insert (line_styles, style)
        else
          table.insert (styles, 1, style)
        end -- if
      end -- if    
    
      avail = 0  -- now we need to wrap
      
    end -- if could not fit whole thing in
          
  end -- while we still have styles over


  display_all ()

end -- chat _handler

-- END OF CHAT HANDLING FUNCTIONS

-- START OF DISPLAY FUNCTION

function Display_Line (line, styles)  -- display one line

 
  local left = TEXT_INSET
  local top = (line - 1) * font_height
  
  for _, v in ipairs (styles) do
    left = left + WindowText (win, "f", v.text, left, top, 0, 0, v.textcolour)
  end -- for each style run                 

 
end -- Display_Line


function display_all (flags, name)

		
		-- 
		local first_visible = #lines - visible_lines - scrolling

		if first_visible < 1 then
			first_visible = 1
		end -- if
        
        local scroll_range		= WINDOW_HEIGHT - 35

		if #lines > visible_lines then 

			scroll_line_pool	= #lines  - visible_lines
			scroll_per_line 	= scroll_range / scroll_line_pool
			scroll_amount	 	= scrolling * scroll_per_line

		end -- if

		local scroll_adjust		= 0 + scroll_amount
		local scroll_position	= (WINDOW_HEIGHT - 20) - scroll_adjust
		

		local scroll_bar_top 	= scroll_position - 5
		local scroll_bar_bottom	= scroll_position + 5

		-- blank existing window contents
		WindowRectOp (win, 2, 0, 0, 0, 0, WINDOW_BACKGROUND_COLOUR)
		WindowRectOp (win, 5, 0, 0, 0, 0, 5, 15)

		--  draw scroll buttons
		WindowRectOp (win, 5,WINDOW_WIDTH - 15, 0, WINDOW_WIDTH, 15, 9, 15 + 0x0800 + 0x1000)
		WindowRectOp (win, 5,WINDOW_WIDTH - 15, WINDOW_HEIGHT - 15, WINDOW_WIDTH, WINDOW_HEIGHT, 9, 15 + 0x0800 + 0x1000)

		-- draw triangles on scroll buttons
		WindowPolygon (win, "352, 5, 355, 10, 350, 10",
						ColourNameToRGB("gray"), 0, 1,
						ColourNameToRGB("lightgray"), 0,
						true,
						false)
		WindowPolygon (win, "352, 145, 355, 140, 350, 140",
						ColourNameToRGB("gray"), 0, 1,
						ColourNameToRGB("lightgray"), 0,
						true,
						false)

		-- draw scroll bar
		WindowRectOp (win, 5, WINDOW_WIDTH - 15, scroll_bar_top, WINDOW_WIDTH, scroll_bar_bottom,
							9, 15 + 0x0800 + 0x1000) 
        
		-- 	display lines

		local count = 0

		for i = first_visible, #lines do
			count = count + 1
			Display_Line (count, lines )
		end -- for

		-- force window redisplay

		WindowShow (win,  true)  -- show it
               
end -- end function display_all

-- END OF DISPLAY FUNCTIONS



function OnPluginInstall ()
  
  win = GetPluginID ()

  local x, y, mode, flags = 
      tonumber (GetVariable ("x")) or 0,
      tonumber (GetVariable ("y")) or 0,
      tonumber (GetVariable ("mode")) or 10, -- bottom left
      tonumber (GetVariable ("flags")) or 0
    
-- make the window
  check (WindowCreate (win,
                x, y, WINDOW_WIDTH, WINDOW_HEIGHT,
                mode,
                flags,
                WINDOW_BACKGROUND_COLOUR) ) -- create window

  check (WindowFont (win, "f", FONT_NAME, FONT_SIZE)) -- define font  
  font_height = WindowFontInfo (win, "f", 1)   -- height of the font  


  visible_lines = math.floor (WINDOW_HEIGHT / font_height) - 1
  scrolling = 0
  scroll_amount = 0

  -- make a hotspot
  WindowAddHotspot(win, "hs1",  
                   0, 0, WINDOW_WIDTH - 15, WINDOW_HEIGHT,   -- whole window
                   "",   -- MouseOver
                   "",   -- CancelMouseOver
                   "mousedown",
                   "",   -- CancelMouseDown
                   "",   -- MouseUp
                   "Drag to move",  -- tooltip text
                   1, 0)  -- hand cursor

  WindowAddHotspot(win, "hs2",  
                   WINDOW_WIDTH - 15, 0, WINDOW_WIDTH, 15,   -- top left corner
                   "",   -- MouseOver
                   "",   -- CancelMouseOver
                   "",   -- MouseDown
                   "",   -- CancelMouseDown
                   "scroll_up",   -- MouseUp
                   "Click to scroll up",  -- tooltip text
                   1, 0)  -- hand cursor

  WindowAddHotspot(win, "hs3",  
                   WINDOW_WIDTH - 15, WINDOW_HEIGHT - 15, WINDOW_WIDTH, WINDOW_HEIGHT,   -- bottom right corner
                   "",   -- MouseOver
                   "",   -- CancelMouseOver
                   "",   -- MouseDown
                   "",   -- CancelMouseDown
                   "scroll_down",   -- MouseUp
                   "Click to scroll down",  -- tooltip text
                   1, 0)  -- hand cursor

                   
  WindowDragHandler(win, "hs1", "dragmove", "dragrelease", 0) 

  if GetVariable ("enabled") == "false" then
    ColourNote ("yellow", "", "Warning: Plugin " .. GetPluginName ().. " is currently disabled.")
    check (EnablePlugin(GetPluginID (), false))
    return
  end -- they didn't enable last time

end -- OnPluginInstall


function OnPluginDisable ()
  WindowShow (win, false)
end -- OnPluginDisable

function OnPluginSaveState ()
  SetVariable ("enabled", tostring (GetPluginInfo (GetPluginID (), 17)))
  SetVariable ("x", tostring (WindowInfo (win, 10)))
  SetVariable ("y", tostring (WindowInfo (win, 11)))
  SetVariable ("mode", tostring (WindowInfo (win, 7)))
  SetVariable ("flags", tostring (WindowInfo (win, 8)))
end -- OnPluginSaveState

]]>
</script>
</muclient>

WindowPolygon (win, "20,50,180,50,180,20",
                        ColourNameToRGB("cyan"), 0, 3,   -- pen (solid, width 3)
                        ColourNameToRGB("yellow"), 0,    -- brush (solid)
                        true,    -- fill
                        false)   -- alternate fil

-- set up variables
local x1, y1, x2, y2, x3, y3 = 20, 50, 180, 50, 180, 20

-- convert into a string with commas in it
points = string.format ("%i,%i,%i,%i,%i,%i", x1, y1, x2, y2, x3, y3)

WindowPolygon (win, points,
                        ColourNameToRGB("cyan"), 0, 3,   -- pen (solid, width 3)
                        ColourNameToRGB("yellow"), 0,    -- brush (solid)
                        true,    -- fill
                        false)   -- alternate fil

  AddTimer ("scroll_up_timer", 0, 0, 0.5, "", 0, "scroll_up ()") 

AddTimer("scroll_up_timer", 0, 0, 0.5, "", 0, "scroll_up")