Dec v0.7.1

Added

• Proper support for Nullable.
• Bespoke_KeyTypeDict() parameter for Recorder which allows dictionary key fields to be implicitly treated as class tags for their values. This will be removed once I've figured out a more general way to support this.

Fixed

• Type parse cache bug that could cause non-arrays to be incorrectly parsed as arrays.
• Cloning an object with a factory that depends on a non-shared recorded object can, if the stack depth is too deep, result in the non-shared recorded object not yet being ready.
• Decs that are also IRecordable cause errors when referenced in other Decs.
• Security issue: XML documents could cause arbitrary HTTP requests.

Dec v0.7.0

Added

• New Recorder.WriteSimple()/ReadSimple() modes that produce much simpler XML, at the cost of no references.
• Type parsing now accepts curly braces in place of generic angle braces, in order to make XML easier to write.
• Decs can now include class tags, if you need to specify a type that doesn't work as an XML node name.

Breaking

• Bespoke.IgnoreRecordDuringParserAttribute has been removed in favor of IConditionalRecorder. If you want a version that supports both for ease of porting, check out v0.6.0.

Improved

• Documentation regarding Recorder load order.

Fixed

• RecorderEnumerator: List.Enumerator would not properly serialize if the enumerator was empty.
• RecorderEnumerator: Recordable Closures did not serialize properly if they were created in a generic function.

Testing

• Added a small test.

Dec v0.6.0

Added

• Added IUserSettings, which is passed throughout the Dec system and can be used to change the behavior of Parser and Recorder.
• Added IConditionalRecorder, which can be used to conditionally record objects.
• CloneWithAssignmentAttribute can now be used to specify that objects can be cloned with basic assignment, speeding up array cloning considerably.
• IPostCloneOriginal/IPostCloneNew interfaces that can be used to perform post-clone operations on objects.
• Converter.TreatAsValuelike() which can be used to treat any type like a valuelike. See documentation for details.

Breaking

• Ignoring provided fields in a Recorder is now considered a warning. Use the new recorder.Ignore() method to explicitly suppress this warning for a field.
• Extra RecorderEnumerator's RecordableClosures attribute now needs to be applied to the class instead of the function (but you weren't using this yet, right?)

Obsoleted

• Bespoke.IgnoreRecordDuringParserAttribute has been obsoleted in favor of IConditionalRecorder. It remains in the codebase for now but will be removed in the future.

Improved

• Major revamp of Recorder.Clone functionality to dramatically improve performance (approx 200x in one real-life test case.)
• Recorder no longer depends on Parser.Finish() to find Converters.
• Better support for parallel operations in multiple threads (but not Parser.)
• Fleshed out an error message.

Fixed

• Inconsistent behavior in Extra RecorderEnumerator Delegate deserialization. (Hopefully.)
• Improper storage of this with Extra RecorderEnumerator iterators.
• Unexpected shrapnel caused by the above two fixes.

Testing

• Improved consistency of a few tests.

Dec v0.5.3

Added

• Proper support for multidimensional arrays.

Possibly Breaking

• Changed default culture from en-US to InvariantCulture. I don't think this should have any effects given the manual string parsing for Infinity, but I may be missing something; report problems, please.

Improved

• Error messages for database queries interacting with AbstractAttribute.
• Error message for inappropriately-timed StaticReferences initialization.
• More consistent usage of the Dec.Config culture.
• Support case-insensitive nan/infinity float/double parsing.

Testing

• Added proper testing for AbstractAttribute.
• Add a self-reference test that might be redundant.

Dec v0.5.2

Added

• Now properly serializes NaN-boxed floats and doubles without loss of information.

Improved

• Error messages when passing null or empty strings to Parser.
• Project configuration revamp to follow established standards for framework choice.
• Better error reporting for Converter read exceptions.
• Tagged an internal-error message as an internal error.
• Error message when attempting to use a class that doesn't inherit from Dec as a Dec.

Fixed

• A lot of warnings.
• TypeSerialization.Overloaded test inconsistencies.

Dec v0.5.1

Notes

• Despite the length of this changelog, this is mostly minor bugfixes and documentation. The "big feature" is an Extra package that I do not recommend using in production until it has a lot more work.

