Difference between revisions of "LazUtils"

From Free Pascal wiki
Jump to navigationJump to search
(→‎UTF8WrapText function: Add See also; add LazUtils category)
 
(3 intermediate revisions by 2 users not shown)
Line 16: Line 16:
 
For a simple dedupe task, just load the strings you want to dedupe and it is done.
 
For a simple dedupe task, just load the strings you want to dedupe and it is done.
  
You can find TLookupStringList on your Lazarus folder ({LazarusDir}\components\lazutils\examples).
+
It is very memory efficient, because:
 +
* Internally it uses a balanced tree container (TStringMap) to store the strings again. A balanced tree is memory efficient compared to a hash map.
 +
* Strings have reference count and lazy copy semantics. It means only a reference to a string is copied to the other container.
 +
 
 +
You can find an example for TLookupStringList in your Lazarus folder: {LazarusDir}\components\lazutils\examples.
  
 
=== UTF8WrapText function ===
 
=== UTF8WrapText function ===
Line 24: Line 28:
 
== See also ==
 
== See also ==
  
[[LazUtils Documentation Roadmap]]
+
* [[LazUtils Documentation Roadmap]]
 +
* [[LazFileUtils]]
  
 
[[Category:Lazarus]]
 
[[Category:Lazarus]]
 
[[Category:LazUtils]]
 
[[Category:LazUtils]]

Latest revision as of 17:13, 20 July 2021

Overview

LazUtils is collection of units that provides non-visual utility functions/classes; it is part of the units supplied by Lazarus but not the LCL (Lazarus Component Library). LazUtils do not have a dependancy on LCL, so they are also suitable for use in command-line, non-GUI applications.

TLookupStringList

The standard TStringList has a serious limitation about duplicated items, Duplicates property only works for sorted lists. It is not possible to avoid duplication in a list which is not sorted or has a custom sort.

TLookupStringList is an unsorted TStringList with a fast lookup feature. Internally it uses a string map container to store the string again. It is then used for InsertItem, Contains, IndexOf and Find methods. The extra container does not reserve excessive memory because the strings are reference-counted and not actually copied.

TLookupStringList fully supports all Duplicates property values including dupIgnore and dupError. A normal unsorted TStringList lacks this support for some values of Duplicates.

This class is particularly useful when you need to preserve the order of strings at the same time doing fast lookups (to check if a string is already there), or when you need to prevent addition of duplicate strings.

For a simple dedupe task, just load the strings you want to dedupe and it is done.

It is very memory efficient, because:

  • Internally it uses a balanced tree container (TStringMap) to store the strings again. A balanced tree is memory efficient compared to a hash map.
  • Strings have reference count and lazy copy semantics. It means only a reference to a string is copied to the other container.

You can find an example for TLookupStringList in your Lazarus folder: {LazarusDir}\components\lazutils\examples.

UTF8WrapText function

It wraps UTF8 text provided as a string into a MaxCol length. It inserts LineEndings at every last space/tab/hyphen character before MaxCol value or just on it and returns the resulting string.

See also