/usr/share/doc/ne/html/Basic-Macros.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>ne&rsquo;s manual: Basic Macros</title>

<meta name="description" content="ne&rsquo;s manual: Basic Macros">
<meta name="keywords" content="ne&rsquo;s manual: Basic Macros">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="Command-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Basics.html#Basics" rel="up" title="Basics">
<link href="More-Advanced-Features.html#More-Advanced-Features" rel="next" title="More Advanced Features">
<link href="Basic-Preferences.html#Basic-Preferences" rel="prev" title="Basic Preferences">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Basic-Macros"></a>
<div class="header">
<p>
Next: <a href="More-Advanced-Features.html#More-Advanced-Features" accesskey="n" rel="next">More Advanced Features</a>, Previous: <a href="Basic-Preferences.html#Basic-Preferences" accesskey="p" rel="prev">Basic Preferences</a>, Up: <a href="Basics.html#Basics" accesskey="u" rel="up">Basics</a> &nbsp; [<a href="Command-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Basic-Macros-1"></a>
<h3 class="section">2.6 Basic Macros</h3>
<a name="index-Macro-definition"></a>
<a name="index-Recording-a-macro"></a>
<a name="index-Saving-a-macro"></a>
<a name="index-Interrupting-a-macro"></a>
<a name="index-Interrupt-character"></a>
<a name="index-Caching-a-macro"></a>
<a name="index-Unloading-macros"></a>
<a name="index-Executing-a-macro"></a>
<a name="index-Comments-in-a-macro"></a>

<p>Very often, the programmer or the text writer has to repeat some complex
editing action over a series of similar blocks of text. This is where
<em>macros</em> come in.
</p>
<p>A <em>macro</em> is a stored sequence of commands. Any sequence of commands
you find yourself repeating is an excellent candidate for being made
into a macro. You could create a macro by editing a document that only
contains valid <code>ne</code> commands and saving it, but by far the easiest way to create
a macro is to have <code>ne</code> record your actions. <code>ne</code> allows you
to record macros and then play them (execute the commands they contain)
many times. You can save them on disk for future use, edit them, or bind
them to any key. You could even reconfigure each key of your keyboard to
play a complex macro if you wanted to.
</p>
<p><code>ne</code> can have any number of named macros loaded at the same time.
It can also have one unnamed macro in its <em>current macro</em> buffer.
The named macros are typically loaded from disk files, while the
current macro buffer is where your recorded macro is held before you
save it or record over it.
</p>
<p>Recording a macro is very simple. The keystroke <kbd><span class="key">Control</span>-T</kbd>
starts and stops recording a macro.  When you start recording a macro,
<code>ne</code> clears the <em>current macro</em> buffer and starts recording all
your actions (with a few exceptions). You can see that you are recording
a macro if an &lsquo;<samp>R</samp>&rsquo; appears on the status bar. After you stop the
recording process (again using <kbd><span class="key">Control</span>-T</kbd>), you can play the
macro with the &lsquo;<samp>Play Once</samp>&rsquo; item of the &lsquo;<samp>Macros</samp>&rsquo; menu or with
the <tt class="key">f9</tt> key. If you want to repeat the action many times, the
<code>Play</code> command allows you to specify a number of times to repeat
the macro. You can always interrupt the macro&rsquo;s execution with
<kbd><span class="key">Control</span>-\</kbd>.
</p>
<p>A recorded macro has no name. It&rsquo;s just an anonymous sequence of
commands in the <em>current macro</em> buffer, and it will go away when you
exit <code>ne</code> or record another macro. If you want to save your
recorded macro for future use, you can give it a name and save it with
the &lsquo;<samp>Save Macro...</samp>&rsquo; menu item or the <code>SaveMacro</code> command.
The macro is saved as a file in your current directory by default or
whatever directory you specify when prompted for the macro&rsquo;s name. If
you save it in your <samp>~/.ne</samp> directory then it will be easy to
access it later from any other directory. The &lsquo;<samp>Open Macro...</samp>&rsquo; menu item
and the <code>OpenMacro</code> command load a macro from a file into the
current macro buffer just as if you had just <code>Record</code>ed it.
</p>
<p>The current setting your your <code>VerboseMacros</code> flag determines whether
long or abbreviated command names are used when saving a macro. For your
convenience, <code>SaveMacro</code> will also convert sequences of
<code>InsertChar</code> commands into single&mdash;usually much more readable&mdash;
<code>InsertString</code> commands, but only if all the inserted characters are
simple printable characters, and only if there are no subsequent <code>Undo</code>
commands or macro invocations.
</p>
<p>Any macro can be loaded from a file and played with the &lsquo;<samp>Play Macro...</samp>&rsquo;
menu item or the <code>Macro</code> command. (This won&rsquo;t modify the recorded
anonymous macro that may be in the <em>current macro</em> buffer;
<code>OpenMacro</code> does that.) Useful macros can be permanently bound to a
keystroke as explained in <a href="Key-Bindings.html#Key-Bindings">Key Bindings</a>. Moreover, whenever a
command line does not specify one of <code>ne</code>&rsquo;s built in commands, it is
assumed to specify the name of a macro to execute. Thus, you can execute
macros just by typing their file names. Include a path if the macro
file&rsquo;s directory is different from your current directory or your
<samp>~/.ne</samp> directory.
</p>
<p>If the first attempt to open a macro fails, <code>ne</code> checks for a macro
with the given name in your <samp>~/.ne</samp> directory. This allows you
to program simple extensions to <code>ne</code>&rsquo;s language. For instance, all
automatic preferences macros&mdash;which are just specially named macros
that contain only commands to set preferences flags&mdash;can be executed
just by typing their names. For example, if you have an automatic
preference for the &lsquo;<samp>doc</samp>&rsquo; extension for example, you can set
<code>ne</code>&rsquo;s flags exactly as if you had loaded a file ending with
&lsquo;<samp>.doc</samp>&rsquo; by typing the command <code>doc#ap</code>.
</p>
<p>In general, it is a good idea to save frequently used macros in
<samp>~/.ne</samp> so that you can invoke them by name without specifying
a path regardless of your current directory. On the other hand, if you
have a macro that is customized for one document or a set of documents
that you store in one directory, then you might want to save the
macro in that directory instead. If you do, then you would want to
<code>cd</code> to that directory before you start <code>ne</code> so that you can
access that macro without specifying a path.
</p>
<p>If your macro has the same name as one of <code>ne</code>&rsquo;s built-in commands,
you can only access it with the <code>Macro <var>name</var></code> command.
Built-in command names are always searched before the <code>ne</code> command
interpreter looks for macros.
</p>
<p>The system administrator may make some macros available from
the <samp>macros</samp> subdirectory of <code>ne</code>&rsquo;s global directory. See <a href="Arguments.html#Arguments">Arguments</a>.
</p>
<p>Since loading a macro each time it is invoked would be a rather slow and
expensive process, once a macro has been executed it is cached internally.
Subsequent invocations of the macro will used the cached version.
</p>
<p><strong>Warning:</strong> while path and file names are case sensitive
when initially loading macros, loaded macro names are <em>not</em> case
sensitive or path sensitive. <code>ne</code> only caches the file name of an
already loaded macro, not the path, and uses a case insensitive
comparison when resolving command names. As such, if you invoke <samp>~/foobar/MyMacro</samp>, <code>ne</code>
remembers it with the case-insensitive name <samp>mymacro</samp>; a subsequent
call for <samp>/usr/MYMACRO</samp> will instead find and use the cached version
of <samp>~/foobar/MyMacro</samp>. You can clear the cache by using the
<code>UnloadMacros</code> command. See <a href="UnloadMacros.html#UnloadMacros">UnloadMacros</a>.
</p>
<p>The behaviour of macros may vary with different preferences. If the user
changes the AutoIndent and WordWrap flags, for example, new lines and new
text may not appear in the same way they would have when a macro was
recorded. Good general purpose macros avoid such problems by using the
<code>PushPrefs</code> command first. This preserves the user&rsquo;s preferences.
Then they set any preferences that could affect their behaviour. Once
that is taken care of they get on with the actual work for which they
were intended. Finally, they use the <code>PopPrefs</code> command to restore
the user&rsquo;s preferences. Note that if a macro is stopped before it
restores the preferences (either by the user pressing
<kbd><span class="key">Control</span>-\</kbd> or by a command failing) then dealing with the
changed preferences falls to the user.
</p>
<p>Any changes made to a document by a macro are recorded just as if you had
entered the commands yourself. Therefore you can use the <code>Undo</code> command
to roll back those changes one at a time. This can be useful especially when
developing macros, but you may want to be able to undo all the changes made
by a macro with a single <code>Undo</code> command. The <code>AtomicUndo</code> command
makes this possible. If you add <code>AtomicUndo +</code> at the start of your
macro and <code>AtomicUndo -</code> at the end, then the <code>Undo</code> and
<code>Redo</code> commands will handle all changes made by your macro atomically,
i.e., as if they had been made by a single command, even if your macro
calls other macros which could themselves contain matching <code>AtomicUndo +</code>
and <code>AtomicUndo -</code> commands. See <a href="AtomicUndo.html#AtomicUndo">AtomicUndo</a>.
</p>
<p>Finally, any line in a macro that starts with a non-alphabetical character
is considered a comment, so you can add comments to a macro by starting
a line with &lsquo;<samp>#</samp>&rsquo;.
</p>
<hr>
<div class="header">
<p>
Next: <a href="More-Advanced-Features.html#More-Advanced-Features" accesskey="n" rel="next">More Advanced Features</a>, Previous: <a href="Basic-Preferences.html#Basic-Preferences" accesskey="p" rel="prev">Basic Preferences</a>, Up: <a href="Basics.html#Basics" accesskey="u" rel="up">Basics</a> &nbsp; [<a href="Command-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
ne-doc 3.0.1-2build1 / usr / share / doc / ne / html / Basic-Macros.html
