big mess, don't use this cl

Author: aappleby

.gitignore

@@ -5,4 +5,4 @@ build
 dist
 __pycache__
 scratch
-
+htmlcov

.vscode/launch.json

@@ -4,17 +4,6 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-    {
-      "name": "Scratch",
-      "type": "debugpy",
-      "request": "launch",
-      "program": "${workspaceFolder}/hancho.py",
-      "cwd": "${workspaceFolder}/scratch",
-      //"args": ["--force", "-j1"],
-      "console": "integratedTerminal",
-      "justMyCode": false,
-      "preLaunchTask": "Wipe build",
-    },
     {
       "name": "Debug hancho.py",
       "type": "debugpy",
@@ -43,7 +32,7 @@
       "request": "launch",
       "program": "run_tests.py",
       "cwd": "${workspaceFolder}/tests",
-      //"args": ["TestHancho.test_raw_task"],
+      "args": ["TestHancho.test_header_changed"],
       "console": "integratedTerminal",
       "justMyCode": false,
     },
@@ -60,14 +49,25 @@
     },
 
     {
-      "name": "Debug Scratch",
+      "name": "Debug scratch/scratch.py",
       "type": "debugpy",
       "request": "launch",
-      "program": "${workspaceFolder}/scratch.py",
-      "cwd": "${workspaceFolder}/..",
+      "program": "${workspaceFolder}/scratch/scratch.py",
+      "cwd": "${workspaceFolder}/scratch",
       "console": "integratedTerminal",
       "justMyCode": false,
+      "preLaunchTask": "Wipe build",
+    },
+    {
+      "name": "Debug hancho.py in scratch/",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${workspaceFolder}/hancho.py",
+      "cwd": "${workspaceFolder}/scratch",
+      //"args": ["--force", "-j1"],
+      "console": "integratedTerminal",
+      "justMyCode": false,
+      "preLaunchTask": "Wipe build",
     },
-
   ]
 }

.vscode/tasks.json

@@ -16,7 +16,7 @@
     {
       "label": "Wipe build",
       "type": "shell",
-      "command": "rm -rf build tutorial/build",
+      "command": "rm -rf build tutorial/build scratch/build",
     }
   ]
 }

README.md

@@ -48,15 +48,15 @@ compile_cpp = task(
     out_obj = "{ext(in_src, '.o')}",
 )
 
-# To make Hancho do some work, we pass tasks, configs and key-value pairs to hancho().
+# To make Hancho do some work, we pass tasks, configs and key-value pairs to hancho.task().
 # It merges tasks and configs, expands templates, and queues an asynchronous task to run
 # the command.
 
-# The hancho() function returns a Task object, which is like a promise that
+# The hancho.task() function returns a Task object, which is like a promise that
 # resolves to a list of output files when the task is complete.
 
-main_o = hancho(compile_cpp, in_src = "main.cpp")
-util_o = hancho(compile_cpp, in_src = "util.cpp")
+main_o = hancho.task(compile_cpp, in_src = "main.cpp")
+util_o = hancho.task(compile_cpp, in_src = "util.cpp")
 
 # This task defines how to link objects into a binary file. Instead of passing
 # filenames to 'in_objs', we can provide the task objects created above.
