28 replies to this topic

[MrCreatoR]

This UDF allows to highlight AutoIt v3 syntax code to html/bbcode format.

Note: As strange as it might sound, this UDF written on pure AutoIt (even includes are not used), and since this UDF uses a lot of RegExp, i had to add a RegExp debugging system.
To enable this system you should set «1» for the following variables in library file (AutoItSyntaxHighlight.au3) under the #Region Global Variables:

Global $iDebug_RegExp_Patterns = 1 ; Enable regular exp[b][/b]ression debugging system
Global $iDebug_RegExp_WriteLog = 1 ; Will write a log-file for debugging data (at the end of each syntax highlighting process)

There is also a Global option to define if the functions/keywoords should be linked to online documentation:

$iAu3SH_AddURLs = 1 ; Will add links to highlighted Functions/Keywords

Example:

Spoiler

AutoIt        expandcollapse  popup

#include <Au3SyntaxHighlight.au3>

#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>
#include <IE.au3>

$iAu3SH_AddURLs = 1

$sInitDir = ""
$sFilter = "*.au3"

$sMRUList = RegRead("HKEY_CURRENT_USERSoftwareMicrosoftWindowsCurrentVersionExplorerComDlg32OpenSaveMRUau3", "MRUList")
$sLastFileOpenPath = RegRead("HKEY_CURRENT_USERSoftwareMicrosoftWindowsCurrentVersionExplorerComDlg32OpenSaveMRUau3", StringLeft($sMRUList, 1))

If Not FileExists($sLastFileOpenPath) Then
$sInitDir = @ScriptDir
$sFilter = "Test Script.au3"
EndIf

$sFile = FileOpenDialog("Open Au3 Script File", $sInitDir, "AutoIt Script (" & $sFilter & ")")
If @error Then Exit

$sAu3Code = FileRead($sFile)
$sAu3Syntax_HighlightedCode = _Au3_SyntaxHighlight_Proc($sAu3Code, 0)

$sTmp_File = @TempDir & "Au3_HighlightSyntax.htm"

$hFile = FileOpen($sTmp_File, 2)
FileWrite($hFile, $sAu3Syntax_HighlightedCode)
FileClose($hFile)

_IEErrorHandlerRegister()

$oIE = _IECreateEmbedded()
GUICreate("AutoIt Syntax Highlighter [" & $sFile & "]", @DesktopWidth-10, @DesktopHeight-70, 0, 0, $WS_OVERLAPPEDWINDOW + $WS_VISIBLE + $WS_CLIPSIBLINGS + $WS_CLIPCHILDREN)

$GUIActiveX = GUICtrlCreateObj($oIE, 10, 20, @DesktopWidth-5-20, @DesktopHeight-200-40)

$GUI_Button_Back = GUICtrlCreateButton("Back", 10, @DesktopHeight-200, 100, 30)
$GUI_Button_Forward = GUICtrlCreateButton("Forward", 120, @DesktopHeight-200, 100, 30)
$GUI_Button_Home = GUICtrlCreateButton("Home", 230, @DesktopHeight-200, 100, 30)
$GUI_Button_Stop = GUICtrlCreateButton("Stop", 340, @DesktopHeight-200, 100, 30)

GUISetState()

_IENavigate($oIE, $sTmp_File)

While 1
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
GUIDelete()
Exit
Case $GUI_Button_Home
_IENavigate($oIE, $sTmp_File)
Case $GUI_Button_Back
_IEAction($oIE, "back")
Case $GUI_Button_Forward
_IEAction($oIE, "forward")
Case $GUI_Button_Stop
_IEAction($oIE, "stop")
EndSwitch
WEnd

UDF Header:

Spoiler

AutoIt        expandcollapse  popup

