[work in progress] Coroutines the Third

.gitignore

@@ -133,3 +133,4 @@ lib.sexp
 src/compiler/version.ml
 tests/party
 tests/misc/projects/Issue10863/error.log
+tests/misc/coroutines/dump

README.md

@@ -1,99 +1,9 @@
-<p align="center">
-  <a href="https://haxe.org/" title="haxe.org"><img src="extra/images/Readme.png" /></a>
-</p>
-
-<p align="center">
-	<a href="https://github.com/HaxeFoundation/haxe/actions"><img src="https://github.com/HaxeFoundation/haxe/workflows/CI/badge.svg" alt="GitHub Build Status"></a>
-	<a href="https://saucelabs.com/u/haxe"><img src="https://saucelabs.com/buildstatus/haxe" alt="SauceLabs Test Status"></a>
-	<a href="https://gitter.im/HaxeFoundation/haxe?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a>
-	<a href="https://discordapp.com/invite/0uEuWH3spjck73Lo"><img src="https://img.shields.io/discord/162395145352904705.svg?logo=discord" alt="Discord"></a>
-</p>
-
-#
-
-Haxe is an open source toolkit that allows you to easily build cross-platform tools and applications that target many mainstream platforms. The Haxe toolkit includes:
-
- * **The Haxe programming language**, a modern, high-level, strictly-typed programming language
- * **The Haxe cross-compiler**, a state-of-the-art, lightning-speed compiler for many targets
- * **The Haxe standard library**, a complete, cross-platform library of common functionality
-
-Haxe allows you to compile for the following targets:
-
- * JavaScript
- * C++
- * JVM
- * Lua
- * PHP 7
- * Python 3
- * [HashLink](https://hashlink.haxe.org/)
- * [NekoVM](https://nekovm.org/)
- * Flash (SWF Bytecode)
- * And its own [interpreter](https://haxe.org/blog/eval/)
-
-You can try Haxe directly from your browser at [try.haxe.org](https://try.haxe.org)!
-
-For more information about Haxe, head to the [official Haxe website](https://haxe.org).
-
-## License
-
-The Haxe project has several licenses, covering different parts of the projects.
-
- * The Haxe compiler is released under the GNU General Public License version 2 or any later version.
- * The Haxe standard library is released under the MIT license.
- * The Neko virtual machine is released under the MIT license. Its bundled runtime libraries (ndll) and tools are released under open source licenses as described in https://github.com/HaxeFoundation/neko/blob/master/LICENSE
-
-For the complete Haxe licenses, please see https://haxe.org/foundation/open-source.html or [extra/LICENSE.txt](extra/LICENSE.txt).
-
-## Installing Haxe
-
-The latest stable release is available at [https://haxe.org/download/](https://haxe.org/download/). Pre-built binaries are available for your platform:
-
- * **[Windows installer](https://haxe.org/download/file/latest/haxe-latest-win.exe/)**
- * **[Windows binaries](https://haxe.org/download/file/latest/haxe-latest-win.zip/)**
- * **[OSX installer](https://haxe.org/download/file/latest/haxe-latest-osx-installer.pkg/)**
- * **[OSX binaries](https://haxe.org/download/file/latest/haxe-latest-osx.tar.gz/)**
- * **[Linux Software Packages](https://haxe.org/download/linux/)**
- * **[Linux 32-bit binaries](https://haxe.org/download/file/latest/haxe-latest-linux32.tar.gz/)**
- * **[Linux 64-bit binaries](https://haxe.org/download/file/latest/haxe-latest-linux64.tar.gz/)**
-
-Automated development builds are available from [build.haxe.org](http://build.haxe.org).
-
-## Building from source
-
-See [extra/BUILDING.md](extra/BUILDING.md).
-
-## Using Haxe
-
-For information on using Haxe, consult the [Haxe documentation](https://haxe.org/documentation/):
-
- * [Haxe Introduction](https://haxe.org/documentation/introduction/), an introduction to the Haxe toolkit
- * [The Haxe Manual](https://haxe.org/manual/), the reference manual for the Haxe language
- * [Haxe Code Cookbook](https://code.haxe.org), code snippets / learning resource
- * [Haxe API](https://api.haxe.org), documentation for the Haxe standard and native APIs
- * [Haxelib](https://lib.haxe.org), Haxelib is the package manager for the Haxe Toolkit.
-
-## Community
-
-You can get help and talk with fellow Haxers from around the world via:
-
- * [Haxe Community Forum](http://community.haxe.org)
- * [Haxe on Stack Overflow](https://stackoverflow.com/questions/tagged/haxe)
- * [Haxe Gitter chatroom](https://gitter.im/HaxeFoundation/haxe/)
- * [Haxe Discord server](https://discordapp.com/invite/0uEuWH3spjck73Lo)
-
-:+1: Get notified of the latest Haxe news, don't forget to read the [Haxe roundups](https://haxe.io/).
-
-## Version compatibility
-
-Haxe            | Neko  | SWF   | Python | HL   | PHP  | Lua |
---------------- | ----- | ----- | ------ | ---- | ---- | --- |
-2.*             | 1.*   | 8-10  | -      | -    | -    | -   |
-3.0.0           | 2.0.0 |       | -      | -    | 5.1+ | -   |
-3.2.0           |       | 12-14 | 3.2+   | -    |      | -   |
-3.3.0           | 2.1.0 | 21    |        | -    |      | 5.1, 5.2, 5.3, LuaJIT 2.0, 2.1 |
-3.4.0           |       |       |        | 1.1  | 5.4+ and 7.0+ (with `-D php7`) |     |
-4.0.0           | 2.3.0 |       |        | 1.11 | 7.0+ |     |
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more. Thank you!
+* First PR: https://github.com/HaxeFoundation/haxe/pull/10128
+* Second PR: https://github.com/HaxeFoundation/haxe/pull/11554
+* Third PR: https://github.com/HaxeFoundation/haxe/pull/12168
+
+* Original design repo: https://github.com/nadako/haxe-coroutines/
+* Related Kotlin document: https://github.com/Kotlin/KEEP/blob/master/proposals/coroutines.md
+* Coroutines under the hood: https://kt.academy/article/cc-under-the-hood
+* Design of Kotlin coroutines: https://www.droidcon.com/2022/09/22/design-of-kotlin-coroutines/
+* Mega document: https://github.com/JetBrains/kotlin/blob/master/compiler/backend/src/org/jetbrains/kotlin/codegen/coroutines/coroutines-codegen.md

src-json/meta.json

@@ -142,6 +142,18 @@
 		"targets": ["TAbstract"],
 		"links": ["https://haxe.org/manual/types-abstract-core-type.html"]
 	},
+	{
+		"name": "Coroutine",
+		"metadata": ":coroutine",
+		"doc": "Transform function into a coroutine",
+		"targets": ["TClassField"]
+	},
+	{
+		"name": "CoroutineTransformed",
+		"metadata": ":coroutine.transformed",
+		"doc": "Marks a field as being a coroutine that has already been transformed",
+		"targets": ["TClassField"]
+	},
 	{
 		"name": "CppFileCode",
 		"metadata": ":cppFileCode",

src/codegen/fixOverrides.ml

@@ -41,7 +41,11 @@ let fix_override com c f fd =
 	let f2 = (try Some (find_field com c f) with Not_found -> None) in
 	match f2,fd with
 		| Some (f2), Some(fd) ->
-			let targs, tret = (match follow f2.cf_type with TFun (args,ret) -> args, ret | _ -> die "" __LOC__) in
+			let targs, tret = 
+				match follow_with_coro f2.cf_type with
+				| Coro (args,ret) -> Common.expand_coro_type com.basic args ret
+				| NotCoro (TFun(args, ret)) -> args, ret
+				| _ -> die "" __LOC__ in
 			let changed_args = ref [] in
 			let prefix = "_tmp_" in
 			let nargs = List.map2 (fun ((v,ct) as cur) (_,_,t2) ->
@@ -86,7 +90,11 @@ let fix_override com c f fd =
 			f.cf_expr <- Some { fde with eexpr = TFunction fd2 };
 			f.cf_type <- TFun(targs,tret);
 		| Some(f2), None when (has_class_flag c CInterface) ->
-			let targs, tret = (match follow f2.cf_type with TFun (args,ret) -> args, ret | _ -> die "" __LOC__) in
+			let targs, tret = 
+				match follow_with_coro f2.cf_type with
+				| Coro (args,ret) -> Common.expand_coro_type com.basic args ret
+				| NotCoro (TFun(args, ret)) -> args, ret
+				| _ -> die "" __LOC__ in
 			f.cf_type <- TFun(targs,tret)
 		| _ ->
 			()

src/context/common.ml

@@ -754,9 +754,20 @@ let create timer_ctx compilation_step cs version args display_mode =
 			tfloat = mk_mono();
 			tbool = mk_mono();
 			tstring = mk_mono();
+			texception = mk_mono();
 			tnull = (fun _ -> die "Could use locate abstract Null<T> (was it redefined?)" __LOC__);
 			tarray = (fun _ -> die "Could not locate class Array<T> (was it redefined?)" __LOC__);
 			titerator = (fun _ -> die "Could not locate typedef Iterator<T> (was it redefined?)" __LOC__);
+			tunit = mk_mono();
+			tcoro = {
+				tcoro = (fun _ -> die "Could not locate abstract Coroutine<T> (was it redefined?)" __LOC__);
+				continuation = mk_mono();
+				base_continuation_class = null_class;
+				suspension_state = mk_mono();
+				suspension_result = (fun _ -> die "Could not locate class ContinuationResult<T> (was it redefined?)" __LOC__);
+				suspension_result_class = null_class;
+				immediate_suspension_result_class = null_class;
+			}
 		};
 		std = null_class;
 		file_keys = new file_keys;
@@ -887,6 +898,17 @@ let clone com is_macro_context =
 			tnull = (fun _ -> die "Could use locate abstract Null<T> (was it redefined?)" __LOC__);
 			tarray = (fun _ -> die "Could not locate class Array<T> (was it redefined?)" __LOC__);
 			titerator = (fun _ -> die "Could not locate typedef Iterator<T> (was it redefined?)" __LOC__);
+			texception = mk_mono();
+			tunit = mk_mono();
+			tcoro = {
+				tcoro = (fun _ -> die "Could not locate abstract Coroutine<T> (was it redefined?)" __LOC__);
+				continuation = mk_mono();
+				base_continuation_class = null_class;
+				suspension_state = mk_mono();
+				suspension_result = (fun _ -> die "Could not locate class ContinuationResult<T> (was it redefined?)" __LOC__);
+				suspension_result_class = null_class;
+				immediate_suspension_result_class = null_class;
+			};
 		};
 		std = null_class;
 		module_to_file = new hashtbl_lookup;
@@ -1097,6 +1119,11 @@ let get_entry_point com =
 		(snd path, c, e)
 	) com.main.main_path
 
+let expand_coro_type basic args ret =
+	let args = args @ [("_hx_continuation",false,basic.tcoro.continuation)] in
+	let ret = if ExtType.is_void (follow ret) then basic.tunit else ret in
+	(args,basic.tcoro.suspension_result ret)
+
 let make_unforced_lazy t_proc f where =
 	let r = ref (lazy_available t_dynamic) in
 	r := lazy_wait (fun() ->

src/context/typecore.ml

@@ -92,6 +92,7 @@ type typer_pass_tasks = {
 
 type function_mode =
 	| FunFunction
+	| FunCoroutine
 	| FunNotFunction
 
 type typer_globals = {
@@ -113,6 +114,7 @@ type typer_globals = {
 	mutable delayed_display : DisplayTypes.display_exception_kind option;
 	root_typer : typer;
 	(* api *)
+	mutable continuation_api : ContTypes.continuation_api option;
 	do_macro : typer -> macro_mode -> path -> string -> expr list -> pos -> macro_result;
 	do_load_macro : typer -> bool -> path -> string -> pos -> ((string * bool * t) list * t * tclass * Type.tclass_field);
 	do_load_module : ?origin:module_dep_origin -> typer -> path -> pos -> module_def;
@@ -288,8 +290,11 @@ module TyperManager = struct
 		let e = create_ctx_e ctx.e.curfun FunNotFunction in
 		create ctx ctx.m ctx.c f e PTypeField ctx.type_params
 
+	let is_coroutine_context ctx =
+		ctx.e.function_mode = FunCoroutine
+
 	let is_function_context ctx = match ctx.e.function_mode with
-		| FunFunction ->
+		| FunFunction | FunCoroutine ->
 			true
 		| FunNotFunction ->
 			false

src/core/tFunctions.ml

@@ -649,6 +649,21 @@ let rec follow_lazy_and_mono t = match t with
 	| _ ->
 		t
 
+type maybe_coro =
+	| Coro of tsignature
+	| NotCoro of t
+
+let follow_with_coro t = match follow t with
+	| TAbstract({a_path = (["haxe";"coro"],"Coroutine")},[t]) ->
+		begin match follow t with
+			| TFun(args,ret) ->
+				Coro (args,ret)
+			| t ->
+				NotCoro t
+		end
+	| t ->
+		NotCoro t
+
 let rec ambiguate_funs t =
 	match follow t with
 	| TFun _ -> TFun ([], t_dynamic)

src/core/tType.ml

@@ -481,6 +481,18 @@ and build_state =
 
 exception Type_exception of t
 
+(* TODO: Most of this can probably be moved to the typer context
+   with lazy initialization from the coro code. *)
+type coro_types = {
+	mutable tcoro : (string * bool * t) list -> t -> t;
+	mutable continuation : t;
+	mutable base_continuation_class : tclass;
+	mutable suspension_state : t;
+	mutable suspension_result : t -> t;
+	mutable suspension_result_class : tclass;
+	mutable immediate_suspension_result_class : tclass;
+}
+
 type basic_types = {
 	mutable tvoid : t;
 	mutable tany : t;
@@ -490,7 +502,10 @@ type basic_types = {
 	mutable tnull : t -> t;
 	mutable tstring : t;
 	mutable tarray : t -> t;
-	mutable titerator : t -> t
+	mutable texception : t;
+	mutable titerator : t -> t;
+	mutable tunit : t;
+	mutable tcoro : coro_types;
 }
 
 type class_field_scope =

src/core/texpr.ml

@@ -649,6 +649,24 @@ let for_remap basic v etype e1 e2 p =
 		mk (TWhile((mk (TParenthesis ehasnext) ehasnext.etype ehasnext.epos),ebody,NormalWhile)) basic.tvoid e1.epos;
 	]) basic.tvoid p
 
+let not_while_true_to_while_true basic e1 e2 flag t p =
+	let e_break = mk TBreak t_dynamic p in
+	let e_not = mk (TUnop(Not,Prefix,Builder.mk_parent e1)) e1.etype e1.epos in
+	let e_if eo = mk (TIf(e_not,e_break,eo)) basic.tvoid p in
+	let rec map_continue e = match e.eexpr with
+		| TContinue ->
+			duplicate_tvars e_identity (e_if (Some e))
+		| TWhile _ ->
+			e
+		| _ ->
+			map_expr map_continue e
+	in
+	let e2 = if flag = NormalWhile then e2 else map_continue e2 in
+	let e_if = e_if None in
+	let e_block = if flag = NormalWhile then concat e_if e2 else concat e2 e_if in
+	let e_true = mk (TConst (TBool true)) basic.tbool p in
+	mk (TWhile(e_true,e_block,NormalWhile)) t p
+
 (* -------------------------------------------------------------------------- *)
 (* BUILD META DATA OBJECT *)
 

src/coro/contTypes.ml

@@ -0,0 +1,25 @@
+open Type
+
+type continuation_api = {
+	state : tclass_field;
+	result : tclass_field;
+	error : tclass_field;
+	completion : tclass_field;
+	context : tclass_field;
+	goto_label : tclass_field;
+	recursing : tclass_field;
+	immediate_result : texpr -> texpr;
+	immediate_error : texpr -> Type.t -> texpr;
+}
+
+let create_continuation_api immediate_result immediate_error state result error completion context goto_label recursing = {
+	immediate_result;
+	immediate_error;
+	state;
+	result;
+	error;
+	completion;
+	context;
+	goto_label;
+	recursing;
+}