HiEdit

HiEdit is a multitabbed, ultra fast, large file edit control consuming very little memory. It can display non-printable characters in a readable format and can be used for any general purpose editing of text and birary files.

Irrespective of the file size, the memory used at file loading never exceeeds 1024K. After the file is loaded, max memory used at any time is 128K.

(See HiEdit.png)

Summary

HiEdit	HiEdit is a multitabbed, ultra fast, large file edit control consuming very little memory.
Add	Add control to the parent.
AutoIndent	Sets the autoindent state
CanPaste	Determines whether a HiEdit control can paste a specified clipboard format.
CanRedo	Returns TRUE if the HiEdit control can do Redo operation.
CanUndo	Returns TRUE if the HiEdit control can correctly do Undo operation.
CloseFile	Close file or all files
Clear	Clear.
CharFromPos	Gets information about the character closest to a specified point in the client area of the Edit control.
ConvertCase	Convert case of selected text
Copy	Copy.
Cut	Cut.
EmptyUndoBuffer	Resets the undo flag in the HiEdit control for the current file.
FindText	Find desired text in the control
GetColors	Get the control colors.
GetCurrentFile	Get the index of the current file.
GetFileCount	Returns count of open files.
GetFileName	Get the file path.
GetFirstVisibleLine	Returns the zero-based index of the uppermost visible line.
GetLastVisibleLine	Returns the zero-based line index of the last visible (including partially displayed) line on the HiEdit control.
GetLine	Get the text of the desired line from the control.
GetLineCount	Returns an integer specifying the number of lines in the HiEdit control.
GetModify	Gets the state of the modification flag for the HiEdit control.
GetRedoData	Returns redo type and/or data for desired redo level.
GetRect	Gets the formatting rectangle of the HiEdit control.
GetSel	Get letfmost and/or rightmost character positions of the selection.
GetSelText	Returns selected text.
GetTextLength	Returns the length of text, in characters.
GetTextRange	Get range of characters from the control
GetUndoData	Returns undo type and/or data for desired undo level.
LineFromChar	Returns line number of the line containing specific character index.
LineIndex	Returns the character index of the line.
LineLength	Returns the lenght of the line.
LineNumbersBar	Sets the line numbers bar state and looks.
LineScroll	Scrolls the text in the HiEdit control for the current file.
NewFile	Opens new tab.
OpenFile	Open file in new tab
Paste	Paste.
PosFromChar	Gets the client area coordinates of a specified character.
Redo	Do redo operation
ReloadFile	Reload file
ReplaceSel	Replace selection with desired text
SaveFile	Save file to disk
Scroll	Scrolls the text vertically in the HiEdit control for the current file.
ScrollCaret	Scroll content of control until caret is visible.
SetColors	Set the control colors
SetCurrentFile	Set the current file.
SetEvents	Set notification events.
SetFont	Sets the control font
SetKeywordFile	Set syntax highlighting.
SetModify	Sets or clears the modification flag for the current file.
SetSel	Set the selection
SetTabWidth	Sets the tab width
SetTabsImageList	Sets the image list of the tab navigation toolbar.
ShowFileList	Show popup menu containg list of open files.
Undo	Do undo operation
Syntax Coloring	The file .hes is structured in sections, each of which specify the keywords for a one (or more) file extension.
Examples
About

Add

HE_Add( HParent,
X,
Y,
W,
H,
Style = "",
DllPath = "" )

Add control to the parent.

Parameters

X..H	Position of the control.
Style	Space separated list of control styles, by default both scroll bars are visible. You can use numbers or style strings.
DllPath	Path of the control dll, by default control is searched in the current folder.

Styles

HSCROLL, VSCROLL, TABBED, HILIGHT, TABBEDBTOP, TABBEDHRZSB, TABBEDBOTTOM

AutoIndent

HE_AutoIndent( hEdit,
pState )

Sets the autoindent state

Parameters

pState

TRUE or FALSE

CanPaste

HE_CanPaste( hEdit,
ClipboardFormat = 0x1 )

Determines whether a HiEdit control can paste a specified clipboard format.

Parameters

ClipboardFormat

The default is 0x1 (CF_TEXT).

Returns

TRUE if the clipboard format can be pasted otherwise FALSE.

Remarks

The HiEdit control supports the standard clipboard text formats -- CF_TEXT, CF_OEMTEXT, CF_UNICODETEXT (for Windows versions that support Unicode), and CF_LOCALE (used by the OS to implicitly convert from CF_TEXT to CF_UNICODETEXT). If any application copies text of any type to the clipboard, it will usually copy the text to one (usually all, depending on the OS) of these clipboard formats.

