paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-26 05:00:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

CHMHelp: fixed delays when getting help while help viewer is already open, bug #29747:

Browse Source 
1. The second instance of IPC server with the same PID was started for second and next search processes (if we did not close LHELP). Then server did not answer and client waited a long time for timeout.
2. Additionally check serverRunning after lHelp rebuild.
3. Always show lHelp on new requests.
4. Changed BeginUpdate/EndUpdate handling.

Patch by Andrey Sobol with minor modifications.

git-svn-id: trunk@64159 -
This commit is contained in:
maxim 2020-11-26 23:26:58 +00:00
parent 4a32e7f70f
commit de6bb0649b
2 changed files with 37 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/chmhelp/packages/idehelp/chmhelppkg.lpk
View File

@ -23,7 +23,7 @@
</CompilerOptions>
<Description Value="IDE package to use chm help files in the IDE via the lhelp viewer."/>
<License Value="GPL 2"/>
<Version Minor="2"/>
<Version Minor="2" Release="1"/>
<Files Count="5">
<Item1>
<Filename Value="lazchmhelp.pas"/>

61
components/chmhelp/packages/idehelp/lazchmhelp.pas
View File

@ -564,12 +564,14 @@ var
Proc: TProcessUTF8;
FoundFileName: String;
LHelpPath: String;
WasRunning: boolean;
WasRunning: Boolean;
UpdateStarted: Boolean;
{$IFDEF CHMLOADTIMES}
TotalTime: TDateTime;
StartTime: TDateTime;
{$ENDIF}
begin
UpdateStarted := False;
if Pos('file://', Node.URL) = 1 then
begin
Result := PassTheBuck(Node, ErrMsg);
@ -608,25 +610,26 @@ begin
if ExtractFileNameOnly(GetHelpExe) = 'lhelp' then
begin
WasRunning := fHelpConnection.ServerRunning;
// Start server and tell it to hide
// No use setting cursor to hourglass as that may take as long as the
// waitforresponse timeout.
{$IFDEF CHMLOADTIMES}
TotalTime:=Now;
StartTime:=Now;
{$ENDIF}
fHelpConnection.StartHelpServer(HelpLabel, GetHelpExe, true);
{$IFDEF CHMLOADTIMES}
DebugLn(['CHMLOADTIMES: ',Format('Starting LHelp took %d ms',[DateTimeToTimeStamp(Now-StartTime).Time])]);
{$ENDIF}
// If the server is not already running, open all chm files after it has started
// This will allow cross-chm (LCL, FCL etc) searching and browsing in lhelp.
if not(WasRunning) then
begin
if fHelpConnection.BeginUpdate = srError then
// Start server and tell it to hide
// No use setting cursor to hourglass as that may take as long as the
// waitforresponse timeout.
{$IFDEF CHMLOADTIMES}
TotalTime:=Now;
StartTime:=Now;
{$ENDIF}
fHelpConnection.StartHelpServer(HelpLabel, GetHelpExe, true);
{$IFDEF CHMLOADTIMES}
DebugLn(['CHMLOADTIMES: ',Format('Starting LHelp took %d ms',[DateTimeToTimeStamp(Now-StartTime).Time])]);
{$ENDIF}
// If the server is not already running, open all chm files after it has started
// This will allow cross-chm (LCL, FCL etc) searching and browsing in lhelp.
UpdateStarted := (fHelpConnection.BeginUpdate = srSuccess);
if not UpdateStarted then
begin
// existing lhelp doesn't understand mrBeginUpdate and needs to be rebuilt
//close lhelp
// close lhelp
if fHelpConnection.RunMiscCommand(LHelpControl.mrClose) <> srError then
begin
// force rebuild of lhelp
@ -637,8 +640,14 @@ begin
// start it again
Debugln(['TChmHelpViewer.ShowNode restarting lhelp to use updated protocols']);
fHelpConnection.StartHelpServer(HelpLabel, GetHelpExe, true);
// now run begin update
fHelpConnection.BeginUpdate; // it inc's a value so calling it more than once doesn't hurt
// check running again
WasRunning := fHelpConnection.ServerRunning;
if not WasRunning then
begin
Result := shrViewerError;
ErrMsg := 'Error starting LHelp IPC server';
exit;
end;
end;
end;
end;
@ -649,16 +658,18 @@ begin
{$IFDEF CHMLOADTIMES}
DebugLn(['CHMLOADTIMES: ',Format('Searching and Loading files took %d ms',[DateTimeToTimeStamp(Now-StartTime).Time])]);
{$ENDIF}
// Instruct viewer to show its GUI
Response:=fHelpConnection.RunMiscCommand(mrShow);
if Response<>srSuccess then
debugln('Help viewer gave error response to mrShow command. Response was: ord: '+inttostr(ord(Response)));
end;
fHelpConnection.BeginUpdate;
// When UpdateStarted = True then server use LHellp version 2 protocol
// it inc's a value so calling it more than once doesn't hurt
if not UpdateStarted then
UpdateStarted := (fHelpConnection.BeginUpdate = srSuccess);
Response := fHelpConnection.OpenURL(FileName, Url);
fHelpConnection.EndUpdate;
if not WasRunning then
if UpdateStarted then
fHelpConnection.EndUpdate;
// Instruct viewer to show its GUI always
Response:=fHelpConnection.RunMiscCommand(mrShow);
if Response<>srSuccess then
debugln('Help viewer gave error response to mrShow command. Response was: ord: '+inttostr(ord(Response)));
{$IFDEF CHMLOADTIMES}
DebugLn(['CHMLOADTIMES: ',Format('Total start time was %d ms',[DateTimeToTimeStamp(Now-TotalTime).Time])]);
{$ENDIF}