Category : Miscellaneous Language Source Code
Archive   : E!518.ZIP
Filename : MACGEN.DOC

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ ³
³ MACGEN 5.0 ³
³ ³
³ E! macro editor / generator ³
³ ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ


(c) Patrick Philippot - 1987,88,89



INTRODUCTION
____________

Macgen is a utility converting existing E! macros to editable
script files which may then be converted to macros again. So you
will easily modify an existing macro or create a new one.


SYNTAX
______

c:\e!> macgen s|m macfile scriptfile

The "s" option means you want to convert the existing macro
(macfile) into a script file.

The "m" option means you want to convert an existing or
modified script file into an E! macro.

WARNING : the target file will be either macfile (m) or
scriptfile (s). This file will always be overwritten.

macfile is the macro file name and takes a default .MAC
extension.

scriptfile is the script file name and takes a default .SCR
extension.

EXAMPLES:

macgen s mymacro.mac mymacro

converts an existing macro (mymacro.mac) into a script file
(mymacro.scr). If it exists mymacro.scr will be overwritten.

macgen m mymacro mymacro.scr

converts the script file (mymacro.scr) into an excutable E!
macro (mymacro.mac).

macgen s mymacro mymacro

is the same as the first example.


USING MACGEN
____________

A script file is a text file made up of lines. Each line
contains only one command. A command is either

- a mnemonic between square brackets representing a specific E!
function. Mnemonics are listed below.

Ex: [SORT] (code 290 : sort the marked block)

- a character string without square brackets but eventually with
quotes. In this case the string will be directed to the E! functions
dispatcher exactly as if you typed it from the keyboard.

Here is a short example of a script file :