For additional information on clipboard formats, see the following

http://msdn.microsoft.com/en-us/library/ms649013(VS.85).aspx

Bugs

Despite the HiEdit documentation, sending zero as the clipboard format never returns a non-zero (can paste) value regardless of the contents of the clipboard.

CanRedo

HE_CanRedo( hEdit )

Returns TRUE if the HiEdit control can do Redo operation.

CanUndo

HE_CanUndo( hEdit )

Returns TRUE if the HiEdit control can correctly do Undo operation.

CloseFile

HE_CloseFile( hEdit,
idx = -1 )

Close file or all files

Parameters

idx	Index of the file to close. -2 to close ALL opened files, -1 to close current file (default)

Clear

HE_Clear( hEdit )

Clear.

CharFromPos

HE_CharFromPos( hEdit,
X,
Y )

Gets information about the character closest to a specified point in the client area of the Edit control.

Parameters

X, Y	The coordinates of a point in the Edit control’s client area relative to the upper-left corner of the client area.

Returns

The character index of the specified point or the character index to the last character if the given point is beyond the last character in the control.

ConvertCase

HE_ConvertCase( hEdit,
case = "toggle" )

Convert case of selected text

Parameters

case	Can be “upper”, “lower”, “toggle” (default), “capitalize”.

Returns

Returns TRUE if successful, FALSE otherwise

Copy

HE_Copy( hEdit )

Copy.

Cut

HE_Cut( hEdit )

Cut.

EmptyUndoBuffer

HE_EmptyUndoBuffer( hEdit )

Resets the undo flag in the HiEdit control for the current file.

FindText

HE_FindText( hEdit,
sText,
cpMin = 0,
cpMax = -1,
flags = "" )

Find desired text in the control

Parameters

sText	Text to be searched for.
cpMin	Start searching at this character position. By default 0.
cpMax	End searching at this character position. By default -1.
flags	Space separated combination of search flags: “WHOLEWORD” “MATCHCASE”

Returns

The zero-based character position of the next match, or -1 if there are no more matches.

GetColors

HE_GetColors( hEdit )

Get the control colors.

Returns

Colors in INI format. See SetColors for details.

GetCurrentFile

HE_GetCurrentFile( hEdit )

Get the index of the current file.

GetFileCount

HE_GetFileCount( hEdit )

Returns count of open files.

GetFileName

HE_GetFileName( hEdit,
idx = -1 )

Get the file path.

Parameters

idx	Index of the file. -1 to get file path of the current file (default)

Returns

TRUE if successful, FALSE otherwise

GetFirstVisibleLine

HE_GetFirstVisibleLine( hEdit )

Returns the zero-based index of the uppermost visible line.

GetLastVisibleLine

HE_GetLastVisibleLine( hEdit )

Returns the zero-based line index of the last visible (including partially displayed) line on the HiEdit control.

Remarks

To calculate the total number of visible lines, use the following:

HE_GetLastVisibleLine(hEdit) - HE_GetFirstVisibleLine(hEdit) + 1

GetLine

HE_GetLine( hEdit,
idx = -1 )

Get the text of the desired line from the control.

Parameters

idx	Zero-based index of the line. -1 means current line.

Returns

The return value is the text. The return value is empty string if the line number specified by the line parameter is greater than the number of lines in the HiEdit control

GetLineCount

HE_GetLineCount( hEdit )

Returns an integer specifying the number of lines in the HiEdit control. If no text is in the HiEdit control, the return value is 1.

GetModify

HE_GetModify( hEdit,
idx = -1 )

Gets the state of the modification flag for the HiEdit control. The flag indicates whether the contents of the control has been modified.

Parameters

idx	Index of the file. -1 for the current file (default).

Returns

TRUE if the content of HiEdit control has been modified, FALSE otherwise.

GetRedoData

HE_GetRedoData( hEdit,
level )

Returns redo type and/or data for desired redo level. The same rules as in GetUndoData.

GetRect

HE_GetRect( hEdit,
ByRef Left = "",
ByRef Top = "",
ByRef Right = "",
ByRef Bottom = "" )

Gets the formatting rectangle of the HiEdit control.

Parameters

Left..Bottom

Output variables, can be omitted.

Returns

Space separated rectangle.

GetSel

