{
* IntfHiliter.pas
*
* Declares various types that describe syntax hilighters and and defines
* interfaces to various syntax highlighters and highlighter attributes.
*
* v0.1 of 21 Apr 2005 - Original version.
* v1.0 of 24 May 2006 - Improved and corrected comments.
* - Removed warnings about un-fixed interfaces - now
* fixed.
* v1.1 of 02 Jul 2007 - Added Title param to Hilite methods of ISyntaxHiliter.
* v1.2 of 21 May 2009 - Added TPredefinedHiliteStyle enumeration.
*
*
* ***** BEGIN LICENSE BLOCK *****
*
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is IntfHiliter.pas
*
* The Initial Developer of the Original Code is Peter Johnson
* (http://www.delphidabbler.com/).
*
* Portions created by the Initial Developer are Copyright (C) 2005-2009 Peter
* Johnson. All Rights Reserved.
*
* ***** END LICENSE BLOCK *****
}
unit IntfHiliter;
interface
uses
// Delphi
Classes, Graphics;
type
{
THiliteElement:
Defines the different elements that can be highlighted in Pascal source
code.
}
THiliteElement = (
heWhitespace, // white space
heComment, // comments: in (* .. *), { .. } or // styles
heReserved, // reserved word (keyword or directives)
heIdentifier, // an identifier that is not "reserved"
heSymbol, // punctuation symbol or symbol group
heString, // string or character literal preceeded by #
heNumber, // whole number
heFloat, // floating point number (may be in scientific format)
heHex, // hexadecimal integer
hePreProcessor, // compiler directive: {$..} and (*$..*) styles supported
heAssembler, // assembler code between asm ... end keywords
heError // an unrecognised piece of code (shouldn't happen)
);
{
IHiliteElemAttrs:
Interface supported by objects that store display attributes applicable to
various elements used in syntax highlighting.
}
IHiliteElemAttrs = interface(IInterface)
['{297A2F3D-77A8-45F9-A147-22A53791F114}']
function IsNul: Boolean;
{Checks whether an element's attributes are "nul" - i.e. all properties
have default values. Used to determine whether to output formatting
information for an element.
@return True if element's attributes are nul.
}
function GetFontStyle: TFontStyles;
{Gets the font style to use for element.
@return Set of font styles.
}
procedure SetFontStyle(const AFontStyle: TFontStyles);
{Sets style of font to use for element.
@param AFontStyle Required set of font styles.
}
function GetForeColor: TColor;
{Get the foreground colour (i.e. text colour) to use for element.
@return The colour.
}
procedure SetForeColor(const AColor: TColor);
{Sets foreground colour (i.e. text colour) to use for element.
@param AColor Required colour.
}
property FontStyle: TFontStyles read GetFontStyle write SetFontStyle;
{Set of font styles to use for element}
property ForeColor: TColor read GetForeColor write SetForeColor;
{Foreground (i.e. text) colour to use for element. clNone => use default
colour}
end;
{
IHiliteAttrs:
Interface implemented by objects that store display attributes that are used
in a syntax highlighter.
}
IHiliteAttrs = interface(IInterface)
['{25570AEE-3225-42A7-A534-3D27357EEA2E}']
function GetFontName: string;
{Gets name of font to use for all output.
@return Name of font.
}
procedure SetFontName(const AFontName: string);
{Sets name of font to use for all output.
@param AFontName Required font name.
}
function GetFontSize: Integer;
{Gets size of font to use for all output.
@return Size of font in points.
}
procedure SetFontSize(const AFontSize: Integer);
{Sets size of font to use for all output.
@param AFontSize Required font size in points.
}
function GetElement(const Elem: THiliteElement): IHiliteElemAttrs;
{Gets the highlight attributes of a highlighter element.
@param Elem Required element.
@return Highlight attributes for element.
}
property FontName: string read GetFontName write SetFontName;
{Name of font used for all output}
property FontSize: Integer read GetFontSize write SetFontSize;
{Size of font used for all output in points}
property Elements[const Elem: THiliteElement]: IHiliteElemAttrs
read GetElement; default;
{List of highlight attributes of each highlight element}
end;
{
TSyntaxHiliterKind:
Enumeration of various kinds of highlighter.
}
TSyntaxHiliterKind = (
hkNul, // nul, do nothing highlighter
hkDetailHTML, // used to highlight code part of detail pane HTML documents
hkXHTML, // used to highlight complete XHTML documents
hkRTF // used to highlight RTF documents
);
{
ISyntaxHiliter:
Interface implemented by all highlighter classes. Provides overloaded
methods used to highlight a document.
}
ISyntaxHiliter = interface(IInterface)
['{8FDE87E5-66AD-49AD-BDA8-2110F47C0F6C}']
procedure Hilite(const Src, Dest: TStream; const Attrs: IHiliteAttrs = nil;
const Title: string = ''); overload;
{Highlights source code on an input stream and writes to output stream.
@param Src [in] Stream containing source code to be highlighted.
@param Dest [in] Stream that receives formatted / highlighted document.
@param Attrs [in] Attributes to be used by highlighter. Nil value causes
a nul highlighter to be used.
@param Title [in] Optional title to be used as meta data in output
document. Will be ignored if document type does not support title.
}
function Hilite(const RawCode: string; const Attrs: IHiliteAttrs = nil;
const Title: string = ''): string; overload;
{Highlights source code and writes to a string.
@param RawCode [in] Source code to be highlighted.
@param Attrs [in] Attributes to be used by highlighter. Nil value causes
a nul highlighter to be used.
@param Title [in] Optional title to be used as meta data in output
document. Will be ignored if document type does not support title.
@return Formatted / highlighted source code.
}
end;
type
{
TPredefinedHiliteStyle:
Enumeration that specifies the different perdefined highlighter styles.
}
TPredefinedHiliteStyle = (
hsCodeSnip, // original codesnip default style
hsDelphi7, // Delphi 7 default style
hsDelphi2006 // Delphi 2006 default style
);
implementation
end.
