https://github.com/jiacai2050/zigcc

A util script that aims to ease use zig cc to compile C/C++/Rust/Go programs.
https://github.com/jiacai2050/zigcc

compile go golang rust rustlang zig ziglang

Last synced: 3 months ago
JSON representation

A util script that aims to ease use zig cc to compile C/C++/Rust/Go programs.

• Host: GitHub
• URL: https://github.com/jiacai2050/zigcc
• Owner: jiacai2050
• License: mit
• Created: 2024-02-05T13:17:43.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T09:53:22.000Z (8 months ago)
• Last Synced: 2024-09-29T02:05:36.917Z (4 months ago)
• Topics: compile, go, golang, rust, rustlang, zig, ziglang
• Language: Python
• Homepage:
• Size: 41 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
* zigcc

[[https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml/badge.svg]]

[[https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml/badge.svg]]

[[https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml/badge.svg]]

[[https://pypi.org/project/zigcc][https://img.shields.io/pypi/v/zigcc]]

A util script that aims to ease use ~zig cc~ to compile C/C++/Rust/Go programs.

* Why

In most cases, we can use following command to use Zig for compile

#+begin_src bash

CC='zig cc' CXX='zig c++' ...

#+end_src

However in real world, there are many issues this way, such as:

- [[https://github.com/ziglang/zig/issues/4911][zig cc: parse -target and -mcpu/-march/-mtune flags according to clang #4911]]

- [[https://gist.github.com/kassane/446889ea1dd5ff07048d921f2b755e78][Targets compare: Rust to Zig]]

- [[https://github.com/search?q=repo%3Aziglang%2Fzig+unsupported+linker+arg%3A&type=issues][unsupported linker arg]]

- [[https://www.reddit.com/r/rust/comments/q866qx/rust_zig_cc_crt_conflict/][Rust + `zig cc` CRT conflict. : rust]]

So this project was born, it will

- Convert target between Zig and Rust/Go

- Ignore link args when =zig cc= throw errors, hopefully this will make compile successfully, WIP.

* Install

#+begin_src bash

pip install -U zigcc

#+end_src

This will install three executables:

- =zigcc=, used for =CC=

- =zigcxx=, used for =CXX=

- =zigcargo= can used to replace =cargo=, it will automatically set

  - =CC= =CARGO_TARGET__LINKER= to =zigcc=

  - =CXX= to =zigcxx=

* Use in GitHub Action

Adding a step to your workflow like this:

#+begin_src yaml

      - name: Install ZigCC

        uses: jiacai2050/zigcc@main

        with:

          zig-version: master

#+end_src

Then you can invoke =zigcc= =zigcxx= =zigcargo= in following steps.

* Config

There some are env variable to config zigcc:

- =ZIGCC_FLAGS=, space separated flags, pass to zig cc. An example is set this to =-fno-sanitize=undefined= to disable sanitize since they may break your programs. See [[https://nathancraddock.com/blog/zig-cc-undefined-behavior/][Catching undefined behavior with zig cc]]

- =ZIGCC_BLACKLIST_FLAGS=, space separated flags, used to filter flags =zig cc= don't support, such as =-Wl,-dylib= otherwise you could see errors below

  #+begin_src bash

  = note: error: unsupported linker arg: -dylib

  #+end_src

- =ZIGCC_VERBOSE= Set to =1= enable verbose logs.