HighlightingLoader.Load(XmlReader) mis-parses non-normalizing readers (e.g. XDocument.CreateReader): silently empty main RuleSet, or misleading "Could not find main RuleSet."

Aperta
#454 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
76/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
csharp
Ambito
tooling

Direzione di ricerca

Start at HighlightingLoader.Load(XmlReader), then inspect V2Loader.ParseElements and GetValidatingReader to follow how whitespace and namespace-mismatched nodes are handled. Reproduce the issue with XmlTextReader and XDocument.CreateReader(), including the comment variation; done means both readers preserve the expected rules and comments no longer change the result or trigger the misleading RuleSet error.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

HighlightingLoader.Load(XmlReader, IHighlightingManager) implicitly requires the caller's reader to report insignificant whitespace as XmlNodeType.Whitespace. When it does not — XDocument.CreateReader() (i.e. XDocument / XElement, public API) is the easy way to hit this — the hand-written parser in V2Loader desynchronizes and either returns a definition whose main RuleSet is empty (no exception, Rules.Count == 0, highlighting silently does nothing), or throws HighlightingDefinitionInvalidException: Could not find main RuleSet.

Which one you get depends on the number of whitespace runs / XML comments in the file: adding or removing a single <!-- --> flips the outcome, even though comments are never parsed. The input is fixed, yet the result looks random.

Minimal reproduction

Valid .xshd (loads correctly on its own):

<?xml version="1.0" encoding="utf-8" ?>
<SyntaxDefinition name="CustomVariable Highlighting"
                  xmlns="http://icsharpcode.net/sharpdevelop/syntaxdefinition/2008">
  <!-- this comment is irrelevant to the parser, but changes the outcome -->
  <RuleSet>
    <Keywords foreground="Brown">
      <Word>[V]</Word>
    </Keywords>
    <Rule foreground="Brown" fontWeight="bold">\[(Aux_V_|Aux_T_)([1-9]|[1-5][0-9]|6[0-4])\]</Rule>
  </RuleSet>
</SyntaxDefinition>
// A) WORKS: Rules.Count == 3
using (Stream s = asm.GetManifestResourceStream("...CustomVariableHighlighting.xshd"))
using (XmlReader r = new XmlTextReader(s))
    def = HighlightingLoader.Load(r, HighlightingManager.Instance);

// B) BROKEN: Rules.Count == 0, no exception
//    (with one extra <!-- ... --> in the file: throws "Could not find main RuleSet.")
using (Stream s = asm.GetManifestResourceStream("...CustomVariableHighlighting.xshd"))
{
    XDocument doc = XDocument.Load(new XmlTextReader(s));
    def = HighlightingLoader.Load(doc.CreateReader(), HighlightingManager.Instance);
}

Identical bytes, only the reader differs: A → 3 rules, B → 0.

Root cause
  1. XDocument.CreateReader() returns an XNodeReader that reports whitespace-only text as XmlNodeType.Text, not Whitespace. A node dump shows one such node per indentation run (d1 Text <> NS=[] val=[\r\n\t], d2 Text <> NS=[] val=[\r\n\t\t], …); with XmlTextReader the same document produces zero such nodes.

  2. GetValidatingReader wraps the caller's reader with XmlReaderSettings { IgnoreComments = true, IgnoreWhitespace = true, ValidationType = Schema, Schemas = ModeV2 }. IgnoreWhitespace discards only nodes whose NodeType is Whitespace, so for a non-normalizing reader it is a no-op and every indentation run reaches the parser. (IgnoreComments does drop comments — but each comment splits the surrounding whitespace into two text runs, which is exactly why the comment count changes the outcome.)

  3. V2Loader.ParseElements calls reader.Skip() for every node whose NamespaceURI != Namespace, inside while (reader.Read() && reader.NodeType != XmlNodeType.EndElement). Text nodes have an empty namespace, so every whitespace node takes the Skip() branch; Skip() on a non-element node is just a Read(), and the loop Read()s again at the top of the next iteration. Two node positions are consumed per iteration, so element start tags are stepped over and never become the current node (they are only "hit" when the parity happens to line up).

  4. Consequences:

    • parity "hits" <RuleSet>, but all children are consumed as text siblings → XshdRuleSet.Elements empty → main RuleSet with zero rules → no exception, no highlighting;
    • one extra whitespace/comment node shifts parity by one → the <RuleSet> start tag itself is stepped over → no unnamed RuleSet in def.Elements → throw new HighlightingDefinitionInvalidException("Could not find main RuleSet.").

Single-step trace (V2Loader's state machine replicated verbatim, run on the wrapped reader of case B):

ParseDefinition at Element <SyntaxDefinition> d0
<def.Elements>: enter ParseElements
  NS-MISMATCH -> Skip: Text <> d1 val=[\r\n\t]
  PARSE RuleSet: Element <RuleSet> d1
    <RuleSet.Elements>: enter ParseElements
      NS-MISMATCH -> Skip: Text <> d2 val=[\r\n\t\t]
      NS-MISMATCH -> Skip: Text <> d3 val=[\r\n\t\t\t]
      ...
      <RuleSet.Elements> loop EXIT at EOF -> parsed 0 V2 elements
<def.Elements> loop EXIT at EOF -> parsed 1 V2 elements

With one extra <!-- --> in the same file the PARSE RuleSet line never appears and the log ends with <def.Elements> ... parsed 0 → the exception.

Why this looks like a library-side bug
  • The Load(XmlReader) contract is not documented as "the reader must normalize whitespace", and returning Text for whitespace-only content is legal for an XmlReader — XNodeReader does exactly that.
  • One branch fails silently (0 rules, no exception), so users only see "highlighting doesn't work"; the other blames an innocent "main RuleSet" that is present in the file.
  • The outcome changes when an XML comment is added. A parser should be immune to that — this is what made the bug so expensive to find.
Suggested fixes (any one closes it)
  1. Only skip element nodes in the namespace check:
if (reader.NodeType == XmlNodeType.Element && reader.NamespaceURI != Namespace)
{
    if (!reader.IsEmptyElement) reader.Skip();
    continue;
}

A non-element node then falls through the loop and costs only the single Read() it is supposed to cost, keeping alignment intact.

  1. Or harden GetValidatingReader: filter whitespace-only Text/SignificantWhitespace nodes coming from the inner reader (a small delegating XmlReader). The parser only cares about significant content, so that is the safest place to normalize.

  2. Or improve diagnostics: when no unnamed RuleSet is found, report the parsed element count and hint that the input reader must normalize whitespace (or fall back to the first RuleSet with a warning). The current message sends users hunting in the wrong place.

Workaround for anyone hitting this
var ms = new MemoryStream();
doc.Save(ms);
ms.Position = 0;
using (var reader = new XmlTextReader(ms))
    definition = HighlightingLoader.Load(reader, HighlightingManager.Instance);

Verified: 3 rules for the file above, 4 rules after appending a rule via XElement.Add.

Happy to attach the standalone repro harness (a small .cs that dumps both node streams and runs the replicated state machine) and the raw logs. Thanks for the library — this is the only issue we have hit in years of using it.

Lingua principale
C#
Stelle
2.1k
Fork
496
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di icsharpcode/AvalonEdit

Tutte le issue di icsharpcode/AvalonEdit

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.