Shareware Supreme Volume 6 #1

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Supreme Volume 6 #1 / swsii.zip / swsii / 450 / TLDR22.ZIP / TOOLDRIV.DOC < prev next >

Wrap

Text File | 1993-06-15 | 95.4 KB | 2,749 lines

T o o l D r i v e r Version 2.02 ──────────────────── User's Guide Organizing files and naming conventions / Professional Tools / for Software Developers and Consultants ┌───────┐ ┌───────┐ │ (R) ──│ │ │─────────────────── │ ┌───────┐ │ Association of ConVal Software, Inc. │ │ │─┘ Shareware └──│ o │ Professionals ─────│ | │───────────────────── └───┴───┘ MEMBER T o o l D r i v e r Version 2.02 ──────────────────── User's Guide Organizing files and naming conventions / Professional Tools / for Software Developers and Consultants ┌───────┐ ┌───────┐ │ (R) ──│ │ │─────────────────── │ ┌───────┐ │ Association of ConVal Software, Inc. │ │ │─┘ Shareware └──│ o │ Professionals ─────│ | │───────────────────── └───┴───┘ MEMBER Copyright 1990-1993 ConVal Software, Inc. All rights reserved. This program is produced by a member of the Association of Shareware Professionals (ASP). ASP wants to make sure that the shareware principle works for you. If you are unable to resolve a shareware-related problem with an ASP member by contacting the member directly, ASP may be able to help. The ASP Ombudsman can help you resolve a dispute or problem with an ASP member, but does not provide technical support for members' products. Please write to the ASP Ombudsman at: ASP Ombudsman 545 Grover Road Muskegon, MI 49442-9427 U.S.A. or send a CompuServe message via CompuServe MAIL to ASP Ombudsman 70007,3536. The ombudsman may be contacted by FAX by sending to the ASP FAX number: (616) 788-2765. In communication with the ombudsman please include a telephone number and/or FAX if available. Turbo Vision (c) is a registered trademark of Borland International, Inc. Portions Copyright Borland International, Inc. Used by permission. iv TABLE OF CONTENTS Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 SECTION 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . . 9 What's in ToolDriver?. . . . . . . . . . . . . . . . . . . . . . . . . . 9 Hardware and software requirements . . . . . . . . . . . . . . . . . . . 9 How to contact ConVal Software . . . . . . . . . . . . . . . . . . . . . 9 The ToolDriver package . . . . . . . . . . . . . . . . . . . . . . . . . 10 SECTION 2: Installing ToolDriver . . . . . . . . . . . . . . . . . . . . 10 To install ToolDriver. . . . . . . . . . . . . . . . . . . . . . . . . . 10 Running ToolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 SECTION 3: ToolDriver Basics . . . . . . . . . . . . . . . . . . . . . . 11 Starting ToolDriver. . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Exiting ToolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 The User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 The menu bar and menus. . . . . . . . . . . . . . . . . . . . . . . . 11 Working with windows. . . . . . . . . . . . . . . . . . . . . . . . . 15 The status line . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Dialog boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Action buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Radio Buttons and check boxes . . . . . . . . . . . . . . . . . . . . 19 Input boxes and list boxes. . . . . . . . . . . . . . . . . . . . . . 20 SECTION 4: Menus and options reference . . . . . . . . . . . . . . . . . 20 ≡ (System) menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Product Information . . . . . . . . . . . . . . . . . . . . . . . . . 21 File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Change Dir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 DOS Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Quit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Edit menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 File Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Show Clipboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 v Search menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Search Again. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 FileXref Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Files to cross reference. . . . . . . . . . . . . . . . . . . . . . . 29 Words to cross reference. . . . . . . . . . . . . . . . . . . . . . . 30 Start cross referencing . . . . . . . . . . . . . . . . . . . . . . . 32 Extended Reports . . . . . . . . . . . . . . . . . . . . . . . . . 33 Condensed Reports. . . . . . . . . . . . . . . . . . . . . . . . . 36 File Parts List Report . . . . . . . . . . . . . . . . . . . . . . 37 Export files . . . . . . . . . . . . . . . . . . . . . . . . . . . 37A View the output log . . . . . . . . . . . . . . . . . . . . . . . . . 39 NameChanger menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Files to process. . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Names to be changed . . . . . . . . . . . . . . . . . . . . . . . . . 42 Start name changing . . . . . . . . . . . . . . . . . . . . . . . . . 43 View the output files . . . . . . . . . . . . . . . . . . . . . . . . 44 Window menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Size/Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Tile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Cascade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Next. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Previous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Help menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 INDEX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 vi FIGURES Figure 1: A ToolDriver window . . . . . . . . . . . . . . . . . . . . . 16 Figure 2: View a File dialog box. . . . . . . . . . . . . . . . . . . . 21 Figure 3: Change Directory dialog box . . . . . . . . . . . . . . . . . 23 Figure 4: The Find Text dialog box. . . . . . . . . . . . . . . . . . . 27 Figure 5: The Replace Text dialog box . . . . . . . . . . . . . . . . . 28 Figure 6: Files to cross reference. . . . . . . . . . . . . . . . . . . 29 Figure 7: The Cross reference files dialog. . . . . . . . . . . . . . . 32 Figure 8: The Extended File Cross Reference Report . . . . . . . . . . 34 Figure 9: The Extended Word Usage Report. . . . . . . . . . . . . . . . 35 Figure 10: The Unreferenced Files Report . . . . . . . . . . . . . . . . 36 Figure 11: The Condensed File Cross Reference Report . . . . . . . . . . 36 Figure 12: The Condensed Word Usage Report . . . . . . . . . . . . . . . 37A Figure 13: The File Parts List Report. . . . . . . . . . . . . . . . . . 37A Figure 14: The Export File . . . . . . . . . . . . . . . . . . . . . . . 37A Figure 15: NameChanger Files dialog. . . . . . . . . . . . . . . . . . . 41 Figure 16: The Change names dialog . . . . . . . . . . . . . . . . . . . 43 Figure 17: View the name-changed files dialog box . . . . . . . . . . . 45 TABLES Table 1: General hot keys. . . . . . . . . . . . . . . . . . . . . . . . 12 Table 2: Menu hot keys . . . . . . . . . . . . . . . . . . . . . . . . . 13 Table 3: Editing hot keys. . . . . . . . . . . . . . . . . . . . . . . . 14 Table 4: Window management hot keys. . . . . . . . . . . . . . . . . . . 14 Table 5: Online help hot keys. . . . . . . . . . . . . . . . . . . . . . 14 Table 6: How to use windows. . . . . . . . . . . . . . . . . . . . . . . 17 Table 7: Export file flags . . . . . . . . . . . . . . . . . . . . . . . 39 vii Preface ──────────────────────────────────────────────────────────────────────────── Welcome to this user guide to ToolDriver. It describes how you can better organize your files and names. This information will be useful to anyone responsible for developing, managing, or maintaining application software. You will learn: ■ The value of understanding the relationships of your source files. ■ How planning your naming conventions can assist in debugging. ■ How to uncover obsolete components. ■ An easy way to change old programs to your current naming style. ■ Organizing tricks that eliminate entire classes of problems. ■ Characteristics of a well organized application. ■ Ways to prevent unanticipated naming problems. Software applications require careful planning and thoughtful implementation. The information provided here will help you understand the detailed organization of your application as well as communicate that understanding to others, making your job easier. 8 SECTION 1: Introduction ──────────────────────────────────────────────────────────────────────────── What's in ToolDriver? ■ An integrated window environment for running the ConVal programming tools below. ■ FileXref - cross references your files and names. It reads text files and documents their use of other files and words you've selected. It works on many languages including C, C++, Pascal, COBOL, BAS, MASM, SQL, Fortran, and xBase. ■ NameChanger - transforms names in the files associated with your application. ■ See the file PACKLIST.DOC for a short description of each file supplied with ToolDriver. Hardware and software requirements ToolDriver runs on machines with an 80286 or higher processor and running DOS 3.1 or higher. A hard disk, at least one floppy drive, and 2 megabytes of RAM are required to run ToolDriver. It uses 1.4 megabytes of hard disk space. ToolDriver supports (but does not require) any Windows-compatible mouse. Microsoft Windows is not required How to contact ConVal Software ConVal Software, Inc. 11607 E. Butter Creek Road Moorpark, CA 93021-2412 Sales and technical support: Monday - Friday Voice (805) 529-6847 9 AM - 5 PM Pacific Time Fax (805) 529-4314 CompuServe 72330,1621 9 The ToolDriver package Your ToolDriver package consists of an installation disk and a ToolDriver User's Guide (this document). The disk contains all the programs and files you need to cross reference your source files and make changes to your naming conventions. SECTION 2: Installing ToolDriver ──────────────────────────────────────────────────────────────────────────── The ToolDriver installation procedure will verify that you have enough space on your hard drive, create directories as needed and transfer files from your distribution diskettes to your hard disk. Its actions are self- explanatory; the following instructions tell you all you need to know. To install ToolDriver: 1. Insert the installation disk into drive A. Type the following command, then press Enter. A:INSTALL 2. Press Enter again when the installation program displays its initial screen. 3. Follow the installation prompts. 4. At the end of installation, you may want to add this line to your CONFIG.SYS file: FILES=20 Running ToolDriver Once you've installed ToolDriver, and if you're anxious to get up and running, change to the TOOLDRIV directory (if you didn't pick another name yourself), type TD and press Enter. Use the help key, F1, to learn about ToolDriver as you use it. Otherwise, continue reading this documentation to see what ToolDriver does. 10 SECTION 3: ToolDriver Basics ──────────────────────────────────────────────────────────────────────────── The ToolDriver platform for organizing files and names was developed using Borland's Turbo Vision for C++. It has everything you need to setup, run, view and print output from cross referencing as well as name-changing functions. It provides: ■ multiple resizable windows that can be moved ■ mouse support and dialog boxes ■ cut, paste, and copy commands using a clipboard ■ a small, fast editor for preparing and revising input files ■ online Help ■ quick access to other programs and back again This section explains the following topics: ■ starting and exiting ToolDriver ■ working with windows ■ using dialog boxes to communicate with ToolDriver Starting ToolDriver To start ToolDriver, go to the ToolDriver directory ( C:\TOOLDRIV by default ), type TD and press Enter at the DOS prompt. Exiting ToolDriver There are two ways to leave ToolDriver: ■ Choose File│Quit to leave ToolDriver completely; you have to type TD again to reenter it. You'll be prompted to save your work before exiting, if you haven't already done so. ■ Choose File│DOS Shell to shell out from ToolDriver to enter commands at the DOS command line. When you're ready to return to ToolDriver, type EXIT at the command line and press Enter. You will be able to resume work just as you left it. The User Interface ToolDriver has three visible objects: a menu bar at the top of the screen, a window area in the middle, and a status line at the bottom of the screen. If you are already familiar with the Borland IDE interface, then you may want to skip the rest of this section and read the sections on cross referencing (See FileXref, page 29) and changing names (See NameChanger, Page 40. Selection of some menu commands will make a dialog box visible. There are several methods for selecting commands, but regardless of the method, the end result is the same. 11 The menu bar and menus The menu bar is your primary access to all the commands on the menu. It is always visible except when you're viewing your program's output or transferring to another program. Here is how you choose menu commands using the keyboard: 1. Press F10. This makes the menu bar active. The next thing you type will relate to items on the menu bar. 2. Use the left and right arrow keys to select the menu you want to display. Then press Enter. As a shortcut for this step, you can just press the highlighted letter of the menu title. For example, when the menu bar is active press N to move to and display the NameChanger menu. A third way of doing this step is to hold down the Alt key and then press a highlighted letter from the menu bar titles (such as Alt+N) to display the menu you want. 3. Use the up and down arrows now to select a command from the menu displayed. At this point ToolDriver either carries out the command or displays a dialog box. There are two ways to choose menu commands with a mouse: 1. Click the desired menu title to display the menu and click the desired command from the menu. 2. Or, drag straight from the menu title down to the menu command. Release the mouse button on the command you want. (If you change your mind, just drag off the menu and no command will be chosen.) Some menus and menu commands are unavailable when it would make no sense to choose them. Following are lists of keyboard shortcuts (or hot keys) for accessing the menu bar, choosing menu commands, and working with dialog boxes. Table 1: General hot keys Hot Key Menu command Function ─────── ──────────── ────────────────────────────────────────── F1 Help Displays a context-sensitive help screen. F2 File│View Brings up a dialog box for viewing a file. F4 Window│Close Closes the active window. F5 Window│Zoom Toggles the active window's size. F10 (none) Takes you to the menu bar. 12 Table 2: Menu hot keys Hot Key Menu Function ──────────── ─────── ──────────────────────────────────────── Alt+Spacebar ≡ Takes you to the ≡(Product Info) menu. Alt+E Edit Takes you to the Edit menu. Alt+F File Takes you to the File menu. Alt+H Help Takes you to the Help menu. Alt+N NameChanger Takes you to the NameChanger menu. Alt+S Search Takes you to the Search menu. Alt+W Window Takes you to the Window menu. Alt+X FileXref Takes you the the FileXref menu. 13 Table 3: Editing hot keys Hot Key Command Function ─────── ────────── ──────────────────────────────────────────── Ctrl+Ins Edit Copy Copies selected text to the clipboard. Shift+Del Edit Cut Places selected text in the clipboard, deletes selected text. Shift+Ins Edit Paste Pastes text from the clipboard into the active window. Ctrl+Del Edit Clear Removes selected text from a window, but doesn't put it in the clipboard. Ctrl+L Search/Search Repeats the last find or replace. F3 File Save Saves the file in the active edit window. Table 4: Window management hot keys Hot Key Menu Command Function ─────── ───────────── ───────────────────────────────────────── Alt+n (none) Displays window n, where n is the number of the window you want to see. F4 Window Close Closes the active window. F5 Window Zoom Toggles the size of the active window. Ctrl+F5 Window Size/Move Changes the size or position of the active window. F6 Window Next Makes the next window the active one. Shift+F6 Window Previous Makes the prior window the active one. Table 5: Online help hot keys Hot Key Function ─────── ────────────────────────────────────── F1 Opens a context-sensitive help screen. Alt+F1 Displays the previous help screen. 14 Working with windows Most of what you see and do in ToolDriver happens in a window. A window is a screen area that you can open, close, move, resize, zoom, tile, and overlap. You can have many windows open in ToolDriver, but only one window can be active at any time. Any menu command you choose or text you type generally applies only to the active window. You can easily spot the active window - it's the one with the double-lined border around it. The active window always has a close box, a zoom box, and scroll bars. If your windows are overlapping, the active window is always on top of all the others. There are several types of windows, but most of them have these things in common: ■ a title bar ■ a close box ■ scroll bars ■ a zoom box ■ a window number (1 to 9) An edit window also displays the current line and column numbers in the lower left corner. If you've modified your file, an asterisk (*) appears to the left of the column and line numbers. The following figure shows a typical window: 15 Figure 1: A ToolDriver window ┌────────────────────────┐ │ The title bar contains │ │ the name of the window │ └───────────┬────────────┘ │ ┌───────────────┐ │ ┌───────────────────────┐ │ Click the │ │ │ Click on the zoom box │ │ close box to │ │ │ to either enlarge or │ │ quickly close │ │ │ shrink the window │ │ the window │ │ └─────────────┬─────────┘ └──────┬────────┘ │ │ │ │ │ ┌─ ╔══[■}════════════ Window Title ════════ 4 ═[■]══╗ ─┐ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░┌────────────────────┴────┐░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░│ The first 9 open │░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░│ windows have a window │░░■ │ │ ║░░░░░░░░░░░░░░░░░░░│ number. Use Alt and n │░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░│ to make window n active │░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░└─────────────────────────┘░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │ │ ║░░░░░░░░┌───────────────────────────┐░░░░░░░░░░░▓ │ │ ║░░░░░░░░│ Use a mouse to scroll the ├─────────░▓ │ │ ║░░░░░░░░│ contents of the window │░░░░░░░░░░░▓ │ │ ║░░░░░░░░└─────────┬─────────────────┘░░░░░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │ │ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ ╚═▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓─┘ │ │ │ │ │ ┌────────────────────────────┐ │ │ └───┴────────────│ Drag any corner to make │──────┴───┘ │ windows larger or smaller. │ └────────────────────────────┘ The close box of a window is the box in the upper left corner. Click this box to quickly close the window. (Or choose Window│Close.) The help windows are considered temporary. You can close them by pressing Esc. The title bar, the topmost horizontal bar of a window, contains the name of the window and the window number. Double-clicking the title bar zooms the window. You can also drag the title bar to move the window around. 16 The zoom box of a window appears in the upper right corner. If the icon in that corner is an up arrow (), you can click the arrow to enlarge the window to the largest possible size. If the icon is a double-headed arrow (), the window is already at its maximum size. In that case, clicking it returns the window to its previous size. To zoom a window from the keyboard, choose Window│Zoom. The first nine windows you open in ToolDriver have a window number in the upper right border. You can make a window active (and bring it to the top) by pressing Alt and the window number. For example if the FileXref output report window is window number 4 and it's behind other windows, then Alt+4 brings it to the top so it's fully visible. Scroll bars are horizontal or vertical bars that look like this: ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ Scroll bars show you where you are in relation to what you're viewing. You use these bars with a mouse to scroll the contents of the window. Click the arrow at either end to scroll one line at a time. (Keep the mouse button pressed to scroll continuously.) You can click the shaded area to either side of the scroll box to scroll a page at a time. Finally, you can drag the scroll box to any spot on the bar to quickly move to a spot in the window relative to the position of the scroll box. You can drag any corner to make a window larger or smaller. To resize from the keyboard, choose Size/Move from the Window menu. Press enter when finished to get out of the sizing/moving mode. Table 6 is a quick reference for using windows in ToolDriver. Note that you don't need a mouse to perform these actions - a keyboard works fine too. Table 6: How to use windows To do this Use one of these techniques ────────────────────── ───────────────────────────────────────────── Open a file viewer Choose File View to open a file and scroll it in a window. Open other windows Choose the desired window from the Window menu. Close a window Choose Close from the Window menu or click the close box of the window or press F4. Activate a window Click anywhere in the window, or 17 To do this Use one of these techniques ────────────────────── ───────────────────────────────────────────── Press Alt plus the window number (1 to 9), or Choose Window Next (F6 is the hot key) to step through the windows in the order you created them, or Choose Window Previous (Shift+F6 is the hot key) to step through the windows in the reverse of the order you created them. Move an active window Drag its title bar. Or choose Window Size/Move and use the arrow keys to place the window where you want it, then press Enter. Resize the active window Drag any corner. Or choose Window Size/Move and press Shift while you use the arrow keys to resize the window, then press Enter. Zoom the active window Click the zoom box in the upper right corner of the window, or Double-click the window's title bar, or Choose Window Zoom (F5 is the hot key). The status line The status line appears at the bottom of the screen to ■ remind you of basic keystrokes and shortcuts (or hot keys) applicable in the active window. ■ let you use the mouse to click on a command to perform the action instead of choosing the action from the menu or pressing the shortcut keystroke. Here is what the status line looks like: ┌───────────┬───────────────────────────────────────────┬──┐ │ToolDriver │ F1 Help F2 View F4 Close F5 Zoom F10 Menu │Id│ └───────────┴───────────────────────────────────────────┴──┘ Where Id is the serial number of your registered software. 18 Dialog boxes A menu command with an ellipsis (...) after it leads to a dialog box. Dialog boxes offer a convenient way to view and set multiple options. When you're making settings in dialog boxes, you work with five basic types of onscreen controls: action buttons, radio buttons, check boxes, input boxes, and list boxes. Action buttons │ OK │ │ Cancel │ Above are two action buttons, OK and Cancel. If you choose OK, the choices in the dialog box are accepted; if you choose Cancel, nothing changes, no action takes place, and the dialog box is put away. Choose Help to open a Help window about this dialog box. Esc is always a keyboard shortcut for Cancel (even if no Cancel button appears). If you're using a mouse, click the dialog-box button you want. When you're using the keyboard, press Alt and the highlighted letter of a command to activate it. For example Alt+C selects the Cancel button because the C in Cancel is highlighted. Press Tab or Shift+Tab to move forward or back from one item to another in a dialog box. Each element is highlighted when it becomes active. In this dialog box, OK is the default button, which means you need only press Enter to choose the button. (On monochrome systems, arrows indicate the default; on color monitors, default buttons are highlighted.) Be aware that tabbing to a button makes that button the default. Radio Buttons and check boxes ┌───────────────────────────────────┐ │ Radio Buttons Check Boxes │ │ ( ) Option 1 ( ) Option A │ │ (X) Option 2 (X) Option B │ │ ( ) Option 3 ( ) Option C │ │ (X) Option D │ └───────────────────────────────────┘ Radio buttons are like car-radio buttons. They come in groups, and only one radio button in the group can be on at any one time. To choose a radio button, click it or its text. From the keyboard, select Alt and the highlighted letter, or press Tab until the group is highlighted, and then use the arrow keys to choose a particular radio button. Press Tab or Shift+Tab again to leave the group with the new radio button chosen. Section 1 Check boxes differ from radio buttons in that you can have any number of check boxes checked at any time. When you select a check box, an X appears in it to show you it's on. An empty box indicates it's off. To change the status of a check box, click it or its text, press Tab until the check box is highlighted and then press Spacebar, or select Alt plus the highlighted letter. 19 If several check boxes apply to a topic, they appear as a group. In that case, tabbing moves to the group. Once the group is selected, use the arrow keys to select the item you want, and then press Spacebar to check or uncheck it. On monochrome monitors, the active check box or group of check boxes will have a chevron symbol (») to the left and right. When you press Tab, the chevrons move to the next group of check boxes or radio buttons. Input boxes and list boxes Input boxes let you type in text. Most basic text-editing keys work in the text box (for example, arrow keys, Home, End, and Ins). If you continue to type once you reach the end of the box, the contents automatically scroll. If there's more text than shows in the box, arrowheads appear at the end ( and ). You can click the arrowheads to scroll or drag the text. If you need to enter control characters (such as ^L or ^M) in the input box, then prefix the character with a ^P. So, for example, to enter ^M into the input box, hold down the Ctrl key and press PM. (This capability is useful for search strings.) If an input box has a down-arrow icon to its right, there is an associated history list. Click the icon to display the list. You'll find text you typed the last few times you used the input box. Press Enter to choose an item from this list. The Find box, for example, has such a history list, which keeps track of the text you searched for previously. Try choosing a previous search string. You can also edit an entry in the history list. Press Esc to exit from the history list without making a selection. A final component of many dialog boxes is a list box, which lets you scroll through and select from variable-length lists (often file names) without leaving a dialog box. If a blinking cursor appears in the list box and you know what you're looking for, you can type the word (or the first few letters of the word) and ToolDriver will search for it. You make a list box active by clicking it or by choosing the highlighted letter of the list title (or press Tab until it's highlighted). Once a list box is displayed, you can use the scroll box to move through the list or press the up and down arrows from the keyboard. SECTION 4: Menus and options reference ──────────────────────────────────────────────────────────────────────────── This section provides a reference to each ToolDriver menu option. It's arranged in the order that the menus appear on the screen. For information on starting and exiting ToolDriver, and general information on how the user interface works, see Section 1. Next to some of the menu option descriptions in this reference you'll see keyboard shortcuts, or hot keys. ≡ (System) menu Alt+Spacebar The ≡ menu appears on the far left of the menu bar. Alt+Spacebar is the fastest way to get there. When you pull down the menu (by using the down arrow) you see two commands, Register and Product Information. Register Choose ≡│Register to print a ToolDriver Registration form. A file print dialog will be presented, with the file REGISTER.DOC selected. Just press enter to print the registration form. 20 Product Information The ≡│Product Information menu command displays the version of ToolDriver you are running. The same information displays when you initially bring up ToolDriver. Put this information away by pressing enter. File menu Alt+F The file menu lets you open and view files in a file viewer window. It also lets you print files, change the working directory, shell to DOS and exit the ToolDriver environment. View F2 The File│View command displays a file-selection dialog box for you to select a text file to open in a file viewer window. Here is what the box looks like: Figure 2: View a File dialog box ╔══[■}═════════════════ View a File ═══════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░ *.* ░░░░░ Open ░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Files ░░░░░░░░░░░░░░░║ ║░░░ CRE8FSL.EXE │ FILEXREF.WSL ░░░░ Cancel ░░║ ║░░░ FILELIST.EXE │ FILEXREF.XRF ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.BAK │ HISTORY.DOC ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.EXE │ NAMEC.EXE ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.FEI │ NAMEC.FSL ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.FSL │ NAMEC.MSG ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.MSG │ NAMEC.SRL ░░░░░░░░░░░░░░░║ ║░░░»FILEXREF.PRN« │ \WORK ░░░░░░░░░░░░░░░║ ║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░C:\TOOLDRIV\*.* ║ ║░░░FILEXREF.PRN 133153 Jun 01,1993 09:15a ║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚══════════════════════════════════════════════════════╝ The dialog box contains an input box, a file list, buttons labeled, Open and Cancel, and an information panel that describes the selected file. Now you can do any of these actions: ■ Type in a full file name and choose Open. Open loads the file into a file viewer window. ■ Type in a file name with wildcards, which filters the file list to match your specifications. ■ Press to choose a file specification from a history list of file specifications you've entered earlier. ■ View the contents of different directories by selecting a directory name in the file list. The input box lets you enter a file name explicitly or enter a file name with standard DOS wildcards (* and ?) to filter the names appearing in the history list box. If you enter the entire name and press enter, ToolDriver opens it for viewing. 21 If you press when the cursor is blinking in the input box, a history list drops down below the box. This list displays the last 15 file names or file name masks you've entered. Choose a name from the list by double-clicking it or selecting it with the arrow keys and pressing Enter. Once you've typed in or selected the file you want, choose the Open button (choose Cancel if you change your mind). You can also just press Enter once the file is selected, or you can double-click the file name in the file list. Using the file list box The File list box displays all file names in the current directory that match the specifications in the input box, displays the parent directory, and displays all subdirectories. Click the list box or press Tab until the list box name is highlighted. You can now press or to select a filename and then press Enter to open it. You can also double-click any file name in the box to open it. You might have to scroll the box to see all the names. If you have more than one panel of names, you can also use the left and right arrows. The file information panel at the bottom of the View a file dialog box displays path name, file name, date, time and size of the file you've selected in the list box. As you scroll through the list box, the panel is updated for each file. Print The File│Print command displays a file-selection dialog box for you to select a text file to be printed. It looks and functions like the File│View command except that the output will be routed to your printer instead of a file viewer. Use this option to print the report file (FILEXREF.PRN) produced by the FileXref tool. Change Dir The File│Change Dir command lets you specify a drive and a directory to make current. The current directory is the one ToolDriver uses for viewing and printing files. Note that choices on the FileXref and NameChanger menus will always reset the current directory to the ToolDriver installation directory, where its control files reside. The Change Directory dialog box looks like is shown on the next page: 22 Figure 3: Change Directory dialog box ╔══[■}═══════════════ Change Directory ════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Directory Name ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░ C:\TOOLDRIV ░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Directory Tree ░░░░░░░░░░░░░░░║ ║░░░ Drives ░░░░ OK ░░║ ║░░░ C:\ ▓ ░░░░░░░░░░░░░░░║ ║░░░ └─TOOLDRIV ▓ ░░░░ Chdir ░░║ ║░░░ └─WORK ▓ ░░░░░░░░░░░░░░░║ ║░░░ ▓ ░░░░ Revert ░░║ ║░░░ ▓ ░░░░░░░░░░░░░░░║ ║░░░ ■ ░░░░░░░░░░░░░░░║ ║░░░ ░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚══════════════════════════════════════════════════════╝ There are two ways to change directories: ■ Type in the path of the new directory in the input box and press Enter ■ Choose the directory you want in the directory tree (if you're using the keyboard, press Enter to make it the current directory), then choose OK or press Esc. If you choose the OK button, your changes are made and the dialog box is closed. If you choose the Chdir button, the Directory Tree list box changes to the selected directory and displays the subdirectories of the currently highlighted directory (pressing Enter or double-clicking on that entry gives you the same result). If you change your mind about the directory you've picked and you want to go back to the previous one (and you've yet to exit the dialog box), choose the Revert button. Running commands under the FileXref and NameChanger menus automatically changes the directory to the ToolDriver installation directory where their program and help files reside. DOS Shell The File│DOS Shell command lets you temporarily exit ToolDriver to enter a DOS command or program. To return to ToolDriver, type EXIT and press Enter. Don't install any TSR programs (like SideKick) or print a file with the DOS print command while you've shelled to DOS, because memory may be misallocated. 23 Quit Alt+Q The File│Quit command exits ToolDriver and removes it from memory. If you have made any changes you haven't saved, ToolDriver asks if you want to save them before exiting. Edit menu Alt+E The Edit menu lets you cut, copy, and paste text in edit windows. You can also open a Clipboard window to view or edit its contents. This window is also used to edit the file extension control table. An edit window is only created by ToolDriver, to support the creation and modification of input files it requires. Edit (and Search) menu commands are disabled otherwise. File edit windows are presented in these cases: ■ when you choose the Edit│File Extensions option (This allows you to modify the list of rules for associating file extensions to the source language types they contain.) ■ after processing the FileXref│Generate dialog (This allows you to modify the list of files to be cross referenced.) ■ after choosing the FileXref│Edit command (This allows you to modify a list of words to be cross referenced.) (You do not need to list the names of any files here - they are automatically cross referenced.) ■ after processing the NameChanger│Generate dialog (This allows you to modify the list of files to be name-changed.) ■ after choosing the NameChanger│Edit command (This allows you to specify the names to be changed and what they are to be changed to.) (Names may be file names; variable names; i.e. any complete symbol) Before you can use most of the commands on the edit menu, you need to know about selecting text (because most editor actions apply to selected text). Selecting text means highlighting it. You can select text either with keyboard commands or with a mouse; the principle is the same even though the actions are different. From the keyboard ■ Press Shift while pressing any key that moves the cursor. Using a mouse ■ To select text with a mouse, drag the mouse pointer over the desired text. If you need to continue the selection past a window's edge, just drag off the side and the window automatically scrolls. 24 ■ To select a single word, double-click it. ■ To extend or reduce the selection, Shift-click anywhere in the document (that is, hold Shift and click). Once you've selected text, the Cut and Copy commands in the Edit menu become available. The Clipboard is the magic behind cutting and pasting. It's a special window that holds text you cut or copied, so you can paste it elsewhere. The Clipboard works in close concert with the commands in the Edit menu. The next few pages contain an explanation of each command in the Edit menu. File Extension The File Extension command brings up an edit box for you to define the source file extensions you use and the type of data they contain. The name of the file being edited is TOOLDRIV.EXT. It is a text file and may contain two types of records: 1. Comments begin with two dashes "--". 2. File attribute records contain four columns each. They associate a file extension with the type of file it is. All extensions in this list should point to text files. Unpredictable results will occur with non-text files. The data is freeform ( where one blank is allowed, you may use several). Column layout: ┌────────────────────────────────────────────────────────────┐ │ 1 2 3 4 │ ├───────────┬─────────────────────┬───────────────┬──────────┤ │ file │ f - fixed length │ maximum │ source │ │ extension │ v - variable length │ record length │ language │ └───────────┴─────────────────────┴───────────────┴──────────┘ Following are the defaults provided at install time: Note that COBOL, FORTRAN, and PL/I need to be fixed length with 80 character records. 25 Ext F/V Length Currently supported language codes (enter these exactly as shown) ─── ─── ──── ──────────── ASM v 255 assembler BAS v 255 basic BAT v 255 batchFile C v 255 c/c++ CBL v 255 cobol COB f 80 cobol CPP v 255 c/c++ DOC v 255 textFile FOR f 80 fortran H v 255 c/c++ HPP v 255 c/c++ INP v 255 OracleForms MAK v 255 textFile PAS v 255 pascal PLI f 80 PL/I PRG v 255 xBase REX v 255 OracleSQLReportWriter RPT v 255 OracleRPT SQL v 255 OracleSQLScript SQR v 255 SQLSolutionsSQR TXT v 255 textFile Change this file if you use other file extensions for the supported language codes (or to cross reference other languages using one of these parsers). So if you use Oracle's PRO*C (C code with embedded SQL) and use the file extension .PC to distinguish these special files, then add the following line. PC v 255 c/c++ Be sure to type the language code exactly as shown above. Cut Shift+Del The Edit│Cut command removes the selected text from your document and places the text in the Clipboard. You can then paste that text into any other document (or somewhere else in the same document) by choosing Paste. The text remains selected in the Clipboard so that you can paste the same text many times. Copy Ctrl+Ins The Edit│Copy command leaves the selected text intact but places an exact copy of it in the Clipboard. You can then paste that text into any other document by choosing Paste. Paste Shift+Ins The Edit│Paste command inserts from the Clipboard into the current edit window at the cursor position. The text that is pasted is the currently marked block in the Clipboard window. 26 Show Clipboard The Edit│Show Clipboard command opens the Clipboard window, which stores the text you cut and copy from other windows. The text that's currently selected (highlighted) is the text ToolDriver uses when you choose Paste. You can think of the Clipboard window as a history list of your cuts and copies. You can edit the Clipboard so that the text you paste is precisely the text you want. ToolDriver uses whatever text is selected in the Clipboard when you choose Paste. The Clipboard window is just like other edit windows; you can move it, resize it, and scroll and edit its contents. The only difference you'll find in the Clipboard window is when you choose to cut or copy text. When you select text in the Clipboard window and choose Cut or Copy, the selected text immediately appears at the bottom of the window. (Remember, any text you cut or copy is appended to the end of the Clipboard and highlighted - so you can paste it later. Search menu Alt+S The Search menu lets you search and replace text in edit windows. Find Ctrl+Q+F The Search│Find command displays the Find Text dialog box, which lets you type in the text you want to search for and set options that affect the search. Figure 4: The Find Text dialog box ╔══[■}════════════ Find Text ════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░» Text to Find ░ ░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Options ░░░░░░░░░░░░░░░░░░║ ║░░░ (X) Case Sensitive ░░░░░░░░░░░░░░░░░░║ ║░░░ ( ) Whole words only ░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚══════════════════════════════════════════════╝ The Find Text dialog box contains several buttons and check boxes: ┌────────────────────┐ Check the Case Sensitive box if │ (X) Case sensitive │ you do want ToolDriver to └────────────────────┘ differentiate uppercase from lowercase. 27 ┌──────────────────────┐ Check the Whole words Only box if │ ( ) Whole words only │ you want ToolDriver to search for └──────────────────────┘ whole words only. (that is, the string must have punctuation or space characters on both sides) Replace Ctrl+Q+A Following is the dialog for replacing text. Figure 5: The Replace Text dialog box ╔══[■}═════════ Replace Text ════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░» Text to Find ░ ░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░ New Text ░ ░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Options ░░░░░░░░░░░░░░░░░░║ ║░░░ (X) Case Sensitive ░░░░░░░░░░░░░░░░░░║ ║░░░ ( ) Whole words only ░░░░░░░░░░░░░░░░░░║ ║░░░ ( ) Prompt on replace ░░░░░░░░░░░░░░░░░░║ ║░░░ ( ) Replace all ░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚══════════════════════════════════════════════╝ The Replace Text dialog box contains several radio buttons and check boxes - many of which are identical to the Find Text dialog box, discussed previously. An additional checkbox, Prompt on Replace, controls whether you want to be prompted for each change. Enter the search string and the replacement string in the input boxes and choose OK to begin the search or Cancel to not do it. If you want to enter a string you used previously, press to show a history list to choose from. If ToolDriver finds the specified text and Prompt on Replace is on, it asks you if you want to make the replacement. If you choose OK, it will find and replace the first instance of the search item. Search Again Ctrl+L The Search│Search Again command repeats the last Find or Replace command. All settings you made in the last dialog box used (Find or Replace) remain in effect when you choose Search Again. 28 FileXref Menu Alt+X The FileXref menu item is the one to choose when you want to see how your text files relate to one another. This option is also used to find the global usage of words (data names, function names, table columns, language verbs, etc.) throughout your source and documentation files. Any text files may be cross referenced. The menu item is named FileXref since it uses the ConVal FILEXREF.EXE program to do the cross referencing. There are four supporting options on this menu: ■ Files to cross reference ■ Words to cross reference ■ Start cross referencing ■ View the output log A complete example of cross referencing will be provided, showing all inputs and outputs. Files to cross reference Choose this menu option to identify which files you want cross referenced. You can enter the list manually or have a ToolDriver utility do it for you. The dialog box you use looks like this: Figure 6: Files to cross reference ╔══[■}══ Files to be cross referenced ══════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░[X] Generate a file list for me ░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░ using the directory tree starting with: ░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░»C:\PROJECT1 ░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚════════════════════════════════════════════════╝ If you check the check box and enter a directory (as above), ToolDriver will prepare a file list for you, using the TOOLDRIV.EXT control file (see Page 25) where you defined the file extensions you use for source and documentation. The list of file names will be written to file FILEXREF.FSL, a file specification list. The list will include files in the directory entered and in its subdirectories and their subdirectories (the directory tree). To select from all files on a hard disk, say D, then enter D: as the starting point. Note: If you enter a file with an extension not listed in TOOLDRIV.EXT, then it will be handled by default as a "textFile" language code. 29 Check the check box and use the default directory of C:\TOOLDRIV to have a file specification list like the following generated by ToolDriver: ─────────────────────────────────────────────────── -- This is a file specification list for FILEXREF. C:\TOOLDRIV\README.DOC C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\PACKLIST.DOC C:\TOOLDRIV\REGISTER.DOC ─────────────────────────────────────────────────── This is the list of files used in the sample reports. There are two line types in the file specification list: 1. Comment lines contain "--" in the first two columns. 2. File specification lines contain one file specification surrounded by white space. The general syntax is: [drive:][path]filename.ext Press F3 to save your changes or F4 to close the window (this will cause a prompt to save). NOTE: The ToolDriver editor can handle files up to 64K. This will handle several thousand file names. If your application is larger than this, we assume you have an editor! Shell to DOS from ToolDriver, edit the list with that editor, and return to do the cross referencing. Words to cross reference This menu option allows you to identify additional words ( other than the file names defined above) to be cross referenced. You can list words to be included and words to be excluded. You can also specify where you want the searching to be case sensitive and where it doesn't matter. (The default for searching is case sensitive) What do we mean by "word"? We mean that which is inbetween white space. White space is here loosely defined to be those characters which are NOT used to form symbols in a source language. You will see a complete example below. You can also identify a set of words to be included where they share a common prefix. All of these are communicated to ToolDriver via a "word specification list" file named FILEXREF.WSL. This file contains three types of lines: 1. Comment lines have "--' in the first two columns. Comments may be placed anywhere in the file. 30 2. Option lines have "++" in the first two columns. Options are toggles. They may be placed anywhere. Four toggle options are supported: ■ CaseSensitive Be sensitive to case when searching for the words that follow. (this is the default) ■ CaseInsensitive Ignore the case when searching for the words that follow. ■ Include Include the following words in the search list. (This is the default) ■ Exclude Exclude the following words from the search list so that they do not appear on cross reference reports. Excluded items will automatically marked as case sensitive. The use of "*" is not supported for excluded words. 3. Word specification lines have a single word surrounded by white space. Note that word phrases are not cross referenced, just individual words. When you select the "Words to cross reference" option, ToolDriver will provide a file edit window for you to define your word cross referencing needs. The starter file provided with ToolDriver is shown below: ──────────────────────────────────────────────────────────────────────────── -- This is the word specification list used by the cross rererence -- utility. For more information, see the end of this file. ------------------------------------------------------------------ ++Include The "++" option lines toggle options. -- The next entry calls for cross referencing of all words starting -- with "re". Case sensitive compares for this type of entry is -- automatic. This "word prefix" format is not valid with the exclude -- --- option. re* ++CaseSensitive Visual window ++CaseInsensitive COLUMN_NAME HELP ++Exclude The following entries exclude the C language keywords. -- Change this list to those words you don't want cross -- referenced. Excluded names are automatically treated -- as case sensitive. -- _Packed auto break case char const continue default do 31 double else enum extern float for goto if int long register return short signed sizeof static struct switch typedef union unsigned void volatile while ──────────────────────────────────────────────────────────────────────────── The control file above directs the cross reference process to include all words starting with "re", and the specific words "Visual" and "window". These three searches are to be case sensitive. It also calls for cross referencing the words "COLUMN_NAME" and "HELP", regardless of case. Finally it provides a list of words is to be excluded. This will cause the words "register" and "return" to be excluded from the output. Start cross referencing Once you've set up the list of files to be examined and (optionally) the words to search for, select this menu item to initiate cross referencing. This is what the associated dialog looks like: Figure 7: The Cross reference files dialog ╔══[■}═════ Cross reference files ( and words) ══════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║ Type of output ░ Optional output ░░░║ ║░ (X) Extended reports ░░ [X] Cross reference words ░░░║ ║░ ( ) Condensed reports ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░ ( ) File Parts List ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░ ( ) Export file ░░░░» OK « ░░ Cancel░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░ Supress entries with SBC > 50 ░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚════════════════════════════════════════════════════════╝ 32 Four types of output are available. 1. The extended report format displays the full file specification (drive, path, file name and extension). This choice produces these reports ■ Extended File Cross Reference Report, ■ Extended Word Usage Report, and ■ List of Unreferenced Files to be written to file FILEXREF.PRN. 2. Condensed format produces reports with file names only, without the path or file extension. The following reports ■ Condensed File Cross Reference Report, ■ Condensed Word Usage Report, and ■ List of Unreferenced Files will be written to file FILEXREF.PRN. 3. The third style mimics a fully exploded bill of material list. With this option you may use the SBC input box to control the number of setback levels to list (the default is 50). Pressing enter creates a ■ File Parts List Report will be written to file FILEXREF.PRN. 4. Export file format provides a means for you to take the cross reference information and use it with other software (e.g. a database program). This option produces ■ cross reference and unreferenced file information in file FILEXREF.XRF. The information is stored in quote and comma delimited export format which is supported by many software products. To choose the optional word cross referencing, type "w" or press the space bar when the cursor is on "Cross reference words". When you do this, the word spaceification list will be used (see "Words to cross reference" Page 30). Otherwise it will be ignored for this cross referencing. Use File│Print to print file FILEXREF.PRN, the report file. Note: The reports require 132 print positions, so set your printer accordingly. Extended Reports The extended report style identifies each file with its full file specification. This is the default. The first report of the extended series 33 is show below. The center column lists all files in the file list in alphabetical order by filename. The left- hand column lists files containing one or more references to the center file's filename. The right- hand column shows filename references found in the center column's file. The first line shows usage and component information for HISTORY.DOC. The filename "HISTORY" was found in the PACKLIST.DOC file, but HISTORY.DOC did not contain references to any other of the selected files. (References to its own name are ignored.) The second line shows usage and compoonent information for PACKLIST.DOC. "PACKLIST" was not mentioned in any other files. But PACKLIST.DOC referenced all the other file names. This report can be used to see everywhere in your application that filenames are specifically referenced. For Oracle users this gives visability to the form (or forms) which invoke another form or a SQL script. For those using make files it identifies the make file(s) referencing each source program. The files (page 30) and words (page 31) in the four ToolDriver DOC files produce the following output: Figure 8: The Extended File Cross Reference Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:58:22 FileXref EXTENDED FILE CROSS REFERENCE REPORT Page 1 FILE SPECIFICATION - REFERS TO: FILE SPECIFICATION - REFERS TO: FILENAMES ------------------------------- ------------------------------- -------- C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\HISTORY.DOC - - C:\TOOLDRIV\PACKLIST.DOC - HISTORY - - README - - REGISTER C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\README.DOC - C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\REGISTER.DOC - ***End of report*** ─────────────────────────────────────────────────────────────────────────── 34 The second in the series of extended reports is the optional word usage report. The second line shows that the word "HELP" was found in the HISTORY, PACKLIST, and README DOC files. Note that the word Visual was not found in any file. Figure 9: The Extended Word Usage Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:58:22 FileXref EXTENDED WORD USAGE REPORT Page 1 WORD IS REFERENCED BY FILENAME(S): ------------------------------- ----------------------------- COLUMN_NAME C:\TOOLDRIV\HISTORY.DOC HELP C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\PACKLIST.DOC C:\TOOLDRIV\README.DOC Visual re* C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\PACKLIST.DOC C:\TOOLDRIV\README.DOC C:\TOOLDRIV\REGISTER.DOC reads C:\TOOLDRIV\HISTORY.DOC receive C:\TOOLDRIV\REGISTER.DOC record C:\TOOLDRIV\HISTORY.DOC records C:\TOOLDRIV\HISTORY.DOC reference C:\TOOLDRIV\README.DOC referenced C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\PACKLIST.DOC references C:\TOOLDRIV\HISTORY.DOC referencing C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\PACKLIST.DOC reflects C:\TOOLDRIV\HISTORY.DOC registered C:\TOOLDRIV\PACKLIST.DOC C:\TOOLDRIV\README.DOC C:\TOOLDRIV\REGISTER.DOC registration C:\TOOLDRIV\PACKLIST.DOC relationships C:\TOOLDRIV\REGISTER.DOC released C:\TOOLDRIV\HISTORY.DOC renaming C:\TOOLDRIV\HISTORY.DOC report C:\TOOLDRIV\HISTORY.DOC reports C:\TOOLDRIV\HISTORY.DOC C:\TOOLDRIV\README.DOC require C:\TOOLDRIV\HISTORY.DOC required C:\TOOLDRIV\README.DOC C:\TOOLDRIV\REGISTER.DOC requirements C:\TOOLDRIV\README.DOC C:\TOOLDRIV\REGISTER.DOC residents C:\TOOLDRIV\REGISTER.DOC returning C:\TOOLDRIV\HISTORY.DOC rexx C:\TOOLDRIV\HISTORY.DOC window C:\TOOLDRIV\README.DOC ***End of report*** ─────────────────────────────────────────────────────────────────────────── 35 The last in the series of extended reports is the list of unreferenced files. Although this information is also contained in the first report, if there are many pages of output the information may be difficult to extract. This report is very useful as it identifys the top level components of an application, components not yet integrated, and old obsolete files. In the example we're following, file PACKLIST.DOC is the only unreferenced file since it is a packing list containing the names of all the files. Figure 10: The Unreferenced Files Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:58:22 FileXref LIST OF UNREFERENCED FILES Page 1 FILENAME TYPE PATH -------- --- ------------------ PACKLIST DOC C:\TOOLDRIV\ ***End of report*** ─────────────────────────────────────────────────────────────────────────── Condensed Reports The condensed style of reports identify files by their filename alone, without the drive, path, and file extension. The information content is parallel to the extended series. Below is the first of the series of condensed reports. Again file names are listed in alphabetical order in the center column. To the left are the files that reference the center column filename and to the right are those that it references. Note that filename PACKLIST was not referenced by any other file and that it references the HISTORY, README and REGISTER files. Figure 11: The Condensed File Cross Reference Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:57:26 FileXref CONDENSED FILE CROSS REFERENCE REPORT Page 1 LIST OF REFERENCING FILES FILENAME LIST OF REFERENCED FILES ---------------------------- ======== ----------------------------- PACKLIST - HISTORY - - PACKLIST - HISTORY README REGISTER PACKLIST - README - PACKLIST - REGISTER - ***End of report*** ─────────────────────────────────────────────────────────────────────────── 36 Figure 12: The Condensed Word Usage Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:57:26 FileXref CONDENSED WORD USAGE REPORT Page 1 WORD IS REFERENCED BY FILENAME(S): ------------------------------- ----------------------------------------- COLUMN_NAME HISTORY HELP HISTORY PACKLIST README Visual re* HISTORY PACKLIST README REGISTER reads HISTORY receive REGISTER record HISTORY records HISTORY reference README referenced HISTORY PACKLIST references HISTORY referencing HISTORY PACKLIST reflects HISTORY registered PACKLIST README REGISTER registration PACKLIST relationships REGISTER released HISTORY renaming HISTORY report HISTORY reports HISTORY README require HISTORY required README REGISTER requirements README REGISTER residents REGISTER returning HISTORY rexx HISTORY window README ***End of report*** ─────────────────────────────────────────────────────────────────────────── The Unreferenced Files Report ─────────────────────────────────────────────────────────────────────────── 05/23/93 07:57:26 FileXref LIST OF UNREFERENCED FILES Page 1 FILENAME TYPE PATH -------- --- -------------------- PACKLIST DOC C:\TOOLDRIV\ ***End of report*** ─────────────────────────────────────────────────────────────────────────── File Parts List The file parts list report starts with each file which is an end item (is not referenced by any other). The complete tree of referenced files is represented by indenting, with setback codes for reference. Circular references (loops) are identified when found. When an item has been exploded earlier you will see the notation "Ref: 1234", where 1234 is the line where it was first exploded. Following is a sample: 37 Figure 13: The File Parts List Report ─────────────────────────────────────────────────────────────────────────── 06/09/93 11:18:03 FileXref Indented File Parts List Page 1 Ref# SBC Filename Type Path --- -------- ---- -------------------- 1 0 COLORSEL CPP D:\BORLANDC\TVISION\SOURCE\ 2 1 COLORSEL H D:\BORLANDC\TVISION\INCLUDE\ 3 1 GRP CPP D:\BORLANDC\TVISION\SOURCE\ 4 2 TGROUP CPP D:\BORLANDC\TVISION\SOURCE\ 5 3 GRP CPP D:\BORLANDC\TVISION\SOURCE\ Circular: 3 6 3 NEW CPP D:\BORLANDC\TVISION\SOURCE\ 7 4 TV H D:\BORLANDC\TVISION\INCLUDE\ 8 5 APP H D:\BORLANDC\TVISION\INCLUDE\ 9 5 BUFFERS H D:\BORLANDC\TVISION\INCLUDE\ 10 5 CONFIG H D:\BORLANDC\TVISION\INCLUDE\ 11 5 DIALOGS H D:\BORLANDC\TVISION\INCLUDE\ 12 5 DRAWBUF H D:\BORLANDC\TVISION\INCLUDE\ 13 5 EDITORS H D:\BORLANDC\TVISION\INCLUDE\ 14 5 MENUS H D:\BORLANDC\TVISION\INCLUDE\ 15 5 OBJECTS H D:\BORLANDC\TVISION\INCLUDE\ 16 5 RESOURCE H D:\BORLANDC\TVISION\INCLUDE\ 17 5 SYSTEM H D:\BORLANDC\TVISION\INCLUDE\ 18 5 TKEYS H D:\BORLANDC\TVISION\INCLUDE\ 19 5 TTYPES H D:\BORLANDC\TVISION\INCLUDE\ 20 5 TVOBJS H D:\BORLANDC\TVISION\INCLUDE\ 21 5 UTIL H D:\BORLANDC\TVISION\INCLUDE\ 22 5 VIEWS H D:\BORLANDC\TVISION\INCLUDE\ 23 3 TEVENT CPP D:\BORLANDC\TVISION\SOURCE\ 24 4 TMOUSE CPP D:\BORLANDC\TVISION\SOURCE\ 25 5 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 26 4 TSCREEN CPP D:\BORLANDC\TVISION\SOURCE\ 27 5 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 28 4 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 29 3 TPOINT CPP D:\BORLANDC\TVISION\SOURCE\ 30 4 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 31 3 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 32 3 TVIEW CPP D:\BORLANDC\TVISION\SOURCE\ 33 4 MAPCOLOR CPP D:\BORLANDC\TVISION\SOURCE\ 34 5 TV H D:\BORLANDC\TVISION\INCLUDE\ Ref: 7 35 5 TVIEW CPP D:\BORLANDC\TVISION\SOURCE\ Circular: 32 ─────────────────────────────────────────────────────────────────────────── Export files The quote and comma delimited export files (see Figure 14) are provided so you can import cross reference information into your software for custom processing and reporting. 37A Figure 14: The Export File ─────────────────────────────────────────────────────────────────────────── "COLUMN_NAME","C:\TOOLDRIV\HISTORY.DOC","0100110" "HELP","C:\TOOLDRIV\HISTORY.DOC","0100110" "HELP","C:\TOOLDRIV\PACKLIST.DOC","0100110" "HELP","C:\TOOLDRIV\README.DOC","0100110" "HISTORY","C:\TOOLDRIV\PACKLIST.DOC","1000110" "PACKLIST","","1000010" "README","C:\TOOLDRIV\PACKLIST.DOC","1000110" "REGISTER","C:\TOOLDRIV\PACKLIST.DOC","1000110" "Visual","","0100011" "re","C:\TOOLDRIV\HISTORY.DOC","0011111" "re","C:\TOOLDRIV\PACKLIST.DOC","0011111" "re","C:\TOOLDRIV\README.DOC","0011111" "re","C:\TOOLDRIV\REGISTER.DOC","0011111" "reads","C:\TOOLDRIV\HISTORY.DOC","0001111" "receive","C:\TOOLDRIV\REGISTER.DOC","0001111" "record","C:\TOOLDRIV\HISTORY.DOC","0001111" "records","C:\TOOLDRIV\HISTORY.DOC","0001111" "reference","C:\TOOLDRIV\README.DOC","0001111" "referenced","C:\TOOLDRIV\HISTORY.DOC","0001111" "referenced","C:\TOOLDRIV\PACKLIST.DOC","0001111" "references","C:\TOOLDRIV\HISTORY.DOC","0001111" "referencing","C:\TOOLDRIV\HISTORY.DOC","0001111" "referencing","C:\TOOLDRIV\PACKLIST.DOC","0001111" "reflects","C:\TOOLDRIV\HISTORY.DOC","0001111" "registered","C:\TOOLDRIV\PACKLIST.DOC","0001111" "registered","C:\TOOLDRIV\README.DOC","0001111" "registered","C:\TOOLDRIV\REGISTER.DOC","0001111" "registration","C:\TOOLDRIV\PACKLIST.DOC","0001111" "relationships","C:\TOOLDRIV\REGISTER.DOC","0001111" "released","C:\TOOLDRIV\HISTORY.DOC","0001111" "renaming","C:\TOOLDRIV\HISTORY.DOC","0001111" "report","C:\TOOLDRIV\HISTORY.DOC","0001111" "reports","C:\TOOLDRIV\HISTORY.DOC","0001111" "reports","C:\TOOLDRIV\README.DOC","0001111" "require","C:\TOOLDRIV\HISTORY.DOC","0001111" "required","C:\TOOLDRIV\README.DOC","0001111" "required","C:\TOOLDRIV\REGISTER.DOC","0001111" "requirements","C:\TOOLDRIV\README.DOC","0001111" "requirements","C:\TOOLDRIV\REGISTER.DOC","0001111" "residents","C:\TOOLDRIV\REGISTER.DOC","0001111" "returning","C:\TOOLDRIV\HISTORY.DOC","0001111" "rexx","C:\TOOLDRIV\HISTORY.DOC","0001111" "window","C:\TOOLDRIV\README.DOC","0100111" ─────────────────────────────────────────────────────────────────────────── File FILEXREF.XRF is used for the cross reference export data. Each line has three columns: 1. A symbol 2. The referencing file's specification ( or null if no files reference the symbol). 3. A seven character flag column. Each position is either 0 (false) or 1 (true). The meanings of each column are shown in Table 7: 38 Table 7: Export file flags ─────────────────────────────────────────────── 1234567 ------- The symbol in the first column is: 1...... a filename. .1..... a whole word. ..1.... a word prefix. ...1... an expansion of a word prefix. ....1.. The symbol was referenced. .....1. The symbol was marked for inclusion. ......1 The search needs to be case sensitive. ─────────────────────────────────────────────── View the output log This command gives you a file viewer window to browse the messages about the cross referencing. These document the scope of the run (files and words specified, options, and record counts). You can use File│Print to get a hardcopy of this output. It is stored in FILEXREF.MSG. The output for the sample we're following is: ─────────────────────────────────────────────────────────────────────────── FileXref - Cross Reference Utility Version 2.02 Copyright 1990-1993 ConVal Software, Inc. All rights reserved. 05/23/93 08:00:43 Message File opened as FILEXREF.MSG. File Specification List opened as FILEXREF.FSL. Word Specification List opened as FILEXREF.WSL Cross reference file opened as FILEXREF.XRF. Report file opened as FILEXREF.PRN. Processing Option is /PRNE. (The default for items below is Include and CaseSensitive) Items in the word specification list: COLUMN_NAME CaseInsensitive HELP CaseInsensitive Visual _Packed Exclude auto Exclude break Exclude case Exclude char Exclude const Exclude continue default do double 39 else enum extern Exclude float Exclude for Exclude goto Exclude if Exclude int Exclude long Exclude re* register Exclude return Exclude short Exclude signed Exclude sizeof Exclude static Exclude struct Exclude switch Exclude typedef Exclude union Exclude unsigned Exclude void Exclude volatile Exclude while Exclude window Examining D:\TOOLDRIV\HISTORY.DOC Examining D:\TOOLDRIV\PACKLIST.DOC Examining D:\TOOLDRIV\README.DOC Examining D:\TOOLDRIV\REGISTER.DOC RECORD COUNTS File Specification List records READ: 25 Word Specification List records READ: 74 Characters READ from the input files: 14,626 Cross Reference Records written: 0 Report Records written: 67 Message records written: 69 05/23/93 08:00:47 ─────────────────────────────────────────────────────────────────────────── NameChanger menu Alt+N Use the NameChanger menu whenever you want to go back and make your naming conventions consistent across your application(s). You might decide to do this after each revision level is complete to keep order. And, now that you have such a tool, you may want to go back to some older code you're still maintaining and clean it up too. 40 You will also want to use the NameChanger menu when you have successful code on one platform and want to port it to another. Download non-DOS code to your PC, do the renaming, and recompile on DOS. Or, do renaming, upload to a non-DOS platform and recompile there. This command invokes a DOS program - NAMEC.EXE. This may be executed outside of the ToolDriver environment. Files to process This is where you identify the files to be processed by NameChanger. The dialog box follows: Figure 15: NameChanger Files dialog ╔══[■}══ Files with names to be changed ════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░[X] Generate a file list for me ░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░ using the directory: ░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░»C:\PROJECT1 ░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚════════════════════════════════════════════════╝ If you check the check box and enter a directory (as above) or drive (like C:), then a list will be prepared for you. It will be written to file NAMEC.FSL (File Specification List). The list will include only those files in the directory entered. In any case you will be presented with an edit window for this file. So the content of the file edit window will be what was just generated if you checked the check box, or it will be as delivered on the installation disk, or as most recently edited by you. We will trace a specific NameChanger request using the following files (from the ToolDriver distibution disk): ─────────────────────────────────────────────────────── -- This data defines the list of files to be processed. D:\TOOLDRIV\README.DOC D:\TOOLDRIV\HISTORY.DOC D:\TOOLDRIV\PACKLIST.DOC D:\TOOLDRIV\REGISTER.DOC ─────────────────────────────────────────────────────── There are two types of lines in the NameChanger file specification list: 1. A comment line contains "--" in the first two columns. 2. A file specification line contains one file spec surrounded by white space. The general syntax is: [drive:][path]filename.ext 41 Press F3 to save your changes or F4 to close the window (this will cause a prompt to save). NOTE: The editor can handle files up to 64K. This will handle several thousand file names. If your application is larger than this we assume you have an editor! Drop out of ToolDriver, edit the list with that editor, and return to ToolDriver to change names. Names to be changed When you want to define the names to be changed, choose this menu option. A file editor window will be displayed so you can add one line for each name change. ───────────────────────────────────────────────────────────────── -- This is a symbol rename list used by ToolDriver's NameChanger -- utility. ++CaseInsensitive EMP_NM Employee_Name ++CaseSensitive QOH QuantityOnHand ───────────────────────────────────────────────────────────────── This file contains three types of lines: 1. A comment line has "--' in the first two columns. 2. An option line has "++' in the first two columns followed immediately by one of these options: ■ CaseSensitive - start case sensitivity ■ CaseInsensitive - start ignoring case 3. A symbol remapping line has two symbols surrounded by white space. The first symbol will be replaced by the second one. Note that NameChanger just transforms individual symbols, not partial symbols or multiple symbols. The controls above tell NameChanger to transform the complete symbol "EMP_NM" to "EMPLOYEE_NM" everywhere it's found, independently of the case used. The chart below shows the effect: ────────────────────────────────────── Old Symbol New Symbol emp_nm EMPLOYEE_NAME Emp_nm EMPLOYEE_NAME EMP_NM EMPLOYEE_NAME EMP_NM2 --- no change --- P_emp_nm_2 --- no change --- ────────────────────────────────────── 42 It also specifies that the complete symbol "QOH" is to be changed to "QuantityOnHand", but only where the case matches exactly. The following shows what this does: ────────────────────────────────────── Old Symbol New Symbol qoh --- no change --- QOH QuantityOnHand aqohb --- no change --- ────────────────────────────────────── Start name changing After you've defined the files and names to be changed, select the "Start name changing" dialog. It looks like this: Figure 16: The Change names dialog ╔══[■}═══════════════ Change names ══════════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║ NOTE: Output files will be written to this ░░░░░░░░░░░║ ║░ directory: ░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░ C:\TOOLDRIV\WORK ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░[ ] Delete prior output░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░ » OK « ░░ Cancel ░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚════════════════════════════════════════════════════════╝ Whenever you do name changing, the output files will be written to a ToolDriver's subdirectory named WORK. This is the WORK directory's only purpose. Your files will never be rewritten in place! If you are rerunning a name changing task, no work will be performed if any output file already exists on the ToolDriver WORK subdirectory. To delete ALL files in the working directory, check the checkbox. As a final precaution, you will be asked to confirm the deletion, when the process starts. This is a reminder to move our prior output to a permanent home in another directory before renaming other projects. When the changing of names is complete, you will be presented with a file viewer window to browse a log of the renaming activity. This file is NAMEC.MSG. 43 Its output for the file list and symbol rename list above are: ──────────────────────────────────────────────────────────────────────────── NameChanger - Symbol Renaming Utility Version 2.02 Copyright 1991-1993 ConVal Software, Inc. All rights reserved. 05/28/93 20:07:36 Invoked with OUTDIR=D:\TOOLDRIV\WORK Message File opened as NAMEC.MSG. File Specification List opened as NAMEC.FSL. Symbol Rename List opened as NAMEC.SRL. (The default for items is CaseSensitive) Items in the Symbol Rename List: EMP_NM Employee_Name CaseInsensitive QOH QuantityOnHand Processing D:\TOOLDRIV\HISTORY.DOC Processing D:\TOOLDRIV\PACKLIST.DOC Processing D:\TOOLDRIV\README.DOC Processing D:\TOOLDRIV\REGISTER.DOC Symbol QOH was not found in any input file. File D:\TOOLDRIV\HISTORY.DOC : The output file was modified as requested. File D:\TOOLDRIV\PACKLIST.DOC : This file contained no symbols for renaming. The output file for it is identical. File D:\TOOLDRIV\README.DOC : This file contained no symbols for renaming. The output file for it is identical. File D:\TOOLDRIV\REGISTER.DOC : This file contained no symbols for renaming. The output file for it is identical. RECORD COUNTS File Specification List records READ: 25 Symbol Rename List records READ: 43 Characters READ from the input files: 14,772 Characters WRITTEN to output files: 14,779 Message records WRITTEN: 41 05/28/93 20:07:42 ──────────────────────────────────────────────────────────────────────────── Note that only the HISTORY.DOC file had changes made. Also note that the symbol QOH was not found in any file. View the output files Select this option to inspect the results of your name changing. The following dialog lets you select a file on the ToolDriver working directory (where NameChanger places its output). 44 Figure 17: View the name-changed files dialog box ╔══[■}═════════════════ View a File ═══════════════════╗ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░ *.* ░░░░░ Open ░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░ Files ░░░░░░░░░░░░░░░║ ║░░░ FILEXREF.PRN │ TST01.C ░░░░ Cancel ░░║ ║░░░ FILEXREF.DOC │ TST02.CPP ░░░░░░░░░░░░░░░║ ║░░░ HISTORY.DOC │ TST03.H ░░░░░░░░░░░░░░░║ ║░░░ NAMECHNG.DOC │ TST04.PAS ░░░░░░░░░░░░░░░║ ║░░░ PACKLIST.DOC │ ..\ ░░░░░░░░░░░░░░░║ ║░░░ REGISTER.DOC │ ░░░░░░░░░░░░░░░║ ║░░░ TOOLDRIV.DOC │ ░░░░░░░░░░░░░░░║ ║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ░░░░░░░░░░░░░░░║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ║░░░C:\TOOLDRIV\WORK\*.* ║ ║░░░FILEXREF.PRN 88722 May 18,1993 08:25a ║ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ ╚══════════════════════════════════════════════════════╝ See the "View a file" dialog description on page 21 for a review of using this dialog. Window menu Alt+W The Window menu contains window-management commands. Most of the windows you open from this menu have all the standard window elements like scroll bars, a close box, and zoom boxes. Refer to page 15 for information on these elements and how to use them. Size/Move Ctrl+F5 Choose Window│Size/Move to change the size or position of the active window. When you choose this command, the active window moves in response to the arrow keys. When the window is where you want, press Enter. You can also move a window by dragging its title bar. If you press shift while you use the arrow keys, you can change the size of the window. When it's the size you want, press enter. If a window has a resize corner, you can drag that corner or any other corner to resize it. Zoom F5 Choose Window│Zoom to resize the active window to the maximum size. If the window is already zoomed, you can choose this command again to restore it to its previous size. You can also double-click anywhere on the top line (except where an icon appears) of a window to zoom or unzoom it. Tile Choose Window│Tile to arrange all your open windows like tiles on the screen. 45 Cascade Choose Window│Cascade to stack all open windows so the top of each (with its window number) shows. Next F6 Choose Window│Next to make the next window active and visible. Previous Shift+F6 Choose Window│Previous to make the prior window active and visible. Close F4 To close the current window, press F4. Help menu Alt+H The help menu gives you access to online help in a special window. There is help information on virtually all aspects of the ToolDriver environment. To open a Help window, do one of these actions: ■ Press F1 at any time (including from any dialog box or when any menu command is selected). ■ Click Help on the status line. To close the Help window, press Esc, click the close box, or choose Window│Close. You can keep the Help window onscreen while you work in another window unless you pressed F1. Help screens often contain keywords (highlighted text) that you can choose to get more information. Press Tab to move to any keyword; press Enter to get more detailed help. (As an alternative, move the cursor to the highlighted keyword and press Enter.) With a mouse, you can double-click any keyword to open the Help text for that item. When you're in a detailed help screen (you got there from another help screen by selecting a keyword) and you want to go back to the previous help, press Alt+F1. By doing this repeatedly you can back-track to the original help screen where you selected the first keyword. Contents The Help│Contents command opens the Help window with the main table of contents displayed. From this window, you can branch to any other part of the help system. You can get help on Help by pressing F1 when the Help window is active. You can also reach this screen by clicking Help on the status line. Index The Help│Index command displays a full list of Help keywords (the special highlighted text in Help screens that let you quickly move to a related screen). These are arranged in alphabetical order. Tab to the item you want and press Enter, or Tab to the "next page" keyword and press Enter to see the next page of keywords. Use Alt+F1 to get back to the previous help screen. 46 INDEX ──────────────────────────────────────────────────────────────────────────── Edit menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 File export data, choosing . . . . . . . . . . . . . . . . . . . . . . . . 32 export data, sample . . . . . . . . . . . . . . . . . . . . . . . . . 38 extension list, editing . . . . . . . . . . . . . . . . . . . . . . . 25 list of files to cross reference, editing . . . . . . . . . . . . . . 29 list of files to name change, editing . . . . . . . . . . . . . . . . 41 list of names to change, editing. . . . . . . . . . . . . . . . . . . 42 list of words to cross reference, editing . . . . . . . . . . . . . . 30 menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 ToolDriver packing list . . . . . . . . . . . . . . . . . . . . . . . . . 39 FileXref menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Help.menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Hot keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Log of.cross referencing activity . . . . . . . . . . . . . . . . . . . . 39 of.name changing activity . . . . . . . . . . . . . . . . . . . . . . 44 NameChanger menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Report printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 sample, Condensed File Cross Reference. . . . . . . . . . . . . . . . 36 sample, Condensed Word Usage. . . . . . . . . . . . . . . . . . . . . 37 sample, Extended File Cross Reference . . . . . . . . . . . . . . . . 34 sample, Extended Word Usage . . . . . . . . . . . . . . . . . . . . . 35 sample, File Parts List . . . . . . . . . . . . . . . . . . . . . . . 37A sample, Unreferenced Files. . . . . . . . . . . . . . . . . . . . 36, 37 selecting the type of . . . . . . . . . . . . . . . . . . . . . . . . 32 Search menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Window menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 ──────────────────────── End of User Guide for ToolDriver ──────────────────────── 47