Difference between revisions of "SciTE4AutoIt3"

From AutoIt Wiki
Jump to navigation Jump to search
m (AutoIt3Wrapper: Added wikilink for AutoIt3Wrapper Directives)
m (Changed direct references to general references. Lots more left. Removed: More Language Highlighting Options. Wiki formatting.)
Line 1: Line 1:
[[Category:SciTE]]
+
'''SciTE4AutoIt3''' is a specialist editor package based on the excellent [http://www.scintilla.org/SciTE.html SciTE] editor.  SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts.  SciTE4AutoIt3 may be downloaded here: [http://www.autoitscript.com/site/autoit-script-editor/ SciTE4AutoIt3]
=SciTE4AutoIt3=
+
 
SciTE4AutoIt3 is a specialist editor package based on the excellent [http://www.scintilla.org/SciTE.html SciTE] editor.  SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts.  SciTE4AutoIt3 may be downloaded here: [http://www.autoitscript.com/site/autoit-script-editor/ SciTE4AutoIt3]
+
Keep in mind that SciTE4AutoIt3 is not an official package.  Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.
  
 
SciTE4AutoIt3 provides:
 
SciTE4AutoIt3 provides:
Line 8: Line 8:
 
* Code AutoComplete
 
* Code AutoComplete
 
* Auto Indentation
 
* Auto Indentation
* AutoIt Script help integration
+
* AutoIt script help integration
 
* SciTE help integration
 
* SciTE help integration
 
* Abbreviations
 
* Abbreviations
Line 18: Line 18:
  
  
Keep in mind that SciTE4AutoIt3 is not an official package.  Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.
+
__TOC__
 +
 
 +
= Syntax Highlighting =
  
=Syntax Highlighting=
 
 
[[File:Syntax_Highlight.png|457px|thumb|right|A demonstration of syntax highlighting using the default theme.]]
 
[[File:Syntax_Highlight.png|457px|thumb|right|A demonstration of syntax highlighting using the default theme.]]
SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting.  Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments, etc.  This allows one to differentiate the various code elements at a glance without having to specifically read everything.  To load a custom theme a user may press [Ctrl] + [1] to bring up ''SciTEConfig''.  The options are located under the ''Color Settings'' tab.
+
 
 +
SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting.  Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments, etc.  This allows one to differentiate the various code elements at a glance without having to specifically read everything.  To load a custom theme a user may press [Ctrl] + [1] to bring up [[SciTEConfig]].  The options are located under the ''Color Settings'' tab.
  
 
Some options that are available for customization include:
 
Some options that are available for customization include:
Line 34: Line 36:
 
* String
 
* String
  
=Quick Tips=
+
= Quick Tips =
 +
 
 
To access the helpfile the user may press [Alt] + [F1].  
 
To access the helpfile the user may press [Alt] + [F1].  
 
To quickly access help information on a specific function/statement, simply click/highlight the function/statement in question and press the [F1] key to bring up the help file on the relevant page.
 
To quickly access help information on a specific function/statement, simply click/highlight the function/statement in question and press the [F1] key to bring up the help file on the relevant page.
  
For SciTE related help, use the key combination [Ctrl] + [F1] to bring up a help file detailing SciTE related help documentation. ''It's recommended that you read it.''
+
For SciTE related help, use the key combination [Ctrl] + [F1] to bring up a help file detailing SciTE related help documentation.
  
For anyone not familiar with SciTE, here are a few tips and tricks to help you easily modify the installation to suit your needs. For any "truly" advanced info, you should visit the [[http://www.scintilla.org/SciTEDoc.html SciTE home page]].
+
For anyone not familiar with SciTE, here are a few tips and tricks to help easily customize the installation. For any advanced info, visit the [[http://www.scintilla.org/SciTEDoc.html SciTE home page]].
  
 
With the information below, you will be doing some minor editing to SciTE's configuration files.
 
With the information below, you will be doing some minor editing to SciTE's configuration files.
Line 53: Line 56:
  
 
<table border="1">
 
<table border="1">
<tr><td>SciTE.properties</td><td>Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.</td></tr>
+
<tr><td>SciTE.properties</td>
<tr><td>SciTEDirectory.properties</td><td>Directory properties file which may be present in the same or in a parent directory as the file being edited. This file overrides all properties setting of the files below, but not the local properties settings aka ''SciTE.properties''. This file is user created.</td></tr>
+
<td>Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.</td></tr>
<tr><td>SciTEUser.properties</td><td>User properties file, this files settings override only the Global properties settings aka ''SciTEGlobal.properties''. This file is found under the current logged on users profile directory.</td></tr>
+
 
<tr><td>SciTEGlobal.properties</td><td>All settings in this file can be overridden by any of the above files. Typically you shouldn't mess with this file and use any of the above methods to implement a setting change. This file can be found in SciTE's installation directory.</td></tr>
+
<tr><td>SciTEDirectory.properties</td>
 +
<td>Directory properties file which may be present in the same or in a parent directory as the file being edited. This file overrides all properties setting of the files below, but not the local properties settings aka ''SciTE.properties''. This file is user created.</td></tr>
 +
 
 +
<tr><td>SciTEUser.properties</td>
 +
<td>User properties file, this file's settings override only the global properties settings aka ''SciTEGlobal.properties''. This file is found under the current logged on users profile directory.</td></tr>
 +
 
 +
<tr><td>SciTEGlobal.properties</td>
 +
<td>All settings in this file can be overridden by any of the above files. Typically this file should not be edited.  Use any of the above methods to implement a setting change. This file can be found in SciTE's installation directory.</td></tr>
 
</table>
 
</table>
  
''If you have any trouble finding any of the previously mentioned files then I recommend that you do ''not'' continue further.''
+
== Inline Errors ==
  
==Inline Errors==
 
 
[[File:InlineError.JPG‎‎|234px|thumb|right|Intentional error prone code used to display the "Inline Error" feature.]]
 
[[File:InlineError.JPG‎‎|234px|thumb|right|Intentional error prone code used to display the "Inline Error" feature.]]
In the latest version of SciTE, there exists a new feature called "Inline Errors", some users find them annoying. Inline Error marks are error messages that will appear in the source code within the Scintilla window. While helpful, some users prefer to disable this feature.
 
You can quickly disable/enable them using the '''SciTEUser.properties'''.
 
  
Open the SciTE user properties file in a text editor by selecting from the AutoIt menu Options, Open User Options File and add the following code to the file.
+
In the latest version of SciTE, there exists a new feature called "Inline Errors".  Inline Error marks are error messages that will appear in the source code within the Scintilla window.
  
To disable Inline Errors, add the following.
+
Inline erros may be quickly toggled using ''SciTEUser.properties''.
 +
 
 +
Open the SciTE user properties file in a text editor by selecting from the SciTE menu ''Options''.  Open ''User Options File'' and add the following code to the file.
 +
 
 +
To disable:
 
<syntaxhighlight lang="properties">
 
<syntaxhighlight lang="properties">
 
# Display settings for inline errors on the source
 
# Display settings for inline errors on the source
 
error.inline=0
 
error.inline=0
 
</syntaxhighlight>
 
</syntaxhighlight>
To enable Inline Errors, add the following.
+
 
 +
To enable:
 +
 
 
<syntaxhighlight lang="properties">
 
<syntaxhighlight lang="properties">
 
# Display settings for inline errors on the source
 
# Display settings for inline errors on the source
Line 79: Line 92:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==Selection Highlighting==
+
== Selection Highlighting ==
In the latest SciTE4AutoIt3, there is a new feature which highlights other instances of the currently highlighted word or string. Due to the colors, sometimes it's hard to tell the selection apart.
 
  
If you'd like, you can do either of two things using the ''SciTEUser.properties''.
+
Syntax Highlighting is a new feature which highlights other instances of the currently highlighted word or string.  Due to the colors, sometimes it's hard to tell the selection apart. The default colors may be changed.
# Disable it
 
# Change the color scheme
 
  
To disable it
+
The feature may be toggled by editing ''SciTEUser.properties''.
<syntaxhighlight lang="properties">
 
highlight.current.word=0
 
</syntaxhighlight>
 
To re-enable it, just delete it and save.
 
  
To change the color scheme, add the following to your SciTEUser.properties file.
+
To disable:
<syntaxhighlight lang="properties">
 
highlight.current.word.colour=#000040
 
selection.alpha=50
 
selection.back=#F025A8
 
</syntaxhighlight>
 
  
The user should try adjusting the ''#COLOR'' values to come to a preferred color.
+
<syntaxhighlight lang="properties">highlight.current.word=0</syntaxhighlight>
  
==More Language Highlighting Options==
+
To enable:
In the SciTEUser.properties file, add the following code.
 
  
<syntaxhighlight lang="properties">
+
<syntaxhighlight lang="properties">highlight.current.word=1</syntaxhighlight>
# Language Highlighting Options
 
menu.language=\
 
#FreeBasic|bas||\
 
Text|txt|Shift+F11|\
 
#Ada|ads||\
 
AutoIt3|au3|Shift+F12|\
 
#Apache Confi&g|conf||\
 
#Assembler|asm||\
 
#ASN.1|asn1||\
 
#Avenue|ave||\
 
#Baan|bc||\
 
#&Batch|bat||\
 
#Bullant|ant||\
 
#&C / C++|cpp||\
 
#CMake|cmake||\
 
#C&#|cs||\
 
#COBOL|cob||\
 
#Csound|orc||\
 
#CSS|css||\
 
#D|d||\
 
#&Difference|diff||\
 
#&Eiffel|e||\
 
#Erlang|erl||\
 
#&Errorlist|err||\
 
#FlagShip|prg||\
 
#&Fortran|f90||\
 
#&Fortran|f90||\
 
#Gap|g||\
 
#Haskell|hs||\
 
#H&ypertext|html|$(keyHTML)|\
 
#&InnoSetup|iss||\
 
#&Java|java||\
 
#Java&Script|js||\
 
#&Kix|kix||\
 
#Lisp|lisp||\
 
#Lot|lot||\
 
#Lout|lt||\
 
#Lu&a|lua||\
 
#Matlab|m.matlab||\
 
#&Makefile|mak||\
 
#MetaPost|mp||\
 
#MMIXAL|mms||\
 
#Modula-3|m3||\
 
#&nnCron crontab|tab||\
 
#NSIS|nsis||\
 
#Objective Caml|ml||\
 
#Octave|m.octave||\
 
#Opal|impl||\
 
#Pascal|pas||\
 
#Pe&rl|pl||\
 
#P&HP|php||\
 
#P&LSQL|spec||\
 
#P&ostScript|ps||\
 
#P&OV-Ray SDL|pov||\
 
#PowerShell|ps1||\
 
#PowerPro|powerpro||\
 
#&Properties|properties||\
 
#Pytho&n|py||\
 
#R|R||\
 
#Reso&urce|rc||\
 
#Ruby|rb||\
 
#Shell|sh||\
 
#S&QL|sql||\
 
#Specman|e||\
 
#&TCL|tcl||\
 
#TeX|tex||\
 
#&txt2tags|t2t||\
 
#&VB|vb||\
 
#VBScr&ipt|vbs||\
 
#Verilog|v||\
 
#VHDL|vhd||\
 
#&XML|xml||\
 
#&YAML|yaml||
 
</syntaxhighlight>
 
  
For whatever language you wish to have an option appear under the ''Language'' menu option, uncomment the language. Say you want to SciTE to give you the option to highlight batch script code, change the following string in the above list from
+
To change the color scheme, add the following to SciTEUser.properties.
  
 
<syntaxhighlight lang="properties">
 
<syntaxhighlight lang="properties">
#&Batch|bat||\
+
highlight.current.word=1
</syntaxhighlight>
+
# Edit the following property to change to the desired color.
to
+
highlight.current.word.colour=#000040
<syntaxhighlight lang="properties">
+
selection.alpha=50
&Batch|bat||\
+
# Edit the following property to change to the desired color.
 +
selection.back=#F025A8
 
</syntaxhighlight>
 
</syntaxhighlight>
Restart SciTE and if done correctly, the option should be present!  Do this for any language listed in the above example list.
 
  
In the case that you uncommented a language and you notice that it's not being highlighted correctly, then we will have to edit some things in the '''SciTEGlobal.properties''' file.
+
== Colors in the Output Pane ==
  
Open the '''SciTEGlobal.properties''' file in a text editor and find the section
+
SciTE has a console window which can be used to output information from running scripts. The function {{Help File|ConsoleWrite}} may be used in an AutoIt script to output text to the console.  The colors of the text may be altered by prepending a string with special characters.
<syntaxhighlight lang="properties">
 
# import properties\all the language specific properties files
 
</syntaxhighlight>
 
Below that section there will be a few strings that look like
 
<syntaxhighlight lang="properties">
 
#import properties\[syntax]
 
</syntaxhighlight>
 
Uncomment the syntax related property you wish to have support for.
 
  
Say you wanted support for ruby, just locate the one that says ''ruby'' where ''[syntax]'' is written.
+
For example:
  
==Colors in the Output Pane==
 
When you use SciTE as your AutoIt script editor it is a simple matter to get color in the output pane while you test run your code. Try this:
 
 
<syntaxhighlight lang="AutoIt">
 
<syntaxhighlight lang="AutoIt">
ConsoleWrite("This is plain text" & @LF)
+
ConsoleWrite("This is plain text" & @LF)
ConsoleWrite(">Make it have some color" & @LF)
+
ConsoleWrite("> This text will have a different color." & @LF)
ConsoleWrite("+Make it have some other color" & @LF)
+
ConsoleWrite("+ This text will have a different color." & @LF)
ConsoleWrite("-Make it have some other color" & @LF)
+
ConsoleWrite("- This text will have a different color." & @LF)
ConsoleWrite("!Make it have some other color" & @LF)
+
ConsoleWrite("! This text will have a different color." & @LF)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==Debugging Code Easily==
+
== Debugging Code Easily ==
This is one of my (@uten's) favorites.
+
 
 
<syntaxhighlight lang="autoit">
 
<syntaxhighlight lang="autoit">
dbg("This is a test")
+
dbg("This is a test")
dbg("Jump to this line")
+
dbg("Jump to this line")
dbg("just by clicking my output line")
+
dbg("just by clicking my output line")
  
Func dbg($msg, $error = @error, $extended = @extended, $erl = @ScriptLineNumber)
+
Func dbg($msg, $error = @error, $extended = @extended, $erl = @ScriptLineNumber)
    ConsoleWrite("(" & $erl & ") : = (" & $error & ")(" & $extended & ") " & $msg & @LF)
+
    ConsoleWrite("(" & $erl & ") : = (" & $error & ")(" & $extended & ") " & $msg & @LF)
    If $error <> 0 Then SetError($error, $extended, $error)
+
    If $error <> 0 Then SetError($error, $extended, $error)
    Return $error
+
    Return $error
EndFunc  ;==>dbg
+
EndFunc  ;==>dbg
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
= AutoIt3Wrapper =
 
= AutoIt3Wrapper =
  
See [[AutoIt3Wrapper Directives]] for a full list of directives and their descriptions.
+
AutoIt3Wrapper directives allow for in depth control of the compilation and interpretation of AutoIt scripts.  Some of these can be very useful under different circumstances.  See [[AutoIt3Wrapper Directives]] for a full list of directives and their descriptions.
  
AutoIt3Wrapper directives allow much greater and in depth control of programs. Some of these can be very useful under different circumstances.
+
= Obfuscator =
 +
 
 +
[[Obfuscator]] may be used to strip away unused [[Function|functions]] and [[Global|global]] [[Variable|variables] from the script prior to compilation. Obfuscator is not intended as protection against decompilation.
  
 
== Stripping Excess Code ==
 
== Stripping Excess Code ==
  
For instance, if you have several includes, then you can often strip thousands of lines from your program using obfuscator:
+
For instance, if you have several includes, then you can often strip thousands of lines from your script using Obfuscator:
  
 
  #AutoIt3Wrapper_Run_Obfuscator=y
 
  #AutoIt3Wrapper_Run_Obfuscator=y
Line 260: Line 178:
 
  #AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
 
  #AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
  
*NB:* Reshacker.exe ''must'' be copied into the script directory for this to work!
+
NB: Reshacker.exe ''must'' be copied into the script directory for this to work.
  
 
If you then want to use the resources in your code, there is an excellent [http://www.autoitscript.com/forum/index.php?showtopic=51103 Resources UDF] which will allow you to access the resources from within the exe.
 
If you then want to use the resources in your code, there is an excellent [http://www.autoitscript.com/forum/index.php?showtopic=51103 Resources UDF] which will allow you to access the resources from within the exe.
Line 326: Line 244:
 
For a more complete list the following website is very useful: [http://ss64.com/nt An A-Z Index of the Windows CMD Line]
 
For a more complete list the following website is very useful: [http://ss64.com/nt An A-Z Index of the Windows CMD Line]
  
=Other Wiki Pages=
+
= Other Wiki Pages =
 +
 
 
[[Adding_utilities_to_the_SciTE_Tools_menu|Adding Utilities to the SciTE Tools Menu]]
 
[[Adding_utilities_to_the_SciTE_Tools_menu|Adding Utilities to the SciTE Tools Menu]]
  
Line 348: Line 267:
  
 
[http://www.autoitscript.com/forum/topic/152960-scite-lua-tool-to-make-string-variable-from-selected-text/ AU3Forum: scite-lua-tool-to-make-string-variable-from-selected-text]
 
[http://www.autoitscript.com/forum/topic/152960-scite-lua-tool-to-make-string-variable-from-selected-text/ AU3Forum: scite-lua-tool-to-make-string-variable-from-selected-text]
 +
 +
[[Category:SciTE]]

Revision as of 04:21, 3 August 2013

SciTE4AutoIt3 is a specialist editor package based on the excellent SciTE editor. SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts. SciTE4AutoIt3 may be downloaded here: SciTE4AutoIt3

Keep in mind that SciTE4AutoIt3 is not an official package. Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.

SciTE4AutoIt3 provides:

  • Syntax highlighting
  • Calltips (also known as IntelliSense)
  • Code AutoComplete
  • Auto Indentation
  • AutoIt script help integration
  • SciTE help integration
  • Abbreviations
  • Editing macros
  • Debugging support
  • Tools for AutoIt scripting
  • A toolbar that enables easy access to an array of community created tools
  • Various other features


Syntax Highlighting

File:Syntax Highlight.png
A demonstration of syntax highlighting using the default theme.

SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting. Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments, etc. This allows one to differentiate the various code elements at a glance without having to specifically read everything. To load a custom theme a user may press [Ctrl] + [1] to bring up SciTEConfig. The options are located under the Color Settings tab.

Some options that are available for customization include:

  • White Space
  • Comment Line
  • Comment Block
  • Number
  • Function
  • Keyword
  • Macro
  • String

Quick Tips

To access the helpfile the user may press [Alt] + [F1]. To quickly access help information on a specific function/statement, simply click/highlight the function/statement in question and press the [F1] key to bring up the help file on the relevant page.

For SciTE related help, use the key combination [Ctrl] + [F1] to bring up a help file detailing SciTE related help documentation.

For anyone not familiar with SciTE, here are a few tips and tricks to help easily customize the installation. For any advanced info, visit the [SciTE home page].

With the information below, you will be doing some minor editing to SciTE's configuration files. It is imperative that you know the hierarchy of SciTE's configuration files. The main files we will be dealing with here are listed below.

Remember there are four properties files used:

  1. SciTE.properties
  2. SciTEDirectory.properties
  3. SciTEUser.properties
  4. SciTEGlobal.properties
SciTE.properties Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.
SciTEDirectory.properties Directory properties file which may be present in the same or in a parent directory as the file being edited. This file overrides all properties setting of the files below, but not the local properties settings aka SciTE.properties. This file is user created.
SciTEUser.properties User properties file, this file's settings override only the global properties settings aka SciTEGlobal.properties. This file is found under the current logged on users profile directory.
SciTEGlobal.properties All settings in this file can be overridden by any of the above files. Typically this file should not be edited. Use any of the above methods to implement a setting change. This file can be found in SciTE's installation directory.

Inline Errors

Intentional error prone code used to display the "Inline Error" feature.

In the latest version of SciTE, there exists a new feature called "Inline Errors". Inline Error marks are error messages that will appear in the source code within the Scintilla window.

Inline erros may be quickly toggled using SciTEUser.properties.

Open the SciTE user properties file in a text editor by selecting from the SciTE menu Options. Open User Options File and add the following code to the file.

To disable:

# Display settings for inline errors on the source
error.inline=0

To enable:

# Display settings for inline errors on the source
error.inline=1

Selection Highlighting

Syntax Highlighting is a new feature which highlights other instances of the currently highlighted word or string. Due to the colors, sometimes it's hard to tell the selection apart. The default colors may be changed.

The feature may be toggled by editing SciTEUser.properties.

To disable:

highlight.current.word=0

To enable:

highlight.current.word=1

To change the color scheme, add the following to SciTEUser.properties.

highlight.current.word=1
# Edit the following property to change to the desired color.
highlight.current.word.colour=#000040
selection.alpha=50
# Edit the following property to change to the desired color.
selection.back=#F025A8

Colors in the Output Pane

SciTE has a console window which can be used to output information from running scripts. The function ConsoleWrite may be used in an AutoIt script to output text to the console. The colors of the text may be altered by prepending a string with special characters.

For example:

ConsoleWrite("This is plain text" & @LF)
ConsoleWrite("> This text will have a different color." & @LF)
ConsoleWrite("+ This text will have a different color." & @LF)
ConsoleWrite("- This text will have a different color." & @LF)
ConsoleWrite("! This text will have a different color." & @LF)

Debugging Code Easily

dbg("This is a test")
dbg("Jump to this line")
dbg("just by clicking my output line")

Func dbg($msg, $error = @error, $extended = @extended, $erl = @ScriptLineNumber)
    ConsoleWrite("(" & $erl & ") : = (" & $error & ")(" & $extended & ") " & $msg & @LF)
    If $error <> 0 Then SetError($error, $extended, $error)
    Return $error
EndFunc   ;==>dbg

AutoIt3Wrapper

AutoIt3Wrapper directives allow for in depth control of the compilation and interpretation of AutoIt scripts. Some of these can be very useful under different circumstances. See AutoIt3Wrapper Directives for a full list of directives and their descriptions.

Obfuscator

Obfuscator may be used to strip away unused functions and global [[Variable|variables] from the script prior to compilation. Obfuscator is not intended as protection against decompilation.

Stripping Excess Code

For instance, if you have several includes, then you can often strip thousands of lines from your script using Obfuscator:

#AutoIt3Wrapper_Run_Obfuscator=y
#Obfuscator_Parameters=/sf /sv /om /cs=0 /cn=0

On a medium sized script, results are often like this:

>Running Obfuscator (1.0.27.0)  from:C:\Program Files\AutoIt3\SciTE cmdline:
- Iteration 1 Strip Functions result: Output  2580 lines and stripped 6741 lines
- Iteration 2 Strip Variables result: Output  1585 lines and stripped 950 lines
- Iteration 3 Strip Variables result: Output  1566 lines and stripped 19 lines
- Iteration 4 Start the actual Obfuscation.
+> Source    26190 lines 1447980 Characters.
+> Stripped  7710 Func/Var lines and  16862 comment lines, Total 1373871 Characters.
+> Saved     93% lines 94% Characters.
+> Obfuscator v1.0.27.0 finished obfuscating 1566 lines, created:C:\MyScript_Obfuscated.au3

Using ResHacker

ResHacker is a very important programming tool for extracting and adding resources into executables. It has a very simple command line interface that allows it to be used easily using the "Run_After" directive. Adding a picture to an executable could be done like this:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0

NB: Reshacker.exe must be copied into the script directory for this to work.

If you then want to use the resources in your code, there is an excellent Resources UDF which will allow you to access the resources from within the exe.

Adding Original Source Code

When using the above tip on stripping excess code, the new source is not readable. As a result, using the standard directive for saving the source:

#AutoIt3Wrapper_Res_SaveSource=y

Would add the obfuscated code to the exe, which is not the desired result. The solution is to add it in manually. This code does not require any editing, so you can just copy and paste it in:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, %scriptfile%.au3, RCDATA, SOURCE, 0

Creating a Version Directory

When compiling, it is very possible that you want to go back to a previous version. If so, then it is neat to have a directory which will store all previous builds, without the need for you to manually copy and paste every time! Make sure you add these directives in last (after adding resources) as they might not be included in the copied result.

#AutoIt3Wrapper_Run_After=md "%scriptdir%\Versions\%fileversion%"
#AutoIt3Wrapper_Run_After=copy "%in%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.au3"
#AutoIt3Wrapper_Run_After=copy "%out%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.exe"

Running the exe on Build

Often you are building as a test, so to have to open up Windows Explorer to get the exe is a pain, furthermore, unless you have a program to do it (or it's a console program) you will not be able to read console info such as the debug messages you put in the exe. The solution is simple:

#AutoIt3Wrapper_Run_After="%out%"

This will run the program and read the console output to the SciTE debug frame.

Extended Reshacker Info

ResHacker doesn't always return with a return code (rc) of not 0 if it fails, to get that info you need to read the ResHacker.log file that is created. This is also pretty simple to do:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
#AutoIt3Wrapper_Run_After=TYPE ResHacker.log

The new output now looks like this:

>Running:ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended   rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:26:22]
ResHacker.exe  -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
 Added: BITMAP,RESOURCENAME,0

Commands completed
>TYPE ResHacker.log Ended   rc:0

And an example of it showing an error:

>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended   rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:32:10]
ResHacker.exe  -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Error: "MyPicture.bmp" does not exist
>TYPE ResHacker.log Ended   rc:0

As you can see, Reshacker on its own returns rc: 0, usually indicating no error. This would have gone completely unnoticed except for the log file, which shows the error and an explanation.

Other Run_After and Run_Before Commands

You can use any commands you like in the Run_After and Run_Before directives. Examples such as "TYPE" have been shown above.

For a more complete list the following website is very useful: An A-Z Index of the Windows CMD Line

Other Wiki Pages

Adding Utilities to the SciTE Tools Menu

Adding UDFs to AutoIt and SciTE

Useful Lua links and scripts

SciTELua

http://www.lua.org/

Programming in Lua

http://lua-users.org/wiki/

http://lua-users.org/wiki/SciteScripts

http://lua-users.org/wiki/SampleCode

AU3Forum: mouse-hover-call-tips

AU3Forum: scite-lua-tool-to-make-string-variable-from-selected-text