compiler.js

var path = require ('path');
var util = require ('util');
var fs   = require ('fs');

var exec = require ('child_process').exec;

var EventEmitter = require ('events').EventEmitter;

var common  = require ('./common');
var ArduinoData = require ('./data');

var Arduino;

function ArduinoCompiler (sketchFolder, platformId, boardId, boardModel, options) {

	// TODO: make use of instance property (instance populated on successful config read)
	Arduino = new ArduinoData ();

	var hw = Arduino.hardware;

	this.buildFolder = options.buildFolder || common.buildFolder (sketchFolder);

	this.objectFiles = [];

	var currentStage = 'build';

	this.platformId = platformId;

	var dict = common.createDict (Arduino, platformId, boardId, boardModel, options, currentStage);

	var hwNode = Arduino.hardware[platformId];
	var hwPlatform = hwNode.platform;
	var hwBoard = Arduino.hardware[platformId].boards[boardId];

	// TODO: get from build.core.path and build.variant.path
	this.coreIncludes = [
		dict['build.core.path']
	];

	if (dict['build.variant.path']) {
		this.coreIncludes.push (dict['build.variant.path']);
	}

	if (options.define && options.define.length) {
		if (!dict["build.extra_flags"]) {
			this.emit ('warning', "extra flags not supported by platform, --define ");
		}
		dict["build.extra_flags"] = dict["build.extra_flags"] + " -D " + options.define.join (" -D ") + " ";
	}

	if (options.includes) {
		this.coreIncludes = this.coreIncludes.concat (options.includes);
	}

	this.cacheCore = options.cacheCore;

	dict['build.path'] = this.buildFolder;

	//	The uno.build.board property is used to set a compile-time variable ARDUINO_{build.board}
	//	to allow use of conditional code between #ifdefs. The Arduino IDE automatically generate
	//	a build.board value if not defined. In this case the variable defined at compile time will
	//	be ARDUINO_AVR_UNO.

	this.dict = dict;

	// TODO: use dataflows
	this.on ('queue-completed', this.runNext.bind (this));
	// TODO: emit something to arduino
	this.on ('queue-progress', function (scope, pos, length) {
//		console.log (scope, pos + '/' + length);
	});
	this.on ('queue-failed', this.cmdFailHandler.bind (this));
	this.on ('queue-failed', function (scope, err) {
//		console.log (scope, 'failed:', err);
	});

	this._done = {};
	this._queue = {};

	var projectName = path.basename (sketchFolder);
	this.setProjectName (projectName);

	this.sketchFolder = sketchFolder;

	this.platform = hwPlatform;
}

util.inherits (ArduinoCompiler, EventEmitter);

ArduinoCompiler.prototype.start = function () {

	var clearBeforeBuild = function () {
		if (this.cacheCore) {
			// clear all but core.a, callback receive fs.stat on core.a file
			this.clear (true, function (err, stat) {
				this.buildAll (stat);
			}.bind (this)); // clear all files but core.a
		} else {
			this.clear (this.buildAll.bind (this));
		}
	}.bind (this);

	fs.mkdir (this.buildFolder, (function (err) {
		if (err) {
			if (err.code !== "EEXIST") {
				this.emit ('error', 'cannot create build folder '+this.buildFolder+': '+err.code+', '+err);
				return;
			}
		}

		clearBeforeBuild();

	}).bind (this));
}

ArduinoCompiler.prototype.buildAll = function (coreMeta) {

	var dict = this.getDict();
	var sketchFolder = this.sketchFolder;

	// TODO: add this file to main async asset pipeline
	fs.writeFile (path.join (this.buildFolder, 'buildprefs.txt'), Object.keys (dict).map (function (dictK) {
		return dictK + ' = ' + dict[dictK];
	}).join ("\n"));

	common.pathWalk (sketchFolder, this.setProjectFiles.bind (this), {
		nameMatch: /[^\/]+\.(c|cpp|h|hpp|S|ino|pde)?$/i,
		depth: false
	});

	if (this.cacheCore && coreMeta && coreMeta.stat && coreMeta.stat.isFile()) {
		this.enqueueCmd ('core', {dummy: true}, null, "using cached core.a");
	} else {
		common.pathWalk (dict['build.core.path'], this.setCoreFiles.bind (this), {
			nameMatch: /[^\/]+\.(c|cpp|S)$/
		});

		if (dict['build.variant.path'] && dict['build.variant.path'] !== '') {
			this.emit ('warning', 'build.variant unknown');
			common.pathWalk (dict['build.variant.path'], this.setCoreFiles.bind (this), {
				nameMatch: /[^\/]+\.(c|cpp|S)$/
			});
		}
	}
}

