@fraczak/k 6.0.0 → 6.0.1

package/DOCS/book.html

@@ -0,0 +1,65 @@
+<div data-align="center">
+<pre><code>      { }                         { }
+     /   \       {.lang name}      |
+   lang   by          --&gt;         name
+    |      |                       |
+   &#39;k&#39;  &#39;wojtek&#39;                  &#39;k&#39;</code></pre>
+</div>
+<h1 id="the-k-language-book">The k-language Book</h1>
+<p>This book describes the k programming language - a minimal functional
+language for transforming tree-structured data using partial functions
+and algebraic data types.</p>
+<h2 id="table-of-contents">Table of Contents</h2>
+<ol type="1">
+<li><a href="book/01-introduction.md">Introduction</a></li>
+<li><a href="book/02-syntax-and-values.md">Syntax and Values</a><br />
+</li>
+<li><a href="book/03-types-as-finite-automata.md">Types as Finite
+Automata</a></li>
+<li><a href="book/04-partial-functions-and-composition.md">Partial
+Functions and Composition</a></li>
+<li><a href="book/05-typing-filters-and-normalization.md">Typing,
+Filters, and Normalization</a></li>
+<li><a href="book/06-values-in-memory.md">Values in Memory</a></li>
+<li><a href="book/07-the-partial-function-abi.md">The Partial Function
+ABI</a></li>
+<li><a href="book/08-operational-semantics-and-execution.md">Operational
+Semantics and Execution</a></li>
+<li><a href="book/09-compiler-architecture.md">Compiler
+Architecture</a></li>
+<li><a href="book/10-from-ast-to-intermediate-representation.md">From
+AST to Intermediate Representation</a></li>
+<li><a href="book/11-llvm-basics.md">LLVM Basics</a></li>
+<li><a href="book/12-code-generation.md">Code Generation</a></li>
+<li><a href="book/13-linking-and-execution.md">Linking and
+Execution</a></li>
+<li><a href="book/14-canonical-serialization.md">Canonical
+Serialization</a></li>
+<li><a href="book/15-optimization-and-folding.md">Optimization and
+Folding</a></li>
+<li><a href="book/16-toward-a-universal-schema-registry.md">Toward a
+Universal Schema Registry</a></li>
+</ol>
+<h2 id="appendices">Appendices</h2>
+<ul>
+<li><a
+href="book/appendix-a-implementing-a-prototype-compiler-in-python.md">Appendix
+A: Implementing a Prototype Compiler in Python</a></li>
+<li><a
+href="book/appendix-b-incorporating-external-predefined-types-and-functions.md">Appendix
+B: Incorporating External Predefined Types and Functions</a></li>
+</ul>
+<hr />
+<p><em>Note: This is the master file. Individual chapters are stored in
+the <code>book/</code> directory for easier editing and maintenance.
+Each chapter can be edited independently and the changes will be
+reflected when the individual files are viewed.</em></p>
+<h2 id="usage">Usage</h2>
+<ul>
+<li><strong>For reading</strong>: Click on any chapter link above to
+read individual chapters</li>
+<li><strong>For editing</strong>: Edit the individual chapter files in
+the <code>book/</code> directory</li>
+<li><strong>For publishing</strong>: Combine chapters as needed for
+different output formats</li>
+</ul>

package/DOCS/book.tex

