LResources unit

Maintains a global list of Lazarus resources, and provides methods and types used to stream components.

lresources.pp maintains and stores all standard Lazarus resources in the global LazarusResources list and provides methods and types for component streaming.

A Lazarus resource is streamed as an UTF-8 string, with a name, value and value type.

Lazarus resources are normally included via an include directive in the initialization part of a unit. To create such include files use the BinaryToLazarusResourceCode procedure.

To create an LRS file from an LFM file use the LFMtoLRSfile function which transforms the LFM text to binary format and stores it as Lazarus resource include file.

Author: Mattias Gaertner

lresources.pp is part of the Lazarus Component Library ( LCL).

Classes and records

`TAbstractTranslator`	class	Abstract base class for translators used in the LCL.
`TCustomLazComponentQueue`	class	A queue to stream components, used for multi-threading or network.
`TLazarusResourceStream`	class	Helper class for streaming resources (read only).
`TLazComponentQueue`	class	Publishes property from the ancestor class.
`TLResource`	class	Describes a Lazarus resource stored in TLResourceList.
`TLResourceList`	class	Container class used for Lazarus resource descriptions.
`TLRSObjectReader`	class	Reader for resource streams.
`TLRSObjectWriter`	class	Object writer for Lazarus Resource Streams.
`TLRSORStackItem`	record	Stack item for the nested resource reader.
`TLRSOWStackItem`	record	Stack item for the nested resource writer.
`TPropertiesToSkip`	class	Implements a list used to store properties which are skipped during LCL streaming.
`TPropertyToSkip`	record	Contains information about a property omitted from LCL component streaming.

Procedures and functions

`BinaryToLazarusResourceCode`	procedure
`CompareComponents`	function
`CompareMemStreams`	function
`ConvertEndianBigDoubleToLRSExtended`	procedure
`CreateLFMFile`	function
`CreateLRSReader`	function
`CreateLRSWriter`	function
`DefineRectProperty`	procedure
`FindLFMClassName`	function
`FindResourceLFM`	function
`FloatToLFMStr`	function
`FormDataToText`	procedure
`GetClassNameFromLRSStream`	function
`GetComponentInfoFromLRSStream`	procedure
`InitLazResourceComponent`	function
`InitResourceComponent`	function
`LFMtoLRSfile`	function
`LFMtoLRSstream`	function
`LoadComponentFromConfig`	procedure
`LRSObjectBinaryToText`	procedure
`LRSObjectResourceToText`	procedure
`LRSObjectResToText`	procedure
`LRSObjectTextToBinary`	procedure
`LRSObjectToText`	procedure
`ReadComponentFromBinaryStream`	procedure
`ReadComponentFromTextStream`	procedure
`ReadLFMHeader`	procedure
`ReadLFMHeaderFromFile`	function	Reads the LFM header from the specified file name.
`ReadLRSByte`	function
`ReadLRSCardinal`	function
`ReadLRSCurrency`	function
`ReadLRSDouble`	function
`ReadLRSEndianLittleExtendedAsDouble`	function
`ReadLRSExtended`	function
`ReadLRSInt64`	function
`ReadLRSInt64MB`	function
`ReadLRSInteger`	function
`ReadLRSShortInt`	function
`ReadLRSSingle`	function
`ReadLRSSmallInt`	function
`ReadLRSValueType`	function
`ReadLRSWideString`	function
`ReadLRSWord`	function
`Register`	procedure	Registers the component TLazComponentQueue.
`RegisterPropertyToSkip`	procedure
`ReverseByteOrderInWords`	procedure
`ReverseBytes`	procedure
`SameLFMTypeName`	function	Indicates whether the specified LFM resource matches the specified unit and type names.
`SaveComponentToConfig`	procedure
`TestFormStreamFormat`	function
`WriteComponentAsBinaryToStream`	procedure
`WriteComponentAsTextToStream`	procedure
`WriteLRS10BytesReversed`	procedure
`WriteLRS4BytesReversed`	procedure
`WriteLRS8BytesReversed`	procedure
`WriteLRSCardinal`	procedure
`WriteLRSCurrency`	procedure
`WriteLRSDouble`	procedure
`WriteLRSDoubleAsExtended`	procedure
`WriteLRSEndianBigDoubleAsEndianLittleExtended`	procedure
`WriteLRSExtended`	procedure
`WriteLRSInt64`	procedure
`WriteLRSInt64MB`	procedure	Writes an integer value, using the smallest possible representation.
`WriteLRSInteger`	procedure
`WriteLRSNull`	procedure	Writes the specified number of Null characters to a TStream instance.
`WriteLRSReversedWord`	procedure
`WriteLRSReversedWords`	procedure
`WriteLRSSingle`	procedure
`WriteLRSSmallInt`	procedure
`WriteLRSWideStringContent`	procedure
`WriteLRSWord`	procedure	Writes a Word value to the specified resource stream.

Types

`PLRSORStackItem`	type	Stack item for the nested resource reader.
`PLRSOWStackItem`	type	Stack item for the nested resource writer.
`PRemovedProperty`	type	Contains information about a property omitted from LCL component streaming.
`TLazObjectWriterString`	type	Compiler version-specific alias for String values used in TLRSObjectWriter.
`TLRSItemType`	enumeration	Stack item type for the nested resource reader/writer.
`TLRSObjectReaderClass`	type	Reader for resource streams.
`TLRSObjectWriterClass`	type	Object writer for Lazarus Resource Streams.
`TLRSOWStackItemState`	enumeration	Tracking what already has been stored or written.
`TLRSStreamOriginalFormat`	enumeration	Represents the LRS stream format offered as the original content for conversion routines like LRSObjectToText and LRSObjectResToText.

Constants

LRSComment constant Text of the "automatically generated..." warning in resource files.

Variables

`LazarusResources`	variable	The list with all of the loaded standard resources.
`LRSObjectReaderClass`	variable	Class type for Lazarus Object Reader instances.
`LRSObjectWriterClass`	variable	Class type for Lazarus Object Writer instances.
`LRSTranslator`	variable	Variable with the default translator used in CreateLRSReader.
`PropertiesToSkip`	variable	Unit global variable with all of the registered skipped properties.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.