ArduinoCompiler.prototype.setProjectName = function (name) {
	this.dict['build.project_name'] = name;
	this.projectName = name;

}

ArduinoCompiler.prototype.runNext = function (scope, pos, length) {
	this.emit ('log', scope, 'done '+(pos+1)+'/'+length);
//	console.log ('['+scope+']', 'done', (pos+1)+'/'+length);
	this._done[scope] = true;

	if (scope === 'size') {
		this.emit ('log', 'compile', 'done');
//		console.log ('COMPILATION COMPLETE!');
//		console.log (this.platform.recipe.size.regex.data.toString ());
//		console.log (this.platform.recipe.size.regex.eeprom.toString ());
		this.emit ('done', this.compiledSize);
	} else if (scope === 'obj-eep' || scope === 'obj-hex') {
		// whe we achieved obj-* stage, no more steps remaining
		if (this._done['obj-eep'] && this._done['obj-hex']) {
			this.checkSize ();
		}
	} else if (this._done['link']) {
		this.objCopy ();
	} else if (this._done['core'] && (this._done['libs'] || this._noLibs) && this._done['project']) {
		// TODO: anything else
		this.linkAll ();
		this.sketchProcessed = false;
	} else if (this._done['libs'] || this._noLibs) {
		if (!this.sketchProcessed) {
			this.processSketch ();
			this.sketchProcessed = true;
		}
	}
}

// simple promise replacement
ArduinoCompiler.prototype.ioAction = function () {
	var result = {
		io: true,
		listeners: [],
		done: function (cb) {
			if (cb)
				this.listeners.push (cb);
			if (!this.ready) {
				return;
			}
			var allCb = this.listeners;
			this.listeners = [];
			allCb.forEach ((function (theCb) {
				theCb (this.error);
			}).bind(this));
		},
		callback: function (err, done) {
			result.error = err;
			if (err && err.code === 'EEXIST') {
				result.error = null;
			}
			result.ready = true;
			result.done ();
		}
	};

	return result;
}

ArduinoCompiler.prototype.ioMkdir = function (folder) {

	var action = this.ioAction ();

	mkdirParent (folder, null, action.callback);

	return action;
}

ArduinoCompiler.prototype.enqueueCmd = function (scope, cmdLine, cb, description) {
	if (!this._queue[scope])
		this._queue[scope] = {length: 0, pos: -1, running: false};
	if (scope in this._done)
		delete this._done[scope];
	var thisQueue = this._queue[scope];

	if (cmdLine === undefined) {
		console.log ('tracing scope:', scope);
		console.trace ();
	}

	thisQueue[thisQueue.length++] = [cmdLine, cb, description];
	this.runCmd (scope);
//	console.log (cmdLine);
}

ArduinoCompiler.prototype.cmdFailHandler = function () {
	var pendingTasks = 0;
	for (var scope in this._queue) {
		var currentQueue = this._queue[scope];
		if (currentQueue.running) {
			pendingTasks ++;
			currentQueue.emergencyStop = true;
		}
	}
	if (!pendingTasks) {
		this.emit ('failed');
	}
}