@@ -0,0 +1,150 @@
+% Options for packages loaded elsewhere
+\PassOptionsToPackage{unicode}{hyperref}
+\PassOptionsToPackage{hyphens}{url}
+\documentclass[
+]{article}
+\usepackage{xcolor}
+\usepackage{amsmath,amssymb}
+\setcounter{secnumdepth}{-\maxdimen} % remove section numbering
+\usepackage{iftex}
+\ifPDFTeX
+  \usepackage[T1]{fontenc}
+  \usepackage[utf8]{inputenc}
+  \usepackage{textcomp} % provide euro and other symbols
+\else % if luatex or xetex
+  \usepackage{unicode-math} % this also loads fontspec
+  \defaultfontfeatures{Scale=MatchLowercase}
+  \defaultfontfeatures[\rmfamily]{Ligatures=TeX,Scale=1}
+\fi
+\usepackage{lmodern}
+\ifPDFTeX\else
+  % xetex/luatex font selection
+\fi
+% Use upquote if available, for straight quotes in verbatim environments
+\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
+\IfFileExists{microtype.sty}{% use microtype if available
+  \usepackage[]{microtype}
+  \UseMicrotypeSet[protrusion]{basicmath} % disable protrusion for tt fonts
+}{}
+\makeatletter
+\@ifundefined{KOMAClassName}{% if non-KOMA class
+  \IfFileExists{parskip.sty}{%
+    \usepackage{parskip}
+  }{% else
+    \setlength{\parindent}{0pt}
+    \setlength{\parskip}{6pt plus 2pt minus 1pt}}
+}{% if KOMA class
+  \KOMAoptions{parskip=half}}
+\makeatother
+\setlength{\emergencystretch}{3em} % prevent overfull lines
+\providecommand{\tightlist}{%
+  \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}
+\usepackage{bookmark}
+\IfFileExists{xurl.sty}{\usepackage{xurl}}{} % add URL line breaks if available
+\urlstyle{same}
+\hypersetup{
+  pdftitle={k-language},
+  pdfauthor={W. Fraczak},
+  hidelinks,
+  pdfcreator={LaTeX via pandoc}}
+
+\title{k-language}
+\author{W. Fraczak}
+\date{}
+
+\begin{document}
+\maketitle
+
+\begin{verbatim}
+      { }                         { }
+     /   \       {.lang name}      |
+   lang   by          -->         name
+    |      |                       |
+   'k'  'wojtek'                  'k'
+\end{verbatim}
+
+\section{The k-language Book}\label{the-k-language-book}
+
+This book describes the k programming language - a minimal functional
+language for transforming tree-structured data using partial functions
+and algebraic data types.
+
+\subsection{Table of Contents}\label{table-of-contents}
+
+\begin{enumerate}
+\def\labelenumi{\arabic{enumi}.}
+\tightlist
+\item
+  \href{book/01-introduction.md}{Introduction}
+\item
+  \href{book/02-syntax-and-values.md}{Syntax and Values}\\
+\item
+  \href{book/03-types-as-finite-automata.md}{Types as Finite Automata}
+\item
+  \href{book/04-partial-functions-and-composition.md}{Partial Functions
+  and Composition}
+\item
+  \href{book/05-typing-filters-and-normalization.md}{Typing, Filters,
+  and Normalization}
+\item
+  \href{book/06-values-in-memory.md}{Values in Memory}
+\item
+  \href{book/07-the-partial-function-abi.md}{The Partial Function ABI}
+\item
+  \href{book/08-operational-semantics-and-execution.md}{Operational
+  Semantics and Execution}
+\item
+  \href{book/09-compiler-architecture.md}{Compiler Architecture}
+\item
+  \href{book/10-from-ast-to-intermediate-representation.md}{From AST to
+  Intermediate Representation}
+\item
+  \href{book/11-llvm-basics.md}{LLVM Basics}
+\item
+  \href{book/12-code-generation.md}{Code Generation}
+\item
+  \href{book/13-linking-and-execution.md}{Linking and Execution}
+\item
+  \href{book/14-canonical-serialization.md}{Canonical Serialization}
+\item
+  \href{book/15-optimization-and-folding.md}{Optimization and Folding}
+\item
+  \href{book/16-toward-a-universal-schema-registry.md}{Toward a
+  Universal Schema Registry}
+\end{enumerate}
+
+\subsection{Appendices}\label{appendices}
+
+\begin{itemize}
+\tightlist
+\item
+  \href{book/appendix-a-implementing-a-prototype-compiler-in-python.md}{Appendix
+  A: Implementing a Prototype Compiler in Python}
+\item
+  \href{book/appendix-b-incorporating-external-predefined-types-and-functions.md}{Appendix
+  B: Incorporating External Predefined Types and Functions}
+\end{itemize}
+
+\begin{center}\rule{0.5\linewidth}{0.5pt}\end{center}
+
+\emph{Note: This is the master file. Individual chapters are stored in
+the \texttt{book/} directory for easier editing and maintenance. Each
+chapter can be edited independently and the changes will be reflected
+when the individual files are viewed.}
+
+\subsection{Usage}\label{usage}
+
+\begin{itemize}
+\tightlist
+\item
+  \textbf{For reading}: Click on any chapter link above to read
+  individual chapters
+\item
+  \textbf{For editing}: Edit the individual chapter files in the
+  \texttt{book/} directory
+\item
+  \textbf{For publishing}: Combine chapters as needed for different
+  output formats
+\end{itemize}
+
+\end{document}

