compilex
[](http://badge.fury.io/js/compilex)
[](https://travis-ci.org/scriptnull/compilex)
[](https://david-dm.org/scriptnull/compilex)
[](https://www.npmjs.org/package/compilex)
[](https://github.com/scriptnull/compilex/blob/master/License.md)
compilex is a node.js library which is used to build online code editor/compiler websites and webservices.
You can compile and respond back outputs for all the languages that can be compiled by the server.
Some of the online code compiling/judging websites are
Using compilex , you can built sites and services like the above said examples.
Why compilex ?
=============
1) It is the one and only library implmenting the online compiler concept.
2) compilex can detect infinite loops in the users program .
3) It can compile programs by getting input from STDIN and from command line arguments.
4) Generates statistics for the administrator.
5) Will include more supporting functions in the future releases.
Supported Languages
===================
compilex is currently in initial development stage . As the library grows , so does the list here .
| Language | Support |
|---------|:-------:|
|C |✔|
|C++ | ✔ |
|Java | ✔ |
|Python | ✔ |
|C# | Available Soon |
|Visual Basic | Available Soon |
|Ruby | Availlable Soon |
|JavaScript | Available Soon |
|PHP | Available Soon |
|Perl | Available Soon |
|Lua | Available Soon |
|Haskell| Available Soon |
|Other Languages | Available Later |
compilex roles out updates more frequently.Days are not so far , you can see the above languages soon.
Work Flow
=========
1) Get the program as input from the client as a request
2) Use compilex modules to compile the program
3) Get the output and errors in json and string formats
4) Respond the output to the client
Setting Up Compilers
====================
Inorder to compile any programming language , you need to first have the compiler for that programming language in the server machine.
C and C++
- Installation :You need GCC compiler that can compile programs from your cmd/terminal
- Windows - You can get MinGw .
- Linux - Most of the linux versions are installed with gcc by default. If you haven't got , Take a look at Installing GCC .
- Testing the Environment :After installing , set your environment variables for accessing the GCC command lines from any directory
- Windows - create a c file in a directory , execute
g++ filename.c -o output.exe
output.exe
then you will get the output of the program
- Linux - create a c file in a directory , execute
gcc filename.c -o output.out
./output.out
then you will get the output of the program
Java
- Installion : You need JDK ( Java Development Kit ) to compile Java programs.Click here to download JDK for various platforms.
- Testing the Environment :After installing , set your environment variables for accessing the javac command lines from any directory
- Create a Java file named Main.java with main function
javac Main.java
java Main
then you will get the output of the program.
Python
- Installation : You can get and install Python from here
- Testing the Environment :After installing , set your environment variables for accessing python command lines from any directory
- Create a python file hello.py and execute
python hello.py
then you will get the output of the program.
Documentation
=============
1)Require compilex
```javascript
var compiler = require('compilex');
var options = {stats : true}; //prints stats on console
compiler.init(options);
```
init() creates a folder named temp in your project directory which is used for storage purpose.
Before using other methods , make sure to call init() method.
2)C and C++
```javascript
//if windows
var envData = { OS : "windows" , cmd : "g++"}; // (uses g++ command to compile )
//else
var envData = { OS : "linux" , cmd : "gcc" }; // ( uses gcc command to compile )
compiler.compileCPP(envData , code , function (data) {
res.send(data);
//data.error = error message
//data.output = output value
});
//res is the response object
```
3)C and C++ with inputs
```javascript
//if windows
var envData = { OS : "windows" , cmd : "g++"}; // (uses g++ command to compile )
//else
var envData = { OS : "linux" , cmd : "gcc" }; // ( uses gcc command to compile )
compiler.compileCPPWithInput(envData , code , input , function (data) {
res.send(data);
});
```
4)Java
```javascript
//if windows
var envData = { OS : "windows"};
//else
var envData = { OS : "linux" }; // (Support for Linux in Next version)
compiler.compileJava( envData , code , function(data){
res.send(data);
});
```
5)Java with inputs
```javascript
//if windows
var envData = { OS : "windows"};
//else
var envData = { OS : "linux" }; // (Support for Linux in Next version)
compiler.compileJavaWithInput( envData , code , input , function(data){
res.send(data);
});
```
6)Python
```javascript
//if windows
var envData = { OS : "windows"};
//else
var envData = { OS : "linux" };
compiler.compilePython( envData , code , function(data){
res.send(data);
});
```
7)Python with inputs
```javascript
//if windows
var envData = { OS : "windows"};
//else
var envData = { OS : "linux" };
compiler.compilePythonWithInput( envData , code , input , function(data){
res.send(data);
});
```
8)Memory Management
All the temporary files ( source code and executables ) are created in your temp directory.
flush and flushSync helps you to free the memory by deleting the temporary files.
```javascript
compiler.flush(function(){
console.log('All temporary files flushed !');
});
```
Synchronous version of flush
```javascript
compiler.flushSync();
```
9)Statistical Data
Getting statistics about your compilex server has been taken care.
fullStat returns json data about your server.
```javascript
compiler.fullStat(function(data){
res.send(data);
});
```
Examples
========
You can find examples here.The examples are downloaded everytime you download compilex via npm.
you can begin with editing CSS and publish your site in minutes.
Here is the screenshot of the demo.
License
=======
All the contents in this repository are released under the MIT License .
[](https://www.gittip.com/scriptnull/)