Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement text KeyValues 3 #61

Draft
wants to merge 49 commits into
base: master
Choose a base branch
from
Draft

Implement text KeyValues 3 #61

wants to merge 49 commits into from

Conversation

xPaw
Copy link
Member

@xPaw xPaw commented Oct 1, 2022 •
edited

  • Flagged values
    • Add Flag to KVValue for flagged strings (text) or flagged anything (binary)
    • Ensure that KV1 serialiser drops the flag when serialising (should happen by default, but check / write unit test)
    • Ensure that flag and value is maintained when deserialising to a strongly-typed object model that has a KVValue field/property.
  • Create KV3 text deserializer
  • Create KV3 text serializer
  • Write tests for converting KV3 to KV1
  • Write tests for converting KV1 to KV3
  • Support null type
  • Support different types of root values (arrays, strings, nulls, etc)
    • This partially works but a few things don't like value flags and arrays.
  • Add support for accessing and setting header encoding/format. We will likely need a breaking change for deserialize method to return some kind of KV file object, rather than KVObject directly. This KVFile object will likely be needed for KV2 implementation too.
  • Better support for arrays
  • Verify whether latest Source2 versions still support multiple flags at once (might have been removed)

@xPaw xPaw added this to In Progress in Key Values 3 via automation Oct 1, 2022
@xPaw xPaw removed the hacktoberfest label Oct 2, 2022
@xPaw
Copy link
Member Author

xPaw commented Oct 23, 2022

@yaakov-h Can you give this an initial review pass? I especially want to hear about stuff around handling arrays and flags.

@xPaw xPaw linked an issue Dec 5, 2022 that may be closed by this pull request
Implement KeyValues3 (Text) #5
Open
@xPaw xPaw mentioned this pull request Dec 5, 2022
Open
@xPaw xPaw mentioned this pull request Dec 25, 2022
Open
@xPaw
still check for :
f8c0d44
@xPaw
Remove InObjectBeforeValue state
ca0d158
@xPaw
Write quoted keys when necessary; test objects
30378fb
@xPaw
Support escaping """
c087db8
@xPaw
Parse binary blobs
999d8a3
@xPaw
Changes for array
5dc8e07
@xPaw
Add OnArrayStart/OnArrayEnd
8325318
@xPaw
Fix nested objects/arrays in arrays
7e9745c
@xPaw
Some preparation for kv flags
914b273
@xPaw
Implement flags on objects/arrays
771c7db
@xPaw
Serialize arrays and flags
623174b
@xPaw
Test that we serialize to kv1 without flags and arrays
38802eb
@xPaw
Add expected array serialization
4d96f4c
@xPaw
Simplify
048513f
@xPaw
Put common token reader methods in one class
eae477d
@xPaw
Put commas after objects and arrays in arrays
749a436
@xPaw
Implement binary blobs
1f02799
@xPaw
Remove unused usings
43a89dc
@xPaw
Add test for nested arrays and objects
91b3e3e
@xPaw
Implement ICollection/IList on KVArrayValue
e186127
@xPaw
Return KVFile from read header
ea6c2b0
@xPaw
Asset.Pass breaks analyzer
1b248ae
@xPaw
Add test cases for different types of roots
6e0bed3
@xPaw
Add kv1 -> kv3 test
66e3bd5
@xPaw
Improve kv3 key escaping
e4cf8fc
@xPaw
Make KVFile extend KVObject
c298a54
@xPaw
Make KVFlag singular
49a7c7d
@xPaw
Rebase
bc47917
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kristiker kristiker kristiker left review comments

Assignees
No one assigned
Labels
enhancement
Projects
Key Values 3
Status: In Progress
Key Values 3
  
In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement KeyValues3 (Text)
2 participants
@xPaw @kristiker