package/NAT.k~

@@ -0,0 +1,452 @@
+-- Examples for defining arithmetic functions natively
+$ yes_no = < {} yes, {} no >;
+swap_yes_no = < /yes |no, /no |yes > $yes_no;
+yes = {}|yes $yes_no;
+no = yes swap_yes_no;
+
+list? = ?< {} nil, {X car, Y cdr} cons > = Y;
+nil = {}|nil list?;
+singleton = {() car, nil cdr} |cons list?;
+cons = {.car car, .cdr cdr} |cons list?;
+nil? = list? / nil nil;
+car = list? /cons .car;
+cdr = list? /cons .cdr;
+
+$ bits = < {} _, bits 0, bits 1 >;
+
+0b = {} | _;
+1_ = | 1;
+0_ = | 0;
+
+0 = 0b 0_;
+succ = {inv x, 0b y} _inc;
+1 = 0 succ;
+2 = 1 succ;
+3 = 2 succ;
+4 = 3 succ;
+5 = 4 succ;
+6 = 5 succ;
+7 = 6 succ;
+8 = 7 succ;
+9 = 8 succ;
+10 = 9 succ;
+11 = 10 succ;
+12 = 11 succ;
+
+empty = $bits < /_ yes, no >;
+empty? = {empty /yes if, () then} .then;
+
+concat = ${bits x, bits y} {.x inv x, .y y} concat_; 
+concat_ = ${bits x, bits y} 
+  < 
+    {.x /0 x, .y 0_ y} concat_, 
+    {.x /1 x, .y 1_ y} concat_, 
+    .y 
+  >;
+inv = {()x, 0b r} _inv; 
+_inv = ${bits x, bits r} < {.x /0 x, .r 0_ r} _inv, {.x /1 x, .r 1_ r} _inv, .r >;
+
+inOrder = ${bits x, bits y} {.x inv x, .y inv y, yes inOrder} inOrder_;
+inOrder_ = ${bits x, bits y, yes_no inOrder} 
+  < 
+    {.x /0 x, .y /0 y, .inOrder inOrder} inOrder_, 
+    {.x /1 x, .y /1 y, .inOrder inOrder} inOrder_,
+    {.x /0 x, .y /1 y, .inOrder inOrder} inOrder_, 
+    {.x /1 y, .y /0 x, .inOrder swap_yes_no inOrder} inOrder_, 
+    {.x </0,/1> if, .inOrder swap_yes_no then} .then, 
+    .inOrder
+  >;
+
+GT = {inOrder /no if, () then} . then;
+
+EQ = GT {.x y, .y x} GT;
+
+toBitList = {inv x, nil r} _toBitList; 
+_toBitList = < 
+  {.x empty? if, .r then }.then, 
+  {.x /0 x, {0 car, .r cdr} cons r} _toBitList, 
+  {.x /1 x, {1 car, .r cdr} cons r} _toBitList 
+>;
+fromBitList =
+< 
+  cdr <
+    {car /0 if, cdr fromBitList 0_ then} .then, 
+    {car /1 if, cdr fromBitList 1_ then} .then
+  >, 
+  0b
+> $bits;
+
+--------------------------------------
+$ int = < bits '+', bits '-' >;
+
+remove_leading_zeros = <
+  /0 remove_leading_zeros, 
+  ()
+>;
+nat = remove_leading_zeros <empty? 0, ()>;
+int = nat | '+' $int;
+abs = $int </'+',/'-'>;
+
+pos? = $int {dec /'+' if, () then} .then;
+neg? = $int {/'-' if, () then} .then; 
+zero_int? = $int {/'+' /0 empty? if, () then} .then;
+minus_one? = $int {/'-' /1 empty? if, () then} .then;
+
+inc = $int <
+  /'+' {inv x, 0b y} _inc |'+',
+  minus_one? 0 int,
+  /'-' {inv x, 0b y} _dec |'-'
+>;
+
+_inc = ${bits x, bits y} <
+    {.x /0 x, .y 1_ y} concat_, 
+    {.x /1 x, .y 0_ y} _inc,
+    .y 1_
+>; 
+
+dec = $int <
+  zero_int? 1 |'-',
+  /'+' {inv x, 0b y} _dec |'+',
+  /'-' {inv x, 0b y} _inc |'-'
+> $int;
+
+_dec = ?{X x, X y, ...} <
+    {.x /1 x, .y 0_ y} concat_, 
+    {.x /0 x, .y 1_ y} _dec
+> ?X;
+
+$carry = <{} 0, {} 1>;
+c0 = {}|0 $carry;
+c1 = {}|1 $carry;
+
+plus = ${int x, int y}
+< 
+  {.x/'+' inv x, .y/'+' inv y, c0 c } _plus inv nat | '+',
+  {.x/'-' inv x, .y/'-' inv y, c0 c } _plus inv nat | '-',
+  {.y/'-' x, .x/'+' y} GT {.x inv x, .y inv y, c0 c} _minus inv nat | '-',
+  {.x/'+' inv x, .y/'-' inv y, c0 c} _minus inv nat |'+',
+  {.x/'-' x, .y/'+' y} GT {.x inv x, .y inv y, c0 c} _minus inv nat | '-',
+  {.y/'+' inv x, .x/'-' inv y, c0 c} _minus inv nat | '+'
+> 
+$int;
+
+swap_sign = <
+  zero_int?,
+  /'+' | '-',
+  /'-' | '+'
+>;
+
+minus = ${int x, int y}
+  {.x x, .y swap_sign y} plus;
+
+_plus =
+  -- least significant bit first addition with carry
+  ${bits x, bits y, carry c}
+  <
+    {.x empty? if, .y empty? and, <.c/0 0, 1> then} .then,
+    {.x empty? if, .c/0 and, .y then} .then,
+
+    {.x y, .y empty? x, .c c} _plus,
+    {<.c/0 0, 1> x, 
+              .y y, .x empty? c0 c} _plus,
+
+    {.x /0 x, .y /0 y, .c/0 c0 c} _plus 0_,
+    {.x /0 x, .y /0 y, .c/1 c0 c} _plus 1_,
+
+    {.x /0 x, .y /1 y, .c/0 c0 c} _plus 1_,
+    {.x /0 x, .y /1 y, .c/1 c1 c} _plus 0_,
+    {.x /1 x, .y /0 y, .c/0 c0 c} _plus 1_,
+    {.x /1 x, .y /0 y, .c/1 c1 c} _plus 0_,
+
+    {.x /1 x, .y /1 y, .c/0 c1 c} _plus 0_,
+    {.x /1 x, .y /1 y, .c/1 c1 c} _plus 1_
+  >
+;
+
+_minus =
+  -- least significat bit first substraction with carry
+  ${bits x, bits y, carry c}
+  <
+    {.x then, .y empty? if, .c/0 and} .then,
+    {.x/1 then, .y empty? if, .c/1 and} .then 0_,
+    {.x/0 x, .y empty? y, .c/1 c1 c} _minus 1_,
+    {.x/0 x, .y/0   y, .c/0 c0 c} _minus 0_,
+    {.x/0 x, .y/0   y, .c/1 c1 c} _minus 1_,  
+    {.x/0 x, .y/1   y, .c/0 c1 c} _minus 1_,
+    {.x/0 x, .y/1   y, .c/1 c1 c} _minus 0_,
+    {.x/1 x, .y/0   y, .c/0 c0 c} _minus 1_,
+    {.x/1 x, .y/0   y, .c/1 c0 c} _minus 0_,
+    {.x/1 x, .y/1   y, .c/0 c0 c} _minus 0_,
+    {.x/1 x, .y/1   y, .c/1 c1 c} _minus 1_
+  >
+;
+
+$ sign = < {} '+' , {} '-' >;
+sign_plus = {}|'+' $sign;
+sign_minus = {}|'-' $sign;
+get_sign = $int </'+' sign_plus, /'-' sign_minus>;
+
+times = ${int x, int y}
+  {
+    <
+      {.x/'+' if, .y /'+' and} sign_plus, 
+      {.x/'-' if, .y /'-' and} sign_plus, 
+      sign_minus
+    > sign,
+    {
+      0 result,
+      .x abs inv _x,
+      .y abs y
+    } _times result
+  }
+  <
+    {.sign/'+' if, .result inv int then} .then,
+    {.sign/'-' if, .result inv int swap_sign then} .then 
+  >
+;
+
+_times =
+  ${bits result, bits _x, bits y}
+  <
+    { .y empty? if, .result then } .then,
+    { 
+      .result 0_ result, 
+      ._x _x, 
+      .y /0 y
+    } _times,
+    { 
+      {._x x, .result 0_ y, c0 c } _plus result, 
+      ._x _x, 
+      .y /1 y 
+    } _times
+  >
+;
+
+
+mod =
+  ${bits x, bits y}
+  _log!
+  < 
+    -- if y > x then (x mod y) = x 
+    {.y x, .x y} GT .y,
+    -- else, i.e.
+    -- if x >= y then (x mod y) = ((x-y mod 2y) mod y)
+    { 
+      {  
+        {.x int x, .y int y} minus /"+" x, 
+        .y inv 0_ inv y
+      } mod x, 
+      .y y 
+    } mod
+  >
+; 
+
+
+// gratest common divisor
+gcd = ${bits x, bits y}
+  <
+    {.y x, .x y} GT, 
+    ()
+  > _gcd
+;
+
+_gcd = <
+  { .y /0 if, .x then } .then,
+  { .y x, mod y } _gcd
+>;
+
+
+
+// div
+
+log2_floor =
+  ${bits x, bits step} 
+-- finds the largest k, such that 'step * 2^k <= x',
+-- returns k1_, i.e., 0 if x < step, and k1_ otherwise.
+  {.x x, .step step, 0 log} log2_floor_;
+
+log2_floor_ = <
+  {{.step x,.x y} GT if, .log then} .then,
+  {.x x, {.step x,0 y} GT {.x x,2 y} {.x int x, .y int y} times abs step, .log int inc abs log} log2_floor_
+>;
+
+
+x_times_2_to_k =
+  ${bits x, bits k}
+  {.x inv _x, .k int k} _x_times_2_to_the_power_of_k inv
+;
+
+_x_times_2_to_the_power_of_k = <
+  {.k zero_int? if, ._x then} .then,
+  {._x 0_ _x, .k dec k} _x_times_2_to_the_power_of_k
+>
+;
+ 
+div = 
+  ${int x, int y} 
+  // remember sign
+  {
+    <
+      { .x/'+' if, .y get_sign then } .then,
+      { .x/'-' if, .y  swap_sign get_sign then } .then
+    > sign,
+    {.x abs x, .y abs step, 0 int res} _div res_wo_sign
+  }
+  < 
+    {.sign/'+' if, {.res_wo_sign.div div, .res_wo_sign.rem rem} then} .then,
+    { .res_wo_sign.div swap_sign div, .res_wo_sign.rem rem }
+  > 
+  ;
+
+_div =
+  {
+    .x x,
+    .step step,
+    .res res,
+    {.x x, .step step} log2_floor log
+  }
+  < 
+    { .log int zero_int? if, {.res div, .x rem} then } .then,
+    { 
+      {1 x, .log int dec abs k} x_times_2_to_k factor,
+      () i
+    }
+    {
+      {.i.x int x, {.i.step int x, .factor int y} times y} minus abs x, 
+      .i.step step, 
+      {.i.res x, .factor int y} plus res
+    } _div
+  >;
+
+
+lcm = 
+  ${bits x, bits y}
+  {{.x int x, .y int y} times x, gcd int y} div .div abs
+;
+
+ factorial = <
+  zero_int? 1 int,
+  /"+" int {dec factorial x, () y} times
+>;
+
+fib_ =
+  <
+    { .n int dec /"+" n,
+      ."fib(n),fib(n.1)" {plus x, .x y} "fib(n),fib(n.1)"
+    } fib_,
+    ."fib(n),fib(n.1)"
+  >
+;
+
+fib = {$bits n, {1 int x, 0 int y} "fib(n),fib(n.1)"} fib_ .x;
+
+
+--------------------
+$ rat = { int n, int d };
+
+rat = ${bits n, bits d} {.n int n, .d int d } normalize_rat;
+
+normalize_rat =
+  $rat 
+  < 
+    { .d/"-" if, 
+      {
+        .n swap_sign n, 
+        .d swap_sign d
+      } then
+     } .then,
+    ()
+  >
+  {() x, {.n abs x,.d abs y} gcd int y}
+  {
+    {.x.n x,.y y} div .div n, 
+    {.x.d x,.y y} div .div d
+  }
+  $rat
+;
+
+
+plus_rat = 
+  ${rat x, rat y}
+  { 
+    .x x, 
+    .y y,
+    {.x.d abs x,.y.d abs y} lcm int lcm
+  }
+  { 
+    {
+      {.x.n x, {.lcm x, .x.d y} div .div y} times x,
+      {.y.n x, {.lcm x, .y.d y} div .div y} times y
+     } plus n, 
+    .lcm d
+  }
+  normalize_rat
+;
+
+
+times_rat = 
+  ${rat x, rat y}
+  { 
+    {.x.n x,.y.n y} times n, 
+    {.x.d x,.y.d y} times d
+  } 
+  normalize_rat;
+ 
+
+minus_rat = 
+  ${rat x, rat y}
+  {
+    .x x, 
+    .y {.n swap_sign n, .d d} y
+  } 
+  plus_rat;
+
+inverse_rat = 
+  $rat
+  { .d n, .n d }
+  normalize_rat
+;
+
+div_rat = 
+  ${rat x, rat y}
+  { .x x, .y inverse_rat y} times_rat
+;
+
+
+--------------------
+
+int_rat = 
+  $rat 
+  { .n n, .d d, {.n x,.d y} div div }
+  { .div.div int, {.div.rem int n, .d d} rat}
+  ${int int, rat rat}
+;
+
+/* 
+ratToString = 
+-- $rat
+[
+    .n toJSON, 
+    "/", 
+    .d toJSON, 
+    " = ",
+    normalize_rat
+    <
+      [.d,.n] GT [.1 toJSON ,"/", .0 toJSON] CONCAT,
+      {.n 0,[.d,1] EQ 1} [.0 toJSON] CONCAT,
+      int_rat [.int toJSON,"+",.rat.n toJSON,"/",.rat.d toJSON] CONCAT
+    >
+  ] CONCAT
+-- $@string
+;
+
+_rat! = $rat {
+  () carryOn, 
+  ratToString _log! drop
+ } .carryOn;
+
+
+
+*/
+
+times