📝 docs(tsl): expand syntax operator and object coverage
This commit is contained in:
@@ -24,13 +24,19 @@
|
||||
|
||||
- `TStringList` 可以直接用 `new TStringList()` 创建。
|
||||
- `TStringList` 支持数字下标、字符串键下标、`Count` 和 `Add(...)`。
|
||||
- `THashedStringList` 可以直接创建，最小用法与 `TStringList` 接近，适合按名称快速取值。
|
||||
- 流对象应先按 `TStream` 家族理解；普通脚本里的最小可靠入口是 `TMemoryStream` 这种具体类型。
|
||||
- 直接 `new TStream()` 会失败，错误信息包含 `function:TStream compile error or not found`。
|
||||
- `TMemoryStream` 支持 `Write(...)`、`Read(...)`、`Position`、`Size`。
|
||||
- `TFileStream` 可以带目录别名、文件名和打开模式创建，并支持 `TStream` 的读写位置模型。
|
||||
- `TCipher` 不是“无参即可创建”的对象；`new TCipher()` 会失败。
|
||||
- `TCipher` 的最小写法是 `new TCipher(2)`，然后设置 `Password` 再做 `Encrypt(...)` / `Decrypt(...)`。
|
||||
- `TRsa` 可以直接创建；先 `GenerateKey(...)`，再读取 `PublicKey` / `PrivateKey` 或执行公私钥加解密。
|
||||
- `TIniFile` 适合读写磁盘 INI 文件；`TMemIniFile` 适合内存 INI 数据。
|
||||
- `MailMsg` 和 `MessagePart` 可以直接创建并设置消息字段，但发送邮件流程属于 SMTP 对象/外部服务边界。
|
||||
- `TWebRequest` 和 `TWebResponse` 在普通脚本里不作为可直接 `new` 的对象。
|
||||
- 因此，Web 请求 / 响应对象不要直接写进普通脚本模板；它们应视为特定运行上下文对象。
|
||||
- 本页不承担对象完整方法表；只收能让 agent 稳定生成代码的最小入口。
|
||||
- 本页失败创建示例只用于边界判断，不作为业务代码模板复制。
|
||||
|
||||
## 可直接照写示例
|
||||
@@ -54,15 +60,23 @@ writeLn(obj.Count);
|
||||
- 依次输出 `B=bbb`、`bbb`、`3`、`4`
|
||||
- 说明既可以按数字下标取整行，也可以按键名取 `Name=Value` 里的值
|
||||
|
||||
代码块身份：输出片段
|
||||
### `THashedStringList`
|
||||
|
||||
```text
|
||||
B=bbb
|
||||
bbb
|
||||
3
|
||||
4
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
obj := new THashedStringList();
|
||||
obj.Add("A=aaa");
|
||||
obj.Add("B=bbb");
|
||||
writeLn(obj.Count);
|
||||
writeLn(obj["B"]);
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 依次输出 `2`、`bbb`
|
||||
- 说明 `THashedStringList` 可按 `Name=Value` 的名称键读取值
|
||||
|
||||
### `TStream` 家族的最小可靠入口：`TMemoryStream`
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
@@ -83,6 +97,27 @@ writeLn(mem.Size);
|
||||
- 依次输出 `ABC`、`3`
|
||||
- 说明普通脚本里应优先使用 `TMemoryStream` 这类具体流对象。
|
||||
|
||||
`TFileStream` 可直接打开文件并沿用 `TStream` 的 `Write(...)` / `Read(...)` / `Position` / `Size` 模型：
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
file_name := "object_probe.txt";
|
||||
stream := new TFileStream("", file_name, 65535);
|
||||
buffer := "ABC";
|
||||
stream.Write(buffer, 3);
|
||||
writeLn(stream.Size);
|
||||
stream.Position := 0;
|
||||
outbuf := "xxx";
|
||||
stream.Read(outbuf, 3);
|
||||
writeLn(outbuf);
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 依次输出 `3`、`ABC`
|
||||
- `TFileStream("", file_name, 65535)` 可作为最小读写文件流骨架
|
||||
|
||||
裸 `TStream` 创建反例：
|
||||
|
||||
代码块身份：反例 / 不可照写
|
||||
@@ -130,6 +165,88 @@ writeLn(cipher.Decrypt(enc));
|
||||
- 依次输出 `1`、`abc`
|
||||
- 说明 `TCipher` 必须按“带模式参数创建”来写，随后可稳定走 `Password -> Encrypt -> Decrypt`
|
||||
|
||||
### `TRsa`
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
rsa := new TRsa();
|
||||
rsa.GenerateKey(1024);
|
||||
plain := "abc";
|
||||
enc := rsa.PubEncrypt(plain);
|
||||
writeLn(rsa.PriDecrypt(enc));
|
||||
enc2 := rsa.PriEncrypt(plain);
|
||||
writeLn(rsa.PubDecrypt(enc2));
|
||||
writeLn(length(rsa.PublicKey) > 0);
|
||||
writeLn(length(rsa.PrivateKey) > 0);
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 依次输出 `abc`、`abc`、`1`、`1`
|
||||
- 说明 `TRsa` 先生成密钥，再用公钥加密 / 私钥解密，或私钥加密 / 公钥解密
|
||||
|
||||
### `TIniFile` 与 `TMemIniFile`
|
||||
|
||||
磁盘 INI 文件：
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
ini := new TIniFile("", "object_probe.ini");
|
||||
ini.WriteString("S", "K", "V");
|
||||
writeLn(ini.ReadString("S", "K", ""));
|
||||
ini.WriteInteger("S", "N", 123);
|
||||
writeLn(ini.ReadInteger("S", "N", 0));
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 依次输出 `V`、`123`
|
||||
- 说明 `TIniFile` 适合直接读写磁盘 INI 文件
|
||||
|
||||
内存 INI 数据：
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
ini := new TMemIniFile();
|
||||
ini.WriteString("S", "K", "V");
|
||||
writeLn(ini.ReadString("S", "K", ""));
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 输出 `V`
|
||||
- 说明 `TMemIniFile` 可不依赖磁盘文件，直接读写内存 INI 数据
|
||||
|
||||
### `MailMsg` 与 `MessagePart`
|
||||
|
||||
代码块身份：可直接照写示例
|
||||
|
||||
```tsl
|
||||
msg := new MailMsg();
|
||||
msg.Subject := "Hello";
|
||||
msg.Body := "BodyText";
|
||||
msg.Sender := "sender@example.com";
|
||||
msg.Recipients := "to@example.com";
|
||||
writeLn(msg.Subject);
|
||||
writeLn(msg.Body);
|
||||
writeLn(length(msg.AsString) > 0);
|
||||
|
||||
part := new MessagePart();
|
||||
part.ContentType := "text/plain";
|
||||
part.Body := "PartBody";
|
||||
writeLn(part.ContentType);
|
||||
writeLn(part.Body);
|
||||
```
|
||||
|
||||
结果说明：
|
||||
|
||||
- 依次输出 `Hello`、`BodyText`、`1`、`text/plain`、`PartBody`
|
||||
- 说明 `MailMsg` / `MessagePart` 可作为消息数据对象使用
|
||||
- 发送邮件应回到 SMTP 对象和外部服务配置，不在本页生成连接/认证/发送模板
|
||||
|
||||
### `TWebRequest` / `TWebResponse` 的普通脚本边界
|
||||
|
||||
代码块身份：反例 / 不可照写
|
||||
@@ -145,24 +262,23 @@ resp := new TWebResponse();
|
||||
- `new TWebResponse()` 会报 `function:TWebResponse compile error or not found`。
|
||||
- 普通脚本里，Web 请求 / 响应对象不能直接按普通 `new ...()` 脚本对象来写。
|
||||
|
||||
## 本页不生成的对象
|
||||
## 本页不生成的范围
|
||||
|
||||
- `TFileStream`
|
||||
- `TIniFile`
|
||||
- `TMemIniFile`
|
||||
- `THashedStringList`
|
||||
- `TRSA`
|
||||
- `FTP` / `SMTP` / `POP3`
|
||||
- `MailMsg` / `MessagePart`
|
||||
- `TCookie` / `TCookieCollection`
|
||||
- `TSessionMan` / `TSession`
|
||||
- `FTP` / `SMTP` / `POP3` 的连接、认证、上传下载、发送邮件和收取邮件流程。
|
||||
- `TWebRequest` / `TWebResponse` 的 Web 请求响应流程。
|
||||
- `TCookie` / `TCookieCollection`。
|
||||
- `THandleStream`。
|
||||
- `TRegistryIniFile`。
|
||||
- `TSessionMan` / `TSession`。
|
||||
|
||||
这些对象不作为本页可生成事实；不要因为未写入文档资料里出现过就默认使用。
|
||||
这些对象不作为本页可生成业务流程；不要因为源资料里出现过就默认生成连接、认证、网络访问、Web 请求响应或会话管理代码。
|
||||
|
||||
## 禁止项
|
||||
|
||||
- 不要直接把 `new TStream()` 写成普通脚本里的可靠创建方式。
|
||||
- 不要无参创建 `TCipher`；最小可靠写法是 `new TCipher(2)` 后再设置 `Password`。
|
||||
- 不要把 `TWebRequest` / `TWebResponse` 写进普通脚本模板。
|
||||
- 不要把 `MailMsg.AddText(...)` 当成默认消息正文写法；普通正文优先设置 `Body`。
|
||||
- 不要在缺少主机、账号、密码、端口和协议要求时生成 `FTP` / `SMTP` / `POP3` 连接流程。
|
||||
- 不要把未写入文档资料里的内置对象，当成语法事实。
|
||||
- 不要把本页反例块里的失败创建代码包进 `try/except` 后当成业务模板。
|
||||
|
||||
Reference in New Issue
Block a user