Equivalent Script API

Squish provides the same fundamental APIs in all the scripting languages it supports, plus some extra language-specific features where required, such as file handling in JavaScript because it isn't provided by the standard language. In this section, we will discuss how the APIs are used, noting the usage differences that are due to differences between the scripting languages themselves.

The differences are described in language-specific notes. For example, the Python Notes show how to access Python's built-in type function instead of Squish's type(objectOrName, text) function the JavaScript Notes and Extension APIs describe the additional APIs Squish makes available for file handling, interacting with the operating system, using XML, and using SQL, for example.

Sample Class

Before reviewing the differences, we take a look at the sample class that is used in the tables below.

For non-macOS platforms the tables use the following example C++ class:

class C
{
public:
    C();
    C(const char *s);

    void doA(bool b);
    static void doB();

    int p;
    ...
};

For macOS the tables use the following Objective-C class:

@interface C : NSObject
{
    ...
}

- (void)doA;
- (void)doB:(BOOL)b;
+ (void)doC;
+ (void)doD:(BOOL)b;

- (int)p;
- (void)setP:(int)newP;

...

@end

The tables also assume the existence of an object of type C called c.

The underscores in some of the calls in the tables relate to Objective C. See Functions and Properties (macOS) for details.

Equivalent Script Functions

The following tables provide a brief overview of the equivalent script functions for the most basic tasks such as creating an object, getting and setting a property, and performing comparisons. Although the actions performed are the same and use the same APIs, the actual example code differs because of the syntactic and structural differences between the scripting languages that Squish supports.

The Squish API documentation contains examples (almost always in all the supported scripting languages} and links to examples elsewhere in the manual. If an example is not shown in your scripting language, use the tables below to convert from one of the languages shown to the language you want.

Python

s = str(val) # or
s = unicode(val)

JavaScript

Perl

my $c = new C();  # new-style
my $c = C->new(); # old-style

my $c = new C("apple");  # new-style
my $c = C->new("apple"); # old-style

Ruby

Tcl

macOS Bindings

For macOS, here are the bindings specific to Objective-C objects: