Componentes.Terceros.jcl/official/1.96/source/common/JclBase.pas

617 lines
20 KiB
ObjectPascal

{**************************************************************************************************}
{ }
{ Project JEDI Code Library (JCL) }
{ }
{ 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 JclBase.pas. }
{ }
{ The Initial Developer of the Original Code is Marcel van Brakel. }
{ Portions created by Marcel van Brakel are Copyright Marcel van Brakel. All rights reserved. }
{ }
{ Contributors: }
{ Marcel van Brakel, }
{ Peter Friese, }
{ Robert Marquardt (marquardt) }
{ Robert Rossmair (rrossmair) }
{ Petr Vones (pvones) }
{ }
{**************************************************************************************************}
{ }
{ This unit contains generic JCL base classes and routines to support earlier }
{ versions of Delphi as well as FPC. }
{ }
{**************************************************************************************************}
// Last modified: $Date: 2005/12/15 11:35:13 $
// For history see end of file
unit JclBase;
{$I jcl.inc}
interface
uses
{$IFDEF CLR}
System.Reflection,
{$ELSE}
{$IFDEF MSWINDOWS}
Windows,
{$ENDIF MSWINDOWS}
{$ENDIF CLR}
SysUtils;
// Version
const
JclVersionMajor = 1; // 0=pre-release|beta/1, 2, ...=final
JclVersionMinor = 96; // Fifth minor release since JCL 1.90
JclVersionRelease = 1; // 0: pre-release|beta/>=1: release
JclVersionBuild = 2070; // build number, days since march 1, 2000
JclVersion = (JclVersionMajor shl 24) or (JclVersionMinor shl 16) or
(JclVersionRelease shl 15) or (JclVersionBuild shl 0);
// EJclError
type
EJclError = class(Exception);
{$IFDEF CLR}
DWORD = LongWord;
TIntegerSet = set of 0..SizeOf(Integer) * 8 - 1;
{$ENDIF CLR}
// EJclWin32Error
{$IFDEF MSWINDOWS}
type
EJclWin32Error = class(EJclError)
private
FLastError: DWORD;
FLastErrorMsg: string;
public
constructor Create(const Msg: string);
constructor CreateFmt(const Msg: string; const Args: array of const);
{$IFNDEF CLR}
constructor CreateRes(Ident: Integer); overload;
constructor CreateRes(ResStringRec: PResStringRec); overload;
{$ENDIF ~CLR}
property LastError: DWORD read FLastError;
property LastErrorMsg: string read FLastErrorMsg;
end;
{$ENDIF MSWINDOWS}
// EJclInternalError
type
EJclInternalError = class(EJclError);
// Types
type
{$IFDEF MATH_EXTENDED_PRECISION}
Float = Extended;
{$ENDIF MATH_EXTENDED_PRECISION}
{$IFDEF MATH_DOUBLE_PRECISION}
Float = Double;
{$ENDIF MATH_DOUBLE_PRECISION}
{$IFDEF MATH_SINGLE_PRECISION}
Float = Single;
{$ENDIF MATH_SINGLE_PRECISION}
PFloat = ^Float;
type
{$IFDEF FPC}
Largeint = Int64;
{$ELSE}
PPointer = ^Pointer;
{$IFDEF RTL140_UP}
{$IFDEF CLR}
PJclByteArray = array of Byte;
{$ELSE}
PByte = System.PByte;
Int8 = ShortInt;
Int16 = Smallint;
Int32 = Integer;
UInt8 = Byte;
UInt16 = Word;
UInt32 = LongWord;
{$ENDIF CLR}
{$ELSE ~RTL140_UP}
PBoolean = ^Boolean;
PByte = Windows.PByte;
{$ENDIF ~RTL140_UP}
{$ENDIF FPC}
PCardinal = ^Cardinal;
{$IFNDEF COMPILER7_UP}
UInt64 = Int64;
{$ENDIF ~COMPILER7_UP}
// Interface compatibility
{$IFDEF SUPPORTS_INTERFACE}
{$IFNDEF FPC}
{$IFNDEF RTL140_UP}
type
IInterface = IUnknown;
{$ENDIF ~RTL140_UP}
{$ENDIF ~FPC}
{$ENDIF SUPPORTS_INTERFACE}
// Int64 support
procedure I64ToCardinals(I: Int64; var LowPart, HighPart: Cardinal);
procedure CardinalsToI64(var I: Int64; const LowPart, HighPart: Cardinal);
// Redefinition of TLargeInteger to relieve dependency on Windows.pas
type
PLargeInteger = ^TLargeInteger;
TLargeInteger = Int64;
{$IFNDEF CLR}
// Redefinition of PByteArray to avoid range check exceptions.
type
TJclByteArray = array[0..MaxInt div SizeOf(Byte) - 1] of Byte;
PJclByteArray = ^TJclByteArray;
TBytes = Pointer; // under .NET System.pas: TBytes = array of Byte;
// Redefinition of TULargeInteger to relieve dependency on Windows.pas
type
PULargeInteger = ^TULargeInteger;
TULargeInteger = record
case Integer of
0:
(LowPart: LongWord;
HighPart: LongWord);
1:
(QuadPart: Int64);
end;
{$ENDIF ~CLR}
// Dynamic Array support
type
TDynByteArray = array of Byte;
TDynShortIntArray = array of Shortint;
TDynWordArray = array of Word;
TDynSmallIntArray = array of Smallint;
TDynLongIntArray = array of Longint;
TDynInt64Array = array of Int64;
TDynCardinalArray = array of Cardinal;
TDynIntegerArray = array of Integer;
TDynExtendedArray = array of Extended;
TDynDoubleArray = array of Double;
TDynSingleArray = array of Single;
TDynFloatArray = array of Float;
{$IFNDEF CLR}
TDynPointerArray = array of Pointer;
{$ENDIF ~CLR}
TDynStringArray = array of string;
TDynIInterfaceArray = array of IInterface;
TDynObjectArray = array of TObject;
// Cross-Platform Compatibility
const
// (rom) too basic for JclStrings
AnsiLineFeed = AnsiChar(#10);
AnsiCarriageReturn = AnsiChar(#13);
AnsiCrLf = AnsiString(#13#10);
{$IFDEF MSWINDOWS}
AnsiLineBreak = AnsiCrLf;
{$ENDIF MSWINDOWS}
{$IFDEF UNIX}
AnsiLineBreak = AnsiLineFeed;
{$ENDIF UNIX}
AnsiSigns = ['-', '+'];
AnsiUppercaseLetters = ['A'..'Z'];
AnsiLowercaseLetters = ['a'..'z'];
AnsiLetters = ['A'..'Z', 'a'..'z'];
AnsiDecDigits = ['0'..'9'];
AnsiOctDigits = ['0'..'7'];
AnsiHexDigits = ['0'..'9', 'A'..'F', 'a'..'f'];
AnsiValidIdentifierLetters = ['0'..'9', 'A'..'Z', 'a'..'z', '_'];
{$IFNDEF XPLATFORM_RTL}
procedure RaiseLastOSError;
{$ENDIF ~XPLATFORM_RTL}
procedure MoveArray(var List: TDynIInterfaceArray; FromIndex, ToIndex, Count: Integer); overload;
procedure MoveArray(var List: TDynStringArray; FromIndex, ToIndex, Count: Integer); overload;
procedure MoveArray(var List: TDynObjectArray; FromIndex, ToIndex, Count: Integer); overload;
procedure MoveArray(var List: TDynIntegerArray; FromIndex, ToIndex, Count: Integer); overload;
procedure MoveChar(const Source: string; FromIndex: Integer;
var Dest: string; ToIndex, Count: Integer); overload; // Index: 0..n-1
{$IFDEF CLR}
function GetBytesEx(const Value): TBytes;
procedure SetBytesEx(var Value; Bytes: TBytes);
procedure SetIntegerSet(var DestSet: TIntegerSet; Value: UInt32); inline;
function ByteArrayStringLen(Data: TBytes): Integer;
function StringToByteArray(const S: string): TBytes;
function ByteArrayToString(const Data: TBytes; Count: Integer): string;
{$ENDIF CLR}
implementation
uses
JclResources;
procedure MoveArray(var List: TDynIInterfaceArray; FromIndex, ToIndex, Count: Integer); overload;
{$IFDEF CLR}
var
I: Integer;
begin
if FromIndex < ToIndex then
for I := 0 to Count - 1 do
List[ToIndex + I] := List[FromIndex + I]
else
for I := Count - 1 downto 0 do
List[ToIndex + I] := List[FromIndex + I];
{$ELSE}
begin
Move(List[FromIndex], List[ToIndex], Count * SizeOf(List[0]));
{ Keep reference counting working }
if FromIndex < ToIndex then
FillChar(List[FromIndex], (ToIndex - FromIndex) * SizeOf(List[0]), 0)
else if FromIndex > ToIndex then
FillChar(List[FromIndex + Count - 1], (FromIndex - ToIndex) * SizeOf(List[0]), 0);
{$ENDIF CLR}
end;
procedure MoveArray(var List: TDynStringArray; FromIndex, ToIndex, Count: Integer); overload;
{$IFDEF CLR}
var
I: Integer;
begin
if FromIndex < ToIndex then
for I := 0 to Count - 1 do
List[ToIndex + I] := List[FromIndex + I]
else
for I := Count - 1 downto 0 do
List[ToIndex + I] := List[FromIndex + I];
{$ELSE}
begin
Move(List[FromIndex], List[ToIndex], Count * SizeOf(List[0]));
{ Keep reference counting working }
if FromIndex < ToIndex then
FillChar(List[FromIndex], (ToIndex - FromIndex) * SizeOf(List[0]), 0)
else if FromIndex > ToIndex then
FillChar(List[FromIndex + Count - 1], (FromIndex - ToIndex) * SizeOf(List[0]), 0);
{$ENDIF CLR}
end;
procedure MoveArray(var List: TDynObjectArray; FromIndex, ToIndex, Count: Integer); overload;
{$IFDEF CLR}
var
I: Integer;
begin
if FromIndex < ToIndex then
for I := 0 to Count - 1 do
List[ToIndex + I] := List[FromIndex + I]
else
for I := Count - 1 downto 0 do
List[ToIndex + I] := List[FromIndex + I];
{$ELSE}
begin
Move(List[FromIndex], List[ToIndex], Count * SizeOf(List[0]));
{$ENDIF CLR}
end;
procedure MoveArray(var List: TDynIntegerArray; FromIndex, ToIndex, Count: Integer); overload;
{$IFDEF CLR}
var
I: Integer;
begin
if FromIndex < ToIndex then
for I := 0 to Count - 1 do
List[ToIndex + I] := List[FromIndex + I]
else
for I := Count - 1 downto 0 do
List[ToIndex + I] := List[FromIndex + I];
{$ELSE}
begin
Move(List[FromIndex], List[ToIndex], Count * SizeOf(List[0]));
{$ENDIF CLR}
end;
procedure MoveChar(const Source: string; FromIndex: Integer;
var Dest: string; ToIndex, Count: Integer);
{$IFDEF CLR}
var
i: Integer;
Buf: array of Char;
begin
Buf := Dest.ToCharArray;
if FromIndex <= ToIndex then
for i := 0 to Count - 1 do
Buf[ToIndex + i] := Source[FromIndex + i]
else
for i := Count - 1 downto 0 do
Buf[ToIndex + i] := Source[FromIndex + i];
Dest := System.String.Create(Buf);
{$ELSE}
begin
Move(Source[FromIndex + 1], Dest[ToIndex + 1], Count * SizeOf(Char));
{$ENDIF CLR}
end;
{$IFDEF CLR}
function GetBytesEx(const Value): TBytes;
begin
if TObject(Value) is TBytes then
Result := Copy(TBytes(Value))
else
if TObject(Value) is TDynByteArray then
Result := Copy(TDynByteArray(Value))
else
if TObject(Value) is System.Enum then // e.g. TIntegerSet
BitConverter.GetBytes(UInt32(Value))
{ TODO : Add further types }
else
raise EJclError.CreateFmt('GetBytesEx(): Unsupported value type: %s', [TObject(Value).GetType.FullName]);
end;
procedure SetBytesEx(var Value; Bytes: TBytes);
begin
if TObject(Value) is TBytes then
Value := Copy(Bytes)
else
if TObject(Value) is TDynByteArray then
Value := Copy(Bytes)
else
if TObject(Value) is System.Enum then // e.g. TIntegerSet
Value := BitConverter.ToUInt32(Bytes, 0)
{ TODO : Add further types }
else
raise EJclError.CreateFmt('SetBytesEx(): Unsupported value type: %s', [TObject(Value).GetType.FullName]);
end;
procedure SetIntegerSet(var DestSet: TIntegerSet; Value: UInt32);
begin
DestSet := TIntegerSet(Value);
end;
function ByteArrayStringLen(Data: TBytes): Integer;
var
I: Integer;
begin
for I := 0 to High(Data) do
if Data[I] = 0 then
begin
Result := I + 1;
Exit;
end;
Result := Length(Data);
end;
function StringToByteArray(const S: string): TBytes;
var
I: Integer;
AnsiS: AnsiString;
begin
AnsiS := S; // convert to AnsiString
SetLength(Result, Length(AnsiS));
for I := 0 to High(Result) do
Result[I] := Byte(AnsiS[I + 1]);
end;
function ByteArrayToString(const Data: TBytes; Count: Integer): string;
var
I: Integer;
AnsiS: AnsiString;
begin
if Length(Data) < Count then
Count := Length(Data);
SetLength(AnsiS, Count);
for I := 0 to Length(AnsiS) - 1 do
AnsiS[I + 1] := AnsiChar(Data[I]);
Result := AnsiS; // convert to System.String
end;
{$ENDIF CLR}
//== { EJclWin32Error } ======================================================
{$IFDEF MSWINDOWS}
constructor EJclWin32Error.Create(const Msg: string);
begin
{$IFDEF CLR}
inherited Create(''); // this works because the GC cleans the memory
{$ENDIF CLR}
FLastError := GetLastError;
FLastErrorMsg := SysErrorMessage(FLastError);
inherited CreateFmt(Msg + AnsiLineBreak + RsWin32Prefix, [FLastErrorMsg, FLastError]);
end;
constructor EJclWin32Error.CreateFmt(const Msg: string; const Args: array of const);
begin
{$IFDEF CLR}
inherited Create(''); // this works because the GC cleans the memory
{$ENDIF CLR}
FLastError := GetLastError;
FLastErrorMsg := SysErrorMessage(FLastError);
inherited CreateFmt(Msg + AnsiLineBreak + Format(RsWin32Prefix, [FLastErrorMsg, FLastError]), Args);
end;
{$IFNDEF CLR}
constructor EJclWin32Error.CreateRes(Ident: Integer);
begin
FLastError := GetLastError;
FLastErrorMsg := SysErrorMessage(FLastError);
inherited CreateFmt(LoadStr(Ident) + AnsiLineBreak + RsWin32Prefix, [FLastErrorMsg, FLastError]);
end;
constructor EJclWin32Error.CreateRes(ResStringRec: PResStringRec);
begin
FLastError := GetLastError;
FLastErrorMsg := SysErrorMessage(FLastError);
{$IFDEF FPC}
inherited CreateFmt(ResStringRec^ + AnsiLineBreak + RsWin32Prefix, [FLastErrorMsg, FLastError]);
{$ELSE}
inherited CreateFmt(LoadResString(ResStringRec) + AnsiLineBreak + RsWin32Prefix, [FLastErrorMsg, FLastError]);
{$ENDIF FPC}
end;
{$ENDIF ~CLR}
{$ENDIF MSWINDOWS}
// Int64 support
procedure I64ToCardinals(I: Int64; var LowPart, HighPart: Cardinal);
begin
{$IFDEF CLR}
LowPart := Cardinal(I and $00000000FFFFFFFF);
HighPart := Cardinal(I shr 32);
{$ELSE}
LowPart := TULargeInteger(I).LowPart;
HighPart := TULargeInteger(I).HighPart;
{$ENDIF CLR}
end;
procedure CardinalsToI64(var I: Int64; const LowPart, HighPart: Cardinal);
begin
{$IFDEF CLR}
I := Int64(HighPart) shl 16 or LowPart;
{$ELSE}
TULargeInteger(I).LowPart := LowPart;
TULargeInteger(I).HighPart := HighPart;
{$ENDIF CLR}
end;
// Cross Platform Compatibility
{$IFNDEF XPLATFORM_RTL}
procedure RaiseLastOSError;
begin
RaiseLastWin32Error;
end;
{$ENDIF ~XPLATFORM_RTL}
// History:
// $Log: JclBase.pas,v $
// Revision 1.46 2005/12/15 11:35:13 ahuser
// Additional MoveArray function for .NET (should have been committed months ago)
//
// Revision 1.45 2005/10/30 05:24:20 rrossmair
// - updated version information for release 1.96
//
// Revision 1.44 2005/10/26 09:00:32 ahuser
// Extended GetBytes() function to allow TBytes and TDynByteArray usage
//
// Revision 1.43 2005/10/12 04:25:47 rrossmair
// - fixed issue #3255 (error in PJclByteArray declaration)
//
// Revision 1.42 2005/09/11 11:28:25 ahuser
// typo
//
// Revision 1.41 2005/08/12 14:08:53 ahuser
// Fixed compile bug
//
// Revision 1.40 2005/08/11 18:11:24 ahuser
// Added MoveChar function
//
// Revision 1.39 2005/08/07 13:09:54 outchy
// Changed PByteArray to PJclByteArray to avoid RangeCheck exceptions.
//
// Revision 1.38 2005/05/05 20:08:42 ahuser
// JCL.NET support
//
// Revision 1.37 2005/03/23 13:19:06 rrossmair
// - check-in in preparation of release 1.95.3 (Build 1848)
//
// Revision 1.36 2005/03/15 20:12:27 rrossmair
// - version info updated, now 1.95.2, Build 1840
//
// Revision 1.35 2005/03/14 08:46:53 rrossmair
// - check-in in preparation for release 1.95
//
// Revision 1.34 2005/03/09 23:56:45 rrossmair
// - fixed compilation condition for UInt64 declaration ($IFDEF COMPILER7_UP instead of $IFDEF COMPILER7)
//
// Revision 1.33 2005/03/08 16:10:07 marquardt
// standard char sets extended and used, some optimizations for string literals
//
// Revision 1.32 2005/03/08 08:33:15 marquardt
// overhaul of exceptions and resourcestrings, minor style cleaning
//
// Revision 1.31 2005/02/24 16:34:39 marquardt
// remove divider lines, add section lines (unfinished)
//
// Revision 1.30 2005/02/14 00:41:58 rrossmair
// - supply PByte for D5/BCB5. Pbyte is required by JclMath.GetParity; including it here helps
// avoid inclusion of unit Windows in the uses clause of unit JclMath just because of PByte.
//
// Revision 1.29 2005/02/13 22:24:25 rrossmair
// moved PCardinal declaration from JclMime to JclBase
//
// Revision 1.28 2005/02/05 14:21:59 rrossmair
// - version information updated
//
// Revision 1.27 2005/01/06 18:48:31 marquardt
// AnsiLineBreak, AnsiLineFeed, AnsiCarriageReturn, AnsiCrLf moved to JclBase JclStrings now reexports the names
//
// Revision 1.26 2004/12/23 04:31:42 rrossmair
// - check-in for JCL 1.94 RC 1
//
// Revision 1.25 2004/12/18 03:58:05 rrossmair
// - fixed to compile in Delphi 5 again
//
// Revision 1.24 2004/12/17 05:33:02 marquardt
// updates for DCL
//
// Revision 1.23 2004/11/18 00:57:14 rrossmair
// - check-in for release 1.93
//
// Revision 1.22 2004/11/06 02:13:24 mthoma
// history cleaning.
//
// Revision 1.21 2004/09/30 07:50:29 marquardt
// remove PH contributions
//
// Revision 1.20 2004/09/16 19:47:32 rrossmair
// check-in in preparation for release 1.92
//
// Revision 1.19 2004/06/16 07:30:14 marquardt
// added tilde to all IFNDEF ENDIFs, inherited qualified
//
// Revision 1.18 2004/06/14 11:05:50 marquardt
// symbols added to all ENDIFs and some other minor style changes like removing IFOPT
//
// Revision 1.17 2004/06/14 06:24:52 marquardt
// style cleaning IFDEF
//
// Revision 1.16 2004/06/06 01:31:09 rrossmair
// version information updated for build #1558
//
// Revision 1.15 2004/05/31 01:43:18 rrossmair
// Processed documentation TODOs
//
// Revision 1.14 2004/05/13 07:47:30 rrossmair
// Removed FPC compatibility code rendered superfluous by latest FPC updates; updated build #
//
// Revision 1.13 2004/05/08 19:56:55 rrossmair
// FPC-related improvements
//
// Revision 1.12 2004/05/06 05:09:55 rrossmair
// Changes for FPC v1.9.4 compatibility
//
// Revision 1.11 2004/05/05 00:04:10 mthoma
// Updated headers: Added donors as contributors, adjusted the initial authors, added cvs names when they were not obvious. Changed $data to $date where necessary,
//
// Revision 1.10 2004/04/19 06:02:18 rrossmair
// fixed QueryPerformanceCounter (FPC compatibility routine)
//
// Revision 1.9 2004/04/14 23:04:09
// add TDynLongWordArray, TDynBooleanArray
//
// Revision 1.8 2004/04/06 04:53:18
// adapt compiler conditions, add log entry
//
end.