ArduinoCompiler.prototype.runCmd = function (scope) {
	var thisQueue = this._queue[scope];
	if (thisQueue.pos + 1 === thisQueue.length) {
		// TODO: emit done
		this.emit ('queue-completed', scope, thisQueue.pos, thisQueue.length);
		return;
	}
	if (!thisQueue.running && thisQueue.pos + 1 < thisQueue.length) {
		thisQueue.running = true;
		var cb = (function (err, done) {
			thisQueue.running = false;
			if (err || thisQueue.emergencyStop) {
				this.emit ('queue-failed', scope, err);
				return;
			}
			thisQueue.pos ++;
			this.emit ('queue-progress', scope, thisQueue.pos, thisQueue.length);
			this.runCmd (scope);
		}).bind (this);


		var cmdMeta = thisQueue[thisQueue.pos + 1];
		var cmd     = cmdMeta[0];
		var cmdCb   = cmdMeta[1];
		var cmdDesc = cmdMeta[2];

		// assume shell command
		if (cmd.constructor === String) {
			if (cmdDesc) {
				this.emit ('log', scope, cmdDesc);
			}

//			console.log ("child exec launch: %s", cmd);

			var env = common.prepareEnv (
				path.resolve (this.dict['runtime.ide.path']),
				path.resolve (this.dict['runtime.platform.path'])
			);

			if (this.verbose)
				console.log (cmd);

			var child = exec (cmd, {env: env}, (function (error, stdout, stderr) {
				// The callback gets the arguments (error, stdout, stderr).
				// On success, error will be null. On error, error will be an instance
				// of Error and error.code will be the exit code of the child process,
				// and error.signal will be set to the signal that terminated the process.
				// console.log('stdout: ' + stdout);
				// console.log('stderr: ' + stderr);
				if (error !== null) {
// compiler error
//ArduinoVoltage.ino:134:2: error: 'XXX' was not declared in this scope
//ArduinoVoltage.ino:135:1: error: expected ';' before '}' token
// linker error
//Error: Command failed: /var/folders/r4/d4l8c_ts4rsdc670pdkbtr0m0000gp/T/PlatformInfo-cuwire-5f1e22f1/PlatformInfo.o: In function `setup':
///Users/apla/tmp/PlatformInfo.ino:29: undefined reference to `setupVcc()'
///var/folders/r4/d4l8c_ts4rsdc670pdkbtr0m0000gp/T/PlatformInfo-cuwire-5f1e22f1/PlatformInfo.o: In function `loop':
///Users/apla/tmp/PlatformInfo.ino:56: undefined reference to `readVcc()'
					error.files = [];
					error.sketchFolder = this.sketchFolder;
					error.buildFolder  = this.buildFolder;
					var stderrStrings = stderr.split(/\r\n|\r|\n/);
					stderrStrings.forEach (function (stderrChunk) {

						var err = stderrChunk.match (/^([^:]+)\:(\d+)\:(?:(\d+)\:)?\s*(.*)/);
						if (err) {

							err[1] = err[1].replace (new RegExp ('^' + error.buildFolder + '(\\' + path.sep+')?'), "");
							err[1] = err[1].replace (/^\/+/, "");
							error.files.push (err);
//							console.log ('found error:', err[4], 'at', err[1], err[2], err[3]);
						}
					});
					error.scope  = scope;
					error.cmd    = cmd;
					error.stderr = stderr;
					this.emit ('error', error);
//					console.log ('******************', scope.toUpperCase(), cmd);
//					console.log ('******************', scope.toUpperCase(), 'exec error: ', error, 'stderr', stderr);
				} else if (stderr) {
					this.emit ('warning', stderr);
				}

				if (cmdCb) {
					cmdCb (error, stdout, stderr);
				}

				cb (error);
			}).bind (this));

		} else if (cmd.io) {
			cmd.done (function (err) {
				if (err) {
					console.log('!!!!!!!!!!!!!!!!!!!!!!!!!', 'exec error: ', err);
				}
				cb (err);
			});
		} else if (cmd.dummy) {
			cb (null);
		}
	}

}

ArduinoCompiler.prototype.clear = function (leaveCoreAlone, cb) {

	if (typeof leaveCoreAlone === 'function') {
		cb = leaveCoreAlone;
		leaveCoreAlone = undefined;
	}

	// TODO: check for build preferences and clear core.a only if new core need to be built
	// and leaveCoreAlone === undefined

	common.pathWalk (this.buildFolder, function (err, files) {
//		console.log (Object.keys (files));

		var buildFolder = path.basename (this.buildFolder);

		var count = 0;
		var coreStat;

		if (!Object.keys (files).length) {
			if (cb) cb (null, coreStat);
			return;
		}

		for (var fileName in files) {
			if (files[fileName].folder) {
				continue;
			}

			if (path.join (this.buildFolder, 'core.a') === fileName && leaveCoreAlone) {
				// skip
				coreStat = files[fileName];
			} else {
				count ++;
				fs.unlink (fileName, function (err) {
					if (err) {
						console.log (err);
					}
					count --;
					if (!count) {
						if (cb) cb (null, coreStat);
					}
				});
			}
		}
	}.bind (this));
}

ArduinoCompiler.prototype.getDict = function () {
	// speed doesn't matter here
	var newDict = {};
	for (var k in this.dict) {
		newDict[k] = this.dict[k];
	}

	return newDict;
}

function wrapInclude (includePath) {
	return '"-I'+includePath+'"';
}

