Difference between revisions of "pas2js modules"

From Free Pascal wiki
Jump to navigationJump to search
Line 1: Line 1:
== Module import ==
+
= Module import =
 
 
  
 
pas2js can convert the '''$linklib''' directive to a JS import statement:
 
pas2js can convert the '''$linklib''' directive to a JS import statement:
Line 42: Line 41:
 
diverge.
 
diverge.
  
== Demos ==
+
= Demos =
  
 
The pas2js demos/modules directory contains a series of subdirectories. Each subdirectory has 1 demo. Compile with the command-line as above:
 
The pas2js demos/modules directory contains a series of subdirectories. Each subdirectory has 1 demo. Compile with the command-line as above:
Line 50: Line 49:
 
</code>
 
</code>
  
=== Basic ===
+
== Basic ==
  
 
This shows a simple program, no units, that uses the linklib directive to
 
This shows a simple program, no units, that uses the linklib directive to
Line 56: Line 55:
 
the exported symbols from the modules.
 
the exported symbols from the modules.
  
=== Basic-Units ===
+
== Basic-Units ==
  
 
This is the same as the Basic  example, but the import definitions are split
 
This is the same as the Basic  example, but the import definitions are split
 
out in units.
 
out in units.
  
=== Flat ===
+
== Flat ==
  
 
This shows a simple program, no units, that uses the linklib directive to
 
This shows a simple program, no units, that uses the linklib directive to
Line 67: Line 66:
 
the exported symbols from the modules; no external class is used.
 
the exported symbols from the modules; no external class is used.
  
=== Flat-Units ===
+
== Flat-Units ==
  
 
This is the same as the flat example, but the import definitions are split
 
This is the same as the flat example, but the import definitions are split
 
out in units.
 
out in units.
  
== Module export ==
+
= Module export =
 
Module export is implemented using the existing pascal '''Library''' concept.
 
Module export is implemented using the existing pascal '''Library''' concept.
  
Line 107: Line 106:
 
export const Move = pas.library.Swim;
 
export const Move = pas.library.Swim;
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
=Using a Pascal Library=
  
 
HTML:
 
HTML:
Line 122: Line 123:
 
</html>
 
</html>
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
==Using Pascal Library from JavaScript==
 +
 +
Write me
 +
 +
==Using Pascal Library from Pascal==
 +
 +
Write me

Revision as of 14:16, 22 February 2022

Module import

pas2js can convert the $linklib directive to a JS import statement:

The following:

{$linklib ./modules/canvas.js canvas}

is converted to

import * as canvas from "./modules/canvas.js";

If the alias is omitted, one is constructed for you:

{$linklib ./modules/some-api.js}

is converted to import * as some_api from "./modules/some-api.js";

The import statements are always inserted in the main program. This is because modules are like windows libraries: self-contained programs, which only import and export well-defined symbols.

For this reason, a new target "operating system" has been invented: the module. This means that you must compile with target module:

pas2js -Tmodule -Jirtl.js main.pp

The nodejs target will also work, but in the future the 2 targets may diverge.

Demos

The pas2js demos/modules directory contains a series of subdirectories. Each subdirectory has 1 demo. Compile with the command-line as above:

pas2js -Tmodule -Jirtl.js main.pp

Basic

This shows a simple program, no units, that uses the linklib directive to import a javascript module. It uses an external class definition to access the exported symbols from the modules.

Basic-Units

This is the same as the Basic example, but the import definitions are split out in units.

Flat

This shows a simple program, no units, that uses the linklib directive to import a javascript module. It uses only external 'name' definitions to access the exported symbols from the modules; no external class is used.

Flat-Units

This is the same as the flat example, but the import definitions are split out in units.

Module export

Module export is implemented using the existing pascal Library concept.

A pas2js library is transpiled into a Javascript module with its own rtl.js and rtl.run. It can export global functions, static methods, and global variables.

For example a library exporting a function twice, as name Swim and as Move:

library Fish;
procedure Swim(w: word);
begin
end;
exports
  Swim;
  Swim name 'Move';
begin
end.

Compiled with "pas2js -Tmodule fish.pas" generates the following fish.js:

...rtl.js and system unit...
rtl.module("library", [], function () {
  var $mod = this;
  this.Swim = function (w) {
  };
  $mod.$main = function () {
  };
});
rtl.run("library");
export const Swim = pas.library.Swim;
export const Move = pas.library.Swim;

Using a Pascal Library

HTML:

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="utf-8">
    <title>Basic Pas2JS library example</title>
    <script type="module" src="fish.js"></script>
  </head>
  <body>

  </body>
</html>

Using Pascal Library from JavaScript

Write me

Using Pascal Library from Pascal

Write me