lazarus/ide/lazarusmanager.pas
mattias 3357682ab6 fixed startlazarus description
git-svn-id: trunk@6335 -
2004-12-06 10:32:32 +00:00

349 lines
10 KiB
ObjectPascal

{ $Id$ }
{
/***************************************************************************
lazarusmanager.pas
--------------------
Class to manage starting and restarting of lazarus
***************************************************************************/
***************************************************************************
* *
* This source is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This code is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* A copy of the GNU General Public License is available on the World *
* Wide Web at <http://www.gnu.org/copyleft/gpl.html>. You can also *
* obtain it by writing to the Free Software Foundation, *
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
* *
***************************************************************************
}
(*
Abstract:
This is the worker unit of the 'startlazarus' application.
It searches the new lazarus executable.
1. open the build lazarus options and look for a custom target directory
2. look in the directory of startlazarus (the lazarus main directory)
and in $(ConfigDir)/bin/ and use the newest lazarus executable.
On systems which lock executables on run it renames the
lazarus to lazarus.old and lazarus.new to lazarus.
Then it starts lazarus and waits until it is finished. It waits only for a
specific running lazarus: the one which pid was passed as command line
parameter. If lazarus gives a special exit code (ExitCodeRestartLazarus) it
goes to step 1.
Any other exit code, also stops startlazarus.
Why that?
- To install a package into the IDE statically, it must be relinked.
This creates a new lazarus[.exe] executable. With the help of startlazarus
the IDE can then automatically restart itself.
- Some platforms like windows locks there executable while running.
This means the new executable created needs another name.
- If the IDE is installed as root/administrator the whole lazarus directory
is readonly for users. This means the new executable created will be
created in another directory.
- Building can result in a broken IDE. Therefore backups are created.
- Copying is slow (especially the huge IDE). So only 'rename' is used for
backup.
- The IDE calls 'make' to rebuild itself. This deletes the old lazarus
executable on some systems. So, the backup must be made before building
for these systems.
- When the original directory can't be used (readonly), the build directory
is <primary config path>/bin/, which results in ~/.lazarus/bin/ on unix
style systems like linux, bsd, macosx and {AppData}\Lazarus\bin on windows.
- For debugging purposes you can work without startlazarus.
- To not confuse the user, the running IDE executable is 'lazarus' or
'lazarus.exe', not 'lazarus.new' or 'lazarus.old'.
- The user can define the Target Directory.
- The IDE can be cross compiled. The resulting executable will be created
in <primary config path>/bin/<TargetOS>
*)
unit LazarusManager;
{$mode objfpc}{$H+}
interface
uses
{$IFDEF win32}
Windows,
{$ENDIF}
{$IFDEF unix}
BaseUnix,
{$ENDIF}
Classes, SysUtils, Process,
LCLProc, FileUtil, Forms, Controls, Dialogs,
LazConf,
StartLazOpts, Splash;
type
TLazarusProcess = class
private
FOnStart: TNotifyEvent;
FProcess: TProcess;
FLazarusPath: string;
FWantsRestart: boolean;
public
constructor Create(const LazarusPath: string);
destructor Destroy; override;
procedure Execute;
procedure WaitOnExit;
property WantsRestart: boolean read FWantsRestart;
property OnStart: TNotifyEvent read FOnStart write FOnStart;
end;
type
TLazarusManager = class(TComponent)
private
FStartLazarusOptions: TStartLazarusOptions;
FLazarusProcess: TLazarusProcess;
FLazarusPath: string;
FLazarusPID: Integer;
FCmdLineParams: TStrings;
procedure ParseCommandLine;
function GetLazarusPath(const FileName: string): string;
function RenameLazarusExecutables: TModalResult;
procedure LazarusProcessStart(Sender: TObject);
procedure WaitForLazarus;
public
constructor Create; reintroduce;
destructor Destroy; override;
procedure Run;
procedure ShowSplash;
end;
implementation
constructor TLazarusManager.Create;
begin
inherited Create(nil);
SplashForm := TSplashForm.Create(Self);
ShowSplash;
FStartLazarusOptions := TStartLazarusOptions.Create;
ParseCommandLine;
end;
destructor TLazarusManager.Destroy;
begin
FreeAndNil(FCmdLineParams);
FreeAndNil(FStartLazarusOptions);
inherited Destroy;
end;
procedure TLazarusManager.ParseCommandLine;
const
LazarusPidOpt='--lazarus-pid=';
var
i: Integer;
Param: string;
begin
FCmdLineParams := TStringList.Create;
FLazarusPID := 0;
for i := 1 to ParamCount do begin
Param := ParamStr(i);
if LeftStr(Param,length(LazarusPidOpt))=LazarusPidOpt then begin
try
FLazarusPID :=
StrToInt(RightStr(Param,Length(Param)-Length(LazarusPidOpt)));
except
DebugLn('Failed to parse %s',[Param]);
FLazarusPid := 0;
end;
end
else
FCmdLineParams.Add(Param);
end;
end;
function TLazarusManager.GetLazarusPath(const FileName: string) : string;
begin
Result := AppendPathDelim(FStartLazarusOptions.LazarusDir) + FileName +
GetDefaultExecutableExt;
end;
function TLazarusManager.RenameLazarusExecutables: TModalResult;
var
NewFileName: string;
BackupFileName: String;
begin
Result := mrOK;
NewFileName := GetLazarusPath('lazarus.new');
FLazarusPath := GetLazarusPath('lazarus');
BackupFileName := GetLazarusPath('lazarus.old');
if FileExists(NewFileName) then
begin
if FileExists(FLazarusPath) then
begin
if FileExists(BackupFileName)
then DeleteFile(BackupFileName);
RenameFile(FLazarusPath, BackupFileName);
end;
RenameFile(NewFileName, FLazarusPath);
end;
if not FileExists(FLazarusPath) then begin
MessageDlg(format('Can''t find lazarus executable: %s', [FLazarusPath]),
mtError, [mbOK], 0);
Result := mrAbort;
end;
end;
procedure TLazarusManager.LazarusProcessStart(Sender: TObject);
begin
SplashForm.Hide;
Application.ProcessMessages;
end;
procedure TLazarusManager.WaitForLazarus;
procedure WaitForPid(PID: integer);
{$IFDEF win32}
var
ProcessHandle: THandle;
begin
ProcessHandle := OpenProcess(SYNCHRONIZE, false, PID);
if ProcessHandle<>HWND(nil) then begin
WaitForSingleObject(ProcessHandle, INFINITE);
CloseHandle(ProcessHandle);
end;
end;
{$ELSE}
{$IFDEF UNIX}
var
Result: integer;
begin
repeat
Sleep(100);
Result := fpKill(PID, 0);
until Result<>0;
end;
{$ELSE}
begin
DebugLn('WaitForPid not implemented for this OS. We just wait 5 seconds');
Sleep(5000);
end;
{$ENDIF}
{$ENDIF}
begin
if FLazarusPID<>0 then begin
WaitForPID(FLazarusPID);
end;
end;
procedure TLazarusManager.Run;
var
Restart: boolean;
begin
WaitForLazarus;
repeat
SplashForm.Show;
Application.ProcessMessages;
Restart := false;
if RenameLazarusExecutables=mrOK then begin
FLazarusProcess := TLazarusProcess.Create(FLazarusPath);
FLazarusProcess.OnStart := @LazarusProcessStart;
FLazarusProcess.Execute;
FLazarusProcess.WaitOnExit;
Restart := FLazarusProcess.WantsRestart;
FreeAndNil(FLazarusProcess);
end;
until not Restart;
Application.Terminate;
end;
procedure TLazarusManager.ShowSplash;
begin
with SplashForm do begin
Show;
Paint;
end;
Application.ProcessMessages; // process splash paint message
end;
{ TLazarusProcess }
constructor TLazarusProcess.Create(const LazarusPath: string);
begin
FLazarusPath := LazarusPath;
FProcess := TProcess.Create(nil);
FProcess.Options := [];
FProcess.ShowWindow := swoShow;
FProcess.CommandLine := FLazarusPath + ' --no-splash-screen --started-by-startlazarus';
end;
destructor TLazarusProcess.Destroy;
begin
FreeAndNil(FProcess);
inherited Destroy;
end;
procedure TLazarusProcess.Execute;
begin
FProcess.Execute;
{$IFNDEF VER1_0}
Sleep(2000);
{$ENDIF}
if Assigned(FOnStart) then
FOnStart(Self);
end;
procedure TLazarusProcess.WaitOnExit;
begin
FProcess.WaitOnExit;
FWantsRestart := FProcess.ExitStatus=ExitCodeRestartLazarus;
end;
end.
{
$Log$
Revision 1.15 2004/12/06 10:32:32 mattias
fixed startlazarus description
Revision 1.14 2004/12/04 01:17:41 mattias
implemented Target Directory for IDE
Revision 1.13 2004/11/23 18:11:18 vincents
fixed hiding splash screen for gtk
Revision 1.12 2004/11/20 13:14:28 vincents
fixed typo.
Revision 1.11 2004/11/19 12:23:43 vincents
fixed WaitForLazarus: close process handle after use.
Revision 1.10 2004/11/06 11:29:24 vincents
Changes due to the new fpc unit directory structure.
Revision 1.9 2004/11/05 22:05:41 vincents
Use symbolic constant for restart exitcode.
Revision 1.8 2004/11/03 14:18:34 mattias
implemented preferred size for controls for theme depending AutoSizing
Revision 1.7 2004/10/31 21:17:34 vincents
- Implemented restarting by starting startlazarus on unix (for 1.9.x only).
- Add Restart After Succesfull Build CheckBox to the Configure Build Lazarus dialog.
Revision 1.6 2004/10/27 20:49:26 vincents
Lazarus can be restarted, even if not started by startlazarus (only win32 implemented).
Revision 1.5 2004/09/27 22:05:40 vincents
splitted off unit FileUtil, it doesn't depend on other LCL units
Revision 1.4 2004/09/04 23:02:56 mattias
added reintroduce to get rid of the warning
Revision 1.3 2004/09/03 21:14:50 vincents
fix showing splash screen on restart
}