XML Format for Outline Parser

This article describes format of XML files to be used with CBCGPOutlineParser and auto-outlining feature of the edit control. The XML parser is invoked by calling to CBCGPEditCtrl::LoadOutlineParserXMLSettings.

The structure used for the outline parser is following:

<SETTINGS>
    <OUTLINE_DATA>
        <IgnoreOneLineBlocks></IgnoreOneLineBlocks>
        <EscapeSequences>
            <EscapeSequence></EscapeSequence>
        </EscapeSequences>

        <BLOCKS>
            <BLOCK>
                <Start></Start>
                <End></End>
                <ReplaceString></ReplaceString>
                <AllowNestedBlocks></AllowNestedBlocks>
                <Ignore></Ignore>
            </BLOCK>
        </BLOCKS>
    </OUTLINE_DATA>
</SETTINGS>

There are no mandatory tags except the main "SETTINGS" tag.

"OUTLINE_DATA" tag defines general outline parser settings.

• "IgnoreOneLineBlocks" tag defines whether the edit control should consider one line blocks as collapsible or not. "False" by default
• "EscapeSequences" tag defines a list of escape sequences.
• "EscapeSequence" tag represents a single escape sequence.
• "BLOCKS" tag is intended for syntax definitions of the language. Each block specifies the rule how the outline parser found the outline collapsible region. It's usable when you need to define a set of automatic outlining regions of the same language syntax block. For each block the XML parser will call CBCGPOutlineParser::AddBlockType.
• "BLOCK" tag represents a single block.
  • "Start" - defines BlockType::m_strOpen
  • "End" - defines BlockType::m_strClose
  • "ReplaceString" - defines BlockType::m_strReplace, "..." by default
  • "AllowNestedBlocks" - defines BlockType::m_bAllowNestedBlocks, "True" by default
  • "Ignore" - defines BlockType::m_bIgnore, "False" by default

Default XML settings for C++:

<SETTINGS>
    <OUTLINE_DATA>
        <IgnoreOneLineBlocks>True</IgnoreOneLineBlocks>
        <IncludeSpaceLines>True</IncludeSpaceLines>
        <EscapeSequences>
            <EscapeSequence>\\\"</EscapeSequence>
        </EscapeSequences>
        <BLOCKS>
            <BLOCK>
                <Start>\\\"</Start>
                <End></End>
                <ReplaceString></ReplaceString>
                <AllowNestedBlocks>False</AllowNestedBlocks>
                <Ignore>True</Ignore>
            </BLOCK>

            <BLOCK>
                <Start>\"</Start>
                <End>\"</End>
                <ReplaceString>\"\"</ReplaceString>
                <AllowNestedBlocks>False</AllowNestedBlocks>
                <Ignore>True</Ignore>
            </BLOCK>

            <BLOCK>
                <Start>{</Start>
                <End>}</End>
                <ReplaceString>..</ReplaceString>
                <KEYWORDS>
                    <Keyword>else</Keyword>
                    <Keyword>struct</Keyword>
                    <Keyword>enum</Keyword>
                    <Keyword>switch</Keyword>
                    <Keyword>catch</Keyword>
                    <Keyword>try</Keyword>
                    <Keyword>for</Keyword>
                    <Keyword>operator</Keyword>
                    <Keyword>class</Keyword>
                    <Keyword>if</Keyword>
                    <Keyword>union</Keyword>
                    <Keyword>do</Keyword>
                    <Keyword>while</Keyword>
                    <Keyword>namespace</Keyword>
                </KEYWORDS>
            </BLOCK>

            <BLOCK>
                <Start>{</Start>
                <End>}</End>
                <ReplaceString>...</ReplaceString>
            </BLOCK>

            <BLOCK>
                <Start>//</Start>
                <End>\n</End>
                <ReplaceString>/**/</ReplaceString>
                <AllowNestedBlocks>False</AllowNestedBlocks>
            </BLOCK>

            <BLOCK>
                <Start>/*</Start>
                <End>*/</End>
                <ReplaceString>/**/</ReplaceString>
                <AllowNestedBlocks>False</AllowNestedBlocks>
            </BLOCK>
        </BLOCKS>
    </OUTLINE_DATA>
</SETTINGS>