lazarus pas2js integration

From Free Pascal wiki
Revision as of 19:41, 21 July 2019 by Socke (talk | contribs) (Global options: Use definition list; added path to simpleserver)

English (en) русский (ru)

Lazarus pas2JS integration

Requires Lazarus 1.9+ and either a pas2js snapshot or svn checkout (see here).

Install the package pas2jsdsgn (components/pas2js/pas2jsdsgn.lpk) and restart the IDE.

Then set the path of pas2js (pas2jsfolder\compiler\utils\pas2js\pas2js.exe) in Tools / Options / Environment / Pas2JS / Path of pas2js.

The Lazarus pas2js integration has 3 parts to it:

Global options

In the Tools/Options... dialog, the Pas2JS section allows you to set some options that affect the IDE integration. It looks like this:

pas2jsdsgn globaloptions.png

The following settings are available:

Path of pas2js
This is the compiler binary used when setting up a new project.
It will be searched in the PATH if no absolute path is set. Corresponds to IDE macro Pas2JSJS.
Path of simpleserver
This is the webserver that is started when a project is run that needs a webserver.
This is by default the simpleserver application from the FPC project. The program can be found in the FPC sources in the directory fpcsrc\packages\fcl-web\examples\simpleserver and has to be compiled manually.

You may also use any other webserver, as long as it accepts the -p option to set the path, and it serves files from the directory in which it was started.

Port numbers to start allocating from
Every time you start a new webserver project, a new port number is allocated for the webserver. (you can still edit this in the new project dialog).
Browser to use when opening HTML page
The IDE will use this browser to open your HTML page.
It will be searched in the PATH if no absolute path is set. Corresponds to IDE macro Pas2JSBrowser.
Node.js executable
The IDE will use this Node.js executable to start a Node.js project.
It will be searched in the PATH if no absolute path is set. Corresponds to IDE macro Pas2JSNodeJS.

Project Wizards

The pas2js support is in the pas2jsdsgn.lpk package, which you can find in the components/pas2js directory. It registers 2 wizards in the 'New project' dialog:

  • Web Browser Application
  • Node.js Application

Besides creating an initial project source, both options will also

  • Set up the compiler command for compiling with pas2js
  • change the 'Run' command so the 'Run without debugging' option works: it will open a project in the browser or run it with nodejs.

New Web Browser application

This wizard will ask for some options before generating a new project. The dialog is shown below.


The following options are available:

  • Create initial HTML page. This is self-explanatory,
    the IDE will generate a template HTML page which includes all that is necessary to run the pas2js code.
    The page is included in the project description, so you can open and edit it from within the IDE.
  • Maintain HTML page.
    If you change the name of the project, the IDE will update the references in the HTML File.
    (all your changes will be lost)
  • Run rtl in document.onReady. By default the script tag that starts the ball rolling will call
    Checking this option changes the script, so the is run in the HTML document.onReady event instead.
    This is necessary if your code contains startup code that references elements in the HTML.
    The elements will only be available after the onReady event.
  • Use Browser Application object.
    This changes the code to use the TBrowserApplication object.
    This is a TCustomApplication descendent which offers support for query parameters etc. as if they were command-line parameters.
  • Use Browser Console unit.
    Checking this will simply include the browserconsole unit in the uses clause.
    This hooks into the system units writeln command: any output will be appended to the HTML.
    the generated HTML has a div with the correct ID to which the output is appended.
  • Project needs a HTTP server.
    If the project needs a HTTP server, then the IDE can start one for you, or you can indicate the URL to use when the 'Run without debugging' command is used.

Project options

You can change the settings chosen in the new project wizard in the Project Settings dialog. It also allows you to convert any existing (simple) project to a web application project.

The project options are located at the bottom "Web Project (pas2js)'


The checkbox at the top marks the project as web browser project.

All other options have the same meaning as their counter parts in the 'New project' wizard.

The ```Reset compile command``` and ```Reset run command``` set the respective commands to thei ddefault values.

Debug window

As you start projects from various directories, the IDE will start webservers as needed. After some time, there can be several webservers running. An overview of running webservers can be shown using the the View/Debug Windows/Pas2JS Webservers menu item.

It shows a list of processes started by the IDE:


Support for stopping/starting processes will still be added, as well as statistics for number of requests etc.