UltimateZoneBuilder/Source/IO/UniversalMapSetIO.cs

#region ================== Copyright (c) 2007 Pascal vd Heiden

/*
 * Copyright (c) 2007 Pascal vd Heiden, www.codeimp.com
 * This program is released under GNU General Public License
 * 
 * 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 General Public License for more details.
 * 
 */

#endregion

#region ================== Namespaces

using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using System.IO;
using CodeImp.DoomBuilder.Map;
using CodeImp.DoomBuilder.Geometry;
using System.Windows.Forms;
using CodeImp.DoomBuilder.Config;
using CodeImp.DoomBuilder.Types;

#endregion

namespace CodeImp.DoomBuilder.IO
{
	internal class UniversalMapSetIO : MapSetIO
	{
		#region ================== Constants

		// Name of the UDMF configuration file
		private const string UDMF_CONFIG_NAME = "UDMF.cfg";
		
		#endregion

		#region ================== Variables

		private Configuration config;
		
		#endregion
		
		#region ================== Constructor / Disposer

		// Constructor
		public UniversalMapSetIO(WAD wad, MapManager manager) : base(wad, manager)
		{
			// Make configuration
			config = new Configuration();
			
			// Find a resource named Font.cfg
			string[] resnames = General.ThisAssembly.GetManifestResourceNames();
			foreach(string rn in resnames)
			{
				// Found it?
				if(rn.EndsWith(UDMF_CONFIG_NAME, StringComparison.InvariantCultureIgnoreCase))
				{
					// Get a stream from the resource
					Stream udmfcfg = General.ThisAssembly.GetManifestResourceStream(rn);
					StreamReader udmfcfgreader = new StreamReader(udmfcfg, Encoding.ASCII);
					
					// Load configuration from stream
					config.InputConfiguration(udmfcfgreader.ReadToEnd());

					// Now we add the linedef flags, activations and thing flags
					// to this list, so that these don't show up in the custom
					// fields list either. We use true as dummy value (it has no meaning)

					// Add linedef flags
					foreach(KeyValuePair<string, string> flag in General.Map.Config.LinedefFlags)
						config.WriteSetting("managedfields.linedef." + flag.Key, true);

					// Add linedef activations
					foreach(LinedefActivateInfo activate in General.Map.Config.LinedefActivates)
						config.WriteSetting("managedfields.linedef." + activate.Key, true);

					// Add thing flags
					foreach(KeyValuePair<string, string> flag in General.Map.Config.ThingFlags)
						config.WriteSetting("managedfields.thing." + flag.Key, true);
					
					// Done
					udmfcfgreader.Dispose();
					udmfcfg.Dispose();
					break;
				}
			}
		}

		#endregion

		#region ================== Properties

		public override int MaxSidedefs { get { return int.MaxValue; } }
		public override int VertexDecimals { get { return 3; } }
		public override string DecimalsFormat { get { return "0.000"; } }

		#endregion

		#region ================== Reading
		
		// This reads a map from the file and returns a MapSet
		public override MapSet Read(MapSet map, string mapname)
		{
			UniversalParser textmap = new UniversalParser();
			StreamReader lumpreader = null;
			Dictionary<int, Vertex> vertexlink;
			Dictionary<int, Sector> sectorlink;
			
			// Find the index where first map lump begins
			int firstindex = wad.FindLumpIndex(mapname) + 1;
			
			// Get the TEXTMAP lump from wad file
			Lump lump = wad.FindLump("TEXTMAP", firstindex);
			if(lump == null) throw new Exception("Could not find required lump TEXTMAP!");

			try
			{
				// Parse the UDMF data
				lumpreader = new StreamReader(lump.Stream, Encoding.ASCII);
				lump.Stream.Seek(0, SeekOrigin.Begin);
				textmap.InputConfiguration(lumpreader.ReadToEnd());

				// Check for errors
				if(textmap.ErrorResult != 0)
				{
					// Show parse error
					General.ShowErrorMessage("Error while parsing UDMF map data:\n" + textmap.ErrorDescription, MessageBoxButtons.OK);
				}
				else
				{
					// Read the map
					vertexlink = ReadVertices(map, textmap);
					sectorlink = ReadSectors(map, textmap);
					ReadLinedefs(map, textmap, vertexlink, sectorlink);
					ReadThings(map, textmap);
				}
			}
			catch(Exception e)
			{
				General.ShowErrorMessage("Unexpected error reading UDMF map data. " + e.GetType().Name + ": " + e.Message, MessageBoxButtons.OK);
			}
			finally
			{
				if(lumpreader != null) lumpreader.Dispose();
			}

			// Return result
			return map;
		}

