Slick EDIT V3.3 User Manual

SlickEdit®Core v3.3

for Eclipse

™

Code Quick | Think Slick

SlickEdit® Core v3.3 for Eclipse™

Information in this documentation is subject to change without notice and does not represent a commitment on the part of SlickEdit Inc. The software described in this document is protected by U.S. and international copyright laws and by other applicable laws, and may be used or copied only in accordance with the terms of the license or nondisclosure agreement that accompanies the software. It is against the law to copy the software on any medium except as specifically allowed in the license or nondisclosure agreement. The licensee may make one copy of the software for backup purposes. No part of this documentation may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the licensee's personal use, without the express written permission of SlickEdit Inc.

SlickEdit, Visual SlickEdit, Clipboard Inheritance, DIFFzilla, SmartPaste, Context Tagging, Slick-C, and Code Quick | Think Slick are registered trademarks of SlickEdit Inc. All other products or company names are used for identification purposes only and may be trademarks of their respective owners. Protected by U.S. Patent 5,710,926.

1. Introduction ................................................................................................................... 1

Getting the Most Out of SlickEdit® Core ....................................................................................2

Cool Features ....................................................................................................................2

Write More Code, Faster ...................................................................................................2

Get Started ........................................................................................................................3

Documentation and Conventions ..............................................................................................4

Accessing Documentation ................................................................................................4

Documentation Conventions .............................................................................................4

Supported Languages and Environments .................................................................................6

Supported Languages and File Types ..............................................................................6

Supported Editor Emulations ............................................................................................9

Install/Uninstall .........................................................................................................................10

System Requirements .....................................................................................................10

Installing SlickEdit® Core ................................................................................................10

Licensing .........................................................................................................................11

Uninstalling SlickEdit® Core ............................................................................................13

Help and Product Support .......................................................................................................14

Using the Help System ...................................................................................................14

Product Support ..............................................................................................................14

2. Quick Start ................................................................................................................... 15

General Options .......................................................................................................................16

Extension-Specific Options ......................................................................................................17

3. User Interface .............................................................................................................. 19

Screen Layout ..........................................................................................................................20

The Workbench ...............................................................................................................20

The Workspace ...............................................................................................................21

Perspectives ....................................................................................................................21

The SlickEdit® Core Editor ..............................................................................................21

Switching Between the SlickEdit® Core Editor and Eclipse Editors ................................23

Menus .............................................................................................................................24

Views ...............................................................................................................................25

Status Area .....................................................................................................................25

Dialogs ............................................................................................................................25

Command Line ................................................................................................................26

SlickEdit Views ........................................................................................................................27

Opening SlickEdit Core Views ........................................................................................27

Available SlickEdit® Core Views .....................................................................................27

The SlickEdit® Core Command Line .......................................................................................30

Activating the Command Line .........................................................................................30

Command Line History ...................................................................................................31

Command Line Completions ...........................................................................................31

Using Shortcuts Inside the Command Line .....................................................................31

SlickEdit® Core v3.3 for Eclipse™

Using the Command Line to View Key Binding Associations .........................................31

Starting a Program from the Command Line (Shelling) ..................................................32

Command Line Prompting ..............................................................................................32

Common SlickEdit® Core Commands ............................................................................33

Using the Mouse and Keyboard ..............................................................................................35

Key Shortcuts in Text Boxes ...........................................................................................35

Redefining Common Keys ..............................................................................................37

4. User Preferences ......................................................................................................... 39

Introduction to User Preferences .............................................................................................40

Global Preferences .........................................................................................................40

Extension-Specific Preferences ......................................................................................40

Emulations ...............................................................................................................................41

Supported Emulations .....................................................................................................41

Changing Emulations ......................................................................................................42

Determining Keys/Functions ...........................................................................................43

Key and Mouse Bindings .........................................................................................................44

What is a Binding? ..........................................................................................................44

Managing Bindings .........................................................................................................45

Key Binding Settings .......................................................................................................50

Cursor, Mouse, and Scroll Settings .........................................................................................52

Setting the Cursor Style ..................................................................................................52

Hiding the Mouse Pointer ................................................................................................52

Displaying Tool Tips ........................................................................................................52

Scroll Style Settings ........................................................................................................52

Setting Fonts and Colors .........................................................................................................53

Fonts ...............................................................................................................................53

Colors ..............................................................................................................................55

Setting Colors for Screen Elements ................................................................................56

Restoring Settings on Startup ..................................................................................................59

5. Context Tagging® ........................................................................................................ 61

Context Tagging® Overview ....................................................................................................62

Tag-Driven Navigation ....................................................................................................62

List Members ...................................................................................................................62

Parameter Information ....................................................................................................63

Auto List Compatible Parameters ...................................................................................64

Completions ....................................................................................................................65

Symbol Browsing ............................................................................................................65

Statement Level Tagging ................................................................................................66

Building and Managing Tag Files ............................................................................................67

Building Tag Files ............................................................................................................67

Managing Tag Files ........................................................................................................70

Context Tagging® Options ..............................................................................................73

6. Editing Features .......................................................................................................... 75

Navigation ................................................................................................................................76

Code Navigation .............................................................................................................76

Cursor Navigation ...........................................................................................................79

Symbol Browsing .....................................................................................................................81

SlickEdit® Core v3.3 for Eclipse™

Class View ......................................................................................................................82

Outline View ....................................................................................................................86

Find Symbol View ...........................................................................................................88

Preview View ...................................................................................................................89