; #FUNCTION# ====================================================================================================
; Name...........: _Au3_SyntaxHighlight_Proc
; Description....: Allows to highlight AutoIt v3 syntax to html/bbcode format.
; Syntax.........: _Au3_SyntaxHighlight_Proc($sAu3Code, $iOutput = -1)
; Parameters.....: $sAu3Code - AutoIt v3 plain code.
; $iOutput - [Optional] Sets the output format:
; -1 - (Default) Return CSS classes header and the AutoIt Syntax Highlighted code as string (wrapped with code tags)
; 1 - Return CSS classes header and AutoIt Syntax Highlighted code as array, where...
; [0] = CSS styles.
; [1] = AutoIt Syntax Highlighted code.
; 2 - Return the result as Html formatted string.
; 3 - Return the result as BBCode formatted string (html tags replaced with bbcode tags).
;
; Return values..: Success - Returns AutoIt Syntax Highlighted code (see $iOutput parameter above for more details).
; Failure - Sets @error to:
; 1 - The $sAu3Code is empty string.
; -1 - The process is aborted by global parameter $iAu3SH_AbortHighlight, and the return value is the original $sAu3Code.
; 2 - Keywords or styles file not found (check the @ScriptDir & "Resources").
;
; Author.........: G.Sandler (a.k.a (Mr)CreatoR), www.creator-lab.ucoz.ru, www.autoit-script.ru
; Modified.......:
; Remarks........: *Idea* based on similar old project: http://www.autoitscript.com/forum/index.php?showtopic=34236
; Related........:
; Link...........:
; Example........: Yes (see #Region Header).
; ===============================================================================================================

Current Library Version: 0.7
AutoIt Support Version: v3.3+, Developed/Tested on Win XP Rus (Service Pack 3) / Win 7 Rus


Screenshot:


Credits:

Spoiler

amel27

Change Log:

Spoiler

[0.7]
* Fixed issue with wrong parsing when Add Urls option is enabled ($iAu3SH_AddURLs = 1).
[0.6]
* Fixed issue with wrong restored strings.

[0.5]
* Fixed bug with highlighting literal strings inside comment blocks.
* Fixed few issues with highlighting special keywords.

[0.4]
* Fixed bug with (re)highlighting keywords and functions inside COM object methods.
* Docs updated.

[0.3]
* Fixed bug when strings and send keys was highlighted inside commented lines.
* Few optimizations to the code.

[0.2]
+ Added Global parameter ($iAu3SH_AbortHighlight) to abort the highlighting process (break the function execution).
If this variable set to 1, the function will return the original Au3 Code and set @error to -1.
+ Added "#White space" style support (now you can set it in the au3.styles.properties file).
+ Added "#Background" style support, used only for highlighting with Html tags mode (now you can set it in the au3.styles.properties file).
* Styles header classes renamed with "au3_" prefix.
* Fixed bug with highlighting COM objects.
* Fixed bug with highlighting keywords inside variables.
* Fixed bug with highlighting more than one preprocessor when instead of <Include.au3> used double/single qoutes ("Include.au3").
* Fixed bug with highlighting commented lines/comment blocks inside literal strings.
* Fixed bug with not (properly) highlighting commented lines.
* Fixed issue with converting to BBCode format.
* Now the PreProcessor and Special keywords are correctly highlighted (all included tags removed).

[0.1]
First public release.

Attachments:
 AutoItSyntaxHighlight_0.7.zip   25.85K   160 downloads
 AutoItSyntaxHighlight_0.6.zip   25.39K   155 downloads
 AutoItSyntaxHighlight_0.5.zip   25.35K   64 downloads
 AutoItSyntaxHighlight_0.4.zip   24.96K   452 downloads
 AutoItSyntaxHighlight_0.3.zip   24.88K   285 downloads
 AutoItSyntaxHighlight_0.2.zip   24.75K   143 downloads
 AutoItSyntaxHighlight_0.2.zip   24.7K   151 downloads
 AutoItSyntaxHighlight.zip   23.38K   290 downloads

Edited by MrCreatoR, 16 December 2012 - 11:09 PM.

[Shafayat]

Magnificent! Keep up the good work.

[ptrex]

@MrCreatoR

Very usefull !

Thanks

rgds,
ptrex

[MrCreatoR]

New version...

[0.2]
+ Added Global parameter ($iAu3SH_AbortHighlight) to abort the highlighting process (break the function execution).
If this variable set to 1, the function will return the original Au3 Code and set @error to -1.
+ Added "#White space" style support (now you can set it in the au3.styles.properties file).
+ Added "#Background" style support, used only for highlighting with Html tags mode (now you can set it in the au3.styles.properties file).
* Styles header classes renamed with "au3_" prefix.
* Fixed bug with highlighting COM objects.
* Fixed bug with highlighting keywords inside variables.
* Fixed bug with highlighting more than one preprocessor when instead of <Include.au3> used double/single qoutes ("Include.au3").
* Fixed bug with highlighting commented lines/comment blocks inside literal strings.
* Fixed bug with not (properly) highlighting commented lines.
* Fixed issue with converting to BBCode format.
* Now the PreProcessor and Special keywords are correctly highlighted (all included tags removed).

Please check the first post.

Edited by MrCreatoR, 24 July 2010 - 12:01 AM.

[MrCreatoR]

And one more update:

v0.3
* Fixed bug when strings and send keys was highlighted inside commented lines.
* Few optimizations to the code.

[Andreik]

Very usefull UDF.
Thanks for sharing with us.

[MrCreatoR]

Update:

[0.4]
* Fixed bug with (re)highlighting keywords and functions inside COM object methods.
* Docs updated.

[JScript]

@MrCreatoR,
Very good! I'll add on a project to examine and run scripts remotely... Thanks!

[Mikeman27294]

Awesome little program!!!

[Mikeman27294]

You know what would make this more interesting? Would be to set it so that you load it into a rich editbox and it does all of the highlighting in there (without writing to the file), instead of being saved as an html file. What do you think? or do you think that it would be too slow?

[CaptainClucks]

This is great! except its turning things like Global $iAu3SH_MDV_Opt = Opt("MustDeclareVars", 1) into Global $iAu3SH_MDV_Opt = Opt(%@~@%28036.3157074722, 1)


how do I fix that?

[Zedna]

Nice!

[MrCreatoR]

Update.

[0.5]
* Fixed bug with highlighting literal strings inside comment blocks.
* Fixed few issues with highlighting special keywords.

[Danyfirex]

Hi Mate I love this work.

I got a Wrong output with this code.


Normal

#cs -------------------------------------------------------
AutoIt Version: 3.3.8.1
Author..........: dany
Script Function...: Dir "Retorna la Ruta sin el nombre del Archivo
Uso..............: Dir("C:WindowsSystem32Dismes-ESMsiProvider.dll.mui") Retorna "C:WindowsSystem32Dismes-ES"
#ce -------------------------------------------------------

;Ejemplo
$ruta="C:WindowsSystem32Dismes-ESMsiProvider.dll.mui"
msgbox(0,"C:WindowsSystem32Dismes-ES",Dir($ruta))

;Funcion Dir
func Dir($path)
local $delimiter=""
$array =StringSplit($path,$delimiter)
$len=UBound($array)-1
$numero= $len-1
$num=StringInStr($path,$delimiter,0,$numero)
$dir=StringMid($path,1,$num)
return $dir
EndFunc

With your software change my variable $delimiter



#cs -------------------------------------------------------
AutoIt Version: 3.3.8.1
Author..........: dany
Script Function...: Dir "Retorna la Ruta sin el nombre del Archivo
Uso..............: Dir("C:WindowsSystem32Dismes-ESMsiProvider.dll.mui") Retorna "C:WindowsSystem32Dismes-ES"
#ce -------------------------------------------------------

;Ejemplo
$ruta="C:WindowsSystem32Dismes-ESMsiProvider.dll.mui"
msgbox(0,"C:WindowsSystem32Dismes-ES",Dir($ruta))

;Funcion Dir
func Dir($path)
local $delimiter="C:WindowsSystem32Dismes-ESMsiProvider.dll.mui"
$array =StringSplit($path,$delimiter)
$len=UBound($array)-1
$numero= $len-1
$num=StringInStr($path,$delimiter,0,$numero)
$dir=StringMid($path,1,$num)
return $dir
EndFunc

Edited by Danyfirex, 09 August 2012 - 07:34 PM.

[MrCreatoR]

I got a Wrong output with this code.

Fixed, please check the first post

[Danyfirex]

Fixed, please check the first post

Simply Amazing MrCreatoR thank you so much

[MrCreatoR]

Simply Amazing MrCreatoR thank you so much

And thank you for revealing this bug, it is strange that this haven't been noticed before by others.

[JavaScript_Freek]

Looking pretty good. I like this! :-)

