Merge pull request #934 from DomCR/issue-891_CadDictionary-defaults

issue 891 default entries

Author: DomCR

src/ACadSharp.Tests/IO/IOTestsBase.cs

@@ -39,8 +39,8 @@ public abstract class IOTestsBase
 		static IOTestsBase()
 		{
 			loadSamples("", "dwg", DwgFilePaths);
-			loadSamples("", "dxf", DxfAsciiFiles);
-			loadSamples("", "dxf", DxfBinaryFiles);
+			loadSamples("", "_ascii", "dxf", DxfAsciiFiles);
+			loadSamples("", "_binary", "dxf", DxfBinaryFiles);
 
 			Versions = new TheoryData<ACadVersion>
 			{
@@ -68,6 +68,11 @@ protected static void loadLocalSamples(string folder, string ext, TheoryData<Fil
 		}
 
 		protected static void loadSamples(string folder, string ext, TheoryData<FileModel> files)
+		{
+			loadSamples(folder, string.Empty, ext, files);
+		}
+
+		protected static void loadSamples(string folder, string prefix, string ext, TheoryData<FileModel> files)
 		{
 			string path = TestVariables.SamplesFolder;
 
@@ -82,7 +87,7 @@ protected static void loadSamples(string folder, string ext, TheoryData<FileMode
 				return;
 			}
 
-			foreach (string file in Directory.GetFiles(path, $"*.{ext}"))
+			foreach (string file in Directory.GetFiles(path, $"*{prefix}.{ext}"))
 			{
 				files.Add(new FileModel(file));
 			}

src/ACadSharp.Tests/Objects/Collections/DictionaryVariableCollectionTests.cs

@@ -12,7 +12,7 @@ public void AddVariable()
 			CadDocument document = new CadDocument();
 			var c = this.getDocumentCollection(document);
 
-			c.AddVariable("hello", "value");
+			c.AddOrUpdateVariable("hello", "value");
 
 			Assert.NotEmpty(c);
 			Assert.True(c.TryGet("hello", out DictionaryVariable variable));
@@ -21,7 +21,7 @@ public void AddVariable()
 
 			Assert.Null(c.GetValue("goodbye"));
 
-			c.AddVariable("hello", "new_value");
+			c.AddOrUpdateVariable("hello", "new_value");
 			Assert.Equal("new_value", c.GetValue("hello"));
 		}
 

src/ACadSharp/ACadSharp.csproj

@@ -17,7 +17,7 @@
 	<PropertyGroup>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
-		<Version>3.3.22</Version>
+		<Version>3.3.23</Version>
 		<PackageOutputPath>../nupkg</PackageOutputPath>
 		<SignAssembly>True</SignAssembly>
 		<AssemblyOriginatorKeyFile>../ACadSharp.snk</AssemblyOriginatorKeyFile>

src/ACadSharp/CadDocument.cs

@@ -262,7 +262,7 @@ public void CreateDefaults()
 				CadDictionary.CreateDefaultEntries(this.RootDictionary);
 			}
 
-			this.UpdateCollections(true);
+			this.UpdateCollections(true, true);
 
 			//Default variables
 			this.AppIds.CreateDefaultEntries();
@@ -445,7 +445,7 @@ public bool TryGetCadObject<T>(ulong handle, out T cadObject)
 		/// Updates the collections in the document and link them to it's dictionary.
 		/// </summary>
 		/// <param name="createDictionaries"></param>
-		public void UpdateCollections(bool createDictionaries)
+		public void UpdateCollections(bool createDictionaries, bool createDefaults)
 		{
 			if (createDictionaries && this.RootDictionary == null)
 			{
@@ -469,16 +469,19 @@ public void UpdateCollections(bool createDictionaries)
 			if (this.updateCollection(CadDictionary.AcadScaleList, createDictionaries, out CadDictionary scales))
 			{
 				this.Scales = new ScaleCollection(scales);
+				if (createDefaults) { this.Scales.CreateDefaults(); }
 			}
 
 			if (this.updateCollection(CadDictionary.AcadMLineStyle, createDictionaries, out CadDictionary mlineStyles))
 			{
 				this.MLineStyles = new MLineStyleCollection(mlineStyles);
+				if (createDefaults) { this.MLineStyles.CreateDefaults(); }
 			}
 
 			if (this.updateCollection(CadDictionary.AcadMLeaderStyle, createDictionaries, out CadDictionary mleaderStyles))
 			{
 				this.MLeaderStyles = new MLeaderStyleCollection(mleaderStyles);
+				if (createDefaults) { this.MLeaderStyles.CreateDefaults(); }
 			}
 
 			if (this.updateCollection(CadDictionary.AcadImageDict, createDictionaries, out CadDictionary imageDefinitions))
@@ -499,11 +502,13 @@ public void UpdateCollections(bool createDictionaries)
 			if (this.updateCollection(CadDictionary.VariableDictionary, createDictionaries, out CadDictionary variables))
 			{
 				this.DictionaryVariables = new DictionaryVariableCollection(variables);
+				if (createDefaults) { this.DictionaryVariables.CreateDefaults(); }
 			}
 
 			if (this.updateCollection(CadDictionary.AcadMaterial, createDictionaries, out CadDictionary materials))
 			{
 				this.Materials = new MaterialCollection(materials);
+				if (createDefaults) { this.Materials.CreateDefaults(); }
 			}
 		}
 

src/ACadSharp/IO/CadDocumentBuilder.cs

@@ -270,7 +270,7 @@ protected void buildDictionaries()
 				dictionaryTemplate.Build(this);
 			}
 
-			this.DocumentToBuild.UpdateCollections(true);
+			this.DocumentToBuild.UpdateCollections(true, false);
 		}
 
 		protected void createMissingHandles()

