fpc/rtl/inc/rttidecl.inc

{
    This file is part of the Free Pascal run time library.
    Copyright (c) 2018 by Sven Barth
    member of the Free Pascal development team

    Contains various RTTI related, private declarations that are used inside
    the system unit before rtti.inc might be included.

    See the file COPYING.FPC, included in this distribution,
    for details about the copyright.

    This program 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.

 **********************************************************************}


{$ifndef FPC_REQUIRES_PROPER_ALIGNMENT}
  {$define USE_PACKED}
{$endif}

{ 3.1.1 and newer also (re)stores $MinEnumSize and $PackSet upon $Push/$Pop }
{$push}

{$MINENUMSIZE 1   this saves a lot of memory }
{$ifdef FPC_RTTI_PACKSET1}
{ for Delphi compatibility }
{$packset 1}
{$endif}

type
  PTypeKind = ^TTypeKind;

const
  // all potentially managed types
  tkManagedTypes   = [tkAstring,tkWstring,tkUstring,tkArray,
                     tkObject,tkRecord,tkDynArray,tkInterface,tkVariant];

type
  PRecordElement=^TRecordElement;
  TRecordElement=
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
    TypeInfo: PPointer;
    Offset: SizeInt;
  end;

  PRecordInfoFull=^TRecordInfoFull;
  TRecordInfoFull=
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
{$if declared(TRttiDataCommon)}
    Common: TRttiDataCommon;
{$endif declared TRttiDataCommon}
    case TTypeKind of
      tkRecord: (
        InitTable: Pointer;
        Size: Longint;
        Count: Longint;
        { Elements: array[count] of TRecordElement }
      );
      { include for proper alignment }
      tkInt64: (
        dummy : Int64
      );
  end;

  PRecordInfoInit=^TRecordInfoInit;
  TRTTIRecVarOp=procedure(ARec: Pointer);
  TRTTIRecCopyOp=procedure(ASrc, ADest: Pointer);
  TRTTIRecOpType=(rotInitialize, rotFinalize, rotAddRef, rotCopy);
  TRTTIManagement=(manNone, manBuiltin, manCustom);
  PRTTIRecordOpVMT=^TRTTIRecordOpVMT;
  TRTTIRecordOpVMT=
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
    case cardinal of
      0:
      (
        Initialize: TRTTIRecVarOp;
        Finalize: TRTTIRecVarOp;
        AddRef: TRTTIRecVarOp;
        Copy: TRTTIRecCopyOp;
      );
      1: (Ops: array[TRTTIRecOpType] of CodePointer);
  end;

  TRTTIRecordOpOffsetEntry =
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
    ManagmentOperator: CodePointer;
    FieldOffset: SizeUInt;
  end;

  TRTTIRecordOpOffsetTable =
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
    Count: LongWord;
    Entries: array[0..0] of TRTTIRecordOpOffsetEntry;
  end;
  PRTTIRecordOpOffsetTable = ^TRTTIRecordOpOffsetTable;

  TRecordInfoInit=
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
{$if declared(TRttiDataCommon)}
    Common: TRttiDataCommon;
{$endif declared TRttiDataCommon}
    case TTypeKind of
      tkRecord: (
        Terminator: Pointer;
        Size: Longint;
        InitRecordOpTable: PRTTIRecordOpOffsetTable;
        RecordOp: PRTTIRecordOpVMT;
        Count: Longint;
        { Elements: array[count] of TRecordElement }
      );
      { include for proper alignment }
      tkInt64: (
        dummy : Int64
      );
  end;

  PArrayInfo=^TArrayInfo;
  TArrayInfo=
{$ifdef USE_PACKED}
  packed
{$endif USE_PACKED}
  record
{$if declared(TRttiDataCommon)}
    Common: TRttiDataCommon;
{$endif declared TRttiDataCommon}
    case TTypeKind of
      tkArray: (
        Size: SizeInt;
        ElCount: SizeInt;
        ElInfo: PPointer;
        DimCount: Byte;
        Dims:array[0..255] of Pointer;
      );
      { include for proper alignment }
      tkInt64: (
        dummy : Int64
      );
  end;

function RTTIManagementAndSize(typeInfo: Pointer; op: TRTTIRecOpType; out size: SizeInt; maxInteresting: TRTTIManagement): TRTTIManagement; forward;
function RTTIRecordMopInitTable(ti: Pointer): PRTTIRecordOpOffsetTable; forward;

{$pop}