Compiler.cs

///
/// WF.Compiler - A Wherigo Compiler.
/// Copyright (C) 2012-2014  Dirk Weltz <web@weltz-online.de>
///
/// This program is free software: you can redistribute it and/or modify
/// it under the terms of the GNU Lesser General Public License as
/// published by the Free Software Foundation, either version 3 of the
/// License, or (at your option) any later version.
/// 
/// This program is distributed in the hope that it will be useful,
/// but WITHOUT ANY WARRANTY; without even the implied warranty of
/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
/// GNU Lesser General Public License for more details.
/// 
/// You should have received a copy of the GNU Lesser General Public License
/// along with this program.  If not, see <http://www.gnu.org/licenses/>.
/// 

using System;
using System.IO;
using System.Text.RegularExpressions;
using Ionic.Zip;
using Eluant;
using System.Collections.Generic;
using System.Reflection;
using System.Linq;

namespace WF.Compiler
{
	using DeviceType = Groundspeak.Wherigo.ZonesLinker.DeviceType;

	public static class Compiler
    {
		/// <summary>
		/// The entry point of the program, where the program control starts and ends when used from command line.
		/// </summary>
		/// <param name="args">The command line arguments.</param>
        public static void Main(string[] args)
        {
			var start = DateTime.Now;
			var device = DeviceType.Unknown;

			Console.WriteLine("WF.Compiler, Version {0}", System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString());
			Console.WriteLine("Copyright 2014 by Wherigo Foundation");
			Console.WriteLine();

			string fileInput = null; 
			string fileOutput = null;

			int userId = 0;
			string userName = "WF.Compiler";
			string completitionCode = "123456789ABCDEF";

			int i = 0;

			while (i < args.Length) {
				switch(args[i].ToLower()) {
				case "-d":
				case "-device":
					if (i+1 >= args.Length) {
						Usage();
						return;
					}
					string deviceName = args[i+1].ToLower();
					i++;
					foreach (DeviceType d in Enum.GetValues(typeof(DeviceType))) 
						if (d.ToString().ToLower() == deviceName) 
							device = d;
					break;
				case "-o":
				case "-output":
					if (i+1 >= args.Length) {
						Usage();
						return;
					}
					fileOutput = args[i+1].ToLower();
					i++;
					break;
				case "-u":
				case "-username":
					if (i+1 >= args.Length) {
						Usage();
						return;
					}
					userName = args[i+1];
					i++;
					break;
				case "-c":
				case "-code":
					if (i+1 >= args.Length) {
						Usage();
						return;
					}
					completitionCode = args[i+1];
					i++;
					break;
				default:
					fileInput = args[i];
					break;
				}
				i++;
			}

			if (fileInput == null) {
				Usage();
				return;
			}

			if (!File.Exists(fileInput)) {
				Usage();
				return;
			}


			if (fileOutput == null)
				fileOutput = Path.ChangeExtension(fileInput,".gwc");

			Console.WriteLine("Input file: " + fileInput);
			Console.WriteLine("Output file: " + fileOutput);
			Console.WriteLine("Device: " + device.ToString());
			Console.WriteLine("Username: " + userName);
			Console.WriteLine("CompletionCode: " + completitionCode);

			FileStream ifs = new FileStream(fileInput, FileMode.Open);

			// ---------- Create GWZ file only (required for upload and download of GWZ file) ----------

			// Create object für reading input file (could be also any other format implementing IInput)
			var inputFormat = new GWZ(ifs);

			// ---------- Check GWZ file (only required for upload of GWZ file) ----------

			// Check gwz file for errors (Lua code and all files included)
			try {
				inputFormat.Check();
			}
			catch (CompilerLuaException e)
			{
				Console.WriteLine();
				Console.WriteLine("Error");
				Console.WriteLine(e.Message);
				Console.WriteLine();
				Console.WriteLine("Line {0}: {1}", e.Line-1, e.CodeBefore);
				Console.WriteLine("Line {0}: {1}", e.Line, e.Code);
				Console.WriteLine("Line {0}: {1}", e.Line+1, e.CodeAfter);
				return;
			}
			catch (Exception e)
			{
				Console.WriteLine();
				Console.WriteLine("Error");
				Console.WriteLine(e.Message);
				ifs.Close();
				return;
			}

			// ---------- Load cartridge from GWZ file (required when downloading cartridge) ----------

			// Load Lua code and extract all required data
			Cartridge cartridge = inputFormat.Load();

			// ---------- Convert cartridge for engine ----------

			// Create selected engine
			IEngine engine = CreateEngine(device);

			// Convert Lua code and insert special code for this player
			cartridge = engine.ConvertCartridge(cartridge);
			userName = engine.ConvertString(userName);

			// Now we can close the input, because we don't require it anymore
			ifs.Close();

			// ---------- Compile Lua code into binary chunk ----------

			try {
				// Compile Lua code
				cartridge.Chunk = LUA.Compile(cartridge.LuaCode, cartridge.LuaFileName);
			}
			catch (Exception e)
			{
				var t = e.Message;
			}

			// ---------- Save cartridge as GWC file ----------

			// Create object for output format (could be also WFC or any other IOutput)
			var outputFormat = new GWC();

			// Write output file
			try {
				// Create output in correct format
				var ms = outputFormat.Create(cartridge, userName, userId, completitionCode);
				// Save output to file
				using(FileStream ofs = new FileStream(fileOutput, FileMode.Create)) {
					ms.CopyTo(ofs);
					// Close output
					ofs.Flush();
					ofs.Close();
				}
			}
			catch (Exception e)
			{
				Console.WriteLine();
				Console.WriteLine("Error");
				Console.WriteLine(e.Message);
				return;
			}

			Console.WriteLine("Compiletime: {0}", DateTime.Now - start);
        }