References View .............................................................................................................91

Symbols View ..................................................................................................................93

Symbol Properties View ................................................................................................101

Code Templates ....................................................................................................................103

Instantiating a Template ................................................................................................103

Creating Templates .......................................................................................................105

Substitution Parameters ................................................................................................106

Organizing Templates ...................................................................................................108

Template Manager Operations .....................................................................................109

Template Manager Dialog .............................................................................................110

Template Options Dialog ..............................................................................................111

Add File Dialog ..............................................................................................................111

Add Parameter Dialog ...................................................................................................111

Add New Item Dialog ....................................................................................................112

Locating Templates .......................................................................................................113

Manually Creating a Template ......................................................................................113

Code Template Metadata File Reference .....................................................................116

Text Editing ............................................................................................................................126

Selections ......................................................................................................................126

Cutting, Copying, and Moving Text ...............................................................................134

Working with Lines ........................................................................................................135

Sorting Text ...................................................................................................................136

Inserting Literal Characters ...........................................................................................138

Color Coding ..........................................................................................................................139

Resetting Modified Lines on Save ................................................................................139

Adding Color-Coded Keywords to Supported Languages ............................................139

Creating Color Coding for a New Language .................................................................140

Color Coding Configuration ...........................................................................................140

Color Coding Settings ...................................................................................................142

Syntax Indent and SmartPaste® ............................................................................................143

Syntax Indent ................................................................................................................143

SmartPaste® .................................................................................................................144

Completions ...........................................................................................................................146

Auto-Complete ..............................................................................................................146

Word Completion ..........................................................................................................148

Configuring Completion Settings ..................................................................................148

Aliases ...................................................................................................................................150

Directory Aliases ...........................................................................................................150

Extension-Specific Aliases ............................................................................................152

Syntax Expansion ..................................................................................................................159

Syntax Expansion Settings ...........................................................................................159

Modifying Syntax Expansion Templates .......................................................................160

Adding Syntax Expansion for Other Languages ...........................................................160

Dynamic Surround and Surround With ..................................................................................162

Dynamic Surround ........................................................................................................162

vii

SlickEdit® Core v3.3 for Eclipse™

Surround With ...............................................................................................................166

Unsurround ...................................................................................................................170

Bookmarks .............................................................................................................................172

Named Bookmarks .......................................................................................................172

Pushed Bookmarks .......................................................................................................174

Setting Bookmark Options ............................................................................................174

Setting Breakpoints ................................................................................................................176

Setting Conditional Breakpoints ....................................................................................176

Setting Java Exception Breakpoints .............................................................................176

Commenting ..........................................................................................................................177

Commenting Blocks and Lines .....................................................................................177

Creating Doc Comments ...............................................................................................178

String Editing .................................................................................................................180

Comment Wrapping ......................................................................................................180

Find and Replace ...................................................................................................................182

Quick Search and Replace ...........................................................................................182

Incremental Searching ..................................................................................................182

Find and Replace Commands ......................................................................................184

Find and Replace View .................................................................................................190

Find Symbol View .........................................................................................................192

Find and Replace with Regular Expressions ................................................................192

Undoing/Redoing Replacements ..................................................................................196

Beautifying Code ...................................................................................................................197

Code Beautifiers ............................................................................................................197

Reflowing Text ..............................................................................................................197

Refactoring ............................................................................................................................198

Quick Refactoring .........................................................................................................198

C++ Refactoring ............................................................................................................200

Reviewing Refactoring Changes ...................................................................................220

Java Refactoring ...........................................................................................................221

Viewing and Displaying ..........................................................................................................223

Hexadecimal View and Edit Mode ................................................................................223

Viewing Special Characters ..........................................................................................223

Selective Display ...........................................................................................................224

Other Display Options ...................................................................................................227

7. Language-Specific Editing ....................................................................................... 229

Language-Specific Editing Overview .....................................................................................230

Language Editing Modes ..............................................................................................230

Extension Options .........................................................................................................231

C and C++ .............................................................................................................................233

C/C++ Formatting Options ............................................................................................233

C/C++ Beautifier ............................................................................................................237

C/C++ Compiler Settings ..............................................................................................244

C/C++ Preprocessing ....................................................................................................245

Java .......................................................................................................................................248

Java Formatting Options ...............................................................................................248

Java Beautifier ..............................................................................................................251

Javadoc Beautifier ........................................................................................................251

viii

SlickEdit® Core v3.3 for Eclipse™

Javadoc Editor ..............................................................................................................252

Organizing Java Imports ...............................................................................................252

Java Refactoring ...........................................................................................................253

XML and HTML ......................................................................................................................254

XML ...............................................................................................................................254

HTML ............................................................................................................................266

XML/HTML Formatting ..........................................................................................................279

Enabling/Disabling XML/HTML Formatting ...................................................................279

Working with Schemes .................................................................................................281

Working with Tags .........................................................................................................284

Formatting Settings .......................................................................................................285

Ada ........................................................................................................................................292

Ada Formatting Options ................................................................................................292

Ada Beautifier ................................................................................................................292

COBOL ..................................................................................................................................299

COBOL Formatting Options ..........................................................................................299

Pascal ....................................................................................................................................301

Pascal Formatting Options ............................................................................................301

PL/I ........................................................................................................................................303

PL/I Formatting Options ................................................................................................303

Python ....................................................................................................................................305

Begin/End Structure Matching for Python .....................................................................305