		// This reads the things
		private void ReadThings(MapSet map, UniversalParser textmap)
		{
			// Get list of entries
			List<UniversalCollection> collections = GetNamedCollections(textmap.Root, "thing");
			
			// Go for all collections
			for(int i = 0; i < collections.Count; i++)
			{
				// Read fields
				UniversalCollection c = collections[i];
				int[] args = new int[Linedef.NUM_ARGS];
				float x = GetCollectionEntry<float>(c, "x", true, 0.0f);
				float y = GetCollectionEntry<float>(c, "y", true, 0.0f);
				float height = GetCollectionEntry<float>(c, "height", false, 0.0f);
				int tag = GetCollectionEntry<int>(c, "id", false, 0);
				int angledeg = GetCollectionEntry<int>(c, "angle", false, 0);
				int type = GetCollectionEntry<int>(c, "type", true, 0);
				int special = GetCollectionEntry<int>(c, "special", false, 0);
				args[0] = GetCollectionEntry<int>(c, "arg0", false, 0);
				args[1] = GetCollectionEntry<int>(c, "arg1", false, 0);
				args[2] = GetCollectionEntry<int>(c, "arg2", false, 0);
				args[3] = GetCollectionEntry<int>(c, "arg3", false, 0);
				args[4] = GetCollectionEntry<int>(c, "arg4", false, 0);

				// Flags
				Dictionary<string, bool> stringflags = new Dictionary<string, bool>();
				foreach(KeyValuePair<string, string> flag in General.Map.Config.ThingFlags)
					stringflags[flag.Key] = GetCollectionEntry<bool>(c, flag.Key, false, false);
				
				// Create new item
				Thing t = map.CreateThing();
				t.Update(type, x, y, height, Angle2D.DegToRad(angledeg), stringflags, tag, special, args);
				//t.DetermineSector();
				t.UpdateConfiguration();
				
				// Custom fields
				ReadCustomFields(c, t, "thing");
			}
		}

		// This reads the linedefs and sidedefs
		private void ReadLinedefs(MapSet map, UniversalParser textmap,
			Dictionary<int, Vertex> vertexlink, Dictionary<int, Sector> sectorlink)
		{
			// Get list of entries
			List<UniversalCollection> linescolls = GetNamedCollections(textmap.Root, "linedef");
			List<UniversalCollection> sidescolls = GetNamedCollections(textmap.Root, "sidedef");

			// Go for all lines
			for(int i = 0; i < linescolls.Count; i++)
			{
				// Read fields
				UniversalCollection lc = linescolls[i];
				int[] args = new int[Linedef.NUM_ARGS];
				int tag = GetCollectionEntry<int>(lc, "id", false, 0);
				int v1 = GetCollectionEntry<int>(lc, "v1", true, 0);
				int v2 = GetCollectionEntry<int>(lc, "v2", true, 0);
				int special = GetCollectionEntry<int>(lc, "special", false, 0);
				args[0] = GetCollectionEntry<int>(lc, "arg0", false, 0);
				args[1] = GetCollectionEntry<int>(lc, "arg1", false, 0);
				args[2] = GetCollectionEntry<int>(lc, "arg2", false, 0);
				args[3] = GetCollectionEntry<int>(lc, "arg3", false, 0);
				args[4] = GetCollectionEntry<int>(lc, "arg4", false, 0);
				int s1 = GetCollectionEntry<int>(lc, "sidefront", true, -1);
				int s2 = GetCollectionEntry<int>(lc, "sideback", false, -1);
				
				// Flags
				Dictionary<string, bool> stringflags = new Dictionary<string, bool>();
				foreach(KeyValuePair<string, string> flag in General.Map.Config.LinedefFlags)
					stringflags[flag.Key] = GetCollectionEntry<bool>(lc, flag.Key, false, false);

				// Activations
				foreach(LinedefActivateInfo activate in General.Map.Config.LinedefActivates)
					stringflags[activate.Key] = GetCollectionEntry<bool>(lc, activate.Key, false, false);
				
				// Create new item
				Linedef l = map.CreateLinedef(vertexlink[v1], vertexlink[v2]);
				l.Update(stringflags, 0, tag, special, args);
				l.UpdateCache();

				// Custom fields
				ReadCustomFields(lc, l, "linedef");
				
				// Read sidedefs and connect them to the line
				if(s1 > -1) ReadSidedef(map, sidescolls[s1], l, true, sectorlink);
				if(s2 > -1) ReadSidedef(map, sidescolls[s2], l, false, sectorlink);
			}
		}

