EnC: Tweak handling of out-of-sync documents to work around source file content inconsistencies (#40947)

* Do not block in presence of out-of-sync documents.

Instead, ignore any changes made to these documents while debugging until their content matches the source used to build the baseline DLL.

* Only check output PDB, not debugger SymReader, for document checksums.
Turns out SymReader does not support reading document checksums once EnC changes have been applied.

Better handle errors that might occur when validating checksums. Previously some of the errors were not reported as diagnostics.

We previously blocked EnC when we observed a source file that is out-of-sync (i.e. its current content does not match the checksum in the originally built PDB). We can however just ignore these files and report a warning that changes made to this file won’t be applied until the file content is reverted back to the state it was when the PDB was built (the file transitions to “matching” state). Once a file is in matching state it can’t change back to another state. We know that we have not applied any change to the code that was compiled from the file because we ignored the file while it was in out-of-sync state. Therefore we know that any changes made from now on can be safely applied to the debuggee.

If we can’t determine whether a file matches or not due to error reading the PDB or the source file content we can treat it similarly to out-of-sync file. That is, ignore any changes until we are able to confirm the file matches. That can happen if, e.g. the PDB is temporarily locked by another process and unlocked later.

Simplify implementation of GetStatusAsync.

Fixes VSO [1051496](https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1051496) ([VS feedback](https://developercommunity.visualstudio.com/content/problem/880533/edits-were-made-which-cannot-be-compiled-stop-debu.html))

* Refactoring

* Refactoring

* Refactoring

* Feedback

* Misc feedback

* Use ValueTask instead of custom task caching

* Remove BaseSolution property

* Refactor GetAllAddedSymbolsAsync

* Track documents that do not match the debuggee

* Handle design-time-only documents and documents with no sequence points

* EnC: fix handing added and design-time-only files

* Fix nullability warnings

* Fix nullable warning

Fixes internal TFS bug 1142095

Commit any existing rename session when a document is saved or when
debugging run mode is entered. This ensures rename sessions are
completed before Edit and Continue sets the buffers to readonly when
debugging begins or when break mode is exited.

All documents of regular running projects are read-only until the debugger breaks the app. However, Dev12 allows Razor views to be editable while the code is running and get refreshed next time the web page is hit. This PR supports the same behavior as in Dev12 by not setting Razor-like files (cshtml/aspx) read-only.

     Background:

     As discussed in the dev team all hands all code under the GitHub dotnet foundation is using a single process for contribution, API review, infrastructure and coding style. The idea is to present a unified view to our customer and give them a single story for contributing to any project under the dotnet foundation.

     https://github.com/dotnet/corefx/wiki/Contributing#c-coding-style

     The coding style transition is automated using a Roslyn based rewrite tool:

     https://github.com/dotnet/codeformatter

     This will be applied in stages across our developer tree. Right now the focus is on the Open directory as this is what is being presented on github. Code owners will be contacted before the transition happens.

     Note: this is a soft style requirement. There are no build errors that come from this change.
 (changeset 1408227)