on-restart

Arguments: project

on-restart is a property of an IDE project. Its value is the name of the function that is called internally to start up a standalone application that has been generated from the project. Normally the value is do-default-restart, though it may be changed to facilitate the debugging of a standalone application that is not successfully starting up and reaching a point where it could be debugged by pressing the BREAK key to enter the debugger in the console window.

In this case, you could debug the standalone application in the following way:

1. Open its project in the IDE
2. change the value of the on-restart property of the current project to do-default-debugable-restart
3. Regenerate and run the standalone application

This simply shows the console window Lisp listener, in which you can evaluate expressions to set up an initial environment for debugging. Then evaluate (do-default-restart) in the console to run the project code in the customized environment.

Alternately, you could change the on-restart property to the name of some other function that programmatically customizes the environment. An on-restart function should take no arguments. After setting things up for debugging, it should then either call do-default-restart (with no arguments) or else start up the application by hand. The application is started by hand by calling initialize-cg, then calling the project's on-initialization function, and finally calling event-loop to handle events.

Note that the way to customize the way a standalone application for a project really starts up is to use the project's on-initialization property. on-restart, in contrast, is intended only for debugging the standalone application.

You can inspect the current project by invoking the View | Project Manager command and then clicking on the Inspect Project button in the Project Manager's toolbar. The "Events" tab of the inspector will then show the on-initialization and on-restart properties of the current project.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.