@effekt-lang/effekt 0.62.0 → 0.64.0

package/libraries/common/scanner.effekt

@@ -2,21 +2,15 @@ module scanner
 
 import stream
 
-interface Scan[A] {
-  /// Return the next character, not advancing.
-  /// That is, this does not change what any future calls on the Scanner return.
-  def peek(): A / stop
-  /// Advance the Scanner to the next character.
-  def skip(): Unit / stop
-}
 
+/// Return the next character, not advancing.
+/// That is, this does not change what any future calls on the Scanner return.
+effect peek[A](): A / stop
 
-/// Advance the Scanner to the next token, returning it.
-def read[A](): A / { Scan[A], stop } = {
-  val t = do peek()
-  do skip()
-  return t
-}
+effect Scan[A] = {read[A], peek[A]}
+
+/// Advance the pull stream to the next element, discarding the current element.
+def skip[A](): Unit / {read[A], stop} = { do read(); () }
 
 
 /// Run a scanner by reading from an input stream, discarding its output.
@@ -29,7 +23,7 @@ def expect(message: String) { scanner: () => Unit / fail }: Unit / Exception[Wro
 /// If conversion is successful read the next token, otherwise stop.
 def readWhen[A, B] { convert: A => B / fail }: B / { Scan[A], stop } = {
   val t = attempt { convert(do peek()) } { do stop() };
-  do skip();
+  do read()
   return t
 }
 
@@ -37,7 +31,7 @@ def readWhen[A, B] { convert: A => B / fail }: B / { Scan[A], stop } = {
 def readIf[A] { predicate: A => Bool }: A / { Scan[A], stop } = {
   val t = do peek()
   if (predicate(t)) {
-    do skip()
+    do read()
     return t
   } else {
     do stop()
@@ -51,7 +45,7 @@ def skipIf[A] { predicate: A => Bool }: Unit / { Scan[A], stop } = {
 
 /// Skips the next token but fails instead of stopping.
 def mustSkip[A](): Unit / { Scan[A], fail } =
-  must { do skip() }
+  must { skip() }
 
 /// Skips the next character but fails if it is not the given one.
 def mustSkip(token: Char): Unit / { Scan[Char], fail } =
@@ -91,19 +85,21 @@ def skipIf(e: Char): Unit / { Scan[Char], stop } =
 /// Immediately stops when already at the end.
 def until[A, R] { predicate: A => Bool } { scanner: () => R / Scan[A] }: R / { Scan[A], stop } = {
   var stopped = false
-  if (predicate(do peek())) { stopped = true; do skip() }
+  if (predicate(do peek())) { stopped = true; skip() }
   try {
     scanner()
-  } with Scan[A] {
-    def peek() = resume {
+  } with  peek[A] {
+    resume {
       if (stopped) { do stop() } else { do peek() }
     }
-    def skip() = resume {
+  } with read[A] {
+    resume {
       if (stopped) { do stop() } else {
-        do skip()
+        val t = do read()
         boundary {
-          if (predicate(do peek())) { stopped = true; do skip() }
+          if (predicate(do peek())) { stopped = true; skip() }
         }
+        return t
       }
     }
   }
@@ -165,7 +161,7 @@ def readHexadecimal(): Int / { Scan[Char], fail } = {
 /// Fails whenn there isn't at least one digit.
 def readInteger(): Int / { Scan[Char], fail } =
   must { do peek() } match {
-    case '-' => must { do skip() }; neg(readDecimal())
+    case '-' => must { skip() }; neg(readDecimal())
     case c and isDigit(c) => readDecimal()
     case _ => do fail()
   }
@@ -174,28 +170,29 @@ namespace returning {
 
 /// Run a scanner by reading from an input stream.
 def scanner[A, R] { scanner: () => R / Scan[A] }: R / read[A] = {
+  def upstream(): A / stop = do read()
   var last = None()
   try {
     scanner()
-  } with Scan[A] {
-    def peek() = resume {
+  } with peek[A] { () =>
+    resume {
       last match {
         case None() =>
-          val t = do read()
+          val t = upstream()
           last = Some(t)
           return t
         case Some(t) =>
           return t
       }
     }
-    def skip() = resume {
+  } with read[A] {
+    resume {
       last match {
         case None() =>
-          val _ = do read()
-          return ()
+          upstream()
         case Some(t) =>
           last = None()
-          return ()
+          return t
       }
     }
   }

package/libraries/common/set.effekt

@@ -243,10 +243,14 @@ def intersection[A](s1: Set[A], s2: Set[A]): Set[A] =
 def each[A](set: Set[A]): Unit / emit[A] =
   set.foreach { x => do emit(x) }
 
+/// Collects elements emitted by a push stream producer `stream` into a new set
+/// using provided `compare` function, discarding the result of the producer.
 def collect[A](compare: (A, A) => Ordering at {}) { stream: () => Unit / emit[A] }: Set[A] =
   returning::collect[A, Unit](compare){stream}.second
 
 namespace returning {
+  /// Collects elements emitted by a push stream producer `stream` into a new set
+  /// using provided `compare` function, returning the result of the producer as well as the collected set.
   def collect[A, R](compare: (A, A) => Ordering at {}) { stream: () => R / emit[A] }: (R, Set[A]) =
     try {
       (stream(), empty(compare))

package/libraries/common/stream.effekt

@@ -314,8 +314,8 @@ def tee[A]{ cons1: { => Unit / emit[A] } => Unit }{ cons2: { => Unit / emit[A] }
   }
 }
 
-/// Return exactly the very first element of the given stream
-/// or raise MissingValue if no elements are emitted.
+/// Extract exactly the very first element of the given stream
+/// or fails if no elements are emitted.
 ///
 /// Examples:
 /// ```effekt
@@ -333,6 +333,50 @@ def first[A] { stream: () => Unit / emit[A] }: A / fail = {
   } with emit[A] { a => a }
 }
 
+/// Extract the nth element of the given stream.
+/// Fails if not enough elements are emitted
+def nth[A](n: Int){ stream: () => Unit / emit[A] }: A / fail = {
+  var m = n
+  try {
+    def body(): A = { stream(); do fail() }
+    body()
+  } with emit[A] { a =>
+    if (m == 0) {
+      return a
+    } else {
+      m = m - 1
+      resume(())
+    }
+  }
+}
+
+// Counting and padding
+// --------------------
+
+/// get current position in stream
+effect getPos(): Int
+
+/// Track position in stream, starting with init
+/// Handles getPos
+def tracking[A](init: Int){ body: => Unit / { emit[A], getPos } }: Unit / emit[A] = {
+  var n = init
+  try body()
+  with emit[A] { b => n = n + 1; resume(do emit[A](b)) }
+  with getPos{ resume(n) }
+}
+
+/// Pad to a multiple of fac emitted values, by emitting gen repeatedly
+def pad[A](fac: Int){ gen: => A }: Unit  / {getPos, emit[A]} = {
+  while(mod(do getPos(), fac) != 0) {
+    do emit[A](gen())
+  }
+}
+
+/// Track how many bytes were emitted (in the body)
+/// Handles getPos
+def tracking[A]{ body: => Unit / { emit[A], getPos } }: Unit / emit[A] =
+  tracking[A](0){body}
+
 namespace returning {
 
 /// Canonical handler of push streams that performs `action` for every

package/libraries/common/test.effekt

@@ -33,6 +33,9 @@ def assert(obtained: String, expected: String, msg: String): Unit / Assertion =
 def assert(obtained: Int, expected: Int): Unit / { Assertion, Formatted } =
   assertEqual(obtained, expected) { (x, y) => x == y } { x => show(x) }
 
+def assert(obtained: Byte, expected: Byte): Unit / { Assertion, Formatted } =
+  assertEqual(obtained, expected) { (x, y) => x == y } { x => show(x) }
+
 def assert(obtained: Bool, expected: Bool): Unit / { Assertion, Formatted } =
   assertEqual(obtained, expected) { (x, y) => x == y } { x => show(x) }
 
@@ -68,6 +71,13 @@ def assertThrown[E](ex: on[E]) { body: => Unit / Exception[E] }: Unit / Assertio
 def assertThrows[E] { body: => Unit / Exception[E] }: Unit / Assertion =
   do assert(on[E].default { true } { body(); false }, "Expected Exception, but exited normally")
 
+def assertFail { body: => Unit / fail }: Unit / Assertion =
+  do assert(succeeds {body}, "Expected 'fail', but exited normally")
+
+def assertNoFail { body: => Unit / fail }: Unit / Assertion =
+  onFail { do assert(false, "Unexpected 'fail'") } {body}
+
+
 interface Test {
   def success(name: String, duration: Int): Unit
   def failure(name: String, msg: String, duration: Int): Unit

package/libraries/llvm/io.c

@@ -826,4 +826,43 @@ void c_spawn(struct Pos cmd, struct Pos args, struct Pos options, Stack stack) {
     }
 }
 
+// Returns the required buffer size if the variable exists, or -1 if it does not.
+// This avoids allocating when the variable is not set.
+Int c_getenv_size(struct Pos name) {
+    char* name_str = c_bytearray_into_nullterminated_string(name);
+    erasePositive(name);
+
+    char dummy;
+    size_t size = 1; // Note: size = 1 is required, otherwise libuv always returns EINVAL.
+    int result = uv_os_getenv(name_str, &dummy, &size);
+    free(name_str);
+
+    if (result == UV_ENOENT) return -1;
+    if (result == 0 || result == UV_ENOBUFS) return (Int)size;
+    return -1;
+}
+
+// Returns the value, given the caller already knows it exists with
+// the given buffer size. Caller passes the size from c_getenv_size.
+struct Pos c_getenv_value(struct Pos name, Int size) {
+    char* name_str = c_bytearray_into_nullterminated_string(name);
+    erasePositive(name);
+
+    char* buffer = malloc((size_t)size);
+    size_t buf_size = (size_t)size;
+    int result = uv_os_getenv(name_str, buffer, &buf_size);
+    free(name_str);
+
+    if (result != 0) {
+        // This should not happen, since we already checked with `c_getenv_size`
+        // ...but in case it does, we return an empty string instead.
+        free(buffer);
+        return c_bytearray_new(0);
+    }
+
+    struct Pos value = c_bytearray_from_nullterminated_string(buffer);
+    free(buffer);
+    return value;
+}
+
 #endif

package/licenses/eclipse public license, version 2.0 - epl-2.0.html

@@ -1,5 +1,5 @@
 <!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><title>Eclipse Public License 2.0 (EPL) | The Eclipse Foundation</title>
-<meta property="og:title" content="Eclipse Public License 2.0 (EPL) | The Eclipse Foundation"><meta name=twitter:title content="Eclipse Public License 2.0 (EPL) | The Eclipse Foundation"><meta name=description content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta property="og:description" content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta name=twitter:description content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta name=author content="Wayne Beaton"><link href=/favicon.ico rel=icon type=image/x-icon><meta property="og:image" content="https://www.eclipse.org/images/og-image.jpg"><meta name=twitter:image content="https://www.eclipse.org/images/og-image.jpg"><meta name=twitter:card content="summary"><meta name=twitter:site content="@eclipsefdn"><meta name=twitter:creator content="@eclipsefdn"><meta property="og:url" content="https://www.eclipse.org/legal/epl-2.0/"><meta property="og:type" content="website"><meta property="og:site_name" content="Eclipse Foundation"><meta name=keywords content="epl,epl-2.0,legal,foundation,eclipse,eclipse public license,license,licenses"><meta name=generator content="Hugo 0.144.2"><link rel=canonical href=https://www.eclipse.org/legal/epl-2.0/><link rel=alternate href=/legal/epl-2.0/index.xml type=application/rss+xml title><link rel=stylesheet href="/public/css/styles.css?v=1772392798"><script>(function(e,t,n,s,o){e[s]=e[s]||[],e[s].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var a=t.getElementsByTagName(n)[0],i=t.createElement(n),r=s!="dataLayer"?"&l="+s:"";i.async=!0,i.src="https://www.googletagmanager.com/gtm.js?id="+o+r,a.parentNode.insertBefore(i,a)})(window,document,"script","dataLayer","GTM-5WLCZXC")</script><script>var tableClasses="table"</script><link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap" rel=stylesheet type=text/css></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5WLCZXC" height=0 width=0 style=display:none;visibility:hidden></iframe></noscript><a href=#main class=skip-link>Skip to content</a><div class=eclipsefdn-featured-story-banner data-publish-target=eclipse_org></div><header class="header-wrapper header-wrapper" id=header><div class="navigation-bar dark"><div class=container><div class=navigation-bar-inner><div class=navigation-bar-left><a class="focus-highlight focus-inverse" href=/><img class=navigation-bar-brand src=https://www.eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse-foundation-white-orange.svg alt="Eclipse Foundation"></a></div><nav class="navigation-bar-nav hidden-xs hidden-sm"><ul><li><button type=button class="btn btn-link" data-target=join-us-menu>Join us</button></li><li><button type=button class="btn btn-link" data-target=what-we-do-menu>What we do</button></li><li><button type=button class="btn btn-link" data-target=resources-menu>Resources</button></li><li><button type=button class="btn btn-link" data-target=about-us-menu>About us</button></li></ul></nav><div class=navigation-bar-right><div class="navigation-bar-controls hidden-xs hidden-sm"><ul><li class=dropdown><a class="dropdown-toggle link-unstyled focus-highlight" tabindex=0 id=search-dropdown-toggle data-toggle=dropdown href=# aria-label=Search><i class="fa-solid fa-magnifying-glass" aria-hidden=true></i></a><form class="search-bar dropdown-menu dropdown-menu-right" aria-labelledby=search-dropdown-toggle action=https://www.eclipse.org/home/search/ method=get><input class=search-bar-input name=q placeholder=Search>
+<meta property="og:title" content="Eclipse Public License 2.0 (EPL) | The Eclipse Foundation"><meta name=twitter:title content="Eclipse Public License 2.0 (EPL) | The Eclipse Foundation"><meta name=description content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta property="og:description" content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta name=twitter:description content="The Eclipse Foundation provides our global community of individuals and organisations with a mature, scalable, and business-friendly environment for open source …"><meta name=author content="Wayne Beaton"><link href=/favicon.ico rel=icon type=image/x-icon><meta property="og:image" content="https://www.eclipse.org/images/og-image.jpg"><meta name=twitter:image content="https://www.eclipse.org/images/og-image.jpg"><meta name=twitter:card content="summary"><meta name=twitter:site content="@eclipsefdn"><meta name=twitter:creator content="@eclipsefdn"><meta property="og:url" content="https://www.eclipse.org/legal/epl-2.0/"><meta property="og:type" content="website"><meta property="og:site_name" content="Eclipse Foundation"><meta name=keywords content="epl,epl-2.0,legal,foundation,eclipse,eclipse public license,license,licenses"><meta name=generator content="Hugo 0.144.2"><link rel=canonical href=https://www.eclipse.org/legal/epl-2.0/><link rel=alternate href=/legal/epl-2.0/index.xml type=application/rss+xml title><link rel=stylesheet href="/public/css/styles.css?v=1773598796"><script>(function(e,t,n,s,o){e[s]=e[s]||[],e[s].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var a=t.getElementsByTagName(n)[0],i=t.createElement(n),r=s!="dataLayer"?"&l="+s:"";i.async=!0,i.src="https://www.googletagmanager.com/gtm.js?id="+o+r,a.parentNode.insertBefore(i,a)})(window,document,"script","dataLayer","GTM-5WLCZXC")</script><script>var tableClasses="table"</script><link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap" rel=stylesheet type=text/css></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5WLCZXC" height=0 width=0 style=display:none;visibility:hidden></iframe></noscript><a href=#main class=skip-link>Skip to content</a><div class=eclipsefdn-featured-story-banner data-publish-target=eclipse_org></div><header class="header-wrapper header-wrapper" id=header><div class="navigation-bar dark"><div class=container><div class=navigation-bar-inner><div class=navigation-bar-left><a class="focus-highlight focus-inverse" href=/><img class=navigation-bar-brand src=https://www.eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse-foundation-white-orange.svg alt="Eclipse Foundation"></a></div><nav class="navigation-bar-nav hidden-xs hidden-sm"><ul><li><button type=button class="btn btn-link" data-target=join-us-menu>Join us</button></li><li><button type=button class="btn btn-link" data-target=what-we-do-menu>What we do</button></li><li><button type=button class="btn btn-link" data-target=resources-menu>Resources</button></li><li><button type=button class="btn btn-link" data-target=about-us-menu>About us</button></li></ul></nav><div class=navigation-bar-right><div class="navigation-bar-controls hidden-xs hidden-sm"><ul><li class=dropdown><a class="dropdown-toggle link-unstyled focus-highlight" tabindex=0 id=search-dropdown-toggle data-toggle=dropdown href=# aria-label=Search><i class="fa-solid fa-magnifying-glass" aria-hidden=true></i></a><form class="search-bar dropdown-menu dropdown-menu-right" aria-labelledby=search-dropdown-toggle action=https://www.eclipse.org/home/search/ method=get><input class=search-bar-input name=q placeholder=Search>
 <button class="btn btn-link" type=submit>
 <i class="fa-solid fa-arrow-right"></i></button></form></li><li class=dropdown><a class="dropdown-toggle focus-highlight" id=user-menu href=# data-toggle=dropdown aria-haspopup=true aria-expanded=false tabindex=0><i class="fa-regular fa-user" aria-hidden=true></i></a><ul class="dropdown-menu dropdown-menu-right" aria-labelledby=user-menu><li><a href=https://accounts.eclipse.org/user><i class="fa-solid fa-user margin-right-10" aria-hidden=true></i>
 View my account</a></li><li><a href=https://accounts.eclipse.org/user/edit><i class="fa-solid fa-edit margin-right-10" aria-hidden=true></i>
@@ -43,4 +43,4 @@ Manage cookies</a></li></ul></li></ul></div><div class="navigation-bar-ctas hidd
 <i class="fa-brands fa-youtube fa-stack-1x fa-inverse" aria-hidden=true></i></span></a></li><li><a href=https://www.linkedin.com/company/eclipse-foundation aria-label=LinkedIn><span class=fa-stack><i class="fa-solid fa-circle fa-stack-2x" aria-hidden=true></i>
 <i class="fa-brands fa-linkedin-in fa-stack-1x fa-inverse" aria-hidden=true></i></span></a></li></ul></section><section class=newsletter-section><p class="subheading text-tertiary">Stay up to date</p><h2>Subscribe to our newsletter</h2><form class="newsletter-form margin-top-40" id=mc-embedded-subscribe-form action="https://eclipse.us6.list-manage.com/subscribe/post?u=eaf9e1f06f194eadc66788a85&amp;id=e7538485cd&amp;f_id=00f9c2e1f0" method=post novalidate target=_blank><div class=text-field-outlined><input name=EMAIL type=email placeholder="Your email">
 <button class=newsletter-form-submit type=submit name=subscribe id=mc-embedded-subscribe aria-label=Submit>
-<i class="fa-solid fa-arrow-right" aria-hidden=true></i></button></div></form></section><section class=footer-bottom-section><img class="img-responsive logo" src=https://www.eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse-foundation-white.svg alt="Eclipse Foundation"><div class=legal-information><p>Copyright &copy; Eclipse Foundation AISBL. All rights reserved.</p><ul class=legal-links><li><a href=https://www.eclipse.org/legal/privacy/>Privacy policy</a></li><li><a href=https://www.eclipse.org/legal/terms-of-use/>Terms of use</a></li><li><a href=https://www.eclipse.org/legal/compliance/>Compliance</a></li><li><a href=https://www.eclipse.org/legal/>Legal</a></li></ul></div></section></div></div></footer><div id=footer-js><script src="/public/js/main.js?v1.0?v=1772392798"></script><script>(function(){})(jQuery,document)</script></div></body></html>
+<i class="fa-solid fa-arrow-right" aria-hidden=true></i></button></div></form></section><section class=footer-bottom-section><img class="img-responsive logo" src=https://www.eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse-foundation-white.svg alt="Eclipse Foundation"><div class=legal-information><p>Copyright &copy; Eclipse Foundation AISBL. All rights reserved.</p><ul class=legal-links><li><a href=https://www.eclipse.org/legal/privacy/>Privacy policy</a></li><li><a href=https://www.eclipse.org/legal/terms-of-use/>Terms of use</a></li><li><a href=https://www.eclipse.org/legal/compliance/>Compliance</a></li><li><a href=https://www.eclipse.org/legal/>Legal</a></li></ul></div></section></div></div></footer><div id=footer-js><script src="/public/js/main.js?v1.0?v=1773598796"></script><script>(function(){})(jQuery,document)</script></div></body></html>