@cella-lang/cfamily 0.0.0-stage → 0.1.202610300255

package/CHANGES.md

@@ -0,0 +1,9 @@
+# @cella-lang/cfamily 的變更
+
+## 未發佈
+
+- 第一版：C 家族（`@cella-lang/c`、`cpp`、`arduino`）共用的深嵌入核心：語法（semorphe 送來的 JSON）、型別檢查、一份記憶體模型上的小步
+  語意、判決、除錯器的工作階段、型別查詢、把程式印回原始碼。沒有自己的入口，由三個分支使用。
+- 判決的 `clause` 照程式的語言：C 程式引 C11，C++ 程式的核心語言規則引 C++17（N4659：有號溢位 `C++17 [expr]p4`、除以零
+  `[expr.mul]p4`、移位 `[expr.shift]p1-2`、不確定的值 `[dcl.init]p12`…）；C 的標準函式庫兩者都引 C11（C++ 以引用納入）。
+- 文字照 UTF-8：語法樹的字串、輸入、除錯時補的輸入是 Unicode 碼位，程式看到的是 UTF-8 位元組；輸出照 UTF-8 解回，不合法的序列是 U+FFFD。

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,7 @@
+Cella
+Copyright 2026 SungYu Chang
+
+This product includes software developed by SungYu Chang
+(the Cella proof language: checker, standard library, and playground).
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,88 @@
-# Temporary Holding Version
+# @cella-lang/cfamily
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The C family's core for the [Cella](https://www.npmjs.com/package/cella-lang) proof checker, as a compiled module pack:
+C11 and C++17 as a deep embedding. A program is a data value (the JSON of its syntax tree), and its type checking and
+execution are ordinary functions on that value.
+
+The core has no entries of its own. Use one of its three branches, each a package with its own verdict, type query and
+debugger; a branch lists this package in its `index.json` and loads it first.
+
+| Package | Programs |
+|---|---|
+| `@cella-lang/c` | C11 (`"lang": {"k": "langC"}`) |
+| `@cella-lang/cpp` | C++17 (`"lang": {"k": "langCpp"}`), without a board |
+| `@cella-lang/arduino` | C++17 on an Arduino board (`"board": "uno"`, `"esp32"`, …) |
+
+The packages depend on each other as `machine` <- `cfamily` <- `c`, `cpp` <- `arduino`.
+
+## Programs
+
+A program is the JSON of `cfamily.syntax`: `{"k": "prog", "n": "<node>", "lang": …, "items": […]}`, with `"board"` and
+the host's inputs over time (`"inputs"`) for a board. Every constructor carries the node label of the editor that made
+it (`"n"`), and a verdict, a stop of the debugger or a type error names the node.
+
+Text is Unicode on the host's side and UTF-8 bytes in the program, as with clang and gcc: string literals, the input and
+the debugger's fed input are encoded (`"é"` is two bytes, `sizeof("é")` is 3); the output is the bytes the program
+wrote, decoded, with U+FFFD for an invalid sequence.
+
+## Verdicts
+
+A branch's `verdict src input fuel` returns:
+
+```json
+{"verdict": "reject", "basis": "computed", "exit": null, "out": "",
+ "problems": [{"kind": "ubOverflow", "at": "<node>", "clause": "C++17 [expr]p4", "reason": "signed overflow"}]}
+```
+
+- `verdict`: `accept`; `reject` (a type error, or undefined behavior); `unknown` (the standard allows results that
+  change the output, a construct the model does not have yet, or the step limit); or `invalid` (the JSON is not a
+  program, or not one for this branch: a C program for a board, a C++ program sent to `c`).
+- `basis`: `computed` when the verdict comes from running the semantics, `kernel` when both kernels proved it
+  (`kernel_verdict_in` in `cella-lang`, with the branch's verdict: `kernel_verdict_in("cpp", "cpp.verdict", …)`).
+- `exit`: the exit status, or `null` when the program did not end.
+- `out`: standard output.
+- `problems`: what decided a reject or an unknown, each with its kind, node, the standard's clause (C11 for C programs,
+  C++17 for C++ ones; the C library is C11's in both) and reason.
+- `assumes` (only when present): the implementation's choices the result depends on, `[{implementation, choice}]`.
+  The library makes them as libc++ does (`vector.growth`: capacity and when `push_back` reallocates; `library.what`:
+  the text of `what()`); a choice of another implementation names it (`gcc:union.typePunning`).
+- A program on a board adds the pins, the environment and the clock (see `@cella-lang/arduino`).
+
+## Type query
+
+A branch's `types src candidates` answers what a block editor asks of a program that may have holes. A hole is
+`{"k": "eHole", "n": "<node>#<slot>"}` (or `sHole` where the syntax needs a statement); a program with holes has the
+verdict `unknown` with a `hole` problem. `candidates` is a JSON array of types written as C or C++ (`"int"`,
+`"double"`, `"char *"`, `"std::string"`, `"struct S"`), the same way the result prints them.
+
+```json
+{"nodes": {"<node>": "int"},
+ "slots": {"<node>#<slot>": {"display": "expects int", "expects": "int",
+                             "fits": {"double": {"level": "narrowing"}, "char *": {"level": "no", "reason": "…"}}}},
+ "errors": [{"at": "<node>", "reason": "…"}]}
+```
+
+- `nodes`: the type of each expression and declaration, before implicit conversions.
+- `fits`: `exact` (no conversion), `convert` (an implicit conversion without loss), `narrowing` (with loss), `no`
+  (rejected, with the reason). The type checker decides: the hole stands for a value of the candidate type, and the
+  level comes from the conversions it puts around it, so overloads, `auto` and `std::cout << ?` follow the real rules.
+- `expects`: the slot's target type when every type that fits is converted to the same one (`int x = ?`, a parameter,
+  `return ?`); `null` when the slot takes anything or depends on the candidate (`std::cout << ?`, `? + 1`, an overloaded
+  call). `display` is for developers.
+- `errors`: statements that do not check. Checking goes on after them, so the other nodes still get their types.
+
+## Modules
+
+| Area | Modules |
+|---|---|
+| Syntax | `cfamily.syntax` (the surface syntax), `syntaxtypes`, `syntaxnodes`, `syntaxwalk`, `syntaxcollect` |
+| Types | `integer` (the integer types), `representation`, `resolution` (written types to resolved ones), `layout`, `literals`, `rules` (where the dialects differ on the same construct), `typetext` (types written as C) |
+| Checking | `typed` (the typed core syntax), `conversion`, `expressions`, `statements`, `lifting`, `statics`, `tables`, `program` |
+| Running | `memory` (objects, pointers as paths, bytes as the target represents them), `arithmetic`, `behavior` (what the standard leaves open), `state`, `evaluation`, `execution`, `sequencing` (unsequenced accesses), `summaries` (what a function may read and write), `running` (a program to its verdict), `encoding` (text at the boundary) |
+| C library | `clibrary`, `standardlibrary`, `librarycode` (the functions written in C), `formatting` (printf), `scanning` (scanf, strtod), `files` |
+| Debugger | `debugging` (the machine for the debugger driver), `sessions`, `variables` |
+| Editors | `querying` (the type query), `generate` (programs back to source) |
+
+## Changes
+
+See `CHANGES.md`.