@@ -71,7 +71,7 @@ link_cpp_bin = task(
 # Hancho will automatically parallelize independent tasks. Here, main.cpp and
 # util.cpp will be compiled in parallel before the link task starts.
 
-main_app = hancho(
+main_app = hancho.task(
     link_cpp_bin,
     in_objs = [main_o, util_o],
     out_bin = "hello_world",
@@ -81,7 +81,7 @@ main_app = hancho(
 # same directory.
 ```
 
-More documentation (still a work in progress) can be found at [docs/README.md](docs/README.md). The currently-broken step-by-step tutorial is in [tutorial](tutorial). Working examples are in [examples](examples). There are also sample build rules for [C++](base_rules.hancho), [WASM](wasm_rules.hancho), and [FPGA synthesis](fpga_rules.hancho).
+More documentation (still a work in progress) can be found at [docs/README.md](docs/README.md). The currently-broken step-by-step tutorial is in [tutorial](tutorial). Working examples are in [examples](examples). There are also sample build tools for [C++](base_tools.hancho), [WASM](wasm_tools.hancho), and [FPGA synthesis](fpga_tools.hancho).
 
 ## Updates
  - 2024-11-03 - I'm stripping out obsolete documentation and trimming the tutorials down to the essentials.

base_rules.hancho base_tools.hanchobase_rules.hancho renamed to base_tools.hancho

@@ -3,15 +3,15 @@ import os
 ####################################################################################################
 # C++
 
-default_toolchain = config(
+default_toolchain = hancho.config(
     arch = "x86-64",
     compiler = "x86_64-linux-gnu-g++",
     linker = "x86_64-linux-gnu-g++",
 )
 
 # ----------------------------------------
 
-check_cpp = task(
+check_cpp = hancho.Tool(
     desc="Checking C++ syntax of {in_src}",
     command="{toolchain.compiler} {flags} {joined_warnings} {joined_defines} {joined_includes} -c {in_src} && touch {out_ok}",
 
@@ -30,7 +30,7 @@ check_cpp = task(
 
 # ----------------------------------------
 
-compile_cpp = task(
+compile_cpp = hancho.Tool(
     desc="Compiling C++ {in_src} -> {out_obj} ({build_tag})",
     command="{toolchain.compiler} {flags} {joined_warnings} {joined_defines} {joined_includes} -c {in_src} -o {out_obj}",
     toolchain=default_toolchain,
@@ -54,20 +54,21 @@ compile_cpp = task(
     joined_warnings="{join('-W', warnings)}",
     joined_defines ="{join('-D', defines)}",
     joined_includes="{join('-I', includes)}",
+    debug = True,
 )
 
 if os.name == "nt":
     compile_cpp.command = "cl.exe /c {in_src} /sourceDependencies {depfile} /Fo:{out_obj}"
     compile_cpp.depformat = "msvc"
 
 
-link_cpp_lib = task(
+link_cpp_lib = hancho.Tool(
     desc="Bundling C++ lib {out_lib}",
     command="ar rcs {out_lib} {in_objs}",
 )
 
 
-link_cpp_bin = task(
+link_cpp_bin = hancho.Tool(
     desc      = "Linking C++ bin {out_bin}",
     toolchain = default_toolchain,
     command   = "{toolchain.linker} {flags} -Wl,--start-group {in_objs} {in_libs} {sys_libs} -Wl,--end-group -o {out_bin}",
@@ -79,19 +80,19 @@ link_cpp_bin = task(
 
 
 def cpp_lib(hancho, *, in_srcs=None, in_objs=None, in_libs=None, out_lib, **kwargs):
-    in_objs = flatten(in_objs)
-    for file in flatten(in_srcs):
-        obj = hancho(compile_cpp, in_src=file, **kwargs)
+    in_objs = hancho.flatten(in_objs)
+    for file in hancho.flatten(in_srcs):
+        obj = hancho.task(compile_cpp, in_src=file, **kwargs)
         in_objs.append(obj)
-    return hancho(link_cpp_lib, in_objs=[in_objs, in_libs], out_lib=out_lib, **kwargs)
+    return hancho.task(link_cpp_lib, in_objs=[in_objs, in_libs], out_lib=out_lib, **kwargs)
 
 
 def cpp_bin(hancho, *, in_srcs=None, in_objs=None, in_libs=None, out_bin, **kwargs):
-    in_objs = flatten(in_objs)
-    for file in flatten(in_srcs):
-        obj = hancho(compile_cpp, in_src=file, **kwargs)
+    in_objs = hancho.flatten(in_objs)
+    for file in hancho.flatten(in_srcs):
+        obj = hancho.task(compile_cpp, in_src=file, **kwargs)
         in_objs.append(obj)
-    return hancho(
+    return hancho.task(
         link_cpp_bin,
         in_objs=[in_objs, in_libs],
         out_bin=out_bin,
@@ -103,34 +104,34 @@ def cpp_bin(hancho, *, in_srcs=None, in_objs=None, in_libs=None, out_bin, **kwar
 # Makefiles
 
 def make(hancho, *, in_makefile, **kwargs):
-    cmd = task(
+    cmd = hancho.Tool(
         desc="Run makefile {in_makefile}",
         command="make -C {make_dir} -f {make_file} {flags}",  #  > /dev/null
         make_dir="{path.dirname(in_makefile)}",
         make_file="{path.basename(in_makefile)}",
         flags="--quiet",
     )
-    return hancho(cmd, in_makefile=in_makefile, **kwargs)
+    return hancho.task(cmd, in_makefile=in_makefile, **kwargs)
 
 
 ####################################################################################################
 # Tests
 
-run_test = task(
+run_test = hancho.Tool(
     desc="Running test {in_test}",
     command="{in_test} {args} && touch {out_pass}",
     task_dir="{test_dir}",
-    test_dir="{mod_dir}",
+    test_dir="{source_dir}",
     args="",
     out_pass="{in_test}.pass",
 )
 
 def cpp_test(hancho, *, in_srcs=None, in_objs=None, in_libs=None, out_bin, **kwargs):
-    objs = [hancho(compile_cpp, in_src=src, **kwargs) for src in flatten(in_srcs)]
-    test_bin = hancho(
+    objs = [hancho.task(compile_cpp, in_src=src, **kwargs) for src in hancho.flatten(in_srcs)]
+    test_bin = hancho.task(
         link_cpp_bin,
         in_objs=[objs, in_objs, in_libs],
         out_bin=out_bin,
         **kwargs
     )
-    return hancho(run_test, in_test=test_bin, **kwargs)
+    return hancho.task(run_test, in_test=test_bin, **kwargs)

build.hancho

@@ -1,4 +1,4 @@
-base_rules  = hancho.repo("{hancho_dir}/base_rules.hancho")
-fpga_rules  = hancho.repo("{hancho_dir}/fpga_rules.hancho")
-riscv_rules = hancho.repo("{hancho_dir}/riscv_rules.hancho")
-wasm_rules  = hancho.repo("{hancho_dir}/wasm_rules.hancho")
+#base_tools  = hancho.repo("{hancho_dir}/base_tools.hancho")
+#fpga_tools  = hancho.repo("{hancho_dir}/fpga_tools.hancho")
+#riscv_tools = hancho.repo("{hancho_dir}/riscv_tools.hancho")
+#wasm_tools  = hancho.repo("{hancho_dir}/wasm_tools.hancho")

build.py

@@ -0,0 +1,9 @@
+#!/usr/bin/python3
+
+print("---------- start ----------")
+import hancho
+
+#print(hancho)
+#print(dir(hancho))
+
+print("---------- done ----------")