pharo-ide / calypso

Pharo system browser

Calypso

The Pharo system browser (now live in Pharo 7)

Consists of:

• new navigation model
• fast table for UI
• tabs toolbar instead of single source code panel
  • separate tools in tabs to create/edit methods/classes
• explicit commands instead of duplicated menu and shortcuts
• extendable by plugins
• suitable for remote scenario
• new features:
  • method group view instead of protocols view
    • "dynamic protocols"
    • based on method tags as symbols
    • support multiple tags per method
    • not required star convention for class extension
  • package view is based on class groups
    • "dynamic protocols" for classes
    • based on class tags as symbols
    • support multiple tags per class
  • visibility option for inherited methods
  • methods inherited from traits are not shown by default
  • variable view as special mode for method group view.
  • and more

Contribution (Pharo 7 and higher)

Use dev branch of Calypso for contribution:

Metacello new
  baseline: 'Calypso';
  repository: 'github://pharo-ide/Calypso:dev/src';
  load

Pharo 6 installation

To install Calypso in Pharo 6 use following script (which disables Iceberg intergation):

Iceberg enableMetacelloIntegration: false.
Metacello new
  baseline: 'Calypso';
  repository: 'github://pharo-ide/Calypso:pharo6';
  load

To make Calypso default toolset evaluate:

ClyBrowserMorph beAllDefault

And to open browser evaluate:

ClyFullBrowser open.

Or use World menu Calypso item

Documentation

If you want to learn more about the architecture of Calypso, refer to the the Pharo Infrascture mini booklet as well as the ClassAnnotation project.

The classes in the Calypso package also have some high level documentation as well.

Problems

If you will find many processes hanging in the image it can be caused by some issue of critic plugin implementation. Some people report it in the past. It should be fixed now but there is always possibility that fix is not complete.

Following line should be enough to disable critic method group with all related computation. It is the main reason of that kind of problems:

ClyCriticEnvironmentPlugin disableMethodGroup.

It is not full critic disable. If it not helps then turn off it completely:

ClyCriticBrowserPlugin disable.
ClyCriticEnvironmentPlugin disable.
ClyNavigationEnvironment reset.

And please report this problem on issue tracker or with direct mail or Pharo mailing list.

calypso's Issues

Show path to method in MethodEditorTool when it is not clean from current selected context

For example method editor tool. When we edit method and move to another class/method without accepting changes we lost information about actual context inside this tool. This information exists but not shown to user. It would be nice to show it in such cases with ability (button) to move browser back to actual context of tool.

Implement "abstract" method group which shows all subclassResponsibility methods

Sorted column headers for MethodBrowser

It will be very useful to be able to sort methods by clicking on any column

Implement tool to preview selected morph classes

Implement class hierarchy view mode

Implement methods diff when two methods are selected

Toolbar: The ui should tell which radio are linked

Trying to use Calypso I see that "Flat classes" and "Hier." are linked together. But there is no indication that they are not linked to "Inst. side".

The UI should give this information. Maybe with separators?

Implement icons over methods when they override or overriden

Implement Match/Rewrite plugin

It should add extra tab which allow search and rewrite current selected scope of browser

Implement settings tab for packages and classes

If package or class define any settings (which shown in SettingsBrowser) it would be nice to see them directly in browser as special tool tab

[UI detail] gray out shortcuts in context menus

In standard Pharo menus, shortcuts (hotkeys) are "grayed out" - menu item title is black, shortcut is gray. It's small UI detail only.

Ergonomy: Toolbar should maybe be between the panels and the tabs.

The toolbar might benefit to be closer to the center of Calypso.

Editing methods from superclasses or traits should request when install new version

Calypso should provide same behaviour like editing trait method in Nautilus. It should ask where to install method when original was from superclass or trait

Protocol pane, inherited methods, awkward to select multiple superclasses

In 60334,

1. Select Collections-Streams > MultiByteBinaryOrTextStream
2. Expand "inherited methods"
   To show all inherited methods up from PositionableStream
   you need to expand "inherited methods" several times.

Options:
A. Leave "inherited methods" list open to allow multiple selections
B. Presumably the common case is not cherry picking superclasses, but picking all superclasses to a certain point in hierarchy. So maybe have a shift-click that selects all classes down to PositionableStream.

Comment pane should keep focus when changing classes

To get a quick overview of a package architecture, I like to flip through all the class comments. Currently changing class moves the focus away from the Comments tab, so it takes extra clicks to see it.

Implement inspector tab on class side variables

Class side variables are usually initialised with some values. It would be nice to see inspector for them directly in browser in extra tool tab

Multi-select should accumulate individual items, not just range

Really nice idea to multi-select. Still need to find its workflow in practice, but its a constraint to only multi-select a range with key. Accumulating individual selection via typical modifier would help.

In protocol pane, some extensions appear twice

In 60334,

1. ClySystemBrowser open.
2. Select Collections-Streams > PositionableStream
3. Select inherited methods > Object
4. Expand extensions
   ==> Epicea appears twice.

waitReadyMorphFor: missing