src/ACadSharp/Objects/CadDictionary.cs

@@ -171,16 +171,14 @@ public static void CreateDefaultEntries(CadDictionary root)
 			root.TryAdd(new CadDictionary(AcadColor));
 			root.TryAdd(new CadDictionary(AcadGroup));
 
-			CadDictionary layouts = root.ensureCadDictionaryExist(AcadLayout);
+			root.TryAdd(new CadDictionary(AcadLayout));
 
 			root.TryAdd(new CadDictionary(AcadMaterial));
 			root.TryAdd(new CadDictionary(AcadSortEnts));
 
-			CadDictionary mLeaderStyles = root.ensureCadDictionaryExist(AcadMLeaderStyle);
-			mLeaderStyles.TryAdd(MultiLeaderStyle.Default);
+			root.TryAdd(new CadDictionary(AcadMLeaderStyle));
 
-			CadDictionary mLineStyles = root.ensureCadDictionaryExist(AcadMLineStyle);
-			mLineStyles.TryAdd(MLineStyle.Default);
+			root.TryAdd(new CadDictionary(AcadMLineStyle));
 
 			root.TryAdd(new CadDictionary(AcadTableStyle));
 			root.TryAdd(new CadDictionary(AcadPlotSettings));
@@ -189,44 +187,17 @@ public static void CreateDefaultEntries(CadDictionary root)
 
 			// { AcadPlotStyleName, new CadDictionaryWithDefault() },	//Add default entry "Normal"	PlaceHolder	??
 
-			CadDictionary variableDictionary = root.ensureCadDictionaryExist(VariableDictionary);
-			root.TryAdd(variableDictionary);
-			DictionaryVariable cmLeaderStyleEntry = new DictionaryVariable
-			(
-				DictionaryVariable.CurrentMultiLeaderStyle,
-				MultiLeaderStyle.DefaultName
-			);
-			variableDictionary.TryAdd(cmLeaderStyleEntry);
+			root.TryAdd(new CadDictionary(VariableDictionary));
 
 			//DictionaryVars Entry DIMASSOC and HIDETEXT ??
 