8. Tools and Utilities ..................................................................................................... 307

Comparing and Merging ........................................................................................................308

DIFFzilla® ......................................................................................................................308

3-Way Merge .................................................................................................................314

File History and Backups .......................................................................................................317

Compare Two Backup History Elements Using DIFFzilla .............................................317

Compare a Local Backup History Element with the Current Version Using DIFFzilla ..317

FTP ........................................................................................................................................318

Working with FTP ..........................................................................................................318

Setting FTP Options ......................................................................................................320

The Regex Evaluator .............................................................................................................321

Using the Regex Evaluator ...........................................................................................321

Using the Calculator and Math Commands ...........................................................................323

The Calculator ...............................................................................................................323

Math Commands ...........................................................................................................324

OS File Browser .....................................................................................................................327

9. Macros and Macro Programming ............................................................................ 329

Recorded Macros ..................................................................................................................330

Recorded Macro Operations .........................................................................................330

Using Macros to Discover and Control Options ............................................................335

Programmable Macros ..........................................................................................................336

Loading Macros ............................................................................................................336

Setting Macro Variables ................................................................................................336

10. SlickEdit Core Dialogs ............................................................................................ 339

Editing Dialogs .......................................................................................................................339

SlickEdit® Core v3.3 for Eclipse™

Select Text to Paste Dialog ...........................................................................................340

Enumerate Dialog .........................................................................................................340

Filter Selection: Command Dialog ................................................................................341

Search Dialogs ......................................................................................................................343

Find and Replace View .................................................................................................343

Find Symbol View .........................................................................................................354

Go to Definition Dialog ..................................................................................................357

Dialogs Related to Viewing and Displaying ...........................................................................358

Selective Display Dialog ...............................................................................................358

Macro Dialogs ........................................................................................................................361

Save Macro Dialog ........................................................................................................361

List Macros Dialog ........................................................................................................361

Variable Editor Dialog ...................................................................................................362

Grid Settings Dialog ......................................................................................................364

Menu Editor Dialog .......................................................................................................364

Auto Enable Properties Dialog ......................................................................................366

Tools Dialogs .........................................................................................................................369

Organize Imports Options Dialog ..................................................................................369

3-Way Merge Dialog .....................................................................................................370

DIFFzilla® Dialog ...........................................................................................................372

Multi-File Diff Output Dialog ..........................................................................................377

Context Tagging® - Tag Files Dialog ............................................................................378

Options Dialogs .....................................................................................................................380

General Options Dialog .................................................................................................380

Extension Options Dialog ..............................................................................................398

Select a Tag Dialog .......................................................................................................420

File Options Dialog ........................................................................................................421

Key Bindings Dialog ......................................................................................................429

Bind Key Dialog .............................................................................................................432

Redefine Common Keys Dialog ....................................................................................433

Context Tagging® Options Dialog .................................................................................436

Color Coding Setup Dialog ...........................................................................................439

Color Settings Dialog ....................................................................................................453

Font Configuration Dialog .............................................................................................454

XML/HTML Formatting Dialog ......................................................................................456

URL Mappings Dialog ...................................................................................................457

Proxy Settings Dialog ....................................................................................................458

Network Options Dialog ................................................................................................459

Web Browser Setup Dialog ...........................................................................................459

FTP Options Dialog .......................................................................................................461

Reflow Comment Dialog ...............................................................................................466

Current Document Options Dialog ................................................................................467

11. Appendix .................................................................................................................. 469

Encoding ................................................................................................................................470

Using Unicode ...............................................................................................................470

Environment Variables ...........................................................................................................475

Setting Environment Variables in vslick.ini ...................................................................477

Using the set Command ...............................................................................................477

SlickEdit® Core v3.3 for Eclipse™

Configuration Variables .........................................................................................................479

Viewing Configuration Variables ...................................................................................479

Setting/Changing Configuration Variables ....................................................................479

Table of Configuration Variables ...................................................................................479

Directories and Files ..............................................................................................................484

Configuration Directory .................................................................................................484

System Configuration Files ...........................................................................................487

File Search Order ..................................................................................................................489

Search Order for Configuration Files ............................................................................489

Search Order for Executable Files ................................................................................489

VLX File and Color Coding ....................................................................................................490

Modifying the VLX File to Change a Color Definition ....................................................491

Creating a Lexer Name and a New VLX File ................................................................491

Editing the Key Binding Source .............................................................................................498

Menu Editing ..........................................................................................................................499

Creating and Editing Menus ..........................................................................................499

Using the ISPF and XEDIT Emulations .................................................................................501

ISPF Options Dialog .....................................................................................................501

ISPF Primary Commands .............................................................................................503

ISPF Line Commands ...................................................................................................505

Regular Expression Syntax ...................................................................................................520

UNIX Regular Expressions ...........................................................................................520

SlickEdit® Regular Expressions ....................................................................................526

Brief Regular Expressions ............................................................................................531

Unicode Category Specifications for Regular Expressions ...........................................537

Unicode Character Blocks for Regular Expressions .....................................................539

xii

List of Figures

1.1. Embedded Languages in HTML ..................................................................................................8

1.2. HTML Embedded in Perl .............................................................................................................9

3.1. The Workbench .........................................................................................................................20

3.2. Managing File Associations .......................................................................................................21

3.3. Opening Source Files with SlickEdit Core .................................................................................23

3.4. Status Area ................................................................................................................................25

3.5. Redefine Common Keys Dialog ................................................................................................37

