diff options
Diffstat (limited to 'pseudocode-lib/README.md')
| -rw-r--r-- | pseudocode-lib/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/pseudocode-lib/README.md b/pseudocode-lib/README.md new file mode 100644 index 0000000..92a4bbb --- /dev/null +++ b/pseudocode-lib/README.md @@ -0,0 +1,20 @@ +# Experimental string library + +Build with `cmake --build build`. Include the built library in your program and pass it as a compiler input: + +```text +INCLUDE "build/pseudocode-lib/_exp_string.cps" +DECLARE Greeting : _EXP_STRING((C_STRING)"hello") +CALL _EXP_STRING_OUTPUT(Greeting & _EXP_STRING_NUM_TO_STR(42)) +``` + +```sh +build/cpsc prog.cps build/pseudocode-lib/_exp_string.cps +build/cpsc prog.cps build/pseudocode-lib/_exp_string.cps -r +``` + +INCLUDE paths are relative to the program. Adjust them when the program is elsewhere. + +`_EXP_STRING` owns an unbounded `std::string` through one handle. Constructors accept no arguments, another `_EXP_STRING`, `C_STRING`, or `(INTEGER count, C_CHAR character)`. Cast literals to C types explicitly; built-in STRING is not a constructor argument. Copy construction and assignment own independent strings. `_HANDLE` is public only for library implementation access; do not modify or free it. + +The first version provides `&`, `_EXP_STRING_NUM_TO_STR` (INTEGER/REAL), `_EXP_STRING_STR_TO_NUM` (REAL), `_EXP_STRING_LENGTH` (byte length) and `_EXP_STRING_OUTPUT` (text plus newline). Numeric formatting uses `std::to_string`; parsing uses `std::stod` and requires full consumption. C++ standard exceptions print the user call line and are catchable with TRY/CATCH. The built-in STRING remains available with its existing lifetime and NUL limitations. Owning class values inside whole-record or BYVAL-array copies still have bitwise-copy limitations. |