⚖️ A tool for transpiling C to Go.
Go Shell
Permalink
Failed to load latest commit information.
.snapshots Use stringer interface for snapshots instead of []string (#446) Dec 11, 2017
ast InlineCommandComment. Fix #553 (#554) Jan 14, 2018
cc Replace regex.MustCompile with util.GetRegex. Fixes #290 (#297) Nov 1, 2017
darwin Added support for sprintf(), snprintf(), vsprintf(), vsnprintf() and … Jan 2, 2018
examples Move some files into examples/ May 30, 2017
linux Fix misspellings in comments (#308) Nov 2, 2017
noarch CSTD: strcmp implementation. Fix #539 (#548) Jan 10, 2018
preprocessor Single line and multiline comments. Fix #121 (#547) Jan 11, 2018
program Simplification of Go code. Fixes #542 (#544) Jan 14, 2018
tests char array initialization. Fixes #551 and #552 (#555) Jan 14, 2018
transpiler char array initialization. Fixes #551 and #552 (#555) Jan 14, 2018
travis Update SQLite3 version to 3.21 on Travis. Fixes #366 (#387) Dec 3, 2017
types char array initialization. Fixes #551 and #552 (#555) Jan 14, 2018
util Typedef for union. Fixes #475, #496, #508, #522, #524 and #556 (#523) Jan 14, 2018
.codeclimate.yml Adding codeclimate config May 4, 2017
.gitattributes Ignore testing code in GitHub statistics (#324) Nov 5, 2017
.gitignore Added support for nested structures. Fixes #114 (#341) Nov 12, 2017
.travis.yml Adding support for clang 3.5. Fixes #55 (#418) Dec 7, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jul 7, 2017
LICENSE Adding Izyumov Konstantin as a major contributor (#521) Jan 3, 2018
README.md Added GoReport badge to README. Fixes #397 (#403) Dec 5, 2017
cli_test.go Use stringer interface for snapshots instead of []string (#446) Dec 11, 2017
codecov.yml Adding custom codecov file so that it doesnt fail when coverage goes … Apr 26, 2017
main.go Bump version: v0.21.1 Zinc 2018-01-14 Jan 14, 2018
main_test.go Single line and multiline comments. Fix #121 (#547) Jan 11, 2018

README.md

Build Status GitHub version Go Report Card codecov GitHub license Join the chat at https://gitter.im/c2goproject Twitter GoDoc

A tool for converting C to Go.

The goals of this project are:

  1. To create a generic tool that can convert C to Go.
  2. To be cross platform (linux and mac) and work against as many clang versions as possible (the clang AST API is not stable).
  3. To be a repeatable and predictable tool (rather than doing most of the work and you have to clean up the output to get it working.)
  4. To deliver quick and small version increments.
  5. The ultimate milestone is to be able to compile the SQLite3 source code and have it working without modification. This will be the 1.0.0 release.

Installation

go get -u github.com/elliotchance/c2go

Usage

c2go transpile myfile.c

The c2go program processes a single C file and outputs the translated code in Go. Let's use an included example, prime.c:

#include <stdio.h>
 
int main()
{
   int n, c;
 
   printf("Enter a number\n");
   scanf("%d", &n);
 
   if ( n == 2 )
      printf("Prime number.\n");
   else
   {
       for ( c = 2 ; c <= n - 1 ; c++ )
       {
           if ( n % c == 0 )
              break;
       }
       if ( c != n )
          printf("Not prime.\n");
       else
          printf("Prime number.\n");
   }
   return 0;
}
c2go transpile prime.c
go run prime.go
Enter a number
23
Prime number.

prime.go looks like:

package main

import "unsafe"

import "github.com/elliotchance/c2go/noarch"

// ... lots of system types in Go removed for brevity.

var stdin *noarch.File
var stdout *noarch.File
var stderr *noarch.File

func main() {
	__init()
	var n int
	var c int
	noarch.Printf([]byte("Enter a number\n\x00"))
	noarch.Scanf([]byte("%d\x00"), (*[1]int)(unsafe.Pointer(&n))[:])
	if n == 2 {
		noarch.Printf([]byte("Prime number.\n\x00"))
	} else {
		for c = 2; c <= n-1; func() int {
			c += 1
			return c
		}() {
			if n%c == 0 {
				break
			}
		}
		if c != n {
			noarch.Printf([]byte("Not prime.\n\x00"))
		} else {
			noarch.Printf([]byte("Prime number.\n\x00"))
		}
	}
	return
}

func __init() {
	stdin = noarch.Stdin
	stdout = noarch.Stdout
	stderr = noarch.Stderr
}

What Is Supported?

See the Project Progress.

How It Works

This is the process:

  1. The C code is preprocessed with clang. This generates a larger file (pp.c), but removes all the platform specific directives and macros.

  2. pp.c is parsed with the clang AST and dumps it in a colourful text format that looks like this. Apart from just parsing the C and dumping an AST, the AST contains all of the resolved information that a compiler would need (such as data types). This means that the code must compile successfully under clang for the AST to also be usable.

  3. Since we have all the types in the AST it's just a matter of traversing the tree is a semi-intelligent way and producing Go. Easy, right!?

Testing

By default only unit tests are run with go test. You can also include the integration tests:

go test -tags=integration ./...

Integration tests in the form of complete C programs that can be found in the tests directory.

Integration tests work like this:

  1. Clang compiles the C to a binary as normal.
  2. c2go converts the C file to Go.
  3. The Go is built to produce another binary.
  4. Both binaries are executed and the output is compared. All C files will contain some output so the results can be verified.

Contributing

Contributing is done with pull requests. There is no help that is too small! :)

If you're looking for where to start I can suggest finding a simple C program (like the other examples) that do not successfully translate into Go.

Or, if you don't want to do that you can submit it as an issue so that it can be picked up by someone else.