4.1. Emulation Options .....................................................................................................................42

4.2. Emulation Prompt ......................................................................................................................42

4.3. Key Bindings Dialog ..................................................................................................................45

4.4. Bind Key Dialog .........................................................................................................................48

4.5. Font Configuration Dialog ..........................................................................................................53

4.6. Color Settings Dialog .................................................................................................................56

5.1. List Members: Example 1 ..........................................................................................................63

5.2. List Members: Example 2 ..........................................................................................................63

5.3. Parameter Info: Example 1 ........................................................................................................64

5.4. Parameter Info: Example 1 ........................................................................................................64

5.5. Auto List Compatible Parameters ..............................................................................................65

5.6. Automatic Tagging Dialog .........................................................................................................67

5.7. Add Tag File Dialog ...................................................................................................................68

5.8. Add Tags Database Dialog .......................................................................................................69

5.9. Context Tagging® - Tag Files Dialog .........................................................................................70

5.10. Rebuild Tag File Dialog ...........................................................................................................72

6.1. Class View .................................................................................................................................82

6.2. Class Exclusion Manager Dialog ...............................................................................................84

6.3. Outline View ..............................................................................................................................86

6.4. Preview View .............................................................................................................................89

6.5. References View .......................................................................................................................91

6.6. Symbols View ............................................................................................................................93

6.7. Symbol Uses/Calling Tree Dialog ..............................................................................................96

6.8. Base Classes Dialog .................................................................................................................97

6.9. Symbol Browser Filter Options Dialog .......................................................................................98

6.10. Symbol Properties View ........................................................................................................101

6.11. Add New Item Dialog .............................................................................................................103

6.12. Parameter Entry Dialog .........................................................................................................104

6.13. Block Insert Mode: Example 1 ...............................................................................................127

6.14. Block Insert Mode: Example 2 ...............................................................................................127

6.15. Block Insert Mode: Example 3 ...............................................................................................128

6.16. Sort Dialog .............................................................................................................................136

6.17. Color Coding Setup: Tokens Tab ..........................................................................................140

6.18. Example of Auto-Complete ...................................................................................................146

6.19. Select Alias File Dialog ..........................................................................................................150

6.20. Alias Editor Dialog .................................................................................................................153

6.21. Dynamic Surround: Example 1 ..............................................................................................162

xiii

SlickEdit® Core v3.3 for Eclipse™

6.22. Dynamic Surround: Example 2 ..............................................................................................163

6.23. Dynamic Surround: Example 3 ..............................................................................................164

6.24. Dynamic Surround: Example 4 ..............................................................................................165

6.25. Surround With Dialog ............................................................................................................167

6.26. Alias Editor Dialog for Surround With ....................................................................................167

6.27. Delete Code Block Dialog .....................................................................................................170

6.28. Find and Replace View .........................................................................................................190

6.29. Quick Rename Refactoring ...................................................................................................198

6.30. Quick Extract Method Refactoring .........................................................................................199

6.31. C++ Refactoring: Rename .....................................................................................................201

6.32. C++ Refactoring: Extract Method ..........................................................................................201

6.33. C++ Refactoring: Modify Parameter List ...............................................................................202

6.34. C++ Refactoring: Push Down to Derived Class ....................................................................203

6.35. C++ Refactoring: Push Down - Selecting Members to Move ................................................204

6.36. C++ Refactoring: Pull Up to Super Class ..............................................................................205

6.37. C++ Refactoring: Pull Up - Selecting Members to Move .......................................................206

6.38. C++ Refactoring: Encapsulate Field ......................................................................................207

6.39. C++ Refactoring: Extract Class 1 ..........................................................................................208

6.40. C++ Refactoring: Extract Class 2 ..........................................................................................208

6.41. C++ Refactoring: Extract Super Class ..................................................................................209

6.42. C++ Refactoring: Move Method 1 .........................................................................................210

6.43. C++ Refactoring: Move Method 2 .........................................................................................211

6.44. C++ Refactoring: Move Static Field .......................................................................................211

6.45. C++ Refactoring: Convert Global to Static Field ...................................................................212

6.46. C++ Refactoring: Convert Local to Field ...............................................................................213

6.47. C++ Refactoring: Replace Literal with Constant ...................................................................213

6.48. C++ Refactoring: Create Standard Methods .........................................................................214

6.49. Test Parsing Configuration: Example 1 .................................................................................216

6.50. Test Parsing Configuration: Example 2 .................................................................................217

6.51. Test Parsing Configuration: Example 3 .................................................................................219

6.52. Refactoring Results ...............................................................................................................220

6.53. Selective Display ...................................................................................................................225

7.1. Extension Options Dialog ........................................................................................................231

7.2. New Extension Dialog .............................................................................................................232

7.3. C/C++ Formatting Options: Begin-end style Tab ....................................................................233

7.4. C/C++ Formatting Options: Indentation Tab ...........................................................................234

7.5. C/C++ Formatting Options: Other Tab ....................................................................................236

7.6. C/C++ Beautifier: Begin-End Style Tab ...................................................................................238

7.7. C/C++ Beautifier: Indenting Tab ..............................................................................................239

7.8. C/C++ Beautifier: Comments Tab ...........................................................................................240

7.9. C/C++ Beautifier: Other Tab ....................................................................................................242

7.10. C/C++ Beautifier: Schemes Tab ............................................................................................243

7.11. C/C++ Compiler Properties Dialog ........................................................................................244