-			CadDictionary scales = root.ensureCadDictionaryExist(AcadScaleList);
-			scales.TryAdd(new Scale { Name = "A0", PaperUnits = 1.0, DrawingUnits = 1.0, IsUnitScale = true });
-			scales.TryAdd(new Scale { Name = "A1", PaperUnits = 1.0, DrawingUnits = 2.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A2", PaperUnits = 1.0, DrawingUnits = 4.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A3", PaperUnits = 1.0, DrawingUnits = 5.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A4", PaperUnits = 1.0, DrawingUnits = 8.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A5", PaperUnits = 1.0, DrawingUnits = 10.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A6", PaperUnits = 1.0, DrawingUnits = 16.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A7", PaperUnits = 1.0, DrawingUnits = 20.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A8", PaperUnits = 1.0, DrawingUnits = 30.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "A9", PaperUnits = 1.0, DrawingUnits = 40.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B0", PaperUnits = 1.0, DrawingUnits = 50.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B1", PaperUnits = 1.0, DrawingUnits = 100.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B2", PaperUnits = 2.0, DrawingUnits = 1.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B3", PaperUnits = 4.0, DrawingUnits = 1.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B4", PaperUnits = 8.0, DrawingUnits = 1.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B5", PaperUnits = 10.0, DrawingUnits = 1.0, IsUnitScale = false });
-			scales.TryAdd(new Scale { Name = "B6", PaperUnits = 100.0, DrawingUnits = 1.0, IsUnitScale = false });
+			root.TryAdd(new CadDictionary(AcadScaleList));
 
 			root.TryAdd(new CadDictionary(AcadVisualStyle));
 			root.TryAdd(new CadDictionary(AcadFieldList));
 			root.TryAdd(new CadDictionary(AcadImageDict));
 
-			CadDictionary materials = root.ensureCadDictionaryExist(AcadMaterial);
-			materials.TryAdd(new Material("Global"));
-			materials.TryAdd(new Material("ByLayer"));
-			materials.TryAdd(new Material("ByBlock"));
+			root.TryAdd(new CadDictionary(AcadMaterial));
 		}
 
 		/// <summary>
@@ -403,17 +374,6 @@ public bool TryGetEntry<T>(string name, out T value)
 			return false;
 		}
 