ArduinoCompiler.prototype.setLibNames = function (libNames, sourceFile, cb) {
	if (!this.libCompile)
		this.libCompile = {};
	var self = this;
	if (libNames.constructor !== Array) {
		libNames = Object.keys (libNames);
	}

	if (this.sketchFiles[sourceFile]) {
		this.sketchFiles[sourceFile].libs = libNames;
	}

//	console.log (this.sketchFiles);
	// return true only if every sketchfile is processed and have no libs
	this._noLibs = Object.keys (this.sketchFiles).every ((function (sketchFileName) {
		if (this.sketchFiles[sketchFileName].libs && this.sketchFiles[sketchFileName].libs.length === 0) {
			return true;
		}
	}).bind (this));

	if (!libNames.length) {
		cb();
		// this.enqueueCmd ('source', {dummy: true}, null, "processed source for: "+sourceFile);
		return;
	}

	var dict = this.getDict ();

	// console.log (libNames);
	libNames.forEach ((function (headerFile) {

		var libMeta = Arduino.findLib (this.platformId, headerFile, dict['build.core']);
		if (!libMeta || !libMeta.root) {
			if (this.debug) console.log ('cannot find library', headerFile);
			return;
		}

		var libName = libMeta.name;

		if (this.libCompile[libName])
			return;

//		console.log ('found lib', libName);

		// requirement by requirement not supported
		for (var reqHeader in libMeta.requirements) {
			var libMeta2 = Arduino.findLib (this.platformId, reqHeader, dict['build.core']);
			if (!libMeta2 || !libMeta2.root) {
				// console.log ('cannot find library', req);
			} else if (!this.libCompile[libMeta2.name]) {
				this.libCompile[libMeta2.name] = libMeta2;
			}

		}

		this.libCompile[libName] = libMeta;
		// libIncludes.push (libDir.root);
	}).bind (this));

	// we can compile libs, core and current sources at same time
	// in a ideal case this is 3x speedup
	// also, core do not need a rebuild

	// console.log (this.libCompile);
	// console.log (Object.keys (this.libCompile));

	var allIncludes = [];

	// TODO: add any library found in included source files
	for (var libName in this.libCompile) {
		allIncludes.push (this.libCompile[libName].include || this.libCompile[libName].root);
	}
//	console.log (this.coreIncludes);
//	console.log (allIncludes);

	for (var libName in this.libCompile) {
		var libMeta = this.libCompile[libName];

		if (libMeta.processed) {
			continue;
		}

		this.libCompile[libName].processed = true;

//		console.log (libName, libMeta.include, libMeta.root);

		var libIncludes = [].concat (this.coreIncludes, allIncludes, libMeta.include || libMeta.root);
		if (libMeta.version !== '1.5') {
			libIncludes = libIncludes.concat (path.join (libMeta.include || libMeta.root, 'utility'));
		}
		libIncludes = libIncludes.map (wrapInclude).join (" ");

//		console.log (libIncludes);

		for (var libSrcFile in libMeta.files) {
			if (!libSrcFile.match (/\.(c|cpp|S)?$/))
				continue;
			var baseName  = path.basename (libSrcFile);
			var ext       = path.extname (libSrcFile).substr (1);
			var localName = path.basename (baseName, '.'+ext);
			dict.source_file = path.join (libMeta.root, libSrcFile);
			// TODO: build dir
//			console.log (libSrcFile);

			dict.object_file = path.join (this.buildFolder, libName, localName + '.o');
			dict.includes    = libIncludes;

			var compileCmd   = common.replaceDict (this.platform.recipe[ext+'.o.pattern'], dict, null, "platform.recipe."+ext+".o.pattern");

			this.enqueueCmd ('mkdir', this.ioMkdir (path.join (this.buildFolder, libName)));

			var cmdDesc = ["compile", libName, libSrcFile].join (" ");
			this.enqueueCmd ('libs', compileCmd, null, cmdDesc);

			this.objectFiles.push (dict.object_file);

//			if (this.verbose)
//				console.log (compileCmd);

		}
	}

	cb();

	// this.enqueueCmd ('source', {dummy: true}, null, "processed source for: "+sourceFile);

//	this.emit ('includes-set');
}

ArduinoCompiler.prototype.setCoreFiles = function (err, coreFileList) {
	if (err) {
//		console.log (err);
//		this.error = 'core.files';
		err.scope = 'core';
		this.emit ('error', err);
		return;
	}

	var dict = this.getDict ();

	if (!dict['build.extra_flags']) {
		dict['build.extra_flags'] = '';
	}

	Object.keys (coreFileList).forEach ((function (srcFile) {
		if (coreFileList[srcFile].folder) {
			return;
		}

		var baseName  = path.basename (srcFile);
		var ext       = path.extname (srcFile).substr (1);
		var localName = path.basename (baseName, '.'+ext);

		dict.source_file = srcFile;
		// TODO: build dir
		dict.object_file = path.join (this.buildFolder, localName + '.' + ext + '.o');
		dict.includes = [].concat (this.coreIncludes).map (wrapInclude).join (" ");
		if (!this.platform.recipe[ext+'.o.pattern']) {
			console.log ('config does not contain info how to process "'+ext+'" extension, config key: recipe.'+ext+'.o.pattern');
			return;
		}
		var compileCmd = common.replaceDict (this.platform.recipe[ext+'.o.pattern'], dict, null, "platform.recipe."+ext+".o.pattern");

		this.enqueueCmd ('mkdir', this.ioMkdir (this.buildFolder));

		var cmdDesc = ['compile', this.platformId, localName + '.' + ext].join (" ");
		this.enqueueCmd ('core', compileCmd, null, cmdDesc);

		dict.archive_file = 'core.a';
		var archiveCmd = common.replaceDict (this.platform.recipe['ar.pattern'], dict, null, "platform.recipe.ar.pattern");

		cmdDesc = ['archive', this.platformId, localName + '.' + ext].join (" ");
		this.enqueueCmd ('core', archiveCmd, null, cmdDesc);

//		if (this.verbose)
//			console.log (compileCmd);
	}).bind (this));

	// after all, we need to make core.a file
}

