home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 10 Tools
/
10-Tools.zip
/
OS2BUILD.ZIP
/
PROGED.DOC
< prev
next >
Wrap
Text File
|
1988-10-18
|
75KB
|
1,981 lines
Programmer's Editor(TM)
Version 2.00
Usage Guidelines
Architectural Software Products(R)
Information in this document is subject to change without notice and
does not represent a commitment on the part of Architectural Software
Products(R).
Copyright (c) 1987, 1988 Architectural Software Products
Architectural Software Products
100 Front Street East
Suite 300
Toronto, Ontario
M5A 1E1
(416) 363-2292
Version 2.00.10
Revised 1988-10-18
Contents
──────────────────────────────────────────────────────────────────────
Introduction............................................ 5
1.0 Pull Down Menu...................................... 5
1.1 File.............................................. 5
1.2 Erase............................................. 6
1.3 Run............................................... 7
1.4 Directory......................................... 7
2.0 File Edit.......................................... 9
2.1 File............................................. 9
2.1.1 Save......................................... 10
2.1.2 Save & Exit.................................. 10
2.1.3 Get.......................................... 10
2.1.4 Put.......................................... 11
2.1.5 Profile Get.................................. 11
2.1.6 Profile Save................................. 12
2.1.7 Exit......................................... 12
2.2 Find............................................. 12
2.2.1 Find & Replace............................... 13
2.2.2 Find......................................... 14
2.2.3 Previous Build Error......................... 14
2.2.4 Next Build Error............................. 14
2.3 Format........................................... 14
2.3.1 Tab Stops.................................... 15
2.3.2 Right Margin................................. 15
2.4 Block............................................ 15
2.4.1 Start........................................ 15
2.4.2 Stop......................................... 16
2.4.3 Info......................................... 16
2.4.4 Copy......................................... 16
2.4.5 Clear........................................ 16
2.4.6 Move......................................... 16
2.4.7 Delete....................................... 17
2.5 Sort............................................. 17
2.5.1 Start........................................ 17
2.5.2 Stop......................................... 17
2.5.3 Direction.................................... 17
2.5.4 Go!.......................................... 18
2.6 Edit............................................. 18
2.6.1 Delete End................................... 18
2.6.2 Undelete..................................... 18
2.6.3 Delete Word.................................. 19
2.6.4 Copy......................................... 19
2.6.5 Cut.......................................... 19
2.6.6 Paste........................................ 19
2.7 Mode............................................. 19
2.7.1 Compress..................................... 20
2.7.2 Sound........................................ 20
2.7.3 Verify....................................... 20
2.8 Line............................................. 20
2.8.1 Insert....................................... 21
2.8.2 Insert Lines................................. 21
2.8.3 Duplicate.................................... 21
2.8.4 Goto......................................... 21
2.8.5 Delete....................................... 21
2.8.6 Delete Lines................................. 22
2.8.7 Split........................................ 22
2.8.8 Join......................................... 22
2.9 Key.............................................. 22
2.9.1 Alternate.................................... 22
2.9.2 Erase........................................ 23
2.9.3 Insert....................................... 23
2.9.4 Delete....................................... 23
2.9.5 Copy......................................... 23
2.9.6 Swap Case.................................... 24
2.9.7 Swap Letter.................................. 24
2.10 Window.......................................... 24
2.10.1 Open........................................ 24
2.10.2 Close....................................... 24
2.10.3 Split....................................... 25
2.10.4 Jump........................................ 25
3.0 Print.............................................. 25
3.1 Print File....................................... 25
3.2 Page............................................. 25
4.0 Accessing Help..................................... 25
5.0 Mouse and Keyboard Usage........................... 25
6.0 Editor Limits...................................... 27
7.0 Configuring the Programmer's Editor................ 27
8.0 Support Files...................................... 27
9.0 Using the File List................................ 30
Usage Guidelines
────────────────
Introduction
The following guidelines are provided to allow you to use the
Programmer's Editor in a useful and meaningful manner. The
Programmer's Editor is a full functioning editing environment
specifically designed for a programmer's needs. The editor has been
designed for speed and ease of use. It falls somewhere in-between
some of the commercially available editors geared towards programmer's
and a simple text editor. You will find features within this program
that will be found in some of the editors (such as error support,
windowing, macro support, etc.) and features that cannot be found on
others (such as automatic program configuration, multiple search and
replace item selection).
The following will outline the general use of the Programmer's Editor
and the functions that are available and their usage.
1.0 Pull Down Menu
The Pull Down Menu provides 4 menus. Through the pull down menu's,
you can perform commands and view information. The general functions
provided are: File, Erase, Run, and Directory.
1.1 File
The File Pull Down Menu is used in conjunction with file operations.
The File Edit function is used to edit the file selected from the file
list. An alternate method of selecting a file for editing is to
double click the left Mouse button on the file. This is equivalent to
selecting the file and selecting the File Edit function from the File
Pull Down Menu.
The File Statistics function is used to display the file size and last
time of update for the file highlighted within the file list. The
name of the file, its size and last modification date are displayed
within the Settings Window below the file list window. The statistics
for the file will remain displayed until another file has its
statistics displayed.
The File Touch function is used to update the currently selected file
to the current date and time. This function is useful when using the
Microsoft Program Maintenance Utility (MAKE). The utility is faster
than editing and saving the file when only trying to update the date
or time. It is for this reason the function is called Touch, since it
essentially touches the file date and time.
The File Cut Time function is used to set the date and time of the
selected file to a value entered through the prompt windows. This is
useful if you want all the files that you will be releasing for
distribution to have the same date and time. The time is entered at
5│
Programmer's Editor
───────────────────
the prompt on a 24 hour clock basis and the date is entered as it
would with the Operating System in the format of mm/dd/yy.
The File XCopy function is similar to the OS/2 XCopy function where
through the prompt window you describe the source and target
drive/paths. This is useful to copy large groups of files between
sub-directories or disks without have to use the Run pull down menu or
to start another OS/2 process.
The File Copy function is similar to the XCopy function except that it
will copy the selected file from the file list to the destination
drive/path entered through the prompt window. You cannot use the
function to specify the source path/drive to copy a file into the
current directory.
The File Move function is similar to the Copy function except that it
will move the selected file from the file list to the destination
drive/path entered through the dialogue window. You cannot use the
function to specify the source path/drive to move a file into the
current directory.
The File Rename function allows you to rename the currently selected
file within the file list to another name. A prompt will ask for the
new name for the file. After the file has been renamed, the file list
will be redisplayed with the file renamed. The filename will be
displayed with the prompt to allow easier editing of the name.
Finally, the File Exit function allows you to exit the program either
back to the OS/2 Program Selector or to the OS/2 command prompt.
1.2 Erase
The Erase Pull Down Menu is designed to provide file maintenance
similar to that of the Operating System without having to leave the
Programmer's Editor programming environment. If individual files or
the backup (.BAK) files are no longer needed, they can be removed from
the active disk or sub-directory.
The Erase File function will delete the file highlighted in the
directory list. It must be remembered that when this is done, it is
the same as invoking the ERASE or DEL command from the Operating
System (OS/2). In both cases, the results are the same; access to the
file can no longer happen.
When it has been decided that the backup (.BAK) files of the files
edited are no longer needed, the Erase Backups function will remove
all the backup entries from the disk directory. This function is very
useful when the current disk is almost full and some of the files
contained on that disk are backup files as they can be removed thereby
allowing for an increase in disk space available.
│6
Usage Guidelines
────────────────
1.3 Run
The Run Pull Down Menu provides three functions that allow you to run
a selected file, OS/2 command or shell to OS/2.
The Run File function is used to run a program that contains a .EXE or
.COM extension. All that is necessary is to select the file from the
file list and to select the function. A prompt window is displayed
allowing you to enter additional parameters that are used by the
selected program. Alternately, you can double click with the left
Mouse button on the file to execute it.
The Run OS Command function is similar to the Operating System command
prompt where you can type in normal Operating System commands such as
DIR or ERASE, etc. A prompt window is opened to allow you to enter
the OS/2 command which will be executed by OS/2.
The Run OS/2 Shell function allows you to temporarily exit the
Programmer's Editor to the OS/2 command prompt. You can then perform
normal OS/2 commands from the command prompt. To return back to the
Programmer's Editor, you only need to type EXIT at the OS/2 command
prompt.
1.4 Directory
The Directory Pull Down Menu allows for disks in the current drive or
for sub-directories to be changed. It also allows for a new disk
drive or new directory path to be used instead of the current drive or
directory path. When this is done, the new drive/sub-directory
becomes the current drive/sub-directory with the input/output of files
taking place on the drive/sub-directory.
The Directory ChDir function is similar to the ChDir (CD) command
found in the Operating System. The major difference between the
Operating System command and the one found here is that you pick the
sub-directory you wish to move to from the directory list on the
screen. This is similar to that of picking a document or file to
edit.
With the Operating System command, you would either type in the path
to the previous directory or you would use the Operating System
shorthand of ".." to move back or up a sub-directory level. Within
this function, you would select the previous dir from the directory
list presented on the screen.
The PgUp, PgDn and cursor keys are used to select the sub-directory
you want after selecting the Directory Show Directory function and
this function is used to perform the actual selection to the sub-
directory chosen.
When the new sub-directory that you have chosen has been changed to, a
new sub-directory list will be read in and displayed allowing you to
make further selections.
7│
Programmer's Editor
───────────────────
The Directory Drive function uses the same syntax as the Operating
System to change from one disk drive to another. When you have
selected this function you will be prompted for the drive you wish to
change to.
To change drives from one to another, you need to type in the drive
letter followed by a colon such as:
a:
As with the Operating System, this form must be used when changing
drive designations. If the target drive (the letter designation)
exists, that drive will be used in place of the previous. Any sub-
directories found within the root directory of the new drive will then
be displayed.
If the drive does not exist, an error message will be displayed.
You can exit from this prompt at any time by pressing the Esc key
which essentially aborts the initial request.
Alternately, if you are using a Mouse, you can click the Mouse cursor
a drive designation list at the bottom of the dialogue window.
The Directory RmDir function allows for the sub-directory highlighted
in directory list to be removed. The sub-directory must be totally
empty for the function to work with the exception of the previous dir
entry. You cannot remove a sub-directory that contains hidden files.
Before ProgEd tries to remove the sub-directory, it will prompt you to
verify the removal of the sub-directory. The prompt will display a N
above the cursor, which is the automatic response for the prompt. If
you wish to remove the sub-directory, you must type in a y or Y.
The function will display an error message if you try to remove the
previous dir entry or a sub-directory that may not be empty.
You can exit from this prompt at any time by pressing the Esc key
which essentially aborts the initial request.
The Directory MkDir function allows you to create an additional sub-
directory from within the directory currently being used. As
mentioned at the beginning of the section, you can create additional
sub-directories that may have the same name as others but are in
different sub-directories.
The prompt of the function requests the name of the new directory.
The directory name follows the same rules as for the naming of files.
The form that the directory name can have is:
dirname.ext
where the dirname consists of one to eight characters. The value
entered for the dirname is checked for invalid characters by the
│8
Usage Guidelines
────────────────
Operating System. The .ext denotes the directory name extension which
consists of a period followed by one to three characters.
Invalid dirname or .ext characters are:
" / \ [ ] : | < > + = ; ,
All other characters are valid.
You can exit from these prompts at any time by pressing the Esc key
which essentially aborts the initial request.
The Directory Show Directory function is used to switch from the file
list to the directory list. You must first perform this function if
you wish to use the above functions except for the Directory Drive
function. To switch back to the file list from the directory list,
you use the Directory Show File Area function.
2.0 File Edit
2.1 File
This function selection when pressed will display a horizontal bar
selection guide from which the Pull Down menus are selected.
The first pull down menu is used for file operations. It contains
seven items. The first one is the File Save function. This will save
the file currently within the editor using the current file name
unless a different one is entered in the prompt. The second function
is similar to the first except that after the file is saved, the
Editor will be exited and control returned the Main Menu.
The third and fourth functions are used to Get and Put files. The Get
function will get a file that is entered at the prompt. The Put
function will save the "blocked" portion of the file within the editor
to the file that you enter at the prompt. It should be noted, the if
a file exists for the name you enter in the Put function, it will be
overwritten and the former file will have a backup extension (.BAK).
The next two functions of the File pull down menu are similar to the
Get and Put functions except that they are used to retrieve and save
Initialization or Profile files. You can save the initialization
characteristics that you have changed to a file that must have a .INI
extension. Within the initialization file will be the Alternate Key
definitions, margins, expand/compress flags, sort direction, etc.
ProgEd can also pull in predefined initialization files for certain
programming extensions. Current languages supported are Macro
Assembler, C, Pascal and MAKE files.
The final function is the Exit function. This function will exit the
Editor without saving the file and return control back to the Main
Menu.
9│
Programmer's Editor
───────────────────
2.1.1 Save
The file that is currently being edited will be saved while being able
to continue to editing afterwards. This function is similar to File
Save & Exit but does not exit. Function quick key: Ctrl+F1.
When invoked, the function will display the existing filename within
the dialogue window. Either a new filename can be entered or just a
<┘ which will cause the current filename to be used for the file being
saved. The old file will contain a .BAK extension to indicate that
this is a back-up file. It will contain the original file as it was
before any editing had taken place.
The filename can be entered with a drive and sub-directory syntax of:
[drive:][\path1\[path2\]][filename.ext]
Invalid filename characters are:
" / \ [ ] : | < > + = ; ,
All other characters are valid.
2.1.2 Save & Exit
This function is similar to File Save, but will exit the editor and
return to the Main Menu. Function quick key: Ctrl+F2.
When invoked, the current name displayed on the name line of the
screen will appear within the dialogue window. If the filename of the
text being used is the name of the file to be saved, only a <┘ needs
to be entered otherwise the name can be replaced or edited as
required. Either a new filename can be entered or just a return which
will use the current filename for the file being saved. The old file
will contain a .BAK extension to indicate that this is a back-up file.
It will contain the original file as it was before any editing had
taken place.
The filename can be entered with a drive and sub-directory syntax of:
[drive:][\path1\[path2\]][filename.ext]
Invalid filename characters are:
" / \ [ ] : | < > + = ; ,
All other characters are valid.
2.1.3 Get
When this function is invoked, a prompt will request the filename of
the file to get. If the file is on a disk in another drive and/or
│10
Usage Guidelines
────────────────
sub-directory, the filename should be prefixed by the drive/sub-
directory designation. Function quick key: Shift+F7.
The imported file will be inserted into the document being edited
following the line where the cursor has been placed.
The prompt asks for the filename of the file being imported into the
file. The following format for the filename should be used:
[drive:][\path1\[path2\]]filename.ext
If the file being imported resides on the same disk or sub-directory
as the text file being edited, the drive or paths can be left off
whereas if the file is on a disk in another drive or in another sub-
directory, then that drive designation should be included. If the
file resides on another disk but is not in any the disk drives on the
system, then text file disk can be removed, and the other disk
inserted into the drive in its place before hitting the <┘ key.
Once the file has been imported (the prompt disappears from the
screen), take the disk out of the drive and return the text file disk
so the edited file can be saved on its original disk. If this is not
done, the edited file will be stored on the disk that the imported
file was taken from.
Both the filename and the external should be included when entering
the imported files name or an error message will be given.
2.1.4 Put
When a portion of the file has been defined using the Block function,
it can be saved to disk. This function is similar to File Save but
only a defined portion of the document is saved not the entire thing.
Function quick key: Shift+F8.
When invoked, the function will request a filename through a dialogue
window. Either a new filename can be entered or just a <┘ which will
use the current filename for the file being saved. The old file will
contain a .BAK extension to indicate that this is a back-up file. It
will contain the original file as it was before any editing had taken
place.
Invalid filename characters are:
" / \ [ ] : | < > + = ; ,
All other characters are valid.
2.1.5 Profile Get
When this function is invoked, a prompt will request the filename of
the profile to be get. If the file is on a disk in another drive or
11│
Programmer's Editor
───────────────────
sub-directory path, the filename should be prefixed by the drive/path
designation. Function quick key: Shift+F9.
The imported profile will reset the current Pull Down Mode Menu values
with the new ones contained in the imported file.
The prompt asks for the filename of the profile file being imported.
The following format for the filename should be used:
[drive:][\path1\[path2\]]filename.ext
If the file being imported resides on the same disk or sub-directory
as the text file being edited, the drive or paths can be left off
whereas if the file is on a disk or in another drive or in another
sub-directory, then that drive designation should be included. If the
file resides on another disk but is not in any the disk drives on the
system, then text file disk can be removed, and the other disk
inserted into the drive in its place.
Once the profile has been imported (the dialogue window will
disappear), take the disk out of the drive and return the text file
disk so the edited file can be saved on its original disk. If this is
not done, the edited file will be stored on the disk that the imported
profile was taken from.
Both the filename and the external should be included when entering
the imported profiles name or an error message will be given.
2.1.6 Profile Save
This function is used to save the current Profile to a file with a
.INI extension. If you have made changes to the editing
characteristics of the Profile, they can be saved to disk for future
use. Function quick key: Ctrl+F4.
2.1.7 Exit
All editing will be stopped and the program will return to the Main
Menu without saving the file being edit. The file will remain in
memory until another file is chosen or ProgEd returns to the Operating
System (OS/2) or returns to the Build Utility if ProgEd was invoked
from there. Editing of the file can be resumed by invoking the File
Re-Edit function. Function quick key: Ctrl+F3.
2.2 Find
The next pull down menu is the Find menu. Depending on the operating
characteristics of ProgEd, either two or four menu items will be
present. If you are using Build Utility and have invoked a F2=Compile
with error trapping permitted and the assembler or compiler finds an
error, the Editor will automatically be invoked and will permit the
searching of Build errors. The last two menu items will allow you to
│12
Usage Guidelines
────────────────
search for the Build errors. At the bottom of the editing window will
the Build error window containing the error number and message.
The first two menu items will always be present. They are for Find &
Replace and Find.
2.2.1 Find & Replace
When this function is first invoked, a window will open that contain a
list of Search For items. By either clicking on the desired item or
by moving the selection bar to the item and hitting the <┘ key, you
will be prompted for the search string. Function quick key: F1.
The search string prompt will contain the item from the list which
will allow you to edit the item if so desired.
Next, the function will present a window that contains a list of
Replace With items. Again, you can either click the right Mouse
button on the desired item or can move the selection bar to the item
and hit the <┘ to select it.
All occurrences of the search string are replaced by the replacement
string starting from the current cursor position to the end of the
document. If the Verify mode is on, each occurrence of the search for
string, the Editor will ask if it should replace the string with the
string being will highlighted. Upon completion, the number of times
that the string was replaced will be displayed in the middle of the
screen for a few seconds before control is returned back to the
Editor.
The Search For dialogue window asks for the string that will be used
in the global search. It must match exactly or the string will not be
found. The last Search for string will be displayed if one was
selected. A <┘ will cause that string to be used unless another one
is typed in. The Replace With dialogue window asks for the string
that will replace the string that is being searched for. The last
Replace With string selected will be displayed. A <┘ will cause that
string to be used unless another one is typed in.
If the Verify option has been toggled On in the Pull Down Mode Menu,
the verification prompt will be presented with a beep and the string
is highlighted when the search for string is found. By entering a y,
the searched for string will be replaced. Conversely, if n is
entered, the searched for string will not be replaced. This function
can be very useful when only replacing certain cases of the searched
for string.
If the Esc key is pressed at this prompt, the process is aborted at
the displayed position and control is returned back to the location
where the search began from. Also, when not using the Verify mode,
the process can be aborted by pressing Ctrl+Break while the search and
replace function is active. This is similar to pressing the Esc key
at the verification prompt.
13│
Programmer's Editor
───────────────────
2.2.2 Find
When this function is first invoked, a window will open that contain a
list of Search For items. By either clicking on the desired item or
by moving the selection bar to the item and hitting the <┘ key, you
will be prompted for the search string. Function quick key: F4.
The search string dialogue window will contain the item from the list
which will allow you to edit the item if so desired. The editor will
then search the document starting at the current cursor line. A beep
will signify that the string has been found as well as highlighting
the matched string. A dull buzzing sound and a message will be
displayed stating that the string was not found. On subsequent
searches, the old search string is displayed with the prompt. If the
same string is to be used again, only <┘ needs to be pressed whereas a
new string can be entered if a different string search is to occur.
The Search For prompt asks for the string that will be used in the
global search. It must match exactly or the string will not be found.
The process can be aborted by pressing Ctrl+Break while the search
function is active.
2.2.3 Previous Build Error
When ProgEd has been invoked by the Build Utility Build function after
it has found an error during the F2=Compile of a file or program, the
Build Error mode will be used and the Editor will display any errors
found within the Build Error window at the bottom of the editing
window. Function quick key: Shift+F3.
The Shift f3 function allows you to move to the previous Build Error
unless the current error is the first error that the compiler or
assembler found.
2.2.4 Next Build Error
When ProgEd has been invoked by the Build Utility Build function after
it has found an error during the F2=Compile of a file or program, the
Build Error mode will be used and the Editor will display any errors
found within the Build Error window at the bottom of the editing
window. Function quick key: Shift+F4.
The Shift f4 function allows you to move to the next Build Error
unless the current error is the last error that the compiler or
assembler found.
2.3 Format
The Format Pulldown Menu is used to set the current Tab Stops and the
Right Margin limit. These values are used throughout the life of the
│14
Usage Guidelines
────────────────
file and if so desired can be saved within a Profile Initialization
File using the File Profile Save function
2.3.1 Tab Stops
When this function is invoked, a new set of tab stops can be entered.
The current tab settings are displayed at the bottom of the screen.
Function quick key: Shift+F2.
The default settings of the Editor for the tab stops are:
5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80
The revised setting will be displayed at the bottom of the screen
replacing the previous settings.
2.3.2 Right Margin
The Right Margin prompt is used to enter the right margin value that
will be used during the typing. The minimum right margin value is 1
and the maximum is 255. Function quick key: Shift+F2.
2.4 Block
The next menu item is for Block functions. Seven items are available.
The first two are used to define either the start or end of a block.
The block will be defined according the current line that the cursor
is positioned on. The next menu item is used to display the current
block definition information. It will show the starting and stopping
block lines and the number of lines contained within the block. The
next four items are used to Copy, Move, Clear or Delete the current
block defined.
2.4.1 Start
By selecting the Block Start the first time, either one line of the
block is defined or just a single line is defined. After positioning
the cursor to another line in the document and selecting Block End,
the block is fully defined. Function quick key: F8.
This function is used in conjunction with the special text handling
and routines. Auxiliary functions Sort Go, Block Copy, Block Clear,
Block Move, Block Info and Block Delete are used in conjunction with
this function.
When the block is defined, a block defined indicator will be shown in
the mode flag area at the bottom of the display screen. This is shown
as a Blk in reverse video.
15│
Programmer's Editor
───────────────────
2.4.2 Stop
By selecting Block Stop, the block is fully defined. Function quick
key: F8.
This function is used in conjunction with the special text handling
and routines. Auxiliary functions Sort Go, Block Copy, Block Clear,
Block Move, Block Info and Block Delete are used in conjunction with
this function.
2.4.3 Info
There may be times when the location and size of a block need to be
known. This function will display the starting and ending lines along
with the number of lines that the block occupies. If no Block is in
effect, the function will indicate this. Function quick key: Alt+F3.
2.4.4 Copy
This function will copy a block of text that has been defined through
the Block Start and Block Stop functions to a location either above or
below the defined block. The cursor is used to point to the location
that the duplicate block of text is to be placed. The block of text
will be inserted into the file starting at the line below the current
cursor position. Function quick key: Ctrl+F7.
2.4.5 Clear
When this function is invoked, the block that was previously defined
is released and set back to normal. This then allows another block of
text to be defined. After the function is complete, the block
indicator on the command line of the display will be removed.
Function quick key: Ctrl+F8.
2.4.6 Move
The block of text previously defined will be moved to the location
pointed to by the cursor. The text will be inserted into the file
immediately following the line that the cursor is on. Upon
completion, the block of text is still highlighted to allow for
corrections in case the block was inserted in the wrong location.
Function quick key: Ctrl+F9.
If the block is correctly located, the block can be cleared using the
Block Clear function.
│16
Usage Guidelines
────────────────
2.4.7 Delete
This function is a convenient method of the removing large amounts of
text from the document that is being edited. The alternate method is
to use the Line Delete function. The block of text previously defined
is deleted from the document and the text below is moved up replacing
the former position occupied by the block of text. Function quick
key: Ctrl+F10.
2.5 Sort
The next menu is used in conjunction with the Sort Go is entered
through this menu as well as the direction of the sort. The sort
function uses the sort zone to confine what is compared during the
sort process and can be used to selectively order required lists.
Each Sort Zone is defined by a starting and ending column position
from which the sort is confined to. The zone does not need to be the
entire line length but can be a small portion of the line. Even
though the zone may be confined to the beginning of a given line, the
entire line moved.
2.5.1 Start
The starting position for the Sort Zone is entered through this
prompt. The number entered corresponds to the starting column
position from where the Sort Comparison is to begin. For example, if
a series of names start in column position 10, then that number is
entered through this prompt.
2.5.2 Stop
The ending position for the Sort Zone is entered through this prompt.
The number entered corresponds to the last column position from where
the Sort Comparison is to begin. Using the above example, if a series
of names start in column position 10, and end at column 25, then that
number is entered through this prompt.
2.5.3 Direction
When using the Sort function, you can specify the direction in which
the sort function is to use. By selecting the Sort Direction
function, you will toggle the current direction from either Up to Down
or Down to Up. The direction is shown on the status line at the
bottom the display by an up or down arrow with the up arrow indicating
that the sort direction is ascending (Up) whereas the down arrow
indicates that the sort direction is descending (Down).
17│
Programmer's Editor
───────────────────
2.5.4 Go!
Before the sort function can be invoked, three things must be done.
The starting and ending column locations have to be defined by the
Zone Mode function in the Sort Pull Down Menu unless the default
values or 1 and 10 are used. The direction the sort is to take place,
either ascending or descending, is also defined by Sort Direction.
Finally, the starting and ending lines that the sort is to occur is
defined by creating a block using Block Define. Function quick key:
Shift+F1.
When the sort function is invoked, the function will only compare the
characters defined by the Zone and within the defined block. All
other characters are ignored.
Once the sorting is complete, all of the lines are rearranged within
the defined block.
If another sort is needed, and if the Zone and Direction are the same
as the previous sort, they do not have to be defined again. They only
need to be defined if either Mode is different. Only the block has to
be defined for this function to be completed. Default values of the
Zone are 1, 10 and Direction is Up or ascending.
2.6 Edit
The Edit pull down menu provides general edit functions to delete to
the end of the current line, delete a word and to undelete. Last
three items are used for cutting and paste blocks of text. The first
item is used to copy the defined block to the cut and paste file. The
second function is used to cut the block from the file and to save it
into the cut and paste file. The final item is used to insert the
contents of the cut and paste file into the current file at the
current cursor location.
2.6.1 Delete End
The Edit Delete End function is used to delete to the end of the
current line in which the text cursor is on. All text from the cursor
to the right will be deleted. Function quick key: Ctrl+End.
2.6.2 Undelete E
This function is a powerful function in that it allows previously
deleted items to be returned into the file. When text has been
deleted in error, it can be retrieved from the deleted item holder.
It should be noted that only the last 32 items deleted are kept in the
holder. When the 33rd item is deleted, the 1st item is discarded, and
all items below are moved up once place. Function quick key: Alt+F2.
│18
Usage Guidelines
────────────────
Deleted items that may be contained in the deleted item holder are
single letters, words or lines. Items deleted using the block delete
function are not contained in this list.
2.6.3 Delete Word
The word starting a the current cursor position will be deleted from
the file and placed into the deleted items holder. If the cursor is
not pointing to the beginning of the word, all characters to the right
until the next word will be deleted. Function quick key: F2.
The maximum number of items contained in the deleted items holder is
32 and the deleted word can be restored by using the Edit Undelete
function.
2.6.4 Copy
After defining a block of text through the Block functions, you can
copy the text into the Cut/Paste Buffer where it can be pasted into
another file. The text will remain within the Cut/Paste Buffer until
you either exit from the program or until you copy other text into it.
It is not removed from the buffer after a Paste operation.
2.6.5 Cut
After defining a block of text through the Block functions, you can
cut the textfrom the file and copy it into the Cut/Paste Buffer where
it can be pasted into another file. The text will remain within the
Cut/Paste Buffer until you either exit from the program or until you
copy other text into it. It is not removed from the buffer after a
Paste operation.
2.6.6 Paste
Once you have copied text into the Cut/Paste Buffer you can insert it
back into the file you are currently editing. After you have placed
the cursor to line where you wish to have the text insert after, you
use this function to perform the operation. You can paste the text
into the file as many times as you wish since the text within the
Cut/Paste Buffer is not deleted by the paste operation.
2.7 Mode
The Pull Down Modes Menu is used to "toggle" on and off various Editor
configuration characteristics. The Mode Flags at the top of the
screen will show the configuration switches currently selected. The
table below shows the four configuration flags that can be selected
from this menu:
19│
Programmer's Editor
───────────────────
Configuration
Switch Flag
──────────────────────────────────
Compress Cmp / Exp
Sound Snd
Verify Ver
──────────────────────────────────
2.7.1 Compress
The Compress/Expand flags are used to denote whether the file will be
compressed or left as it appears. By using the compress feature
(Cmp), the document will be from 20 to 70% smaller in size when saved
to disk.
2.7.2 Sound
When the Sound flag is switched on (displayed in the mode flag area),
the speaker is left on to make audible sounds when acknowledging
specific input (such as accepting a filename during the save document
process), when displaying error messages or signifying that a string
has been found during a search function. There may be a desire to
turn the sound off while using the Editor and this function will
permit this to happen.
2.7.3 Verify
The last mode flag, Verify, is used by the Find & Replace function.
There may be times that a global search is desired but a selective
replacement of the search value is necessary. By selecting and
toggling the Verify switch, when the Find & Replace function is used,
each time the searched for string is found, you will be prompted for a
y/n answer to a prompt to replace the found string highlighted on the
screen.
2.8 Line
The Line pull down menu provides more general editing functions. Ten
functions are provided. The first and second functions are used to
insert blank lines into the file at the current cursor location. The
first of the two functions will insert 1 blank line whereas the second
function will allow you to specify the number of lines to insert. The
next function will allow you to duplicate the current line that the
cursor is positioned on. The Goto function will allow you to specify
which line to place at the top of the editing window. The Delete and
Delete Lines functions are similar to the Insert functions of this
menu. Again, the first of the two functions will allow you to delete
the line that the cursor is placed on and the second function, Delete
Lines, will allow you to specify the number of lines to delete. The
Split function is similar to the Split Line function. The line that
│20
Usage Guidelines
────────────────
the cursor is on will be split into two parts with the part to the
right of the cursor moving to the line below the cursor. The Join
function is the exact opposite of the Split function. The line below
the will joined to the current line starting at the point where the
cursor is positioned.
2.8.1 Insert
A new blank line is inserted into the file below the line the cursor
is currently pointing to. All of the lines below the current position
are moved down one line. Function quick key: F3.
2.8.2 Insert Lines
After selecting this function, a dialogue window will be opened in
which you can enter the number of blank lines that are to be inserted
into the file below the current cursor position. All of the lines
below the current position are moved down accordingly.
2.8.3 Duplicate
This will duplicate the line at current cursor position. All lines
below the current cursor line will be moved down one line into the
file to prevent the duplicate line from overwriting the next line.
Function quick key: F7.
It should be noted that the cursor can be in any position on the
current line.
2.8.4 Goto
When this function is invoked, a dialogue window will be opened which
will request a line number that is to become the current line being
edited. Function quick key: Alt+F4.
The prompt will only accept a numeric value between 1 and the last
line contained in the document (inclusive).
2.8.5 Delete
This function will delete the line that the cursor is currently
located on. The former line will be saved with the Delete items if it
has been deleted by mistake. Function quick key: F6.
The lines below the line being deleted will be moved up one position
to replace the line deleted.
21│
Programmer's Editor
───────────────────
2.8.6 Delete Lines
After selecting this function, a dialogue window will be opened in
which you can enter the number of lines that are to be deleted
starting from the current cursor position. All of the lines below the
current position are moved up accordingly.
2.8.7 Split
The current line will be split into two separate lines starting at the
current cursor position. The first half of the line will occupy the
same line in the file and the second half of the line will occupy a
new line in the file. All lines below the current cursor position
will be moved down one line to prevent the second half of the line
from overwriting the line below the current cursor position. Function
quick key: F5.
2.8.8 Join
This function essentially moves the line below the current cursor to
the line the cursor occupies with the first character of the line
below starting at the column the cursor occupies. Function quick key:
Alt+F6.
It works in a similar fashion to Delete Line but only deletes the
portion of the line to the right of the cursor while bringing up the
line below it and joining it to the current line at the current cursor
position.
2.9 Key
The Key pull down menu provides five functions. The first is used to
define the Alternate Key definitions. You will first be prompted for
the Alternate Key and then for the Alternate Key string that is
associated with the key. To use the Alternate Key definition, you
only need to place to cursor in the desired position and press the
Alt+key to have the string inserted into the file. Valid Alternate
Keys are: A-Z, 0-9, -, =. The Insert function is used to turn the
Insert mode on and off. The Delete function is used to delete the
current character that the cursor is placed under. The Swap Case
function is used to swap the case of the character if it is a normal
alphabet character. The Swap Letter function is used to swap the
letters of the current letter with the one to the right of the cursor.
2.9.1 Alternate
ProgEd allows you to define alternate key values that work in
conjunction to the regular keyboard. By pressing the Alt key + x and
then a valid Alternate Key, you will be able to include a string of
text within the document. The dialogue window is used to enter the
│22
Usage Guidelines
────────────────
alternate key and the string value. This function is somewhat similar
to keyboard macros that are found in other application programs.
Function quick key: Shift+F10.
You will first be prompted for the alternate key that you wish to
define or change. If the key that you entered is valid, the current
alternate key definition will then be presented in the prompt window
and you can either edit the definition or change it completely.
Valid alternate keys are:
0 - 9, A - Z, -, =
2.9.2 Erase
When using the Mouse, you can quickly select text within a line being
displayed by pressing the left Mouse button and dragging the Mouse
along the line. You can then use the Key Erase function to erase the
text highlighted. Alternately, you can press the space bar to perform
the same task.
2.9.3 Insert
If you want to go from overtype mode to insert mode you can use this
function to toggle the typing mode. This is the equivalent of
pressing the Ins key. The text cursor will change its shape depending
on the current typing mode. When in overtype mode, the text cursor is
its normal shape at the bottom of the character. When it insert mode,
the cursor changes its shape to a full flashing block.
2.9.4 Delete
To quickly delete text within a line on the screen, you can quickly
select text within a line being displayed by pressing the left Mouse
button and dragging the Mouse along the line. You can then use the
Key Delete function to delete the text highlighted. Alternately, you
can press the Del key to perform the same task.
2.9.5 Copy
To copy text within a line on the screen to another, you can select
text within a line being displayed by pressing the left Mouse button
and dragging the Mouse along the line after you have placed the text
cursor to the position where you want to copy the text. You can then
use the Key Copy function to copy the text highlighted. If you have
toggled from overtype mode to insert, the text highlighted will be
inserted at the current cursor location instead of overwriting the
existing text.
23│
Programmer's Editor
───────────────────
2.9.6 Swap Case
This function will convert lower case letters into upper case and vice
versa. This is major convenience when the Caps Lock has been left on
by mistake and all the letters on a line are in the wrong case.
Function quick key: Alt+F7.
The cursor points to the character to be converted. This function
does not have to be pressed each time a character is to be converted
when an entire line is to be converted.
After the letter has been converted the cursor moves to the next
letter to the right.
2.9.7 Swap Letter
This function causes two letters are swapped. The cursor points to
the first character. This function also works with spaces. Function
quick key: Alt+F6.
If the cursor is pointing to the last character on the line, no swap
will take place.
2.10 Window
From within the Programmer's Editor, it is possible to view two files
at the same time. By using the Window functions you can split the
current file into two windows or you can load a second file into
memory.
2.10.1 Open
The Window Open function is used to load a second file into the Editor
into a window at the bottom of the display. The function will open a
dialogue window in hwich you can enter the file that you wish to load.
The focus of the Editor will be in the newly opened window on the
bottom of the display. An indicator at the top of the display will
state that you are in Window 2. If you wish to move to the first
window, you can use the Window Jump function to jump between the two
windows.
2.10.2 Close
When you finished with a window, you can close the window by using the
Window Close function. Caution should be used with this function
since it will not prompt you before closing the window since it
assumes that you want to close the window without any regard to
changes made in the window. If you want to save the contents of the
window and close it, you should use either of the File Save functions.
│24
Usage Guidelines
────────────────
2.10.3 Split
When you want to work on the current file within two windows, you can
use function to perform the task. The Editor will open the second
window with the file being displayed at the current location. The
other window's display will be frozen while you are making changes
within the current window.
2.10.4 Jump
The Window Jump function is used to jump between two opened windows.
If you are currently in Window 1 and you select this function, the
Editor will change its focus from Window 1 to Window 2. It will
denote this by changing the Window Indicator in the top right hand
corner of the screen.
3.0 Print
3.1 Print File
This function is used to send single file to the printer. For a
single file, after using either the PgDn/PgUp or cursor keys to
highlight the file to be printed, pressing Print will cause the file
to be read into memory for printing. Once it has been read in, it will
be sent to the printer. When the file has been completely printed,
control will be passed back to the menu.
While a document is printing, pressing the Ctrl+Break keys will cause
the printing to be cancelled after the current line has been printed.
The printing of the rest of the document will ignored.
3.2 Page
When a file has finished printing and the output is still in the
continuous forms tractor, this function can be used to advance the
output past the tractor arms.
4.0 Accessing Help
Within the Programmer's Editor is a Help Facility. To access the Help
Facility you press Ctrl+H. A prompt will ask you to press the
function key that you wish help information for. If the key is
defined for the area in which you invoke the Help Facility, the help
information will be display within the Help Window. Depending on the
information, more than one page may be accessible. To access the
subsequent pages, you can either press the PgDn or PgUp keys or click
the Mouse cursor on the up or down arrows on the scroll bar of the
window.
5.0 Mouse and Keyboard Usage
The usage of a Mouse is fully supported within the Programmer's
Editor. This is one of the unique characteristics of the Editor and
25│
Programmer's Editor
───────────────────
can actually increase the editing speed. When you are within the
actual Editor itself, you can use the Mouse to access the pull down
menus, page through the file or move the text cursor to the desired
location within the editing window.
When using the Mouse with prompt windows, the following conventions
are used. Pressing the left Mouse button is the equivalent of
pressing the Esc key and pressing the right Mouse button is the
equivalent of pressing the <┘ key.
When working with the directory file list, you can use the Mouse to
select a file within the file list simply by moving the Mouse cursor
to the file desired within the list and clicking either Mouse button.
This will cause the highlight bar to move to the file that was clicked
on. To view subsequent pages of the directory list, you can click the
Mouse cursor on the scroll bar either above or below the scroll bar
elevator. Clicking the Mouse cursor above the scroll bar elevator is
the equivalent of pressing the PgUp key and conversely, clicking the
cursor below the elevator is the same as pressing the PgDn key.
When entering text at a prompt, you have a multitude of editing
options which you can you use. The following editing options are
available for use:
Key Function
──────────────────────────────────────────────────────────────────────
Cursor Right Moves the cursor right one character.
Cursor Left Moves the cursor left one character.
Ctrl+Cursor Right Moves the cursor right to the beginning of the
next word.
Ctrl+Cursor Left Moves the cursor left to the beginning of the
previous word.
Ins Changes the text cursor to a full block to
indicate Insert Mode is on. Pressing the Ins key
a subsequent time will cancel Insert Mode and
returning the text cursor to normal size.
Del Will delete the character currently above the text
cursor.
Ctrl+End Will delete all text starting at the current
cursor position to the end of the line.
Backspace Will delete the character immediately to the left
of the text cursor.
│26
Usage Guidelines
────────────────
6.0 Editor Limits
The following describe the maximum limits of the Programmer's Editor:
Maximum Lines: 5000 (default unless changed through the
environment variable, see 10.0
Configuring the Programmer's
Editor)
Maximum Line Length: 255 characters
Maximum Undelete Stack: 32 items
Maximum Number of Files
within Directory List: 255
7.0 Configuring the Programmer's Editor
There are ways of configuring the Programmer's Editor to best suit you
system. The following environment variables can be defined for use by
the Programmer's Editor:
PROGED Maximum number of lines within editor (should be no
larger than 5000)
TMP Path where temporary files are created
8.0 Support Files
The following support files are provided with the Programmer's Editor:
BAS.INI BASIC Source File Initialization Profile
Valid Extensions: .BAS
C.INI C Source File Initialization Profile
Valid Extensions: .C, .H
FOR.INI FORTRAN Source File Initialization Profile
Valid Extensions: .FOR
MAKE.INI MAKE File Initialization Profile
Valid Extensions: .MAK
MASM.INI Macro Assembler Source File Initialization Profile
Valid Extensions: .ASM, .INC, .MAC
PAS.INI Pascal Source File Initialization Profile
Valid Extensions: .PAS, .INT
PROGED.HLP Programmer's Editor Help Facility
C Source File Initialization Defaults (C.INI):
Right Margin: 132
Tab Stops: 1, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40,
44, 48, 52, 56, 73
File Compression: On
Sound: On
27│
Programmer's Editor
───────────────────
Alternate Keys Defined:
Key Definition
──────────────────
W while (
E else
R register
T typedef
U unsigned
I if (
O int
P printf(
A double
S switch (
D do
F for (
G float
K short
L long
X sizeof(
C case
V void
B break;
N NULL
1 #define
2 #if
3 #include <
4 #ifndef
- ->
MAKE File Initialization Defaults (MAKE.INI):
Right Margin: 120
Tab Stops: 1, 5, 10, 15, 20, 25, 30, 35, 40,
45, 50, 55, 60, 65, 70, 75
File Compression: Off
Sound: On
Macro Assembler Source File Initialization Defaults (MASM.INI):
Right Margin: 100
Tab Stops: 1, 9, 17, 33, 36, 57, 65, 73
File Compression: On
Sound: On
│28
Usage Guidelines
────────────────
Alternate Keys Defined:
Key Definition
──────────────────
Q EQU
W REP
E END
R RET
T TEST
Y PUSH
U OUT
I INC
O ORG
P POP
A ADD
S SUB
D DEC
F CLI
G STI
H IN
J JMP
K JMP SHORT
L LOOP
Z JZ
X XOR
C CMP
V CALL
B AND
N NOT
M MOV
1 DB
2 DW
3 DIV
4 JNZ
5 JC
6 JL
7 JA
8 MUL
9 PAGE
0 PROC
Pascal Source File Initialization Defaults (PAS.INI):
Right Margin: 132
Tab Stops: 1, 3, 6, 9, 12, 15, 18, 21, 24, 27, 30,
33, 36, 39, 42, 45, 48, 64
File Compression: On
Sound: On
29│
Programmer's Editor
───────────────────
Alternate Keys Defined:
Key Definition
──────────────────
W WITH
E END;
R REPEAT
T THEN
U UNTIL
I IF
O OF
P PROCEDURE
A ARRAY[
S STRING(
D DO
F FOR
L LSTRING(
C CASE
V VAR
B BEGIN
N NOT
3 {$PAGE+}
4 {$INCLUDE:'
= :=
9.0 Using the File List
When within the Main Menu or similar menu, the current file or
directory list will be displayed on the screen at all times. To
select a file within the list or to view remaining files, you can use
the general cursor keys. The PgUp and PgDn keys can be used to page
through the file list if more than 50 files are within the list. The
cursor arrow keys can be used to move the highlight bar from one file
to the next.
If you are using a Mouse, the Mouse can be used instead of the cursor
keys. To select a file within the file list you only need to click
the Mouse cursor on the desired file. To view alternate pages, you
only need to click the Mouse cursor on the scroll either above
(equivalent to PgUp) or below (equivalent to PgDn) the scroll bar.
│30