		/// <summary>
		/// Usage of programm when called from command line.
		/// </summary>
		static void Usage ()
		{
			Console.WriteLine("Usage: WF.Compiler [options] <filename>");
			Console.WriteLine();
			Console.WriteLine("Options:");
			Console.WriteLine("-d|-device");
			string devices = "";
			foreach (DeviceType d in Enum.GetValues(typeof(DeviceType))) 
				devices = (devices != "" ? devices + ", " : devices) + d.ToString();
			Console.WriteLine("One of the following devices: " + devices);
			Console.WriteLine("-o|-output");
			Console.WriteLine("Filename for output file. If there is none, than the input file extensions is changed to gwc.");
			Console.WriteLine("-u|-username");
			Console.WriteLine("Username for the cartridge");
			Console.WriteLine("-c|-code");
			Console.WriteLine("Completition code for the cartridge");
		}

		/// <summary>
		/// Checke the file with name fileInput, if it is a valid GWZ file and the Lua code has no errors.
		/// </summary>
		/// <param name="fileInput">File name for input.</param>
		public static void Upload(string fileInput)
		{
			Upload(new FileStream(fileInput, FileMode.Open));
		}

		/// <summary>
		/// Checke the stream fileInput, if it is a valid GWZ file and the Lua code has no errors.
		/// </summary>
		/// <param name="fileInput">Stream for input.</param>
		public static void Upload(Stream ifs)
		{
			// ---------- Create GWZ file only (required for upload and download of GWZ file) ----------

			// Create object für reading input file (could be also any other format implementing IInput)
			var inputFormat = new GWZ(ifs);

			// ---------- Check GWZ file (only required for upload of GWZ file) ----------

			// Check gwz file for errors (Lua code and all files included)
			// Could throw CompilerLuaException when there is a bug in Lua code
			inputFormat.Check();

			// We are ready an no exception was thrown, so we only have to close the input stream and leave.
			ifs.Close();
		}

		/// <summary>
		/// Compiler entry for online compilation.
		/// </summary>
		/// <param name="fileInput">File name of the input file.</param>
		/// <param name="device">Device.</param>
		/// <param name="userName">User name.</param>
		/// <param name="completitionCode">Completition code.</param>
		public static MemoryStream Download(string fileInput, DeviceType device = DeviceType.Emulator, string userName = "WF.Compiler", string completitionCode = "1234567890ABCDE")
		{
			return Download(new FileStream(fileInput, FileMode.Open), device, userName, completitionCode);
		}

		/// <summary>
		/// Compiler entry for online compilation.
		/// </summary>
		/// <param name="ifs">Stream of the input file.</param>
		/// <param name="device">Device.</param>
		/// <param name="userName">User name.</param>
		/// <param name="completitionCode">Completition code.</param>
		public static MemoryStream Download(Stream ifs, DeviceType device = DeviceType.Emulator, string userName = "WF.Compiler", string completitionCode = "1234567890ABCDE")
		{
			// ---------- Check device ----------

			// ---------- Create GWZ file only (required for upload and download of GWZ file) ----------

			// Create object für reading input file (could be also any other format implementing IInput)
			var inputFormat = new GWZ(ifs);

			// ---------- Check GWZ file (only required for upload of GWZ file) ----------

			// Check gwz file for errors (Lua code and all files included)
			// Now there shouldn't be any errors, because files on the server are checked.
			inputFormat.Check();

			// ---------- Load cartridge from GWZ file (required when downloading cartridge) ----------

			// Load Lua code and extract all required data
			Cartridge cartridge = inputFormat.Load();

			// ---------- Convert cartridge for engine ----------

			// Create selected player
			IEngine engine = CreateEngine(device);

			// Convert Lua code and insert special code for this player
			cartridge = engine.ConvertCartridge(cartridge);
			userName = engine.ConvertString(userName);

			// Now we can close the input, because we don't require it anymore
			ifs.Close();

			// ---------- Compile Lua code into binary chunk ----------

			// Compile Lua code
			cartridge.Chunk = LUA.Compile(cartridge.LuaCode, cartridge.LuaFileName);

			// ---------- Save cartridge as GWC file ----------

			// Create object for output format (could be also WFC or any other IOutput)
			var outputFormat = new GWC();

			// Write output file
			try {
				// Create output in correct format
				var ms = outputFormat.Create(cartridge, userName, 0, completitionCode);
				return ms;
			}
			catch (Exception e)
			{
				Console.WriteLine(e.Message);
				return null;
			}

		}

		public static IEngine CreateEngine (DeviceType device)
		{
			IEngine result;

			switch (device) {
			case DeviceType.Garmin:
				result = new EngineGarmin ();
				break;
			case DeviceType.iPhone:
			case DeviceType.iPhoneRetina:
			case DeviceType.iPad:
			case DeviceType.iPadRetina:
				result = new EngineiOS (device);
				break;
			case DeviceType.WFPlayer:
				result = new EngineWFPlayer();
				break;
			case DeviceType.OpenWIG:
			case DeviceType.WhereYouGo:
				result = new EngineOpenWIG ();
				break;
			case DeviceType.XMarksTheSpot:
				result = new EngineXMarksTheSpot ();
				break;
			case DeviceType.Emulator:
			case DeviceType.PPC2003:
			default:
				result = new EnginePocketPC ();
				break;
			}

			return result;
		}
	}
}