HE_GetSel( hEdit,
ByRef start_pos = "@",
ByRef end_pos = "@" )

Get letfmost and/or rightmost character positions of the selection.

Parameters

start_pos	Optional starting position of the selection.
end_pos	Optional ending position of the selection.

Returns

Starting position.

GetSelText

HE_GetSelText( hEdit )

Returns selected text.

GetTextLength

HE_GetTextLength( hEdit )

Returns the length of text, in characters.

GetTextRange

HE_GetTextRange( hEdit,
min = 0,
max = -1 )

Get range of characters from the control

Parameters

min	Index of leftmost characther of the range. By default 0.
max	Index of rightmost characther of the range. -1 means last character in the control.

GetUndoData

HE_GetUndoData( hEdit,
level )

Returns undo type and/or data for desired undo level.

Parameters

level

Undo level.

Types

UNKNOWN	The type of undo action is unknown.
TYPING	Typing operation.
DELETE	Delete operation.
DRAGDROP	Drag-and-drop operation.
CUT	Cut operation.
PASTE	Paste operation.
SETTEXT	WM_SETTEXT message was used to set the control text
REPLACESEL	EM_REPLACESEL message was used to insert text
CLEAR	Delete selected text
BACKSPACE	Back Space Operation
INDENT	Increase Indent
OUTDENT	Decrease Indent
CODEPAGE	Convert codepage
CASE	Convert case

LineFromChar

HE_LineFromChar( hEdit,
ich )

Returns line number of the line containing specific character index.

Parameters

ich

The character index of the character contained in the line whose number is to be retrieved. If the ich parameter is -1, either the line number of the current line (the line containing the caret) is retrieved or, if there is a selection, the line number of the line containing the beginning of the selection is retrieved.

Returns

The zero-based line number of the line containing the character index specified by ich.

LineIndex

HE_LineIndex( hedit,
idx = -1 )

Returns the character index of the line.

Parameters

idx	Line number for which to retreive character index. -1 (default) means current line.

Returns

The character index of the line specified in the idx parameter, or -1 if the specified line number is greater than the number of lines.

LineLength

HE_LineLength( hEdit,
idx = -1 )

Returns the lenght of the line.

Parameters

idx	Line number for which to retreive line length. -1 (default) means current line.

Returns

the length, in characters, of the line

LineNumbersBar

HE_LineNumbersBar( hEdit,
state = "show",
linw = 40,
selw = 10 )

Sets the line numbers bar state and looks.

Parameters

state	Can be “show”, “hide”, “automaxsize”, “autosize”
linw	Line numbers width (by default 40)
selw	Selection bar width (by default 10)

LineScroll

HE_LineScroll( hEdit,
xScroll = 0,
yScroll = 0 )

Scrolls the text in the HiEdit control for the current file.

Parameters

xScroll	The number of characters to scroll horizontally. Use a negative number to scroll to the left and a positive number to scroll to the right.
yScroll	The number of lines to scroll vertically. Use a negative number to scroll up and a positive number to scroll down.

Remarks

This message does not move the caret.

The HiEdit control does not scroll vertically past the last line of text in the control. If the current line plus the number of lines specified by the yScroll parameter exceeds the total number of lines in the HiEdit control, the value is adjusted so that the last line of the HiEdit control is scrolled to the top of the HiEdit control window.

This function can be used to scroll horizontally past the last character of any line.

NewFile

HE_NewFile( hEdit )

Opens new tab.

OpenFile

HE_OpenFile( hEdit,
pFileName,
flag = )

Open file in new tab

Parameters

pFileName	Path of the file to be opened
flag	Set to TRUE to create new file if pFileName doesn’t exist. If set to FALSE, function fails if the file doesn’t exist (default). Returns: TRUE if successful/FALSE otherwise

Paste

HE_Paste( hEdit )

Paste.

PosFromChar

HE_PosFromChar( hEdit,
CharIndex,
ByRef X,
ByRef Y )

Gets the client area coordinates of a specified character.

Parameters

CharIndex	The zero-based index of the character.
X, Y	These parameters, which must contain valid variable names, are used to return the x/y-coordinates of a point in the HiEdit control’s client relative to the upper-left corner of the client area.

Remarks

If CharIndex is greater than the index of the last character in the control, the returned coordinates are of the position just past the last character of the control.

Redo

HE_Redo( hEdit )

Do redo operation

Returns

TRUE if the Redo operation succeeds, FALSE otherwise

ReloadFile

