{
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at http://mozilla.org/MPL/2.0/
*
* Copyright (C) 2008-2013, Peter Johnson (www.delphidabbler.com).
*
* $Rev$
* $Date$
*
* Implements a static class that manages sharing of snippets. Provides support
* for exporting snippets, importing snippets and submitting snippets to the
* online database.
}
unit UCodeShareMgr;
interface
uses
// Project
DB.USnippet, UBaseObjects, UView;
type
{
TCodeShareMgr:
Sealed static class that manages sharing of snippets. Provides support for
exporting snippets, importing snippets and submitting snippets to the online
database.
}
TCodeShareMgr = class sealed(TNoConstructObject)
strict private
class function GetSnippetFromView(ViewItem: IView): TSnippet;
{Gets reference to any snippet represented by a view item.
@param ViewItem [in] View item for which snippet is required.
@return Reference to required snippet or nil if view item does not
represent a snippet.
}
public
class procedure Submit(ViewItem: IView);
{Submits code for consideration to be included in main database.
@param ViewItem [in] View item that may contain a snippet. If so the
snippet is included in code for submission by default.
}
class function CanShare: Boolean;
{Checks if there are any snippets that can be shared (i.e. exported or
submitted).
@return True if any snippets exist in database.
}
class procedure ExportCode(ViewItem: IView);
{Exports snippets to an export file.
@param ViewItem [in] View item that may contain a snippet. If so the
snippet is included in the export file by default.
}
class procedure ImportCode;
{Imports snippets from an export file.
}
end;
implementation
uses
// Delphi
SysUtils,
// Project
DB.UMain, FmCodeExportDlg, FmCodeImportDlg, FmCodeSubmitDlg, UCodeImportMgr;
{ TCodeShareMgr }
class function TCodeShareMgr.CanShare: Boolean;
{Checks if there are any snippets that can be shared (i.e. exported or
submitted).
@return True if any snippets exist in database.
}
begin
Result := not Database.IsEmpty;
end;
class procedure TCodeShareMgr.ExportCode(ViewItem: IView);
{Exports snippets to an export file.
@param ViewItem [in] View item that may a snippet. If so the snippet is
included in the export file by default.
}
begin
TCodeExportDlg.Execute(nil, GetSnippetFromView(ViewItem));
end;
class function TCodeShareMgr.GetSnippetFromView(
ViewItem: IView): TSnippet;
{Gets reference to any snippet represented by a view item.
@param ViewItem [in] View item for which snippet is required.
@return Reference to required snippet or nil if view item does not represent
a snippet.
}
var
SnippetView: ISnippetView; // ViewItem as snippet view if supported
begin
if Supports(ViewItem, ISnippetView, SnippetView) then
Result := SnippetView.Snippet
else
Result := nil;
end;
class procedure TCodeShareMgr.ImportCode;
{Imports snippets from an export file.
}
var
ImportMgr: TCodeImportMgr; // manages import of code
begin
ImportMgr := TCodeImportMgr.Create;
try
TCodeImportDlg.Execute(nil, ImportMgr);
finally
ImportMgr.Free;
end;
end;
class procedure TCodeShareMgr.Submit(ViewItem: IView);
{Submits code for consideration to be included in main database.
@param ViewItem [in] View item that may contain a snippet. If so the snippet
is included in code for submission by default.
}
begin
TCodeSubmitDlg.Execute(nil, GetSnippetFromView(ViewItem));
end;
end.
