Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Table of Contents
1 Welcome to the Komodo User Guide.............................................................................................................1
1.1 What's new in Komodo IDE..............................................................................................................1
1.2 Support and Community....................................................................................................................1
1.3 Sample Project...................................................................................................................................1
1.4 Feature Showcase...............................................................................................................................1
1.5 Tutorials.............................................................................................................................................1
3 Starting Komodo............................................................................................................................................10
3.1 Windows..........................................................................................................................................10
3.2 Mac OS X........................................................................................................................................10
3.3 Linux................................................................................................................................................11
i
Komodo User Guide
Table of Contents
4 Komodo Installation Guide
4.2.2 Installing the Komodo License on OS X................................................................................15
4.2.3 Upgrading from Previous Komodo Versions.........................................................................15
4.2.4 Installing Komodo on Mac OS X...........................................................................................16
4.2.5 Starting Komodo on OS X.....................................................................................................16
4.2.6 Uninstalling Komodo on OS X..............................................................................................16
4.3 Linux................................................................................................................................................16
4.3.1 Prerequisites...........................................................................................................................16
4.3.1.1 Hardware Requirements...............................................................................................16
4.3.1.2 Operating System Requirements..................................................................................16
4.3.1.3 Software Prerequisites on Linux...................................................................................17
4.3.1.4 Adding Perl or Python to the PATH Environment Variable........................................17
4.3.2 Installing the Komodo License on Linux...............................................................................18
4.3.3 Upgrading from Previous Komodo Versions.........................................................................18
4.3.4 Installing Komodo on Linux..................................................................................................18
4.3.5 Starting Komodo on Linux.....................................................................................................19
4.3.6 Uninstalling Komodo on Linux..............................................................................................19
4.4 Language and Debugging Prerequisites...........................................................................................19
4.5 Source Code Control Integration Prerequisites................................................................................20
ii
Komodo User Guide
Table of Contents
7 Support and Feedback
7.3 Mailing Lists....................................................................................................................................30
7.4 Reporting Bugs................................................................................................................................30
7.5 Feature Requests..............................................................................................................................31
7.6 ActiveState Technical Support........................................................................................................31
7.7 Comments and Feedback.................................................................................................................31
iii
Komodo User Guide
Table of Contents
10 Working with Files
10.5 Comparing Files.............................................................................................................................47
10.6 Refreshing File Status....................................................................................................................48
10.7 Source Code Control......................................................................................................................49
10.8 File Properties and Settings...........................................................................................................49
10.8.1 File Properties.......................................................................................................................49
10.8.2 File Source Control Settings.................................................................................................50
10.8.3 File Editor Settings...............................................................................................................50
10.8.4 Indentation Tab.....................................................................................................................50
10.8.5 Browser Preview..................................................................................................................50
10.9 Printing Files..................................................................................................................................50
10.9.1 Page Setup............................................................................................................................51
10.9.2 Print to HTML File...............................................................................................................51
10.10 Saving Files..................................................................................................................................51
10.10.1 Saving Files Remotely........................................................................................................52
10.10.2 Show Unsaved Changes.....................................................................................................52
10.11 Reverting Files.............................................................................................................................52
10.12 Closing Files................................................................................................................................52
12 Editing...........................................................................................................................................................58
12.1 Language Support..........................................................................................................................58
12.1.1 Syntax Coloring and Indentation..........................................................................................58
12.1.2 Background Syntax Checking..............................................................................................59
12.1.3 AutoComplete and CallTips.................................................................................................60
12.1.3.1 Perl AutoComplete and CallTips................................................................................60
12.1.3.2 Python AutoComplete and CallTips...........................................................................61
12.1.3.3 Ruby AutoComplete and CallTips..............................................................................62
12.1.3.4 PHP AutoComplete and CallTips...............................................................................62
12.1.3.5 Tcl AutoComplete and CallTips.................................................................................63
12.1.3.6 XSLT AutoComplete..................................................................................................64
iv
Komodo User Guide
Table of Contents
12 Editing
12.1.3.7 XML AutoComplete and CallTips.............................................................................64
12.1.4 Soft Characters.....................................................................................................................65
12.1.5 Viewing the Current File as Another Language...................................................................65
12.1.6 Commenting Blocks of Code...............................................................................................65
12.2 Manipulating Code........................................................................................................................66
12.2.1 Cutting and Copying Lines...................................................................................................66
12.2.2 Selecting and Dragging Lines..............................................................................................66
12.2.3 Automatically Repeating Keystrokes...................................................................................66
12.2.4 Indenting and Un-indenting Lines of Code..........................................................................66
12.2.5 Reflowing Paragraphs..........................................................................................................67
12.2.6 Formatting Code Komodo IDE only....................................................................................67
12.2.7 Joining Lines........................................................................................................................67
12.2.8 Converting between Uppercase and Lowercase...................................................................67
12.2.9 Transposing Characters........................................................................................................67
12.2.10 Literal Characters...............................................................................................................68
12.2.11 Commenting and Un-commenting Lines or Blocks of Code.............................................68
12.2.12 Cleaning Line Endings.......................................................................................................68
12.2.13 Tabifying and Untabifying Regions...................................................................................68
12.2.14 Column / Rectangular Selection.........................................................................................69
12.2.15 Column Editing..................................................................................................................70
12.2.16 Completing Words.............................................................................................................70
12.2.17 Selecting Blocks of Code...................................................................................................70
12.3 Editor Display Characteristics.......................................................................................................71
12.3.1 Toggling Whitespace On and Off........................................................................................71
12.3.2 Toggling Indentation Guides On and Off.............................................................................71
12.3.3 Toggling Line Numbers On and Off....................................................................................71
12.3.4 Toggling EOL (end of line) Markers On and Off................................................................71
12.3.5 Increasing and Decreasing the Code Font Size....................................................................71
12.3.6 Toggling Fixed and Non-Fixed Width Fonts.......................................................................72
12.3.7 Folding and Unfolding Code................................................................................................72
12.4 Navigating Within Files.................................................................................................................73
12.4.1 Moving to a Specific Line....................................................................................................73
12.4.2 Go to Definition....................................................................................................................73
12.4.3 Setting and Moving to Bookmarks and Marks.....................................................................73
12.4.4 Matching Braces...................................................................................................................74
12.5 Detecting Changed Files................................................................................................................74
12.6 Preview in Browser........................................................................................................................74
12.7 Editor Tab Display.........................................................................................................................75
13 Abbreviations...............................................................................................................................................76
13.1 Inserting Snippets..........................................................................................................................76
13.2 Language-Specific Search Order...................................................................................................77
13.3 Adding New Abbreviations...........................................................................................................77
v
Komodo User Guide
Table of Contents
14 Working with Folders
14.1.2 Export Contents to Package.................................................................................................79
14.1.3 Import Contents from Package.............................................................................................79
14.1.4 Refresh Folder Contents Status............................................................................................80
14.1.5 Adding Components to Folders............................................................................................80
14.1.6 Exporting Contents as Project File.......................................................................................80
14.1.7 Renaming Folders.................................................................................................................80
14.1.8 Source Control on Folder Contents......................................................................................80
14.1.9 Deleting Folders...................................................................................................................80
15 Snippets.........................................................................................................................................................81
15.1 Creating Snippets...........................................................................................................................81
15.2 Configuring Snippets.....................................................................................................................81
15.3 Using Snippets...............................................................................................................................82
15.4 Snippet Options..............................................................................................................................82
15.4.1 Snippet Properties.................................................................................................................82
15.4.1.1 Assigning Custom Icons to Snippets..........................................................................83
15.4.1.2 Snippet Key Bindings.................................................................................................83
16 Tabstops........................................................................................................................................................84
16.1 Creating Tabstops..........................................................................................................................84
16.2 Using Tabstops..............................................................................................................................84
16.3 Examples........................................................................................................................................84
17 Macros...........................................................................................................................................................86
17.1 Creating Macros.............................................................................................................................86
17.1.1 Recording Macros................................................................................................................86
17.1.2 Writing Macros.....................................................................................................................86
17.2 Running Macros.............................................................................................................................87
17.3 Managing Macros..........................................................................................................................87
17.4 Macro Properties............................................................................................................................87
17.4.1 Assigning Key Bindings to Macros......................................................................................87
17.4.2 Assigning Custom Icons to Macros......................................................................................88
17.4.3 Running Macros in the Background.....................................................................................88
17.4.4 Specifying Macro Triggers...................................................................................................88
17.4.4.1 Trigger Macro subject Variable..................................................................................89
17.4.4.2 Macro Return Values..................................................................................................89
17.5 Vi Command Mode Macros...........................................................................................................89
18 Macro API....................................................................................................................................................90
18.1 The Komodo Macro API...............................................................................................................90
18.1.1 Warning................................................................................................................................90
18.1.2 Feedback...............................................................................................................................90
18.2 JavaScript Macros..........................................................................................................................90
18.2.1 ko.views.manager.currentView.scimoz................................................................................91
18.2.1.1 scimoz Attributes........................................................................................................91
18.2.1.2 scimoz Methods..........................................................................................................92
18.2.1.3 scimoz Notes...............................................................................................................95
vi
Komodo User Guide
Table of Contents
18 Macro API
18.2.2 ko.views.manager.currentView.document...........................................................................96
18.2.2.1 document Attributes....................................................................................................96
18.2.3 ko.views.manager.currentView.document.file.....................................................................96
18.2.3.1 document.file attributes..............................................................................................96
18.2.4 ko.commands.doCommand()...............................................................................................96
18.2.5 ko.open.URI().......................................................................................................................97
18.2.6 ko.projects.findPart()............................................................................................................97
18.2.7 ko.interpolate.interpolateString().........................................................................................98
18.2.8 ko.interpolate.getWordUnderCursor().................................................................................98
18.2.9 ko.run.runEncodedCommand()............................................................................................98
18.3 Python Macros...............................................................................................................................99
18.3.1 Creating a view object..........................................................................................................99
18.3.2 Opening a URI......................................................................................................................99
18.3.3 Interpolate a string..............................................................................................................100
18.3.4 Get word under cursor........................................................................................................100
18.3.5 Running a Komodo command............................................................................................100
18.3.6 Find a part...........................................................................................................................100
20 Templates....................................................................................................................................................110
20.1 Creating New Files from Templates............................................................................................110
20.2 Creating Custom Templates.........................................................................................................110
20.2.1 Using Interpolation Shortcuts in Custom Templates.........................................................111
20.3 Project Templates.........................................................................................................................111
20.4 Storing Templates in a Project or the Toolbox............................................................................111
20.4.1 Template Options...............................................................................................................112
20.4.2 Assigning Custom Icons to Templates...............................................................................112
20.4.3 Template Key Bindings......................................................................................................113
21 Open Shortcuts...........................................................................................................................................114
21.1 Open Shortcut Options.................................................................................................................114
21.1.1 Open Shortcut Properties....................................................................................................115
vii
Komodo User Guide
Table of Contents
21 Open Shortcuts
21.1.1.1 Assigning Custom Icons to Open Shortcuts.............................................................115
21.1.1.2 Open Shortcut Key Bindings....................................................................................115
22 URL Shortcuts............................................................................................................................................116
22.1 URL Shortcut Options.................................................................................................................116
22.1.1 URL Shortcut Properties....................................................................................................117
22.1.1.1 Assigning Custom Icons to URL Shortcuts..............................................................117
22.1.1.2 URL Shortcut Key Bindings.....................................................................................117
23 Run Commands..........................................................................................................................................118
23.1 Creating Run Commands.............................................................................................................118
23.1.1 Simple Run Commands......................................................................................................118
23.1.2 Advanced Run Commands.................................................................................................119
23.1.3 Command Output Tab........................................................................................................119
23.2 Storing Run Commands in a Project or the Toolbox...................................................................120
23.2.1 Run Command Properties..................................................................................................120
23.2.1.1 Assigning Custom Icons to Run Commands............................................................120
23.2.1.2 Run Command Key Bindings...................................................................................121
viii
Komodo User Guide
Table of Contents
25 Debugging Programs Komodo IDE only
25.4.6 Debugger Proxy..................................................................................................................134
25.5 Sending Input to the Program......................................................................................................135
25.6 Using Debugger Commands........................................................................................................135
25.6.1 Debugger Command Description.......................................................................................135
25.6.2 Debugger Stepping Behavior.............................................................................................137
25.7 Viewing the Debugging Session..................................................................................................137
25.7.1 Viewing Variables..............................................................................................................138
25.7.1.1 Python Variables and Objects...................................................................................138
25.7.1.2 PHP and Tcl Variables..............................................................................................138
25.7.1.3 Perl Variables............................................................................................................138
25.7.1.4 XSLT Variables........................................................................................................138
25.7.2 Setting Watched Variables.................................................................................................139
25.7.3 Output Tab..........................................................................................................................139
25.7.4 HTML Preview Tab...........................................................................................................140
25.7.5 Viewing the Call Stack.......................................................................................................140
25.8 Watching Files.............................................................................................................................140
25.9 Detaching the Debugger..............................................................................................................140
25.10 Stopping the Debugger..............................................................................................................141
ix
Komodo User Guide
Table of Contents
29 Debugging PHP Komodo IDE only..........................................................................................................156
29.1 Installing PHP..............................................................................................................................156
29.1.1 Windows.............................................................................................................................156
29.1.2 Linux..................................................................................................................................156
29.1.3 Mac OS X...........................................................................................................................157
29.2 Local PHP Debugging.................................................................................................................157
29.2.1 Configuring Local PHP Debugging...................................................................................157
29.2.1.1 PHP Debugger Config Wizard.................................................................................157
29.2.2 Starting and Stopping a PHP Local Debugging Session....................................................158
29.3 Remote PHP Debugging..............................................................................................................159
29.3.1 Configuring Remote PHP Debugging................................................................................159
29.3.1.1 Step 1 - Copy the Debugging Extension to the Web Server.....................................159
29.3.1.2 Step 2 - Edit the Web Server's PHP Configuration..................................................160
29.3.1.3 Step 3 - Verify the Web Server's PHP Configuration...............................................161
29.3.2 Starting and Stopping a PHP Remote Debugging Session.................................................161
29.3.2.1 To initiate remote debugging from a web browser:..................................................161
29.3.2.2 To initiate remote debugging from the command line:............................................162
29.3.2.3 To initiate remote debugging using the DBGP Proxy:.............................................162
29.3.2.4 To stop the debugger:...............................................................................................163
29.3.3 Using xdebug_break()........................................................................................................163
29.3.4 Xdebug Logging.................................................................................................................163
29.3.5 PHP Just-in-Time Debugging / Break on Exception..........................................................164
29.4 Common PHP Debugging Problems...........................................................................................164
29.4.1 Debugging PHP on OS X...................................................................................................164
29.4.2 Debugging PHP on 64-bit Linux........................................................................................164
29.4.3 Zend Optimizer and Zend Studio Debugger......................................................................165
x
Komodo User Guide
Table of Contents
33 Unit Testing................................................................................................................................................175
33.1 Creating and Editing Test Plans...................................................................................................175
33.1.1 Supported Test Frameworks by Language.........................................................................175
33.2 Running a Test Plan.....................................................................................................................175
33.3 Importing Global Test Plans........................................................................................................176
36 Code Intelligence........................................................................................................................................189
36.1 Code Browser Komodo IDE only................................................................................................189
36.1.1 Context Menu.....................................................................................................................190
36.1.2 Sorting................................................................................................................................190
36.1.3 Locating Current Scope......................................................................................................190
36.1.4 Filtering Symbols...............................................................................................................190
36.2 Object Browser Komodo IDE only..............................................................................................191
xi
Komodo User Guide
Table of Contents
37 DOM Viewer Komodo IDE only..............................................................................................................192
37.1 Navigating the DOM Tree...........................................................................................................192
37.2 Filtering the DOM Tree...............................................................................................................192
37.3 DOM Resources...........................................................................................................................192
xii
Komodo User Guide
Table of Contents
39 Using the Rx Toolkit Komodo IDE only
39.3 Modifier Examples.......................................................................................................................208
39.3.1 Using Ignore Case..............................................................................................................208
39.3.2 Using Multi-Line Mode......................................................................................................209
39.3.3 Using Single-Line Mode....................................................................................................209
39.3.4 Using Multi-line Mode and Single-line Mode...................................................................210
39.3.5 Using Verbose....................................................................................................................211
39.4 Using Regular Expressions..........................................................................................................211
39.4.1 Perl......................................................................................................................................212
39.4.2 Python.................................................................................................................................212
39.4.3 Tcl.......................................................................................................................................212
39.4.4 PHP.....................................................................................................................................212
39.4.5 Ruby...................................................................................................................................213
xiii
Komodo User Guide
Table of Contents
41 Komodo and the Perl Dev Kit Komodo IDE only
41.2.3.2 Editing Files..............................................................................................................228
41.2.3.3 Deleting Files............................................................................................................228
41.2.4 Configuring the Version Tab..............................................................................................228
41.2.5 Configuring the Library Paths Tab.....................................................................................228
41.2.5.1 Specifying "lib" and "blib" Directories to Include...................................................228
41.2.6 Configuring the Extra Tab..................................................................................................229
41.2.6.1 Specifying Icon files.................................................................................................229
41.2.6.2 Specifying Additional Command Line Parameters..................................................229
42 Interpolation Shortcuts.............................................................................................................................230
42.1 Interpolation Code List................................................................................................................230
42.2 Basic Interpolation Shortcut Syntax............................................................................................231
42.2.1 Non-Bracketed Syntax.......................................................................................................231
42.2.2 Bracketed Syntax................................................................................................................231
42.3 Basic Interpolation Shortcut Options...........................................................................................232
42.4 %(date).........................................................................................................................................232
42.4.1 %(date) Syntax...................................................................................................................233
42.4.2 %(date) Format Option.......................................................................................................233
42.5 %(ask) and %(askpass)................................................................................................................234
42.5.1 %(ask) and %(askpass) Syntax...........................................................................................234
42.5.2 %(ask) and %(askpass) Options.........................................................................................235
42.6 %(path).........................................................................................................................................235
42.6.1 %(path) Syntax...................................................................................................................235
42.6.2 %(path) Options.................................................................................................................235
42.7 %(debugger).................................................................................................................................235
42.7.1 %(debugger) Syntax...........................................................................................................235
42.7.2 %(debugger) Options.........................................................................................................236
42.8 %(pref).........................................................................................................................................236
42.8.1 %(pref) Syntax...................................................................................................................236
42.9 Back-References..........................................................................................................................236
42.9.1 Back-Reference Syntax......................................................................................................236
43 Customizing Komodo................................................................................................................................238
43.1 Appearance Preferences...............................................................................................................238
43.2 Code Intelligence Preferences......................................................................................................238
43.3 Debugger Preferences Komodo IDE only...................................................................................239
43.3.1 Debugger Connection Preferences.....................................................................................240
43.3.2 Advanced Debugger Preferences.......................................................................................240
43.4 Directory Import..........................................................................................................................240
43.5 Editor Preferences........................................................................................................................241
43.5.1 Configuring Key Bindings.................................................................................................242
43.5.2 Configuring Indentation.....................................................................................................244
43.5.3 Smart Editing......................................................................................................................245
43.5.3.1 Configuring Word Completion.................................................................................245
43.5.3.2 Configuring Word or Character Wrap......................................................................245
43.5.3.3 Configuring Edge Lines............................................................................................245
43.5.3.4 Soft Characters..........................................................................................................245
xiv
Komodo User Guide
Table of Contents
43 Customizing Komodo
43.5.3.5 Background Syntax Checking..................................................................................246
43.5.3.6 Configuring Folding.................................................................................................246
43.5.4 Save Options.......................................................................................................................246
43.6 Environment.................................................................................................................................247
43.7 File Associations..........................................................................................................................247
43.8 Fonts and Colors Preferences.......................................................................................................248
43.8.1 Fonts...................................................................................................................................248
43.8.2 Colors.................................................................................................................................249
43.8.3 Common Syntax Coloring..................................................................................................250
43.8.4 Language-Specific Coloring...............................................................................................250
43.9 Code Formatters Komodo IDE only............................................................................................250
43.10 HTTP Inspector Preferences Komodo IDE only.......................................................................251
43.11 Interactive Shell Preferences Komodo IDE only.......................................................................251
43.12 Internationalization Preferences.................................................................................................251
43.13 Language Help Settings.............................................................................................................252
43.13.1 Configuring Reference Locations....................................................................................252
43.13.2 Using Language Help.......................................................................................................253
43.14 Language Configuration............................................................................................................253
43.14.1 Configuring JavaScript.....................................................................................................253
43.14.2 Configuring Perl...............................................................................................................253
43.14.3 Configuring PHP..............................................................................................................254
43.14.4 Configuring Python..........................................................................................................254
43.14.5 Configuring Ruby.............................................................................................................254
43.14.6 Configuring Tcl................................................................................................................255
43.14.6.1 Tcl Syntax Checking...............................................................................................255
43.14.6.2 Tcl Debugging........................................................................................................256
43.14.7 Configuring HTML..........................................................................................................256
43.14.8 Configuring XML Catalogs..............................................................................................256
43.15 Mapped URIs.............................................................................................................................257
43.16 New Files Preferences................................................................................................................257
43.17 Printing Preferences...................................................................................................................258
43.18 Projects and Workspace Preferences.........................................................................................258
43.19 Servers Preferences....................................................................................................................259
43.20 Shared Support Preferences.......................................................................................................260
43.20.1 Sharing .tip, .pcx and .pdx Files.......................................................................................261
43.20.2 Sharing Preferences..........................................................................................................261
43.21 Source Code Control Preferences Komodo IDE only...............................................................262
43.21.1 CVS Integration................................................................................................................262
43.21.2 Perforce Integration..........................................................................................................262
43.21.3 Subversion Integration.....................................................................................................263
43.22 Web and Browser Preferences...................................................................................................263
43.23 Windows Integration Preferences..............................................................................................263
xv
Komodo User Guide
Table of Contents
44 Komodo Tutorial Overview Komodo IDE only
44.4 PHP Tutorial................................................................................................................................265
44.5 Perl Tutorial.................................................................................................................................265
44.6 Python Tutorial............................................................................................................................266
44.7 Ruby Tutorial...............................................................................................................................266
44.8 XSLT Tutorial..............................................................................................................................266
44.9 Run Command Tutorial...............................................................................................................266
45 Feature Showcase.......................................................................................................................................267
45.1 Project and Workspace................................................................................................................267
45.2 Editing..........................................................................................................................................267
45.3 Debugging....................................................................................................................................267
45.4 Search...........................................................................................................................................267
45.5 Tools............................................................................................................................................267
xvi
Komodo User Guide
Table of Contents
46 Perl Tutorial Komodo IDE only
46.4.9.2 Lines 52 to 54 - Ending the Program........................................................................272
46.5 Run the Program to Generate Output...........................................................................................272
46.6 Debugging the Program...............................................................................................................272
46.7 More Perl Resources....................................................................................................................274
46.7.1 ASPN, the ActiveState Programmer Network...................................................................274
46.7.2 Documentation...................................................................................................................274
46.7.3 Tutorials and Reference Sites.............................................................................................274
xvii
Komodo User Guide
Table of Contents
47 PHP Tutorial Komodo IDE only
47.4.12 Closing Tags.....................................................................................................................280
47.4.12.1 Lines 148 to 151 - Closing Tags.............................................................................280
47.5 Running the Program...................................................................................................................280
47.6 Debugging the Program...............................................................................................................280
47.7 More PHP Resources...................................................................................................................282
47.7.1 ASPN, the ActiveState Programmer Network...................................................................282
47.7.2 Tutorials and Reference Sites.............................................................................................282
xviii
Komodo User Guide
Table of Contents
48 Python Tutorial Komodo IDE only
48.6 Explore Python with the Interactive Shell...................................................................................292
48.7 More Python Resources...............................................................................................................293
48.7.1 ASPN, the ActiveState Programmer Network...................................................................293
48.7.2 Tutorials and Reference Sites.............................................................................................293
48.7.3 Preprocessor Reference......................................................................................................293
xix
Komodo User Guide
Table of Contents
50 Ruby on Rails Tutorial Komodo IDE only
50.5.1 Running Model Tests in Komodo IDE..............................................................................303
50.5.2 Running Tests in Komodo Edit.........................................................................................304
50.5.3 Running Controller Tests...................................................................................................304
50.6 Starting the Rails Application Server..........................................................................................305
50.6.1 Dealing with Mongrel........................................................................................................306
50.6.2 Testing the Application......................................................................................................306
50.7 Installing Plugins.........................................................................................................................307
50.7.1 Adding Pagination..............................................................................................................307
50.7.2 Testing Pagination..............................................................................................................308
50.7.3 Testing Pagination in the Application................................................................................309
50.7.4 Adding In-Place Editing.....................................................................................................309
50.8 Adding Borrower Data.................................................................................................................310
50.9 Handling Checkouts.....................................................................................................................311
50.10 Rails Resources..........................................................................................................................313
50.10.1 Tutorials and Reference Sites...........................................................................................313
52 XSLT Tutorial............................................................................................................................................318
52.1 XSLT Tutorial Overview.............................................................................................................318
52.1.1 Before You Start.................................................................................................................318
52.1.2 XSLT Tutorial Scenario.....................................................................................................318
52.2 Opening the Tutorial Project........................................................................................................318
52.2.1 Opening the XSLT Tutorial Files.......................................................................................318
52.2.2 Overview of the Tutorial Files...........................................................................................319
52.3 Analyzing the Program................................................................................................................319
52.3.1 XSLT Header.....................................................................................................................319
52.3.1.1 Lines 1 to 3 - XML and XSLT Declarations............................................................319
52.3.2 HTML Header....................................................................................................................319
52.3.2.1 Line 6 - XSLT "template".........................................................................................319
52.3.2.2 Lines 7 to 11 - HTML Tags......................................................................................320
52.3.2.3 Line 12 - XSLT apply-templates..............................................................................320
52.3.2.4 Lines 13 to 15 - HTML Tags....................................................................................320
52.3.3 Format Email Header.........................................................................................................320
xx
Komodo User Guide
Table of Contents
52 XSLT Tutorial
52.3.3.1 Lines 18 to 21 - Select HEADER content................................................................320
52.3.3.2 Lines 22 to 29 - call-template...................................................................................320
52.3.4 Process Email.....................................................................................................................320
52.3.4.1 Lines 33 to 34 - Process First Message.....................................................................321
52.3.4.2 Lines 36 to 39 - Process Email Body........................................................................321
52.3.5 Format Email Addresses....................................................................................................321
52.3.5.1 Lines 45 to 52 - Format Email Addresses.................................................................321
52.4 Running the Program...................................................................................................................321
52.5 Debugging the Program...............................................................................................................322
52.6 More XSLT Resources................................................................................................................323
52.6.1 ASPN, the ActiveState Programmer Network...................................................................323
52.6.2 Documentation...................................................................................................................323
52.7 Tutorials and Reference Sites......................................................................................................323
xxi
Komodo User Guide
Table of Contents
54 Komodo FAQ.............................................................................................................................................337
54.1 Where is Komodo installed?........................................................................................................337
54.2 Where does Komodo keep settings data?....................................................................................338
54.3 Where does Komodo log output and errors?...............................................................................338
54.4 Komodo doesn't start. Why?........................................................................................................338
54.5 Why can't I see my Left or Right Pane........................................................................................339
54.6 I can't see my Bottom Pane..........................................................................................................339
54.7 I want to maximize the Editor Pane.............................................................................................339
54.8 How do I know if I'm debugging?...............................................................................................339
54.9 How do I know if I'm editing?.....................................................................................................339
54.10 How can I add command-line arguments to my program for debugging?................................339
54.11 Komodo crashes. What can I do?..............................................................................................340
54.12 Why is Komodo so big?.............................................................................................................341
54.13 I already have Mozilla. Why do I need to have two versions?..................................................341
54.14 I'm having trouble debugging PHP. What do I do?...................................................................341
54.15 How do I emulate sessions in PHP debugging?.........................................................................342
54.16 Why don't breakpoints work when I use the Psyco extension in Python?.................................343
54.17 How do I configure Virtual Hosting on an Apache Web server?..............................................343
54.18 I moved my Komodo installation on Linux, and am now getting Perl debugging errors..........344
54.19 How do I prevent the dialog from displaying every time I start the debugger?........................344
54.20 Why do I get a CGI security alert when debugging PHP?........................................................344
54.21 When I click Check Configuration on the Start Page, Komodo reports that a language that
is installed on my system is not available. Why?...............................................................................344
54.22 My screen goes black for a second or two whenever I open files for which Komodo
performs background syntax checking. Why?....................................................................................344
54.23 How can I run additional CVS commands from within Komodo?............................................345
54.24 Why doesn't Ruby debugging work on my Linux x64 system?................................................345
xxii
Komodo User Guide
Table of Contents
57 OS X Key Bindings (Default)....................................................................................................................354
57.1 OS X Scheme...............................................................................................................................354
57.1.1 Code Browser.....................................................................................................................354
57.1.2 Code Intelligence................................................................................................................354
57.1.3 Debugger............................................................................................................................354
57.1.4 Editor..................................................................................................................................354
57.1.5 Find.....................................................................................................................................357
57.1.6 General...............................................................................................................................357
57.1.7 Help....................................................................................................................................358
57.1.8 Macro..................................................................................................................................358
57.1.9 Source Code.......................................................................................................................358
57.1.10 Source Control..................................................................................................................358
57.1.11 Tools.................................................................................................................................359
57.1.12 User Interface...................................................................................................................359
57.1.13 Snippets............................................................................................................................359
59 Vi Key Bindings..........................................................................................................................................368
59.1 Vi Emulation................................................................................................................................368
59.1.1 Custom Vi Commands.......................................................................................................369
59.2 Vi Scheme....................................................................................................................................369
59.2.1 Vi-specific key bindings.....................................................................................................370
59.2.2 Code Browser.....................................................................................................................371
59.2.3 Debugger............................................................................................................................371
59.2.4 Editor..................................................................................................................................371
60 XML Catalogs............................................................................................................................................374
60.1 Using an Existing XML Catalog.................................................................................................374
60.2 Creating an XML Catalog............................................................................................................374
60.3 XML Catalog Resources..............................................................................................................375
xxiii
Komodo User Guide
Table of Contents
61 User-Defined Language Support
61.2.1 A Sample............................................................................................................................376
61.3 Luddite in a Nutshell....................................................................................................................377
61.4 Families........................................................................................................................................377
61.5 Styles............................................................................................................................................378
61.6 Keywords.....................................................................................................................................378
61.7 Pattern Variables..........................................................................................................................379
61.8 States and Transitions..................................................................................................................379
61.8.1 The Initial State..................................................................................................................380
61.8.2 Specifying State Transitions...............................................................................................380
61.8.3 Include, Upto, and EOF Conditions...................................................................................380
61.8.4 Redo and Lookahead..........................................................................................................381
61.8.5 Preventing Keyword Promotion.........................................................................................381
61.8.6 Pattern Syntax.....................................................................................................................382
61.8.7 Pushing States.....................................................................................................................382
61.8.8 Handling Newlines.............................................................................................................383
61.8.9 Supporting Arbitrary Delimiters........................................................................................383
61.8.9.1 Supporting Here Documents.....................................................................................385
61.9 Disambiguation............................................................................................................................386
61.10 Specifying Folding.....................................................................................................................387
61.11 Recognizing XML Vocabularies...............................................................................................387
61.12 Compiling and Installing...........................................................................................................387
61.13 Samples......................................................................................................................................388
61.14 Luddite Reference......................................................................................................................388
61.15 Keywords...................................................................................................................................388
61.16 Style Names...............................................................................................................................393
61.17 Terms.........................................................................................................................................394
61.18 Concepts.....................................................................................................................................395
xxiv
1 Welcome to the Komodo User Guide
Komodo FAQs
Komodo Forums
1.5 Tutorials
Helpful introductions to Ruby on Rails, JavaScript, Ruby, PHP, Perl, Python, XSLT and Run
Commands.
History: Navigation (forward and back) buttons and a drop list in the toolbar that let you browse
though the files and buffer locations you've been editing recently.
2.3.2 Startup
The first time Komodo is run after installation, it must register a number of components with the
operating system. This causes the first launch to be considerably slower than subsequent launches.
2.3.3 Editing
Tabstop syntax has changed in Komodo 5.0. Abbreviation from the Toolbox|Samples directory of
pre-5.0 versions of Komodo will not work as expected with the current implementation. Delete the
older versions to use the ones featured in the "Samples (5.0.0)" directory. Alternatively, if you have
made modifications to these snippets or have implemented your own using tabstops linked by name,
consult the documentation and revise them using numbered linking.
By design, Komodo does not attempt Replace in Files operations on unknown file types. However,
file association preferences can be used to associate a user-defined extension with a language category
(e.g. "Text") which then enables replacements for that file type.
Linux users may need to install the SCIM platform packages for non-ASCII text entry. See "Linux
Software Prerequisites" in the Installation Guide for details. (Bug 70812)
Autocompletion on the following Python Win32 modules is not yet available: dbc, perfmon,
pywintypes, win2kras, dde, pythoncom, and the binary sub-modules of win32com.
The macro recorder will record events that it cannot handle, such as the opening of dialogs. The only
dialog that can be opened via a macro is the Find dialog; other dialogs will cause the macro to stop.
Languages that are read right to left and Asian languages are not supported. All Latin and Cyrillic
languages are fully supported. (Bug 29702)
On slow networks, users may notice performance degradation when editing files on network
machines. Performance can be improved by disabling the Komodo function that checks if files on disk
have changed. Use the Editor Preferences to disable this feature. (Bug 18297)
Interpolation shortcuts in snippets are not executed when the snippet is inserted in the Editor Pane via
dragging and dropping.
On Linux, GTK2 hard codes 'Ctrl'+'Shift' to use international input. Therefore, all key bindings
involving 'Ctrl'+'Shift'+ (any valid hexadecimal character) do not work in Komodo. A workaround is
to start Komodo with the command: export GTK_IM_MODULE=xim; ./komodo'. Otherwise,
key bindings of this kind must be changed. (Bug 38205)
When copying text that does not have Windows line endings into another application, which expects
Windows line endings, the text may not retain the desired formatting. The text is often pasted as a
single line. (Bug 36791)
Code snippets that are 8-bit-encoded and contain high-bit characters may have the wrong encoding (or
no encoding) when inserted from the Toolbox into a UTF-8 encoded file in the Editor Pane. (Bug
36769)
When editing a code comment in Komodo you may use <Shift+Enter> to start a new line within the
comment -- the comment prefix is added automatically. Komodo may fail to properly add the
comment prefix if many new lines are added quickly with repeated <Shift+Enter> presses. (Bug
38658)
2.3.4 Debugging
PHP: A non-empty doc_root setting in php.ini causes a 'No input file specified' error when starting
a local debugging session with CGI emulation. The Web Developer Suite 2.0 package and others use
this setting, and it is copied into the debugging version of php.ini during PHP auto-config. Comment
this setting out in the file specified in 'Preferences|Languages|PHP|Path to alternate PHP configuration
file' to avoid this problem.
Python: Breakpoints will not work with the Psyco extension enabled. The Komodo FAQ has a
work-around solution.
Tcl 8.5: Tcl Beta releases contain only version-specific executables (e.g. tclsh85.exe and
wish85.exe). Komodo does not automatically find these in the path. To use them, specify the
executables manually in Edit|Preferences...|Languages|Tcl|Interpreters, or create non-versioned
symlinks/shortcuts to the versioned executables.
The Perl debugger uses alarm() internally. This can conflict with some Perl frameworks and
modules (such as POE) which use alarm() as well. To work around this problem, add alarm=0 to
the PERLDB_OPTS environment variable (in the Environment tab of the Debugger Options) which
stops the debugger from using alarm(). With this work-around in place, the Break Now button and
menu item will not work in debugging sessions.
Using the JavaScript debugger on files with mapped URIs can yield confusing results. Komodo will
2.3.3 Editing 4
Komodo User Guide
open the mapped source file rather than querying Firefox for the runtime JavaScript.
Python debugging with IronPython does not currently work as there is no support for Python
debugging hooks in IronPython.
In PerlApp executables, it is now possible to step into loaded modules, but not to set breakpoints in
them.
The Komodo JavaScript Debugger is incompatible with the FireBug Firefox extension. FireBug must
be manually disabled (Tools|Firebug|Disable Firebug) for the JavaScript debugger to work. (Bug
47208)
PHP 5.0.0, 5.0.1 and 5.0.2 do not work with the debugger extension. Use PHP versions 4.3.10 or
greater, or 5.0.3 or greater, including 5.1.
If the debug listener (Debug|Listen for Debugger Connections) is off, multithreaded applications
may not run or debug as expected. Only the main thread operates through the debugger. To debug
multithreaded applications, turn on debug listening prior to debugging. (Debug listening is turned on
by default.) (Bug 32776)
PHP configurations that use Zend Extensions (such as PHP Accelerator) are not compatible with the
Komodo PHP debugger. (Bug 21890)
Due to the way the core Perl interpreter works, it is not possible to step over "require" statements.
(Bug 18776)
You cannot debug 'freestanding' executables created with the PDK in Komodo. Instead, build a
'dependant' executable, which requires a local install of ActivePerl.
The variable watcher does not work when debugging
\\machine\d$\path\to\perl_script.pl. It does work when opening the same file via a
UNC path that does not include a '$' character. (Bug 19558)
When debugging remote applications, Komodo fails if the remote process does not have valid stdout
and stderr handles. GUI applications, such as those started with "wperl.exe" or "pythonw.exe", or
those using the Pythonwin or wxPython frameworks, or those with certain embedded applications,
can have invalid stdout and stderr handles. Until we resolve this issue, try to run and debug your
remote program under perl.exe or python.exe.
Python, XSLT and PHP debugging require TCP/IP to be installed and properly configured, even if
you are debugging scripts locally. While TCP/IP is configured by default on most systems, early
versions of Windows may require manual TCP/IP configuration.
When debugging a GUI script in Komodo, adding a "watched variable" when not stopped at a
breakpoint can cause Komodo to hang. You must manually terminate the script being debugged to
stop Komodo from hanging. The problem occurs because the GUI script, while in its message loop,
does not respond to Komodo's request for the variable value. (Bug 23516)
If the Komodo debugger is configured to use a specific port, when Komodo is shut down, the port is
sometimes not immediately released. If Komodo is restarted before the port is released by the
operating system, a message is displayed advising that the system is unable to bind that port. As a
workaround, we suggest configuring port 0 as the Komodo debugging port and using the debugger
proxy for remote debugging. (Bug 32821)
Breaking into a running Perl script can only occur while crossing sub boundaries in the Perl code, as
that's currently the only chance the Perl debugger has to check to see if the IDE has sent the break
command. (Bug 35611)
When debugging Perl, if you set a breakpoint on the while statement, the debugger stops on the
breakpoint only once, namely before the first pass through the loop. This is a limitation in the Perl
interpreter. (Bug 34866)
Komodo debugger uses TCP/IP networking for communications. On systems with firewalls installed,
the debugger may fail if the firewall is not configured to allow Komodo to listen for connections. On
Windows, you may see a "Windows Security Alert" dialog asking if you want to allow Komodo to
listen for connections, you will need to unblock Komodo. (Bug 21684)
2.3.4 Debugging 5
Komodo User Guide
The Perl debugger cannot trap fatal runtime errors. Users can accomplish this in their code by
wrapping problematic code in an eval block, and then testing for an exception. (Bug 33855)
Komodo does not provide proper source debugging in Python exec and eval statements. This is a
limitation of Python's interpreter. (Bug 40336)
When debugging PHP on a remote Linux machine from a local Windows machine, the debugging
option "Try to find files on the local system when remote debugging" has no effect. This is due to
differences in Unix and Win32 file paths. (Bug 39137)
When debugging Python, Komodo does not permit you to set local variables in the interactive shell.
However, you can edit those values from the program's variable viewers, such as the Watch and
Locals panes on the Debug tab. (Bug 36794)
When debugging PHP scripts on Komodo with CGI emulation, you may need to change the setting
for cgi.force_redirect in the php.ini file. You may also need to set an environment variable in
the Debugger Options dialog box: "REDIRECT_STATUS=200 OK". These settings vary depending
on your system and the configuration of PHP. (Bug 35021)
When Debugging PHP, the HTML pane of the Output tab does not refresh automatically. To refresh
the contents of this pane, click the "Reload HTML view" button on the Output tab. (Bug 36999)
Komodo supports full Unicode debugging with Perl 5.8. Although Perl 5.6 can be used for debugging
programs with single-byte encodings (e.g. cp1251), it is recommended that programmers with
multi-byte character sets upgrade to Perl 5.8.5 or better. (Bug 36760)
When debugging Python, if you launch the debugger from a directory containing a module with the
same name as one of the modules used by the debugger, the wrong file is used. For example, if you
have a file named logging.py in the directory where the debugger is launched, the debugger will fail.
(Bug 36783)
When stepping through Perl files, the Komodo debugger displays the wrong print results in the Locals
window of the Debug tab. This is because Perl provides only one iterator for each collection variable.
The Komodo debugger must iterate through a hash or an array in order to display the values in
Komodo. A workaround is to display the Watch pane instead of the Locals pane, and type the names
of the expressions that you want to view. (Bug 33668)
As of Komodo 5.0, the Perl debugger emits numeric hash keys with embedded underscores. For
example, a hash key of '123456789' now appears in the variables tabs as '123_456_789'.
Breakpoints don't work in files with symlinks in their path. The debugger engine calculates whether to
break based on the actual file path. To work around this limitation, load the file in Komodo using the
real path, or create a hard link (e.g. on Linux, use 'ln' without the '-s' option). (Bug 79147)
Komodo's integration with the Perforce commit/submit command cannot commit files that are not in
the default changelist. These files must be submitted via an external interface (e.g. p4, P4Win). Note
that any files checked out inside Komodo are in the default changelist, so this limitation should only
apply to users who already use an external interface to their Perforce repository. (Bug 27070)
If the Perforce connection cannot be established, checking the status of files in a Perforce repository
will hang Komodo. (Bug 35058)
If you are using CVS Source Code Control, note that the very first time you log in to a repository,
cvs.exe fails to create the .cvspass file correctly and will return an error. Repeat the command to login
a second time and correctly generate the file. This is a CVS bug. (Bug 20353)
2.3.7 Mac OS X
If you have two drives with the same name, and you use the file open dialog in a Mozilla application,
the directory menu (top middle of dialog) may crash when clicked. To avoid this, rename one of the
hard drives.
New Custom Menus created in a Project or in the Toolbox will not appear until Komodo has been
restarted.
Throughout the Komodo documentation there are references to key bindings that use the 'Meta' key.
This key may be better known to OS X users as the 'Command' key. (Bug 41959)
Komodo will shut down and restart itself the first time it is run after installation. (Bug 40143)
Display of text during editing ("painting") may sometimes be slow or pause momentarily.
Certain UI elements stop working after changing key bindings. Restarting Komodo fixes this. (Bug
38683)
When saving a file, Komodo does not set file information (type and creator) for the OS X Finder to
know that Komodo created the file. (Bug 38745)
Breakpoints cannot be removed when debugging XSLT scripts. (Bug 40072)
PHP debugging will not work with the PHP build distributed with OS X because it does not load
external modules. To use PHP debugging on OS X, build PHP from source or download a binary
from http://www.entropy.ch/software/macosx/php
(Bug 39901)
Komodo is sometimes recognized as a web browser by some applications on OS X (e.g. Safari's
"Default Web Browser" setting). Using Komodo as the default web browser is not recommended.
Application menu items that have multi-key key bindings will not show their key bindings in a pop-up
tool tip on OS X. This is a limitation in OS X.
Context menus may not display unless you hold down the mouse button for a period of time. This is
because the Komodo editor is implemented in Mozilla as a plugin, and it does not access the
appropriate context menu event to handle this behavior properly without interfering with other mouse
events (for example, drag and drop). (Bug 41216)
Due to a limitation in the Mozilla code base, key bindings for the Next File and Previous File options
on the Window menu are not displayed next to the menu items. The key bindings are
'Meta'+'PageDown' to view the next file and 'Meta'+'PageUp' to view the previous file. (Bug 40716)
2.3.8 Linux
The Fonts and Colors pane in the Preferences dialog box displays the same list of fonts in both the
Fixed and Proportional lists. There is no programmatic way to identify whether a font is proportional
or not on GTK; therefore, users must know the properties of the individual fonts when modifying
these values. (Bug 27206)
Install Komodo into a directory path that only includes alphanumeric characters. Komodo is known to
have trouble with paths that include spaces and some non-alphanumeric characters.
2.3.9 Other
A limitation in the parser used by the DOM Viewer causes HTML elements embedded in JavaScript
strings to appear as element nodes of the current document. Placing the JavaScript in a CDATA
section or a comment avoids this problem.
Komodo inherits a Mozilla bug whereby certain video drivers on Windows cause Komodo to crash. If
you experience this behavior, upgrade your video driver to the latest version. If the problem persists,
reduce the color definition assigned to the driver (Control Panel|Display|Settings). (Bug 32746)
Komodo inherits a Mozilla bug regarding display on dual-monitor systems where the secondary
monitor is to the left of the primary monitor (causing negative coordinate results). The Komodo
display occasionally fails to refresh; Komodo must be stopped and restarted to fix the display (Bug
26852)
When using Komodo's Preview in Browser feature, users running Mozilla on Windows XP Pro,
Windows 2000 Pro and Windows 98 may find that they cannot exit Komodo if Mozilla is still open. If
this should occur, close all open browser windows before exiting Komodo. (Bug 26431)
The Palm Desktop for Windows software makes exclusive use of the 'Ctrl'+'Shift'+'T' key
combination, thus making this combination unavailable in Komodo. (Bug 27851)
When using the PDK Build Standalone Application feature in Komodo with Perl 5.8.0 on a Linux
installation where the environment is set to use UTF-8, you must add a module 'utf8' on the modules
tab. This is the equivalent of 'perlapp --add utf8'. This does not affect Perl 5.6.x or future versions of
Perl 5.8.1 or higher. (Bug 26898)
On Windows NT, some interactive commands may not work properly when run from the Command
Output tab of the Output Pane. You must run these commands in a separate shell. (Bug 23176)
Perforce client version 2001.1 and previous for Windows is known to hang when used for Komodo's
Perforce integration. Upgrading to the most recent version of Perforce is known to fix the problem.
(Bug 19959)
The Output tab cuts off lines at 250 characters. (Bug 20711)
Macros will not record certain commands, including (but possibly not limited to)
'Ctrl'+'Shift'+'B'|'R'|'E'|'D' (toggle toolbars or button text), 'Ctrl'+'Shift'+'N' (new default file), and
View as Language menu items.
If you are using the Pop-Up Stopper ad-blocking program (Pop-Up Zapper on OS X), it will close the
2.3.8 Linux 8
Komodo User Guide
Rx Toolkit window immediately after it is opened. (Bug 21768)
When you schedule a new file to be added using CVS, CVS will not permit you to remove the file
from the repository using the "revert changes" command. (Bug 27192)
Users of the Japanese version of Windows XP may experience difficulties in starting Komodo.
The Open field in the Open/Find Toolbar does not automatically display a drop-down list of
directories when an UNC path is typed. Currently, the list is only displayed when a the path includes a
subdirectory. (Bug 29011)
When creating a "diff" in Komodo (Tools|Compare Files), the line endings of the files are
normalized to Unix style line endings. Lines in files that have different line endings are not displayed
differently in the diff (unless other differences are present), but a warning is provided to the user in
the 'diff' window, or the 'no difference' dialog. (Bug 32932)
In Komodo's Rx Toolkit, the match offsets for Unicode or high-bit data are incorrect. When matching,
the program does not account for UTF-8 multi-byte characters. (Bug 33287)
When adding new key bindings via the Preferences dialog box, Komodo displays a message
indicating that the key bindings will not take effect until Komodo is restarted. However, some
changes do take effect immediately.(Bug 36710)
If you rename a folder that was added to a custom menu, the name is changed in Komodo's Toolbox
but not on the menu itself. A workaround is to move the renamed folder out and then back into the
associated custom menu icon in the Toolbox. (Bug 36679)
A newly created custom menu is added to the Toolbox but is not immediately displayed alongside
existing toolbars. Restarting Komodo causes the new toolbar to display. (Bug 40078)
2.3.9 Other 9
3 Starting Komodo
3.1 Windows
From within the Windows environment, use one of the following methods to launch Komodo:
Multiple filenames may be specified; all specified filenames will be loaded in the Komodo editor pane.
Help: -h or --help
Show Komodo version: -V or --version
Open at a specified line number: -l line or --line=line
Open with a specified range selected: -s range or --selection=range
(e.g. komodo -s 1,5-2,15 example.py would open example.py and select from line 1
and column 5 to line 2 column 15)
3.2 Mac OS X
From within the OS X environment, use one of the following methods to launch Komodo:
If you want to start to Komodo from the command line, it is best to first create the following symlink:
All command line options described in the Windows section are available.
3 Starting Komodo 10
Komodo User Guide
3.3 Linux
To start Komodo from a shell prompt, enter:
All command line options described in the Windows section are available.
Desktop icons and taskbar applets are not added automatically during installation on Linux. Check your
window manager documentation for information on creating these manually. A choice of Komodo icons is
available. By default, the icon files (.xpm) are stored in the Komodo installation directory.
3.3 Linux 11
4 Komodo Installation Guide
Windows
Prerequisites
Installing the Komodo License
Upgrading from a Previous Komodo Version
Installing Komodo on Windows
Command Line Installation Options
Starting Komodo on Windows
Uninstalling Komodo on Windows
Mac OS X
Prerequisites
Installing the Komodo License
Upgrading from a Previous Komodo Version
Installing Komodo on OS X
Starting Komodo on OS X
Uninstalling Komodo on OS X
Linux
Prerequisites
Installing the Komodo License
Upgrading from a Previous Komodo Version
Installing Komodo on Linux
Starting Komodo on Linux
Uninstalling Komodo on Linux
Language and Debugging Prerequisites
Source Code Control Integration Prerequisites
4.1 Windows
4.1.1 Prerequisites
4.1.1.1 Hardware Requirements
x86 or x86_64 processor, 500 MHz (or faster) with 512 MB RAM (Windows 2000/XP) or 1 GB
RAM (Vista).
170 MB hard disk space
340 MB of temporary hard disk space during installation
The following platforms are officially supported. Current Critical Updates, Windows Updates, and Service
Packs must be installed (see http://windowsupdate.microsoft.com).
Windows Vista
Windows XP
Windows Server 2003
Windows 2000
Installation Prerequisites:
Windows 98, Me and NT users: Microsoft Windows Installer (MSI) version 2.0 or greater ( MSI
2.0 for 9x and Me, MSI 2.0 for NT)
Windows 98/NT4 Users: Windows Scripting Host: Microsoft's Windows Scripting Host is required
by the Microsoft Windows Installer. Older versions of Windows did not include the Windows
Scripting Host. To check if your system has the Windows Scripting Host, select Run from the
Windows Start menu, and enter wscript. If the Windows Script Host Setting dialog appears, WSH
is installed on your system. If it doesn't, download the WSH from Microsoft website.
Miscellaneous Prerequisites:
Perl Dev Kit: In order to build executable programs, ActiveX controls and Windows services in Perl,
you must have ActiveState's Perl Dev Kit version 3.1 or greater installed on your system.
For minor releases (e.g. 4.1 to 4.2) and patch-level releases (4.1.1 to 4.1.2), use the auto-update system
(Help|Check for Updates). The changes will be applied safely in the current install directory. If you need to
update using an installer, completely uninstall the older version before installing the new one, or manually
specify a different install directory during the installation process. Your Komodo preferences will be
preserved as they are installed in a different directory.
If you intend to run the installation from a shared network drive, your system must have SYSTEM
rights (or greater) to the directory from which the installation is run. Alternatively, run the installation
from a local drive.
When installation is complete, you will see an ActiveState Komodo icon on your desktop.
Komodo's installer uses Windows Installer technology, which allows you to partially control the install from
the command line. For example:
You can have the Komodo installer run with a reduced user interface. For example, the following will install
silently and only open a dialog when the installation is complete.
You can generate a log of the Komodo installation with the following command:
Command line options can be used to configure Komodo installation properties. The following will install
Komodo to "E:\myapps\Komodo", instead of the default location:
Komodo is divided into a number of distinct features. In the "Customize Setup" dialog you can select which
features to install. You can also do this on the command line with the ADDLOCAL property. For example,
the following command will install just the core Komodo functionality (i.e. not the PyWin32 extensions or the
documentation.
The hierarchy denotes dependencies (i.e. to install quicklaunch you must install the env.
The register option puts the Komodo location in the registry so 'start komodo' works, and adds bindings for
.kpz and .kpf Komodo project files.
Alternatively, use the Add/Remove Programs menu (accessible from the Windows Control Panel).
4.2 Mac OS X
4.2.1 Prerequisites
4.2.1.1 Hardware Requirements
4.3 Linux
4.3.1 Prerequisites
4.3.1.1 Hardware Requirements
x86 or x86_64 processor, 500 MHz (or faster) with 512 MB RAM (or greater)
170 MB hard disk space
340 MB of temporary hard disk space during installation
Komodo can also be run on the following platforms. This version of Komodo has not necessarily been tested
on these platforms; platform-specific bugs may or may not be fixed.
Installation Prerequisites:
glibc 2.4 (or higher) and libjpeg.so.62 (or higher): These libraries are included in standard Linux
distributions.
libstdc++6 (or higher)
Running Komodo on 64 bit versions of Linux will require additional 32-bit libraries (e.g. libc6 and gtk),
which may need to be installed with your system's package manager. For example:
To add Perl or Python to the PATH environment variable, do one of the following:
Modify your PATH environment variable. For example, if you use the Bash shell, add the following
line to your ~/.bashrc file:
export PATH=<installdir>/bin:$PATH
...where <installdir> points to the directory where you installed ActivePerl or ActivePython.
Create a symbolic link to the Perl or Python executable. For example, for ActivePerl, enter:
ln -s <installdir>/bin/perl /usr/local/bin/perl
ln -s <installdir>/bin/python /usr/local/bin/python
...where <installdir> points to the directory where you installed ActivePerl or ActivePython.
For minor releases (e.g. 4.1 to 4.2) and patch-level releases (4.1.1 to 4.1.2), use the auto-update system
(Help|Check for Updates). The changes will be applied safely in the current install directory. If you need to
update using an installer, completely uninstall the older version before installing the new one, or manually
specify a different install directory during the installation process. Your Komodo preferences will be
preserved as they are installed in a different directory.
cd Komodo-<version>-<platform>
4. Run the install script ("install.sh"):
./install.sh
5. Answer the installer prompts:
6. Specify where you want Komodo installed, or press 'Enter' to accept the default location
(/home/<username>/Komodo-<IDE|Edit>-x.y).The -I option can be used to
specify the install directory. For example:
./install.sh -I ~/opt/Komodo-IDE-4.2
If multiple users are sharing the system and will be using the same installation, install
Komodo in a location every user can access (e.g. /opt/Komodo-x.x/ or
/usr/local/Komodo-x.x/).
Note:
7. Once the installer has finished, add Komodo to your PATH with one of the following:
Add Komodo/bin to your PATH directly:
export PATH=<installdir>/bin:$PATH
Add a symlink to Komodo/bin/komodo from another directory in your PATH:
ln -s <installdir>/bin/komodo /usr/local/bin/komodo
Note: Creating symlinks in system directories such as /usr/bin requires root access.
After completing the installation, you can delete the temporary directory where the Komodo tarball was
unpacked.
Note: You cannot relocate an existing Komodo installation to a new directory by simply moving it. You must
uninstall Komodo from the existing location and reinstall it in the new location.
5.2 Menus
The default drop-down menus are: File, Edit, Code, View, Debug, Project, Toolbox, Tools, Window, and
Help. The functions accessed from each menu are described in detail in the relevant section of the User
Guide. For example, the items accessed from the Debug menu are described in Debugging Programs.
Note: On Mac OS X systems, a menu labelled Komodo is displayed to the left of the File menu. On OS X,
Komodo's Preferences dialog box is accessed by clicking Komodo|Preferences.
Menu Bar Areas and Toolbar Areas: Options to view or hide individual toolbars and toolbar text
(unavailable on Mac OS X).
Projects Sidebar (Project Name): Options to open, save, activate, and close the projects, and to add
a file to the selected project.
Projects Sidebar (File Name): Options to edit, remove or export the selected file ,and access to
source code control commands.
Toolbox Sidebar: Options to work with the specified component.
Editor Pane (File Editing Area): Options to cut, copy, and paste text, to set a breakpoint, and to edit
the file properties and settings.
Editor Pane (Tabs): Options to close the selected file and to view the file's properties and settings.
Bottom Pane: The context menus available on tabs in the Bottom Pane (e.g. the Debug tab and the
Breakpoints tab) contain subsets of Komodo's top-level menus.
5.4 Toolbars
To hide or show toolbars, or to hide or show button text, do one of the following:
The Standard Toolbar provides quick access to common editing functions. Launch the Komodo User Guide
by clicking the Help button.
The Debug Toolbar provides quick access to common debugging functions, such as Step In and Step Over.
For more information about debugging programs, see Debugging Programs.
The Source Code Control Toolbar (Komodo IDE only) makes it easy to work with files that are stored in
Perforce or CVS. For more about using the Source Code Control Toolbar, see Source Code Control.
For users of PDK 6.0 and later, the PDK Toolbar provides quick access to Perl Dev Kit tools. Buttons for
launching the core PDK tools (PerlApp, PerlSvc, PerlCtrl, and PerlTray) are grayed out unless a Perl file is
the active file in the Editor Pane. Availability of buttons depends on which features are included in your PDK
version. If the PDK is not installed on your system, all toolbar options are grayed out when the PDK Toolbar
is displayed. For more information on how the PDK integates with Komodo, see Komodo and the Perl Dev
Kit.
It is also possible to create Custom Toolbars consisting of items in the Toolbox or Komodo projects (e.g. run
commands, code snippets and directory shortcuts).
5.4 Toolbars 23
Komodo User Guide
Related Topics:
Related Topics:
Code Browser
Managing Sidebars, Tabs and Panes
Related Topics:
DOM Viewer
Managing Tabs and Panes
Related Topics:
Related Topics:
Sharing Toolboxes
Managing Tabs and Panes
Related Topics:
Editing Files
Managing Projects and Files
Managing Tabs and Panes
Breakpoints Tab: manage breakpoints and spawnpoints in the current debugging session(s)
Command Output Tab: displays the results of commands run in the Run Command dialog box
Find Results Find Results 2 Tabs: display the results of the Find All, Find in Files or Replace in
Files functions
SCC Output Tab: displays details of source code control commands, such as editing or checking in
files
Interactive Shell Tab: displayed when the interactive shell is launched as a stand-alone tool or from
within a debugging session
Debug Tab: consolidates views of the debugger output, call stack, program variables (local and
global), and watched variables.
The Breakpoints, SCC Output, Interactive Shell, and Debug tabs are only available in Komodo IDE.
To open a sample program, double-click the file name on the Projects sidebar. The contents of the file will
display in the Editor Pane.
1. Breakpoints: In the sample program, click on the gray margin to the immediate left of the Editor
Pane. A green circle will appear, indicating that a breakpoint has been set. When you run the
debugger, program processing will stop at lines where breakpoints have been set.
2. Start / Step Over / Step In: To start debugging, click the "Go" button on the Debug Toolbar. When
debugging begins, the Bottom Pane will be displayed beneath the Editor Pane in the Komodo
workspace. The program will run until a breakpoint is encountered; when program execution pauses
at a breakpoint, click "Step In" to move through the program in single line increments, or "Step Over"
to execute the entire function (as applicable), or "Step Out" to execute the remainder of a function (as
applicable).
3. Debug Tab: The tab labeled Debug: <filename> is displayed when debugging begins. In addition to
the debug output, the Debug tab displays the call stack, variables, and variable values.
7.1 Documentation
Have a look through this user guide to see if there is any relevant documentation. Use the Search field in the
top right corner of the Komodo Help window to search the table of contents.
http://community.activestate.com/products/Komodo
komodo-discuss@listserv.ActiveState.com:
http://aspn.activestate.com/ASPN/Mail/Browse/Threaded/komodo-discuss
komodo-beta@listserv.ActiveState.com:
http://aspn.activestate.com/ASPN/Mail/Browse/Threaded/komodo-beta
http://bugs.activestate.com/query.cgi
Try a few searches using different keywords related to the problem; someone else may have reported the same
problem, but described it slightly differently. If you can't find an existing bug, submit a new one. A set of
guidelines for writing up a bug can be found here:
http://bugs.activestate.com/page.cgi?id=bug-writing.html
http://bugs.activestate.com/enter_bug.cgi
Your bug will be assigned a bug ID (and related URL) that you can use to monitor the progress of the bug.
The system can also email you when your bug is resolved.
the version of Komodo (copy the Build Information listed in "Help|About Komodo").
your operating system version
relevant details of any associated software you are running (e.g. PHP version, SCC type, filesystem
type)
Komodo projects are containers for files, folders, templates, macros, run commands, snippets and links
specific to a particular software project or website. There are two types of Komodo projects:
Live Projects: A live project does a Live Import of the directory where the project is created, thereby
including all the files and sub-directories of that directory. This becomes the live project's base
directory. Changes in the filesystem are reflected in the project, and deleting files from the project
gives you the option to delete them from the filesystem (the "Move to Trash" option). This kind of
project is essentially a top-level live folder.
Static Projects: Static projects are virtual containers for project components, similar to virtual
folders. They can, however, contain live folders.
By default, new Komodo projects are "live". This can be changed with the Live Import preference.
Komodo projects are XML files stored on disk with a ".kpf" extension. If you manually edit the project file,
make a backup copy first; invalid project files will not load.
Components can be dragged and dropped between projects and the Toolbox. Context menus are available for
the various components and a Project drop-down menu. New items can be added via the Add item drop-down
menu in the project tab's toolbar.
View|Tabs & Sidebars|Projects: Opens the left pane with the Project sidebar in the foreground.
Key Binding: The default key binding for opening and closing the left pane is 'Ctrl'+'Shift'+'P'. See
Configuring Key Bindings to alter or view the current assignment.
Workspace Toolbar: If the Workspace Toolbar is displayed, click the Show/Hide Left Pane button.
(Select View|Toolbars|Workspace to display the toolbar.) Alternatively, click the Show Specific
Sidebar/Tab button and select Projects.
Project Menu: On the Project menu, click New Project From Template..., select the desired project
template and click Open.
Projects Sidebar: Project Tools|New Project
When creating a new project, you are prompted to select a directory where the project file is stored. The
project filename becomes the project name displayed in the Projects Sidebar (without the ".kpf" extension).
"Live" projects will automatically import the files and sub-directories in this directory.
Recently opened projects can be accessed from the Komodo Start Page, or from the File|Recent Projects
menu. (The number of recently opened projects is determined by the Most Recently Used preference.)
The project name and associated files are displayed on the Projects tab. By default, opening a project only
opens the project file, not the components associated with the project. The Opening and Closing Projects
preferences can change this behavior to automatically open recent project files (and close them when the
project is closed).
Knowing which project is currently active is important because file preferences can be stored in projects.
Komodo chooses a location for saved preferences based on the following criteria:
When debugging a file in the active project, preferences are stored in the active project.
When debugging a file in a project which is open but not active, preferences are stored in the first
project found containing that file.
When debugging a file that is not in an open project, preferences are saved as a 'global' preference for
that file.
To set the active project, right-click the desired project name and select Make Active Project, or select
Project|Make Active Project from the drop-down menu.
Filesystem-based components consists of items that exist as entities on the disk: files and templates.
Komodo-specific components exist only in Komodo, and are not stored as external disk entities.
Komodo-specific components include open shortcuts, folders, snippets, run commands, URL shortcuts,
macros and custom menus and toolbars.
Within projects, filesytem-based components are merely references; they cannot be moved or deleted from
within Komodo; moving them between projects and the Toolbox, or deleting them from projects or the
Toolbox, has no effect on their actual disk-based location or their contents. On the other hand,
Komodo-specific components (such as macros and snippets) do not exist outside of Komodo; therefore, they
can be moved and copied (for example, from the Toolbox to the Projects sidebar) and deleted independently
of the filesystem.
For example, when a snippet (a Komodo-specific component) is copied from the Projects sidebar to the
Toolbox, a new copy of the snippet is created; the original version still exists in the original location.
Subsequent modifications of the snippet in the Toolbox do not change the version of the snippet stored in a
project. On the other hand, when the contents of a file (a filesystem-based component) are changed, the
changes apply regardless of the location from which the file is invoked.
Project|Add: Use the Project drop-down menu. If multiple projects are open, the component is added
to the project that is currently active.
Project|Add|project_name: When a project name is selected in the Projects sidebar, the selected
project's name is also displayed in the Project drop-down menu. Components can be added directly to
that project.
Add Button: Use the Add button on the Project tab. If multiple projects are open, the component
will be added to the project that is currently selected.
Context Menu: Right-click a project name and select Add|component.
Drag and Drop: Drag and drop components from:
Drag-and-Drop-Aware Applications: Filenames can be dragged from drag-and-drop
applications (such as Windows Explorer).
Projects or Toolbox sidebars: Components can be dragged between projects, the Toolbox
and container components (such as folders).
Editor File Name Tabs: When a file is open in the editor pane, drag and drop from the tab
that displays the filename to a project.
Import from Filesystem: Right-click a project and select Import from File System.
Cut/Copy/Paste: All components have a right-click menu that includes the options Cut, Copy and
Paste. Use these options to move components between projects, the Toolbox and container
components.
Some components have special component-specific mechanisms for being added to projects. For example,
snippets can be created and added to a project in one step by selecting a block of text in the Editor Pane and
dragging it onto a project. URL shortcuts are created by dragging and dropping a URL from a browser address
bar or from the Editor Pane onto a project. Refer to the specific component sections for more information
To remove a component from a project, click the desired component and press 'Delete', or right-click the
component and select Delete from the context menu.
Komodo-specific components (such as run commands, macros, etc) are permanently deleted.
Filesystem-based components (such as files and dialog projects) are not; only the reference to the component
within the project is removed.
Column contents depend on the type of component. For example, the Status and Depot Rev display options
only have contents if the component is part of a source code control repository.
Date: The date from the filesystem when the component was last saved.
Size: The filesystem size of the component.
Status: The source code control status of the component.
Rev: When a component is part of a source code control repository, this column displays the revision
number of the local version of the file.
Depot Rev: When a component is part of a source code control repository, this column displays the
revision number of the repository version of the file.
Action: When a component is part of a source code control repository, this column displays the
current action (if any) being performed on the file. For example, if a file is currently opened for
editing, the action is "edit".
Name: The name of the component. For filesystem-based components (such as files and dialog
projects), the name is equivalent to the filename. For Komodo-specific components (such as macros
and run commands), the name is the user-defined name assigned to the component.
The mechanisms described above can also be used to save a project to a new project file by selecting Save
Project As... rather than Save. Filesystem-based components (such as files and dialog boxes) are relative
references rather than actual entities; in the new project, the reference to the location of the component is
preserved. Komodo-specific components (such as macros and run commands) are copied to the new project;
there are independent versions of the component in the original project and in the new project.
If the project or its components are stored in a source code control system, Refresh Status also checks the
repository status of the file. Komodo determines whether a file is contained in an SCC repository by the
following methods:
Perforce: query of the P4 repository (with the current user's client spec)
CVS: analysis of the CVS control directories
Subversion: analysis of the subversion control files
To export a project and its contents to an archive, select Project|project_name|Export Package from the
drop-down menu, or right-click the project and select Export Package.
The Package Export Wizard prompts for a Package Name and a Export Location. The Package Name is the
file in which the package is stored; it will have the extension ".kpz", and can be opened by any archiving
utility that supports libz (for example WinZip).
Exported packages can only be imported into "container" objects in Komodo, such as projects, the Toolbox,
and folders within projects and the Toolbox.
To import the contents of a package into a project, right-click the project to which you want to import the
package, and click Import Package. The Package Import Wizard prompts for the name of the package and
the location on disk where the files will be extracted. Click Next and then click Finish to complete the import.
For information about importing packages to the Toolbox or a folder, see Toolbox - Import Package and
Folders - Import Package for more information.
Project Menu: On the Project menu, click Import from File System. This imports the specified
filesystem (according to the criteria described below) into the current active project. If a project name
is currently highlighted in the Projects sidebar, the Project menu contains an option for importing into
the selected project (Project|project_name|Import from File System).
Project Context Menu: Right-click the desired project and select Import from File System.
Directory to import from: Specify the directory from which you want to import files. Use the
Browse button to navigate the file system.
Browse for directory location: Choose Locally... to browse the local filesystem or Remotely... to
browse a remote filesystem.
Files to include: Specify the filenames to include. Use wildcards ("*" and "?") to specify groups of
files. Separate multiple file specifications with semicolons. If the field is left blank, all files in the
specified directory are imported.
Files and directories to exclude: Specify the file and directory names to exclude. Use wildcards ("*"
and "?") to specify groups of files. Separate multiple file specifications with semicolons. If the field is
left blank, no files in the specified directory are excluded.
Import Subdirectories Recursively: Select this check box to import directories (and files contained
in those directories) located beneath the directory specified in the Directory to import from field.
This check box must be checked in order to specify the "Import Directory Structure" option as the
Type of folder structure to create.
Type of folder structure to create:
Import directory structure: If the Import Subdirectories Recursively box is selected and
this option is selected, Komodo creates folders within the project that represent imported
directories. Thus, the directory structure is preserved within the project.
Make a folder per language: If this option is selected, imported files are organized into
folders according to the language indicated by file pattern in the filename. File associations
are configured in the Komodo Preferences. Each folder is named after the associated
language, for example, "Perl files", "XML files", etc. Files that don't correspond to a known
file pattern are stored in a folder called "Other files".
Make one flat list: If this option is selected, all the imported files are placed directly under
the project from which the Import from File System command was invoked.
When Komodo integration with a source code control system is configured, icons in the Project Manager
display the SCC status of the project file and components contained in the project. See file status icons in the
source code control documentation for more information about these icons.
Source code control functions (such as adding files to an SCC repository, or opening files contained in a
repository for editing) can be performed both on the project file, and on the components contained in the
project. To access SCC commands for a project file:
Project Menu: Click the project name in the Project Manager, then select
Project|project_name|Source Control).
Project Context Menu: Right-click the desired project and select Source Control.
Project Menu: Click the project name in the Project Manager, then select
Project|project_name|Source Control on Contents).
Project Context Menu: Right-click the desired project and select Source Control on Contents.
See Source Code Control Commands for a description of each of the commands.
Project Context Menu: Right-click the desired project and select Revert Project.
Project Menu: Select Project|Revert Project or Project|project_name|Revert Project.
Project|Revert Project reverts the active project. If a project name is currently highlighted in the
Projects sidebar, the Project menu contains an option for reverting the selected project
(Project|project_name|Revert Project).
If the project has changed since it was last saved, you are prompted to save it. If files contained in the project
are open in the editor, you are asked if you wish to close them.
To access the Project Properties dialog box, right-click the desired project name and select Properties, or
click the desired project and select Project|project_name|Properties from the drop-down menu.
Properties: Displays the name, size, and location of the project; the date and time it was created, last
modified and last accessed; and indicates if the project is read-only.
Source Code Control: Displays SCC status as applicable (SCC System, Status, Depot Revision, and
My Revision).
Debugging: Displays a subset of the settings available in the Debugging Options dialog box. These
settings will take precedence over the default debugging settings for files in the project.
Directory Import: Defines how Komodo dynamically imports files and directories into the project.
These settings override those configured in Komodo's global Directory Import preferences. Select the
Live Import check box to keep the imported directories and files current with the file system via Live
Folders.
Languages: Allows you to add additional directories to a language's path for Komodo to use when
debugging, syntax checking, or in the interactive shell. Komodo will also scan these directories for
autocomplete and calltip information.
The Komodo Toolbox stores components that are frequently used. The Toolbox is similar to a persistent
project; however, rather than storing components that are specific to a particular project, it stores components
that are used for a variety of tasks.
The Projects Manager and the Toolbox share a common set of components. Components are of two types:
Komodo-specific components (such as macros, run commands and custom menus) and filesystem-based
components (such as files and dialog projects).
Components within the Projects sidebar and the Toolbox are manipulated using an intuitive drag-and-drop
interface, by context menus, or via the Project and Toolbox drop-down menus. Component options are
accessed via the drop-down menus, or via right-click context menus.
View|Tabs & Sidebars|Toolbox: Use the View drop-down menu to modify Komodo's display
characteristics.
Key Binding: The default key binding (in the default key binding scheme) for opening and closing
the Toolbox tab is 'Ctrl'+'Shift'+'T'. See Configuring Key Bindings to alter or view the current key
assignment.
Workspace Toolbar: If the Workspace Toolbar is displayed, click the "Show/Hide Right Pane"
button. (Select View|Toolbars|Workspace to display the toolbar.) Alternatively, click the Show
Specific Sidebar/Tab button and select Toolbox.
Filesystem-based components consists of items that exist as entities on the disk: files and templates.
Komodo-specific components exist only in Komodo, and are not stored as external disk entities.
Komodo-specific components include open shortcuts, folders, snippets, run commands, URL shortcuts,
macros and custom menus and toolbars.
Within the toolbox, filesytem-based components are merely references; they cannot be moved or deleted from
within Komodo; moving them between projects and the Toolbox, or deleting them from projects or the
For example, when a snippet (a Komodo-specific component) is copied from the Projects sidebar to the
Toolbox, a new copy of the snippet is created; the original version still exists in the original location.
Subsequent modifications of the snippet in the Toolbox do not change the version of the snippet stored in the
Projects sidebar. On the other hand, when the contents of a file (a filesystem-based component) are changed,
the changes apply regardless of the location from which the file is invoked.
Some components have special component-specific mechanisms for being added to projects. For example,
snippets can be created and added to the Toolbox in one step by selecting a block of text in the Editor Pane
and dragging it into the Toolbox. URL shortcuts are created by dragging and dropping a URL from a browser
address bar or from the Editor Pane into the Toolbox. Refer to the specific component sections for more
information about these options.
To remove a component from the Toolbox, right-click the desired item and select Delete. Alternatively, click
the desired component and press 'Delete', or right-click the component and select Delete.
Komodo-specific components (run commands, macros, etc) are permanently deleted. Filesystem-based
components (files, dialog boxes) are not; only the reference to the component within the project is removed.
Both Komodo-specific components (such as run commands and snippets) and filesystem-based components
(such as files and dialog projects) can be included. The exported file can subsequently be loaded as a project
or imported into the Toolbox. This provides a mechanism for sharing a Toolbox among multiple Komodo
users; another mechanism is described in the "Shared Toolbox" section below.
The functionality of the Shared Toolbox is determined by the user's access rights to the toolbox.kpf file.
All users with "read" rights to the file are able to use items from the Toolbox. To prevent users from altering
the shared toolbox, ensure that they only have "read" (and not "write") access to the file.
The Shared Toolbox is populated by the same methods described in Adding Components to the Toolbox.
If Komodo is configured to integrate with a source code control system (SCC), status icons beside the
filenames indicate the file's current SCC status, and SCC options are available from the File menu and the
right-click context menus. This integration is described in detail in the Source Code Control section of the
Komodo documentation.
Files are manipulated in various ways: via the File menu, via context menus in the editor, via context menus
on the file tab (above the editor), and as components within projects and the Toolbox.
This document describes file functionality, such as opening, printing, and saving files. See the Editing page
for information about editing files.
To create a new file from a template, select File|New|File. The New File dialog box contains numerous
pre-defined templates organized into categories. Select the desired category, then select the desired template
within that category.
Click Open to create a file with the contents of the template file. The file is loaded in the editor.
The File|New|File menu displays a list of the most recently accessed templates. To alter the number of
template files displayed, refer to the New Files page in Komodo's Preferences.
To add a template to the Toolbox for quick access, select the desired template and click Add to Toolbox.
While most file options (such as source code control commands, viewing unsaved changes, and refreshing the
file status) are accessible regardless or whether or not the file is contained in a project or the Toolbox, some
commands are specific to the project/Toolbox environment. These commands are described below.
Open shortcuts can be created using a specific file as the context. Right-click a file in a project or the Toolbox
and select Make "Open..." Shortcut. This creates an open shortcut to the directory where the file is stored.
Exported packages can only be imported into "container" objects in Komodo, such as projects, the Toolbox,
and folders within projects and the Toolbox. See Toolbox - Exporting and Importing Toolbox Contents,
Projects - Importing and Exporting Projects via Packages, or Folders - Import Contents from Package for
more information.
Command-Line Argument: When Komodo is invoked from the command line, files can be specified
as open arguments. See Starting on Windows, Starting on OSX, or Starting on Linux for more
information.
File|Open: Use the File|Open menu option.
Projects or Toolbox sidebars: Double-click, drag and drop, or use the file's right-click context menu
to open a file contained in a project or the Toolbox.
Open/Find Toolbar: Use the Open/Find Toolbar. To display the Open/Find Toolbar, select
View|Toolbars|Open/Find.
Most Recently Used List: The most recently opened files are displayed on Komodo's Start Page.
This list is also accessible from the File|Recent Files menu. The number of files in the most recently
Use the Open field on the Open/Find Toolbar to open one or more files in the filesystem. The Open field
generates a drop-down list of files and directories as you navigate the hierarchy. To open a file, enter the file
path and name, and then press 'Enter'.
For example, to open a file named "debug.txt" in the directory C:\temp\log on a machine running Windows,
enter C:\tmp\log\debug.txt in the Open field and then press 'Enter'. As you enter each backslash, a drop-down
list displays the files and directories beneath the current directory.
Enter "./" or ".\" in the Open field to display a list of files and directories in the "current" directory. The
current directory is determined as follows:
1. Current File: If a file is open in the editor, the directory where the file is stored is the current
directory. If multiple files are open, the file that is currently displayed is the current file.
2. HOME Variable: If no files are open, Komodo checks if the system has a defined HOME
environment variable. If so, the directory specified in that variable's value is the current directory.
3. Filesystem Root: If neither of the above conditions is met, the system's root directory is used ("C:\" is
the default on Windows, and "/" is the default on Linux and Mac OS X).
To narrow the results in the list box, enter one or more characters in the name of the file or directory you wish
to open or view. (The search is case-sensitive.) Alternatively, use the arrow keys to navigate the drop-down
list. The contents of the Open field are updated as you move up and down the list with the arrow keys.
Note that you can use standard directory navigation syntax to change directories. For example, if the current
directory is /home/fred/tmp/foo, change to the /home/fred/tmp/bar directory by entering ../bar.
To open a file, press 'Enter' when the file name is displayed in the Open field. To continue navigating the
directory structure, append a frontslash or backslash to the directory name displayed in the Open field; the
drop-down list is updated with the list of files and directories that exist under the current location.
To open multiple files, specify a wildcard ("*" for a file name segment, "?" for a specific character). For
example, to open all the files with the extension ".tcl" in the directory /home/fred/tmp, enter
/home/fred/tmp/*.tcl.
At any time, press the 'Escape' key to return focus to the Komodo editor.
Komodo supports public key authentication through external key agents like ssh-agent (inlcuded with the
OpenSSH distribution) and Pageant (a companion utility for Putty). This allows you to access remote files
over SFTP or SCP without entering passwords.
ssh-agent configuration: See Jeremy Mates's "OpenSSH Public Key Authentication" guide or the
ssh-agent manual page.
Pageant configuration: See Using Pageant for authentication".
Information on configuring public key authentication with source code control (CVS and SVN) can be found
in Configuring SSH Support for CVS and Subversion.
After establishing a connection to the remote server, a list of files and directories is displayed. These files and
directories exist under the directory specified in the Look in field. Double-click a directory (indicated by a file
folder icon) to navigate the directory structure. Use the navigation buttons in the top right corner of the dialog
box to navigate the remote filesystem.
To open a single file, double-click the filename. To open multiple files, hold down the 'Ctrl' key while
clicking multiple files, then click Open.
The buttons in the top right corner of the dialog box perform various file and directory manipulation
functions. Hover your mouse pointer over the buttons for a description of their functions. To delete or rename
a file on the remote server, right-click the filename and, with the left mouse button, select the desired
command on the context menu.
When remote files are added to a project or the Toolbox, or to container components within a project or the
Toolbox, they are accessed and organized in the same manner as local files (double-clicking a file opens it in
the editor; right-clicking a file accesses file option, etc). Remote files can only be added to projects or the
Toolbox by connecting to the remote server.
Login authentication is processed when the remote file is opened, or when it is added to the Toolbox or a
project. For the duration of the Komodo session, the user name and password are remembered; closing and
opening the file uses the same authentication information as the first time the file was opened. If
authentication fails, you are prompted to enter a user name and password.
See Adding Components to Projects or Adding Components to the Toolbox for instructions on adding remote
files to the Toolbox or to projects.
To open a remote file, double-click the file name, use the assigned key binding, or right-click the file and
select Open File.
This feature also works with URIs mapped to remote filesystems (via FTP, SFTP or SCP), which in turn can
be configured for automatic authentication under Edit|Preferences|Servers.
If more files are opened than can be displayed by file tabs, click the right and left arrow buttons located in the
top right corner of the editor to view the tabs of all open files.
To re-order the position of the file tabs, drag and drop the tabs into the desired positions.
For more information about working with the editor tabs, see Editor Tab Display in the editor documentation.
If the file is stored in a project or the Toolbox, this function can also be invoked by right-clicking the file and
selecting Compare File With.
The unique characteristics of each file are displayed in different colors (red and blue by default); common
characteristics are displayed in a third color (black by default). To configure custom colors for the "diff"
window, alter the Language-Specific Coloring setting for the Other|Diff language in the Fonts and Colors
preference.
The following buttons (and default keybindings) are available in the "diff" window:
A right-click context menu is also available with the following additional options:
Copy
Select All
View Whitespace
View Indentation Guides
View Line Numbers
View EOL Markers
Word Wrap
If the component is stored in a source code control system, Refresh Status also checks the repository status of
the file. Komodo determines whether a file is contained in an SCC repository by the following methods:
To refresh the file status of the current file, right-click the file tab or right-click within the editor and select
Refresh Status. The same option is available on the right-click context menu of files in projects or within the
Toolbox.
Editor Context Menu: Right-click a file in the editor and select Source Control.
File Tab Context Menu: Right-click a file tab above the editor and select Source Control.
Toolbox or Project Context Menu: Right-click a file in the Toolbox or Projects sidebar and select
Source Control.
Toolbox or Project Menu: If a file is currently selected in the Toolbox or Projects sidebar, use the
menu to access source code control commands for the selected file.
For HTML and XML documents, two additional settings are available:
Default DOCTYPE
Default Namespace
Komodo tries to determine these values from the document's XML declaration. If the document does not have
one, the DOCTYPE and namespace can be manually set here, enabling appropriate XML autocompletion.
XHTML 1.1 is the default if no declaration or settings are present.
Printing style is configured on the Printing page in Komodo's Preferences. Alternatively, select
File|Print|Print Settings to display the Printing preferences page.
Select File|Print|Print Preview contains features for setting the scale and orientation of a print job. Use the
arrow buttons to move forward or backward in a multi-page print job, or enter a specific page number in the
field provided. Click the Page Setup button to access the complete set of print features in the Page Setup
dialog box.
To print a selection of text rather than the entire file, select the desired text in the editor, then select
File|Print|Print Selected Text.
Orientation: Select whether the printed output should have a portrait or landscape orientation.
Scale: If the Shrink To Fit Page Width check box is not selected, use this field to manually enter a
percentage.
Shrink To Fit Page Width: Select this check box to make the print job fit the paper size selected for
the default printer.
Print Background (colors & images): Select this check box to include background colors and
graphics (e.g., on a web page) in a print job.
Margins: Use the fields provided to enter the size of the margins in inches.
Headers and Footers: Use the drop-down lists to select the type of information that appears in the
headers and/or footers, and to determine their position on the page. The top row of lists contains the
header options, and the bottom row contains the footer options. Choose from options such as "Title",
"URL" and "Page #". Select the "Custom" option from any of the drop-down lists to enter custom
header information. To print without headers and footers, select the "blank" option in each of the
drop-down lists.
1. On the File menu, click Print to HTML File. You are prompted to name the output file.
2. Enter the file location in the field provided. Click OK. The HTML file opens in the editor.
To print a selection of text to an HTML file (rather than the entire file), select the desired text in the editor,
then select File|Print|Print to HTML File.
File Tab Context Menu: Right-click the file tab and select Save. To save the file to a different name,
select File|Save As.
The unique characteristics of each file are displayed in different colors (red and blue by default); common
characteristics are displayed in a third color (black by default). To configure custom colors for the "diff"
window, alter the Language-Specific Coloring setting for the Other|Diff language in the Fonts and Colors
preference.
File Menu: Select File|Close or Window|Close. To close all open files, select Windows|Close All.
Key Binding: Use the associated key binding.
File Tab Context Menu: Right-click the file tab and select Close.
Editor: Click the "x" in the top right corner of the editor to close the current file.
To replace text, use the Open/Find Toolbar with the Replace option.
Start an incremental search: Use the associated key binding (by default: 'Ctrl'+'I' on Windows and
Linux, 'Cmd'+'I' on Mac OS X). The status bar displays "Incremental Search:" followed by the
characters in your search. Begin typing the characters you want to find. As you type, the cursor moves
to the first match after the current cursor position.
Jump to the next/previous occurrence: Press 'Ctrl'+'I' 'Ctrl'+'I' to cycle through all subsequent
occurrences; press 'Ctrl'+'Shift'+'I' to cycle through previous ones.
Use a selection as your search string: Select the text you want to use with the mouse or keyboard,
then press 'Ctrl'+'I'.
Change the search string while searching: Use 'Shift'+'Right Arrow' to add the character to the right
of the current selection, and 'Shift'+'Left Arrow' will remove a character.
Cancel the search: Press 'Esc'.
The interface changes as different options are selected, so that you only see fields and buttons that are relevant
to your task.
To the right of the "Find what:" field are two buttons which can help you compose your regular expression:
Regular Expression Shortcuts: A drop list of commonly used regular expression special characters
and sequences with a short description of what each one does.
Open in Rx Toolkit: Opens the regular expression from the "Find what:" field in the Rx Toolkit,
allowing you to test it before running your search. Komodo IDE only
When used in conjunction with Replace, regular expression replacement sequences can be used in the
"Replace with:" field (e.g. "\1", "\g<name>", etc.).
Match case (selected): Performs a case sensitive search; only exact matches are found (e.g.
"myString" matches "myString" but not "mystring").
Match case (deselected): Performs a case insensitive search; strings will match even if the case is
different (e.g. "mystring" will match "myString").
Smart case (selected): Search strings containing capital letters are automatically case sensitive.
11.2.4 Multiline
Selecting Multiline changes the "Find what:" field (and the "Replace with:" field if Replace is selected) with
larger, multiline text boxes.
This makes it easier to paste in multiline blocks of text in these fields. The search text will only match if the
line breaks are the same. Line breaks in the "Replace with:" field are likewise respected.
11.2.5 Scope
The "Search in:" drop list defines where the find or replace will happen. It contains the following options:
Current document
Selected text
Open files
Project (current project)
Files
Selecting Files from this list opens additional fields allowing you to set the scope of your search in directories
on your filesystem:
Directories: Defines the path to the directory to start your search in. Multiple paths can be added by
separating them with a semi-colon (";"). Relative paths can be specified using the path of the file in
the current editor tab as the starting point (e.g. "../adjacent-dir/").
Search in sub-directories: If selected, makes the search recursive. The search starts in the directory
or directories specified above and descends into all sub-directories.
Include: Defines the file names to include in the search or replace. Can be used to specify a partial
filename or file extension with glob syntax (e.g. "*.html, *.txt").
Exclude: As above, but defining the files and directories to exclude.
See also the Replace in Files section for a description of the Confirm and Undo options.
11.2.6 Actions
Once all the options for the Find or Replace are set, choose the action you wish to perform. The action buttons
available will depend on which options have been selected:
Find Next: Finds consecutive occurrences of the search string in your file or selection. As matches
are found, the text will be highlighted. The Find dialog box remains in focus. To keep the focus in
your file, close the Find dialog box, then use the associated key binding.
Find All: Locates all occurrences of the search string in your file or selection. The matches will be
displayed in the Find Results tab in the Bottom Pane.
Replace: Highlights the next occurrence of the search string; if you click Replace again, the
highlighted text will be replaced with the replacement string and the next occurrence of the search
string will be highlighted.
Replace All: Replaces all occurrences of the search string in the document or selection without
prompting for confirmation. All replacements will be displayed on the Find Results tab of the Bottom
Pane.
Mark All: Inserts a bookmark on each line that contains the search string. To move the editing cursor
to a bookmarked line, press 'F2'.
Komodo's Replace in Files feature has a Confirm option which lets you check the substitutions before you
apply them, and an Undo feature to revert the replacement if you make a mistake.
11.2.5 Scope 55
Komodo User Guide
The Confirm Replacements dialog box shows a list of all pending replacements from the Replace in Files
operation. Each line shows:
A check mark (by default all are marked) indicating that the replacements in that file are marked for
inclusion. Click on the check marks to toggle them on or off.
The path and filename
The number of replacements to be made in the file
Show Selected Changes previews all selected changes in the list. Use 'Shift'+'Click' or 'Ctrl'+'Click' to select
multiple items.
The preview window has the same format and options as Compare Files. The preview is in unified diff
format, so it can be copied and saved as a patch.
Once you have confirmed that all pending replacements are correct, or un-marked the changes you do not
want to include, click Make Changes.
If you've made a mistake and would like to roll back all of the changes from the last Replace in Files
operation, click the Undo Replacements button in the Find Results tab toolbar.
Komodo can open two tabs, Find Results 1 and Find Results 2, which can be locked using the Lock button
in their respective toolbars. New find or replace operations will not overwrite contents in a locked tab.
Komodo uses the first available tab for output. If both tabs are locked during subsequent find or replace
operations, Komodo prompts you to unlock one of the tabs or cancel the action.
File: the path and filename in which the match or replacement occurred
Line: the line number on which the match or replacement occurred
Content: the text that was matched or replaced
Double-click on any output line to jump to the relevant file and line in an editor tab.
Open: The file to open. Use the full path of the file, the relative path from the directory of the current
file, or just the filename if it's in the same directory as the current file.
Find: The string to search for. Pressing 'Enter' after typing the search term searches the current file.
in: The directory or file to search in. Pressing 'Enter' in this field causes the search term in the Find
field to be applied to the specified directory or file instead of the current file. You can use the Browse
button to the right of the field to populate this field. Accepts the glob wildcards '*' and '?'.
The Find and in fields both keep a list of the most recently entered strings and file specifications.
If a file or directory is specified in the in field, matches will be displayed in a Find Results tab.
Press 'Esc' to return focus to the Komodo editor. All fields can be accessed via their associated key bindings.
Use Code|Find Next Function or Code|Find Previous Function (or the associated key bindings) to cycle
through the functions.
Use Code|Find All Functions to display a list of all functions in a Find Results tab. Double-click on any
entry to jump to the relevant line.
Komodo IDE has a more powerful feature with the same default keybinding ('Ctrl'+'F8') called the Sections
List.
Komodo's editor has extensive code intelligence features for JavaScript, HTML, XML, XSLT, Perl, PHP,
Python, Ruby, and Tcl. and provides syntax highlighting and common editor features for most other
programming languages. Many of these features can be customized in Komodo's editor preferences.
Right-clicking in the editor pane brings up a context menu with common editing functions. In addition to
standard Cut, Copy, Paste, Select All, and Print commands, the following options are available:
12 Editing 58
Komodo User Guide
More Information:
The syntax checking icon in the status bar displays the syntax status of the current file displayed in the Editor
Pane:
A green check mark over the icon indicates that the language interpreter does not detect any warnings
or errors in the program.
A red exclamation mark over the icon indicates one or more errors. To see the number of errors and
warnings contained in the program, hover your mouse pointer over the syntax checking icon. A
pop-up tool tip will display the total number of errors and warnings.
An hourglass over the icon indicates that syntax analysis is in progress.
You can view the error message from the interpreter in the status bar if the editing cursor is on the same line
as the error. If it is not, hover the mouse pointer over the error and the interpreter error will be displayed in a
pop-up tool tip.
To move the editing cursor to the line containing the error or warning, double-click the syntax checking icon.
If there are multiple errors or warnings, each time you double-click the icon, the editing cursor will move to
the next error.
If background syntax checking is disabled in Preferences, shift-click on the syntax checking icon to check the
syntax of the file.
Autocomplete presents a pop-up list of relevant choices at certain trigger points as you are editing a
document. Autocomplete functionality varies according to language; for example, Python autocomplete lists
object methods when you type the '.' (period) trigger character, Perl autocomplete lists available sub-packages
when you type the '::' trigger string in a "use" statement, and XSLT autocomplete lists appropriate element
and attribute names when starting XML tags.
Use the arrow keys to scroll through the list; use the 'Tab' or 'Enter' key to insert the currently selected item
into your document; use the 'Esc' key to cancel the pop-up list.
A calltip presents you with a call signature for, and possibly a short description of, a function or method call.
Generally, a calltip is opened when you enter the open parenthesis, "(", of a function call. However, this varies
according to language. Use the 'Esc' key to close the calltip.
Komodo includes autocomplete and calltip support for several languages. Language-specific functionality for
each supported language is described below.
More Information:
Autocomplete for sub-modules in use statements: Available sub-modules are listed upon entering
"::" in use and require statements. For example:
use LWP::|
use LWP;
$HTTP::Request::|
Autocomplete for module subroutines: Subroutines are listed upon entering "->" after a module
name. For example:
use LWP;
LWP::UserAgent->|
Autocomplete for object methods: Object methods are listed upon entering "->" after an object
reference. For example:
use Data::Dumper;
my $d = Data::Dumper->new($foo);
$d->|
Calltips for subroutine calls: A calltip is shown for subroutine and object method calls upon
entering "(" after a sub-routine name, if information is available for that subroutine. Note: Perl
supports subroutine calls without the parentheses. Komodo only triggers a calltip without the
parentheses for certain built-in Perl functions such as, "chdir", "split", "join", etc.
A Perl autocomplete list or calltip can also be explicitly initiated by typing 'Ctrl'+'J' ('Meta'+'J' on Mac OS X).
Autocomplete for object methods and attributes: Object methods and attributes are listed upon
entering "." after an object reference. For example:
import sys
sys.|
"This is a string".|
Autocomplete for import statements: Modules are listed after an import or from statement.
Available members (i.e. sub-modules, variables, functions, and classes) are listed after a from ...
import construct. For example:
##
# This is the description.
# @|
Calltips for function calls: A calltip will be shown for function and object method calls upon
entering "(" after the function name -- if information is available for that function.
A Python autocomplete list or calltip can also be explicitly initiated by typing 'Ctrl'+'J' ('Meta'+'J' on Mac OS
X).
Autocomplete for require statements: Available Ruby libraries are listed upon entering the
opening quote and for slashes in the quotes. For example:
class Animal
def initialize(species)
@@species = species
end
def grunt
"ugh"
end
def run
end
end
Animal::|
Autocomplete for methods on an class instance: Available methods on an instance are listed upon
entering ".". For example:
a = Animal.new("dog")
a.|
Calltips for method calls: The method signature (and possibly some method documentation) is
shown in a calltip upon entering the "(" for a method call.
a = Animal.new(|"dog")
A Ruby autocomplete list or calltip can also be explicitly initiated by typing 'Ctrl'+'J' ('Meta'+'J' on Mac OS
X).
Classes and Methods: Classes in the current file, and classes in any included files, are displayed
upon entry of the keyword "new". Methods for a class instance are displayed after you enter "->" on
the instance variable or alternatively if the scope is inside the class you will get completions after
"this->", "self::", "parent::" operators. Static and constants are displayed after you enter "::" after a
class name.
class Student {
const UNIVERSITY = "Pluto";
var $id = "";
var $name = "";
function Print() {
echo "Id: " . $this->id . " Name: " . $this->name . "\n";
}
}
Functions: Standard PHP functions and functions defined within the script (and within any included
files) are displayed after you have typed three characters that match one or more function names.
Function calltips are displayed after the opening parentheses "(" on a function call.
php|info();
phpversion(|);
Constants: PHP constants are included with the functions list triggering after three characters have
been typed.
Variables: Variables declared in the current file, or in any included files, are displayed when you
enter the symbol "$" followed by one letter.
Autocomplete for command names: A list of matching Tcl commands is displayed after you have
typed three characters in a command. For example,
str|
Calltips for command arguments: A calltip is displayed for a Tcl command upon entering ' ' (space)
after the command name. For example,
string is alpha |
Tcl autocomplete and calltips use the built-in function definitions contained in Tcl .tip files, which are in the
lib/support/tcl subdirectory of the Komodo installation directory.
Windows
<komodo-install-directory>\lib\support\tcl
Linux
<komodo-install-directory>/lib/support/tcl
Mac OS X
<komodo-install-directory>/Contents/SharedSupport/tcl
Edit the .tip files to customize or extend Tcl autocomplete and calltips in Komodo. Review the existing .tip
files for examples before editing.
Autocomplete for XSLT elements: A list of appropriate elements in the XSL-namespace for the
current context is supplied upon entering "<" to start a tag.
Autocomplete for XSLT attributes: A list of appropriate attributes in the XSL-namespace for the
current element is supplied upon entering ' ' (space) in a tag.
Autocomplete for end-tags: A one item list containing the appropriate closing tag for the current
position is supplied upon entering '</'.
Autocomplete for output: A list of elements and attributes for HTML or XML output (as defined in
the method attribute of the xsl:output element) is supplied upon entering "<" within
xsl:template blocks. If the output method is a specific dialect of XML, specifying the
publicId or systemId of that dialect in the doctype-public or doctype-system
(respectively) enables autocompletion appropriate to that dialect.
Komodo supports XML autocomplete and calltips for basic XML as well as a a number of XML dialects,
including:
HTML
XML Schema VXML
XHTML
Atom SVG
SGML
Dublin Core MathML
RELAX
DocBook XBL
RELAX NG
WAP XUL
RDF
XSLT XML Catalog
MXML
Support for additional XML dialects can be configured by adding an XML Catalog for the dialect in the
SGML/XML Catalogs section of the Code Intelligence Preferences.
Autocomplete for elements: A list of elements available in the current namespace is supplied upon
entering "<". If the current document's XML dialect is not recognized (i.e. it is not in the above list or
in a configured catalog), the completion list is drawn from elements used in the document.
Autocomplete for attributes: A list of attributes available within in the current element is supplied
upon entering a space after the element name.
Autocomplete for end-tags: A list (of length one) to close the current tag is supplied upon entering
'</'.
If the document does not have an XML declaration, autocomplete will default to XHTML 1.1. The
DOCTYPE and namespace can be manually set under File Properties.
object.method(value|)
object.method(value)|
In most programming languages, typing a string-start character in a "default" context (i.e. not in a string or
comment), will generate the appropriate soft quote to the right of the cursor. Komodo is aware that in some
languages characters like single-quote are used to start a comment, so no soft character is generated.
Cursor movement (e.g. moving over the soft character with the right-arrow) "hardens" soft characters.
If you have opened a file that does not have a file association specified in the Preferences dialog box, Komodo
displays the file as text. You can select to view the file as another language, but Komodo does not remember
again. If you will be working with a new type of file, it is recommended that you specify a file association.
For example, if you open a DocBook (*.docb) file in Komodo, it does not have XML syntax coloring. Specify
a file association to tell Komodo to open *.docb files as XML files. For more information on specifying file
associations, see Customizing File Associations.
If you choose to view a file in a different language and then save the file, the original language will not be
restored when you re-open the file. If you are unsure of the original language, you can select View|View As
Language|Reset to best guess. Komodo will ignore the user preference, and analyze the file in an attempt to
determine its language.
More Information:
Copying or cutting lines repeatedly from the same cursor position adds each line to the clipboard rather than
overwriting the previous clipboard contents.
To drag a single line, click the line number and (keeping the left mouse button depressed) drag it to the
desired location. The same operation can be done with multi-line selections.
1. Select Code|Repeat Next Keystroke N Times. The status bar at the bottom of the Komodo
workspace prompts you for the number of times the keystroke will be repeated.
2. Type a number using only numeric characters.
3. Enter the keystroke. The results of the sequence are displayed in the Editor Pane the specified number
of times.
Single Line: Position the cursor at the start of the text on the desired line. Press Tab, or select
Code|Increase Line Indent.
Multiple Lines: Select the desired lines by clicking and dragging in the Editor Pane. Press Tab, or
select Code|Increase Line Indent.
Single Line: Position the cursor at the start of the text on the desired line. Select Code|Decrease Line
Indent or use the associated key binding.
Multiple Lines: Select the desired lines by clicking and dragging in the Editor Pane. Select
Code|Decrease Line Indent, or use the associated key binding.
Specify the number of spaces per tab in the Indentation Editor Preferences
(Edit|Preferences|Editor|Indentation).
Select the formatter from the list under Code|Format Using. The first sub-menu shows the formatters
available based on Komodo's language detection. Additional formatters are available under the Other
Formatters sub-menu.
Use the Editor: Format Code or Text command ('cmd_format'). Komodo will run the formatter on
the selection if there is one. If there is no selection, the entire document will be formatted. By default,
this command does not have a key binding; you can assign one in the Key Bindings preferences.
Note: Komodo uses HTML Tidy as the default formatter for HTML documents. Since this parser cannot
differentiate between isolated sections of HTML and complete documents, use Tidy Fragment when
formatting selection and Tidy Document when formatting the entire file.
To un-comment a line of code, place the cursor is on the desired line, then, from the Code menu, select
Uncomment Region. Alternatively, use the associated key binding.
To comment a block of code, select the lines you wish to comment by clicking and dragging the mouse in the
Editor Pane. Then, from the Code menu, select Comment Region. Alternatively, use the associated key
binding.
To un-comment a line of code, place your cursor is on the desired line, then, from the Code menu, select
Uncomment Region, or use the associated key binding.
1. On the View menu, click View EOL Markers to show line endings.
2. Select the line(s) for which you want to replace the endings.
3. On the Code menu, click Clean Line Endings. The line endings are replaced with the line endings
specified in the file's settings.
To tabify a region:
To untabify a region:
1. Open python_sample.py
2. Find the following line: print "element %s is a string" % element. There are 8
leading spaces on this line.
3. Tabify this line. Set the number of spaces to 8. This means the 8 spaces will be converted to one Tab
character.
4. Now this line has one Tab character, represented as a right arrow, preceding print "element %s
is a string" % element;. This does not change the line's indentation.
5. Untabify this line. Set the number of spaces to 8. This returns the line to the original state.
You can set the width of Tab characters in the Preferences dialog box. The default value is 8.
Note: On Linux, the default key bindings may conflict with ones used by the window manager. To avoid this,
re-map the "Editor: Select Rectangular..." commands in the Key Binding Preferences to unused key
combinations.
For example to change "directory-name" in the file list below, select the column containing that name as
described above.
Once the column is selected, begin typing. The cursor will appear only at the top line of the selection, but the
new text will appear on all subsequent lines within the colum selection.
Note: Column selections in areas beyond line endings will not appear correctly. The areas beyond the end of
line will not be highlighted, but column editing will still work. Text will be inserted immediately after the
longest line in the selection.
With Vi emulation enabled, mouse selection and Vi visual blockwise selection ('Ctrl'+'V') will not trigger
column editing. While in Input mode, use 'Alt'+'Shift' with the direction keys to make the column selection,
and 'Esc' to exit column editing mode.
Enter one or more characters, then select Code|Complete Word, or use the associated key binding. Words are
completed based on the most recent occurrence in the current file. For example, if you type "pr", Komodo
searches backward from the insertion point to find the first instance of a word that begins with "pr". Continue
pressing the spacebar while holding down the 'Ctrl' ('Meta' on Mac OS X) key to cycle through all possible
completions for the word. The Complete Word feature is case sensitive.
When the Select Block function is invoked, Komodo analyzes the cursor position relevant to the blocks of
code in the document. If the cursor is within a block, the entire block will be selected. (If the cursor is within a
nested block, only the current sub-block will be selected, not the block that contains the entire nested
structure.) If the cursor is not inside a block, the entire document will be selected.
To toggle whitespace on and off, select View|View Whitespace, or use the associated key binding.
To set a default for whitespace display, see Customizing Editor Features for more information.
To toggle indentation guides on and off, select View|View Indentation Guides, or use the associated key
binding.
To toggle line numbers on and off, select View|View Line Numbers, or use the associated key binding.
To set this option globally, see Customizing General Editor Features for more information.
To toggle EOL markers on and off, select View|View EOL markers, or use the associated key binding.
To set this option globally, see Customizing General Editor Features for more information.
1. On the View menu, select Font, then Toggle Fixed/Proportional Fonts. This changes the font to
fixed width.
2. Repeat to reverse.
All foldable blocks of code collapse and the minus signs all become plus signs.
All foldable blocks of code expand and the plus signs all become minus signs.
12.4.2 Go to Definition
You can jump to the definition of a code object under your cursor (e.g. a variable, a subroutine, a module,
etc.) in any of the following ways:
Alternatively, double-click the symbol node for the object in the Code Browser tree.
Objects defined within the file, in user-defined modules, and in the site library are accessible in this way;
objects defined in a language's standard library are not.
In Rails applications, you can also jump to symbol definitions in models from controller files.
Bookmarks
To set or unset a bookmark: Position the editing cursor on the line of interest. Select
Code|Marks|Toggle Bookmark or use the associated key binding to bookmark the line. If the line is
already bookmarked, the bookmark will be removed.
To move to the next bookmark: Select Code|Marks|Next Bookmark or use the associated key
binding.
To move to the previous bookmark: Select Code|Marks|Previous Bookmark or use the associated
key binding.
To clear all bookmarks: Select Code|Marks|Remove All Bookmarks or use the associated key
binding.
Marks
To set a mark: Position the cursor on the line of interest. Select Code|Marks|Set Transient Mark.
To jump to the matching brace, select Code|Jump to Matching Brace, or use the associated key binding. To
select the braces and the contents they contain, select Code|Select to Matching Brace.
The browser preview will be displayed in a separate window, in the Editor Pane, or in a split view of the
Editor Pane, depending on which preference has been set.
The context menu in the Editor Pane is only available when the "source" tab is in focus. If Komodo does not
support previewing of a specific file type, the Preview in Browser option will not be available from either the
toolbar or the View menu.
1. Open the file in the Komodo Editor Pane. Or, if the file is already open, make sure it is the selected
tab in the Editor Pane.
2. Select View|Preview in Browser. A dialog box will appear, prompting you to choose which file to
preview.
Move to Other Tab Group: Splits the Editor Pane (if not already split) and moves the active file to
the other tab group.
Split View: Splits the Editor Pane (if not already split) and displays the active file in both tab groups.
Rotate Tab Groups: If two tab groups are displayed, this option switches between a horizontal and
vertical split.
If displayed in the Editor Pane, previews include a toolbar with basic Web browser functionality, including
(from left to right) "Back", "Forward" "Reload", and "Stop" buttons.
Komodo looks for abbreviations in a special folder in projects and toolboxes called Abbreviations. Within the
Abbreviations folder are language specific sub-folders, and a General sub-folder for global snippets.
divblock|
<div id="default">
</div>
Many of the default snippets in Komodo use Tab Stops (highlighted above) to make populating the snippet
with your content even quicker. After inserting the snippet, the first tab stop is selected, just start typing to
insert text in place of the marker. Use the Tab key to cycle through subsequent markers.
13 Abbreviations 76
Komodo User Guide
Komodo checks the language-specific sub-directory and the General sub-directory in each of these places. For
example, if you are editing a Python module, these snippet directories will be checked in this order:
In a multi-language buffer, both the language type of the file and the language type at the current cursor
position are included. For example, in a JavaScript block inside a PHP file, the following search order would
be used:
This allows you to have snippets with the same names for multiple languages. For example an abbreviation
called 'class' abbreviation would insert a different snippet in a Perl file than in a PHP file.
To add a new abbreviation to a project, use the steps above after adding the necessary folders (i.e. at least
Abbreviations/General) to the project.
As with all project and toolbox items, snippets can be copied, cut and pasted between toolboxes and projects.
Komodo has two distinct types of folders that can be used in projects or in the Toolbox:
Live Folders correspond to actual directories on the filesystem. The directory tree view displays the
current contents of the corresponding filesystem directory.
Virtual Folders do not directly correspond to directories on the filesystem. They are multi-purpose
containers; any component that can be added to a project or the Toolbox can be stored in these
folders.
When you Import from File System, the virtual project or Toolbox folders are created with the same
names as the imported directories, but modifying the name of the folder within Komodo has no effect
on the directory's name in the file system. See Adding Components to Projects or Adding
Components to the Toolbox for instructions on adding folders.
Double-click a folder to display its contents. Double-click again to collapse a folder and hide its contents.
Alternatively, click the plus and minus icons.
Use the following options on the Import from File System dialog box to configure the import:
Directory to import from: Specify the directory from which you want to import files. Use the
Browse button to navigate the file system.
Files to include: Specify the filenames to include. Use wildcards ("*" and "?") to specify groups of
files. Separate multiple file specifications with semicolons. If the field is left blank, all files in the
specified directory are imported.
After importing from the file system, you are prompted to confirm the addition of the files that match the
specified criteria. You may remove one or more files from the import. Click OK to proceed with the import.
After using the Import from File System feature, if you attempt to re-import the same file system location
into the same project, only files that are new since the last import are imported.
1. In the Project Tab or Toolbox, right-click the folder containing the item(s) to be exported to a package
and select Export Package.
2. In the Package Export Wizard, enter the Package Name and Export Location. Click Next.
3. Click Finish.
1. In the Project Tab or Toolbox, right-click the folder and select Import Package.
2. In the Package Import Wizard, enter the name of the package and the location on disk where files (as
opposed to internal components like snippets and run commands) will be extracted. Click Next.
3. Click Finish.
If the component is stored in a source code control system, Refresh Status also checks the repository status of
the component. Komodo determines whether a file is contained in an SCC repository by the following
methods:
Use the cut/copy/paste options to remove folders from a project or the Toolbox, or to move folders between
the project and the Toolbox, between projects, or between folders.
Snippets are frequently used strings that can be quickly inserted into the current document. For example,
repetitive sections of code or standard comments can be stored within a snippet. Snippets have advanced
properties; they support the use of Tabstops and Interpolation Shortcuts, can be assigned to Key Bindings, and
allow for the specification of indentation context and cursor position.
Alternatively, select the desired text, then right-click and select Add as Snippet in the Toolbox.
Alternatively, right-click a folder in the Toolbox or on a project or folder name in the Projects sidebar, and
select New Snippet. If you use this method, you must manually enter the contents of the snippet; text selected
in the Editor Pane is not automatically added to the Snippet dialog box.
Snippet Name: Enter the text that should display in the Projects or Toolbox sidebars for this code
snippet. If the snippet was created by dragging a text selection from the Editor Pane, the snippet is
named after the text in the snippet.
Snippet Contents: If the snippet was created by dragging a text selection from the Editor Pane, the
contents of the selected text are displayed in the Snippet Contents field. Otherwise, enter the contents
of the snippet manually. Add or edit snippet content as desired.
Snippet Shortcuts: Add Interpolation Shortcuts or Tab Stop/Replace markers to a snippet by clicking
the arrow button to the right of the Snippets Contents field, and selecting a shortcut from the
drop-down menu. Interpolation shortcuts in snippets are not executed when the snippet is inserted in
the Editor Pane via dragging and dropping.
Maintain selected text or cursor position after insertion: Within the snippet contents field, either
select a portion of the snippet (by dragging the mouse pointer over the desired selection) or position
the editing cursor within the string. If this check box is selected, when the snippet is inserted into the
Editor Pane, the selected text or the cursor position is displayed in the same manner.
Maintain indentation context after insertion: If the snippet is inserted into the Editor Pane when
the editing cursor is in an indented position, select this check box to use the indentation point as an
indentation "prefix". The indentation structure of the snippet is preserved at the position of insertion.
15 Snippets 81
Komodo User Guide
Although you can also drag and drop snippets onto the Editor Pane, the cursor position and indentation check
box options explained above in Configuring Snippets will only take effect if the snippet is added using the
double-click or Insert Snippet method.
Insert Snippet: Use this option to insert the snippet at the current cursor position in the editor, as
described above in Using Snippets.
Cut/Copy/Paste: These options are used to remove the snippet from a project or the Toolbox, or to
move snippets between the project and the Toolbox (and vice versa).
Export as Project File: When this option is invoked, a new project file is created that contains the
snippet from which the option is invoked. You are prompted to provide the name of the new project
file and the directory where it will be stored. To open the new project file, select File|Open|Project.
Export Package: Snippets can be archived and distributed among multiple Komodo users via
Packages. Packages are compressed archive files that contain the snippet from which the Export
Package option was invoked. Packages are stored in files with a ".kpz" extension, and can be opened
by any archiving utility that supports libz (for example WinZip). The Export Package option
differs from the Export as Project File option in that copies of filesystem-based components (such as
files and dialog projects) are included in the archive. Conversely, Export as Project File creates a
project with a reference to the component's original location and does not create copies of the
components. When Export Package is invoked, you are prompted for a name and file location for the
package. Exported packages can only be imported into "container" objects in Komodo, such as
projects, the Toolbox, and folders within projects and the Toolbox. See Toolbox - Exporting and
Importing Toolbox Contents, Projects - Importing and Exporting Projects via Packages, or Folders -
Import Contents from Package for more information.
Rename: To change the name of a snippet, select this option and enter a new name.
Delete: To remove a snippet from a project or the Toolbox, select this option. The snippet is
permanently deleted.
The default snippet icons can be replaced with custom icons. Komodo includes more than 600 icons;
alternatively, select a custom image stored on a local or network drive (use 16x16-pixel images for best
results).
1. In the Projects or Toolbox sidebar, right-click the desired snippet and select Properties. Alternatively,
click the icon in the Projects or Toolbox sidebar, then select Projects|snippet_name|Properties or
Toolboxsnippet_name|Properties.
2. In the Properties dialog box, click Change Icon.
3. In the Pick an Icon dialog box, select a new icon and click OK. Alternatively, click Choose Other,
and browse to the desired image file.
4. In the Properties dialog box for the snippet, click OK. The custom icon is displayed next to the
snippet.
1. In the Projects or Toolbox sidebar, right-click the desired snippet and select Properties.
2. Click Reset, then click OK. The default icon is displayed next to the snippet.
To assign a key binding to a snippet, right-click the snippet on either the Toolbox tab or the Projects tab, and
select Properties. Select the Key Bindings tab, and configure the desired binding. See Key Bindings for
Custom Components for more information.
[[%tabstop]
Adding a colon followed by any string provides a default value (or just a helpful name):
[[%tabstop:myValue]
Numbered tabstops are linked together in the buffer. Text replacements in one numbered tabstop will be
replicated in tabstops with the same number. Linked tabstops should use the same default string or omit the
default string once it's been defined in the first linked tabstop:
print <<"[[%tabstop1:EOT]]";
[[%tabstop:TextHere]]
[[%tabstop1]]
With the cursor on a tabstop, typing overwrites the default value (if defined). Hitting Tab again inserts the
default value and moves to the next tabstop.
16.3 Examples
This "blank" PHP function snippet uses numbered tabstops. This is what it looks like when defined in the
snippet:
/*
* function [[%tabstop1:name]]
* @param [[%tabstop2:arg]]
*/
function [[tabstop1:name]]($[[%tabstop2:arg]]) {
16 Tabstops 84
Komodo User Guide
[[%tabstop]];
}
/*
* function name
* @param $arg;
*/
function name($arg) {
The "name" tabstop is the first place Tab will stop. It gets replaced with the function name which is
propagated through the rest of the snippet when Tab is hit again. The "arg" tabstop is the next place Tab
stops, and is treated the same way. The unnamed tabstop is invisible in the buffer, but hitting Tab again will
move the cursor to it's position.
<[[%tabstop1:div]]>[[%s]]</[[%tabstop1:div]]>
<div>[[%s]]</div>
Hitting Tab after insertion will select the first "div" for replacement. If it is replaced, the closing tag will be
changed as you type. If it is not replaced, "div" will be used as the element type.
16.3 Examples 85
17 Macros
Macros are scripts which automate Komodo. They are stored in projects or toolboxes, and can be launched by
double-clicking the macro icon, pressing an associated custom key binding, or by binding them to event
triggers.
The Macros toolbar provides quick access for recording, running, and saving macros. To show or hide the
toolbar, select View|Toolbars|Macros. You can also use the Tools|Macros menu items.
To record a macro:
1. Select Tools|Macros|Start Recording (or use the Record Macro button in the Macro toolbar). The
Komodo status bar displays "Recording Macro".
2. In the Editor Pane, enter the keystrokes to store in the macro. While entering keystrokes, pause
recording by selecting Tools|Macros|Pause Recording. Select Start Recording when ready to
resume macro creation.
3. To end macro recording, select Tools|Macros|Stop Recording. The status bar displays "Macro
Recorded".
Note: Though keystrokes in the Editor pane can be captured and recorded in this manner, several Komodo
commands cannot. If your resulting macro does not replay certain operations, you may be able to add them
manually by editing the recorded macro. Consult the Writing Macros section in conjunction with the
Command ID List and the Macro API for further information.
1. Select Tools|Macros|Save to Toolbox, or click Macro: Save to Toolbox on the Macro Toolbar.
2. Give the new macro a unique name in the Enter name for new macro field. A reference to the macro
is automatically added to the Toolbox.
To add a macro:
1. Select Toolbox|Add|New Macro... or Project|Add|New Macro.... Alternatively, use the Add buttons
within the Project or Toolbox sidebars, or right-click a project or folder name and select Add|New
Macro....
17 Macros 86
Komodo User Guide
2. Language: Specify the language (Python or JavaScript) in which to program the macro.
3. Set any desired macro properties.
4. Write the macro in the editor field or save what you have so far by clicking OK. You can open it in an
editor tab by right-clicking on the macro icon and selecting Edit Macro. This is useful as it provides
autocompletion and other Komodo editing features.
Refer to the Macro API for information about writing JavaScript and Python macros in Komodo.
To run a macro that has been saved to a project or toolbox, double-click the macro or use the key binding you
have assigned to it. Alternatively, right-click the macro and select Execute Macro.
If the macro is in a toolbox, the assigned keybinding will always trigger the macro. If it's in a project, the
keybinding will work only when that project is open.
To revert to the default icon for a selected macro, use the Reset button.
If a macro is not associated with a Komodo event, it can run either in the foreground or in the background.
Macros that perform "editor" functions or modify open files should always run in the foreground to "block"
and prevent user interference. This prevents the user from moving the cursor and disrupting the macro
currently in progress.
Check to make sure macro triggers are enabled in the Projects and Workspace preferences. In the Triggering
Macros area, select Enable triggering of macros on Komodo events, and then click OK.
Trigger macros run with an argument called "subject", available as a global variable within the macro. This
variable references the ko.views.manager.currentView object for post-open, pre/post-save, and pre-close
trigger macros. For post-close macros, it references the URI since the view object is empty at that point. For
example, in a macro with an "After file open" trigger you could use:
Komodo macros that use the event triggers "Before file save", "Before file close", or "On shutdown", can
make use of return values. Macros that return that return a true value (e.g. True in Python, true in
JavaScript) can interrupt the process under execution. For example, the following JavaScript macro triggering
"Before file save" prevents you from saving files on Sunday:
The interfaces for the two macro languages are described separately:
JavaScript Macros
Python Macros
18.1.1 Warning
The macro system is a powerful mechanism by which Komodo users can execute arbitrary code inside the
Komodo process. It is easy for novices to write macros that can significantly disrupt Komodo's behavior,
leading to instability and data loss. Avoid experimenting with macros while working with important files.
Of particular note:
Macros that never terminate (for example, due to infinite loops) can hang Komodo.
Macros that modify the buffer should never be run in the background, as multiple threads accessing
the editor object could cause crashes.
Macros that modify the scimoz object should be written with care, to avoid data loss.
18.1.2 Feedback
The Komodo JavaScript API is under active development. If you have questions or feedback about the API,
please post to the Komodo Macros and Extensions forum.
The API described below may change in future releases (we will of course try to minimize
backwards-incompatible changes).
18 Macro API 90
Komodo User Guide
18.2.1 ko.views.manager.currentView.scimoz
The ko.views.manager.currentView.scimoz object corresponds to the main text editing widget
that contains and manipulates files in the Editor Pane. It is a thin wrapper around the Scintilla widget, an
open-source component written by Neil Hodgson (www.scintilla.org).
The Scintilla API is large, complex and subject to change. This document only contains the calls most
relevant to Komodo, and notes some common patterns of use relevant to changing the editor widget.
int currentPos
The location (in character units) of the caret.
int anchor
The location (in character units) of the selection anchor.
string text
The contents of the buffer.
string selText
The contents of the selection (readonly).
long scrollWidth
The width of the scroll area (in pixels).
long xOffset
The horizontal scroll position (in pixels) of the start of the text view.
boolean viewEOL
Whether to show end-of-line markers or not.
long viewWS
Whether to show whitespace characters (0: no, 1: yes).
long eOLMode
The characters that are inserted when the user presses 'Enter': either 'CRLF' (0 - the default on
Windows), 'CR' (1) or 'LF' (2 - the default on Linux).
long tabWidth
The size of a tab as a multiple of the size of a space character.
long indent
The size of indentation in terms of the width of a space.
boolean useTabs
Whether indentation should be created out of a mixture of tabs and spaces (1) or be based purely on
spaces (0).
boolean indentationGuides
Whether to show indentation guides or not.
readonly long firstVisibleLine
The line number of the first visible line in the text view.
long lineCount
The number of lines in the text view.
long textLength
The length of the current buffer in characters.
long targetStart
void emptyUndoBuffer()
Empty the undo buffer.
void undo()
Undo the last action.
void cut()
Cut current selection (ko.commands.doCommand('cmdCut') is the preferred method).
void copy()
Copy current current selection.
void paste()
Replace current selection with the clipboard contents.
void clear()
Clear current selection.
long replaceTarget(in long length, in string text)
Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the
length of the replacement text..
string getTextRange(in long min, in long max)
Return a range of characters from the current buffer.
void insertText(in long pos, in string text)
Insert text at a specified position.
void colourise(in long start, in long end)
Force the re-coloring of the specified range.
wchar getWCharAt(in long pos)
Get the (Unicode) character at the specified position.
void addText(in long length, in string text)
Add text to the end of the current buffer.
void selectAll()
Select the entire buffer.
void gotoLine(in long line)
Jump to the specified line.
void gotoPos(in long pos)
Jump to the specified position in the buffer.
void deleteBack()
Delete the character to the left of the cursor.
void newLine()
Add a newline (note: this is a less 'smart' newline than can be obtained using
ko.commands.doCommand('cmd_newlineExtra').
void redo()
Redo the last action.
boolean canRedo()
There is an action that can be redone.
void beginUndoAction()
Begin an undo block (see note).
void endUndoAction()
Invalid Parameters: The Scintilla API assumes that users of the API do their own error-checking. Passing
arguments that are out of bounds or otherwise erroneous can result in Komodo crashing.
The Undo Stack: Scintilla manages the "undo" stack. To treat a sequence of operations as a single operation
for the sake of Undo/Redo, wrap these operations in a beginUndoAction / endUndoAction pair. The
endUndoAction must be called even in the case of an exception in the code. Otherwise, the undo stack will
be corrupted and might lose data.
ko.views.manager.currentView.scimoz.beginUndoAction()
try {
18.2.2 ko.views.manager.currentView.document
The ko.views.manager.currentView.document object refers to the current document. A
document contains the contents of the file being edited. These contents will be different than those of the file
on disk if the file is unsaved or "dirty".
string baseName
The basename of the document (e.g. "myfile.txt").
string displayPath
The display path of the document (e.g. "C:\Code\myfile.txt").
file
The document.file object corresponding to the document (null if the document is unsaved).
string buffer
The contents of the document (Unicode string).
boolean isDirty
Whether there are unsaved changes to the document.
boolean isUntitled
Whether the document has never been saved.
string language
The language that this document is viewed as ("Python", "Perl", etc.
18.2.3 ko.views.manager.currentView.document.file
The file object is an attribute of document objects, and corresponds to a wrapper object around the file
object.
string URI
The URI to the file (e.g. "file:///C:/Code/myfile.txt").
string displayPath
The display path of the file (e.g. "C:\Code\myfile.txt"), or the URI if the URI is not of the
file:// scheme.
string baseName
The base name of the file (e.g. "myfile.txt").
string dirName
The directory of the file (e.g. "C:\Code").
18.2.4 ko.commands.doCommand()
Signature:
ko.commands.doCommand(commandId)
18.2.2 ko.views.manager.currentView.document 96
Komodo User Guide
Command IDs and their corresponding functions are available in the Command ID reference.
Most editor-related commands require that the Editor Pane be in focus. To ensure focus before invoking
doCommand, set the focus explicitly as follows:
ko.views.currentView.setFocus()
18.2.5 ko.open.URI()
Signature:
ko.open.URI(uri_string#line_number)
Open the file specified by the URI string and move the cursor to the line number specified after '#' (if any).
All file access protocols used by Komodo are valid. For example:
ko.open.URI("file:///home/user/example.txt#33");
ko.open.URI("ftp://example.org/pub/example.xml");
ko.open.URI("scp:///host.example.org/home/user/file.txt#11");
18.2.6 ko.projects.findPart()
Signature:
Find a "part" (the internal name for a component such as a snippet, another macro, a run command, etc) in the
Toolbox or a project.
18.2.4 ko.commands.doCommand() 97
Komodo User Guide
"container"
search the project or Toolbox that contains the current macro
"*"
search all of the above
18.2.7 ko.interpolate.interpolateString()
Signature:
18.2.8 ko.interpolate.getWordUnderCursor()
Signature:
This function returns the word under the cursor in the current buffer.
18.2.9 ko.run.runEncodedCommand()
Signature:
window: Required (literal) argument indicating Komodo's top-level window object. This allows the
method to be called from dialog boxes or other sub-windows.
command: The shell command to run. Can include arguments in Python dict format.
callback: An optional callback function.
For example:
function did_it() {
alert("Done.");
}
ko.run.runEncodedCommand(window, 'sleep 5', did_it);
Command options and environment variables can be added in curly braces "{...}" after the command in
Python dict format. For example:
ko.run.runEncodedCommand(window,
'svn up "%F" {"cwd": "%D", "env": "SVN_SSH=plink.exe"}')
18.2.6 ko.projects.findPart() 98
Komodo User Guide
The following JavaScript macro uses Komodo's cmd_refreshStatus function as the callback in
ko.run.runEncodedCommand(). This updates the SCC status information after running 'svn up' on
the file in the current editor tab:
if (komodo.view) {
komodo.view.setFocus();
ko.run.runEncodedCommand(window,
'svn up "%F"',
(function (view) {
return function () {
view.setFocus();
komodo.doCommand('cmd_refreshStatus');
}
})(komodo.view)
);
};
To use the XPCOM components described below, add the following to your macro:
viewSvc = components.classes["@activestate.com/koViewService;1"]\
.getService(components.interfaces.koIViewService)
view = viewSvc.currentView
The view object will have the same properties as ko.views.manager.currentView, exposing:
obsvc = components.classes["@mozilla.org/observer-service;1"].\
getService(components.interfaces.nsIObserverService);
obsvc.notifyObservers(None, 'open-url', uri);
18.2.9 ko.run.runEncodedCommand() 99
Komodo User Guide
import komodo
komodo.interpolate()
Some interpolation shortcuts cannot be used within Python macros. These include %P and %ask, and the
:orask modifier on other shortcuts. A ValueError is raised if they are used.
import komodo
komodo.getWordUnderCursor()
def doCommand(commandId):
_observerSvc = components.classes["@mozilla.org/observer-service;1"]\
.getService(components.interfaces.nsIObserverService)
_observerSvc.notifyObservers(None, 'command-docommand', commandId);
19.3 Debugger
Add Watch Variable cmd_dbgAddVariable
Add/Edit Breakpoint... cmd_dbgBreakpointAddOrEdit
Add/Edit Spawnpoint... cmd_dbgSpawnpointAddOrEdit
Break Now cmd_dbgBreakNow
Clear All Breakpoints cmd_dbgBreakpointClearAllInURI
Delete Selected Variable cmd_dbgDeleteVariable
Detach cmd_dbgDetach
Disable/Enable Breakpoint cmd_dbgBreakpointToggle
Edit Selected Variable Name cmd_dbgWatchedVariable
Edit Selected Variable Value cmd_dbgEditVariable
Interactive Debugger Shell Clear Buffer cmd_dbgInteractiveClearBuffer
Interactive Debugger Shell cmd_dbgInteractive
Listen for Debugger Connections cmd_debuggerListener
Load HTML Preview cmd_dbgViewAsHTML
Make Selection a Watched Variable cmd_dbgMakeWatchedVariable
New Session cmd_dbgNewSession
Run Script cmd_dbgRun
Run to Cursor cmd_dbgStepCursor
19.4 Editor
Add as Snippet to Toolbox cmd_makeSnippetFromSelection
Back cmd_back
Backspace cmd_backSmart
Beginning of Line (first char/first column) cmd_home
Cancel AutoComplete cmd_cancel
Compare with file on disk cmd_showUnsavedChanges
Copy cmd_copy
Current File Settings cmd_editPrefsCurrent
Cut Line cmd_lineCut
Cut Region cmd_cutRegion
Cut rest of line cmd_killLine
Cut cmd_cut
Decrease Line Indent cmd_dedent
Delete Line cmd_lineDelete
Delete Word Left cmd_deleteWordLeft
Delete Word Right cmd_deleteWordRight
Delete cmd_delete
End of Line cmd_end
Exchange Current Point and Mark cmd_transientMarkExchangeWithPoint
Go to Beginning of word cmd_beginningOfWord
Go to End of Document
cmd_documentEnd
Go to End of word cmd_endOfWord
Go to Line... cmd_gotoLine
Go to Next Bookmark cmd_bookmarkGotoNext
Go to Next Line cmd_lineNext
Go to Previous Bookmark cmd_bookmarkGotoPrevious
Go to Previous Line cmd_linePrevious
Go to Top of Document cmd_documentHome
Increase Line Indent cmd_indent
Insert Newline (align with current line) cmd_newlineSame
Insert Newline (continue comments) cmd_newlineExtra
Insert Newline (no favors) cmd_newlineBare
Insert Newline cmd_newline
Insert Next Key as Literal Character cmd_rawKey
Join current and next lines cmd_join
Move Back Part of Word cmd_wordPartRight
Move Forward Part of Word cmd_wordPartLeft
Move Left One Character cmd_left
Move One Character Right cmd_right
Move One Word Left cmd_wordLeft
Move One Word Right cmd_wordRight
Move to previous mark in mark ring cmd_transientMarkMoveBack
Page Down cmd_pageDown
Page Up cmd_pageUp
Paste and Select cmd_pasteAndSelect
Paste cmd_paste
Redo cmd_redo
Reflow paragraph(s) cmd_editReflow
Remove All Bookmarks cmd_bookmarkRemoveAll
Repeat next keystroke N times cmd_repeatNextCommandBy
Reset language to best guess cmd_viewAsGuessedLanguage
Scroll One Line Down cmd_lineScrollDown
Scroll One Line Up cmd_lineScrollUp
Scroll current line to center of screen cmd_editCenterVertically
Scroll current line to top of screen cmd_editMoveCurrentLineToTop
19.5 Find
Find Next Result cmd_findNextResult
Find Next Selected cmd_findNextSelected
Find Next cmd_findNext
Find Previous cmd_findPrevious
Find in Files... cmd_findInFiles
Find... cmd_find
Incremental Search Backwards
cmd_startIncrementalSearchBackwards
Incremental Search cmd_startIncrementalSearch
Replace... cmd_replace
19.6 General
Close All Windows cmd_closeAll
Close Project cmd_closeProject
Close Window cmd_bufferClose
Edit Properties cmd_editProperties
Export Selection as HTML... cmd_exportHTMLSelection
Export as HTML... cmd_exportHTML
Import From File System into Current Project cmd_importFromFS_Project
Least Recently Viewed File cmd_bufferNextLeastRecent
Most Recently Viewed File cmd_bufferNextMostRecent
New File (default type) cmd_new
New File... cmd_newTemplate
New Project... cmd_newProject
Next File cmd_bufferNext
Open File... cmd_open
Open Project... cmd_openProject
Open Remote File... cmd_open_remote
Open Template... cmd_openTemplate
Open URL... cmd_openURL
Preferences... cmd_editPrefs
Previous File cmd_bufferPrevious
Print Preview cmd_printPreview
Print Selection... cmd_printSelection
Print Setup... cmd_printSetup
Print... cmd_print
Quit cmd_quit
Refresh Status cmd_refreshStatus
Revert Project cmd_revertProject
Revert cmd_revert
Save All cmd_saveAll
Save As Remote... cmd_saveAs_remote
Save As Template
cmd_saveAsTemplate
Save As... cmd_saveAs
Save Project As... cmd_saveProjectAs
Save Project cmd_saveProject
Save cmd_save
19.7 Help
About Komodo cmd_helpAbout
ActiveState Programmer Network cmd_helpASPN
ActiveState Support cmd_helpSupport
ActiveState Website cmd_helpActiveState
Alternate Help on Selection cmd_helpLanguageAlternate
Help... cmd_helpHelp
Komodo Bug Database cmd_helpViewBugs
Language-Specific Help on Selection cmd_helpLanguage
PHP Mailing Lists cmd_helpPHPMailingLists
PHP Reference (Web) cmd_helpPHPRef_Web
Perl Mailing Lists cmd_helpPerlMailingLists
Perl Reference (Local) cmd_helpPerlRef_Local
Perl Reference (Web) cmd_helpPerlRef_Web
Python Mailing Lists cmd_helpPythonMailingLists
Python Reference (Local) cmd_helpPythonRef_Local
Python Reference (Web) cmd_helpPythonRef_Web
Show Keybindings... cmd_helpShowKeybindings
Software Updates cmd_helpUpdates
Start Page cmd_openStartPage
Tcl Mailing Lists cmd_helpTclMailingLists
Tcl Reference (Local) cmd_helpTclRef_Local
Tcl Reference (Web) cmd_helpTclRef_Web
Tip of the Day... cmd_helpTipOfTheDay
XSLT Mailing Lists cmd_helpXSLTMailingLists
19.8 Macro
End Recording cmd_stopMacroMode
Execute Last Macro cmd_executeLastMacro
Pause Recording cmd_pauseMacroMode
19.9 Projects/Toolbox
Add New Folder... cmd_addFolderPart
Add Remote File... cmd_addRemoteFilePart
19.12 Toolbox
Export Package cmd_toolboxExportPackage
19.13 Tools
Build Standalone Perl Application... cmd_toolsBuildPerlAppCommand
Run Command... cmd_toolsRunCommand
Rx Toolkit cmd_toolsRx
Watch File... cmd_toolsWatchFile
Templates are files that contain the basic structure for new files or projects. For example, a Perl template
might contain the standard "#!" line, appropriate copyright statements, and use statements calling a standard
set of modules.
Komodo includes templates for a number of languages languages, and lets you create and use your own.
Templates can contain Interpolation Shortcuts or Tabstops. They can be stored in a project or in the Toolbox
for quick access, and shared via the Common Data Directory.
To create a new file from a template file, in the New File dialog box, select the category in the Left Pane, then
double-click the template name in the Right Pane. A new file is created in the Komodo editor using the code
stored in the template.
When using the New File button on the Standard Toolbar, the template (if any) associated with the language
in the new files preferences is used to create the new file.
Alternatively, templates can be stored in a project or the Toolbox, and can be associated with a key binding.
1. Create Template File: In Komodo, create a file with the desired contents for the template.
2. Save as Template: Select File|Save As Template.
Custom templates are stored in the "My Templates" folder (as displayed in the Save File dialog box). Due to a
Komodo bug (41829), OS X users must navigate manually to:
Optionally, create shortcuts (on Windows), aliases (Mac OS X) or symlinks (on Linux or Mac OS X) in the
"My Templates" directory structure that point to files located elsewhere on the system. Files should have an
extension that allows Komodo to correctly detect the language (according to the settings configured in
Komodo's File Associations preference).
20 Templates 110
Komodo User Guide
If you create a directory alongside My Templates with the same name as a template group that already
exists in Komodo (such as Common or Web), the contents of the two directories are merged. If files of the
same name exist in both directories, the file in the directory at the same level as My Templates is used.
For example:
templates\
My Templates\ <--directory
MyCGI.pl <--file in the My Templates directory
TestSystem.tcl <--file in the My Templates directory
Corporate <--shortcut/symlink to corporate templates
Common\ <--directory
Python.py <--file; takes precedence over the Python.py template
MyCGI.pl <--file; displays in the Common folder
To edit an existing template, select File|Open|Template File. The directory containing the My Templates
directory (and any "merge" directories, as described above) is displayed. Select the desired template and make
the desired changes.
For example, if a template file contains the interpolation shortcut [[%date:%d/%m/%Y %H:%M:%S]],
when a new file is created from that template, the interpolation shortcut is converted to the current date and
time in the following format: 27/06/2004 11:10:21.
Interpolation shortcuts within templates use the bracketed syntax. Refer to the interpolation shortcut section
for a complete description of the code, syntax and usage.
To create a new project from a project template, click File|New|New Project from Template and choose
from one of the available templates.
To save any project as a template select the project and click Project|Create Template From Project..., or
right-click on the project and click Create Template From Project.... in the context-menu. The project will
be exported as a project package and saved in the project-templates/My Templates sub-directory of the user
data directory. Once the project has been saved as a template, it becomes available via File|New|New Project
from Template.
Komodo ships with project templates for, Ruby on Rails, Komodo Extensions, and Firefox Extensions.
be added to the Toolbox via the New File dialog box. Select Add to Toolbox to add the selected template to
the Toolbox.
Open Template: Use this option to create a new file from the selected template.
Cut/Copy/Paste: These options are used to remove the template from a project or the Toolbox, or to
move templates between the project and the Toolbox (and vice versa).
Export as Project File: When this option is invoked, a new project file is created that contains the
template from which the option is invoked. You are prompted to provide the name of the new project
file and the directory where it will be stored. To open the new project file, select File|Open|Project.
Export Package: Templates can be archived and distributed among multiple Komodo users via
"packages". Packages are compressed archive files that contain the template from which the Export
Package option was invoked. Packages are stored in files with a ".kpz" extension, and can be opened
by any archiving utility that supports libz (for example WinZip). The Export Package option
differs from the Export as Project File option in that copies of filesystem-based components (such as
files and dialog projects) are included in the archive. Conversely, Export as Project File creates a
project with a reference to the component's original location and does not create copies of the
components. When Export Package is invoked, you are prompted for a name and file location for the
package. Exported packages can only be imported into "container" objects in Komodo, such as
projects, the Toolbox, and folders within projects and the Toolbox. See Toolbox - Exporting and
Importing Toolbox Contents, Projects - Importing and Exporting Projects via Packages, or Folders -
Import Contents from Package for more information.
Rename: To change the name of a template (as displayed in the Projects or Toolbox sidebars), select
this option and enter a new name.
Delete: To remove a template from a project or the Toolbox, select this option. The reference to the
template is deleted; the file containing the template is not deleted.
Properties: Changes the title or the disk location of the template. In addition, the icon and key
binding assigned to the template are accessed via the Properties dialog box. See below for instructions
on altering the template's icon or key binding.
1. On the Projects or Toolbox tab, right-click the desired template and select Properties. Alternatively,
click the template in the Projects or Toolbox tab, then select Projects|template_name|Properties or
Toolbox|template_name|Properties.
2. In the Properties dialog box, click Change Icon.
3. In the Pick an Icon dialog box, select a new icon and click OK. Alternatively, click Choose Other,
and browse to the desired image file.
4. In the Properties dialog box for the template, click OK. The custom icon is displayed next to the
template.
1. On the Projects or Toolbox tab, right-click the desired template and select Properties.
2. Click Reset, then click OK. The default icon is displayed next to the template.
Open shortcuts are references stored in projects or the Toolbox that point to directories on a local or network
drive. When an open shortcut is invoked, the standard Open File dialog box is displayed with the contents of
the directory. Open shortcuts make it quick to access deep directories that are frequently used.
Refer to Adding Components to Projects or Adding Components to the Toolbox for instructions on adding
components to projects or the Toolbox. In addition, open shortcuts can be created by right-clicking a file in a
project or the Toolbox and selecting Make "Open..." Shortcut.
Open (Shortcut): Use this option to display the contents of the folder specified in the open shortcut.
Cut/Copy/Paste: These options are used to remove components from a project or the Toolbox, or to
move components between the Projects sidebar and the Toolbox.
Export as Project File: When this option is invoked, a new project file is created that contains the
open shortcut from which the option is invoked. You are prompted to provide the name of the new
project file and the directory where it will be stored. To open the new project file, select
File|Open|Project.
Export Package: Open shortcuts can be archived and distributed among multiple Komodo users via
"packages". Packages are compressed archive files that contain the open shortcut from which the
Export Package option was invoked. Packages are stored in files with a ".kpz" extension, and can be
opened by any archiving utility that supports libz (for example WinZip). The Export Package
option differs from the Export as Project File option in that copies of filesystem-based components
(such as files and dialog projects) are included in the archive. Conversely, Export as Project File
creates a project with a reference to the component's original location and does not create copies of
the components. When Export Package is invoked, you are prompted for a name and file location for
the package. Exported packages can only be imported into "container" objects in Komodo, such as
projects, the Toolbox, and folders within projects and the Toolbox. See Toolbox - Exporting and
Importing Toolbox Contents, Importing and Exporting Projects via Packages, or Folders - Import
Contents from Package for more information.
Rename: To change the name of an open shortcut, select this option and enter a new name.
Delete: To remove an open shortcut from a project or the Toolbox, select this option. The open
shortcut is permanently deleted.
The default open shortcut icon can be replaced with custom icons. Komodo includes more than 600 icons;
alternatively, select a custom image stored on a local or network drive (use 16x16-pixel images for best
results).
1. In the Projects sidebar or Toolbox tab, right-click the desired open shortcut and select Properties.
Alternatively, click the open shortcut in the Projects tab or Toolbox tab, then select
Projects|shortcut_name|Properties or Toolbox|shortcut_name|Properties.
2. In the Properties dialog box, click Change Icon.
3. In the Pick an Icon dialog box, select a new icon and click OK. Alternatively, click Choose Other,
and browse to the desired image file.
4. In the Properties dialog box for the open shortcut, click OK. The custom icon is displayed next to the
open shortcut.
1. In the Projects sidebar or Toolbox tab, right-click the desired open shortcut and select Properties.
2. Click Reset, then click OK. The default icon is displayed next to the open shortcut.
Custom key bindings can be assigned to open shortcuts stored in the Toolbox or in a Project. Use the Key
Binding tab in the open shortcut's Properties to specify the keystrokes that invoke the open shortcut. See Key
Bindings for Custom Components for more information.
Refer to Adding Components to Projects or Adding Components to the Toolbox for instructions on adding
components to projects or the Toolbox. In addition, URL shortcuts can be created by dragging a URL from a
browser address bar or from a Komodo tab onto a project or Toolbox. URLs must be preceded by "http://".
To open a URL, double-click the URL name (which opens the URL in an external browser), use the assigned
key binding, or right-click the URL and select Open URL in browser or Open URL in tab.
Open URL in browser: Use this option to launch the default web browser (as specified in the Web
and Browser preference) and display the stored URL.
Open URL in tab: Use this option to display the stored URL in a tab in the Komodo Editor Pane.
Cut/Copy/Paste: These options are used to remove the URL shortcut from a project or the Toolbox,
or to move URL shortcuts between the project and the Toolbox (and vice versa).
Export as Project File: When this option is invoked, a new project file is created that contains the
URL shortcut from which the option is invoked. You are prompted to provide the name of the new
project file and the directory where it will be stored. To open the new project file, select
File|Open|Project.
Export Package: URLs can be archived and distributed among multiple Komodo users via
"packages". Packages are compressed archive files that contain the URL shortcut from which the
Export Package option was invoked. Packages are stored in files with a ".kpz" extension, and can be
opened by any archiving utility that supports libz (for example WinZip). The Export Package
option differs from the Export as Project File option in that copies of filesystem-based components
(such as files and dialog projects) are included in the archive. Conversely, Export as Project File
creates a project with a reference to the component's original location and does not create copies of
the components. When Export Package is invoked, you are prompted for a name and file location for
the package. Exported packages can only be imported into "container" objects in Komodo, such as
projects, the Toolbox, and folders within projects and the Toolbox. See Toolbox - Exporting and
Importing Toolbox Contents, Projects - Importing and Exporting Projects via Packages, or Folders -
Import Contents from Package for more information.
Rename: To change the name of a URL shortcut, select this option and enter a new name.
Delete: To remove a URL shortcut from a project or the Toolbox, select this option. The URL
The default URL shortcut icon can be replaced with custom icons. Komodo includes more than 600 icons;
alternatively, select a custom image stored on a local or network drive (use 16x16-pixel images for best
results).
1. In the Projects or Toolbox sidebar, right-click the URL shortcut and select Properties. Alternatively,
click the URL shortcut to select it, then select Projects|macro_name|Properties or
Toolbox|macro_name|Properties.
2. In the Properties dialog box, click Change Icon.
3. In the Pick an Icon dialog box, select a new icon and click OK. Alternatively, click Choose Other,
and browse to the desired image file.
4. In the Properties dialog box for the URL shortcut, click OK. The custom icon is displayed next to the
URL shortcut.
1. In the Projects or Toolbox sidebar, right-click the desired URL shortcut and select Properties.
2. Click Reset, then click OK. The default icon is displayed next to the URL shortcut.
Custom key bindings can be assigned to URL shortcuts stored in the Toolbox or in a Project. Use the Key
Binding tab in the URL shortcut's Properties to specify the keystrokes that invoke the URL shortcut. See Key
Bindings for Custom Components for more information.
Run Commands
Feature Showcase
Run commands are operating system commands run from within Komodo. Use the Run Command dialog box
to interact with the system command line or shell while editing or debugging files in Komodo. Besides
making it easy to run simple and complex custom commands from within Komodo, the Run Command dialog
box can insert the results of shell commands into a document in the Editor Pane, or pass the contents of a
document to the system command line or shell.
To view examples of run commands, see the "Samples" folder in the Toolbox.
Run commands can be stored for re-use in a project or the Toolbox, where they can be assigned key bindings.
Access the last ten commands executed in the Run Command dialog box by selecting Tools|Recent
Commands. The prefixes [i], [l] and [il] indicate that Insert output, Pass selection as input or both were
selected with the original command.
The Run Command dialog box can be toggled between its "simple" or "advanced" form by clicking the
More/Less button.
Add to Toolbox: If this check box is selected, the command is saved in the Toolbox.
Start in: Enter the directory where the command should be run, or click the Browse button to
navigate the filesystem. Click the arrow button to the right of the Start in field to select interpolation
shortcuts pertinent to the Start in setting. Interpolation shortcuts are inserted at the current cursor
position in the Run field.
Run in: Specify the environment in which the command should be run. The options are:
Command Output Tab: The command is run in Komodo's Bottom Pane.
New Console: The command is run in a new shell or command window.
No Console (GUI Application): The command launches the specified application without
displaying output in a shell or on the Command Output tab.
Do not open output pane: If this check box is selected, the Bottom Pane containing the Command
Output tab does not automatically open when the command is run. To manually view the Bottom
Pane, select View|Command Output. (This option is only accessible if the Run in field is set to
Command Output tab.)
Parse output with: If this check box is selected, the field to the right is used to enter a regular
expression that parses the output. See Parsing Command Output in the Run Command Tutorial for an
example. (This option is only accessible if the Run in field is set to Command Output tab.)
Show parsed output as list: If output parsing is configured, select Show parsed output as list to
display the output in list format on the Command Output tab. (This option is only accessible if the
Run in field is set to Command Output tab.)
Environment Variables: Use the Environment Variables section of the dialog box to configure
new environment variables or change the value of existing environment variables for the duration of
the run. To add or alter an environment variable, click New and configure the following values:
Variable Name: Enter a name for the variable.
Variable Value: Enter a value for the variable.
Interpolation Shortcut: Click the arrow button to the right of the Variable Value field to
insert an interpolation shortcut pertinent to the Variable Value setting. The interpolation
shortcut is inserted at the current cursor position in the Variable Value field.
Add Path: Click this button to insert a directory as the variable value.
Save advanced options as defaults: If this check box is selected, the current settings are stored as the
defaults for the Run Command dialog box.
If the command prompts for input, enter it directly on the Command Output tab. Output written to "stderr"
(standard error output) is displayed in red at the top of the tab. Click the Close button at the top right of the
Command Output tab to terminate a running command. Click the Toggle Raw/Parsed Output View button
to jump from parsed results to raw output and vice versa. (Parsing is enabled and configured via the Parse
output with field.)
Note: For more information on parsing command output, see the Parsing Command Output section of the Run
Command Tutorial.
To run a command stored in the Toolbox or in a project, double-click the run command's name, use the
assigned key binding, or right-click the run command and select Run.
To access run command options for the selected run command, right-click the run command's name. The
options are as follows:
The default run command icon can be replaced with custom icons. Komodo includes more than 600 icons;
alternatively, select a custom image stored on a local or network drive (use 16x16-pixel images for best
results).
1. In the Projects sidebar or Toolbox, right-click the desired run command and select Properties.
Alternatively, single click the run command to highlight it in the sidebar then select
Projects|runcommand_name|Properties or Toolboxruncommand_name|Properties.
2. In the Properties dialog box, click Change Icon.
3. In the Pick an Icon dialog box, select a new icon and click OK. Alternatively, click Choose Other,
and browse to the desired image file.
4. In the properties dialog box for the run command, click OK. The custom icon is displayed next to the
run command.
1. In the Projects or Toolbox sidebar, right-click the desired run command and select Properties.
2. Click Reset, then click OK. The default icon is displayed next to the run command.
Custom key bindings can be assigned to run commands stored in the Toolbox or in a Project. Use the Key
Binding tab in the run command's Properties to specify the keystrokes that invoke the run command. See Key
Bindings for Custom Components for more information.
Custom toolbars and menus are used to extend Komodo's default menus and toolbars with menus and toolbars
containing custom items. Any component that can be stored in a project or the Toolbox can be stored in a
custom toolbar or menu. A custom toolbar might contain frequently used run commands and snippets; a
custom menu might contain folders with the contents of a local filesystem.
Custom toolbars and menus are created and configured within the Project Manager and/or the Toolbox.
Custom toolbars and menus contained in projects are only displayed when the projects are open in the Projects
sidebar; custom toolbars and menus contained in the Toolbox are always displayed.
Export as Project File: When this option is invoked, a new project file is created that contains the
custom menu or toolbar from which the option is invoked. You are prompted to provide the name of
the new project file and the directory where it will be stored. To open the new project file, select
File|Open|Project.
Export Package: Snippets can be archived and distributed among multiple Komodo users via
Packages. Packages are compressed archive files that contain the snippet from which the Export
Package option was invoked. Packages are stored in files with a ".kpz" extension, and can be opened
by any archiving utility that supports libz (for example WinZip). The Export Package option
differs from the Export as Project File option in that copies of filesystem-based components (such as
files and dialog projects) are included in the archive. Conversely, Export as Project File creates a
Custom menus are displayed between the default Tools and Window menus. If multiple custom menus are in
effect, the display order depends on the menu's Priority setting. New menus have a default priority of 100;
alter the priority of custom menus to control the left-to-right order of display.
Custom toolbars are displayed to the right of default Komodo toolbars. If necessary, a new row is created for
their display. If multiple custom toolbars are in effect, the display order depends on the toolbar's Priority
setting. New toolbars have a default priority of 100; alter the priority of custom toolbars to control the
left-to-right order of display.
To assign a letter to be used in combination with the 'Alt' key for menu access, enter a shortcut letter in the
Menu Access Key field. If the letter is already assigned to a Komodo core function, you are prompted to enter
a different letter.
Perl tutorial
Python tutorial
PHP tutorial
Ruby tutorial
XSLT tutorial
Feature Showcases
conditional breakpoints
XSLT debug view
The Komodo debugger is a tool for analyzing programs on a line-by-line basis, monitoring and altering
variables, and watching output as it is generated. Debugging features include:
The sections that follow contain general information about the debugger that is applicable to each language.
Komodo provides debugging support for JavaScript, Perl, Python, PHP, XSLT and Tcl. For information about
configuring languages and language-specific debugger functions, see:
Debugging JavaScript
Debugging Perl
Debugging Python
Debugging PHP
Debugging Ruby
Debugging Tcl
Debugging XSLT
Notes
Perl Debugging on Windows 98/Me requires ActivePerl Build 623 or higher. Restart your machine
after you install ActivePerl to be sure that your system's PATH variable is updated with the location of
Perl.
Be sure you meet the software prerequisites for debugging, as described in the Installation Guide.
By default, the Debugging Options dialog box is displayed (unless the debugger preference has been
configured to start without displaying the dialog box). To override the debugger preference on Windows and
Linux systems, hold down the 'Ctrl' key while invoking the key binding for starting the debug session. (Select
Help|List Key Bindings to view the current key bindings; use the key bindings preference to configure
custom key bindings.) Alternatively, the 'Ctrl' key can be used to suppress the display of the Debugging
Options dialog box.
If multiple files are open in the Editor Pane, the program that is currently displayed is debugged. If no
breakpoints are set, Go/Continue causes the debugger to run to the end without stopping. Step In moves
through the program one line at a time.
By default, the debugger will break on the first line of executable code when it starts. This is useful for adding
breakpoints if none have been set yet. To change this behavior, set Initial break behavior to Run to first
breakpoint in the debugger preferences (Edit|Preferences|Debugger).
When debugging multiple sessions, each session has a unique Debug tab (located in the Bottom Pane) for
controlling the debug actions specific to that process. A Debug tab is created each time a new debugger
session is started. To close a Debug tab, click the X button at the top right corner.
To suppress the display of the Debugging Options dialog box on Windows and Linux systems, hold down the
'Ctrl' key while clicking the desired debugging button on the Debug Toolbar, or use the desired keyboard
shortcut. Change the default display by selecting Skip debug options dialog from
Edit|Preferences|Debugger.
Change variables by adding a new variable with the same name and a new value. These changes have no
effect outside of the Komodo debugger and are stored in each saved configuration.
To Add New Variables: Click New and enter the Variable Name and Variable Value in the
Environment Variable dialog box. To add one or more directories to the Variable Value field, click
Add Path and navigate to the desired directory.
To Edit Existing Variables: Select the variable, click Edit, then change as desired. This creates a
new variable with the same name and the desired value. (User Environment Variables take
precedence over Default Environment Variables.)
To Delete a Variable: Select the variable from the User Environment Variables pane and click
Delete. Default Environment Variables cannot be deleted, but can be set to an empty value.
To Add New Variables: Click New, and enter the Variable Name and Variable Value in the
Environment Variable dialog box. To add one or more directories to the Variable Value field, click
Add Path and navigate to the desired directory.
To Edit Existing Variables: Select the variable, click Edit, then change as desired. This creates a
new variable with the same name and the desired value. (User CGI Environment Variables take
precedence over Default CGI Environment Variables.)
To Delete a Variable: Select the variable from the User CGI Environment Variables pane and
click Delete.
Request Method: Select the request method that has been assigned to the form in the CGI program.
Post Type: Select the format in which data is sent from the browser to the server.
Use the Request Variable section of the dialog box to create variables that are processed by your CGI
program. These variables are displayed in the Browser Arguments section of the dialog box.
Type: Specify the type of input associated with the variable (GET, POST, cookie or file).
Name: Enter the variable name as specified in the CGI program.
Value: Enter the value for the variable specified in the Name field. To provide a directory path and
file, click the Browse Files button, select the desired file and click Add. (To accommodate file
uploads, select Multipart as the form's POST method.)
To alter variables: Click on the desired variable in the Browser Arguments section of the dialog box, make
changes in the Type, Name and Value fields, then click Update.
To delete variables: click on the desired variable in the Browser Arguments section of the dialog box, and
click Delete.
1. Click New...
2. Enter a unique Configuration Name.
3. Click OK.
Existing saved configurations can be selected from the drop-down list. If you wish to delete a saved
configuration, select it from the list and click Delete.
If the file being debugged is part of a project that is currently open, these preferences are saved in that project.
If not, this configuration is automatically saved as part of the file's Properties and Settings (although they
cannot be altered via the file's Properties dialog box).
Spawnpoints are set at points in a Tcl script where you want an external application to execute (spawn). When
a spawnpoint is encountered during the debugging process, Komodo configures the spawned application to
start as a new debugger session. Both the initial and spawned debugger sessions run concurrently. Enabled
spawnpoints appear as solid green arrows in the left margin of the Editor pane and are also listed on the
Breakpoints tab during debugging. Disabled spawnpoints appear as white arrows with a green outline.
Double-clicking an enabled or disabled spawnpoint from the Breakpoints tab opens the associated file in the
Editor pane and shifts focus to the line number coinciding with that spawnpoint location.
toggle breakpoints
toggle spawnpoints
go to source code
set breakpoint properties
Breakpoints and Spawnpoints can be toggled between enabled, disabled and deleted. To toggle a breakpoint,
do one of the following:
Breakpoint Margin: Click on the line you wish to break at once to enable a breakpoint, a second
time to disable it, and a third time to delete it.
Debug Menu: Click Enable/Disable Breakpoint once to enable a breakpoint on the current line, a
second time to disable it, and a third time to delete it.
Keyboard: Press 'F9' ('Meta'+'\' on Mac OS X) once to enable a breakpoint on the current line, a
second time to disable it, and a third time to delete it.
1. Click the New button and then select New Breakpoint or right-click in the Breakpoints pane and
select Add|New Breakpoint on the context menu.
2. The following Breakpoint Properties are required:
3. Language: By default, the language of the program being debugged.
File: The location of the file where the breakpoint is being set.
Line: The line number in the file where the spawnpoint is to be set.
Enable: Select the check box to enable the breakpoint.
4. Click OK.
On the Breakpoints tab, click the Disable/Enable All Breakpoints button. All breakpoints are
disabled if previously enabled, or enabled if previously disabled.
1. Click the New button and then select New Tcl Spawnpoint or right-click in the Breakpoints list and
select Add|New Tcl Spawnpoint on the context menu.
2. The following properties are configurable in the Spawnpoint Properties dialog box:
3. Language: Tcl
File: The location of the file where the spawnpoint is to be set (for example,
C:\samples\tcl_sample.tcl).
Line: The line number in the file where the spawnpoint is to be set.
Enable: Select the check box to enable the spawnpoint. Deselect the check box to disable the
spawnpoint.
4. Click OK.
On the Breakpoints tab, click the Disable/Enable All Breakpoints button. All spawnpoints are
disabled if previously enabled, or enabled if previously disabled.
Note: Breakpoints and spawnpoints added or modified while a program is running are not necessarily updated
in the breakpoint manager. To add breakpoints while debugging, interrupt the debugging session using the
Break button to ensure that the new breakpoint is properly updated.
To open the source code in the Editor Pane at the line number where the breakpoint or spawnpoint is set, do
one of the following:
Breakpoints Tab: Double-click the breakpoint to view the associated source code.
Breakpoints Tab: Select the desired breakpoint and click the Go to the Source Code button.
When adding or editing a breakpoint in the Breakpoint tab, a Breakpoint Properties dialog box appears.
This dialog box contains a tab for each available breakpoint type. Change the breakpoint type by switching to
a different tab.
Each tab is split into two parts, separated by a horizontal line. The top section contains configuration items
that are required; the bottom section contains configuration options that are optional. The last item on this tab
for 1 in range(256):
print 'hello'
2. Define a hit condition 'Break when hit count is a multiple of'.
3. Enter the value 5. The debugger breaks every 5th time it passes the line with the print
statement.
Not all breakpoint types are supported for all languages. The following table shows breakpoint support by
language:
Use the Break Now function to stop debugging an application at the current execution point, and then
continue debugging from that point. For example, use this control when debugging applications running long
processes. To force a break while debugging an application, do one of the following:
Komodo can be set to Listen for Debugger Connections continuously. Additionally, you can set remote
debugger preferences and check listener status of the current listener configuration. For instructions on
configuring specific languages for remote debugging, see:
Debugging Perl
Debugging Python
Debugging PHP
Debugging XSLT
Debugging Tcl
Consult the language-specific debugging documentation listed above for configuration instructions.
Note: A check mark appears when Listen for Debugger Connections is enabled. Otherwise, this feature is
disabled.
1. On the Debug menu, select Listener Status. The Debugger Listener status screen appears.
2. Click OK after reviewing listener status, or use the associated key binding.
For example, the file '/www/htdocs/php/info.php' on a server named 'myserver', would send the
following URI to Komodo:
file://myserver/www/htdocs/php/info.php
If 'myserver' was accessible via SFTP, you could add the following mapping in Komodo's Preferences:
URI: file://myserver/www
Path: sftp://user@myserver/apache/www
This mapping would apply to all files in www and it's subdirectories.
The Path can include remote files accessed via FTP, SFTP or SCP as well as files on the local filesystem.
Mapped URIs can also be specified by right-clicking on the editor tab and selecting Create Mapped URI
from the context menu. By default, the Path field will show the full path of the file in that editor tab. This
path can be shortened to include more files and directories in the mapping (as above).
Example
If you are debugging scripts on a remote web server that cannot connect to Komodo directly because of a
firewall, you can run dbgpProxy on an intermediary server (e.g. a gateway) which can connect to Komodo and
the web server on specified ports. The three servers in this example are:
1. workstation: The machine running Komodo. The following preferences are set:
Listen for Debugger Connections is enabled.
Enable Debugger Proxy is selected.
Listen for debug connections on port is set to '0' (use system-assigned port)
Proxy Listener Address is set to gateway:9001
Proxy Key is set to "jdoe"
Debug|Listener Status displays a system-assigned Host Port of 37016.
2.
3. gateway: A gateway server with access to the internal and external networks. The proxy is running
with the following options:
The remote debugger running on 'webserver' (dbgpClient.py in this case) connects to the proxy
(dbgpProxy.py) running on 'gateway'. The proxy uses the IDE Key "jdoe" to connect the debugger process to
the Komodo instance listening with a Proxy Key of "jdoe". The proxy continues to communicate with the
remote debugger on port 9000, but routes the debugging session to Komodo on port 37016.
Step In: Executes the current statement and pauses at the following statement.
Step Over: Executes the current statement. If the line of code calls a function or method, the function
or method is executed in the background and the debugger pauses at the statement that follows the
original one.
Step Out: When the debugger is within a function or method, Step Out will execute the code without
stepping through the code line by line. The debugger will stop on the line of code following the
function or method call in the calling program.
When stepping through a program which calls a function or method from an external program (e.g. a module
or package) the debugger steps into the external program at the point where the function or method is called,
opening it in a new tab. Stepping continues in the external program until the function call is completed.
Note: Perl operators sort, map, and grep behave like other looping constructs with respect to stepping
behavior in the debugger. When Komodo has stopped at one of these operators, Step Over stops at the first
statement or expression used within the first argument of these operators.
For example, if the debugger steps over a statement containing a foreach, while, map, grep, or sort
looping construct that evaluates its body five times, the debugger remains inside that loop for five iterations.
When it steps over on the sixth iteration, the debugger exits the loop and stops at the next statement.
To skip execution of such looping constructs, set a breakpoint on the statement following the construct, and
continue until Komodo reaches that breakpoint.
When debugging more than one session at a time (multi-session debugging), a Debug tab for each session is
accessible in the Bottom Pane. The Debug tab selected is the session currently being debugged. To change to
another debug session, select the Debug tab for that session (identified by the filename of the program). When
a new session is started, a new Debug tab is created and Komodo automatically switches to that new session.
The Debug tab is divided into two sub-panes, which have tabs of their own. The right sub-pane contains the
Output, Call Stack, and HTML Preview tabs. The left sub-pane contains variable tabs.
To Expand or Collapse Variables: Plus symbols indicate variables with multiple values that can be
expanded; minus symbols indicate variables that can be collapsed. Click on the plus or minus symbol to
expand or collapse the variable list.
To Change Variable Values: Double-click in the variable's Value field and enter the desired value. (The
value of nodes in XML documents cannot be changed.)
While debugging Python programs, variables and objects are displayed on the Locals, Globals, and Code
Objects tabs:
Locals: Displays variables referenced within the current function. If the program is currently outside
of a function, all variables are displayed.
Globals: Displays all used program variables.
Code Objects: Displays an expandable tree view of all classes, functions, and their attributes.
During Python debugging sessions, click the Show Hidden Variables button to display special Python
variables prefixed with double underscores, such as __doc__, __dict__, etc.
While debugging PHP and Tcl programs, variables are displayed on the Locals and Globals tabs:
Locals: Displays variables referenced within the current function. If the program is currently outside
of a function, all variables are displayed.
Globals: Displays all used program variables. Note: PHP "Super Globals" ($_POST, $_GET, etc.) are
hidden by default. The Show Hidden Variables button will toggle them on and off.
While debugging Perl programs, Argument and Special tabs are displayed in addition to the Locals and
Globals tabs listed above.
While debugging XSLT programs, data nodes and variables are displayed on the Locals and Globals tabs:
Locals: Displays data nodes from the input XML document. Only nodes contained in the context of
the template specified in the Call Stack are displayed.
Globals: Displays xsl:param and xsl:variable elements declared at the top level of the
program.
Watched variables can be added, manipulated and removed regardless of whether the debugger is currently
running.
Click the Add button on the Watch variables tab and type a variable name in the dialog box
Select the variable in the editor (or any other drag-and-drop aware application), then drag and drop
the variable into the Watch tab
Right-click a variable in one of the other variable tabs and select Add to Watch from the context
menu.
The Watch variable tab supports viewing the results of expressions made with watched variables. For
example, in a Perl program with scalar variables $base and $height the following expression could be
entered:
($base / 2) * $height
Double-click the variable on the Watch variable tab and specify a value. Currently, only the values of
simple variables can be changed. For example, values of variables such as 'a.b[3]' (in Python) or
'$a{b}->[3]' (in Perl) cannot be changed.
Note: This function is not available for arbitrary expressions.
Double-click the variable on the Locals or Globals pane and specify a value in the dialog box.
To remove a variable from the Watch variable tab, select the variable and click Delete on the bottom right
toolbar. Alternatively, right-click the desired variable and select Remove Watch on the context menu.
When debugging Tcl and Python, if stdin is requested by the program, a red percent character is shown in
the margin of the Output tab.
To view the call stack in a current debugging session, select the Call Stack tab in the right pane of the Debug
tab.
There is one line in this tab per stack frame at any point in the execution of a program. The calling frame
contains the information about a function call, including the filename, the line number, and any parameters or
local variables.
The Watch File tool shows a file as the file is being updated on disk. It has no relationship with variable
viewing, except that, while debugging, it is often useful to watch variables change state and files change
content.
To detach application execution from the debugging process, do one of the following:
JavaScript Tutorial
Komodo can debug local or remote JavaScript programs. Unlike other dynamic language debugging, Komodo
uses uses the Firefox browser as its JavaScript runtime environment. JavaScript enabled pages are loaded,
viewed and controlled in Firefox, and the debugging information is passed to Komodo via the Komodo
JavaScript Debugger extension.
The instructions below describe how JavaScript debugging works in Komodo, and how to configure Komodo
and Firefox for debugging. For general information about using the Komodo debugger, see Komodo
Debugger Functions.
The Pretty Print Debug toolbar button and menu option allows for manual toggling of this view. This option
is important in two cases:
JavaScript in an HTML element: When JavaScript is used within an HTML element, the Komodo
JavaScript Debugger currently returns a code object without the HTML context. For example:
If this construct were on line 200 of an HTML file, the debugger would not open the HTML file at
line 200, but automatically display the following in Pretty Print mode:
function onclick(event) {
javascript:
alert("This is an alert!");
}
eval(): As JavaScript does not have a 'use' statement to pull in modules, eval() is often used to
dynamically load JavaScript code (common in various JavaScript web toolkits). When stepping
through the contents of an eval() it will often be helpful to switch to Pretty Print mode.
In the following example the string being evaluated is actually JavaScript code defined in the code
variable.
function runIt() {
eval(code);
}
runIt();
</script>
When stepping through this code in normal mode, Komodo will spend several extra steps on the
eval(code) line without jumping up to the embedded code in the var code section. In more
complex JavaScript, or in eval() instances that call external files or dynamically generated code,
this would be quite uninformative.
In Pretty Print mode, the code objects are returned individually, each in a new editor tab, as you step
through the code. When the eval(code) line is encountered, a new tab will open up displaying the
embedded JavaScript from the var code section.
When debugging these JavaScript constructs, you may find that the line numbers displayed in the Call Stack
are wrong, sometimes even specifying a line number beyond the last line of the file. This is a side-effect of the
JavaScript library constraints mentioned earlier, and an indicator that you should switch to Pretty Print mode
(if Komodo has not done this automatically).
Alternatively, launch Firefox and navigate to the /lib/support/modules/ subdirectory of your Komodo
installation and open the xpi files.
Once these extensions have been installed, the Komodo JavaScript Debugger extension must be configured to
communicate with Komodo. In Firefox, click Tools | Komodo JavaScript Debugger | Options.
Host: This is set to 127.0.0.1 (localhost) by default and should not normally need to be changed. If
Firefox is running on a different host, or if you are using a DBGP Proxy, set the appropriate IP
address here.
Port: This should be set to the same value that is set in Komodo's Debugger preferences. This port
setting can also be checked by clicking Debug | Listener Status.
Use Proxy: Select this option if you are connecting to Komodo via a DBGP Proxy.
Proxy Key: If Use Proxy is selected, this should be set to the same value configured in Komodo's
Debugger preferences.
1. Click Debug | Listen for Debugger Connections in Komodo if it is not already selected.
2. Open the web page or local file you wish to debug in Firefox.
3. In Firefox, click Connect to Komodo Debugger in the Komodo JavaScript Debugger toolbar or click
Tools | Komodo JavaScript Debugger | Connect to Komodo Debugger.
4. In Firefox, click or mouse over a JavaScript control or, if your page contains one, wait for a
JavaScript timer event.
At this point the New Remote Debugger Connection dialog box may appear asking if you want to accept the
debugger session. Click Yes to open the program in a new editor tab. Select "Don't ask me again." to
automatically accept all remote debugging sessions in future.
Breakpoints can now be set and the program can be interactively debugged in Komodo. See Komodo
Debugger Functions for full instructions on using Komodo's debugging functionality.
Perl Tutorial
Komodo can debug Perl programs locally or remotely, including debugging in CGI and mod_perl
environments. The instructions below describe how to configure Komodo and Perl for debugging. For general
information about using the Komodo debugger, see Komodo Debugger Functions.
Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar.
For a summary of debugger commands, see the Debugger Command List.
On the Debug menu or Debug Toolbar, click Go/Continue or Step In to invoke the debugging session. See
Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
To enable Break Now, include the setting 'async=1' in the PERLDB_OPTS environment variable. This can
be done in Komodo's Environment preferences (Edit|Preferences...|Environment).
Perl remote debugging works on any system that can run the version of perl5db.pl distributed with Komodo.
ActivePerl and most other distributions of Perl (version 5.6 or greater) will work.
Note: If you have the ActiveState Perl Development Kit (PDK) installed, follow the instructions for PDK
users to disable the PDK debugger before continuing.
1. Copy Komodo's perl debugger and its associated libraries to the remote machine by copying the entire
dbgp/perllib sub-directory of the Komodo installation to the new machine, or download a package
from the Komodo Remote Debugging page.
Note: Do not copy perl5db.pl to the standard "lib" directory of the Perl installation on the remote
machine, as this will overwrite the standard perl5db.pl file.
2.
3. On the remote machine, set the PERL5LIB environment variable to the location of the new
perl5db.pl and its libraries. For example, if the remote machine is running Windows and perllib
directory was copied to C:\misc\perllib, set the variable as follows:
set PERL5LIB=C:\misc\perllib
For example, if the remote machine is running Linux or Mac OS X and perllib was copied to the
/home/me/perl/komodo_perl_debugging directory, set the variable as follows:
export
PERL5LIB=/home/me/perl/komodo_perl_debugging/perllib
4. On the remote machine, set the PERLDB_OPTS and DBGP_IDEKEY variables. This tells the Perl
interpreter on the remote machine where to connect to Komodo or the DBGP Proxy and how to
identify itself.
PERLDB_OPTS=RemotePort=<hostname>:<port>
DBGP_IDEKEY=<ide_key>
The port number must match the port number specified in Edit|Preferences|Debugger. Click
Debug|Listener Status to check the current port.
Replace <hostname> with the name or IP address of the machine running Komodo.
If DBGP_IDEKEY is unset, the USER or USERNAME environment variable is used as the
IDE Key.
The variable definitions must be on one line.
For example:
set PERLDB_OPTS=RemotePort=127.0.0.1:9000
set DBGP_IDEKEY=jdoe
Windows Me
Use the MSCONFIG utility (Start|Run|MSCONFIG). Select the Environment tab, and create a new
variable with the Variable Name of PERLDB_OPTS, and the Variable Value of
RemotePort=127.0.0.1:9000.
export PERLDB_OPTS="RemotePort=127.0.0.1:9000"
export DBGP_IDEKEY="jdoe"
Note: As with local debugging, the Break Now function is disabled by default. To enable this button
and functionality, add the option 'async=1' to the PERLDB_OPTS environment variable. For
example, on Windows:
perl -d program_name.pl
Click Step In, or Go/Continue to run to the first breakpoint. See Komodo Debugger Functions for full
instructions on using Komodo's debugging functionality.
Option 1:
27.3 Disabling and Enabling the Perl Dev Kit (PDK) Debugger 147
Komodo User Guide
Windows
Linux
export PERLDB_OPTS=
To re-enable the PDK debugger, set the PERL5DB variable to an empty string.
Option 2: (Windows)
These changes take effect in new Command Prompt windows. To re-enable the PDK debugger, delete the
PERL5DB variable, and change the PERLDB_OPTS variable back to it's original value.
The settings and paths listed are examples only. Substitute these with the specific paths, hostnames and port
numbers of your server as necessary
Note: The path for the PERL5LIB directory shown above is the correct path in a default installation.
That path must be changed if you have installed Komodo in a different location. Also, the debugger
doesn't seem to be able to find the libraries if any directories in the path contain spaces. You should
Extension = .pl
Executable Path = c:\perl\bin\perl.exe -d "%s" %s
IIS 6:
1. Open the Internet Information Services manager.
2. Select the Web Service Extensions node.
3. Add (or modify) the Web Service Extension for Perl CGI as above.
Reboot: The system must be rebooted for the changes to take effect. Environment variables are not
updated by restarting the IIS service.
Modify the httpd.conf file: The following values can be configured for a specific virtual host or all
hosts. Add the following values in the appropriate sections:
Modify the Perl Script: Add the "-d" flag to the "shebang" line:
#!/perl/bin/perl -d
1. Copy the entire dbgp/perllib sub-directory of the Komodo installation to a convenient directory on the
server, or download and unpack the Perl Remote Debugging package from the Komodo Remote
Debugging page. If you are running Apache on your local workstation, you can use Komodo's copy
directly (e.g. <Komodo-install-dir>/lib/support/dbgp/perllib ) for the following steps. Note: Do not
copy perl5db.pl to the standard "lib" directory of the Perl installation on the remote machine, as this
will overwrite the standard perl5db.pl file.
2.
3. In the directory containing perl5db.pl, create a new directory called Apache. For example:
$ cd Komodo/lib/support/dbgp/perllib
$ mkdir Apache
4. Create a symlink or shortcut to perl5db.pl within the new Apache directory. For example:
$ cd Apache
$ ln -s ../perl5db.pl .
5. Install the Apache::DB perl module on the server:
$ cpan Apache::DB
6. Add the following snippet to your httpd.conf file (replace "/path/to/dbgp/perllib" with the full path to
the directory containing perl5db.pl):
<Perl>
use ModPerl::Registry;
use lib qw(/path/to/dbgp/perllib);
$ENV{PERLDB_OPTS} = "RemotePort=localhost:9000 LogFile=stderr";
use Apache::DB ();
Apache::DB->init;
</Perl>
Make sure that RemotePort is set to the hostname and port Komodo using to listen for debugger
connections (see the PERLDB_OPTS setting in the "Configure the Remote Machine" section of
Debugging Perl Remotely).
7. You will probably already have a <Location> section in httpd.conf (or apache.conf) for your perl
scripts. Add the following line to that section:
PerlFixupHandler Apache::DB
For example:
<Location /perl-bin>
SetHandler perl-script
PerlHandler ModPerl::Registry
Options +ExecCGI
PerlOptions +ParseHeaders
PerlFixupHandler Apache::DB
Python Tutorial
Komodo can be used to debug Python programs locally or remotely, including debugging in CGI
environments. The instructions below describe how to configure Komodo and Python for debugging. For
general information about using the Komodo debugger, see Komodo Debugger Functions.
Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar.
For a summary of debugger commands, see the Debugger Command List.
Note: Breakspoints will not work with the Psyco Python extension enabled. The Komodo FAQ has a
work-around solution.
On the Debug menu or Debug Toolbar, click Go/Continue or Step In to invoke the debugging session. See
Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
Windows
<komodo-install-directory>\lib\support\dbgp\pythonlib\
<komodo-install-directory>\lib\support\dbgp\bin
Linux
Mac OS X
<komodo-install-directory>/Contents/SharedSupport/dbgp/pythonlib/
<komodo-install-directory>/Contents/SharedSupport/dbgp/bin
1. The Python remote debugging package requires the logging package, which is included in Python
2.3 and later. However, if you have Python 2.2 (the earliest supported version), you must download
and install the logging package. To verify that the logging package is installed correctly, run the
following command:
If this command prints the word "ok", you can move to the next step. If this command results in an
ImportError, you need to resolve the error before continuing.
2. Download and unzip the Komodo-PythonRemoteDebugging package for your platform and Komodo
version from the Komodo Remote Debugging page.
3. Set up your Python installation so the dbgp Python package is on your PythonPath. You can do this
by copying the dbgp directory to the site-packages directory of your Python installation.
Alternatively, you can copy the dbgp directory to a convenient location, and then add that directory to
your PYTHONPATH environment variable. For example, on Windows, if you copied the files to a
directory called C:\debugger, enter the following at the command line:
set PYTHONPATH=%PYTHONPATH%;C:\debugger
If this command prints the word "ok", you can move to the next step. If this command results in an
ImportError then you need to resolve the error before continuing.
4. Put the bin\pydbgp.py script (bin/pydbgp on Linux and Mac OS X) somewhere convenient. This is the
main script that you run to start a remote debugging session.
Tip: Placing the pydbgp.py script in a directory that is on your PATH environment variable, makes the script
easier to run. On Windows, also make sure that your PATHEXT environment variable includes .py. On Linux
and Mac OS X, ensure that the pydbgp script is executable by running this command:
pydbgp --help
If the setup is correct, the internal help documentation for running pydbgp is displayed.
Note: The debugging client relies on certain core python library files (e.g. sys, os, getopt, socket,
types). If you have added custom modules to your python site-packages, PYTHONPATH or sys.path with
28.2.1 Installing the Python Remote Debugger on the Remote Machine 153
Komodo User Guide
the same name as those imported by pydbgp, the debugger may not work properly.
All methods require that the Python remote debugger client package is installed on the remote machine (see
Installing the Python Remote Debugger).
1. On the Debug menu, ensure that Listen for Debugger Connections is checked.
2. Log in to the remote machine. (Note: the "remote" machine can be the same machine on which
Komodo is running.)
3. On the remote machine, run the pydbgp.py driver program with the appropriate options:
where host:port identifies the port on which Komodo is listening. By default, Komodo listens for
remote debugger connections on port 9000. For example, if the "remote" machine is the same
machine on which Komodo is running, start a debugging session with this command:
Other options for using the pydbgp.py driver are available by running:
If you are connecting to a DBGP Proxy, you must specify an ide_key value with the -k option to
pydbgp.py. Listener port and DBGP Proxy settings are configurable via Edit|Preferences|Debugger.
Select Debug|Listener Status to view the current settings.
Note: If your application requires that sitecustomize.py is loaded, you must run Python with the -S argument.
The debugger will load site.py at the appropriate time. Komodo is unable to debug sitecustomize.py due to
how Python handles loading of that file.
Note: If you followed the tip described in Installing the Python Remote Debugger the basic command is:
To break into a remote debugging session directly from within your Python code:
1. On the Debug menu, ensure that Listen for Debugger Connections is checked
2. Import and use the brk() function in the dbgp.client module to set a hard breakpoint. For
example, the following simple Python script will break into a debugging session when execution
reaches the brk() call:
host: machine running Komodo or the DBGP Proxy (uses localhost if unspecified)
port: port to connect on (uses 9000 if unspecified)
idekey: key used to identify the debugging session to Komodo or the DBGP Proxy (uses the value of
the USER or USERNAME environment variable if unspecified)
"Just-in-time debugging" allows the remote debugger to connect to Komodo if an uncaught exception occurs
during execution (i.e. if a Python exception reaches the top level of your Python program). By adding the
following lines of code to the beginning of your script, you can trap and explore the execution state of your
Python program when an exception reaches the top level:
If and when an exception reaches the top level of your Python program, a post-mortem debugging session is
started in Komodo at the line at which the exception is raised. The debug session is automatically placed in
interactive mode so that you can inspect the current program environment, exactly like a Python interactive
shell.
The brkOnExcept() function takes the same arguments as brk(). As with brk(), brkOnExcept()
attempts to connect to localhost on port 9000 with an idekey of USER or USERNAME if no arguments
are specified.
Configure Python to be used as the CGI (or embedded extension) for your Web server. For
information on configuring Python, refer to the Python documentation.
Follow the steps outlined in Using dbgp.client Functions in Python Programs to call the Python
remote debugger from within the application. Start the remote application through a web browser
instead of running it from the command line.
PHP Tutorial
Komodo can be used to debug PHP programs locally or remotely. Remote PHP debugging encompasses all
types of PHP debugging not initiated from within Komodo, including debugging PHP scripts running under a
local web server.
The instructions below describe how to configure Komodo and PHP for debugging. For general information
about using the Komodo debugger, see Komodo Debugger Functions.
Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar.
For a summary of debugger commands, see the Debugger Command List.
Komodo uses a PHP debugger extension called Xdebug that must be installed for Komodo to debug PHP
scripts. This can be done manually or with the PHP Configuration Wizard. Pre-built binaries named
"php_xdebug.dll" (for Windows) or "xdebug.so" (for Linux and Mac OS X) are provided with Komodo and
are also available for download from the Komodo Remote Debugging page.
See www.xdebug.org/install.php for instructions on compiling Xdebug from source on other platforms.
To debug PHP scripts in a web environment, be sure PHP is operating correctly with your web server before
configuring the debugger extension. Consult the PHP documentation for details on configuring PHP with
various web servers.
29.1.1 Windows
If you are unfamiliar with the installation of PHP, we recommend using the Windows InstallShield package.
To install the PHP executable or SAPI module manually, see the PHP website. Be sure that the PHP directory
is included in your system's PATH.
29.1.2 Linux
Your Linux system may already have PHP installed. Login and type 'php -v' to determine the version of your
current PHP interpreter. If it is earlier than version 4.3.11 (or 5.0.0 through 5.0.2) you must upgrade. PHP
must also support loading dynamic extensions (the default for PHP under Linux). If it does not, reinstall PHP
as per the instructions on the PHP website.
When installing PHP to a non-default directory, you must add the following argument to the ./configure
command:
--with-config-file-path=/path/to/php.ini
where /path/to/php.ini is the full path to the directory where the php.ini file is located.
29.1.3 Mac OS X
Although both the Jaguar and Tiger releases of OS X include a version of PHP, it is recommended that you
obtain a more recent version. Either build from source code, or download a PHP module for OS X's Apache
web server from www.entropy.ch/software/macosx/php/.
When debugging locally, certain environment variables are not available, such as those provided by the CGI
environment. However, it is possible to simulate a CGI environment by specifying CGI environment variables
and CGI input in the Debugging Options dialog box. It is is not necessary to install a web server to use
Komodo's local debugging features. Once you have configured PHP to use the debugger extension as
described below, you can debug your scripts by opening a PHP file and using Komodo Debugger Functions.
If you receive an error message when attempting to debug a PHP script, check the PHP troubleshooting
section of the Komodo FAQ.
If the automatic configuration of PHP debugging is not successful, try configuring PHP debugging manually
using the PHP Configuration Wizard.
1. Choose Installation:
The first step assumes that you have already installed PHP. If you have more than one version of PHP
installed, choose the version to configure. Browse to the directory containing the PHP executable or
enter the directory path in the Set up this installation field, and then click Next.
2. Choose PHP INI Path:
Next, choose the php.ini file to be copied and its destination directory. Subsequent changes to the
original file will not be available in the new copy. Modify the new file directly, or rerun the wizard to
copy the changes. Click Next.
Many PHP installations already include a default "extensions" directory. This is where the debugger
extension should be installed. If you have specified an extensions directory in the .ini file, you do not
need to change the path that appears in the Use this extensions directory field. It is important that the
extensions are installed in the same directory as your PHP installation. If you choose a different
location, some extensions may not work. Once the desired path is set, click Next.
5. Ready to Install:
The final window in the wizard displays the installation options. Confirm that the selections are
correct and click Next. To change any of the selections, click Back.
The PHP Configuration Wizard is only used to configure local debugging. To debug PHP remotely on a web
server, see Configuring Remote PHP Debugging.
If the wizard does not successfully enable local PHP debugging, refer to Configuring Remote PHP Debugging
for more information on manual configuration and Common PHP Debugging Problems for information on
common problems.
To run the script to the first breakpoint, from the Debug menu, select Go/Continue.
See Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
When a PHP script is run through a web browser, the web server uses the PHP interpreter to execute the
script. If PHP is configured for remote debugging, the server contacts Komodo to start a debugging session.
Komodo controls the debugging (e.g. stepping and breakpoints) once the session starts. CGI variables are
available, as are all other variables that are available when running PHP under a web server.
Though remote PHP debugging allows PHP scripts to be run in their true environment, it may be slower than
local PHP debugging.
Single User Remote PHP Debugging: In single user remote debugging, PHP is configured to always look for
a specific instance of Komodo on a specific machine. This configuration requires no changes to the PHP
script. Your web server and your instance of Komodo can be on one machine or two machines
Multi-User Remote PHP Debugging: When multiple users need to debug PHP scripts on a single web
server, use the DBGP Proxy with the remote PHP debugging instructions below. While it is possible to
configure Apache with Virtual Hosting, it is easier to configure multi-user remote PHP debugging with the
proxy.
Remote PHP debugging must be configured manually. The following procedure assumes that you have
already installed PHP.
Before debugging PHP scripts in Komodo, PHP must be configured to use the Xdebug extension
(php_xdebug.dll or xdebug.so).
Find the appropriate extension for the version of PHP you are running and manually copy it into a directory
on the server that the PHP interpreter and web server can access. The Xdebug files can be found in the php
sub-directory of the Komodo installation. For example:
Windows
File: php_xdebug.dll
Location:
<komodo-install-directory>\lib\support\php\debugging\<PHP-version> or
the Komodo Remote Debugging page.
Linux
File: xdebug.so
Location:
<komodo-install-directory>/lib/support/php/debugging/<PHP-version>/
or the Komodo Remote Debugging page.
Mac OS X
File: xdebug.so
Location:
<komodo-install-directory>/Contents/SharedSupport/lib/support/php/debuggin
or the Komodo Remote Debugging page.
In the downloadable packages, the extensions are found in version-specific subdirectories of the unpacked
archive.
The Xdebug extension does not have to be installed in the PHP extension_dir because it's location is
specified explicitly in php.ini (see below).
Open the php.ini configuration file on the web server. In the "Dynamic Extension" section, add the lines
specified below. Edit the values to reflect your particular environment (see Xdebug settings explained
below).
Windows
The php.ini configuration file should be in your operating system directory (e.g. C:\WINDOWS or
C:\WINNT), or in the same directory as php.exe (e.g. C:\PHP). If you used the PHP Windows
installer, this file should be in the correct location.
29.3.1.1 Step 1 - Copy the Debugging Extension to the Web Server 160
Komodo User Guide
Xdebug settings explained:
zend_extension_ts or zend_extension
Should be set to the full path to the xdebug library on your system. Use zend_extension_ts
("thread safe") on Windows and zend_extension on other platforms.
xdebug.remote_enable
Enables remote debugging.
xdebug.remote_handler
Should be set to dbgp for use with Komodo.
xdebug.remote_mode
Set to req to have the script connect to Komodo when it starts. Set to jit to connect only on an
error condition (see PHP Just-in-Time Debugging / Break on Exception).
xdebug.remote_host
Set to the hostname or IP address of the computer running Komodo or the DBGP Proxy. Use
'localhost' or '127.0.0.1' if Komodo and the web server are running on the same system.
xdebug.remote_port
Set to the same value as the debugging listener port configured in the Debugger Connection
preferences (or the system assigned Host Port displayed under Debug|Listener Status)
xdebug.idekey (optional)
If you are using the DBGP Proxy, set this to the Proxy Key configured in the Debugger Connection
preferences.
Once the php.ini file is updated, verify that Xdebug is configured by running the following command:
php -m
If your command-line PHP interpreter uses a different php.ini file (this is often the case) or if you're not sure
which file it uses, create a phpinfo.php file containing the line '<?php phpinfo(); ?>' in a web server
directory to display the configuration in a web browser.
Make sure Xdebug appears in the Zend module lists, but not in the PHP module list.
Note: Recent versions of PHP are set to buffer program output by default. While debugging, it is useful to
disable output buffering so that results of print and echo statements can be seen immediately when
stepping through code. To disable output buffering, comment out the output_buffering setting in
php.ini with a ";" character, or set it to "off".
1. Ensure PHP is installed and configured properly for your web server.
2. Ensure Komodo and PHP are configured for remote debugging (as described in "Configuring Remote
PHP Debugging").
http://example.org/sample.php?XDEBUG_SESSION_START=1
If you are using the DBGP Proxy, the value for the GET method should match the Proxy Key value
shown in Debug|Listener Status. For example:
http://example.org/sample.php?XDEBUG_SESSION_START=jdoe
Note: This is only required for the first request. After that, Xdebug tracks the debugging session with
a cookie. For more information on how this works, see
www.xdebug.org/docs-debugger.php#browser_session
5. A PHP debugging session starts in Komodo. On the Debug menu, click Step In or Go/Continue to
run to the first breakpoint.
On Windows:
On Linux/Mac OS X:
php -f sample.php
5. A PHP debugging session will start in Komodo. Click Step In to start stepping through the script or
Go/Continue to run to the first breakpoint.
On Windows:
On Linux/Mac OS X:
php -f sample.php
4. A PHP debugging session will start in Komodo. On the Debug menu, Click Step In to start stepping
through the script or Go/Continue to run to the first breakpoint.
Output from the debug session appears in the Bottom Pane of the Komodo Workspace. Komodo does not
support a console for remote debugging. The browser will not show the script output until debugging is
complete.
On the Debug menu, select Stop or pass the XDEBUG_SESSION_STOP=1 variable by appending it to the
URL or adding it to a form (as with XDEBUG_SESSION_START=1 above).
See Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
If you receive an error message while debugging a PHP script that is not caused by the errors in the script
itself, check the PHP troubleshooting section of the Komodo FAQ.
<?php
echo "<p>Breaks after this line.</p>";
xdebug_break();
echo "<p>Breaks before this line.<p>";
?>
This function breaks the code during a debugging session but will not initiate a new session. Use
xdebug_break() in conjunction with the methods described above for starting debugging sessions.
xdebug.remote_log=/tmp/xdebug.log
You can replace "/tmp/xdebug.org" with any writable directory and the filename of your choice.
To turn this on, change the xdebug.remote_mode setting in php.ini from 'req' to 'jit' or override the
setting in your code:
<?php
ini_set('xdebug.remote_mode', 'jit');
...
?>
Whenever an exception is thrown, a debugging session is initiated with a break at the line that caused the
problem.
This may generate a lot of breaks if PHP is configured with verbose error handling (e.g.
error_reporting = E_ALL). In PHP 5, you can define your own Exception class which enables JIT
debugging only for specific exceptions:
<?php
class KoException extends Exception
{
function __construct($message, $code = 0) {
ini_set('xdebug.remote_mode', 'jit');
parent::__construct($message, $code);
}
}
Ruby Tutorial
Komodo can debug Ruby programs locally or remotely. The instructions below describe how to configure
Komodo and Ruby for debugging. For general information about using the Komodo debugger, see Komodo
Debugger Functions.
Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar.
For a summary of debugger commands, see the Debugger Command List.
On the Debug menu or Debug Toolbar, click Go/Continue or Step In to invoke the debugging session. See
Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
Note: Mac OS X users may have to install a more recent version of Ruby (1.8.4 or greater). Linux users on
x86_64 systems will need to install a 64 bit version of the ruby-debug library (see the Komodo FAQ entry
for more information).
1. Install the Ruby debugger application and associated files on the remote machine. All of these files
are included in /lib/support/dbgp/rubylib beneath the Komodo installation directory
(/Contents/SharedSupport/dbgp/rubylib on ac OS X). Copy rdbgp.rb and the contents of the DB
directory to a convenient location on the remote machine. Note:Some of these files are shared library
files (.so), which are platform specific. If your Komodo installation is on a different platform,
download the Komodo-PythonRemoteDebugging package for the appropriate platform and Komodo
version from the Komodo Remote Debugging page.
2. Start Komodo on the local machine.
3. On the remote machine, set the dbgdir variable to specify the location of the remote mahcine
directory where you copied rdbgp.rb and its associated files.
Windows
set dbgdir=<Path_To_rbdbgp.rb>
Linux/Mac OS X
dbgdir=<Path_To_rbdbgp.rb>
4. On the remote machine, set the RUBYDB_OPTS variable his supplies the Ruby interpreter with the
information that is necessary to connect to the Komodo application running on the local machine.
Windows
set RUBYDB_OPTS=remoteport=<ServerName>:<Port>
set RUBYOPT=
Linux/Mac OS X
export RUBYDB_OPTS=remoteport=<Server_Name>:<Port>
unset RUBYOPT
5. Start the debugger and open the program that you want to debug.
6. Windows
Linux/Mac OS X
The remote file will open in Komodo with the debugger stopped at the first line of executable code. A
yellow arrow indicates the current position. You can now set breakpoints in this file, step through, and
use other Komodo debugging features as if it were a local file. However, you cannot modify the file.
ENV['RUBYDB_OPTS'] = 'remoteport=<Server_Name>:<Port>'
$:.push('<Path_To_rdbgp.rb>')
require 'rdbgp'
The first two lines set up the environment for remote debugging (similar to steps three and four above). The
third line loads the debugger which breaks immediately by default.
Once the debugger has been loaded, subsequent breaks can be specified in the program with the
Debugger.current_context.stop_next function. It's a good idea to wrap this function in a begin
... end block in case the module wasn't loaded:
begin;
Debugger.current_context.stop_next = 1;
rescue Exception;
end
Set a breakpoint on the first line of the main file, and start the debugger with Go instead of the Step
Into.
In Komodo's Environment preferences, set the RUBYOPT environment variable an empty string.
When you start the debugger, choose the Environment tab in the Debugging Options dialog box, add
a new entry for RUBYOPT in the User Environment Variables box, and leave its value empty.
Windows
Linux/Mac OS X
Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar.
For a summary of debugger commands, see the Debugger Command List.
Note: Tcl Beta releases contain only version-specific executables (e.g. tclsh85.exe and wish85.exe).
Komodo does not automatically find these in the path. To use them, specify them manually in the Interpreters
section of the Tcl language preferences rather than selecting Find on Path.
To start a local Tcl debugging session, click Go/Continue or Step In on the Debugger menu or toolbar. See
Komodo Debugger Functions for full instructions on using Komodo's debugging functionality.
Windows
<komodo-install-directory>\lib\support\tcl
Linux
<komodo-install-directory>/lib/support/tcl
Mac OS X
<komodo-install-directory>/Contents/SharedSupport/tcl
This application is also available for download from the Komodo Remote Debugging page.
1. In Komodo, select Listen for Debugger Connections from the Debug menu.
2. Log in to the remote machine.
3. On the remote machine, run the dbgp_tcldebug executable from the command line. To specify
command line arguments for the script that you are debugging, simply add those arguments to the end
of the command, after the dbgp_tcldebug arguments.
-dbgp: Sets the hostname (or IP address) and port where Komodo or the DBGP Proxy is
running. In Komodo, select Debug|Listener Status to check the current port setting.
-app-file: Specifies the Tcl program to debug. Program arguments should follow a "--"
delimiter after the Tcl program name (e.g. ... -app-file test.tcl -- arg_0
arg_1).
-app-shell: Sets the path to the Tcl interpreter (tclsh or wish).
-help: Displays a complete list of options.
4. A Tcl Debug tab opens in Komodo. Click Step In, or Go/Continue) to run to the first breakpoint (see
Komodo Debugger Functions for full instructions).
Example
The file dbgp_tcldebug.exe has been copied into the C:\remote_debug directory.
The Tcl file to be debugged is called test.tcl and is located in the current working directory.
The Tcl interpreter is C:\Tcl\bin\wish.exe.
Local Machine:
XSLT Tutorial
Komodo does not need to be manually configured for local XSLT debugging. It uses the libxslt and libxml
libraries directly to transform XML documents into HTML, text, or other XML document types. See
www.libxml.org for more information on this XML C parser and toolkit.
For general information about debugging with Komodo, see General Debugger Functions. Debugger
commands can be accessed from the Debug menu, by shortcut keys, or from the Debug Toolbar. For a
summary of debugger commands, see the Debugger Command List.
The XSLT program, the input XML file, and the results of the transformation appear simultaneously. By
default, Komodo splits the Editor pane horizontally.
A yellow arrow on the breakpoint margin shows the current line of execution in both the XSLT and XML file.
Breakpoints can be set in the both files before starting the debugging session, or while stepping through the
code.
Step In: Executes the current XSL element or template line and pauses at the following line.
Step Over: Not applicable. Behaves the same as Step In.
Step Out: When the debugger is within an XSL element, Step Out will execute the entire block
without stepping through the code line by line. The debugger will stop on the line following the
Though the current line is highlighted in both the XSLT and XML files, the stepping behavior is only
applicable to the XSLT file.
To create a project-specific test plan, right-click on a project and select Create New Test Plan....
Project-specific test plans can be edited and managed in the project preferences.
To edit an existing test plan, select the test plan from the drop list in the Test Results tab and click the Edit
Current Test Plan button.
Project-specific test plans can be run by right-clicking on the project to bring up the context menu, then
selecting the test plan from the Test sub-menu.
To copy or move a global test plan into the current document's preferences, select Tools|Test|Move Global
Test Plans to Document. This opens the "Import Global Test Plans" dialog. Select the desired test plans and
click Move (deletes the global test plans), or Copy (leaves them available for other documents).
Transactions highlighted in the Transaction table are displayed in detail in the Request and Response panes
below.
Alternatively, set Komodo to start the HTTP Inspector proxy automatically at startup. Under
Preferences|HTTP Inspector, select Run HTTP Inspector in the background when Komodo starts up. If
you want to run the Inspector on a port other than 8080 (the default) specify it in the Listen on port field.
If you are working behind a web proxy (i.e. at your network gateway) you can specify the hostname and port
of the proxy for the HTTP Inspector to forward connections through. Select Enable proxy forwarding and
enter the hostname and port (e.g. host.example.org:18080) of the proxy. If no port is specified
Komodo will attempt to use port 8080.
Debugging HTTP connections may require you to switch back and forth from using the Inspector to making a
direct connection to the internet. If this is the case you may find it useful to configure a separate browser for
debugging HTTP, or use a browser plugin (e.g. SwitchProxy Tool for Firefox) that allows you to change your
proxy configuration quickly.
Note: The HTTP Inspector does not unencrypt HTTPS (encrypted) sessions.
If the response is returned in a compressed format (i.e. the response headers contain a "gzip"
content-encoding) the unzipped data will be displayed in the data buffer. If any modifications are made, the
data will be re-compressed before being passed back to the browser.
When modifying request or response data, the content-length header will be automatically modified to match
the length of data in the corresponding data buffer.
34.5 Rules
Rules perform specified actions when a certain HTTP request or response is detected. They can be created
(New...), edited (Edit...), removed (Delete) and ordered (Move Up and Move Down). The order of the rules
can be important as all matching rules are processed sequentially.
Python Tutorial
Feature Showcase
interactive shell
Komodo's interactive shell implements individual language shells within Komodo. Shells are used to directly
communicate with the specified language interpreter.
Statements, expressions, and code fragments can be entered independent of program files. The shell can be
used as a stand-alone interactive tool or as a shell that interacts from within a debugging session.
prototyping code
identifying bugs
experimenting with a library
programming interactively
learning new syntax
The interactive shell supports history recall, AutoComplete and CallTips (Tcl only), and custom colors and
fonts.
The interactive shell supports history recall, AutoComplete and CallTips (Tcl only), and custom colors and
fonts.
Each Komodo interactive shell is associated with a corresponding interpreter and is thus language-specific.
Each time a command or multi-line string is entered into the Shell tab, that code is sent to the corresponding
interpreter for evaluation. The interpreter evaluates the command, and then returns output and error text.
Select Tools|Interactive Shell, and then select the desired language (Python, Tcl, Perl, or Ruby).
Alternatively, click the down arrow for the Shell button on the Workspace toolbar and select the
desired language.
The interactive shell opens in a Shell tab in the Bottom Pane beside the Command Output and Breakpoint
tabs.
On the active Debug tab, click the Interact (>>) button on the Debug toolbar, or select
Debug|Interact. The Debug tab toggles to a Shell tab. Enter code as desired. To toggle back to the
Debug tab, click the Interact button on the Debug Toolbar.
View debugging and code inspection functions by clicking the "Collapse/Expand Pane" button at the left side
of the Bottom Pane. This splits the shell into a left and right pane. The left pane performs debugging functions
while the right pane contains the interactive shell.
Komodo can also detect when further data is required at the command prompt. When insufficient
programming data is entered at the prompt, Komodo displays a language-dependent "more" prompt. This
prompt indicates that the language interpreter requires more information before the code can run. Once
enough data is entered, Komodo executes the code and the standard language-dependent input prompt returns.
Python 2.2.2 (#37, Nov 25 2002, 13:15:27) [MSC 32 bit (Intel)] on win32
Type "copyright", "credits" or "license" for more information.
>>>
The following example shows a series of Python statements with resulting output:
With an error:
With an error:
Use the Perl shell to enter function definitions, long strings, and specify if and while blocks interactively.
The Perl shell also handles multiple line input delimited by braces, curly braces, single quotes, and double
quotes. The following examples demonstrate this usage.
% $b = 'abc
> def
> ghi
> jkl'
abc
def
ghi
jkl
%
Example: Using curly braces "{}" to define a function and enter multiple line input.
% sub foo {
> my $arg = shift;
> my $arg2 = shift;
> return $arg + $arg2;
> }
% foo(10, 12)
22
%
% $name = 'Bob'
Bob
% print qq(<html><head><title>
> Browser Window Caption Text
> </title></head><body bg="white">
> <p>Welcome to my fine web site, $name
> </body>
> </html>)
<html><head><title>
Browser Window Caption Text
</title></head><body bg="white">
<p>Welcome to my fine web site, Bob
</body>
</html>
%
% $first_long_variable_name = 3
3
% $second_long_variable_name = 4
4
% $third_long_variable_name_to_store_result = $first_long_variable_name + \
> $second_long_variable_name
7
In Interact Mode, the left section of the bottom pane shows the variable viewer tabs while the right section
contains the interactive shell. Debugger stepping functionality (e.g. Run, Step In, Step Out) is not available.
In this mode, you can enter expressions, define new local and global variables, create functions, and modify
the DOM of the HTML document loaded in the browser.
> 2 + 2
4
>
When variables are declared without a var statement, they are echoed in the shell and appear in the globals
variable tab on the left. When the var statement is used, they are not echoed by the shell and appear in the
locals tab.
This will cause the browser to spawn an alert pop-up. To change the Title of the page you are viewing in the
browser:
The "*" character in place of the ">" in the left margin indicates a multi-line statement. The interactive shell
usually doesn't need any special escaping to let you enter a multi-line statement, but you can put a backslash
at the end of a line to explicitly specify line continuation. For example:
> var a2 = 1 \
* + 2 + \
* 3
Once you've established a link between Komodo and Firefox, you can use the interactive shell at any time by
switching to Komodo and clicking the Interact (>>) button. Press Interact button to re-enter the interactive
shell. Variables defined in the previous session should still be present.
You're free to keep using the browser, however, the shell does not "follow" the browser as you move from
window to window.
Subscribe to http://blogs.activestate.com/ericp/ for future postings on DHTML tricks in the interactive shell.
When more information is required for execution (e.g. within any flow control construct) or when requesting
user input, a "*" is displayed. No prompt is displayed when program output is sent to the screen.
> mylist = []
[]
> for x in (0..3)
* puts "Enter a value:"
* mylist[x] = gets.chomp!
* end
Enter a value:
*
> mylist[wrong]
undefined local variable or method `wrong' for main:Object
Code Browser: A sidebar in the left pane that displays a hierarchical view of all code constructs (for
example, variables, methods, imports) in all open files. In the Code Browser, symbols can be sorted
and filtered; the current scope of a symbol can be located. To access the Code Browser, click
View|Tabs & Sidebars|Code Browser.
AutoComplete and CallTips: The Code Intelligence system is used to drive autocomplete and calltip
functionality for Perl, Python, Tcl, Ruby, JavaScript, XSLT, CSS, and XML (including HTML and
DTD).
The Python Tutorial demonstrates the Code Browser and other Code Intelligence tools. See the Python
Tutorial to explore a Python program in Komodo.
where it is declared.
Locate all variables used within a file.
View a symbol definition signature.
Find all defined symbols matching a pattern.
Go to Definition: Jumps to the definition of the associated symbol in the editor. Alternatively,
double-click the symbol name in the Code Browser tree. Objects defined within the file, in
user-defined modules, and in the site library are accessible in this way; objects defined in a language's
standard library are not. (See also Editor: Navigating within Files)
Copy: Copies the symbol name to the clipboard.
Sort By File Order: Sorts all symbols in the tree by file order.
Sort Alphabetically: Sorts all symbols in the tree alphabetically.
36.1.2 Sorting
Use the Sort By button to organize all Code Browser symbols by file order or alphabetically. To sort all
symbols by file order, click Sort By, and then select Sort By File Order from the drop-down list. To sort all
symbols alphabetically, click Sort By, and then select Sort Alphabetically from the drop-down list.
Alternatively, use the context menu (right-click in the Code Browser) to access sorting options.
Use the Locate Current Scope button to find the scope of a symbol (for example, namespace, command, or
variable definition). To view the scope of a symbol, place the cursor on the desired symbol in the source code
and then click the Locate Current Scope button. The Code Browser tree opens to the associated scope.
Alternatively, click Code|Locate Current Scope in Code Browser to open the Code Browser tree to the
associated scope.
The Filter Symbols text box limits the Code Browser display to matching symbols. To filter symbols in the
Code Browser, enter the desired symbol name, or partial name, in the text box. The filter supports regular
Press 'Tab' to switch focus between the Filter text box and the Code Browser tree. Press 'Esc' to clear the
current filter pattern.
If the window focus is on the DOM Viewer, it moves the cursor in the editor tab to the node selected
in the DOM Viewer.
If the window focus is on the editor tab, it finds the node in the tree corresponding to the current
cursor position in the document.
The Show/hide attributes button toggles the visibility of element attributes. Attributes are hidden by default.
For example, when viewing an HTML document, entering table in the Filter box might limit the tree view
to the <table ...> element and the parent <body> and <html> elements. If a node matching the search
string is found in a collapsed branch, the branch is automatically expanded.
For documents that use namespace prefixes, like XSLT, use the format prefix:element-name in the search (e.g.
xsl:template).
The Filter box uses the XPath syntax supported in Python's ElementTree.
W3C DOM Recommendations: The canonical source for DOM Technical Reports (specifications).
What does each DOM Level bring?: Abstracts of the three DOM Level specs by Fabian Guisset.
W3 Schools XML DOM Tutorial: A straightforward tutorial with links to an XML DOM object
reference and examples. See also their HTML DOM Tutorial.
CVS
SVN (Subversion)
P4 (Perforce)
Git
Bazaar
From within Komodo, you can perform the following SCC actions:
Depots, repositories, branches, and projects cannot be created or configured from within Komodo. This must
be done using the SCC software directly. Komodo's SCC features become available when files are checked
out from the source code repository.
Komodo is can work in conjunction with external graphial SCC clients such as TortoiseCVS and
TortoiseSVN, and P4Win. However, the command line executables (i.e. cvs, svn and p4) must be present
on the local system.
Toolbox Context Menu: Right-click a file in the Toolbox to access the Source Control menu
options. Source code control functions can also be performed on Folders in the Toolbox; right-click a
folder and select Source Control on Contents to access the menu.
Projects sidebar context menu: Right-click a file in the Project Manager to access the Source
Control menu options. SCC functions can also be performed on Folders in the Toolbox; right-click a
folder and select Source Control on Contents to access the menu. Two source code control options
are available from the Projects sidebar and Toolbox context menus:
Source Control applies source code functions to the selected file only.
Source Control on Contents applies source code functions to the contents of the selected
project or folder.
Editor Pane: Right-click a file in the Editor Pane to access the Source Control menu options.
Filename Tab: Right-click the filename tab above the Editor Pane to access the Source Control
menu options.
File Menu: Select the Source Control option from the File menu.
The Source Control submenu options are the same regardless of which method is used to access the menu.
Access common source code control commands from the SCC Toolbar at the top of the Komodo workspace.
Refer to the command descriptions below for more information. The toolbar commands only apply to the file
currently active in the Editor Pane.
Invoke source code control context menus by right-clicking files or folders in the following areas:
Projects sidebar
Toolbox
Editor Pane
The SCC Output tab is located in the Bottom Pane of the Komodo workspace. As you execute source code
control commands, such as editing or checking in files, details of the commands are displayed on the SCC
Output tab.
Error messages and warnings are also displayed on the SCC Output tab. Additionally, error messages and
warnings are displayed on the status bar in the bottom left corner of the Komodo workspace.
Checkout: Launches the SCC Checkout wizard for fetching a local copy from a repository.
Add: Add a file from a designated source code directory on your local drive to the source code
repository.
Edit: Unlock a file for editing.
Revert Changes: Check the file back into the repository, abandoning any changes made since it was
checked out.
Remove: Delete the file from both the source code repository and the corresponding local directory.
Update: When the local version no longer matches the repository version of a file, select this
command to update the local version of the file.
Diff (Compare Files): Compare the version of a file open in the Editor Pane with the version in the
source code repository. Depending on the setting in Preferences, the diff display is shown on another
Komodo editor tab or in a separate window. If the display style for diffs (Edit|Preferences|Source
Code Control) is set to Create new window, press 'F9' or select Jump to Corresponding Line to
open and/or shift focus to the original file in the Editor Pane. If viewing a diff in an editor tab,
right-click and select Jump to Corresponding Line to shift focus to the editor tab containing the
source code. Selecting this option opens the source code tab in the Editor Pane if it is not already
Under Perforce, to open files for edit from within a Komodo project, you must first add files to the project
using options on the Project menu. To accomplish the same under CVS, use the following procedure:
1. At the command prompt, enter cvs co <projname> to open working copies of the files.
2. In the Projects sidebar, right-click the project and select Import from File System.
3. In the Import from File System dialog box, specify the location of the files to be imported and click
Next.
4. Click OK to confirm changes to the project.
The icons can appear in a variety of combinations, depending on the status of the file and where they are
displayed in the Komodo workspace. For example, a pencil icon next to a padlock icon on a tab in the Editor
Pane indicates that the file has been locally modified and that the version of the file in your local directory is
in sync with the version in the source code repository.
Right-click the on file tab or within the editor pane and select Refresh Status
Right-click on the file in the Projects sidebar and select Refresh Status
Click Refresh Status on the File menu
Press 'Ctrl' + 'K', 'R'
38.2.1 Step One: Set the SCC handler and the checkout data
Set the following options:
SCC Handler: Choose the SCC system to use (e.g. svn, git, bzr, etc.)
Checkout URL: Specify the specific URL of the branch being checked out (e.g.
"http://svn.openkomodo.com/repos/komododoc/trunk/"). Specify the protocol to use (e.g. "http://",
"rsync://", "git://" etc.).
Save to: Specify the local directory to download to. Some SCC clients, such as CVS, will require that
the specified directory already exists. Others, such as SVN, will create the directory if it does not exist
already.
bzr:
Revision: The revision to check out. User the revision number or other revision identifier.
Hard-link working tree files where possible: Uses the "--hardlink" command line option.
cvs:
Module: A path within the repository or a CVS module name (required field).
Branch or Tag: The branch or "sticky tag" of the branch to be checked out.
Specific date: Checkout version from a specific date. Accepts a variety of date formats (e.g.
"YYYY-MM-DD HH:MM").
Checkout Type: Normal (for working on the modules) or Export (for making a software
release).
git:
Local repository: Used if the repository to clone is locally available. Uses the "--local"
command line option.
Do not perform a HEAD checkout after cloning: Uses the "--no-checkout" option.
Make a bare GIT repository: Uses the "--bare" option.
hg:
Revision: The revision number to check out. Current if unspecified.
Do not update the new working directory: Uses the "--noupdate" option.
Use pull protocol to copy metadata: Uses the "--pull" option.
Use uncompressed transfer (fast over LAN): Uses the "--uncompressed" option.
svn:
Revision: The revision number to check out (HEAD by default).
Only check out the top folder: Users the "--non-recursive" option.
Omit externals: Uses the "--ignore-externals" option.
Options mentioned above are explained with more detail in the documentation for each SCC handler:
Note: The SCC Checkout wizard does not correctly handle password authentication. SCC checkouts requiring
password authentication should be done at the command line. You can do this by copying the command
shown in the command line summary and pasting it into a terminal.
The Change Lists sidebar in the right pane allows you to create new changelists, modify existing ones, and
drag files from one list to another.
The Default Changes list can be renamed and modified as desired; new ones are created by Komodo as
necessary.
Files: The list of files included with the change list. By default, this shows the files that have been
added to the list (checked) and other files with pending SCC operations under the same base path
(unchecked). An icon next to the check box shows which SCC operation is pending for each file.
Only checked files will be included when the change list is submitted. Unchecked files (those that are under
the same base path with pending SCC operations) are displayed so that they can be added easily if desired.
Select Only show checked files to hide these.
The Base path displayed above the file list is the longest path prefix (lowest level directory) that can include
all files in the list. If you add a new file file or directory that is outside of this base path, Komodo re-computes
the base path and updates the relative paths displayed in the list.
The Show Diff will display a unified diff of all checked files using the base path described above. This is an
excellent way to create patches.
If Diff Display Style is set to Create new window, copy the diff into a new file and save it. If this is set to
Open editor tab, use File|Save As....
1. If you have not already done so, install the cvs command-line utility on your system.
2. Check out files: Komodo does not have integrated SCC checkout functions. As necessary, run cvs
from the command line (e.g. 'cvs checkout repository ...').
3. Enable CVS support in Komodo: Under Preferences|Source Code Control|CVS and ensure that the
"CVS Integration" option is checked and that the cvs executable is available in your PATH or is
specified with a full pathname.
4. Open any file under CVS control in Komodo.
Komodo should now recognize that the file is under CVS source code control and the SCC menus and status
icons should be enabled. If not, click Refresh Status on the File menu (or Ctrl-K, R) to force it to reset.
Some CVS repositories (e.g. SourceForge) will only support CVS access over SSH (secure shell). When
accessing these repositories, an SSH client is required. See Configuring SSH Support for CVS and
Subversion below for details on configuring SSH support.
1. If you have not already done so, install Subversion on your system.
2. Check out files: Komodo does not have integrated SCC checkout functions. As necessary, run svn
from the command line (e.g. 'svn checkout URL ...').
3. Enable Subversion support in Komodo: Under Preferences|Source Code Control|Subversion and
ensure that the "SVN Integration" option is checked and that the svn executable is available in your
PATH or is specified with a full pathname.
4. Open any file under Subversion control in Komodo.
Komodo should now recognize that the file is under Subversion source code control and the SCC menus and
status icons should be enabled. If not, click Refresh Status on the File menu (or Ctrl-K, R) to force it to reset.
Some Subversion repositories only support Subversion access over SSH (secure shell). When accessing these
repositories, an SSH client is required. See Configuring SSH Support for CVS and Subversion below for
details on configuring SSH support.
1. If you have not already done so, install Perforce on your system.
2. Check out files: Komodo does not have integrated SCC checkout functions. As necessary, run p4
from the command line (e.g. 'p4 sync path').
3. Enable Perforce support in Komodo: Under Preferences|Source Code Control|Perforce and ensure that
the "Perforce Integration" option is checked and that the p4 executable is available in your PATH or is
specified with a full pathname.
4. Set P4 environment variables: Unless Komodo is always started from a shell with all necessary P4
environment variables set (e.g. P4CLIENT, P4PORT, P4USER), you will need to specify them in
Komodo's Environment preferences.
5. Open any file under Perforce control in Komodo.
Komodo should now recognize that the file is under Perforce source code control and the SCC menus and
status icons should be enabled. If not, click Refresh Status on the File menu (or Ctrl-K, R) to force it to reset.
Users of Perforce's P4CONFIG feature may find that Komodo's source code control doesn't work unless
Komodo is started from within the client view of the Perforce repository.
This is a basic guideline for configuring CVS and Subversion to use SSH, however, because server
configurations can vary, you should consult the documentation for the control system you are using, or request
help from you system administrator.
The use of Pageant (on Windows) or ssh-agent (OS X and Linux) with Komodo is strongly recommended.
1. Install Putty
http://www.chiark.greenend.org.uk/~sgtatham/putty/
putty.exe
puttygen.exe
pageant.exe
pscp.exe
plink.exe
Ensure that the directory where Putty is installed is specified in your system's PATH environment variable.
Run the pageant program. This loads the Putty Authentication Agent into the Windows System Tray.
Right-click the Pageant icon in the Windows System Tray. Select Add Key. Navigate to the directory where
you saved the public and private keys in the previous step, and select the file private1.key.ppk.
1. Specify Server: On the Session page of the Configuration form, enter the host name or IP address of
the server.
2. Specify Protocol: On the Session page, in the Protocol field, select the "SSH" protocol.
3. Create Saved Session: In the Saved Sessions field, enter the host name again. Click the Save button.
4. Configure Connection: on the Connection page of the Configuration form, enter your username for
the server in the Auto-login username field.
5. Configure SSH Protocol: On the SSH page of the Configuration form, specify "2" for the Preferred
SSH protocol version.
6. Enable Agent Forwarding: On the Auth page of the Configuration form, check Allow agent
forwarding. In the Private key file for authentication field, specify the path and filename of the
private key created above (private1.key).
7. Save Session Information: On the Session page of the Configuration form, click the Save button.
You must store the public key file generated in step 2 (public1-openssh.key) on the CVS or Subversion server.
1. Open Command Prompt Window: Type cmd in the Windows Run dialog box.
2. Copy Public Key to Server: At the command prompt, enter:
...where c:\path\to\public1-openssh.key specifies the location of the key file created in step two, and
username@server.com specifies your username and URL on the remote server. You are prompted to
confirm the legitimacy of the host, and may be prompted to enter your password for the server.
3. Connect Using Putty: If necessary, run the putty program. In the Saved Sessions field,
double-click the configuration created in Step 4. This establishes a connection to the server.
4. Configure the Key on the Server: After logging on to the server, enter the following commands to
configure the SSH key:
mkdir ~/.ssh
chmod 700 .ssh
cat ~/public1-openssh.key >> ~/.ssh/authorized_keys
rm ~/public1-openssh.key
chmod 600 ~/.ssh/*
5. Log Off and Exit Putty: Enter exit to close the session of the server.
Restart Putty. In the Saved Sessions field, double-click the configuration created in Step 4. You should not be
prompted to log in. If you are, the configuration failed. Review the steps above and ensure that they were
completed correctly.
Use the following additional steps if you are using CVS with Komodo.
1. Create Local CVS Directory: Create a directory to store a copy of the CVS repository.
2. Copy Files to Local Directory: At a command prompt, enter:
set CVS_RSH=plink
set PLINK_PROTOCOL=ssh
cvs -d :ext:username@cvs.server.com:/repository_name co cvs_module
...where username@cvs.server.com specifies your username on the CVS server and the URL of the
CVS server, repository_name specifies the name of the repository on the server, and cvs_module
specifies the name of the module in the chosen working repository.
Login is handled by SSH. The files are copied to the local system. These environment variables do
not interfere with non-SSH repositories.
Ensure that these variables are permanently configured in your system environment (for example, by adding
them to the autoexec.bat file or configuring them in the system properties).
You can also execute Pageant and load the key via a batch file. For example:
Use the following additional steps if you are using Subversion with Komodo.
1. Create Local Subversion Directory: Create a directory to store a copy of the Subversion repository.
2. Copy Files to Local Directory: At a command prompt, enter:
...where svn.server.com specifies the server domain name of the Subversion server,
repository_path/module specifies the path of the repository on the server, and local_path specifies the
preferred location on your local system for your copy of the repository. The local_path can be
ommited, in which case the local path is the last part of the repository_path.
Login is handled by SSH. The files are copied to the local system.
Ensure that these variables are permanently configured in your system environment (for example, by adding
them to the autoexec.bat file or configuring them in the system properties).
PLINK_PROTOCOL=ssh
SVN_SSH=c:/path/to/plink.exe -batch
Specify the full path to plink.exe using forward slashes "/" or escaped back slashes "\\". The -batch
argument is used to prevent plink from prompting for user input. You can specify a specific private key by
adding "-i C:/path/to/private_keyfile". For example:
SVN_SSH="c:/path/to/plink.exe" -i "c:/path/to/private_keyfile"
You can use the Subversion configuration file instead of setting the SVN_SSH environment variable:
[tunnels]
ssh = $SVN_SSH plink.exe
This permits configuration of different connection types. The config file is located in the Subversion directory,
typically inside the Application Data area of the user's profile directory (eg. C:\Documents and
Settings\USERNAME\Application Data\Subversion). See the Subversion documentation for more
information.
If you use "plink = $SVN_SSH plink.exe" in the tunnels section of the config file, use "svn+plink" for your
checkout url rather than "svn+ssh".
Run pageant to enable the authentication agent. Ensure that the private1.key is loaded. You can start
Pageant and load the key using a batch file. For example:
CVS_RSH=ssh
CVS determines when to use SSH, depending on how you check out the modules. If you use the "cvs login"
method with the "pserver" protocol, CVS does not use SSH, even if CVS_RSH=ssh is set in the environment.
...where username@cvs.server.com specifies your username on the CVS server and the URL of the
CVS server, repository_name specifies the name of the repository on the server, and cvs_module
specifies the name of the module in the chosen working repository.
5. Start Komodo within the cygwin shell as follows:
/path/to/komodo/bin/komodo
After completing the configuration steps above, follow these steps to open Komodo with CVS-SSH enabled:
/path/to/komodo/komodo.exe
Subversion determines when to use SSH depending on how you check out the modules. If you use http:// or
file:/// URIs, Subversion will not use SSH.
1. Open a shell.
2. Enter exec ssh-agent bash.
3. Enter ssh-add /path/to/public/key (e.g. 'ssh-add ~/.ssh/id_rsa.pub')
4. To check out a Subversion module, enter:
...where svn.server.com specifies the server domain name of the Subversion server,
repository_path/module specifies the path of the repository on the server, and local_path specifies the
preffered location on your local system for your copy of the repository. The local_path can be
ommited, in which case the local path is the last part of the repository_path.
5. Start Komodo from within the shell. Komodo inherits the environment set in the shell by ssh-agent
Feature Showcase
Komodo's Rx Toolkit is a tool for building, editing and debugging regular expressions. Build a regular
expression in the Regular Expression pane, and enter the sample search string in the Search Text pane.
Adjust the regular expression as necessary to produce the desired matches in the Match Results pane.
Note: Although the Rx Toolkit has a Python back end, most Perl, PHP, Ruby and Tcl regular expression
syntax is also supported.
If you are new to Regular Expressions, see the Regular Expressions Primer. In addition, online references for
Python, Perl, PHP, Ruby, and Tcl regular expressions are available via the Rx Toolkit's Help menu.
Click the "X" button in the top right corner of the Rx Toolkit window.
Many of the display characteristics available in the Editor Pane can be enabled in the Regular Expression
field. However, these characteristics must be manually enabled via key bindings. For example, to display line
numbers in the Regular Expression field, press 'Ctrl'+'Shift'+'6' ('Meta'+'Shift'+'6' on Mac OS X) if the
default key binding scheme is in effect.
Note: Do not enclose regular expressions in forward slashes ("/"). The Rx Toolkit does not recognize
enclosing slashes.
If you already know the metacharacter you need, just type it in the Regular Expression pane.
Match: Scan the search text for the first instance of a match for the regular expression.
Match All: Find all matches for the regular expression in the search text and display them as a series
of matches in the Match Results pane.
Split: Scan the search text for regular expression matches and split the string apart wherever there is
match. Each match is displayed on a separate line in the Match Results pane.
Replace: Scan the text for the first occurrence of the regular expression and replace it with text
specified in the Replacement pane. The Replacement pane is only displayed when either the
Note: You must use the Modifiers check boxes to add modifiers to a regular expression. The Rx Toolkit does
not recognize modifiers entered in the Regular Expression pane.
Ignore Case: Ignore alphabetic case distinctions while matching. Use this to avoid specifying the
case in the pattern you are trying to match.
Multi-line Mode: Let caret "^" and dollar "$" match next to newline characters. Use this when a
pattern is more than one line long and has at least one newline character.
Single-line Mode: Let dot "." match newline characters. Use this when a pattern is more than one line
long and has at least one newline character.
Verbose: Permit the use of whitespace and comments in regular expressions. Use this to pretty print
and/or add comments to regular expressions.
Unicode (Python Only): Make the special characters "\w", "\W", "\b" and "\B" dependent on
Unicode character properties.
Locale (Python Only): Make the special characters "\w", "\W", "\b" and "\B" dependent on the
current locale.
If there is a match...
If there is no match...
If a regular expression does not match the test string, an error message is displayed in the Match
Results pane.
If a regular expression is invalid, the title bar of the Match Results pane becomes red and details of
the error are displayed in that pane.
The Match Results pane is displayed with as many as four columns, depending on which match type is
selected. The Group column displays a folder for each match; the folders contain numbered group variables.
The Span column displays the length in characters of each match. The Value column lists the values of each
variable.
Ignore Case
Multi-line
Single-line
Multi-line and Single-line
Verbose
Testing123
...you could use the following regular expression with Ignore case selected:
^([a-z]+)(\d+)
Discussion
The ^ matches the beginning of a string. The [a-z] matches any lowercase letter from "a" to "z". The +
matches any lowercase letter from "a" to "z" one or more times. The Ignore case modifier lets the regular
expression match any uppercase or lowercase letters. Therefore ^([a-z]+) matches "Testing". The
(\d+)matches any digit one or more times, so it matches "123".
"okay?"
...you could use the following regular expression with Multi-line selected:
^(\"okay\?\")
Discussion
The ^ matches the beginning of any line. The \" matches the double quotes in the test string. The string
matches the literal word "okay". The \? matches the question mark "?". The \" matches the terminal double
quotes. There is only one variable group in this regular expression, and it contains the entire test string.
...you could use the following regular expression with Single-line selected:
(:[\t ]+)(.*)work\?
Discussion
This regular expression matches everything in the test string following the word "Subject", including the
colon and the question mark.
The (\s+) matches any space one or more times, so it matches the space after the colon. The (.*) matches
any character zero or more times, and the Single-line modifier allows the period to match the newline
character. Therefore (.*) matches "Why did this <newline> match". The \? matches the terminal question
mark "?".
...you would need both the Multi-line and Single-line modifiers selected for this regular expression:
([\t ]+)(.*)^work\?
Discussion
This regular expression matches everything in the test string following the word "Subject", including the
The ([\t ]+) matches a Tab character or a space one or more times, which matches the space after the
colon. The (.*) matches any character zero or more times, which matches "Why did this <newline>". The
^work matches the literal "work" on the second line. The \? matches the terminal question mark "?".
If you used only the Single-line modifier, this match would fail because the caret "^" would only match the
beginning of a string.
If you used only the Multi-line modifier, this match would fail because the period "." would not match the
newline character.
testing123
...you could use the following regular expression with the Verbose modifier selected:
Discussion
The .* matches any character zero or more times, the ? makes the * not greedy, and the Verbose modifier
ignores the spaces after the (.*?). Therefore, (.*?) matches "testing" and populates the "Group 1"
variable. The (\d+) matches any digit one or more times, so this matches "123" and populates the "Group 2"
variable. The Verbose modifier ignores the spaces after (\d+) and ignores the comments at the end of the
regular expression.
39.4.1 Perl
This Perl code uses a regular expression to match two different spellings of the same word. In this case the
program prints all instances of "color" and "colour".
while($word = <STDIN>){
print "$word" if ($word =~ /colou?r/i );
}
The metacharacter "?" specifies that the preceding character, "u", occurs zero or one times. The modifier "i"
(ignore case) that follows /colou?r/ means that the regular expression will match $word, regardless of
whether the specified characters are uppercase or lowercase (for example, Color, COLOR and CoLour will all
match).
39.4.2 Python
This Python code uses a regular expression to match a pattern in a string. In Python, regular expressions are
available via the re module.
import re
m = re.search("Java[Ss]cript", "in the JavaScript tutorial")
if m:
print "matches:", m.group()
else:
print "Doesn't match."
The re.search() function returns a match object if the regular expression matches; otherwise, it returns
none. The character class "[Ss]" is used to find the word "JavaScript", regardless of whether the "s" is
capitalized. If there is a match, the script uses the group() method to return the matching strings. Otherwise
the program prints "Doesn't Match".
39.4.3 Tcl
This Tcl code uses a regular expression to match all lines in a document that contain a URL.
This while loop searches every line in a file for any instance of a URL and displays the results. Tcl
implements regular expressions using the regexp and regsub commands. In the example shown above, the
regexp is followed by the -nocase option, which specifies that the following regular expression should
match, regardless of case. The regular expression attempts to match all web addresses. Notice the use of
backslashes to include the literal dots (.) that follow "www" and precede "com".
39.4.4 PHP
This PHP code uses a Perl Compatible Regular Expressions(PCRE) to search for valid phone numbers in the
United States and Canada; that is, numbers with a three-digit area code, followed by an additional seven
digits.
$numbers = array("777-555-4444",
function isValidPhoneNumber($number) {
return preg_match("/\(?\d{3}\)?[-\s.]?\d{3}[-\s.]\d{4}$/x", $number);
}
This PHP example uses the preg_match function for matching regular expressions. Other Perl compatible
regular expression functions are also available. If the function isValidPhone returns true, the program
outputs a statement that includes the valid phone number. Otherwise, it outputs a statement advising that the
number is not valid.
39.4.5 Ruby
This Ruby code uses a regular expression that does simple email addresses validation.
The regular expression is stored in the addrtest variable, which is compared to the cmdline variable
using the match method. The regular expression specifies that the address must have:
It will accept some addresses that are not fully RFC compliant, and will not accept long user or domain
names. A more robust regular expression is:
/^([a-z0-9]+[._]?){1,}[a-z0-9]+\@(([a-z0-9]+[-]?){1,}[a-z0-9]+\.){1,}[a-z]{2,4}$/i
This does not limit the length of the username or domain. It also enforces some additional requirements:
Writing a regular expression that is fully compliant with RFC 822 is quite a bit more complicated.
-->
A regular expression is often called a "regex", "rx" or "re". This primer uses the terms "regular expression"
and "regex".
Unless otherwise stated, the examples in this primer are generic, and will apply to most programming
languages and tools. However, each language and tool has it's own implementation of regular expressions, so
quoting conventions, metacharacters, special sequences, and modifiers may vary (e.g. Perl, Python, grep, sed,
and Vi have slight variations on standard regex syntax). Consult the regular expression documentation for
your language or application for details.
import re
n = re.compile(r'\bw[a-z]*', re.IGNORECASE)
print n.findall('will match all words beginning with the letter w.')
Komodo can accept Python syntax regular expressions in it's various Search features.
Komodo IDE's Rx Toolkit can help you build and test regular expressions. See Using Rx Toolkit for more
information.
Regex:
at
Matches:
at
Doesn't Match:
it
a-t
At
40.3.2 Wildcards
Regex characters that perform a special function instead of matching themselves literally are called
"metacharacters". One such metacharacter is the dot ".", or wildcard. When used in a regular expression, "."
can match any single character.
Regex:
t...s
Matches:
trees
trams
teens
Doesn't Match:
trucks
trains
beans
Regex:
c:\\readme\.txt
Matches:
c:\readme.txt
Doesn't Match:
c:\\readme.txt
c:\readme_txt
Precede the following metacharacters with a backslash "\" to search for them as literal characters:
^ $ + * ? . | ( ) { } [ ] \
These metacharacters take on a special function (covered below) unless they are escaped. Conversely, some
characters take on special functions (i.e. become metacharacters) when they are preceeded by a backslash
(e.g. "\d" for "any digit" or "\n" for "newline"). These special sequences vary from language to language;
consult your language documentation for a comprehensive list.
40.3.4 Quantifiers
Quantifiers specify how many instances of the preceeding element (which can be a character or a group) must
appear in order to match.
The "?" matches 0 or 1 instances of the previous element. In other words, it makes the element optional; it can
be present, but it doesn't have to be. For example:
Regex:
colou?r
Matches:
colour
color
Doesn't Match:
colouur
colur
40.3.4.2 Asterisk
The "*" matches 0 or more instances of the previous element. For example:
Regex:
www\.my.*\.com
Matches:
www.my.com
www.mypage.com
www.oursite.com
mypage.com
As the third match illustrates, using ".*" can be dangerous. It will match any number of any character
(including spaces and non alphanumeric characters). The quantifier is "greedy" and will match as much text as
possible. To make a quantifier "non-greedy" (matching as few characters as possible), add a "?" after the "*".
Applied to the example above, the expression "www\.my.*?\.com" would match just
"www.mysite.com", not the longer string.
40.3.4.3 Plus
The "+" matches 1 or more instances of the previous element. Like "*", it is greedy and will match as much as
possible unless it is followed by a "?".
Regex:
bob5+@foo\.com
Matches:
bob5@foo.com
bob5555@foo.com
Doesn't Match:
bob@foo.com
bob65555@foo.com
To match a character a specific number of times, add that number enclosed in curly braces after the element.
For example:
Regex:
w{3}\.mydomain\.com
Matches:
www.mydomain.com
Doesn't Match:
web.mydomain.com
w3.mydomain.com
To specify the minimum number of matches to find and the maximum number of matches to allow, use a
number range inside curly braces. For example:
Regex:
60{3,5} years
Matches:
6000 years
60000 years
600000 years
Doesn't Match:
60 years
6000000 years
Quantifier Description
Matches any preceding element 0 or 1
?
times.
Matches the preceding element 0 or
*
more times.
Matches the preceding element 1 or
+
more times.
Matches the preceding element num
{num}
times.
Matches the preceding element at least
{min,
min times, but not more than max
max}
times.
40.3.5 Alternation
The vertical bar "|" is used to represent an "OR" condition. Use it to separate alternate patterns or characters
for matching. For example:
Regex:
perl|python
Matches:
perl
python
Doesn't Match:
ruby
Regex:
(abc){2,3}
Matches:
abcabc
abcabcabc
Doesn't Match:
abc
abccc
Regex:
gr(a|e)y
Matches:
gray
grey
Doesn't Match:
graey
Strings that match these groups are stored, or "delimited", for use in substitutions or subsequent statements.
The first group is stored in the metacharacter "\1", the second in "\2" and so on. For example:
Regex:
Regex:
[cbe]at
Matches:
cat
bat
eat
Doesn't Match:
sat
Since a character class on it's own only applies to one character in the match, combine it with a quantifier to
search for multiple instances of the class. For example:
Regex:
[0123456789]{3}
Matches:
123
999
376
Doesn't Match:
W3C
2_4
If we were to try the same thing with letters, we would have to enter all 26 letters in upper and lower case.
Fortunately, we can specify a range instead using a hyphen. For example:
Regex:
[a-zA-Z]{4}
Matches:
Perl
ruby
SETL
Doesn't Match:
1234
AT&T
Most languages have special patterns for representing the most commonly used character classes. For
example, Python uses "\d" to represent any digit (same as "[0-9]") and "\w" to represent any alphanumeric, or
"word" character (same as "[a-zA-Z_]"). See your language documentation for the special sequences
applicable to the language you use.
Regex:
[^a-zA-Z]{4}
Matches:
1234
$.25
#77;
Doesn't Match:
Regex:
^From: root@server.*
Matches:
From: root@server.example.com
Doesn't Match:
Regex:
.*\/index.php$
Matches:
www.example.org/index.php
the file is /tmp/index.php
Doesn't Match:
www.example.org/index.php?id=245
www.example.org/index.php4
Sometimes it's useful to anchor both the beginning and end of a regular expression. This not only makes the
expression more specific, it often improves the performance of the search.
Regex:
^To: .*example.org$
Matches:
To: feedback@example.org
To: hr@example.net, qa@example.org
Doesn't Match:
There are many variations in substitution syntax depending on the language used. This primer uses the
"/search/replacement/modifier" convention used in Perl. In simple substitutions, the "search" text will be a
regex like the ones we've examined above, and the "replace" value will be a string:
For example, to earch for an old domain name and replace it with the new domain name:
Regex Substitution:
s/http:\/\/www\.old-domain\.com/http://www.new-domain.com/
Search for:
http://www.old-domain.com
Replace with:
http://www.new-domain.com
Notice that the "/" and "." characters are not escaped in the replacement string. In replacement strings, they do
not need to be. In fact, if you were to preceed them with backslashes, they would appear in the substitution
literally (i.e. "http:\/\/www\.new-domain\.com").
The one way you can use the backslash "\" is to put saved matches in the substitution using "\num". For
example:
Substitution Regex:
s/(ftp|http):\/\/old-domain\.(com|net|org)/\1://new-domain.\2/
Target Text:
http://old-domain.com
Result:
http://new-domain.com
This regex will actually match a number of URLs other than "http://old-domain.com". If we had a list of
URLs with various permutations, we could replace all of them with related versions of the new domain name
(e.g. "ftp://old-domain.net" would become "ftp://new-domain.net"). To do this we need to use a modifier.
40.5 Modifiers
Modifiers alter the behavior of the regular expression. The previous substitution example replaces only the
first occurence of the search string; once it finds a match, it performs the substitution and stops. To modify
this regex in order to replace all matches in the string, we need to add the "g" modifier.
Substitution Regex:
/(ftp|http):\/\/old-domain\.(com|net|org)/\1://new-domain.\2/g
Target Text:
The "i" modifier causes the match to ignore the case of alphabetic characters. For example:
Regex:
/ActiveState\.com/i
Matches:
activestate.com
ActiveState.com
ACTIVESTATE.COM
Modifier Meaning
i Ignore case when matching exact strings.
Treat string as multiple lines. Allow "^''
m and "$'' to match next to newline
characters.
Treat string as single line. Allow ".'' to
s
match a newline character.
Ignore whitespace and newline
x characters in the regular expression.
Allow comments.
o Compile regular expression once only.
Match all instances of the pattern in the
g
target string.
Intermediate:
Advanced:
Language-Specific:
Perl: http://perldoc.perl.org/perlre.html
PHP: http://www.php.net/manual/en/ref.pcre.php
Python: http://docs.python.org/lib/module-re.html
Ruby: http://www.rubycentral.com/book/ref_c_regexp.html
Tcl: http://www.tcl.tk/man/tcl8.4/TclCmd/re_syntax.htm
Javascript: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Guide:Regular_Expressions
Instructions for using these tools can be found in the Perl Dev Kit documentation.
1. Click File|Open|File...
2. Navigate to the /lib/support/modules/ subdirectory of your Komodo installation.
3. Select the perlapp.xpi package and click Open.
4. The Software Installation dialog will appear. Click Install to add the extension.
To use this extension, select Tools|Build Standalone Perl Application with a Perl script open in Komodo's
Editor Pane.
After configuring options using the tabs in the Build Standalone Perl Application dialog box, use the buttons
at the bottom of the dialog box to:
Add to Toolbox - Once you have created a new script, click this button to add it to the Toolbox as a
run command.
Build - Create a new build or overwrite an existing build.
Debug - If the Komodo debugging option is selected on the General tab, click this button to start the
debugger.
Note: When using the Build Standalone Application feature with Perl 5.8.0 on a Linux installation where
the environment is set to use UTF-8, you must add the module 'utf8' on the Modules tab. This is the
41 Komodo and the Perl Dev Kit Komodo IDE only 226
Komodo User Guide
equivalent of perlapp --add utf8. The module is not required for Perl 5.8.1 or higher.
Enter the name of the script to build using the PDK - Specify the path and filename of the source
Perl script. This option is equivalent to the -script command-line argument.
Build the script using - Select the type of output to generate.
Enter the name of the target executable or control - Specify the path and name of the output file.
This option is equivalent to the -exe command-line argument.
Dependencies
None - Include all necessary files in the output file, so that it can be run on systems that do
not have Perl56.dll or ActivePerl. This option is equivalent to the -freestanding
command-line argument.
Perl Dll required on target - Reduce the size of the generated executable by excluding
Perl56.dll from the output file. Target systems must have the Perl56.dll installed. This setting
corresponds with the -xclude command-line argument.
ActivePerl required on target - Create an output file to run on systems where ActivePerl
and any modules included via use and require statements are installed. This option is
equivalent to the -dependent command-line argument.
Verbose build information - Generate detailed output messages while the output file is being built.
This option corresponds to the -verbose command-line argument.
Hide console (for GUI applications) - Similar to running wperl.exe, this option is useful for building
applications that run in the background. This setting corresponds with the PerlApp -gui
command-line argument and is only available for the PerlApp tool.
Overwrite existing build - Replace the existing build with a new build. If you attempt to overwrite a
build without selecting this option, a pop-up dialog box warns that the .exe file already exists. You
can then choose to overwrite the file, overwrite the file and enable the check box, or cancel the
command. This option is equivalent to the -force command-line argument.
Delete temp files after each run - Freestanding Perl applications, services and controls sometimes
contain embedded DLLs that are extracted and cached in the host system's temporary directory. Select
this check box to delete these files after each run. This setting corresponds with the -clean
command-line argument.
Debugging - To debug the Perl executable, control or service as it is being built, select the desired
debugger from the drop-down list. If you are not using either the Komodo or PDK debugger, specify a
Hostname and Port for another debugger in the fields provided.
To add a module to the output program, enter the name of the module in the Module name field, and click
Add. The module to be added is displayed in the list box above. Remove modules from the list box using the
Delete and Delete All buttons.
To remove an unwanted module from the build, enter the name of the module in the Modules field, and click
Add. The module to be trimmed is displayed in the list box above. Remove modules from the list box using
the Delete and Delete All buttons.
To add a file to the output program, click Add. In the pop-up dialog box, enter the source location of the file
on your system, and the location where the file should be extracted when the output file runs.
To edit a file that has been added to the output program, click Edit. In the dialog box, as required, alter the
source location of the file on your system, and the location where the file should be extracted when the output
file runs.
To remove a file that was to be added to the output program, click the file, then click Delete.
To alter any of the version options, select the desired option in the Version field column, and enter the desired
value in the field below. This information is assembled as a version information (VERINFO) resource and
displayed to users if they view the properties for the script in Windows Explorer.
To add a lib or blib directory to include in an output file, click Add. In the Browse for Folder dialog box,
select the directory path to include, and click OK. The path can contain multiple directories that are separated
in the same way as in the PATH environment variable.
Use Delete and Delete All to remove directories that you do not want to add from the "lib" and "blib" list
boxes.
To include .ico files in a build, click Add. From the Add Icon dialog box, select the icon(s) you want to add,
and click Open. The complete path for the icon file is displayed in the Icon File list box.
If you want to specify any command-line parameters in addition to those selected using the options in the
Build Standalone Perl Application dialog box, enter them in the field provided.
Interpolation shortcuts can be inserted in Run Commands using the drop-down list to the right of Command
field in the "Add Command..." and "Properties" dialog boxes, or entered manually. When using interpolation
shortcuts in snippets or templates, insert the interpolation code using bracketed syntax. Run commands and
snippets can be stored in a project or the Toolbox for frequent use.
Code Description
%% a literal percent sign (%) (e.g. %%PATH%% instead of %PATH% on Windows)
%f the basename of the current file
%b the basename of the current file without it's extension
%F the full path and name of the current file
%L the line where the editing cursor is located within the current file
%d the base directory of the current file
%D the entire directory path of the current file
%P the full path of the active project
%p the directory path of the active project
%w the word under the cursor in the editor
URL-escaped word under cursor; replaces characters that are not valid in a query string,
%W
such as spaces and ampersands
%s the current selection; interpolates the text that is currently selected in the editor
URL-escaped selection; replaces characters that are not valid in a query string, such as
%S
spaces and ampersands
%(perl) the perl interpreter specified in Komodo's Perl preference
%(php) the php interpreter specified in Komodo's PHP preference
%(python) the python interpreter specified in Komodo's Python preference
the pythonw interpreter for python scripts that display a GUI (Windows and OS X only -
%(pythonw)
requires ActivePython)
%<code>
%(<code><backref>:<options>...)
For example:
%(perl)
%w
%guid2
%(ask:Your Name:Trent Mick)
The parentheses are optional if the block does not contain spaces. For example, the following two commands
are equivalent:
%ask:Name:Trent
%(ask:Name:Trent)
[[%(<code><backref>:<options>...)]]
<code> is one of the codes shown in the table above, <backref> is a number and <options>... depend on the
specific code. Back-references and options are discussed in other sections. The following are examples of
bracketed syntax:
[[%perl]]
[[%w]]
[[%guid2]]
[[%ask:Your Name:Trent Mick]]
With bracketed interpolation codes, the parentheses are always optional. The double brackets enclose spaces,
making parentheses unnecessary. For example, both of the following commands are valid:
Bracketed interpolation code blocks permit some excess space immediately adjacent to the double brackets.
For example the following are equivalent:
%(s:orask:Element Name)
If there is no selected text, a pop-up dialog box appears with a text field called "Element Name".
See Using Command Query Shortcuts in the Run Command Tutorial for examples of %(ask) and
%(...:orask) shortcuts.
42.4 %(date)
A %(date) shortcut is replaced with the current date, formatted according to a given optional format or the
default format.
%(date<backref>:<optional-format>)
[[%(date:<optional-format>)]]
As noted in the Basic Interpolation Code Syntax section, the parentheses are optional. The <backref> optional
parameter is discussed in the Back-references section. The following examples are valid:
%date
[[%date]]
%(date)
%date:%H:%M:%S
[[%date:%d/%m/%Y %H:%M:%S]]
If this format is not appropriate, you can specify a different one using the following date formatting codes
(from Python's time.strftime() method):
Directive Meaning
%a Locale's abbreviated weekday name.
%A Locale's full weekday name.
%b Locale's abbreviated month name.
%B Locale's full month name.
%c Locale's appropriate date and time representation.
%d Day of the month as a decimal number [01,31].
%H Hour (24-hour clock) as a decimal number [00,23].
%I Hour (12-hour clock) as a decimal number [01,12].
%j Day of the year as a decimal number [001,366].
%m Month as a decimal number [01,12].
%M Minute as a decimal number [00,59].
%p Locale's equivalent of either AM or PM.
%S Second as a decimal number [00,61].
Week number of the year (Sunday as the first day of the week) as a decimal number
%U [00,53]. All days in a new year preceding the first Sunday are considered to be in week
0.
%(ask[:NAME:[DEFAULT]])
%(askpass[:NAME:[DEFAULT]])
"NAME" appears next to the corresponding field in pop-up dialog box, and "DEFAULT" is an optional
default value. A "DEFAULT" cannot be specified without a "NAME".
Typical usage of the %(askpass) shortcut would use "Password" for the "NAME" and not set a
"DEFAULT". For example:
%(askpass:Password)
As noted in Basic Interpolation Code Syntax, usage of parentheses depends on the context. The following
examples are valid:
%ask
[[%ask:Name]]
%ask:Name:Joe
%(ask:What is Your Name:Joe Smith)
%(ask<backref>:<optional-question>:<optional-default>)
[[%(ask<backref>:<optional-question>:<optional-default>)]]
42.6 %(path)
The "path" codes are used to provide special directory paths based on the installation of Komodo that is
currently running. These include such items as the common data directory, which may be necessary if you are
building run commands that you intend to work on shared files.
%(path:<pathName>)
[[%(path:<pathName>)]]
42.7 %(debugger)
The %(debugger) shortcuts are used to provide runtime values from the debugger subsystem in Komodo.
These codes can be used to provide debugging information to applications such as PerlApp.
Debugger
Meaning
Value
address The hostname or address Komodo is running on.
port The TCP/IP port number that the debugger system is listening on.
proxyAddress The hostname or address of a debugger proxy that Komodo is using.
proxyPort The TCP/IP port number of a debugger proxy that Komodo is using.
A session key, typically retrieved from the USER environment variable, that the proxy
proxyKey
uses to match debug sessions with a specific running instance of Komodo.
42.8 %(pref)
The %(pref) shortcut is used to provide values from Komodo's Preferences. The back-end of Komodo's
preference system is undocumented, but you can examine the settings in the prefs.xml file in the user data
directory to find the preference IDs.
%(pref:<prefName>)
[[%(pref:<prefName>)]]
42.9 Back-References
Back-references are particularly useful for code snippets. You can use back-references to interpolate the same
value any number of times in the snippet. Back-references make it possible to prompt the user for an input
value only once, and then insert that value multiple times. For example, you could create a snippet that
prompts for a value, which would then be entered at various places in the snippet text.
%(<code><backref>:<options>...)
[[%(<code><backref>:<options>...)]]
For example:
All interpolation blocks with the same shortcut/number pairs are part of the same back-reference set. All
members of the same back-reference set will be replaced with the first code block in that set. For example:
This opens a pop-up dialog box prompting for one entry, "Name", with a default of "Trent". Whatever value
the user entered for "Name" would then be inserted in two places in the command, resulting in the following
command:
Another useful application of back-references is the "guid" code. A guid code is replaced with a new GUID
(Globally Unique Identifier). Sometimes it is desirable to have the same GUID inserted in more than one
place in a file. In snippets, this can be done by using a code "%guid1" instead of just "%guid" wherever you
want the GUID inserted.
Some preferences can also be configured on a per-file basis. For example, the configuration of line endings,
indentation style and word wrap can be configured for individual files. File-specific settings override the
default preferences described in this section. To configure file-specific defaults, see File Properties and
Settings in the File section of the Komodo documentation.
Toolbar Configuration
Show Komodo Start Page on startup: Select to display the Start Page in the Editor Pane when
Komodo launches.
Hide Tutorials Pane: Select to hide the Tutorials section of the Komodo Start Page.
Hide Quick Links Pane: Select to hide the Quick Links section of the Komodo Start Page.
Number of Projects: The number of projects displayed on Komodo's Start Page, and on the Recent
Projects menu.
Number of Files: The number of files displayed on Komodo's Start Page, and on the Recent Files
menu.
Enable automatic autocomplete and calltip triggering while you type: Toggles automatic
autocomplete triggering and calltips (Enabled by default). Click OK to save changes.
Enable autocomplete fill-up characters: Toggles"fill-up" characters. Typing certain characters, like
'(' or '.', during an autocomplete session will trigger insertion of the current completion before the
character itself is inserted.
Maximum number of lines shown in calltip: Used to control how much calltip information can be
displayed.
API Catalogs
Komodo uses API catalogs to provide autocomplete and calltips for 3rd-party libraries. In the API Catalogs
panel, select the libraries that you use in your code to enable them. Selecting multiple API catalogs for a
particular language can yield confusing results if there are overlapping namespaces, classes or function names.
When starting a new debug session: Specify whether Komodo should Ask me what files to save
(which displays a list of changed files); Save all modified files (whereby all modified files are
automatically saved); or Save no files (whereby the debugging session starts without saving any
files).
When receiving a remote debugging connection: Specify whether Komodo should Ask me to
allow connection (Komodo prompts to allow the connection request); Allow the connection
(Komodo accepts the connection without prompting); or Refuse the connection (Komodo refuses the
connection without prompting).
Initial break behavior: Specify whether Komodo should Break on first executable line or Run to
first breakpoint. Breaking on the first line of code is useful for adding breakpoints if none have been
set yet (e.g. in a non-local JavaScript file).
Skip debugging options dialog: To block the display of the debugger dialog box when the debugger
is invoked, check this box. Using the 'Ctrl' key in conjunction with a debugger command key toggles
the value specified here. However, commands invoked from the Debugger drop-down menu always
use the convention specified here.
Confirm when closing debugger session tab: If the debugger is running when you attempt to close
the Debug tab, this check box determines whether you are prompted to halt the debug session and
close the tab, or whether this happens without prompting.
Show expression values in hover tooltip: If this is enabled, while you are debugging, you can hover
the mouse pointer over a variable or expression in Komodo to see a tooltip with the value of that
variable.
Try to find files on the local system when remote debugging: By default, when Komodo performs
remote debugging, it retrieves a read-only copy of the file to be debugged from the debug engine.
Children per page: The number of child nodes displayed for an object in a variable view. Clicking
"...Next Page..." at the end of the list will fetch another "page" of nodes.
Variable Data retrieved: The maximum number of bytes stored for a value in a variable view.
Recursive Depth retrieved: Recursion depth for nested objects (e.g. arrays of arrays etc.).
Live Import: Keep the imported directories and files current with the file system via Live Folders. By
default, new projects use the base directory in which they are created as the project's root directory
and import all files and directories recursively. Files and directories in the project are kept
synchronized with the filesystem. For example, when new files are added to a directory in the project,
they will automatically appear in the corresponding Live Folder in the project. This setting can be
overridden in a particular Project's scope in Project Properties and Settings.
Directory to import from: Specify the directory from which you want to import files. Use the
Browse button to navigate the file system.
Files to include: Specify the filenames to include. Use wildcards ("*" and "?") to specify groups of
files. Separate multiple file specifications with semicolons. If the field is left blank, all files in the
specified directory are imported.
These settings apply to all new projects in Komodo. They can be overridden in:
General Preferences
Show whitespace characters: Display or hide whitespace characters in the editor. Spaces are
displayed as dots; tab characters appear as right arrows.
Show end-of-line characters: This option sets the default for displaying end of line markers. Display
can also be toggled using the View|View EOL Markers menu option.
Show line numbers: This option sets the default for displaying line numbers. If enabled, line
numbers are displayed on the left side of the Editor Pane. Line numbers can also be toggled using the
View|View Line Numbers menu option.
Options set through the Preferences dialog box are the default for all files opened in Komodo. Some display
characteristics can be assigned to individual files.
Confirmation Dialogs
When files that are opened in the Komodo editor are changed by another application, Komodo can be
configured to respond in various ways:
Detect when files are changed outside the environment: When this option is enabled, Komodo
pays attention to changes made to files outside the Komodo environment.
If files have been changed: When files are changed outside Komodo, select whether Komodo should
Ask me what files to reload (prompt for reload confirmation); Reload all files (reload without
prompting); or Reload no files (do nothing).
If files have been deleted: When files are deleted outside Komodo, select whether Komodo should
Ask me what files to close (prompt for close confirmation); Close all files (close without prompting);
or Close no files (do nothing).
If Ask me what files to reload Ask me what files to close are selected, the prompt is displayed when:
Scrolling
The Scrolling setting determines the number of lines that are be displayed above or below the editing cursor.
As the editing cursor moves, the number of lines specified here are displayed between the cursor and the top
or bottom of the Editor Pane. You can also set the horizontal scroll bar width by entering the desired size in
pixels.
Incremental Search
These options set the defaults for the Incremental Search feature.
On Linux systems, key bindings defined in the window manager (including default key bindings) take
precedence over Komodo key bindings. If certain keys or key combinations do not work as expected in
Komodo, check the window manager's key binding scheme. In the case of conflicts, change either the
Komodo key bindings or the window manager key bindings.
To configure key binding defaults, select Edit|Preferences|Editor|Key Bindings. By default, menu key
bindings are accessed using 'Alt' key combinations on Windows and Linux. For example, the File menu is
opened via 'Alt'+'F'. Select Remove Alt-<letter> shortcuts from menus to disable menu access via these key
bindings. The 'Alt' key still activates the File menu.
Key binding "schemes" are sets of pre-configured key bindings. Click the links below to view a list of key
bindings for each of the schemes.
Pre-configured schemes cannot be modified. When you attempt to modify a key binding, you are prompted to
make a copy of the scheme with a new name before making changes.
Some Emacs key bindings use 'Alt'+'letter' combinations that are also used to access Komodo menus. To
avoid this conflict, select Remove Alt-<letter> shortcuts from menus.
Vi Emulation
Vi emulation mimics the modal behavior of the Vi editor. Selecting Enable Vi emulation when a scheme
other than Vi is selected prompts you to create a new scheme. This scheme is based on the current scheme
with the Vi emulation behavior added.
Schemes created with Vi emulation enabled (including the default Vi scheme) will always require Vi
emulation. The Enable Vi emulation checkbox cannot be toggled.
To alter or view a specific key binding, scroll the Commands list or enter characters in the filter field. If
multiple key bindings are assigned to a single command, the Current Key Sequence field displays as a
drop-down list. Click the Clear button to delete the key binding displayed for the selected command; click
Clear All to delete all key bindings for the selected command.
To add a new key binding for the selected command, enter the desired key binding in the New Key Sequence
field. If the key sequence is already assigned to another command, the current assignment is displayed in the
Key Sequence Already Used By field. Click Change to update the key binding displayed in the Current
Key Sequence field; click Add to make the new key binding an additional key binding. If the key binding is
already assigned, the original assignment is cleared.
Open Shortcuts
URLs
Run Commands
Macros
Snippets
Templates
When the key binding associated with a component is invoked, it has the same action as double-clicking the
component in the Toolbox or Projects tab.
Key bindings assigned to components in a project are only available for the active project. Key bindings for
Toolbox components are always available.
To assign a key binding to a component, or to alter or delete an existing key binding, right-click the desired
component in the Toolbox or Projects sidebar to display the Properties dialog box, then click the Key Binding
tab. Configure as described above.
Sharing Keybindings
Keybindings can be shared between Komodo installations by copying the keybinding (*.kkf) scheme files.
Number of spaces per indent: Number of spaces Komodo inserts on the left margin when indenting
a line of code.
Width of each Tab character: Number of spaces that are equal to a Tab character.
Fold mark style: Use the drop-down list to select the style of node used in code folding.
Use horizontal line on folds: Displays collapsed code with fold marks; a thin line also spans the
width of the Editor Pane.
'Backspace' decreases indentation in leading whitespace: If this option is enabled, pressing
'Backspace' clears an entire indentation, rather than a single space, if there is nothing between the
editing cursor and the left margin. For example, if the number of spaces per indent is set to four, and
there are five spaces between the left margin and the editing cursor, pressing 'Backspace' once clears
one space; pressing 'Backspace' a second time clears four spaces.
Restore fold state on document load (slows down file opening): If this option is enabled, the
current state of code folding is remembered when a file is closed, and reinstated when the file is next
opened.
Options set through the Preferences dialog box are the default for all files opened in Komodo. Some
The Komodo editor maintains an index of words in the current file. Instead of re-entering words that already
exist in the current file, you can use the Complete Word function to finish words. If you are using the default
key binding scheme, word completion is invoked from the keyboard by pressing 'Ctrl'+'Space' ('F5' or
'Alt'+'Esc' on Mac OS X). If you also want to be able to complete words by pressing the 'Tab' key, select the
check box labeled Use tab character to complete words like Ctrl+Space. Note that the 'Tab' key can still be
used for other purposes when this check box is selected. Word completion only occurs when the cursor is
positioned to the right of characters in a word that has been stored in the editor's index.
Select an option from the Word wrap long lines drop-down list to have lines automatically "wrapped"; that
is, when a line exceeds the width of the Editor Pane, it wraps to the next line. This is merely a display
characteristic - no end-of-line marker is inserted. You can choose Word, Character, or leave it as the default
value of None. The Character option wraps the line at the immediate position where the line exceeds the
width of the Editor Pane; the Word option wraps the line from the beginning of the word that extends beyond
the width of the Editor Pane.
Note: For lines that have been wrapped automatically, the behavior of the 'Home' and 'End' keys is slightly
different. Pressing 'Home' or 'End' moves the cursor to the beginning or end of the current line. Pressing the
same key a second time moves the cursor to the previous or next end-of-line marker.
Select an option from the Word wrap markers drop-down list to display markers in the Editor Pane. You can
choose to view End of line markers, Start of line markers, Both or None. The default is None.
Show edge line / Highlight characters beyond edge line: Select to show where the line wraps, and
to highlight characters beyond the wrap column. With fixed-width fonts, a line is drawn at the column
specified. With proportional-width fonts, those characters beyond the specified column are drawn on
a colored background. The line or background color is configured on the Fonts and Colors preference
page.
Edge line column: Specify the column position of the vertical marker.
Enable soft characters turns on language-specific autocompletion for brackets, braces and other delimiters.
The highlighted closing character is inserted after the cursor and can be "typed over". See Soft Characters in
the Editor section for more information.
Background syntax checking validates code against the language interpreter as you type. (If Code Intelligence
is enabled for Python, the code intelligence database is used to validate Python code.) Syntax errors and
warnings are underlined in the Editor Pane. See Background Syntax Checking for more information.
By default, Komodo performs a background syntax check one second (1000 msecs) after you stop typing. In
very large files, this background process can slow down editing. If you notice slowness in the editor pane, try
extending the delay or disabling background syntax checking. Syntax checking can be run manually by
clicking the syntax checking icon ( or ) in the status bar.
The level of background syntax checking for Perl is determined by the setting on the Perl Language
preference page.
Enable checking of mixed end-of-line (EOL) characters" checks for inconsistent end-of-line characters
caused by editing a file on multiple platforms (e.g. CR-LF on Windows vs. LF on Linux).
Komodo can fold (i.e. hide and un-hide) logical segments of code in many languages and data file types. The
following options define how code folding looks and works:
Clean trailing whitespace and EOL markers: Eliminates unnecessary empty space between text
and EOL markers, and fixes inappropriate EOL markers.
Ensure file ends with EOL marker: Adds an EOL marker to the last line in a file if one does not
already exist.
Based on the specified Minutes between auto-save, Komodo saves backup copies of all files open in the
editor. When Komodo is shut down normally, the backup copies are deleted. If Komodo is shut down
abnormally (such as through a system crash), Komodo prompts to restore the backup copy when the file is
next opened. If you respond "Yes", the backup copy of the file, rather than the (older) disk copy, is opened in
the editor.
When files without extensions are saved, Komodo can be configured to prompt for an action. Configure the If
filename has no extension drop-down list:
Ask me what to do: Komodo prompts you with a dialog box to decide what to do when a particular
file is saved without an extension.
Add appropriate extension: Komodo automatically adds an extension based on file content.
Leave filename alone: Komodo does nothing when a file is saved without an extension.
43.6 Environment
At startup, Komodo loads all environment variables it can access. If it is launched from a desktop icon rather
than a shell, environment variables set in the default shell will not be loaded automatically.
To ensure that Komodo runs with the correct environment variables, (e.g. SCC settings, library locations, SSH
options, etc.) set them in the User Environment Variables (override defaults) list box. Three buttons are
available for manipulating this list:
1. Enter the desired pattern in the Pattern field. The pattern consists of the wildcards and the naming
convention. Typically, file associations are made by the filename extension; for example, a Perl script
has the extension ".pl". The pattern for a Perl script is therefore "*.pl".
2. Select the language to associate with the pattern from the Language drop-down list.
XML Declarations: The Use XML Declarations option checks for XML declarations that specify
the language of a file (e.g. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> for XHTML 1.0).
Shebang (#!...) Line: The Use shebang line option checks for a "#!/..." line at the top of a file that
specifies the interpreter (e.g. #!/usr/bin/perl).
Emacs-Style Mode Variable: When this check box is selected, as Komodo opens files, it checks for
an embedded Emacs "mode" specification used to set the syntax checking and debugging
configuration.
The Sample Text window at the top of the Fonts and Colors page offers a preview of the current scheme. If
multiple schemes are configured, select the desired scheme from the Scheme drop-down list.
1. Select the scheme that you want to base your new scheme upon.
2. Click the New button and enter a name for the new scheme.
3. Make any necessary changes using the controls on the Fonts, Colors, Common Syntax Coloring, and
Language-Specific Coloring tabs.
4. Click OK to save the new scheme.
Schemes are added to the Scheme drop-down list. Remove the selected scheme by clicking the Delete button.
System schemes appear in bold and cannot be deleted.
43.8.1 Fonts
The Fonts tab is used to configure the display characteristics for fixed-width and/or proportional fonts. Note
that the default font characteristics configured on this tab are not overridden by any language-specific font
configurations.
To create a scheme that affects characters in specific encodings, select the type of encoding from the
Encoding drop-down list. If you do not specify the encoding, Komodo uses the system's default encoding.
The Fonts tab contains two identical sets of font controls, one for fixed-width fonts on the left, and the other
for proportional fonts on the right. Select the Prefer Fixed or Prefer Prop. option button to set the desired
font type and then use the drop-down list immediately beneath the selected option to choose a specific font.
Font: Select specific fixed-width or proportional fonts from the drop-down lists. (On Linux, the same
list of fonts is displayed in both drop-down lists. On GTK, there is no programmatic way to identify
whether a font is proportional or not; therefore, you must know the properties of the individual fonts
when modifying these values.)
Font Size: Select the size of the font from the drop-down list.
43.8.2 Colors
Use the Color Choice drop-down list on the Colors tab to configure general color properties for the Editor
Pane. After selecting an interface component from the list, click the box to the right of the drop-down list to
choose a color from the color palette, or click the small arrow button to select a color from the system color
palette.
Current Line Background Color: The color configured here does not take effect unless the
Highlight Current Line check box is selected. This sets the highlighting color of the line in which
the editing cursor is positioned.
Cursor Color: Sets the color of the editing cursor.
Selection Background Color: The background of text that has been selected in the Editor Pane (by
double-clicking, or clicking and dragging), is colored according to this setting.
Selection Text Color: This option is only available if the Override Text Color in Selection check
box is selected. Regardless of other color configurations, all text that has been selected in the Editor
Pane (by double-clicking, or clicking and dragging), is displayed in the color specified in this setting.
Active Breakpoints Color: Sets the color of the breakpoint at which the debugger is currently
stopped.
Pending Breakpoints Color: Sets the color of breakpoints at which the debugger has yet to stop.
Bookmark Color: Sets the color of the bookmarks that are inserted in the margin to the left of the
Editor Pane.
Debugger Current Line Background Color: Sets the background color of the line highlighted by
the debugger.
Debugger Calling Line Background Color: Sets the color of lines that call subroutines. Caller line
coloring is applied only when you have changed the stack position to view the line that calls the
current line. View caller lines in the Call Stack drop-down list box on the Variables tab on the
Debug tab.
Edge Line/Background Color of Text Too Far: If Word Wrap is enabled, use this option to set the
color of the word wrap column marker, as well as the highlighted characters beyond the wrap column.
If using fixed-width fonts, a line is drawn at the specified column. If using a proportional-width font,
characters beyond the specified column are drawn on a colored background.
The Override Text Color in Selection check box activates the "Selection Text Color" setting described
above. The Highlight Current Line check box activates the coloring specified in the "Current Line
Background Color" setting described above.
Face: Select the typeface of the font from the drop-down list. You can choose either "Fixed-width" or
"Proportional".
Size: Select the size of the font from the drop-down list.
Bold: If you want the default font to be displayed in bold, click the "B".
Italic: If you want the default font to be displayed in italics, click the "I".
Font Color: Set the font color by clicking on the foreground color box. Select the desired color from
the color picker dialog box, or click the small arrow button to select a color from the system color
palette.
Background Color: Set the background color for the Editor Pane by clicking on the background
color box. Select the desired color from the color picker dialog box, or click the small arrow button to
select a color from the system color palette.
Reset: Click this button to return the font and color preferences to Komodo's original, default settings.
Face: Select the typeface of the font from the drop-down list. You can choose either "Fixed-width" or
"Proportional".
Size: Select the size of the font from the drop-down list.
Bold: If you want the default font to be displayed in bold, click the "B".
Italic: If you want the default font to be displayed in italics, click the "I".
Font Color: Set the font color by clicking on the foreground color box. Select the desired color from
the color picker dialog box, or click the small arrow button to select a color from the system color
palette.
Background Color: Set the background color for the Editor Pane by clicking on the background
color box. Select the desired color from the color picker dialog box, or click the small arrow button to
select a color from the system color palette.
Reset: Click this button to return the font and color preferences to Komodo's original, default settings.
You can configure one or more formatters for any language. Each language will have one formatter marked as
Default, which is the one used by the Format Code or Text ('cmd_format') function. By default, this
command does not have a key binding. You can assign one in the Key Bindings preferences.
Run HTTP Inspector at startup: If selected, this starts the proxy when Komodo is launched. If not,
the proxy can be started from the HTTP Inspector interface.
Listen on port: Specify the port the proxy runs on. Most proxies use port 8080.
Only accept connections from the local machine: Enabled by default.
Proxy forwarding:
Enable proxy forwarding: Enable this option if you use an HTTP proxy to connect to the internet
(i.e. at your network gateway).
Forward proxy connections on to this host: If you have enabled proxy forwarding, enter the proxy
information in the format <hostname>:<port>. If no port is specified, Komodo will attempt to
use port 8080.
Preferred Language: Specify which language interpreter's shell is launched when the interactive
shell is invoked.
Session Control:
Close tab when interactive shell session ends: If this option is selected, the Shell tab closes
when the Stop button is clicked. Otherwise, the tab remains visible (although you must
invoke another interactive shell session to use the shell).
Confirm when closing interactive shell: When you attempt to close the Shell tab before
stopping the session (by clicking the Stop button), this option determines whether you are
prompted for confirmation. The confirmation dialog box has an option to disable the warning;
to re-enable the warning, set this field to Ask me each time.
Working Directory: This option sets the "current" directory for the interactive shell session. Specify
the desired directory.
1. File Preference: If a specific encoding has been assigned to a file via the file's Properties and Settings
context menu, the assigned encoding is always used when that file is opened.
2. Auto-Detect: If the Auto-Detect File Encoding when Opened box is checked, Komodo analyzes the
existing encoding of the file by first looking for a Byte Order Marker (BOM), then by checking for an
XML declaration, and then by performing heuristic analysis on the file's contents. If an encoding can
When you create a new file, only the third and fourth methods described above are used to set the file's
encoding.
The following settings override all other encoding settings except the File Preference setting.
Allow XML Declaration to Override Auto-Detection: Komodo always uses the XML encoding
declaration contained in the XML file when opening XML files (if applicable).
Allow HTML META tag to Override Auto-Detection: Komodo uses the charset setting defined
in META tags in HTML documents.
Allow 'coding:' tag to Override Auto-Detection: If the file contains a
"coding: <encoding_name>" directive within the first two lines, that encoding is used.
The Date & Time format determines the display format of the date and time for items listed on the Start Page,
and for the Current File settings display.
The General Help field is used to specify a help location that does not specifically apply to a language (or
applies to a language not available in the above list).
To reset any of the help settings to their original value, click Reset beside the pertinent field.
JavaScript Directories: Specify any directories that you want Komodo to use for autocompletion and
calltips. Komodo scans these directories recursively (up to 5 directories deep) for information.
Use this installation: Use the drop-down list or the Browse button to specify the path to the PDK
executable file.
Use this interpreter: Select Find on Path to use the first PHP interpreter that occurs in the system's
PATH variable. The paths to interpreters found in the PATH variable are available from the drop-down
list; select a specific interpreter as desired. Alternatively, click Browse and navigate the filesystem to
select the desired interpreter.
Path to alternate PHP configuration file: The php.ini file must be modified to support Komodo
debugging. To specify an different php.ini than the one configured by the PHP Debugger
Configuration Wizard, enter the path in this field, or use the Browse button. See Debugging PHP
for information about manually configuring the php.ini.
PHP Directories: Specify any directories that you want Komodo to use for autocompletion and
calltips. Komodo scans these directories recursively (up to 5 directories deep) for information.
Comment Style: PHP can use "//" or "#" for comments. Choose one of these styles for use by the
Comment Region and Un-comment Region features.
Note: Be sure your php.ini configuration file is located in your operating system directory. If you used the
PHP Windows installer, this file should be in the correct location. To verify, on Windows 2000/NT the
php.ini file should be in \winnt; on Windows 98/Me the php.ini file should be in \windows. On
Windows XP, the system directory is either \winnt or \windows, depending on whether XP was a native
installation or was an upgrade from a previous Windows version.
Use Komodo's shared support functionality to share PHP preferences, run commands, code snippets,
templates, .tip files, or other items that have special usefulness within your PHP programming group. See
Configuring Shared Support for more information.
Debugger Logging: If this option is enabled, the Komodo debugger logs the debugging session to a
file in the directory specified in the Debugger Log Path field (or the directory specified in the
system's TEMP variable, if no directory is specified). This is primarily for debugging the debugger, as
opposed to gaining additional insight on the debug session itself. The debugger log file is named
ruby-dbgp.log. The contents of the log file are overwritten each time the debugger is invoked.
Additional Ruby Import Directories: Directories specified in this field are inserted at the beginning
of Ruby's PATH_LOAD environment variable. Modules in the specified directories are used for
debugging and syntax checking.
Use this Wish interpreter: Select Find on Path to use the first Wish interpreter that occurs in the
system's PATH variable. The paths to interpreters found in the PATH variable are available from the
drop-down list; select a specific interpreter as desired. Alternatively, click Browse and navigate the
filesystem to select the desired interpreter.
Use this Tclsh Interpreter: As described above, specify the desired Tclsh interpreter.
Enable Debugger Log: If this option is enabled, the debugger logs sessions to a file called
tcl-dbgp.log in the directory specified in Debugger Log Path (or the the system's TEMP directory if
no path is specified). The contents of the log file are overwritten each time the debugger is invoked.
This file is primarily useful in troubleshooting debugger sessions.
Additional Tcl Include Directories: Directories specified in this field are inserted at the beginning of
Tcl's TCLLIBPATH environment variable. Modules in the specified directories are used for
debugging, syntax checking and during interactive shell sessions.
Note: Tcl Beta releases contain only version-specific executables (e.g. tclsh85.exe and wish85.exe).
Komodo does not automatically find these in the path. To use them, specify them manually in the Interpreters
section rather than selecting Find on Path.
Syntax checking support in Komodo Edit requires the TCL Syntax Checker extension.
Warning messages to suppress: The warning messages listed in this dialog box can be disabled. This
prevents Komodo's syntax checking functionality from reporting these warnings.
Error messages to suppress: The error messages listed in this dialog box can be disabled. This
prevents Komodo's syntax checking functionality from reporting these errors.
Additional options: Configure the level of error and warning checking by using the switches -W1
(display parsing and syntax errors), -W2 (display parsing and syntax errors, and usage warnings),
-W3 (display parsing and syntax errors, portability warnings, upgrade warnings, performance
warnings, and usage warnings), and -Wall (displays all messages and errors (the default)).
Additionally, specific warning and error messages can be suppressed using the -suppress error
switch.
Force checking for specific Tcl/Tk Version: To use a version of Tcl other than the default (8.4) for
warning and error checking, select the desired version from the drop-down list.
Komodo's Tcl debugger has additional preferences for instrumenting files and logging debug sessions.
Tcl Instrumented Files: By default, all files are instrumented. However, once modules are added to
this list box, you can choose to not instrument specific modules by clearing the appropriate check
boxes next to the module names. To instrument modules in the list box, select the check box beside
the module name. To add a module to the list (e.g. "incrtcl, "TclX"), click the "Add Entry" button,
specify the Module Name, and click OK. To remove a module, select one or more module names in
the list box, and click "Delete Entries".
Debugger Logging: If this option is enabled, the Komodo debugger logs the debugging session to a
file in the directory specified in the Debugger Log Path field (or the directory specified in the
system's TEMP variable, if no directory is specified). This is primarily for debugging the debugger, as
opposed to gaining additional insight on the debug session itself. The debugger log file is named
tcl.log. The contents of the log file are overwritten each time the debugger is invoked.
Use Komodo's shared support functionality to share Tcl preferences, run commands, code snippets, templates,
.tip files, or other items that have special usefulness within your Tcl programming group. See Configuring
Shared Support for more information.
Error Level: Errors Only displays all HTML errors with a red underline; Errors and Warnings
displays both errors and warnings with a red underline.
WAI Accessibility Conformance level: The Web Accessibility Initiative (WAI) provides HTML
developers with guidelines for making web content accessible to those with disabilities. These
guidelines include methods for making content understandable and navigable (for example, adding
"alt" text to an "img" tag for those who cannot view images). WAI accessibility levels are:
Off: WAI accessibility is off. No WAI-related syntax errors are reported.
Priority 3: The lowest WAI conformance level. One or more groups will have difficulty
accessing the information in this document.
Priority 2: Satisfying this level removes significant barriers to accessing content in this
document.
Priority 1: The highest WAI conformance level. A web content developer must satisfy this
level for the greatest content accessibility.
Configuration File: Tidy functionality can be customized via a custom configuration file. See
teaching Tidy about new tags on the W3C site for information on building a custom configuration
file. To specify a custom Tidy configuration file, click Browse beside the Configuration File text
box to locate the configuration file on your filesystem.
Click the Delete... button to delete the currently selected catalog from the list.
Use the arrow buttons to rearrange the order of the catalogs. Catalogs at the top of the list take precedence
over those below. All catalogs specified here (and the DTDs and RelaxNG Schemas referenced by them) take
precedence over the ones that ship with Komodo.
http://www.example.org/index.html
/var/www/index.html
remote debugging
dragging URLs into the Editor pane
previewing HTML files
To map a URI (the address of an internet or network resource, such as a web URL) to a local directory:
The Path can refer to remote paths that are accessed via FTP, SFTP, or SCP (e.g.
scp://user@host.example.org:/home/user/) in addition to paths on the local filesystem. If the remote server is
configured under Servers Preferences, Komodo will open the file without prompting for authentication.
Double-click an existing mapping in the list to edit the URI or Local Path. URI mappings are substring
matches. For example, /home/user/public_html/project would match any directories starting with that string
(i.e. subdirectories project_1, project_2, etc.).
The Komodo templates used to create new files (File|New|New File) support the same Interpolation Shortcut
codes as snippets and run commands. Prior to Komodo Version 2.5, only a limited set of variables could be
used (for example, to embed the current date and time in files created from custom templates). The new
Interpolation Shortcuts are more powerful but are backward-incompatible.
Enter a number in the Number of recent templates to remember field to specify how many recent template
names appear on the File|New drop-down menu.
The encoding for new files is determined by the configuration of the Internationalization preference.
Use the When starting Komodo field to specify the display when Komodo is opened.
Ask me whether to restore workspace: Komodo prompts to open recent files and projects.
Restore last workspace: Komodo displays the workspace exactly as it was when you last quit
Komodo (including expanded tabs and open files).
Do not restore last workspace: Komodo displays the default workspace (the Start Page and no
expanded tabs).
These options specify the relationship between projects and files that are open in the Editor Pane.
Ask me what to do: Komodo prompts whether the files that were open when the project was last
closed should be re-opened.
Open recent files: Komodo automatically opens the files that were open when the project was last
closed.
Open no files: Komodo opens the project without opening any files.
Ask me what to do: Komodo prompts whether open files associated with the project should be
closed.
Close all open files in project: Komodo automatically closes open files associated with the project.
Close no files: Komodo closes no files.
The Update file status automatically option enables a periodic check of the read/write status and the source
code control status of components stored in the Projects sidebar and the Toolbox.
Status refresh can also be performed manually; see Refreshing Project Status for more information.
Specify the defaults for the Import from File System option, available in the option in the Projects sidebar,
the Toolbox, and in folders stored in either a project or the Toolbox. These defaults can be overridden in the
Import from File System dialog box.
Filenames to include: Specify the filenames to include. Use wildcards ("*" and "?") to specify groups
of files. Separate multiple file specifications with semicolons. If the field is left blank, all files in the
specified directory are imported.
Filenames to exclude: Specify the file and directory names to exclude. Use wildcards ("*" and "?") to
specify groups of files. Separate multiple file specifications with semicolons. If the field is left blank,
no files in the specified directory are excluded.
Import Subdirectories Recursively: To import subdirectories located beneath the directory specified
for the import, check Import Subdirectories Recursively. Specify how Komodo should handle
subdirectories by selecting one of the following options:
Import directory structure: If the Import Subdirectories Recursively box is checked and
this option is selected, Komodo creates folders within the project that represent imported
directories. Thus, the directory structure is preserved within the project.
Make a folder per language: If this option is selected, imported files are organized into
folders according to the language indicated by file pattern in the filename. File associations
are configured in the Komodo Preferences. Each folder is named after the associated
language, for example, "Perl files", "XML files", etc. Files that don't correspond to a known
file pattern are stored in a folder called "Other files".
Make one flat list: If this option is selected, all the imported files are placed directly under
the project or folder from which the Import from File System command was invoked.
Triggering Macros
Macros can be configured to execute when specific Komodo events occur (such as before a file is saved or
after a file is closed). To disable this feature, uncheck Enable triggering of macros on Komodo events.
See Opening Remote Files for information about working with remote files.
If no servers have been previously configured, enter access information as described below and click the Add
button. If there are prior server configurations, click the New Server button to clear the fields. To alter an
existing configuration, select the configuration from the drop-down list, make the desired changes, then click
the Update button. To delete a configuration, select the desired configuration and click the Delete button.
Remote Accounts: Previous server configurations can be accessed via this field.
Server Type: Select the type of connection to the server (FTP, SFTP or SCP).
Name: Enter a name for the account. The value in this field is displayed in the "Remote Accounts"
drop-down list box, and is used as the Server name in the Remote File dialog box.
Hostname: Enter the name of the remote server. The name may be fully qualified (e.g.
"server.example.org", or just the hostname of a machine within a local domain.
Port: Enter the port to use to connect to the server. SFTP and SCP generally use port 22. FTP
generally uses port 21.
User Name: If you require an account to use the remote server, enter the user name in this field. If the
server accepts anonymous access, enter "anonymous" or click the Anonymous Login check box.
Password: If you require an account to use the remote server, enter the account password in this field.
If access to the server is anonymous, the password is usually an email address (such as
"user@host.com").
Default Path: To specify the directory that displays when you connect to the server, enter the path in
this field.
Anonymous Login: If the server allows anonymous login, check this box.
templates
Shared Toolbox
Tcl .tip files (syntax definition files)
.pcx files (checker extension files that define exact syntax information)
.pdx files (debugger extension files)
preferences
To access shared components, Komodo users must have "read" access rights to shared files in both the
Common Data Directory and the Shared Toolbox (if the directory is not the same as the Common Data
Directory). To alter shared components, users must also have "write" rights.
By default, the The Common Data Directory is the same as the user data directory.
The other file types that can be shared are .pcx files, which can be used to extend the command information
supported by the TDK Checker and Komodo Tcl linter, and .pdx files, which are debugger extension files that
define debugging functions, such as spawnpoints. Like .tip files, .pcx and .pdx files are stored in the tcl
subdirectory of the Common Data Directory.
1. user preferences
2. shared preferences (common)
3. default preferences (factory)
In a shared configuration, user preferences always override the shared preferences. Shared preferences always
override the default preferences.
To configure shared preferences, set the desired preferences in one instance of Komodo. (This sets user
preferences for that Komodo installation.) Then, edit the prefs.xml file that stores the preferences.
Make a backup copy of prefs.xml before editing it. In prefs.xml, make the following changes:
Copy prefs.xml to the Common Data Directory. When other Komodo sessions (configured to use the same
Common Data Directory) are started, the preferences in the Common Data Directory are used.
Because user preferences override both default and shared preferences, ensure that user preferences are not
configured for items defined in the shared preferences. For example, if the shared preference contains a tab
size definition, and a user's personal preference contains a tab size definition, the user's preference is used, not
the shared preference.
Show SCC Output Tab on Commands: Select the desired action from the drop-down list to specify
whether the SCC tab is displayed when SCC commands produce output.
Method used to display 'diff' output: Specify whether the output from the SCC diff command
should be displayed in a separate window, or within a new tab in the Komodo Editor Pane.
CVS Integration: Select this check box if you are using a CVS source code repository.
CVS executable used: Choose the path to the desired CVS executable file from the drop-down list, or
click Browse to navigate to the file location.
Check for status changes from outside of Komodo: If this check box is selected, Komodo checks to
see if the status of files that are open in the editor has changed from the status they had at the last
check. Specify the interval at which Komodo should check the file status in the field below.
Do recursive status checks: When checking the CVS status of files in a project, select this check box
to recurse the directories. If this check box is not selected, only the status of files in the current
directory are checked.
Diff options: When you use the option Diff (Compare Files), the comparison is performed according
to the style specified here. Any CVS diff options may be specified. For a complete list of options,
refer to the CVS Manual.
Do not warn about CVS external protocols (CVS_RSH) at startup: If you are using an external
protocol (such as RSH) to connect to the CVS repository, select this check box if you do not want a
warning displayed when you start Komodo.
Perforce Integration: Select this check box if using a Perforce source code repository.
Perforce executable used: Use the drop-down list or the Browse button to specify the path to the
Perforce executable file.
Check for status changes from outside of Komodo: If this check box is selected, Komodo checks to
see if the status of files that are open in the editor has changed from the status it had at the last check.
Specify the interval at which Komodo should check the file status in the field below.
Do recursive status checks: When checking the status of files in a project, select this check box to
recurse the directories. If this box is not checked, only the status of files in the current directory is
checked.
Show diff in Komodo: When you use the option Diff (Compare Files), the comparison is performed
according to the style specified here. Refer to the Perforce Manual for a complete description of the
options. (Alternatively, on the command line, enter p4 help diff.)
Use external diff tool: If you want to use a diff tool other than Perforce, it must be specified in this
field. The location of the diff tool must also be included in your system's PATH environment variable.
SVN Integration: Select this check box if you are using a Subversion source code repository.
SVN executable used: Use the drop-down list or the Browse button to specify the path to the
Subversion executable file. Requires the svn command line client, available from
http://subversion.tigris.org/. Komodo cannot use the TortoiseSVN client as it's SVN executable.
Check for status changes from outside of Komodo: If this box is selected, Komodo checks to see if
the status of files that are open in the editor has changed from the status they had at the last check.
Specify the interval at which Komodo should check the file status in the field below.
Do recursive status checks: When checking the Subversion status of files in a project, check this box
to recurse the directories. If this box is not checked, only the status of files in the current directory are
checked.
Diff options: When you use the option Diff (Compare Files), the comparison is performed according
to the style specified here. Any Subversion diff options may be specified. For more about diff options,
refer to the Subversion Documentation.
Do not warn about Subversion external protocols (SVN_SSH) at startup: If you are using an
external protocol (such as SSH) to connect to the Subversion repository, check this box if you do not
want a warning displayed when you start Komodo.
When a file extension is added to the "Edit with Komodo" association, the context menu displayed when the
filename is right-clicked in Window Explorer contains an "Edit with Komodo" option.
Individual file extensions may be added and deleted via the lists.
If another application overrides the associations configured by Komodo, click Re-apply settings to system to
reset the Komodo associations.
Editing
Code Analysis
Debugging
Search
Tools
Project and Workspace
Creating a Rails scaffold using the Ruby on Rails Komodo project template
Using project macros to create a MySQL database and a core application
Writing a Rails application iteratively
Debugging the application
45.2 Editing
Preview Cascading Style Sheets
Simple Snippets
Create a Prompting Snippet
Code Completion Snippet
45.3 Debugging
Break on a Variable Value
Debug an XSLT Program
45.4 Search
Fast String Finder
Incremental Search
Open/Find Toolbar
45.5 Tools
Installing Extensions
Using SCC
Google Run Command
Interactive Shell
Test a Regular Expression
...that ActivePerl build 623 or greater is installed on your system. ActivePerl is a free distribution of
the core Perl language. See Komodo's Installation Guide for configuration instructions.
...that you have a connection to the Internet.
...that you are interested in Perl. You don't need to have previous knowledge of Perl; the tutorial will
walk you through a simple program and suggest some resources for further information.
1. Install a Perl module for parsing text files containing comma-separated values.
2. Open the Perl Tutorial Project and associated files.
3. Analyze parse.pl the Perl program included in the Tutorial Project.
4. Generate output by running the program.
5. Debug the program using the Komodo debugger.
3. Click the Run button to run the command. PPM connects to the default repository, downloads the
necessary files and installs them.
Perl Pointer It is also possible to install Perl modules without PPM using the CPAN shell. See the CPAN
FAQ for more information.
46.3 Opening Files
46.3.1 Open the Perl Tutorial Project
Select File|Open|Project and choose perl_tutorial.kpf from the perl_tutorials subdirectory. The
location differs depending on your operating system.
Windows
<komodo-install-directory>\lib\support\samples\perl_tutorials
Linux
<komodo-install-directory>/lib/support/samples/perl_tutorials
Mac OS X
<User-home-directory>/Library/Application Support/Komodo/3.x/samples/perl_tutorials
The files included in the tutorial project are displayed on the Projects sidebar. No files open automatically in
the Editor Pane.
mailexport.xml This file was generated by parse.pl, using mailexport.txt as input. When you run
parse.pl (in Generating Output), this file will be regenerated.
Komodo analyzes this line for hints about what language the file contains
warning messages are enabled with the "-w" switch
Komodo Tip notice that syntax elements are displayed in different colors. You can adjust the display options
for language elements in the Preferences dialog box.
46.4.2.2 Lines 2 to 4 - External Modules
input and output files are opened; if the output file does not exist, it is created
scalar variables, indicated by the "$" symbol, store the files
"strict" mode (enabled by loading "strict.pm" in line 2) requires that variables be declared using the
format "my $variable"
Perl Pointer scalar variables store "single" items; their symbol ("$") is shaped like an "s", for "scalar".
46.4.3.2 Lines 9 to 13 - Print the Header to the Output File
the result of the method call "new" is assigned to the scalar variable $csv
the method "new" is contained in the module Text::CSV_XS
({binary => 1}) tells the method to treat the data as binary
Perl Pointer good Perl code is liberally annotated with comments (indicated by the "#" symbol).
46.4.4.2 Lines 18 to 19 - Method "getline"
the method "getline" is contained in the module Text::CSV_XS, referenced in the $csv scalar variable
"getline" reads the first line of mailexport.txt (referenced in the $in variable), parses the line into
fields, and returns a reference to the resulting array to the $fields variable
Komodo Tip Click on the minus symbol to the left of line 21. The entire section of nested code will be
collapsed. This is Code Folding.
Komodo Tip click the mouse pointer on line 21. Notice that the opening brace changes to a bold red font.
The closing brace on line 51 is displayed the same way.
46.4.5.2 Lines 22 to 25 - Extracting a Line of Input Data
the "getline" function extracts one line of data from the input file and places it in the $record scalar
variable
if "getline" returns an empty array, the input file has been fully processed and the program exits the
loop and proceeds to line 52
Perl Pointer variable arrays store lists of items indexed by number; their symbol ("@") is shaped like an "a",
for "array".
46.4.6 Converting Characters with a Regular Expression
46.4.6.1 Lines 27 to 31 - "foreach"
Komodo Tip Komodo's Rx Toolkit is a powerful tool for creating and debugging regular expressions. See
Regular Expressions Primer for more information.
line 35 combines the @$record array with the field reference generated in line 19
Perl Pointer variable hashes are indicated by the symbol "%", and store lists of items indexed by string.
46.4.8 Writing Data to the Output File
46.4.8.1 Lines 37 to 50 - Writing Data to the Output File
one line at a time, lines from the input file are processed and written to the output file
portions of the data line (stored in the $record scalar variable) are extracted based on the
corresponding text in the field reference (the first line in the input file, stored in the $fields variable)
at line 51, processing will loop back to the opening brace on line 21
the logic to exit the loop is on line 25
1. Clear the contents of mailexport.xml Click on the "mailexport.xml" tab in the Editor Pane. Delete
the contents of the file - you will regenerate it in the next step. Save the file.
2. Run the Debugger Click on the "parse.pl" tab in the editor. From the menu, select
Debug|Go/Continue. In the Debugging Options dialog box,
click OK to accept the defaults.
3. View the contents of mailexport.xml Click on the "mailexport.xml" tab in the editor. Komodo
informs you that the file has changed. Click OK to reload the file.
1. Set a breakpoint: On the "parse.pl" tab, click in the grey margin immediately to the left of the code
on line 9 of the program. This will set a breakpoint, indicated by a red circle.
2. Run the Debugger: Select Debug|Go/Continue. In the Debugging Options dialog box, click OK to
accept the defaults. The debugger will process the program until it encounters the first breakpoint.
Komodo Tip Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the
Debug Toolbar. For a summary of debugger commands, see Debugger Command List.
3. Watch the debug process: A yellow arrow on the breakpoint indicates the position at which the
debugger has halted. Click on the "mailexport.xml" tab. Komodo informs you that the file has
changed. Click OK to reload the file.
4. View variables: In the Bottom Pane, see the Debug tab. The variables "$in" and "$out" appear in the
Locals tab.
5. Line 9 - Step In: Select Debug|Step In. "Step In" is a debugger command that causes the debugger to
execute the current line and then stop at the next processing line (notice that the lines between 9 and
13 are raw output indicated by "here" document markers).
6. Line 16 - Step In: On line 16, the processing transfers to the module Text::CSV_XS. Komodo opens
the file CSV_XS.pm and stops the debugger at the active line in the module.
7. Line 61 - Step Out: Select Debug|Step Out. The Step Out command will make the debugger execute
the function in Text::CSV_XS and pause at the next line of processing, which is back in parse.pl on
line 19.
8. Line 19 - Step Over: Select Debug|Step Over. The debugger will process the function in line 19
without opening the module containing the "getline" function.
Step In executes the current line of code and pauses at the following line.
Step Over executes the current line of code. If the line of code calls a function or method, the
function or method is executed in the background and the debugger pauses at the line that follows the
original line.
Step Out when the debugger is within a function or method, Step Out will execute the code without
stepping through the code line by line. The debugger will stop on the line of code following the
function or method call in the calling program.
9. Line 22 - Set Another Breakpoint: After the debugger stops at line 21, click in the grey margin
immediately to the left of the code on line 22 to set another breakpoint.
Perl Pointer The perl debugger will not break on certain parts of control structures, such as lines containing
only braces ( { }).
With Perl 5.6 and earlier, the debugger will also not break at the start of while, until, for, or foreach
statements.
10. Line 22 - Step Out: It appears that nothing happened. However, the debugger actually completed one
iteration of the "while loop" (from lines 21 to 51). To see how this works, set another breakpoint at
line 37, and Step Out again. The debugger will stop at line 37. On the Debug Session tab, look at the
data assigned to the $record variable. Then Step Out, and notice that $record is no longer displayed,
and the debugger is back on line 21. Step Out again, and look at the $record variable - it now contains
data from the next record in the input file.
11. Line 37 - Stop the Debugger: Select Debug|Stop to stop the Komodo debugger.
12.
Perl Pointer Did you notice that output wasn't written to mailexport.xml after every iteration of the while
loop?
This is because Perl maintains an internal buffer for writing to files. You can set the buffer to "autoflush"
using the special Perl variable "$|".
46.7 More Perl Resources
46.7.1 ASPN, the ActiveState Programmer Network
ASPN, the ActiveState Programmer Network, provides extensive resources for Perl programmers:
46.7.2 Documentation
There is a wealth of documentation available for Perl. The first source for language documentation is the Perl
distribution installed on your system. To access the documentation contained in the Perl distribution, use the
following commands:
Open the Run Command dialog box (Tools|Run Command), and then type perldoc perldoc.
A description of the "perldoc" command will be displayed on your screen. Perldoc is used to navigate
the documentation contained in your Perl distribution.
47.1 Overview
47.1.1 Before You Start
This tutorial assumes:
PHP 4.3.11 or greater is installed on your system. See the Debugging PHP documentation for
installation and configuration instructions.
You are interested in PHP. You don't need previous knowledge of PHP; the tutorial will walk you
through a simple program and suggest some resources for further information.
Windows
<komodo-install-directory>\lib\support\samples\php_tutorials
Linux
<komodo-install-directory>/lib/support/samples/php_tutorials
Mac OS X
<User-home-directory>/Library/Application Support/Komodo/3.x/samples/php_tutorials
All files included in the tutorial project are displayed on the Projects sidebar.
guestbook.php: This PHP program writes data from an HTML form to a data file, then extracts the
contents of the data file and formats it as HTML.
Komodo Tip: Notice that syntax elements are displayed in different colors. Adjust the display options for
language elements in the Preferences
dialog box.
47.4.3 PHP Declaration and Datafile
47.4.3.1 Line 9 - PHP Declaration
the // characters indicate a single-line comment in PHP programs; the # symbol can also be used.
Multi-line comments are nested in /* and */ characters, as shown on lines 27 to 30
the tmp directory must exist beneath the root of the drive where the program resides (unless a
different location is specified in the Debugging Options).
PHP statements are terminated with semicolons
Komodo Tip: On line 23, type $da. Komodo displays a list of the variables declared above the cursor
position that begin with the letters da. This is AutoComplete.
47.4.4 GuestBook Class
47.4.4.1 Lines 25 to 28 - Class Declaration
Komodo Tip: Click the mouse pointer at the end of line 25. Notice that the brace changes to a bold red font.
The closing brace on line 144 is displayed the same way. In this case, the braces mark the beginning and end
of a class. See Editing Files in the Komodo User Guide for more about matching braces.
47.4.5 GuestBook Function
47.4.5.1 Lines 34 to 37 - GuestBook Function
Komodo Tip: On line 38, type function GuestBook(. When you type the left parenthesis, Komodo
displays a pop-up hint that describes parameters for the function GuestBook. This is a CallTip.
47.4.5.2 Lines 40 to 44 - Check for Valid Form Entry
the "file" statement parses the contents of the file stored in the gb_dat variable into the $lines
array
the @ symbol suppresses warnings; in this case, if the data file is empty, the program
generates a non-fatal error
the if ($lines) statement checks to see if the $lines variable has data
the "join" statement converts the $lines array to a string and places it in the variable
$this->data
PHP Pointer: Use the "@" operator with care; you could disable error messages for critical errors that
terminate the execution of the script.
47.4.7 outputData Function
47.4.7.1 Lines 64 to 66 - outputData Function
the contents of the $this->data variable are written to the standard output using the echo
statement
the PHP variable $_POST is used to provide data to the script via HTTP POST
lines 74 to 77 extract the form data and place the items in variables
On line 80, the validity of the name and message variables is tested:
in !$name and !$message, "!" is a "not" operator; it is true if either variable is not true
The || symbol is an "or" operator
PHP Pointer: PHP has two "or" operators: the word "or", and the symbol ||. The || operator has
precedence over the word "or", providing flexibility in logic tests.
47.4.8.3 Line 86 - Current Date and Time
the variable $today contains the result of the PHP function date:
the date function returns a string
the "switches" are interpreted as follows:
F: text month
j: numeric day within month
y: four digit year
text and HTML tags are parsed with the $today variable and the form data
the return statement supplies the result (true or false) of a function or the value of a variable to the
routine from which it was called
the fopen function opens the file stored in the $this->gb_dat variable
the w switch opens the file if it exists
If the file does not exist, fopen will attempt to create it
the file is opened for writing only, and the file pointer is positioned at the top of the file
the if !$f statement checks to see if the $f variable contains a value
the fwrite function writes the contents of $this->data to the file contained in the $f variable
Komodo Tip: Click on the minus symbol to the left of line 100. The entire_writeDataFile function
collapses. This is Code Folding.
47.4.10 addGuestBookEntry Function
47.4.10.1 Lines 120 to 125 - Call Functions for Writing Data
the $gb variable creates a new instance of the GuestBook class using the file specified in the
$datafile variable
when the functions in the GuestBook class are complete, the PHP program is closed using the
syntax ?>
closing HTML tags are written as output
1. Set breakpoints: On the guestbook.php tab in the editor, click on the gray margin immediately to the
left of the code in line 9 of the program. This sets a breakpoint, indicated by a red circle. Set a second
breakpoint on line 148.
2. Run the debugger: Select Go|Continue. In the Debugging Options dialog box, click OK to accept
the defaults (assuming that you created the CGI variables in the previous step, Running the Program).
Komodo Tip: Notice that the Debugger Options have been saved from the last time a PHP program was run
or debugged.
Komodo Tip: Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the
Debug Toolbar. For a summary of debugger commands, see Debugger Command List.
3. Watch the debug process: A yellow arrow on the breakpoint indicates the position at which the
debugger has halted.
4. Line 9: Step In: Select Debug|Step In. "Step In" is a debugger command that causes the debugger to
execute the current line and then stop at the next processing line (line 19). The lines between line 9
and line 19 are comments, not processing statements, and are therefore ignored by the debugger.
5. View Variables: Expand the Bottom Pane (if necessary) by clicking and dragging the bottom margin
of the Komodo workspace. Variables defined in the program are displayed on the Locals tab.
6. Line 19: Select Go|Continue. The debugger moves to line 148. The GuestBook class is called from
line 148.
7. Line 148: Step In: The debugger is now processing the GuestBook function.
8. View Variables: The Locals tab displays all variables.
9. Line 35: Step In: Expand the $this variable on the Locals tab in the Bottom Pane. Notice that it
now has a sub-variable gb_dat, which stores the value of the data file.
10. Line 36: Step In: Continue to step in until the debugger stops at the _getData function. Continue
to select Step In to process each statement in the function. After line 57 has been processed and the
debugger is stopped at line 58, the $lines variable can be expanded on the Locals tab.
11. Line 58: Step Out: On line 58, select Step Out to process the rest of the _getData function. The
debugger will proceed to line 40, which follows the line where _getData was called.
Step In: Executes the current line of code and pauses at the following line.
Step Over: Executes the current line of code. If the line of code calls a function or method, the
function or method is executed in the background and the debugger pauses at the line that follows the
original line.
Step Out: Executes the code without stepping through the code line by line (when the debugger is
within a function or method). The debugger stops on the line of code following the function or
method call in the calling program.
14. Line 40: Step In: Continue to select Step In until the debugger is on line 121, in the
addGuestBookEntry function. On line 121, the addGuestBookEntry function calls the
_createEntryHTML function.
15. Line 121: Step In: In the _createEntryHTML function, the program assigns variables to the CGI
input data configured in the Debugging Options.
Python 2.3 or greater is installed on your system. ActivePython is a free distribution of the core
Python language. See the Debugging Python documentation for configuration instructions.
You are interested in learning about Komodo functionality, including the debugger and the interactive
shell.
You are interested in Python and have some programming experience either in Python or another
language.
See Interactive Shell and Debugging Programs for more information on this Komodo functionality.
Windows
<komodo-install-directory>\lib\support\samples\python_tutorials
Linux
<komodo-install-directory>/lib/support/samples/python_tutorials
Mac OS X
<User-home-directory>/Library/Application Support/Komodo/3.x/samples/python_tutorials
All files included in the tutorial project are displayed on the Projects sidebar.
preprocess.py: The main program. This Python program parses input source files and produces
output filtered on a set of rules and statements embedded in the original input source.
preprocess current file: A run command for executing preprocess.py on the file currently open in
Komodo.
contenttype.py: A Python module used by the main program (preprocess.py) to identify the language
of a given file.
content.types: A support file used by the Python module contenttype.py.
helloworld.html and helloworld.py: Sample files to process using preprocess.py.
About Preprocessors: A preprocessor is a program that examines a file for specific statements called
"directive statements". These directive statements are interpreted, and the resulting program output is
conditional based on those statements. In languages like C/C++, preprocessing is a common step applied to
source files before compilation. The Python preprocessor.py program mimics a C/C++ preprocessor using
similar directive statements.
About Directive Statements: Preprocessor directive statements are dependent on the preprocessor program
they are used within. In the preprocessor.py program, a directive is preceded with a pound sign (#), and is
located alone on a line of code. Placing a directive on a unique line ensures the statement is included in a file
without breaking file syntax rules. Valid preprocessor.py directives include:
#define <var>[=<value>]
#undef <var>
#if <expr>
#elif <expr>
#else
#endif
#error <error string>
Komodo Tip: Notice that syntax elements are displayed in different colors. You can adjust the display
options for language elements in the Preferences dialog box.
48.3.2.1 Lines 3 to 57 - Defining a Module Docstring
Komodo Tip: See Explore Python with the Interactive Shell to examine these docstrings, and other Python
elements, using the Komodo interactive shell.
Komodo Tip: Click on the minus symbol to the left of line 3. The entire section of nested help code is
collapsed. This is called Code Folding.
48.3.2.2 Lines 59 to 65 - Importing Standard Python Modules
The custom contenttype module is used by the preprocess.py program and is not included in a standard
Python installation.
Komodo Tip: To interact directly with the contenttype.py module, see Explore Python with the
Interactive Shell for more information.
48.3.3 Defining an Exception Class
48.3.3.1 Lines 72 to 88 - Declaring an Exception
Komodo Tip: Click the mouse pointer on the closing parenthesis ")" on line 72. Notice that its color changes
to a bold red. The opening brace is displayed the same way. This is called "Brace Matching". Related features
in Komodo are Jump to Matching Brace and Select to Matching Brace, available via the Code menu.
48.3.4 Initializing Global Objects
log is a global object used to log debug messages and error messages
Note that preprocessor directives recognized by the preprocess.py module are hidden in programming
language-specific comments.
Komodo Tip: Use the Code sidebar, available in the Left Pane, to browse the general program structure of
all currently open files. For each file, the code browser shows a tree of classes, functions, methods and
imported modules. Python instance attributes are also displayed.
48.3.5 Defining a Private Method
48.3.5.1 Lines 116 to 123 - Expression Evaluation
Examines how programming comments are delimited (started and ended) based on the type of file (for
example, HTML, C++, Python).
file type is used to look up all comment delimiters (opening and closing language comment
characters) in _commentGroups
This section defines advanced regular expressions for finding preprocessor directives in the input file.
Komodo Tip: Use the Komodo Rx Toolkit to build, edit, or test regular expressions. New to regular
expressions? The Regular Expressions Primer is a tutorial for those wanting to learn more about regex
syntax.
48.3.6.4 Lines 178 to 303 - Scanning the File to Generate Output
This block of code implements a basic state machine. The input file is scanned line by line looking for
preprocessor directives with the patterns defined above (stmtRes). This code determines whether each line
should be skipped or written to the output file.
The main method takes the text entered at the command line and uses the getopt module to parse the data
into arguments. These arguments are then passed into the "preprocess" method.
imports external modules used in this file (re, os, sys, logging)
logging is not a standard module; it is new in Python 2.3
This section outlines the usage of the private _getContentTypesFile method located in the
contenttype module.
This section outlines the usage of the private _getContentTypesRegistry method located in the
contenttype module.
locates the content.types file and scans it to calculate three mappings to return, as follows:
file suffix -> content type (i.e. ".cpp", a C++ implementation file)
regex -> content type (i.e. ".*\.html?", an HTML file)
filename -> content type (i.e. "Makefile", a Makefile)
This section outlines the usage of the public getContentType method located in the contenttype
module.
takes one parameter (the name of the file to determine the content)
returns a string specifying the content type (for example,
getContentType("my_web_page.htm") returns "HTML" )
getContentType is the only publicly accessible method in the module
1. Open the Source File: In the Projects sidebar, double-click the helloworld.html file. The file opens
in the Editor Pane.
2. Open the Run Command: In the Projects sidebar, double-click the preprocess current file run
command. A Preprocess Current File dialog box appears.
3. Preprocess Current File: In the Preprocessor Options text area, enter:
-D SAY_BYE
Click OK to run the program.
4. View Output: The helloworld.html file output is displayed on the Command Output tab as follows:
['path_to_file\\python_tutorials\\helloworld.html']
<html>
<head> <title>Hello World</title> </head>
<body>
<p>Hello, World!</p>
</body>
</html>
Python Tutorial Tip: For more information about the -D SAY_BYE command, see Using the Debugger.
Komodo Tip: For more infomation on using run commands in Komodo, see the Run Command Tutorial.
48.4.2 Using the Debugger
Generate output by running the program through the debugger without setting any breakpoints.
1. Run the debugger: Select the preprocess.py tab in the editor. From the menu, select
Debug|Go/Continue. In the Debugging Options dialog box, click OK to accept the defaults.
2. View the Debug Output Tab: Notice the messages in the bottom left corner of the Komodo screen;
these inform you of the status of the debugger. When the program has finished, program output is
displayed in the Bottom Pane, on the right side. If necessary, click the Debug Output tab to display
it.
This error message is the expected output by the preprocess.py program when no source file or arguments are
specified before it is run. The following instructions explain how to specify a file at the command line.
3. Specify a File to Process: In the Projects sidebar, double-click the file helloworld.html. Note the
preprocessor directives inside the comments (#) in this file. Select the preprocess.py tab in the editor.
From the menu select Debug|Go/Continue. In the Script Arguments text box on the Debugging
Options dialog box, enter helloworld.html. Click OK.
<html>
<head> <title>Hello World</title> </head>
<body>
preprocess: error: helloworld.html:5: #error: "SAY_BYE is not
defined, use '-D' option"
This error message is the expected output by the preprocess.py program when no command-line arguments
are specified with the source file helloworld.html. The following instructions explain how to specify a
command-line argument with the source file to be processed.
4. Specify an Argument with the Source File: Select Debug|Go/Continue. In the Script Arguments
text box in the Debugging Options dialog box, enter the following source file and argument: -D
SAY_BYE helloworld.html. Click OK.
<html>
<head> <title>Hello World</title> </head>
<body>
<p>Hello, World!</p>
</body>
</html>
In the helloworld.html file, if SAY_BYE is not defined, preprocessing generates an error. If SAY_BYE is
defined, the preprocessor includes the line <p>Hello, World!</p> in the body of the output of the
HTML. This demonstrates how a Python preprocessor can be used to conditionally include blocks of a source
file being processed.
5. View the Debug Output Tab: Notice the HTML output and compare the result to the actual file
helloworld.html.
6. View Rendered HTML: On the right side of the Bottom Pane, click the HTML tab. The rendered
HTML for the helloworld.html file is displayed in the Bottom Pane. Click the Output tab to return to
the HTML code.
7. Create New File: To create a new HTML file that will later contain the HTML code in the Bottom
Pane, select File|New|New File. In the New File dialog box, select the HTML Category. Click Open.
8. Save the Output: Delete the contents of the new HTML file tab in the Editor Pane, and then select
the contents of the Output tab on the Bottom Pane. Copy the contents to the new HTML file tab in
the Editor Pane. Select File|Save As to save the file with a unique name.
9. Specify Another Source File: Go through steps 3 to 5 using the file helloworld.py in place of
helloworld.html. Notice how the output displayed is now in Python, (for example, print "Hello,
World!"). This demonstrates how the preprocess.py program can be used to process files written in
different language types.
1. Set a breakpoint: On the preprocessor.py tab, click on the gray margin immediately to the left of
the code on line 347 of the program. This sets a breakpoint, indicated by a red circle.
2. Run the debugger: Select Debug|Go/Continue. In the Script Arguments text box on the Debugging
Options dialog box, enter the following source file and argument (if not there from a recent run): -D
"SAY_BYE" helloworld.html. Click OK.
Komodo Tip: Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the
Debug Toolbar. For a summary of debugger commands, see the Debugger Command List.
3. Watch the debug process: Notice that the line where the breakpoint is set (line 347) turns pink. Also,
a yellow arrow appears on the breakpoint. This arrow indicates the position at which the debugger has
halted.
4. View variables: On the Debug tab, click the Locals tab. If necessary, resize the pane by clicking and
dragging the upper margin. On the Locals tab, notice the declared variables are assigned values.
Examine the infile variable. This variable contains the name of the file specified above
(helloworld.html).
Step In: Executes the current line of code and pauses at the following line.
Step Over: Executes the current line of code. If the line of code calls a function or method, the
function or method is executed in the background and the debugger pauses at the line that follows the
original line.
Step Out: When the debugger is within a function or method, Step Out executes the code without
stepping through the code line-by-line. The debugger stops on the line of code following the function
or method call in the calling program.
5. Step In: Select Debug|Step In until the debugger stops at line 129, the preprocess method. "Step
In" is a debugger command that causes the debugger to enter a function called from the current line.
6. Set another breakpoint: Click on the gray margin immediately to the left of the code in line 145 to
set another breakpoint. Line 145 is where getContentType is called.
7. Run the debugger: Select Debug|Go/Continue.
8. Step Over: When line 145 is processed, the variable contentType is assigned the source file's
(helloworld.html) type (HTML). "Step Over" is a debugger command that executes the current line of
code. If the line of code calls a function or method, the function or method is executed in the
background and the debugger pauses at the line that follows the original line.
9. View variables: On the Debug tab, click the Locals tab. Examine the contentType variable. This
variable contains the type of the source file; the type is "HTML" for helloworld.html.
If starting this section of the tutorial with currently open Python shells, please follow the steps below to ensure
the Python shell's current directory is the Python Tutorial directory.
1. Close any Current Python Shells: Click the "X" button, located in the upper-right corner of the
Shell tab, for each open Python shell.
2. Make python_tutorial.kpf the Active Project: On the Project menu, select Make Active
Project|preprocess.
Start using the interactive shell with the Python Tutorial project files:
1. Start the Interactive Shell: On the Tools menu, select Interactive Shell|Start New Python Shell. A
Python Shell tab is displayed in the Bottom Pane.
2. Import a Module: At the ">>>" Python prompt in the interactive shell, enter: import
contenttype
Notice that another ">>>" Python prompt appears after the import statment. This indicates that the
contenttype module imported successfully.
3. Get Help for a Module: At the prompt, enter: help (contenttype)
The help instructions embedded in the contenttype.py file are printed to the interactive shell screen.
This is useful for easily accessing Python documentation without installing external help files.
4. Get Help for a Method in a Module: At the prompt, press the up arrow to redisplay previously
entered commands. When help (contenttype) is redisplayed, enter .getContentType at
the end of the command. The entire command is as follows:
help (contenttype.getContentType)
Press Enter. The help instructions for the getContentType method are printed to the shell screen.
The ability to instantly access help on specific Python functions is a powerful use for the interactive
shell.
Ruby 1.8.0 or greater is installed on your system. See the Debugging Ruby documentation for
configuration instructions.
You are interested in learning about Komodo functionality, including the debugger.
You are interested in Ruby and have some programming experience either in Ruby or another
language.
49.3.1 Introduction
In this step, you will analyze the program in sections. Ensure that line numbers are enabled in Komodo
(View|View Line Numbers) and that the file menagerie.rb is displayed in the Komodo editor.
Komodo Tip: Notice that syntax elements are displayed in different colors. You can adjust the display
options for language elements in the Preferences dialog box.
49.3.1.2 Line 8 to 13 - Define and Initialize the Entry class
The Entry class contains variables which hold data for individual entries in our simple database, and the
behavior of that data. Information about each animal in our menagerie will be contained in an Entry class
object.
These variables need to be private (instance variables) rather than global because there will be an instance of
the Entry class for each animal in the menagerie.
attr_reader is a Ruby shortcut for exposing @sci_name, @desc, and @time_mod as read-only
attributes of the Entry class.
the sci_name= method ensures that @time_mod is updated with the current time whenever
@sci_name is updated.
the desc= method does the same thing for @desc.
Komodo Tip: Click on the minus symbol to the left of line 18. The section of code for the sci_name method
is collapsed. Doing this at line 8 collapses the entire Entry class. This is called Code Folding.
49.3.1.5 Line 28 to 35 - Data Behavior Methods
the contains? method lets the cmd_search method determine if a particular entry contains the string
the user entered (see line 82).
the to_sci method returns the scientific name and description of an entry (see lines 77 and 83).
the $help global variable contains a string with information on command usage, providing an easy
way for methods to display help information when needed.
The Menagerie class contains the @menagerie hash: the container which holds the multiple instances of the
Entry class. It also contains all the methods available to the user of the application (via the command
interface starting at line 154.
The name of the animal is stored as a key in the @menagerie hash. It references the Entry object which
contains the rest of the information, namely the scientific name (sci_name) and description (descr). All
the information we store on each animal is kept in two separate areas -- the @menagerie key and the Entry
it points to.
the split method (from Ruby's String class) allows us to enter an entire record in one line, specifying
the separator character we intend to use
line 60 checks for an existing entry of the same name
if none is found, a new entry (i.e. Entry.new) is added
if there is an existing key of the same name, the entry is only updated if there is a change to
sci_name or descr (or both)
Exercise: After completing the tutorial, come back to this section and try writing a more "user friendly"
version of this cmd_add method which asks for the name, scientific name and description separately (i.e. one
at a time).
49.3.1.9 Line 74 to 88 - Searching for Entries
line 100 specifies that the argument for cmd_list is called "not_used" - a placeholder argument name
which tells us that the method will not actually use the argument
line 101 calls the dump method of the YAML class (see line 6) to show the entire Menagerie object
in YAML format
line 105 to 112: checks if the first character of the fname argument is "!"; this sets the overwrite
variable which determines whether cmd_save can overwrite an existing file
line 115 to 117: if overwrite is false and the specified file exists, warn the user with a helpful
message.
line 118 to 122: if the fname argument exists, set the @fname instance variable, if not, prompt the
user with a useful error message.
line 123 to 126 uses ruby's File class to open the file for writing
a file descriptor (fd) is created on line 124 which is written to in the next line (a YAML dump of our
menagerie)
line 127 to 131 provides error handling for problems during the save
The program needs a way to handle input from the user. This section deals with parsing input and splitting it
into commands which call methods in the Menagerie class, and arguments for those methods.
The output of the last command (including "Error: undefined method...") indicates that something is not
working correctly. Debugging can help trace this problem. Type quit in the Output window before starting
the debugger.
Breakpoints are used to identify exactly where a program may be having problems. A bug has been
intentionally left in the cmd_delete method which can illustrate this.
1. Set a breakpoint: On the menagerie.rb tab, click on the gray margin immediately to the left of the
code on line 93 of the program. This sets a breakpoint, indicated by a red circle.
2. Run the debugger: Select Debug|Go/Continue (or enter 'F5', or use the Debug Toolbar). The
Debugging Options dialog box will then pop up; press the Return key or OK button to dismiss it.
You can pass program options to the program with the Script Arguments text box, but this particular
program doesn't take any.
3. Enter commands: In the Command Output tab, re-enter the commands from the Running the
Program section ('load animals.yaml', 'list', and 'delete Komodo dragon').
Komodo Tip: Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the
Debug Toolbar. For a summary of debugger commands, see the Debugger Command List.
4. Watch the debug process: After the last command, notice that a yellow arrow appears where
breakpoint is set (line 93). This arrow indicates the position at which the debugger has halted. This
tells us that our command did match a key in @menagerie.
5. Check the relevant variables: Click on the Self tab to see the current object's instance and class
variables. Notice the @menagerie hash. Expand the view of the hash by clicking the plus symbol
next to it. It should only contain the "Leopard gecko" entry after the "Komodo dragon" entry has been
deleted.
6. Set a Watch variable: Select the Watch tab of the debugger window, highlight
'@menagerie.has_key?(name))' on line 92 and drag it into the Watch tab. You can place most
valid Ruby expressions in this area, including assignments, whether they're in the program or not. For
example, placing the expression 'x = 2 + 2' in the Watch tab will show that a local variable called
'x' is set to 4.
Step In: Executes the current line of code and pauses at the following line.
Step Over: Executes the current line of code. If the line of code calls a function or method, the
function or method is executed in the background and the debugger pauses at the line that follows the
original line.
Step Out: When the debugger is within a function or method, Step Out executes the code without
stepping through the code line-by-line. The debugger stops on the line of code following the function
or method call in the calling program.
6. Step In: Select Debug|Step In until the debugger stops at line 166 (print status_message). "Step In"
is a debugger command that causes the debugger to enter a function called from the current line.
7. View local variable: On the Debug tab, click the Locals tab. Examine the status_message
variable. This variable contains the message that will be returned to the user.
8. Run the debugger: Select Debug|Go/Continue (or enter 'F5', or use the Debug Toolbar). The
command returns "#<Entry:0x83096f8>Error: undefined method `[]' for
#<Entry:0x83096f8>" which is not a very user-friendly message. The cmd_delete method is
missing an explicit return value to provide if the deletion was successful.
9. Fix the problem: On the Debug menu, click Stop (or use the Stop button on the Debug Toolbar).
Uncomment line 94 by removing the "#".
10. Disable and Delete a breakpoint: Click on the red breakpoint at line 93. The red breakpoint is now
white with a red outline. This breakpoint is now disabled. Click on the disabled white breakpoint.
This removes the breakpoint.
11. Run the debugger: Select Debug|Go/Continue and re-run the commands used previously ('load
animals.yaml', 'list', and 'delete Komodo dragon'). The 'delete' command now returns the message
"Deleted".
ruby-lang.org: The main page for the ruby language, including release notes and downloads.
ruby-doc.org: Extensive online documentation including tutorials and links, with well organized core
and standard library API documentation.
Programming Ruby: Tutorial and reference.
why's (poignant) guide to ruby: An entertaining introduction to Ruby.
Learn to Program: Excellent Ruby tutorials for beginners by Chris Pine.
Ruby on Rails - Documentation: Documentation and tutorials for the Ruby on Rails web
development framework.
A recent local installation of Ruby (1.8.5 or later). See the Debugging Ruby documentation for
debugger configuration instructions.
A local installation of Ruby on Rails (version 2.x).
Access to a MySQL or SQLite database.
Several online "how to" guides are available for installing and configuring Ruby on Rails. See Rails
Resources for links to setup tutorials and installation bundles
Komodo has a very powerful Ruby on Rails project template with macros and commands for further
automating the creation of Rails applications. The entire application can be created within Komodo using
these tools and Komodo itself, without having to work at the command-line.
1. Create a new Rails scaffold using the Ruby on Rails Komodo project template.
2. Create a MySQL database.
3. Create the core of the application using just the project macros.
4. Write some code to iteratively develop the Movie Library application.
5. Test and debug the application.
If Rails has been installed correctly, you should see output in the bottom pane saying "The movielib project is
built". The movielib.kpf project should open in the Projects tab on the left, and should contain "Live Folders"
of all the directories created by the rails command (app, components, config, db, etc.) plus a Virtual Folder
containing the Komodo macros we'll be using.
If MySQL is installed locally and can accept connections by 'root' without a password (it often does by
default), click the Create Databases macro in the Rails Tools project folder to create the database.
If you have set a MySQL root password, created another MySQL account that you would like to use, or are
running the server on a different host, you will need to configure the database.yml file:
1. Open the config project folder and double-click database.yml to open it in an editor tab.
2. As necessary, modify the username and password values to match the configuration of your
MySQL server. If you're not sure what values to use, leave the default values ('username: root'
and 'password: '). In this tutorial, we will only be working with the development database, but
you should modify the test and production sections as well to avoid seeing errors when running
the Create Databases macro below.
3. If you are running MySQL on a remote server, add the setting hostname: host to the
development: configuration block, or modify the value if that setting is already present (set to
localhost by default.
If the database.yml file (and the database server) are configured correctly, a database called movielib (as
specified in the database.yml file - derived from the project name) will be created and an alert will appear
indicating that the database creation is done.
In the Generators folder, double-click the scaffold macro. In the dialog box enter movie as the model name,
and title:string as the only attribute in the movie model. Click OK.
The following output should appear in the Command Output tab showing the files created in this step:
exists app/models/
exists app/controllers/
exists app/helpers/
create app/views/movies
exists app/views/layouts/
exists test/functional/
exists test/unit/
create app/views/movies/index.html.erb
create app/views/movies/show.html.erb
create app/views/movies/new.html.erb
create app/views/movies/edit.html.erb
create app/views/layouts/movies.html.erb
create public/stylesheets/scaffold.css
dependency model
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/movie.rb
create test/unit/movie_test.rb
create test/fixtures/movies.yml
create db/migrate
create db/migrate/001_create_movies.rb
create app/controllers/movies_controller.rb
create test/functional/movies_controller_test.rb
create app/helpers/movies_helper.rb
route map.resources :movies
Several files are created and opened in editor tabs. You can unclutter your workspace by closing most of
them. For now close all the files but movie.rb, movie_tests.rb, movie_controller.rb, and
movie_controller_tests.rb. We'll return to most of the other generated files later.
50.4.1 Migration
Now that we've defined the model in Rails, we need to apply them to our database. In Rails this is done with
the 'rake db:migrate' command. Again, there's a macro to do this for us.
Double-click the db:migrate macro in Rails Tools|Migrate. The Command Output tab should show that the
table 'movies' has been created.
Let's add a couple of sanity checks to the model: we want to verify that all movie entries have a title, and that
there are no duplicates. Bring up movie.rb and add this code at lines 2 and 3, immediately after class
Movie < ActiveRecord::Base:
validates_presence_of :title
validates_uniqueness_of :title
You should see code-completion after you type val each time.
In the second line, after you type :t you can press the tab key to have it finish :title. If this does nothing
verify that the "Use tab character to complete words like Ctrl+Space" setting is on under
Edit|Preferences|Editor|Smart Editing.
Bring up movie_test.rb, delete the test_truth that the scaffolder generated for you, and add these two
tests:
def test_present
m = Movie.new
assert !m.valid?
m.title = "Rocky"
assert m.valid?
end
def test_unique
m1 = Movie.create(:title => "Alien")
assert m1.valid?
m2 = Movie.create(:title => "Alien")
# First film should still be valid
assert m1.valid?
assert !m2.valid?
m2.title += "s"
assert m2.valid?
end
tab in the bottom window. In the test plan dropdown menu on the right side. Select "test:units", and press the
Run button immediately to the right.
You should see the tests run for a few seconds, and then a list of results will appear. If you get a message
along the lines of the following: "Run `rake db:migrate` to update your database then try again." you probably
skipped that step above. Run the Rails Tools/Migrate/db:migrate macro, and retry the tests.
The result tab should show that 2 tests passed, 0 failed, and there were 0 errors. There's also an "Information"
line, where Komodo displays lines of output from the underlying test pass that might be of interest, but don't
fit in any particular test.
Other commands (e.g. rake test:functionals below) can be run in a Run Command.
Click on the Test Results tab, select the test:functionals test from the dropdown list, and press the Run
button.
This time you should see that two of the tests failed: test_should_create_movie and
test_should_update_movie. If you click on the red "failures" button above the results, it will cycle
through the failed tests.
The Details window shows the results for each test. Make sure the test_should_create_movie test is
highlighted in the first window.
assert_difference('Movie.count') do
post :create, :movie => { }
end
The problem is that the controller_test's call to 'post' hits the controller's create command, which does go
through the validation check. The failure to pass the check prevents a new movie from being created, and we
still have two entries in the database after the block runs. Let's make a change that should satisfy the model's
rules:
def test_should_create_movie
If we rerun the test, we're now down to one failure. Click on the red failure button to move to the failed test,
then double-click on the line starting with
test/functional/movies_controller_test.rb:35:in
`test_should_update_movie' in the Details window to see the failed code.
def test_should_update_movie
put :update, :id => movies(:one).id, :movie => { }
assert_redirected_to movie_path(assigns(:movie))
end
It's not obvious why this test is failing. Rails tests are just Ruby code, so let's use the debugger (Komodo IDE
only) to have a closer look, with the following steps:
What are those duplicate values? While the debugger is still running, enter the interactive shell with the
Debug|Interact menu command, and type the line:
Movie.find(:all).map(&:title)
Ruby should reply with ["MyString", "MyString"]. Those values come from the file
test/fixtures/movies.yml. The problem is that when Rails reads the fixtures file to populate the database, it
doesn't run the values through ActiveRecord's validation checks. Once you start using controller methods, like
the update method here, the values are run through validation checks.
Let's fix that. Stop the debugger and change one of those "MyString" movie titles to something more
interesting, like "Who Is Harry Kellerman and Why Is He Saying Those Terrible Things About Me?", or "My
Other String", if you're not up for all that typing.
At this point we have a working application. It's not yet useful as a lending library, but we can have a look at
what we've got so far.
In the Run folder, double-click the run server macro. This will start one of the Mongrel, lighttpd, or
Webrick servers, depending on your Ruby installation, and run it in a separate console window.
with:
While the application the Rails scaffolder generates is certainly serviceable, there are some tweaks that will
immediately make it friendlier:
If we're going to enter a number of movies, let's speed things up by stealing the New Movie link from
index.html.erb, and placing it in show.html.erb:
from index.html.erb, and paste it at the end of show.html.erb. Put a "|" character at the end of the previous line
to maintain consistency. Save show.html.erb. No need to restart the server -- switch to the app, enter a new
title at the New Movie screen, press the "Create" button, and you should have a "New movie" link.
Similarly, it would be nice if the cursor was in the Title field when we load the New movie page, similar to
how the Search field has the focus on Google's home page. Since we're going to be using the Prototype
library, I added the javascript_include_tag directive to the head section of
app/views/layouts/movies.html.erb:
<script type="text/javascript">
Event.observe(window, "load", function() {
$('movie_title').focus();
});
</script>
If you type this code in, you should see code-completion after 'Event.' and a call-tip after '(' if you've
enabled the prototype.js code intelligence API catalog in Preferences.
Again, there's no need to restart the server. As soon as you load the new controller and view code, your
changes will come into effect.
We're going to install two plugins, to handle in-place editing and pagination.
Fortunately Komodo ships with macros that install these plugins, and add necessary patches. Open the Rails
Tools|Plugins folder in your Rails project, and run the in-place editing and pagination
macros. If you try to install a plugin that's already installed, you'll get a warning.
It's easy to create new plugin macros. Every installable plugin is treated as a resource, usually in a public
subversion repository, and identifiable with a URI. On the command-line you would invoke ruby
script/install plugin <URI>. In Komodo you would just need to copy one of the macros, paste it
into the same Plugins folder, edit it, and replace the old URI with the new one.
Plugins need to be installed in new Rails projects that use them (i.e. the plugin is added to the specific Rails
application, not to Rails itself). You have to restart the server after doing this, so this would be a good time to
stop the current Rails server. Find the window it's running in, and press Ctrl-C (Ctrl-Break on
Windows). We'll restart it again later.
@movies = Movie.find(:all)
to
cattr_reader :per_page
@@per_page = 10
Finally, add pagination to the view. The last three lines of app/views/movies/index.html.erb should contain
this code:
def test_pagination
Movie.delete_all
35.times {|i| Movie.create(:title => "title #{i}")}
get :index
assert_tag(:tag => 'div',
:attributes => { :class => 'pagination'})
assert_tag(:tag => 'span',
:content => '« Previous',
:attributes => { :class => 'disabled'})
assert_tag(:tag => 'span',
:content => '1',
:attributes => { :class => 'current'})
assert_tag(:tag => 'div',
:attributes => { :class => 'pagination'},
:child => { :tag => 'a',
:attributes => { :href => "/movies?page=4" },
:content => "4" })
end
Those assert_tag tests might look like they were pulled out of thin air, but the debugger was very useful
in writing them. Originally the test read like this:
def test_pagination
Movie.delete_all
35.times {|i| Movie.create(:title => "title #{i}")}
get :index
assert_response :success
end
We used the debugger to stop at the final line, captured the contents of @request.body by double-clicking
on it in the Self tab of the Debug tab, and pasted it into an empty HTML buffer in Komodo, and found the
paginator was generating this code:
<div class="pagination">
We then entered an interactive context with the Debug|Interact menu item, found some documentation
on the assert_tag, and interactively tried out the expressions, starting with simple expressions and making
them more complex. A final set that covered the situations was then copied into the test.
<td class="dvdlib_item">
<% @movie = movie %>
<%= in_place_editor_field :movie, :title %>
</td>
It should replace the line that displays the movie's title in a readonly field (<%= h(movie.title) %>)
with a user-editable field. You can also remove the link to the edit page (in the show.html.erb file as well), and
remove views/movies/edit.html.erb by right-clicking its icon in the project view, selecting Delete, and
choosing "Move to Trash".
Finally you need to tell your controller you're doing in-place editing:
Also in the controller, change the edit method so it doesn't go looking for the now-deleted edit.html.erb file:
# GET /movies/1/edit
def edit
@movie = Movie.find(params[:id])
Once again, run the unit and functional tests to verify these changes didn't break anything. They should be
fine, and this would be a good time to verify their actions in the browser, especially because in-place editing is
hard to verify in a functional test. Click on a movie title in the list view, and you should see the field become
writable, and an OK button appear. Make a change and press the OK button. If you see a "Saving..." message
in the field, and nothing else is happening, check the end of your log/development.log file. If you're curious
about the calls to protect_from_forgery, they're related to a security issue that was addressed in Rails
2.0, but not by the plugin.
def self.down
remove_column :movies, :borrower
remove_column :movies, :borrowed_on
remove_column :movies, :due_on
end
end
Let's add another validation routine. This one's more complex: we want to verify that if any of the
borrower, borrowed_on, and due_on fields are specified, they all are, and we'll do a sanity check on
the value of due_on. This is to guard the case where someone hits the controller without going through one
of our own views.
def validate
if borrowed_on.blank? && borrower.blank? && due_on.blank?
# ok
elsif !borrowed_on.blank? && !borrower.blank? && !due_on.blank?
if due_on <borrowed_on
errors.add(:due_on, "is before date-borrowed")
end
def test_borrower
m = Movie.create(:title => "House")
m.borrowed_on = Date.today
assert !m.valid?
m.borrower = "Dave"
assert !m.valid?
m.due_on = Date.yesterday
assert !m.valid?
m.due_on = m.borrowed_on + 3
assert m.valid?
Here's the RHTML for the checkout screen. Create the file app/views/movies/checkout.html.erb with this
code. One way to create this file is to right-click the app/views/movies folder and select "Add New File..."
<h1>Checkout a movie</h1>
<p>Title: <%= h @movie.title %></p>
<% form_tag :action => 'checkout', :id => @movie do %>
<p>Your name: <%= text_field(:movie, :borrower) %>
<%= submit_tag 'Check out' %>
<% end %>
<%= link_to 'Back to the library', movies_path %>
You might have noticed that we accept any name to be typed in the form. We can get away with this because
we're building a lending library that our friends will use. In a public application you would need to build a
separate table to track members, and another one to handle login status, and then you'd have to deal with
issues like password hashing and email address verification. All good information, and interesting, but beyond
the scope of this tutorial. See the references section for more info.
Here are the two new methods we need to add to the movies_controller.rb:
# Non-Rest methods
def checkout
@movie = Movie.find(params[:id])
if request.post?
# It's an update
@movie.borrower = params[:movie][borrower]
@movie.borrowed_on = today = Date.today
@movie.due_on = today + 7
if @movie.save
flash[:notice] = 'Movie was successfully created.'
redirect_to(movies_url)
else
render :action => "checkout"
end
else
# Render the template, the default
end
end
def return
@movie = Movie.find(params[:id])
@movie.borrower = @movie.borrowed_on = @movie.due_on = nil
@movie.save!
redirect_to(movies_url)
end
I assume HTML output to simplify the code. If you want you can add the respond_to and format
statements. Note how we overload the checkout method -- if it's part of a get request, we render the form.
Otherwise we assume we're processing the submitted form.
<h2>Movies</h2>
<table>
<tr>
<th class="dvdlib_header">Title</th>
<th class="dvdlib_header">Status</th>
</tr>
<% for movie in @movies %>
<tr>
<td class="dvdlib_item">
<% @movie = movie %>
<%= in_place_editor_field :movie, :title %>
</td>
<% if movie.borrower %>
<td class="dvdlib_item">Signed out by: <%= h movie.borrower %></td>
<td class="dvdlib_item">Due <%= h movie.due_on %></td>
<td class="dvdlib_item"><%= link_to 'Return', :action => 'return', :id => movie %></td>
<% else %>
<td class="dvdlib_item"><%= link_to 'Check out', :action => 'checkout', :id => movie %></td
<td class="dvdlib_item"><%= link_to 'Remove', { :action => 'destroy', :id => movie },
:confirm => 'Are you sure?', :method => :delete %></td>
<% end %>
</tr>
def test_checkout_get
get :checkout, :id => movies(:one).id
assert_response :success
end
def test_checkout_put
post :checkout, :id => movies(:one).id, :movie => {:borrower => "Fred"}
assert_redirected_to movies_path
end
We were expecting no errors, but this time we get an undefined local variable or method
error for borrower at around line 97-99 of movie_controller.rb. Sure enough, we forgot to put a ":"
before the param name "borrower". Change it to :borrower, rerun the tests, and they should pass.
People familiar with the first version of this tutorial will recall using the debugger to correct a problem like
this. Writing tests is more efficient. You can debug Rails apps if you need to, though. Press the Rails
Tools|Run|debug rails app tool, set breakpoints at the points in the controllers and views you're
interested in, and then hit them with your application.
Finally, start the server one more time, and verify that your application now works as you expect. You're
ready to take this one live.
Line numbers are referenced in this tutorial. To enable line numbering in the editor tabs, click View Line
Numbers in the View menu.
jsdemo.html: This "City picker" demo is an HTML page that uses JavaScript to display special
right-click context menus over an image map, and add the selected items to a table on the right.
context-menu.js: A JavaScript file containing the functions used in jsdemo.html.
YUI directory: A collection of Yahoo! User Interface JavaScript libraries used in the demo.
If Firefox is not set as your default browser in Komodo's Web Browser preferences, use the file URL in your
browser's address bar to locate the file and open it in Firefox.
Try the application. Right-clicking over a country in the map brings up a country-specific context menu
instead of Firefox's default context menu. Selecting a city from the menu adds that city under the appropriate
country heading in the table to the right and removes it from the menu. Reloading the page resets the page to
the initial view.
The context menu for Mexico is intentionally broken so that we can find the problem with the debugger later
in this tutorial and fix it.
The first thing we notice is the cities object. This is a list of the countries with nested lists of cities that
belong to them. Next is the demo function, which contains the onContextMenu function that brings up the
custom context menu, and the onCitySelect which controls the actions on that menu. The comments
describe what is happening in the code.
Komodo Tip: To enable autocompletion for the YUI libraries, click Preferences... on the Code menu and
select the YUI API Catalog in the Code Intelligence section.
51.4 Debugging the Page Komodo IDE only
If you have not already done so, configure the JavaScript Debugger.
If the debugger is configured correctly, the file event-min.js should open in a Komodo tab. Though you
haven't set any breakpoints in this file, the debugger stops at the first line of JavaScript executed by the
browser (in this case a YUI event handler). This gives you the opportunity to set breakpoints in the file if you
want to, or step through the code with the Step In button.
To leave this event handler and start debugging context-menu.js, click the Go/Continue Debugging button in
the main or debugging toolbar. Select the context-menu.js editor tab.
Set a breakpoint on line 62 of context-menu.js by clicking in the empty left margin. Breakpoints are displayed
as an orange-red octagonal icon in the breakpoint margin.
Komodo Tip: While the JavaScript debugger is in a break state, clicking Interact on the Debug menu opens
up a JavaScript shell where you can interact with the Firefox's JavaScript engine directly.
One of the most useful things the debugger does is keep track of variables in the code. In the locals tab in the
Output pane we can see a list of all variables in the current scope (i.e. variables in the demo function). The
globals tab shows everything in the window object; you can see the DOM objects by expanding the
document node in this list. The instance tab shows properties of the current object.
You may have noticed earlier that the context menu for Mexico is broken. The variables list in the locals tab
can help us find out why.
The curr_country variable was set on line 61 and appears to have the value "Mexic" which doesn't match
the country variable which is "Mexico".
We can modify this variable within the debugger while the it is in a break state. Double click on
curr_country in the locals tab to bring up the Edit Variable Value dialog box. Change "Mexic" to
"Mexico" and click "OK". Click the Go/Continue Debugging button to resume execution. The context
menu for Mexico should appear in Firefox. (Note: The default context menu may appear initially because of
how the debugger handles coming out of a break state. Clicking anywhere on the Komodo or Firefox windows
will clear this and show the expected menu.)
That solved the problem for this debugging session only. We need to find out where that typo came from.
Since the only appearance of the country's name in context-menu.js is spelled correctly on line 7, we can
assume there's a problem in jsdemo.html. Since curr_country is taken from e.target.id, we can
extrapolate that the "alt=" attribute of the image map area for Mexico is wrong.
Komodo Tip: If we didn't know where the e.target.id came from, we could use Komodo's Find...
feature to locate the typo in jsdemo.html
51.5 Adding Links
The cities are added to the country lists by manpulating the DOM. These are plain text <LI> elements, but it's
fairly simple to turn these into useful links by creating an <A> element and populating it with a URL
containing the selected city's name in an href attribute.
Wikipedia has a fairly simple URL syntax for topic names, and it has information on all of the cities in our
lists, so we could easily use it for our link targets.
Lines 43 to 45 in context-menu.js handle creating the list elements and inserting the city name:
Wikipedia articles can be accessed by adding the subject name to the end of the base URL. To set the href
attribute to a combination of the Wikipedia base URL and the selected city name, add the following line:
To insert this link in the list, modify the subsequent two lines to use newLink rather than newItem:
newLink.appendChild(document.createTextNode(cityName));
targetList.appendChild(newLink);
Save the file and reload the page. Selected cities will now appear as Wikipedia links.
You are interested in XSLT. Previous knowledge of XSLT is not required for this tutorial. The XSLT
Tutorial walks you through a simple program and later suggests various resources for further
information.
Windows
<komodo-install-directory>\lib\support\samples\xslt_tutorials
Linux
<komodo-install-directory>/lib/support/samples/xslt_tutorials
Mac OS X
<User-home-directory>/Library/Application Support/Komodo/3.x/samples/xslt_tutorials
All files included in the tutorial project are displayed on the Projects sidebar.
an XSLT program is an XML document - thus, the XML version and character set are declared on the
first line
the namespace declaration on the second line tells the "parser" (the XSLT interpreter) that XSLT
elements are prefixed with xsl: to prevent confusion with user-defined element names and
non-XSLT elements
xsl:output controls the appearance of the generated output; for example, the presence of this line
generates a META declaration in the head of the HTML output
Komodo Tip: Notice that different types of language elements are displayed in different colors. Adjust the
display options for language elements in the Preferences dialog box.
XSLT Pointer: Processing routines in XSLT programs are enclosed in opening and closing tags similar to
those in XML.
XSLT Pointer: XSLT commands have (up to) four components: namespace ("xsl"), element ("template"),
attribute(s) ("match="), and attribute value(s) ("/").
XSLT Pointer: XSLT uses XPath expressions to select data from XML documents. On line 6, match="/"
selects a "node" in the XML document's hierarchy, rather than a specific item of data.
processes each node of the XML document (that is, each sub-section contained beneath the current
position in the XML document)
for each node, the XSLT "engine" (the internal processor) checks the XSLT program for a matching
template
the first XML tag with a corresponding template is <EMAIL>
after processing all the nodes in the XML document, processing returns to line 13, where the closing
tags for the HTML page are written to the output
line 15 closes the XSLT processing routine, completing the program
when line 18 is processed, content in <HEADER> tags in the XML document are processed
lines 19 and 21 write standard HTML formatting around the content generated in line 20
on line 20, the value-of statement selects content contained in the <SUBJECT> tag and writes it to
the output document
Komodo Tip: Click the minus symbol to the left of line 19. The entire section of nested code is collapsed.
This is called Code Folding.
52.3.3.2 Lines 22 to 29 - call-template
after the From: text, the call-template routine causes the XSLT program to proceed to the
template formatEmail on line 51; after completing the formatEmail routine, processing returns
to line 23
with-param indicates that the parameter address should be applied to the contents of the
<ORIGADDRESS> XML tag
the same selection and formatting routine is applied to the contents of the <DESTADDRESS> XML
tag on lines 26 to 28
XSLT Pointer: Notice the <BR/> HTML tag on line 25. XML and XSLT treat all tags as container tags that
have both opening and closing elements. However, some HTML tags (like <BR> and <IMG>) stand alone,
and do not require a closing tag. They are represented with a closing slash. XSLT tags also use a closing slash
if they are not a tag pair (as shown on line 23).
XSLT Pointer: Comments in XSLT programs are enclosed in the tags <!-- and -->, the same as in
HTML.
52.3.4.2 Lines 36 to 39 - Process Email Body
after processing the email header, the XSLT program proceeds to line 36
the contents of the BODY tag are placed in the HTML tags
Komodo Tip: XSLT programs and XML input documents must be "well-formed" in order to perform
transformations. Komodo's Background Syntax Checking makes it easy to identify and fix coding errors.
1. Assign XML input file: On the Debug menu, click Go/Continue. In the Debugging Options dialog
box, specify mailexport.xml as the XML input file. Use the Browse button to navigate to the directory
containing the XSLT tutorial project files.
2. Run the debugger: Click OK to run the debugger.
3. Stop the debugger: From the Debug menu, select Stop to end the debugging process.
4. View Debug Output: Notice the messages displayed on the status bar in the bottom left corner of the
screen; these indicate the debugger status. The results of the transformation are displayed on the
Debug tab.
5. View the Output as HTML: On the right side of the Bottom Pane, click the HTML tab. The
rendered HTML is displayed in the Bottom Pane. Click the Output tab to return to the HTML code.
6. Create New File: To create a new HTML file that will later contain the HTML code in the Bottom
Pane, select File|New|New File. In the New File dialog box, select the HTML Category. Click Open.
7. Save the Output: Delete the contents of the new HTML file tab in the Editor Pane, and then select
the contents of the Output tab on the Bottom Pane. Copy the contents to the new HTML file tab in
the Editor Pane. Select File|Save As to save the file with a unique name.
1. Step In/Assign the XML input file: If necessary, click on the mailexport2html.xsl tab in the editor.
From the menu, select Debug|Step In. In the Debugging Options dialog box, specify mailexport.xml
as the XML input file. This should already be set if the input file was assigned in the previous step.
Assigning the XML input file to the XSLT program file selects the XML file as the default input file
when running the transformation.
2. Start Debugging: In the Debugging Options dialog box, click OK to start debugging.
Komodo Tip: Debugger commands can be accessed from the Debug menu, by shortcut keys, or from the
Debug Toolbar. For a summary of debugger commands, see the Debugger Command List.
3. Watch the debug process: A yellow arrow on line 7 indicates the position in the XSLT file where the
debugger has halted.
4. View Debug tab: In the Bottom Pane, click the Debug tab. On the right side of the Debug tab, click
the Call Stack tab. On the Call Stack tab, notice that the current call stack is the template in line 6 of
the XSLT program.
5. Set a breakpoint: On the mailexport2html.xsl tab in the Editor Pane, click the gray margin
immediately to the left of the code on line 12. This sets a breakpoint, indicated by a red circle.
Komodo Tip: Breakpoints can be set at any time. An enabled breakpoint is a solid red circle. A disabled
breakpoint is a white circle with a red outline. Click once in the gray margin to enable a breakpoint. Click an
enabled breakpoint once to disable it.
6. Line 7: Continue: Select Debug|Go/Continue. The debugger runs until it encounters the breakpoint
on line 12. If no breakpoint had been set, the debugger would have run to the end of the program.
7. Line 12: Step In: Click Debug|Step In. Notice the debugger jumps to line 33 of the XSLT program,
and shows a pointer in the XML file on line 3. When the debugger processed line 12
(xsl:apply-templates), it looked for a template that matched the top node in the XML
document (<EMAILCOMMENTS>). When no matching template was found, it proceeded to the next
node in the XML document (<EMAIL>) and found a matching template on line 33.
8. View the Debug tab: Notice that the Call Stack tab displays the current template match. Previous
template matches can be selected from the list; double-clicking them jumps to the corresponding lines
in both files.
9. Line 33: Step In: Use the Step In command until the current-line pointer in the XSLT file is on line
20.
10. Line 20: Step In: Watch the Bottom Pane as you Step In line 21. The xsl:value-of statement
selects the contents of the <SUBJECT> field on line 7 of the XML file and places it within the HTML
tags on lines 19 and 21.
11. Line 21: Step In: Line 22 calls the template formatEmail on line 45. Continue to step in until line
49 is processed. The formatEmail template is processed with the address parameter on line 46.
This routine processes the contents of the <ORIGADDRESS> node in the XML document. In order to
generate the hyperlink in the output HTML document, lines 48 and 49 concatenate the string
mailto: with the contents of the <ORIGADDRESS> node.
12. Line 49 to end: Go/Continue: On Debug menu, click Go/Continue to run the rest of the XSLT
program. The program's output is displayed in the Bottom Pane: raw output in the Output tab and
52.6.2 Documentation
The W3C (World Wide Web Consortium) specifications are available online:
XSLT
XPath
XML
Use the Command Output tab to interact with commands; if the command accepts input, enter it directly into
the command on the Command Output tab. The Command Output tab has the following features:
Output written to stderr (standard error output) is displayed in red at the top of the Command
Output tab.
To terminate a running command, click the button in the upper right-hand corner of the tab.
Many keyboard shortcuts available in the Komodo editor can also be executed on the Command
Output tab. For example, 'Ctrl'+'Shift'+'8' ('Meta'+'Shift'+'8' on Mac OS X) displays white space and
'Ctrl'+'Shift'+'7' ('Meta'+'Shift'+'7' on Mac OS X) displays line endings (if the default key binding
scheme is in effect).
The Toggle Raw/Parsed Output View button is discussed in the Parsing Command Output section of this
tutorial.
1. On the Projects sidebar, double-click the file play.txt. The file opens in the Editor Pane; a tab at the
top of the pane displays its name.
2. Select Tools|Run Command.
3. In the Run field, enter the command dir (on Windows) or ls -al (on Linux).
4. Select the Insert output check box, and then click Run. The contents of Komodo's current directory
are inserted into play.txt.
1. Open play.txt from the Run Command tutorial project (if it is not already open).
2. Select all six lines containing the word frog.
3. Select Tools|Run Command.
4. In the Run field, enter the command sort (on Windows) or sort -n (on Linux).
5. Note that the Pass selection as input and Insert output options are selected automatically. If one or
Use the grep command line utility to filter lines of text. Use grep to filter out all but the red frogs from the
list.
This tutorial assumes the grep utility is installed on your system and is in your system's PATH. Grep is a
Linux utility that searches for text and characters in files. Windows operating system users may not have a
grep installation. There are a number of free versions available on the Web. Search using the keywords
grep for Windows.
1. Open play.txt from the Run Command tutorial project (if it is not already open).
2. Select the "5 red frogs" and "6 green frogs" lines.
3. Select Tools|Run Command.
4. In the Run field, enter the command grep red.
5. Click Run to remove all but the red frogs.
For example, the Run Command Tutorial project includes a Command to echo "Hello World".
Consider adding commands to your projects to run make or other command line tools. There are two ways to
add commands to a project:
To open this dialog box, right click on any saved command and select Properties.
correctly.
Click the arrow button to the right of the Run field to view a list of Run Command shortcuts.
1. In the Projects sidebar, double-click the file play.txt to open it for editing.
2. Select Tools|Run Command.
3. In the Run field, enter the command:
echo "%F"
4. Click Run.
To open a current HTML file in a Web browser, combine %F with the %(browser) shortcut.
3. Click the arrow to the right the Run field to display the shortcuts drop-down list. Select %browser,
press the space bar, and then select %F. Enclose the %F in double quotation marks. On Mac OS X,
you wil have to add 'open' at the beginning of the command if Safari is your default browser.
4. From the Run in drop-down menu, select No Console (GUI Application).
5. Click Run.
Now that you have searched for a word or selection in Google, try the following shortcut to search for PHP
methods.
1. Open index.html.
2. Select the text mysql_info methods in the file.
3. Select Tools|Run Command.
4. In the Run field, enter the command "%(browser)
http://www.php.net/manual-lookup.php?pattern=%S".
5. Select the Add to Toolbox check box to save this command.
6. Click Run to search mysql_info methods in PHP's online manual.
These two commands are built into Komodo. If the default key binding scheme is in effect, 'Ctrl'+'F1'
('Meta'+'Ctrl'+'/' on Mac OS X) starts a Google search for the current selection. 'Shift'+'F1' ('Meta'+'/' on OS
X) in a Perl, Python or PHP file starts a help search appropriate for that language. Customize searches in the
Preferences dialog box (Edit|Preferences|Language Help).
This example assumes a perl interpreter is configured on your system. If a perl interpreter is not configured
(the required file is perl.exe), an error message displays at the top of the Command Output tab.
Alternatively, run the command dir (Windows) or ls (Linux) to display a list of files and folders beneath
The %(ask) and %(askpass) shortcuts always prompts the user for data. Other shortcuts can use the
orask modifier to prompt the user if no valid value could be determined.
Windows users should enclose all Komodo shortcuts (with the exception of %(browser)) in double
quotation marks. This is necessary to ensure that any spaces in filenames or file paths are interpreted
correctly.
%(ask[:NAME:[DEFAULT]])
%(askpass[:NAME:[DEFAULT]])
where NAME is an optional name to use when prompting in the dialog box and DEFAULT is an optional
default value to place in the dialog box.
For example:
4. Enter your favorite number and click OK to finish running the command.
Refine this shortcut by adding a more meaningful name than "Value 0" and a more appropriate default value.
4. If your favorite number does not happen to be 42, enter a different number and click OK to finish
running the command.
%(SHORTCUT:orask[:NAME])
where NAME is an optional name to use when prompting in the dialog box.
In the previous step we created a shortcut to search for the selected word on Google with the command:
%(browser) http://www.google.com/search?q="%W"
However, if nothing has been selected and there is no word under the cursor, the command fails. In this case,
it would be better if the command prompted you for a search term.
Komodo Tip: Use the Komodo Rx Toolkit to build, edit, or test regular expressions. New to regular
expressions? The Regular Expressions Primer is a tutorial for those wanting to learn more about regex
syntax.
Named groups in Python regular expressions (e.g. (?P<name>pattern) ) can be used to sort match data.
The names 'file', 'line', 'column' and 'content' can be used as column titles in Parsed Ouptut mode, with the
matching text displayed in the columns under the names.
For example, the output of the "Find in Files" example below contains the following:
<file>:<line>:<content>
An regular expression to match the important elements of this line could be:
(.+?):(\d+):(.*)
However, to view this information as a useful list, we need to define the column headings by naming the
groups:
(?P<file>.+?):(?P<line>\d+):(?P<content>.*)
When parsing the run command output, Komodo determines that hello.pl is the file, 5 is the line and
print "Hello, frogs!\n"; is the content, and displays the output sorted into the appropriate
columns:
Parts of the output that match outside the named groups in the regular expression (e.g. the ":" delimiters seen
above) are visible when viewed as raw output, but are hidden when viewed as a list. You can use this
technique to filter out extraneous information when viewing output as a list.
For example, if you were not interested in viewing the line number of the match, you could change the regular
expression to the following:
(?P<file>.+?):\d+:(?P<content>.*)
Komodo can use the information from the 'file' and 'line' groups to open a file in an editor tab at a particular
line (see below).
Note that findstr is a Windows command line utility that searches for strings in files.
5. Select the Add to Toolbox check box to save this command.
6. In the Start in field, enter:
%(ask:Start Directory:%D)
(When the command is run, Komodo should prompt for the "Start Directory" using the directory of
the current file, or %D as the default value).
7. Select the Parse output with check box and enter:
^(?P<file>.+?):(?P<line>\d+):(?P<content>.*)$
as the regular expression with which to parse.
8. Select the Show parsed output as a list check box.
9. Click Run. The Interpolation Query dialog box is displayed.
10. Click OK to run findstr. A list of all occurrences of "frogs" in the files of the Run Command tutorial
project is displayed on the Command Output tab.
13. Alternatively, double-click on lines in the raw output view to jump to that file and line.
Windows
Note: Older versions of Komodo on Windows installed in a directory which included the version number (e.g.
"ActiveState Komodo IDE 4.2"), which allowed for side-by-side installations of different versions of
Komodo. If you wish to do this, manually specify an install directory with a version number.
Linux
/opt/Komodo-[IDE|Edit]-<version>/
OS X
Windows Vista
C:\Users\<user>\AppData\Roaming\ActiveState\Komodo[IDE|Edit]\<version>
Linux
/home/<user>/.komodo[ide|edit]/<version>
Mac OS X
/Users/<user>/Library/Application Data/Komodo[IDE|Edit]/<version>
The location of this directory can be overridden using the KOMODO_USERDATADIR environment variable.
Komodo needs a license to become functional. If you have a Beta release, we include a trial license
with the package. If you have a final release (non-Beta), you can download a license from
ActiveState.
Do you have Norton Anti-Virus (NAV) installed, or more specifically, the File System Realtime
Protection feature enabled?
The problematic relationship between Komodo and Norton Anti-Virus' File System Realtime
Protection feature is a known issue, which we are working to remedy. In the meantime, you can
disable NAV Corp 7.5 FSRP before running Komodo, and then re-enable it after Komodo starts.
If none of these seem to apply to you, please follow the instructions in this FAQ entry to log a bug in
Komodo's bug database.
To view the Left Pane, click the Show/Hide Left Pane button on the toolbar, use the options on the View
menu, or use the associated key binding.
To view the Bottom Pane, click the Show/Hide Bottom Pane button on the toolbar, use the options on the
View menu, or use the associated key binding.
To maximize your Editor Pane, hide the other panes in the Komodo workspace:
1. Click the close arrow button that appears in the top right corner of each of these panes.
3. In the same Debugger Launch Options dialog, enter your command-line arguments. These are sent to
the script and not to the interpreter. Separate the arguments with spaces.
4. Click OK.
Step 1: Ensure the logs are for the time Komodo crashed
Komodo's log files are only for the last time Komodo was run. If you have restarted Komodo since the time it
crashed on you, you must reproduce the crash so that the log files are relevant.
Note: If Komodo is hung (i.e. won't shutdown), you may need to manually stop the komodo-bin process:
Windows
Press 'Ctrl'+'Shift'+'Esc' to open "Windows Task Manager". Select the "Processes" tab.
Right-click on the "komodo.exe" entry and select "End Process".
Mac OS X
Right-click (or 'Option'+click) on the Komodo head icon in the Dock and select the "Force Quit"
option.
Linux
At the terminal run ps ux | grep komodo-bin to determine the Komodo process id (or "pid").
Then run kill -9 PID where "PID" is the process id from the previous command.
Komodo stores its log files in the host data subdirectory of the user data directory.
54.10 How can I add command-line arguments to myprogram for debugging? 340
Komodo User Guide
3. Create a bug describing what happened just before the crash in the Komodo or OpenKomodo bug
database. (If you do not already have an ASPN or ActiveState bug database account, you can open
one by selecting "New Account".)
4. Once the bug has been created, add the error log files by selecting Create in the Attachments and
Dependencies section of the bug report.
Another sizable component of Komodo is language support. Komodo is so tightly integrated with Perl,
Python, Ruby and PHP that it is necessary to include components of those languages, at specific version
levels, for debugger and editor support.
1. xdebug: in the command or shell window, enter php -m. "xdebug" should be listed under Zend
Modules (and not under PHP Modules). If this is not the case, your configuration is incorrect. See
"Common PHP Configuration Problems" below.
2. Syntax Checking: in Komodo, select Edit|Preferences. Click on Smart Editing, and ensure that
"Enable background syntax checking" is checked. Open a PHP file and enter something that is
syntactically incorrect, such as:
<?
asdf
echo test;
?>
Komodo should display a red squiggly line under echo test;. If it does not, it indicates that
Komodo is not able to communicate with the PHP interpreter.
3. Debug: if steps one and two were successful, ensure that the debugger is functioning by opening a
PHP program and debugging it. Ensure that the correct Preferences are configured for PHP.
If any of the steps above were unsuccessful, proceed to the next section.
Multiple PHP executables on one machine: in Komodo's Preferences, explicitly specify the PHP
interpreter configured in your php.ini file. The location of the php.ini file can also be explicitly set.
Verify the PHP version: PHP 4.0.5 or greater is required for PHP syntax checking. PHP 4.3.11 or
greater is required to debug PHP programs.
Verify Xdebug library specification: The location of xdebug.dll (Windows) or xdebug.so (Linux)
must be defined the php.ini file, for example:
Windows: zend_extension_ts=C:\php-4.3.7\extensions\php_xdebug.dll
Linux: zend_extension=/php-4.3.7/extensions/php_xdebug.dll
Ensure that the Xdebug extension is configured correctly in the php.ini file as per the Remote PHP
Debugging instructions.
Windows 2000 upgrade: if you upgraded to Windows 2000 from an earlier version of Windows,
check the value of the "COMSPEC" variable in the "System variables" (as described above). It should
point to C:\WINNT\system32\cmd.exe, and not command.com. If you must change the
variable, reboot your system.
There are known issues regarding the installation of PHP on Windows Millennium systems; please
refer to the PHP site for installation information.
Warning
xdebug: Unable to initialize module
Module compiled with debug=0, thread-safety=1 module API=20001222
PHP compiled with debug=0, thread-safety=1 module API=20001222
These options need to match
... download an updated version of xdebug.dll (Windows) or xdebug.so (Linux) from the
Xdebug.org site.
It is easier to debug sessions using remote debugging. Run the script under a web server and start the
debugging session from a web browser. Komodo intercepts the session and debugs it. All session data is
available and modifiable through the Variable tabs.
You can work around this problem with the following code which disables Psyco while debugging:
import logging
if not logging.Logger.manager.loggerDict.has_key('dbgp'):
import psyco
psyco.full()
If you have configured your Apache installation to use Virtual Hosting (see
httpd.apache.org/docs/1.3/vhosts/), you can add directives to your VirtualHost sections to specify how
Komodo's PHP debugger extension operates for those hosts. Use the "php_admin_value" to set specific
debugger settings for that virtual host. Here is an example:
NameVirtualHost *
<VirtualHost *>
php_admin_value xdebug.enabled 0
DocumentRoot "/Apache/htdocs/"
ErrorLog logs/www.error.log
Servername www.yourdomain.com
</VirtualHost>
<VirtualHost *>
php_admin_value xdebug.enabled 1
DocumentRoot "/Apache/htdocs/"
ErrorLog logs/debug.error.log
Servername debug.yourdomain.com
</VirtualHost>
This will enable debugging under debug.yourdomain.com, but not under www.yourdomain.com. You can
additionally configure the Virtual Host to use a specific machine for remote debugging:
<VirtualHost *>
php_admin_value xdebug.enabled 1
php_admin_value xdebug.host komodo.yourdomain.com
DocumentRoot "/Apache/htdocs/"
ErrorLog logs/debug.error.log
Servername debug.yourdomain.com
</VirtualHost>
54.16 Why don't breakpoints work when I use the Psyco extension in Python? 343
Komodo User Guide
For more information on configuring Virtual Hosting under Apache, see the Apache documentation at
httpd.apache.org/docs/.
To run your compilation of PHP under Komodo with CGI emulation, you have to add a CGI environment
variable called REDIRECT_STATUS with any value.
Komodo launches a process as part of the background syntax checking that can cause a full screen command
prompt to momentarily appear on some Windows systems. You can make the process invisible by editing the
properties for the command prompt window. On the Windows Start menu, right-click the Command Prompt
item, and select Properties. Select the Options tab, and change the Display options to Window.
Alternatively, the %(ask:...) interpolation shortcut could be populated with defaults or replaced with
static values:
CVS requires a real terminal for adding change descriptions. Be sure to set Run in: New Console in the
command's properties.
Komodo ships with a 32-bit version of ruby-debug-base, which will not work with 64-bit versions of Ruby.
To fix this:
Komodo will automatically find and use the new version of the debugging library.
54.22 My screen goes black for a second or two whenever Iopen files for which Komodo performs
345
backgrou
55 Key Binding Schemes
The following pages list the key bindings for Komodo's default keybinding schemes:
To view the current list of key bindings for your Komodo installation, including any custom key bindings,
select Help|List Key Bindings. The default key binding scheme is set according to your platform. To select a
different key binding scheme, select Edit|Preferences|Editor|Keybindings.
To duplicate your current keybindings on a new system, copy the desired .kkf to the corresponding schemes
directory on the target system, then start (or restart) Komodo on that system. The copied scheme will be
available for selection in the key binding preferences.
56.1.4 Editor
Back Shift+Backspace
Backspace Backspace
Beginning of Line (first char/first column) Home
Cancel AutoComplete Escape
Ctrl+C
Copy
Ctrl+Insert
Ctrl+X
Cut Shift+Delete
Ctrl+Shift+X
Delete Delete
Delete Word Left Ctrl+Backspace
Delete Word Right Ctrl+Delete
End of Line End
Go to End of Document Ctrl+End
Go to End of word Ctrl+E
Go to Line... Ctrl+G
Go to Next Bookmark F2
Go to Next Line Down
Go to Previous Bookmark Shift+F2
Go to Previous Line Up
Go to Top of Document Ctrl+Home
Insert Newline Return
Insert Newline (align with current line) Ctrl+Shift+Return
Insert Newline (continue comments) Shift+Return
Insert Newline (no favors) Ctrl+Return
Insert Next Key as Literal Character Ctrl+M
Join current and next lines Ctrl+K, Ctrl+J
Move Back Part of Word Alt+Right
Move Forward Part of Word Alt+Left
Move Left One Character Left
Move One Character Right Right
Move One Word Left Ctrl+Left
Move One Word Right Ctrl+Right
Page Down Page_Down
Page Up Page_Up
Ctrl+V
Paste
Shift+Insert
Paste and Select Ctrl+Shift+V
Redo Ctrl+Y
Reflow paragraph(s) Ctrl+Q
Remove All Bookmarks Ctrl+Shift+F2
Repeat next keystroke N times Ctrl+K, Ctrl+U
Scroll One Line Down Ctrl+Down
Scroll One Line Up Ctrl+Up
Select All Ctrl+A
Select Next Character Shift+Right
Select Next Part of Word Alt+Shift+Right
Select Next Word Ctrl+Shift+Right
Select Page Down Shift+Page_Down
Select Page Up Shift+Page_Up
Select Previous Character Shift+Left
Select Previous Part of Word Alt+Shift+Left
Select Previous Word Ctrl+Shift+Left
Select to Beginning of Line (first char/first column) Shift+Home
Select to Beginning of word Ctrl+Shift+W
Select to End of Document Ctrl+Shift+End
Select to End of Line Shift+End
Select to Next Line Shift+Down
Select to Previous Line Shift+Up
Select to Top of Document Ctrl+Shift+Home
Toggle Bookmark Ctrl+F2
Toggle Overtype/Insert Mode Insert
Transpose Current and Previous Characters Ctrl+T
Trigger preceding autocomplete list or calltip Ctrl+J
Undo Ctrl+Z
Zoom Font Size Down Ctrl+Shift+-
Ctrl+Shift+=
Zoom Font Size Up
Ctrl+Shift++
56.1.5 Find
Find Next F3
Find Next Result Ctrl+Shift+F3
Find Next Selected Ctrl+F3
Find Previous Shift+F3
Find in Files... Ctrl+Shift+F
Find... Ctrl+F
Incremental Search Ctrl+I
Incremental Search Backwards Ctrl+Shift+I
Replace... Ctrl+H
56.1.6 General
Ctrl+W
Close Window
Ctrl+F4
Edit Properties Alt+Return
Least Recently Viewed File Ctrl+Shift+F6
Most Recently Viewed File Ctrl+F6
New File (default type) Ctrl+Shift+N
New File... Ctrl+N
Next File Ctrl+Page_Down
Open File... Ctrl+O
Open Project... Ctrl+Shift+J
Previous File Ctrl+Page_Up
Refresh Status Ctrl+K, R
Save Ctrl+S
Save All Ctrl+Shift+S
56.1.7 Help
Note: The "Meta" key referred to in the following list may be better known to Mac OS X users as the
"Command" key.
57.1 OS X Scheme
57.1.1 Code Browser
Back Shift+Backspace
Backspace Backspace
Beginning of Line (first char/first column) Meta+Left
Home
Cancel autocomplete Escape
Copy Meta+C
Cut Meta+X
Ctrl+Backspace
Cut rest of line
Ctrl+Delete
Delete Delete
Delete Word Left Meta+Backspace
Delete Word Right Meta+Delete
Meta+Right
End of Line
End
Meta+Down
Go to End of Document
Meta+End
Go to End of word Meta+E
Go to Line... Meta+L
Go to Next Bookmark F2
Go to Next Line Down
Go to Previous Bookmark Shift+F2
Go to Previous Line Up
Meta+Up
Go to Top of Document
Meta+Home
Insert Newline Return
Insert Newline (align with current line) Meta+Shift+Return
Insert Newline (continue comments) Shift+Return
Insert Newline (no favors) Meta+Return
Insert Next Key as Literal Character Meta+M
Join current and next lines Ctrl+K, Ctrl+J
Move Back Part of Word Meta+Alt+Right
Move Forward Part of Word Meta+Alt+Left
Move Left One Character Left
Move One Character Right Right
Move One Word Left Alt+Left
Move One Word Right Alt+Right
Page Down Page_Down
Page Up Page_Up
Paste Meta+V
57.1.7 Help
Back Shift+Backspace
Backspace Backspace
Ctrl+Z
Scroll One Line Up
Ctrl+Up
Scroll current line to center of screen Ctrl+L
Scroll current line to top of screen Ctrl+X, !
Select Next Character Shift+Right
Select Next Part of Word Alt+Shift+Right
Select Next Word Ctrl+Shift+Right
Select Page Down Shift+Page_Down
Select Page Up Shift+Page_Up
Select Previous Character Shift+Left
Select Previous Part of Word Alt+Shift+Left
Select Previous Word Ctrl+Shift+Left
Select to Beginning of Line (always first column) Ctrl+Shift+A
Select to Beginning of Line (first char/first column) Shift+Home
Select to Beginning of word Ctrl+Shift+W
Shift+End
Select to End of Line
Ctrl+Shift+E
Select to Next Line Shift+Down
Select to Previous Line Shift+Up
Select to Top of Document Ctrl+Shift+Home
Set Mark Ctrl+Space
Alt+Ctrl+O
Split Line
Escape, Ctrl+O
Toggle Bookmark Ctrl+F2
Toggle Overtype/Insert Mode Insert
Transpose Current and Previous Characters Ctrl+T
Transpose Current and Previous Lines Ctrl+L
Ctrl+/
Undo
Ctrl+X, U
Zoom Font Size Down Ctrl+Shift+-
Ctrl+Shift+=
Zoom Font Size Up
Ctrl+Shift++
58.1.5 Find
Find Next F3
Find Next Result Ctrl+Shift+F3
Ctrl+X, )
End Recording
Ctrl+X, )
Ctrl+X, M
Execute Last Macro
Ctrl+X, e
Ctrl+X, (
Start/Resume Recording
Ctrl+X, (
Ctrl+C, #
Comment Region Ctrl+C, c
Ctrl+3
Complete Word (backwards) Ctrl+Shift+Space
Find All Functions Ctrl+F8
Find Next Function F8
Find Previous Function Shift+F8
Go to Definition Escape, .
Jump to Matching Brace Ctrl+]
Select to Matching Brace Ctrl+M
Ctrl+C, u
Un-comment Region Ctrl+Shift+3
Ctrl+2
58.1.10 Source Control
Ctrl+Shift+7
Show/Hide End of Lines
Ctrl+7
Show/Hide Output Pane Ctrl+Shift+O
Show/Hide Projects Sidebar Ctrl+Shift+P
Show/Hide Toolbar Button Text Ctrl+Shift+B
Show/Hide Toolbox Sidebar Ctrl+Shift+T
Ctrl+Shift+8
Show/Hide Whitespace
Ctrl+8
Split view of tab Ctrl+X, 5, 2
View Source Ctrl+C, Ctrl+S
Ctrl+Shift+5
View/Hide Indentation Guides
Ctrl+5
Ctrl+Shift+4
View/Hide Line Numbers
Ctrl+4
Ctrl+Shift+9
Word-wrap long lines
Ctrl+9
59.1 Vi Emulation
Komodo emulates the following Vi modes:
When you open a file in Komodo with the Vi scheme enabled, you start off in command mode.
Keystrokes in this mode control movement, deletion, cutting, pasting and other standard editing
commands that are generally mapped to Ctrl and Alt key combinations in other schemes.
Input: entering text.
Hitting an "input" command key in Normal mode (i.e. 'i' to insert, 'a' to append, or 'o' to open a new
line and insert) puts the editor into Input mode. Keystrokes in this mode enter text. Use the 'Esc' key
to exit into Normal mode.
Visual: visual selection of text with navigation keystrokes.
Similar to Vim's visual modes. Entering 'v' enables selection by character, 'V' enables linewise
selection, and 'Ctrl'+'v' enables blockwise selection. Navigation keystrokes within these modes
expand and contract the selection area. Use the 'Esc' key to exit into Normal mode.
Command-line: running vi/ex commands.
In Normal mode, entering ':' opens a text box in the status bar at the bottom of the Komodo window
for entering Vi commands. The following Vi and Vim commands have been implemented in the
default Vi scheme:
edit
exit
help
next
previous
quit
set
splitview
undo
write
wq
xit
number <line number>
<range>s/<search string>/<substitution>/[g|i|I]
Command-line arguments can be passed to Macros using the koIViCommandDetail XPCOM service.
The IDL for this service is:
59.2 Vi Scheme
The default Vi scheme is based on the Default scheme (which varies slightly between platforms) and includes
all Default keybindings which do not conflict with those used in Vi emulation. To view the list of key
bindings for your current scheme, select Help|List Key Bindings. The following are key bindings which are
unique to the Vi scheme.
|
Vi: Move to Beginning of the Current Line
0
Vi: Move to Beginning of the Previous Line -
59.2.2 Code Browser
Back Shift+Backspace
Backspace Backspace
Beginning of Line (first visible char/first column) Home
Cancel AutoComplete Escape
Ctrl+W
Close Current Buffer
Ctrl+F4
Ctrl+C
Copy
Ctrl+Insert
Ctrl+X
Cut Shift+Delete
Ctrl+Shift+X
Delete Delete
Delete Word Left Ctrl+Backspace
Delete Word Right Ctrl+Delete
End of Line End
Go to End of Document Ctrl+End
Go to End of word Ctrl+E
Go to Line... Ctrl+G
Go to Next Bookmark F2
Go to Next Line Down
Go to Previous Bookmark Shift+F2
Go to Previous Line Up
Go to Top of Document Ctrl+Home
Insert Abbreviation Snippet by Name Ctrl+T
Insert Newline Return
Insert Newline (align with current line) Ctrl+Shift+Return
Insert Newline (continue comments) Shift+Return
Insert Newline (no favors) Ctrl+Return
Insert Next Key as Literal Character Ctrl+M
Join current and next lines Ctrl+K, Ctrl+J
Move Back Part of Word Alt+Right
Move Forward Part of Word Alt+Left
Move Left One Character Left
Move One Character Right Right
Move One Word Left Ctrl+Left
Move One Word Right Ctrl+Right
Page Down Page_Down
Page Up Page_Up
Ctrl+V
Paste
Shift+Insert
Paste and Select Ctrl+Shift+V
Redo Ctrl+Y
Reflow paragraph(s) Ctrl+Q
Remove All Bookmarks Ctrl+Shift+F2
A simple catalog for this XML dialect would look like this:
<?xml version='1.0'?>
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"
prefer="public">
</catalog>
If your documents use the DOCTYPE declaration, you can add support for that in the catalog by using the
public and system identifier. For example, XUL uses DOCTYPE declarations like this one:
Komodo's catalog for XUL uses publicId and systemId in addition to uri for the mapping.
<?xml version='1.0'?>
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="public">
</catalog>
http://www.oasis-open.org/committees/entity/spec.html
Examples of XML catalog files can be found in the Komodo installation under:
<komodo-install-directory>\lib\support\catalogs (Windows)
/Applications/Komodo.app/Contents/SharedSupport/catalogs/ (OS X)
<komodo-install-directory>/lib/support/catalogs (Linux)
61.1 Introduction
Komodo includes a general-purpose lexer engine that loads a description resource, and walks it while lexing
the buffer. It currently allows for up to five sub-languages, each of which is expected to be a member of a
pre-defined family ("markup", "style", "client-side scripting language", "server-side scripting language", and
"template language"). The format of these resource files is low-level and intended to be fast to parse, so we
have provided a programming language that is intended to allow users to build lexers for their own
programming languages.
Currently these lexers allow for six-bit colorizing, meaning that both errors and warnings can be highlighted
in the buffer. The lexer description language allows for:
Luddite consists of a set of declarations, most of which can appear in any order, except for the initial "family"
declaration. This is because some declarations are family-specific, and bind to the prevailing family
declaration.
61.2.1 A Sample
The php-mainlex.udl file defines the PHP lexer. It is a useful example as it uses one of each of the language
families: markup (HTML), css (CSS), client-side (JavaScript), and server-side (PHP). It includes transitions
from HTML to JavaScript, CSS, and PHP, followed by transitions back to HTML from each of these
languages, and finally the main language modules.
language PHP
include "html2js.udl"
include "html2css.udl"
include "html2php.udl"
include "css2html.udl"
include "js2html.udl"
include "php2html.udl"
include "html.udl"
include "csslex.udl"
include "jslex.udl"
include "phplex.udl"
Working from the bottom of the list towards the top, we have four core files that contain code to describe how
to lex each language on it's own. Above those are files that explain how to transition from one language to
another (e.g. "php2html.udl"). As rules are attempted in the order they're first presented, we normally need to
test transition rules before we attempt internal rules, which is why the core modules appear at the bottom.
The Luddite compiler allows lists to be entered with minimal punctuation (i.e without quotes around strings,
or commas between entries). However, the following words should always be quoted when declared as strings
as they are reserved words in Luddite:
61.4 Families
Most lexer components need to declare which language family they belong to: markup, css, csl (client-side
language), ssl (server-side language - usually JavaScript ), or tpl (template language). This last language is
usually used by the server-side processor that has to determine which code is markup to be output "as is", and
which is server-side code to be executed (e.g. PHP's Smarty and Perl's Template Toolkit).
All directives in a file belong to the most recent family directive. When a new file is included, it starts off in
the family at the point of inclusion. If a new family is specified, when the include-file is processed, Luddite
pops to using the family that was current when the include began.
There are currently three domains that are family-specific: keywords, named patterns, and look-back tests,
which are used to disambiguate.
Example:
family csl
61.5 Styles
For each family, we currently need to specify the style from scintilla.iface that the family will use.
Example:
start_style CSL_DEFAULT
end_style CSL_REGEX
61.6 Keywords
Most sub-languages have a set of keywords that we want to color differently from identifiers. You specify
them using keywords, supplying a list of names and strings, which may be comma-separated, as in this code
for JavaScript:
The string "include" is quoted because it is a Luddite keyword. Commas are optional, and comments can be
added at the end of a line inside a list.
You must generally specify a different list of keywords for each family, however it is possible to define some
languages without keywords (e.g. HTML).
Tell Luddite when to color a range of text as a keyword with the keyword_style directive. For example:
To prevent the color for an identifer from being converted into a keyword, use the no_keyword command.
Patterns for a particular language tend to be repetitive. To make it easier to use them, Luddite supports
family-based pattern variables, which are interpolated into pattern expressions. These are the four pattern
variables used in the JavaScript lexer:
family css
Pattern variables can nest within one another. You need to keep track of which variables define a character
set, and which ones are intended to be used inside a character set.
initial IN_M_DEFAULT
The first statement means that we should start lexing at the state we call "IN_M_DEFAULT". Subsequent
initial statements are ignored, without warning messages.
state IN_M_DEFAULT:
'<?' : paint(upto, M_DEFAULT), => IN_M_PI_1
'<[CDATA[' : paint(upto, M_DEFAULT), => IN_M_CDATA
'<!--' : paint(upto, M_DEFAULT), => IN_M_COMMENT
When we're in the state we call "IN_M_DEFAULT" (Luddite turns this into an arbitrary number to be used by
Scintilla), if we match any of the above strings, we first will have Scintilla color (or "paint") everything up to
the current starting position the SCE_UDL_M_DEFAULT color (remember, the prefix is implicit), and then
change to the state named to the right of the "=>". The comma before "=>" is optional, but advisable in more
complex rules.
The match strings may use double-quotes instead of single-quoted. Simple C-like backslash-escaping is used,
such as ' and ", but not hex or octal escapes.
The "include" directive for the paint command paints from the last paint-point, to the position we end at.
Recall that paint(upto,[color]) stops at the position we were at when we attempted to match the
string.
One of the advantages of this approach over a standard regular expression based set of rules, specifying the
start and end delimiters, is that Luddite is geared to building editor lexers. When people are using lexers they
often are typing at the end of the file. For example, if I was typing this code:
1. Perl-like (?=...) lookahead test in a regular expression, which will match but won't advance the
cursor into that text.
2. The redo command. In the following example, we modify our rules for recognizing processing
instructions in HTML. If the "<?" is followed immediately by "php", and then by a non-name
character, we want to transition to the server-side family, which presumably implements a PHP lexer.
In the HTML lexer, we rewrite the state blocks for PIs as follows:
state IN_M_PI_1:
/./ : redo, => IN_M_PI_2
state IN_M_PI_2:
'?>' : paint(include, M_PI) => IN_M_DEFAULT
Wait a minute, you say. That does just the same thing, and less efficiently than when there was just the one
state. In fact, all state IN_M_PI_1 does is a so-called epsilon transition to state IN_M_PI_2 ("epsilon"
transitions don't consume input).
Go back to that sample at the beginning of this document. Notice that the "html2php.udl" file is included
before "html.udl". This file is short, and is reproduced here without comments:
family markup
state IN_M_PI_1:
/php\b/ : paint(upto, M_OPERATOR), paint(include, M_TAGNAME), \
=> IN_SSL_DEFAULT
Because "html2php.udl" is processed before "html.udl", its pattern will be attempted earlier. If the lexer finds
"php" followed by a word boundary, it will then paint the leading "<?" as a markup operator, paint the "php"
as a markup tagname, and then switch to the default state in the server-side language family.
If you write a Luddite program that ends up where two states do epsilon transitions to one another, the lexer
engine will detect this. More precisely, if it notices that it has carried out 1000 consecutive epsilon transitions,
it will move on to the next character. This shows up in Komodo as the rest of the buffer highlighted in a single
color (remember the implicit end-of-buffer coloring).
state IN_CSL_DEFAULT:
# ...
# Swallow to end-of-line
/\/\/.*/ : paint(upto, CSL_DEFAULT), paint(include, CSL_COMMENT)
If no target state is specified, the lexer will stay in the current state.
In most Smarty files, you transition from HTML to Smarty on "{", and transition back on "}". But if you find
an open-brace while processing Smarty code, you should allow for a matching "}".
In RHTML, the delimiters "<%=" and "%>" are used to transition from HTML into a Ruby expression, and
back. These delimiters can occur in many different parts of HTML files, including attribute strings and
content. The lexer needs to be told which state to return to when it finishes processing the Ruby expression.
In Ruby proper, you can interpolate arbitrary amounts of Ruby code inside double-quoted strings between
"#{" and "}". By pushing a state when you find "#{" in a Ruby string, you can allow for multiple nested pairs
of braces in the expression, and return to the string when the matching "}" is reached.
The Luddite code for expressing this is simple. Let's look at how it's expressed for double-quoted strings in
Ruby:
state IN_SSL_DEFAULT:
#...
'"' : paint(upto, SSL_DEFAULT), => IN_SSL_DSTRING
#... Note the redo here for things that could be operators
/[$OP]/ : paint(upto, SSL_DEFAULT), redo, => IN_SSL_OP1
#...
state IN_SSL_DSTRING:
'#{' : paint(include, SSL_STRING), spush_check(IN_SSL_DSTRING), \
=> IN_SSL_DEFAULT
...
state IN_SSL_OP1:
'{' : paint(include, SSL_OPERATOR), spush_check(IN_SSL_DEFAULT) \
=> IN_SSL_DEFAULT
'}' : paint(upto, SSL_DEFAULT), paint(include, SSL_OPERATOR), \
spop_check, => IN_SSL_DEFAULT
# ...
When we find "#{" while processing a double-quoted string, we push the state we want to return to
(IN_SSL_DSTRING), and transition to the default Ruby state (IN_SSL_DEFAULT), where we lex an
expression.
If we find an open-brace while looking for operators, we again push the default state on the stack.
To handle a close-brace, we carry out a "spop_check" test. If there's something on the stack, we pop it and
transition to the state it specified. Otherwise, we transition to the specified state. If users never made mistakes,
you would never need to specify a target state in a directive containing an "spop" command. But because
people are capable of typing things like:
cmd {
yield
}
The simplest way to express this in Luddite is to put an at_eol command in the transition into that state.
When the lexer reaches the end of that line, it will automatically transition into the specified state. For
example, the Luddite code to express this for the above Mason example is here:
state IN_M_DEFAULT:
/^%/ : paint(upto, M_DEFAULT), paint(include, TPL_OPERATOR), \
at_eol(IN_M_DEFAULT), => IN_SSL_DEFAULT
1. Targeting an "opposite" delimiter, so that one of the four characters "[", "{", "(" or "<" is matched by
its closing character "]", "}", ")", or ">" respectively. These pairs are hard-wired into UDL.
2. Targeting any character as the closing delimiter. Alphabetic characters can be targeted. The only
character that cannot be targeted is the "\".
3. Matching a delimiter.
4. Continuing use of a delimiter. For example, to support a construct like Perl's "s,\\,/,g" idiom, set
the target delimiter to ",", match it, and keep it as the target for one more match.
This code shows how the delimiter-oriented keywords are used to work together. We'll walk through support
for Perl's matching statement first:
state IN_SSL_DEFAULT:
# ...
/m([\{\[\(\<])/ : paint(upto, SSL_DEFAULT), \
set_opposite_delimiter(1), => IN_SSL_REGEX1_TARGET
/m([^\w\d])/ : paint(upto, SSL_DEFAULT), \
set_delimiter(1), => IN_SSL_REGEX1_TARGET
# ...
The first transition matches one of the open-bracket characters in a grouped pattern, and sets the target
delimiter to the opposite of the contents of the first pattern group. The opposite_delimiter() routine
requires its input to be one character long, and returns its input if it isn't one of the opening characters. So the
two patterns could be expressed with the one transition:
Handling a construct like Perl's substitution syntax is slightly more complicated because it can use various
delimiters (e.g. s/foo/bar/, s'foo'bar', s#foo#bar#, etc.). Furthermore, if the character after the 's' is an opening
bracket character, the full pattern can use either two pairs of bracketing delimiters, or non-bracketing
delimiters, as in
s[find] {replace}
s<first>/second/
White space is always ignored after the first pair. To encode this in Luddite we need several states:
state IN_SSL_REGEX2_TARGET1_OPPOSITE_2:
/\\./ : #stay
/[$WS]/ : #stay -- assume we're in {...} [ ... ]x
/([\{\[\(\<])/ : paint(upto, SSL_DEFAULT), \
set_opposite_delimiter(1), => IN_SSL_REGEX1_TARGET
/([^\w\d])/ : paint(upto, SSL_DEFAULT), set_delimiter(1), \
=> IN_SSL_REGEX1_TARGET
/\z/ : paint(upto, SSL_DEFAULT)
Matching the second half is similar to matching the delimiter after the 'm'.
The final part is handling constructs like the standard 's/.../.../' language. To do that we tell UDL to
keep the current delimiter for another round of matching:
Often when a construct is bracketed with matching delimiters, the target language is smart enough to ignore
inner matched pairs. For example, if in Ruby you were to write
puts %Q(first(middle)second)
Ruby would write out the string "first(middle)second". To encode this in Luddite use UDL's built-in stack:
state IN_SSL_QSTRING_NESTED2:
/\\./ : #stay
/[\[\{\(\<]/ : spush_check(IN_SSL_QSTRING_NESTED2), \
=> IN_SSL_QSTRING_NESTED2
/[\]\}\)\>]/ : spop_check, => IN_SSL_QSTRING_NESTED
/\z/ : paint(include, SSL_STRING)
Finally, you've probably noticed that we put an end-of-buffer transition in many of these states. Notice that the
final IN_SSL_QSTRING_NESTED2 state actually does no painting in its other matches. Normally Luddite
will look at the colors a state uses to determine how to color the rest of the text if it reaches the end of the
buffer. If more than one color is used, or none is used, the Luddite program should specify a color. Otherwise
it's possible that Komodo will repeatedly invoke the colorizer until something is chosen.
"Here documents" are a convenient way of defining multi-line strings. Typically they start by defining the
"terminating identifier", preceded by an operator like << or <<<. The string starts on the following line, and
ends when we find a line containing only the terminating identifier.
The following Luddite code outlines how to add here-document processing to a language, using PHP as an
example, where we assume a here document always begins with the three less-than characters followed by a
name, then the end of line:
IN_SSL_PRE_HEREDOC_1
state IN_SSL_PRE_HEREDOC_1:
/([$NMSTART][$NMCHAR]*)/ : set_delimiter(1), paint(include, SSL_IDENTIFIER)
/\r?$/ : paint(include, SSL_DEFAULT), => IN_SSL_IN_HEREDOC_1
state IN_SSL_IN_HEREDOC_1:
delimiter : keep_delimiter, paint(upto, SSL_STRING), => IN_SSL_IN_FOUND_HEREDOC_1
/./ : => IN_SSL_IN_HEREDOC_2 # Not this line
state IN_SSL_IN_HEREDOC_2:
/.+/ : #stay
/$/ : => IN_SSL_IN_HEREDOC_1
state IN_SSL_IN_FOUND_HEREDOC_1:
/[\r\n]+/ : clear_delimiter, paint(upto, SSL_IDENTIFIER), => IN_SSL_DEFAULT # Got it!
/./ : => IN_SSL_IN_HEREDOC_2 # The delimiter continues, so keep looking
]]>
In this example the keywords delimiter, keep_delimiter, and clear_delimiter all work
together. After matching the delimiter, we retain it with the keep_delimiter action, and then test to make
sure the delimiter is followed immediately by the end of the line. If it is, we clear it. Otherwise we return to
61.9 Disambiguation
In both Ruby and JavaScript, sometimes a '/' is just a '/', and sometimes it's the start of a regular expression.
Luddite's token_check directive directs this. For example, in JavaScript, to determine if a '/' is the start of a
regex, and not a division operator, you could write a test like this:
state IN_CSL_DEFAULT:
#...
'/' token_check : paint(upto, CSL_DEFAULT), => IN_CSL_REGEX
Note that the "token_check" directive is part of the test, not the action to perform. This states that if we do
match, color everything before the '/' with the default color, and change to the regex state.
What happens during a token_check test depends on the contents of the token_check block specified for
the current family. In a token_check block, you look at the tokens to the left of the current position. Each
token consists of a two-value tuple, containing its colored style, and its text. On each token, we can decide
whether to accept the token (meaning the test passes), reject the token (meaning it fails), or skip the token,
meaning we get the previous token in the buffer, working towards the beginning.
token_check:
CSL_OPERATOR: reject [")", "++", "--", "]", "}", ";"]
You can provide either a list of strings and/or names, or the "all" keyword. Here are the rules on defaults:
Authors writing UDL-based lexers for XML vocabularies can tap into this mechanism by using any
combination of the namespace, public_id, and system_id declarations to specify which language
Komodo should associate with a particular file, regardless of the actual extension of the filename it is saved
by.
For example, XBL (XML Binding Language) contains a combination of XML and JavaScript, and is widely
used for Firefox extensions and Mozilla applications. These files often are saved with names containing
".xml" extensions, but they usually contain the following prologue:
<bindings id="koListboxBindingsNew"
xmlns="http://www.mozilla.org/xbl" ...>
Any combination of the following three declarations in a Luddite file for XBL will be sufficient to direct
Komodo to load the Luddite-based XBL mode instead of the default XML mode:
namespace "http://www.mozilla.org/xbl"
system_id "http://www.mozilla.org/xbl"
Windows: INSTALLDIR\lib\sdk\
Mac OS X: INSTALLDIR/Contents/SharedSupport/sdk/
Linux: INSTALLDIR/lib/sdk/
Simply place the SDK bin directory on your PATH and you should be able to run luddite:
# On Windows
C:\> set PATH=INSTALLDIR\lib\sdk\bin;%PATH%
C:\> set PATHEXT=%PATHEXT%;.py
C:\> luddite help
# On Mac OS X
$ export PATH=INSTALLDIR/Contents/SharedSupport/sdk/bin:$PATH
$ luddite help
# On Linux
$ export PATH=INSTALLDIR/lib/sdk/bin:$PATH
$ luddite help
61.13 Samples
Sample UDL files can be found in the udl subdirectory of the Komodo SDK directory.
61.15 Keywords
The following is a list of Luddite keywords - not to be confused with the keywords described by the UDL file
itself for the target language definition. The Luddite keyword is always given followed by its argument list,
where applicable; optional arguments are given in square brackets ([ ... ]).
all
Used in accept, reject, and skip statements in token_check definitions. This means that the
token_check test will follow whatever directive is associated with this occurrence of all.
at_eol(state-name)
Used to specify the Luddite state to transition to when the end of the current line is reached. This is
useful for processing languages like the Perl-based template language, Mason, in which one can
embed Perl code on a single line by putting a '%' character at the start of the line, as in this example:
Good
% if ($time > 12) {
afternoon
% } else {
morning
% }
This is easily handled with this Luddite code:
state IN_M_DEFAULT:
/^%/ : paint(upto, M_DEFAULT), paint(include, TPL_OPERATOR), \
at_eol(IN_M_DEFAULT), => IN_SSL_DEFAULT
If there's a percent character at the start of a line in markup mode, cause it to be lexed as a template
operator, and switch to Perl lexing (IN_SSL_DEFAULT), and switch back to markup-based lexing
when it reaches the end of the line.
clear_delimiter
Used in conjunction with keep_delimiter, this action explicitly clears the current delimiter (useful in
recognizing terminating identifiers in here documents).
delimiter
Used in place of a pattern or match-string in transitions, this will succeed if there's a current delimiter
defined, and it can be matched at the current point in the buffer. When it's matched, the current
delimiter will be unset, unless the keep_delimiter action is given in the transition.
csl
client-side language (e.g. usually JavaScript)
markup
markup language (e.g. HTML, XHTML, other XML dialects)
ssl
server-side language (e.g. Perl, Python, Ruby)
style
stylesheet language (usually CSS)
tpl
a "template-oriented" language, usually geared to either adding template-side processing to
the server-side language, or making it easier to inject the server-side language into other parts
of the full multi-language document, as in CSS or JS. Examples include Smarty for PHP
processing.
keep_delimiter
Used when the delimiter directive was used in place of a pattern or string, this tells the UDL lexer
to retain that directive for subsequent matching. This is useful for matching a construct like Perl's
s,/,\\, construct, where we would be using ',' as the regex delimiter, instead of the normal '/'.
keywords name-or-string-list
List the words that should be colored as keywords (as opposed to identifiers) in the defined language.
Keywords for the target language that are the same as reserved words in Luddite must be quoted.
include [path/]file
Include a UDL file. The include path starts with the current directory; if you include a file in a
different directory, that file's directory is appended to the include path.
include "html2ruby.udl"
include
When used as an argument to the paint keyword, include a style.
initial state-name
The state processing for the current family should start at.
initial IN_SSL_DEFAULT
language name
The name of the language being defined. The language directive must be given. It may be given more
than once, but only with the same value is given each time. This value shows up in the Komodo UI in
places like Language Preferences and the "New File" command.
language RHTML
no_keyword
The no_keyword command is used to prevent identifier => keyword promotion when an identifier is
recognized. This is useful for programming languages that allow any token, even keywords, to be
used in certain contexts, such as after the "." in Python, Ruby, and VBScript, or after "::" or "->" in
Perl.
state IN_SSL_DEFAULT:
/\.(?=[a-z])/ : paint(upto, SSL_DEFAULT), \
paint(include, SSL_OPERATOR), => IN_SSL_NON_KEYWORD_IDENTIFIER_1
state IN_SSL_NON_KEYWORD_IDENTIFIER_1:
/[^a-zA-Z0-9_]/ : paint(upto, SSL_IDENTIFIER), redo, no_keyword, \
=> IN_SSL_DEFAULT
paint(include|upto, style-name)
These directives are used in state transitions, and are key to the way UDL generates lexers. They
appear in a context like this:
state IN_SSL_COMMENT_1 :
/$/ : paint(include, SSL_COMMENT) => IN_SSL_DEFAULT
This means that when we're in a state with name "IN_SSL_COMMENT_1" (remember that state
names are completely arbitrary in your Luddite programs), and we find the end of the line, we should
paint everything from the last "paint point" to the end of the line with the style
"SCE_UDL_SSL_COMMENT". This will also move the paint-point to the point after the last
character this command styles.
A transition can have a paint(include...) command, a paint(upto...) command, both of them, or neither.
redo
The redo command indicates that the lexer should not advance past the current characters being
matched, but should stay there in the new state.
state IN_SSL_NUMBER_3:
...
/[^\d]/ : paint(upto, SSL_NUMBER), redo, => IN_SSL_DEFAULT
This specifies that when we're processing numbers (assuming the arbitrary name
"IN_SSL_NUMBER_3" reflects the idea that we're trying to recognize numeric terms in the input),
and find a non-digit, we should paint everything up to but not including the start of the matched text
with the SCE_UDL_SSL_NUMBER style, change to the default state for this family, and retry lexing
the same character.
Since having both a redo action and a paint(include...) action in the same transition would
be contradictory, the Luddite compiler gives an error message when it detects this condition and stops
processing.
set_delimiter (number)
This transition action takes a single argument, which must be a reference to a grouped sub-pattern in
the transition's pattern. It sets the current delimiter to that contents of the subpattern.
/m([^\w\d])/ : paint(upto, SSL_DEFAULT), set_delimiter(1), \
=> IN_SSL_REGEX1_TARGET
set_opposite_delimiter (number)
This transition action takes a single argument, which must be a reference to a grouped sub-pattern in
the transition's pattern. It sets the current delimiter to that contents of the subpattern.
/m([\{\[\(\<])/ : paint(upto, SSL_DEFAULT), \
set_opposite_delimiter(1), => IN_SSL_REGEX1_TARGET
sublanguage name
The common name of the language this family targets.
sublanguage ruby
sub_language
Synonym for sublanguage
system_id "http://www.w3.org/2001/XMLSchema"
systemid "http://www.w3.org/1999/XMLSchema"
# "systemid" is a synonym for "system_id"
token_check: token-recognition-list
A set of directives that define the token checking set for this family.
Used in state transitions immediately after a pattern or string (match target) is given. This is used for
token disambiguation. For example in Ruby, Perl, and JavaScript, a '/' can either be a division
operator or the start of a regular expression. By looking at how the previous token was styled, we can
determine how to interpret this character.
If the token_check test fails, the pattern is deemed to fail, and UDL tries subsequent transitions in the
state block.
end_style
The highest style in the list of styles Luddite will use for this family (in terms of the values given in
Scintilla.iface). This is used for token_check processing while lexing, so it's not required otherwise.
upto
See paint
spop_check
See spush_check
spush_check(state-name)
Used to specify the Luddite state to transition to at a later point.
state IN_SSL_DSTRING:
'#{' : paint(include, SSL_STRING), spush_check(IN_SSL_DSTRING), \
=> IN_SSL_DEFAULT
...
state IN_SSL_OP1:
'{' : paint(include, SSL_OPERATOR), spush_check(IN_SSL_DEFAULT) \
=> IN_SSL_DEFAULT
...
state IN_SSL_DEFAULT:
'}' : paint(upto, SSL_DEFAULT), paint(include, SSL_OPERATOR), \
spop_check, => IN_SSL_DEFAULT
This code is used to account for the way the Ruby lexer is intended to color expressions inside #{...}
brackets in strings as if they weren't in strings. When the "}" is reached, the lexer needs to know
whether it should go back to lexing a string, or to the default state. We use the spush_check and
spop_check directives to specify this.
First, we are limited to about 56 styles, as UDL partitions the style byte associated with each character by 6
bits for styles, 1 bit for error squigging, and 1 bit for warnings. Additionally, scintilla reserves styles 32
through 39 for its own use, leaving us with 56.
This reduces the number of available styles for each family down to the basics. This includes the default style
(which should only be used for white-space in most cases), comments, numbers, strings, keywords, identifiers,
operators, and regular expressions. We add a style for variable names for the server-side, and leave
comment-blocks in as well, although their usefulness is in question.
Some of the styles in the markup block reflect terms used in ISO 8859, the SGML standard. These are:
SCE_UDL_M_STAGO
Start-tag-open character, as in "<"
SCE_UDL_M_TAGNAME
61.17 Terms
name-or-string
Either a quoted string, delimited by single- or double-quote characters, with -escape sequences, or a
sequence of characters starting with a letter, followed by zero or more alphanumeric characters,
hyphens, or underscores.
name-or-string-list
List of strings or non-keyword-names surrounded by square brackets. Commas are optional.
state-name
A symbolic name for a UDL state. These names are are completely arbitrary, but we recommend the
convention that they start with "IN_", then contain a sequence that reflects the family they belong to
("SSL", "CSL", "CSS", "TPL", or "M" for "Markup"), and finally a descriptive part.
Example:
IN_TPL_BLOCK_COMMENT_1
style-name
A symbolic name that reflects the style names used in .h files derived from the Scintilla.iface file.
These names all start with the prefix "SCE_UDL_", which may always be omitted.
Example:
SSL_STRING
token-recognition-list
A line-oriented list of directives containing a style-name, a colon, and then an accept, reject, or skip
directive.
transition-list
Zero or more transition, separated by newlines
transition
Consists of a string or pattern to be matched, an optional token_check, ":" (optional), an optional list
of actions (comma-separated), and optionally, an "=>" followed by a style-name. Actions include
paint, redo, spush_check, and spop_check.
61.18 Concepts
1. Order of token_check statements
2. The statements in a token_check directive are followed in order, and are family-specific. The default
action, if no term is chosen, depend on what kinds of statements are specified:
The target state is optional. A transition that contains both a "paint(include...)" and a "redo" directive
would loop indefinitely, so UDL contains a limit of 1000 before it bypasses the current character and
continue with the next one.
ActiveState is a registered trademark of ActiveState Software Inc. Komodo, the Perl Dev Kit, the Tcl Dev
Kit, ActivePerl, ActivePython, ActiveTcl and ASPN are trademarks of ActiveState Software Inc.
All other products mentioned are trademarks or registered trademarks of their respective companies.
Some of the icons in Komodo are used under Creative Commons license from Mark James, and some are the
work of Bright Creative. We are grateful to Mark James and Dave Shea for their great creative work. Some
SCC icons are derived from those in the TortoiseSVN project and used under the TortoiseSVN Icon License.
---------------
1. Definitions.
1.5. "Executable" means Covered Code in any form other than Source
Code.
B. Any new file that contains any part of the Original Code or
previous Modifications.
1.11. "Source Code" means the preferred form of the Covered Code for
making modifications to it, including all modules it contains, plus
any associated interface definition files, scripts used to control
compilation and installation of an Executable, or source code
differential comparisons against either the Original Code or another
well known, available Covered Code of the Contributor's choice. The
Source Code can be in a compressed or archival form, provided the
appropriate decompression or de-archiving software is widely available
for no charge.
3. Distribution Obligations.
(c) Representations.
Contributor represents that, except as disclosed pursuant to
Section 3.4(a) above, Contributor believes that Contributor's
Modifications are Contributor's original creation(s) and/or
Contributor has sufficient rights to grant the rights conveyed by
this License.
7. DISCLAIMER OF WARRANTY.
8. TERMINATION.
8.1. This License and the rights granted hereunder will terminate
automatically if You fail to comply with terms herein and fail to cure
such breach within 30 days of becoming aware of the breach. All
sublicenses to the Covered Code which are properly granted shall
survive any termination of this License. Provisions which, by their
nature, must remain in effect beyond the termination of this License
shall survive.
9. LIMITATION OF LIABILITY.
11. MISCELLANEOUS.
``The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/
Contributor(s): ______________________________________.
Alternatively, the contents of this file may be used under the terms
of the _____ license (the "[___] License"), in which case the
provisions of [______] License are applicable instead of those
above. If you wish to allow use of your version of this file only
under the terms of the [____] License and not to allow others to use
your version of this file under the MPL, indicate your decision by
deleting the provisions above and replace them with the notice and
other provisions required by the [___] License. If you do not delete
the provisions above, a recipient may use your version of this file
under either the MPL or the [___] License."
[NOTE: The text of this Exhibit A may differ slightly from the text of
the notices in the Source Code files of the Original Code. You should
use the text of this Exhibit A rather than the text found in the
Original Code Source Code for Your Modifications.]
AMENDMENTS
VI. Litigation.
Notwithstanding the limitations of Section 11 above, the
provisions regarding litigation in Section 11(a), (b) and (c) of
Contributor(s): ______________________________________.