Jump to content

Recommended Posts

The block comment (internal: box comment) in SciTE cannot be toggled.
I have now created a script that helps. It works with any file type for which the corresponding entries in the properties are created.For toggeling its required to detect, what the user want to do.

EDIT 2021-04-14 [v0.10]

In the meantime, I have changed and discarded a few things. But in my opinion, the current variant is much easier to handle:

Rules for detection:
        UNSET COMMENT BLOCK
        - NEW:
          NONE SELECTION IS REQUIRED!
          There must exist an comment block near the cursor position (cursor inside the .start line or above).
          The script detects automatically the "comment.box.start" and the corresponding "comment.box.end" (also if nested) and works until this line.

        SET COMMENT BLOCK
        - Some text must selected (at minimum one character)
        - Starts and/or ends the selection inside of a line, the selection will expanded to full line.
        - Ends the selection in a line with text, but at line start position so will this line ignored!
        - Leading and trailing empty lines in selection will ignored!

This means that in nested block comments there is at least one more line between two comment.box.start markers.

It is recommended to write all block comment settings into "SciTEUser.properties". The setting "comment.box.end.au3" from "SciTEGlobal.properties" is incorrect and must be corrected.

comment.box.start.au3=#cs
#~ If you want characters or tab in each line of comment block (middle lines), define it here.
#~ If TAB should used as box.middle, set it so: comment.box.middle.au3=@Tab
#~ "@Tab" is replaced by a tabulator by the script.
comment.box.middle.au3=
comment.box.end.au3=#ce

additional [optional] property:
#~ message for comment block set or unset - output/none (1/0), default=0 (none output)
#~ e.g.: "++ COMMENT BLOCK - UNSET [line 103-106]"
#~ SET  : current line numbers of commented text including the lines with .start .end
#~ UNSET: current line number(s) of text that was commented
comment.box.output=0

Connection to SciTE
Search a free command number. Use a Hotkey of your choice. (or use the default shortcut: Ctrl+Shift+Q)
If you have declared an option for user lua scripts (e.g.: "Lua.User.Scripts.Path=C:\code\lua"), copy the script to this folder.
Otherwise copy it to a folder of your choice and change the path in the command: "dofile". But backslashes in the path must be masked. ("\\").
If your path has spaces don't forgot to encapsulate in string delimiters.

# 24 Toggle Block Comment
command.name.24.*=Toggle Block Comment
command.24.*=dofile $(Lua.User.Scripts.Path)/BlockComment.lua
command.mode.24.*=subsystem:lua,savebefore:no
command.shortcut.24.*=Ctrl+Alt+F10

 

Here the lua script:

-- TIME_STAMP   2021-04-14 17:56:37   v 0.10

--[[  Toggle Block Comments   ©BugFix ( autoit[at]bug-fix.info )

	For toggeling its required to detect, what the user want to do.

	Rules for detection:
	    UNSET COMMENT BLOCK
		- NEW:
		  NONE SELECTION IS REQUIRED!
		  There must exist an comment block near the cursor position (cursor inside the .start line or above).
		  The script detects automatically the "comment.box.start" and the corresponding "comment.box.end" (also if nested) and works until this line.

		SET COMMENT BLOCK
		- Some text must selected (at minimum one character)
		- Starts and/or ends the selection inside of a line, the selection will expanded to full line.
		- Ends the selection in a line with text, but at line start position so will this line ignored!
		- Leading and trailing empty lines in selection will ignored!

	Properties:
		It is recommended to write all block comment settings into SciTEUser.properties.
		The setting "comment.box.end.au3" from "au3.properties" is wrong and must be corrected.

		comment.box.start.au3=#cs
		#~ If you want characters or tab in each line of comment block (middle lines), define it here.
		#~ If TAB should used as box.middle, set it so: comment.box.middle.au3=@Tab
		#~ "@Tab" is replaced by a tabulator by the script.
		comment.box.middle.au3=
		comment.box.end.au3=#ce

		additional [optional] property:
		#~ message for comment block set or unset - output/none (1/0), default=0 (none output)
		#~ e.g.: "++ COMMENT BLOCK - UNSET [line 103-106]"
		#~ SET  : current line numbers of commented text including the lines with .start .end
		#~ UNSET: current line number(s) of text that was commented
		comment.box.output=0

	Example with AutoIt comment:
	  "SelectionStart" = [S]   "SelectionEnd" = [E]
	----------------------------------------------------------------------
	selection:						or								or
		1 [S]line with some text[E]		1 [S]							1 lin[S]e with some text[E]
										2 line with some text[E]
	or								or								or
		1 [S]							1 [S]line with some text		1 [S]
		2 line with some text			2 [E]							2 line with so[E]me text
		3 [E]
	or                            	or
	    1 [S]							1 [S]
		... empty lines					2	line with some text
		5								... empty lines
		6 line with some text			6
		7 [E]							7 [E]

					result for all:
						1 #cs
						2 line with some text
						3 #ce
	----------------------------------------------------------------------

]]

