1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
{ $Id: basepkgmanager.pas 19651 2009-04-27 18:08:58Z mattias $ }
{
/***************************************************************************
basepkgmanager.pas
------------------
***************************************************************************/
***************************************************************************
* *
* 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. *
* *
***************************************************************************
Author: Mattias Gaertner
Abstract:
TBasePkgManager is the base class for TPkgManager, which controls the whole
package system in the IDE. The base class is mostly abstract.
}
unit BasePkgManager;
{$mode objfpc}{$H+}
interface
{$I ide.inc}
uses
{$IFDEF IDE_MEM_CHECK}
MemCheck,
{$ENDIF}
TypInfo, Classes, SysUtils, Forms, FileUtil, LCLProc,
PropEdits, LazIDEIntf, PackageIntf, MenuIntf,
LazarusIDEStrConsts, EnvironmentOpts,
PackageDefs, PackageSystem, ComponentReg, CompilerOptions, Project;
type
{ TBasePkgManager }
TBasePkgManager = class(TPackageEditingInterface)
public
// initialization and menu
constructor Create(TheOwner: TComponent); override;
destructor Destroy; override;
procedure ConnectMainBarEvents; virtual; abstract;
procedure ConnectSourceNotebookEvents; virtual; abstract;
procedure SetupMainBarShortCuts; virtual; abstract;
procedure SetRecentPackagesMenu; virtual; abstract;
procedure SaveSettings; virtual; abstract;
procedure UpdateVisibleComponentPalette; virtual; abstract;
procedure ProcessCommand(Command: word; var Handled: boolean); virtual; abstract;
procedure OnSourceEditorPopupMenu(const AddMenuItemProc: TAddMenuItemProc); virtual; abstract;
procedure TranslateResourceStrings; virtual; abstract;
// files
function GetDefaultSaveDirectoryForFile(const Filename: string): string; virtual; abstract;
function OnRenameFile(const OldFilename, NewFilename: string;
IsPartOfProject: boolean): TModalResult; virtual; abstract;
function FindIncludeFileInProjectDependencies(Project1: TProject;
const Filename: string): string; virtual; abstract;
function AddDependencyToOwners(OwnerList: TFPList; APackage: TLazPackage;
OnlyTestIfPossible: boolean = false): TModalResult; virtual; abstract;
function SearchFile(const AFilename: string;
SearchFlags: TSearchIDEFileFlags;
InObject: TObject): TPkgFile; virtual; abstract;
function SearchUnitInDesigntimePackages(const AnUnitName: string;
InObject: TObject): TPkgFile; virtual; abstract;
function AddDependencyToUnitOwners(const OwnedFilename,
RequiredUnitname: string): TModalResult; virtual; abstract;
procedure GetPackagesChangedOnDisk(var ListOfPackages: TFPList); virtual; abstract;
function RevertPackages(APackageList: TFPList): TModalResult; virtual; abstract;
// project
function OpenProjectDependencies(AProject: TProject;
ReportMissing: boolean): TModalResult; virtual; abstract;
procedure AddDefaultDependencies(AProject: TProject); virtual; abstract;
function AddProjectDependency(AProject: TProject; APackage: TLazPackage;
OnlyTestIfPossible: boolean = false): TModalResult; virtual; abstract;
procedure AddProjectRegCompDependency(AProject: TProject;
ARegisteredComponent: TRegisteredComponent); virtual; abstract;
procedure AddProjectLCLDependency(AProject: TProject); virtual; abstract;
function AddProjectDependencies(AProject: TProject; const Packages: string;
OnlyTestIfPossible: boolean = false): TModalResult; virtual; abstract;
function CheckProjectHasInstalledPackages(AProject: TProject; Interactive: boolean): TModalResult; virtual; abstract;
function CanOpenDesignerForm(AnUnitInfo: TUnitInfo;
Interactive: boolean): TModalResult; virtual; abstract;
function OnProjectInspectorOpen(Sender: TObject): boolean; virtual; abstract;
function OnProjectInspectorAddDependency(Sender: TObject;
ADependency: TPkgDependency): TModalResult; virtual; abstract;
function OnProjectInspectorRemoveDependency(Sender: TObject;
ADependency: TPkgDependency): TModalResult; virtual; abstract;
function OnProjectInspectorReAddDependency(Sender: TObject;
ADependency: TPkgDependency): TModalResult; virtual; abstract;
// package editors
function DoNewPackage: TModalResult; virtual; abstract;
function DoOpenPackage(APackage: TLazPackage; Flags: TPkgOpenFlags;
ShowAbort: boolean): TModalResult; virtual; abstract;
function DoSavePackage(APackage: TLazPackage;
Flags: TPkgSaveFlags): TModalResult; virtual; abstract;
function DoClosePackageEditor(APackage: TLazPackage): TModalResult; virtual; abstract;
function DoCloseAllPackageEditors: TModalResult; virtual; abstract;
// package graph
procedure DoShowPackageGraphPathList(PathList: TFPList); virtual; abstract;
procedure RebuildDefineTemplates; virtual; abstract;
procedure LazarusSrcDirChanged; virtual; abstract;
// package compilation
function DoCompileProjectDependencies(AProject: TProject;
Flags: TPkgCompileFlags): TModalResult; virtual; abstract;
function DoCompilePackage(APackage: TLazPackage; Flags: TPkgCompileFlags;
Globals: TGlobalCompilerOptions = nil): TModalResult; virtual; abstract;
// package installation
procedure LoadInstalledPackages; virtual; abstract;
function DoShowOpenInstalledPckDlg: TModalResult; virtual; abstract;
function ShowConfigureCustomComponents: TModalResult; virtual; abstract;
function DoCompileAutoInstallPackages(Flags: TPkgCompileFlags
): TModalResult; virtual; abstract;
function DoSaveAutoInstallConfig: TModalResult; virtual; abstract;
function DoGetIDEInstallPackageOptions(
var InheritedOptionStrings: TInheritedCompOptsStrings
): string; virtual; abstract;
// components
function GetUsableComponentUnits(CurRoot: TPersistent): TFPList; virtual; abstract; // list of TUnitInfo
procedure IterateComponentNames(CurRoot: TPersistent; TypeData: PTypeData;
Proc: TGetStringProc); virtual; abstract;
function FindUsableComponent(CurRoot: TPersistent;
const ComponentPath: string): TComponent; virtual; abstract;
function FindReferencedRootComponent(CurRoot: TPersistent;
const ComponentName: string): TComponent; virtual; abstract;
end;
var
PkgBoss: TBasePkgManager;
const
PkgSaveFlagNames: array[TPkgSaveFlag] of string = (
'psfSaveAs',
'psfAskBeforeSaving'
);
PkgOpenFlagNames: array[TPkgOpenFlag] of string = (
'pofAddToRecent',
'pofRevert',
'pofConvertMacros',
'pofMultiOpen'
);
function PkgSaveFlagsToString(Flags: TPkgSaveFlags): string;
function PkgOpenFlagsToString(Flags: TPkgOpenFlags): string;
procedure GetDescriptionOfDependencyOwner(Dependency: TPkgDependency;
out Description: string);
procedure GetDirectoryOfDependencyOwner(Dependency: TPkgDependency;
out Directory: string);
implementation
function PkgSaveFlagsToString(Flags: TPkgSaveFlags): string;
var
f: TPkgSaveFlag;
begin
Result:='';
for f:=Low(TPkgSaveFlag) to High(TPkgSaveFlag) do begin
if not (f in Flags) then continue;
if Result<>'' then Result:=Result+',';
Result:=Result+PkgSaveFlagNames[f];
end;
Result:='['+Result+']';
end;
function PkgOpenFlagsToString(Flags: TPkgOpenFlags): string;
var
f: TPkgOpenFlag;
begin
Result:='';
for f:=Low(TPkgOpenFlag) to High(TPkgOpenFlag) do begin
if not (f in Flags) then continue;
if Result<>'' then Result:=Result+',';
Result:=Result+PkgOpenFlagNames[f];
end;
Result:='['+Result+']';
end;
procedure GetDescriptionOfDependencyOwner(Dependency: TPkgDependency;
out Description: string);
var
DepOwner: TObject;
begin
DepOwner:=Dependency.Owner;
if (DepOwner<>nil) then begin
if DepOwner is TLazPackage then begin
Description:=Format(lisPkgMangPackage, [TLazPackage(DepOwner).IDAsString]
);
end else if DepOwner is TProject then begin
Description:=Format(lisPkgMangProject, [ExtractFileNameOnly(TProject(
DepOwner).ProjectInfoFile)]);
end else if (DepOwner=PkgBoss) or (DepOwner=PackageGraph) then begin
Description:=lisPkgMangLazarus;
end else begin
Description:=dbgsName(DepOwner)
end;
end else begin
Description:=Format(lisPkgMangDependencyWithoutOwner, [Dependency.AsString]
);
end;
end;
procedure GetDirectoryOfDependencyOwner(Dependency: TPkgDependency;
out Directory: string);
var
DepOwner: TObject;
begin
DepOwner:=Dependency.Owner;
if (DepOwner<>nil) then begin
if DepOwner is TLazPackage then begin
Directory:=TLazPackage(DepOwner).Directory;
end else if DepOwner is TProject then begin
Directory:=TProject(DepOwner).ProjectDirectory;
end else if DepOwner=PkgBoss then begin
Directory:=EnvironmentOptions.LazarusDirectory;
end else begin
Directory:=''
end;
end else begin
Directory:=''
end;
end;
{ TBasePkgManager }
constructor TBasePkgManager.Create(TheOwner: TComponent);
begin
PackageEditingInterface:=Self;
inherited Create(TheOwner);
end;
destructor TBasePkgManager.Destroy;
begin
inherited Destroy;
PackageEditingInterface:=nil;
end;
initialization
PkgBoss:=nil;
end.
|