Tweet
Tweet

Slide 1

Slide 1 text

Miklos Vajna Software Engineer vmiklos@collabora.com 2024-04-09 Tips for debugging your text documents

Slide 2

Slide 2 text

2/7 Document model level ● Can check what’s inside the C++ structures in the memory ● Set SW_DEBUG=1, then Shift-F12 produces a nodes.xml

Slide 3

Slide 3 text

3/7 UNO API level ● UNO API is visible to scripting, can write e.g. a (Python) macro ● Tools → Development tools in Collabora Office

Slide 4

Slide 4 text

4/7 DOCX import level ● DOCX import works by producing tokens, SW_DEBUG_WRITERFILTER=1 to see them in /tmp as a dump ● Based on that, it’s possible to decide if the bug is in the tokenizer or in the mapper (to UNO API calls)

Slide 5

Slide 5 text

5/7 Layout level ● Can check what’s inside the frames in the memory ● Set SW_DEBUG=1, then F12 produces a layout.xml

Slide 6

Slide 6 text

6/7 UI / Online level ● Can check outgoing protocol messages ● Can verify incoming responses

Slide 7

Slide 7 text

7/7 Summary ● Debugging text documents start with finding which layer has the problematic behaviour: need to go wide ● Once that area is known, can go deep in that layer ● Minimal, public reproducer documents are great ● Always solve the root cause, it pays off in the long run