Added

• Converters now support generic arguments; they must be converting a generic with the same number of arguments in the same order. This might get changed later.
• Recorder.Clone() function to duplicate objects.
• Added the first extra package, recorder_enumerator, capable of serializing and deserializing both Linq and user-defined enumerators mid-iteration.
• Added support for Stack and Queue.

Breaking

• Type parsing system no longer supports + separator for nested types, but it never wrote these in the first place, so this shouldn't be a big problem. If you have to edit some xml files, sorry 'bout that, this was an oversight.

Improved

• Improved error message when trying to initialize a composite with a string.
• First-time Parser startup speed now faster.
• Type parsing system now properly supports generic nested types of generics.
• User-types now don't include anything under the Dec namespace.

Fixed

• Type caching system no longer results in silent errors.
• Missing Mode property on Recorder.Parameters.
• bool not recognized as a primitive type.

Testing

• Made test harness more durable regarding errors happening during parsing.
• Fixed a test that was accidentally testing the wrong thing.
• Detect internal errors and report them as true test failures, even if a failure was expected.
• Added an integration-unified test for the case where people are just copypasting source files into their project.
• Improved testing of locale issues.
• Reduced compiler warnings in test suite.

Dec v0.5.0

Added

• ParserModular, a more complicated parser that supports game mods.
• A large number of new merge modes intended for game modding.

Breaking

• Minor changes to Parser API to cleanly support more file types.

Documentation

• Picked a more modern and less awkwardly stifling visual style.

Fixed

• Minor errors in several error messages.
• Comment typos in unit tests.

Testing

• Added internal validation checks.
• Better coverage in various areas.

Dec v0.4.0

Breaking

• Recorder no longer shares class references by default. The new .Shared() recorder decorator can be used to allow this, although it will error on non-null defaults.
• Converter has been split into ConverterString, ConverterRecord, and ConverterFactory.

Improved

• RecordAsThis() does not (and currently cannot) work on a polymorphic object; document this and explicitly report it as an error.

Changed

• Recorder now defaults to not doing pretty-print.

Fixed

• Failed ref instantiations can later cause unhandled exceptions.
• Recorder breaks when trying to deal with multiply referenced Array objects.
• Various problems with both Visual Studio compatibility and VS Code compatibility.
• Fixed a variety of obscure errors with shared objects.

Documentation

• Fixed typos.

Testing

• Better diagnostic output on missing expected errors.
• Added more thorough tests for sharing.

Dec v0.3.5

Added

• Added Bespoke.IgnoreRecordDuringParserAttribute, which provides special-purpose functionality that will be rolled into an eventual Converter redesign.
• Added system-wide CultureInfo support so your games stop breaking in France.

Improved

• Better text quoting among many error messages.
• Dec.ToString() now returns type data as well.
• Better error message if attempting to Record a never-registered Dec.
• Better error messages and recovery on errors with key and value elements in <li> Dictionary lists.
• Better error message for capitalization in <li> tags.

Fixed

• Parser.LoadDirectory's prefix filtering breaks if given a directory that includes . or ...
• RecordAsThis documentation refers to code that is no longer an example.

Documentation

• Fixed broken relative links.
• Fixed commandline parameter that docfx originally misspelled and finally dropped support for.

Testing

• Added tests for a few edge cases (none of which were actually broken, as it turned out.)

Dec v0.3.4

Fixed

• Recording a referenced object that would otherwise need a class tag results in an invalid (but still readable) file.
• Errors when multiple Decs inherit from a Dec with attributes on its members.
• Documentation crosslink error.

Improved

• Better error message when failing to find a Dec.
• Better error messages when failing to load StaticReferences.
• Better error message when parsing a Dec without a decName.

Changed

• Private constructors are now considered valid to use.

Documentation

• Fix incorrect tl;dr instructions.
• Improve tl;dr instructions.
• Connect the Inheritance documentation to the Merge Mode documentation.
• Rewrite Index documentation.
• Added clarity regarding the interaction between NonSerialized and Recorder.

Breaking

• Parser.LoadDirectory no longer loads files or directories with . prefixes.