ArduinoCompiler.prototype.processSketch = function () {
	var dict = this.getDict ();

	Object.keys (this.sketchFiles).forEach ((function (srcFile) {
		var baseName  = path.basename (srcFile);
		var ext       = path.extname (srcFile).substr (1);
		var localName = path.basename (baseName, '.'+ext);

		dict.source_file = srcFile;
		dict.object_file = path.join (this.buildFolder, localName + '.o');

		var allIncludes = [];

		// TODO: add any library found in included source files
		for (var libName in this.libCompile) {
			allIncludes.push (this.libCompile[libName].include || this.libCompile[libName].root);
		}

		var includes = [].concat (this.coreIncludes, allIncludes).map (wrapInclude).join (" ");
		dict.includes = includes;

		if (!this.platform.recipe[ext+'.o.pattern']) {
			console.log ('config does not contain info how to process "'+ext+'" extension, config key: recipe.'+ext+'.o.pattern');
			return;
		}

		var compileCmd = common.replaceDict (this.platform.recipe[ext+'.o.pattern'], dict, null, "platform.recipe."+ext+".o.pattern");

		// this.enqueueCmd ('mkdir', this.ioMkdir (this.buildFolder));

		var cmdDesc = ["compile", localName + '.' + ext].join (" ");
		this.enqueueCmd ('project', compileCmd, null, cmdDesc);

		this.objectFiles.push (dict.object_file);

//		if (this.verbose)
//			console.log (compileCmd);

	}).bind (this));

}

ArduinoCompiler.prototype.setSketchFile = function (srcFile, libNames) {

	if (!this.sketchFiles) {
		this.sketchFiles = {};
	}

	this.sketchFiles[srcFile] = {};

}

ArduinoCompiler.prototype.setProjectFiles = function (err, files, dontCompile) {
	if (err) {
		// TODO: what errors we expects here, what's error recovery strategy?
//		console.log (err);
		err.scope = 'project';
		this.emit ('error', err);
		return;
	}

	// ok, we just got sources. now, we need to find libs from .h,
	// copy all sources to the build folder and generate cpp from ino/pde file

	// TODO: if we found any ino files, symlinked onto cpp file, ignore that cpp
	// this is a RepRap config

	Object.keys (files).forEach ((function (fileName) {
		var fileObject = files[fileName];
		if (fileObject.folder) {
			return;
		}
		var extname = path.extname (fileName).substring (1);
		if (extname.match (/^(c|cpp|h|hpp|S|ino|pde)$/)) {
			this.filePreProcessor (fileName, files[fileName]);
		}

	}).bind(this));

// TODO
	//	if (!this.libIncludes) {
//		this.on ('includes-set', this.processProjectFiles.bind (this));
//	} else {
//		this.processProjectFiles();
//	}
}

ArduinoCompiler.prototype.filePreProcessor = function (fileName, fileMeta) {
	var extname = path.extname (fileName).substring (1);

	if (extname === 'ino' || extname === 'pde') {
		this.processIno (fileName, fileMeta);
	} else if (extname.match (/c|cpp|h|hpp/)) {
		this.processCpp (fileName, fileMeta, extname);
	} else if (extname.match (/S/)) {
		this.processAsm (fileName, fileMeta);
	}
}