7.12. C/C++ Preprocessing Dialog .................................................................................................246

7.13. Java Options Dialog ..............................................................................................................248

7.14. Organize Imports Dialog ........................................................................................................252

7.15. XML Formatting Options Dialog ............................................................................................254

7.16. XML Beautifier: Indent Tab ....................................................................................................256

7.17. XML Beautifier: Tags Tab ......................................................................................................258

xiv

SlickEdit® Core v3.3 for Eclipse™

7.18. XML Beautifier: Attributes/Values Tab ..................................................................................260

7.19. XML Beautifier: Comments Tab ............................................................................................262

7.20. XML Beautifier: Advanced Tab ..............................................................................................263

7.21. XML Beautifier: Schemes Tab ...............................................................................................264

7.22. URL Mappings Dialog ...........................................................................................................265

7.23. Web Browser Setup Dialog ...................................................................................................266

7.24. HTML Formatting Options Dialog ..........................................................................................268

7.25. HTML Beautifier: Indent Tab .................................................................................................271

7.26. HTML Beautifier: Tags Tab ...................................................................................................272

7.27. HTML Beautifier: Attributes/Values Tab ................................................................................274

7.28. HTML Beautifier: Comments Tab ..........................................................................................275

7.29. HTML Beautifier: Advanced Tab ...........................................................................................277

7.30. XML/HTML Formatting Menu ................................................................................................279

7.31. Current Document Options Dialog ........................................................................................280

7.32. XML/HTML Formatting Scheme Configuration Dialog ..........................................................281

7.33. New Formatting Scheme Dialog ............................................................................................283

7.34. XML/HTML Formatting: General Tab ....................................................................................285

7.35. XML/HTML Formatting: Content Wrap Tab ...........................................................................287

7.36. XML/HTML Formatting: Tag Layout Tab ...............................................................................289

7.37. COBOL Formatting Options Dialog .......................................................................................299

7.38. Pascal Formatting Options Dialog .........................................................................................301

7.39. PL/I Formatting Options Dialog .............................................................................................303

8.1. DIFFzilla® Dialog .....................................................................................................................309

8.2. Multi-File Diff Output Dialog ....................................................................................................311

8.3. Save Multi-File Output Dialog ..................................................................................................312

8.4. 3-Way Merge Setup Dialog .....................................................................................................314

8.5. 3-Way Merge Results Dialog ...................................................................................................315

8.6. FTP Profile Manager Dialog ....................................................................................................318

8.7. Regex Evaluator View .............................................................................................................321

8.8. The SlickEdit® Calculator ........................................................................................................323

9.1. Binding Recorded Macros .......................................................................................................332

9.2. Set Variable Dialog ..................................................................................................................336

9.3. Variable Editor Dialog ..............................................................................................................336

10.1. Select Text to Paste Dialog ...................................................................................................340

10.2. Enumerate Dialog ..................................................................................................................341

10.3. Filter Selection: Command Dialog .........................................................................................342

10.4. Find and Replace View .........................................................................................................343

10.5. Find and Replace: Find Tab ..................................................................................................344

10.6. Find and Replace: Find in Files Tab ......................................................................................347

10.7. Find and Replace Replace Tab .............................................................................................350

10.8. Find and Replace: Replace in Files Tab ...............................................................................352

10.9. Find Symbol View ..................................................................................................................354

10.10. Go to Definition Dialog ........................................................................................................357

10.11. Selective Display Dialog ......................................................................................................358

10.12. List Macros Dialog ...............................................................................................................361

10.13. Variable Editor Dialog ..........................................................................................................362

10.14. Grid Settings Dialog ............................................................................................................364

10.15. Menu Editor Dialog ..............................................................................................................364

10.16. Auto Enable Properties Dialog ............................................................................................366

SlickEdit® Core v3.3 for Eclipse™

10.17. Organize Imports Options Dialog ........................................................................................369

10.18. 3-Way Merge Dialog ............................................................................................................370

10.19. DIFFzilla®: Files Tab ...........................................................................................................372

10.20. DIFFzilla®: File Compare Options .......................................................................................374

10.21. DIFFzilla®: Dialog Setup Options ........................................................................................376

10.22. Multi-File Diff Output Dialog ................................................................................................377

10.23. Context Tagging® - Tag Files Dialog ...................................................................................378

10.24. General Options: General Tab ............................................................................................380

10.25. General Options: Search Tab ..............................................................................................383

10.26. General Options: Selections Tab ........................................................................................386

10.27. General Options: Special Characters Tab ...........................................................................389

10.28. General Options: More Tab .................................................................................................391

10.29. General Options: Exit Tab ...................................................................................................394

10.30. General Options: Virtual Memory Tab .................................................................................396

10.31. Extension Options Dialog ....................................................................................................398

10.32. Extension Options: Indent Tab ............................................................................................400

10.33. Extension Options: Word Wrap Tab ....................................................................................402

10.34. Extension Options: General Tab .........................................................................................404

10.35. Extension Options: Comments Tab .....................................................................................406

10.36. Extension Options: Comment Wrap Tab .............................................................................411

10.37. Extension Options: Advanced Tab ......................................................................................413

10.38. Extension Options: Auto-Complete Tab ..............................................................................415

10.39. Extension Options: Context Tagging® Tab .........................................................................417

10.40. Select a Tag Dialog .............................................................................................................421

10.41. File Options: Load Tab ........................................................................................................422

10.42. File Options: Save Tab ........................................................................................................424

