home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 5 Edit
/
05-Edit.zip
/
pmeditor.zip
/
RSEDOC.TXT
< prev
next >
Wrap
Text File
|
1990-06-15
|
61KB
|
1,651 lines
RimSTAR Programmer's Editor
for OS/2 Presentation Manager
PRELIMINARY USER GUIDE
Copyright (C) 1990 by RimSTAR Technology. All rights reserved.
Reproduction or redistribution by any means is a violation of
applicable law.
Rimstar is a trademark of Rimstar Technology.
IBM, OS/2, PM, Presentation Manager are trademarks or registered
trademarks of International Business Machines Corp.
BRIEF is a registered trademark of Underware, Inc.
TABLE OF CONTENTS
Introduction . . . . . . . . . . . . . . . . . . . . . . . . 1
Installing the Editor . . . . . . . . . . . . . . . . . . . 3
Buffering and Windowing Concepts . . . . . . . . . . . . . 5
Windowing behavior . . . . . . . . . . . . . . . . . . . . . 6
Starting the Editor . . . . . . . . . . . . . . . . . . . . 7
Using a Mouse . . . . . . . . . . . . . . . . . . . . . . . 8
Supplied Key Mappings (Bindings) . . . . . . . . . . . . . . 9
Syntax of Keyboard Definition File . . . . . . . . . . . . . 9
Dynamic assignment of Accelerator Keys to Pulldown Menu
Items . . . . . . . . . . . . . . . . . . . . . . . . . 10
Configuring the Editor . . . . . . . . . . . . . . . . . . . 11
Saving and Restoring the state of the editor . . . . . . . . 11
File Action Bar Choices . . . . . . . . . . . . . . . . . . 13
New . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Open . . . . . . . . . . . . . . . . . . . . . . . . . 14
Next . . . . . . . . . . . . . . . . . . . . . . . . . 14
Previous . . . . . . . . . . . . . . . . . . . . . . . 14
Save . . . . . . . . . . . . . . . . . . . . . . . . . 14
Save as . . . . . . . . . . . . . . . . . . . . . . . . 14
Compile . . . . . . . . . . . . . . . . . . . . . . . . 15
Delete . . . . . . . . . . . . . . . . . . . . . . . . 15
Print . . . . . . . . . . . . . . . . . . . . . . . . . 15
Exit . . . . . . . . . . . . . . . . . . . . . . . . . 15
Edit Action Bar Choices . . . . . . . . . . . . . . . . . . 17
Undo . . . . . . . . . . . . . . . . . . . . . . . . . 17
Redo . . . . . . . . . . . . . . . . . . . . . . . . . 18
Search Action Bar Choices . . . . . . . . . . . . . . . . . 19
Replace Action Bar Choices . . . . . . . . . . . . . . . . . 19
Regular Expression Syntax . . . . . . . . . . . . . . . . . 21
Window Action Bar Choices . . . . . . . . . . . . . . . . . 23
Option Action Bar Choices . . . . . . . . . . . . . . . . . 25
Associating a Program with a File Extension . . . . . . . . 27
Compiling Within the Editor . . . . . . . . . . . . . . . . 31
Jumping to Errors in the Source File . . . . . . . . . . . . 33
The Virtual Memory System . . . . . . . . . . . . . . . . . 35
Getting HELP . . . . . . . . . . . . . . . . . . . . . . . . 35
LIST OF ALL FUNCTIONS WHICH CAN BE BOUND TO KEYS . . . . . . 37
BRIEF Key Mapping Quick Reference . . . . . . . . . . . . . 43
Introduction
This is a pre 1.0 version of the RimSTAR PM Programmer's Editor
for OS/2 Version 1.2 or later.
All registered users will receive free upgrades to the Version
1.0 release. This includes complete printed user documentation.
Interim releases will be made available free via BIX (Byte
Information Exchange) or for the cost of materials & shipping
(approx. $5.00). Bug fixes are supplied at no charge.
Features not available in this release:
Extension language (macro language)
User coded dynamic link library extensions
Code folding
Template editing & smart indenting
Version 1.0's planned release date is July 1990.
Technical support is available Monday-Friday 9:00am - 6:00pm
EST. Call 1-617-925-2718. There are no charges for technical
support. Please have the serial number printed on the master
disk available when you call.
If you are a BIX user you may e-mail support questions to
'rimstar' We plan to have a dedicated conference on BIX in the
future for on-line technical support.
Please register your copy(s). We will not be able to
provide upgrades if you have not registered.
We solicit your requests for features, bug reports, and any
comments you may have. We want you to be a satisfied customer
and we will do all we can to assist you. Thank you for selecting
RimSTAR for your programmer's editor.Installing the Editor
The distribution disk contains the following files:
R.EXE - Editor executable
RSFONTS.FON - Custom RimStar font(s) (only 1 for now)
KEYCOMP.EXE - Keyboard definition compiler
NEWKEY.CMD - Batch file which invokes KEYCOMP.EXE on
RSE.KEY to produce RSE.KBD
RSE.KEY - Keyboard definitions for BRIEF keyboard
layout.
RSE.KBD - Compiled version of RSE.KEY
RSE.HLP - Help library
RSE_CFG.INI - Configuration file (sample)
Installing the editor is straightforward.
1) Copy the files on the distribution disk to the directory of
your choice, we suggest \RSE.
2) Copy RSFONTS.FON to C:\OS2\DLL or let the CONTROL PANEL do
it. Install RSFONTS.FON using the CONTROL PANEL. Set your
PATH statement to include the directory in which R.EXE is
located. Note the keyboard file RSE.KBD must reside in the
same subdirectory as R.EXE.
RSFONTS.FON is not required, it is a small font that gives
you 40 lines in a maximized window in VGA mode. By default
Courier 8 is selected, the configuration file saves the
current font selection when written. If no fixed size font
is available the editor will give you an error message and
exit. If this occurs install the COURIER font (supplied
with OS/2) or the RimSTAR font.
3) Copy RSE.HLP to C:\OS2\HELP or one of the directories
specified in the HELP environment variable in the CONFIG.SYS
file. ( HELP=C:\OS2\HELP is placed in CONFIG.SYS when you
installed OS/2.)
The HELP system is incomplete in this release. If you are
familiar with BRIEF's keyboard layout you should have very
little trouble coming up to speed. Take a look at the
RSE.KEY file, there are a couple of changes to the key
bindings but nothing major, except for Alt+F10 to compile
within the editor being changed to SHIFT+F10.
Of course you can customize the keyboard any way you like.
See RSE.KEY for a description of the key definition syntax.
RSE.KEY also contains the default keyboard configuration
(BRIEF).
4) Add the directory path to R.EXE to your PATH environment
variable in CONFIG.SYS.Buffering and Windowing Concepts
A buffer is the term used to describe a file which has been
loaded into the editor. Some buffers are temporary and are not
associated with a file that resides on disk (eg. compiler
output). A buffer is the editable entity in the editor.
A window displays the contents of a specific buffer. The
buffer is said to be "attached" to the window.
The current window is the window which PM considers the
active window.
The current buffer is the buffer attached to the current
window.
A buffer does not have to be attached to a window.
A window always has a buffer attached to it.
The same buffer can be attached to multiple windows.
Undo/redo information is retained for each buffer.
The current marking state is retained for a buffer not a
window.
You may have one window with many buffers loaded. The
window displays only the current buffer. You can rotate the
buffers through a window using the Next/Previous Buffer commands.
You may have multiple windows and only one buffer. You can
change the current window by using the Next/Previous Window
commands.
You can have multiple windows and multiple buffers. Each
window can change the buffer associated with that window using
the Next/Previous Buffer commands or by selecting a buffer by
name from the "File" pulldown menu, which contains a list of all
available buffers.
Untitled buffers created with the "New" command must be
renamed before you can save them to disk.
Buffers created by the editor to hold output from programs
executed by the editor can not be renamed or saved to disk. If
you want to save the information in one of these buffers copy it
to a "normal" buffer.Windowing behavior
The initial window is sized to fill the main window's client
area unless the editor state is restored, or the Keep tiled or
Keep cascaded options are set in the config file.
Keep tiled or Keep cascaded maintain the tiling or cascaded
state when you create or delete a window. They do not interfere
with you sizing the windows individually, until you create or
delete a window or resize the main window. These settings are
saved in the state restore file so they will be restored when you
invoke the editor without command line arguments and you have
"Save Editor State" enabled. They are also saved along with the
state of "Open In Current Window" setting (set in the Open File
dialog box) to the RSE_CFG.INI file when you permanently save the
global settings, .
"Duplicating" a window will exactly copy the size and
position of the current window, unless Keep tiled or Keep
cascaded is in effect.
Resizing the main window will resize maximized file windows
to maintain maximized sizing unless Keep tiled or Keep cascaded
is in effect, in which case all windows will be re-sized.
Starting the Editor
Invoking the editor:
R [filename(s)...]
eg: R *.c *.h
loads all files with .c or .h file extensions in the current
directory.
Invoking the editor with no file names will cause one of two
actions:
1) If editor state restore is enabled and a state file
exists the editor will use the information contained in
the state file to restore the edit state to that
contained in the state file. If no state file can be
found then...
2) The editor loads with the settings specified in the
RSE_CFG.INI file and opens an UNTITLED buffer and a
single window attached to this buffer. If no
configuration file is found the editor loads with
default settings.Using a Mouse
Button 1 is the left-most mouse button. Button 2 is the
right button on a 2 button mouse and the center button on a 3
button mouse.
Clicking Button 1 positions the cursor to the mouse pointer.
Dragging the mouse while Button 1 is down begins block marking.
Hold down the SHIFT key, press Button 1 and begin dragging to
start line marking, hold down the CTRL key, press Button 1, and
begin dragging to start column marking.
You DO NOT have to continue to hold the SHIFT or CTRL key
while holding Button 1 down, once marking has begun that mark
type stays in effect until marking is turned off.
Clicking Button 2 while still holding Button 1 down will
cause the marked text to be COPIED to the clipboard.
Clicking Button 2 when marking is on will turn marking off.
Clicking Button 2 when there is text in the clipboard will
PASTE the text into the document at the mouse pointer position.
You can continue marking after you have released Button 1 by
pressing Button 1 again, the marked area will be extended to the
new cursor location set when you press Button 1. You can
continue to hold down Button 1 and drag select.Supplied Key Mappings (Bindings)
The supplied key mappings are for BRIEF compatibility. The
file RSE.KEY contains these key definitions.
Keyboard definition files are compiled by the keyboard
definition compiler KEYCOMP.EXE. The keyboard definition
compiler allows multi-key sequences to be mapped (bound /
assigned) to an editor function/command.
The keyboard definition compiler creates a file which can be
loaded by the editor at start-up time. The editor uses the
keyboard mappings to process the keystrokes you enter. Compiled
keyboard definition files have the extension .KBD. The editor
looks for the file RSE.KBD when it starts and loads the
definition file.
You may customize the source keyboard definition file
RSE.KEY and recompile it to produce a new keyboard mapping or you
can create one from scratch.
To invoke the keyboard definition compiler enter the
following command:
[drive:pathname\] KEYCOMP [drive:pathname\]filename.ext
KEYCOMP creates a compiled keyboard definition file with the same
filename and the extension .KBD.
Syntax of Keyboard Definition File
A semicolon begins a comment (like assembly language), the
remainder of the line following a semicolon is ignored
Format of a key definition line:
[ [ [[SHIFT+][CTRL+][ALT+]] KEY ]...] = function_name
White-space is ignored between tokens.
Multiple shift keys may be specified, eg. :
CTRL + ALT + 'C' = SomeFunctionName
Multi-keystroke sequences can be defined, eg. :
CTRL + 'K' + CTRL + 'X' = ExitEditor
CTRL + 'X' + CTRL + 'X' = SaveAllAndExit
The following keys are reserved for system menu accelerator
or action bar keys and should not be defined, as the definitions
will be ignored:
F1 Invokes HELP subsystem
F10 Activates the action bar
ALT + SPACE Activate the main window's system menu
ALT + F4 Close the application (ExitEditor)
ALT + F5 Restore the application main window
ALT + F7 Move the application main window
ALT + F8 Size the application main window
ALT + F9 Minimize the application main window
ALT + F10 Maximize the application main window
CTRL + SPACE Activate the current edit window's system menu
CTRL + F4 Close the current edit window
CTRL + F5 Restore the current edit window
CTRL + F7 Move the current edit window
CTRL + F8 Size the current edit window
CTRL + F9 Minimize the current edit window
CTRL + F10 Maximize the current edit window
Dynamic assignment of Accelerator Keys to Pulldown Menu Items
When the editor is loaded accelerator (short-cut) keys are
added to the pulldown menu items if a key assignment has been
made for a the editor function assigned to the pulldown item.
This is done by scanning the current keyboard key assignments and
using the first key assignment to the function matching the
pulldown item.
Configuring the Editor
The configuration file RSE_CFG.INI is created in the same
directory which R.EXE is located. This file holds the settings
you make in the dialog boxes presented by the "Options" pulldown
menu choices.
When the editor starts it reads this file and sets the
editor up according to the settings in the file.
If NO config file is found or it is invalid the editor uses
default settings.
Configuration settings can be changed using the dialog boxes
presented by the "Options" pulldown menu selections.
When you invoke the editor for the first time you should set
the configurable settings to your liking and check the
"Permanently save settings"
check-box in the dialog box and press the Enter key. The config
file will be written at this point.
NOTE: Autosave is unimplemented in this release.
Saving and Restoring the state of the editor
You may enable or disable this feature from the "Options"
"Global settings..." dialog box. It is disabled by default.
Each file you were editing along with windowing information
and your current position in the file is saved in the state
restore file RS_STATE.INI. The path and file name used to name
the state file can be changed using the "Options" "Global
settings..." dialog box.
Other information retained in the state file:
The last search expression
The last search & replace expressions
The Ignore Case and Ignore Regular Expression settings
Open in current window setting (set from the Open File
dialog box)
Keep tiled / Keep cascaded settings
Tiling Orientation (across or down)
The position and size of the editor's main window is saved
in the OS2.INI file whether you have "Save Editor State" enabled
or not. The editor recognizes the Desktop Manger "Save" request,
and will save the main window size and position.
File Action Bar Choices
The File choice on the action bar allows you to perform the
following actions:
New Creates a new untitled buffer. You must give the
buffer a name before you can save it to disk.
Open Presents a dialog box which allows you to select a file
to load into a buffer. If the file does not exist you
are prompted whether to create it or ignore the
request.
Next Brings the next buffer into the current window.
Previous Brings the previous buffer into the current window.
Save Save the buffer displayed in the current window to
disk.
Save as Renames the buffer displayed in the current window and
then saves the buffer to disk under the new name you
gave.
Compile Allows you to execute an associated executable if there
is an extension associated with the buffer's file
extension. This association is established by
selecting the Associate action on the Options pulldown
menu or the ConfigAssociate command.
Delete Deletes the buffer displayed in the current window. If
the buffer has been modified you are presented a dialog
box which allows you to save the buffer before deleting
it.
Print Prints the entire contents or the selected text in the
buffer displayed in the current window.
Print setup This item is currently unavailable.
Exit Exits the editor, displaying a dialog box if there are
unsaved buffers, giving you the option of saving them
before exiting.
Following the above choices is a list of all buffers. The
buffer being displayed in the current window has a check mark in
front of it. Selecting one of these displays that buffer in the
current window. Buffer names followed by an asterisk indicate
that the buffer has unsaved changes.
New
The New action on the File action bar pulldown creates an
UNTITLED buffer. You are prompted to give the buffer a name when
you save the file to disk.
If you exit the editor with an unsaved UNTITLED buffer you
receive a pop-up message informing you that there are unsaved
UNTITLED buffers. If you want to save them you should cancel the
exit and use the Save as... choice on the File action bar
pulldown and give the buffer a valid OS/2 path and file name.
Uses the NewFile command.
Open
The Open... action on the File action bar pulldown presents
a dialog box which allows you to open an existing file and load
it in an edit buffer, or create a new file if the file you
specify does not exist. Uses the OpenFile command.
Next
The Next action on the File action bar pulldown attaches the
next buffer in the list of buffers to the currently active
window. If there is no next buffer the first buffer in the list
is attached. Uses the NextBuffer command.
Previous
The Previous action on the File action bar pulldown attaches
the previous buffer in the list of buffers to the currently
active window. If there is no previous buffer the last buffer in
the list is attached. Uses the PreviousBuffer command.
Save
The Save action on the File action bar pulldown saves a
modified buffer to disk. If the buffer has not been modified a
pop-up message informs you that the file has not been modified
and the save request is ignored. If you are saving an UNTITLED
buffer you are presented the Save As dialog box. Uses the
WriteCurrentBuffer command.
Save as
The Save as... action on the File action bar pulldown
presents a dialog box which permits you to change the path and
file name of the current buffer. The buffer is saved to the new
path and file name when you select the OK push button. Uses the
RenameBuffer command.Compile
The Compile... action on the File action bar pulldown is
used to invoke an executable program based on the current
buffer's file extension. If more than one executable has been
associated with the file extension, you are presented a dialog
box which permits you to select which program you want to start.
Output from the invoked program is redirected to an edit
buffer as the program executes, allowing you to monitor its
progress. A window is created for the output buffer if one does
not already exist.
See Associate for further information on associating
programs with file extensions. Uses the CompileCurrentBuffer
command.
Delete
The Delete action on the File action bar pulldown deletes
the current buffer attached to the currently active window. If
the buffer has unsaved modifications you are presented a dialog
box which permits you to save the buffer before deleting, delete
without saving or cancel the delete buffer operation. The next
buffer in the buffer list will be displayed in any window which
was displaying the deleted buffer. Uses the DeleteCurrentBuffer
command.
Print
The Print action on the File action bar pulldown prints the
currently selected text in the current buffer or the entire text
of the buffer is printed if no text is currently selected. Uses
the Print command.
Exit
The Exit action on the File action bar pulldown exits the
editor. If there are unsaved buffers a dialog box is presented
which allows you to choose whether to save all, save selected,
cancel the exit request or exit without saving unsaved buffers.
Uses the ExitEditor command.Edit Action Bar Choices
The Edit choice on the action bar allows you to perform the
following actions:
Undo the last editing action which moved the cursor or
changed the contents of the buffer. Undo/Redo
information is saved for each buffer. All your editing
actions are saved. When you save the buffer to disk
undo/redo information is discarded (this default can be
overridden by changing the setting in the Options
Global Settings dialog box.)
Redo Redo the action or actions you just backed out by using
the undo command.
Cut Copies the selected text to the clipboard and then
deletes the selected text from the buffer. If no text
is selected the current line is copied to the clipboard
and then deleted.
Copy Copies the selected text to the clipboard. If no text
is selected the current line is copied to the
clipboard.
Paste Inserts the contents of the clipboard at the current
cursor position.
Delete Deletes the selected text from the buffer.
Undo
The Undo action on the Edit action bar pulldown undoes
(backs out) the last editing command which moved the cursor or
changed the contents of the current buffer's text. Undo
information is retained for all your editing actions except
scrolling performed by using the scroll bars.
Undo information is separately maintained for each edit
buffer. If you accidentally undo something which you wanted to
keep use the Redo command to reverse the effect of your undo
action.
By default, when you save the buffer to disk the undo
information is discarded. If you wish undo information to be
retained across buffer saves, you may change the default behavior
using the Global settings choice on the Options action bar
pulldown menu.
Undo information is saved using the virtual memory system
incorporated in the editor. Up to 128MB of virtual memory is
available to you if you have the disk space available for the
swap file.Redo
The Redo action on the Edit action bar pulldown redoes
(reverses the effect of undoing) the last editing command which
was undone. Redo is available only after you have used undo, if
there are undoable actions (ie. you have moved the cursor or
changed the buffer's contents since you last used undo) you will
have to undo to the point of your last undo in order to use redo.
Redo information is separately maintained along with undo
information for each edit buffer. If you accidentally redo
something which you wanted to keep undone use the Undo command to
reverse the effect of your redo action.
Note: Once you redo what you have undone and then resume
editing the undo/redo information for what you
have just redone will be discarded (ie. you can
not undo a redo after you have moved the cursor or
edited the buffer.)
By default, when you save the buffer to disk the redo
information is discarded. If you wish redo information to be
retained across buffer saves, you may change the default behavior
using the Global settings choice on the Options action bar
pulldown menu.
Redo information is saved using the virtual memory system
incorporated in the editor. Up to 128MB of virtual memory is
available to you if you have the disk space available for the
swap file.
Search Action Bar Choices
The Search choice on the action bar allows you to perform
the following actions:
Forward Presents a dialog box allowing you to specify the
search pattern. Searches forward from the current
cursor position.
Backward Presents a dialog box allowing you to specify the
search pattern. Searches backward from the current
cursor position.
Again Uses the last search pattern and direction to search
for the next match in the buffer.
Replace Action Bar Choices
The Replace choice on the action bar allows you to perform
the following actions:
Forward Presents a dialog box allowing you to specify the
search pattern and the replacement text. Searches
forward from the current cursor position.
Backward Presents a dialog box allowing you to specify the
search pattern and the replacement text. Searches
backward from the current cursor position.
Again Uses the last search pattern, replacement text, and
direction to search for the next match in the buffer to
be replaced.
When an match is found the matching text is highlighted and
a dialog box is displayed which permits you to Replace All,
Replace One, Skip, Undo Last or Cancel the operation.Regular Expression Syntax
BRIEF compatible regular expression syntax:
? match any single character except newline
* match zero or more of any character except newline
{} used to group expressions
@ zero or more of preceding character or expression
+ one or more of preceding character or expression
| match the preceding or following character or
expression, expressions must be grouped between
curly braces.
< or ^ Beginning of line
> or $ End of line
\c position cursor to the character following \c in
the pattern
\ escape (match following character literally)
[ ] enclose a character set (Example: [abcde] or
[a-e])
[^ ] [~ ] NOT in class (Example: [~a-z] or [^a-z] )
UNIX EGREP regular expression syntax:
. (dot/period) match any single character except
newline
() used to group expressions
* zero or more of preceding character or expression
+ one or more of preceding character or expression
| match the preceding or following character or
expression, expressions must be grouped between
parenthesis.
^ or < Beginning of line
$ or > End of line
\c position cursor to the character following \c in
the pattern
\ escape (match following character literally)
[ ] enclose a character set (Example: [abcde] or
[a-e])
[^ ] [~ ] NOT in class (Example: [~a-z] or [^a-z] )
The following escape sequences are interpreted as in the 'C'
language when specified within a character set specification:
\b - backspace
\t - tab
\f - form feed
\n - line feed
Escape sequences of the form \xNN where NN are hex digits
will be supported at a later date.
Replacement strings may include the escape sequence \'digit'
where 'digit' is a number from 0-9. This causes the text matching
the grouped expression in the search string to be substituted at
this point in the replacement string. A group expression is one
enclosed by the grouping characters {} in BRIEF and () in EGREP
syntax.
NOTE: Searching across line boundaries is not currently
supported.
Selection of which syntax you want as the default can be
made in the "Options" "Global settings..." dialog box. BRIEF is
selected by default.Window Action Bar Choices
The Window choice on the action bar allows you to perform
the following actions:
Cascade Causes all edit windows (except for minimized
windows) to be sized and positioned from the upper
left corner of the main window towards the lower
right corner of the main window overlapping each
other so that just the title bar of overlapped
windows is displayed. The current window becomes
the topmost window.
Tile across Causes all edit windows (except for minimized
windows) to be sized to fill the main window
without overlapping each other. The windows are
sized in such a way as to give windows greater
width than height.
Tile down Causes all edit windows (except for minimized
windows) to be sized to fill the main window
without overlapping each other. The windows are
sized in such a way as to give windows greater
height than width.
Keep tiled When this selection is checked, resizing the main
window, closing or creating an edit window causes
all edit windows to be re-tiled as above. The
tiling orientation (across or down) is that of the
default or the last tiling orientation selected
using the Tile across or Tile down actions.
Keep cascaded When this selection is checked, resizing the main
window, closing or creating an edit window causes
all edit windows to be re-cascaded as described
above.
Next Makes next window the current (active) window.
This window is made the topmost edit window. If
there is only one edit window this action is
ignored.
Previous Makes previous window the current (active) window.
This window is made the topmost edit window. If
there is only one edit window this action is
ignored.
Duplicate Duplicates the current window, creating a new edit
window of the same size and position as the
current window. The new window displays the same
buffer as the current window. The new window
becomes the current window. If either the Keep
tiled or Keep cascaded item is checked then all
edit windows are adjusted accordingly.
Following the above items is a list of all edit windows
(shows the name of buffer associated with the window). Selecting
one of these items makes that window the current (active) window.Option Action Bar Choices
The Options choice on the action bar allows you to perform
the following configuration actions:
Global settings
Set default tab widths, backups, state save,
autosave, regular expression syntax and keyboard
speed.
Fonts Set default font to use for displaying buffer
text.
Colors Set foreground and background colors for
displaying buffer text.
Cursors Set cursor size and type for insert / overtype and
virtual insert / virtual overtype edit modes.
Associate Allows you to tell RSE which executable program(s)
(compilers/make, etc.) to associate with a
particular filename extension. When you select
this option a dialog box File Extension
Associations showing the current file extensions
and program associations is displayed.
Associating a Program with a File Extension
The File Extension Associations dialog box allows you to
tell RSE which executable program(s) (compilers/make, etc.) to
associate with a particular filename extension. When you select
this option a dialog box File Extension Associations showing the
current file extensions and program associations is displayed.
Add an extension
To add a new filename extension click or press the Add...
pushbutton under the Extension list box. A dialog box will
prompt you for the filename extension, enter the extension
including the leading dot/period (eg. .c or .asm or .rc
etc.) and press the OK pushbutton. The extension is added
to the Extension listbox. If you change your mind and don't
want to add an extension press the Cancel pushbutton.
Delete an extension
To delete a filename extension select the extension you wish
to delete in the Extension list box then click or press the
Delete... pushbutton under Extension list box. A dialog box
prompts to confirm that you wish to proceed. Pressing the
Yes pushbutton deletes the extension and all executables
associated with the extension. Pressing No cancels the
delete operation.
Adding an executable program to an extension
Select the filename extension in the Extension list box with
which to associate with the new program you are about to
add. To add (associate) a new program to the extension
currently selected in the Extension listbox press the Add...
pushbutton under the Associated programs list box. A dialog
box prompts you for the following information:
Program title
Enter a descriptive title for this program. This
description appears in the Associated programs list box
and is used to build the title of the window which will
display output from executing the program. For example:
MSC 6.0 Syntax Check Only
Path and file name
Enter the full path and file name including the
extension to the program to be executed. (If this
program is in your PATH environment you may omit the
path.) Batch files (.CMD) requires the executable
CMD.EXE. Specify the batch file name in the parameters
field preceded with /C. For example:
CMD.EXE
C:\BINP\CMD.EXE
Working directory
If you wish to have the current working directory
changed before invoking the program enter the directory
path to be switched to. This field is optional.
Parameters
Enter the command line arguments to pass to the
program. To have the path and filename excluding the
file's extension of the current buffer (file) inserted
in the arguments string passed to the program enter %s
at the appropriate position in the parameter field.
Please note that the extension is not inserted so if
the program requires the extension you must place it
after the %s ( eg. %s.c .) RSE will substitute the full
path and filename excluding the extension for the %s.
You may omit the %s from the parameter string and RSE
will use the Parameters just as you specify them.
Parameters are optional. Some examples follow:
-c -AL %s.c For CL.EXE
-mx -zi %s.asm; For MASM.EXE
mypjt.mak For MAKE.EXE
"/C DIR *.C" For CMD.EXE
"/C BATCH.CMD" For CMD.EXE
When all fields are completed press the OK pushbutton to add
this entry to the Associated programs list box. If you
change your mind and don't want to perform the add, press
the Cancel pushbutton.
Changing an executable program's information
Select the extension and program in their respective list
boxes and press the Change... pushbutton under the
Associated programs list box. A dialog box will present you
with the current settings of the fields for this entry.
(See above for a description of the fields.) Change any
fields that you wish and press the OK pushbutton when you
are satisfied with your changes. If you change your mind
and don't want to save the changes you have made, press the
Cancel pushbutton, any changes you have made are discarded.
Copying an associated program
To copy an Associated programs entry select the entry you
wish to copy in the Associated programs list box and press
the Copy... pushbutton. You are presented a dialog box
which allows you to choose which file extension you wish to
copy the entry to. Select the file extension and press the
OK pushbutton. The entry is added to the list of associated
programs for the extension you selected. If you change your
mind and don't want to perform the copy operation press the
Cancel pushbutton. A fast way to add multiple entries for
an extension is to add the first and then copy the first as
many times as you wish and then change the copied entries.
Deleting an associated program
Select the extension and program in their respective list
boxes and press the Delete... pushbutton under the
Associated programs listbox. You are prompted to confirm
that you really want to perform the deletion, press the Yes
pushbutton to perform the deletion or No pushbutton to
cancel the delete operation.
When you complete your modifications to the File Extension
Association dialog box you have two choices:
Press the OK pushbutton to permanently save the changes to
the configuration file.
OR
Press the Cancel pushbutton which does not perform a save to
the configuration file, the changes you have made are
retained until you change them again or exit the editor.
You can go back at a later time and permanently save them by
selecting the OK pushbutton.Compiling Within the Editor
When you invoke the "CompileCurrentBuffer" command, either
from the "File" pulldown ("Compile..." option) or via a keystroke
association one of three things will occur.
1) If the file extension for the current buffer (file) is
not found in the file extension associations data you
receive a pop-up message telling you that no
association exists.
2) If only one association exists for this extension RSE
immediately executes the associated executable.
3) If more than one association exists RSE presents a
dialog box from which you may select which executable
association you want to execute. The dialog box shows
the "Program title" which you entered in the
"Associate..." dialog box. Select the title you wish
to execute and press the "Execute" pushbutton. Press
the "Cancel" pushbutton if you change your mind and
don't want to execute any of the selections.
When RSE invokes an executable the following actions are
performed:
o If the current buffer has been modified, it is written
to disk.
o A temporary buffer and a window for this buffer is
created, if one does not already exist, for output from
the executing program. The window's title is a
concatenation of the "Program title" and the full path
and filename of the current buffer.
Note: stdout and stderr are both redirected to this window.
o Associates the temporary buffer with the current
buffer.
o Locks the current buffer and the temporary buffer so
that they can not be deleted until the program
completes execution. You can delete the windows but
not the buffers.
o Creates a thread which executes the program and
redirects its output to the temporary buffer. The
program is exec'd asynchronously to RSE.
o Creates a thread which waits for the completion of the
executing program.
While the program is executing, its output to stdout and stderr
is redirected to the temporary buffer (and displayed in the
window attached to this buffer, if any) as the program executes
so you can monitor the progress of the executing program.
When the program completes execution the following actions occur:
o A pop-up message notifies you of the completion and if
the program returned with a non-zero result code.
o The temporary buffer and the buffer associated with the
temporary buffer are unlocked. You may now delete
these buffers if you wish.
o You may invoke multiple concurrent program executions,
but each must be on an unlocked buffer (ie. you can not
start two executions on the same buffer, you must wait
until the first completes before starting another). If
you attempt to do so you will receive a message telling
you the buffer is locked by a process.
Jumping to Errors in the Source File
RSE supports jumping to errors for programs which format
their error messages in the same way as the Microsoft C Compiler,
ie.:
pathname(error line #) : text {error}|{warning}
In the following discussion error line includes lines
containing warning messages as well as errors.
Jump to error processing is performed by the "NextError" and
"PrevError" commands. When you invoke these commands (default
key assignments are CTRL+N for NextError and CTRL+P for
PrevError) four actions are possible:
1) No temporary file is associated with the current buffer
the command is ignored.
2) The end (for NextError) or beginning (for PrevError) of
the temporary file has been reached - no action is
taken. A subsequent invocation will reposition to the
beginning or end of file and display the first or last
error message (ie. treats the temporary buffer as a
circular list).
3) An error line is found and the error is in the current
buffer - you are positioned to the line specified in
the error message and a pop-up message box containing
the contents of the error line message is displayed.
4) An error line is found but the file is not the current
buffer's:
A) If the file is currently loaded in the editor a
pop-up message box asks you if you want to jump to
the line in error in the other file.
B) If the file is not currently loaded a pop-up
message box asks you if you want to have the file
loaded and then jump to the error in that file.
The message box displays the file which will be jumped
to/loaded if you press the "Yes" pushbutton.
If you don't want to see the error in the other file
press the "No" pushbutton.
This makes it possible to step through errors generated by a MAKE
of multiple source files, but the current window must be the
buffer with which the temporary (error) buffer is associated for
the NextError/PrevError command to work.The Virtual Memory System
The virtual memory system supports an address space up to
128MB if you have the space available on your hard drive for the
swap file.
The virtual memory swap file is placed in the drive/dir
specified by the TMP environment variable or the root of the
current drive if no TMP variable is found. If you have any
comments on the use of the TMP environment variable, please let
us know. This could be a problem if TMP points to a ram disk,
since they are usually not very large. The virtual memory system
is used to retain all undo/redo and text buffer contents, which
can cause quite large swap files.
Getting HELP
The beginnings of a complete on-line context sensitive help
system are in place using the IPF functions new to OS/2 Version
1.2. RSE.HLP contains the IPF help library. This file should be
copied to one of the directories associated with the HELP
environment variable, or you can add the directory containing
RSE.HLP to the HELP path. OS/2 by default creates a
HELP=C:\OS2\HELP entry in CONFIG.SYS.
Pressing the F1 key invokes the help subsystem. Help is
currently available for action bar choices and some of the
pulldown menu items. Consult the table of contents or index for
help on other topics.LIST OF ALL FUNCTIONS WHICH CAN BE BOUND TO KEYS
SelfInsert Insert/Overtype the ascii value of the key
NewLine Insert a carriage return or moves to beginning of
next line
Note: SelfInsert and NewLine are affected by the state
of Insert/Overtype mode
DeleteChar Delete char at cursor
DeleteCharLeft Delete char to left of cursor (no wrap back to
previous line)
DeleteLine Delete line cursor is on
DeleteLineEnd Delete from cursor to end of line
Left Move cursor left one position (does not wrap back
to previous line)
Right Move cursor right one position (does not wrap to
next line)
Up Move cursor up to previous line
Down Move cursor down to next line
PageDown Move cursor down number of lines in window - 1
PageUp Move cursor up number of lines in window - 1
Home Triple action (LineStart/TopOfWindow/TopOfBuffer)
End Triple action (LineEnd/EndOfWindow/EndOfBuffer)
LineStart Move cursor to start of line
LineEnd Move cursor to end of line
WordLeft Move cursor to beginning of previous word or
number
WordRight Move cursor to beginning of next word or number
TopOfWindow Move cursor to beginning of top line in window
EndOfWindow Move cursor to end of last line in window
TopOfBuffer Move cursor to start of buffer
EndOfBuffer Move cursor to end of buffer
ScrollUp Scroll contents of window up
ScrollDown Scroll contents of window down
GotoLine Prompts for line to jump to (precede line number
with a + or - for to jump relative to current
line)
Undo Back out last cursor movement or editing change
Redo Put back what was just undone
MarkBlock Toggle block marking
MarkLine Toggle line marking
MarkColumn Toggle column marking
Note: If another marking mode is selected the above will
change the mark type to that which the command
specifies.
CutClipboard Copy to clipboard then delete selected text
CopyClipboard Copy selected text to clipboard
PasteClipboard Insert contents of clipboard at cursor position
DeleteBlock Delete selected text
WriteCurrentBuffer
Save buffer to disk
WriteMarkedRegion
Save selected text to disk
Write Save buffer or selected text to disk
Note: Write combines the action of WriteCurrentBuffer
and WriteMarkedRegion. If text is selected
(marked) you receive a dialog box to give the path
and file name to which the selected text should be
written. If no text is selected the entire buffer
is written to disk if the buffer has been
modified.
DeleteCurrentBuffer
Deletes the current buffer, if it has unsaved
changes you are given the opportunity to save
before deleting, delete without saving or cancel
the request.
ExitEditor Exits the editor. If unsaved buffers exist you
receive a dialog box giving you the opportunity to
save all, selected, or none of the unsaved
buffers, exit without saving, or cancel the
request.
SaveAllAndExit Saves any unsaved buffers and exits the editor
NewFile Creates an UNTITLED buffer
OpenFile Presents a dialog for you to select the file you
wish to load into buffers.
ReadFile Presents a dialog box for you to select a file to
be read into the current buffer at the current
cursor position.
RenameBuffer (Save as) allows you to change the path and file
name of a loaded buffer. The buffer is then
written to disk.
NextBuffer Brings next buffer in the buffer list into the
current window.
PrevBuffer Brings the previous buffer in the buffer list into
the current window.
Print Print the selected text or if no text is selected
the entire buffer.
CompileCurrentBuffer
Invokes an executable which has been associated
with the extension of the buffer's file name. If
more than one association exists you are presented
a dialog box from which to select the program you
wish to run. Stdout and stderr are redirected to
a temporary buffer which is created for you.
Undo/redo information is not retained for the
temporary buffer and the temporary buffer can not
be saved to disk or renamed.
NextError If a temporary buffer is associated with the
current buffer searches forward for an
error/warning message conforming to the Microsoft
'C' compiler's error format. If a line is found a
pop-up message displays the error/warning line and
jumps to the line in error. If the error is
located in a different file you will be notified.
If the file is not loaded it will load the file
and then jump to the line in error or if the file
is loaded you can jump to the line in error.
PrevError If a temporary buffer is associated with the
current buffer searches backward for an
error/warning message conforming to the Microsoft
'C' compiler's error format. If a line is found a
pop-up message displays the error/warning line and
jumps to the line in error.
TileWindows Uses the current tiling orientation to tile all
windows which are not minimized.
TileAcross Tile windows giving preference to window sizing
wider than they are high.
TileDown Tile windows giving preference to window sizing
taller than wide.
ToggleKeepTiled
Toggle whether windows should be kept tiled when
the main window is sized or windows are created or
deleted. When the toggle goes from off to on the
windows are tiled.
CascadeWindows Arrange all non-minimized windows so that they
overlap.
ToggleKeepCascaded
Toggle whether windows should be kept cascaded
when the main window is sized or windows are
created or deleted. When the toggle goes from off
to on the windows are cascaded.
NextWindow Make next window in the window list the current
(active) window.
PrevWindow Make the previous window in the window list the
current (active) window.
DuplicateWindow
Make a copy of the current window. The window
overlays the current window and displays the same
buffer. If KeepTiled or KeepCascaded is on then
all windows are re-sized and positioned.
DeleteCurrentWindow
Deletes the current window. The buffer that was
attached to the window is not deleted.
DeleteWindowAndBuffer
Deletes the current window and the buffer
displayed in the current window. Any other
windows attached to this buffer will have the next
buffer in the buffer list attached to them.
ToggleRecordMacro
Toggle keystroke macro recording. If toggling to
on, a dialog box prompts for the name of the file
to which to save the macro.
PlayMacro Presents a dialog box prompting for the file name
of the macro you wish to play.
PlayMacroAgain Plays the last recorded macro, or the last macro
that was played, again.
SearchForward Presents a dialog box prompting for the search
expression. You may also change the state of the
Ignore regular expression and Ignore case flags.
Searches forward from the current cursor position.
SearchBackward Presents a dialog box prompting for the search
expression. You may also change the state of the
Ignore regular expression and Ignore case flags.
Searches backward from the current cursor
position.
SearchAgain Uses last search expression and search direction
to search. Searches from one character position
away from the current cursor position.
ReplaceForward Presents a dialog box prompting for the search
expression and replace expression. You may also
change the state of the Ignore regular expression
and Ignore case flags. Searches forward from the
current cursor position.
ReplaceBackward
Presents a dialog box prompting for the search
expression and replace expression. You may also
change the state of the Ignore regular expression
and Ignore case flags. Searches backward from the
current cursor position.
ReplaceAgain Uses last search and replace expressions and
search direction to search. Searches from one
character position away from the current cursor
position.
ToggleInsert Toggle insert/overtype mode.
ToggleTabs Toggle whether to use tab characters or an
appropriate number of spaces when the TAB key is
pressed.
ToggleBackups Toggle whether backup files will be created when
you save a buffer to disk.
ConfigGlobals Presents the Editor Configuration dialog box.
ConfigFonts Presents the Font Selection dialog box.
ConfigColors Presents the Color Selection dialog box.
ConfigCursors Presents the Cursor Settings dialog box.
ConfigAssoc Presents the File Extension Association dialog box
HelpForHelp Invokes help system for help on using help
HelpExtended Displays extended help for item if available
HelpKeys Displays keys help
HelpIndex Displays the help index
AboutEditor Displays the About RimSTAR Editor dialog box
InvalidKey Beeps when key is pressed.BRIEF Key Mapping Quick Reference
NewLine ENTER or KP_ENTER
DeleteChar DELETE or KP_DELETE (note: deletes block if text
is marked)
DeleteCharLeft BACKSPACE
DeleteLine ALT + D
DeleteLineEnd ALT + K
Left LEFT or KP_LEFT
Right RIGHT or KP_RIGHT
Up UP or KP_UP
Down DOWN or KP_DOWN
PageDown PGDN or KP_PGDN
PageUp PGUP or KP_PGUP
Home HOME or KP_HOME (Triple action)
End END or KP_END (Triple action)
LineStart CTRL + Q + CTRL + S (like WordStar)
LineEnd CTRL + Q + CTRL + D (like WordStar)
WordLeft CTRL + LEFT or CTRL + KP_LEFT
WordRight CTRL + RIGHT or CTRL + KP_RIGHT
TopOfWindow not assigned
EndOfWindow not assigned
TopOfBuffer CTRL + HOME
EndOfBuffer CTRL + END
ScrollUp CTRL + U
ScrollDown CTRL + D
GotoLine ALT + G
Undo ALT + U or KP_STAR
Redo ALT + R or SHIFT + KP_STAR
MarkBlock ALT + M
MarkLine ALT + L
MarkColumn ALT + C
CutClipboard KP_MINUS
CopyClipboard KP_PLUS
PasteClipboard INSERT or KP_INSERT
DeleteBlock DELETE or KP_DELETE (if text marked)
WriteCurrentBuffer CTRL + S
WriteMarkedRegion not assigned
Write ALT + W
ExitEditor ALT + X
SaveAllAndExit CTRL + X
NewFile not assigned
OpenFile ALT + E
ReadFile CTRL + R (note BRIEF uses ALT + R for this)
RenameBuffer ALT + O
DeleteCurrentBuffer CTRL + -
NextBuffer ALT + N
PrevBuffer ALT + -
Print ALT + P
CompileCurrentBuffer SHIFT + F10
NextError CTRL + N
PrevError CTRL + P
TileWindows SHIFT + CTRL + F1
TileAcross not assigned
TileDown not assigned
ToggleKeepTiled not assigned
CascadeWindows not assigned
ToggleKeepCascaded not assigned
NextWindow SHIFT + F1
PrevWindow CTRL + F1
DuplicateWindow F3
DeleteCurrentWindow F4
DeleteWindowAndBuffer SHIFT + CTRL + -
ToggleRecordMacro F7
PlayMacro F8
PlayMacroAgain SHIFT + F8
SearchForward F5
SearchBackward SHIFT + CRL + F5 (note: different from BRIEF)
SearchAgain SHIFT + F5
ReplaceForward F6
ReplaceBackward SHIFT + CTRL + F6 (note: different from BRIEF)
ReplaceAgain SHIFT + F6
ToggleInsert ALT + I
ToggleTabs not assigned
ToggleBackups CTRL + W
ConfigGlobals not assigned
ConfigFonts not assigned
ConfigColors not assigned
ConfigCursors not assigned
ConfigAssoc not assigned
HelpForHelp not assigned
HelpExtended not assigned
HelpKeys not assigned
HelpIndex not assigned
AboutEditor ALT + V
InvalidKey not assigned