--[[ History
	v 0.10
	- fixed: If last selected line is also last line in editor, the comment.end was set in this line and so was this line deleted if has toggled.
	v 0.9
	- removed: comment.box.ignore.empty.before/after - was not very usefull
	- added:   detection (and excluding) of leading and/or trailing empty lines in selection
	v 0.8
	- fixed: Problem with selection starts/ends in the middle of a line or ends at the first position of the line with text
	v 0.7
	- added: Automatic detection for comment blocks, NO SELECTION REQUIRED to unset a comment block
	- added: properties
	    comment.box.ignore.empty.before: if first selected line is empty -- don't include in comment block
	    comment.box.ignore.empty.after:  if last selected line is empty  -- don't include in comment block
	    comment.box.output:              if "1" -- write result of proceeding to console, default is "0"
	- changed: minimum required selection to start block comment: 1 character
	v 0.6
	- fixed: if selection for uncommenting is wrong, leading/trailing empty line will removed
	v 0.5
	- fixed: the trailing line break from comment.end while uncommenting will not removed
	v 0.4
	- added: detection for uncommenting if selection is wrong (starts/ends in empty line)
	v 0.3
	- project new designed (object syntax)
	v 0.2
	- fixed: missed adding of middle marker in first line

]]

local BlockComment = {
	-- variables
	ext,          -- file extension
	boxStart,     -- property: comment.box.start
	boxMiddle,    -- property: comment.box.middle
	boxEnd,       -- property: comment.box.end
	bMiddle,      -- bool: boxMiddle is defined
	lenEOL,       -- length of line break character(s) from file in editor
	eol,          -- the end of line character(s) in this file
	msg = {},     -- store line numbers (start, end) for proceeding message
	selS = {},    -- selection start
	selE = {},    -- selection end
	-- selection table fields:
	--   .pos,    -- selection position
	--   .line,   -- selection line number

	newText,	  -- the text that replaces the selection

	-- initialize variables
	Init = function(self)
		self.ext = props["FileExt"]
		self.boxStart        = props["comment.box.start."..self.ext]
		self.boxMiddle       = props["comment.box.middle."..self.ext]
		self.bMiddle         = not (self.boxMiddle == "")
		self.boxEnd          = props["comment.box.end."..self.ext]
		if self.boxMiddle == "@Tab" then self.boxMiddle = "\t" end
		self.selS = self:SelLineData(editor.SelectionStart)
		self.selE = self:SelLineData(editor.SelectionEnd)
		self.lenEOL = self:GetEOL()
		self.eol = "\n"
		if self.lenEOL == 2 then self.eol = "\r\n" end
		self.newText   = ""
	end,

	-- stores #pos and #line from selection position
	SelLineData = function(self, _selPos) -- _selPos: editor.SelectionStart or editor.SelectionEnd
		local t = {}
		t.pos  = _selPos
		t.line = editor:LineFromPosition(t.pos)
		return t
	end,

	-- returns position from start and end (behind last visible char) of a line
	LineStartEndPos = function(self, _line)
		local startP = editor:PositionFromLine(_line)
		local endP = editor.LineEndPosition[_line]
		return startP, endP
	end,

	-- returns the length of EOL (default) or with "_getMode=true": LF/CRLF
	-- asking the property "eol.mode.type" is not safe, maybe not set and the global value may differ from the file in the editor
	GetEOL = function(self, _getMode)
		-- It is possible that another program makes entries (e.g.: version number) at the beginning of the file..
		-- ..with a different EOL mode, therefore the second last line (last line with line break) of the file is checked.
		local l = editor.LineCount -2
		local lenEOL
		if l < 0 then -- the eol.mode from properties will used instead (but not sure, if exists)
			local mode = props["eol.mode."..self.ext]       -- mode for file type (if declared)
			if mode == "" then mode = props["eol.mode"] end -- otherwise the global mode
			if mode == "LF" then lenEOL = 1 else lenEOL = 2 end
		else
			local textEnd = editor.LineEndPosition[l]       -- pos after last visible character
			local posLineStart = editor:PositionFromLine(l) -- first pos in line
			local textLen = textEnd - posLineStart          -- pure text length
			local len = editor:LineLength(l)                -- length of line including the line break characters
			lenEOL = len - textLen                          -- length of line line break characters
		end
		if _getMode then
			if lenEOL == 1 then return "LF" else return "CRLF" end
		else
			return lenEOL
		end
	end,

	-- detects if is/not selection
	IsSelection = function(self)
		return (self.selS.pos ~= self.selE.pos)
	end,

	-- mask magic characters
	MaskMagic = function(self, _s)
		if _s == nil then return "" end
		return _s:gsub('([%(%)%.%%%+%-%*%?%[%^%$])', '%%%1')
	end,

	-- checks if line is empty (has only a line break)
	LineIsEmpty = function(self, _line) -- _line: number or text from "editor:GetLine"
		if type(_line) == "string" then return (_line:len() == self.lenEOL) end
		if _line == nil then return true end
		local len = editor:LineLength(_line)
		return (len <= self.lenEOL)
	end,

	-- checks if line starts with/has box.start
	-- detects it also, if nested and middle marker(s) before the start marker
	LineHasStart = function(self, _line)
		if self:LineIsEmpty(_line) then return false end
		if type(_line) == "number" then _line = editor:GetLine(_line) end
		local pattern
		if self.boxMiddle == '' then pattern = self:MaskMagic(self.boxStart)
		else pattern = self:MaskMagic(self.boxMiddle)..'*'..self:MaskMagic(self.boxStart) end
		local n = _line:find(pattern)
		return (n ~= nil)
	end,

	-- checks if line starts with/has box.end
	-- detects it also if nested, and middle marker(s) before the end marker
	LineHasEnd = function(self, _line)
		if self:LineIsEmpty(_line) then return false end
		if type(_line) == "number" then _line = editor:GetLine(_line) end
		local pattern
		if self.boxMiddle == '' then pattern = self:MaskMagic(self.boxEnd)
		else pattern = self:MaskMagic(self.boxMiddle)..'*'..self:MaskMagic(self.boxEnd) end
		local n = _line:find(pattern)
		return (n ~= nil)
	end,

	-- remove middle marker/add line
	UncommentMiddleLine = function(self, _bMiddle, _text)
		if _bMiddle then self.newText = self.newText.._text:gsub("^("..self:MaskMagic(self.boxMiddle)..")", "")
		else self.newText = self.newText.._text end
	end,

	-- checks if passed line is last line in editor AND selection ends not at line start position
	IsLastLine = function(self, _line)
		return (editor.LineCount == (_line + 1)) and (editor:PositionFromLine(_line) ~= self.selE.pos)
	end,

	-- the ternary operator
	ternary = function(self, _condition, _ifTrue, _ifFalse)
		if _condition == true then return _ifTrue
		else return _ifFalse end
	end,

	-- creates the text to toggle and replace the selection with it
	Toggle = function(self)
		self:Init()
		local firstVisibleLine = editor.FirstVisibleLine
		local countNesting, bStart, nStart, text, nLine, replS, replE = 0, false, -1
		local lineStart, lineEnd, bLastLine
		local sStart, sEnd = self:MaskMagic(self.boxStart), self:MaskMagic(self.boxEnd)
		local sMiddle = self:MaskMagic(self.boxMiddle)
		local bUsedMiddle = false  -- (for uncommenting) check if first line after comment.start, starts with comment.box.middle marker
		local insertMiddle = ""
		if self.bMiddle then insertMiddle = self.boxMiddle end

		-- error check
		if self.boxStart == "" or self.boxEnd == "" then
		return print("! ERROR - The comment.box properties for *."..self.ext.." files are missing or incomplete.") end

		-- check for set comment block
		if (not self:IsSelection()) then                          -- none selection - means: Unset CommentBlock
			-- start unset
			self.msg.action = 'COMMENT BLOCK - UNSET'
			nLine = self.selS.line
			while nLine < editor.LineCount do
				text = editor:GetLine(nLine)     -- line with eol

				if (not bStart) and self:LineHasStart(text) then  -- first line with comment.box.start
					bStart = true
					self.msg.starts = nLine
					nStart = nLine
					replS = editor:PositionFromLine(nLine) -- save the start position for replacing
				end

				if nLine == nStart +1 then       -- first line after comment.box.start
					if self.bMiddle then -- check if comment.box.middle is used, if defined
						local n = text:find(sMiddle)
						if n == 1 then bUsedMiddle = true end  -- true, if starts with it
					end
				end

				if self:LineIsEmpty(text) then   -- do nothing with empty lines, add them only if start was detected before
					if bStart then self.newText = self.newText..text end  -- text is only a line break
				else
					if self:LineHasEnd(text) then       -- the box.end or a nested box.end
						countNesting = countNesting -1  -- decrease nesting counter
						if countNesting == 0 then       -- it's the corresponding end position
							self.newText = self.newText:sub(1, -(self.lenEOL +1))  -- ignore text from this line and delete line break from stored line before
							replE = editor.LineEndPosition[nLine]                  -- save the end position (w.o. line break) for replacing
							self.msg.ends = nLine -2
							break                       -- leave the loop
						else  -- will be treated as middle line (it's a nested comment.box.end)
							self:UncommentMiddleLine(bUsedMiddle, text)
						end
					elseif self:LineHasStart(text) then
						countNesting = countNesting +1 -- increase nesting counter
 						-- countNesting == 1              it's the real start of block comment --> ignore this line
						if countNesting > 1 then self:UncommentMiddleLine(bUsedMiddle, text) end -- treat it like a middle line
					else  -- all other cases are middle lines but if not start was detected - ignore this line
						if bStart then self:UncommentMiddleLine(bUsedMiddle, text) end
					end
				end
				nLine = nLine +1
			end
			if (not bStart) then
				return print("! ERROR - None comment block starts near the cursor.")  -- text near Cursor isn't comment block start marker
			end
		else
			-- set comment block
			self.msg.action = 'COMMENT BLOCK - SET'
			if self.selS.line == self.selE.line then                   -- selection is in one line
				text = editor:GetLine(self.selS.line)
				lineStart = editor:PositionFromLine(self.selS.line)
				lineEnd = editor.LineEndPosition[self.selS.line] + self.lenEOL
				editor:SetSel(lineStart, lineEnd)                      -- select all text in line
				bLastLine = self:IsLastLine(self.selE.line)
				if bLastLine then self.boxEnd = self.eol..self.boxEnd end
				self.newText = self.boxStart..self.eol..insertMiddle..text..self.boxEnd..self:ternary(bLastLine, '', self.eol)
				self.msg.starts = self.selS.line
				self.msg.ends = self.selS.line +2
			else
				-- as 1.: find the last line with text in selection, possibly blank lines are selected at the end
				local iLineLastText = -1
				for i = self.selE.line, self.selS.line, -1 do
					if (not self:LineIsEmpty(i)) then
						iLineLastText = i
						break
					end
				end
				-- none text selected
				if iLineLastText == -1 then return print("! ERROR - Only empty lines selected.") end
				if iLineLastText ~= self.selE.line then
					self.selE.line = iLineLastText
					self.selE.pos = editor.LineEndPosition[self.selE.line]
				end
				bLastLine = self:IsLastLine(self.selE.line)
				if bLastLine then self.boxEnd = self.eol..self.boxEnd end

				for i = self.selS.line, self.selE.line do
					text = editor:GetLine(i)
					if i == self.selS.line then                        -- selection start line
						if (not self:LineIsEmpty(text)) then
							lineStart = editor:PositionFromLine(self.selS.line)
							if lineStart ~= self.selS.pos then
								self.selS.pos = lineStart
								editor:SetSel(self.selS.pos, self.selE.pos)
							end
							self.newText = self.boxStart..self.eol..insertMiddle..text
							self.msg.starts = i
						else
							-- start line is empty - do nothing
						end
					elseif i == self.selE.line then                    -- selection end line
						if self.newText == "" then                     -- the last line is the 1st line with text in selection
							self.newText = self.boxStart..self.eol
							self.selS.pos = editor:PositionFromLine(i)
							self.msg.starts = i
						end
						lineStart = editor:PositionFromLine(i)
						lineEnd = editor.LineEndPosition[i]
						if lineStart == self.selE.pos then                      -- selection ends at line start position
							self.newText = self.newText..self.boxEnd..self.eol  -- ignore this line
							self.msg.ends = i +2
							break
						end
						if lineEnd == self.selE.pos then                        -- selection ends behind last visible char
							self.newText = self.newText..insertMiddle..text..self.boxEnd  -- without EOL
							self.msg.ends = i +2
							break
						end
						if lineEnd > self.selE.pos then                         -- selection ends inside the line, line will used
							self.selE.pos = lineEnd + self.lenEOL               -- set selE.pos to line end for correct replacing
						end
						self.newText = self.newText..insertMiddle..text..self.boxEnd..self:ternary(bLastLine, '', self.eol)
						self.msg.ends = i +2
					else                                                        -- middle lines
						if (not self:LineIsEmpty(i)) and self.newText == "" then -- may be only empty lines in selection before
							self.newText = self.boxStart..self.eol
							self.selS.pos = editor:PositionFromLine(i)
							self.msg.starts = i
						end
						if self.newText ~= "" then self.newText = self.newText..insertMiddle..text end
					end
				end
				editor:SetSel(self.selS.pos, self.selE.pos)
			end
		end

		-- replace the selection with the new toggled text
		if bStart then editor:SetSel(replS, replE) end  -- for uncommenting exists none selection - do it here
		editor:ReplaceSel(self.newText)                 -- replace the next
		editor:SetSel(self.selS.pos,self.selS.pos)      -- set the cursor to start position
		editor.FirstVisibleLine = firstVisibleLine      -- make the first visible line visible again
		if props["comment.box.output"] == "1" then
			print(string.format('++ %s [line %d-%d]', self.msg.action, self.msg.starts +1, self.msg.ends +1))
		end
	end
}

BlockComment:Toggle()

As far as I know, it is not possible to overwrite SciTE internal hotkeys. In this case "Ctrl+Shift+B" for IDM_BLOCK_COMMENT. Therefore I used the connection shown here.
But if overwriting is possible, I would be interested in this solution.

 

BlockComment.lua

Edited by BugFix

Best Regards BugFix  

Link to post
Share on other sites
Posted (edited)

New version v0.10

Set comment.block:

  • leading and trailing empty lines in selection will ignored
  • selection.start / selection.end is inside a text line: selection will expanded to full line
  • selection.end is at 1st position in a line: this line will ignored (is outside the block comment)
  • at minimum 1 character needs to selected 

UnSet comment.block:

  • Only one: The cursor position must be within a line with comment.box.start or in any line above.
    The related comment.box.end will detected automatically (with any kind of nesting).
Edited by BugFix

Best Regards BugFix  

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By mrider
      Greetings all,
      I went looking around for dark themes for SciTE and didn't have much luck.  No wish to necro-post, but I found this post -> A dark theme for SciTE but it seems as if things were ended at a single change for AutoIt where I was hoping for a comprehensive dark theme.  I currently have a dark desktop in Mint where xed, the terminal emulator, vim, and etcetera do an acceptable job of showing the dark theme.  Then I load SciTE and get blinded.  To resolve this, I'm currently working on creating a set of lang.properties files that use the Solarized themes (both light and dark).  The mechanism is simple enough: I wrote a small Perl program which parsed all the properties files and extracted all the distinct color values.  Then I assigned indexes to all the distinct colors, and wrote the colors themselves out to a separate properties file.  Next I parsed that and I used the formula for reducing the color palette to fewer colors as a baseline for generating the Solarized light theme - which turned out surprisingly less awful than I would have guessed.  Next I generated a color theme where all the colors are reversed for the Solarized dark theme.  The result is dark, but the individual source files I look at still need more help (Perl was particularly bad).  At this point, it is possible on my computer to switch to either the Solarized light or dark theme with one line of text in my user options file.
      Now I'm working my way through source-code cleaning up the result.  My first stop is completing Perl, but AutoIt is my next stop.  I'm happy to put the modified files out there for all to use (if you want them).
      I'm willing to do all the legwork for all the properties files.  The problem is that I'm only familiar with some of the languages that SciTE recognizes (for example - I wouldn't know Baan if it bit me on the butt).  I looked all around both the Solarized website and the Scintilla/SciTE website, and I can't find any reference files that can be used to test the colors.  Which means that any language I don't understand will get the colors chosen by the algorithm, which is admittedly fairly rough. 
       
      Which leads me to this post: What would be particularly useful would be code samples in different languages.  The more of the style numbers that are touched in that language the better.  I don't care if the code is "quality" code, I'm more interested in whether the code snip is properly colorized (for some values of "proper").  I understand that nobody is obligated to help me with "my project".  However, I promise that I will do my best with any code snips in any language and I will post the results here.  I'm using xed and vim as my templates, so my results will (mostly) resemble results there.
      I'll post my work here as time progresses, I'll probably have a working version for Perl and AutoIt in the next few days, and I'll do my best with other languages going forward.  As I say, I welcome code snips in any language that SciTE colorizes using a properties file.
       
      Edit1: Attached is the first Solarized Version.  I have only tested this in the default install of SciTE.  I'm certain there are going to be differences between the default install and the full version, but I don't yet know what those differences will be.  To use this:
      Detach the zip file. Drop the folder into your profile directory.  For example: C:\Users\mrider\Solarized . Open your local options file in SciTE (Options -> Open User Options File). Add the line "import Solarized\SolarDark" (without the quotes) to your file. You can turn the dark theme on and off with a comment character (#) at the beginning of the statement. Enable "Solar Light" theme similarly using "import Solarized\SolarLight". As I say, this doesn't work in the full version, so only use this if you are using the basic version.  I'll chase the full version next.
       
      Edit2: Attached is the second Solarized Version.  This works with the full install of SciTe, but so far I've only tested it with Autoit, Batch Files, and Perl.  I'll keep expanding the languages as I go.  To use this:
      Detach the zip file. I had to navigate to "C:\Program Files (x86)\AutoIt3\SciTE" and relax the file permissions to perform the next step. Drop the folder in the SciTE install directory (it doesn't seem to work in one's profile directory). Open your local options file in SciTE (Options -> Open User Options File) - note that this opens the user properties file inside the SciTE directory, not your profile. Add the line "import Solarized\SolarDark" (without the quotes) to your file. You can turn the dark theme on and off with a comment character (#) at the beginning of the statement. Enable "Solar Light" theme similarly using "import Solarized\SolarLight".  
      Solarized_AutoIt_SciTE_version_only.zip
      Solarized_SciTE_Full_Install.zip
    • By beautifulsoup
      Hi All,
      I'm not sure if its possible that I'm trying to achieve, I've looked into https://www.autoitscript.com/autoit3/scite/docs/SciTE4AutoIt3/AutoIt3Wrapper.html and such resources for help, but I cant really find the answer to my question.
      So upon compiling the script in SciTE, the exe file is given a Description under file Properties>Details. I understand, that  one can enter info manually there and it can even implement the version automatically with each compilation.
       
      What I'm trying to achieve is to somehow include the "@ScriptName" in the Details>File Description Field. But as I see no variable can be taken after "#" in this case.
       
      Do You think its achievable? (Win 10)
       
      Much obliged for taking time on reading this.
       
      Kind Regards,
      Brave


    • By argumentum
      In the console under the editor in SciTE: 
      if I add @@ Debug(line,column) then it goes there.
      if I add "script.au3" (line,column) then it goes there if loaded.
      if I add "c:\path\script.au3" (line,column) then it loads the file and goes there.
      ...so far so good.
      Since I don't know LUA, nor where that is at, my question is ... where is it at ?
      A silly question because once there I would not know what to do, since I don't know LUA.
      What I want to achieve is, that since there is something delimiting the script and editor position (li,co), a way to have, let's say:
      +I like this color and the text that I care for on the left ["c:\path\script.au3" (line,column)]
      and by having this ["" ()] format ( or anything else, it don't have to be this exact format ), the console would know to jump there.
      If DClick to jump/goto Line,Column can trigger an external EXE or script, I'd take it from there. If it all can be done from LUA then, I'd do it there.
      So I don't mind or know how. I just would like that functionality. In a way that don't require a recompile of SciTE.
      Thanks  
    • By Dave1
      Hello everyone,
      I have several signals on the screen that need to be monitored while a program is running. These signals are scattered around an image which is maximized on 4  equal resolution screens - the AutoIT Window Info does not recognize any objects on the program meaning that I'm left with the PixelSearch() and PixelCheckSum() functions to monitor the signals:
      The signals are as small as a 5x5 pixel area and their coordinates are known.
      I've been digging around for a while now in this forum about the PixelSearch() and PixelCheckSum()  and found some interesting and useful ideas for the use of them. I also came across some other UDF functions like MultiMon(), FastFind(), TtColXY() and the ImageSearch2015 scripts that might be useful for the final output. I don't know if hovering the mouse by using TtColXY() and output its ToolTip() information onto the log file will be faster than using PixelSearch() and/or PixelCheckSum() in a loop for all signals' coordinates.
      The colours of the signals are below:
      red - 0x00FF00 (opaque red)
      green - 0x00FF00 (opaque green)
      yellow - 0xFFFF00 (opaque yellow)
      black - 0x000000 (opaque black, default colour)
      EDIT:
      The desired output is to monitor and record/log the changes and status of each inside a .txt file or a .csv with the below format: 
      Local Machine Time        Signal,      Change,               delta-t
      14:32:07                  Signal1     Green - Yellow         DELTA-t1
      14:34:02                  Signal1     Yellow - Red           DELTA-t1
      14:35:14                  Signal2     Yellow - Red           DELTA-t2
      ...
      Below is the code I came up with. 
      #include <AutoItConstants.au3> #include <MsgBoxConstants.au3> #include <misc.au3> #include <Date.au3> #include <Array.au3> #include <File.au3> #include <ScreenCapture.au3> #include <WinAPI.au3> #include <WinAPIHObj.au3> Global $program_name, $program_open, $Wname, $tCurrent Global $button_xy[2] = [150, 175] Global $iniColour, $ColourCheck, $NewCheck Global $Red, $Green, $Blue, $Nil Global $sFilePath = @ScriptDir & "\Signals_status.txt" Global $SignalID[10] = ["Signal_1", "Signal_2", "Signal_3", "Signal_4", "Signal_5", "Signal_6", "Signal_7", "Signal_8", "Signal_9", "Signal_10"] $program_name = "Signals.exe" $Wname = "Training Task 3" $program_open = ShellExecute($program_name, @ScriptDir) WinWait($Wname) $iniColour = "0x" & Hex(PixelGetColor($button_xy[0], $button_xy[1]), 6) ;~ $iniChecksum = "0x" & Hex(PixelChecksum($button_xy[0], $button_xy[0] - 5, $button_xy[1], $button_xy[1] + 5), 6) $ColourCheck = "0x" & Hex(PixelChecksum($button_xy[0], $button_xy[0] - 5, $button_xy[1], $button_xy[1] + 5, 1, $Wname), 6) ConsoleWrite(_ColourID($iniColour) & " // " & _ColourID($ColourCheck) & @CRLF) ;~ $ColourCheck = "0x " & Hex(PixelGetColor($button_xy[0], $button_xy[1]), 6) $iniColour = $ColourCheck ;$iniChecksum = $currentCheck Do ;~ While 1 _WindowOnTop() _Close_Notepad() $NewCheck = "0x" & Hex(PixelChecksum($button_xy[0], $button_xy[0] - 5, $button_xy[1], $button_xy[1] + 5, 1, $Wname), 6) $tCurrent = _NowCalc() $LogFile = FileOpen($sFilePath, 2) FileWriteLine($LogFile, "Local Machine Time " & "Signal, " & "Change, " & "delta-t") ;~ $ColourCheck = "0x" & Hex(PixelChecksum($button_xy[0], $button_xy[0] - 5, $button_xy[1], $button_xy[1] + 5, 1, $Wname), 6) If $ColourCheck <> $NewCheck Then ;If there's a colour change from the current colour $ColourCheck = $NewCheck Local $tChange, $NewCheckID, $ColourCheckID, $sLogMsg $tChange = _NowCalc() ConsoleWrite("Colour changed!" & @CRLF) $ColourCheckID = _ColourID($ColourCheck) $NewCheckID = _ColourID($NewCheck) $iTimeDiffh = _DateDiff('h', $tChange, $tCurrent) ; time difference in hours $iTimeDiffm = _DateDiff('n', $tChange, $tCurrent) ; time difference in minutes $iTimeDiffs = _DateDiff('s', $tChange, $tCurrent) ; time difference in seconds $durationCheckSum = $iTimeDiffh & ":" & $iTimeDiffm & ":" & $iTimeDiffs ; Timestamp of the signal until PixelCheckSum $sLogMsg = " " & $SignalID[0] & " " & $ColourCheckID & " - " & $NewCheckID & " " & $durationCheckSum _FileWriteLog($LogFile, $sLogMsg) ElseIf $ColourCheck = $NewCheck Then Local $Colour_check = _ColourID("0x" & Hex(PixelChecksum($button_xy[0], $button_xy[0] - 5, $button_xy[1], $button_xy[1] + 5, 1, $Wname), 6)) ConsoleWrite($tCurrent & " " & $Colour_check & @CRLF) EndIf FileClose($sFilePath) Until Not ProcessExists($program_name) And Not WinExists($Wname) _IsProgramOpen() Func _Close_Notepad() $notepad_open = ProcessExists("notepad.exe") ? ProcessClose("notepad.exe") : ProcessClose("notepad.exe") $notepad_open = WinActive("[CLASS:Notepad]") ? WinClose("[CLASS:Notepad]") : ProcessClose("notepad.exe") EndFunc ;==>_Close_Notepad Func _ColourID($sColour) $Red = Int("0x" & StringRegExpReplace($sColour, "(..)(..)(..)(..)", "\2")) $Green = Int("0x" & StringRegExpReplace($sColour, "(..)(..)(..)(..)", "\3")) $Blue = Int("0x" & StringRegExpReplace($sColour, "(..)(..)(..)(..)", "\4")) If $Green > $Blue And $Red > $Blue And $Green >= 0xB0 And $Red >= 0xB0 Then $sCol = "Yellow" ElseIf $Blue > 0xE0 And $Green > 0xE0 And $Red > 0xE0 Then $sCol = "White" ElseIf $Blue > 0x50 And $Blue = $Green And $Blue = $Red Then $sCol = "Grey" ElseIf $Red > $Green And $Red > $Blue And $Red > 0x70 Then $sCol = "Red" ElseIf $Green > $Red And $Green >= $Blue And $Green > 0x70 Then $sCol = "Green" ElseIf $Blue > $Red And $Blue > $Green And $Blue > 0x70 Then $sCol = "Blue" Else $sCol = "Nil" EndIf Return $sCol EndFunc ;==>_ColourID Func _WindowOnTop() WinActivate($Wname) WinSetOnTop($Wname, "", $WINDOWS_ONTOP) Opt("MouseCoordMode", 0) EndFunc ;==>_WindowOnTop Func _IsProgramOpen() If Not ProcessExists($program_name) And Not WinExists($Wname) Then Break(1) EndIf EndFunc ;==>_IsProgramOpen When the program is running, the window opens in the centre of the screen however, the PixelChecksum function is not looking at the correct area. In addition:
      1 - I'm not sure about how to put the message into the log file.
      2 - I tested this script but it is not recording the message into the log file.
      3 - Is there other way to calculate the duration in these lines?
      $iTimeDiffh = _DateDiff('h', $tChange, $tCurrent) ; time difference in hours $iTimeDiffm = _DateDiff('n', $tChange, $tCurrent) ; time difference in minutes $iTimeDiffs = _DateDiff('s', $tChange, $tCurrent) ; time difference in seconds $durationCheckSum = $iTimeDiffh & ":" & $iTimeDiffm & ":" & $iTimeDiffs ; Timestamp of the signal until PixelCheckSum $sLogMsg = " " & $SignalID[0] & " " & $ColourCheckID & " - " & $NewCheckID & " " & $durationCheckSum _FileWriteLog($LogFile, $sLogMsg) Thanks in advance!
    • By Bhooshan
      I need to mute an ongoing call on Microsoft teams without activating the window. Teams allows us to mute using shortcut key Ctrl+Shift+m but only when the window is active.
      # Used set option as ongoing call can be with any person which leads to change in Title Name.
      AutoItSetOption ( "WinTitleMatchMode", 2 ) 
      # I am not clear with the control ID which will be good to use here and also the key combination of ^M       
      ControlSend ( "Microsoft Teams", "", "[CLASS:Intermediate D3D Window; INSTANCE:1]", "{ctrl down}")
       
      Can anyone help...!!! 
       

×
×
  • Create New...