Hi!
I just had a look into this package and what I saw was a great upgrade on the Systems Browser! Great!
However, I had trouble to load the code into the most current Pharo6 image.

The mothod "waitReadyMorphFor:" is missing....

One notice on the side. It would be a great and an additional improvement if one would be presented the content of Class Variables in the 4th column (methods list view) upon selection in the 3rd column (categories list view). Like an inspector view...

Extension protocols not highlighted when method selected

Selecting... Collections-Streams > ReadWriteStream > inherited methods
asBinaryOrTextStream(PositionableStream) is shown normal
asZLibReadStream(PositionableStream) is shown grey
Can you explain?

It's easy. Class extension is shown with grey and #asZLibReadStream is from
Compression package.
Actually this logic is a bit different. If method not belongs to selected
package (from package view) then it will be shown with grey.
It is current logic of Nautilus.

Okay. That should have been obvious. So in trying to work out why my mind faltered, I think it may be because Nautlius provides visual feedback by light-highlighting the extension package (i.e. Compression) where Calypso does not - it only highlights real protocols.

Implement traits hierarchy view mode

Tabs created when we select a package/class/protocol/method should not be closable.

It's counter intuitive to have tab we closed reappearing when we click again on the entity. So I think the default tabs should not be closable.

Better updating selections after tree expansion

Try expand inherited methods group then select Object items and you will see all methods of Object.
Now if you collapse inherited group method panel will be not changed. It will be still show inherited methods.
Also expanding/collapsing break position of highlighted table rows

Some UI elements are not Dark Theme friendly

See: http://puu.sh/tfkUB/ce1c202363.png

The "inherited methods" label and also the color of the unselected tabs.
It's maybe not a problem of Calypso but I don't have the time to investigate more.

Implement "removed" method group with all methods removed by user

Add navigation history

It is very helpful to be able to step back and forth in history of movements. Without it Calypso is not very usable.

Better management of filtered EnvironmentContent

It is possible to retrieve new filtered content based on given one. Probably filtered version is not properly work, cached or garbage collected and maybe not react on environment changes

Protocol pane scroll bar doesn't position properly when items added

In 60334,

1. ClySystemBrowser open.
2. Select Collections-Streams > PositionableStream
3. Select inherited methods > Object
4. Scroll down to "extensions" at the bottom of list and expand it
   ==> scroll bar resizes okay, but it doesn't reposition. So it looks like you are already at the bottom of the list, when the bottom of list has moved with added items.

Is this maybe a FastTable issue?

World menu CalypsoBrowser is needed

entry under World > Tools?

Installation from Gofer asks to resolve dependencies in ClassTagAnnouncement and FTSubstringFilter

While installing from Gofer I got this warnings:

This package depends on the following classes:
  ClassTagAnnouncement
You must resolve these dependencies before you will be able to load these definitions: 
  ClassTagAnnouncement>>#fixEnvironmentContent:

This package depends on the following classes:
  FTSubstringFilter
You must resolve these dependencies before you will be able to load these definitions: 
  FTSubstringFilter>>#asClyItemFilter

and, of course, launching doesn't work without those dependencies installed. I'm working on Pharo 5. (Latest update: #50761)

Global shortcuts (at browser level as in Nautilus) is not supported

Implement settings menu for browser shortcuts

show setUp/teardown tabs for test cases

Implement message browser on same browser model

code editor should simple rename shortcut (cmd+r)

On dark theme virtual groups should be Color blue + Color green

Implement "inspector tool" for methods to provide bytecode, ir and ast views

Implement hierarchical class/method tags

New browser support multiple tags.
It would be nice to build and show tags hierarchically.
For example by simple convention #'accessing-private', #'accessing-public' browser could show tree with accessing as parent and private and public as children

Accumulate individual multi-selects using <Ctrl> modifier

Really nice idea to multi-select. Still need to trial its practical effect on my workflow, but it would help to be able to accumulate individual selections via typical modifier, rather than just range select with modifier.

implement package comment editor tool

Implement highlighting for method/class groups of selected method/class

Tooltip for the inherited methods

It is not obvious to know the exact effect of the check box and (T) icons at the right of the 'inherited method'.
Add contextualized tooltips, newbies will really appreciate it.
Nice work.

Review again how BrowserTool's implemented

Now I not completely happy with names in tool model and how model is defined:
Now model defined as #managedItems variables which is list of DataSourceItem's. It needs to be rethinking.

Drag and drop is not supported

Implement navigation history to go back/forward to previous/next selected item/tool

SortedMethods should put binary messages into beginning

Implement add new class command

With ConfigurationOfCalypso-DenisKudryashov.8
in packages pane, right-click > Add New Package "AAAA"
in empty classes pane, right-click > Add New Class
==> Instance of ClyStandardBrowserCommands did not understand #addNewClass

Implement "realize" method group where all superclass abstract methods are shown and ready to be implemented

Creation method on class side adds it to instance side

Implement nautilus method icons with Calypso way

Now special ClyNautilusBrowserPlugin is introduced to push method icons from Nautilus to Calypso.
To remove this plugin and dependency from Nautilus all this features should be implemented in terms of Calypso.
And at the end this plugins should be removed