Running an Editor Script

Running an Editor Script

This chapter illustrates Ada-ASSURED's scripting language. Scripts can be used to (a) customize and extend the Ada-ASSURED's functionality, (b) integrate Ada-ASSURED with other tools, and (c) implement batch or interactive program analyzers. The chapter contains only toy examples, to suggest what is possible. Chapter Scripting Language describes the scripting language in detail.

• If you are already running Ada-ASSURED, close any buffers of no further interest by invoking command close from the File menu. If you are not currently running Ada-ASSURED, start it up, as described above in Editing an Ada Program.

• Go on to the appropriate Section:

  • Scripts under X Windows

  • Scripts under Microsoft^® Windows^®

Typically, scripts are stored in a text file that is loaded and executed. However, here you execute script statements one at a time in the *transcript* buffer so you can see the immediate effect of each statement:

• Invoke command switch-to-buffer in the View/Buffers menu. In the dialog box, select buffer *transcript*, select choice Yes for New Window, and click on OK.

Customization and Extension under X Windows

1. Type the following statement in the *transcript* window. When you strike Enter, a new menu labeled LOCAL should appear at the left end of the menu bar:

   	(sg:add-menu "" "LOCAL" 0 #\null #\c '() "local")
   	

2. Type the following script statement in the *transcript* window. When you strike Enter, a new item labeled My Editor should appear in the LOCAL menu:

   	(sg:add-menu "local" "My Editor" 0 #\null #\b '() "vi")
   	

   If you select item My Editor from the LOCAL menu, you will get the message ``Bad command "vi" in menu'' because no command named vi is yet defined to carry out the action for the menu item.

3. Type the following script statement in the *transcript* window, and then strike Enter:

   	(sg:add-command "vi" (lambda() (sg:write-message "Call vi")))
   	

   Now, when you select item My Editor from the LOCAL menu, the message ``Call vi'' is displayed in the status pane.

• Invoke command eval-file from the Tools/Scripts menu. In the popped-up dialog box, enter the full pathname of file

  aahome/scripts/vi.stk

  or use the file-and-directory browser to locate it. Then click on OK.

The new definition of command myeditor is:

(sg:add-command "vi" (lambda()
   (sg:save-selection-to-file "Text" "/tmp/ssel" "BASEVIEW")
   (system "xterm -e /usr/ucb/vi /tmp/ssel")
   (sg:cut-structure)
   (sg:insert-file-structure "/tmp/ssel")))

Try out the new vi command on an Ada file:

1. Open an Ada file from directory

   aahome/AdaSamples/SPC/examples1

2. Make the buffer modifiable by toggling Write Permission in menu Options.

3. Select a small group of statements, or a single procedure.

4. Invoke command myeditor from the LOCAL menu, so as to run vi.

5. If you know vi, modify the code fragment slightly.

6. Exit vi by typing :wq and then strike Enter.

Scripts under Microsoft^® Windows^®

Typically, scripts are stored in a text file that is loaded and executed. However, here you execute script statements one at a time in the *transcript* buffer so you can see the immediate effect of each statement:

• Select the *transcript* window from the Window menu, if one is present. If there currently is no *transcript* window, then invoke command show-buffer in the Window menu, and in the dialog box that opens, select buffer *transcript* and click on OK.

Customization and Extension under Microsoft^® Windows^®

1. Type the following statement in the *transcript* window. When you strike Enter, a new menu labeled LOCAL should appear at the left end of the menu bar:

   	(sg:add-menu "" "LOCAL" 0 #\null #\c '() "local")
   	

2. Type the following script statement in the *transcript* window. When you strike Enter, a new item labeled My Editor should appear in the LOCAL menu:

   	(sg:add-menu "local" "My Editor" 0 #\null #\b '() "notepad")
   	

   If you select item My Editor from the LOCAL menu, you will get the message ``Bad command "notepad" in menu'' because no command named notepad is yet defined to carry out the action for the menu item.

3. Type the following script statement in the *transcript* window, and then strike Enter:

   	(sg:add-command "notepad" (lambda() (sg:write-message "Call notepad")))
   	

   Now, when you select item My Editor from the LOCAL menu, the message ``Call notepad'' is displayed in the status pane.

• Invoke command eval-file from the Tools/Scripts menu. In the popped-up dialog box, enter the full pathname of file

  aahome/scripts/notepad.stk

  or use the file-and-directory browser to locate it. Then click on OK.

The new definition of command notepad is:

(sg:add-command 
   "notepad" 
   (lambda()
     (sg:save-selection-to-file "Text" "C:\\temp\\ssel" "BASEVIEW")
     (system "notepad C:\\temp\\ssel")
     (sg:cut-structure)
     (sg:insert-file-structure "C:\\temp\\ssel")))

Try out the new notepad command on an Ada file:

1. Open an Ada file from directory

   aahome/AdaSamples/SPC/examples1

2. Make the buffer modifiable by toggling Write Permission in menu Options.

3. Select a small group of statements, or a single procedure.

4. Invoke command notepad from the LOCAL menu, so as to run notepad.

5. If you know notepad, modify the code fragment slightly.

6. Exit notepad by selecting Exit from the notepad window File menu.