[Danyfirex]

hi mate it's me again reporting another bug when I use in this code.

I use so much you usefull tool

where my registry keys are, I put some comment line with the problem.

maybe for next version you can add size-type font. it's only a suggestion.

Thank you Again for you great tool MrCreatoR

AutoIt        expandcollapse  popup

#cs -------------------------------------------------------
AutoIt Version: 3.3.8.1
Author..........: Danyfirex
Script Function...: ListarRun
Uso..............: $Listar=listarRun()
Retorna : Lista las Claves Run en un Array

#ce -------------------------------------------------------


;Ejemplo

#include

$Listar=listarRun()

_ArrayDisplay($Listar,"Funcion Listar Runs")


Func listarRun()
local $valor


Select
Case @OSArch="X64"

Local $clave[3]
local $Array
Local $split
local $XD =1
$clave[0]="HKLM64SoftwareMicrosoftWindowsCurrentVersion Run";here Make me one space in my string "Run"
$clave[1]="HKLMSoftwareMicrosoftWindowsCurrentVersionRu n";here Make me one space in my string"Run"
$clave[2]="HKCUSoftwareMicrosoftWindowsCurrentVersionRu n";here Make me one space in my string "Run"

for $a=0 to 2
For $i = 1 To $XD

Local $var = RegEnumVal($clave[$a], $i)
if _RegExist($clave[$a],$var) Then
$valor=RegRead($clave[$a],$var)
$clavereg=StringSplit($clave[$a],"")



$Array&=($clavereg[1] & " - Run: " &"[" & $var& "] - " & $valor)&@CR
$XD+=1
EndIf

Next

next

$split=stringsplit($Array,@CRLF)
ReDim $split[UBound($split)-1]
return $split



Case @OSArch="X86"
local $clave2[2]
local $Array
local $split
local $XD =1
$clave2[0]="HKLMSoftwareMicrosoftWindowsCurrentVersionRu n" ;here Make me one space in my string "Run"
$clave2[1]="HKCUSoftwareMicrosoftWindowsCurrentVersionRu n" ;here Make me one space in my string "Run"

for $a=0 to 1
For $i = 1 To $XD

Local $var = RegEnumVal($clave2[$a], $i)
if _RegExist($clave2[$a],$var) Then
$valor=RegRead($clave2[$a],$var)
$clavereg=StringSplit($clave2[$a],"")
$Array&=($clavereg[1] & " - Run: " &"[" & $var& "] - " & $valor)&@CR
$XD+=1
EndIf

Next

next

$split=stringsplit($Array,@CRLF)
ReDim $split[UBound($split)-1]
return $split

EndSelect

EndFunc


Func _RegExist($sKeyName, $sValueName)
RegRead($sKeyName, $sValueName)
Return @error = 0
EndFunc

Edited by Danyfirex, 17 August 2012 - 12:13 AM.

[MrCreatoR]

I am not sure that i understand the bug...

Edited by MrCreatoR, 17 August 2012 - 12:39 AM.