		// This reads a single sidedef and connects it to the given linedef
		private void ReadSidedef(MapSet map, UniversalCollection sc, Linedef ld,
								 bool front, Dictionary<int, Sector> sectorlink)
		{
			// Read fields
			int offsetx = GetCollectionEntry<int>(sc, "offsetx", false, 0);
			int offsety = GetCollectionEntry<int>(sc, "offsety", false, 0);
			string thigh = GetCollectionEntry<string>(sc, "texturetop", false, "-");
			string tlow = GetCollectionEntry<string>(sc, "texturebottom", false, "-");
			string tmid = GetCollectionEntry<string>(sc, "texturemiddle", false, "-");
			int sector = GetCollectionEntry<int>(sc, "sector", true, 0);

			// Create sidedef
			Sidedef s = map.CreateSidedef(ld, front, sectorlink[sector]);
			s.Update(offsetx, offsety, thigh, tmid, tlow);

			// Custom fields
			ReadCustomFields(sc, s, "sidedef");
		}

		// This reads the sectors
		private Dictionary<int, Sector> ReadSectors(MapSet map, UniversalParser textmap)
		{
			Dictionary<int, Sector> link;

			// Get list of entries
			List<UniversalCollection> collections = GetNamedCollections(textmap.Root, "sector");

			// Create lookup table
			link = new Dictionary<int, Sector>(collections.Count);

			// Go for all collections
			for(int i = 0; i < collections.Count; i++)
			{
				// Read fields
				UniversalCollection c = collections[i];
				int hfloor = GetCollectionEntry<int>(c, "heightfloor", false, 0);
				int hceil = GetCollectionEntry<int>(c, "heightceiling", false, 0);
				string tfloor = GetCollectionEntry<string>(c, "texturefloor", true, "-");
				string tceil = GetCollectionEntry<string>(c, "textureceiling", true, "-");
				int bright = GetCollectionEntry<int>(c, "lightlevel", false, 160);
				int special = GetCollectionEntry<int>(c, "special", false, 0);
				int tag = GetCollectionEntry<int>(c, "id", false, 0);
				
				// Create new item
				Sector s = map.CreateSector();
				s.Update(hfloor, hceil, tfloor, tceil, special, tag, bright);

				// Custom fields
				ReadCustomFields(c, s, "sector");

				// Add it to the lookup table
				link.Add(i, s);
			}

			// Return lookup table
			return link;
		}

		// This reads the vertices
		private Dictionary<int, Vertex> ReadVertices(MapSet map, UniversalParser textmap)
		{
			Dictionary<int, Vertex> link;
			
			// Get list of entries
			List<UniversalCollection> collections = GetNamedCollections(textmap.Root, "vertex");
			
			// Create lookup table
			link = new Dictionary<int, Vertex>(collections.Count);
			
			// Go for all collections
			for(int i = 0; i < collections.Count; i++)
			{
				// Read fields
				UniversalCollection c = collections[i];
				float x = GetCollectionEntry<float>(c, "x", true, 0.0f);
				float y = GetCollectionEntry<float>(c, "y", true, 0.0f);

				// Create new item
				Vertex v = map.CreateVertex(new Vector2D(x, y));

				// Custom fields
				ReadCustomFields(c, v, "vertex");
				
				// Add it to the lookup table
				link.Add(i, v);
			}

			// Return lookup table
			return link;
		}

		// This reads custom fields from a collection and adds them to a map element
		private void ReadCustomFields(UniversalCollection collection, MapElement element, string elementname)
		{
			// Go for all the elements in the collection
			foreach(UniversalEntry e in collection)
			{
				// Check if not a managed field
				if(!config.SettingExists("managedfields." + elementname + "." + e.Key))
				{
					int type = (int)UniversalType.Integer;
					
					// Determine default type
					if(e.Value.GetType() == typeof(int)) type = (int)UniversalType.Integer;
					else if(e.Value.GetType() == typeof(float)) type = (int)UniversalType.Float;
					else if(e.Value.GetType() == typeof(bool)) type = (int)UniversalType.Boolean;
					else if(e.Value.GetType() == typeof(string)) type = (int)UniversalType.String;

					// Try to find the type from configuration
					type = manager.Options.GetUniversalFieldType(elementname, e.Key, type);

					// Make custom field
					element.Fields.Add(e.Key, new UniValue(type, e.Value));
				}
			}
		}
		
