// This file is part of YamlDotNet - A .NET library for YAML. // Copyright (c) Antoine Aubry and contributors // // Permission is hereby granted, free of charge, to any person obtaining a copy of // this software and associated documentation files (the "Software"), to deal in // the Software without restriction, including without limitation the rights to // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies // of the Software, and to permit persons to whom the Software is furnished to do // so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. using System; namespace YamlDotNet.Core { public sealed class EmitterSettings { /// /// The preferred indentation. /// public int BestIndent { get; } = 2; /// /// The preferred text width. /// public int BestWidth { get; } = int.MaxValue; /// /// If true, write the output in canonical form. /// public bool IsCanonical { get; } = false; /// /// If true, write output without anchor names. /// public bool SkipAnchorName { get; private set; } /// /// The maximum allowed length for simple keys. /// /// /// The specifiction mandates 1024 characters, but any desired value may be used. /// public int MaxSimpleKeyLength { get; } = 1024; /// /// Indent sequences. The default is to not indent. /// public bool IndentSequences { get; } = false; public static readonly EmitterSettings Default = new EmitterSettings(); public EmitterSettings() { } public EmitterSettings(int bestIndent, int bestWidth, bool isCanonical, int maxSimpleKeyLength, bool skipAnchorName = false, bool indentSequences = false) { if (bestIndent < 2 || bestIndent > 9) { throw new ArgumentOutOfRangeException(nameof(bestIndent), $"BestIndent must be between 2 and 9, inclusive"); } if (bestWidth <= bestIndent * 2) { throw new ArgumentOutOfRangeException(nameof(bestWidth), "BestWidth must be greater than BestIndent x 2."); } if (maxSimpleKeyLength < 0) { throw new ArgumentOutOfRangeException(nameof(maxSimpleKeyLength), "MaxSimpleKeyLength must be >= 0"); } BestIndent = bestIndent; BestWidth = bestWidth; IsCanonical = isCanonical; MaxSimpleKeyLength = maxSimpleKeyLength; SkipAnchorName = skipAnchorName; IndentSequences = indentSequences; } public EmitterSettings WithBestIndent(int bestIndent) { return new EmitterSettings( bestIndent, BestWidth, IsCanonical, MaxSimpleKeyLength, SkipAnchorName ); } public EmitterSettings WithBestWidth(int bestWidth) { return new EmitterSettings( BestIndent, bestWidth, IsCanonical, MaxSimpleKeyLength, SkipAnchorName ); } public EmitterSettings WithMaxSimpleKeyLength(int maxSimpleKeyLength) { return new EmitterSettings( BestIndent, BestWidth, IsCanonical, maxSimpleKeyLength, SkipAnchorName ); } public EmitterSettings Canonical() { return new EmitterSettings( BestIndent, BestWidth, true, MaxSimpleKeyLength, SkipAnchorName ); } public EmitterSettings WithoutAnchorName() { return new EmitterSettings( BestIndent, BestWidth, IsCanonical, MaxSimpleKeyLength, true ); } public EmitterSettings WithIndentedSequences() { return new EmitterSettings( BestIndent, BestWidth, IsCanonical, MaxSimpleKeyLength, SkipAnchorName, true ); } } }