10.43. File Options: AutoSave Tab ................................................................................................426

10.44. File Options: File Filters Tab ...............................................................................................428

10.45. Key Bindings Dialog ............................................................................................................429

10.46. Bind Key Dialog ...................................................................................................................432

10.47. Redefine Common Keys Dialog ..........................................................................................433

10.48. Context Tagging® Options Dialog .......................................................................................436

10.49. Color Coding Setup Dialog ..................................................................................................439

10.50. Color Coding Setup: Tokens Tab ........................................................................................441

10.51. Color Coding Setup: Numbers Tab .....................................................................................443

10.52. Color Coding Setup: Strings Tab .........................................................................................445

10.53. Color Coding Setup: Language Tab ....................................................................................447

10.54. Color Coding Setup: Comments Tab ..................................................................................449

10.55. Color Coding Setup: Tags Tab ............................................................................................451

10.56. Color Settings Dialog ...........................................................................................................453

10.57. Font Configuration Dialog ....................................................................................................455

10.58. XML/HTML Formatting Dialog .............................................................................................457

10.59. Proxy Settings Dialog ..........................................................................................................458

10.60. Network Options Dialog .......................................................................................................459

10.61. Web Browser Setup Dialog .................................................................................................460

10.62. FTP Options: General Tab ..................................................................................................461

10.63. FTP Options: Advanced Tab ...............................................................................................462

10.64. FTP Options: Firewall/Proxy Tab ........................................................................................463

10.65. FTP Options: SSH/SFTP Tab .............................................................................................465

xvi

SlickEdit® Core v3.3 for Eclipse™

10.66. FTP Options: Debug Tab ....................................................................................................465

10.67. Reflow Comment Dialog ......................................................................................................466

10.68. Current Document Options Dialog ......................................................................................468

11.1. Configuration Directory Preferences .....................................................................................484

11.2. ISPF Options Dialog ..............................................................................................................501

xvii

xviii

List of Tables

1.1. Supported Languages and File Types ........................................................................................6

3.1. UI Commands vs. Command Line Counterpart ........................................................................33

3.2. Common SlickEdit Core Commands .........................................................................................33

3.3. Text Box Editing Key .................................................................................................................35

4.1. Command Line Font Recommendations ...................................................................................55

6.1. Preview View Information ..........................................................................................................91

6.2. Predefined Substitution Parameters ........................................................................................107

6.3. Summary of Metadata Element ...............................................................................................116

6.4. Selection Key ..........................................................................................................................128

6.5. Operations for Selected Text ...................................................................................................129

6.6. Sorting Options ........................................................................................................................138

6.7. Alias Escape Sequences .........................................................................................................155

6.8. Escape Sequence Examples ..................................................................................................156

6.9. Incremental Search Key ..........................................................................................................183

6.10. OptionCharacters for find and Slash (/) Commands ............................................................184

6.11. Replace Key ..........................................................................................................................187

6.12. Replace Command Search Examples ..................................................................................189

6.13. Examples of Replacing Using Regular Expressions .............................................................193

6.14. Examples of Tagged Search Expressions ............................................................................194

6.15. Hex Mode Key .......................................................................................................................223

8.1. Binary Operators .....................................................................................................................324

8.2. Math Command Examples ......................................................................................................325

11.1. Environment Variables ..........................................................................................................475

11.2. Configuration Variable ...........................................................................................................479

11.3. User Configuration Files ........................................................................................................485

11.4. System Configuration File .....................................................................................................487

11.5. VLX File Statement ...............................................................................................................491

11.6. Table of style Value ...........................................................................................................494

11.7. ISPF Primary Commands ......................................................................................................503

11.8. ISPF Line Commands ...........................................................................................................506

11.9. XEDIT Line Commands .........................................................................................................516

11.10. Unsupported ISPF Primary Commands ..............................................................................517

11.11. Supported ISPF Commands ...............................................................................................518

11.12. UNIX Regular Expression ...................................................................................................520

11.13. UNIX Regular Expression Examples ...................................................................................525

11.14. SlickEdit Regular Expressions ............................................................................................526

11.15. SlickEdit Regular Expression Examples .............................................................................531

11.16. Brief Regular Expressions ...................................................................................................532

11.17. Brief Regular Expression Examples ....................................................................................536

11.18. Unicode SubCategories for Regular Expressions ...............................................................538

11.19. Unicode Character Blocks for Regular Expressions ...........................................................540

xix

Chapter 1. Introduction

Cool Features

Getting the Most Out of SlickEdit® Core

At SlickEdit, we take great pride in delivering unparalleled power, speed, and flexibility to our customers. Our goal is to remove the tedious tasks involved with programming, allowing you to focus on the reason you first got into programming: the thrill of writing great code.

SlickEdit Core brings the rich history of excellence of SlickEdit to the Eclipse framework. It delivers the power programming capabilities needed to write more code faster and more accurately, making it an indispensable plug-in for developers.

Cool Features

SlickEdit® Core contains powerful editing features and capabilities. Some of our coolest features are listed in the Cool Features dialog. Using this dialog, you can read a description of each feature and watch a short demo of the feature in action. By default, the Cool Features dialog appears each time Eclipse is started. It can also be displayed anytime by clicking Help → SlickEdit Cool Features.

Write More Code, Faster

These keys to programming efficiency will help you write more code, faster than you ever have before:

• Keep your hands on the keyboard - Time is wasted each time you reach for the mouse. SlickEdit®

