# VisualWorks

VisualWorks (formerly ObjectWorks, afterward Cincom Smalltalk) is a cross-platform implementation of the Smalltalk language. It is implemented as a development system based on images, which are dynamic collections of software objects, each contained in a system image.
The lineage of VisualWorks goes back to the first Smalltalk-80 implementation by Xerox PARC. In the late 1980s, a group of Smalltalk-80 developers spun off ParcPlace Systems to further develop Smalltalk-80 as a commercial product. The commercial product was initially named ObjectWorks, and then VisualWorks. On August 31, 1999, the VisualWorks product was sold to Cincom Systems. VisualWorks runs under many operating systems, including Windows, macOS, Linux, and several Unix versions.
VisualWorks supports cross-platform development projects, because of its built-in multi-platform features. For example, a graphical user interface (GUI) application needs to be developed only once, and can then be switched to different widget styles. A VisualWorks application can be run on all supported platforms with no modifications. Only the virtual machine is platform-dependent.

## Benefits and drawbacks

VisualWorks allows for very fast application development, as individual methods can be compiled even while the program to be developed is running. Compiling a Smalltalk method typically takes significantly less than a second, while doing the same for a C++ project often takes a minute or more, and cannot be done easily without restarting the process. The various code browsers of VisualWorks help the developer to quickly locate a class or method of interest.
The performance and throughput of Smalltalk programs can approach the performance of static languages such as C++, Fortran, Pascal, or Ada using a just-in-time compiler by generating machine code that is specialised for frequently used types, but numeric processing and programs that benefit from precise memory layout may still run slower. The generational garbage collector minimises most collection pauses, but may not be suitable for hard real-time and determinism requirements, as long full collections may occur, which may stop the world for tens to hundreds of milliseconds, proportional to heap size. However, garbage collection is preferable over manual memory management in an object-oriented language, and the programmer can take various actions to control when and for how long garbage collection occurs; so under most circumstances, garbage collection is not a concern.

## Installation

All components of the VisualWorks system are installed on Windows 7 or later in a Program Files\Cincom directory named after the version number of the installed system – for instance, vw7.5nc. This directory contains several subdirectories including bin, doc, examples and many others.

## Mouse buttons and menus

VisualWorks assumes a three-button mouse with buttons having logical names <Select>, <Operate>, and <Window>. Although, a one or two button mouse can be used along with Ctrl, Option, or Command keys. <Select> selects any interface object. <Operate> brings up a menu of operations for the current view/selection. <Window> initiates actions (move, close...) on VisualWorks windows.

## File-in format

File-in format is the original Smalltalk format for representing classes as text files. These can be "filed in" to the VisualWorks IDE to generate any classes not already contained in the Smalltalk image. Every file-in document provides a simple textual representation of a Smalltalk class, or classes, in a text file with a .st suffix. It is still supported in VisualWorks, but has been superseded by a Parcels mechanism. There are examples in file-in format in the examples subdirectory.

## Parcels

Parcels are external file representations of packages.
An Examples Browser is provided as a parcel in the examples directory. Several image level switches are available to specify parcel loading on image startup. The parcel path is the list of directories where VisualWorks looks for parcels. This can be set using the System Settings tool.
Parcels provide the component technology for VisualWorks. Packages and bundles organize the code and model the contents of parcels. Parcels are created by publishing packages/bundles. The term components, in the VisualWorks sphere, is used to refer to parcels, packages, and bundles when it is not necessary to be specific.
The parcel code's organization on loading is determined by its creation. If it was created by publishing a package, it is loaded into the same package. If created from a bundle, it can be reloaded as the bundle or as one package.
The load sequence for a package is:
* Any prerequisite components are loaded.
* Any defined pre-load action is performed (e.g. undeclared variables initialized).
* Objects in the package are installed.
* Every class in the parcel is sent message post Load: the Package, and any action executed. This is often an application launch.

## Parcel manager

The Parcel Manager is used to load and unload all parcels on the parcel path. A Suggestions view lists Categories containing key add-in parcels-by selecting a category, you get a list of recommended parcels. For example, the UI Painter is located in the Essentials category. There is also a Directory-tree view of the parcel path, for finding parcels outside the Suggestions view. A Loaded view lists all parcels already in the image. Only loaded parcels can be browsed.
A supported VisualWorks product parcel is represented by an icon that looks like a parcel. Parcels from other vendors look like a shopping sack. Because of the convoluted history of Smalltalk class development this can be very useful. For instance, a parcel icon indicates that the Arbor hypertext system is now VisualWorks supported.
One can also load and unload parcels programmatically from the application.

## Packages

When a parcel is loaded it is organized as a package, or bundle of packages. When looking for code loaded from a parcel, one can locate the bundle or package with the same name in the System Browser. Packages are categories that organize classes into related groups, according to component. Packages can be grouped into bundles. Packages and bundles can be saved (published) as parcels, or saved into a source code repository.

## Loading code libraries

The initial visual.im image contains minimal development facilities, using basic class libraries. Additional class libraries are provided by VisualWorks or third-party vendors, usually as parcel files. For most non-Smalltalk development environments, code libraries are imported at compile time, using an include command. In Smalltalk, code libraries are loaded into the running system, and become part of the environment. For example, the UI Painter is loaded as a parcel.

## VisualWorks Launcher

The VisualWorks Launcher, usually just called the Launcher, is the control centre for the VisualWorks system. It is the launching pad for all the major tools.

## Smalltalk basics

Smalltalk is a pure object oriented programming language, which means the only way to get something to happen within Smalltalk is by sending messages to objects. VisualWorks uses the Smalltalk-80 language as standard, but comes with its own set of classes and methods. So even basic classes, like Object, differ from those in other Smalltalk-80 IDEs like Squeak and Dolphin Smalltalk. The illustrative examples here work in VisualWorks Smalltalk, but may not work in other Smalltalks because the classes and/or methods may differ.

## Browsing and editing Smalltalk code

In traditional object-oriented programming environments a developer directly edits a plain text source code file containing class and method definitions. In VisualWorks, like all Smalltalks, everything is an executing object, including classes. In browsing Smalltalk classes the developer gleans definitions from executing objects. The main browser/editor in VisualWorks is the System Browser. It allows the developer to browse classes either in the overall class hierarchy or through their packages. It is launched from the VisualWorks Launcher.
List panes in the System Browser allow developers to navigate to class and method definitions. They can then be viewed or edited in a code view, or modified with a new definitions.

## Undeclared variables

When a variable is deleted while references to it still exist, or is loaded via a parcel but never declared, its name enters the Undeclared name space. Undeclared variables can cause certain program errors.

## String and files

Cincom's first tutorial on VisualWorks illustrates how VisualWorks can be used to manipulate server log files. It illustrates how things like strings and files can be easily subsumed into the object structure within VisualWorks. Consider the Smalltalk expression:
One can evaluate this expression as-is in a VisualWorks workspace using one command in the operate menu. This creates:
* An object of class ByteString containing the string (as bytes) and the methods for manipulating it;
* An object of class NTFSFilename (in Windows XP); and
* An editor object.
The latter is a simple notebook-like editor containing the contents of the file. That is, the evaluation created a filename object as a gateway to the file ws000101.log and opened an editor onto it. The editor itself is an object, as are all its components (down to and including the characters in its menus). The source code is available for all these objects, and VisualWorks has a plethora of inspectors, browsers, and other tools for anyone to evaluate and inspect the code in static or dynamic mode.

## Tutorials

Tutorials are produced for Cincom Smalltalk often, and a Seaside tutorial exists.