paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2026-02-19 18:16:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

LazUtils: Document function GuessPascalEncoding. Improve last paragraph doc for GuessEncoding.

Browse Source
This commit is contained in:
Juha 2026-02-04 21:53:27 +02:00
parent 4beb867d1b
commit 9ac18157ff
2 changed files with 37 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
components/lazutils/lconvencoding.pas
View File

@ -321,23 +321,18 @@ end;
function GetDefaultTextEncoding: string;
begin
if EncodingValid then begin
Result:=DefaultTextEncoding;
exit;
end;
if EncodingValid then
exit(DefaultTextEncoding);
{$IFDEF Windows}
Result:=GetWindowsEncoding;
{$ELSE}
{$IFDEF Darwin}
Result:=EncodingUTF8;
{$ELSE}
Result:=GetUnixEncoding;
{$IFDEF Darwin}
Result:=EncodingUTF8;
{$ELSE}
Result:=GetUnixEncoding;
{$ENDIF}
{$ENDIF}
{$ENDIF}
Result:=NormalizeEncoding(Result);
DefaultTextEncoding:=Result;
EncodingValid:=true;
end;

41
docs/xml/lazutils/lconvencoding.xml
View File

@ -280,22 +280,15 @@ value, including: <var>UTF8BOM</var>, <var>UTF16LEBOM</var>, and
the value.
</p>
<p>
Next, it checks for an explicit '<b>{%encoding</b>' marker at the start of
the value. When present, the value after the marker (up to the closing
'<b>}</b>' character) is normalized and used as the return value.
</p>
<p>
Finally, it checks for a valid UTF-8 encoding (which includes ASCII
characters). All characters in S are examined until a character whose UTF-8
code point is not valid is encountered.
</p>
<p>
When <var>EncodingValid</var> is <b>True</b>, <var>EncodingAnsi</var> is
assumed. Otherwise, the default encoding for the platform is used. When the
return value is <var>EncodingUTF8</var>, it is changed to
'<b>ISO-8859-1</b>'. This is done because the system may use the UTF-8
encoding, but the value in S does not. ISO 8859-1 has a full mapping to
Unicode, and this prevents data loss in encoding conversions.
If encoding cannot be determined, the default encoding for the platform is used.
When it is <var>EncodingUTF8</var>, it is changed to '<b>ISO-8859-1</b>'.
This is done because the system may use the UTF-8 encoding, but the value in S does not.
ISO 8859-1 has a full mapping to Unicode, and this prevents data loss in encoding conversions.
</p>
</descr>
<seealso/>
@ -307,6 +300,32 @@ Unicode, and this prevents data loss in encoding conversions.
<short>String with the content examined in the routine.</short>
</element>
<element name="GuessPascalEncoding">
<short>Works like GuessEncoding but also supports <b>{%encoding ...}</b> directive.</short>
<descr>
<p>
<var>GuessPascalEncoding</var> is a <var>String</var> function which tries to
determine the encoding used for Pascal source code specified in <var>S</var>.
The return value is like in <var>GuessEncoding</var>.
</p>
<p>
First it checks S for various Byte Order Marks at the start, including
<var>UTF8BOM</var>, <var>UTF16LEBOM</var>, and <var>UTF16BEBOM</var>.
Then it checks for an explicit '<b>{%encoding</b>' marker at the start of
the value. When present, the value after the marker (up to the closing
'<b>}</b>' character) is normalized and used as the return value.
Without a '<b>{%encoding</b>' marker the function continues like <var>GuessEncoding</var>.
</p>
</descr>
<seealso/>
</element>
<element name="GuessPascalEncoding.Result">
<short>Encoding name detected, or a default value.</short>
</element>
<element name="GuessPascalEncoding.s">
<short>String with the content examined in the routine.</short>
</element>
<element name="ConvertEncodingFromUTF8">
<short>
Converts the encoded value from UTF-8 to the encoding with the specified name.