Core contains 13 editor emulations with predefined key bindings that are ready for use in performing common tasks. Define your own key bindings or invoke editor operations from the SlickEdit Core command line. For more information, see Using the Mouse and Keyboard.

• Type as little as possible - SlickEdit Core contains many features that reduce the number of key-

strokes you type, including automatic completions, syntax expansion, aliases, macros, code templates, and code generators. For information about these features, see the topics in Chapter 6, Editing Fea-

tures.

• Rapidly navigate code - Instantly jump from a symbol to its definition or view a list of references. Pre-

view definitions for the current symbol without having to open the file. Use bookmarks to mark important locations in the code. SlickEdit Core includes powerful browse and search capabilities, allowing you to quickly find the code you want. See Navigation for more information.

• Access information quickly - SlickEdit Core uses visual indicators to provide you with information

about your code, including syntax highlighting and color coding. Special views are also available for looking up information about files, classes, symbols, definitions, and more. To learn more, see SlickEdit

Views, Symbol Browsing, and other topics in Chapter 6, Editing Features.

• Let SlickEdit Core do the formatting - Syntax indenting, SmartPaste®, and code beautifiers are just a

few of the automatic formatting features in SlickEdit Core. For more information, see the topics in

Chapter 6, Editing Features.

• Utilize utilities - SlickEdit Core provides many utilities for working with your code, such as DIFFzilla®,

3-Way Merge, a RegEx Evaluator, math commands, and even a calculator. See the topics in Chapter 8,

Get Started

Tools and Utilities for more information.

Get Started

To get started, check out Chapter 2, Quick Start. This will guide you through configuration of some of the most common user preference settings, so you can get more work done in less time, your way.

Accessing Documentation

Documentation and Conventions

Accessing Documentation

Documentation is located in the SlickEdit® Core installation directory at <PathToSlickEditCore>/eclipse/plugins/com.slickedit.core_VERSION/docs. The docs directory contains PDFs of the following items:

• The User Guide - This guide provides comprehensive information about using SlickEdit Core.

• The Slick-C® Macro Programming Guide - This guide contains details about how to write macros using

the Slick-C macro programming language.

• Emulation charts for the following editors: BBEdit, Brief, CodeWarrior™, CodeWright®, CUA (default),

Epsilon, GNU Emacs, ISPF, SlickEdit (Text Mode edition), Vim, Visual C++ ® 6, Visual Studio®, and Xcode®.

In addition to the documentation, SlickEdit Core provides a built-in Help system. The contents of the Help system is the same as the contents of the User Guide.

Documentation Feedback

We welcome your comments and suggestions regarding our documentation. Please send feedback to <docs@slickedit.com>.

Documentation Conventions

The subsequent topics describe conventions that are used in the SlickEdit® Core documentation.

Default Emulation/Key Binding Mode

CUA is the default editor emulation mode. Therefore, key bindings and shortcuts listed in the documentation follow the CUA emulation.

Platform-Specific Notes

Platform-specific notes for for Microsoft Windows and Linux® are listed throughout the documentation where applicable.

Menus and Dialogs

Instructions for navigating to items accessed from the main menu are written in the form:

MainMenuItem > SubMenuItem

For example, the text "click Window → Preferences" indicates that you should first select Window from

Supported Languages and En-

vironments

the main menu, then select Preferences from the Window submenu. Our documentation structure is set up so that instructions for using the product make up the bulk of the

content, while listings of dialog boxes and options can be found in Chapter 10, SlickEdit Core Dialogs. Buttons on dialogs, such as OK and Close, are not usually documented since the meaning is obvious.

Code Syntax Conventions

• Commands, switches, keywords, properties, operators, options, variables, and text to be typed by the

user are shown in bold type.

• User-input variables and placeholders are shown in bold italic type.

• Code samples and file names are displayed in a monospaced font.

• File extensions and environment variables are written with an UPPERCASE font.

• SlickEdit® Core commands that contain two or more words are written with underscore separators: for

example, cursor_down. Note that in the user interface, however, these commands are displayed with hyphen separators: for example, cursor-down. Both of these forms work, so you can use whichever style you prefer.

Supported Languages and File

Types

Supported Languages and Environments

This section lists the languages and file types supported by each SlickEdit® Core feature as well as the supported emulations.

Supported Languages and File Types

The table below indicates the languages and file types that support key SlickEdit® Core features. Features that are not language-specific, such as DIFFzilla®, are not listed here.

Table 1.1. Supported Languages and File Types

Feature Languages

Automatic Syntax Expansion ActionScript, Ada, AWK, C, C#, C++, CFML, CF-

Script, Ch, COBOL, DTD, Fortran, HTML, IDL, InstallScript, J#, Java, JavaScript™, JSP™, Objective-C, Pascal, Perl, PHP, PL/SQL, PV-WAVE ®, Python™, REXX, Ruby, SAS®, Slick-C®, Tcl, Transact-SQL®, VBScript, Verilog®, VHDL, Visual Basic®, Visual Basic .NET™, XML, XSD

Code Beautifier ActionScript, Ada, C, C#, C++, CFML, HTML, Java,

JavaScript, JSP, Slick-C, XML, XSD

Color Coding ActionScript, Ada, ANTLR, AppleScript®, Assembly

