feat[stdlib]: add concat method for StringBuilder (#217)

It returns `self`, thus allowing chaining of `concat` calls
tact-lang · Apr 1, 2024 · a7f3ad0 · a7f3ad0
1 parent ea5191a
commit a7f3ad0
Show file tree

Hide file tree

Showing 7 changed files with 90 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Reserve mode constants in `@stdlib/reserve`, namely `ReserveExact`, `ReserveAllExcept`, `ReserveAtMost`, `ReserveAddOriginalBalance`, `ReserveInvertSign`, `ReserveBounceIfActionFail`: PR [#173](https://github.com/tact-lang/tact/pull/173)
 - JSON Schema for `tact.config.json`: PR [#194](https://github.com/tact-lang/tact/pull/194)
 - Display an error for integer overflow at compile-time: PR [#200](https://github.com/tact-lang/tact/pull/200)
+- Non-modifying `StringBuilder`'s `concat` method for chained string concatenations: PR [#217](https://github.com/tact-lang/tact/pull/217)
 
 ### Changed
 - Update the `dump` function to handle addresses: PR [#175](https://github.com/tact-lang/tact/pull/175)

diff --git a/src/generator/writers/__snapshots__/writeSerialization.spec.ts.snap b/src/generator/writers/__snapshots__/writeSerialization.spec.ts.snap
@@ -2996,6 +2996,21 @@ return ((builders), ());",
     "name": "__tact_string_builder_append",
     "signature": "((tuple), ()) __tact_string_builder_append(tuple builders, slice sc)",
   },
+  {
+    "code": {
+      "code": "builders~__tact_string_builder_append(sc);
+return builders;",
+      "kind": "generic",
+    },
+    "comment": null,
+    "context": "stdlib",
+    "depends": Set {
+      "__tact_string_builder_append",
+    },
+    "flags": Set {},
+    "name": "__tact_string_builder_append_not_mut",
+    "signature": "(tuple) __tact_string_builder_append_not_mut(tuple builders, slice sc)",
+  },
   {
     "code": {
       "code": "var b = begin_cell();
@@ -6978,6 +6993,21 @@ return ((builders), ());",
     "name": "__tact_string_builder_append",
     "signature": "((tuple), ()) __tact_string_builder_append(tuple builders, slice sc)",
   },
+  {
+    "code": {
+      "code": "builders~__tact_string_builder_append(sc);
+return builders;",
+      "kind": "generic",
+    },
+    "comment": null,
+    "context": "stdlib",
+    "depends": Set {
+      "__tact_string_builder_append",
+    },
+    "flags": Set {},
+    "name": "__tact_string_builder_append_not_mut",
+    "signature": "(tuple) __tact_string_builder_append_not_mut(tuple builders, slice sc)",
+  },
   {
     "code": {
       "code": "var b = begin_cell();
@@ -10960,6 +10990,21 @@ return ((builders), ());",
     "name": "__tact_string_builder_append",
     "signature": "((tuple), ()) __tact_string_builder_append(tuple builders, slice sc)",
   },
+  {
+    "code": {
+      "code": "builders~__tact_string_builder_append(sc);
+return builders;",
+      "kind": "generic",
+    },
+    "comment": null,
+    "context": "stdlib",
+    "depends": Set {
+      "__tact_string_builder_append",
+    },
+    "flags": Set {},
+    "name": "__tact_string_builder_append_not_mut",
+    "signature": "(tuple) __tact_string_builder_append_not_mut(tuple builders, slice sc)",
+  },
   {
     "code": {
       "code": "var b = begin_cell();

diff --git a/src/generator/writers/writeStdlib.ts b/src/generator/writers/writeStdlib.ts
@@ -1227,6 +1227,17 @@ export function writeStdlib(ctx: WriterContext) {
         });
     });
 
+    ctx.fun(`__tact_string_builder_append_not_mut`, () => {
+        ctx.signature(`(tuple) __tact_string_builder_append_not_mut(tuple builders, slice sc)`);
+        ctx.context('stdlib');
+        ctx.body(() => {
+            ctx.write(`
+                builders~${ctx.used('__tact_string_builder_append')}(sc);
+                return builders;
+            `);
+        });
+    });
+
     ctx.fun(`__tact_int_to_string`, () => {
         ctx.signature(`slice __tact_int_to_string(int src)`);
         ctx.context('stdlib');

diff --git a/src/imports/stdlib.ts b/src/imports/stdlib.ts
@@ -228,27 +228,29 @@ files['std/text.tact'] =
     'KF9fdGFjdF9zdHJpbmdfYnVpbGRlcl9zdGFydF90YWlsX3N0cmluZykKbmF0aXZlIGJlZ2luVGFpbFN0cmluZygpOiBTdHJpbmdCdWlsZGVyOwoKQG5hbWUoX190YWN0' +
     'X3N0cmluZ19idWlsZGVyX3N0YXJ0KQpuYXRpdmUgYmVnaW5TdHJpbmdGcm9tQnVpbGRlcihiOiBCdWlsZGVyKTogU3RyaW5nQnVpbGRlcjsKCkBuYW1lKF9fdGFjdF9z' +
     'dHJpbmdfYnVpbGRlcl9hcHBlbmQpCmV4dGVuZHMgbXV0YXRlcyBuYXRpdmUgYXBwZW5kKHNlbGY6IFN0cmluZ0J1aWxkZXIsIHM6IFN0cmluZyk7CgpAbmFtZShfX3Rh' +
-    'Y3Rfc3RyaW5nX2J1aWxkZXJfZW5kKQpleHRlbmRzIG5hdGl2ZSB0b0NlbGwoc2VsZjogU3RyaW5nQnVpbGRlcik6IENlbGw7CgpAbmFtZShfX3RhY3Rfc3RyaW5nX2J1' +
-    'aWxkZXJfZW5kX3NsaWNlKQpleHRlbmRzIG5hdGl2ZSB0b1N0cmluZyhzZWxmOiBTdHJpbmdCdWlsZGVyKTogU3RyaW5nOwoKQG5hbWUoX190YWN0X3N0cmluZ19idWls' +
-    'ZGVyX2VuZF9zbGljZSkKZXh0ZW5kcyBuYXRpdmUgdG9TbGljZShzZWxmOiBTdHJpbmdCdWlsZGVyKTogU2xpY2U7CgovLwovLyBTdHJpbmcgY29udmVyc2lvbgovLwoK' +
-    'QG5hbWUoX190YWN0X2ludF90b19zdHJpbmcpCmV4dGVuZHMgbmF0aXZlIHRvU3RyaW5nKHNlbGY6IEludCk6IFN0cmluZzsKCkBuYW1lKF9fdGFjdF9mbG9hdF90b19z' +
-    'dHJpbmcpCmV4dGVuZHMgbmF0aXZlIHRvRmxvYXRTdHJpbmcoc2VsZjogSW50LCBkaWdpdHM6IEludCk6IFN0cmluZzsKCmlubGluZSBleHRlbmRzIGZ1biB0b0NvaW5z' +
-    'U3RyaW5nKHNlbGY6IEludCk6IFN0cmluZyB7CiAgICByZXR1cm4gc2VsZi50b0Zsb2F0U3RyaW5nKDkpOwp9CgpleHRlbmRzIGZ1biBhc0NvbW1lbnQoc2VsZjogU3Ry' +
-    'aW5nKTogQ2VsbCB7CiAgICBsZXQgYjogU3RyaW5nQnVpbGRlciA9IGJlZ2luQ29tbWVudCgpOwogICAgYi5hcHBlbmQoc2VsZik7CiAgICByZXR1cm4gYi50b0NlbGwo' +
-    'KTsKfQoKQG5hbWUoX190YWN0X3N0cl90b19zbGljZSkKZXh0ZW5kcyBuYXRpdmUgYXNTbGljZShzZWxmOiBTdHJpbmcpOiBTbGljZTsKCkBuYW1lKF9fdGFjdF9zbGlj' +
-    'ZV90b19zdHIpCmV4dGVuZHMgbmF0aXZlIGFzU3RyaW5nKHNlbGY6IFNsaWNlKTogU3RyaW5nOwoKaW5saW5lIGV4dGVuZHMgZnVuIGZyb21CYXNlNjQoc2VsZjogU3Ry' +
-    'aW5nKTogU2xpY2UgewogICAgcmV0dXJuIHNlbGYuYXNTbGljZSgpLmZyb21CYXNlNjQoKTsKfQoKZXh0ZW5kcyBmdW4gZnJvbUJhc2U2NChzZWxmOiBTbGljZSk6IFNs' +
-    'aWNlIHsKICAgIGxldCBzaXplOiBJbnQgPSBzZWxmLmJpdHMoKSAvIDg7CiAgICBsZXQgcmVzdWx0OiBCdWlsZGVyID0gYmVnaW5DZWxsKCk7CgogICAgcmVwZWF0IChz' +
-    'aXplKSB7CiAgICAgICAgbGV0IGNvZGU6IEludCA9IHNlbGYubG9hZFVpbnQoOCk7CiAgICAgICAgaWYgKGNvZGUgPj0gNjUgJiYgY29kZSA8PSA5MCkgeyAvLyBBLVoK' +
-    'ICAgICAgICAgICAgcmVzdWx0ID0gcmVzdWx0LnN0b3JlVWludChjb2RlIC0gNjUsIDYpOwogICAgICAgIH0gZWxzZSBpZiAoY29kZSA+PSA5NyAmJiBjb2RlIDw9IDEy' +
-    'MikgeyAvLyBhLXoKICAgICAgICAgICAgcmVzdWx0ID0gcmVzdWx0LnN0b3JlVWludChjb2RlIC0gKDk3IC0gMjYpLCA2KTsKICAgICAgICB9IGVsc2UgaWYgKGNvZGUg' +
-    'Pj0gNDggJiYgY29kZSA8PSA1NykgeyAvLyAwLTkKICAgICAgICAgICAgcmVzdWx0ID0gcmVzdWx0LnN0b3JlVWludChjb2RlICsgKDUyIC0gNDgpLCA2KTsKICAgICAg' +
-    'ICB9IGVsc2UgaWYgKGNvZGUgPT0gNDUgfHwgY29kZSA9PSA0MykgeyAvLyAtIG9yICsKICAgICAgICAgICAgcmVzdWx0ID0gcmVzdWx0LnN0b3JlVWludCg2MiwgNik7' +
-    'CiAgICAgICAgfSBlbHNlIGlmIChjb2RlID09IDk1IHx8IGNvZGUgPT0gNDcpIHsgLy8gXyBvciAvCiAgICAgICAgICAgIHJlc3VsdCA9IHJlc3VsdC5zdG9yZVVpbnQo' +
-    'NjMsIDYpOwogICAgICAgIH0gZWxzZSBpZiAoY29kZSA9PSA2MSkgeyAvLyA9CiAgICAgICAgICAgIC8vIFNraXAKICAgICAgICB9IGVsc2UgewogICAgICAgICAgICB0' +
-    'aHJvdygxMzQpOwogICAgICAgIH0KICAgIH0KCiAgICAvLyBQYWRkaW5nCiAgICBsZXQgdG90YWw6IEludCA9IHJlc3VsdC5iaXRzKCk7CiAgICBsZXQgcGFkZGluZzog' +
-    'SW50ID0gdG90YWwgJSA4OwogICAgaWYgKHBhZGRpbmcgIT0gMCkgewogICAgICAgIGxldCBzOiBTbGljZSA9IHJlc3VsdC5hc1NsaWNlKCk7CiAgICAgICAgcmV0dXJu' +
-    'IHMubG9hZEJpdHModG90YWwgLSBwYWRkaW5nKTsKICAgIH0gZWxzZSB7CiAgICAgICAgcmV0dXJuIHJlc3VsdC5hc1NsaWNlKCk7CiAgICB9Cn0=';
+    'Y3Rfc3RyaW5nX2J1aWxkZXJfYXBwZW5kX25vdF9tdXQpCmV4dGVuZHMgbmF0aXZlIGNvbmNhdChzZWxmOiBTdHJpbmdCdWlsZGVyLCBzOiBTdHJpbmcpOiBTdHJpbmdC' +
+    'dWlsZGVyOwoKQG5hbWUoX190YWN0X3N0cmluZ19idWlsZGVyX2VuZCkKZXh0ZW5kcyBuYXRpdmUgdG9DZWxsKHNlbGY6IFN0cmluZ0J1aWxkZXIpOiBDZWxsOwoKQG5h' +
+    'bWUoX190YWN0X3N0cmluZ19idWlsZGVyX2VuZF9zbGljZSkKZXh0ZW5kcyBuYXRpdmUgdG9TdHJpbmcoc2VsZjogU3RyaW5nQnVpbGRlcik6IFN0cmluZzsKCkBuYW1l' +
+    'KF9fdGFjdF9zdHJpbmdfYnVpbGRlcl9lbmRfc2xpY2UpCmV4dGVuZHMgbmF0aXZlIHRvU2xpY2Uoc2VsZjogU3RyaW5nQnVpbGRlcik6IFNsaWNlOwoKLy8KLy8gU3Ry' +
+    'aW5nIGNvbnZlcnNpb24KLy8KCkBuYW1lKF9fdGFjdF9pbnRfdG9fc3RyaW5nKQpleHRlbmRzIG5hdGl2ZSB0b1N0cmluZyhzZWxmOiBJbnQpOiBTdHJpbmc7CgpAbmFt' +
+    'ZShfX3RhY3RfZmxvYXRfdG9fc3RyaW5nKQpleHRlbmRzIG5hdGl2ZSB0b0Zsb2F0U3RyaW5nKHNlbGY6IEludCwgZGlnaXRzOiBJbnQpOiBTdHJpbmc7CgppbmxpbmUg' +
+    'ZXh0ZW5kcyBmdW4gdG9Db2luc1N0cmluZyhzZWxmOiBJbnQpOiBTdHJpbmcgewogICAgcmV0dXJuIHNlbGYudG9GbG9hdFN0cmluZyg5KTsKfQoKZXh0ZW5kcyBmdW4g' +
+    'YXNDb21tZW50KHNlbGY6IFN0cmluZyk6IENlbGwgewogICAgbGV0IGI6IFN0cmluZ0J1aWxkZXIgPSBiZWdpbkNvbW1lbnQoKTsKICAgIGIuYXBwZW5kKHNlbGYpOwog' +
+    'ICAgcmV0dXJuIGIudG9DZWxsKCk7Cn0KCkBuYW1lKF9fdGFjdF9zdHJfdG9fc2xpY2UpCmV4dGVuZHMgbmF0aXZlIGFzU2xpY2Uoc2VsZjogU3RyaW5nKTogU2xpY2U7' +
+    'CgpAbmFtZShfX3RhY3Rfc2xpY2VfdG9fc3RyKQpleHRlbmRzIG5hdGl2ZSBhc1N0cmluZyhzZWxmOiBTbGljZSk6IFN0cmluZzsKCmlubGluZSBleHRlbmRzIGZ1biBm' +
+    'cm9tQmFzZTY0KHNlbGY6IFN0cmluZyk6IFNsaWNlIHsKICAgIHJldHVybiBzZWxmLmFzU2xpY2UoKS5mcm9tQmFzZTY0KCk7Cn0KCmV4dGVuZHMgZnVuIGZyb21CYXNl' +
+    'NjQoc2VsZjogU2xpY2UpOiBTbGljZSB7CiAgICBsZXQgc2l6ZTogSW50ID0gc2VsZi5iaXRzKCkgLyA4OwogICAgbGV0IHJlc3VsdDogQnVpbGRlciA9IGJlZ2luQ2Vs' +
+    'bCgpOwoKICAgIHJlcGVhdCAoc2l6ZSkgewogICAgICAgIGxldCBjb2RlOiBJbnQgPSBzZWxmLmxvYWRVaW50KDgpOwogICAgICAgIGlmIChjb2RlID49IDY1ICYmIGNv' +
+    'ZGUgPD0gOTApIHsgLy8gQS1aCiAgICAgICAgICAgIHJlc3VsdCA9IHJlc3VsdC5zdG9yZVVpbnQoY29kZSAtIDY1LCA2KTsKICAgICAgICB9IGVsc2UgaWYgKGNvZGUg' +
+    'Pj0gOTcgJiYgY29kZSA8PSAxMjIpIHsgLy8gYS16CiAgICAgICAgICAgIHJlc3VsdCA9IHJlc3VsdC5zdG9yZVVpbnQoY29kZSAtICg5NyAtIDI2KSwgNik7CiAgICAg' +
+    'ICAgfSBlbHNlIGlmIChjb2RlID49IDQ4ICYmIGNvZGUgPD0gNTcpIHsgLy8gMC05CiAgICAgICAgICAgIHJlc3VsdCA9IHJlc3VsdC5zdG9yZVVpbnQoY29kZSArICg1' +
+    'MiAtIDQ4KSwgNik7CiAgICAgICAgfSBlbHNlIGlmIChjb2RlID09IDQ1IHx8IGNvZGUgPT0gNDMpIHsgLy8gLSBvciArCiAgICAgICAgICAgIHJlc3VsdCA9IHJlc3Vs' +
+    'dC5zdG9yZVVpbnQoNjIsIDYpOwogICAgICAgIH0gZWxzZSBpZiAoY29kZSA9PSA5NSB8fCBjb2RlID09IDQ3KSB7IC8vIF8gb3IgLwogICAgICAgICAgICByZXN1bHQg' +
+    'PSByZXN1bHQuc3RvcmVVaW50KDYzLCA2KTsKICAgICAgICB9IGVsc2UgaWYgKGNvZGUgPT0gNjEpIHsgLy8gPQogICAgICAgICAgICAvLyBTa2lwCiAgICAgICAgfSBl' +
+    'bHNlIHsKICAgICAgICAgICAgdGhyb3coMTM0KTsKICAgICAgICB9CiAgICB9CgogICAgLy8gUGFkZGluZwogICAgbGV0IHRvdGFsOiBJbnQgPSByZXN1bHQuYml0cygp' +
+    'OwogICAgbGV0IHBhZGRpbmc6IEludCA9IHRvdGFsICUgODsKICAgIGlmIChwYWRkaW5nICE9IDApIHsKICAgICAgICBsZXQgczogU2xpY2UgPSByZXN1bHQuYXNTbGlj' +
+    'ZSgpOwogICAgICAgIHJldHVybiBzLmxvYWRCaXRzKHRvdGFsIC0gcGFkZGluZyk7CiAgICB9IGVsc2UgewogICAgICAgIHJldHVybiByZXN1bHQuYXNTbGljZSgpOwog' +
+    'ICAgfQp9';
 files['stdlib_ex.fc'] =
     'Zm9yYWxsIFggLT4gdHVwbGUgX190YWN0X3NldCh0dXBsZSB4LCBYIHYsIGludCBpKSBhc20gIlNFVElOREVYVkFSUSI7CigpIF9fdGFjdF9ub3AoKSBhc20gIk5PUCI7' +
     'CnNsaWNlIF9fdGFjdF9zdHJfdG9fc2xpY2Uoc2xpY2UgcykgYXNtICJOT1AiOwpzbGljZSBfX3RhY3Rfc2xpY2VfdG9fc3RyKHNsaWNlIHMpIGFzbSAiTk9QIjsKc2xp' +

diff --git a/src/test/feature-strings.spec.ts b/src/test/feature-strings.spec.ts
@@ -22,6 +22,7 @@ describe('feature-strings', () => {
         const l = 'привет мир 👀 привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀';
         expect(await contract.getConstantStringUnicodeLong()).toBe(l);
         expect((await contract.getDynamicStringCell()).equals(beginCell().storeStringTail('Hello!').endCell())).toBe(true);
+        expect((await contract.getDynamicStringCell2()).equals(beginCell().storeStringTail('Hello, World!').endCell())).toBe(true);
         expect((await contract.getDynamicCommentCell()).equals(beginCell().storeUint(0, 32).storeStringTail('Something something world!').endCell())).toBe(true);
         const l2 = 'Hello!привет мир 👀 привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀привет мир 👀';
         expect((await contract.getDynamicCommentCellLarge()).equals(beginCell().storeStringTail(l2).endCell())).toBe(true);

diff --git a/src/test/features/strings.tact b/src/test/features/strings.tact
@@ -26,6 +26,12 @@ contract StringsTester {
         return b.toCell();
     }
 
+    get fun dynamicStringCell2(): Cell {
+        let b: StringBuilder = beginString();
+        b = b.concat("Hello,").concat(" ").concat("World!");
+        return b.toCell();
+    }
+
     get fun dynamicCommentCell(): Cell {
         let b: StringBuilder = beginComment();
         b.append("Something something world!");

diff --git a/stdlib/std/text.tact b/stdlib/std/text.tact
@@ -17,6 +17,9 @@ native beginStringFromBuilder(b: Builder): StringBuilder;
 @name(__tact_string_builder_append)
 extends mutates native append(self: StringBuilder, s: String);
 
+@name(__tact_string_builder_append_not_mut)
+extends native concat(self: StringBuilder, s: String): StringBuilder;
+
 @name(__tact_string_builder_end)
 extends native toCell(self: StringBuilder): Cell;