HE_ReloadFile( hEdit,
idx = -1 )

Reload file

Parameters

idx	Index of the file to reload. -1 to reload current file (default)

ReplaceSel

HE_ReplaceSel( hEdit,
text = "" )

Replace selection with desired text

Parameters

text	Text to replace selection with.

SaveFile

HE_SaveFile( hEdit,
pFileName,
idx = -1 )

Save file to disk

Parameters

pFileName	File name.
idx	Index of the file to save. -1 to save current file (default)

Returns

TRUE if successful, FALSE otherwise

Scroll

HE_Scroll( hEdit,
Pages = 0,
Lines = 0 )

Scrolls the text vertically in the HiEdit control for the current file.

Parameters

Pages	The number of pages to scroll. Use a negative number to scroll up and a positive number to scroll down.
Lines	The number of lines to scroll. Use a negative number to scroll up and a positive number to scroll down.

Returns

The number of lines that the command scrolls. The number returned may not be the same as the actual number of lines scrolled if the scrolling moves to the beginning or the end of the text.

Remarks

This message does not move the caret. 0x7FFFFFFF = 2147483647 = largest possible 32-bit signed integer value

Despite the documentation, the return value for the message always reflects the request, not necessarily the actual number of lines that were scrolled. Example: If a request to scroll down 25 lines is made, 25 is returned even if the control is already scrolled down to the bottom of the document. [Bug?]

ScrollCaret

HE_ScrollCaret( hEdit )

Scroll content of control until caret is visible.

SetColors

HE_SetColors( hEdit,
colors,
fRedraw = true )

Set the control colors

Parameters

colors	Any subset of available color options in INI format (array of NAME=COLOR lines). Skiped colors will be set to 0.
fRdraw	Set to TRUE to redraw control

Colors

Text	Normal Text Color
Back	Editor Back Color
SelText	Selected Text Color
ActSelBack	Active Selection Back Color
InSelBack	Inactive Selection Back Color
LineNumber	Line Numbers Color
SelBarBack	Selection Bar Back Color
NonPrintableBack	0 - 31 special non printable chars
Number	Number Color

SetCurrentFile

HE_SetCurrentFile( hEdit,
idx )

Set the current file.

Parameters

idx	New file index to set as current.

SetEvents

HE_SetEvents( hEdit,
Handler = "",
Events = "selchange" )

Set notification events.

Parameters

Handler	Function that handles events. If empty, any existing handler will be removed.
Events	White space separated list of events to monitor (by default “selchange”).

Handler

Hwnd	Handle of the HiEdit that sends notification.
Event	Specifies event that occurred. Event must be registered to be able to monitor them. Events “tabmclick” and “filechange” are registered automatically.
EventInfo	Specifies event info.

Events & Infos

SelChange	S<start_char_idx> E<end_char_idx> L<line_num> [t\|] (t if tab changed, if text changed)
Key	key pressed
Mouse	x<mouse_x> y<mouse_y> v<virtual_key_code>
Scroll	””
ContextMenu	””
FileChange	<file_index> (file is changed outside of the application)
Tabmclick	”” (middle button click over tab)

Returns

The previous event mask (number).

SetFont

HE_SetFont( hEdit,
pFont = "" )

Sets the control font

Parameters

pFont

AHK font definition: “Style, FontName”

SetKeywordFile

HE_SetKeywordFile( pFile )

Set syntax highlighting.

Parameters

pFile

Path to .hes file

SetModify

HE_SetModify( hEdit,
Flag )

Sets or clears the modification flag for the current file. The modification flag indicates whether the text within the control has been modified.

Parameters

Flag	Set to TRUE to set the modification flag. Set to FALSE to clear the modification flag.

SetSel

HE_SetSel( hEdit,
nStart = 0,
nEnd = -1 )

Set the selection

Parameters

nStart	Starting character position of the selection. Set -1 to remov current selection.
nEnd	Ending character position of the selection. Set -1 to use position of the last character in the control.

SetTabWidth

HE_SetTabWidth( hEdit,
pWidth,
pRedraw = true )

Sets the tab width

Parameters

pWidth	Tab width in characters
pRedraw	Set to true to redraw control (default)

SetTabsImageList

HE_SetTabsImageList( hEdit,
pImg = "" )

Sets the image list of the tab navigation toolbar.

Parameters

pImg	BMP file with the image list. Omit this parameter to use default image list.

ShowFileList

HE_ShowFileList( hEdit,
X = 0,
Y = 0 )

