├── .gitignore ├── LICENSE ├── README.rst ├── build.sbt ├── project ├── build.properties └── plugins.sbt └── src └── sphinx ├── 2.0.x ├── advancedsetup.rst ├── faq.rst ├── features.rst ├── features │ ├── formatting.rst │ ├── navigating.rst │ ├── refactoring.rst │ ├── scalainterpreter.rst │ └── typingviewing.rst ├── gettingstarted.rst ├── images │ ├── advancedsetup-heapstatus-01.png │ ├── advancedsetup-jdtweaving-01.png │ ├── clear_co.gif │ ├── feature-code-completion-01.png │ ├── feature-code-completion-02.png │ ├── feature-formatting-01.png │ ├── feature-formatting-02.png │ ├── feature-hyperlinking-01.png │ ├── feature-inferredsemicolons-01.png │ ├── feature-inferredsemicolons-02.png │ ├── feature-interpreter-01.png │ ├── feature-interpreter-02.png │ ├── feature-interpreter-03.png │ ├── feature-occurences-01.png │ ├── feature-open-type-01.png │ ├── feature-quickfix-import-01.png │ ├── feature-refactoring-extract-local-01.png │ ├── feature-refactoring-extract-local-02.png │ ├── feature-refactoring-extract-method-01.png │ ├── feature-refactoring-inline-local-01.png │ ├── feature-refactoring-organize-import-01.png │ ├── feature-refactoring-rename-01.png │ ├── feature-refactoring-rename-02.png │ ├── feature-structured-selection-01.png │ ├── feature-syntax-highlighting-01.png │ ├── feature-template-01.png │ ├── feature-typing-error-01.png │ ├── frflag.png │ ├── refresh_interpreter.gif │ ├── restart_co.gif │ ├── run_interpreter.gif │ ├── setup-diagnostics-01.png │ ├── show_inferred_semicolons.png │ ├── term_restart.gif │ ├── terminate_co.gif │ ├── testing-junit-01.png │ ├── testing-scalatest-01.png │ ├── testing-specs-01.png │ └── usflag.png ├── index.rst ├── known-issues.rst └── testingframeworks.rst ├── 3.0.x ├── advancedsetup │ ├── images │ │ ├── advancedsetup-heapstatus-01.png │ │ ├── advancedsetup-jdtweaving-01.png │ │ ├── completion.png │ │ ├── content-assist-deactivation.png │ │ └── limit-editors.png │ └── index.rst ├── faq │ ├── images │ │ └── setup-diagnostics-01.png │ ├── index.rst │ └── known-issues.rst ├── features.rst ├── features │ ├── logging │ │ ├── images │ │ │ └── logging-preferences.png │ │ └── index.rst │ ├── navigating │ │ ├── comment-hyperlinking.rst │ │ ├── declaration-hyperlinking.rst │ │ ├── find-occurrences.rst │ │ ├── images │ │ │ ├── feature-hyperlinking-01.png │ │ │ ├── feature-open-type-01.png │ │ │ ├── implicit-hyperlink.png │ │ │ ├── outline-view-1.png │ │ │ ├── outline-view-2.png │ │ │ ├── quick-outline-1.png │ │ │ ├── scala-search-find-occurrences-01.png │ │ │ ├── scala-search-type-hierarchy-01.png │ │ │ ├── tasks-view-1.png │ │ │ └── url-hyperlinking.png │ │ ├── implicit-hyperlinking.rst │ │ ├── index.rst │ │ ├── open-declaration.rst │ │ ├── open-type.rst │ │ ├── outline-view.rst │ │ ├── tasks-view.rst │ │ └── type-hierarchy.rst │ ├── scaladebugger │ │ ├── images │ │ │ ├── detailpane-01.png │ │ │ ├── logicalstructure-01.png │ │ │ ├── logicalstructure-02.png │ │ │ ├── preferences-01.png │ │ │ ├── preferences-02.png │ │ │ ├── remotedebugging-01.png │ │ │ ├── scaladisplay-01.png │ │ │ ├── smartstepping-01.png │ │ │ ├── smartstepping-02.png │ │ │ ├── smartstepping-03.png │ │ │ ├── smartstepping-04.png │ │ │ └── unboxedprimitive-01.png │ │ └── index.rst │ ├── scalainterpreter │ │ ├── images │ │ │ ├── clear_co.gif │ │ │ ├── feature-interpreter-01.png │ │ │ ├── feature-interpreter-02.png │ │ │ ├── feature-interpreter-03.png │ │ │ ├── refresh_interpreter.gif │ │ │ ├── restart_co.gif │ │ │ ├── run_interpreter.gif │ │ │ ├── term_restart.gif │ │ │ └── terminate_co.gif │ │ └── index.rst │ ├── test-finder │ │ ├── images │ │ │ ├── config.png │ │ │ └── right-click.png │ │ └── index.rst │ └── typingviewing │ │ ├── auto-edits.rst │ │ ├── code-completion.rst │ │ ├── code-templates.rst │ │ ├── errors-as-you-type.rst │ │ ├── formatting │ │ ├── images │ │ │ ├── feature-formatting-01.png │ │ │ └── feature-formatting-02.png │ │ └── index.rst │ │ ├── images │ │ ├── example.png │ │ ├── feature-code-completion-01.png │ │ ├── feature-code-completion-02.png │ │ ├── feature-inferredsemicolons-01.png │ │ ├── feature-inferredsemicolons-02.png │ │ ├── feature-occurences-01.png │ │ ├── feature-quickfix-import-01.png │ │ ├── feature-structured-selection-01.png │ │ ├── feature-syntax-highlighting-01.png │ │ ├── feature-template-01.png │ │ ├── feature-typing-error-01.png │ │ ├── inferred-types-01.png │ │ ├── javadoc.png │ │ ├── literals.png │ │ ├── mark-occurrences-toolbar.png │ │ ├── preferences.png │ │ ├── quick-fix.png │ │ ├── show-type-window.png │ │ ├── show-type.png │ │ └── show_inferred_semicolons.png │ │ ├── implicit-highlighting │ │ ├── images │ │ │ ├── hover.png │ │ │ ├── implicit-format.png │ │ │ ├── prefs.png │ │ │ └── quick-fix.png │ │ └── index.rst │ │ ├── index.rst │ │ ├── inferred-hover.rst │ │ ├── javadoc.rst │ │ ├── mark-occurrences.rst │ │ ├── quick-fixes.rst │ │ ├── refactoring │ │ ├── images │ │ │ ├── change-order-before.png │ │ │ ├── change-order-dialog.png │ │ │ ├── change-order-preview.png │ │ │ ├── extract-trait-before.png │ │ │ ├── extract-trait-dialog.png │ │ │ ├── extract-trait-extracted.png │ │ │ ├── extract-trait-preview.png │ │ │ ├── feature-refactoring-extract-local-01.png │ │ │ ├── feature-refactoring-extract-local-02.png │ │ │ ├── feature-refactoring-extract-method-01.png │ │ │ ├── feature-refactoring-inline-local-01.png │ │ │ ├── feature-refactoring-organize-import-01.png │ │ │ ├── feature-refactoring-rename-01.png │ │ │ ├── feature-refactoring-rename-02.png │ │ │ ├── merge-dialog.png │ │ │ ├── merge-not-possible.png │ │ │ ├── merge-preview.png │ │ │ ├── move-class-configuration.png │ │ │ ├── move-class-preview.png │ │ │ ├── move-constructor-before.png │ │ │ ├── move-constructor-preview.png │ │ │ ├── split-before.png │ │ │ ├── split-dialog.png │ │ │ └── split-preview.png │ │ └── index.rst │ │ ├── semantic-highlighting │ │ ├── images │ │ │ ├── example.png │ │ │ └── prefs.png │ │ └── index.rst │ │ ├── show-inferred-semicolons.rst │ │ ├── show-type-of-selection.rst │ │ ├── source-generators │ │ ├── images │ │ │ ├── generate-before.png │ │ │ ├── generate-existing-dialog.png │ │ │ ├── hashcode-and-equals-after.png │ │ │ ├── hashcode-and-equals-dialog.png │ │ │ ├── productN-after.png │ │ │ └── productN-dialog.png │ │ └── index.rst │ │ ├── structured-selection.rst │ │ └── syntax-highlighting.rst ├── gettingstarted │ └── index.rst ├── images │ └── video-coming-soon.jpg ├── index.rst └── testingframeworks │ ├── images │ ├── testing-junit-01.png │ ├── testing-scalatest-01.png │ └── testing-specs-01.png │ └── index.rst ├── 4.0.x ├── advancedsetup │ ├── images │ │ ├── advancedsetup-heapstatus-01.png │ │ ├── advancedsetup-jdtweaving-01.png │ │ ├── closing-presentation-compilers.png │ │ ├── completion.png │ │ ├── content-assist-deactivation.png │ │ └── limit-editors.png │ ├── index.rst │ └── scala-installations.rst ├── faq │ ├── images │ │ └── setup-diagnostics-01.png │ ├── index.rst │ └── known-issues.rst ├── features.rst ├── features │ ├── async-debugger │ │ ├── images │ │ │ ├── async-stack-1.png │ │ │ ├── async-stack-2.png │ │ │ ├── async-stack-3.png │ │ │ ├── async-stack-4.png │ │ │ ├── async-stack-5.png │ │ │ ├── configuration.png │ │ │ ├── dead-letter-1.png │ │ │ ├── dead-letter-2.png │ │ │ ├── program-points.png │ │ │ ├── step-msg-1.png │ │ │ ├── step-msg-2.png │ │ │ ├── step-msg-3.png │ │ │ └── step-msg-4.png │ │ └── index.rst │ ├── logging │ │ ├── images │ │ │ └── logging-preferences.png │ │ └── index.rst │ ├── navigating │ │ ├── comment-hyperlinking.rst │ │ ├── declaration-hyperlinking.rst │ │ ├── images │ │ │ ├── feature-hyperlinking-01.png │ │ │ ├── feature-open-type-01.png │ │ │ ├── implicit-hyperlink.png │ │ │ ├── outline-view-1.png │ │ │ ├── outline-view-2.png │ │ │ ├── quick-outline-1.png │ │ │ ├── tasks-view-1.png │ │ │ └── url-hyperlinking.png │ │ ├── implicit-hyperlinking.rst │ │ ├── index.rst │ │ ├── open-declaration.rst │ │ ├── open-type.rst │ │ ├── outline-view.rst │ │ └── tasks-view.rst │ ├── scalacompiler │ │ ├── images │ │ │ ├── allow-output-folders.PNG │ │ │ ├── set-output-folder.PNG │ │ │ └── uncheck-scopes-compilation.PNG │ │ └── index.rst │ ├── scaladebugger │ │ ├── expression-evaluator.rst │ │ ├── images │ │ │ ├── detailpane-01.png │ │ │ ├── drop-to-frame.png │ │ │ ├── expression-evaluator │ │ │ │ ├── choosing-frames.png │ │ │ │ ├── conditional-menu.png │ │ │ │ ├── conditional-properties.png │ │ │ │ ├── console-and-tree-on-bottom.png │ │ │ │ ├── console-and-tree-on-right.png │ │ │ │ ├── console.png │ │ │ │ ├── context-menu.png │ │ │ │ ├── expression.png │ │ │ │ ├── input-and-tree-on-bottom.png │ │ │ │ ├── input-and-tree-on-right.png │ │ │ │ ├── preferences.png │ │ │ │ └── run-selection-in-ee.png │ │ │ ├── hot-code-replace.png │ │ │ ├── logicalstructure-01.png │ │ │ ├── logicalstructure-02.png │ │ │ ├── preferences-01.png │ │ │ ├── preferences-02.png │ │ │ ├── remotedebugging-01.png │ │ │ ├── scaladisplay-01.png │ │ │ ├── smartstepping-01.png │ │ │ ├── smartstepping-02.png │ │ │ ├── smartstepping-03.png │ │ │ ├── smartstepping-04.png │ │ │ ├── step-filters.png │ │ │ └── unboxedprimitive-01.png │ │ └── index.rst │ ├── scalainterpreter │ │ ├── images │ │ │ ├── clear_co.gif │ │ │ ├── feature-interpreter-01.png │ │ │ ├── feature-interpreter-02.png │ │ │ ├── feature-interpreter-03.png │ │ │ ├── refresh_interpreter.gif │ │ │ ├── restart_co.gif │ │ │ ├── run_interpreter.gif │ │ │ ├── term_restart.gif │ │ │ └── terminate_co.gif │ │ └── index.rst │ ├── test-finder │ │ ├── images │ │ │ ├── config.png │ │ │ └── right-click.png │ │ └── index.rst │ ├── typingviewing │ │ ├── auto-edits.rst │ │ ├── code-completion.rst │ │ ├── code-templates.rst │ │ ├── errors-as-you-type.rst │ │ ├── formatting │ │ │ ├── images │ │ │ │ ├── feature-formatting-01.png │ │ │ │ └── feature-formatting-02.png │ │ │ └── index.rst │ │ ├── images │ │ │ ├── auto_edits.png │ │ │ ├── change-capitalization.png │ │ │ ├── create-method.png │ │ │ ├── example.png │ │ │ ├── explicit-type.png │ │ │ ├── feature-code-completion-01.png │ │ │ ├── feature-code-completion-02.png │ │ │ ├── feature-code-completion-03.png │ │ │ ├── feature-inferredsemicolons-01.png │ │ │ ├── feature-inferredsemicolons-02.png │ │ │ ├── feature-occurences-01.png │ │ │ ├── feature-quickfix-import-01.png │ │ │ ├── feature-structured-selection-01.png │ │ │ ├── feature-syntax-highlighting-01.png │ │ │ ├── feature-template-01.png │ │ │ ├── feature-typing-error-01.png │ │ │ ├── indent-guide-pref.png │ │ │ ├── indent-guide.png │ │ │ ├── inferred-types-01.png │ │ │ ├── javadoc.png │ │ │ ├── literals.png │ │ │ ├── mark-occurrences-toolbar.png │ │ │ ├── preferences.png │ │ │ ├── quick-fix.png │ │ │ ├── show-type-window.png │ │ │ ├── show-type.png │ │ │ ├── show_inferred_semicolons.png │ │ │ └── todo-markers.png │ │ ├── implicit-highlighting │ │ │ ├── images │ │ │ │ ├── hover.png │ │ │ │ ├── implicit-format.png │ │ │ │ ├── prefs.png │ │ │ │ └── quick-fix.png │ │ │ └── index.rst │ │ ├── indent-guide.rst │ │ ├── index.rst │ │ ├── inferred-hover.rst │ │ ├── javadoc.rst │ │ ├── mark-occurrences.rst │ │ ├── quick-fixes.rst │ │ ├── refactoring │ │ │ ├── images │ │ │ │ ├── change-order-before.png │ │ │ │ ├── change-order-dialog.png │ │ │ │ ├── change-order-preview.png │ │ │ │ ├── extract-code-inline-renaming.png │ │ │ │ ├── extract-code-scope-selection.png │ │ │ │ ├── extract-trait-before.png │ │ │ │ ├── extract-trait-dialog.png │ │ │ │ ├── extract-trait-extracted.png │ │ │ │ ├── extract-trait-preview.png │ │ │ │ ├── feature-refactoring-inline-local-01.png │ │ │ │ ├── feature-refactoring-organize-import-01.png │ │ │ │ ├── feature-refactoring-rename-01.png │ │ │ │ ├── feature-refactoring-rename-02.png │ │ │ │ ├── merge-dialog.png │ │ │ │ ├── merge-not-possible.png │ │ │ │ ├── merge-preview.png │ │ │ │ ├── move-class-configuration.png │ │ │ │ ├── move-class-preview.png │ │ │ │ ├── move-constructor-before.png │ │ │ │ ├── move-constructor-preview.png │ │ │ │ ├── split-before.png │ │ │ │ ├── split-dialog.png │ │ │ │ └── split-preview.png │ │ │ └── index.rst │ │ ├── semantic-highlighting │ │ │ ├── images │ │ │ │ ├── example.png │ │ │ │ └── prefs.png │ │ │ └── index.rst │ │ ├── show-inferred-semicolons.rst │ │ ├── show-type-of-selection.rst │ │ ├── source-generators │ │ │ ├── images │ │ │ │ ├── generate-before.png │ │ │ │ ├── generate-existing-dialog.png │ │ │ │ ├── hashcode-and-equals-after.png │ │ │ │ ├── hashcode-and-equals-dialog.png │ │ │ │ ├── productN-after.png │ │ │ │ └── productN-dialog.png │ │ │ └── index.rst │ │ ├── structured-selection.rst │ │ └── syntax-highlighting.rst │ └── wizards │ │ ├── images │ │ ├── code-completion-support.png │ │ ├── new-file-wizard.png │ │ ├── new-menu-scala-file-entry.png │ │ ├── search-field-scala-file-entry.png │ │ └── template-preference-page.png │ │ └── index.rst ├── gettingstarted │ └── index.rst ├── images │ └── video-coming-soon.jpg ├── index.rst └── testingframeworks │ ├── images │ ├── testing-junit-01.png │ ├── testing-scalatest-01.png │ └── testing-specs-01.png │ └── index.rst ├── Makefile ├── _static └── favicon.ico ├── changelog.rst ├── community.rst ├── conf.py ├── contribute.rst.inc ├── current-user-doc ├── dev ├── appendix │ ├── appendix.rst │ ├── git-github.rst │ ├── resources.rst │ ├── shortcuts.rst │ └── what-to-work-on.rst ├── architecture │ ├── architecture.rst │ ├── expression-evaluator.rst │ └── presentation-compiler.rst ├── building │ └── building.rst ├── code │ └── code.rst ├── ide-extensions │ ├── ide-extensions.rst │ ├── semantic-annotations │ │ └── index.rst │ └── wizards │ │ └── index.rst ├── index.rst ├── release │ └── how-to-create-release.rst ├── repository-organization │ └── repository-organization.rst ├── setup │ ├── images │ │ ├── sbt-full-jars.png │ │ └── setup.png │ └── setup.rst ├── testing │ ├── eclipse-tests.rst │ ├── presentation-compiler-tests.rst │ └── testing.rst └── workflow │ └── workflow.rst ├── global_defs.hrst ├── image_placeholder.rst ├── images ├── frflag.png ├── splash-features-video.png ├── splash-getting-started-video.png ├── splash-nn30-improved-features-video.png ├── splash-nn30-new-features-video.png ├── splash-nn30-overview-video.png ├── splash-nn30-scala-debugger-video.png └── usflag.png ├── index.rst ├── license.rst ├── make.bat ├── resources └── screenshots │ ├── ScalaIDE-2.0.0-large.png │ └── ScalaIDE-2.0.0-small.png ├── sources ├── README.rst └── testing-frameworks │ ├── .classpath │ ├── .project │ ├── build.sbt │ ├── project │ └── build.sbt │ └── src │ └── test │ └── scala │ ├── junit │ └── SimpleTest.scala │ ├── scalatest │ └── ExampleSuite.scala │ └── specs2 │ └── HelloWorldSpec.scala ├── themes └── scala-ide │ ├── layout.html │ ├── static │ └── resources │ │ ├── images │ │ ├── bg.jpg │ │ ├── logo.png │ │ └── watermark.png │ │ ├── javascript │ │ ├── bootstrap-dropdown-app.js │ │ ├── bootstrap-dropdown.js │ │ ├── contentsFix.js │ │ ├── effects.core.js │ │ ├── effects.highlight.js │ │ ├── highlightCode.js │ │ ├── jquery.js │ │ ├── prettify.js │ │ ├── scrollTo.js │ │ └── toc.js │ │ └── stylesheets │ │ ├── base.css │ │ ├── bootstrap.css │ │ ├── doc.css │ │ ├── prettify.css │ │ └── sphinx.css │ └── theme.conf ├── tutorials ├── continuations-plugin │ ├── images │ │ ├── 1-continuations-disabled.png │ │ ├── 2-project-properties.png │ │ ├── 3-use-project-settings.png │ │ ├── 4-enable-continuations-plugin.png │ │ └── 5-no-errors.png │ └── index.rst ├── index.rst ├── lift24scalaide20 │ ├── images │ │ ├── 01-lift_basic_folder_structure.png │ │ ├── 02-import_project_dialog.png │ │ ├── 03-eclipse_project_structure.png │ │ └── 04-eclipse_run_configuration_jrebel.png │ └── index.rst ├── m2eclipse │ ├── images │ │ ├── archetypes.png │ │ ├── import.png │ │ ├── install-new-software.png │ │ └── new-project.png │ └── index.rst ├── play │ ├── images │ │ ├── install-play2-plugin.png │ │ ├── play20-scalaide20-01.png │ │ ├── play20-scalaide20-02.png │ │ ├── play20-scalaide20-03.png │ │ ├── play20-scalaide20-04.png │ │ ├── play20-scalaide20-05.png │ │ ├── play20-scalaide20-06.png │ │ ├── play20-scalaide20-07.png │ │ ├── play20-scalaide20-08.png │ │ ├── play20-scalaide20-09.png │ │ ├── play20-scalaide20-10.png │ │ ├── play20-scalaide20-11.png │ │ ├── play20-scalaide20-12.png │ │ ├── play20-scalaide20-13.png │ │ ├── play20-scalaide20-15.png │ │ ├── play20-scalaide20-16.png │ │ ├── play20-scalaide20-17.png │ │ ├── play20-scalaide20-18.png │ │ ├── play20-scalaide20-19.png │ │ └── refresh-on-access.png │ └── index.rst └── scalac-trunk │ ├── images │ ├── scalac-launch.png │ └── scalac-properties.png │ └── index.rst ├── user ├── faq.rst ├── gettingstarted.rst └── images │ └── setup-diagnostics-01.png └── videos.rst /.gitignore: -------------------------------------------------------------------------------- 1 | _build 2 | .target 3 | .DS_Store 4 | 5 | # IntelliJ IDEA 6 | /.idea 7 | 8 | # sbt 9 | target 10 | project/target 11 | project/project 12 | 13 | # Vim 14 | .*.swp 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright © 2002-2014 EPFL 2 | Copyright © 2011-2014 Typesafe, Inc. 3 | 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 7 | 8 | Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 9 | Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 10 | Neither the name of the EPFL nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 11 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | Documentation for Scala IDE 4 | --------------------------- 5 | 6 | This documentation web site is using `Sphinx`_ (version 1.1.2) to generate HTML pages from `reStructuredText`_ files. 7 | 8 | To setup Sphinx locally, use ``easy_install``: 9 | 10 | :: 11 | 12 | $ sudo easy_install "sphinx==1.1.3" 13 | $ sudo easy_install pygments # required on some systems 14 | 15 | To generate the files, use the ``makeSite`` task in sbt: 16 | 17 | :: 18 | 19 | $ sbt makeSite 20 | 21 | To deploy the changes, use the ``ghpagesPushSite`` task: 22 | 23 | :: 24 | 25 | $ sbt makeSite ghpagesPushSite 26 | 27 | .. _reStructuredText: http://docutils.sourceforge.net/rst.html 28 | .. _Sphinx: http://sphinx.pocoo.org/ 29 | 30 | ValueError: unknown locale: UTF-8 31 | ................................. 32 | 33 | On Mac osX, it appears to have some 'local' problem. Running the following fixes it: 34 | 35 | :: 36 | 37 | export LC_ALL=en_US.UTF-8 38 | export LANG=en_US.UTF-8 39 | -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | name := "docs" 2 | 3 | enablePlugins(GhpagesPlugin) 4 | enablePlugins(SphinxPlugin) 5 | 6 | git.remoteRepo := "git@github.com:scala-ide/docs.git" 7 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=0.13.16 2 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.0") 2 | 3 | addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2") 4 | -------------------------------------------------------------------------------- /src/sphinx/2.0.x/features.rst: -------------------------------------------------------------------------------- 1 | Features 2 | ======== 3 | 4 | The aim of Scala IDE is to provide a support for Scala development equivalent to the support provided by Eclipse for Java development. 5 | 6 | The features overview screencast gives a quick tour of the Scala IDE features. 7 | 8 | .. raw:: html 9 | 10 |
11 | 12 |
13 | 14 | The following pages provide a description of a list of selected features provided by Scala IDE: 15 | 16 | .. toctree:: 17 | :maxdepth: 2 18 | 19 | features/typingviewing 20 | features/navigating 21 | features/refactoring 22 | features/formatting 23 | features/scalainterpreter 24 | -------------------------------------------------------------------------------- /src/sphinx/2.0.x/features/formatting.rst: -------------------------------------------------------------------------------- 1 | Formatting 2 | ========== 3 | 4 | The Scala formatter `scalariform`_ is integrated in Scala IDE. It allows for a good formatting of both Scala code and XML literals. 5 | 6 | Before: 7 | 8 | .. image:: ../images/feature-formatting-01.png 9 | 10 | After: 11 | 12 | .. image:: ../images/feature-formatting-02.png 13 | 14 | Scalariform options can be modified in the ``Scala → Formatter`` preference page. 15 | 16 | .. _scalariform: https://github.com/mdr/scalariform 17 | -------------------------------------------------------------------------------- /src/sphinx/2.0.x/features/navigating.rst: -------------------------------------------------------------------------------- 1 | Navigating 2 | ========== 3 | 4 | Open type 5 | --------- 6 | 7 | The ``Open Type`` dialog used to find Java type also provide all defined Scala types. The shortcut is ``Ctrl-Shift-T`` or ``Cmd-Shift-T``. 8 | 9 | .. image:: ../images/feature-open-type-01.png 10 | 11 | Hyperlinking 12 | ------------ 13 | 14 | Hyperlinking to declaration is enable in the Scala editor. 15 | 16 | It is activated by holding the ``Ctrl`` or the ``Cmd`` key, and hovering on variable, method or type. It became underlined and can be click to jump to its declaration. 17 | 18 | .. image:: ../images/feature-hyperlinking-01.png 19 | 20 | Open declaration 21 | ---------------- 22 | 23 | In a similar way to hyperlinking, ``F3`` can be used to the declaration of the element currently under the caret. 24 | -------------------------------------------------------------------------------- /src/sphinx/2.0.x/features/refactoring.rst: -------------------------------------------------------------------------------- 1 | Refactoring 2 | =========== 3 | 4 | `Scala Refactoring`_ is integrated in Scala IDE. It offers a broad range of refactoring actions. 5 | 6 | Extracting Local Values 7 | ----------------------- 8 | 9 | The `Extract Local`_ action does the opposite work of Inline Local. It creates a value of an expression. It is a must use to make code more readable. 10 | 11 | Select an expression to extract. 12 | 13 | .. image:: ../images/feature-refactoring-extract-local-01.png 14 | 15 | Call the action, then set a name for the created value. 16 | 17 | .. image:: ../images/feature-refactoring-extract-local-02.png 18 | 19 | Extracting Methods 20 | ------------------ 21 | 22 | The `Extract Method`_ action extract the set of selected statements into a new method. The original code is replaced by the equivalent method call. 23 | 24 | .. image:: ../images/feature-refactoring-extract-method-01.png 25 | :width: 100% 26 | :target: ../../_images/feature-refactoring-extract-method-01.png 27 | 28 | Inlining Local Values 29 | ------------------------ 30 | 31 | The `Inline Local`_ action helps removing unneeded values. 32 | 33 | The action is performed on the currently selected value. 34 | 35 | .. image:: ../images/feature-refactoring-inline-local-01.png 36 | :width: 100% 37 | :target: ../../_images/feature-refactoring-inline-local-01.png 38 | 39 | Organizing Imports 40 | ------------------ 41 | 42 | The `Organize Imports`_ action allows to do some automated cleanup on the list of imports. It removes the unused or unneeded imports and organizes the remainder. 43 | 44 | .. image:: ../images/feature-refactoring-organize-import-01.png 45 | :width: 100% 46 | :target: ../../_images/feature-refactoring-organize-import-01.png 47 | 48 | This action can be configure in the ``Scala → Organize Import`` preference page. 49 | 50 | Renaming 51 | -------- 52 | 53 | The `Rename`_ action allows to change any name, and update its reference. 54 | 55 | The action is performed in in-line mode if the name as only a local scope. 56 | 57 | .. image:: ../images/feature-refactoring-rename-01.png 58 | :width: 100% 59 | :target: ../../_images/feature-refactoring-rename-01.png 60 | 61 | The action is done through a wizard if the name can be referenced from different source files. 62 | 63 | .. image:: ../images/feature-refactoring-rename-02.png 64 | :width: 100% 65 | :target: ../../_images/feature-refactoring-rename-02.png 66 | 67 | .. _Extract Local: http://scala-refactoring.org/extract-local/ 68 | .. _Extract Method: http://scala-refactoring.org/extract-method/ 69 | .. _Inline Local: http://scala-refactoring.org/inline-local/ 70 | .. _Organize Imports: http://scala-refactoring.org/organize-imports/ 71 | .. _Rename: http://scala-refactoring.org/rename/ 72 | .. _Scala Refactoring: http://scala-refactoring.org/ 73 | 74 | -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/advancedsetup-heapstatus-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/advancedsetup-heapstatus-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/advancedsetup-jdtweaving-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/advancedsetup-jdtweaving-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/clear_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/clear_co.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-code-completion-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-code-completion-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-code-completion-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-code-completion-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-formatting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-formatting-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-formatting-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-formatting-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-hyperlinking-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-hyperlinking-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-inferredsemicolons-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-inferredsemicolons-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-inferredsemicolons-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-inferredsemicolons-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-interpreter-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-interpreter-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-interpreter-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-interpreter-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-interpreter-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-interpreter-03.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-occurences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-occurences-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-open-type-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-open-type-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-quickfix-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-quickfix-import-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-extract-local-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-extract-local-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-extract-local-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-extract-local-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-extract-method-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-extract-method-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-inline-local-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-inline-local-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-organize-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-organize-import-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-rename-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-rename-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-refactoring-rename-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-refactoring-rename-02.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-structured-selection-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-structured-selection-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-syntax-highlighting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-syntax-highlighting-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-template-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-template-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/feature-typing-error-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/feature-typing-error-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/frflag.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/frflag.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/refresh_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/refresh_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/restart_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/restart_co.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/run_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/run_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/setup-diagnostics-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/setup-diagnostics-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/show_inferred_semicolons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/show_inferred_semicolons.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/term_restart.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/term_restart.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/terminate_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/terminate_co.gif -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/testing-junit-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/testing-junit-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/testing-scalatest-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/testing-scalatest-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/testing-specs-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/testing-specs-01.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/images/usflag.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/2.0.x/images/usflag.png -------------------------------------------------------------------------------- /src/sphinx/2.0.x/index.rst: -------------------------------------------------------------------------------- 1 | User Documentation for the Scala IDE 2.0.x 2 | ========================================== 3 | 4 | This documentation is the starting point for the installation guide and other information regarding the use of the Scala IDE for Eclipse V2.0.2. 5 | 6 | Contents: 7 | 8 | .. toctree:: 9 | :maxdepth: 2 10 | 11 | gettingstarted 12 | advancedsetup 13 | features 14 | /tutorials/index 15 | faq 16 | /community 17 | testingframeworks 18 | /license 19 | 20 | .. include:: /contribute.rst.inc 21 | 22 | .. toctree:: 23 | :hidden: 24 | 25 | known-issues -------------------------------------------------------------------------------- /src/sphinx/3.0.x/advancedsetup/images/advancedsetup-heapstatus-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/advancedsetup/images/advancedsetup-heapstatus-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/advancedsetup/images/advancedsetup-jdtweaving-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/advancedsetup/images/advancedsetup-jdtweaving-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/advancedsetup/images/completion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/advancedsetup/images/completion.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/advancedsetup/images/content-assist-deactivation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/advancedsetup/images/content-assist-deactivation.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/advancedsetup/images/limit-editors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/advancedsetup/images/limit-editors.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/faq/images/setup-diagnostics-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/faq/images/setup-diagnostics-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features.rst: -------------------------------------------------------------------------------- 1 | Features 2 | ======== 3 | 4 | The aim of Scala IDE is to provide a support for Scala development equivalent to the support provided by Eclipse for Java development. 5 | 6 | The features overview screencast gives a quick tour of the new features is Scala IDE 3.0. The other videos are about the :ref:`improved features <3-0-improved-features>` and the :ref:`Scala debugger <3-0-scala-debugger>`. 7 | 8 | .. raw:: html 9 | 10 |
11 | 12 |
13 | 14 | The following pages provide a description of a list of selected features provided by Scala IDE: 15 | 16 | .. toctree:: 17 | :maxdepth: 2 18 | 19 | features/typingviewing/index 20 | features/navigating/index 21 | features/test-finder/index 22 | features/scaladebugger/index 23 | features/scalainterpreter/index 24 | features/logging/index 25 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/logging/images/logging-preferences.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/logging/images/logging-preferences.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/logging/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Logging |new| 4 | ============= 5 | 6 | Logging isn't likely to be the most wanted feature, and we hope that you won't ever need to know about it. 7 | But software can crash, and decent logging can go a long way into understanding the reasons behind a failure. 8 | Thus, we have improved the logging infrastructure so that it can be easily controlled by you. 9 | 10 | In this page we discuss how you can manage logging in the Scala IDE. 11 | 12 | 13 | Configuration 14 | ------------- 15 | 16 | You can access the logging settings in the Eclipse Preferences. Click on the ``Scala`` item and select ``Logging``. 17 | You should see the following page: 18 | 19 | .. image:: images/logging-preferences.png 20 | 21 | By default, the log level is set to ``WARN``. That should be enough for general use, and it should still provide 22 | some useful information in the event of an error. Naturally, you are free to change the log level at any time -- 23 | remember, though, that increasing logging may noticeably decrease performance. 24 | 25 | All logging information is stored in a ``scala-ide.log`` file located in the ``${workspace}/.metadata/.plugins/org.scala-ide.sdt.core/`` 26 | directory, where ``${workspace}`` is the directory provided when starting up Eclipse -- i.e., your Eclipse workspace. 27 | This file can grow up to 10MB, at which point it automatically rolls over. You can easily check the log's contents at 28 | any time by clicking on the link at the bottom of the ``Logging`` preferences page. 29 | 30 | By default, standard output and standard error are redirected to the log file. This makes it easy to gather all debugging 31 | output in one place. However, when debugging or working with other plugins you may want to keep stdout and stderr out 32 | of the logs, so make sure to uncheck the option. 33 | 34 | Should you so desire, you can also output all log messages directly to the terminal. Be aware that in order to do so 35 | you must start Eclipse from the command line. For example, you can start Eclipse from the command line with the 36 | following on Mac OSX: 37 | 38 | .. code-block:: bash 39 | 40 | $ /Applications/eclipse/Eclipse.app/Contents/MacOS/eclipse 41 | 42 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/comment-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | URL Hyperlinking in Comments |new| 4 | ================================== 5 | 6 | .. note:: 7 | 8 | Comment URL detection needs an ``http://`` prefix to be present 9 | 10 | If you enter an URL in a multi-line comment, it will be 11 | clickable. Hovering on it will also bring up the menu seen below. 12 | 13 | .. image:: images/url-hyperlinking.png 14 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/declaration-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Declaration Hyperlinking 4 | ======================== 5 | 6 | Hyperlinking to declaration is enable in the Scala editor. 7 | 8 | It is activated by holding the ``Ctrl`` or the ``Cmd`` key, and hovering on variable, method or type. It became underlined and can be click to jump to its declaration. 9 | 10 | .. image:: images/feature-hyperlinking-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/find-occurrences.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Find Occurrences |new| |plugin| 4 | =============================== 5 | 6 | .. note:: This feature requires the `Scala Search plugin`_. In the future this will be merged with the IDE 7 | 8 | It is possible to find all occurrences of a specific Scala entity by selecting the entity in the editor and press the shortcut ``Ctrl-Alt-Shift-R`` (or ``Cmd-Alt-Shift-R`` on Mac). Currently, find references only works for members, i.e., methods and fields. 9 | 10 | *It currently only monitors file changes that happen inside of Eclipse, so if a file is changed outside of Eclipse (e.g. by switching git branch) it might not find the correct occurrence in that document. Refreshing the workspace should help, if not, delete the indices (/.metadata/.plugins/org.scala.tools.eclipse.search/lucene-indices). This will be fixed in the next release, see the relevant* `ticket`_. *for more information* 11 | 12 | .. image:: images/scala-search-find-occurrences-01.png 13 | 14 | .. _Scala Search plugin: http://github.com/scala-ide/scala-search 15 | .. _ticket: https://scala-ide-portfolio.assembla.com/spaces/scala-ide/tickets/1001608#/activity/ticket: -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/feature-hyperlinking-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/feature-hyperlinking-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/feature-open-type-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/feature-open-type-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/implicit-hyperlink.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/implicit-hyperlink.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/outline-view-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/outline-view-1.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/outline-view-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/outline-view-2.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/quick-outline-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/quick-outline-1.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/scala-search-find-occurrences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/scala-search-find-occurrences-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/scala-search-type-hierarchy-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/scala-search-type-hierarchy-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/tasks-view-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/tasks-view-1.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/images/url-hyperlinking.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/navigating/images/url-hyperlinking.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/implicit-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Implicit Hyperlinking |new| 4 | =========================== 5 | 6 | .. note:: 7 | 8 | :doc:`Implicit Highlighting <../typingviewing/implicit-highlighting/index>` needs to be enabled. 9 | 10 | With *Implicit Hyperlinking* you can hyperlink to an implicit declaration. 11 | 12 | Hold down |keystroke-mouse| and hover over a binding. If an implicit conversion 13 | has been applied to the hovered binding, a contextual menu will open, giving you a chance 14 | to navigate to either the binding's declaration (a.k.a. 15 | :doc:`definition hyperlinking `) or to the implicit declaration! 16 | 17 | And if you don't like to touch your mouse too much, just hit |keystroke-keyboard| and 18 | immediately navigate to the implicit declaration. 19 | 20 | .. image:: images/implicit-hyperlink.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Navigating 4 | ========== 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | comment-hyperlinking 10 | declaration-hyperlinking 11 | implicit-hyperlinking 12 | open-type 13 | open-declaration 14 | outline-view 15 | tasks-view 16 | find-occurrences 17 | type-hierarchy -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/open-declaration.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Open declaration 4 | ================ 5 | 6 | In a similar way to hyperlinking, ``F3`` can be used to the declaration of the element currently under the caret. 7 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/open-type.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Open type 4 | ========= 5 | 6 | The ``Open Type`` dialog used to find Java type also provide all defined Scala types. The shortcut is ``Ctrl-Shift-T`` or ``Cmd-Shift-T``. 7 | 8 | .. image:: images/feature-open-type-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/outline-view.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Outline View 4 | ============ 5 | 6 | The outline view of the standard Eclipse editors is also supported for the Scala IDE ! Hit ``Alt + Shift + Q, O`` to bring it up. You will be able to see eclarations for package, class, member, etc. 7 | 8 | .. image:: ./images/outline-view-2.png 9 | 10 | The outline view is also linked to your editor : clicking on members in the Outline view focuses your editor to the region of text where that element is declared. In a large file, this may be very useful. 11 | 12 | .. image:: ./images/outline-view-1.png 13 | 14 | A lighter version of the same feature is available if you press ``Ctrl + O`` (``Command + O`` on Mac) with the focus on the current editor. 15 | 16 | .. image:: ./images/quick-outline-1.png 17 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/tasks-view.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Tasks View 4 | ========== 5 | 6 | The Scala IDE will also look through your comments and list TODO or FIXME mentions in the Tasks view. You can then navigate to them by clicking on them. The Tasks view can be brought up by clicking on ``Alt + Shift + Q, K``. 7 | 8 | .. image:: ./images/tasks-view-1.png 9 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/navigating/type-hierarchy.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Type Hierarchy |new| |plugin| 4 | =============================== 5 | 6 | .. note:: This feature requires the `Scala Search plugin`_. In the future this will be merged with the IDE 7 | 8 | It is possible to visualize the type hierarchy of any Scala type by putting the cursor on the type in the editor and press the shortcut ``Ctrl-F4`` (or ``Cmd-F4`` on Mac). 9 | 10 | .. image:: images/scala-search-type-hierarchy-01.png 11 | 12 | 13 | .. note:: Currently, type hierarchy cannot be started from source attachments. This is a known limitation, and will be fixed in a future release. 14 | 15 | 16 | .. _Scala Search plugin: http://github.com/scala-ide/scala-search -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/detailpane-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/detailpane-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/logicalstructure-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/logicalstructure-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/logicalstructure-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/logicalstructure-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/preferences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/preferences-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/preferences-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/preferences-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/remotedebugging-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/remotedebugging-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/scaladisplay-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/scaladisplay-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-03.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/smartstepping-04.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scaladebugger/images/unboxedprimitive-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scaladebugger/images/unboxedprimitive-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/clear_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/clear_co.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/feature-interpreter-03.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/refresh_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/refresh_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/restart_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/restart_co.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/run_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/run_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/term_restart.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/term_restart.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/scalainterpreter/images/terminate_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/scalainterpreter/images/terminate_co.gif -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/test-finder/images/config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/test-finder/images/config.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/test-finder/images/right-click.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/test-finder/images/right-click.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/test-finder/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Scala JUnit Test Finder |new| 4 | ============================= 5 | 6 | The plain JUnit test runner of Eclipse works well for Scala projects as well. If one does not need (or cannot use) a Scala-specific testing framework such as `ScalaTest `_ (that comes with `its own Eclipse plugin `_), JUnit is a good default. In this release we added a specific test finder for Scala projects (the default Java one was unreliable, and often missed Scala classes that define unit tests). 7 | 8 | To enable the new test finder simply select **Scala JUnit 4** from the drop down list of test runners in the usual *JUnit run configuration*. 9 | 10 | 11 | .. image:: images/config.png 12 | 13 | The `Scala JUnit 4` runner is automatically selected when **right-clicking** on a file (package, project or source folders are also supported) if the project has the Scala nature. 14 | 15 | .. image:: images/right-click.png 16 | 17 | Limitations 18 | ~~~~~~~~~~~ 19 | 20 | The current Scala test finder does not find: 21 | 22 | * tests using the 3.8-style (extending ``TestCase``) 23 | * tests that have no ``@Test`` annotations, for instance a test that inherits all the test methods from a super class. This limitation can be worked around by adding `@Test` in a comment. 24 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/code-completion.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Code Completion 4 | =============== 5 | 6 | Scala IDE provides full code completion support, returning the entities available in the current context. Code completion is enable by using ``Ctrl+Space`` in the Scala Editor. 7 | 8 | In **Scala source files**, code completion returns the valid Scala and Java proposals. 9 | 10 | .. image:: images/feature-code-completion-01.png 11 | :width: 100% 12 | :target: ../_images/feature-code-completion-01.png 13 | 14 | The Scala elements compatible with Java are provided in **Java source files**. 15 | 16 | .. image:: images/feature-code-completion-02.png 17 | :width: 100% 18 | :target: ../_images/feature-code-completion-02.png 19 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/code-templates.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Code Templates 4 | ============== 5 | 6 | Code templates are available in the completion proposals in code assist. They provide shortcuts for boilerplate code like main method definition and asInstanceOf invocation. 7 | 8 | .. image:: images/feature-template-01.png 9 | :width: 100% 10 | :target: ../_images/feature-template-01.png 11 | 12 | The list of available templates can be viewed and modified in the ``Scala → Templates`` preference page. 13 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/errors-as-you-type.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | As You Type Error Reporting 4 | =========================== 5 | 6 | The Scala code is checked as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*. 7 | 8 | .. image:: images/feature-typing-error-01.png 9 | :width: 100% 10 | :target: ../_images/feature-typing-error-01.png 11 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/formatting/images/feature-formatting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/formatting/images/feature-formatting-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/formatting/images/feature-formatting-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/formatting/images/feature-formatting-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/formatting/index.rst: -------------------------------------------------------------------------------- 1 | Formatting 2 | ========== 3 | 4 | The Scala formatter `scalariform`_ is integrated in Scala IDE. It allows for a good formatting of both Scala code and XML literals. 5 | 6 | Before: 7 | 8 | .. image:: images/feature-formatting-01.png 9 | 10 | After: 11 | 12 | .. image:: images/feature-formatting-02.png 13 | 14 | Scalariform options can be modified in the ``Scala → Formatter`` preference page. 15 | 16 | .. _scalariform: https://github.com/mdr/scalariform 17 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/example.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-code-completion-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-code-completion-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-code-completion-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-code-completion-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-inferredsemicolons-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-inferredsemicolons-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-inferredsemicolons-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-inferredsemicolons-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-occurences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-occurences-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-quickfix-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-quickfix-import-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-structured-selection-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-structured-selection-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-syntax-highlighting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-syntax-highlighting-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-template-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-template-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/feature-typing-error-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/feature-typing-error-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/inferred-types-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/inferred-types-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/javadoc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/javadoc.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/literals.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/literals.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/mark-occurrences-toolbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/mark-occurrences-toolbar.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/preferences.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/preferences.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/quick-fix.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/quick-fix.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/show-type-window.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/show-type-window.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/show-type.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/show-type.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/images/show_inferred_semicolons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/images/show_inferred_semicolons.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/hover.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/implicit-format.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/implicit-format.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/prefs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/prefs.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/quick-fix.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/images/quick-fix.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/implicit-highlighting/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Implicit Highlighting |new| 4 | ============================ 5 | 6 | Implicit annotations are a very powerful feature in Scala. They allow for 7 | fluid DSLs, an amazing collection library, or enriching existing types. With 8 | great power comes great responsability, and a desire to control. Meet *Implicit Highlighting*! 9 | 10 | Implicit highlighting 11 | --------------------- 12 | 13 | .. image:: images/implicit-format.png 14 | 15 | We have defined a class for rational numbers, and defined an implicit comversion from integers 16 | to rationals. This way we can easily mix integers and rationals in arithmetic 17 | expressions, for instance by adding 42 with a rational number. 18 | 19 | Notice that the number ``42`` is underlined, and a marker is added to the left 20 | gutter. This signals that the method ``plus`` was added through an implicit 21 | conversion. If you move your mouse over the gutter, you will see the actual 22 | conversion (``intToRational``). 23 | 24 | .. image:: images/hover.png 25 | 26 | There is also a QuickFix available (``CMD-1``) 27 | that makes the call the implicit conversion explicit! Check :doc:`Expand Implicit Conversion <../quick-fixes>` for more details. 28 | 29 | .. image:: images/quick-fix.png 30 | 31 | Configuration 32 | ------------- 33 | 34 | By default, only *implicit conversions* are highlighted. This makes sense, 35 | since most of the times implicit values that are passed around are not too 36 | costly, nor interesting. However, if you'd like to show those as well, you can 37 | enable them from the ``Implicits`` preferences page. 38 | 39 | .. image:: images/prefs.png 40 | :width: 100% 41 | :target: ../../../_images/prefs.png 42 | 43 | Thank you 44 | --------- 45 | 46 | This feature was contributed by Jin Mingjian and improved by David Bernard and 47 | Mirko Stocker. Thank you! 48 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Typing and Viewing 4 | ================== 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | errors-as-you-type 10 | code-completion 11 | code-templates 12 | auto-edits 13 | formatting/index 14 | inferred-hover 15 | implicit-highlighting/index 16 | javadoc 17 | mark-occurrences 18 | quick-fixes 19 | refactoring/index 20 | semantic-highlighting/index 21 | show-type-of-selection 22 | show-inferred-semicolons 23 | source-generators/index 24 | structured-selection 25 | syntax-highlighting 26 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/inferred-hover.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Inferred Type Hover 4 | =================== 5 | 6 | If you click or hover on an element of the Editor, the IDE will display a tooltip with its definition and type declaration. 7 | 8 | .. image:: ./images/inferred-types-01.png 9 | :width: 100% 10 | :target: .././_images/inferred-types-01.png 11 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/javadoc.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Javadoc on hover 4 | ================ 5 | 6 | When hovering on a Java element, the javadoc view, if you have it 7 | open, will show you the documentation for it. Below you can see 8 | the result when hovering on an ``IJavaProject`` (part of the 9 | Eclispe JDT). 10 | 11 | .. image:: images/javadoc.png 12 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/mark-occurrences.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Mark Occurrences |updated| 4 | ========================== 5 | 6 | As in the Java tooling, Mark Occurrences highlights within a file where a type, variable or method is referenced. 7 | 8 | .. image:: images/feature-occurences-01.png 9 | :width: 100% 10 | :target: ../_images/feature-occurences-01.png 11 | 12 | **This feature is disabled by default, as it can have an impact on the editor performance**, but it is really useful when exploring code. 13 | 14 | It can be enabled in the ``Scala -> Editor`` preference page, or using the button in the main toolbar. 15 | 16 | .. image:: images/mark-occurrences-toolbar.png 17 | :width: 100% 18 | :target: ../_images/mark-occurrences-toolbar.png 19 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/quick-fixes.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Quick Fixes 4 | =========== 5 | 6 | Quick Fix Import 7 | ---------------- 8 | 9 | `Quick Fix`_ can be used to easily add a required import statement. 10 | 11 | .. image:: images/feature-quickfix-import-01.png 12 | :width: 100% 13 | :target: ../_images/feature-quickfix-import-01.png 14 | 15 | .. _typingviewing_show-inferred-semicolons: 16 | 17 | .. _Quick Fix: http://wiki.eclipse.org/FAQ_What_is_a_Quick_Fix%3F 18 | 19 | Expand Implicit Conversion |new| 20 | -------------------------------- 21 | 22 | .. note:: 23 | 24 | :doc:`Implicit Highlighting ` needs to be enabled. 25 | 26 | 27 | `Quick Fix`_ can be used to expand an implicit conversion. 28 | 29 | .. image:: images/quick-fix.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-before.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/change-order-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-before.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-extracted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-extracted.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/extract-trait-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-local-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-local-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-local-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-local-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-method-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-extract-method-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-inline-local-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-inline-local-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-organize-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-organize-import-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-not-possible.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-not-possible.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/merge-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-class-configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-class-configuration.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-class-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-class-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-constructor-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-constructor-before.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-constructor-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/move-constructor-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-before.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/refactoring/images/split-preview.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/semantic-highlighting/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/semantic-highlighting/images/example.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/semantic-highlighting/images/prefs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/semantic-highlighting/images/prefs.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/semantic-highlighting/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Semantic Highlighting |new| 4 | =========================== 5 | 6 | Haven't you always wanted to have more colors in your source code? Meet 7 | *semantic* highlighting! 8 | 9 | Introduction 10 | ------------ 11 | 12 | While syntax highlighting deals with keywords, 13 | strings and other low-level tokens in the language, semantic highlighting 14 | takes it a (big) step forward! Classes, traits, types, vals, vars, methods, 15 | etc. can each have their own assign color and text style. Our favorite is 16 | having deprecated symbols striked-through. The coloring is consistent between 17 | the use-site and definition site, so all occurrences of a symbol will be 18 | colored the same way. 19 | 20 | .. image:: images/example.png 21 | 22 | Configuration 23 | ------------- 24 | 25 | There is a slight performance penalty for using semantic highlighting. 26 | However, this is done in the background and we haven't noticed any important 27 | slowdowns. Should you notice any, you can always jump to the preferences page 28 | and tweak or completely disable this feature. 29 | 30 | You can enable/disable and tweak your color scheme from the configuration 31 | page. The highlighter will use Java colors by default, but there are more 32 | semantic classes in Scala, so make sure you tweak them to your liking. We 33 | suggest the Java-based `Color Theme`_ plugin as a starting point. 34 | 35 | .. image:: images/prefs.png 36 | 37 | 38 | .. _Color Theme: http://www.eclipsecolorthemes.org/?view=plugin 39 | 40 | Thank you 41 | --------- 42 | 43 | Semantic highlighting was contributed by `Matt Russel`_. Thank you! 44 | 45 | .. _Matt Russel: http://twitter.com/#!/mattrusselluk -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/show-inferred-semicolons.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Show Inferred Semicolons 4 | ======================== 5 | 6 | Use the |icon| toggle button in the to enable *infer semicolons*. It will display the inferred semicolons in gray as an overlay on the code. 7 | 8 | .. |icon| image:: images/show_inferred_semicolons.png 9 | 10 | Without: |without| With: |with| 11 | 12 | .. |without| image:: images/feature-inferredsemicolons-01.png 13 | .. |with| image:: images/feature-inferredsemicolons-02.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/show-type-of-selection.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Show Type of Selection |new| 4 | ============================ 5 | 6 | It often happens that during development you'd like to know what is the type of a Scala expression. This can 7 | be very handy when 'debugging' a type error, for instance inside a for comprehension, or a pattern match. 8 | 9 | Similarly to the hover window, you can invoke the ``Show Type`` command on any expression, and get back the type 10 | of selection. Of course, this relies on the expression being type-correct. 11 | 12 | 13 | .. image:: images/show-type.png 14 | 15 | If you choose ``Show Type`` an overlay window will appear, showing the inferred type of the selection. 16 | 17 | .. image:: images/show-type-window.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/generate-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/generate-before.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/generate-existing-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/generate-existing-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-after.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/productN-after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/productN-after.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/images/productN-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/features/typingviewing/source-generators/images/productN-dialog.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/source-generators/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Source generators |new| 4 | ####################### 5 | 6 | Tired of writing ``hashCode`` and ``equals`` implementations by hand? Now you can let the IDE take care of it! The following source generators can be found under the *Source* context menu that appears after right-clicking in the editor. 7 | 8 | Generate hashCode and equals 9 | ============================ 10 | *Generate hashCode and equals* generates implementations for the ``hashCode`` and ``equals`` methods based on selected class parameters. The implementations are based on the recommendations from `Programming in Scala`_. This includes a ``canEqual`` method, thus the ``Equals`` trait is mixed in as well. 11 | 12 | .. _`Programming in Scala`: http://www.artima.com/pins1ed/object-equality.html 13 | 14 | To start this refactoring simply select a class. As an example we will use the class ``Generate``: 15 | 16 | .. image:: images/generate-before.png 17 | 18 | In the refactoring dialog the class parameters that should be included in the equals comparison and the hashcode computation can be selected. Optionally calls to ``super`` can be inserted: 19 | 20 | .. image:: images/hashcode-and-equals-dialog.png 21 | 22 | Selecting both class parameters and inserting calls to ``super`` results in this: 23 | 24 | .. image:: images/hashcode-and-equals-after.png 25 | 26 | If the original class already has existing implementations for ``canEqual``, ``equals`` or ``hashCode``, the refactoring dialog offers the option to keep those or let them be replaced by newly generated implementations: 27 | 28 | .. image:: images/generate-existing-dialog.png 29 | 30 | Introduce ProductN trait 31 | ======================== 32 | Asked for by the community, *Introduce ProductN trait* is an extension of *Generate hashCode and equals*. In addition to *Generate hashCode and equals* this generator creates the methods ``_1`` to ``_n`` for the selected class parameters and mixes in the trait ``ProductN``, where *n* stands for the number of selected class parameters. 33 | 34 | The refactoring dialog is almost the same as for *Generate hashCode and equals*: 35 | 36 | .. image:: images/productN-dialog.png 37 | 38 | Selecting only the first parameter ``a`` and omitting calls to ``super`` results in this: 39 | 40 | .. image:: images/productN-after.png 41 | 42 | 43 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/structured-selection.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Structured Selection 4 | ==================== 5 | 6 | Using ``alt+shift+up`` and ``alt+shift+down`` selects larger or smaller portion of the AST. It allows for quick selection of sub-expressions or statements. 7 | 8 | .. note:: 9 | Shortcuts are platform-dependent, and can be re-configured in the ``Keys`` preference page. The actions are named **Select Enclosing Element** and **Restore Last Selection**. 10 | 11 | .. image:: images/feature-structured-selection-01.png 12 | 13 | Hovering over the selection will also bring up a dialog dispaying 14 | the inferred type of the selected expression, just as it would if 15 | you put the cursor on a :doc:`specific element `. 16 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/features/typingviewing/syntax-highlighting.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Syntax Highlighting |updated| 4 | ============================= 5 | 6 | The Scala editor has full syntax highlighting support, including comments, control structures and embedded XML. 7 | 8 | .. image:: images/feature-syntax-highlighting-01.png 9 | :width: 100% 10 | :target: ../_images/feature-syntax-highlighting-01.png 11 | 12 | As one can see in the following preview, syntax highlighting works not only for Scala code, but also for Scaladoc and for string interpolation: 13 | 14 | .. image:: images/example.png 15 | 16 | In the following picture there are all literals shown that are available in Scala. Note that escape sequences are shown in string and char literals as well as Unicode and octal sequences. 17 | 18 | .. image:: images/literals.png 19 | 20 | Configuration 21 | ------------- 22 | 23 | There are several options available how syntax highlighting can be configured. Beside the possibility to set fore- and background color it is possible to paint the text in bold and italic or to underline it. 24 | 25 | .. image:: images/preferences.png 26 | -------------------------------------------------------------------------------- /src/sphinx/3.0.x/images/video-coming-soon.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/images/video-coming-soon.jpg -------------------------------------------------------------------------------- /src/sphinx/3.0.x/index.rst: -------------------------------------------------------------------------------- 1 | User Documentation for the Scala IDE 3.0.x 2 | ========================================== 3 | 4 | This documentation is the starting point for the installation guide and other information regarding the use of the Scala IDE for Eclipse V3.0.0. 5 | 6 | Contents: 7 | 8 | .. toctree:: 9 | :maxdepth: 3 10 | 11 | gettingstarted/index 12 | advancedsetup/index 13 | features 14 | /tutorials/index 15 | faq/index 16 | /community 17 | testingframeworks/index 18 | /license 19 | 20 | .. include:: /contribute.rst.inc 21 | 22 | .. toctree:: 23 | :hidden: 24 | 25 | faq/known-issues -------------------------------------------------------------------------------- /src/sphinx/3.0.x/testingframeworks/images/testing-junit-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/testingframeworks/images/testing-junit-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/testingframeworks/images/testing-scalatest-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/testingframeworks/images/testing-scalatest-01.png -------------------------------------------------------------------------------- /src/sphinx/3.0.x/testingframeworks/images/testing-specs-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/3.0.x/testingframeworks/images/testing-specs-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/advancedsetup-heapstatus-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/advancedsetup-heapstatus-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/advancedsetup-jdtweaving-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/advancedsetup-jdtweaving-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/closing-presentation-compilers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/closing-presentation-compilers.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/completion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/completion.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/content-assist-deactivation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/content-assist-deactivation.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/advancedsetup/images/limit-editors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/advancedsetup/images/limit-editors.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/faq/images/setup-diagnostics-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/faq/images/setup-diagnostics-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features.rst: -------------------------------------------------------------------------------- 1 | Features 2 | ======== 3 | 4 | The aim of Scala IDE is to provide a support for Scala development equivalent to the support provided by Eclipse for Java development. 5 | 6 | The features overview screencast gives a quick tour of the new features is Scala IDE 3.0. The other videos are about the :ref:`improved features <3-0-improved-features>` and the :ref:`Scala debugger <3-0-scala-debugger>`. 7 | 8 | .. raw:: html 9 | 10 |
11 | 12 |
13 | 14 | The following pages provide a description of a list of selected features provided by Scala IDE: 15 | 16 | .. toctree:: 17 | :maxdepth: 2 18 | 19 | features/typingviewing/index 20 | features/navigating/index 21 | features/wizards/index 22 | features/test-finder/index 23 | features/scalacompiler/index 24 | features/scaladebugger/index 25 | features/async-debugger/index 26 | features/scalainterpreter/index 27 | features/logging/index 28 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/async-stack-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/async-stack-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/async-stack-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/async-stack-2.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/async-stack-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/async-stack-3.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/async-stack-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/async-stack-4.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/async-stack-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/async-stack-5.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/configuration.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/dead-letter-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/dead-letter-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/dead-letter-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/dead-letter-2.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/program-points.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/program-points.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/step-msg-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/step-msg-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/step-msg-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/step-msg-2.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/step-msg-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/step-msg-3.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/async-debugger/images/step-msg-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/async-debugger/images/step-msg-4.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/logging/images/logging-preferences.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/logging/images/logging-preferences.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/logging/index.rst: -------------------------------------------------------------------------------- 1 | Logging 2 | ======= 3 | 4 | Logging isn't likely to be the most wanted feature, and we hope that you won't ever need to know about it. 5 | But software can crash, and decent logging can go a long way into understanding the reasons behind a failure. 6 | Thus, we have improved the logging infrastructure so that it can be easily controlled by you. 7 | 8 | In this page we discuss how you can manage logging in the Scala IDE. 9 | 10 | 11 | Configuration 12 | ------------- 13 | 14 | You can access the logging settings in the Eclipse Preferences. Click on the ``Scala`` item and select ``Logging``. 15 | You should see the following page: 16 | 17 | .. image:: images/logging-preferences.png 18 | 19 | By default, the log level is set to ``WARN``. That should be enough for general use, and it should still provide 20 | some useful information in the event of an error. Naturally, you are free to change the log level at any time -- 21 | remember, though, that increasing logging may noticeably decrease performance. 22 | 23 | All logging information is stored in a ``scala-ide.log`` file located in the ``${workspace}/.metadata/.plugins/org.scala-ide.sdt.core/`` 24 | directory, where ``${workspace}`` is the directory provided when starting up Eclipse -- i.e., your Eclipse workspace. 25 | This file can grow up to 10MB, at which point it automatically rolls over. You can easily check the log's contents at 26 | any time by clicking on the link at the bottom of the ``Logging`` preferences page. 27 | 28 | By default, standard output and standard error are redirected to the log file. This makes it easy to gather all debugging 29 | output in one place. However, when debugging or working with other plugins you may want to keep stdout and stderr out 30 | of the logs, so make sure to uncheck the option. 31 | 32 | Should you so desire, you can also output all log messages directly to the terminal. Be aware that in order to do so 33 | you must start Eclipse from the command line. For example, you can start Eclipse from the command line with the 34 | following on Mac OSX: 35 | 36 | .. code-block:: bash 37 | 38 | $ /Applications/eclipse/Eclipse.app/Contents/MacOS/eclipse 39 | 40 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/comment-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | URL Hyperlinking in Comments 2 | ============================ 3 | 4 | .. note:: 5 | 6 | Comment URL detection needs an ``http://`` prefix to be present 7 | 8 | If you enter an URL in a multi-line comment, it will be 9 | clickable. Hovering on it will also bring up the menu seen below. 10 | 11 | .. image:: images/url-hyperlinking.png 12 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/declaration-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | Declaration Hyperlinking 2 | ======================== 3 | 4 | Hyperlinking to declaration is enable in the Scala editor. 5 | 6 | It is activated by holding the ``Ctrl`` or the ``Cmd`` key, and hovering on variable, method or type. It became underlined and can be click to jump to its declaration. 7 | 8 | .. image:: images/feature-hyperlinking-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/feature-hyperlinking-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/feature-hyperlinking-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/feature-open-type-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/feature-open-type-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/implicit-hyperlink.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/implicit-hyperlink.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/outline-view-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/outline-view-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/outline-view-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/outline-view-2.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/quick-outline-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/quick-outline-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/tasks-view-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/tasks-view-1.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/images/url-hyperlinking.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/navigating/images/url-hyperlinking.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/implicit-hyperlinking.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Implicit Hyperlinking 4 | ===================== 5 | 6 | .. note:: 7 | 8 | :doc:`Implicit Highlighting <../typingviewing/implicit-highlighting/index>` needs to be enabled. 9 | 10 | With *Implicit Hyperlinking* you can hyperlink to an implicit declaration. 11 | 12 | Hold down |keystroke-mouse| and hover over a binding. If an implicit conversion 13 | has been applied to the hovered binding, a contextual menu will open, giving you a chance 14 | to navigate to either the binding's declaration (a.k.a. 15 | :doc:`definition hyperlinking `) or to the implicit declaration! 16 | 17 | And if you don't like to touch your mouse too much, just hit |keystroke-keyboard| and 18 | immediately navigate to the implicit declaration. 19 | 20 | .. image:: images/implicit-hyperlink.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Navigating 4 | ========== 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | comment-hyperlinking 10 | declaration-hyperlinking 11 | implicit-hyperlinking 12 | open-type 13 | open-declaration 14 | outline-view 15 | tasks-view 16 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/open-declaration.rst: -------------------------------------------------------------------------------- 1 | Open declaration 2 | ================ 3 | 4 | In a similar way to hyperlinking, ``F3`` can be used to the declaration of the element currently under the caret. 5 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/open-type.rst: -------------------------------------------------------------------------------- 1 | Open type 2 | ========= 3 | 4 | The ``Open Type`` dialog used to find Java type also provide all defined Scala types. The shortcut is ``Ctrl-Shift-T`` or ``Cmd-Shift-T``. 5 | 6 | .. image:: images/feature-open-type-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/outline-view.rst: -------------------------------------------------------------------------------- 1 | Outline View 2 | ============ 3 | 4 | The outline view of the standard Eclipse editors is also supported for the Scala IDE ! Hit ``Alt + Shift + Q, O`` to bring it up. You will be able to see eclarations for package, class, member, etc. 5 | 6 | .. image:: ./images/outline-view-2.png 7 | 8 | The outline view is also linked to your editor : clicking on members in the Outline view focuses your editor to the region of text where that element is declared. In a large file, this may be very useful. 9 | 10 | .. image:: ./images/outline-view-1.png 11 | 12 | A lighter version of the same feature is available if you press ``Ctrl + O`` (``Command + O`` on Mac) with the focus on the current editor. 13 | 14 | .. image:: ./images/quick-outline-1.png 15 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/navigating/tasks-view.rst: -------------------------------------------------------------------------------- 1 | Tasks View 2 | ========== 3 | 4 | The Scala IDE will also look through your comments and list TODO or FIXME mentions in the Tasks view. You can then navigate to them by clicking on them. The Tasks view can be brought up by clicking on ``Alt + Shift + Q, K``. 5 | 6 | .. image:: ./images/tasks-view-1.png 7 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalacompiler/images/allow-output-folders.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalacompiler/images/allow-output-folders.PNG -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalacompiler/images/set-output-folder.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalacompiler/images/set-output-folder.PNG -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalacompiler/images/uncheck-scopes-compilation.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalacompiler/images/uncheck-scopes-compilation.PNG -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/detailpane-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/detailpane-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/drop-to-frame.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/drop-to-frame.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/choosing-frames.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/choosing-frames.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/conditional-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/conditional-menu.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/conditional-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/conditional-properties.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console-and-tree-on-bottom.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console-and-tree-on-bottom.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console-and-tree-on-right.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console-and-tree-on-right.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/console.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/context-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/context-menu.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/expression.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/expression.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/input-and-tree-on-bottom.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/input-and-tree-on-bottom.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/input-and-tree-on-right.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/input-and-tree-on-right.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/preferences.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/preferences.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/run-selection-in-ee.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/expression-evaluator/run-selection-in-ee.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/hot-code-replace.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/hot-code-replace.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/logicalstructure-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/logicalstructure-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/logicalstructure-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/logicalstructure-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/preferences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/preferences-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/preferences-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/preferences-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/remotedebugging-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/remotedebugging-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/scaladisplay-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/scaladisplay-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-03.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/smartstepping-04.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/step-filters.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/step-filters.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scaladebugger/images/unboxedprimitive-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scaladebugger/images/unboxedprimitive-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/clear_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/clear_co.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/feature-interpreter-03.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/refresh_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/refresh_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/restart_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/restart_co.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/run_interpreter.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/run_interpreter.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/term_restart.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/term_restart.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/scalainterpreter/images/terminate_co.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/scalainterpreter/images/terminate_co.gif -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/test-finder/images/config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/test-finder/images/config.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/test-finder/images/right-click.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/test-finder/images/right-click.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/test-finder/index.rst: -------------------------------------------------------------------------------- 1 | Scala JUnit Test Finder 2 | ======================= 3 | 4 | The plain JUnit test runner of Eclipse works well for Scala projects as well. If one does not need (or cannot use) a Scala-specific testing framework such as `ScalaTest `_ (that comes with `its own Eclipse plugin `_), JUnit is a good default. In this release we added a specific test finder for Scala projects (the default Java one was unreliable, and often missed Scala classes that define unit tests). 5 | 6 | To enable the new test finder simply select **Scala JUnit 4** from the drop down list of test runners in the usual *JUnit run configuration*. 7 | 8 | 9 | .. image:: images/config.png 10 | 11 | The `Scala JUnit 4` runner is automatically selected when **right-clicking** on a file (package, project or source folders are also supported) if the project has the Scala nature. 12 | 13 | .. image:: images/right-click.png 14 | 15 | Limitations 16 | ~~~~~~~~~~~ 17 | 18 | The current Scala test finder does not find: 19 | 20 | * tests using the 3.8-style (extending ``TestCase``) 21 | * tests that have no ``@Test`` annotations, for instance a test that inherits all the test methods from a super class. This limitation can be worked around by adding `@Test` in a comment. 22 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/code-templates.rst: -------------------------------------------------------------------------------- 1 | Code Templates 2 | ============== 3 | 4 | Code templates are available in the completion proposals in code assist. They provide shortcuts for boilerplate code like main method definition and asInstanceOf invocation. 5 | 6 | .. image:: images/feature-template-01.png 7 | :width: 100% 8 | :target: ../_images/feature-template-01.png 9 | 10 | The list of available templates can be viewed and modified in the ``Scala → Templates`` preference page. 11 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/errors-as-you-type.rst: -------------------------------------------------------------------------------- 1 | As You Type Error Reporting 2 | =========================== 3 | 4 | The Scala code is checked as it is entered. It allows to see small or more complex compilation error as the code is type. No more endless cycle *code → code → code → compile → error reported → fix error → compile → error reported → fix error →...*. 5 | 6 | .. image:: images/feature-typing-error-01.png 7 | :width: 100% 8 | :target: ../_images/feature-typing-error-01.png 9 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/formatting/images/feature-formatting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/formatting/images/feature-formatting-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/formatting/images/feature-formatting-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/formatting/images/feature-formatting-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/formatting/index.rst: -------------------------------------------------------------------------------- 1 | Formatting 2 | ========== 3 | 4 | The Scala formatter `scalariform`_ is integrated in Scala IDE. It allows for a good formatting of both Scala code and XML literals. 5 | 6 | Before: 7 | 8 | .. image:: images/feature-formatting-01.png 9 | 10 | After: 11 | 12 | .. image:: images/feature-formatting-02.png 13 | 14 | Scalariform options can be modified in the ``Scala → Formatter`` preference page. 15 | 16 | .. _scalariform: https://github.com/mdr/scalariform 17 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/auto_edits.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/auto_edits.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/change-capitalization.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/change-capitalization.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/create-method.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/create-method.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/example.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/explicit-type.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/explicit-type.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-code-completion-03.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-inferredsemicolons-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-inferredsemicolons-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-inferredsemicolons-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-inferredsemicolons-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-occurences-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-occurences-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-quickfix-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-quickfix-import-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-structured-selection-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-structured-selection-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-syntax-highlighting-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-syntax-highlighting-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-template-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-template-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/feature-typing-error-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/feature-typing-error-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/indent-guide-pref.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/indent-guide-pref.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/indent-guide.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/indent-guide.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/inferred-types-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/inferred-types-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/javadoc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/javadoc.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/literals.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/literals.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/mark-occurrences-toolbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/mark-occurrences-toolbar.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/preferences.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/preferences.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/quick-fix.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/quick-fix.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/show-type-window.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/show-type-window.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/show-type.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/show-type.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/show_inferred_semicolons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/show_inferred_semicolons.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/images/todo-markers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/images/todo-markers.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/hover.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/implicit-format.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/implicit-format.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/prefs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/prefs.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/quick-fix.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/images/quick-fix.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/implicit-highlighting/index.rst: -------------------------------------------------------------------------------- 1 | Implicit Highlighting 2 | ===================== 3 | 4 | Implicit annotations are a very powerful feature in Scala. They allow for 5 | fluid DSLs, an amazing collection library, or enriching existing types. With 6 | great power comes great responsability, and a desire to control. Meet *Implicit Highlighting*! 7 | 8 | Implicit highlighting 9 | --------------------- 10 | 11 | .. image:: images/implicit-format.png 12 | 13 | We have defined a class for rational numbers, and defined an implicit comversion from integers 14 | to rationals. This way we can easily mix integers and rationals in arithmetic 15 | expressions, for instance by adding 42 with a rational number. 16 | 17 | Notice that the number ``42`` is underlined, and a marker is added to the left 18 | gutter. This signals that the method ``plus`` was added through an implicit 19 | conversion. If you move your mouse over the gutter, you will see the actual 20 | conversion (``intToRational``). 21 | 22 | .. image:: images/hover.png 23 | 24 | There is also a QuickFix available (``CMD-1``) 25 | that makes the call the implicit conversion explicit! Check :doc:`Expand Implicit Conversion <../quick-fixes>` for more details. 26 | 27 | .. image:: images/quick-fix.png 28 | 29 | Configuration 30 | ------------- 31 | 32 | By default, only *implicit conversions* are highlighted. This makes sense, 33 | since most of the times implicit values that are passed around are not too 34 | costly, nor interesting. However, if you'd like to show those as well, you can 35 | enable them from the ``Implicits`` preferences page. 36 | 37 | .. image:: images/prefs.png 38 | :width: 100% 39 | :target: ../../../_images/prefs.png 40 | 41 | Thank you 42 | --------- 43 | 44 | This feature was contributed by Jin Mingjian and improved by David Bernard and 45 | Mirko Stocker. Thank you! 46 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/indent-guide.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Indent Guide |new| 4 | ================== 5 | 6 | The Scala editor supports showing an Indent Guide, which is disabled by default: 7 | 8 | .. image:: images/indent-guide.png 9 | 10 | It can be enabled in ``Preferences → Scala → Editor`` where also its color can be chosen: 11 | 12 | .. image:: images/indent-guide-pref.png 13 | 14 | Please note that the indentation span between two guides is specified by the ``Preferences → Scala → Formatter → Spaces to indent`` preference. 15 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Typing and Viewing 4 | ================== 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | errors-as-you-type 10 | code-completion 11 | code-templates 12 | auto-edits 13 | formatting/index 14 | inferred-hover 15 | implicit-highlighting/index 16 | javadoc 17 | mark-occurrences 18 | quick-fixes 19 | refactoring/index 20 | semantic-highlighting/index 21 | show-type-of-selection 22 | show-inferred-semicolons 23 | source-generators/index 24 | structured-selection 25 | syntax-highlighting 26 | indent-guide 27 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/inferred-hover.rst: -------------------------------------------------------------------------------- 1 | Inferred Type Hover 2 | =================== 3 | 4 | If you click or hover on an element of the Editor, the IDE will display a tooltip with its definition and type declaration. 5 | 6 | .. image:: ./images/inferred-types-01.png 7 | :width: 100% 8 | :target: .././_images/inferred-types-01.png 9 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/javadoc.rst: -------------------------------------------------------------------------------- 1 | Javadoc on hover 2 | ================ 3 | 4 | When hovering on a Java element, the javadoc view, if you have it 5 | open, will show you the documentation for it. Below you can see 6 | the result when hovering on an ``IJavaProject`` (part of the 7 | Eclispe JDT). 8 | 9 | .. image:: images/javadoc.png 10 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/mark-occurrences.rst: -------------------------------------------------------------------------------- 1 | Mark Occurrences 2 | ================ 3 | 4 | As in the Java tooling, Mark Occurrences highlights within a file where a type, variable or method is referenced. 5 | 6 | .. image:: images/feature-occurences-01.png 7 | :width: 100% 8 | :target: ../_images/feature-occurences-01.png 9 | 10 | **This feature is disabled by default, as it can have an impact on the editor performance**, but it is really useful when exploring code. 11 | 12 | It can be enabled in the ``Scala -> Editor`` preference page, or using the button in the main toolbar. 13 | 14 | .. image:: images/mark-occurrences-toolbar.png 15 | :width: 100% 16 | :target: ../_images/mark-occurrences-toolbar.png 17 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/quick-fixes.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | Quick Fixes |updated| 4 | ===================== 5 | 6 | Quick Fix Import 7 | ---------------- 8 | 9 | `Quick Fix`_ can be used to easily add a required import statement. 10 | 11 | .. image:: images/feature-quickfix-import-01.png 12 | :width: 100% 13 | :target: ../_images/feature-quickfix-import-01.png 14 | 15 | .. _typingviewing_show-inferred-semicolons: 16 | 17 | .. _Quick Fix: http://wiki.eclipse.org/FAQ_What_is_a_Quick_Fix%3F 18 | 19 | Expand Implicit Conversion 20 | -------------------------- 21 | 22 | .. note:: 23 | 24 | :doc:`Implicit Highlighting ` needs to be enabled. 25 | 26 | 27 | `Quick Fix`_ can be used to expand an implicit conversion. 28 | 29 | .. image:: images/quick-fix.png 30 | 31 | 32 | Create Method and Class |new| 33 | ----------------------------- 34 | 35 | For the following code snippet there exists a quick fix for the method call of ``g``: 36 | 37 | .. image:: images/create-method.png 38 | 39 | The result of applying this quick fix is the following:: 40 | 41 | object Test extends App { 42 | 43 | def f() { 44 | val value = g("a string") 45 | } 46 | 47 | def g(arg: String) = { 48 | ??? 49 | } 50 | } 51 | 52 | As one can see in the screenshot above it is also possible to create classes, not only methods. 53 | 54 | Change Capitalization |new| 55 | --------------------------- 56 | 57 | If one did a type error in the name of a method, it is possible to correct this as long as the only type error is due to wrong capitalization: 58 | 59 | .. image:: images/change-capitalization.png 60 | 61 | Add Explicit Type |new| 62 | ----------------------- 63 | 64 | If you want to add an explicit type to a method or a value definition, you can automatically add the inferred type. Position the cursor on the value or method definition and type ``Ctrl-1`` (or ``CMD`` for Macs). You should see a popup offering to add the explicit type, like the in the picture below: 65 | 66 | .. image:: images/explicit-type.png 67 | 68 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-before.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/change-order-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-code-inline-renaming.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-code-inline-renaming.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-code-scope-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-code-scope-selection.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-before.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-extracted.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-extracted.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/extract-trait-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-inline-local-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-inline-local-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-organize-import-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-organize-import-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/feature-refactoring-rename-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-not-possible.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-not-possible.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/merge-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-class-configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-class-configuration.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-class-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-class-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-constructor-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-constructor-before.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-constructor-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/move-constructor-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-before.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/refactoring/images/split-preview.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/semantic-highlighting/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/semantic-highlighting/images/example.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/semantic-highlighting/images/prefs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/semantic-highlighting/images/prefs.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/semantic-highlighting/index.rst: -------------------------------------------------------------------------------- 1 | Semantic Highlighting 2 | ===================== 3 | 4 | Haven't you always wanted to have more colors in your source code? Meet 5 | *semantic* highlighting! 6 | 7 | Introduction 8 | ------------ 9 | 10 | While syntax highlighting deals with keywords, 11 | strings and other low-level tokens in the language, semantic highlighting 12 | takes it a (big) step forward! Classes, traits, types, vals, vars, methods, 13 | etc. can each have their own assign color and text style. Our favorite is 14 | having deprecated symbols striked-through. The coloring is consistent between 15 | the use-site and definition site, so all occurrences of a symbol will be 16 | colored the same way. 17 | 18 | .. image:: images/example.png 19 | 20 | Semantic highlighting works for both, the Scala source files and the source attachments of compiled Scala files. 21 | 22 | Configuration 23 | ------------- 24 | 25 | There is a slight performance penalty for using semantic highlighting. 26 | However, this is done in the background and we haven't noticed any important 27 | slowdowns. Should you notice any, you can always jump to the preferences page 28 | and tweak or completely disable this feature. 29 | 30 | You can enable/disable and tweak your color scheme from the configuration 31 | page. The highlighter will use Java colors by default, but there are more 32 | semantic classes in Scala, so make sure you tweak them to your liking. We 33 | suggest the Java-based `Color Theme`_ plugin as a starting point. 34 | 35 | .. image:: images/prefs.png 36 | 37 | 38 | .. _Color Theme: http://www.eclipsecolorthemes.org/?view=plugin 39 | 40 | Thank you 41 | --------- 42 | 43 | Semantic highlighting was contributed by `Matt Russel`_. Thank you! 44 | 45 | .. _Matt Russel: http://twitter.com/#!/mattrusselluk -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/show-inferred-semicolons.rst: -------------------------------------------------------------------------------- 1 | Show Inferred Semicolons 2 | ======================== 3 | 4 | Use the |icon| toggle button in the to enable *infer semicolons*. It will display the inferred semicolons in gray as an overlay on the code. 5 | 6 | .. |icon| image:: images/show_inferred_semicolons.png 7 | 8 | Without: |without| With: |with| 9 | 10 | .. |without| image:: images/feature-inferredsemicolons-01.png 11 | .. |with| image:: images/feature-inferredsemicolons-02.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/show-type-of-selection.rst: -------------------------------------------------------------------------------- 1 | Show Type of Selection 2 | ====================== 3 | 4 | It often happens that during development you'd like to know what is the type of a Scala expression. This can 5 | be very handy when 'debugging' a type error, for instance inside a for comprehension, or a pattern match. 6 | 7 | Similarly to the hover window, you can invoke the ``Show Type`` command on any expression, and get back the type 8 | of selection. Of course, this relies on the expression being type-correct. 9 | 10 | 11 | .. image:: images/show-type.png 12 | 13 | If you choose ``Show Type`` an overlay window will appear, showing the inferred type of the selection. 14 | 15 | .. image:: images/show-type-window.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/generate-before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/generate-before.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/generate-existing-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/generate-existing-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-after.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/hashcode-and-equals-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/productN-after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/productN-after.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/images/productN-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/typingviewing/source-generators/images/productN-dialog.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/source-generators/index.rst: -------------------------------------------------------------------------------- 1 | Source generators 2 | ################# 3 | 4 | Tired of writing ``hashCode`` and ``equals`` implementations by hand? Now you can let the IDE take care of it! The following source generators can be found under the *Source* context menu that appears after right-clicking in the editor. 5 | 6 | Generate hashCode and equals 7 | ============================ 8 | *Generate hashCode and equals* generates implementations for the ``hashCode`` and ``equals`` methods based on selected class parameters. The implementations are based on the recommendations from `Programming in Scala`_. This includes a ``canEqual`` method, thus the ``Equals`` trait is mixed in as well. 9 | 10 | .. _`Programming in Scala`: http://www.artima.com/pins1ed/object-equality.html 11 | 12 | To start this refactoring simply select a class. As an example we will use the class ``Generate``: 13 | 14 | .. image:: images/generate-before.png 15 | 16 | In the refactoring dialog the class parameters that should be included in the equals comparison and the hashcode computation can be selected. Optionally calls to ``super`` can be inserted: 17 | 18 | .. image:: images/hashcode-and-equals-dialog.png 19 | 20 | Selecting both class parameters and inserting calls to ``super`` results in this: 21 | 22 | .. image:: images/hashcode-and-equals-after.png 23 | 24 | If the original class already has existing implementations for ``canEqual``, ``equals`` or ``hashCode``, the refactoring dialog offers the option to keep those or let them be replaced by newly generated implementations: 25 | 26 | .. image:: images/generate-existing-dialog.png 27 | 28 | Introduce ProductN trait 29 | ======================== 30 | Asked for by the community, *Introduce ProductN trait* is an extension of *Generate hashCode and equals*. In addition to *Generate hashCode and equals* this generator creates the methods ``_1`` to ``_n`` for the selected class parameters and mixes in the trait ``ProductN``, where *n* stands for the number of selected class parameters. 31 | 32 | The refactoring dialog is almost the same as for *Generate hashCode and equals*: 33 | 34 | .. image:: images/productN-dialog.png 35 | 36 | Selecting only the first parameter ``a`` and omitting calls to ``super`` results in this: 37 | 38 | .. image:: images/productN-after.png 39 | 40 | 41 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/structured-selection.rst: -------------------------------------------------------------------------------- 1 | Structured Selection 2 | ==================== 3 | 4 | Using ``alt+shift+up`` and ``alt+shift+down`` selects larger or smaller portion of the AST. It allows for quick selection of sub-expressions or statements. 5 | 6 | .. note:: 7 | Shortcuts are platform-dependent, and can be re-configured in the ``Keys`` preference page. The actions are named **Select Enclosing Element** and **Restore Last Selection**. 8 | 9 | .. image:: images/feature-structured-selection-01.png 10 | 11 | Hovering over the selection will also bring up a dialog dispaying 12 | the inferred type of the selected expression, just as it would if 13 | you put the cursor on a :doc:`specific element `. 14 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/typingviewing/syntax-highlighting.rst: -------------------------------------------------------------------------------- 1 | Syntax Highlighting 2 | =================== 3 | 4 | The Scala editor has full syntax highlighting support, including comments, control structures and embedded XML. 5 | 6 | .. image:: images/feature-syntax-highlighting-01.png 7 | :width: 100% 8 | :target: ../_images/feature-syntax-highlighting-01.png 9 | 10 | As one can see in the following preview, syntax highlighting works not only for Scala code, but also for Scaladoc and for string interpolation: 11 | 12 | .. image:: images/example.png 13 | 14 | In the following picture there are all literals shown that are available in Scala. Note that escape sequences are shown in string and char literals as well as Unicode and octal sequences. 15 | 16 | .. image:: images/literals.png 17 | 18 | Inside of comments, the editor supports the feature to highlight so called task tags, also known as todo markers: 19 | 20 | .. image:: images/todo-markers.png 21 | 22 | Because this is a feature JDT supports too, they are not implemented as a complete separate feature. Instead, SDT uses the markers already defined by JDT, which can be found and configured in ``Preferences → Java → Compiler → Task Tags``. The task tags can also be shown on the right and left side of the editor as so called Annotations. These Annotations can be configured in ``Preferences → General → Editors → Text Editors → Annotations``. Furthermore it is possible to view the them in the Tasks View that can be found in ``Window → Show View → Other... → General → Other``. 23 | 24 | Configuration 25 | ------------- 26 | 27 | There are several options available how syntax highlighting can be configured. Beside the possibility to set fore- and background color it is possible to paint the text in bold and italic or to underline it. 28 | 29 | .. image:: images/preferences.png 30 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/wizards/images/code-completion-support.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/wizards/images/code-completion-support.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/wizards/images/new-file-wizard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/wizards/images/new-file-wizard.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/wizards/images/new-menu-scala-file-entry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/wizards/images/new-menu-scala-file-entry.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/wizards/images/search-field-scala-file-entry.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/wizards/images/search-field-scala-file-entry.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/features/wizards/images/template-preference-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/features/wizards/images/template-preference-page.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/images/video-coming-soon.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/images/video-coming-soon.jpg -------------------------------------------------------------------------------- /src/sphinx/4.0.x/index.rst: -------------------------------------------------------------------------------- 1 | User Documentation for the Scala IDE 4.x - Lithium 2 | ==================================================== 3 | 4 | This documentation is the starting point for the installation guide and other information regarding the use of the Scala IDE 4.x 5 | 6 | Contents: 7 | 8 | .. toctree:: 9 | :maxdepth: 3 10 | 11 | gettingstarted/index 12 | advancedsetup/index 13 | advancedsetup/scala-installations 14 | features 15 | /tutorials/index 16 | faq/index 17 | /community 18 | testingframeworks/index 19 | /license 20 | 21 | .. include:: /contribute.rst.inc 22 | 23 | .. toctree:: 24 | :hidden: 25 | 26 | faq/known-issues 27 | -------------------------------------------------------------------------------- /src/sphinx/4.0.x/testingframeworks/images/testing-junit-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/testingframeworks/images/testing-junit-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/testingframeworks/images/testing-scalatest-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/testingframeworks/images/testing-scalatest-01.png -------------------------------------------------------------------------------- /src/sphinx/4.0.x/testingframeworks/images/testing-specs-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/4.0.x/testingframeworks/images/testing-specs-01.png -------------------------------------------------------------------------------- /src/sphinx/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/_static/favicon.ico -------------------------------------------------------------------------------- /src/sphinx/community.rst: -------------------------------------------------------------------------------- 1 | Community 2 | ========= 3 | 4 | Mailing lists 5 | ------------- 6 | 7 | Scala IDE is using 2 mailing lists host on Google Groups: 8 | 9 | * `scala-ide-user`_ is the mailing list for questions and discussions relating to the installation and use of Scala IDE. 10 | 11 | * `scala-ide-dev`_ is the mailing list used by the development team and the committers to discuss current and future work on Scala IDE. 12 | 13 | When posting a message, please remember the suggestions from `How To Ask Questions The Smart Way`__. It helps you getting the best answer and us staying sane. 14 | 15 | __ http://www.catb.org/~esr/faqs/smart-questions.html 16 | 17 | IRC 18 | ------------- 19 | 20 | You can also drop by the #scalaide IRC channel on freenode. If you don't have an 21 | IRC client installed you can use this `online client`_. 22 | 23 | Reporting Problems 24 | ------------------ 25 | 26 | We welcome contributions in the form of bug reports. There are a few pieces of information that are helpful to have when you report a bug: 27 | 28 | * The version of Eclipse Scala IDE is running on. It is available under ``Help → About`` (``Eclipse → About`` on Mac osX). It appears as 'version number' and a 'build id'. 29 | 30 | * The version of Scala IDE used. There are 2 ways to obtain it: 31 | 32 | * Using ``Scala → Report a Bug...``. The window opened contains the plug-in version, and a link to the tickets page. 33 | 34 | * In the ``About`` page, using ``Installation Details``. It is the version of 'Scala IDE for Eclipse'. 35 | 36 | Please, first explore the `existing tickets`_. If you cannot add your contribution to any of them, use the ``New Ticket`` button on the `support page`_. 37 | 38 | If you're unsure if you have found an issue or not, please don't hesitate to ask on the `scala-ide-user`_ mailing list. 39 | 40 | 41 | .. _existing tickets: https://scala-ide-portfolio.assembla.com/spaces/scala-ide/support/tickets 42 | .. _scala-ide-user: http://groups.google.com/group/scala-ide-user 43 | .. _scala-ide-dev: http://groups.google.com/group/scala-ide-dev 44 | .. _support page: http://scala-ide-portfolio.assembla.com/spaces/scala-ide/support/tickets 45 | .. _online client: http://webchat.freenode.net/ 46 | -------------------------------------------------------------------------------- /src/sphinx/contribute.rst.inc: -------------------------------------------------------------------------------- 1 | .. topic:: Contribute! 2 | 3 | This documentation could use your help to grow and be refined. It is managed as a GitHub project at http://github.com/scala-ide/docs. Use the different available :doc:`tools ` to communicate with development team. 4 | 5 | .. note:: 6 | 7 | The documentation is redacted using `reStructuredText markup language `_ (reST). As with other `markup languages `_, reST is the moral descendant of DocBook, and intended to be a lightweight way to structure text without having to deal with the presentation details involved in HTML. You can find references and tools for editing reST on its `wikipedia page `_. 8 | -------------------------------------------------------------------------------- /src/sphinx/current-user-doc: -------------------------------------------------------------------------------- 1 | 4.0.x -------------------------------------------------------------------------------- /src/sphinx/dev/appendix/appendix.rst: -------------------------------------------------------------------------------- 1 | Appendix 2 | ======== 3 | 4 | Contents: 5 | 6 | .. toctree:: 7 | :maxdepth: 1 8 | 9 | what-to-work-on 10 | git-github 11 | resources 12 | shortcuts 13 | -------------------------------------------------------------------------------- /src/sphinx/dev/appendix/shortcuts.rst: -------------------------------------------------------------------------------- 1 | .. _shortcuts: 2 | 3 | Suggested Shortcuts 4 | =================== 5 | 6 | Here you can find a collection of shortcuts you will find useful for Scala development. Replace ``Ctrl`` by ``CMD`` if you are using a Mac. 7 | 8 | 9 | * ``Alt+Shift+X S``: Run As Scala Application. It is quicker than the popup menu because it does not need to scan every Launcher to see what type of Launches can be acted upon. 10 | * ``Alt+Shift+X T``: Run As JUnit. Also quicker than a popup menu for the same reasons. 11 | * ``Ctrl+Space``: completion (using code, templates,...) 12 | * ``Alt + /``: complete word (unless you have chosen to integrate word completion in completion proposals above) 13 | * ``Ctrl + /``: toggle comment of a block (the selected line(s) or current line) 14 | * ``Ctrl-3``: Quick Access -- a huge time saver. Opens up a dialog with incremental search on all commands available on the platform 15 | * ``Ctrl-Shift-R``: Open Resource -- opens up a dialog with incremental search on all files in the workspace 16 | * ``Ctrl-.``: Go to the next error in the current editor 17 | * ``F2``: Show the error for the position under the cursor 18 | * ``F3``: Navigate to definition (same as ``Ctrl-click`` on an identifier) 19 | * ``Ctrl-O``: Quick Outline -- opens up a dialog with incremental search on all definitions in the current editor 20 | * ``Ctrl-J``: Incremental search 21 | * ``F11`` or ``CMD-F11`` (Mac only): Launch the debugger. By default it tries to launch the current file. I configure Eclipse to always launch the last application. 22 | * ``Ctrl-F11`` or ``CMD-Shift-F11`` (Mac only): Launch the application (with no debugger attached) 23 | -------------------------------------------------------------------------------- /src/sphinx/dev/appendix/what-to-work-on.rst: -------------------------------------------------------------------------------- 1 | What to work on 2 | =============== 3 | 4 | You probably already know exactly what you're interested in working on! Whatever you decide to work 5 | on, please post a message on the `scala-ide-dev `_ 6 | list to see if anyone else is working on anything related and collaborate if possible. 7 | 8 | If you are looking around for things to work on, have a look at the `Enhancements 9 | `_ milestones. We listed 10 | a number of well-delimited improvements that are nice-to-have and nobody is currently working on. 11 | 12 | See `Open Tickets `_ for further 13 | inspiration. 14 | 15 | Last, our :ref:`testing_regression-test-suite` could be expanded. Creating tests is one of the best 16 | way to start contributing now and bring immediate value to the project! -------------------------------------------------------------------------------- /src/sphinx/dev/architecture/expression-evaluator.rst: -------------------------------------------------------------------------------- 1 | .. Copyright (c) 2015 Contributor. All rights reserved. 2 | 3 | .. include:: /global_defs.hrst 4 | 5 | Expression evaluator |new| 6 | ========================== 7 | 8 | Scala debugger uses new expression evaluator, which translates user code into invocations of ``JDI`` remote calls. This allows evaluation of expression in context of some breakpoint, with access to local variables and methods. 9 | 10 | .. _expression-evaluator: 11 | 12 | Expression evaluation 13 | --------------------- 14 | 15 | Overview 16 | ~~~~~~~~ 17 | 18 | Main entry point into expression evaluation in Scala IDE debugger is ``ExpressionManager`` object which takes care of holding debug session state, and evaluating expressions in GUI friendly way. 19 | 20 | Expression evaluation is done in ``ExpressionEvaluator`` which parses the code using ``ToolBox``, applies several transformations to it and then compiles the result with ``ToolBox``. 21 | 22 | Transformation phases 23 | ~~~~~~~~~~~~~~~~~~~~~ 24 | 25 | Before evaluation multiple AST transformations (called ``phases``) are performed. 26 | 27 | Those are split into 3 groups: 28 | 29 | * First few of them are necessary to make user-defined code type-check. Unbound variables, lambdas, usages of ``this`` and ``super`` etc. are mocked. 30 | * Next comes type-check (from ``ToolBox``), which expands implicits, assigns types and make some other Scala magic. 31 | * After type-check code is transformed further to allow remote execution. All mocks and method calls are replaced with code mimicking their behavior using ``JDI`` calls to debugged jvm. 32 | 33 | JdiProxy 34 | ~~~~~~~~ 35 | 36 | Every type used in evaluated expression is replaced with ``JdiProxy``. Those proxies uses ``scala.Dynamic`` trait to intercept all method calls and proxy them to debugged jvm. 37 | 38 | Because of different handling of arrays, primitives and ``String``\s on jvm, we had to create a separate proxy flavors for each of those. 39 | 40 | JdiContext 41 | ~~~~~~~~~~ 42 | 43 | All methods related to debugged jvm are encapsulated within a ``JdiContext`` instance. It provides abilities to: 44 | 45 | * run methods on debugged jvm, 46 | * access types and values in context of debugged jvm, 47 | * load new classes on debugged jvm, 48 | * create proxies for values and object by name, 49 | * create String representations of proxies etc. 50 | 51 | Conditional breakpoints 52 | ----------------------- 53 | 54 | Support for conditional breakpoints is placed in ``ConditionManager`` and relies on ``ExpressionManager`` to do all heavy lifting. -------------------------------------------------------------------------------- /src/sphinx/dev/ide-extensions/ide-extensions.rst: -------------------------------------------------------------------------------- 1 | .. include:: /global_defs.hrst 2 | 3 | IDE Extensions |new| 4 | ==================== 5 | 6 | It is possible to extend the Scala IDE with your own plugins - this section provides the necessary documentation to help you to write your own extensions. 7 | 8 | Contents: 9 | 10 | .. toctree:: 11 | wizards/index 12 | semantic-annotations/index 13 | -------------------------------------------------------------------------------- /src/sphinx/dev/index.rst: -------------------------------------------------------------------------------- 1 | Welcome to the Scala IDE Developer Documentation 2 | ================================================ 3 | 4 | This document is intended for developers interested in exploring with the Scala IDE sources to 5 | contribute to the project. 6 | 7 | Feel free to ask questions related to the Scala IDE internals and discuss ideas for enhancements 8 | and bug fixes on the `scala-ide-dev `_ mailing list. 9 | 10 | 11 | 12 | Contents: 13 | 14 | .. toctree:: 15 | :maxdepth: 2 16 | 17 | setup/setup 18 | building/building 19 | architecture/architecture 20 | architecture/presentation-compiler 21 | architecture/expression-evaluator 22 | code/code 23 | ide-extensions/ide-extensions 24 | testing/testing 25 | repository-organization/repository-organization 26 | workflow/workflow 27 | appendix/appendix 28 | release/how-to-create-release 29 | /license 30 | 31 | .. include:: /contribute.rst.inc 32 | -------------------------------------------------------------------------------- /src/sphinx/dev/repository-organization/repository-organization.rst: -------------------------------------------------------------------------------- 1 | .. _repository-organization_page: 2 | 3 | Repository organization 4 | ======================= 5 | 6 | Ideally, the project's directory structure should be close to the following: 7 | 8 | .. code-block:: text 9 | 10 | | - master 11 | | - feature 12 | | - gwt-support 13 | | - issue 14 | | - scala-java-interop-1000508 15 | | - scaladoc-hover-1000210 16 | | - platform 17 | | - indigo-3.7 18 | | - juno-3.8 19 | | - release 20 | | - scala-ide-2.0.0 21 | | - scala-ide-2.0.x 22 | 23 | * ``master``: The main development branch. 24 | * ``feature``: Hosts branches for trying out ideas. 25 | * ``issue``: All branches under `issue` are related to an Assembla ticket. The ticket's number must 26 | be suffixed to the name of the branch. 27 | * ``platform``: Branches for experimental support of future Eclipse platforms (with different JDT). 28 | * ``release``: Development branches for a target release. Stability is an important requirement for 29 | all branches living here. 30 | 31 | Branches should be named using the following :ref:`convention `. 32 | 33 | -------------------------------------------------------------------------------- /src/sphinx/dev/setup/images/sbt-full-jars.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/dev/setup/images/sbt-full-jars.png -------------------------------------------------------------------------------- /src/sphinx/dev/setup/images/setup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/dev/setup/images/setup.png -------------------------------------------------------------------------------- /src/sphinx/dev/testing/testing.rst: -------------------------------------------------------------------------------- 1 | .. _testing_regression-test-suite: 2 | 3 | Regression Test Suite 4 | ===================== 5 | 6 | The Scala IDE relies for most of its functionality on two pillars: 7 | 8 | .. toctree:: 9 | :maxdepth: 1 10 | 11 | eclipse-tests 12 | presentation-compiler-tests 13 | 14 | Testing should therefore be directed to the two of them, but also to their integration. 15 | 16 | 17 | While unit tests make sense, it is sometimes difficult to test things in isolation, especially when 18 | they involve the Scala compiler. Imagine a test for code completion: there must be a source file, a 19 | position inside the source file, an instantiated Scala PC, a correct classpath. For hyperlinking, it 20 | may be even worse: in addition to the above, you’d need to have a source locator (in order to find 21 | attached sources to a jar file). Of course, you could mock most of these things, but that would be 22 | very tedious. The alternative is to use real projects and an Eclipse instance, where this 23 | functionality can be tested programmatically. We call them integration tests, because they exercise 24 | a full Eclipse installation, and mimic very much what the user is doing. 25 | 26 | .. note:: 27 | 28 | All tests have to run without a UI (headless mode). If any UI class is instantiated, the test 29 | will fail in Jenkins (the slaves do not have a GUI). Make sure that any test you write does not 30 | depend on UI classes, and always check that the test runs from the command line. 31 | 32 | .. note:: 33 | 34 | The presentation compiler test suite is part of the `Scala project source tree 35 | `_. -------------------------------------------------------------------------------- /src/sphinx/global_defs.hrst: -------------------------------------------------------------------------------- 1 | 2 | .. role:: strikethrough 3 | 4 | .. role:: raw-html(raw) 5 | :format: html 6 | 7 | .. |done| replace:: :raw-html:`done` 8 | .. |progress| replace:: :raw-html:`in progress` 9 | .. |testing| replace:: :raw-html:`testing` 10 | .. |new| replace:: :raw-html:`new` 11 | .. |updated| replace:: :raw-html:`updated` 12 | .. |plugin| replace:: :raw-html:`plug-in` 13 | 14 | .. |keystroke-mouse| replace:: :raw-html:`Ctrl/Cmd` 15 | .. |keystroke-keyboard| replace:: :raw-html:`ALT+F3` -------------------------------------------------------------------------------- /src/sphinx/image_placeholder.rst: -------------------------------------------------------------------------------- 1 | Image placeholder 2 | ================= 3 | 4 | .. image:: /images/splash-getting-started-video.png 5 | .. image:: /images/splash-features-video.png 6 | .. image:: /images/splash-nn30-overview-video.png 7 | .. image:: /images/splash-nn30-improved-features-video.png 8 | .. image:: /images/splash-nn30-new-features-video.png 9 | .. image:: /images/splash-nn30-scala-debugger-video.png 10 | 11 | -------------------------------------------------------------------------------- /src/sphinx/images/frflag.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/frflag.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-features-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-features-video.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-getting-started-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-getting-started-video.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-nn30-improved-features-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-nn30-improved-features-video.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-nn30-new-features-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-nn30-new-features-video.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-nn30-overview-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-nn30-overview-video.png -------------------------------------------------------------------------------- /src/sphinx/images/splash-nn30-scala-debugger-video.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/splash-nn30-scala-debugger-video.png -------------------------------------------------------------------------------- /src/sphinx/images/usflag.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/images/usflag.png -------------------------------------------------------------------------------- /src/sphinx/index.rst: -------------------------------------------------------------------------------- 1 | .. Scala IDE documentation master file, created by 2 | sphinx-quickstart on Fri Nov 25 18:15:04 2011. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to Scala IDE's documentation! 7 | ===================================== 8 | 9 | `Scala IDE`_ provides support for development of Scala applications in the Eclipse platform. Its main target is the support for the `Scala`_ language and the integration with the Eclipse Java tools. It provides many of the features Eclipse users have come to expect including: 10 | 11 | * Support for mixed Scala/Java projects and any combination of Scala/Java project dependencies. Type driven operations are transparent across Scala and Java files and projects, allowing straightforward references from Scala to Java and vice versa. 12 | 13 | * A Scala editor with syntax highlighting, inferred type, hyperlinking to definitions, code completion, error and warning markers, indentation, brace matching. 14 | 15 | * Project and source navigation including Scala support in the Package explorer view with embedded outline, outline view, quick outline, open type, open type hierarchy. 16 | 17 | * Incremental compilation, application launching with integrated debugger, hyperlinking from stack traces to Scala source, interactive console. 18 | 19 | * Support for Eclipse plug-in and OSGi development including hyperlinking to Scala source from plugin.xml and manifest files. 20 | 21 | The Scala IDE is released under a :doc:`BSD-like license ` and community involvement in its development is strongly encouraged. See the :doc:`Developer Documentation ` on how to take part. 22 | 23 | This documentation is the starting point for the installation guide and other information regarding the use of the Scala IDE for Eclipse. 24 | 25 | Contents: 26 | 27 | .. toctree:: 28 | :maxdepth: 2 29 | 30 | current-user-doc/index 31 | videos 32 | tutorials/index 33 | changelog 34 | 2.0.x/index 35 | 4.0.x/index 36 | Developer Documentation 37 | 38 | .. include:: /contribute.rst.inc 39 | 40 | .. toctree:: 41 | :hidden: 42 | 43 | 3.0.x/index 44 | 4.0.x/index 45 | user/faq 46 | user/gettingstarted 47 | image_placeholder 48 | 49 | .. _Scala: http://www.scala-lang.org/ 50 | .. _Scala IDE: http://www.scala-ide.org/ 51 | 52 | -------------------------------------------------------------------------------- /src/sphinx/license.rst: -------------------------------------------------------------------------------- 1 | License 2 | ======= 3 | 4 | SCALA LICENSE 5 | 6 | Copyright (c) 2002-2010 EPFL, Lausanne, unless otherwise specified. All rights reserved. 7 | 8 | This software was developed by the Programming Methods Laboratory of the Swiss Federal Institute of Technology (EPFL), Lausanne, Switzerland. 9 | 10 | Permission to use, copy, modify, and distribute this software in source or binary form for any purpose with or without fee is hereby granted, provided that the following conditions are met: 11 | 12 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 13 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 14 | 3. Neither the name of the EPFL nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 15 | 16 | THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 17 | -------------------------------------------------------------------------------- /src/sphinx/resources/screenshots/ScalaIDE-2.0.0-large.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/resources/screenshots/ScalaIDE-2.0.0-large.png -------------------------------------------------------------------------------- /src/sphinx/resources/screenshots/ScalaIDE-2.0.0-small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/resources/screenshots/ScalaIDE-2.0.0-small.png -------------------------------------------------------------------------------- /src/sphinx/sources/README.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | Sources folder 4 | ============== 5 | 6 | This folder contains projects used to create the screenshots visible in the documentation. 7 | -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/.classpath: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/.project: -------------------------------------------------------------------------------- 1 | 2 | testing frameworks 3 | 4 | 5 | org.scala-ide.sdt.core.scalabuilder 6 | 7 | 8 | 9 | org.scala-ide.sdt.core.scalanature 10 | org.eclipse.jdt.core.javanature 11 | 12 | -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/build.sbt: -------------------------------------------------------------------------------- 1 | name := "testing frameworks" 2 | 3 | version := "0.1" 4 | 5 | scalaVersion := "2.9.1" 6 | 7 | libraryDependencies ++= Seq( 8 | "org.scalatest" %% "scalatest" % "1.6.1" % "test", 9 | "org.specs2" %% "specs2" % "1.6.1", 10 | "org.specs2" %% "specs2-scalaz-core" % "6.0.1" % "test", 11 | "junit" % "junit" % "4.8.1" % "test" 12 | ) 13 | -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/project/build.sbt: -------------------------------------------------------------------------------- 1 | 2 | resolvers += Classpaths.typesafeResolver 3 | 4 | addSbtPlugin( "com.typesafe.sbteclipse" % "sbteclipse" % "1.5.0" ) 5 | -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/src/test/scala/junit/SimpleTest.scala: -------------------------------------------------------------------------------- 1 | package junit 2 | 3 | import scala.collection.mutable.ListBuffer 4 | import org.junit.Test 5 | import org.junit.Assert._ 6 | 7 | class SimpleTest { 8 | 9 | @Test def +() { 10 | val list= new ListBuffer[String] 11 | list + "one" 12 | assertEquals("Wrong list state", ListBuffer("one"), list) 13 | } 14 | 15 | @Test def isEmptyTrue() { 16 | val list= new ListBuffer[String] 17 | assertTrue("list should be empty", list.isEmpty) 18 | } 19 | 20 | @Test def isEmptyFalse() { 21 | val list= ListBuffer("one") 22 | assertFalse("list should not be empty", list.isEmpty) 23 | } 24 | 25 | } -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/src/test/scala/scalatest/ExampleSuite.scala: -------------------------------------------------------------------------------- 1 | package scalatest 2 | 3 | import org.scalatest.FunSuite 4 | import org.scalatest.BeforeAndAfter 5 | import scala.collection.mutable.Stack 6 | import org.junit.runner.RunWith 7 | import org.scalatest.junit.JUnitRunner 8 | 9 | @RunWith(classOf[JUnitRunner]) 10 | class ExampleSuite extends FunSuite with BeforeAndAfter { 11 | 12 | var stack: Stack[Int] = _ 13 | 14 | before { 15 | stack = new Stack[Int] 16 | } 17 | 18 | test("pop is invoked on a non-empty stack") { 19 | 20 | stack.push(1) 21 | stack.push(2) 22 | val oldSize = stack.size 23 | val result = stack.pop() 24 | assert(result === 2) 25 | assert(stack.size === oldSize - 1) 26 | } 27 | 28 | test("pop is invoked on an empty stack") { 29 | 30 | intercept[NoSuchElementException] { 31 | stack.pop() 32 | } 33 | assert(stack.isEmpty) 34 | } 35 | } -------------------------------------------------------------------------------- /src/sphinx/sources/testing-frameworks/src/test/scala/specs2/HelloWorldSpec.scala: -------------------------------------------------------------------------------- 1 | package specs2 2 | 3 | import org.specs2._ 4 | import org.junit.runner.RunWith 5 | import org.specs2.runner.JUnitRunner 6 | 7 | @RunWith(classOf[JUnitRunner]) 8 | class HelloWorldSpec extends Specification { def is = 9 | 10 | "This is a specification to check the 'Hello world' string" ^ 11 | p^ 12 | "The 'Hello world' string should" ^ 13 | "contain 11 characters" ! e1^ 14 | "start with 'Hello'" ! e2^ 15 | "end with 'world'" ! e3^ 16 | end 17 | 18 | def e1 = "Hello world" must have size(11) 19 | def e2 = "Hello world" must startWith("Hello") 20 | def e3 = "Hello world" must endWith("world") 21 | } -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/images/bg.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/themes/scala-ide/static/resources/images/bg.jpg -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/themes/scala-ide/static/resources/images/logo.png -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/images/watermark.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/themes/scala-ide/static/resources/images/watermark.png -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/bootstrap-dropdown-app.js: -------------------------------------------------------------------------------- 1 | $(document).ready(function(){ 2 | $('.top-bar').dropdown(); 3 | }); -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/bootstrap-dropdown.js: -------------------------------------------------------------------------------- 1 | /* ============================================================ 2 | * bootstrap-dropdown.js v1.3.0 3 | * http://twitter.github.com/bootstrap/javascript.html#dropdown 4 | * ============================================================ 5 | * Copyright 2011 Twitter, Inc. 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | * ============================================================ */ 19 | 20 | 21 | !function( $ ){ 22 | 23 | /* DROPDOWN PLUGIN DEFINITION 24 | * ========================== */ 25 | 26 | $.fn.dropdown = function ( selector ) { 27 | return this.each(function () { 28 | $(this).delegate(selector || d, 'click', function (e) { 29 | var li = $(this).parent('li') 30 | , isActive = li.hasClass('open') 31 | 32 | clearMenus() 33 | !isActive && li.toggleClass('open') 34 | return false 35 | }) 36 | }) 37 | } 38 | 39 | /* APPLY TO STANDARD DROPDOWN ELEMENTS 40 | * =================================== */ 41 | 42 | var d = 'a.menu, .dropdown-toggle' 43 | 44 | function clearMenus() { 45 | $(d).parent('li').removeClass('open') 46 | } 47 | 48 | $(function () { 49 | $('html').bind("click", clearMenus) 50 | $('body').dropdown( '[data-dropdown] a.menu, [data-dropdown] .dropdown-toggle' ) 51 | }) 52 | 53 | }( window.jQuery || window.ender ); -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/contentsFix.js: -------------------------------------------------------------------------------- 1 | jQuery(document).ready(function($) { 2 | 3 | $("#toc ul").each(function(){ 4 | var elem = $(this); 5 | if (elem.children().length == 0) { 6 | $(".contents-title").css("display","none"); 7 | } 8 | }); 9 | 10 | }); -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/effects.highlight.js: -------------------------------------------------------------------------------- 1 | /* 2 | * jQuery UI Effects Highlight @VERSION 3 | * 4 | * Copyright (c) 2008 Aaron Eisenberger (aaronchi@gmail.com) 5 | * Dual licensed under the MIT (MIT-LICENSE.txt) 6 | * and GPL (GPL-LICENSE.txt) licenses. 7 | * 8 | * http://docs.jquery.com/UI/Effects/Highlight 9 | * 10 | * Depends: 11 | * effects.core.js 12 | */ 13 | (function($) { 14 | 15 | $.effects.highlight = function(o) { 16 | 17 | return this.queue(function() { 18 | 19 | // Create element 20 | var el = $(this), props = ['backgroundImage','backgroundColor','opacity']; 21 | 22 | // Set options 23 | var mode = $.effects.setMode(el, o.options.mode || 'show'); // Set Mode 24 | var color = o.options.color || "#ffff99"; // Default highlight color 25 | var oldColor = "#f2f2eb"; 26 | 27 | // Adjust 28 | $.effects.save(el, props); el.show(); // Save & Show 29 | el.css({backgroundImage: 'none', backgroundColor: color}); // Shift 30 | 31 | // Animation 32 | var animation = {backgroundColor: oldColor }; 33 | if (mode == "hide") animation['opacity'] = 0; 34 | 35 | // Animate 36 | el.animate(animation, { queue: false, duration: o.duration, easing: o.options.easing, complete: function() { 37 | if(mode == "hide") el.hide(); 38 | $.effects.restore(el, props); 39 | if (mode == "show" && jQuery.browser.msie) this.style.removeAttribute('filter'); 40 | if(o.callback) o.callback.apply(this, arguments); 41 | el.dequeue(); 42 | }}); 43 | 44 | }); 45 | 46 | }; 47 | 48 | })(jQuery); -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/highlightCode.js: -------------------------------------------------------------------------------- 1 | jQuery(document).ready(function($) { 2 | if (typeof disableStyleCode != "undefined") { 3 | return; 4 | } 5 | var a = false; 6 | $("pre").each(function() { 7 | if (!$(this).hasClass("prettyprint")) { 8 | $(this).addClass("prettyprint lang-scala linenums"); 9 | a = true 10 | } 11 | }); 12 | if (a) { prettyPrint() } 13 | }); 14 | -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/javascript/scrollTo.js: -------------------------------------------------------------------------------- 1 | jQuery(document).ready(function($) { 2 | $(".scroll").click(function(event){ 3 | event.preventDefault(); 4 | $('html,body').animate({scrollTop:$(this.hash).offset().top}, 300); 5 | $('html,body').animate({scrollTop:$(this.hash).offset().top-=5}, 300); 6 | $(this.hash).effect("highlight", {color: "#FFCC85"}, 2000); 7 | }); 8 | }); -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/static/resources/stylesheets/prettify.css: -------------------------------------------------------------------------------- 1 | .com { color: #93a1a1; font-weight: normal; } 2 | .lit { color: #195f91; font-weight: normal; } 3 | .pun, .opn, .clo { color: #595050; } 4 | .fun { color: #dc322f; font-weight: normal; } 5 | .str, .atv { color: #83b925; font-weight: normal; } 6 | .kwd, .tag { color: #30a628; font-weight: normal; } 7 | .typ, .atn, .dec, .var { color: #008fa9; font-weight: normal; } 8 | .pln { color: #595050;/*color: #93a1a1;*/ font-weight: normal; } 9 | pre.prettyprint { 10 | background: #fefbf3; 11 | padding: 9px; 12 | border: 1px solid rgba(0,0,0,.2); 13 | -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.1); 14 | -moz-box-shadow: 0 1px 2px rgba(0,0,0,.1); 15 | box-shadow: 0 1px 2px rgba(0,0,0,.1); 16 | margin-top: 20px; 17 | } 18 | 19 | /* Specify class=linenums on a pre to get line numbering */ 20 | ol.linenums { margin: 0 0 0 40px; } /* IE indents via margin-left */ 21 | ol.linenums li { color: rgba(0,0,0,.15); line-height: 20px; } 22 | /* Alternate shading for lines */ 23 | li.L1, li.L3, li.L5, li.L7, li.L9 { } 24 | 25 | /* 26 | $base03: #002b36; 27 | $base02: #073642; 28 | $base01: #586e75; 29 | $base00: #657b83; 30 | $base0: #839496; 31 | $base1: #93a1a1; 32 | $base2: #eee8d5; 33 | $base3: #fdf6e3; 34 | $yellow: #b58900; 35 | $orange: #cb4b16; 36 | $red: #dc322f; 37 | $magenta: #d33682; 38 | $violet: #6c71c4; 39 | $blue: #268bd2; 40 | $cyan: #2aa198; 41 | $green: #859900; 42 | */ 43 | 44 | /*.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{*//*padding:2px;border:1px solid #888*//*}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}*/ -------------------------------------------------------------------------------- /src/sphinx/themes/scala-ide/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = basic 3 | stylesheet = resources/stylesheets/base.css 4 | pygments_style = none 5 | 6 | [options] 7 | 8 | -------------------------------------------------------------------------------- /src/sphinx/tutorials/continuations-plugin/images/1-continuations-disabled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/continuations-plugin/images/1-continuations-disabled.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/continuations-plugin/images/2-project-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/continuations-plugin/images/2-project-properties.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/continuations-plugin/images/3-use-project-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/continuations-plugin/images/3-use-project-settings.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/continuations-plugin/images/4-enable-continuations-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/continuations-plugin/images/4-enable-continuations-plugin.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/continuations-plugin/images/5-no-errors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/continuations-plugin/images/5-no-errors.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | Tutorials 2 | ========= 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | 7 | m2eclipse/index.rst 8 | play/index.rst 9 | lift24scalaide20/index.rst 10 | continuations-plugin/index.rst 11 | scalac-trunk/index.rst 12 | -------------------------------------------------------------------------------- /src/sphinx/tutorials/lift24scalaide20/images/01-lift_basic_folder_structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/lift24scalaide20/images/01-lift_basic_folder_structure.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/lift24scalaide20/images/02-import_project_dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/lift24scalaide20/images/02-import_project_dialog.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/lift24scalaide20/images/03-eclipse_project_structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/lift24scalaide20/images/03-eclipse_project_structure.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/lift24scalaide20/images/04-eclipse_run_configuration_jrebel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/lift24scalaide20/images/04-eclipse_run_configuration_jrebel.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/m2eclipse/images/archetypes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/m2eclipse/images/archetypes.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/m2eclipse/images/import.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/m2eclipse/images/import.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/m2eclipse/images/install-new-software.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/m2eclipse/images/install-new-software.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/m2eclipse/images/new-project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/m2eclipse/images/new-project.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/install-play2-plugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/install-play2-plugin.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-01.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-02.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-03.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-04.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-05.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-06.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-07.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-08.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-08.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-09.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-09.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-10.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-11.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-12.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-12.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-13.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-15.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-16.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-17.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-17.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-18.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-18.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/play20-scalaide20-19.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/play20-scalaide20-19.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/play/images/refresh-on-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/play/images/refresh-on-access.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/scalac-trunk/images/scalac-launch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/scalac-trunk/images/scalac-launch.png -------------------------------------------------------------------------------- /src/sphinx/tutorials/scalac-trunk/images/scalac-properties.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/tutorials/scalac-trunk/images/scalac-properties.png -------------------------------------------------------------------------------- /src/sphinx/user/faq.rst: -------------------------------------------------------------------------------- 1 | .. include:: /current-user-doc/faq/index.rst 2 | .. include:: /current-user-doc/faq/known-issues.rst 3 | -------------------------------------------------------------------------------- /src/sphinx/user/images/setup-diagnostics-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scala-ide/docs/3c9e5185fadcd078910ba9188b7073ff5d250371/src/sphinx/user/images/setup-diagnostics-01.png -------------------------------------------------------------------------------- /src/sphinx/videos.rst: -------------------------------------------------------------------------------- 1 | Videos 2 | ====== 3 | 4 | General 5 | ------- 6 | 7 | Getting started 8 | ............... 9 | 10 | .. raw:: html 11 | 12 |
13 | 14 |
15 | 16 | Scala IDE 3.0 17 | ------------- 18 | 19 | Quick overview 20 | .............. 21 | 22 | .. raw:: html 23 | 24 |
25 | 26 |
27 | 28 | .. _3-0-improved-features: 29 | 30 | Part 1: Improved features 31 | ......................... 32 | 33 | .. raw:: html 34 | 35 |
36 | 37 |
38 | 39 | .. _3-0-new-features: 40 | 41 | Part 2: New features 42 | .................... 43 | 44 | .. raw:: html 45 | 46 |
47 | 48 |
49 | 50 | .. _3-0-scala-debugger: 51 | 52 | Part 3: Scala debugger 53 | ...................... 54 | 55 | .. raw:: html 56 | 57 |
58 | 59 |
60 | 61 | Scala IDE 2.0 62 | ------------- 63 | 64 | Features overview 65 | ................. 66 | 67 | .. raw:: html 68 | 69 |
70 | 71 |
72 | 73 | 74 | 75 | --------------------------------------------------------------------------------