Language, AWK, Bourne shell scripts, C, C Shell, C#, C++, CFML, CFScript, Ch, CICS®, COBOL, DB2®, DTD, Fortran, High Level Assembler, HTML, IDL, InstallScript, J#, Java, JavaScript, JCL, JSP, Lex, Modula-2, Objective-C, Pascal, Perl, PHP, PL/ I, PL/SQL, PowerNP™ Assembler, Progress® 4GL, PV-WAVE, Python, REXX, Ruby, SAS, Slick-C, Tcl, Transact-SQL, VBScript, Verilog, VHDL, Visual Basic, Visual Basic .NET, Windows batch files, x86 Assembly, XML, XSD, Yacc

Context Tagging®: Auto List Members, Auto Parameter Info

ActionScript, Ada, C, C#, C++, CFML, CFScript, Ch, CICS, COBOL, DTD, High Level Assembler, HTML, IDL, InstallScript, J#, Java, JavaScript, JSP, Objective-C, Pascal, Perl, PHP, PL/I, PV-WAVE, Python, Ruby, Slick-C, VBScript, Verilog, VHDL, Visual Basic .NET, XML, XSD

Context Tagging: Auto List Parameters ActionScript, C, C++, Ch, J#, Java, Slick-C

Supported Languages and File

Types

Feature Languages

Javadoc™ Editor ActionScript, C, C#, C++, J#, Java, JavaScript,

Slick-C

Select/Hide Code Block ActionScript, Ada, C, C#, C++, CFML, Ch, COBOL,

DB2, Fortran, High Level Assembler, HTML, IDL, InstallScript, J#, Java, JavaScript, Modula-2, Objective-C, Pascal, Perl, PHP, PL/SQL, Slick-C, Tcl, Visual Basic, Visual Basic .NET, XML, XSD

Selective Display

Collapsible code block and function bodies.

SmartPaste®

Pasted code re-indents to correct level.

Source Code Navigation and Lookup

Includes Class, Outline, Preview, References, and Symbols views, as well as symbol navigation.

ActionScript, Ada, ANTLR, C, C#, C++, CFML, CFScript, Ch, CICS, COBOL, DB2, DTD, Fortran, High Level Assembler, HTML, IDL, InstallScript, J#, Java, JavaScript, JCL, JSP, Lex, Modula-2, Objective-C, Pascal, Perl, PHP, PL/I, PL/SQL, PowerNP Assembler, PV-WAVE, Python, REXX, Ruby, SAS, Slick-C, Tcl, Transact-SQL, VBScript, Verilog, VHDL, Visual Basic, Visual Basic .NET, x86 Assembly, XML, XSD, Yacc

ActionScript, AWK, C, C#, C++, IDL, InstallScript, J#, Java, JavaScript, JSP, Objective-C, Pascal, Perl, PHP, PL/I, PV-WAVE, Python, Ruby, Slick-C, Tcl

ActionScript, Ada, ANTLR, Assembly Language, AWK, Bourne shell scripts, C, C Shell, C#, C++, CFML, CFScript, Ch, CICS, COBOL, DB2, DTD, Fortran, High Level Assembler, HTML, IDL, InstallScript, J#, Java, JavaScript, JCL, JSP, Lex, Makefile, Modula-2, Objective-C, Pascal, Perl, PHP, PL/I, PL/SQL, PowerNP Assembler, Progress 4GL, PVWAVE, Python, REXX, Ruby, SAS, Slick-C, Tcl, Transact-SQL, VBScript, Verilog, VHDL, Visual Basic, Visual Basic .NET, Windows batch files, x86 Assembly, XML, XSD, Yacc

Syntax Indenting

Cursor is placed at correct indent level.

ActionScript, Ada, AWK, C, C#, C++, CFML, CFScript, Ch, COBOL, Fortran, HTML, IDL, InstallScript, J#, Java, JavaScript, JSP, Objective-C, Pascal, Perl, PHP, PL/SQL, PV-WAVE, Python, REXX, Ruby, SAS, Slick-C, Tcl, Transact-SQL, VBScript, Verilog, VHDL, Visual Basic, Visual Basic .NET, XML, XSD

Supported Languages and File

Types

Embedded Languages

SlickEdit® Core recognizes languages embedded in HTML, COBOL, Perl scripts, and UNIX shell scripts. When editing embedded languages, all language-sensitive features are supported, including Context Tagging®, SmartPaste®, Syntax Expansion, Syntax Indenting, and Color Coding. In fact, Context Tagging picks up embedded tags. For example, the Outline view displays function names if any exist. Embedded language colors are user-defined.

Embedded Languages in HTML

SlickEdit® Core supports any embedded language in HTML. However, Web browsers usually only support VBScript, JavaScript, and/or Java, while Web servers typically support VBScript, Java, or PHP. The following screen is an example of VBScript, JavaScript, and Java embedded in HTML:

Figure 1.1. Embedded Languages in HTML

Embedded Languages in Perl and Other Scripting Languages

To allow SlickEdit® Core to recognize embedded source in a Perl script or UNIX shell, prefix the HERE

+ 538 hidden pages

Slick EDIT V3.3 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Table of Contents

List of Figures

List of Tables

Chapter 1. Introduction

Cool Features

Getting the Most Out of SlickEdit® Core

Write More Code, Faster

Get Started

Accessing Documentation

Documentation and Conventions

Documentation Feedback

Documentation Conventions

Default Emulation/Key Binding Mode

Platform-Specific Notes

Menus and Dialogs

Code Syntax Conventions

Supported Languages and Environments

Supported Languages and File Types

Embedded Languages

Embedded Languages in HTML

Embedded Languages in Perl and Other Scripting Languages