Show popup menu containg list of open files.

Parameters

X, Y	Position of the popup window. Optional, by default 0.

Undo

HE_Undo( hEdit )

Do undo operation

Returns

TRUE if the Undo operation succeeds, FALSE otherwise

Syntax Coloring

File structure

The file .hes is structured in sections, each of which specify the keywords for a one (or more) file extension. Thus, a single .hes file can be used to specify the syntax highlight of several different file types.

Section structure

Each section starts with a list of file extensions, separated by a comma, enclosed in square brackets, for instance

[asm,inc]

starts a section for the keywords that will be applied to .asm and .inc files.

The lines following the section start will specify a color and the keywords to which it is applied in this form :

0x00bbggrr = keyword1 keyword2 keyword3 ...

the number is a DWORD in hexadecimal format
first byte specifies the type of keywords (00=normal, 01=separators).
rr, gg, bb specify the red green blue parts of the color (note the reverse order).
after the equal sign follow the list of keywords separated by a space.

Keyword specification

A ^ in front of keyword: the keyword is case sensitive.
A ~ in front of keyword: forces the specified case (display only).
A + at the end of keyword: all the rest of the line will be treated as a comment.
A - at the end of keyword: all the rest of the line will be treated as a string.
A & at the end of keyword: specify the enclosing characters for a string (ie. “& specifies “ as the string quotes, meaning that “string” is a string).
A ! at the end of any delimiter indicates that any word starting with this delimiter will be colored. For example, 0x00408080=$! indicates that any word starting with $ (such as php variables e.g. $somevar, $another etc) will be colored.

Comments

A line starting with ; is a comment and ignored by the syntax highlight parser.

Notes

The same file extension can be specified in up to nine (9) sections and all the keywords will be taken into account. This simplifies the management of keywords that are shared among different file types.
There is no limit on the number of languages, keywords and keyword groups.
You can specify a default syntax highlight for new, unsaved files by adding an “empty” extension between the square brackets at the beginning of the section. i.e. [,asm,inc] means that new files will have by default applied the syntax highlight of asm files.
See http://www.winasm.net/forum/index.php?showtopic=2161 for some syntax sections.

Example

This is an simplified example of a .hes syntax highlight file.

[asm,inc]
;Registers
0x00408080=~AH ~AL ~AX ~BH ~BL ~BH
;User instructions
0x008000ff=~AAA ~AAD ~AAM ~AAS ~ADC ~ADD

[rc]
;General statements
0x10000080=#define #include ACCELERATORS ALT AUTOCHECKBOX
;Object states
0x104080ff=^BS_3STATE ^BS_AUTO3STATE ^BS_AUTOCHECKBOX

Quick reference

[[,]ext1,ext2,...,extN]	Each keyword definiton block starts with list of extensions in angular brackets. If started with comma, this section will be used for coloring of new files.
0xSSRRGGBB=word1 .. wordN	Color keywords on this line with RRGGBB color. SS is 00 by default.
delimiters	High byte in the color (0x01xxxxxx) refers to delimiters. Delimiters are added from ALL sections for a file extension.
&	A & at the end of keyword specifies a string char. For ex. “& means that everything enclosed in two “ is a string
+	A + at the end of keyword specifies a comment char/keyword. For ex. //+ means that everything that follows is a comment. Multiline comments are not supported yet.
!	A ! at the end of any delimiter indicates that any word starting with this delimiter will be colored. For example $! marks php variables.
-	A - at the end of keyword specifies that ALL text up to the end of line will be painted using the color specified UNLESS a comment indicator is found.
~	A ~ in front of keyword forces the specified case (display only).
^	A ^ in front of keyword means that the keyword is case sensitive.
;	Line comment in hes file.

Examples

Gui, +LastFound
hwnd := WinExist()

hEdit := HE_Add(hwnd,0,0,600,500)
Gui, SHow, w600 h500

HE_SetKeywordFile( A_ScriptDir "\Keywords.hes")
HE_OpenFile( hEdit, A_ScriptFullPath )

About

HiEdit control is copyright of Antonis Kyprianou (aka akyprian). See http://www.winasm.net.
Available for NON commercial purposes provided you have previous line in your about box. You need author’s written permission to use HiEdit in commercial applications.
AHK wrapper version 4.0.0.4-5 by majkinetor.
Additonal functions and fixes by jballi.
AHK module licensed under BSD http://creativecommons.org/licenses/BSD/.