		// This validates and returns an entry
		private T GetCollectionEntry<T>(UniversalCollection c, string entryname, bool required, T defaultvalue)
		{
			T result = default(T);
			bool found = false;
			
			// Find the entry
			foreach(UniversalEntry e in c)
			{
				// Check if matches
				if(e.Key == entryname)
				{
					// Let's be kind and cast any int to a float if needed
					if((typeof(T) == typeof(float)) &&
					   (e.Value.GetType() == typeof(int)))
					{
						// Make it a float
						result = (T)e.Value;
					}
					else
					{
						// Verify type
						e.ValidateType(typeof(T));

						// Found it!
						result = (T)e.Value;
					}
					
					// Done
					found = true;
				}
			}
			
			// Not found?
			if(!found)
			{
				// Entry is required?
				if(required)
				{
					// Error, cannot find required entry!
					throw new Exception("Error while reading UDMF map data: Missing required field '" + entryname + "'.");
				}
				else
				{
					// Make default entry
					result = defaultvalue;
				}
			}

			// Return result
			return result;
		}
		
		// This makes a list of all collections with the given name
		private List<UniversalCollection> GetNamedCollections(UniversalCollection collection, string entryname)
		{
			List<UniversalCollection> list = new List<UniversalCollection>();

			// Make list
			foreach(UniversalEntry e in collection)
				if((e.Value is UniversalCollection) && (e.Key == entryname)) list.Add(e.Value as UniversalCollection);
			
			return list;
		}
		
		#endregion

		#region ================== Writing

		// This writes a MapSet to the file
		public override void Write(MapSet map, string mapname, int position)
		{
			UniversalParser textmap = new UniversalParser();

			// Begin with fields that must be at the top
			textmap.Root.Add("namespace", manager.Config.EngineName);

			Dictionary<Vertex, int> vertexids = new Dictionary<Vertex, int>();
			Dictionary<Sidedef, int> sidedefids = new Dictionary<Sidedef, int>();
			Dictionary<Sector, int> sectorids = new Dictionary<Sector, int>();

			// Index the elements in the data structures
			foreach(Vertex v in map.Vertices) vertexids.Add(v, vertexids.Count);
			foreach(Sidedef sd in map.Sidedefs) sidedefids.Add(sd, sidedefids.Count);
			foreach(Sector s in map.Sectors) sectorids.Add(s, sectorids.Count);

			// We will write the custom field types again, so forget
			// all previous field types (this gets rid of unused field types)
			manager.Options.ForgetUniversalFieldTypes();
			
			// Write the data structures to textmap
			WriteVertices(map, textmap);
			WriteLinedefs(map, textmap, sidedefids, vertexids);
			WriteSidedefs(map, textmap, sectorids);
			WriteSectors(map, textmap);
			WriteThings(map, textmap);
			
			// Get the textmap as string
			string textmapstr = textmap.OutputConfiguration();
			
			// Find insert position and remove old lump
			int insertpos = MapManager.RemoveSpecificLump(wad, "TEXTMAP", position, "", manager.Config.MapLumpNames);
			if(insertpos == -1) insertpos = position + 1;
			if(insertpos > wad.Lumps.Count) insertpos = wad.Lumps.Count;

			// Create the lump from memory
			Lump lump = wad.Insert("TEXTMAP", insertpos, textmapstr.Length);
			StreamWriter lumpwriter = new StreamWriter(lump.Stream);
			lump.Stream.Seek(0, SeekOrigin.Begin);
			lumpwriter.Write(textmapstr);
			lumpwriter.Flush();
		}

		// This writes the vertices
		private void WriteVertices(MapSet map, UniversalParser textmap)
		{
			// Go for all vertices
			foreach(Vertex v in map.Vertices)
			{
				// Make collection
				UniversalCollection coll = new UniversalCollection();
				coll.Add("x", v.Position.x);
				coll.Add("y", v.Position.y);

				// Add custom fields
				AddCustomFields(v, "vertex", coll);
				
				// Store
				textmap.Root.Add("vertex", coll);
			}
		}

		// This writes the linedefs
		private void WriteLinedefs(MapSet map, UniversalParser textmap, IDictionary<Sidedef, int> sidedefids, IDictionary<Vertex, int> vertexids)
		{
			// Go for all linedefs
			foreach(Linedef l in map.Linedefs)
			{
				// Make collection
				UniversalCollection coll = new UniversalCollection();
				if(l.Tag != 0) coll.Add("id", l.Tag);
				coll.Add("v1", vertexids[l.Start]);
				coll.Add("v2", vertexids[l.End]);
				if(l.Front != null) coll.Add("sidefront", sidedefids[l.Front]); else coll.Add("sidefront", -1);
				if(l.Back != null) coll.Add("sideback", sidedefids[l.Back]); else coll.Add("sideback", -1);
				if(l.Action != 0) coll.Add("special", l.Action);
				if(l.Args[0] != 0) coll.Add("arg0", l.Args[0]);
				if(l.Args[1] != 0) coll.Add("arg1", l.Args[1]);
				if(l.Args[2] != 0) coll.Add("arg2", l.Args[2]);
				if(l.Args[3] != 0) coll.Add("arg3", l.Args[3]);
				if(l.Args[4] != 0) coll.Add("arg4", l.Args[4]);

				// Flags
				foreach(KeyValuePair<string, bool> flag in l.Flags)
					if(flag.Value) coll.Add(flag.Key, flag.Value);
				
				// Add custom fields
				AddCustomFields(l, "linedef", coll);
				
				// Store
				textmap.Root.Add("linedef", coll);
			}
		}

