Source-to-source compiler
Data transformation/Source transformation |
---|
Concepts |
Languages |
Techniques and transforms |
Applications |
Application fields |
A source-to-source compiler, transcompiler, or transpiler is a type of compiler that takes the source code of a programming language as its input and outputs the source code into another programming language. A source-to-source compiler translates between programming languages that operate at approximately the same level of abstraction, while a traditional compiler translates from a higher level programming language to a lower level programming language. For example, a source-to-source compiler may perform a translation of a program from Pascal to C. An automatic parallelizing compiler will frequently take in a high level language program as an input and then transform the code and annotate it with parallel code annotations (e.g., OpenMP) or language constructs (e.g. Fortran's forall
statements).[1]
Another purpose of source-to-source-compiling is translating legacy code to use the next version of the underlying programming language or an API that breaks backward compatibility. It will perform automatic code refactoring which is useful when the programs to refactor are outside the control of the original implementer (for example, converting programs from Python 2 to Python 3, or converting programs from an old API to the new API) or when the size of the program makes it impractical or time consuming to refactor it by hand.
Transcompiler may either keep translated code as close to the source code as possible to ease development and debugging of the original source code, or else they may change so much the structure of the original code that the translated code does not look like the source code.[2]
Contents
History
One of the earliest programs of this kind was Digital Research's XLT86 in 1981, a program written by Gary Kildall, which translated .ASM source code for the Intel 8080 processor into .A86 source code for the Intel 8086. Using global data flow analysis on 8080 register usage, the translator would also optimize the output for code size and take care of calling conventions, so that CP/M-80 and MP/M-80 programs could be ported to the CP/M-86 and MP/M-86 platforms automatically. XLAT86 itself was written in PL/I-80 and was available for CP/M-80 platforms as well as for DEC VMS (for VAX 11/750 or 11/780).[3]
A similar, but much less sophisticated program was TRANS.COM, written by Tim Paterson in 1980 as part of 86-DOS. It could translate some Z80 assembly source code into .ASM source code for the 8086, but supported only a subset of opcodes, registers and modes, often still requiring significant manual correction and rework afterwards. Also it did not carry out any register and jump optimizations.[4][5]
Programming language implementation
The first implementations of some programming languages started as transcompilers, and the default implementation for some of those languages are still transcompilers:
Source language | Target language | Comment |
---|---|---|
C++ (originally known as "C with classes") |
C | The cfront transcompiler was doing the conversion |
C/Fortran |
C Annotated with OpenMP, C Annotated with OpenACC | Implemented by Parallware |
BCX | C | |
Eiffel | C | |
Lisaac | C | |
Vala | C, with additional libraries such as GObject | |
CoffeeScript | JavaScript | |
ClojureScript | JavaScript | |
TypeScript | JavaScript | |
ECMAScript 6 | JavaScript | Transcompiled using traceur-compiler[6] |
Haxe | JavaScript, PHP, C++, C#, and Java. Also compiling to bytecode such as ActionScript bytecode |
|
C# | JavaScript | Transcompiled using ScriptSharp[7] |
Dart | JavaScript | |
Delphi Web Script / Object Pascal | JavaScript | Transcompiled using Smart Mobile Studio[8] |
ParenJS[9] | JavaScript | |
Mirah | Java | |
Efene[10] | Erlang | |
Xtend[11] | Java | |
PHP | C++ | Transcompiled using HipHop for PHP |
Sass[12] | CSS | |
L++[13] | C++ | |
LESS | CSS | |
Java | Objective-C | Transcompiled using J2ObjC[14] |
Ratfor | Fortran | |
X10 | C++ and Java | |
Chapel | C | |
BASIC | C | Transcompiled using BaCon[15] |
COBOL | C | Transcompiled using OpenCOBOL |
COBOL | Java | Transcompiled using P3COBOL |
OCaml bytecode | JavaScript | Transcompiled using js_of_ocaml from the Ocsigen project |
Note: AltJS maintains a list of languages transpiling to JavaScript [16]
Porting a codebase
When developers want to switch to a different language while retaining most of an existing codebase, it might be better to use a transcompiler compared to rewriting the whole software by hand. In this case, the code often needs manual correction because the automated translation might not work in all cases.
Tool | Source language | Target language | Comments | |
---|---|---|---|---|
2to3 script | Python 2 | Python 3 | Even though 2to3 does its best at automating the translation process, further manual corrections are often needed. | |
Emscripten | LLVM bytecode | ECMAScript | This allows running C/C++ codebases in a browser for example | |
Eranea's COBOL to Java Converter | COBOL | Java | This is a commercial product. | |
Google Web Toolkit | Java program that uses a specific API | JavaScript | The Java code is a little bit constrained compared to normal Java code. | |
Js_of_ocaml[17] of Ocsigen | OCaml | JavaScript | ||
Tangible Software Solutions's C# to C++ Converter | C# | Unmanaged C++ | This is a commercial product. | |
JSIL, SharpKit, Script# | CLI bytecode | human readable ECMAScript | ||
J2Eif[18] | Java | Eiffel | The resulting Eiffel code has classes and structures similar to the Java program but following Eiffel syntax and conventions. | |
C2Eif[19] | C | Eiffel | The resulting Eiffel code has classes and structures that try to be as clean as possible. The tool is complete and relies on embedding the C and assembly code if it cannot translate it properly. |
Examples
DMS Software Reengineering Toolkit
DMS Software Reengineering Toolkit is a source-to-source program transformation tool, parameterized by explicit source and target (may be the same) computer language definitions. It can be used for translating from one computer language to another, for compiling domain-specific languages to a general purpose language, or for carrying out optimizations or massive modifications within a specific language. DMS has a library of language definitions for most widely used computer languages (including full C++, and a means for defining other languages which it does not presently know).
LLVM
LLVM can translate from any language supported by gcc 4.2.1 (Ada, C, C++, Fortran, Java, Objective-C, or Objective-C++) or by clang to any of: C, C++, or MSIL by way of the "arch" command in llvm-gcc.
% llvm-g++ -emit-llvm x.cpp -o program.bc -c % llc -march=c program.bc -o x.c % cc x.c -lstdc++ % llvm-g++ x.cpp -o program.bc -c % llc -march=msil program.bc -o program.msil
Translation to C has been removed from LLVM since version 3.1. It had numerous problems, to the point of not being able to compile any nontrivial program.[20]
Emscripten
Emscripten is a C/C++/LLVM to Javascript Source-to-Source compiler that converts applications coded to run natively on linux to run as javascript in a webpage.
Example of using the emscripten C compiler:
% emcc helloworld.c -o helloworld.html
Example of using a make file with Emscripten:
% emmake make
Example of using a configure script with emscripten:
% emconfigure ./configure
Emscripten is very powerful and is remarkably able to compile most large applications that are system independent with almost no modifications to the source code, some examples are:
- Unreal Engine 3.[21]
- A Fork of Cube Engine 2 known as BannanaBread.[22]
- ammo.js an exact javascript port of the Bullet physics engine compiled using emscripten.[23]
Refactoring tools
The refactoring tools automate transforming source code into another:
- Python's 2to3 tool transforms non-forward-compatible Python 2 code into Python 3 code.
- Qt's qt3to4 tool convert non forward-compatible usage of the Qt3 API into Qt4 API usage.
- Coccinelle uses semantic patches to describe refactoring to apply to C code. It's been applied successfully to refactor the drivers of the Linux kernel due to kernel API changes.[24]
- RefactoringNG is a NetBeans module for refactoring Java code where you can write transformations rules of a program's abstract syntax tree.
See also
References
- ^ "Types of compilers". compilers.net. 1997–2005. Retrieved 28 October 2010.
- ^ Fowler, Martin (February 12, 2013). "Transparent Compilation". Retrieved February 13, 2013.
- ^ Digital Research (1981): XLT86 - 8080 to 8086 Assembly Language Translator - User's Guide. Digital Research Inc, Pacific Grove ([1]).
- ^ Seattle Computer Products (1980): 86-DOS - Disk Operating System for the 8086. User's manual, version 0.3 - Preliminary. Seattle Computer Products, Seattle ([2]).
- ^ Paterson, Tim (2013-12-19) [1982]. "Microsoft DOS V1.1 and V2.0: Z80 to 8086 Translator version 2.21 /msdos/v11source/TRANS.ASM". Computer History Museum, Microsoft. Retrieved 2014-03-25. (NB. While the publishers claim this would be MS-DOS 1.1 and 2.0, it actually is SCP MS-DOS 1.25 and TeleVideo PC DOS 2.11.)
- ^ "Traceur is a JavaScript.next-to-JavaScript-of-today compiler". github.com. Retrieved 2014-07-02.
- ^ "Script# by nikhilk". Scriptsharp.com. Retrieved 2013-08-02.
- ^ "Smart Mobile Studio". SmartMobileStudio.com. Retrieved 2014-03-09.
- ^ "ktg / ParenJS — Bitbucket". Bitbucket.org. Retrieved 2014-07-08.
- ^ "efene programming language". Marianoguerra.com.ar. Retrieved 2014-07-08.
- ^ [3][dead link]
- ^ Maptastic Maple (3.3.9). "Sass: Syntactically Awesome Style Sheets". Sass-lang.com. Retrieved 2014-07-08.
- ^ "ktg / L++ — Bitbucket". Bitbucket.org. Retrieved 2014-07-08.
- ^ "j2objc - A Java to iOS Objective-C translation tool and runtime. - Google Project Hosting". Code.google.com. 2012-10-15. Retrieved 2013-08-02.
- ^ Peter van Eerten. "BaCon - A free BAsic CONverter for Unix, BSD and MacOSX". Basic-converter.org. Retrieved 2014-07-08.
- ^ "AltJS - Alternative JavaScript". Retrieved February 13, 2013.
- ^ http://ocsigen.org/js_of_ocaml/manual/overview
- ^ "J2Eif Research Page - Chair of Software Engineering". Se.inf.ethz.ch. doi:10.1007/978-3-642-21952-8_4. Retrieved 2014-07-08.
- ^ "C2Eif Research Page - Chair of Software Engineering". Se.inf.ethz.ch. Retrieved 2014-07-08.
- ^ "LLVM 3.1 Release Notes". llvm.org.
- ^ Epic Games; Mozilla. "HTML5 Epic Citadel".
- ^ Mozilla. "BannanaBread Demo".
- ^ Alon Zakai. "ammo.js".
- ^ Valerie Henson (January 20, 2009). "Semantic patching with Coccinelle". lwn.net. Retrieved 28 October 2010.