ArduinoCompiler.prototype.processIno = function (inoFile, fileMeta) {
	// read ino

	var sketchFileName = path.basename (inoFile, path.extname (inoFile));

	var dict = this.getDict ();

	if (fileMeta.stat.isSymbolicLink()) {
		var ext = path.extname (inoFile).substring (1);
		if (fileMeta.linkedTo === sketchFileName + '.cpp') {
			this.setSketchFile (sketchFileName);
			return;
		}
	}

	var projectFile = path.join (this.buildFolder, this.projectName + '.cpp');
	this.setSketchFile (projectFile);

	var action = this.ioAction ();
	this.enqueueCmd ('copy', action, null, inoFile);

	fs.readFile (inoFile, (function (err, data) {
		if (err) {
			err.scope = 'project';
			this.emit ('error', err);
//			console.log ('read failed', err);
			cb (err);
			return;
		}
		var inoContents = data.toString ();

		// search for libraries
		var libNames = Arduino.parseLibNames (inoContents, this.platformId, dict['build.core']);
		// search for a function declarations

		if (libNames.length) {
//			console.log (path.relative (this.sketchFolder, inoFile), 'contains libs', libNames);
		}

		var commentOrInstruction = /\s*(\/\*[\s\S]*?\*\/|\/\/[^\n\r]*|#[^#\n\r]*)/gm;

		var funcs        = [];
		var instructions = [];
		var comments     = [];
		var matchArray   = [];

		var firstStatementOffset;
		var lastMatchOffset;

		var lastInstructionOffset = 0;
		var ifInstruction         = 0;
		var ifInstructionOffset   = 0;

		while ((matchArray = commentOrInstruction.exec (inoContents)) !== null) {
//			console.log (matchArray.index, lastMatchOffset, matchArray[1]);
			if (lastMatchOffset === undefined && matchArray.index > 0) {
				firstStatementOffset = 0;
			}
			if (
				lastMatchOffset !== undefined &&
				lastMatchOffset !== matchArray.index &&
				firstStatementOffset === undefined
			) {
				// first statement found. but this statement can be within #ifdef
				if (ifInstruction > 0) {
					firstStatementOffset = ifInstructionOffset;
				} else {
					firstStatementOffset = lastInstructionOffset;
				}
			}

			lastMatchOffset = matchArray.index + matchArray[0].length;

			if (matchArray[1][0] === '/') {
				comments.push ([matchArray.index, matchArray.index + matchArray[0].length]);
			} else {
				if (matchArray[1].match (/#ifdef/)) {
					ifInstruction ++;
					if (ifInstruction === 1) {
						ifInstructionOffset = matchArray.index;
					}
				} else if (matchArray[1].match (/#endif/)) {
					ifInstruction --;
				}
				instructions.push ([matchArray.index, matchArray.index + matchArray[0].length]);
				lastInstructionOffset = matchArray.index + matchArray[0].length;
			}
		}

		if (firstStatementOffset === undefined) {
			var lastComment = 0, lastInstruction = 0;
			if (comments.length) {
				lastComment = comments[comments.length-1][1];
			} else if (instructions.length) {
				lastInstruction = instructions[instructions.length-1][1];
			}
			firstStatementOffset = Math.max (lastComment, lastInstruction);
		}

		// we found comments and instructions

		var functionRe = /^[\s\n\r]*((\w+)[\s\n\r]+)?(\w+(?:\:\:\w+)?(?:\<\w+(?:\:\:\w+)?\>)?[&*]?)[\s\n\r]+(\w+)[\s\n\r]*\(([^\)]*)\)[\s\n\r]*\{/gm;
		while ((matchArray = functionRe.exec (inoContents)) !== null) {
			var skip = false;

			if (
				(matchArray[1] && matchArray[1].match (/if|else|for|while|do|case/))
				|| matchArray[3].match (/if|else|for|while|do|case/)
			) {
				continue;
			}

			for (var i = 0; i < comments.length; i++) {
				// console.log (comments[i][0] + ' < ' + matchArray.index + ' ' + comments[i][1] + ' > ' + matchArray.index);
				if (comments[i][0] < matchArray.index && comments[i][1] > matchArray.index) {
					skip = true;
					break;
				}
			}
			if (skip) {
				continue;
			}

			// http://stackoverflow.com/questions/2545720/error-default-argument-given-for-parameter-1
			var fnParams = matchArray[5].split (/\s*,\s*/).map (function (fnParam) {
				var defVal = fnParam.split (/\s*=\s*/);
				if (defVal[1]) {
					return defVal[0] + ' /* ='+defVal[1]+'*/';
				} else {
					return defVal[0];
				}
			}).join (", ");

			// matchArray.index
			funcs.push ([matchArray[1] || "", matchArray[3], matchArray[4], '('+fnParams+')'].join (" "));
			//console.log (matchArray[1] || "", matchArray[3], matchArray[4], '(', matchArray[5], ');');
		}

		// write temp file:

//		console.log (this.buildFolder, '_' + this.projectName + '_generated.cpp');

		var inoBeforeFirstStatement = inoContents.substr (0, firstStatementOffset);
		var lineNumber = inoBeforeFirstStatement.split(/\r\n|\r|\n/).length;

		fs.writeFile (path.join (this.buildFolder, this.projectName + '.ino'), inoContents);

		fs.writeFile (
			projectFile,
			[
				inoBeforeFirstStatement,
				"\n#include \"Arduino.h\"\n" + funcs.join (";\n") + ";\n#line " + lineNumber + ' "' + this.projectName + '.ino"',
				inoContents.substr (firstStatementOffset)
			].join ("\n"),
			(function (err, done) {
				if (err) {
					err.scope = 'project';
					this.emit ('error', err);
//					console.log ('cannot write to the ', inoFile);
					return;
				}
				// this.setProjectFiles (null, [projectFile], true);
				this.setLibNames (libNames, projectFile, action.callback);
		}).bind (this));

		// function declarations
		// actual ino file contents
	}).bind (this));

}

ArduinoCompiler.prototype.processCpp = function (cppFile, fileMeta, extname) { // also for a c, h files
	// read file

	// TODO: Arduino don't process subdirs. inverstigate need to create subdirs if any
	var cppRelPath = path.relative (this.sketchFolder, cppFile);
	var cppFolder = path.join (this.buildFolder, path.dirname (cppRelPath));
	var sourceFile = path.join (this.buildFolder, cppRelPath);
	if (extname.match (/^(c|cpp)$/))
		this.setSketchFile (sourceFile);

	var dict = this.getDict ();

	var action = this.ioAction ();
	this.enqueueCmd ('copy', action, null, cppFile);

	fs.readFile (cppFile, (function (err, data) {
		if (err) {
			err.scope = 'project';
//			console.log ('read failed', err);
			this.emit ('error', err);
			cb (err);
			return;
		}

		var cppContents = data.toString ();

		// search for libraries
		var libNames = Arduino.parseLibNames (cppContents, this.platformId, dict['build.core']);
		// search for a function declarations

//		if (libNames.length)
//			console.log (path.relative (this.sketchFolder, cppFile), 'contains libs', libNames);


//		var functions = [];
//
//		var matchArray = [];
//
//		var functionRe = /^[\s\n\r]*((unsigned|signed|static)[\s\n\r]+)?(void|int|char|short|long|float|double|word)[\s\n\r]+(\w+)[\s\n\r]*\(([^\)]*)\)[\s\n\r]*\{/gm;
//		while ((matchArray = functionRe.exec(inoContents)) !== null) {
//			functions.push ([matchArray[1] || "", matchArray[3], matchArray[4], '('+matchArray[5]+')'].join (" "));
//			//			console.log (matchArray[1] || "", matchArray[3], matchArray[4], '(', matchArray[5], ');');
//		}

		// TODO: something wrong: mkdirParent not working
		mkdirParent (cppFolder, (function (err) {
			if (err && err.code !== 'EEXIST') {
				err.scope = 'mkdir';
//				console.trace ('cannot create folder', cppFolder, err.code);
				this.emit ('error', err);
				return;
			}
			fs.writeFile (
				sourceFile,
				cppContents,
				(function (err, done) {
					if (err) {
						err.scope = 'project';
						this.emit ('error', err);
						return;
					}
					// this.setProjectFiles (null, [projectFile], true);
					this.setLibNames (libNames, sourceFile, action.callback);

				}).bind (this));



			// function declarations
			// actual ino file contents

		}).bind (this));
	}).bind (this));
}

ArduinoCompiler.prototype.processAsm = function (asmFile, fileMeta) { // also for a c, h files
	// read file

	// TODO: Arduino don't process subdirs. inverstigate need to create subdirs if any
	var asmRelPath = path.relative (this.sketchFolder, asmFile);
	var asmFolder = path.join (this.buildFolder, path.dirname (asmRelPath));
	var sourceFile = path.join (this.buildFolder, asmRelPath);
	this.setSketchFile (sourceFile);

	var dict = this.getDict ();

	var action = this.ioAction ();
	this.enqueueCmd ('copy', action, null, asmFile);

	fs.readFile (asmFile, (function (err, data) {
		if (err) {
			err.scope = 'project';
			//			console.log ('read failed', err);
			this.emit ('error', err);
			cb (err);
			return;
		}

		var asmContents = data.toString ();


		// TODO: something wrong: mkdirParent not working
		mkdirParent (asmFolder, (function (err) {
			if (err && err.code !== 'EEXIST') {
				err.scope = 'mkdir';
				//				console.trace ('cannot create folder', asmFolder, err.code);
				this.emit ('error', err);
				return;
			}
			fs.writeFile (
				sourceFile,
				asmContents,
				(function (err, done) {
					if (err) {
						err.scope = 'project';
						this.emit ('error', err);
						return;
					}
					// this.setProjectFiles (null, [projectFile], true);
					this.setLibNames ([], sourceFile, action.callback);

				}).bind (this));
		}).bind (this));
	}).bind (this));
}



/*

		// Java Compiler version 1.5.7

		// TODO: Make the --relax thing in configuration files.

		// For atmega2560, need --relax linker option to link larger
		// programs correctly.
		String optRelax = "";
		if (prefs.get("build.mcu").equals("atmega2560"))
			optRelax = ",--relax";

		String flags = dict.get("compiler.c.elf.flags") + optRelax;
		dict.put("compiler.c.elf.flags", flags);
		*/


ArduinoCompiler.prototype.linkAll = function () {

	var dict = this.getDict ();

	dict.archive_file = 'core.a';

	dict.object_files = '"' + this.objectFiles.join ("\" \"") + '"';
	//		dict.put("ide_version", "" + Base.REVISION);

	var linkCmd = common.replaceDict (this.platform.recipe['c.combine.pattern'], dict, null, "platform.recipe.c.combine.pattern");
	this.enqueueCmd ('link', linkCmd, null, 'all together');

//	if (this.verbose)
//		console.log (linkCmd);

}

ArduinoCompiler.prototype.objCopy = function () {
	var dict = this.getDict ();

	var eepCmd = common.replaceDict (this.platform.recipe['objcopy.eep.pattern'], dict, null, "platform.recipe.objcopy.eep.pattern");
	this.enqueueCmd ('obj-eep', eepCmd, null, 'objcopy eep');

	var hexCmd = common.replaceDict (this.platform.recipe['objcopy.hex.pattern'], dict, null, "platform.recipe.objcopy.hex.pattern");
	this.enqueueCmd ('obj-hex', hexCmd, null, 'objcopy hex');
}

ArduinoCompiler.prototype.checkSize = function () {
	var dict = this.getDict ();

	var sizeCmd = common.replaceDict (this.platform.recipe['size.pattern'], dict, null, "platform.recipe.size.pattern");
	var sizeRegexp = new RegExp (this.platform.recipe['size.regex'], 'gm');
	var sizeDataRegexp, sizeEepromRegexp;
	if (this.platform.recipe['size.regex.data'])
		sizeDataRegexp = new RegExp (this.platform.recipe['size.regex.data'], 'gm');
	if (this.platform.recipe['size.regex.eeprom'])
		sizeEepromRegexp = new RegExp (this.platform.recipe['size.regex.eeprom'], 'gm');
	this.enqueueCmd ('size', sizeCmd, (function (error, stdout, stderr) {
		// console.log ('[size]', stdout);
		var size = 0, sizeData = 0, sizeEeprom = 0;
		var matches;
		while ((matches = sizeRegexp.exec (stdout)) !== null) {
			size += parseInt (matches[1]);
		}
		if (sizeDataRegexp)
			while ((matches = sizeDataRegexp.exec (stdout)) !== null) {
				sizeData += parseInt (matches[1]);
			}
		if (sizeEepromRegexp)
			while ((matches = sizeEepromRegexp.exec (stdout)) !== null) {
				sizeEeprom += parseInt (matches[1]);
			}

		this.compiledSize = {
			text: size,
			maxText: parseInt (dict['upload.maximum_size']),
			data: sizeData,
			maxData: parseInt (dict['upload.maximum_data_size']),
			eeprom: sizeEeprom
		};

		// console.log (sizeRegexp.exec (stdout));
		this.emit ('log', 'size', [
			'text', size + (this.compiledSize.maxText ? '/'+this.compiledSize.maxText : ""),
			'data', sizeData + (this.compiledSize.maxData ? '/'+this.compiledSize.maxData : ""),
			'eeprom', sizeEeprom
		].join (' '), this.compiledSize);
		//		console.log ('[size]', 'text', size, 'data', sizeData, 'eeprom', sizeEeprom);


		// TODO: warn_data_percentage instabilities
//		int warnDataPercentage = Integer.parseInt(prefs.get("build.warn_data_percentage"));
//		if (maxDataSize > 0 && dataSize > maxDataSize*warnDataPercentage/100)
//			System.err.println(_("Low memory available, stability problems may occur."));
	}).bind(this), 'determine compiled size');

}


function mkdirParent (dirPath, mode, callback) {
	//Call the standard fs.mkdir
	fs.mkdir(dirPath, mode, function(error) {
		//When it fail in this way, do the custom steps
//		console.log (error && error.code);
		if (error && error.code === 'ENOENT') {
			//Create all the parents recursively
			mkdirParent (path.dirname (dirPath), mode, function (err) {
				//And then the directory
				mkdirParent (dirPath, mode, callback);
			});
			return;
		}
		//Manually run the callback since we used our own callback to do all these
		callback && callback(error);
	});
};

module.exports = ArduinoCompiler;