[COMMANDMODE] macro begins in command mode
[TEXT_BEGIN] go to text beginning
[TEXT_BEGIN]
=/begin/BEGIN/* enter a search command
[ENTER]
[CONTINUE] continue mark
[TEXT_BEGIN]
[TEXT_BEGIN] etc...
=/end/END/*
[ENTER]
[CONTINUE]
[TEXT_BEGIN]
[TEXT_BEGIN]
=/if/IF/*
[ENTER]

On a script line containing a mnemonic, the first non blank
character must be a left square bracket. All text not included within
the brackets is ignored. So you may freely comment your commands.

For non mnemonic commands, all the text available is sent to E!
except the leading and trailing blanks. If you use quotes leading and
trailing blanks will be taken into account.

If MACGEN detects an error it will issue an error message and
stop. It will eventually display the line containing the error.

The first line of a script file must be either [COMMANDMODE] or
[EDITMODE].

Commands may be either uppercase or lowercase.

Please see E! documentation on macros.


MNEMONICS LIST
______________


Function code Mnemonic Function


001 [ALIGN_TEXT] Align text to cursor
002 [PASCAL_STYLE] See documentation (Ctrl B)
003 [CLEAR_LINE] Clear line
004 [REPEAT_CHAR] Repeat specified character
005 [CLEAR_EOL] Erase end of line
006 [WRAP] Toggle Wordwrap
007 [43_LINES] Toggle 35/43/50 lines mode
008 [DELETE_LEFT] Delete left character
009 [NEXT_TAB] Go to next tab
010 [JUSTIFICATION] Toggle justify mode
012 [EDIT] Edit a file
013 [ENTER] Insert a line or validate a command
014 [INSERT_NAME] Insert filename
016 [MACRO] Execute active macro
017 [RESTORE_MACRO] Restore previous macro
019 [REPEAT_SEARCH] Repeat last search
020 [INSERT_DATE] Insert date and time
022 [INIT_SEARCH] Initialize search variables
023 [DEL_WORD] Delet current word
024 [EXECUTE] Execute current line as a command
026 [LIST_DIR] List current line as a directory
027 [CHANGE_MODE] Toggle between editmode and commandmode
127 [REMOVE_LINE] Remove current line
271 [PREV_TAB] Go to previous tab
272 [CONTINUE] Insert a continue-mark in macro
273 [WORD_MARK] Mark the current word
274 [END_OF_BLOCK] Go to end of block
275 [REMOVE_TAB] Remove current tab position
276 [RECORD_TAB] Create a new tab positioneur
277 [BLOCK_BEGIN] Go to block begin
278 [UNMARK] Unmark block
279 [REMOVE_TABS] Remove all tab positions
280 [OVERLAY] Overlay block at cursor position
281 [PARAGRAPH] Go to next paragraph
286 [ADJUST] Adjust block position
287 [SPLIT] Split line at cursor
288 [DELETE_BLOCK] Delete marked block
289 [FILL_BLOCK] Fill block with specified character
290 [SORT] Sort block
291 [BOX] Draw a box around the block
292 [JOIN] Join current line and next line
293 [BOOKMARK] Drop bookmark
294 [LINE_MARK] Mark lines
300 [SENTENCE_MARK] Mark sentences
301 [GRAPHICS] Toggle control characters access
302 [COPY_BLOCK] Copy block to cursor position
303 [REMOVE_SPACES] Remove trailing blanks
304 [BLOCK_MARK] Mark block
306 [MOVE_BLOCK] Move block
315 [HELP] Load help file
316 [SAVE] Save current file
317 [QUIT] Quit current file
318 [QUIT_SAVE] Quite and save current file
319 [WINDOW] Create/Remove window
320 [DRAW] Toggle draw mode


321 [NAME] Name current file
322 [LOAD] Edit a new file
323 [RESTORE] Restore (undo) current line
324 [NEXT] Go to next file
327 [LINE_BEGIN] Go to line begin
328 [UP] Up
329 [PREV_PAGE] Scroll screen up
331 [LEFT] Left
333 [RIGHT] Right
335 [EOL] Go to end of line
336 [DOWN] Down
337 [NEXT_PAGE] Scroll screen down
338 [TOGGLE_INSERT] Toggle insert mode
339 [DEL_CHAR] Delete character at cursor
340 [SCROLL_RIGHT] Scroll right
341 [SCROLL_LEFT] Scroll left
342 [SCROLL_UP] Scroll up
343 [SCROLL_DOWN] Scroll down
344 [CENTER_LINE] Center line in window
345 [RAISE_LINE] Raise line to top of window
346 [CLEAR_WINDOWS] Delete all windows
350 [UPCASE_WORD] Upcase word
351 [LOWCASE_WORD] Lowcase word
352 [UPCASE_BLOCK] Upcase block
353 [LOWCASE_BLOCK] Lowcase block
354 [CENTER_BLOCK] Center text in block
355 [FORMAT_PAR] Format paragraph
356 [FORMAT_BLOCK] Format paragraphs within block
360 [KEYHELP] Key oriented help
362 [PAGE_RIGHT] Scroll page right
363 [PAGE_LEFT] Scroll page left
364 [CHANGE_WINDOW] Change active window
365 [DELETE_WINDOW] Delete next window
366 [ZOOM] Zoom / Unzoom active window
367 [NEXT_ERROR] Go to next compilation error
368 [PREV_ERROR] Go to previous compilation error
369 [PREVIOUS] Go to previous file
371 [PREV_WORD] Go to previous word
372 [NEXT_WORD] Go to next word
373 [TEXT_END] Go to end of text
374 [PAGE_BOTTOM] Go to bottom of window
375 [TEXT_BEGIN] Go to text begin
376 [TEXTMARK1] Drop text mark 1
377 [TEXTMARK2] Drop text mark 2
378 [TEXTMARK3] Drop text mark 3
379 [UNMARK_TEXTS] Remove text marks
380 [REFRESH] Reload (refresh) original file
381 [PAIRED_BRACE] See documentation
382 [MATCH_BRACE] See documentation
383 [UNDO] Restore removed lines
384 [INSERT_DOS] Insert captured lines (DOS SHELL)
385 [SEARCH_WORD] Search current word
386 [INSERT_BLOCK] Insert blanks before block
387 [INSERT_BLANK] Insert blanks without moving cursor
388 [PAGE_TOP] Go to top of window
423 [INPUT_PAUSE] Insert Input Pause in macro