-		private CadDictionary ensureCadDictionaryExist(string name)
-		{
-			if (!this.TryGetEntry(name, out CadDictionary entry))
-			{
-				entry = new CadDictionary(name);
-				this.Add(entry);
-			}
-
-			return entry;
-		}
-
 		private void onEntryNameChanged(object sender, OnNameChangedArgs e)
 		{
 			var entry = this._entries[e.OldName];

src/ACadSharp/Objects/Collections/DictionaryVariableCollection.cs

@@ -20,7 +20,7 @@ public DictionaryVariableCollection(CadDictionary dictionary) : base(dictionary)
 		/// </summary>
 		/// <param name="name">The name of the variable to add or update. Cannot be null.</param>
 		/// <param name="value">The value to assign to the variable. Can be null.</param>
-		public void AddVariable(string name, string value)
+		public void AddOrUpdateVariable(string name, string value)
 		{
 			if (this.TryGet(name, out DictionaryVariable v))
 			{
@@ -32,6 +32,37 @@ public void AddVariable(string name, string value)
 			}
 		}
 
+		/// <summary>
+		/// Adds a new variable with the specified name and value to the collection if a variable with the same name does not
+		/// already exist.
+		/// </summary>
+		/// <param name="name">The name of the variable to add. Cannot be null or empty.</param>
+		/// <param name="value">The value to assign to the variable. Can be null or empty.</param>
+		public void AddVariable(string name, string value)
+		{
+			if (!this.ContainsKey(name))
+			{
+				this.Add(new DictionaryVariable(name, value));
+			}
+		}
+
+		/// <summary>
+		/// Creates and adds default variables to the collection.
+		/// </summary>
+		/// <remarks>Call this method to ensure that the collection contains the standard default variables.
+		/// Calling this method multiple times has no effect on existing entries.</remarks>
+		public void CreateDefaults()
+		{
+			this.AddVariable(DictionaryVariable.CurrentMultiLeaderStyle, MultiLeaderStyle.DefaultName);
+			this.AddVariable(DictionaryVariable.CurrentAnnotationScale, Scale.DefaultName);
+			this.AddVariable(DictionaryVariable.CurrentTableStyle, TableStyle.DefaultName);
+			this.AddVariable(DictionaryVariable.WipeoutFrame, ((int)WipeoutFrameType.DisplayAndPlotted).ToString());
+
+			//View Section Style object not implemented
+			this.AddVariable("CVIEWDETAILSTYLE", "Metric50");
+			this.AddVariable("CVIEWSECTIONSTYLE", "Metric50");
+		}
+
 		/// <summary>
 		/// Retrieves the value associated with the specified variable name.
 		/// </summary>

src/ACadSharp/Objects/Collections/MLeaderStyleCollection.cs

@@ -1,9 +1,26 @@
 namespace ACadSharp.Objects.Collections
 {
+	/// <summary>
+	/// Represents a collection of <see cref="MultiLeaderStyle"/> objects within a CAD dictionary.
+	/// </summary>
+	/// <remarks>This collection provides access to <see cref="MultiLeaderStyle"/>s stored in the underlying CAD dictionary. It
+	/// enables enumeration, retrieval, and management of <see cref="MultiLeaderStyle"/> definitions used for annotative entities in a
+	/// drawing.</remarks>
 	public class MLeaderStyleCollection : ObjectDictionaryCollection<MultiLeaderStyle>
 	{
+		/// <inheritdoc/>
 		public MLeaderStyleCollection(CadDictionary dictionary) : base(dictionary)
 		{
 		}
+
+		/// <summary>
+		/// Adds the default <see cref="MultiLeaderStyle"/> to the collection if it does not already exist.
+		/// </summary>
+		/// <remarks>Call this method to ensure that the collection contains a default style entry. If the default
+		/// style is already present, this method has no effect.</remarks>
+		public void CreateDefaults()
+		{
+			this._dictionary.TryAdd(MultiLeaderStyle.Default);
+		}
 	}
 }

src/ACadSharp/Objects/Collections/MLineStyleCollection.cs

@@ -1,9 +1,26 @@
 namespace ACadSharp.Objects.Collections
 {
+	/// <summary>
+	/// Represents a collection of <see cref="MLineStyle"/> available in the associated CAD dictionary.
+	/// </summary>
+	/// <remarks>This collection provides access to the set of <see cref="MLineStyle"/> objects defined within a CAD dictionary.
+	/// Use this class to enumerate, retrieve, or manage <see cref="MLineStyle"/> for drawing operations. Changes to the collection
+	/// affect the styles available for multiline entries in the underlying dictionary.</remarks>
 	public class MLineStyleCollection : ObjectDictionaryCollection<MLineStyle>
 	{
+		/// <inheritdoc/>
 		public MLineStyleCollection(CadDictionary dictionary) : base(dictionary)
 		{
 		}
+
+		/// <summary>
+		/// Adds the default <see cref="MLineStyle"/> to the internal collection if it does not already exist.
+		/// </summary>
+		/// <remarks>Call this method to ensure that the collection contains the default multiline style. If the
+		/// default style is already present, this method has no effect.</remarks>
+		public void CreateDefaults()
+		{
+			this._dictionary.TryAdd(MLineStyle.Default);
+		}
 	}
 }

src/ACadSharp/Objects/Collections/MaterialCollection.cs

@@ -1,9 +1,28 @@
 namespace ACadSharp.Objects.Collections
 {
+	/// <summary>
+	/// Represents a collection of <see cref="Material"/> objects stored in a CAD dictionary.
+	/// </summary>
+	/// <remarks>Use this collection to access, add, or remove <see cref="Material"/> instances associated with a CAD document. The
+	/// collection provides dictionary-style access to materials by name.</remarks>
 	public class MaterialCollection : ObjectDictionaryCollection<Material>
 	{
+		/// <inheritdoc/>
 		public MaterialCollection(CadDictionary dictionary) : base(dictionary)
 		{
 		}
+
+		/// <summary>
+		/// Adds the default materials "Global", "ByLayer", and "ByBlock" to the collection if they are not already present.
+		/// </summary>
+		/// <remarks>This method is typically called to ensure that the collection contains the standard default
+		/// materials required for typical usage. If any of the default materials already exist in the collection, they are
+		/// not added again.</remarks>
+		public void CreateDefaults()
+		{
+			this._dictionary.TryAdd(new Material("Global"));
+			this._dictionary.TryAdd(new Material("ByLayer"));
+			this._dictionary.TryAdd(new Material("ByBlock"));
+		}
 	}
 }