Home

LPEX Editor User's Guide

1. Macro file delempty 1x Find and remove leading empty lines mark set predel Save the cursor position for later use top move cursor to first line in file extract content get contents of first line do while content loop while empty lines found block mark element highlight empty lines next element move cursor to next line extract content get contents of next line end block delete delete marked block mark find predel Restore cursor position if still existing mark clear predel Clear mark saving the cursor position exit 0 a To run the callback routine called del_empt lx each time you request the pop up menu type set popupinit del_empt 1x b To remove the callback routine called del_empt lx from the pop up menu callback list type set popupinit drop del_empt 1x API Return Code None Related Reading popuplink Parameter Add menu items already defined on the menu bar to the pop up menu in the Editor window Scope File Syntax set popuplink Id Item SubItem Ordinal Options Id Either the predefined Editor name for an Editor defined pop up menu item or a numeric value for a user added item The numeric value can be obtained by querying the popupmenuid parameter Item Pop up menu item to which the new menu item should be linked Chapter 8 References 289 Sub
2. For a list of predefined Editor names see the API Return Codes 1 The option specified for Item was not valid Type the option exactly as it appears in the menu including uppercase and lowercase letters 2 The item subitem or bitmap name contains invalid characters or you tried to define a new menu item without specifying a command Related Reading actionbarid parameter Returns the menu id of a menu bar pull down Scope File 158 LPEX Editor User s Guide Syntax query actionbarid Item Subitem Subitem BITMAP_resdl1_id Options Item The name of a menu item on the menu bar Subitem The name of a sub menu item attached to Item BITMAP Specifies that the menu or sub menu item is a bitmap resdll The resource dll containing the item s bitmap id The id for the bitmap contained in the resdll resource dll Description The actionbarid parameter queries the id of a menu or menu selection created with the actionbar parameter The item and subitem names specified must be the same as those used to create the menu bar If the item specified is not set a value of lt NULL gt is returned Example To query the id of the sound sub menu item attached to the mine pull down menu type query actionbarid mine sound API Return Code 1 You cannot issue the set command for this parameter Related Reading actionbarlist parameter Lists user defined pull down menus Scope File Syntax query actio
3. 12 This command requires an open document First open a document then issue the command 2 The number specified was outside the valid range or was not a whole number Issue the command again using a valid number Related Reading focus Parameter Specifies the focus lines of the file view Scope View Syntax query focus bottom next top row set focus bottom next top row RowNumber Options bottom Set the line in the display area that triggers upward scrolling of the file It is the lowest line on which you can place the cursor The default value is 3 220 LPEX Editor User s Guide next Focus line for next file view Temporarily overrides the standard focus row and margin triggering Margin triggering refers to the automatic scrolling that occurs when the cursor is positioned above focus top or below focus bottom For the next display only the current position is displayed on the focus next row The default value for focus next is 0 The focus next parameter describes an absolute line on the physical screen rather than a line within the editing window You can use it to position files within windows The focus command can be used to set focus next equivalent to focus row thus moving the current position to the focus line of the file view top Set the line in the display area that triggers downward scrolling of the file It is the highest line on which you can place the cursor The default value is 3 row Sets th
4. The showcurrent off parameter moves the cursor from the line if it is an excluded line and places the cursor on the next visible line Example All classes of this fragment from a C file are displayed This is a comment void f1 char char int int int char f2 int include lt stdio h gt main int argc char argv char envp char b int a C fl b b amp c a a strcpy b f2 a void f1 char b char c int a int y int z int is i a3 Chapter 8 References 323 char f2 int b return b The cursor is on the line int i If showcurrent is on and then you selected Functions from the View menu to exclude all but functions the following is displayed main int argc char argv char envp void f1 char b char c int a int y int z int i char f2 int b The current position remains displayed even though it is now an excluded line until you move the cursor If showcurrent is off and you select Functions from the View pull down menu then only the functions are displayed but the current position moves to the next visible line API Return Codes 2 The option you specified was not on off or inverse Related Reading shows Parameter Displays show lines Scope View Syntax query shows set shows on off inverse Options on Display all show lines This is the default value off Do not display show lines invers
5. 9 More than one argument supplied to the quitview command Related Reading record Command Records keystrokes to a macro file Scope Global Chapter 8 References 121 Syntax Parameters on Start or restart recording off Stop recording inverse Toggles between on and off play Play back recording continue Continue recording Description The record command records keystrokes to a macro file that can be played back at a later time Playback is within the context of the current insert replace mode Keystrokes are recorded to the record lx macro file in the directory pointed to by the TMP environment variable Subsequent recordings will overwrite the record lx file If you want to save the recording for later use you should save this file under a different name keeping the Ix file name extension to the macros directory You can use the macro command to play back this saved macro at a later time Example To start recording type record on API Return Codes 20 The recorder was not recording 21 There is no recording to play back 22 The recorder is already recording 23 There is no existing recording to continue recording with 24 An invalid option was specified 25 The recording contains nothing to play back 122 LPEX Editor User s Guide Related Reading repeat Command Repeats a command a specified number of times Scope Global Syntax Pr repeat Number Ce mmand AN er
6. Description The doccontent parameter stores the most severe error or warning result of text import operations It should be set to docOK prior to a file update such as loading a file and verified after the operation If the text length limit is exceeded during an import operation the edit line is kept or truncated as specified by the limiterror parameter The initial default value for this parameter is docOK The least severe is the warning docLimitExceeded and the most severe is the error docUpdateCancelled Example To clear the file update indication prior to an import set doccontent docOK API Return Codes 2 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set command again Chapter 8 References 201 Related Reading doclist Parameter Lists current file numbers Scope Global Syntax query doclist Description The doclist parameter returns a list of the numbers of all files currently open Example To obtain a list of file numbers type query doclist API Return Codes None Related Reading docnum Paramete docnum Parameter Gives the unique number identifying a file Scope File Syntax query docnum Description The docnum parameter gives a number that uniquely identifies the current file among those that are open It is the same number used to make up the default autoname name 202 LPEX Editor User s Guide Example To obt
7. Option ClassName Name of a class to be included in the file when it is displayed A list of class names is separated by blanks Description The include parameter specifies the list of classes for which member lines are to be displayed in the current file view If the list is empty all classes are displayed The list of classes can be overridden by the exclude parameter To display all classes in the file view the set include and set exclude commands without any class list are issued You can use the set showcurrent command to override the exclude setting for a line as long as that line is visible in the file view Examples 1 To list classes to be included in the file when it is displayed type query include 2 To define the classes to be included in the file when it is displayed type set include error comment The ERROR and COMMENT classes are displayed API Return Code 2 The specified ClassName was not a valid class type Use the query classes command to see which ClassName is currently defined or use the set class command to define a new class Issue the command again using valid ClassName Related Reading indent Parameter Sets the indent factor Scope View Syntax query indent set indent Number Chapter 8 References 245 Option Number The number of character positions used for indentation The range is integer values between 0 and 5 inclusive the default value is 2 Description The indent para
8. 2 Parameter options specified are out of valid range Related Reading 188 LPEX Editor User s Guide commandcheck Parameter Runs a specified command whenever an Editor command is issued from the Editor command line or Issue edit command window Scope Global Syntax query commandcheck set commandcheck Command Options Command A macro or an external Editor command Description The commandcheck command causes a specified command to be run whenever an Editor command is issued from the Editor command line or Issue edit command window Example To run sample1 lx whenever an Editor command is issued type set commandcheck samplel API Return Codes None commandline Parameter Displays an Editor command input area at the bottom of the Editor window Scope View Syntax set commandline on off inverse default query commandline Option on Display the Editor command input area off Do not display the Editor command input area Chapter 8 References 189 inverse Toggle the value of the commandline parameter between default and off default Command input area display is controlled by the value of the default parameter Description The Editor command input area appears and remains at the bottom of the Editor when the commandline parameter is set to on Pressing the ESC key toggles cursor focus between the command input area and the editing pane The Editor command input area commandline functions s
9. Description The marklist parameter gives you a list of mark names defined in the current file Note This parameter cannot be used in API calls Example To list mark names type query marklist API Return Codes None Related Reading markrange Parameter Returns starting and ending positions of the specified mark Scope File Syntax 268 LPEX Editor User s Guide query markrange Name Id Option Name The name of a mark This name is truncated if longer than 32 characters The search for this name is case insensitive Id The id number of an unnamed mark Description The markrange parameter gives the range location of the specified mark The four numbers returned are the starting line starting column ending line and ending column Examples 1 To get the text range location of a mark called undoref type query markrange undoref 2 To get the text range location of a mark with id of 567 type query markrange 567 API Return Codes None Related Reading menuactive Parameter Enables or disables a menu bar item pull down menu choice or pop up menu item in the Editor window Scope View Syntax set menuactive Name on off inverse query menuactive Name Options Name Either the predefined Editor window name for an Editor defined menu item or a numeric value for a user added item The numeric value can be obtained by querying the actionbarid parameter on Enables the menu bar
10. Issue the command again using a valid number 5 You cannot make changes to the file because the readonly parameter is set to on 8 Insufficient storage to continue Related Reading Chapter 8 References 77 end Command Moves cursor position to the end of the current line Scope View Syntax Description The end command moves the cursor position to the end of the current line The current position is set to one character beyond the end of the chosen line Example To move the cursor to the end of the current line type end API Return Codes None Related Reading entab Command Compresses blanks to tabs Scope File Syntax Description The entab command compresses sequences of blanks to tab characters according to current tab selections 78 LPEX Editor User s Guide Example To compress blanks to tabs entab API Return Codes None Related Reading exit Command Closes documents views in the Editor Scope Global Syntax gt omm prompt Parameter prompt A window appears asking you to confirm your intent to close the Editor Description The exit command closes all file views files and external commands then ends the Editor session For every file containing unsaved changes a message appears asking you to save or discard changes Example To end your Editor session type exit API Return Codes 1 The exit command was cancelled by user request Chapter
11. 181 182 183 183 184 185 186 187 189 189 191 192 192 193 194 195 197 198 198 199 200 201 202 202 203 204 204 205 206 206 207 208 209 210 210 211 212 214 215 216 218 219 220 222 225 226 fontsize Parameter format Parameter formatter Parameter formwidth Parameter fullparse Parameter global Parameter globallist Parameter group Parameter help Parameter hex Parameter highlight Parameter horizscroll Parameter hoverhelp Parameter idletime Parameter impmacro Parameter impset Parameter include Parameter indent Parameter inserting Parameter key Parameter keylist Parameter lastfind Parameter lastkey Parameter lastline Parameter length Parameter level Parameter limiterror Parameter linebreak Parameter linenumber Parameter lineread Parameter lines Parameter linked Parameter list Parameter loadedmacros Parameter mark Parameter markdeleteexit Parameter markdirtyexit Parameter markexclude Parameter markfont Parameter markid Parameter markinclude Parameter marklist Parameter markrange Parameter menuactive Parameter menucheck Parameter messageline Parameter messages Parameter modes Parameter name Parameter noblanks Parameter Contents 227 228 231 233 234 235 236 236 238 239 239 240 241 242 243 243 244 245 246 247 250 250 251 253 254 255 255 256 257 258 259 259 260 261 261 262 263 264 265 266
12. 5 Click on OK to close the Editor parameters window Related Reading Changing the Base Editor Font To customize the base font used by the Editor you must first open the Font dialog 1 Select Options from the Editor window main menu bar 2 Select Font from the resulting pull down menu The Font dialog appears In the Font dialog do the following 1 Use the selection lists to choose a font name style and size 2 When you are satisfied with your chosen font click on OK The chosen font is applied to the current editor window and to all future edit sessions To cancel all changes click on Cancel instead Related Reading Changing Token Display Attributes The Editor uses different font and character effects to emphasize different parts of a program To customize the attributes assigned to different types of document elements you must first open the Token Attributes dialog 1 Select Options from the Editor window main menu bar 2 Select Token Attributes from the resulting pull down menu The Token Attributes dialog appears In the Token Attributes dialog do the following 1 Change token display attributes by doing the following a Select the token type whose attributes you want to change from the Token type selection list b Select the Foreground radio button if you want to change the foreground color otherwise select the Background radio button 26 LPEX Editor User s Guide c S
13. Description The godoc command switches to the specified document If used with no parameters it switches to the next open document beginning with the most recently used document When you specify a parameter and document file name the Editor ignores case when making comparisons though it stores a new name exactly as typed If you create a new document without specifying one of the nonewring or newring parameters the new document is placed in a new or existing ring according to the value of the ring parameter The godoc command searches only documents already opened in an Editor window If the specified document exists on the disk but is not opened in the Chapter 8 References 87 Editor godoc ignores it and creates a new document with the specified file name When you save this new document you will overwrite the existing file on the disk Note The godoc command does not load any profiles when creating a new document Examples 1 To create a document called rester c type godoc name rester c The document is created If saved it is placed in the current directory 2 To switch to a document with document number of 71 type godoc docnum 71 The document must already be open for docnum to display it If it is not open the document file is not created 3 To switch to a document called lpex samples tester doc type godoc find lpex samples tester doc If the document is not found it is not created 4 To create
14. Description or Name Halt Playback Continue recording Rename macro Delete all macro lines Options Editor parameters Font Color Palette Token attributes Global variables Profiles Change profiles All active Key behavior LPEX EPM SEU XEDIT ISPF Customize Save key behavior Windows Macro log File list Next in ring Previous in ring Next ring Previous in ring Help How do I Product information Chapter 8 References 271 Menu ID Description Menu ID Description or Name or Name LP_TOOLBAR_SHOW Show Note Based on the state of the Editor some built in menu items are automatically enabled or disabled They are not affected by the value of the menuactive parameter setting Example To suspend the Keystoke recorder choices in the Actions menu type set menuactive LP_RECORD off API Return Code 2 The option specified with the parameter was not valid Related Reading menucheck Parameter Sets or unsets the check mark for a cascaded pull down or pop up menu choice in the Editor window Scope View Syntax set menucheck Name on off inverse query menucheck Name Options Name Either the predefined Editor window name for an Editor defined menu item or a numeric value for a user added item The numeric value can be obtained by querying the actionbarid parameter on Check the menu item off Uncheck the menu item inverse Toggle between on and off Descr
15. If a specified condition is false an action is either not taken or stops You can also specify an action to take if a condition is false The simplest comparison compares two terms against each other For example a b true if the value of a is equal to the value of b a lt b true is the value of a is less than the value of b a gt b true is the value of a is greater than the value of b Terms in a comparison can include numeric or string constants numeric or string variables or REXX functions that return numeric or string values Comparisons must however be of terms of like type String values cannot be compared with numeric values Conditions can also be based on a combination of comparisons Each comparison is enclosed within parenthesis and the logical operators OR 1 and AND amp are used to combine comparisons Use the OR logical operator for conditions that should be taken if any one or more of the specified comparisons is true For example a b c d true if one or more of the following are true value of a is equal to value of b value of c is equal to value of d a b e lt f g gt h true if any one or more of the following are true value of a is equal to value of b value of e is less than value of f value of g is greater than value of h Use the AND logical operator for conditions that should be taken if all of the specified comparisons is true For example a b amp c d
16. Parameters Number The number of times the command is to be repeated It is a non zero positive integer Command The command sequence to be repeated The mult command can be used as the Command to be performed Description The repeat command runs any Editor command repeatedly until either the given number of runs is complete or an API return code occurs Note The command is processed by the lxi command so you can use synonyms of the command and its parameters Example To repeat the command next class comment five times or until a nonzero return code occurs type repeat 5 next class comment The current position moves to the fifth COMMENT type line API Return Code 1 A parameter issued with the command was not valid Check the command syntax requirements and then issue the command again using a valid parameter Chapter 8 References 123 Return codes are also issued by the repeated command Related Reading reset Command Resets selected Editor settings to their initial value Scope Global Syntax Description The reset command resets selected Editor settings that were saved by the preserve command to their initial default values The settings affected are Command Default Setting exclude none expandtabs on formatter off impmacro off impset on include all overhang 1 protect none showcurrent off shows on wrap off API Return Code 9 Parameter passed where none required Related Reading
17. Setting a new quick mark will cause a previous quick mark to be lost You can also find a quick mark using the same procedure used to find a named location mark as described near the top of this page The quick mark will appear in the list of named marks as QUICK Related Reading Finding Text To search for an item in your document or file view first do the following to open the Editor Find and Replace dialog 1 Select Edit from the main menu 2 Select Find and Replace from the resulting pull down menu The Editor Find and Replace dialog opens Specify the item to be searched for by doing the following 1 Type a search item in the Find text entry area This can be a word a partial word or a sequence of such You can also enter a pattern you want to match provided that the pattern follows the rules of regular expression 2 Select your desired options If you enter a pattern in the Find text entry area you must also select the Pattern match check box 3 Click on Find If the entered text or pattern is found the cursor moves to either the next or previous occurrence of the search item according to your chosen search direction 12 LPEX Editor User s Guide Related Reading Finding and Replacing Text To search for an item in your document or file view first do the following to open the Editor Find and Replace dialog 1 2 Select Edit from the main menu Select Find and Replace from the resu
18. command whichever occurred last If the lineread dialog is used pressing its OK and Cancel buttons return the values as Enter and Escape respectively The possible names returned by this command are nnn xnn xnnn any key c a tO C z c 0 to c 9 a a tO a z a 0 to a 9 f1 to f12 s f1 to s f12 c f1 to c f12 a f1 to a f12 a named key 252 LPEX Editor User s Guide A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A A hexadecimal based ASCII character code where n is a digit of value value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x041 A Any keyboard character Ctrl letter keys Ctrl number keys The number keys on the numeric keypad are excluded Alt letter keys Alt number keys The number keys on the numeric keypad are excluded Function keys Shift Function keys Ctrl Function keys Alt Function keys The following key names either alone or in combination with the Alt or Ctrl keys e Backspace e Tab e Backtab e Enter e Esc e PadEnter The following key names either alone or in combination with the Alt Ctrl or Shift keys e PgUp e PgDn End e Home e Left e Right Up e Down Ins e Del lt null gt If either of the keyread or lineread commands were not previously called Example To return the last key obtained by keyread ty
19. european Return the date in European dd mm yy ormat month Returns only the full English spelling of the current month of the year ordered Returns the date in yy mm ddformat sorted Returns the date in yyyymmdd format usa Returns the date in mm dd yyformat weekday Returns only the full English spelling of the current day of the week var Evaluates the type of data invar If numeric function returns NUM If a character or string function returns CHAR str num_1num_2 Deletes characters from the stringstr starting at character num_1 in the string and continuing for num_2 characters If num_2 is not specified characters are deleted to the end of the string The function returns the remaining characters in the string If num _1 is larger than the length ofstr the complete string is returned unchanged str num_1 num_2 Deletes words from the string str starting at word num _1 in the string and continuing for num_2 words If num_2 is not specified words are deleted to the end of the string The function returns the remaining words in the string If num_1 is greater than the number of words in str the complete string is returned unchanged new_str str num_1 num_2 char Inserts the string new_ str into another string str starting after character position num_1 If a value is specified for num_2 the string being inserted is padded to that number of characters The default padding character is a blank
20. key Parameter Maps a physical key to a logical key Scope Global Syntax query key PhysicalKeyName set key PhysicalKeyName LogicalKeyName Options PhysicalkeyName The name of the key that is pressed Chapter 8 References 247 LogicalkeyName Your operating system may reserve certain function keys or key combinations such as F1 for special purposes With these exceptions permitted values for LogicalKeyName are nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where is a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any letter key An alphabetic character of value A to Z or a to z inclusive c a to c z Ctrl letter keys c 0 to c 9 Ctrl number keys The number keys on the numeric keypad are excluded a a to a z Alt letter keys a 0 to a 9 Alt number keys The number keys on the numeric keypad are excluded f1 to f12 Function keys s f1 to s f12 Shift Function keys c f1 to c f12 Ctrl Function keys a f1 to a f12 Alt Function keys buttonNdouble A double click on button N N 1 2 or 3 although only 1 and 2 will be usable on a two button mouse buttonNdown A single click on button N buttonNdrag Drag mouse with button N down 248 LPEX Editor User s Guide a named key
21. the find previous next point is reset to the last entry 218 LPEX Editor User s Guide Note If no number is specified then 0 is assumed Example To set the find occurrence number to 0 type set findhistory 0 API Return Code 2 The number specified is outside the valid range Related Reading flow Parameter Controls the automatic flowing of elements Scope View Syntax query flow set flow LevelNumber Option LevelNumber The level at which elements are to be flowed The default is 100 Description The flow parameter causes elements of a level number equal to or greater than the LevelNumber to flow together in the document window This gives a formatted appearance to the document Note You must set the formatter parameter to on for the flow parameter to have an effect on displayed text Examples The lines below have not been flowed together Tine 1111111111 1111 level 1 line 22222222222222 level 2 line 33333333333333 level 3 line 44444444444444 level 4 Tine 55555555555555 level 5 Chapter 8 References 219 To flow together elements at or below the third level type set flow 4 The elements of level 4 and 5 are flowed together on to the previous level as shown below line 1111111111 1111 line 22222222222222 line 33333333333333line 44444444444444 ine 55555555555555 Note You must set the formatter parameter to on for the flow parameter to have an effect on displayed text API Return Code
22. to be confirmed 4 To replace every occurrence of the 6 character string colourwith the 5 character string color in the next five lines type change colour color 5 The integer 5 in the Command position gives the number of lines over which the changes can be made 5 To replace up to five occurrences of the 6 character string colour with the 5 character string color in the current line type change colour color 5 The integer 5 in the Count position gives the maximum number of changes allowed in the current line The two quotation marks in the Command parameter position are required to place the integer in the Count position API Return Codes 1 The marked block in which you want to search is not in the current file Click on the file containing the block to make it current and then retry the command 2 The file contains no lines no operations can be performed 3 The change command received a negative return code from the command specified by the Command parameter 4 The Count parameter was not a valid positive integer Correct the Count and issue the command again 5 You cannot make changes to the file because the readonly parameter is set to on 7 The change command required at least two parameters and you have specified only one Check to see that a null string is preceded by a delimiter Related Reading Chapter 8 References 69 check Command Takes a checkpoint Scope File Syntax ros lt i clea
23. 1 Command parameter is not valid 2 No block is marked for cut or copy 4 Clipboard is empty or content is not in text format Related Reading compare Command Examines two documents for differences in their content Scope Global Chapter 8 References 71 Syntax compare Wename filename path Parameters DOCNUM n A document specified by Editor document number n filename The name of a file including if required the directory path of that file If filename is enclosed with the file name and directory path can include blanks if permitted by the file system path A directory path without a file name If path is enclosed with the directory path can include blanks if permitted by the file system Description The compare command examines two documents for differences in their content Each document is placed in a new file view and these new file views are placed side by side inside an Editor compare window Between the two file views a comparison bar highlights both similar and different sections of the two documents Options for the compare command can be set from the Compare pull down menu that appears in the menu bar of the Editor compare window If the compare command is issued without any file names or document numbers there must be exactly two documents open in the Editor The currently active document appears in the file view on the left side of the Editor compare window If you spe
24. 23 pels across and 34 pels from the top Because CX and CY are omitted the view cannot be resized 2 To set the position and size of the of the file view type set windowpos 4 512 1011 252 The lower left corner of the view is placed at 4 pels across and 512 pels from the top The frame of the view is 1011 pels wide and 252 pels deep API Return Codes 2 The coordinates placed the entire view outside the desktop Issue the command again using position and size coordinates that place the view within the desktop Related Reading windowshow Parameter Sets the prerequisites for displaying a Editor window Scope Global Syntax query windowshow set windowshow create load parse user Options create Display the view window as soon as it is created with the godoc or lx commands 352 LPEX Editor User s Guide load When opening a new file with the Ix command the window is not displayed until the file has been loaded parse When opening a new file with the Ix command the window is not displayed until the load profile has been run user The window is not automatically displayed The set window visible command must be invoked to display the window Description The windowshow parameter controls when a window is displayed The effect this parameter has is dependent on whether a window is created using the godoc or lx commands If windowshow is not set to create then any window created by the godoc command will not
25. 267 268 268 269 272 273 274 275 276 277 Vv nosave Parameter oldline Parameter overfont Parameter overhang Parameter overlay Parameter pad Parameter parent Parameter parser Parameter pending Parameter popupinit Parameter popuplink Parameter popupmenu Parameter popupmenuid Parameter popupmenulist Parameter position Parameter prefix Parameter prefixdefaulttext Parameter prefixdisplayformat Parameter prefixentry Parameter prefixformat Parameter prefixprotect Parameter prefixshow Parameter profiles Parameter protect Parameter rawtext Parameter readonly Parameter recall Parameter recentfilecmd Parameter recentmenushow Parameter recentpathshow Parameter recentsize Parameter recording Parameter resolve Parameter rexx Parameter ring Parameter ringlist Parameter ringnum Parameter rings Parameter ringselector Parameter ruler Parameter rulertext Parameter screen Parameter seconds Parameter show Parameter showcurrent Parameter shows Parameter sidescroll Parameter space Parameter spill Parameter split Parameter vi LPEX Editor User s Guide 277 278 279 280 282 283 284 285 286 287 289 290 293 294 295 295 296 297 299 300 301 302 303 304 305 305 306 307 308 310 311 312 313 314 315 315 316 317 318 319 320 320 321 322 323 324 325 326 327 328 statusline Parameter submenuinit Parameter symbol Parameter sy
26. 8 References 67 Parameters visible any asis Delimiter String1 String2 Command Count Description Changes are restricted to visible lines Find String regardless of case Find String exactly as typed Strings are separated by any single non blank character not used elsewhere in the parameter string For example change String1 String2 uses double quotes as a delimiter Because z is not part of the string to be changed you could also have specified the command with change zString1 zString2 Spaces placed between the delimiter and string are considered part of the string String1 is the string to be searched for and String2 is the string which replaces String A change is made only when an exact match is found including alphabetic case and spaces If no other parameters are used only the current line or marked block is searched If String is null String2 is inserted at the beginning of each line If String2 is null each occurrence of String1 is deleted To indicate null use the delimiter followed by the next delimiter for example An Editor command including multiple commands This is used to define the range of lines over which any changes are to be applied The range extends from the current position to the line that becomes the current line when the command is executed This parameter can also be a positive integer that gives the number of lines over which the changes can be made The maximum number o
27. 8 References 79 Related Reading extract Command Obtains the value of Editor parameters when REXX is active Scope File Syntax i Te a into Variable Parameter Name The name of an Editor parameter that can be queried Variable The name of a REXX variable The value of the parameter specified by Name is stored in this variable If not specified the parameter name is used as the variable Description In an Editor macro program you use the extract command to extract the value of an Editor parameter into a REXX variable This variable can then be operated on or used by program logic structures in macro program Note The extract command can only be issued as part of an Editor macro and will not extract the value of a parameter if issued from the Editor command line You can issue the query command from the command line to see the value of a parameter Example To query the doclist parameter and store its value to a REXX variable of the same name type extract doclist API Return Codes 1 Invalid item found 2 REXX not available to set variables 80 LPEX Editor User s Guide Related Reading file Command Closes all file views of the file saving the changes Scope File Syntax ieee Geese O Drive Directory Filename fasshown Jnofilelist Parameters Drive Directory Filename The drive directory and filename to which the file is saved asshown or as This option lets you save a dif
28. ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any key Any keyboard character The default character is a blank Description The space parameter defines the character that occupies the areas in the window into which nothing has been typed Example To fill blank areas with dashes type set space API Return Codes 2 The option specified with the parameter was not valid 326 LPEX Editor User s Guide Related Reading spill Parameter Sets the formatting width for elements to spill over to a new line Scope View Syntax query spill set spill Width Option Width The width in characters at which a new line begins for an element that spills over Valid values are integers between 20 and 2500 inclusive The default value is 72 Description The spill parameter sets the width at which spillover elements are formatted If an element whose format includes the spill option is longer than the spill width the line ends at a blank and a new line is started If spill is larger than formwidth it has no effect The wrap parameter must be set to on for spill to take effect Examples Suppose you have a text file that contains some elements you want to spill at a lengt
29. Check that the file name is correct and is preceded by the correct path name Use the Open dialog or relevant commands to try to locate the file to make sure it exists 3 No Filename was specified Issue the command again with a valid file name Specify a path name if necessary 4 The Editor expects the first line of the macro file to be a comment and starting with but it is not First make sure that you have called the correct file If the file is correct edit the file to include a comment on the first line Related Reading macrodrop Command Removes a macro from internal storage Scope Global Syntax gt macrodrop MacroName Lr Chapter 8 References 103 Option MacroName The name of the macro to remove Description The macrodrop command removes the named macro from internal storage Any path specified is not used The extension must be appended if it is not Axl Example To remove the test macro type macrodrop test API Return Code 1 The Editor cannot find the file Related Reading macroload Command Preloads an Editor macro into internal storage Scope Global Syntax P macroload Path Mac re Name _ ___ _ _ rg Options Path The path to be used instead of LPATH MacroName The name of the macro to preload Description The macroload command preloads an Editor macro into internal storage Preloading macros provides faste
30. Command insert Command keyread Command lineread Command load Command lx Command lxc Command Ixi Command lxn Command lxr Command macro Command macrodrop Command macroload Command mark Command msg Command mult Command next Command openclose Command prefixprocess Command prefixrenumber Command preserve Command prev Command primitive Command print Command iv LPEX Editor User s Guide 58 59 59 60 62 62 67 67 70 70 71 73 74 75 76 78 78 79 80 81 82 85 85 86 89 90 92 93 94 94 95 96 98 99 100 101 102 103 104 105 108 109 110 111 112 112 113 114 115 116 qquit Command query Command quit Command quitview Command record Command repeat Command reset Command restore Command save Command saveall Command scroll Command set Command setoldlines Command showfont Command sort Command splitjoin Command sshow Command start Command submit Command substitute Command top Command trigger Command undo Command unlink Command Parameters Summary accelerator Parameter action Parameter actionbar parameter actionbarid parameter actionbarlist parameter actionlist Parameter actionprefix Parameter actionprefixlist Parameter actions Parameter alarm Parameter autochanges Parameter autocheck Parameter autocount Parameter autoname Parameter autonext Parameter autoparse Parameter autoprefix Parameter autosymbols param
31. Linenumber query oldline Options Linenumber A number to be used as the old line value for the current line Description You can associate an old line value with each line in a document You can then later locate that line using the oldline option of the find command 278 LPEX Editor User s Guide Unless specifically set the old line value for a line defaults to zero Use the setoldlines command or the oldline parameter to assign an old line value to a line or set of lines Examples 1 To assign an old line value of 81 to the current line type set oldline 81 2 To query the old line value of the current line type query oldline API Return Codes 2 The option specified is not valid Related Reading overfont Parameter Sets font overlay lines Scope View Syntax query overfont n set overfont n String Options n The line on the screen for which the fonts are to be set A positive value is counted from the top of the view while a negative value is counted from the bottom of the view The value and sign used must be the same as in a previous set overlay command String A numeric string in which each digit identifies a font Digits 1 through 9 can be used Description The overfont n parameter sets the fonts explicitly for the overlay that appears on line n of the view The Stringparameter is a numeric string in which each digit sets the font for the corresponding position on the window These digits 1 thro
32. The following key names can be used either alone or in combination with the Alt or Ctrl keys Backspace Tab Backtab Enter Esc PadEnter The following key names can be used either alone or in combination with the Alt Ctrl or Shift keys Description PgUp PgDn End Home Left Right Up Down Ins Del The key parameter provides a simple way of remapping the keyboard Pressing the key identified by PhysicalkKeyName has the same effect as pressing the LogicalKeyname key Example To assign the function of the home key to Ctrl F4 type set key c f4 home API Return Code 2 The Editor could not find the specified PhysicalKeyName Related Reading Chapter 8 References 249 keylist Parameter Lists current remapped keys Scope Global Syntax query keylist Description The keylist parameter lists all the key names that have been remapped using the set key command Note This parameter cannot be used in API calls Example To list all key names that have been remapped type query keylist API Return Codes None Related Reading lastfind Parameter Sets the default parameter for the find command Scope Global Syntax query lastfind set lastfind visible up asis TextString any TextString element Num line Num Options visible Restrict search to lines that are currently displayed Must be the first parameter specified up Search upwards If used this parameter must precede th
33. To control split window border orientation with the value defined by the default parameter type set split default 3 To display the value of the split parameter type query split If this query returns DEFAULT type the following query default split 328 LPEX Editor User s Guide API Return Codes 2 An invalid option was specified Related Reading statusline Parameter Controls the display of the statusline Scope File Syntax query statusline set statusline on off inverse default Option on Display the status in an area at the top of the window If the statusline parameter is not set on the space is not reserved for the window off Do not display the statusline anywhere inverse Toggle between on and off default Status line display is controlled by the value of the default parameter Description The statusline parameter controls the display of the file or view status The status shows the insert replace mode and the cursor position within the file the number of changes since the last update and whether or not browse mode is on If the value of the statusline parameter is default status line display is controlled by the value of the default parameter Note The width for the statusline parameter is fixed so you cannot use the scroll bar to display any text which is not in view You must open the Macro Log to view the text Examples 1 To display the file status type Chapter 8 Reference
34. a document and if present displays a menu choice on the pop up menu that will remove those blank lines The primary callback routine used to create the menu choice is shown below Macro file del_empt 1x Enable a pop up menu item if empty lines are found at the top of a file mark set predel Save the cursor position for later use top Move cursor to first line in the file extract content Get contents of first line A pair of Editor commands will be run if the pop up menu item is selected 1 run the macro called delempty 1x 2 remove the menu item from the pop up menu when done These commands are assigned to a variable for easier reading in the next section where the pop up menu item is actually created run_cmd mult macro delempty set popupmenu Delete_leading_empty_lines Check line and add pop up if first line is empty if content then do line is empty Create a pop up menu item that runs commands to first delete empty leading lines and then removes itself from the pop up menu set popupmenu Delete_leading_empty_lines run_cmd end mark find predel Restore original cursor position if still existing mark clear predel Clear the mark saving the original cursor position exit 0 This callback routine calls another macro file called delempty lx that actutally removes the leading empty lines from the file 288 LPEX Editor User s Guide
35. a thin vertical line Any new text that you type is inserted into the file at the cursor position and existing text to the right of the cursor will be shifted to the right To toggle back and forth between the two modes press the Insert key Deleting Text There are many ways to delete unwanted text To delete single characters do one of the following Press the Delete key If you are in Insert mode the character to the right of the cursor is deleted if you are in Replace mode the character that is overlaid by the cursor is deleted Text to the left of the cursor moves right to fill the resulting gap Press the Backspace key The character to the left of the cursor is deleted Text to the right of or overlaid by the cursor moves left to fill the resulting gap To delete all the text between the cursor and the end of the current line press Ctrl Delete To delete a complete line move the cursor to the unwanted line and press Ctrl Backspace Moving the Cursor Position the mouse pointer where you want the cursor to be and click mouse button 1 or Press the Up Down Left or Right arrow keys or Press the Home key to move the cursor to the beginning of a line or the End key to move it to the end of a line or Press Alt Left arrow to move the cursor one word left or Alt Right arrow to move it one word right or Press the Page Up or Page Down keys to move the cursor up or down one window at a time or Pres
36. adds or drops the current line from the pending list of lines waiting to be processed by the parser Lines are added to the pending list if a parser has been specified by the set parser command and the text content of the lines is changed A line is also automatically added to the list if the parser has been specified and the line becomes the current line after another line is deleted Lines can be changed by commands such as insert or set content or by overtyping If a line is changed by overtyping it is added to the list when the cursor is moved off the line The query pending command indicates whether the current line is on the pending list because of changes Examples 286 LPEX Editor User s Guide 1 To see if the current line is on the pending list type query pending 2 To drop the current line from the pending list type set pending off 3 To add a line to the list following a change to the content of the line type set pending change API Return Codes 2 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading popupinit Parameter Specifies a command or callback routine to be run when the pop up menu is raised in the Editor window Scope Document Syntax set popupinit drop Command query popupinit Options Command A command or callback rou
37. already been run in the current editing session you must first unlink that external command before running the new version The query linked command lists the commands currently linked Note This command cannot be used in API calls Example To unlink the command match type unlink match API Return Code 1 Command not found 2 No command name specified Related Reading 142 LPEX Editor User s Guide Parameters Summary The Editor window is fully programmable through the use of an extensive Editor command and parameter set You can use commands and parameters to customize the Editor window search for or change text in your document or perform many other functions Select a parameter from the list below to display complete reference information for that parameter Parameter Name Description Sets the accelerator for a given menu item Attaches an action to a logical key Modifies the contents of the Editor window menu bar and pull down menus Returns the id of a menu bar pull down item Query only Lists user defined pull down menus Query only Lists the logical keys to which commands have been assigned Query only Attaches a prefix action to a logical key Used to get a list of all prefix commands defined for the current document Query only Enables action keys Sounds the alarm on next screen refresh Sets the number of changes since last save or autosave Enables automatic c
38. any if either or is used type set synonym 1 find up any API Return Codes 2 The Length parameter must be a positive number greater than 1 and less than 25 Issue the set synonym command again with a valid Length Related Reading synonymlist Parameter Lists current synonyms Scope File Chapter 8 References 335 Syntax query synonymlist Description The synonymlist parameter lists synonyms set for the current file Example To list all synonyms for the current file type query synonymlist API Return Codes None Related Reading tabcursorpos Parameter Moves the cursor to the specified column within the line allowing for tab characters expanded to spaces Scope View Syntax query tabcursorpos set tabcursorpos ColumnNumber Option ColumnNumber The column where the cursor is to be positioned Description The tabcursorpos parameter moves the cursor to the specified column within the line regardless of the window size The columns that form the prefix area are assigned negative numbers If the new position is beyond what is currently displayed the window will scroll right or left to display it Note If the expandtabs parameter is set to on each space used to expand the tab character in the Editor window is counted as a column Example 336 LPEX Editor User s Guide To set the cursor to column 34 type set tabcursorpos 34 If column number 34 is not currently displayed the wi
39. blank line Executes all commands found in the prefix entry fields Reorders the numeric part of the prefix data into unique ascending numbers Command Name Description Saves current settings to be restored later Moves current position to previous object line level class or word Performs a keyboard or other simple function from a macro Prints the current document Quits from current file view without saving changes Queries one or more parameters Quits current file view if no changes have been made Quits current file view Records keystrokes to a macro file Repeats a command a specified number of times Resets selected Editor settings to their initial value Restores file status Saves the contents of the current editing window into a file Invokes an Editor command or macro after saving user specifiable set of modified files Scrolls a specified number of lines or columns of the file Specifies the value for an Editor parameter Sets the oldline value for each line to its current line number Displays the content of the character set Sorts lines of text Splits a line or joins two lines Refreshes a file view Invokes an operating system command to run in a separate process Invokes an Editor macro to run on a secondary thread thereby allowing the user to continue interacting with the Editor Causes symbol substitution Moves the cursor position to the top of the file Enables live
40. both are displayed on a tool bar button Sets the position used after trigger processing Unprotects a line with listed classes Identifies the Editor version Query only Displays the name of a specific view Query only Lists current view numbers Query only Sets the name of the current view Displays the number identifying the view Query only Changes the visibility of the current Editor window Displays a unique number which identifies a window to the operating system Query only Sets the position and size of a view window Sets the prerequisites for displaying a window Defines the valid characters for an Editor word Enables or disables wrapping of elements for the display accelerator Parameter Allows the setting and querying of a shortcut key associated with a menu item Scope File Syntax query accelerator Chapter 8 References 151 set accelerator Name Key Options Name Either the name for a defined Editor menu item or a numeric value for a user added item The numeric value can be obtained using the query actionbarid command Key A key name Any of the key name formats valid for the action parameter are valid Description The accelerator parameter associates a function key with a menu item This attribute can also be set for menu items you have created with the set actionbar command Example To set the accelerator for the Save menu item to F2 type set accelerator
41. close only the current view of a file do the following 1 Select File from the Editor menu bar 2 Select Close view from the resulting pull down menu The selected view is closed If this is the last view of a given file the Editor will warn you if there are unsaved changes and give you an opportunity to save those changes Closing a ring To close a ring and all file views in it do the following 1 Select File from the menu bar of the Editor window that contains the ring you want to close 2 Select Close ring from the resulting pull down menu All file views in the current ring are closed If the last view of any file is being closed the Editor warns you of any unsaved changes and gives you an opportunity to save them Related Reading 20 LPEX Editor User s Guide Chapter 3 Editor Commands and Parameters The Editor is fully programmable through the use of an extensive command and parameter set You can use commands and parameters to customize your Editor window search for or change text in your document or perform many other functions You can find more information about using commands and parameters in the related readings below Related Reading Issuing Editor Commands Issuing Editor Commands You can use Editor commands to customize the Editor window search for or change text in your document or perform many other functions The Editor is fully programmable through the use of an extensive Edit
42. column will be removed n Shift the data between the two commands ncharacter positions to the left Any data in the first n columns will be removed Related Reading SEU Editor Personality The following is a list of the SEU prefix area commands that you can use in the Editor window Select the SEU editor personality by selecting Options gt Key behavior in the Editor window To process SEU commands type the commands you want to use over the sequence numbers in the prefix area hold down the Alt key and then press Enter Roll the member forward one line n Roll the member forward n lines Roll the member backward one line n Roll the member backward n lines n Type a sequence number to position the line identified by that value as the first line on the display A Move or copy lines after this line An Move or copy lines after this line and repeat these lines n times B Move or copy lines before this line Bn Move or copy lines before this line and repeat these lines n times 374 LPEX Editor User s Guide Cn CC CR CR 1 CCR Dn DD F IP IS IS n LL LL n LT IT n LLT LIT n Copy this line to the specified target Copy this and the following n 1 lines to the specified target Copy the block of lines between the two CC commands Copy this line to multiple specified targets Copy this and the following n 1 to multiple specified targets Copy the block of lines between the
43. column within the Editor Scope View Syntax query cursorcol set cursorcol ColumnNumber 192 LPEX Editor User s Guide Option ColumnNumber The window column where the cursor is to be positioned Description The cursorcol parameter moves the cursor to the specified column within the Editor The columns that form the prefix area are assigned negative numbers If the window width is less than the specified ColumnNumber a message is displayed and the cursor remains in its current position The cursor will not be moved beyond the rightmost column on the Editor Example To set the cursor to column 34 type set cursorcol 34 If the window width is less than 34 columns a message is displayed and the cursor remains in its current position API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading cursorpos Parameter Moves the cursor to the specified column within the line Scope View Syntax query cursorpos set cursorpos ColumnNumber Option ColumnNumber The column where the cursor is to be positioned Description Chapter 8 References 193 The cursorpos parameter moves the cursor to the specified column within the line regardless of the window size The columns that form the prefix area are assigned negative numbers If the new position is beyond what is currently displayed the file view will scroll right
44. columns col left as blank space at the beginning of each line where a column is the average width of a character in the chosen print font Print copies of the document The print command lets you specify how and which text is printed Print options once chosen remain in effect for the current Editor window until explicitly changed using either the print command or the Print options window An option not explicitly set with the print command uses if one Chapter 8 References 117 exists a value acquired from a previous print operation If no value exists from a previous print operation a value is applied from the following default print options printer Most recently used in the previous Editor window driver Most recently used in the previous Editor window fontsize Most recently used in the previous Editor window visible off tokenized off linenumbers off startmargin 0 zero copies 1 one Print options can be initialized for an editing session even if no document is open Example A sample print command print printer ibm4201p driver ibm42xx ibm fontsize 8 visible off tokenized The printer and driver options are set to specify an IBM Proprinter as the target printer The document is printed using 8 point character size all lines are printed and token attribute highlights are sent to the printer API Return Codes 8 Not enough resources to print 4 Incorrect parameter specified for print command 1 Unable
45. create the menu choice in the My tools pull down menu is shown below Macro file del_emp 1x Enable pull down menu item if empty lines found at the top of a file mark set predel Save cursor position for later use top Move cursor to first line in file extract content Get contents of first line A pair of Editor commands is run if the pull down menu item is selected 1 run the macro called delemp 1x 2 remove menu item from the pull down menu when done These commands are assigned to a variable for easier reading in the next section where a pull down menu item is actually created run_cmd mult macro delemp set actionbar My_tools Delete_leading_empty Check line and add pull down menu item if first line is empty Chapter 8 References 331 if content then do line is empty Create pull down menu item that runs commands to delete empty leading lines then remove itself from the pull down menu set popupmenu Delete_leading_empty run_cmd end mark find predel Restore original cursor position if still exists mark clear predel Clear mark saving the original cursor position exit 0 This callback routine calls another macro called delemp Ixthat actually removes the leading empty lines from the file Macro file delemp 1x Find and remove leading empty lines mark set predel Save the cursor position for lat
46. entry field of the Name a mark dialog box 5 Click on OK Finding a Named Location Mark To move the cursor to a named mark do the following 1 Select Edit from the main menu bar 2 Select Locate from the resulting pull down menu 3 Select Mark from the cascading menu 4 A Locate Mark dialog box appears highlight the name of the mark you want to move to 5 Click on OK Using a Quick Location Mark To mark one cursor position quickly you can use the Quick Mark feature as follows 1 Move the cursor to the position where you want to set a mark 2 Select Edit from the main menu bar 3 Select Set quick mark from the resulting pull down menu A quick mark is set at the chosen position in your file To find a quick mark do the following 1 Select Edit from the main menu bar 2 Select Locate from the resulting pull down menu 10 LPEX Editor User s Guide 3 Select Quick mark from the next pull down menu The cursor is moved to the position marked by the quick mark You can have only one quick mark per document view Setting a new quick mark will cause a previous quick mark to be lost You can also find a quick mark using the procedure described in Finding a Named Location Mark above The quick mark will appear in the list of named marks as QUICK Related Reading Finding Text or Locations in a File Finding a Specific Line in a File A quick way to find a specific line in a file is to use th
47. file list to 10 type set recentsize 10 2 To query the current value of the recentsize parameter type query recentsize Chapter 8 References 311 API Return Codes 2 Invalid value specified forNumber Related Reading recording Parameter Enables recording of changes made to a document Scope Global Syntax set recording on off inverse query recording Options on Enable recording of changes made to a document off Disable recording of changes made to a document inverse Toggles between on and off Description If the recording parameter is set to on the Editor records changes made to a document These recorded changes can later be used by the undo command to undo or redo those changes If the recording parameter is set to off you will not be able to undo or redo changes to your document Examples 1 To enable recording of changes type set recording on 2 To obtain the value of the recording parameter type query recording API Return Codes 312 LPEX Editor User s Guide None Related Reading resolve Parameter Displays a message describing the command to be run Scope Global Syntax query resolve Name Option Name This can be an Editor macro synonym or native command If it is a command that contains a period such as font doc or mark the period must be included in the Name Description The resolve parameter displays a message describing the command that would b
48. following example assigns lowercase and uppercase umlauts to the Alt A and Ctrl A key combinations respectively The lowercase umlaut is represented by ascii code 132 and the uppercase umlaut is represented by ascii code 142 set key A A 132 lowercase umlaut set key C A 142 uppercase umlaut Chapter 5 Customizing Editor Appearance and Function 27 Note Ctrl and Alt key combinations do not differentiate between uppercase and lowercase characters For example using Alt a or Alt A in any Editor command yields the same result Set action command lets you program the logical keyboard and assign a command or set of commands to a key This programming relates to a single file so the same key can have a different effect for different files When a key is pressed the Editor performs an action dictated by the corresponding logical key Many keys have default actions Any key can be assigned an action using the set action command For example the following command makes the F7 key scroll the text in a window up one screen set action F7 scroll screen up Your operating system may reserve some keys such as F1 and F10 The set key command is sometimes more useful than a set action because remapping using set key is global For example you could define the Ctrl H key as the help key in all files by using the following Editor command set key C H Fl Related Reading Changing Text and Background Color Palettes The Editor uses a se
49. follows starting with the first line in the current file 1 The command is applied against the contents of the current line 2 If the current line does not change as a result of running the command that line is added to the displayed lines and processing moves to the next line in the file 3 If running the command causes the current line to change the new current line is displayed and processing continues with the line following the new current line 4 Processing stops when the end of the file is reached Depending on the command specified the contents of the file may or may not change Using commands such as add or delete will result in changes to the file Using other commands such as the find command may result in only a subset of lines in the file being displayed but will not change the original contents of the file For example issuing the command all find asisa_non existent_word results in no lines being displayed All lines of the file can be redisplayed by issuing the all command without specifying a command Examples 1 To display only those lines containing string type all find any string 2 To display all lines type all Chapter 8 References 61 API Return Code 3 Specify less than 29 ClassNames The all command itself occupies one class name so even though the maximum number of class names is 30 you must specify less than 29 class names Related Reading begin Command Moves the curs
50. if no number is specified the first available position is used Command The action or actions to perform when the tool bar item is selected Description The toolbar parameter sets the tool bar menu by adding or removing user defined items from the tool bar It can also remove default Editor window tool bar items If only the name of an existing tool bar item is given when setting the toolbar parameter that item is deleted from the tool bar menu When specifying the name of user defined tool bar items Name is case sensitive You must enter the tool bar item text name exactly as it appears Where a space appears substitute the underscore character _ Default Editor window tool bar items must be referred to by their reserved names as listed below Tool bar Item Reserved Name for Item New LP_NEW 340 LPEX Editor User s Guide Open Save Print Undo Redo Cut Copy Paste Select all Deselect all Find Compare Start recording Stop recording Playback recording Fonts Colors Ring manager Next in ring Previous in ring Next ring Previous ring Help index General help Using help Examples LP_OPENEDIT LP_SAVE LP_PRINT LP_UNDO LP_REDO LP_CLIPCUT LP_CLIPCOPY LP_CLIPPASTE LP_SELALL LP_DESELALL LP_FINDCHANGE LP_COMPARE LP_RECSTART LP_RECHALT LP_RECPLAY LP_FONTS LP_TOKENS LP_RINGCONFIGURE LP_NEXTINRING LP_PREVINRING LP_NEXTRING LP_PREVRING LP_HELPINDEX LP_GENERALHELP LP_USINGHELP 1 To r
51. in front of the text string are included in the new line but trailing blanks are ignored Example To insert a new line of text This is a new line of text after the current line type insert This is a new line of text If the current line is followed by another line and not by a break the inserted line is merged with the following line API Return Code 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading Chapter 8 References 93 keyread Command Waits for a key to be pressed Scope Global Syntax Pe keyread _ _ esses Description The keyread command waits for a key to be pressed The value can then be queried using query lastkey Note that any key strokes corresponding to operating system functions will not be detected Example To wait for a key to be pressed type keyread API Return Codes None Related Reading lineread Command Produces a dialog that reads a string of characters Scope Global Syntax he lineread Length Eese o o S TextString Parameters Length Maximum number of characters to be input including the initial text The length can be wider than the physical screen 94 LPEX Editor User s Guide TextString Initial text to appear inside the text entry box Description The lineread command requests a line of input from the user A dialog is displayed with a text entry box and three pushbutton
52. in this line n character positions to the right gt gt Shift the data between the two gt gt commands one character position to the right gt gt n Shift the data between the two gt gt commands n character positions to the right lt Shift the data in this line one character position to the left lt n Shift the data in this line n character positions to the left lt lt Shift the data between the two lt lt commands one character position to the left Chapter 8 References 373 lt lt n Shift the data between the two lt lt commands n character positions to the left Shift the data in this line one character position to the right Any data that appeared in the last column will be removed n Shift the data in this line n character positions to the right Any data in the last n columns will be removed Shift the data between the two commands one character position to the right Any data that appeared in the last column will be removed n Shift the data between the two commands ncharacter positions to the right Any data in the last n columns will be removed Shift the data in this line one character position to the left Any data that appeared in the first column will be removed n Shift the data in this line n character positions to the left Any data in the first n columns will be removed jack mac Shift the data between the two commands one character position to the left Any data in the first
53. item or menu choice Chapter 8 References 269 off Disables the menu bar item or menu choice inverse Toggle between on and off Description The menuactive parameter enables or disables menu bar items or sub menus The action is performed on the window for the current file view Disabling an item does not disable any accelerator key this must be done using an appropriate set action command Similarly enabling an item does not activate the accelerator key The following list defines the names of the predefined Editor items and the English content of each item Menu ID Description Menu ID Description or Name or Name LP_SYSMENU System menu LP_TOOLBAR_HELP Hover help LP_FILE File LP_TOOLBAR_STYLE Style LP_NEW New LP_TOOLBAR_BOTH Graphic and text LP_OPENEDIT Open LP_TOOLBAR_GRAPHIC Graphic only LP_NEWVIEW Open new view LP_TOOLBAR_TEXT Text Only LP_GET Get LP_RING Ring LP_SAVE Save LP_RINGSINGLE Single window LP_SAVEAS Save as LP_RINGNEW New ring LP_SAVEALL Save all LP_RINGEXPLODE All new rings LP_CLOSEVIEW Close view LP_RINGSPLIT Split ring LP_CLOSERING Close ring LP_RINGCONFIGURE Configure rings LP_PRINT Print LP_RINGDEFAULT Default to ring LP_COLLAPSE Minimize all LP_RINGSELECTOR Ring selector LP_CLOSE Exit LP_SPLIT Split orientation LP_EDIT Edit LP_VERTICAL Vertical LP_UNDO Undo LP_HORIZONTAL Horizontal LP_REDO Redo LP_WRAP Wrap LP_CLIPCUT Cut LP_VIEWSPLIT Split window LP_CLIPCOPY Copy LP_ACTIONS Action
54. longer be changed 2 Invalid argument specified 3 The Format string is not valid 8 Insufficient storage to continue Related Reading prefixprotect Parameter Enable or disable text entry in the displayed prefix area Scope View Syntax query prefixprotect set prefixprotect on off inverse Option on Disable text entry in the displayed prefix area off Enable text entry in the displayed prefix area inverse Toggles between on and off Description The prefixprotect parameter controls whether text can be entered in the displayed prefix area The Editor reads this parameter only when the prefixshow parameter is used to enable the display of text or numbers in the prefix area Example To disable text entry in the displayed prefix area type set prefixprotect on Chapter 8 References 301 API Return Codes 2 Invalid parameter argument Related Reading prefixshow Parameter Displays the prefix data in the left margin of the current view Scope View Syntax query prefixshow set prefixshow text numbers on off inverse default Option on Displays the prefix data off Hides the prefix data inverse Toggles between on and off default Prefix data display is controlled by the value of the default Description The prefixshow parameter controls whether the prefix data is displayed The prefix data is stored in the prefix parameter associated with each line If the value of the prefixshow
55. lp_save F2 For a list of predefined Editor names see the API Return Code 2 Invalid parameter Related Reading action Parameter Assigns a command to a logical key Scope File Syntax query action prefix KeyName set action prefix KeyName Command 152 LPEX Editor User s Guide Options Command prefix KeyName Command which may include the mult command If Command is omitted the key is set to its default action which is to return its own value If this option is specified the key is active only when the cursor is in the prefix area Your operating system may reserve certain function keys or key combinations such as F1 for special purposes With these exceptions permitted values for KeyName are nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnnor xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any letter key An alphabetic character of value A to Z or a to z inclusive c a to c z Ctrl letter keys c 0 to c 9 Ctrl number keys The number keys on the numeric keypad are excluded a a to a z Alt letter keys a 0 to a 9 Alt number keys The number keys on the numeric keypad are excluded f1 to 12 Function keys s f1 to s f12 Shift Function keys c f1
56. mark can be specified by its name if it is a named mark or by its id number If Name or Id is not specified the last mark created is queried Examples 1 To get the id number of the named mark mark1 type query markid mark1 2 To get the id number of the unnamed mark with id number 765 type query markid 765 3 To get the id number of the mark most recently created type query markid API Return Codes 266 LPEX Editor User s Guide None Related Reading markinclude Parameter Gives the include setting of a mark Scope View Syntax query markinclude Name Id Options Name The name of a named mark to query Id The id number of an unnamed mark to query Description If the specified mark is included the markinclude parameter will return a value of on Otherwise it returns a value of off A mark can be specified by its name if it is a named mark or by its id number If Name or Id is not specified the last mark created is queried Example 1 To get the include setting of the named mark mark1 type query markinclude mark1 2 To get the include setting of the unnamed mark with id number 765 type query markinclude 765 3 To get the include setting of the mark most recently created type query markinclude API Return Codes Chapter 8 References 267 None Related Reading marklist Parameter Displays a list of mark names set in the current file Scope File Syntax query marklist
57. name for the macro according to its purpose e If the macro will be run when a specific event occurs such as when the Editor window is started or when a file is saved or loaded use the naming conventions described in Macros and Profiles and Using Profiles to Modify Editor Behavior Note A profile is a special type of macro e If you are creating an ordinary macro that will be run using the Editor macro command name the macro filename lx where filename can be any name except profile 2 Create a new text file 3 Place the commands you want to issue in the text file The first line of the macro must start with a comment Comments begin with and end with the symbols Editor commands within the macro must be enclosed in single or double quotation marks If you need to extract information from the Editor use the extract command 4 Save the file 5 Ensure that the file is in a directory that is on your LPATH Note Unless you issue a sshow command the Editor does not refresh information displayed in the Editor window until after a macro finishes running See the repeats sample macro for a detailed example of how to create a macro Related Reading Specifying Conditions in Editor Macros Conditions in macros are based on true or false comparisons Depending on the type of macro instruction specifying a condition if a specified condition is 36 LPEX Editor User s Guide true an action is either taken or continues
58. on and off Description The autocheck on parameter automatically takes checkpoints at various points for example whenever the cursor moves to a new line or when Chapter 8 References 165 another file becomes current Each checkpoint records a state of the file You can return to any of these states with the undo command When autocheck is off you are responsible for taking manual checkpoints You can take manual checkpoints using the check command or the Set checkpoint selection from the Edit pull down menu Example To set up automatic checkpointing type set autocheck on API Return Code 2 The option you specified was not on off or inverse Related Reading autocount Parameter Sets the number of changes before the next autosave Scope File Syntax query autocount set autocount Number Option Number Number of changes required before an autosave The default is 50 and the maximum is 32767 Description The autocount parameter sets the number of changes you can make before the file is automatically saved The file is automatically saved using the autoname if the number of changes since the last save or autosave or since the file was loaded if no previous autosave equals or exceeds the autocount value and no key has been pressed for idletime seconds You can use query autochanges to determine the number of changes since the last save or autosave 166 LPEX Editor User s Guide Note Setting autocou
59. outside the valid range or not a whole number Issue the command again using a valid number Related Reading dispwidth Parameter Queries the width of the Editor window Scope View Syntax query dispwidth set dispwidth Number Option Number The file view width The width must be greater than 19 Description The dispwidth parameter queries the width of the Editor window The file view scrolls sideways when the cursor reaches the window frames if dispwidth is less than the longest line the formatter produces Examples 1 To query the width of the view type query dispwidth 2 To set the width of the view to 20 type set dispwidth 20 API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number 200 _LPEX Editor User s Guide Related Reading doccontent Parameter Stores the result of the last text import operation in the file Scope File Syntax query doccontent set doccontent docOK docUpdateCancelled docTruncated docLimitExceeded Options docOK No recorded warnings or errors for updates to this file docLimitExceeded The text length limit was exceeded in a line The update to the line has been accepted as is docTruncated The text length limit was exceeded in a line The content of the line has been truncated docUpdateCancelled The text length limit was exceeded in a line The update to the line has been cancelled
60. parameter is default prefix data display is controlled by the value of the default parameter Examples 1 To remove prefix data from the current Editor type set prefixshow off 2 To control prefix data display with the value defined by the default parameter type set prefixshow default 3 To display the value of the prefixshow parameter type query prefixshow If this query returns DEFAULT type the following query default prefixshow 302 LPEX Editor User s Guide API Return Codes 2 Invalid or missing parameter argument Related Reading profiles Parameter Specifies profiles to be used by the Editor Scope File Syntax query profiles set profiles Options load user save Description load user save If present when a file is loaded the extension dependent load macro profile is called after the file is loaded The name of the load macro is the same as the doctype setting which is usually the same as the file extension The load macro s extension is lxl This macro is used for extension dependent settings and especially for invoking the initial parser for the file If the user profile profile Ix exists it is called after the file is loaded and after the system profile and the load macro have been called If the save macro exists when save is called it is called to set the formatting defaults The name of the save macro is the same as the doctype setting and has an extension of I
61. programmable editor that can be used to create and edit many kinds of files including programs documentation and data files In addition to basic editing functions the editor also offers the following features Language parsing uses automatic indenting color and text effects to emphasize different parts of your source program such as programming language keywords logic structures comment lines and arithmetic operators Locations marking facilities let you define bookmarks that let you move quickly from one location to another within your source file Elaborate search facilities let you specify the precise scope of the search In addition to locating specific character strings editor search facilities will also accept regular expression search strings that can finding matching search patterns in your source file Multiple editing views let you have more than one file open for editing at a time Multiple editing windows let you open multiple views of the same file for editing letting you view different parts of the file at the same time Changes to the file in any view are reflected immediately in other views containing that same file An Editor programming language lets you program elaborate macros to automate recurring editing tasks Keystroke recording facilities let you record sets of keystrokes which you can later replay or incorporate into your own macros Related Reading Copyright IBM Corp 1995 1998 2 LPE
62. query show set show on off inverse Options on Indicate show lines off Do not indicate show lines This is the default value inverse Toggle between on and off Description The show on parameter changes a line to a show line one that is displayed only to improve the presentation of the file while editing Show lines are automatically excluded when files are saved to a file To exclude show lines from the display use the set shows off command Setting the show parameter to on or off increments the change count which can be undone with the undo command Example To set the show status of a line to on type set show on API Return Codes 5 You cannot make changes to the file because the readonly parameter is set to on 2 The option you specified was not on off or inverse 322 LPEX Editor User s Guide Related Reading showcurrent Parameter Forces a temporary display of the current line Scope View Syntax query showcurrent set showcurrent on off inverse Options on Display excluded line temporarily to allow the current position to be set on it off Only visible lines are made current Excluded lines are not displayed inverse Toggle between on and off Description The showcurrent on parameter allows the current line to remain visible even if it subsequently becomes an excluded line Once the cursor is moved the line if in an excluded class is no longer visible and cannot be re selected
63. resource dll containing the new item s bitmap id The id for the bitmap contained in the resdll resource dll OrdinalNumber The position at which the menu item is inserted starting at zero Separators are included in the count Command The action or actions to perform when Subitem is selected Description The popupmenu parameter is used to add menu choices to the Editor window pop up menu and its associated pull down menus You can create completely new pull down menu sets or you can add to the contents of existing pull down menus Use text or icons to represent menu choices e If you use icons the icons must be contained in a DLL file located in a directory path included in the PATH environment variable e If you use text you can also use the following special characters in the name The underscore character _ represents a blank in the menu name The tilde before a letter in the name creates a mnemonic for the menu item t defines an accelerator for the menu item If Item Subitem or BITMAP is not an existing item it is created If Item Subitem or BITMAP is an existing item the following happens If a command is specified the previous command is replaced with the newly specified command If an item contains a pull down or cascaded menu you cannot change the contents of that item to a command Similarly if an item contains a command you cannot change the contents of that item to a pull down
64. s title bar prompt The text used for the entry field label Text The text to use for the appropriate area of the lineread window Description The lineread parameter sets the title line or prompt line for the next lineread command Examples 1 To set the title of the lineread window as Editor lineread window type set lineread title Editor lineread window 2 To set the prompt of the lineread window as Sample type set lineread prompt Sample API Return Code 2 Invalid option Related Reading 258 LPEX Editor User s Guide lines Parameter Gives the number of non show lines in the current file Scope File Syntax query lines Description The lines parameter gives the number of non show lines in the current file Example To obtain the number of non show lines in the current file type query lines API Return Codes None Related Reading linked Parameter Lists external commands linked to the Editor Scope Global Syntax query linked Description The linked parameter lists names of any external commands linked to the Editor Once invoked an external command remains linked until it is removed with an unlink command or the Editor is terminated The string lt Null gt is returned if no commands are linked Example To list the external commands linked with the Editor type Chapter 8 References 259 query linked API Return Code 1 You cannot issue the set command for this parameter Re
65. so you cannot use the scroll bar to display any text which is not in view You must open the Macro Log to view the text Examples 1 To set the messageline off type set messageline off 2 To control message line display with the value defined by the default parameter type set messageline default 3 To query the value of the messageline parameter type query messageline If this query returns DEFAULT type the following query default messageline API Return Code 2 The option specified with the parameter was not valid Related Reading messages Parameter Enables the display of messages Scope Global Syntax query messages set messages on off inverse Options on Messages are displayed in the information area and are logged in the Editor window macro log off All messages are suppressed inverse Toggle between on and off Description Messages are displayed in the information area when the messages parameter is set to on 274 LPEX Editor User s Guide The value of the messages parameter is saved between Editor sessions Examples 1 To display and log messages as they are generated type set messages on 2 To suppress display and logging of messages type set messages off API Return Code 2 The option you specified was not on off or inverse Related Reading modes Parameter Displays the character modes for the current line Scope File Syntax query modes Description Th
66. the trigger processing is complete type set trigpos 7 API Return Codes 2 The option specified with the parameter was not valid Related Reading unprotect Parameter Sets classes to be unprotected on the display Scope File Syntax query unprotect set unprotect ClassList Chapter 8 References 345 Option ClassList The list of classes to unprotect from modifications Description The unprotect parameter releases lines specified in the class list from protection against modifications This parameter is normally used to negate the effect of the protect parameter Example To unprotect comments type set unprotect comment API Return Codes 2 The option is not valid Related Reading version Parameter Identifies the Editor version Scope Global Syntax query version Description The version parameter displays the version of the Editor being used This is in the form Editor VxRyMz where V is version R is release and M modification level Example To display the Editor version information type query version API Return Codes 346 LPEX Editor User s Guide None Related Reading view Parameter Displays the name of a specific view Scope View Syntax query view ViewNumber Option ViewNumber The number of the view as returned from the viewnum or viewlist parameters It must be a positive integer Description The view parameter displays the name of the specified view View
67. the background color of font A to blue type set font A blue 2 To reverse the colors of a marked block from red on black to black on red type set font block reverse 3 To set the font for overlay lines type either of the following lines set font overlay yellow red set font overlay 15 5 4 To query the font effect and colors used for overlay lines type query font overlay API Return Codes 2 The FontName specified for the set font command was not found Check the spelling and form of the FontName in the command string You can also use the query fontlist command to list the current FontNames 1 The FontName specified was not valid Check the syntax requirements for the parameter and issue the parameter again Related Reading fontlist Parameter Lists the symbolic fonts that are currently set Scope View Chapter 8 References 225 Syntax query fontlist Description The fontlist command displays a string containing the symbolic font characters that are currently set separated by blanks Symbolic fonts are defined in font Parameter Use the query font command to find the characteristics of a specific font Note This parameter cannot be used in API calls Example To list the symbolic font characters type query fontlist API Return Codes None Related Reading fonts Parameter Sets the character fonts for the current line Scope Line Syntax query fonts set fonts String Option String T
68. the nosave parameter is set to on To save the file set the nosave parameter to off and then use either the file or save command to save the file The file was open in another Editor window Related Reading find Command Find a specific string or line Scope View Syntax up down mark columns numi num prefixentry block prefixte xt alldocs nowrap element checkcurrent prefixnumber nosave oldline emphasis prefixentry next previous 82 LPEX Editor User s Guide Parameters up down visible mark columns num1 num2 block alldocs nowrap checkcurrent nosave emphasis asis TextString any TextString match TextString match asis TextString element Number prefixentry prefixentry TextString prefixtext TextString prefixtext to TextString prefixnumber Number next previous oldline Number Searches upwards in the document Must precede any asis or element Searches downwards in the document Must precede any asis or element Restricts the search to visible lines For a line to be visible its class must be included in the list specified by the include parameter or excluded from the list specified by the exclude parameter If visible is not specified the Editor searches all lines and places the cursor at the closest visible point to the string when found If used visible must be specified first Marks the text as a character block or marks the line as a line block The found text w
69. the numeric part of the prefix data into unique ascending numbers Scope File 112 LPEX Editor User s Guide Syntax br prefixrenu ve kaa OC Increment Start Options Increment Specifies the increment to use when renumbering the prefix numbers If this value is not specified the increment will be 100 Start Specifies the value for the prefix number of the first line in the file If this value is not specified the starting value will be Increment Description The prefix numbers for the current file will be renumbered starting from Start and incrementing by Increment API Return Codes 1 The specified options will cause the prefix numbers to grow larger than the size specified by the prefixformat parameter 2 This command requires that there be a numeric part to the prefix data 8 Insufficient storage to continue Related Reading preserve Command Saves current settings to be restored later in the Editor window Scope File Syntax Description The preserve command saves the current values of selected Editor settings These settings are listed and described in the reset command Editor settings can later be returned to the saved values by using the restore Chapter 8 References 113 Example To save the current settings type preserve You can then change some of the values temporarily and restore the preserved set afterwards using the restore command API Return Code 9 Too many parameters we
70. the prefix area hold down the Alt key and then press Enter A Add a blank line after the current line An Move or copy lines after this line and repeat these lines n times C Copy this line to the specified target CC Copy the block of lines between the two CC commands D Delete this line Dn Delete this and the following n 1 lines DD Delete all lines between the two DD commands F Copy or move one or more lines to after the current line Insert a blank line after the current line In Insert n blank lines after the current line Move a line to the specified target MM Move all lines between the two MM commands to a specified target Copy or move one or more lines to before the current line S Show all the hidden lines in an exclude group S Show all the hidden lines in an exclude group Sn Show the first n lines in an exclude group S n Show the first n lines in an exclude group S n Show the last n lines in an exclude group X Exclude this line from the display Xn Exclude this line and the next n 1 lines from the display x Exclude the lines from the current line to the end of the file from the display XX Exclude all the lines between the two XX commands from the display gt Shift the data in this line one character position to the right gt n Shift the data in this line n character positions to the right gt gt Shift the data between the two gt gt commands one character position to the right gt gt n Sh
71. the same as the order that the classes were specified in the CLASSES command starting with the highest order bit That is the first class specified in the CLASSES command is represented by the bit 0x80000000 Description The lxqclass subroutine provides a fast way of finding out about line classes avoiding the need to do string operations that involve adding or deleting words See the classes parameter for more information Examples Before the examples below will work you must enter the command set classes DATA COMMENT CODE 1 Ifa file has three classes defined as follows 366 LPEX Editor User s Guide define DATA 0x80000000 define COMMENT 0x40000000 define CODE 0x20000000 A line belonging to both the DATA and CODE classes would return the value 0xA0000000 2 To see if an line contains both DATA and CODE using the same definitions as in the previous example type int classlist lxqclass amp classlist if classlist amp DATA amp amp classlist amp CODE printf Element belongs to both DATA and CODE classes n Return Value The return value is the return code from the Editor Related Reading Ixsclass Subroutine Issues the set class command Library Ipexapi h Include File lpexapi h C Syntax int 1xsclass long ClassList Parameter ClassList A long integer the bits of which represent the classes that are to be set for the current line Each bit represents a possible class
72. the value of the prefix data associated with the current line Sets the text to be used for the text part of the prefix data when lines are inserted or changed and the autoprefix parameter is on Specifies a format string used to display the prefix area Sets the text in the prefix entry field of the current line Defines the size and type of prefix data for the current file Enables or disables text entry in a displayed prefix data area Controls the display of the prefix area in the current edit view Sets the profiles to be used Sets the classes to protect from overtyping Displays the data content of a line without symbol substitution Query only Protects view from changes Sets command recall options Specifies the Editor command processed when a file name is selected from the recently accessed file list Specifies how the recently accessed file list is displayed Enables or disables the display of complete file paths in the recently accessed file list Specifies how many file names are maintained in the recently accessed file list Enables recording of changes made to a document Displays a message describing the command to be run Query only Enables the use of REXX Set the default ring assignment mode for new views Queries ring numbers active in the Editor Query only Chapter 8 References 149 Parameter Name 150 LPEX Editor User s Guide Description Specifies the ring number t
73. to c f12 Ctrl Function keys a f1 to a f12 Alt Function keys Chapter 8 References 153 buttonNdouble A double click on button N N 1 2 or 3 although only 1 and 2 will be usable on a two button mouse buttonNdown A single click on button N buttonNdrag Drag mouse with button N down a named key The following key names can be used either alone or in combination with the Alt or Ctrl keys Backspace Tab Backtab Enter Esc PadEnter The following key names can be used either alone or in combination with the Alt Ctrl or Shift keys Description PgUp PgDn End Home Left Right Up Down Ins Del The action parameter assigns a command to a logical key for the current file only When the assigned key is pressed the command is carried out provided the actions parameter is on A multiple command can be attached to a key using the mult command This parameter can be used to override previously defined accelerators If the accelerator was advertised on a menu it would now be incorrect To change the accelerators displayed for a menu item use the set actionbar command 154 LPEX Editor User s Guide Note The case of the key assigned to an action is ignored when used in combination with the Alt or Ctrl keys Examples 1 To assign the addition of eight lines to a key sequence Alt 8 type set action a 8 add 8 Pressing Alt 8 now adds eight lines to the file 2 To make the F7 key move the text up by the num
74. to start PrinterHandler 1 Printing cancelled by user 2 No printer selected 3 No document present to print qquit Command Quits from the current file view in an Editor window without saving changes Scope File Syntax 118 LPEX Editor User s Guide Description The qquit command quits the current file without saving changes Example To quit the current file including all views documents opened in the Editor window type qquit API Return Codes 3 Attempted to leave file while trigger processing 9 Parameter passed where none required Related Reading query Command Queries one or more parameters Syntax be query panmi d pa Description The query command displays the values of specified attributes just above the command line If the value of an item is null or just blanks one of the messages lt null gt lt blank gt or lt blanks gt is displayed for the value Parameters A list of the settings to be queried separated by blanks See the appropriate parameters for valid settings Example To display the values of some autosave parameters type query autonext autotime idletime autochanges autocount Chapter 8 References 119 API Return Code 1 The parameter is not valid First check its spelling then check this list to see if the parameter is supposed to be queried Related Reading quit Command Quits the current file view in the Editor window if no changes have been mad
75. two CCR commands to multiple specified targets Delete this line Delete this and the following n 1 lines Delete all lines between the two DD commands When editing RPG display a format line When editing RPG Show the Select Format display From this display choose the format to use Insert a blank line after the current line Insert n blank lines after the current line When editing RPG Insert a blank line and display the line in a prompt Insert a line after this line and initialize it to the data saved as the skeleton line Insert n lines after this line and initialize them to the data saved as the skeleton line Shift the data in this line one character position to the left Shift the data in this line n character positions to the left If there is any data in the first n columns the line will only shift up to the start of the data Shift the data between the two LL commands one character position to the left If there is any data in the first column the lines will shift only up to the start of the data Shift the data between the two LL commands n character positions to the left If there is any data in the first n columns the lines will only shift to the start of the data Shift the data in this line one character position to the left Any data that appeared in the first column will be removed Shift the data in this line n character positions to the left Any data in the first n columns will be removed Shift the data
76. unless otherwise specified by char Chapter 6 Macros and Profiles 43 length substr subword time trunc word wordindex wordlength words 44 LPEX Editor User s Guide str Returns the number of characters instr str num_1num_2 Returns a substring from the stringstr starting at character num_1 for a length of num_2 characters If num_2 is not specified the rest of the string is returned str num_1 num_2 Returns a substring from the stringstr starting at word num_1 for a length of num_2 words If num _2 is not specified the rest of the string is returned opts If no option is specified returns the current time in 24 hour clock hh mm ss format Some values for opts are civil Returns the time in 12 hour clock format showing hours and minutes followed by am or pm for example 12 10am hours Returns the number of hours since midnight with no leading zeros minutes Returns the number of minutes since midnight with no leading zeros seconds Returns the number of seconds since midnight with no leading zeros num_1 num_2 Returns the value of num_1 truncated or expanded to num_2 decimal places If num_2 is not specified 0 is assumed as its value str num Returns the num th word from string str If num is greater than the number of words instr the null string is returned str num Returns the character position of the first letter of the num th word in strin
77. value of the lastkey REXX variable to see how the user chose to leave the user input window A value of ENTER implies that a value was Chapter 6 Macros and Profiles 47 entered in the text input field and if so the macro will go on to extract the information entered in the user input window Related Reading extract lastline The extract command is used in this statement to retrieve or extract the value stored in the lastline parameter The extracted value is stored in a REXX variable which by default has the same name as the parameter being extracted The value stored in this REXX variable can then be used later on in the macro Related Reading if datatype lastline NUM This line uses the datatype REXX function to test the value of the astline REXX variable If lastline contains a numeric value the user has entered a valid repetition factor and the macro continues If not an error message is displayed and the macro ends Related Reading numrep lastline This line assign the value of variable lastline to the variable numrep for use later in the macro This value represents the repetition factor that will be applied to the Editor command that will later be prompted for The value of the Jastline variable is stored to another name because the lastline parameter will be overwritten later in the macro and a subsequent extract on that parameter would overwrite the value in the Jastline variable used in the ma
78. visible at a lower level type next below API Return Code 1 A parameter issued with the command is not valid Check the command syntax requirements and then issue it again with a valid parameter Related Reading openclose Command Adds or deletes a blank line Scope File Syntax amp p enc lo s e AA Oe Description If current line is blank the openclose command deletes it and sets the current position to the first non blank of the following line If the current line is not blank openclose adds a new line consisting of a single blank and sets the current position to line If the current line has flow set only a single blank is used for the content of the new line Example Chapter 8 References 111 To add a new line after a line place the cursor anywhere within the line and type openclose API Return Codes 5 You cannot make changes to the file because the readonly parameter is set to on 8 Insufficient storage to continue Related Reading prefixprocess Command Executes all commands found in the prefix entry fields Scope View Syntax prefixp roc ess H Description The prefixprocess command executes the commands in the prefix entry fields If the command in the prefix area is not defined the text is left in the prefix entry field until it is explicitly reset with the prefixentry parameter API Return Codes None Related Reading prefixrenumber Command Reorders
79. 10 LPEX Editor User s Guide recentsize Parameter Specifies how many file names are maintained in the recently accessed file list Scope Global Syntax query recentsize set recentsize Number Options Number The number of file names maintained in the recently accessed file list Number must be an integer with value of 0 to 10 inclusive If a value is not specified Number defaults to 0 Description The Editor window can display a list of the recently accessed files If the recentmenushow parameter has a value other than off and the recentsize parameter has a value other than 0 a list of recently accessed file names is displayed in the File pull down menu Files can be opened by double clicking on the file names displayed in the recently accessed file list The value of the recentsize parameter determines the maximum number of file names displayed in this list If you open or save a file whose name already appears in the recently accessed file list the name of that file is moved to the top of the list If the file name is not already in the recently accessed file list the name of that file is added to the top of the list and all other entries move down one position If adding a file name to the recently accessed file list causes the number of files in that list to exceed the value of Number the file name at the bottom of the list is removed from the list Example 1 To set the maximum number of entries in the recently accessed
80. 124 LPEX Editor User s Guide restore Command Restores file status Scope File Syntax Description The restore command sets selected Editor settings to the value they had when the preserve command was last issued Editor settings that can be preserved and restored are listed under the reset command Example Use the preserve command to save the current state of the view Change the settings to perform a task using the macro then use restore to restore the settings to the way they were at the time of the preserve command API Return Codes 2 A preserve command must be issued before you may issue a restore command 9 Parameter passed where none required Related Reading save Command Saves the contents of the current Editor window into a file Scope File Syntax Lena laude 7 Drive Directory Filename fasshown fnofile list Chapter 8 References 125 Parameters Drive Directory Filename The drive directory and filename to which the file is saved asshown or as This option lets you save a different view of the file The data is saved exactly as it is displayed at the time the command is issued nofilelist or nfl The file saved is not shown in the recently accessed file list in the File pull down menu in the Editor window Description The save command saves the contents of the current Editor window into a file If no file name is specified then the file is saved under the current file name
81. 2 The option you specified was not on off or inverse Related Reading changes Parameter Sets the number of changes made to the file Scope File Syntax query changes set changes Number Option Number The new count of changes made to the file until the next save The default is zero Description The changes parameter counts the number of changes made to the file until it is saved 184 LPEX Editor User s Guide The changes count is increased by one every time a command that changes the file is issued or a line or part line is altered by overtyping A macro that makes many alterations counts as just one change The changes count is also affected by the undo command Each set of changes undone by an undo operation decrements the count by one and each set of changes redone by a redo operations increases the count by one If you perform undo operations to a document past a file save point the count decrements until it reaches zero after which it starts incrementing The opposite occurs if you are redoing changes to a document When the file is saved Number is set to zero Setting the changes parameter explicitly also adds Number to the value of the autochanges parameter This means that the changes parameter can be used to force an autosave operation Changing the autochanges parameter does not change the changes parameter Examples 1 To display the number of changes made type query changes 2 To force an autos
82. Ctrl J End Ctrl Right Ctrl Left Ctrl C Ctrl X Ctrl V Alt L Ctrl T Alt U Alt B Alt R Alt K Alt I Alt C Alt M Alt Z Alt D Ctrl Shift tHome Ctrl Shift End Ctrl Y Enter Ctrl Enter Alt S Alt J Ctrl Delete Ctrl Backspace Backspace Delete Ctrl Z Ctrl Shift Z Ctrl K Ctrl Q Alt Q Ctrl U Ctrl N Scroll left one screen in the contents of a file view Scroll right one screen in the contents of a file view Process prefix area commands Move line with cursor to top focus line of current file view Move cursor to top of file Move cursor to bottom of file Move cursor to last position Move cursor to end of line Move cursor to start of next word Move cursor to beginning of word or previous word Copy selected text to clipboard Cut selected text to the clipboard Paste text from the clipboard Select a line of text or extend selected text by additional lines for copying moving or deleting and deselect any text selected from any other file view Select word token Unmark text selected with Alt L applies to any file view opened Select a block of text Select a rectangular block of text Convert selected text to uppercase Convert selected text to lowercase Copy selected text to the current cursor position Move selected text to the current cursor position Overlay block Delete block of text if in the current file view Select all text to start of file Select all text to end o
83. Description The rulertext parameter specifies the text to be used to label the ruler control If you issue the command query rulertext while it is set to the default text null will be returned The actual display of the ruler is controlled by the ruler parameter Example To specify the ruler for the Extension specification in RPG type set rulertext E FromfileTofile Name N rN tbLenFDSArrnamLenFDSComments API Return Codes None Related Reading screen Parameter Gives the number of rows and columns and picture elements pels in the screen 320 LPEX Editor User s Guide Scope Global Syntax query screen Description The screen parameter returns the number of rows and columns and picture elements pels in the screen It also returns the character size in pels Example To obtain the number of rows and columns and pels in the screen type query screen API Return Codes None Related Reading seconds Parameter Gives the number of elapsed seconds since the start of the Editor session Scope Global Syntax query seconds Description The length of time that has elapsed since the start of the Editor session The unit is in seconds Example To give the number of elapsed seconds since the start of the Editor type query seconds Chapter 8 References 321 API Return Codes None Related Reading show Parameter Changes a line to a show line Scope Line Syntax
84. Editor records each set of changes you make to a file in the Editor window The number of changes made since the last file save is displayed on the status line If you want to undo a set of changes to a file do the following 1 Select Edit from the Editor window menu bar 2 Select Undo 3 Repeat the above steps until all unwanted changes are undone Chapter 2 Using LPEX 5 You can also cancel the effects of an undo operation by doing the following a 2 3 Select Edit from the Editor window menu bar Select Redo Repeat the above steps until all the effects of all unwanted undo operations are cancelled Related Reading Marking and Manipulating Blocks of Text 6 The editor offers facilities that let you mark blocks of text in various ways to accomplish different results Once you have marked a block of text you can manipulate the marked block with either standard operating system clipboard facilities or the Editor s own block manipulation facilities Related Reading Marking Blocks of Text There are many ways of marking text in the Editor windows Some are described below Marking a Block of Text with the Mouse 1 2 3 Position the mouse pointer over the character that is to start the block Press and hold mouse button 1 Drag the mouse pointer to the to the end of the block of text you want and release the mouse button The block is now marked Note Marking a Block of Text using the Keyboa
85. Guide Exit Conditions An external command can have an exit clean up routine Define this in your program as int 1xexit char parm This optional subroutine can call other Editor functions such as Ixcmd find up asis needle It should release any Editor storage acquired using Ixalloc or other storage acquired using malloc and it should terminate any other processes that have been linked to earlier by the command Related Reading Sample External Command proto Inserts statements into a file Scope File Syntax proto Nane s_ HANYNYNYNSJ_aH gt a Description The proto command provides a simple mechanism for inserting statements into programs For example you could use proto to insert simple logic structures such as IF DO or WHILE or calls to other applications If you assign the mechanism to a key pressing that key when the cursor is placed on any keyword such as if expands the keyword into a prototype pattern The external command proto is assigned to the Ctrl R key by the C tokenizer parser The global variables are set up in c lxl When C or C files are open in the Editor you can use the Global Variables selection in the Options pull down menu to query and amend the variables Note You can find the source code for the proto command is in the file proto c located in the extras directory Chapter 7 External Editor Commands 53 Parameter Name Can be any prefix used to
86. If a save macro for the current doctype exists in one of the directories specified in LPATH then the save command runs the save macro before writing the file to disk The save macro is not called if the asshown option is specified Note The Editor window will be renamed to the specified filename Examples 1 To save a file to a new file name type save newname c 2 To save a file as it is displayed to a new file name type save newname c as API Return Codes 1 The filename already exists The Editor asks if you want to overwrite the existing file with this file 2 The file was saved successfully with some lines truncated 1 The filename is not valid 2 A filename must be specified for an untitled document 3 The file is empty 6 The Editor encountered an error when the file was being saved 7 The file was not saved because the nosave parameter is set to on To save the file set the nosave parameter to off and then use either the file or save command to save the file 9 The file was open in another Editor window 126 LPEX Editor User s Guide Related Reading saveall Command Invokes an Editor command or macro after saving a set of modified files Scope Global Syntax prompt EdiferMacre Options prompt Displays the Save before action secondary dialog box to allow the user to select the modified files to be saved EditorMacro Any Editor command or macro This variable is optional Description The s
87. LPEX Editor LPEX Editor User s Guide Version 4 Release 0 SC09 2795 00 LPEX Editor LPEX Editor User s Guide Version 4 Release 0 SC09 2795 00 m Note Before using this information_and the product it supports be sure to read the general information under First Edition September 1998 This documentation applies to Version 4 Release 0 of the LPEX Editor and to all subsequent releases and modifications until otherwise indicated in new editions Make sure you are using the correct edition for the level of the product Order publications through your IBM representative or the IBM branch office serving your locality Publications are not stocked at the address below If you have comments about this document address them to IBM Canada Ltd Laboratory Information Development 2G 345 1150 TOR 1150 Eglinton Avenue East North York Ontario Canada M3C 1H7 When you send information to IBM you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you Copyright International Business Machines Corporation 1995 1998 All rights reserved Note to U S Government Users Documentation related to restricted rights Use duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp Contents Notices i a Trademarks and Service Marks About the LPEX User s Guide Te
88. Level must not be negative Change the level of subsequent elements by Number relative to the current element Number can be positive higher level or negative lower level Change the level of the current and subsequent elements by Number relative to the previous element Number can be positive lower level or negative higher level Both before and after values can be specified for the same element Always start this element on a new line even if format flow is set or the element would otherwise be flowed because of the setting of the flow parameter Always start the next element on a new line even if it has format flow set or the element would otherwise be flowed because of the setting of flow parameter Wrap this element to follow the preceding element unless break or final is set on the previous line Include a blank line after this element and always start the next element on a new line Include a blank line before this element and always start this element on a new line Indicates that the element is solid The formatter must not split the element at blanks or elsewhere except when there is no other way to format the element Indicates that the element can be spilled That is the element can be formatted at the spill width rather than at the formwidth The format parameter sets or replaces the formatting controls for the current element Formatting controls are used to enhance the displayed document The last option
89. Name of the command to be issued Description The lxi command processes the command in a macro external command or command line as an interactive command and hence applies synonym resolution The Ixi command adds 1 to the changes count if one or more lines are altered during the running of the command The data checked against the list of synonyms can be in two forms e If the first character is alphanumeric all characters up to but not including the first nonalphanumeric character are processed e If the first character is nonalphanumeric all the characters up to but not including the first alphanumeric character are processed Note Use the lxr command if you want to call specific commands so as to avoid them being processed by the synonym processor Example To process a command string as an interactive command type set synonym delete 3 delete lxi del 4 API Return Codes 1 The commands in theCommand parameter were not valid Editor commands Make sure all commands are valid and if more than one command is issued make sure you have used the mult command 8 Insufficient storage to continue For other codes returned by called routines or macros see the relevant routine or macro Related Reading Ixn Command Issues an Editor command without searching for a macro in an Editor window Syntax 100 LPEX Editor User s Guide gt xn Command a Parameter Command Name of the Editor command t
90. Number contains the value that is returned from the viewnum or viewlist parameters Example To display the name of view 7 type query view 7 API Return Codes None Related Reading viewlist Parameter Lists all current view numbers Scope File Syntax Chapter 8 References 347 query viewlist Description The viewlist parameter lists numbers of all views currently open The numbers are separated by blanks Note This parameter cannot be used in an API call Example To display a list of view numbers type query viewlist API Return Codes None Related Reading viewname Parameter Sets the name of the current view Scope View Syntax query viewname set viewname Name Option Name The name to be given to the specific view Description The viewname parameter sets a name for each view when it is created The initial view is called lt null gt If no name is specified viewname is set to the view number To move to a view with a particular name use the goview command Example 348 LPEX Editor User s Guide To give the current view the name newview type set viewname newview API Return Codes 3 The name for the view was too long Related Reading viewnum Parameter Displays the number identifying the view Scope View Syntax query viewnum Description The viewnum parameter displays the number of the current view The first view has a viewnum of 1 and each successive view t
91. Only one file is open MOREVIEWS More than one view is open Only one view is open SAVEABLE File can be saved File cannot be saved WRITEABLE Changes to file permitted Changes to file not permitted Examples 1 To specify the last defined menu item to be enabled when text is selected type set group block Chapter 8 References 237 2 To specify the last defined menu item to be enabled when text in the COMMENTS class is visible type set group comments API Return Code 3 The specified menu item id does not correspond to any user defined action Related Reading help Parameter Specifies the help information associated with a user defined menu item Scope File Syntax set help MenuItemId HelpId HelpCommand Options MenultemId The numeric menu item identifier that can be obtained by the query actionbarid command If 0 or no ID value is given the ID for the last defined menu item is used Helpld Specifies the help resource id to be associated with the menu item HelpCommand Specifies the command line entry to display help for the menu item Description The help parameter associates information for providing online help for a user defined action This information can be in the form of a help panel ID or any operating system command line entry for bringing up the help Example To associate a section in a book with the last defined menu item set help view Ipxcref block API Return Codes 2 Help information is
92. Related Reading Ixnext Subroutine Issues the next command Library Ipexapi h Include File lpexapi h C Syntax int 1xnext Description The lxnext subroutine provides a faster way of issuing the next command from a C program It has the same effect as calling 1xcmd next Example To move to the next line type int rc rc Ixnext Return Value Chapter 8 References 361 Ixnext gives a return code of 1 if it is already on the last line It returns a code of 0 if successful Related Reading Ixprev Subroutine Issues the prev command Library lpexapi h Include File lpexapi h C Syntax int Ixprev Description The lxprev subroutine provides a faster way of issuing the prev command from a C program It has the same effect as calling 1xcmd prev Example To move to the previous line type int rc rc 1xprev Return Value Ixprev gives a return code of 1 if it is already on the first line It returns a code of 0 if successful Related Reading 362 LPEX Editor User s Guide Ixqtext Subroutine Issues the query content command Library Ipexapi h Include File lpexapi h C Syntax int lxqtext unsigned char Buffer Parameter Buffer A variable long enough to hold the return value The MAXQUERY constant in lpexapi h is set to the longest possible return string Description The lxqtext subroutine provides a faster way of issuing the query content comm
93. SEU XEDIT or ISPF commands when the prefix area is active You can also create your own commands by binding any editor macro or command to your own line commands The prefix area appears on the left side of the Editor window and may display line numbers and or the date Line numbers are maintained by the 32 LPEX Editor User s Guide Editor Refer to related readings below for more information on using prefix area commands for specific editor personalities Related Reading Chapter 5 Customizing Editor Appearance and Function 33 34 LPEX Editor User s Guide Chapter 6 Macros and Profiles Much of the Editor s flexibility come from profiles which are text files containing Editor commands A profile is a specialized form of an Editor macro file Some of the profiles supplied with the Editor provide specific editing features and run automatically at specific times You can also define your own profiles and macros and run them at any time you want The standard Editor profiles are kept in the macros directory You can edit these profiles directly but if you change them incorrectly the behavior of the Editor may be affected Instead if you need to modify the behavior of the Editor do so by defining new profiles See Using Profiles to Modify Editor Behavior for more information The following types of profiles are provided with the Editor xxx Ixs This profile if it exists runs whenever a file with filename typexxxis s
94. The order of the bits is the same as the order that the classes were specified in the CLASSES command starting with the highest order bit That is the first class specified in CLASSES command is represented by the bit 0x80000000 Description The Ixsclass subroutine provides a fast way of setting line classes avoiding the need to do string operations that involve adding or deleting words Chapter 8 References 367 Example To set a line as belonging to both the DATA and CODE classes type define DATA 0x80000000 define COMMENT 6x40000000 define CODE 0x20000000 1xsclass DATA CODE Return Value The return value is the return code from the Editor Related Reading Ixalloc Subroutine Gets storage Library lpexapi h Include File lpexapi h C Syntax char lxalloc int Size Parameter Size The amount of storage to be allocated in bytes Description The lxalloc subroutine is used to get storage Example To allocate 1000 bytes of memory type char p p 1xalloc 1000 Return Value 368 LPEX Editor User s Guide The return value is the return code from the Editor Related Reading Ixfree Subroutine Frees storage obtained by Ixalloc Library Ipexapi h Include File lpexapi h C Syntax void 1xfree unsigned char Pointer Parameter Pointer A valid address for the memory block Description The Ixfree subroutine is used to free any storage allocated by Ixalloc Exam
95. X Editor User s Guide Chapter 2 Using LPEX Starting the Editor To start the Editor do any of the following e At a command line prompt type iedit filename ext where filename ext is optional and represents the name of the file you want to edit e If you have an icon for the LPEX Editor installed on your desktop double click on the icon Related Reading Getting Help The LPEX Editor provides a variety of online help Getting Help for an Item in a Window To access help for a specific item on a LPEX Editor window select the item you want help for then press the Help key F1 A window appears showing the help text associated with the item Using the Help Menu Selecting Help from the menu bar on any LPEX Editor window opens a pull down menu that lets you choose from several types of online help and reference information Working with Text Entering and Editing Text Entering Text e Click in the working area of the Editor window and begin typing Copyright IBM Corp 1995 1998 4 To type on the command line click in the command line area or press the Esc key and then begin typing Replacing and Inserting Text The status line indicates which mode the Editor is in When the Editor is in Replace mode the cursor appears as a solid block one character width in size Text overlaid by this block will be replaced by any new text that you type When the Editor is in Insert mode the cursor appears as
96. a new document in a new ring type godoc newring name mynewdoc API Return Codes 1 You typed a parameter that is not valid 2 DocumentNumber must be in the range 1 to 9999 3 There was an attempt to move to a new document during trigger processing 4 Exceeds the maximum number of views in a ring Related Reading 88 LPEX Editor User s Guide goring Command Move to or create a new ring in an Editor window Scope Global Syntax next prev next split prey split new split ringnum Number Parameter next prev next split prev split new split ringnumNumber Description Move to the next ring Move to the previous ring Move to the next split file view within an Editor window Move to the previous split file view within an Editor window Create a new ring with the current file view within an Editor window Create a new ring with the current file view An Editor window is split to contain the new ring Move to the ring number specified by Number Number must be a positive integer value greater than 0 Use the goring command to move to or create new rings in the current editing session Specifying the goring command without parameters moves you to the previous ring Specifying the new parameter has no effect on a file view that is already the only member of its ring Examples 1 To move the current file view into a new ring type goring new 2 To move to ring number 6 a
97. able Description The docvar parameter assigns a value to a variable global to all file views of the current document Such global variables remain until all file views of the document are closed They may be set or queried from any file view of the document in which they are defined Examples 1 To display the value of a global variable called x type query docvar x 2 To assign the value company name to a global variable calledx type set docvar x company name API Return Code 1 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set or query command again Related Reading docvarlist Parameter Lists names of variables global to all file views of the current document Scope File Syntax query docvarlist Description The docvarlist parameter lists global variables set for the current document Example To list the names of global variables set for the current document type query docvarlist API Return Codes Chapter 8 References 205 None Related Reading drive Parameter WN Changes the drive used by Editor processes Scope Global Syntax query drive set drive drive name Option drive name The letter of the disk drive you want to use for Editor processes Description The Editor locks the directory in which it was started This means that it is not possible to remove that directory as long as the current instance of the Editor is acti
98. acter of the first line in the file Example To move the cursor to the top of the file type top API Return Code 9 Parameter passed where none required 138 LPEX Editor User s Guide Related Reading trigger Command Enables live parsing of pending lines Scope File Syntax Be trigge r Aaa AAA AA rr Description The trigger command causes live parsing of pending lines This command calls the live parser which is specified by the set parser command for each line on the pending list This list contains those lines whose content has changed since the last live parsing or since the set parser command was issued Lines changed by the parser are not added to the list of changed lines so you do not have to turn off the parser during trigger processing During live parsing the current line and position are saved They are restored when all the changed lines have been processed To change the current position use the set trigpos command Lines can also be added to or deleted from the pending list with the set pending command If autoparse is on then pending lines are parsed automatically Example To start live parsing type trigger API Return Code 9 Too many parameters were issued with the command Chapter 8 References 139 Related Reading undo Command Undo one or more sets of file changes Scope File Syntax hr undo Number Number Parameter Number A positive or negative i
99. ain the current file number type query docnum API Return Codes None Related Reading doctype Parameter Sets file type Scope File Syntax query doctype set doctype ExtensionName Option ExtensionName The extension given to the filename when it is saved Blanks are allowed Description The doctype parameter sets or returns the filename extension that is used when the current file is saved A file with no extension is given a doctype of LPEX when it is created Examples 1 To find out the file type type query doctype 2 To call a COBOL macro when a file is saved or autosaved type set doctype cbl API Return Codes 2 The ExtensionName specified for the set doctype command contains more than 8 characters Select a doctype of 8 characters or less Chapter 8 References 203 Related Reading documents Parameter Gives the number of files currently open Scope Global Syntax query documents Description The documents parameter gives the number of files currently open Example To find out the numbers of files that are open type query documents API Return Codes None Related Reading docvar Parameter Assigns a value to a variable that is global to all file views of the current document Scope File Syntax query docvar Name set docvar Name Value Options Name User defined name for the global variable 204 LPEX Editor User s Guide Value Value assigned to the global vari
100. alog drive Drivel etter filedialog directory Hath filedialog filermask query filedialog drive tleiatog directory filedialog filemask 212 LPEX Editor User s Guide Options drive Changes the default drive used by the Open Get and Save As dialogs DriveLetter Any local or remote drive that your system recognizes directory Changes the default directory used by the Open Get and Save As dialogs Path A path name for any directory on the defined drive filemask Changes the default filemask used by the Open Get and Save As dialogs Mask A file name that may include the global filename characters and No files are masked unless they are specified Description The filedialog parameter allows you to specify the default drive directory and filemask used by the Open Get and Save As dialogs No validation checks are done when the parameter is set Examples 1 To specify G as the default drive used by the file dialogs Open Get and Save As dialogs type set filedialog drive g 2 To specify coolstuf lpex as the default directory used by file dialogs type set filedialog directory coolstuf lpex 3 To have the file dialogs display only c files by default type set filedialog filemask c 4 To have the file dialogs display files that differ from the filename goodlpex txt only in the seventh character type set filedialog filemask goodlp x txt 5 To determine the currect default filemask used by the file di
101. alogs type query filedialog filemask API Return Codes None Chapter 8 References 213 fill Parameter Specifies the fill character Scope View Syntax query fill set fill Char Option Char Any single printable character including the space character or blank The fill character can be specified in the following ways nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where n is a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A single character Any single printable character entered from the keyboard Description The fill character is used to represent spaces displayed as a result of formatting instructions from parameters such as format indent level or wrap The fill character can be used to emphasize indentation or overhang The fill character is for display only and is not saved when the file is saved Use the set font fill command to select the color and typeface used for the fill character The default fill character is a period Example To specify a plus sign for the fill character type set fill API Return Codes 2 The Char option was not or did not represent a single character 214 LPEX Editor User s Guide Related Reading filter Parameter Sets options for the filter opera
102. ameter is set to on Related Reading alarm Command Produces a tone on the speaker Scope Global Chapter 8 References 59 Syntax br alarm nc waai lt Tone Duration Parameters Tone Frequency in hertz in the range 50 to 20000 The default is 440 Tone can also be set using the beeptone parameter Duration Duration in hundredths of a second in the range 0 to 1000 The default is 20 Duration can also be set using the beeplength parameter Description The alarm command sounds a tone on the speaker if sound has not been turned off using a system command or the set beep off command Use the set alarm on command to produce the sound when the screen is next refreshed Note If the system beep has been turned off using an system command the beep on parameter cannot override it and the alarm will remain off Example To change the alarm type alarm 100 75 API Return Code 1 A parameter issued with the command was not valid Issue the command again with valid numeric values for Duration and Tone Related Reading all Command Shows all lines or only those selected by a command Scope View Syntax 60 LPEX Editor User s Guide Command Parameter Command Any valid Editor command including required and optional parameters Description If a command is not provided all lines are displayed If a command is provided only selected lines in the current file are displayed Selection occurs as
103. and from a C program It has the same effect as calling lxquery content buff1 Buffer buffl 8 to skip over the word content Example To find the content of the current line and put it into a variable called element_content_buffer char element_content_buffer element_content_buffer malloc MAXQUERY Ixqtext element_content_buffer Return Value The return value is the return code from the Editor Related Reading Ixstext Subroutine Issues the set content command Library Ipexapi h Include File lpexapi h Chapter 8 References 363 C Syntax int 1xstext unsigned char Buffer Parameter Buffer A variable long enough to hold the value Description The lxstext subroutine provides a faster way of issuing the set content command from a C language program It has the same effect as calling sprintf bufferl set content s buffer 1xcmd buffer1 Example To set the content of the current line to deposit amount type lxstext deposit amount Return Value The return value is the return code from the Editor Related Reading Ixqfont Subroutine Issues the query fonts command Library lpexapi h Include File lpexapi h C Syntax int lxqfont unsigned char Buffer Parameter Buffer A variable long enough to hold the return value The MAXQUERY constant in lpexapi h is set to the longest possible return string Description 364 LPEX Editor User s Gui
104. and in a macro or external command in the same way as one originating from the command line in the Editor Syntax Parameter Command The command to be issued If more than one command is issued use the mult command Description 98 LPEX Editor User s Guide The lxc command processes a command in a macro or external command in the same way as one originating from the command line In particular the special command which means repeat the last command is understood The command is added to the history so it can be retrieved or reissued with the command Note The Ixc command adds the command to the buffer and then calls the lxi command Example To process the command string add 10 cursorpos 3 type the following into routine or macro lxc mult add 10 cursorpos 3 This command is added to the command history and the lxi command is called API Return Codes 1 The commands in the Command parameter were not valid Editor commands Make sure all commands are valid and if more than one command is issued ensure that you have used the mult command 8 Insufficient storage to continue For other codes returned by called routines or macros see the relevant routine or macro Related Reading Ixi Command The Ixi command processes the command in a macro external command or command line as an interactive command and hence applies synonym resolution Syntax Chapter 8 References 99 Parameter Command
105. ands issued through menus are recallable actionkey Commands issued by pressing action keys are recallable Description The recall parameter sets the size of the command recall buffer The Editor maintains a buffer of recently typed commands that can be recalled 306 LPEX Editor User s Guide The recall command also determines which commands are saved in the buffer By default only those issued through the command line are saved but you can also specify the commands issued by choosing menu selections or by pressing keys to which actions have been assigned If an identical command already exists in the buffer only one copy is retained Example To resize the buffer and save only those commands issued through the menus type set recall 20 pulldown API Return Codes 2 The number specified was either outside the valid range not a positive integer or not a whole number Issue the command again using a valid number recentfilecmd Parameter Specifies the Editor command processed when a file name is selected from the recently accessed file list in the Editor window Scope File Syntax query recentfilecmd set recentfilecmd Command Options Command Any Editor command Description Each file name entry in the recently accessed file list has an associated open command associated with it The recentfileemd parameter can query and change this command If the current document is not in the recently accessed file list settin
106. annot be more than 255 digits in size The lineread command creates a dialog box with an entry field and Save Cancel and Help push buttons You leave the dialog box by pressing the Enter or Esc keys or by clicking on the Save or Cancel push buttons The method used to leave this dialog box is stored to the lastkey parameter e If you select the Enter key or Save push button to leave this dialog box the current value in the entry field is stored to the lastline parameter e If you select the Esc key or Cancel push button to leave this dialog box the initial value of the entry field is stored to the lastline parameter In this example no initial value is specified Related Reading extract lastkey The extract command is used in this statement to retrieve or extract the value stored in the lastkey parameter The extracted value is stored in a REXX variable which by default has the same name as the parameter being extracted The value stored in the REXX variable can then be examined to see which key or push button was used to leave the dialog box If the user presses the Enter key or the Save push button to leave the dialog box the value of the lastkey parameter and REXX variable will be ENTER If the user presses the Esc key or the Cancel push button to leave the dialog box the value of the lastkey parameter and REXX variable will be ESC Related Reading if lastkey ENTER then do This line tests the
107. art of line Select or deselect to start of previous token Select or deselect to start of token above current cursor position Select or deselect to top of file Chapter 8 References 381 Related Reading 382 LPEX Editor User s Guide Part Number CT8WFIE Printed in the United States of America G on recycled paper containing 10 recovered post consumer fiber Sc09 2795 00 CT8WFIE
108. ate of the document being edited when the sub menu is requested A menu item or sub item can have multiple callback routines which are called in LIFO order If one of the callback routines returns a non zero value no further callbacks will be called A callback routine can be removed from the callback list by using the drop argument with the submenuinit parameter If a callback routine is not explicitly dropped it remains active until the document is closed Examples 1 To display the message Options menu item selected each time you select an item from the Options pull down menu type set submenuinit LP_OPTIONS msg Options menu item selected To stop displaying the message Options menu item selected each time you select an item from the Optionspull down menu type set submenuinit LP_OPTIONS drop msg Options menu item selected To see all callback routines in the callback list for the Options menu bar item type query submenuinit LP_OPTIONS The more complex example shown below looks for blank lines at the beginning of a document and if present displays a menu choice on the My_tools pull down menu that will remove those blank lines The example assumes that the My tools menu bar item has been created with the following command set actionbar My_tools Query_version query version and that the id attached to this menu item as returned by querying the actionbarid parameter is 6008 The primary callback routine used to
109. ave if autocount is 15 and autochanges is zero type set changes 15 API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading class Parameter Sets the class to which the current line belongs Scope Line Syntax query class set class ClassName ClassName Chapter 8 References 185 Option ClassName A string of one or more classes separated by blanks All classes in the list must have been already defined with the set classes parameter Description The class parameter sets the classes to which the current line belongs for example FUNCTION and COMMENT in C Examples 1 To discover which class the current line belongs to type query class 2 To set the current line in C to the COMMENTS class type set class comments API Return Codes 1 The specified ClassName was not a valid class type Use the query classes command to see which class names are currently defined or use the set class command to define a new class Issue the command again using one or more valid ClassNames 2 At least one ClassName option must be present Issue the set class command again specifying a valid ClassName 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading classes Parameter Sets the number and names of classes for the current file Scope File Syntax query classes se
110. aveall command issued without options saves all modified named files Using options you can save selected files and you can specify a macro to be run after the file save operation A progress indicator will be displayed during the save operation The file being saved will be shown in the status field and you can interrupt the save operation by clicking on the Stop push button Documents not yet named are not saved by the saveall command Example To prompt the user to save any modified files before invoking the build lx macro type saveall prompt macro build b Chapter 8 References 127 API Return Codes 1 System resource error Save operation aborted 1 The save operation has been cancelled or stopped Related Reading scroll Command Scrolls a specified number of lines or columns of the file Scope View Syntax down scroll left right soreen Number up Parameters up Scroll up the file down Scroll down the file default direction left Scroll the file to the left right Scroll the file to the right screen Scroll the number of lines in the Editor window minus Number or scrolls one line whichever is greater Number Scroll the specified number of lines or if screen is used subtract Number from screen count The default is 1 Description The scroll command lets you move up or down lines and left or right across columns in your file When scrolling vertically the current position moves to
111. aved including autosaves The Editor comes with predefined save macros for many programming languages For example the cpp lxs profile runs whenever a C file with a cpp source type is saved You can also use the same profile naming convention to create your own save profiles for files of other source types xxx lxl This profile if it exists runs whenever a file with filename typexxxis loaded or opened for editing The Editor comes with predefined load macros for many programming languages For example the cpp lxl profile runs whenever a C file with a cpp source type is loaded You can also use the same profile naming convention to create your own load profiles for files of other source types profile lx This is a profile in which you can save your own customization commands It is the last standard profile that is run before a file is opened and its commands override the commands used in previous profiles Related Reading Copyright IBM Corp 1995 1998 35 Writing Macros for the Editor You may want to write an editor macro to customize aspects of the Editor window and to automate lengthy or frequently used sequences of commands Macros are written using a combination of REXX commands and Editor commands and parameters Macros used by the Editor along with other example macros can be found in the macros directory You can use these system macros as a guide when creating your own macros as follows 1 Decide on a
112. basefont API Return Code 2 The Char option was not or did not represent a single character Check that it conforms to the syntax requirements and type the command again Related Reading 174 LPEX Editor User s Guide beep Parameter Turns the alarm on or off Scope Global Syntax query beep set beep on off inverse Options on Activates the alarm off Turns the alarm off This is the default value inverse Toggles between on and off Description The beep on parameter turns the alarm beep on When beep is set to on any message displayed on the screen is accompanied by a beep When beep is off the alarm command is disabled If the system beep has been turned off using a system command the beep on parameter cannot override it and the alarm will remain off The value of the beep parameter is saved between Editor sessions Example To turn the beep on type set beep on API Return Code 2 The option you specified was not on off or inverse Related Reading Chapter 8 References 175 beeplength Parameter Sets the default duration of the alarm Scope Global Syntax query beeplength set beeplength Duration Option Duration Duration of the alarm in hundredths of a second The default value is 20 and the range is between 0 and 1000 Description The beeplength parameter sets the default duration of the beep produced by the alarm command Example To set the duration of the alarm bee
113. be automatically displayed You will need to issue the set window visible command to display the window The default setting for the windowshow parameter is parse Example To display a window only after the load profile is run type set windowshow parse API Return Codes 1 You must specify an option Related Reading wordchars Parameter Defines the characters that are considered part of a word in the Editor window Scope File Syntax query wordchars set wordchars Characters Option Characters The characters to define as possible word characters Chapter 8 References 353 Description The wordchars parameter determines valid word characters The default word characters are the national language alphabetic and numeric characters This parameter sets the valid word characters to the list provided The character list is restricted to the single byte character set because the Editor concept of a word does not apply to the double byte character set for example KANJI Example To set the valid word characters to a b and c type set wordchars abc API Return Codes None wrap Parameter Wraps elements for the display Scope Element Syntax query wrap set wrap on off inverse default Options on Wraps the elements off Does not wrap elements This is the default value inverse Toggles between on and off default Display wrap is controlled by the value of the default parameter Descrip
114. ber of lines that can be displayed in the window type set action f7 scroll screen up 3 To enable a key sequence Ctrl w to process multiple commands sequentially for example to mark a word and then delete it type set action c w block set clear word block delete The first is a synonym for the mult command Actions assigned to a key work much like commands typed on the command line synonyms are processed macros and external commands can be used 4 To force a macro to be processed in preference to a built in command type set action a m macro block If the word macro is omitted the Alt m key issues the built in block command Adding the word macro ensures that the Editor searches instead for a macro named block Ix 5 To assign a function to the action of dragging the mouse while a button is pressed type set action buttonldrag primitive setcursor block mark character This dynamically marks the block The first command primitive setcursor makes the Editor move the cursor to the position of the mouse pointer The second command makes the Editor extend or shrink the current block to include the character at the cursor position API Return Codes 1 The number specified was not a positive integer Issue the command again using a valid positive number 2 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set or query command again Chapter 8 Ref
115. between the two LLT commands one character position to the left Any data in the first column will be removed Shift the data between the two LLT commands n character positions to the left Any data in the first n columns will be lost Move a line to the specified target Move this line and the following n 1 lines to a specified target Move all lines between the two MM commands to a specified target Overlay this line with the lines defined by the move copy or copy retain commands Overlay this line and the following n 1 lines with the lines defined by the move copy or copy retain commands Overlay all the lines between the two OO commands with the lines defined by the move copy or copy retain commands Display this line in a prompt Chapter 8 References 375 RR RR n RT RT n RRT RRT n RP RP n RRP RRP n S SF SF n SL SL n WwW Wn X Xn XX Shift the data in this line one character position to the right If there is any data in the last column the line will only shift up to the end of the data Shift the data in this line n character positions to the right If there is any data in the last n columns the line will only shift up to the end of the data Shift the data between the two RR commands one character position to the right Shift the data between the two RR commands n character positions to the right If there is any data in the last n columns the lines will only shift to the end of the data Shi
116. cify only one file name or document number in the compare command an Editor compare window opens with the currently active document in the file view on left side of the window and the specified document in the file view on the right side of the window If comparing two files that have the same name but reside in different directories you can identify the second document by specifying only its directory location File names specified in the compare command that do not already exist will be created A document cannot be compared to itself 72 LPEX Editor User s Guide Examples 1 To compare two documents if those two document are the only documents opened in the Editor type compare 2 To compare the current document and the config sys file on your D drive type compare d config sys 3 To compare document numbers 4 and 8 that are already opened in the Editor type compare DOCNUM 4 DOCNUM 8 4 To compare the files config sys and config old type compare config sys config old 5 To compare the file config sys and document number 4 that is already opened in the Editor type compare config sys DOCNUM 4 6 To compare the files d config sys and c backups config sys type compare d config sys c backups 7 To compare the file c backups config sys with the current document that is called config sys type compare c backups API Return Codes 4 Document number specified is not in valid range of 1 9999 6 D
117. cope Global Syntax Pe mult Delimiter Command Parameter Delimiter Command Series of commands to be issued in sequence separated by a space and a delimiter Description The mult command issues a series of commands as delimited by the first non blank character of the parameter string Processing stops if a negative return code is returned by one of the commands or if no files are available Each command is issued as a call to the Ixi command Example To display the list of assigned keys in the message window and turn both the set actions and set readonly parameters to on type mult query actionlist set actions on set readonly on The semi colon symbol is the delimiter API Return Code 1 The commands specified in the command string were not valid Editor commands Check to make sure all commands are valid Chapter 8 References 109 110 Related Reading next Command Moves the current position to next object level class or word Scope View Syntax element above below class GlassName level Level same word Parameters visible element above below class ClassName level Level same word Description Restrict moves to objects that are currently visible See the include and exclude parameters on making lines visible in the current view If visible is not specified the Editor sets the current position on an object that is not displayed Then it adjusts the curren
118. cro It also stores the value under a more meaningful name Related Reading 48 LPEX Editor User s Guide MSG You must enter a valid number The msg command is used to display an error message on the Editor message line area Related Reading return The REXX return command quits the macro and returns control to the Editor cmd_rep lastline This line assign the value of variable lastline to the variable cmd_rep for use later in the macro This value represents the command that will be repeated Related Reading repeat numrep cmd_rep This line uses the Editor repeat command to repeat the command input by the user by the repetition factor also input by the user Quote marks surround only the repeat command and not the arguments to that command The numrep and cmd_rep variables on this line yield the values stored in them as arguments to the repeatcommand Had the two variables been enclosed inside the quotation marks the variable names themselves and not the values they contain would be supplied to the repeat command The Editor repeat command offers you one way to repeat a single command for a known number of times You can also use various forms of the REXX DO command to cause several commands to loop and to include additional macro processing inside the loop itself See related readings below for more information Related Reading Chapter 6 Macros and Profiles 49 50 LPEX Editor User s Gu
119. d Related Reading linebreak Parameter Defines line break modes Scope File Syntax set linebreak Type query linebreak 256 LPEX Editor User s Guide Option Type The type of line break The type must be one of the following DOS Both CR and LF are required Default for OS 2 and Windows CRLF Both CR and LF are required This option is the same as DOS UNIX Only LF is required Default for AIX LF Only LF is required This option is the same as UNIX Description The linebreak parameter defines the line break modes This is used to determine how lines are to be defined The default mode is DOS which requires that both CR and LF are present and are adjacent in that order End of file is determined by the sequence CR LF EOF or hex 0DOA1A Example To change the line modes type set linebreak crlf API Return Code 2 Invalid option specified linenumber Parameter Gives the line number of the current line Scope Line Syntax query linenumber Options None Description The linenumber parameter returns the line number of the current line Example Chapter 8 References 257 To get the line number of the current line type query linenumber API Return Codes None Related Reading lineread Parameter Sets a title or prompt for the next lineread command Scope Global Syntax query lineread title prompt set lineread title prompt Text Options title The text for the secondary window
120. d Copy this line immediately below itself n Copy this line immediately below itself it n times Copy the lines between the two commands immediately below itself Move the current line to the top of the edit window Related Reading Editor Shortcut Keys This section lists keys used to perform and manage Editor window operations The first table identifies shortcut keys used in the Editor window Caution The keys help defines only the default Editor key behaviors and may be incorrect if applied to other Editor personalities or customized key behaviors Where two key names are joined by a plus sign hold down the first key and press the second or hold down the first two and press the third The following Editor shortcut keys work when the cursor is in the editing space F7 Outdents text in the selected element or rectangular block F8 Indents text in the selected element or rectangular block F9 Switch to the Command shell window which gives you access to the command line prompt Note The cursor must be located within the working area of the Editor Esc Moves the cursor to the command line Arrows Move within text in the working area of the Editor Spacebar Select a check box list item or push button PgDn Scroll down one screen in the contents of a file view PgUp Scroll up one screen in the contents of a file view 378 LPEX Editor User s Guide Ctrl PgUp Ctrl PgDn Alt Enter Alt T Ctrl Home Ctrl End
121. d Description Chapter 8 References 283 The pad parameter defines the pad character that is used to extend or fill lines as required Do not use the Tab character for a pad character as it is not processed as a single character The default fill character is a blank The pad character is for display only and is not saved with the file Example To set the pad character to a dash type set pad API Return Code 2 The Character option was not or did not represent a single character Related Reading parent Parameter Sets the parent window for the Editor window Scope Global Syntax query parent set parent Id Option Id The handle of the Editor window to make the parent A value of 0 sets the desktop as the parent Description The parent parameter changes the parent of the Editor window to the Id The current positioning is maintained at the same relative position to the new parent Example To assign the desktop as parent window type 284 LPEX Editor User s Guide parser set parent 0 API Return Codes None Parameter Defines the live parser to be used Scope File Syntax query parser set parser Command Parameters Options Command A native Editor command to be invoked by trigger Parameters The parameters required by the command Description The parser parameter sets the command to be invoked by the trigger command to process changed lines If a parser has been specified
122. d the last mark created is queried Example 1 To get the exclude setting of the named mark mark1 type query markexclude markl 2 To get the exclude setting of the unnamed mark with id number 765 type query markexclude 765 3 To get the exclude setting of the mark most recently created type query markexclude API Return Codes 264 LPEX Editor User s Guide None Related Reading markfont Parameter Gives the font setting of a mark Scope View Syntax query markfont Name Id Options Name The name of a named mark to query Id The id number of an unnamed mark to query Description This parameter returns the font setting associated with the specified mark A mark can be specified by its name if it is a named mark or by its id number If Name or Id is not specified the last mark created is queried Example 1 To get the font setting of the named mark mark1 type query markfont mark1l 2 To get the font setting of the unnamed mark with id number 765 type query markfont 765 3 To get the font setting of the mark most recently created type query markfont API Return Codes Chapter 8 References 265 None Related Reading markid Parameter Gives the id value of a mark Scope View Syntax query markid Name Id Options Name The name of a named mark to query Id The id number of an unnamed mark to query Description The markid parameter returns the id number of a mark A
123. d appear in the current editing pane e If not enabled a new ring in a new Editor window is created for each newly opened file or view Creating multiple views of the same file You can have more than one view of the same file open at a time and these views may reside in more than one ring Changes made to one view of a file are applied to all other views of that file To create a new view of a file already open for editing do the following 1 Select the file for which you want to create another view 2 Select File from the Editor menu bar 3 Select Open new view from the resulting pull down menu Depending on setting of the View gt Default to ring pull down menu choice a new view appears either in the editing pane of your current ring or in the editing pane of a new ring Alternatively you can 1 Select the file for which you want to create another view 2 Select View from the Editor menu bar 3 Select Split from the resulting pull down menu 4 Select View from the resulting cascaded menu The Editor window containing the editing pane of the current view of the file splits to also accomodate the editing window of a new ring A new view of the current file is placed into this new ring and its editing pane Moving a view to another ring You may find it useful to move a file view to a new or other existing ring To move a file view to a new ring do the following 1 Open the Editor ring manager window a Select Windo
124. d either splits a line or joins two lines together If the split option is specified or if no option is specified and there is a non blank character under or to the right of the cursor the current line is split into two lines The current position remains at the end of the first line Chapter 8 References 133 The join option joins any following line to the end of the current line A join is also carried out if no option is specified and there are only blank characters to the right of the current position There are some exceptions The splitjoin command ignores show lines and treats a sequence of flowed lines as continuous text If the cursor is beyond the end of the line splitjoin first pads the line with the pad character regardless of whether a split or join is to be done Example To split a line place the cursor at the place where you want the current line to end and type splitjoin split API Return Codes 1 A parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading sshow Command Refreshes a file view Scope View Syntax Description The sshow command refreshes the contents of the file view Used in a macro sshow synchronizes the display with the commands issued by the macro Example To display the effects of the fi
125. d to run in a secondary thread 2 The ending quote for the description text is missing Related Reading substitute Command Causes symbol substitution Scope File Syntax gt a CE all Parameter all Scans the whole file for symbol substitution The scanning is done from right to left Description The substitute command causes symbol substitution on demand instead of automatically as it would if the autosymbols parameter was set to on If the all option is not specified only the current line is scanned Chapter 8 References 137 Example To set substitution on demand for all lines type substitute all API Return Codes 1 There are no symbols to convert to special characters in the file If you think there are symbols within the file check that the symbols have been spelled correctly and that they are defined with the set symbol command 2 There are no symbols to convert to special characters in the line If you think there are symbols within the line check that the symbols have been spelled correctly and that they are defined with the set symbol command 2 A parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter Related Reading top Command Moves the cursor position to the top of the file Scope View Syntax Description The top command moves the cursor position for the current view to the first char
126. de The lxqfont subroutine provides a faster way of issuing the query fonts command from a C program It has the same effect as calling lxquery fonts buff1 buffer buffl 6 to skip over the word fonts Example To find the font string set for the current line and put it into a variable called font_string type char font_string font_string malloc MAXQUERY lxqfont font_string Return Value The return value is the return code from the Editor Related Reading Ixsfont Subroutine Issues the set fonts command Library Ipexapi h Include File lpexapi h C Syntax int 1lxsfont unsigned char Buffer Parameter Buffer A variable long enough to hold the value Description The lxsfont subroutine provides a faster way of issuing the set fonts command from a C program It has the same effect as calling sprintf buffl set fonts s buffer lxcmd buff1 Example Chapter 8 References 365 To set the fonts of the current line type 1xsfont ABBBBBA Return Value The return value is the return code from the Editor Related Reading Ixqclass Subroutine Issues the query class command Library Ipexapi h Include File lpexapi h C Syntax int 1lxqclass long ClassList Parameter ClassList Pointer to a long integer in which the data will be returned For each class set for the current line one bit in the ClassList will be turned on The order of the bits is
127. des 1 The parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter 2 A block was not set or marked before you tried a block move block copy block shift block upper block lower block overlay or block find command Mark or set a block before performing one of these block operations 3 You cannot move a line character or rectangular block into itself Move the cursor outside the block and try again 5 You cannot make changes to the file because the readonly parameter is set to on 6 Copying moving shifting the block or converting the block to overlay would make the line too long The block operation was canceled See if there is a way to decrease the size of the block or the line that is being appended Related Reading 66 LPEX Editor User s Guide bottom Command Moves the current position to the bottom of the file Scope View Syntax Description The bottom command moves the current position to the last character of the last line of the file Example To move to the bottom of the file type bottom API Return Code 9 This command takes no parameters Related Reading change Command Substitutes one string for another Scope File Syntax br change Delimiter String 1 Delimiter String t t visible any asis Uelimiter Gommand Delimiter H Delimiter Gount Command Chapter
128. ditor customizations take effect the next time you start the Editor c To cancel your customizations edit the profinit lxu file to remove the unwanted Editor commands or erase the file completely 30 LPEX Editor User s Guide Storing a Personalized Profile Personalized profiles should be stored in your own directory This helps ensure that your profiles are not lost if you later reinstall the Editor It also simplifies profile management when the Editor is used in a network environment To store your profiles in your own directory do the following a Create a directory in which to store your personal profiles for example uN mkdir d my_prof Da mkdir u my_user_id my_prof b Create your personalized profiles and store them in this directory c WN Add the new directory to the LPATH environment variable in your config sys file If this environment variable does not already exist create it For example set LPATH d my_prof LPATH fa Add the new directory to the LPATH environment variable in your environment If this environment variable does not already exist create it For example export LPATH u my_user_id my_prof LPATH d WN Reboot your system Related Reading Changing Editor Load Profiles You can select the load profiles applied to your file The Editor can use both system and user profiles to customize Editor functions In addition programming language profiles can also be specified so that par
129. dow Scope Global Syntax set default Parameter Options query default Parameter Option Parameter The name of a parameter for which a default value can be assigned Options Options assigned as default to Parameter Description Use the default parameter to assign a default value for the parameters listed below commandline e fontsize e hoverhelp Editor window only e messageline e prefixshow e ringselector Editor window only Chapter 8 References 195 e ruler e split e statusline e toolshow Editor window only e toolview Editor window only e wrap When the parameters listed above are set with the default option the Editor attributes they normally control are instead controlled by the values stored in the default parameter When a default parameter value is changed file views and documents using the parameter specified by the default parameter option Name are updated accordingly Changing the value of a default parameter option does not change the value of the parameter for which default values are set You can assign any valid option for a parameter as a default value except the default option The default parameter by itself has no scope Instead its scope is determined by the parameter name specified as an option to the default parameter Default settings assigned by the default parameter are saved between editing sessions Examples 1 To set the default value of the toolview parameter so bot
130. dow select the icon or text representing any ring Select Selected from the menu bar of the Editor ring manager window Select All new rings from the resulting pull down menu Each file view is moved into its own ring and a new Editor window appears for each ring Moving all open file views into the current ring To move all file views back into one ring do the following 1 Open the Editor ring manager window a Select Windows from the menu bar of any Editor window b Select Ring manager from the resulting pull down menu The Editor ring manager window opens In the top part of the Editor ring manager window select the icon or text representing the ring to which the contents of all other rings will be moved Select Selected from the menu bar of the Editor ring manager window Select Single ring from the resulting pull down menu All file views are moved to the selected ring and all other rings are destroyed Closing a file view The Editor lets you have more than one file or more than one view of a given file open at a time This may affect the method you choose to close a file view To close all files or views of a file in the Editor do the following 1 Select File from the Editor menu bar Chapter 2 Using LPEX 19 2 Select Exit from the resulting pull down menu All Editor windows are closed The Editor will warn you if there are unsaved changes and give you an opportunity to save those changes To
131. e Scope File Syntax Description The quit command quits the current file if no changes have been made by calling qquit If changes have been made you are asked to confirm the request to quit Example To quit the current file in the Editor window if no changes have been made type quit API Return Codes 6 The Editor discovered an error while writing the file to the disk or while renaming a temporary file 7 The file was not exited because the nosave parameter is on To exit the file set the nosave parameter off and use the quit command again 9 Too many parameters were issued with the command Related Reading 120 LPEX Editor User s Guide quitview Command Quits the current file view Scope View Syntax gt quitview lt quit Parameters quit If specified closes the last view of a given file Description The quitview command quits the current file view and makes the next view the current view If the current view is the only view that view is closed only if you issue the quitview command with the quit option Example To quit the current view type quitview API Return Codes 2 Incorrect argument supplied to the quitview command If supplied argument must be quit 4 This is the only file view and therefore cannot be closed with the quitview command You can close it using the qquit or quit or by using the quitview command with the quit option for example quitview quit
132. e Moves cursor position to the end of the current line Compresses blanks to tabs Closes the Editor Obtains the value of Editor parameters when REXX is active Closes all file views of the file saving the changes Find a specific string or line 55 Command Name 56 LPEX Editor User s Guide Description Moves the current position to the focus line Gets a file and inserts it after the current line Go to or create a named document Move to or create a new ring in the Editor window Displays or creates the specified file view Returns help information on a requested command or parameter Inserts a text string after the current line Waits for a key to be pressed Produces a dialog that reads a string of characters This command reads a specified file no lines wider than 2500 characters into an empty Editor window as a simple list of elements Loads or creates the named file Issues command as though from the command line Issues command as though invoked interactively Issues an Editor command without searching for a macro Issues one or more resolved commands Searches the LPATH for a macro file then processes it Removes the named macro from internal storage Preloads an Editor macro into internal storage Sets up or finds a position mark Displays a specified message Issues a series of commands Moves the current position to next object level class or word Adds or deletes a
133. e Syntax query rawtext Option None Description The rawtext parameter returns the content of the character string of the current line Regardless of the setting of symbols any substitution characters are restored to the original symbol string Using the form instead of content guarantees that if the text is replaced by a set content command the symbol variables are retained Example To return the content of the character string for the current line type query rawtext API Return Codes None readonly Parameter Protects view from changes Scope View Syntax query readonly set readonly on off inverse Options on Changes are not permitted off Changes are permitted This is the default value Chapter 8 References 305 inverse Toggles between on and off Description The readonly parameter prevents changes from being made directly to a view An attempt to change a line sounds an alarm when the beep is enabled Example To protect a view from changes type set readonly on API Return Code 2 The option you specified was not on off or inverse Related Reading recall Parameter Sets command recall options Scope Global Syntax query recall set recall Number commandline pulldown actionkey Options Number Size of the recall buffer The default value is 12 the valid range is 1 to 1000 inclusive commandline Commands issued through the command line are recallable pulldown Comm
134. e 1xcall next word Return Value The return value is the return code from the Editor Related Reading Ixquery Subroutine Queries an Editor parameter value Library Ipexapi h Include File lpexapi h C Syntax int Ixquery unsigned char Item unsigned char Buffer Parameters Item The item to be queried Buffer Set this to a variable long enough to hold the return string The MAXQUERY constant in lpexapi h is set to the longest possible return string Description The lxquery subroutine retrieves the response to the query command The result returned by Ixquery is the same as the response to the query command For example 1xquery nosave commandline returns the value of the commandline parameter There are three exceptions The lxquery subroutine does not indicate an empty string as lt null gt a single blank as lt blank gt or multiple blanks as lt blanks gt It returns the empty string blank or blanks as appropriate 360 LPEX Editor User s Guide Note Unlike the query command only a single item may be queried at a time with this subroutine It cannot be used with the list parameter Example To find out how many changes there are in a file type char changes changes malloc MAXQUERY lxquery CHANGES changes To set the number of changes back to the original number type 1xcall SET changes Return Value The return value is the return code from the Editor
135. e block s initial characters are removed The shift parameter cannot be used with the character or word parameters When applied to a rectangular block shift moves the characters within the rectangle to the left or right but does not move the block itself Deletes the block If the current position is within the block it is set to the first character after the block 1 To clear a marked block type block clear 2 To mark a rectangle place the cursor at one corner of the rectangle and type block mark rectangle Then move the cursor to the opposite corner of the rectangle and type the same command again 3 To copy the current block to a specific position mark the block place the cursor where you want a copy of the block to be placed and type Chapter 8 References 65 block copy 4 To place a copy of the current block below the existing one and then clear the block type block copy after clear 5 To move the current line block two characters to the right type block shift right 2 6 To overwrite the current block with plus signs type block fill 7 To find the start of the current block type block find Use block find end to find the end of the current block 8 To move the current block to a specific position mark the block place the cursor where you want the block to be moved and type block move The block is deleted from its original position and placed in the new position API Return Co
136. e Ix and save commands in the Editor window to open and save files Example To display the recently accessed file list at the top of the File pull down menu type set recentmenushow TOP API Return Codes 2 Invalid or missing value for parameter Related Reading Chapter 8 References 309 recentpathshow Parameter Enables or disables the display of complete file paths in the recently accessed file list in the Editor window Scope View Syntax query recentpathshow set recentpathshow ON OFF Options ON Show the directory path of each file in the recently accessed file list OFF Do not show the directory path of each file in the recently accessed file list Description The Editor window can display a list of the recently accessed files If the recentmenushow parameter has a value other than off and the recentsize parameter has a value other than 0 a list of recently accessed file names is displayed in the File menu If the recentpathshow parameter is set to on each entry in the recently accessed file list displays both the name and directory path of that file If set to off only the file names are displayed Example 1 To display the both file names and directory paths in the recently accessed file list type set recentpathshow ON 2 To query the current value of the recentpathshow parameter type query recentpathshow API Return Codes 2 Invalid or missing parameter value Related Reading 3
137. e Locate Line facility 1 Select Edit from the main menu bar 2 Select Locate from the resulting pull down menu 3 Select Line from the cascading menu The Locate line dialog box appears The Line number text entry field displays the line number of the current cursor position 4 Replace the current line number with with another number and click on OK The Locate Line dialog box disappears and the cursor moves to the beginning of the chosen line Note If you try to go to a line number that is greater than the number of lines in the file the cursor moves to the beginning of the last line in the file Related Reading Finding a Location Mark in a File Location marks function like bookmarks You place them in your document and use them to easily return to marked locations in your file To find a named location mark in your file do the following 1 Select Edit from the main menu bar Chapter 2 Using LPEX 11 N Select Locate from the resulting pull down menu w Select Mark from the cascading menu 4 A Locate Mark dialog box appears highlight the name of the mark you want to move to 5 Click on OK To find a quick mark in your file do the following 1 Select Edit from the main menu bar 2 Select Locate from the resulting pull down menu 3 Select Quick mark from the next pull down menu The cursor is moved to the position marked by the quick mark You can have only one quick mark per document view
138. e Returned Line Returns zero You may want to use the blocktype parameter to determine if a line block was set Character Returns the position of the last marked character in the last line in the last block Rectangular Returns the position of the last marked character in each marked line Example To display the end position of the current block type query blockend API Return Codes None Related Reading Chapter 8 References 179 blocklength Parameter Gives the number of characters or lines in a block Scope Global Syntax query blocklength Description The blocklength parameter returns the length of the current block The length is given in characters if blockstart is nonzero otherwise it is given in lines Zero is returned if no block is marked Example To display the number of lines or characters in the current block type query blocklength API Return Codes None Related Reading blockshow Parameter Defines the appearance of a block on the screen Scope Global Syntax query blockshow set blockshow font invert Options font Displays the marked block using white text on a gray background inverse Displays the marked block using an XOR of the normal color s of the text in the marked block Description 180 LPEX Editor User s Guide The blockshow parameter sets the layout of a marked block Default value for the blockshow parameter is inverse The query blockshow command disp
139. e Toggle between on and off Description 324 LPEX Editor User s Guide The shows parameter controls whether the show elements are displayed in the Editor window Show elements can be set using the show parameter but are visible only when the shows parameter is set to on Example To display all show lines type set shows on API Return Code 2 The option you specified was not on off or inverse Related Reading sidescroll Parameter Offsets leftmost visible column Scope View Syntax query sidescrol set sidescroll ColumnNumber Option ColumnNumber The offset in columns The default is zero Description The sidescroll parameter gives the number of columns that the Editor scrolls horizontally to keep the current position visible Because sidescroll does not change the current position and the Editor ensures that the current position is always visible there may be some adjustment in the amount of scrolling that actually takes place Example To offset the sidescroll by five columns type set sidescroll 5 Chapter 8 References 325 API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading space Parameter Sets character used to highlight formatting spaces Scope View Syntax query space set space Character Option Character Any character specified in the forms below nnn A decimal based
140. e any asis element or line options 250 LPEX Editor User s Guide asis TextString Search for a text string using the exact case of characters specified any TextString Search for a text string regardless of case element Num Search for the specified line number line Num Note The length of the entire lastfind parameter string is limited to a total of 250 characters Description The lastfind parameter determines the search that takes place if the find command is issued without parameters If lastfind is not set explicitly it takes its values from the most recently issued find command Example To set a default find string of Help type set lastfind any Help Help is searched for regardless of case if a find command is used without parameters API Return Codes 1 The length of the lastfind command string exceeds 250 characters Limit the length of the entire string which includes fixed parameters such as asis and any to 250 characters 1 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading lastkey Parameter Displays the name of the most recent key obtained by the keyread or lineread commands Scope Global Syntax query lastkey Description Chapter 8 References 251 The lastkey parameter displays the name of the key read by the most recent keyread command or the key used to terminate the most recent lineread
141. e bottom of the Editor window Sets the data content of a line Associates a command with the creation of a line Sets the window column containing the cursor Parameter Name Description Sets the column in a line containing the cursor Sets the window row containing the cursor Sets a default value for a parameter Associates a command with the deletion of a line Changes the directory used by the Editor processes Gives the setting of the dirty flag Query only Sets the depth of the Editor window Sets the width of the Editor window Stores the result of the last text import operation in the file Lists current file numbers Query only Gives the unique number identifying a file Query only Sets the file type used for xxx lxs save macro Gives the number of files currently open Query only Sets the value of a variable global to all file views of the current document Lists names of variables global to all file views of the current document Query only Sets the drive used by the Editor processes Gives the number of current line Query only Specifies an Editor command to be performed whenever the current element changes Gives the number of lines in the current file Query only Creates an emphasis box starting from the current cursor position and surrounding the number of characters given by the parameter value Obtains information about the system environment Query only Sets the cla
142. e executed if Name was issued as a command The message returned is one of the following synonym Command is a synonym The value of the synonym is also displayed native Command is an Editor command query Command is a query parameter Command is either unknown or an Editor macro Example To display a message describing the substitute command type query resolve substitute The message resolve substitute native is displayed in the message line API Return Codes Chapter 8 References 313 None Related Reading rexx Parameter Enables the use of REXX if present Scope Global Syntax query rexx set rexx on off inverse Options on Enables REXX for macros if the REXX interpreter is present off Disables the use of REXX inverse Toggles between on and off Description The rexx parameter enables the use of REXX for macros if the REXX interpreter is present and is set on If REXX is off the Editor uses the built in macro processor which is faster but has no support for variables and conditional processing Example To use the built in macro processor turn off the REXX interpreter with the following set rexx off API Return Codes None 314 LPEX Editor User s Guide ring Parameter Sets the default ring assignment mode for new views Scope Global Syntax set ring on off query ring Options on A new view becomes a member of the current ring off A new view is placed into a new
143. e font character It is displayed in the Fonts colors secondary window The font parameter sets the attributes color and typeface for fonts There are two types of font symbolic and special Symbolic fonts are specified with a single character either alphabetic numeric or special and can be used to set font strings to highlight parts of a file For example the C parser uses font C Special fonts perform predefined functions They are background block context fill highlight overlay 224 LPEX Editor User s Guide Sets the attributes of the background character Sets the attributes of a marked block Sets the attributes of the protected file lines displayed to provide context if the context parameter is on Sets the attributes of the fill character the area between the left edge of the file and the beginning of the text in a formatted file Sets the attributes of those lines whose classes match one of those in the highlighted class list Sets the default font of overlay lines space Sets the font of the space area the area between the end of an line and the right edge of the file symbol Sets the attributes of the symbols displayed when the symbols parameter is on The fonts set for each of these types takes effect within the current file view That means that the colors and typeface for marking blocks block for example can be displayed in different colors in different file views Examples 1 To change
144. e is set on again The set parser command defines a live parser and makes it active by turning autoparse on If the parser returns an error during live parsing autoparse is turned off automatically Example To allow new commands to suspend a live parser temporarily while making changes to a file type set autoparse off API Return Code 2 The option you specified was not on off or inverse Related Reading Chapter 8 References 169 autoprefix Parameter Indicate that the prefix data should be automatically maintained Scope File Syntax query autoprefix set autoprefix on off inverse Options on Indicates that prefix data should be automatically maintained This parameter should be set to on after the file has been loaded The numeric part of the prefix data will be maintained as ascending sequence numbers while the file is edited For lines that are inserted or changed the text part of the prefix data will be replaced by the text in the prefixdefaulttext parameter off Indicates that prefix data should not be automatically maintained When a new line is inserted the numeric part of the prefix data will be zero and the text part will be blank This prefix data may be changed by setting the prefix parameter inverse Toggles between on and off Description The autoprefix parameter indicates whether the prefix data should be automatically maintained while the file is being edited The autoprefix param
145. e line in the display area that is used by the focus command as the default If RowNumber is not specified or if it is zero the focus row defaults to the line in the center of the window A positive number counts from the top of the file view downward a negative number counts from the bottom of the file view upward Description The focus parameter sets a line in the file view as the focus line The focus line is the line to which the current position moves when you issue the focus command You specify the focus line using set focus row If a number is not specified the RowNumber defaults to the middle row of the file view The focus area is the area of the view where you can place the cursor to scroll the file It is specified using set focus bottom and set focus top to specify the bottom and top focus lines respectively When you place the cursor on either the top focus line or the bottom focus line the contents of the window are scrolled up or down The cursor remains on the focus line To override the focus line for one display only use the set focus next command This specifies the actual line in the view on which to position the current position the next time the file is displayed in this file view Examples 1 To set the fifth row from the bottom as the row that triggers downward scrolling type set focus bottom 5 2 To position a file in a window so that the eighth line above the current position is the first line i
146. e modes parameter queries the character modes for the current line The string returned specifies whether the characters are SBCS or DBCS A character value of 0 is returned for SBCS For DBCS a character value of 1 or 2 is returned depending on the position of the double byte character Example To query the modes of a string of characters type query modes API Return Code 1 You cannot issue the set command for this parameter Chapter 8 References 275 name Parameter Sets the file name of a file Scope File Syntax query name set name Filename Option Filename The new name and path of the file in one of the following formats depending on your operating system DE Directory Filename WIN Directory Filename Description The name parameter changes the filename of the current file If the filename does not already exist a new file will be created The Editor accepts a name with any syntax but a file without a valid file name cannot be saved by a simple save or file command Example To change the name and directory of a file type set name lpex newfile c When the file is reloaded the C parser is used because the c extension is specified in the new file name API Return Codes 1 The filename already exists 1 The filename is not valid 6 The Editor encountered an error when the file was being saved 7 The file was not saved because the nosave parameter is set to on To save the file set the nosave pa
147. ecified Positions is too large Related Reading textlimit Parameter Sets the byte limit on the size of lines Scope File Syntax query textlimit set textlimit Number Option Number The maximum size in bytes of any line The initial value is 2499 Description The textlimit parameter limits the number of bytes of text that can be typed on an edit line Note that the text length limit value does not include the prefix data and the CRLF characters If the text length limit is exceeded during an import operation the text may be truncated or the operation cancelled as specified by the limiterror parameter Example To set the text length limit to 80 type set textlimit 80 338 LPEX Editor User s Guide API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number 2 The new text limit has been set but one or more lines in the current file exceed the size specified Related Reading timeout Parameter Number of minutes before the Editor window closes down after the last Editor window is closed Scope Global Syntax query timeout set timeout Minutes Option Minutes The number of minutes the Editor window will wait before closing after the last view was closed Any integer between 1 and 32767 is considered valid 32767 minutes is a bit more than 22 days Description An Editor window session does not necessarily end af
148. ed under this name To save changes to all files you are currently working with do the following while in any open Editor window a b Select File from the Editor menu bar Select Save all from the resulting pull down menu Existing files are saved under their current file names For each new un named file saved the Save as dialog box appears Enter the new name of the file and click on the OK push button to save the new file under that name Related Reading Embedding Another File into the Current Document The Get operation embeds another file into the file currently open in the editor The Get operation will not load any new profiles along with the file being inserted Profiles already loaded remain in effect and are applied to the file being inserted Embed another file into your document by doing the following 1 w Move the cursor anywhere on the line above where the inserted text is to appear Select File from the Editor menu bar Select Get from the resulting pull down menu The Get window appears Select the desired file and click on the OK push button The inserted text appears on the line s after the cursor position Chapter 2 Using LPEX 15 Related Reading Working with Multiple Documents The Editor lets you have several documents file views open for editing at the same time These views can be of different documents or different views of the same document Displaying multiple views of
149. ed Reading rings Parameter Queries the number of rings active in the Editor Scope Global Syntax query rings Options None Description The rings parameter displays how many rings are active in the Editor Example query rings API Return Codes None Related Reading Chapter 8 References 317 ringselector Parameter Sets the display state of the ring selector Scope Global Syntax query ringselector set ringselector on off inverse default Options on The ring selector is displayed off The ring selector is not displayed inverse Toggles between on and off default Ring selector display is controlled by the value of the default parameter Description The ringselector parameter determines if the ring selector is displayed The ring selector lets you select a given view in a ring without having to cycle through other views in that ring Examples 1 To display the ring selector type set ringselector on 2 To control ring selector display with the value defined by the default parameter type set ringselector default 3 To display the value of the ringselector parameter type query ringselector If this query returns DEFAULT type the following query default ringselector API Return Codes 2 An invalid option was specified Related Reading 318 LPEX Editor User s Guide ruler Parameter Controls the display of a ruler at the top of the Editor Scope View Syntax query rul
150. elect the color button with the color combination that you want to apply to the token type The text in the sample window changes to show the effect of your choice d Select any combination of character emphasis reverse italic bold or underline for the token type The text in the sample window changes to show the effect of your choice 2 Repeat the above steps to change the display attributes of other token types as needed 3 If you want the new display attribute settings saved for use in future editing sessions enable the Save settings check box Otherwise the new settings will stay in effect only for the current editing session and are lost when you close the Editor 4 When you have finished changing token display attributes click on OK Related Reading Customizing the Keyboard You can customize the keyboard used to work in the Editor with the set key or set action commands A set key command lets you remap the connections between the physical keyboard and the logical keyboard This remapping is global and affects all Editor files You can use set key to use the editor with a keyboard that does not have all of the required keys For example if your keyboard does not have the F11 and F12 keys you can remap the Alt 1 and Alt 2 key combinations to have the same effect set key A 1 F11 set key A 2 F12 Similarly you can use various accented characters that are not on the keyboard by assigning them to keys The
151. emove the New tool bar button from the tool bar type set toolbar LP_NEW 2 To create a new text item on the tool bar called Open that when selected displays the open dialog type set toolbar Open dialog open To create this same item with help and appearing after the second item already on the tool bar type set toolbar Open HELP display the open dialog 2 dialog open You can use a bitmap icon in place of a text label for your tool bar item Bitmaps must be defined in a DLL file located in a directory path included in your PATH environment variable The following example uses the bitmap with resource id 2 found in the evfwrc21 dll file included with the Editor To create an iconic tool bar item with the same function as Example 1 type set toolbar Open BITMAP evfwrc21_2 dialog open Chapter 8 References 341 API Return Code 1 The option specified for the bitmap was not valid Related Reading toolbarlist Parameter Lists items in the toolbar menu Scope File Syntax query toolbarlist Description The toolbarlist parameter lists the names of all items in the toolbar menu the current file Example To list all the items in the toolbar for the current file type query toolbarlist API Return Code 1 You cannot issue the set command for this parameter Related Reading toolshow Parameter Sets the display mode of the tool bar Scope Global Syntax query toolshow set toolshow on off inver
152. ength type set emphasis 4 2 To find the length of this emphasis box type query emphasis API Return Code 2 The value specified for length was outside the valid range Chapter 8 References 209 environment Parameter Obtains information about the system environment Scope Global Syntax query environment Description The environment parameter displays a string of information about the current system environment Example To display information about the system environment type query environment API Return Code None Related Reading exclude Parameter Specifies the classes to be excluded from a view Scope View Syntax query exclude set exclude ClassName ClassName Options ClassName Name of classes to be excluded from the view separated by blanks Description The exclude parameter removes from the display lines belonging to the specified classes To be displayed a line must belong to a class listed in set 210 LPEX Editor User s Guide include and must not belong to any class listed in set exclude If no ClassName is specified no classes are excluded You can override the effect of the include and exclude parameters for the current line only using the showcurrent parameter Examples 1 To exclude the COMMENT class in a source file type set exclude comment 2 To exclude CODE and COMMENT type set exclude code comment API Return Codes 2 The specified ClassName was
153. entered then do numrep lastline end else do msg You must enter a valid number return end get the second piece of information set lineread title Repeat a Command set lineread prompt Enter the command to repeat lineread 255 extract lastkey if lastkey ENTER then do extract lastline Chapter 6 Macros and Profiles 45 end cmd_rep lastline substitute the values entered and run repeat command repeat numrep cmd_rep Related Reading This macro repeats a command a given number of times The first line of any macro must be a comment Comments may appear on any part of a line but must be preceded with and followed by set lineread title Repeat a Command The lineread parameter with the title option assigns a title to the first user input window The window itself will not appear until created by the lineread command Related Reading set lineread prompt Enter the number of times to repeat The lineread parameter with the prompt option assigns a prompt to the first user input window The window itself will not appear until created by the lineread command For more information about this parameter see lineread Parameter in the Editor Reference Related Reading 46 LPEX Editor User s Guide lineread 255 The lineread command gets input from the user In the sample macro this input will be a number for the command repetition factor which c
154. er set ruler on off inverse default Options on Displays the ruler at the top of the current Editor off Removes the ruler from the top of the Editor if any This is the initial display mode inverse Toggles between on and off default Ruler display is controlled by the value of the default parameter Description The ruler parameter controls the display of a ruler in an edit view The content of the ruler is specified with the rulertext parameter The scrolling and highlighting of the cursor location are handled by the Editor The ruler does not wrap when wrap is set on If the value of the ruler parameter is default ruler display is controlled by the value of the default parameter Examples 1 To display a ruler at the top of the current Editor type set ruler on 2 To control ruler display with the value defined by the default parameter type set ruler default 3 To display the value of the ruler parameter type query ruler If this query returns DEFAULT type the following query default ruler API Return Codes 2 The option you specified was not on off or inverse Chapter 8 References 319 Related Reading rulertext Parameter Specifies the content of the ruler Scope View Syntax query rulertext set rulertext Text Options Text The text for labelling the ruler control The initial default value indicates the following label t 2 3 _ __4_ _ 5 __ 6
155. er use top move cursor to first line in file extract content get contents of first line do while content loop while empty lines found block mark element highlight empty lines next element move cursor to next line extract content get contents of next line end block delete delete marked block mark find predel Restore cursor position if still existing mark clear predel Clear mark saving the cursor position exit 0 a To run the callback routine called del_emp lx each time you select the My tools pull down menu type set submenuinit 6008 del_emp 1x b To remove the callback routine called del_emp Ixfrom the My tools pull down menu type set submenuinit 6008 drop del_emp 1x API Return Code None Related Reading symbol Parameter Assign a special character to a symbol Scope File Syntax 332 LPEX Editor User s Guide set symbol SymbolString Character FontName Options SymbolString The string that you type it can be up to 25 characters Character The special character to be produced entered in any of the forms below nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xn or xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A t
156. erations to the columns specified by the find columnnums parameter Display the present value of all find parameter options set to on Also display the value of the find scope parameter Set the string or match pattern to find If you set a search pattern that pattern must adhere to the rules of regular expression and the match option must be set on Set to on to search forward from the cursor location If set to off the find operation will search backward from the cursor position Set to on to save the current find string or match pattern in the find history log The maximum number of entries in this log is set by the historysize option Set the maximum find history log size using an integer value between 1 and 25 inclusive Set to on to mark found text or match patterns Set to on to specify that the find operation treat the search item as a match pattern conforming to the rules of regular expression and not as a text string Set to on to set the Replace then Find radio button as a default in the Editor Find and Replace dialog box Set the new string to replace the found string Set the scope of the find operation Valid values are all Search the entire document current Search only the current element selection Search only selected text Set to on if you want the find operation to search the entire document regardless of the position of the cursor at the time the search is started Otherwise the find operation will
157. erences 155 Related Reading actionbar parameter Sets the contents of the Editor menu bar and associated pull down menu items Scope File Syntax set actionbar Item BITMAP_resdll_id Subitem BITMAP_resdll_id OrdinalNumber Command query actionbar Item BITMAP_resdll_id Subitem BITMAP_resdil_id Options Item Subitem BITMAP resdll id OrdinalNumber Command Description 156 LPEX Editor User s Guide Name of the menu item to be included on the menu bar You can also use the following special characters or strings Use the underscore to include a blank in the name Creates a mnemonic for the menu item The mnemonic is the character that follows the t Defines an accelerator for the menu item separator Places a horizontal separator line in the pull down or cascaded menu Name of the selection item to be added to the Item pull down menu You can also use the special characters described in Item Specifies that the menu or sub menu item is a bitmap The resource dll containing the new item s bitmap The id for the bitmap contained in the resdll resource dll The position at which the menu item is inserted starting at zero Separators are included in the count The action or actions to perform when Subitem is selected The actionbar parameter is used to add menu choices to the Editor menu bar and its associated pull down menus You can create completely new pull d
158. es the current file view for the specified string or line number and then moves the current position to the string or line If the string or line is not in the window the window scrolls to display it The search checks the entire file If no parameters are specified find repeats the last find parameter that was processed The last find parameter string is saved by the preserve command and can be retrieved or changed using the lastfind parameter Examples 1 To find the text Goto type find visible any goto Goto is searched for regardless of case 2 To find the text Ixcmd in the exact form of characters specified type find asis 1xcmd The text Ixcmd in any other case form for example LXCMD or Lxcmd is ignored 3 To find the text fontstyle and to start the search backward type find up asis fontstyle API Return Codes 1 A parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter 2 The file contains no lines no operations can be performed 8 Insufficient storage to continue 1 TextString or Number was not found Check to see if the TextString or Number was typed correctly 2 The TextString specified for the find command occurs only once in this file 3 The text string or line number was found but the Editor had to wrap from the top to bottom or bottom to top to find it 4 The prefix number was requested but the file has no
159. es the id of a pop up menu or submenu selection The names or ids of the pop up menu item and sub menu items must be the same as originally used used to create the item If the item is not found a value of lt NULL gt is returned Example To query the id of the sound sub menu item attached to the mine pop up menu type query popupmenuid mine sound Chapter 8 References 293 API Return Codes 1 You cannot issue the set command for this parameter Related Reading popupmenulist Parameter Lists user defined pop up menus in the Editor window Scope File Syntax query popupmenulist Description The popupmenulist parameter lists the names of all user defined pop up menu items for the current file Example To list all user defined pop up menu items for the current file type query popupmenulist API Return Code 1 You cannot issue the set command for this parameter Related Reading 294 LPEX Editor User s Guide position Parameter Sets cursor position in a line Scope View Syntax query position set positionNumber Option Number A positive integer up to the length of the content of the line 1 Description The position parameter moves the current position within the character content of the current line The value of Number must be positive and can be set no farther than one space to the right of the last character of the line Note A tab character is counted as a single column in the line Exam
160. eter autotime Parameter background Parameter basefont Parameter beep Parameter beeplength Parameter beeptone Parameter blockdefaulttype Parameter 118 119 120 121 121 123 124 125 125 127 128 129 130 130 131 133 134 135 136 137 138 139 140 142 143 151 152 156 158 159 160 161 162 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 176 177 blockdoc Parameter blockend Parameter blocklength Parameter blockshow Parameter blockstart Parameter blocktype Parameter blockview Parameter browse Parameter changes Parameter class Parameter classes Parameter color Parameter commandcheck Parameter commandline Parameter content Parameter creating Parameter cursorcol Parameter cursorpos Parameter cursorrow Parameter default Parameter deleting Parameter directory Parameter dirty Parameter dispdepth Parameter dispwidth Parameter doccontent Parameter doclist Parameter docnum Parameter doctype Parameter documents Parameter docvar Parameter docvarlist Parameter drive Parameter element Parameter elementchangeexit Parameter elements Parameter emphasis Parameter environment Parameter exclude Parameter expandtabs Parameter filedialog Parameter fill Parameter filter Parameter find Parameter findhistory Parameter flow Parameter focus Parameter font Parameter fontlist Parameter fonts Parameter 178 179 180 180
161. eter is set to 2 then to set an indentation of 6 characters to the right of the first element type this Editor command set overhang 3 The second and subsequent lines are indented 4 characters to the right as shown below Rather than holding data passively while it is being edited the Editor recognizes the different elements of a program or document 3 If the indent parameter is set to 2 then to set an indentation of 6 characters to the left of the first element type set overhang 3 Chapter 8 References 281 The second and subsequent lines are indented 4 characters to the left as shown below Rather than holding data passively while it is being edited the Editor recognizes the different elements of a program or document API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading overlay Parameter Sets text for overlay line Scope View Syntax query overlay RowNumber set overlay RowNumber TextString Options RowNumber Line where the overlay appears A positive value is counted from the top of the view a negative value is counted from the bottom Because the size of the window can change dynamically you should use negative values when attempting to set overlays at or near the bottom of the view TextString Text to appear on the overlay Description The set overlay parameter places a TextString o
162. eter setting affects only the prefix data and has no effect on the display prefix Example To indicate that the prefix data should be automatically maintained use the following command set autoprefix on API Return Code 2 The numeric part of the prefix data must be in ascending order before the autoprefix command can be set to on First reorder the prefix data by using the prefix parameter or the prefixrenumber command then issue this command again 170 LPEX Editor User s Guide Related Reading Related Reading autosymbols parameter Causes symbol substitution to occur automatically Scope File Syntax set autosymbols on off query autosymbols Options on Symbols are automatically substituted off Symbols are not automatically substituted Description The autosymbols parameter controls how symbols defined by the symbol parameter are substituted If set to on symbols are substituted for their defined characters when you leave the line the symbol is entered on If set to off symbols must be substituted by explicit request with the substitute command Example To turn off automatic substitution of symbols type set autosymbols off API Return Codes 2 Incorrect option specified for parameter Related Reading Chapter 8 References 171 autotime Parameter Sets time in minutes before autosave Scope File Syntax query autotime set autotime Minutes Option Minutes The time in minutes
163. expression resultl 20 where resultl is a numeric variable his_name Adrian his_name is assigned the character string Adrian her_name Sandra her_name is assigned the character string Sandra evens 2468 evens is assigned a list of values 2 4 6 8 type datatype data type is assigned the value returned by the datatype function if function input variable data is numeric the returned value is NUM a character string the returned value is CHAR Variables are not explicitly typed For example a variable might be assigned a numeric value in one part of the macro but later be assigned a character string value Related Reading Chapter 6 Macros and Profiles 39 Using the IF Statement in Editor Macros You can use the REXX IF statement to control instruction flow within your macro You can specify an action or actions to take if a specified condition is true and you can also specify actions to take if that condition is not true The basic forms of the IF statement are shown below IF condition_true THEN IF condition_true THEN action actionl ELSE action2 In the most basic form an action is performed only when the IF condition is satisfied The ELSE clause lets you also specify an action to take when the condition is not satisfied If you want to perform several actions as a result of an IF decision you need to enclose those actions within a DO END structure as shown below IF condition_true THEN IF condit
164. f changes allowed in any line If omitted the default is any number of changes but if String is null then the default becomes one If the Command parameter is omitted you need to ensure that there are two delimiters before the Count The Editor prompts for each change to be confirmed The change command searches for String1 and if found replaces it with String2 This command searches forward only By default the change command is applied only to the current line or if a block is marked then only to the marked block If the Command or Count parameters are used the change command continues to make changes beyond the current line or marked block if required by these parameters Examples 1 To replace every occurrence of the 6 character string colour with the 5 character string color in the current line or marked block type change colour color 68 LPEX Editor User s Guide In this example is the delimiter 2 To replace every occurrence of the 6 character string colourwith the 5 character string color from the current position to the end of the file type change colour color bottom 3 To replace every occurrence of the 6 character string colourwith the 5 character string color until the Editor finds the word finish type change colour color find asis finish The Editor searches for the word colour and changes it to color until it finds the word finish Because of the the Program Editor asks for each change
165. f file Duplicate line Split the line at the current cursor position or insert a new line when at the end of the current line Create new line without splitting current line and move cursor to new line Split current line at cursor Join next line to current line Delete to end of line Delete entire line Delete the character to the left of the cursor Delete the character to the right of the cursor Undo the last editing change Redo the last undo operation Set checkpoint Set quick mark Find quick mark Find the previous occurrence of a selected text string Find the next occurrence of a selected text string Chapter 8 References 379 Alt N Ctrl O Ctrl S Ctrl I Ctrl L Ctrl A Find the next error Open a file for editing Save a file Display the Filter window Include all lines with this string Locate line by line or sequence number Include all lines of the file into the current file view The Editor window shortcut keys function the following way when you are working within a dialog box Home End Ctrl Left Ctrl Right Tab Shift Tab Move to the beginning of a field Move to the end of a field Move to the beginning of a field Move to the end of a field Move to the next entry field or check box Move to the previous entry field or check box Miscellaneous Editor shortcut keys Esc F10 or Alt Home End Arrows Alt Underlined letter F3 Ctrl F Alt Right Alt Left Ctrl A
166. ferent view of the file The data is saved exactly as it is displayed at the time the command is issued nofilelist or nfl The file saved is not shown in the recently accessed file list in the File pull down menu in the Editor window Description The file command ends the editing of the current file by saving it to a file and then quits from the file If the save fails the file is not closed If a Filename is not specified the name is derived from the current file name Examples 1 To save a file view of a file called testdoc1 doc to another file name in a different directory and then quit type file example newtest1 doc 2 To save and close a file that has three file views open type file newtest1 doc All changes made to all file views are saved to the file name 3 To save a file as it appears in the view and then close the view type file asshown All changes made to the file in the view are saved to the current file name when the Editor is closed Changes made to other views if not copied to this view are not saved Chapter 8 References 81 API Return Codes The filename already exists The Editor asks if you want to overwrite the existing file with this file The file was saved successfully with some lines truncated The filename is not valid A filename must be specified for an untitled document The file is empty The Editor encountered an error when the file was being saved The file was not saved because
167. file the Editor encountered a line with length greater than that allowed by the current setting of the textlimit parameter You cannot make changes to the file because the readonly parameter is on Insufficient storage to continue Related Reading godoc Command Go to or create a named document file in an Editor window Scope Global Syntax 86 LPEX Editor User s Guide br godoc DecumentName doonum VecumentNumber newring nonewring next Parameters name Switch to the named document If it is not open create it find Switch to the named document If it is not open in the Editor do not create it DocumentName To switch to an open document you must use the document file name as it is displayed in the title bar and as is returned by the query name command If you do not specify a path name when creating a new document file the file is placed in the current directory when it is saved docnum Switch to the document specified by DocumentNumber If the document is not open do not create it DocumentNumber must be the number returned by the query docnum command newring The document if created is opened into a new ring in the Editor window If newring split is specified an Editor window is split to accommodate the new ring and document Otherwise a new Editor window is opened nonewring The document if created is opened as a member of the current ring next Shows the next document in the sequence
168. ft the data in this line one character position to the right Any data that appeared in the last column will be removed Shift the data in this line n character positions to the right Any data in the last n columns will be lost Shift the data between the two RRT commands one character position to the right Shift the data between the two RRT commands n character positions to the right Any data in the last n columns will be lost Repeat this line once before the next line Repeat this line n times before the next line Repeat all lines between the two RRP commands Repeat all lines between the two RRP commands n times Define this line as a skeleton line Show the first line of the exclude group Show the first n lines of the exclude group Show the last line of the exclude group Show the last n lines of the exclude group Display the member beginning in column 1 Display the member beginning in column n Exclude this line from the display Exclude this line and the next n 1 lines from the display Exclude all the lines between the two XX commands from the display Related Reading XEDIT Editor Personality The following is a list of the XEDIT prefix area commands that you can use in theEditor window Select the XEDIT editor personality by selecting Options gt Key behavior in the Editor window 376 LPEX Editor User s Guide To process XEDIT commands type the commands you want to use over the sequence numbers in
169. g file selector To use the Ring file selector do the following 1 Click on the push button found above the top right corner of the editing pane to open the ring selector If you have more than one view open in your current ring and the Ring file selector is not visible you can enable it by doing the following a Select Options from the menu bar of the Editor window that contains the ring you want to work with b Select Controls from the resulting pull down menu c Select Ring selector from the cascade menu to enable the Ring file selector 2 Click on the file view you want to work with The selection list closes and the view in the editing pane is replaced with your newly chosen view Moving between rings If you have more than one ring open you can move between rings by doing the following 1 Select Windows from the menu bar of any Editor window 18 LPEX Editor User s Guide 2 Select Next ring or Previous ring from the resulting pull down menu The editing pane belonging to the next or previous ring depending on your choice becomes the active window Moving all open file views into separate rings To move each open file view into its own ring do the following 1 Open the Editor ring manager window a Select Windows from the menu bar of any Editor window b Select Ring manager from the resulting pull down menu The Editor ring manager window opens In the top part of the Editor ring manager win
170. g on which parameter is specified The same above and below command parameters operate within the local display group displayed text in a view Any line at the relevant level that has structural information that is formatting flags before after or absolute is considered structural Any line at level zero is also considered structural The class level and word command parameters operate without regard to display groups Example To move the current position to the previous visible class COMMENT type prev visible class comment API Return Code 1 The ClassName was not a valid class type Use the query classes command to see which ClassNames are currently defined or use the set class command to define a new class Issue the command again using a valid ClassName Related Reading primitive Command Performs a keyboard or other simple function from a macro Scope Global Syntax be primitive Function A i rer Chapter 8 References 115 116 Parameters Use the name of any primitive function as a parameter to this command Description The primitive command provides a way of invoking a keyboard function on data from a macro You can perform functions such as moving the cursor to the beginning and end of lines and inserting or deleting characters Examples To cause the Enter key to parse the data even when the cursor does not move off the current line type set action enter trigger primitive new
171. g str or 0 if num is greater than the number of characters in str str num Returns the length of the num th word in string str or 0 if num is greater than the number of words in str str num Returns the number of words in the string str Related Reading repeats sample macro The sample macro shown below contains a variety of REXX commands and Editor commands and parameters commonly found in user defined macros Editor commands parameters and their options are enclosed in quote marks Following the sample macro are selected lines and a brief description of what those lines do This section provides only a minimal guide to macro programming for the Editor Refer to a REXX language and programming reference for more information on REXX programming Refer to the commands and parameters summaries for more information on how to use commands and parameters to modify Editor function This macro repeats a command a given number of times Two dialogs are issued the first collects the number the second the command to repeat Note If number not entered macro ends and a message is issued Note Only valid editor commands are accepted in second dialog set lineread title Repeat a Command set lineread prompt Enter the number of times to repeat lineread 255 extract lastkey if lastkey ENTER then do extract lastline end if datatype lastline NUM check that a number was
172. g the recentfilecmd parameter adds the current file name and new Command to the recently accessed file list recently accessed file list If Command is left blank the name of the current file is removed from the recently entered file list Chapter 8 References 307 The command associated with a file name in the recently accessed file list is saved between Editor window sessions However the command is applied only if the file is opened by selecting its entry on the recently accessed file list This list is displayed only if the receentmenushow and recentsize parameters are set accordingly Opening the file in another way replaces the command in the recently accessed file list with a default file open command assigned by the Editor No checking is performed on the validity of Command Example 1 To query the current value of the recentfilecmd parameter type query recentfilecmd 2 To change the command used to open the file my_file txt to include an asis option type set recentfilecmd 1x my_file txt asis 3 A sequence of commands can be specified For example to change the command used to open the file my_file txt to include an asis option and sound an alert on loading type set recentfilecmd mult 1x my_file txt asis alarm alarm API Return Codes None Related Reading recentmenushow Parameter Specifies how the recently accessed file list is displayed in the Editor window Scope View Syntax query recentmenusho
173. gle record up to a maximum length of 2499 characters The formwidth parameter setting can also be changed by setting the Wrap setting choice found in the View pull down menu Selecting the Wrap setting sets both the formatter and wrap parameters to on and the formwidth parameter to 0 Deselecting this choice sets the formatter and wrap parameters to off The formwidth parameter is not changed and retains its value of 0 Chapter 8 References 233 Conversely setting both the formatter and wrap parameters to on and the formwidth parameter to 0 will select the Wrap setting choice Note You must set the formatter parameter to on for the formwidth parameter to have an effect on displayed text Examples To set the longest line to 500 characters type set formwidth 500 API Return Code None Related Reading fullparse Parameter Defines the parser to use to parse the full file Scope Global Syntax set fullparse ParserName ParserOption query fullparse Options ParserName The name of the parser to use ParserOption The option to specify for the parser Description The fullparse parameter defines the parser to use for a full parse as opposed to an incremental parse Example To use the REXX parser type set fullparse prrexx all 234 LPEX Editor User s Guide API Return Codes None Related Reading global Parameter Assigns a value to a global variable to all documents in the Editor window Sco
174. h less than formwidth set at 72 characters For each of these elements use the format parameter to assign the format spill option Then to set the width of these elements to 60 characters type set formwidth 72 set spill 60 API Return Code 12 This command requires an open document First open a document then issue the command 2 The number specified was either outside the valid range not a positive integer or not a whole number Issue the command again using a valid number Chapter 8 References 327 Related Reading split Parameter Sets the default border orientation between multiple editing views in the Editor window Scope Global Syntax query split set split horizontal vertical default Options horizontal The borders between multiple editing views run horizontally vertical The borders between multiple editing views run vertically default Split window border orientation is controlled by the value of the default parameter Description The Editor window lets you have multiple windows The split parameter does not actually split the window into multiple views Instead it determines the default orientation of borders between editing views If the value of the ruler parameter is default split view border orientation is controlled by the value of the default parameter Examples 1 To set the default border orientation between multiple editing views to vertical type set split vertical 2
175. h text and graphics show in the tool bar buttons when the toolview parameter is set with the default option type set default toolview both 2 To set the default value of the fontsize parameter so the 11 point System VIO font is used when the fontsize parameter is set with the default option type set default fontsize 11 System VIO 3 To change the default value of the hoverhelp parameter from its current value of off to a new value of on when the hoverhelp parameter is set with the default option type one of the following set default hoverhelp on set default hoverhelp inverse API Return Codes 2 An invalid parameter option was specified 196 LPEX Editor User s Guide Related Reading deleting Parameter Associates a command with the deletion of a line Scope File Syntax query deleting set deleting Command Option Command An external command or macro to be associated with the line Description The deleting parameter defines a command to be run when its associated line is deleted Example To set sample1 lx to be run when a line is deleted type set deleting samplel API Return Codes None Chapter 8 References 197 directory Parameter Changes the directory used by Editor processes Scope Global Syntax query directory set directory path Option path The directory you to want to use for Editor processes Description The Editor locks the directory in which it was started This means
176. hat is created has a viewnum one larger than the one before it Example To get the view number of the current view type query viewnum API Return Codes None Related Reading Chapter 8 References 349 window Parameter Sets the mode of the Editor window Scope File Syntax query window set window hidden min max visible activated Options hidden The view window is hidden It is restored to normal before hiding min The view is minimized If it is hidden it is displayed before minimizing max The view is maximized If it is hidden it is displayed before maximizing visible The view is restored and displayed The focus is not necessarily set on the view activated The view is displayed and the focus is set to it Description The view parameter controls whether the current file is visible hidden minimized maximized or activated Example To hide the current view window type set window hidden API Return Codes 2 The option is not valid Related Reading windowid Parameter Displays a unique number which identifies a file view or window or to the operating system Scope View Syntax 350 LPEX Editor User s Guide query windowid Description The windowid parameter returns the unique number assigned by the operating system as the handle of the window This number can be used to send or post messages to that window This is necessary for operation in a modeless dialog Exam
177. he elements displayed below include CODE and COMMENT classes Note Class names are chosen by the writer of the parser CODE Class COMMENT Class Lines of C code an element if x test J test for x Lines of Fortran code an DO 10 I 1 10 C PURPOSE element Copyright IBM Corp 1995 1998 23 Using a Parser s View Menu The selections in the View menu specify which classes are displayed in the document For example you can select the Functions selection from a C View menu to display only the function headers in the C document Live Parsing LPEX monitors and records all the changes that you make to a document As you complete each line LPEX examines that line for defined class elements For example in a C program the parser recognizes the text between an open comment marker and a close comment marker as being comments and displays those comments in the color and font specified for the comment class Other text even if on the same line as a comment is displayed according to class You can change the fonts and colors associated with different elements of a program by selecting Options gt Token Attributes from the editor menu bar You can also change the special keys fonts and pull down menu for a file type by modifying the load macro associated with that file type Related Reading 24 LPEX Editor User s Guide Chapter 5 Customizing Editor Appearance and Function You can c
178. he font string Description The fonts parameter sets the fonts for individual characters in the current line You must supply a string of characters that has the same length as the current content of the line Each character in String refers to a currently defined font and sets the font of the corresponding character in the line 226 LPEX Editor User s Guide Note If a parser is loaded all the fonts are specified by the parser The set fonts command has no effect Example The current line is include lt stdio h gt To set the angled brackets and the hash sign of the current line to font A and the remaining characters to font B type set fonts abbbbbbb_abbbbbbba The underscore symbol denotes a space in the line API Return Code 2 The length of the font string does not match that of the line Related Reading fontsize Parameter Sets the size of the characters for the Editor window Scope View Syntax query fontsize set fontsize N Facename default Option N The point size used to display characters in the Editor Nmust be an integer value greater than 0 Facename The desired face name If no face name is specified the first font found that meets the size criterion is used default Font display is controlled by the value of the default parameter Description The fontsize parameter sets the size of the characters for the Editor The size of the file view remains the same and the file is red
179. heckpointing Sets the number of changes required before autosave Sets the name for the autosave file Gives the time in seconds before next autosave Query only Resumes parsing Maintains the prefix data while a file is being edited Causes symbol substitution to occur automatically Chapter 8 References 143 Parameter Name 144 LPEX Editor User s Guide Description Sets the time in minutes before the next autosave Sets the background character Sets the default font for a line Query only Sets the alarm Sets the duration for the alarm Sets the frequency for the alarm Changes the block type favoured by the block selection commands Gives the number of the file that contains the marked block Query only Gives end position of block Query only Gives the number of characters or lines in a block Query only Sets the way a block is shown on the screen Gives the start position of a block Query only Gives the type of block currently set Query only Gives the number of the view that contains the marked block Query only Prevents overwriting or changing of a file Sets the number of changes made to the file Sets the class to which the current line belongs Sets the number and names of classes for the current file Sets RGB color values for the Editor Associates a command with the issuing of a command with the Issue edit command Displays an Editor command entry area at th
180. hen the current element changes use the mult command For example set elementchangeexit mult alarm query prefix API Return Codes None Related Reading elements Parameter Gives the number of lines in the current file Scope File Syntax query elements Description The elements parameter gives the number of lines in the current file Example To obtain the number of lines in the current file type query elements API Return Codes None Related Reading 208 LPEX Editor User s Guide emphasis Parameter Specifies the current length of the emphasis box Scope Global Syntax query emphasis set emphasis length Option length The length in characters of the emphasis box This value can be any whole number value including zero Description The emphasis parameter sets an emphasis box around text starting at the current cursor position The length of the emphasis box is set by the length attribute Positive values for length will place the emphasis box around text following the cursor and negative values will place the emphasis box before the cursor The emphasis box remains displayed until the cursor is moved or the emphasis length is set to 0 Regardless of length specified the emphasis box will not wrap onto following or preceding lines of text Performing a query on the current emphasis box will return the length of the box in characters Examples 1 To create an emphasis box 4 characters in l
181. her a character block or a stream block depending on the setting of the blockdefaulttype parameter fill Character find find end lower upper overlay shift left Number shift right Number delete Examples Fills the current block with the Character Character can be a blank or any other single keyboard character specified in any of the following forms nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A single character Any single keyboard character The fill character also fills a line block up to the end of the text line Moves the current position to the start of the current block which may be in another file Moves the current position to the end of the current block which may be in another file Converts the block to lowercase Converts the block to uppercase The current rectangular block is placed over the text at the current position If you clear the block the contents of the rectangle block are pasted at the current position Moves the current block a specified number of characters to the left or right When the block is shifted to the right it is padded with the pad character and no data is lost When shifted to the left th
182. ickly find marked locations in your document 106 LPEX Editor User s Guide You can also use the mark command to highlight your marked locations or to include or exclude marked locations from view When including or excluding marked areas for display lines are displayed according to the following rules of precedence 1 2 3 4 If the showcurrent parameter is set to on the line is displayed If the line has in it an excluded mark or class it is not displayed If the line does not belong to an included class it is not displayed If the line is set as a show line by the show parameter and the shows parameter is set to off it is not displayed If there are one or more included marks and the line does not include one of those marks it is not displayed Marks are not saved when the file is closed Examples 1 To mark a position in a file with the name undoref type mark set undoref The mark s name is undoref To move the cursor to the mark undoref type mark find undoref To mark a position in a file with an unnamed mark type mark set You can query the markid parameter to get the id number of the new mark To move the cursor to the mark with id 276 type mark find 276 To highlight the mark with id 276 using a font with name M type mark setfont 276 M If font M does not yet exist you can create it using the font parameter For example to use a red foreground on yellow background to highlight y
183. ide Chapter 7 External Editor Commands External commands are created as shared BE or dynamic link A HN libraries whose names start with a prefix specific to the version of LPEX installed usually 14 and have a filename extension of dll For example an external command called scanl4scan dll Your external command is run directly as a procedure call from within the Editor Consider the following 1 You cannot use the C exit function to quit from your external command The return statement in lxmain returns you to the Editor 2 The command runs on the Editor s stack The stack is usually quite large however you should avoid storing too much information in it 3 One copy of the external command is loaded If you make a recursive call the same procedure is called and any items you use will refer to the same storage location Write your programs to allow for this reentrance Related Reading V ne EX OU ode External Subroutines Summary on page Writing External Command Source Code The source code is written as a standard C program using the Editor access calls described in the lpexapi h file The following is an example of a typical minimal external function DISCLAIMER OF WARRANTIES The following enclosed code is sample code created by IBM Corporation This sample code is not part of any standard IBM product and is provided to you solely for the purpose of assisting you in the develo
184. ift the data between the two gt gt commands n character positions to the right lt Shift the data in this line one character position to the left lt n Shift the data in this line n character positions to the left lt lt Shift the data between the two lt lt commands one character position to the left lt lt n Shift the data between the two lt lt commands n character positions to the left Shift the data in this line one character position to the right Any data that appeared in the last column will be removed n Shift the data in this line n character positions to the right Any data in the last n columns will be removed Shift the data between the two commands one character position to the right Any data that appeared in the last column will be removed n Shift the data between the two commands n character positions to the right Any data in the last n columns will be removed Chapter 8 References 377 Keys Help Shift the data in this line one character position to the left Any data that appeared in the first column will be removed n Shift the data in this line n character positions to the left Any data in the first n columns will be removed Shift the data between the two commands one character position to the left Any data in the first column will be removed n Shift the data between the two commands ncharacter positions to the left Any data in the first n columns will be remove
185. ill be marked with either a character block or stream block depending on the setting of the defaultblockselection parameter Restricts the search to a columnar area including the columns specified by num1 and num2 and the area between them Searches are restricted to the currently selected block of text Searches all documents currently open in the Editor Searches will stop when the bottom of the file is reached Begins searching at the current cursor position The current find operation is not saved into the lastfind parameter Found text is emphasized in the view Searches for the text string using the exact form of characters specified Searches for the text string regardless of case Treats TextString as a regular expression search pattern If asis is specified the search pattern is case sensitive Searches for the line number specified Finds the next prefix entry If TextString is specified go to the next prefix entry that matches TextString Finds and goes to the next prefix text entry that matches TextString Searches for the line that has the largest prefix number that is not greater than Number Finds the next occurrence in the find history Finds the previous occurrence in the find history Search for the line that has been set with an old line number of Number Note The length of the entire find parameter string is limited to 250 characters Chapter 8 References 83 Description The find command search
186. imilarly to the Issue Edit Command dialog box An Editor command typed into the command input area is run when the Enter key is pressed Cursor focus then returns to the Editor The input area also incorporates a pull down selection list arrow key to the right of the commandline of recently entered Editor commands Entries in this list can be selected and run The number of entries stored in this list is determined by the value of the recall parameter Setting the commandline parameter to off removes the Editor command input area from the Editor Editor commands can still be entered by using the Issue edit command window available from the Actions pull down menu or by pressing the ESC key If the value of the commandline parameter is default the command input area display is controlled by the value of the default parameter Example 1 To display the Editor command input area type set commandline on 2 To display the value of the commandline parameter type query commandline If this query returns default type the following query default command ine 3 To control command input area display with the value defined by the default parameter type set commandline default API Return Codes 1 Invalid parameter value specified 190 LPEX Editor User s Guide Related Reading content Parameter Changes the data content of a line Scope Line Syntax query content set content String Option String Any string t
187. in a new Editor window Files are opened but not shown in the recently accessed file list in the File pull down menu Files are opened in the current ring Disable the use of profile Ix Set the display format and starting column of the prefix If not specified the default value of col is 1 If no filename is specified the lx command opens a new untitled document If a filename is specified all currently open files are searched If the file is not found the Editor looks for the file in the current directory then in the directories specified by LPATH If the file is found it is loaded Otherwise a new file with the given filename is created Chapter 8 References 97 If you create a new document without specifing one of the nonewring or newring parameters the new document is placed in a new or existing ring according to the value of the ring parameter Examples 1 To load a file named buslet and set its doctype to c type 1x buslet dt c 2 To create an untitled file and set its doctype to c type Ix dt c 3 To load all files with a filename extension of cpp into separate rings each with its own Editor window type 1x cpp nr all API Return Codes 1 The file name is too long 2 Wild cards are not supported by the Editor 3 The file is in use elsewhere 6 Anerror occurred while reading the file 7 The file is too wide Related Reading Ixc Command The Ixc command processes a comm
188. ing information as appropriate e profile lx may be used for personal customization of the Editor Note If the doctype parameter is not set then the file will not be parsed when loaded Example To load the file called myfile txt type load myfile txt API Return Codes 1 Document is not empty 2 No filename given 3 Invalid filename 6 Error reading file 7 File too wide only a fixed buffer is available Related Reading Ix Command Loads or creates the named file in an Editor window Syntax 96 LPEX Editor User s Guide p x T cen Filename Parameters Filename asis as doctype DocType dt DocType newring nr nofilelist n l nonewring nnr nopro np prefixformat format col fp format col Description fasis dootype Voclype i all nofilelist nonewring nopro prefixfor mat tormat Name of a file to be edited You can use a wild card character to specify a range of file names that fit a given pattern Note If you want to open an untitled document with any of the options shown below you must specify for Filename Disable the use of xxx Ixs save macro and xxx lxl load macro and parser Set the file type doctype to DocType DocType can be up to 8 characters in length Files are opened into a new ring If split is specified the new ring is created by splitting the current Editor window If all is specified the new ring is opened
189. ing must be entirely made up of 9 and X characters e The 9 characters represent the positions that will contain the numeric part of the prefix data e The X characters represent the positions that will contain the text part of the prefix data The size of the prefix data is determined by the size of Format col The starting column at which the prefix data is displayed on a line If not specified the value of col is 1 Description The prefixformat parameter defines the size format and location of the prefix data that will be maintained with the current file This parameter must be set before the prefix is set for any line in the current file After the prefix parameter has been set for a line in the file the prefixformat parameter becomes a read only parameter and can only be queried If the prefixformat parameter is never set then it will have a null string default value In this case the only valid value for set prefix is an empty string Example 1 To define the prefix data as an AS 400 sequence number with a 6 digit sequence number followed by a 6 digit date the following command could be used set prefixformat 999999XXXXXX 300 LPEX Editor User s Guide 2 To define the prefix data as a 8 digit MVS sequence number appearing in columns 73 to 80 of a line enter set prefixformat 99999999 73 API Return Codes 1 Parameter is read only After the prefix parameter is set this parameter can no
190. ing to the following naming conventions profinit lxu User profile that runs when the Editor is first initiated profsys lxu User profile that runs each time a new file is loaded into the Editor xxx xu User defined language profile that runs each time a file of type xxx is loaded into the Editor For example if your personalized load profile is to apply to cpp files your personalized load macro will be called cpp lxu Note When you load the Editor with file type xxx the Editor loads the xxx lxu user load profile immediately after the xxx lxl standard load profile Note Personalized load profiles can be stored in the macros directory but we recommend that you store them in your own directory Creating a Personalized Profile This example shows you how you can create and customize your personal profile in for example the profinit 1xu file Perform the following steps a Create a new file in the Editor with the following lines The first line of the profile must be a comment as shown Do not forget the quotation marks around each command line profinit 1xu set blockdefaulttype rectangle set toolbar my_button HELP Add 5 lines to end of file 5 mult bottom add 5 set actionbar Queries Class 5 query class set actionbar Queries F onts tCtr1 Z 5 query fonts set action c Z query fonts b Save the file in the macros directory with a name of profinit lxu and quit the Editor Your new E
191. ion The Editor supports a set of sixteen colors You can use the color parameter to change these colors Changes to colors are saved between editing sessions Chapter 8 References 187 Colors are defined by a mix of Red Green and Blue RGB color components The color parameter lets you set the RGB mix of a given Editor color number to create your own colors Not all RGB color components need be defined when changing RGB color values If an RGB color component is not specified when setting the color parameter the current value for that color component is not changed If however no color components at all are specified the specified Editor color returns to its default value The default values of colors provided with the Editor are shown below Color Default Value R G B 1 black 0 0 0 2 blue 0 0 170 3 green 0 128 0 4 cyan 0 128 128 5 red 128 0 0 6 pink 170 0 170 7 brown 128 128 0 8 light gray 192 192 192 9 gray 128 128 128 10 bright blue 0 0 255 11 bright green 0 255 0 12 bright cyan 0 255 255 13 bright red 255 0 0 14 bright pink 255 0 255 15 yellow 255 255 0 16 white 255 255 255 Examples 1 To change color 1 to khaki green type set color 1 R 150 G 160 B 110 2 To darken the gray used in color 9 and give it a slight reddish hue type set color 9 G 75 B 75 3 To change color 16 back to its default color values type set color 16 4 To query the RGB color values for color 4 type query color 4 API Return Codes
192. ion_true THEN DO DO actionl actionl action2 action2 action3 action3 END END ELSE DO action4 action5 action6 END The condition can be specified using any combination of REXX variable and constant terms REXX functions and logical and comparison operators Related Reading 40 LPEX Editor User s Guide Using Loops in Editor Macros The various forms of the REXX DO statement lets you set up loops to perform repetitive tasks until a specified condition occurs The basic forms of the DO command are shown below do num loop do var num_l to num_2 loop do while condition_true do until condition_true do forever loop num times set the value of var to num_1 and loop incrementing the value of var by 1 each time through the loop until the value of var is greater than num_2 then leave the loop enter the loop only if condition_true is satisfied and continue looping for as long as condition_true is satisfied always enter the loop once and continue looping until condition_true is satisfied loop until exit is forced by the leave or return commands You can use numeric constants numeric variables or functions that return numeric values in place of num num_1 and num_2 above Loop control conditions can be specified using any combination of REXX variable and constant terms REXX functions and logical and comparison operators The DO loop starts with the DO statement and ends with the END statement Macro s
193. iption The menucheck parameter enables you to display a checkmark next to cascaded pull down or pop up menu items 272 LPEX Editor User s Guide Note Based on the state of the Editor window some built in menu items are automatically checked or unchecked They are not affected by the value of the menucheck parameter setting Example To change the setting of user defined menu item 8181 from on to off type set menucheck 8181 inverse API Return Code 2 The option specified with the parameter was not valid Related Reading messageline Parameter Controls the display of the last generated message Scope File Syntax set messageline dynamic on off inverse default query messageline Options dynamic Display the last message in the data area overlaying the first text line until the next function is performed on Display the last message in a special area at the bottom of the window off Do not display the last message anywhere inverse Toggle between on and off or set dynamic off default Message display is controlled by the value of the default parameter Description The messageline parameter controls the displaying of the last message This control is used in addition to the messages parameter If the value of the messageline parameter is default message display is controlled by the value of the default parameter Chapter 8 References 273 Note The width for the messageline parameter is fixed
194. irst and multiplication and division operations performed before addition and subtraction operations For example a b 8 12 4 a is assigned a value of 11 8 12 4 b is assigned a value of 5 Related Reading Using Constants and Variables in Editor Macros Variables let you associate data with a unique name With Editor macros you can display compare do arithmetic or many other functions with the value stored in the variable name 38 LPEX Editor User s Guide The first character of a variable name must be one of e an alphabetic character case ignored e E e _ underscore Other characters in the variable name can be any of the characters listed above plus the digits 0 to 9 You can assign a value to a variable This value can be a constant value the value of another variable the result of an arithmetic or logical expression or the result of a REXX function String constants must be enclosed in single or double quotes Numeric constants names of other variables and REXX function names do not require quotes In the examples below the variable name appears to the left of the sign and the constant expression or function value being assigned to the variable appears to the right of the sign a 10 a is assigned a value of 10 b 10 5 b is assigned a value of 10 5 result 1 1 resultl is assigned a value of 1 1 or 2 result2 resultl 20 result2 is assigned the result of the arithmetic
195. ization features AIX Version 4 System User s Guide Operating System and Devices SC23 2544 Describes the AIX Version 4 Operating System for novice system users It describes how to run commands handle processes files and directories printing and working with the AIXwindows Desktop It also introduces system commands for securing files using storage media and customizing environment files AIX Version 4 Getting Started SC23 2527 Contains information for first time users who have little or no experience with the AIX operating system It introduces basic system commands covering tasks such as starting and stopping the system using a keyboard or mouse logging in and out identifying and using the various user interfaces and running basic file commands AIX Version 4 Commands Reference SBOF 1851 A collection of volumes that contain descriptions and examples of the AIX commands and their available flags AIX Version 4 General Programming Concepts SC23 2533 and SC23 2490 Discusses the operating system from a programming perspective AIX Version 4 Technical Reference Volumes 1 and 2 Base Operating System and Extensions SC23 2614 and SC23 2615 Provides reference information about system calls subroutines macros and statements associated with the AIX base operating system runtime services and device services LPEX Editor User s Guide Chapter 1 Introducing the LPEX Editor LPEX Live Parsing Extensible Editor is a
196. k is set Example To determine the type of block set type query blocktype API Return Codes None Related Reading 182 LPEX Editor User s Guide blockview Parameter Gives the number of the file view that contains the marked block Scope Global Syntax query blockview Description The blockview parameter can be used with the blockdoc parameter to determine which file view of which document contains the block selection Because the stream block type has a scope of file view only when there is a stream selection will query blockview return a number If there is no block selection or the block selection is not of type stream then query blockview will return zero Example To query in which file view does a marked blocked exist type query blockview API Return Codes None Related Reading browse Parameter Prevents overwriting or changing of a file Scope View Syntax query browse set browse on off inverse Chapter 8 References 183 Options on Typed changes are not permitted off Typed changes are permitted This is the default value inverse Toggles between on and off Description The file can still be altered by action keys commands from the command menu or a macro A beep warns that browse is on if typing is attempted Note You get the beep tone only if the beep parameter is set to on Example To protect a file from typed changes type set browse on API Return Code
197. k removal handling routine set markdeleteexit errlist API Return Code 8 Insufficient storage to continue Related Reading markdirtyexit Parameter Defines the mark changed exit routine to be used with the current file Scope File Syntax query markdirtyexit set markdirtyexit Command Parameters Options Command A native Editor command to be invoked the first time the text associated with a mark is changed Parameters The parameters required by the command Description The markdirtyexit parameter sets the command to be invoked when the text associated with a mark is changed Note that the routine is only invoked the first time the mark is changed When the command specified by set markdirtyexit is invoked the mark s name is concatenated to the command parameters Example To specify errlist as the mark changed handling routine set markdirtyexit errlist Chapter 8 References 263 API Return Code 8 Insufficient storage to continue Related Reading markexclude Parameter Gives the exclude setting of a mark Scope View Syntax query markexclude Name Id Options Name The name of a named mark to query Id The id number of an unnamed mark to query Description If the specified mark is excluded the markexclude parameter will return a value of on Otherwise it returns a value of off A mark can be specified by its name if it is a named mark or by its id number If Name or Id is not specifie
198. lap in fact he was about to set a new lap record and in the process win his class and the overall Solo 1 championship here comes the flag To format the document type set formatter on The document appears like this with formatter on Just then her head struck against the roof of the hall in fact she was now more than nine feet high and she at once took up the little golden key and hurried off to the garden door Note Indentation spaces will be represented by a fill character The default fill character is a period as shown in the example above You can define your own fill character using the fill parameter API Return Code 2 An invalid parameter option was specified 232 LPEX Editor User s Guide Related Reading formwidth Parameter Sets the formatting width of the document Scope View Syntax query formwidth set formwidth LineLength Options LineLength The maximum displayed length of a line in the Editor This value must be either 0 or an integer 0 between 20 and 2499 inclusive The default value for LineLength is 72 Description The formwidth parameter sets the length of the longest line that the formatter displays when the wrap parameter is on If wrap is off long lines are not wrapped If the value of the formwidth parameter is 0 the maximum line length is determined by the width of the editing window If wrap is off when a document is saved each element is saved as a sin
199. lated Reading list Parameter Lists details about items such as files keys and file views Scope Global Syntax query list action actionbar doc face font global key mark symbol synonym view Options action Lists the logical keys that have been assigned to action keys using the set action command actionbar Lists pulldown menus and the choices assigned to them doc Lists the names and numbers of the opened files face Lists current user defined font names font Lists current symbolic fonts and their values global Lists currently set global variables key Lists physical keys that have been remapped and the logical keys to which they have been assigned mark Lists the current set marks and their position symbol Lists the current symbols and their values synonym Lists the current synonyms and their values view Lists the viewnames of the current file Description The list parameter gives information about current actions files fonts keys marks symbols synonyms or views Note This parameter cannot be used with API calls Example To list current symbolic fonts type query list font 260 LPEX Editor User s Guide API Return Codes None Related Reading loadedmacros Parameter Lists the preloaded REXX macros Scope Global Syntax query loadedmacros Description The loadedmacros parameter lists the names of REXX macros that have been preloaded into REXX storage Example To lis
200. lays the current option The value of the blockshow parameter is saved between Editor sessions Example To set the marked block to display in XOR type set blockshow INVERT API Return Code 2 The parameter issued with the command was not valid Check the command s syntax requirements and issue the command again using a valid parameter Related Reading blockstart Parameter Gives the start position of a block Scope Global Syntax query blockstart Description The blockstart parameter gives the start position of the currently set block Zero is returned if no block is set or if a line block is set The value returned depends on the type of block set Block Type Value Returned Line Returns zero Character Returns the position of the first character in the first line of the block Rectangular Returns the position of the first marked character for each marked line Example To display the start position of the block type Chapter 8 References 181 query blockstart API Return Codes None Related Reading blocktype Parameter Gives the type of block currently set Scope Global Syntax query blocktype Description The blocktype parameter gives the type of block that is currently set by returning one of the following values Return Value Meaning of Value STREAM A stream block is set CHARACTER A character block is set ELEMENT A line block is set RECTANGLE A rectangular block is set UNSET No bloc
201. le and the autosaved file is not saved to disk if you exit the Editor normally Example To name the autosave file type set autoname place2 markup c The autosave filename is changed to markup c and is placed in the place2 directory of the current drive API Return Code 2 The Drive Directory Filename was not valid Related Reading autonext Parameter Gives the time in seconds before next autosave Scope File Syntax query autonext Description The autonext parameter gives the time in seconds before the next autosave occurs When the autotime parameter is set to zero autonext is also zero because no autosave is scheduled Example To view the seconds before the next autosave occurs type query autonext API Return Code 1 You cannot issue set for this parameter 168 LPEX Editor User s Guide Related Reading autoparse Parameter Resumes or suspends live parsing Scope File Syntax query autoparse set autoparse on off inverse Options on Activates the parser for the current file This is the default value off Suspends the parser for the current file inverse Toggles between on and off Description The autoparse parameter resumes or suspends live parsing When autoparse is off any pending changed lines are processed before parsing is suspended The Editor remembers the name of the parser and continues adding lines to the pending list but does not invoke the parser until autopars
202. le hoverhelp for the toolbar buttons Parameter Name Description Sets the idle seconds required before autosave Processes unknown commands as macros Processes unknown commands as set query Specifies the list of classes for which member lines are to be displayed in a file view Sets the indent factor Sets the cursor to either insert or replace mode Maps a logical key to a physical key Lists current remapped keys Query only Sets the default parameter string for the find command Displays the last key obtained by keyread or lineread Query only Displays the last line obtained by the lineread parameter Query only Displays the length of the current line Query only Specifies the level of the current element Query only Specifies how a text length limit error is handled Sets the mode for ending lines in a file Gives the line number of the current line Query only Sets the title or prompt for the next lineread Returns the number of non show lines in the file Query only Lists external commands linked to the Editor Query only Lists details about items such as files keys and views Query only Lists the preloaded REXX macros Query only Returns position of specified mark within a line Query only Defines the mark removal exit routine for the current file Defines the mark changed exit routine for the current file Chapter 8 References 147 Parameter Name 148 LPEX Edit
203. lette dialog box appears 5 Enter the name of the new color palette in the Add a palette dialog box and click OK to return to the Palette dialog box The name of the new color palette now appears in the Palettes field e To delete a color palette 1 Click on the down arrow button at the right side of the Palettes field to see a list of defined palettes 2 Select the name of the color palette you want to delete from this list If the deleted color palette is the palette in effect when you first opened the Palette dialog box the colors in that deleted palette remain in effect until you explicitly select another color palette Click on OK to close the Palette dialog box and apply your changes to the Editor Related Reading Using Profiles to Modify Editor Behavior A number of profiles are loaded each time you start the Editor or open a file into it These profiles contain various commands and parameter settings that control how the Editor looks and behaves You can directly modify load profiles supplied with the Editor to your own personal preferences but your modifications may be lost if you later reinstall the software To avoid losing your load profile modifications we recommend that you do the following Chapter 5 Customizing Editor Appearance and Function 29 1 Do not directly modify the standard load profiles that come with the Editor 2 Instead create your own load profiles using an lxu filename extension accord
204. letter key Any single keyboard character Description The background parameter sets the background character which is used to fill the area above the first and below the last line of data in the data area Use the set font background command to select the color and typeface of the background character Issuing a query background command returns the numeric value of the background character Example To set the background character to a dash type set background API Return Code 2 The Char option was not or did not represent a single character Check that it conforms to the syntax requirements and type the command again Related Reading Chapter 8 References 173 basefont Parameter Sets the default font for the current line Scope Line Syntax set basefont Char query basefont Option Char An predefined font character where Char can be specified in any of the following forms nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where n is a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any letter key An alphabetic character of value A to Z or a to z inclusive Description The basefont parameter specifies the default font for the current line Example To see the default font for a line type query
205. line The semicolon symbol is a synonym for the mult command API Return Codes 1 A mandatory parameter is missing from the command Issue the command again with the correct parameters 1 The Function was not valid Select a valid Function from the list provided with the command description and issue the command again Related Reading print Command Prints the current document Scope Global Syntax LPEX Editor User s Guide Parameter prompt printer x driver y fontsize size visible selected tokenized linenumbers startmargin col copies n Description printer fontsize size visible selected tokenized linenumbers off startmargin col copies n Displays the Print dialog box in which you can specify print options Print using printer x If enclosed in x can include spaces in the printer name Print using the y printer driver If enclosed in y can include spaces in the printer driver name Print the document using a printer font of size point size If specified without the off option print only document lines that are visible in the Editor window If specified without the off option print only document lines that are selected If specified without the off option print document text using token attributes Results will depend on the capabilities of your printer If specified without the off option add document line numbers at the start of each line printed The number of
206. line up to but not including line Number in the file Number Sort the next Number lines starting with the current line BLOCK Sort all lines in a block of selected text d Sort all lines from the current line to the end of the file including the last line in the file Mmark Sort from the current line up to but not including the line containing the named mark mark string Sort from the current line up to but not including the line containing the next occurence of the string expression specified in string A Sort by ascending string value This is the default if a sort ordering type is not specified D Sort by descending string value AN Sort by ascending numeric value DN Sort by descending numeric value Al Sort by ascending string value ignoring character case DI Sort by descending string value ignoring character case coll col2 A pair of column numbers defining a sort field within each line Column numbers are always absolute column numbers Up to 100 pairs of column numbers can be defined as part of a sort command line invocation with highest sort priority given to the first column number pairs appearing in the command line invocation If no column number pairs are specified the entire line is considered to be the sort field Description The sort command provides a method of sorting information in specific areas of a file Options associated with the sort command let you define sort fields for data in specific location
207. ll be enabled or disabled Scope File Syntax set group MenuItemId GroupName GroupName 236 LPEX Editor User s Guide Options MenultemId The numeric menu item id that can be obtained by the query actionbarid command If zero or no value is specified the id for the last defined menu item is used GroupName The name of the group to which the Menultemld is added Unrecognized group names are ignored One or more of the following groups can be specified BLOCK CHANGED ClassName CLIPBOARD DOCNONEMPTY MARKSET MOREDOCS MOREVIEWS SAVEABLE WRITEABLE Description The group parameter specifies the group s to which a menu item belongs The conditions for each associated group must be satisfied before a menu item is enabled For example the Paste operation belongs to the CLIPBOARD and WRITEABLE groups It will be enabled only when there is text in the clipboard and the file is not readonly The following table lists the states required for each group to be active or inactive Group Name Active Members are Inactive Members are not Selectable Selectable BLOCK Block is set Block is not set CHANGED Change has been made No changes have been made ClassName Other classes are included in Only a specified class is the current view included in the current view CLIPBOARD Clipboard contains text Clipboard is empty DOCNONEMPTY File contains text File is empty MARKSET Mark is set No mark is set MOREDOCS More than one file is open
208. lt Right Ctrl Alt Left Ctrl L Ctrl M Ctrl R Related Reading Cancel a menu or the system menu Go to or from the menu bar Go to the first choice in a menu Go to the last choice in a menu Move between the menu bar and menu choices Select the associated item on menu bar or menu Close a program window Find a text string with the Editor find and replace dialog box Go to next file in ring Go to previous file in ring Go to next ring Go to previous ring Locate line by line or sequence number If used when the Line Number dialog box is in focus focus will be switched back to the Editor Match brackets for C language Prototype expansion template insertion 380 LPEX Editor User s Guide Keys for Text Selection and Actions Keys and actions you use to select text differ depending on the following e If token highlighting is on you can select tokens otherwise you can select character strings words delimited by white space or the end of line EOL character e If you have already selected a token some actions will deselect it and select another one Other actions will expand or contract the selection e If your keyboard is in Replace mode the cursor is placed on a character and that character is selected by a block In Replace mode selection actions may include the character where the cursor is located as well as a selected field which can be a character a word or a token The following ke
209. ltem Pop up sub menu item to which the new menu item should be linked Ordinal Integer value of zero or greater defining the position in which the new item is placed in the specified pop up menu or sub menu Description The popuplink parameter lets you link to the pop up menu items already defined in the menu bar and its sub menus You can place a linked menu item on the main pop up menu or in any pop up sub menu If the menu or sub menu location specified does not exist it is created If no menu or sub menu is specified the linked menu item is placed on the main pop up menu Example To add the Open new view choice from the File pull down menu to the third position in the pop up menu in the Editor window type set popuplink LP_NEWVIEW 2 API Return Code 1 Incorrect parameter specified Related Reading popupmenu Parameter Sets the contents of the pop up menu and associated pull down menu items in the Editor window Scope File Syntax set popupmenu Item BITMAP_resd1l_id Subitem BITMAP_resdl1_id OrdinalNumber Command query popupmenu Item BITMAP_resdll_id Subitem BITMAP_resdil_id 290 LPEX Editor User s Guide Options Item Name of the menu item to be included on the pop up menu Subitem Name of the selection item to be added to the Item pull down menu BITMAP Specifies that the pop up or pull down menu item is a bitmap If this is chosen you must also specify resdll The
210. lting pull down menu The Editor Find and Replace dialog opens Specify the item to be found and replaced by doing the following 1 Type a search item in the Find text entry area This can be a word a partial word or a sequence of such You can also enter a pattern you want to match provided that the pattern follows the rules of regular expression Type the replacement word in the Replace with text entry field Select your desired options If you enter a pattern in the Find text entry area you must also select the Pattern match check box Click on Replace If the entered text or pattern is found the cursor moves to either the next or previous occurrence of the search item according to your chosen search direction and replaces the found text according to your selections Related Reading Managing Files in the Editor Creating a New File You can open a new file by doing the following 1 2 Select File from the main menu bar Select New from the resulting pull down menu The New dialog appears Use the check boxes and selection lists to select the options you want 4 Click on New in this dialog box A new empty Editor window appears You can start entering text for your new file in this view Chapter 2 Using LPEX 13 Related Reading Opening an Existing File You can open an existing file by doing any of the following e Drag a file icon from a file manager window onto an Editor icon e At a com
211. make changes to the document because the readonly parameter is set to on Related Reading formatter Parameter Turns formatting instructions on or off Scope Global Syntax query formatter set formatter on off inverse Options on Sets line formatting on off Sets line formatting off inverse Toggles between on and off Description The formatter on parameter formats documents and uses information supplied by commands and parameters such as indent format and wrap to format displayed text Chapter 8 References 231 Formatted text can be saved as displayed by using the save command with the asshown option When the formatter parameter is set to off each element is displayed unformatted on a separate line The default setting for the formatter parameter is off The formatter parameter setting can also be changed by the Wrap setting choice found in the View pull down menu Selecting the Wrap setting sets both the formatter and wrap parameters to on and the formwidth parameter to 0 Deselecting this choice sets the formatter and wrap parameters to off The formwidth parameter is not changed and retains its value of 0 Conversely setting both the formatter and wrap parameters to on and the formwidth parameter to 0 will select the Wrap setting choice Example The following is an example of a document with wrap on formwidth 30 and formatter set to off At that very moment Jack knew he was on a very hot
212. mand line prompt type iedit filename ext where filename ext is the name of the file you want to edit e If the Editor is already running do the following 1 Select File from the Editor menu bar 2 Select Open from the resulting pull down menu 3 Use the file and directory selection lists to select the file you want to open 4 Click on the OK push button to open the selected file for editing An Editor window opens showing the chosen file Note The Editor will not try to open a file that is already loaded in the Editor Related Reading Saving a File To save your work do any of the following 1 To save one file a If you have more than one Editor window open select the window that contains the work you want to save b Select File from the Editor menu bar 14 LPEX Editor User s Guide Select Save from the resulting pull down menu If you are saving an existing file the file is saved under its current name If you are saving a new file the Save as dialog box appears Enter a new name for the file and click OK The new file is saved under this name To save one file to a different file name a If you have more than one Editor window open select the window that contains the work you want to save b Select File from the Editor menu bar c Select Save as from the resulting pull down menu The Save as dialog box appears Enter a new name for the file and click OK The new file is sav
213. mbollist Parameter synonym Parameter synonymlist Parameter tabcursorpos Parameter tabs Parameter textlimit Parameter timeout Parameter toolbar Parameter toolbarlist Parameter toolshow Parameter toolview Parameter trigpos Parameter unprotect Parameter version Parameter view Parameter viewlist Parameter viewname Parameter viewnum Parameter window Parameter windowid Parameter windowpos Parameter windowshow Parameter wordchars Parameter wrap Parameter Primitive Functions Summary External Subroutines Summary lxcmd Subroutine lxcall Subroutine Ixquery Subroutine Ixnext Subroutine Ixprev Subroutine Ixqtext Subroutine lxstext Subroutine Ixqfont Subroutine lxsfont Subroutine Ixqclass Subroutine lxsclass Subroutine lxalloc Subroutine lxfree Subroutine Regular Expression Syntax and Usage Alternate Editor Personalities ISPF Editor Personality SEU Editor Personality XEDIT Editor Personality Keys Help Editor Shortcut Keys Keys for Text Selection and Asiotis 329 330 332 334 334 335 336 337 338 339 340 342 342 343 344 345 346 347 347 348 349 350 350 351 352 353 354 355 357 358 359 360 361 362 363 363 364 365 366 367 368 369 370 372 372 374 376 378 378 381 Notices Any reference to an IBM licensed program in this publication is not intended to state or imply that only IBM s licensed program ma
214. meter specifies the number of character positions by which each level is indented when the document is displayed The number of indented spaces is the product of the level which is set by the format parameter in conjunction with the value of Number Note The indent parameter has no effect on displayed text unless the formatter parameter is set to on Examples To set the indent to three character positions type set indent 3 The actual indent of each element shown in the window varies with the level of the element For example an element of level 1 is indented three character positions A level 2 element is indented six character positions and a level 0 element has no indent at all API Return Code 2 The specified Number is not in the valid range of values Related Reading inserting Parameter Sets the cursor to insert or replace Scope View Syntax query inserting set inserting on off inverse 246 LPEX Editor User s Guide Options on Characters are inserted This is the default off Characters are replaced inverse Toggle between on and off Description The inserting parameter sets the cursor to insert inserting on or replace inserting off This lets a macro or command force insertion or replacement of characters at the cursor Example To set the cursor to insert mode type set inserting on API Return Code 2 The option you specified was not on off or inverse Related Reading
215. mple 2 type set popupmenu E xample BITMAP_evfwrc21_2 alarm You can also use a bitmap as a menu item in the pop up menu 5 You can define sub menu items to sub menu items For example the following example adds a sub menu item called Add to the pop up menu defined in Example 2 Selecting the Add pop up menu item raises a cascaded menu with menu items that add one two or three lines to your document set popupmenu E xample Add One_line add 1 set popupmenu E xample Add Two_lines add 2 set popupmenu E xample Add Three_lines add 3 292 LPEX Editor User s Guide API Return Code 1 The option specified for Item was not valid Type the option exactly as it appears in the menu including uppercase and lowercase letters 2 The item sub menu item or bitmap name contains invalid characters or you tried to define a new menu item without specifying a command Related Reading popupmenuid Parameter Queries the menu id of a pop up menu item in the Editor window Scope File Syntax query popupmenuid Item BITMAP_resdll_id Subitem BITMAP_resdll_id Options Item The name of a pop up menu item Subitem A sub menu item attached to the Item pop up menu BITMAP Specifies that the menu or sub menu item is a bitmap If this is chosen you must also specify resdll The resource dll containing the new item s bitmap id The id for the bitmap contained in the resdll resource dll Description The popupmenuid parameter queri
216. n Editor window type goview newring split name mysplitview Chapter 8 References 91 API Return Codes 1 A parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter 2 ViewNumber must be in the valid range 4 Exceeds maximum number of views in a ring 8 Insufficient storage to continue Related Reading Ra Te ETS help Command Returns help information on a requested command or parameter Scope Global Syntax help requested_item Parameter requested_item The Editor command or parameter for which you want help Description The help command returns help information specific to the requested command or parameter Issuing the help command without a specific request returns general help information Example To display help for the add command type help add API Return Codes None 92 LPEX Editor User s Guide insert Command Inserts a text string after the current line Scope File Syntax br insert Fes frin g tta Parameter TextString The text string that forms the content of the line It can be blank Description The insert command inserts a new line made up of TextString after the current line The new line becomes the current line and inherits the current font formatting and class settings The new line merges with the following line if a following line is available Note Leading blanks
217. n a specified row in the window The overlay remains in the fixed position on the window even if the file is scrolled The string appears in the font set by set font overlay An overlay is deleted using set overlay RowNumber with no text RowNumber must have the same value and sign used when the overlay was first specified Example 1 To place a warning note on row 3 of the window type 282 LPEX Editor User s Guide set overlay 3 WARNING nosave is on The text WARNING nosave is on stays on row 3 of the window even if the file is scrolled 2 To delete the overlay on row 3 of the window type set overlay 3 3 To place a warning note on the fourth row from the bottom type set overlay 4 WARNING nosave is on API Return Code 2 The RowNumber specified was not numeric Related Reading pad Parameter Defines the pad character Scope View Syntax query pad set pad Character Option Character Any single printable character including the space character or blank The pad character can be specified in the following ways nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any keyboard character Any single printable character entered from the keyboar
218. n the correct form All parsers must be invoked using this command Example To process a command without applying synonym resolution type Ixr add 10 API Return Codes 1 The commands in the Commandparameter were not valid Editor commands Make sure all commands are valid and if more than one command is issued make sure you have used the mult command 8 Insufficient storage to continue Related Reading macro Command Searches the LPATH for a macro file then processes it Syntax b macro Filename e Parameter Parameters Filename Name of the macro to invoke If the macro is not in the current directory or in a directory listed in the LPATH then specify a full path name If no extension is supplied then lx is added to the name 102 LPEX Editor User s Guide Parameter The parameter string to be passed to the macro Description The macro command searches for a file and invokes it as a macro It invokes simple macros files containing only comments and Editor commands by passing each line of the file to the Editor for processing When MACRO is set to BUILTIN the Parameter string is not processed You can view the MACRO type using the environment command Example To invoke a macro called newkeys type macro newkeys The Editor searches for a file called newkeys lx and processes each line of the file as either a command or a comment API Return Codes 1 The file specified as a macro was not found
219. n the display type set focus next 8 Chapter 8 References 221 The focus line is set to eight only until the cursor is moved again 3 To set the fifth row from the top as the row that triggers upward scrolling type set focus top 5 4 To define line 2 as the focus line to be used by the focus command as a default type set focus row 2 5 To remove lines that cause scrolling type set focus bottom set focus top By not specifying the RowNumber you can set the focus line to either the very bottom or the very top of the window API Return Code 2 The RowNumber specified was larger than the number of rows in the file view To find out the number of rows in the window use the query dispdepth command Related Reading font Parameter Sets attributes of a font Scope View Syntax query font FontName set font FontName bold italic underline reverse Foreground Background Description 222 LPEX Editor User s Guide Options FontName The name of the font to be set This can be one of the following Letter An uppercase letter where Letter can be represented by nn A decimal based ASCII character code where nn is a numeric value between 65 and 90 inclusive For example character code 65 A xnn or xnnn A hexadecimal based ASCII character code where n is a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive Valid hexadecimal values for nn ra
220. nbarlist Options None Chapter 8 References 159 Description The actionbarlist parameter lists the names of all user defined menus on the menu bar for the current file Examples To list all user defined menus for the current file type query actionbarlist API Return Code 1 This parameter cannot be set Related Reading actionlist Parameter Lists the logical keys to which commands have been assigned Scope File Syntax query actionlist Description The actionlist parameter lists the keys to which commands have been assigned by the set action parameter Note For a list of the logical keys and the commands assigned to each key use the list parameter This parameter cannot be used in an API call Example To list the keys that have commands assigned to them type query actionlist API Return Code 1 You cannot issue the set command with this parameter 160 LPEX Editor User s Guide Related Reading actionprefix Parameter Assigns a prefix command to a character sequence Scope File Syntax query actionprefix prefixcommand set actionprefix prefixcommand Command Options prefixcommand Prefix command to be defined This can be any non numeric character sequence Character case is not significant Command Any Editor command and its associated parameters if any If Command is omitted prefixcommand becomes undefined The text will be left in the prefix area until it is explicitly reset
221. ndow is scrolled to display the new cursor position API Return Codes 2 The number specified was either outside the valid range or not an integer Issue the command again using a valid number Related Reading cursorcol Parameter on page 192 tabs Parameter Sets tab positions Scope File Syntax query tabs set tabs Position Position every Interval Options Position Explicit positions for up to a maximum of 50 tab settings These positions must be sequential every Interval Sets tabs at fixed intervals The default is 8 Description The tabs parameter sets tab postions for the file When the Tab key is pressed the cursor moves to the next tab position When the Backtab key is pressed the cursor moves to the previous tab position You can set tabs at a number of explicit positions and at fixed intervals Examples 1 To set tabs at positions 8 12 16 26 36 type set tabs 8 12 16 every 10 2 To set tabs at positions 10 20 30 40 50 type Chapter 8 References 337 set tabs every 10 API Return Codes 2 You have specified more than 50 Positions for the set tabs command Issue the command again with fewer Positions 2 The Interval set for the every option is not a whole positive number Issue the set tabs command again with a valid Interval 2 The Positions set are not sequential Issue the set tabs command with the Positions listed in ascending order 2 One or more of the sp
222. ng Arithmetic anaes in Editor Macros Using Constants and Variables i in Editor Macros Using the IF Stateme t i in Editor Mactos Using Loops in Editor Macros Using REXX Functions in Editor Maios repeats sample macro This macro repeats a command a given number of times g a set lineread title Repeat a Command set lineread prompt Enter the number of times to repeat lineread 255 extract lastkey if lastkey ENTER then do extract lastline if datatype lastline numrep lastline MSG You must enter a valid acinar return noes cmd_rep lastline repeat numrep cmd_rep NUM Chapter 7 External Editor Commands Writing External Command Source Code Application Programming Interface Overview Program Entry and Exit Conditions Sample External Command proto Chapter 8 References Commands Summary 26 26 27 28 29 31 32 35 36 36 38 38 40 41 42 45 46 46 46 47 47 47 48 48 48 49 49 49 49 51 51 52 52 53 55 55 iii Command add Command alarm Command all Command begin Command block Command bottom Command change Command check Command clip Command compare Command delete Command detab Command dialog Command dup Command end Command entab Command exit Command extract Command file Command find Command focus Command get Command godoc Command goring Command goview Command help
223. ng the selection types set by the blockdefaulttype parameter Chapter 8 References 63 mark character mark stream mark element mark group mark rectangle set character set element set group set rectangle set stream mark word set word 64 LPEX Editor User s Guide Sets the beginning or end of a character block On the first call a single character is marked On a second call the block is extended to all characters between the initial and the current positions On further calls the block is extended if the current position is before or after the block or if the current position is inside the block reduced to include characters between the original start and current position Sets the beginning or end of a stream block It is similar to a character block except for the following differences e It has a scope of view e The selection is coupled with the cursor If the cursor is moved the block selection will disappear e The delete and backspace keys will cause a selection to be deleted e A stream block can be replaced by text entered from the keyboard played back by the keystroke recorder or pasted from the clipboard Sets the beginning or end of a line block On the first call the current line is marked On a second call the block is extended to include the new current line On further calls the block is extended if the current line is outside the block or if the current line is inside the block i
224. nge from 41 to 5A inclusive For example character code x41 A keypress An alphabetic keyboard keypress of value A to Z inclusive background Background character font block Marked block font bold Displays the text in bold font context Context lines font fill Fill character font highlight Highlighting font italic Display the text in italic font overlay Overlay lines font prefixentry Prefix entry font prefixtext Text part of prefix data prefixnumber Numeric part of prefix data space Space area font symbol Displayed symbols font underline Underline the text bold Displays the selected font in bold face Chapter 8 References 223 italic underline reverse Foreground Background Description Description Displays the selected font in italic face Displays the selected font as underlined characters Displays the foreground color as the background and the background color as the foreground The foreground color Specify either the color number or its corresponding default color name which can be any one of Color Default Value 1 black 2 blue 3 green 4 cyan 5 red 6 pink 7 brown 8 light gray 9 gray 10 bright blue 11 bright green 12 bright cyan 13 bright red 14 bright pink 15 yellow 16 white The background color which can be any color number or name from the list above You must include the in the command string Description of the token type associated with th
225. nly if it occurs at the very end of a line Matches the pattern specified by expr only if it comprises the entire line Matches zero or more occurrences of the pattern specified by expr Matches one or more occurrences of the pattern specified by expr Matches the pattern specified by either expr1 or expr2 For example slo matches both characters s and o Operator Orders of Precedence Regular expression elements are processed in a specific order The order of precedence is described below Element categories with higher precedence appear closer to the top of the list Within each category higher precedence is to the left Operators special 2 n n n1 n2 Related Reading Category or Description Special characters preceded by a backslash Bracket expressions Grouping of expressions Pattern repetition Anchoring of pattern to start or end of line Alternate match patterns Alternate Editor Personalities ISPF Editor Personality The following is a list of the ISPF prefix area commands that you can use in the Editor window 372 LPEX Editor User s Guide Select the ISPF editor personality by selecting Options gt Key behavior in the Editor window To process ISPF commands type the commands you want to use over the sequence numbers in the prefix area hold down the Alt key and then press Enter A Move or copy lines after this line B Move or copy lines before this line C Cop
226. not a valid class type Use the query classes command to see which ClassName is currently defined or use the set class command to define a new class Issue the command again using a valid ClassName Related Reading expandtabs Parameter Expands tab characters found in a file to spaces for viewing purposes Scope View Syntax query expandtabs set expandtabs on off inverse Options on Tab characters found in a file will be expanded to spaces for viewing purposes off Tab characters are displayed as is inverse Toggles the value of the parameter between on and off Description Chapter 8 References 211 The expandtabs parameter controls how tabs are displayed in the Editor If the expandtabs parameter is set to on tab characters in the file will be expanded to spaces according to the value of the tabs parameter for viewing purposes only Tab characters in a file are not changed by the expandtabs parameter If however the file is saved with the asshown option tab characters are expanded to spaces in the saved file The expandtabs parameter is affected by the preserve reset and restore commands Example To expand tab characters to spaces in the current file view type set expandtabs on API Return Codes 2 Invalid parameter argument given Related Reading filedialog Parameter Default drive directory and file mask for the Open Get and Save As dialogs Scope Global Syntax set _filedi
227. not provided 3 The specified menu item ID does not correspond to any user defined action 238 LPEX Editor User s Guide hex Parameter Returns the hexadecimal ASCII code of the character at the current cursor position Scope View Syntax query hex Description The hex parameter returns the hexadecimal ASCII code of the character at the current cursor position If the cursor is beyond the end of the line a value of 0 is returned Example To see the hexadecimal ASCII value of the character at the current cursor position type query hex API Return Codes None highlight Parameter Selects the classes to highlight on the display Scope View Syntax query highlight set highlight ClassName ClassName Option ClassName Name of the class to be highlighted separated by blanks Description The highlight parameter defines the classes to be highlighted Any line that has a class specified has its contents displayed using font highlight You can Chapter 8 References 239 identify classes that are not visually distinguishable by their fonts The highlight parameter is especially useful for error conditions Note The font used for marking blocks font block overrides the font used for highlighting set highlight Example To define the classes to be highlighted type set highlight comment The COMMENT class is displayed using fonts set by font highlight API Return Code 2 The specified ClassName
228. nt to 0 may prevent changes from triggering an autosave of the file However an autosave is made anyway if the time since the last autosave or load equals the value set by the autotime parameter and at least one change has been made since that save or autosave Example To set a file to save automatically after 20 changes are made type set autocount 20 API Return Code 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading autoname Parameter Sets the name for the autosave file Scope File Syntax query autoname set autoname Drive Directory Filename Option Drive Directory Filename The drive directory and filename of the autosave file including a relevant extension Description The autoname parameter sets the name under which a file is saved automatically if the conditions set by the autocount or autotime parameters are met The default autoname is the 8 character hexadecimal equivalent of the window handle under which the file was first opened This method is used to minimize the possibility of a duplicate id when using the Editor in a network environment You can change this name but should do it before the first autosave Chapter 8 References 167 Note Any changes you made to your file will be autosaved to the file specified by the autoname parameter The original file is not updated if you quit without saving the fi
229. nteger value If not specified the default is 1 Description The undo command lets you restore the document to a previous state by undoing or redoing undoing an undo sets of changes generations to a document These sets of changes are recorded using the check command or more usually the autocheck parameter provided the recording parameter is set to on Depending on the value specified for Number the undo command handles changes to a document as follows No value Undo the last change to document and decrement the value of the specified changes parameter by 1 Positive integer Undo the most recent number of changes specified by Number and decrement the value stored in the changes parameter by the value of Number Negative integer Redo the most recent number of undos specified by Number and increment the value stored in the changes parameter by the value of Number You can perform any combination or number of undo and redo operations until a change is made to the document Once you have made that change the undo operation becomes a single undoable change regardless of the number of undo and redo operations just performed 140 LPEX Editor User s Guide Examples The examples refer to the following states of a file linel linel linel linel linel line2 line2 line2 line2 line3 line3 line3 line4 line4 lined State E State D State C State B State A Most Oldest recent version version The file starts in state A and i
230. o This is shown below start line 1 end line 1 start line 2 end line 2 start line 3 end line 3 start line 4 _ end line 4 start line 5 end line 5 6 To set the level of line 3 to three levels lower than level 2 but two levels higher than subsequent elements place the cursor on line 3 and type set format after 2 before 3 The before option sets line 3 4 and 5 to level 3 and the after option sets lines 4 and 5 to two levels lower that the level set for line 3 This is shown in the following start line 1 end line 1 start line 2 end line 2 start line 3 end line 3 start line 4 _ end line 4 start line 5 end line 5 230 LPEX Editor User s Guide Note Indentation spaces will be represented by a fill character The default fill character is a period but you can define your own fill character by using the fill parameter In the examples above the fill character is defined to be a blank API Return Codes 2 The current element is a header element in the document and cannot be changed 12 This command requires an open document First open a document then issue the command 2 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set command again 5 You cannot
231. o F or a to f inclusive For example character code x41 A any key Any keyboard character FontName The font specified for the special character Description The symbol parameter assigns a special character to a symbol When SymbolString is typed in the file it is replaced by the Character assigned to it providing a live parser is processing symbols If FontName is not specified the default font for the line is used Example To specify that typing beta in the file enters the lowercase Greek beta character B in font type set symbol beta xel or set symbol beta 225 beta is the symbol and xe1 or 225 represents the special character B API Return Codes 2 FontName must be a single character Check the syntax requirements for the parameter and issue to parameter again 2 The special character specified in the set symbol command was not in the range 1 to 255 Enter a valid value and re issue the command Related Reading Chapter 8 References 333 symbollist Parameter Returns list of current symbols Scope File Syntax query symbollist Description The symbollist parameter gives an unordered list of all the symbols set for the current file Example To list all the symbols set for the current file type query symbollist API Return Codes None Related Reading synonym Parameter Sets up a synonym Scope File Syntax query synonym Name set synonym Name Length Value O
232. o be issued Description The Ixn command issues an Editor supplied command from within a macro external command or command line without a macro search so that the command string is processed in the simplest possible way Example To process an Editor command delete type Ixn delete 5 API Return Codes 8 Insufficient storage to continue 1 The commands in the Commandparameter were not valid Editor commands Make sure all commands are valid and if more than one command is issued make sure you have used the mult command For other codes returned by called routines or macros see the relevant routine or macro Related Reading fxr Command Ixr Command Issues one or more resolved commands in an Editor window Syntax tae ler Command a Parameter Command Name of the command to be issued Chapter 8 References 101 Description The Ixr command processes the command as a possible macro or Editor command It is processed as follows 1 As acommand only if the impset parameter is on 2 If not found the Editor adds 1x to the front and looks for an external command on the LPATH If one is found the Editor passes control to this 3 If not found and if impmacro is on the Editor tries to process the command as a macro This routine receives all commands issued from Editor macros In all cases if live parsing is in effect trigger is called after the command is invoked to ensure that any changed data is i
233. o create a new mark mark set The Editor will assign the next available id number to the new mark You can get the id of the new mark by querying the markid parameter Set the current cursor position to the position recorded by the mark set Name or mark set Idcommands The mark specified must exist in the current file Cancel the specified mark The starting line of the mark This value must be an integer The starting column of the mark This value must be an integer The ending line of the mark This value must be an integer The ending column of the mark This value must be an integer Display lines associated with the specified mark as follows on Hide from display lines that are not associated with the mark off Do not hide from display lines that are not associated with the mark inverse Toggle between on and off Do not display lines associated with the markNameas follows on Hide from display lines that are associated with the mark off Do not hide from display lines that are associated with the mark inverse Toggle between on and off Display the specified mark in the character size and font specified by Font If Font is not specified the mark displays in the default editing window font Font can be any valid font name as described in the help for the font parameter Marks function like a bookmark Use the mark command to position new marks or relocate existing marks Once set you can use the mark command to qu
234. o form the new content of the line The default is null Description The content parameter changes the content of the current line The fonts parameter is reset to the default font for the current line repeated to the same length as the new content and the position parameter in the line to set to one Examples 1 To query the content of a character string type query content 2 To replace the contents of the current line with This is a replacement statement type set content This is a replacement statement The current line is deleted and replaced with the specified text string API Return Codes 8 Insufficient memory 6 Text limit exceeded operation cancelled 5 You cannot make changes to the file because the readonly parameter is set to on 10 The text length limit is exceeded in the line The update to the line has been accepted as is 11 The text length limit is exceeded in the line The content of the line has been truncated Chapter 8 References 191 Related Reading creating Parameter Associates a command with the creation of a line Scope Line Syntax set creating Command query creating Option Command An external command macro or internal command Description The creating parameter associates Command with the creation of a line Example To associate the test macro with the current line type set creating test API Return Codes None cursorcol Parameter Moves the cursor to the specified
235. o many words or parameter string is too long 5 You cannot make changes to the file because the readonly parameter is set Chapter 8 References 129 Related Reading setoldlines Command Sets the old line value for each line to its current line number Scope File Syntax rs etold lines _ _ _ i MmMOoOo i i i i rd None Description The setoldlines command sets the old line value for each line equal to the current line number of that line Examples To assign an old line value to each line in a document type setoldlines API Return Codes None Related Reading showfont Command Displays the content of the character set Scope View Syntax 130 LPEX Editor User s Guide Te font Parameters font Displays the character set for this font This is the default value off Removes the showfont display Description The showfont command invokes the external command Icshwfnt dll which displays the entire character set for the given font on a series of overlay lines and in their own typeface If no parameters are specified with this command the character set is displayed in font 1 Example To display the entire character set for the given font type showfont API Return Codes 2 Invalid font name 1 Font was not set sort Command Sorts lines of text Scope File Syntax br sort coll col2 Chapter 8 References 131 Parameters Number Sort from the current
236. o which to move the current view Queries the number of rings active in the Editor Query only Sets the display state of the ring selector Controls the display of the format line in the edit window Specifies the content of the format line Gives the number of rows and columns and pels in the screen Query only Gives the number of elapsed seconds since the start of the Editor session Query only Turns a line into a show line Enables display of the current line Enables display of show lines Sets the offset of the leftmost visible column Sets the space character Sets the formatting width for elements to spill over to a new line Sets the default orientation of split window borders in the Editor window only Controls the display of the status line Specifies a callback routine to be called when a specified menu bar item or sub item is selected Assigns a special character to a symbol Returns list of current symbols Query only Sets the value of a synonym Lists current synonyms Query only Sets the column allowing for expanded tab characters in a line containing the cursor Sets tab positions Sets the byte limit on the size of lines Number of minutes before the Editor closes down after the last Editor window is closed Creates new tool bar items Parameter Name Description Lists items in the toolbar menu Query only Displays or hides the tool bar Determines whether text graphics or
237. ock type favoured by the block selection commands and primitives when no block type is explicitly specified The setting of the parameter will affect the block mark and block set commands as well as selection primitives The value of the blockdefaulttype parameter is saved between Editor sessions Note Some types of block selection require the mode to be set to character or stream For these commands if the blockdefaulttype parameter is not set to either character or stream then stream will be used Example To set the default block type to character type set blockdefaulttype character API Return Codes None Related Reading blockdoc Parameter Gives the number of the file that contains the marked block Scope Global Syntax query blockdoc Description The blockdoc parameter gives the file number the number of the file in the sequence of open files of the file containing the current block or zero if there is no current block Example To display the file number of the file containing the current block type query blockdoc 178 LPEX Editor User s Guide API Return Codes None Related Reading blockend Parameter Gives end position of block Scope Global Syntax query blockend Description The blockend parameter gives the end position of the current block If no block is set or if a line block is set zero is returned The value returned depends on the type of block set Block Type Valu
238. ocument number specified is not open in the Editor 7 No current document to compare 8 Out of memory in compare 11 Cannot compare document to itself 12 Document failed to load 13 Number of open documents is not two delete Command Deletes one or more lines Scope File Syntax br delete e Number Chapter 8 References 73 Parameter Number The number of lines to be removed Must be positive The default is one Description The delete command removes the current line or the current line and a number of following lines from the file The line that follows the deleted lines becomes the current one If there are no following lines the previous line becomes the current line If a parser is set the new current line if any is added to the pending list If any deleted line contains the beginning or end of a block the block clear command is called before the delete is done Example To delete the next five lines from a file type delete 5 The sixth line becomes the current one API Return Codes 1 The number specified was not a positive integer Issue the command again using a valid positive number 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading detab Command Expands tabs to blanks Scope File Syntax Parameters 74 LPEX Editor User s Guide None Description The detab command expands tabs to blanks according to the current tab
239. on e If you wish to include a 9 or an X as part of the displayed prefix it must be preceded by a character e If the numeric part of the prefix data overflows its space in the format string it will be truncated on the left e If the numeric part of the prefix data does not fill its space in the format string it will be padded with leading zeros e If there are more X characters than text data the remaining X characters will be padded with blanks e If there is more text data than X characters the unused characters will not be displayed Description The prefixdisplayformat parameter controls how the prefix data will be displayed in the left margin of an edit view The prefix data is divided into two parts a text part and a numeric part This division is defined by the prefixformat parameter The format string will determine how these two parts are displayed in relation to one another Note that the prefixshow parameter must be used to control whether the prefix data is actually displayed If there is no prefix data or there is no numeric part to the prefix data the line number will be displayed in the numeric part of the prefixdisplayformat format string If the text part of the prefix data contains DBCS data no attempt to maintain the integrity of DBCS characters will be made during display formatting Example If the prefixformat parameter is set to 999999XXXXXX and the numeric part consis
240. ons are case sensitive only if you select the Case sensitive check box in the Editor Find and Replace window The basic forms of a bracket expression are Expression Description string Matches any of the characters specified in string For example set matches the next instance of characters s e or t string Does not match any of the characters specified in string symbol1 symbol2 Matches all collating elements that fall between the two specified collating symbols inclusive The symbols must be different with symbol2 higher in the collating sequence than symbol1 For example d f will match the next instance of characters d e or f Note If you want to match a hyphen the hyphen must appear as either the first or last character in the string 370 LPEX Editor User s Guide Note You can use a right bracket as an ordinary character in a bracket expression only if you specify it as the first character following the left bracket or caret symbols Regular Expression Syntax You can combine characters special characters and bracket expressions to form regular expressions that match multiple characters and character patterns Basic syntax elements for regular expressions are described below Expression Syntax expr expr expr n expr n Description Matches expr Place a simple expression in parentheses if you want to apply a or operator or pattern repetition expression to i
241. ope File Syntax query autochanges set autochanges Number Option Number Number of changes between autosaves The default is zero Description The autochanges parameter gives a count of changes since the last autosave The query autochanges command lists the number of changes made to the file since the last save or autosave or since the file was loaded if no previous save or autosave was made The autochanges parameter can be set explicitly to either a higher count to force an autosave or to a lower count to postpone an autosave 164 LPEX Editor User s Guide An autosave is made when the value of autochanges equals or exceeds the value set by the autocount parameter or when the time elapsed since the last autosave equals the value set by the autotime parameter Examples 1 If autocount is 15 to force autosaves after only five changes type set autochanges 10 After five changes autochanges is increased to 15 equal to autocount thus forcing an autosave 2 To list the number of changes that have been made since the last autosave type query autochanges API Return Code 2 The number specified was not a positive integer Related Reading autocheck Parameter Enables automatic checkpointing Scope File Syntax query autocheck set autocheck on off inverse Options on Takes checkpoints automatically This is the default value off Does not take checkpoints automatically inverse Toggles between
242. or User s Guide Description Gives the exclude setting of a mark Query only Gives the font setting of a mark Query only Gives the id value of a mark Query only Gives the include setting of a mark Query only Displays a list of mark names set in the current file Query only Returns starting and ending positions of the specified mark Query only Enables or disables a menu bar item pull down menu choice or pop up menu item Sets or unsets the checkmark for a menu choice Controls the display of messages Enables the display of messages Displays the character modes for the current line Query only Sets the file name of a file view Saves the file without trailing blanks Enables save to be on Set the OLDLINE value for the current line Defines the font for overlay lines Sets the overhang for formatting flowed lines Sets the overlay text for the Editor window Sets the pad character Sets the parent window for the Editor window Defines command for live parsing Sets line pending live parsing Specifies a callback routine to be called when the pop up menu is raised Add menu items already defined on the menu bar to the pop up menu Sets the contents of the pop up menu and associated pull down menu items Queries the menu id of a pop up menu item Query only Lists user defined pop up menus Query only Parameter Name Description Sets the cursor position in the line Specifies
243. or cascaded menu You must first delete the item then recreate it specifying the new menu item contents Chapter 8 References 291 If no command is specified the item and any commands or sub menu items attached to it are deleted Examples 1 To create a Example pop up menu item which creates a sound when selected type set popupmenu Example alarm 2 To create a Example pop up menu item with a sub menu item called Sound which creates a sound when selected and mnemonics for both items type set popupmenu E xample Sound alarm The mnemonic for Example is x and the mnemonic for Sound is s Note You cannot define menu items with the same name within a given menu set Though Examples 1 and 2 appear to set up menu bar items with the same base name the mnemonic differentiates them You could continue to set up more menu bar items with the same base name as long as a different mnemonic was used for each item 3 To add an accelerator to the Sound sub menu item defined in the above example type set popupmenu E xample Sound tAlt S alarm The accelerator for Sound is Alt S 4 You can use a bitmap in place of a text label for your menu item or sub menu item Bitmaps must be defined in a DLL file located in a directory path included in your PATHenvironment variable The following example uses the bitmap with resource id 2 found in the evfwrc21 dll file included with the Editor To add this bitmap to the pop up menu defined in Exa
244. or command set Elaborate sequences of Editor commands are probably best saved to a macro or profile but you can also issue commands to the Editor without having to write a macro or profile To issue an Editor command 1 Press the Esc key to bring up the Editor command line at the bottom of the Editor window 2 Type your Editor command on the command line then press Enter to perform the command To recall a previously used command 1 While in the command line press the Up or Down arrow key Previously used commands will appear in the message window 2 Select the command you want to reuse then press Enter Copyright IBM Corp 1995 1998 21 Issuing Multiple Editor Commands The mult command lets you issue multiple Editor commands on one command line To use the mult command to issue multiple commands in one step 1 Change cursor focus to the editor command line 2 Type the following command mult command_1 command_2 command_3 where command_1 command_2 and so on are the commands you want to run 3 Press Enter There are many commands you can use in the editor command line For a complete listing of Editor commands see the Commands Summary Related Reading 22 LPEX Editor User s Guide Chapter 4 Using Parsers A parser is an editor command that acts interactively on a document to improve the presentation of the data in the document A parser uses colors and fonts to highlight different item
245. or left to display it Note A Tab character is counted as a single column in the line Example To set the cursor to column 34 type set cursorpos 34 If column number 34 is not currently displayed the file view is scrolled to display the new cursor position API Return Codes 2 The number specified was either outside the valid range or not an integer Issue the command again using a valid number Related Reading cursorrow Parameter Sets the row containing the cursor within the Editor Scope View Syntax query cursorrow set cursorrow RowNumber Option RowNumber The row number where the cursor is to be positioned It must not be beyond the bottommost row Description The cursorrow parameter sets the row containing the cursor within the Editor The topmost row of the window is row 1 The Editor adjusts the value if necessary so that the cursor position is within the text entry portion of the 194 LPEX Editor User s Guide screen If the RowNumber is set to a row in a nontext entry area the Editor places the cursor on the closest available row and adjusts the RowNumber to reflect the change Example To set the cursor to a new row type set cursorrow 17 API Return Codes 2 The RowNumber specified was larger than the number of rows in the window Specify a number smaller than the number of rows in the window Related Reading default Parameter Sets a default value for a parameter in the Editor win
246. or to the beginning of the current line Scope View Syntax Description The begin command moves the cursor to the beginning of the current line Example To move the current position to the beginning of the current line type begin API Return Codes None Related Reading block Command Manipulates a block of text Scope File Syntax 62 LPEX Editor User s Guide Parameters move JL copy fill Character shift T delete clear If no parameters are supplied a block mark is done Only one block can be marked at a time copy move before after clear mark Copies the current block The block definition moves to the copied block and the current position is moved to be the start of the new copied block If a character string is being copied the characters are copied before the current position If a list of lines is being copied the list is copied after the current line If a rectangular block is being copied the remainder of each line at and following the current position is moved to the right to make room for the block Deletes the block from its original position and places it into its new position The block is placed immediately before the current position The block is placed immediately after the current position Clears any currently set block Use the clear parameter to cancel a block after the copy fill lower move shift and upper parameters have been used Marks usi
247. ot coupled with the marked text selection You can mark a block of text with the mouse and then click the mouse at another location in the file without unmarking the block of text already selected element Whole elements are marked The cursor is not coupled to the marked text selection rectangle Rectangular areas can be marked starting at any character position on a line and extending over as many lines as needed The cursor is not coupled to the marked text selection To change the default block marking mode for the Editor window 1 Open the edit command by pressing the Esc key 2 Enter the following command set blockdefaulttype markmode where markmode is one of the modes listed above To determine the current default block marking mode 1 Open the edit command by pressing the Esc key 2 Enter the following command query blockdefaulttype 3 The current blocking mode is returned in the message area at the bottom of the Editor window Related Reading Chapter 2 Using LPEX 9 Using Location Marks in a File Location marks function like bookmarks You place them in your document and use them to easily return to marked locations in your file Creating and Naming a Location Mark To create and name a location mark in your document do the following 1 Place the cursor at the position to be marked 2 Select Edit from the main menu bar 3 Select Name a mark 4 Enter the name of the new mark in the text
248. our mark type the following commands set font M red yel low mark setfont 276 M To clear highlighting for the mark with id 276 type mark setfont 276 To display only lines associated with the mark areal type mark include areal on To exclude from display lines associated with the mark areal type mark exclude areal on Chapter 8 References 107 API Return Codes 1 The file is empty 2 No name specified 3 A parameter issued with the command was not valid Check the command syntax requirements and then issue the command again using a valid parameter 8 Insufficient storage to continue 1 Mark not found The specified name is unknown 2 The specified name was already in use It is now overridden 3 The mark refers to a line that has been deleted Related Reading msg Command Displays a specified message Scope Global Syntax gt i aas t Text String Parameter TextString The optional message to be displayed Description The msg command displays the TextString in the information area in an Editor window and logs it in the Editor macro log but only if the messages parameter is set to on The blank space after the msg command is significant Example To display the message No parameter used with this command type 108 LPEX Editor User s Guide msg No parameter used with this command API Return Code None Related Reading mult Command Issues a series of commands S
249. own menu sets or you can add to the contents of existing pull down menus Use text or icons to represent menu choices If you use icons the icons must be contained in a DLL file located in a directory path included in the PATH environment variable If Item Subitem or BITMAP does not already exist in the specified menu bar or sub menu it is created If Item Subitem or BITMAP is an existing item the following happens e Ifa command is specified the previous command is replaced with the newly specified command e If an item contains a pull down or cascaded menu you cannot change the contents of that item to a command Similarly if an item contains a command you cannot change the contents of that item to a pull down or cascaded menu You must first delete the item then recreate it specifying the new menu item contents e If no command is specified the item and any commands or subitems attached to it are deleted Examples 1 To create a Example menu bar item which creates a sound when selected type set actionbar Example alarm 2 To create a Example menu bar item with a subitem called Sound which creates a sound when selected and mnemonics for both items type set actionbar E xample Sound alarm The mnemonic for Example is x and the mnemonic for Sound is s Note You cannot define menu items with the same name within a given menu set Though Examples 1 and 2 appear to set up menu bar items with the same base name
250. p to 300 hundredths of a second type set beeplength 300 API Return Code 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading beeptone Parameter Sets the default tone of the alarm Scope Global Syntax query beeptone set beeptone Tone 176 LPEX Editor User s Guide Option Tone The tone of the alarm in hertz The default value is 440 and the range is between 50 and 10000 Description The beeptone parameter sets the default frequency of the sound produced by the alarm command If beeptone is not set the default frequency is 440 hertz Example To set the tone of the alarm to 550 hertz type set beeptone 550 API Return Code 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading blockdefaulttype Parameter Changes the block type favoured by the block selection commands Scope Global Syntax query blockdefaulttype set blockdefaulttype stream character element rectangle Options stream Set the default block type to stream If no block type is specified stream is assumed character Set the default block type to character element Set the default block type to element rectangle Set the default block type to rectangle Description Chapter 8 References 177 The blockdefaulttype parameter is used to change the bl
251. parsing of pending lines Undo one or more sets of file changes Chapter 8 References 57 Command Name Description Unlinks a previously linked external command Command Repeats the most recently run Editor command Scope Global Syntax Parameters None Description The command re runs the most recently run Editor command Example To add five new lines after the current line type add 5 Bring up the Open window by selecting the Open choice from the File pull down menu then close it To bring up the Open window again issue the Editor command as shown below API Return Codes None 58 LPEX Editor User s Guide add Command Adds one or more blank lines Scope File Syntax Se r Number Parameter Number The number of blank lines to add The default is 1 it must be a positive integer Description The add command adds one or more lines following the current line or sequence of flowed lines Each new line consists of a single blank on a new line To add a line at the top of the file before the first line move to the first character in the file and then use the splitjoin command to create a new blank line Example To add five new lines after the current line type add 5 API Return Codes 1 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number 5 You cannot make changes to the file because the readonly par
252. pe query lastkey API Return Code 1 You cannot issue the set command for this parameter Related Reading lastline Parameter Displays the last line obtained by lineread Scope Global Syntax query lastline Description The lastline parameter displays the line of data read by the most recent lineread command The key that terminated the lineread can be obtained by Chapter 8 References 253 using query lastkey The string lt Null gt is returned if lineread was not accepted a line with no data typed in it Example To return the last line obtained by lineread type query lastline API Return Code 1 You cannot issue the set command for this parameter Related Reading Related Reading length Parameter Displays the length of the current line Scope Line Syntax query length Description The length parameter displays the number of characters in the current line Note that you can have a zero length line such as a blank line Example To obtain the number of characters in the current line type query length API Return Codes None Related Reading 254 LPEX Editor User s Guide level Parameter Specifies the level of the current element Scope Element Syntax query level Description The level parameter displays the structural level of the current element and is set by the format parameter It can be negative if relative before and after settings are used such that the indent i
253. pe Global Syntax query global Name set global Name Value Options Name User defined name for the global variable Value Value assigned to the global variable Description The global parameter assigns a value to a global variable to all documents in the Editor Global variables remain until the Editor session is terminated They may be set or queried from any file Note The external command proto compares the current word with a list of global variables If the keyword is in the list proto substitutes the value of the variable For more on using the proto command to insert values for variables see the related readings below Examples 1 To display the value of a global variable called x type query global x 2 To assign the value company name to a global variable called x type set global x company name API Return Code 1 The option specified with the parameter was not valid Check the syntax requirements for the parameter and try the set or query command again Chapter 8 References 235 Related Reading globallist Parameter Lists names of variables global to all documents in the Editor window Scope Global Syntax query globallist Description The globallist parameter lists variables global to all documents in the Editor Example To list the global variables type query globallist API Return Codes None Related Reading group Parameter Specifies the conditions under which a menu item wi
254. pen file views for a file view with the specified number If the view is not found it is not created Shows the previous file view in the current ring If the current view is the first view in the ring the previous file view will be the last view in the current ring Shows the next file view in the current ring If the current view is the last file view in the ring the next file view shown will be the first view in the current ring Shows the next file view If the current view is the last view in a given ring the next file view shown will be the first view in the next ring The goview command with no parameters switches to the next file view The parameters allow specific file views to be called When you specify a parameter and a file view name the Editor ignores case when making comparisons though a new name is created exactly as typed If you create a new file view without specifying one of the nonewring or newring parameters the new file view is placed in a new or existing ring according to the value of the ring parameter Examples 1 To search for a file view called myview type goview name myview If the file view myview is not found it is created 2 To switch to a file view with a number of 45 type goview viewnum 45 3 To switch to a file view called functions type goview find functions If the file view functions is not found it is not created 4 To create a file view in a new ring that will split a
255. pexapi h Include File lpexapi h C Syntax int 1xcmd unsigned char Command Parameter Command A single string containing the command and any parameters to be issued Description 358 LPEX Editor User s Guide The lxcmd subroutine provides a way of issuing an Editor command from a C program It is passed one parameter which is a string containing the command with any parameters to be issued Examples 1 To issue the insert command type lxcmd insert this is a new element 2 To issue the find command type lxcmd find up asis needle 3 To issue the next command type lxcmd next word Return Value The return value is the return code from the Editor Related Reading Ixcall Subroutine Calls an Editor command with a separate parameter string Library Ipexapi h Include File lpexapi h C Syntax int Ixcall unsigned char Command unsigned char ParameterString Parameters Command The command name ParameterString The parameters for the command Description The Ixcall subroutine provides a way of issuing an Editor command from a C program It passes two parameters the first parameter is the command name and the second is the parameter string for the command Examples 1 To issue the insert command type lxcall insert this is a new element Chapter 8 References 359 2 To issue the find command type 1xcall find up asis line 3 To issue the next command typ
256. ple To allocate 1000 bytes of memory and then free them type char p p 1xalloc 1000 if p printf out of memory exit 2 Ixfree p Return Value There is no return value Related Reading Chapter 8 References 369 Regular Expression Syntax and Usage A regular expression consists of a combination of ordinary and special characters and bracket expressions Together these elements can be used to specify a search expression with flexibility and power far greater than that afforded by a simple text search Regular Expression Character Set You can use any single byte character in your regular expression subject to the rules listed below e An ordinary character is any single byte character that is not a special character An ordinary character matches itself A simple regular expression could consist of a string of ordinary characters which would be treated as a literal text search item e A special character is any of the following Lie eee e A special character preceded by a backslash matches itself e A period not preceded by a backslash matches any single character e Characters are case sensitive only if you select the Case sensitive check box in the Editor Find and Replace window Bracket Expressions A bracket expression can contain one or more expressions that match characters collating symbols equivalence or character classes or ranges of characters Bracket expressi
257. ple To return the window handle type query windowid API Return Codes None Related Reading windowpos Parameter Positions and resizes a file view in the Editor window Scope View Syntax query windowpos set windowpos X Y CX CY Options xX Y Coordinates determining the position of the lower left corner CX CY Coordinates determining the size of the file view Description The windowpos parameter positions and resizes the file view The parameters are given in pels X and Y set the position of the lower left corner while CX and CY set the width and depth If X amp Y are set to 1 the view can be resized without changing its location If CX and CY are omitted or set to zero the view is not resized Setting both CX and CY to 1 iconifies the view X and Y are ignored Chapter 8 References 351 There are a multitude of factors that govern exactly where on the screen a file view may be placed When you ask the Editor to place the view at a certain location it will do it s best to satisfy all the constraints and position the view as close to the location you specified as possible You might want to issue query windowpos after each set windowpos to determine the exact location of the view Some part of the file view must be visible on the desktop whose size can be obtained by query screen Example 1 To set the position for the file view type set windowpos 23 34 The lower left corner of the view is placed at
258. ple To set the current position to the first column of the current line type set position 1 API Return Codes 2 The Number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading prefix Parameter Specifies the value of the prefix data associated with the current line Scope Line Syntax query prefix set prefix7ext Chapter 8 References 295 Option Text The prefix data This parameter is interpreted according to the format specified by the prefixformat parameter Description The prefix parameter changes the prefix data of the current line Example To set the prefix of the current line to 012400920912 type set prefix 012400920912 API Return Codes 1 Parameter is read only The prefix parameter cannot be changed when autoprefix is set to on 3 Prefix does not match format 8 Insufficient storage to continue Related Reading prefixdefaulttext Parameter Sets the text that is to be used to set the text part of the prefix data when lines are inserted or changed and the autoprefix parameter is set to on Scope File Syntax query prefixdefaultext set prefixdefaulttext Text 296 LPEX Editor User s Guide Options Text The text part of the prefix data subject to the following rules If the autoprefix parameter is set to on Text is used to set the prefix data for lines that are inserted or changed e If the Text i
259. pment of your applications The code is provided AS IS without warranty of any kind IBM shall not be liable for any damages arising out of your use of the sample code even if they have been advised of the possibility of such damages FF F FF F F F KF F F F F FF F HF F Copyright IBM Corp 1995 1998 51 RRR RKRK KER KEK ER KEK ERK IK ERK ERK AK ERE EKER LXMIN2 C A minimal LPEX external command in C or C Eeue EEEE EE EEEEEE EEE EEEE EEEE EE E EE include lpexapi h include function definitions int Ixmain uchr parm 1xmain is the command entry point return 0 do nothing Note that the program entry point is always the lxmain function You cannot use the main function Related Reading Application Programming Interface Overview You can use the application program interface API to customize and extend Editor functions by adding new commands including parsers Related Reading Program Entry and Exit Conditions Entry Conditions External commands receive control at a routine called Ixmain Define this in your program as int 1xmain char parm The argument is a pointer to the command parameter string The return value is the return code sent back to the Editor The values 1 to 10 are reserved for use by the Editor you must not return these from your external commands All other return values are allowed 52 LPEX Editor User s
260. prefix numbers 5 The prefix number was requested but the prefix numbers are not ordered 7 When using the change all parameter a string was found at a wrap point noPrefixEntryFound There are no prefix entries in the document 84 LPEX Editor User s Guide Related Reading focus Command Moves the current position to the focus line Scope View Syntax Description The focus command scrolls the file up or down to move the current position the line containing the cursor to the focus line The focus line was set using the focus row parameter If a focus line was not set the focus command moves the current position to the center row of the Editor window Example The focus row is set to row 5 and the cursor is now on row 23 To scroll the file so that row 23 is moved to the focus row type focus API Return Code 9 Too many parameters Related Reading get Command Gets a file and inserts it after the current line Scope File Chapter 8 References 85 Syntax get Fienamne AA rr Parameter Filename Name of the file to be inserted Description The get command gets a named file and places it after the current line in the current file Example To incorporate the file nextopt doc into the current file type get nextopt doc API Return Codes 1 2 The file does not exist No filename was specified The Editor encountered an error while reading the file While reading the
261. ptions Name The synonym you are creating Must be composed either of just alphanumerics or just special characters Length Can be up to 25 characters long Value The command to be issued when Name is typed Description 334 LPEX Editor User s Guide The synonym parameter sets up a synonym for a command When used at the start of an interactive command the synonym is replaced by the Value of the synonym before the command is processed by Ixi The mult command can be used to set a single synonym for a string of commands If Length is used the name can be abbreviated to the given length and still be recognized A synonym name can be no more than 25 characters There is no restriction on its value When a command is processed for synonyms by 1xi the first character determines the kind of synonym There are two types e Alphanumeric synonyms consist of alphabetics and digits Characters up to the first nonalphanumeric character are compared with the synonym table e Special synonyms consist of characters that are neither alphabetic nor digits Characters up to the first alphanumeric character are used Users should note that an Editor command issued from a REXX macro will not have synonym resolution applied unless the command is prefixed with lxc or lxi Examples 1 To issue the command block mark if any of blockmark blockmar blockma or blockm are used type set synonym blockmark 6 block mark 2 To issue the command find up
262. r Parameters clear Delete all sets of changes Description The check command records a checkpoint A checkpoint is a set of changes which can be reversed by the undo command The first time check is called it starts the recording of changes The check command can be called explicitly at any time or automatically if the autocheck parameter is set to on Example To delete all checkpoint records type check clear API Return Codes 1 The parameter issued with the command was not valid Related Reading clip Command Provides clipboard functions for the Editor window Scope View Syntax 70 LPEX Editor User s Guide copy cut clear paste query Parameters copy Copies the current marked block into the clipboard leaving the original in the file cut Moves the current marked block into the clipboard removing it from in the file empty Clears the clipboard paste Copies the current clipboard contents into the file at the cursor position provided the clipboard contents are available in standard text format query Display a message indicating whether the clipboard is empty or contains text Description The clip command provides standard clipboard functions copy cut and paste for all block types Examples 1 To copy the marked block type clip copy 2 To paste the clipboard contents into a file type clip paste API Return Codes 8 Out of memory 5 Attempting to cut or paste in read only file
263. r invocation of the macro but the macro will not run faster If a path is specified the selected path is used to find the file 104 LPEX Editor User s Guide otherwise the LPATH is used If the macro was previously preloaded the preloaded macro is replaced by the macro in the file The profile lx macro should be preloaded Example To load the test macro type macroload test API Return Codes 1 Not enough storage to load the macro 1 The Editor cannot find the macro file 4 The file is not an Editor macro file or is larger than 64KB where KB equals 1024 bytes Related Reading mark Command Sets up or finds a position mark Scope File Syntax find EndLine EndCol include Name o l exclude Name Lwa E setfont r Name Parameters Name A name identifying a named mark The name is truncated if longer than 32 characters The setting and comparison of this name is not case sensitive Chapter 8 References 105 Id set find clear StartLine StartColumn EndLine EndColumn include exclude setfont Description An id number identifying an unnamed mark Assign the mark Name or Id to the specified position If no position is specified the current position is used If Name is already in use it is reassigned to the current position Specify Id only if that id already exists and you want to move a mark associated with a specific id number Otherwise issue the following command t
264. rameter is default tool bar button text and graphics display is controlled by the value of the default parameter Examples 1 To display both text and graphics in the tool bar buttons type set toolview both 2 To control tool bar display with the value defined by the default parameter type set toolview default 3 To display the value of the toolview parameter type query toolview If this query returns DEFAULT type the following query default toolview API Return Codes 2 Invalid option specified for the parameter Related Reading trigpos Parameter Specifies the current position after the live parsing of pending lines has been processed Scope View Syntax 344 LPEX Editor User s Guide query trigpos set trigpos Number Option Number The new current position Description The trigpos parameter sets the current position to be the specified character position in the current line after trigger processing is complete If trigpos is not set the current position is saved before trigger processing and restored afterward The query trigpos command returns a number that indicates the saved current position e If the position is unknown a zero is returned e If the position is in the current line a positive number is returned e If the position is known but is not on the current line a negative number is returned Example To set the next current position to the seventh character of the line after
265. rameter to off and then use either the file or save command to save the file 276 LPEX Editor User s Guide Related Reading noblanks Parameter Controls the formatting of trailing blanks Scope File Syntax query noblanks set noblanks on off inverse Options on Remove trailing blanks off Do not remove trailing blanks inverse Toggle between on and off Description The noblanks parameter when set on removes trailing blanks when an unformatted file is saved using the save command Example To remove all trailing blanks type set noblanks on API Return Codes 2 The option specified is not valid nosave Parameter Prevents the file from being saved Scope File Syntax query nosave set nosave on off inverse Chapter 8 References 277 Options on Prevent file from being saved or autosaved off Do not suppress save or autosave File can be saved if it is not in the read only mode This is the default value inverse Toggle between on and off Description The nosave parameter prevents a file from being autosaved or saved by the save command Setting the nosave parameter does not prevent other Editor instances from changing the file Example To prevent a file from being saved type set nosave on API Return Code 2 The option specified is not valid Related Reading oldline Parameter Sets or queries the old line value for the current line Scope Line Syntax set oldline
266. rator notation used on your operating system Terminology Conventions Certain conventions are used in this guide when referring to or describing various aspects of using the Program Builder Highlighting Conventions Italic font e User supplied variables Book titles Monospace font Examples e Text that is displayed on the screen e Text that you type Boldface font Command names e Menu items e File and directory names e Option flags e Language keywords operators function calls and statements Libraries and resources Mouse Button Terminology When this manual refers to the three buttons on either a right handed or left handed mouse e The term mouse button 1 refers to the inside button e The term mouse button 2 refers to the middle button e The term mouse button 3 refers to the outside button Copyright IBM Corp 1995 1998 ix If you are using a two button mouse click both buttons simultaneously to perform a mouse button 2 action Menu Sequence Convention Menu sequences are shown with arrows for example File gt Open This means on the File pull down menu select Open Related Publications x Optimization and Tuning Guide for Fortran C and C SC09 1705 Describes how Fortran C and C programs can be optimized for the POWER POWER2 and PowerPC architectures This book explains how to improve performance both by hand tuning your programs and by taking advantage of compiler optim
267. rawn with the top line as Chapter 8 References 227 the top of the new file view If any typeface has been defined the Editor sets the corresponding face for the new size If the value of the fontsize parameter is default font and font size are controlled by the value of the default parameter Examples 1 To change the size of the characters in the Editor view to 8 point size type set fontsize 8 2 To change the size of the characters in the Editor view to 10 point size and the font to System VIO type set fontsize 10 System VIO 3 To change the size of the characters in the Editor view to that specified by the default parameter type set fontsize default 4 To query the size and font of the characters in the Editor view type query fontsize If this query returns DEFAULT type the following query default fontsize API Return Code 2 The value specifed for fontsize is not valid Related Reading format Parameter Specifies the format controls for the current element Scope Element Syntax query format set format absolute Level before Number after Number break nobreak final nofinal flow noflow postspace nopostspace prespace noprespace solid nosolid spill nospi11 228 LPEX Editor User s Guide Options absolute Level after Number before Number break final flow postspace prespace solid spill Description Set the Level of the current and subsequent elements
268. rd 1 Use the cursor keys to move the cursor to the character that will start the block Press Alt B Move the cursor to the end of the block of text Press Alt B again Text between the two points is marked LPEX Editor User s Guide Marking an Entire Line of Text e Select Edit from the main menu bar select Block from the resulting pull down menu then select Mark Line from the cascaded menu or e Place the cursor anywhere on the line and press AIt L or e With the Ctrl key depressed double click on the line Marking Multiple Lines 1 Place the cursor on the first line to be marked and press Alt L 2 Move the cursor to the last line to be marked and press Alt L again The two selected lines and all lines between them are marked Related Reading Unmarking a Block of Text To unmark a block of text use any of the following methods e Select Edit from the main menu bar select Block Unmark from the resulting pull down menu then select Unmark from the cascaded menu or e Click the right mouse button and select Deselect all from the resulting pop up menu or e Press Alt U Related Reading Manipulating Blocks of Text After you have marked a block of text you can manipulate it in any of the ways described below Copying a Marked Block 1 Move the cursor to the location in the file where the blocked text will be copied 2 Select Edit from the main menu bar 3 Select Block from the resulting p
269. re specified Related Reading prev Command Moves current position to previous object line level class or word Scope View Syntax element above below class GlassName level Level same word Parameters visible Restrict moves to objects that are currently visible See the include and exclude parameters on making lines visible in the current view If visible is not specified and the Editor sets the current position on an object that is not visible the current position is subsequently adjusted to a visible line unless the showcurrent parameter is set to on If used this must be the first parameter specified element Moves to the previous structural line This is the default value above Moves to the previous line at a higher level If none is found the current position remains unchanged 114 LPEX Editor User s Guide below Moves to the previous line at a level below that of the current line If none is found the current position moves to the previous structural line at a higher level class ClassName Moves to the previous line of the specified ClassName level Level Moves to the previous line at the specified level same Moves to the previous line at the same level or above or if none is found to the previous line at a lower level word Moves to the start of the previous word Description The prev command moves the current position to the previous element level class or word dependin
270. required between autosaves The inital value is 5 with the range between 1 and 1439 If no value is specified it defaults to 0 Description The autotime parameter sets the minutes between autosaves The file is saved when autotime minutes have passed if at least one change has been made since the last save or autosave and no key has been pressed for idletime seconds The file is saved using its autoname Note An autosave is made before the time limit has been reached if the idletime condition is met and the number of changes since the last save or autosave reaches the value set for autocount Example To set the time before the next autosave to 5 minutes type set autotime 5 API Return Code 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number Related Reading 172 LPEX Editor User s Guide background Parameter Sets background character Scope View Syntax query background set background Char Option Char Can be a blank or any other single keyboard character where Char can be specified in any of the following forms nnn A decimal based ASCII character code where n is a digit of value 0 to 9 inclusive For example character code 065 A xnn or xnnn A hexadecimal based ASCII character code where nis a digit of value 0 to 9 inclusive or an alphabetic character of value A to F or a to f inclusive For example character code x41 A any
271. ring Description Unless specifically overridden by a command parameter the ring parameter determines whether a new view is placed in its own ring or becomes a member of an existing ring The value of the ring parameter is saved between Editor sessions Example To set the default ring assignment mode so that new views default into a new ring type set ring off API Return Codes 2 An invalid option was specified Related Reading ringlist Parameter Queries ring numbers active in the Editor Scope Global Syntax Chapter 8 References 315 query ringlist Options None Description The ringlist parameter is a query only parameter It returns a list of all ring numbers that are active in the Editor Example To see a list of active ring numbers type query ringlist API Return Codes None Related Reading ringnum Parameter Sets the ring to which the current document is moved Scope Global Syntax query ringnum set ringnum Number Options Number The number of the ring to which the current document is moved Description To move the current document to another ring set the ring parameter to the Number of the new ring Examples 316 LPEX Editor User s Guide 1 To move the current document to ring 2 type set ringnum 2 2 To discover the ring number for which the current document is a member type query ringnum API Return Codes 2 An invalid ring number was specified Relat
272. rminology Conventions Related Publications Chapter 1 Introducing the LPEX Editor Chapter 2 Using LPEX Starting the Editor Getting Help Working with Text Entering and Editing Text Undoing Changes Marking and Manipulating Blocks of Text Marking Blocks of Text NE Unmarking a Block of Text Manipulating Blocks of Text Changing the Default Marking Mode Using Location Marks in a File Finding Text or Locations in a File Finding a Specific Line in a File Finding a Location Mark in a File Finding Text Finding and Replacing Text F Managing Files in the Editor Creating a New File Opening an Existing File Saving a File Embedding Another File ito the Curen Document Working with Multiple Documents Chapter 3 Editor Commands and Parameters os Issuing Editor Cormiands F Issuing Multiple Editor Commands Chapter 4 Using Parsers Chapter 5 Customizing Editor Appearance and Function Changing Editor Tab Settings Copyright IBM Corp 1995 1998 vii vii ix _ ONNAADIWWW WwW W 21 21 22 23 25 25 Changing the Base Editor Font Changing Token Display Attributes Customizing the Keyboard Changing Text and Background Color Palettes Using Profiles to Modify Editor Behavior Changing Editor Load Profiles Using Alternate Editor Personalities Chapter 6 Macros and Profiles Writing Macros for the Editor Specifying Conditions in Editor Macros Specifyi
273. roducts All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental IBM may change this publication the product described herein or both Trademarks and Service Marks The following terms are trademarks of the International Business Machines Corporation in the United States and or other countries Copyright IBM Corp 1995 1998 vii AIX AlXwindows C Set IBM OS 2 POWER POWER2 PowerPC RS 6000 Windows is a trademark or registered trademark of Microsoft Corporation in the U S and or other countries UNIX is a registered trademark in the U S and other countries licensed exclusively through X Open Company Limited Other company product and service names which may be denoted by a double asterisk may be trademarks or service marks of others viii LPEX Editor User s Guide About the LPEX User s Guide This guide presents an overview of the LPEX Editor LPEX improves your programming work flow by providing a user programmable parsing editor which you can use to create and modify source code used by your programs The LPEX Editor accompanies several IBM programming products on a variety of hardware and software platforms Examples throuhout the guide may use either the DOS or AIX style of directory path separator notation Unless noted otherwise you can change the separator notation used in an example to the sepa
274. rst five commands in a macro type as the sixth command 134 LPEX Editor User s Guide sshow API Return Code 9 Parameter passed where none required Related Reading start Command Invokes an operating system command to run in a separate process Scope File Syntax Pr start Com man AA p NN S rr Options Command Any command that can be invoked from an operating system command line Description The start command executes the supplied command as a foreground application in a separate session To execute the supplied command in the same session use the REXX address command from an Editor macro The following substitution variables are supported FILENAME Fully qualified file name PROFILE Profile name MARKEDTEXT Selected text on the first line of a text selection Example To invoke a new program start visualage for java filename 1 profile API Return Codes 1 System error is encountered during the invocation of the specified command Chapter 8 References 135 2 The MARKEDTEXT parameter is specified but there is no text selected in the current file Related Reading submit Command Invokes an Editor macro to run on a secondary thread thereby allowing the user to continue interacting with the Editor Scope File Syntax be submit EditorMa cro ovd read stop synch Description write none Options read The Editor macro will read the Editor s content
275. ry filter historysize API Return Codes 1 No parameter sub item was specified Enter one of historysize case or match as a parameter sub item 2 An invalid setting was assigned to a parameter sub item Enter one of historysize case or match as a parameter sub item followed by a valid value for the sub item find Parameter Specifies default options for both the find command and the Editor Find and Replace dialog box Scope View Syntax query find cancel case columnnums columns findstring forward history historysize mark match prompt replacestring scope wrap query findoptions set find cancel case columns forward history mark match prompt wrap on off set find columnnums Number1 Number2 set find findstring String set find historysize Number set find replacestring String set find scope all current selection 216 LPEX Editor User s Guide Options cancel case columnnums columns findoptions findstring forward history historysize mark match prompt replacestring scope wrap Description Set to on to cancel the Find and Replace dialog box after a successful find operation Set to on to make find operations character case sensitive Specify left and right column positions using integer values between 1 and 2499 inclusive If the columns parameter is set on find operations search only text between and including these columns Set to on to restrict find op
276. s LP_CLIPPASTE Paste LP_ISSUECMD Issue edit command LP_FINDCHANGE _ Find LP_COMPARE Compare LP_FINDNEXT Find next LP_RECORD Keystroke recorder LP_FINDPREV Find up LP_RECSTART Start Restart 270 LPEX Editor User s Guide Menu ID LP_FINDSEL LP_SELALL LP_DESELALL LP_BLOCK LP_MARKLINE LP_MARKCHAR LP_MARKRECT LP_LUNMARK LP_COPY LP_OVERLAY LP_MOVE LP_DELETE LP_UPPER LP_LOWER LP_LOCATE LP_NEXTERROR LP_LINE LP_START LP_END LP_JUMP LP_QUICKMARK LP_FINDMARK LP_SETQUICK LP_NAMEMARK LP_VIEW LP_FILTER LP_FILTERDATE LP_SHOWALL LP_FORMATLINE LP_MSGLINE LP_STATUSLINE LP_TOOLBAR Description or Name Find selection Select all Deselect all Block Mark line Mark character Mark rectangle Unmark Copy Overlay Move Delete Uppercase Lowercase Locate Next error Line Start of block End of block Previous location Quick mark Mark Set quick mark Name a mark View Filter Filter date Show all Format line Message line Status line Tool bar Menu ID LP_RECHALT LP_RECPLAY LP_RECCONT LP_RECRENAME LP_RECDELETE LP_OPTIONS LP_PARAMETERS LP_FONTS LP_COLORS LP_TOKENS LP_GLOBALS LP_PROFS LP_CHANGEPROFS LP_ACTIVEPROFS LP_KEYS LP_LPEXKEYS LP_EPMKEYS LP_SEUKEYS LP_XEDITKEYS LP_ISPFKEYS LP_CUSTOMIZE LP_SAVEKEYS LP_WINDOWS LP_MACROLOG LP_DOCLIST LP_NEXTINRING LP_PREVINRING LP_NEXTRING LP_PREVRING LP_HELP LP_HOWDOI LP_ABOUT
277. s OK Cancel and Help The text entry box can display an optional TextString as a suggested input value which a user can accept or replace as required The button used to leave the dialog can be retrieved using the lastkey parameter The text typed in the box including the initial text can be retrieved using the lastline parameter If Cancel is used to leave the dialog the lastline parameter contains the initial text Note Although a macro can request a line of input it cannot process the response This command may be more useful in an external program where processing can take place Example To obtain a filename from a user using a dialog type lineread 40 Enter the filename A dialog is displayed with a text entry box for user response that contains an initial value of Enter the filename API Return Code 1 Length must be a positive integer Related Reading load Command This command reads a specified file no lines wider than 2500 characters into an empty Editor as a simple list of elements Scope Global Syntax br load Filename O Ia Chapter 8 References 95 Parameter Filename The name of the file Drive and path may be specified Description Once the file has been read a number of customizing macros are called providing they are listed in the PROFILES setting All macros are passed the filename and extension e xxx lxl sets up the parser which in turn sets class structure and formatt
278. s 329 set statusline on 2 To control status line display with the value defined by the default parameter type set statusline default 3 To query the value of the statusline parameter type query statusline If this query returns DEFAULT type the following query default statusline API Return Codes 2 The option is not valid Related Reading submenuinit Parameter Specifies a command that is run when the specified menu bar item or sub item is selected Scope Document Syntax set submenuinit Menu_id drop Command query submenuinit Menu_id Options Menu_id The id of an existing menu bar item or sub item For predefined Editor window items this is the predefined Editor window name as described i g 9d For user defined items this id can be obtained by querying the actionbarid parameter Command A command that is run when the specified menu bar item or sub item is selected drop Remove the specified command from the callback list of the specified menu bar item or sub item Description You can use the submenuinit parameter to specify a callback routine or command to be run between the time you request a menu bar item or sub item and the time it appears The callback routine can use any of the Editor window commands including the set and query commands to work 330 LPEX Editor User s Guide with items of interest A typical callback routine might modify the contents of a sub menu depending on the st
279. s Ctrl Home to move the cursor to the beginning of the file or Ctrl End to move it to the end of the file or Press Ctrl J to return the cursor to the place in the file where you last entered text LPEX Editor User s Guide Tip If you inadvertently select text by dragging the mouse deselect it by pressing Alt U or click the right mouse button and choose Deselect all from the pop up menu Inserting a Blank Line e Move the cursor to any point on a line and press Ctrl Enter or e Move the cursor to the end of a line and press Enter A blank line is created after the current line and the cursor moves to the first column position of this new line Splitting and Joining Lines of Text e To split a line Place the cursor where you want the break to occur and press either Alt S or Enter Pressing Alt S leaves the cursor at its current position pressing Enter moves the cursor to the beginning of the new line When you split a line all the text to the right of the cursor is moved down to a new line e To join two lines do one of the following If the cursor is at the end of a line press the Delete key to join the current line with the next line If the cursor is at the beginning of a line press the Backspace key to join the current line with the previous line With the cursor anywhere on a line press Alt J to join the current line with the next line together Related Reading Undoing Changes The
280. s in a programming language document For example language keywords are highlighted in one color variable names in another and string literals in yet another The original indentation of the program code is maintained LPEX comes with parsers for C C COBOL Fortran and for its own macros Invoking a Parser When you open a file the editor automatically runs a load macro used to invoke a parser whose file name is composed of the extension of the file being loaded and an extension of lxl This load macro in turn invokes a parser For example if you open a file called sample c the editor calls the c lxl load macro which invokes the C parser If you open a file called sample f the editor calls the f lxl load macro which invokes the Fortran parser If you open a file called sample cbl the editor calls the cbl 1xl load macro which invokes the COBOL parser Typically the load macro and the parser e Set default fonts and colors e Color and emphasize the data being displayed e Set up special actions for keys e Set up language specific additions to the View pull down menu You can use the load macros supplied with the Editor as examples when developing your own load macros About Elements and Classes In a programming language document such as sample c or sample f in the samples directory each line is an element A class definition describes the type of data the element contains Each element may contain more than one class T
281. s less than the current level Examples To obtain the level of the current element type query level API Return Code 12 This command requires an open document First open a document then issue the command Related Reading limiterror Parameter Specifies how a text length limit exceeded error condition during an import operation is to be handled Scope File Syntax query limiterror set limiterror cancel truncate ignore Options cancel Cancels change to the offending edit line This is the initial option Chapter 8 References 255 truncate Truncates the text in the offending edit line to fit within the current text length limit Note that additional characters before the text length limit may have to be removed to avoid splitting a DBCS character and to balance SO SI characters on each edit line ignore Accepts all the text in the offending edit line Description The limiterror parameter specifies the action to be taken when the text length limit is exceeded during the update of an edit line in the current file The default action is to cancel the update If specific recover action is required for certain editing operations this parameter must first be set accordingly before the operation and reset after its completion Example To ignore the text length limit violations during an import operation type set limiterror ignore API Return Code 2 The option specified with the parameter was not vali
282. s on each line and apply the sort operation to specific sets of lines Examples 1 To sort from the current line up to but not including line 25 of the file type sort 25 2 To sort 25 lines in descending string order starting from the current line type sort 25 D 3 To sort a block of selected text in ascending case insensitive string order based on the contents of columns 10 to 15 of each line in that block type sort BLOCK AI 10 15 4 To sort from the current line up to and including the last line in the file in ascending numeric order based on sequence numbers in columns 73 to 80 type 132 LPEX Editor User s Guide sort AN 73 80 5 To sort from the current line up to but not including the line with a named mark called Limit in ascending order based first on the contents of columns 10 to 15 and then the contents of columns 5 to 6 type sort Mlimit A 10 15 5 6 6 To sort from the current line up to but not including the line containing the next instance of the string arbitrary in ascending order type sort arbitrary A API Return Codes 1 String or mark not found 2 Invalid parameter argument supplied 6 Bad block defined 8 Out of memory Related Reading splitjoin Command Splits a line or joins two lines Scope File Syntax br splitjoin Lepr join Parameters split Splits the current line into two lines join Joins two lines together Description The splitjoin comman
283. s progressively changed to state B then C then D then E A checkpoint is taken between each state 1 To revert to state B one state at a time type the following command three times undo The first undo changes the file to state D the second undo to state C and the third undo to state B If there are no more changes to undo the following message is displayed No recorded changes available for UNDO 2 To revert 3 states directly from for example state E type undo 3 State B becomes the current state 3 Now if you type undo 2 The last two undos are undone and the document returns to state D API Return Codes 1 Parameter specified is not a number 5 You cannot make changes to the file because the readonly parameter is set to on Related Reading Chapter 8 References 141 unlink Command Unlinks a previously linked external command Scope Global Syntax mr unlink Command NN Yio Parameter Command The command to be unlinked Description The unlink command unlinks a previously linked external command External commands are loaded the first time they are invoked Once invoked an external command remains linked until it is removed with an unlink command or the Editor is terminated If the external command contains an lxexit subroutine call this will be invoked to allow the command to terminate any other processes and release the Editor storage If you make changes to an external command that has
284. s reduced to include lines between the original start and current position Marks the current subgroup of lines The block is set up as for mark element except that if the first mark is on a structure line that mark sets a block that extends from the beginning of that line to the end of the next structure line at the same or lower level Sets the beginning or end of a rectangular block On the first call the current character is marked On a second call the block is extended to all characters in the rectangle between the current position and the previous one On further calls the block is extended or reduced The presence of Tab characters will distort a rectangular block Using this style of block with text containing tabs may produce unexpected results Performs the same operations as their respective mark functions with this exception if the cursor is on the first or last character in the block on the third or subsequent calls the whole block is cleared unmarked Marks the current word If a block is already set it is cleared first then the whole word under the cursor is selected If the cursor is not located at an alphanumeric character a forward scan is done If a word is not found before the end of the current element a backward scan is carried out If a word is still not found by the time start of the current element is reached an error code is returned For all block operations a word block is treated the same as eit
285. s shorter than the text part of prefix data then it will be truncated e If it is longer than the text part of the prefix data it will be padded with blanks e No attempt to maintain the integrity of DBCS data will be made during padding or truncation Description The prefixdefaulttext parameter sets the text that is to be used to set the text part of the prefix data for lines that are inserted or changed while the prefix data is being automatically maintained Example If the text portion of the prefix data is the date of the last change made to the line and the current date is Jan 1 1993 the following command could be used set prefixdefaulttext 930101 API Return Codes 8 Insufficient storage to continue Related Reading prefixdisplayformat Parameter Specifies a format string that is used to display the prefix area Scope View Syntax query prefixdisplayformat set prefixdisplayformat Format Chapter 8 References 297 Options Format This string describes how the prefix data will be displayed subject to the following rules e The length of the string is equal to the number of characters that you wish to have displayed e X characters found in the format string will be replaced by the text part of the prefix area e 9 characters found in the format string will be replaced by the numeric part of the prefix area e All other characters in the format string will be displayed without substituti
286. se Related Reading Primitive Functions Summary The primitive functions shown below are used by the primitive command to simulate key press actions in macros and profiles Chapter 8 References 355 Primitive Name beginelement beginline char x cursordown cursorleft cursorright cursorup deletechar deleteword endelement endline insertchar x jump newline nexttab null previoustab replacechar x rubout selectdown selectdrag selectend selectfileend selectfilehome selecthome selectleft selectpagedown selectpageleft selectpageright selectpageup selectright selectup 356 LPEX Editor User s Guide Action Move the cursor to the beginning of the current element Move the cursor to the beginning of the current line Put the character x at the cursor position Move the cursor down one line Move the cursor left one column Move the cursor right one column Move the cursor up one line Delete the character at the cursor position Delete the word at the cursor position Move the cursor to the end of the current element Move the cursor to the end of the current line Insert character x at the cursor position Move the cursor to the position of last change Move the cursor to the start of the next line Move the cursor to the next tab position Take no action Move the cursor to the preceding tab position Replace the character at the cursor position with character x Move
287. se default 342 LPEX Editor User s Guide Options on Display the tool bar off Do not display the tool bar inverse Toggles between on and off default Display the tool bar according to the value of the default parameter Description The value of the toolshow parameter determines if the tool bar is displayed If the value of the toolshow parameter is default tool bar display is controlled by the value of the default parameter Examples 1 To display the tool bar type set toolshow on 2 To control tool bar display with the value defined by the default parameter type set toolshow default 3 To display the value of the toolshow parameter type query toolshow If this query returns DEFAULT type the following query default toolshow API Return Codes 2 Invalid option specified for the parameter Related Reading toolview Parameter Sets the display mode of the tool bar Scope View Syntax query toolview set toolview both graphic text default Chapter 8 References 343 Options both Display tool bar items as buttons containing both text and graphics bitmap Display tool bar items as buttons containing only graphics text Display tool bar items as buttons containing only text default Display tool bar items according to the value of the default parameter Description The toolview parameter determines how tool bar buttons are displayed in the Editor window If the value of the toolview pa
288. set up the global variables for example proto c Example To insert an if statement 1 Open a file containing a C or C program 2 Type the keyword if 3 Press Ctrl R The keyword is replaced by if Of and the cursor is positioned between the parenthesis For further details on proto and how it works read the source code that is provided as Ixproto c in the extras directory Related Reading 54 LPEX Editor User s Guide Chapter 8 References Commands Summary The Editor window is fully programmable through the use of an extensive Editor command set You can use commands to customize the Editor window search for or change text in your document or perform many other functions Select a command from the list below to display complete reference information for that command Command Name Copyright IBM Corp 1995 1998 Description Re runs the most recently run Editor command Adds one or more blank lines Produces a tone on the speaker Shows all lines or those selected by a command Moves the cursor to the beginning of the current line Manipulates a block of text Moves the current position to the bottom of the file Substitutes one string for another Takes a checkpoint Provides clipboard functions for the Editor Examines two documents for differences in their content Deletes one or more lines Expands tabs to blanks Invokes an Editor dialog Duplicates the current lin
289. settings Example To expand tabs to blanks detab API Return Codes None Related Reading dialog Command Invokes an Editor dialog Scope Global Syntax be dialog T Nane p Parameters Name The name of the dialog window to invoke List all dialog windows available in the Editor 1 Issue the command dialog 2 View the Macro log file to see the output of the dialog command The Editor window will show the basic dialog windows listed below Also shown for each dialog window is the standard pulldown menu path used to open that dialog through the Editor window user interface Description Chapter 8 References 75 The dialog command opens the specified Editor dialog window Window Name new open getfile saveas print findchange element date findmark markname filter filterdate commandline compare action options fonts colors tokens globals changeprof customize rings logo Example Pull Down Menu Path to Window File gt New File gt Open File gt Get File gt Save as File gt Print Edit gt Find and replace Edit gt Locate gt Line no menu equivalent Edit gt Locate gt Mark Edit gt Name a mark View gt Filter no menu equivalent Actions gt Issue edit command Actions gt Compare no menu equivalent Options gt Editor parameters Options gt Font Options gt Color palette Options gt Token a
290. shed that the unknown command is not one of its own commands a set or query parameter or an external Editor command Example To process unknown commands as macros type set impmacro on API Return Code 2 The option you specified was not on off or inverse Related Reading impset Parameter Processes unknown text strings as set or query commands Scope View Syntax query impset Chapter 8 References 243 set impset on off inverse Options on Process unknown text strings as set or query commands This is the default value off Do not process unknown text strings as set or query commands inverse Toggle between on and off Description The impset parameter makes the Editor process unknown text strings as set or query commands Single words are tried as a query command multiple words are tried as a set command If impset is set to off you must use the full set command set impset on to turn it on Example To process unknown commands as set or query commands type set impset on With impset on beep would be processed as query beep and beep on would be processed as set beep on API Return Code 2 The option you specified was not on off or inverse Related Reading include Parameter Specifies the list of classes for which member lines are to be displayed in a file view Scope View Syntax query include set include ClassName ClassName 244 LPEX Editor User s Guide
291. sing functions are available to highlight the tokens appropriate to a given programming language To change profiles in the Editor proceed as follows 1 Select Options from the menubar in the Editor window 2 Select Profiles to display selections Chapter 5 Customizing Editor Appearance and Function 31 3 Select Change Profile The Change Profile dialog box appears 4 Select any combination of System Apply the system load profile profsys Ixu to the file User Apply the user preferences load profile profile lx to the file Language profile Apply a language profile to the file If this check box is selected a list of available language profiles is enabled Scroll through the list and select one of the listed profiles 5 When you are satisfied with your selections click OK To cancel all changes click Cancel Related Reading Using Alternate Editor Personalities You can configure the editor to adopt the keyboard and command personalities of many popular editors Most editor personalities differ only in the keys and commands used to perform various editor tasks Some editor personalities supported by the editor listed below also add a prefix information and command area at the start of each line Editor Profile Name Personality ISPF ispfprf 1x SEU seuprf 1x XEDIT xediprf 1x The Editor recognizes prefix commands used by these editor personalities Depending on which profile you are using you can enter
292. specified has the highest priority Note The formatter parameter must be set to on to display the formatting controls Important This parameter is intended for use by programmers writing structured parsers Formatting controls are not checked until they are used Inconsistencies may lead to unexpected results Examples The following examples refer to these elements Chapter 8 References 229 start line 1 end line 1 start line 2 end line 2 start line 3 end line 3 start line 4 end line 4 start line 5 end line 5 1 To ensure that line 3 always starts on a new line place the cursor on line 3 and type set format break 2 Suppose you have already used the format parameter to ensure line 3 always starts on a new line To ensure that line 3 always starts on a new line and that it can be spilled type set format break spill Simply typing format spill would have deleted the previous break option so break had to be repeated in the latest command 3 To reverse a previously issued set format break setting for line 3 place the cursor on line 3 and type set format nobreak 4 To indicate that line 3 can be spilled if it were extended type set format spill 5 To set the level of lines 3 4 and 5 to level 4 place the cursor on line 3 and type set format absolute 4 Lines 3 4 and 5 are indented by the number of spaces appropriate for level 4 elements if indent is set to a value other than zer
293. sses to exclude from the display Chapter 8 References 145 Parameter Name 146 LPEX Editor User s Guide Description Expands tab characters to spaces for display purposes Sets the default settings used by the Open Get and Save As dialogs Sets the fill character Sets options for the filter operation Specifies default options for both the find command and the Editor find and replace window Sets the number of search occurrences to remember Controls the automatic flowing of elements Query only Sets the focus lines for the Editor Sets the attributes for a given font Lists the symbolic fonts that are currently set Query only Sets the character font for the current line Sets the character size for the current line Specifies format controls for the current element Enables line wrapping Sets the formatting width of the current document Defines the parser to be used for a full parse Sets the value of a variable global to all documents in the Editor Lists names of variables global to all documents in the Editor Query only Specifies the conditions by which a menu item will be enabled or disabled Query only Specifies the help information associated with a user defined menu item Query only Returns the hexadecimal ASCII code of the character at the current cursor position Query only Sets the classes to be highlighted Sets the increment for the horizontal scroll Enable or disab
294. ssuming it exists type Chapter 8 References 89 goring ringnum 6 API Return Codes 1 Invalid command parameter given Issue the command again using a valid parameter 2 Invalid ring number given Issue the command again using a ring number value in the valid range The ring number specified does not exist You are already in the ring specified The file view is already the only member of the ring You specified a next split or prev split parameter but no other split file view exists to move to oF WR goview Command Displays or creates the specified view of a named file in an Editor window Scope Global Syntax newring name ViewName Lai nonewring find viewnum ViewNumber inring next inring next Parameters newring The file view if created is opened in a new ring in an Editor window If newring split is specified the file view is split in an Editor window to accommodate the new ring Otherwise the new ring is opened in a new Editor window nonewring The file view if created becomes a member of the current ring name Searches all open file views for a named view If it is not found it will be created 90 LPEX Editor User s Guide find ViewName viewnumViewNumber inring next inring next Description Searches all open file views for a named view If it is not found it will not be created The file view name that is returned by the query viewname command Searches all o
295. stop when it reaches the beginning or end of the file depending on your chosen search direction This option has no effect if the forward option is set to off The find parameter sets options used by the find command Options are saved between editing sessions Chapter 8 References 217 When the find command is run with a specified search string that search string becomes the new value of the find findstring parameter Examples 1 To set the search string to lost type set find findstring lost 2 To restrict find operations to between columns 10 and 25 type set find columnnums 10 25 set find columns on The first line only defines the column boundaries The second line instructs the Editor to restrict find operations to bounds set by the find columnnums parameter 3 To redefine the maximum number of find operations stored in the history log to six entries type set find historysize 6 API Return Code 2 Invalid option specified Related Reading findhistory Parameter Sets the number of find occurrences to track Scope File Syntax query findhistory set findhistory Number Option Number The number of find occurrences to remember to a maximum of 24 Description The findhistory parameter limits the number of find occurrences to remember By default a history of up to 10 occurrences is retained If findhistory is zero no record of found occurrences is retained When the value of findhistory is changed
296. t Matches zero or more occurrences of the pattern specified by expr For example in the phrase at the cabana abc matches any single character in your file as well as all complete sequences of letters including only the letters a b or c as in the character sequence caba Subsequent find operations start from the character immediately following the first character of the found string For example in the phrase above after a find operation finds caba subsequent find operations would find aba ba and a Matches exactly n occurrence s of the pattern specified by expr For example in the phrase at the cabana cab 2 matches only the sequences ca ab and ba in the word cabana cab 3 would match the sequences cab and aba in the word cabana Matches at least n occurrences of the pattern specified by expr For example in the phrase at the cabana cab 3 matches only the sequences caba and aba in the word cabana but not ca ab or ba Chapter 8 References 371 expr n1n2 expr expr expr expr expr expr1 expr2 Matches between n1 and n2 occurrence s of the pattern specified by expr and occurrences between n1 and n2 For example in the phrase at the cabana cab 2 3 matches only the sequences cab aba and ba in the word cabana but not c a b or caba Matches the pattern specified by expr only if it occurs at the very start of a line Matches the pattern specified by expr o
297. t classes ClassName ClassName Option ClassName Up to 30 words each naming a class Each word in the list of classes is used to name the next class in sequence always counting from left to right Description 186 LPEX Editor User s Guide The classes parameter sets the number and names of classes for the current file At least one class must always be present The default class is DATA The set classes command can be used repeatedly to rename the current classes but once a given number of classes has been set the number of classes cannot be reduced Examples 1 To set up three new classes type set classes TEXT GRAPHICS WASTE If this is the first set classes parameter it has the effect of increasing the number of classes available from one to three and renaming the first DATA to TEXT 2 To discover the number and names of classes for a file type query classes API Return Codes 2 At least one ClassName option must be present Issue the command again specifying a valid ClassName 3 Too many classes are specified Specify less than 30 ClassNames Related Reading color Parameter Sets and queries RGB color values for the Editor Scope Global Syntax set color n R nn G nn B nn query color n Options n An Editor color number from 1 to 16 nn A color intensity value Permitted values are 0 to 255 inclusive where 0 is lowest intensity of color and 255 is highest intensity of color Descript
298. t of up to sixteen colors for text and background display A default color palette is supplied with the Editor but you can modify this color palette or define and save other color palettes as you require Changes to the color palette apply to all open Editor windows To use or define a different color palette in the Editor you must first open the Color Palette dialog 1 Select Options from the Editor window main menu bar 2 Select Color Palette from the resulting pull down menu The Color Palette dialog appears with the name of the current color palette displayed in the Palettes field In the Color Palette dialog do the following e To change to another previously defined color palette 28 LPEX Editor User s Guide 1 Click on the down arrow button at the right side of the Palettes field to see a list of defined palettes 2 Select the name of the color palette you want from this list e To create a new color palette 1 Select the color button that represents the color to be changed 2 Change the values in the Red Green and Blue color component fields until the color button selected in step a shows the color you want Permissible values are integers from 0 to 255 inclusive where 0 indicates lowest intensity of color and 255 indicates highest intensity of color 3 Repeat steps 1 and 2 for each color that you want to change 4 When you finish defining colors for the new palette click on the Add button The Add a Pa
299. t position to a visible line unless the showcurrent parameter is on This must be the first parameter specified if used Move to the next structural line This is the default value Move to the next line at a higher level If none is found the current position remains unchanged Move to the next line at level below current If none is found the current position moves to the next structural line at a higher level Move to the next line of the specified Class Move to the next line at the specified Level Level must be numeric and positive Move to the next line at the same level or above or if none is found to the next line at a lower level Move to the start of the next word The next command moves the current position to the next level element or word depending upon the parameters used LPEX Editor User s Guide The same above and below parameters operate within the local display group They move to the next line at the relevant level that has structural information that is formatting flags before after or absolute Any line at level zero is also considered structural The class level and word parameters operate regardless of display groups Examples 1 To move the current position to the next visible class COMMENT type next visible class comment 2 To move the current position to the next visible line at a higher level type next visible above 3 To move the current position to the next line visible or non
300. t the preloaded REXX macros type query loadedmacros API Return Codes None mark Parameter Returns position of specified mark within a line Scope File Syntax query mark Name Id Chapter 8 References 261 Option Name The name of a mark This name is truncated if longer than 32 characters The search for this name is case insensitive Id The id number of an unnamed mark Description The mark parameter gives the position of a specified mark within a line The number returned is positive if the mark is in the current line negative if it is set but is not on the current line or zero if the mark is not in the file Example To get the position of a mark called undoref type query mark undoref API Return Codes None Related Reading markdeleteexit Parameter Defines the mark removal exit routine to be used with the current file Scope File Syntax query markdeleteexit set markdeleteexit Command Parameters Options Command A native Editor command to be invoked when all the text associated with a mark has been removed Parameters The parameters required by the command Description 262 LPEX Editor User s Guide The markdeleteexit parameter sets the command to be invoked when a mark is removed as text is deleted from the edit data When the command specified by set markdeleteexit is invoked the mark s name is concatenated to the command parameters Example To specify errlist as the mar
301. tatements of any kind can appear inside the loop including other loops For example do reps 5 to 10 statement 1 statement 2 num 0 do while num lt 3 statement a statement b num num 1 end statement 4 end You can force an early exit from any kind of DO loop by using the leave or return commands Chapter 6 Macros and Profiles 41 Related Reading Using REXX Functions in Editor Macros REXX functions can perform many useful operations in Editor macros A REXX function can appear in arithmetic or comparison expressions and the results returned by a function can also be assigned to a variable Only a few of the most useful REXX functions are briefly described here For a complete list of REXX functions refer to any REXX language and programming reference REXX Function Arguments and Description Name abs num Returns the absolute value of num center str num Returns a string of length num characters with the string str centered in the returned string If the length of str is greater than num characters are truncated off each end of str starting from the right end copies str num Returns num copies of the string str 42 LPEX Editor User s Guide date datatype delstr delword insert opts If no option is specified returns the current date in dd mon yyyy format Some values for opt are days Return the number of days so far this year in form ddd with no leading zeros
302. ter the last Editor window is closed The timeout parameter allows the user the option of having the Editor shut down automatically some period of time after the last window is closed The default is 5 minutes If set to 1 the Editor window will never timeout If set to 0 the Editor will shut down immediately after the last window is closed Example To have the Editor close automatically after the last window is closed type set timeout 0 API Return Code 2 Number is out of range Chapter 8 References 339 toolbar Parameter Sets the contents of the tool bar menu Scope File Syntax query toolbar Name set toolbar Name BITMAP resddl_id HELP HelpText OrdinalNumber Command Options Name Name for the item to be included on the new tool bar menu This name is also used as the text label on the new tool bar menu item To include a blank in the name use the underscore character _ BITMAP Specifies that the new tool bar item is a bitmap If used you must also specify resdll The resource dll containing the new item s bitmap id The id for the bitmap contained in the resdll resource dll HELP Optional hover help text specified by HelpText enclosed in quotes When you pause the mouse cursor over your tool bar item this text will appear in a bubble near the mouse cursor OrdinalNumber The position at which the tool bar item is inserted starting at zero If the number is greater than the first available position or
303. that it is not possible to remove that directory as long as the current instance of the Editor is active The directory parameter gives you the option of changing that directory Example To determine which directory is locked by the Editor type query directory API Return Code 2 Unsuccessful Most likely an invalid drive letter or directory name Related Reading dirty Parameter Gives the setting of the dirty flag Scope File Syntax query dirty Options None 198 LPEX Editor User s Guide Description The dirty flag is set on if there is an uncompleted change in the document A change to a document is complete when an undoable unit is closed either explicitly by use of the check command or automatically if the autocheck parameter has a value of on To find out if a file has unsaved changes you must query both the changes and dirty parameters Example To get the setting of the dirty flag type query dirty API Return Codes None Related Reading dispdepth Parameter Sets the depth of the Editor window Scope View Syntax query dispdepth set disdepth Number Option Number The Editor depth Description The dispdepth parameter queries the depth of the Editor window Examples 1 To query the depth of the Editor type query dispdepth Chapter 8 References 199 2 To set the depth of the Editor to 20 type set disdepth 20 API Return Codes 2 The number specified was either
304. the character and line vertically above or below the original position After scrolling the cursor usually remains on the same row in the window When scrolling horizontally the cursor maintains its position in the window and the data is scrolled sideways Examples 128 LPEX Editor User s Guide 1 To scroll down one line type scroll 2 To scroll down ten lines type scroll down 10 3 To scroll up eight lines type scroll up 8 API Return Code 1 A parameter issued with the command was not valid Check the command s syntax requirements and then issue the command again using a valid parameter set Command Specifies the value for an Editor parameter Syntax pe set parameter d pu Description Use the set ommand to set certain Editor parameters to different values These parameter settings can be used to modify various Editor operating characteristics such as action key assignments menu contents text formatting and more The value of many of these same Editor parameters values can also be queried using the query command Parameters Parameter Any parameter that can be set See the Parameters Summary for a list of parameters and their effect on Editor function Some parameters are query only and cannot be used with the set command API Return Codes 1 Invalid item 2 The parameter is not valid First check its spelling then check this list to see if the parameter is supposed to be set 3 To
305. the cursor and all characters to the right to the left one column deleting the character on the left Select deselect the next line Select deselect text to the mouse position Select deselect text to the end of the line Select deselect text to the end of the file Select deselect text to the start of the file Select deselect text to the start of the line Select deselect text one character position to the left Select deselect text down one page Select deselect text left one page Select deselect text right one page Select deselect text up one page Select deselect text one character position to the right Select deselect text up one line Primitive Name selectword selectworddown selectwordleft selectwordright selectwordup setcursor setpointer togglecommand toggleinsert toggleprefix topline truncate wordleft wordright Action Select deselect the word at the cursor position Select deselect text one line down and move to a word boundary Select deselect one word to the left Select deselect one word to the right Select deselect text one line up and move to a word boundary Move the cursor to the mouse pointer position Move the mouse pointer to the cursor position Display the Issue edit command dialog Toggle between insert and replace modes Toggle the cursor between the prefix area and the data area Set the current line to the top line in the display Delete text to the end of the line Mo
306. the mnemonic differentiates them You could continue to set up more menu bar items with the same base name as long as a different mnemonic was used for each item 3 To add an accelerator to the Sound subitem defined in the above example type set actionbar E xample Sound tAlt S alarm The accelerator for Sound is Alt S Chapter 8 References 157 4 You can use a bitmap in place of a text label for your menu item or subitem Bitmaps must be defined in a DLL file located in a directory path included in your PATH environment variable The following example uses the bitmap with resource id 2 found in the evfwrc21 dll file included with the Editor To add this bitmap to the pull down menu defined in Example 2 type set actionbar E xample BITMAP_evfwrc21_2 alarm You can also use a bitmap as a menu item on the menu bar 5 You can define subitems to subitems For example the following example adds a subitem called Add to the pull down menu defined in Example 2 Selecting the Add pull down menu item raises a cascaded menu with menu items that add one two or three lines to your document set actionbar E xample Add One_line add 1 set actionbar E xample Add Two_lines add 2 set actionbar E xample Add Three_lines add 3 6 To place a separator between the first two items created in the previous example use set actionbar E xample Add separator 1 7 To set the accelerator for the Save menu item to F2 type set accelerator lp_save F2
307. the same document can help you perform functions like cutting and pasting from one section to another Any changes you make to one file view are automatically updated in all other views of that document You can also carry out functions like cutting and pasting between views of different documents You can manage different file views with the following facilities e The Split window option lets you split the Editor window vertically or horizontally to view multiple file views at the same time Select View from the Editor window menu bar then Split from the resulting pull down menu e The Ring Manager lets you arrange files into groupings or rings You can easily move between the rings or between files within a given ring To open the Ring Manager window select Windows from the Editor window menu bar then Ring manager from the resulting pull down menu Related Reading Managing Multiple File Views with the Ring Manager This section describes how to use the Editor ring manager window to work with multiple files and views of files Typical ring manager operations are described below Setting the default ring To set the default ring option do the following 1 Select View from the Editor menu bar 2 Select Default to ring from the resulting pull down menu 16 LPEX Editor User s Guide e If this option is enabled a check mark appears beside its menu selection Newly opened files or views are added to the current ring an
308. tine to run when the pop up menu is requested along with any parameters required drop Remove the specified callback routine from the callback list Description You can use the popupinit parameter to specify a command or callback routine to be run between the time you request the pop up menu and the time it appears The callback routine can use any of the Editor commands including the set and query commands to work with items of interest A typical callback routine might modify the contents of the pop up menu depending on the state of the document being edited when the pop up menu is requested Chapter 8 References 287 The pop up menu can have multiple callback routines which are called in LIFO order If one of the callback routines returns a non zero value no further callbacks will be called A callback routine can be removed from the callback list by using the drop argument with the popupinit parameter If a callback routine is not explicitly dropped it remains active until the document is closed Examples 1 To display the message Pop up menu raised each time you request the pop up menu type set popupinit msg Pop up menu raised 2 To stop displaying the message Pop up menu raised each time you request the pop up menu type set popupinit drop msg Pop up menu raised 3 To see all callback routines in the callback list type query popupinit 4 The more complex example shown below looks for blank lines at the beginning of
309. tion The wrap on parameter ensures that elements wrap from one line to the next if the formatted line is longer than the formwidth The wrap parameter must be set to on to spill elements at either the formwidth or spill lengths If the spill parameter is set to on it wraps at the lower of the two lengths 354 LPEX Editor User s Guide The wrap parameter setting can also be changed by the Wrap setting choice found in the View pull down menu Selecting the Wrap setting sets both the formatter and wrap parameters to on and the formwidth parameter to 0 Deselecting this choice sets the formatter and wrap parameters to off The formwidth parameter is not changed and retains its value of 0 Conversely setting both the formatter and wrap parameters to on and the formwidth parameter to 0 will select the Wrap setting choice in the pull down menu for the View menu bar choice If the value of the wrap parameter is default display wrap is controlled by the value of the default parameter Examples 1 To set the wrap parameter on type set wrap on 2 To control display wrap with the value defined by the default parameter type set wrap default 3 To display the value of the wrap parameter type query wrap If this query returns DEFAULT type the following query default wrap API Return Codes 12 This command requires an open document First open a document then issue the command 2 The option you specified was not on off or inver
310. tion Scope Global Syntax query filter historysize case match set filter historysize case match Value Options historysize The number of filter strings or character pattern expressions saved for future recall in the Filter window Value Must be an integer value between 0 and 25 inclusive case Permitted values for Value are on String or character pattern matching takes character case into account off String or character pattern matching ignores character case inverse Toggle between values of on and off match Permitted values Value are on The string in the Include all lines with this string field is treated as regular expression character pattern matching string off The string in the Include all lines with this string field is treated as a literal string inverse Toggle between values of on and off Description Chapter 8 References 215 The filter parameter lets you set the default options Changes to filter options are saved between Editor sessions Examples 1 To make the filter operation character case sensitive type set filter case on 2 To treat the entry in the Include all lines with this string field as a regular expression pattern type set filter match on 3 To change the maximum number of entries in the saved string and character pattern list to 10 type set filter historysize 10 4 To query the maximum number of entries in the saved string and character pattern list type que
311. tor User s Guide The value of the overhang parameter determines the indentation of flowed lines in a paragraph of text A paragraph is any length of text ended by a hard carriage return A paragraph can be wrapped flowed over multiple lines The overhang parameter sets the indentation of the second and subsequent lines of a paragraph Multiply the values of the overhang and indent parameters together to calculate the offset for the start columns of flowed lines This offset is measured in character positions from the start column of first line in the paragraph A positive offset value starts flowed lines to the right of the start column of the first line A negative offset value starts flowed lines to the left of the start column of the first line The overhang parameter has no effect on the start column of the first line in a paragraph Notes 1 You must set the formatter parameter to on for the overhang parameter to have an effect on displayed text 2 The Editor will accept but not use indent or overhangparameter values that cause less than 14 characters to be displayed on a wrapped line Examples For the following examples place the cursor on the first line of a paragraph before typing the following commands in the Issue edit command window 1 Set an initial formatting style for the document by typing these Editor commands set formatter on set wrap on set formwidth 60 set format absolute 4 2 If the indent param
312. true if both of the following are true value of a is equal to value of b value of c is equal to value of d a b amp e lt f amp g gt h true if all of the following are true value of a is equal to value of b value of e is less than value of f value of g is greater than value of h Related Reading Chapter 6 Macros and Profiles 37 Specifying Arithmetic Expressions in Editor Macros You can perform basic arithmetic operations between variables in an Editor macro Basic operators available to you are addition subtraction i multiplication division division returning only the whole number part of the result whole number division returning only the remainder part of the result An arithmetic expression performs operations with two or more terms Terms in an arithmetic expression can include any combination of numeric constants variables and REXX functions The result of the arithmetic expression must be assigned to a variable Some simple arithmetic expressions are a 10 12 a is assigned a value of 22 b 11 2 b is assigned a value of 5 5 c 10 abs 10 c is assigned a value of 100 d 11 2 d is assigned a value of 5 e 11 2 e is assigned a value of 1 More complex arithmetic expressions can mix several arithmetic operators in the same expression In such expressions the normal rules of arithmetic precedence apply with arithmetic expressions inside parentheses evaluated f
313. ts of a 6 digit number and the text part consists of a 6 digit date To display the prefix data area as a 6 digit sequence number followed by the date the following command could be used 298 LPEX Editor User s Guide set prefixdisplayformat 999999 XX XX XX API Return Codes 8 Insufficient storage to continue Related Reading prefixentry Parameter Used to query or set the text in the prefix entry field of the current line Scope Element Syntax query prefixentry set prefixentry Text Options Text Specifies the text that is to be displayed in the prefix entry field Description The character s specified in the Text option are placed in the prefix area for the current line If Text is not specified the prefix area is filled with either the current prefix number or if there is no numeric part to the prefix data with the line number If the size of Text is larger than the prefix entry entry field it will be truncated on the right Example To query the text in the prefix entry field type query prefixentry API Return Code 8 Not enough resources available Chapter 8 References 299 Related Reading prefixformat Parameter Defines the size and type of prefix data that will be maintained with the current file Scope File Syntax query prefixformat set prefixformat Format col Options Format This parameter is a string that describes how the prefix parameter is interpreted This str
314. ttributes Global variables Options gt Change profile Options gt Key behavior gt Customize Windows gt Ring Manager Product Information To invoke the Open dialog window issue the following Editor command dialog open API Return Code 2 The Name specified was not a valid dialog name Issue the command again using a valid dialog name dup Command Duplicates the current line Scope Line 76 LPEX Editor User s Guide Syntax gt dup Tat Number Parameter Number The number of times the current line is duplicated It must be zero or a positive integer value The default is 1 Description The dup command duplicates the current line copying all information including content fonts and structure The new line is placed after the current line and the first character of the new line becomes the current position If more than one new line is created the first character of the last of the new lines becomes the current position If no new lines are created the current position is not moved If the line being duplicated is the last in a list of lines forming the current block the block is extended to include the duplicated line By default the line is duplicated once A repetition count can be specified if desired Example To copy the current line five times type dup 5 API Return Codes 1 The number specified was either outside the valid range or not a whole number
315. ue of the hoverhelp parameter type query hoverhelp If this query returns DEFAULT type the following query default hoverhelp Chapter 8 References 241 API Return Codes 2 Invalid option specified for the parameter Related Reading idletime Parameter Sets number of idle seconds required before autosave Scope File Syntax query idletime set idletime Seconds Option Seconds Delay time for a pending autosave in seconds Must be greater than zero The default is 2 seconds Description The idletime parameter sets the number of seconds during which no data is typed before an autosave occurs Any pending autosave is delayed until the keyboard has been idle for idletime seconds Example To set idletime to 3 seconds type set idletime 3 API Return Codes 2 The number specified was either outside the valid range or not a whole number Issue the command again using a valid number 2 The Seconds option must be greater than zero Use a number of one or more 242 LPEX Editor User s Guide impmacro Parameter Processes unknown commands as macros Scope View Syntax query impmacro set impmacro on off inverse Options on Process unknown commands as macros This is the default value off Do not process unknown commands as macros inverse Toggle between on and off Description The impmacro on parameter makes the Editor process unknown commands as macros This occurs only after the Editor has establi
316. ugh 9 refer to fonts previously defined by the set font n command When the set overfont command is issued the current definition of these Chapter 8 References 279 fonts is saved and the definition is used when the overlay line is built on the screen These fonts can be reset with the set font x command without affecting the appearance of the overlay line unless another set overfont command is issued Programs can set up overlay lines using the nine fonts without interference from other programs setting up overlay lines at different times The set font x command only modifies the color attributes specified All attributes should be fully specified when you set the numeric fonts for use in an overlay line because the appearance of the font depends set font x commands If String is omitted the font set by font overlay is used If String is shorter than the overlay lines font overlay is used for the remaining positions Example To set the fonts for the overlay that appears on the fifth line of the view type set overfont 5 eeeeeeeeeeeeeeee API Return Codes 2 Option is not valid Related Reading overhang Parameter Specifies overhang for flowed lines Scope View Syntax query overhang set overhang Number Option Number The value positive or negative by which indent is multiplied to determine direction right or left and the number of characters to indent lines The default value is 1 Description 280 LPEX Edi
317. ull down menu Chapter 2 Using LPEX 7 4 Select Copy from the cascade menu A copy of the marked block is inserted at the cursor position Alternatively position the cursor and then press Alt C to copy a selected block Deleting a Marked Block 1 2 3 Select Edit from the main menu bar Select Block from the resulting pull down menu Select Delete from the cascade menu to delete the marked block Alternatively press Alt D to delete a marked block Moving a Marked Block 1 2 3 4 Move the cursor to the desired location Select Edit from the main menu bar Select Block from the resulting pull down menu Select one of the following options a Select Move from the cascade menu The block is placed below the cursor Existing text below the cursor shifts downward to allow room for the moved block of text b Select Overlay from the cascade menu The block is placed below the cursor overwriting any existing text Alternatively position the cursor and then press Alt M or use Alt Z if you want to place the block over existing text Related Reading Changing the Default Marking Mode You can change the default marking mode to one of the following choices stream Default The cursor is coupled with the marked text selection Marked text will be deselected if you click the mouse at another location in the file 8 LPEX Editor User s Guide character Similar to stream except that the cursor is n
318. using set parser the trigger command is invoked automatically to process the lines on the pending list As each is processed the parser command specified by set parser is invoked with the pending line temporarily set to the current line A call to set parser processes any pending changed lines before the new parser is selected or switched off The parser command must be a native command invoked with the argument string specified on the set parser command If the parser itself is a macro or external command the native command must be Ixr Use the set parser command without a command name or arguments to turn off automatic parsing of changed lines Use the set autoparse off command to suspend automatic parsing without canceling any parser Example To specify a prrexx parser type set parser prrexx Chapter 8 References 285 API Return Codes None Related Reading pending Parameter Adds a line to a pending list being processed by a parser Scope Line Syntax query pending set pending off change delete both Options off Drops current line from the pending list This is the default value change Line is added to the pending list following a change to the content of the line delete Line is added to the pending list following the deletion of another line both Line is added to the pending list following a change in the content of the line and the deletion of another line Description The pending parameter
319. ustomize Editor appearance and function to suit individual preferences or project needs Simple customizations can be made with pull down menu selections or by setting Editor parameters You can also create macros and load profiles to handle more elaborate customizations See the topics below for instructions on how to perform common Editor customizations Related Reading Changing Editor Tab Settings You can easily change the Editor tab stops to suit the requirements of the document you are working on To change the tab stops you must first open the Editor parameters dialog 1 Select Options from the Editor window main menu bar 2 Select Editor parameters from the resulting pull down menu The Editor parameters dialog appears In the Editor parameters dialog do the following 1 Find and highlight the Tabs entry in the parameters selection list The current value for the Tabs parameter is displayed below the selection list For example a Tabs parameter of EVERY 8 indicates that a tab stop occurs at every eighth character position on a line 2 Click on Change The Set Option Tabs window appears 3 Enter your new tab stops into the Set Option Tabs window For example if you want a tab stop at every third position enter EVERY 3 You can also enter tab stops at irregular intervals 4 Click on OK to save the new Tabs parameter setting and close the Set Option Tabs window Copyright IBM Corp 1995 1998 25
320. value This is the default value off A key enters its own value inverse Toggles between on and off Description The actions on parameter causes any action assigned to a specific key to be carried out when that key is pressed If actions is off the key returns its own value as if it had not been remapped Example To make keys carry out the actions that have been assigned to them type set actions on API Return Code 2 The option you specified was not on off or inverse Related Reading alarm Parameter Sounds the alarm on the next screen refresh Scope Global Syntax query alarm set alarm on off inverse Options on Sounds the alarm after the next refresh off Does not sound the alarm after the next refresh This is the default value inverse Toggles between on and off Description Chapter 8 References 163 The alarm on parameter sounds an alarm when the screen is next refreshed for example when the current macro ends or after a sshow command The alarm parameter is then automatically set to off after the screen has been refreshed The alarm sounds only if the beep parameter is set to on Examples 1 To see the state of the alarm parameter type query alarm 2 To turn the refresh alarm on type set alarm on API Return Code 2 The option you specified was not on off or inverse Related Reading autochanges Parameter Counts the number of changes since the last autosave Sc
321. ve The drive and directory parameters together give you the option of changing that directory Example To determine which drive is being used by the Editor type query drive API Return Code 2 Unsuccessful Most likely an invalid drive letter Related Reading element Parameter Gives the number of the current line Scope Line 206 LPEX Editor User s Guide Syntax query element Description The element parameter returns the number of the current line counted from the top of the file An empty file returns 1 Example To find the number of a line place the cursor on it and type query element If the cursor is on the fourth line element returns 4 API Return Codes None Related Reading elementchangeexit Parameter Specifies an Editor command to be performed whenever the current element changes Scope File Syntax query elementchangeexit set elementchangeexit Command Options Command Any valid Editor command Description The elementchangeexit parameter defines an Editor command to be performed when the current element changes You can clear the value of the elementchangeexit parameter by setting the parameter without specifying a Command Chapter 8 References 207 Example 1 To sound an alarm when the current element changes type set elementchangeexit alarm 2 To clear the value of the elementchangeexit parameter type set elementchangeexit 3 To issue a series of commands w
322. ve the cursor to the next word on the left Move the cursor to the next word on the right Note For char insertchar and replacechar x can be either any single character or a character s ASCII code expressed as three decimal digits or two hexadecimal digits preceded by x if the resulting decimal value is greater than 0 and less than 256 You can also specify a string enclosed in single or double quotation marks to allow several characters to be inserted or replaced in one operation Related Reading External Subroutines Summary You can use the following library of external subroutines to access Editor functions Invokes an Editor command Invokes an Editor command with a separate parameter string Gets information about Editor data items and settings Chapter 8 References 357 Several special purpose subroutines provide fast access to Editor functions These are especially useful when working with parsers Moves the current position to the next line Move the current position to the previous line Gets the content of the current line Sets the content of the current line Gets the fonts of the current line 4 Ixsfont Subroutine o Sets the fonts of the current line Gets the class of the current line Sets the class of the current line Allocates storage Frees storage allocated using the Ixalloc Ixcmd Subroutine Issues an Editor command and any parameters from a C program Library I
323. w set recentmenushow BOTTOM TOP OFF Options BOTTOM The recently accessed file list is displayed and appears at the bottom of the File pull down menu 308 LPEX Editor User s Guide TOP The recently accessed file list is displayed and appears at the top of the File pull down menu OFF The recently accessed file list is not displayed Description The Editor window can display a list of the recently accessed files If the recentmenushow parameter has a value other than off and the recentsize parameter has a value other than 0 a list of recently accessed file names is displayed in the File pull down menu Files can be opened by double clicking on the file names displayed in the recently accessed file list If you open or save a file whose name already appears in the recently accessed file list the name of that file is moved to the top of the list If the file name is not already in the recently accessed file list the name of that file is added to the top of the list and all other entries move down one position If adding a file name to the recently accessed file list causes the number of files in that list to exceed the value of recentsize parameter the file name at the bottom of the list is removed from the list The recently accessed file list is saved each time you work within an Editor window Additions to the recently accessed file list can be suppressed by specifying the NFL or NOFILELIST options when using th
324. was not a valid class type Use the query classes command to see which ClassName is currently defined or use the set class command to define a new class Issue the command again using a valid ClassName Related Reading horizscroll Parameter Sets the number of columns to scroll Scope View Syntax query horizscrol1 set horizscroll Number Option Number The number of columns to scroll This value must be an integer between 1 and 30 Description The horizscroll parameter sets the number of columns to scroll when the horizontal scrollbar scroll buttons are pressed Example 240 LPEX Editor User s Guide To set the horizontal scrollbar to move by three columns when the scroll buttons are pressed type set horizscroll 3 API Return Code 2 Number is not in the valid range 1 30 hoverhelp Parameter Enables or disables hover help for toolbar buttons Scope View Syntax set hoverhelp on off inverse default query hoverhelp Options on Enable hover help off Disable hover help inverse Toggles the value of the hoverhelp default Hover help display is controlled by the value of the default Description The value of the hoverhelp determines if hover help is displayed when the cursor pauses over a toolbar button Example 1 To enable hover help type set hoverhelp on 2 To control hover help display with the value defined by the default parameter type set hoverhelp default 3 To display the val
325. with the prefixentry parameter Description The actionprefix parameter assigns a prefix command to a character sequence for the current file only When the assigned sequence is entered in the prefix area the command is carried out provided that the actions parameter is set to on Multiple commands can be attached to an actionprefix character sequence by using the mult command Use the actionprefixlist parameter to see a list of prefix commands already defined for the current editing session Example To define a prefix command D that will delete the current line type set actionprefix D delete Entering D into the prefix area will delete the current line Return Codes Chapter 8 References 161 None Related Reading actionprefixlist Parameter Used to get a list of all prefix commands defined for the current document Scope File Syntax query actionprefixlist Options None Description This parameter displays a list of all prefix commands defined for the current document Output can be viewed in the macro log Example To see a list of prefix commands defined for the current document type query actionprefixlist API Return Code 1 The actionprefixlist parameter accepts no options Related Reading actions Parameter Enables shortcut keys Scope Global Syntax query actions 162 LPEX Editor User s Guide set actions on off inverse Options on A key enters its assigned
326. without updating the text write The Editor macro will update the text in the edit window This is the default option none No lock is applied stop The Editor macro will honor a Stop pushbutton in the progress indicator synch If selected the submit command will not lock up the main thread while waiting for the macro to complete Description The description text to be displayed in the progress indicator EditorMacro Certain Editor macros supplied with the product for language sensitive editing support Description The submit command places the specified access lock on the Editor before invoking the supplied command on a secondary thread A progress indicator is displayed with the optional description text The command string is displayed as the description by default Notes 136 LPEX Editor User s Guide 1 Multiple concurrent read accesses are allowed however only one write access is allowed at any one time 2 When an Editor window is locked for write access read access requests will be queued up When an edit window is locked for read access write access requests are rejected 3 Only certain IBM supplied default Editor macros which observe the proper protocol for concurrent execution can be invoked with the submit command Example To invoke the CL tokenizer to perform a total parse submit read stop Parsing file evflcl all API Return Codes 1 There is not enough system resource to invoke the comman
327. ws from the menu bar of any Editor window b Select Ring manager from the resulting pull down menu The Editor ring manager window opens 2 In the top part of the Editor ring manager window find and select the icon or text representing the view that you want to move into a new ring 3 Select Selected from the menu bar of the Editor ring manager window Chapter 2 Using LPEX 17 4 Select New ring from the resulting pull down menu A separate Editor window for the new ring appears and your file view is moved into the editing pane of the new ring To move a file view to an existing ring do the following 1 In the top part of the Editor ring manager window find and select the icon or text representing the view that you want to move into a new ring 2 Use the mouse to drag the selected item to the icon or text representing the new ring Moving between file views within the same ring Within a file ring only one view is accessible for editing at any given time You can however cycle through all views in the ring by doing the following 1 Select Windows from the menu bar of the Editor window that contains the ring you want to work with 2 Select either Next in ring or Previous in ring from the resulting pull down menu The file visible in the editing pane is replaced with the next or previous file in the ring If you have many file views in a ring you may find it faster to go directly to another view by using the Rin
328. xs The profiles parameter sets the profiles that are used if available by the Editor when you are loading and saving files By default all four parameters are used Examples 1 To load only the user profile when a file is loaded type set profiles user 2 To see which profiles have been used when you are loading or saving a file type query profiles Chapter 8 References 303 API Return Codes 2 The option specified with the parameter was not valid Related Reading protect Parameter Sets classes to be protected on display Scope View Syntax query protect set protect ClassName ClassName Option ClassName List of valid classes to be protected separated by blanks The maximum number of classes is 30 Description The protect parameter ensures that classes specified are protected against overtyped changes even if browse is off Changes by other means such as macros are still allowed Example To protect lines containing CODE and BRACE classes from being overtyped type set protect code brace API Return Codes 2 The ClassName was not a valid class type Use the query classes command to see which ClassNames are currently defined or use the set class command to define a new class Issue the command again using valid ClassNames Related Reading 304 LPEX Editor User s Guide rawtext Parameter Displays the data content of a line without symbol substitution Scope Fil
329. y be used Any functionally equivalent product program or service that does not infringe any of IBM s intellectual property rights may be used instead of the IBM product program or service Evaluation and verification of operation in conjunction with other products except those expressly designated by IBM is the user s responsibility IBM may have patents or pending patent applications covering subject matter in this document The furnishing of this document does not give you any license to these patents You can send license inquiries in writing to Director of Licensing Intellectual Property amp Licensing International Business Machines Corporation North Castle Drive MD NC119 Armonk New York 10504 1785 U S A Licensees of this program who wish to have information about it for the purpose of enabling i the exchange of information between independently created programs and other programs including this one and ii the mutual use of the information which has been exchanged should contact IBM Canada Ltd Department 071 1150 Eglinton Avenue East North York Ontario M3C 1H7 Canada Such information may be available subject to appropriate terms and conditions including in some cases payment of a fee This publication may contain examples of data and reports used in daily business operations To illustrate them as completely as possible the examples may include the names of individuals companies brands and p
330. y this line to the specified target CC Copy the block of lines between the two CC commands D Delete this line Dn Delete this and the following n 1 lines DD Delete all lines between the two DD commands F Show the first line in an exclude block Fn Show the first n lines in an exclude block I Insert a blank line after the current line In Insert n blank lines after the current line L Show the last line in an exclude block Ln Show the last n lines in an exclude block LC Convert the current line to lowercase M Move a line to the specified target MM Move all lines between the two MM commands to a specified target O Overlay this line with the lines defined by the move copy or copy retain commands OO Overlay all the lines between the two OO commands with the lines defined by the move copy or copy retain commands R Duplicate the current line immediately before the next line Rua Duplicate the current line n times immediately before the next line RR Duplicate the lines between the two RR commands RR Duplicate the lines between the two RR commands n times S Show all of the significant lines in an exclude group UC Convert the current line to uppercase X Exclude this line from the display Xn Exclude this line and the next n 1 lines from the display XX Exclude all the lines between the two XX commands from the display gt Shift the data in this line one character position to the right gt n Shift the data
331. ys will help you select text in the Editor Where two or more key names are joined by a plus sign hold down the first key and press the second or hold down the first two and press the third Single click mouse button 1 Click with mouse button 1 and drag Move cursor Select new text Double click mouse Select current word button 1 Shift Single Click mouse button 1 Ctrl Double click mouse button 1 Alt Double click mouse button 1 Ctrl Left Ctrl Right Shift Ctrl PgUp Shift Ctrl PgDn Shift Right Shift Left Shift Ctrl End Shift Down Shift Up Shift Ctrl Right Shift Ctrl Down Shift End Shift Home Shift Ctrl Left Shift Ctrl Up Shift Ctrl Home Expand or contract the currently selected item to the mouse cursor position Select current line Start rectangular block selection then drag to mark remainder of rectangle Move cursor to start of current or previous token Move cursor to start of next token Extend selection one screen page to the left Extend selection one screen page to the right Select or deselect following character Select or deselect previous character Select or deselect to bottom of file in the working area Select or deselect to column beneath current cursor position Select or deselect to column above current cursor position Select or deselect to start of next token Select or deselect to end of token or word beneath Select or deselect to end of line Select or deselect to st

LPEX Editor User's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents