zigcc 0.1.0__tar.gz

zigcc-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+target
+cgo-demo
+dist
+README.md

zigcc-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Jiacai Liu <dev@liujiacai.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zigcc-0.1.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.3
+Name: zigcc
+Version: 0.1.0
+Summary: A util script that aims to ease use `zig cc` to compile C/C++/Rust/Go programs.
+Project-URL: Repository, https://github.com/jiacai2050/zigcc
+Project-URL: Issues, https://github.com/jiacai2050/zigcc/issues
+Author-email: Jiacai Liu <dev@liujiacai.net>
+License-Expression: GPL-3.0
+License-File: LICENSE
+Keywords: compile,cross-compile,rust,zig
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development
+Requires-Python: >=3.0.0
+Description-Content-Type: text/markdown
+
+# zigcc
+
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml)
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml)
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml)
+[<https://img.shields.io/pypi/v/zigcc>](https://pypi.org/project/zigcc)
+
+A util script that aims to ease use `zig cc`{.verbatim} to compile
+C/C++/Rust/Go programs.
+
+# Why
+
+In most cases, we can use following command to use Zig for compile
+
+``` bash
+CC='zig cc' CXX='zig c++' ...
+```
+
+However in real world, there are many issues this way, such as:
+
+-   [zig cc: parse -target and -mcpu/-march/-mtune flags according to
+    clang #4911](https://github.com/ziglang/zig/issues/4911)
+-   [Targets compare: Rust to
+    Zig](https://gist.github.com/kassane/446889ea1dd5ff07048d921f2b755e78)
+-   [unsupported linker
+    arg](https://github.com/search?q=repo%3Aziglang%2Fzig+unsupported+linker+arg%3A&type=issues)
+-   [Rust + \`zig cc\` CRT conflict. :
+    rust](https://www.reddit.com/r/rust/comments/q866qx/rust_zig_cc_crt_conflict/)
+
+So this project was born, it will
+
+-   Convert target between Zig and Rust/Go
+-   Ignore link args when `zig cc`{.verbatim} throw errors, hopefully
+    this will make compile successfully, WIP.
+
+# Install
+
+``` bash
+pip install -U zigcc
+```
+
+This will install three executables:
+
+-   `zigcc`{.verbatim}, used for `CC`{.verbatim}
+-   `zigcxx`{.verbatim}, used for `CXX`{.verbatim}
+-   `zigcargo`{.verbatim} can used to replace `cargo`{.verbatim}, it
+    will automatically set
+    -   `CC`{.verbatim} `CARGO_TARGET_<triple>_LINKER`{.verbatim} to
+        `zigcc`{.verbatim}
+    -   `CXX`{.verbatim} to `zigcxx`{.verbatim}
+
+# Use in GitHub Action
+
+Adding a step to your workflow like this:
+
+``` yaml
+- uses: jiacai2050/zigcc@main
+  with:
+    zig-version: master
+```
+
+Then you can invoke `zigcc`{.verbatim} `zigcxx`{.verbatim}
+`zigcargo`{.verbatim} in following steps.
+
+# Config
+
+There some are env variable to config zigcc:
+
+-   `ZIGCC_FLAGS`{.verbatim}, space separated flags, pass to zig cc. An
+    example is set this to `-fno-sanitize=undefined`{.verbatim} to
+    disable sanitize since they may break your programs. See [Catching
+    undefined behavior with zig
+    cc](https://nathancraddock.com/blog/zig-cc-undefined-behavior/)
+
+-   `ZIGCC_BLACKLIST_FLAGS`{.verbatim}, space separated flags, used to
+    filter flags `zig cc`{.verbatim} don\'t support, such as
+    `-Wl,-dylib`{.verbatim} otherwise you could see errors below
+
+    ``` bash
+    = note: error: unsupported linker arg: -dylib
+    ```
+
+-   `ZIGCC_VERBOSE`{.verbatim} Set to `1`{.verbatim} enable verbose
+    logs.

zigcc-0.1.0/README.md

@@ -0,0 +1,84 @@
+# zigcc
+
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml)
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml)
+[![](https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml/badge.svg)](https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml)
+[<https://img.shields.io/pypi/v/zigcc>](https://pypi.org/project/zigcc)
+
+A util script that aims to ease use `zig cc`{.verbatim} to compile
+C/C++/Rust/Go programs.
+
+# Why
+
+In most cases, we can use following command to use Zig for compile
+
+``` bash
+CC='zig cc' CXX='zig c++' ...
+```
+
+However in real world, there are many issues this way, such as:
+
+-   [zig cc: parse -target and -mcpu/-march/-mtune flags according to
+    clang #4911](https://github.com/ziglang/zig/issues/4911)
+-   [Targets compare: Rust to
+    Zig](https://gist.github.com/kassane/446889ea1dd5ff07048d921f2b755e78)
+-   [unsupported linker
+    arg](https://github.com/search?q=repo%3Aziglang%2Fzig+unsupported+linker+arg%3A&type=issues)
+-   [Rust + \`zig cc\` CRT conflict. :
+    rust](https://www.reddit.com/r/rust/comments/q866qx/rust_zig_cc_crt_conflict/)
+
+So this project was born, it will
+
+-   Convert target between Zig and Rust/Go
+-   Ignore link args when `zig cc`{.verbatim} throw errors, hopefully
+    this will make compile successfully, WIP.
+
+# Install
+
+``` bash
+pip install -U zigcc
+```
+
+This will install three executables:
+
+-   `zigcc`{.verbatim}, used for `CC`{.verbatim}
+-   `zigcxx`{.verbatim}, used for `CXX`{.verbatim}
+-   `zigcargo`{.verbatim} can used to replace `cargo`{.verbatim}, it
+    will automatically set
+    -   `CC`{.verbatim} `CARGO_TARGET_<triple>_LINKER`{.verbatim} to
+        `zigcc`{.verbatim}
+    -   `CXX`{.verbatim} to `zigcxx`{.verbatim}
+
+# Use in GitHub Action
+
+Adding a step to your workflow like this:
+
+``` yaml
+- uses: jiacai2050/zigcc@main
+  with:
+    zig-version: master
+```
+
+Then you can invoke `zigcc`{.verbatim} `zigcxx`{.verbatim}
+`zigcargo`{.verbatim} in following steps.
+
+# Config
+
+There some are env variable to config zigcc:
+
+-   `ZIGCC_FLAGS`{.verbatim}, space separated flags, pass to zig cc. An
+    example is set this to `-fno-sanitize=undefined`{.verbatim} to
+    disable sanitize since they may break your programs. See [Catching
+    undefined behavior with zig
+    cc](https://nathancraddock.com/blog/zig-cc-undefined-behavior/)
+
+-   `ZIGCC_BLACKLIST_FLAGS`{.verbatim}, space separated flags, used to
+    filter flags `zig cc`{.verbatim} don\'t support, such as
+    `-Wl,-dylib`{.verbatim} otherwise you could see errors below
+
+    ``` bash
+    = note: error: unsupported linker arg: -dylib
+    ```
+
+-   `ZIGCC_VERBOSE`{.verbatim} Set to `1`{.verbatim} enable verbose
+    logs.

zigcc-0.1.0/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zigcc"
+dynamic = ["version"]
+authors = [{name = "Jiacai Liu", email="dev@liujiacai.net"}]
+description = "A util script that aims to ease use `zig cc` to compile C/C++/Rust/Go programs."
+readme = "README.md"
+keywords = ["zig", "compile", "rust", "cross-compile"]
+license = "GPL-3.0"
+requires-python = ">=3.0.0"
+dependencies = [
+]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Topic :: Software Development",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+[project.urls]
+Repository = "https://github.com/jiacai2050/zigcc"
+Issues = "https://github.com/jiacai2050/zigcc/issues"
+
+[project.scripts]
+zigcc = "zigcc:main"
+zigcxx = "zigcc:main"
+zigcargo = "zigcc:main"
+
+[tool.hatch.version]
+path = "zigcc/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "zigcc",
+  "pyproject.toml",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+  "zigcc"
+]
+
+# https://github.com/astral-sh/ruff?tab=readme-ov-file#configuration
+[tool.ruff.lint]
+fixable = ["ALL"]
+
+[tool.ruff.format]
+quote-style = "single"

zigcc-0.1.0/zigcc/__init__.py

@@ -0,0 +1,189 @@
+#!/usr/bin/env python3
+
+# A util script that aims to ease use `zig cc` to compile C/C++/Rust/Go programs.
+#
+# How it works:
+# This script will infer which command to run based on `sys.argv[0]`, which is
+# the program name, currently it supports:
+# 1. zigcc, invoke `zig cc`
+# 2. zigcxx, invoke `zig c++`
+# 3. zigcargo, invoke `cargo` with `CC`, `CXX`, and rustc linker set to zig.
+#
+# Supported env vars:
+# 1. `ZIGCC_VERBOSE`, enable verbose log
+# 2. `ZIGCC_FLAGS`, extra flags passed to zig, such as `-fno-sanitize=undefined`
+
+import sys
+import os
+import logging
+import subprocess
+import platform
+
+__VERSION__ = '0.1.0'
+
+UNKNOWN = 0
+RUST = 1
+GO = 2
+IS_MACOS = platform.system() == 'Darwin'
+ENABLE_LOG = os.getenv('ZIGCC_VERBOSE', '0') == '1'
+FLAGS = os.getenv('ZIGCC_FLAGS', '').split(' ')
+FLAGS = [f for f in FLAGS if f != '']
+
+# Blacklist flags, wild match
+BLACKLIST_WILD_FLAGS = os.getenv('ZIGCC_BLACKLIST_FLAGS', '').split(' ') + [
+    '--target',
+    '-exported_symbols_list',
+    '-no_pie',
+    '-Wl,-dylib',
+    # https://github.com/ziglang/zig/issues/5320
+    'self-contained/rcrt1.o',
+    'self-contained/crti.o',
+]
+BLACKLIST_WILD_FLAGS = [f for f in BLACKLIST_WILD_FLAGS if f != '']
+
+
+def log(msg, *args, **kwargs):
+    if ENABLE_LOG:
+        logging.info(msg, *args, **kwargs)
+
+
+def zig_target_from(target, lang):
+    if lang == RUST:
+        # Zig target has no vendor field
+        # i686-pc-windows-msvc --> x86-windows-msvc
+        triple = target.split('-')
+        if len(triple) == 4:
+            [arch, vendor, os, abi] = triple
+        # aarch64-apple-darwin
+        elif len(triple) == 3:
+            [arch, vendor, os] = triple
+            abi = 'none'
+        else:
+            return target
+
+        zig_arch = {
+            'i686': 'x86',
+        }.get(arch, arch)
+        zig_os = {'darwin': 'macos'}.get(os, os)
+        return '-'.join([zig_arch, zig_os, abi])
+    elif lang == GO:
+        [arch, os] = target.split('-', 2)
+        zig_arch = {
+            '386': 'x86',
+            'amd64': 'x86_64',
+            'arm64': 'aarch64',
+        }.get(arch, arch)
+        zig_os = {'darwin': 'macos'}.get(os, os)
+        return '-'.join([zig_arch, zig_os])
+    else:
+        return target
+
+
+# Detect zig target from language specific vars.
+def detect_zig_target():
+    target = os.getenv('CARGO_BUILD_TARGET')
+    if target is not None:
+        return zig_target_from(target, RUST)
+
+    goos = os.getenv('GOOS')
+    if goos is not None:
+        goarch = os.getenv('GOARCH')
+        return zig_target_from('{}-{}'.format(goarch, goos), GO)
+
+    return None
+
+
+def cargo_linker_var_name(target):
+    return 'CARGO_TARGET_{}_LINKER'.format(target.replace('-', '_').upper())
+
+
+def guess_rust_target(args):
+    found_target = False
+    for arg in args:
+        if arg == '--target':
+            found_target = True
+            continue
+        if found_target:
+            return arg
+
+    target = os.getenv('CARGO_BUILD_TARGET')
+    if target is not None:
+        return target
+
+    try:
+        stdout = subprocess.check_output(['rustc', '-Vv']).decode('utf8')
+        for line in stdout.split('\n'):
+            kv = line.split(':', 2)
+            if len(kv) > 1:
+                [key, value] = kv
+                if key == 'host':
+                    return value.strip()
+    except Exception as e:
+        log('Get rustc triple failed, err:{}', e)
+        raise e
+
+
+def run_subprocess(args, env):
+    log('Begin run command\nArgs:%s\nEnv:%s', args, env)
+    try:
+        subprocess.run(args, check=True, env=env)
+    except subprocess.CalledProcessError as e:
+        log(f'Command {e.cmd} failed with error {e.returncode}')
+        sys.exit(e.returncode)
+
+
+def run_as_cargo(args):
+    target = guess_rust_target(args)
+    env = os.environ.copy()
+    env[cargo_linker_var_name(target)] = 'zigcc'
+    env['CC'] = 'zigcc'
+    env['CXX'] = 'zigcxx'
+    run_subprocess(['cargo'] + args, env)
+
+
+def main():
+    logging.basicConfig(level=logging.INFO, format='%(asctime)s %(message)s')
+    program = os.path.basename(sys.argv[0])
+    args = sys.argv[1:]
+    if program == 'zigcargo':
+        run_as_cargo(args)
+        sys.exit(0)
+
+    run_args = {
+        'zigcc': ['zig', 'cc'],
+        'zigcxx': ['zig', 'c++'],
+    }.get(program)
+    if run_args is None:
+        print(f'Unknown program, {program}')
+        sys.exit(1)
+
+    target = detect_zig_target()
+    if target is not None:
+        run_args += ['-target', target]
+
+    for flag in FLAGS:
+        run_args.append(flag)
+
+    # https://github.com/ziglang/zig/issues/10299#issuecomment-989736808
+    # Append $(xcrun --show-sdk-path)/System/Library/Frameworks in search path
+    if IS_MACOS:
+        root_path = subprocess.getoutput('xcrun --show-sdk-path')
+        run_args += [f'-F{root_path}/System/Library/Frameworks']
+
+    for arg in args:
+        found = False
+        for wild_args in BLACKLIST_WILD_FLAGS:
+            if wild_args in arg:
+                found = True
+                break
+
+        if found:
+            continue
+
+        run_args.append(arg)
+
+    run_subprocess(run_args, os.environ)
+
+
+if __name__ == '__main__':
+    main()