Skip to content

Latest commit

 

History

History
117 lines (67 loc) · 8.27 KB

jadeitehelp.md

File metadata and controls

117 lines (67 loc) · 8.27 KB

Jadeite Help

Jadite Help

Jadeite is a graphical user interface for code development and debugging, for use with the Rowan code manager
within a GemStone environment. For more information, see the Github project.
 

This is a placeholder for online help for Jadeite.

Topics are:

Browser Code status decoration

Project status text decoration

The color, weight (cold) and italic font for a Project's name in the Console's Project List or the Projects Browser indicates the status of the Project in the image, vs. the on-disk status. This project information is also available via Hover help and in the Projects Browser Project tab.

 Project Pane of a Project Browser
Project List Pane Font Decorations

  • Normal font for a Project's name (that is, not red, bold, or italic) indicates that it is loaded, and there are no changes either in the image or on disk.

  • Bold font indicate that the Project has changes in the image that have not been written to disk.

  • Italic font indicates that the Project is dirty on disk, with respect to the git repository. For example, if you have previously written the project to disk without doing a git commit, the disk is dirty, although the image is clean with respect to the disk. Dirty on disk, however, can also mean that you have edited files on disk, or made changes from Jadeite and not saved your image before restarting.

  • Red font indicates there is skew; the sha on disk does not match the sha loaded into the image. This can result if you checkout a different git tag or branch, from Jadeite or on the git command line, if you perform git commit outside of jadeite on the git command line, or if you are working in a shared repository and do a git pull after another user has committed.

    If you see skew, it is generally recommended to refresh from disk to load the current git sha; otherwise, you should avoid making any changes or performing any git commits, to avoid the risk of logical corruption in the git repository.

    Jadeite does not currently support git merge; if you have changes and the repository is in skew, you will need to write your changes to disk without commit, and perform a git merge and resolve any conflicts outside of Jadeite.

  • (projectname) When the project name is enclosed in parentheis, it indicates that project does not exist on disk.

Class and Method status text decoration

When the Projects Browser displays a Package, it displays a list of all classes that are associated with that Package, and also displays classes that are in other Packages, but have extension methods that are in that Package.

When the Projects Browser displays a Class, it displays a list of all methods that are defined for that class, including methods that are in the selected Package and methods that are defined in other Packages.

  • A class is in normal font and a method in normal font indicate that the Class and method is defined in the selected Package or Packages.

  • If the class is in normal and the method is in purple and underlined , it indicates that the method is defined in a different package; the other package contains an extension method to the selected class.

    Use the method pop up menu item Go To Defining Package to see the Package for that method.

 Class that is not defined in the selected Package
Method Decorations Example

  • A class in purple indicates that the class definition is associated with a different package; the class is included in the list of classes since it has one or more extension methods that are defined in this package. Use the pop up menu item Go To Defining Package to see the Package for that class.

    In the example, the selected package holds only extension methods, so all classes in the example are purple (selecting a class masks the purple font, for readability).

  • If the class is in purple and the method is in normal font, it indicates that the method is defined in the same package as the class, and that neither the class nor the definition are in the selected package. The Class and Method pane pop up menu item Go To Defining Package will show the Package for that class/method.

    In the example, methods such as asDefinition are in normal font, indicating that they are defined in the same package as its class. The class RwDefinition and the method asDefinition are both defined in the package named Rowan-Definitions, while Rowan-Core-Definitions-Extensions is the selected package.

  • If the class is in purple and the method is in purple (not underlined), it indicates that the method is defined in the selected package; that is, this is an extension method in the selected package.

    The method comparePropertiesAgainstBase: is defined in the package Rowan-Core-Definitions-Extensions, which is the selected package, but not the package that its class is defined in.

  • If the class is in purple and the method is in purple and underlined , it indicates that the method is defined in a third package, neither the selected package nor the package that the class is defined on. Use the method pop up menu item Go To Defining Package to see the Package for that method.

    The method diffSton: is defined in another package, Rowan-Core-Definitions-Extensions-37; neither the selected package, nor its class's package.

Setting Font Sizes

To set the System Font, which controls pane labels, menus, tabs, and the display of class and method names, set a preference in Jadeite.prefs. You can use the Console menu item Edit Preferences File to set a font size. Legal values are an integer or nil for default font size.

For example, to set the font size to 11 (slightly larger than the default)

fontSize: 11

You will need to logout and login to see the change.

To set the Text Font for method bodies, workspaces, and similar text panes, you can also use the preferences file.

textFontSize: 11

You will need to logout and login to see the change.

You may also set this at runtime using the Projects Browser menu Preferences > Text Font Size.

Project Packaging Conventions

A feature of rowan is that a Package can contain methods that belong to classes that are in a different package. These are called extension methods. These methods show up in purple in the Project Browser (see Browser code status decoration). The way the programmer defines that a method should be part of a particular package varies; the rules are based on the Project's packaging convention.

To see the packaging convention for a project, see the Project Browser Project tab.
Options are:

Monticello

A leading asterisk in the method or class category indicates the package for the method. For example, a method category *myproject-tests means that all methods in that category belong to a package named MyProject-Tests. While Rowan and GemStone code often use lowercase package names, the category is case-insenstive. This convention is widely used within the Pharo community.
Other feature of Monticello convention is that a trailing -aString could be included, to provide a non-package related categorization. For example *myproject-tests-setup and *myproject-tests-behavior would both be packaged in the package named MyProject-Tests, although the method categories are distinct.
A problem associated with Monticello convention is the ambiguous case in which the -aString is ambigous; for example, if the packages MyProject-Tests and MyProject both exist.

RowanHybrid

The RowanHybrid is a modified version of the Monticello convention. A leading asterisks in the method or class category indicates the package for the method; however, the a trailing -aString is not allowed. This avoids the ambiguity of the Monticello convention.

Rowan

With the Rowan convention, package association is not controlled by category name; the underlying definition contains packaging information, and Jadeite tools allow you to move methods from package to package.