		// This writes the sidedefs
		private void WriteSidedefs(MapSet map, UniversalParser textmap, IDictionary<Sector, int> sectorids)
		{
			// Go for all sidedefs
			foreach(Sidedef s in map.Sidedefs)
			{
				// Make collection
				UniversalCollection coll = new UniversalCollection();
				if(s.OffsetX != 0) coll.Add("offsetx", s.OffsetX);
				if(s.OffsetY != 0) coll.Add("offsety", s.OffsetY);
				if(s.LongHighTexture != map.EmptyLongName) coll.Add("texturetop", s.HighTexture);
				if(s.LongLowTexture != map.EmptyLongName) coll.Add("texturebottom", s.LowTexture);
				if(s.LongMiddleTexture != map.EmptyLongName) coll.Add("texturemiddle", s.MiddleTexture);
				coll.Add("sector", sectorids[s.Sector]);
				
				// Add custom fields
				AddCustomFields(s, "sidedef", coll);
				
				// Store
				textmap.Root.Add("sidedef", coll);
			}
		}

		// This writes the sectors
		private void WriteSectors(MapSet map, UniversalParser textmap)
		{
			// Go for all sectors
			foreach(Sector s in map.Sectors)
			{
				// Make collection
				UniversalCollection coll = new UniversalCollection();
				coll.Add("heightfloor", s.FloorHeight);
				coll.Add("heightceiling", s.CeilHeight);
				coll.Add("texturefloor", s.FloorTexture);
				coll.Add("textureceiling", s.CeilTexture);
				coll.Add("lightlevel", s.Brightness);
				if(s.Effect != 0) coll.Add("special", s.Effect);
				if(s.Tag != 0) coll.Add("id", s.Tag);
				
				// Add custom fields
				AddCustomFields(s, "sector", coll);
				
				// Store
				textmap.Root.Add("sector", coll);
			}
		}

		// This writes the things
		private void WriteThings(MapSet map, UniversalParser textmap)
		{
			// Go for all things
			foreach(Thing t in map.Things)
			{
				// Make collection
				UniversalCollection coll = new UniversalCollection();
				if(t.Tag != 0) coll.Add("id", t.Tag);
				coll.Add("x", t.Position.x);
				coll.Add("y", t.Position.y);
				if(t.Position.z != 0.0f) coll.Add("height", (float)t.Position.z);
				coll.Add("angle", t.AngleDeg);
				coll.Add("type", t.Type);
				if(t.Action != 0) coll.Add("special", t.Action);
				if(t.Args[0] != 0) coll.Add("arg0", t.Args[0]);
				if(t.Args[1] != 0) coll.Add("arg1", t.Args[1]);
				if(t.Args[2] != 0) coll.Add("arg2", t.Args[2]);
				if(t.Args[3] != 0) coll.Add("arg3", t.Args[3]);
				if(t.Args[4] != 0) coll.Add("arg4", t.Args[4]);
				
				// Flags
				foreach(KeyValuePair<string, bool> flag in t.Flags)
					if(flag.Value) coll.Add(flag.Key, flag.Value);
				
				// Add custom fields
				AddCustomFields(t, "thing", coll);

				// Store
				textmap.Root.Add("thing", coll);
			}
		}
		
		// This adds custom fields from a map element to a collection
		private void AddCustomFields(MapElement element, string elementname, UniversalCollection collection)
		{
			// Add custom fields
			foreach(KeyValuePair<string, UniValue> f in element.Fields)
			{
				// Not a managed field?
				if(!config.SettingExists("managedfields." + elementname + "." + f.Key))
				{
					// Add type information to DBS file for map
					manager.Options.SetUniversalFieldType(elementname, f.Key, f.Value.Type);

					// Store field
					collection.Add(f.Key, f.Value.Value);
				}
			}
		}
		
		#endregion
	}
}