fsCGuiParseTree.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCGuiParseTree.h
*
*       Purpose:        Neutral, engine-free representation of a parsed GUI
*                               layout file, produced by fsIGuiComponent::parseToTree()
*                               and consumed by fsIGuiComponent::constructFromTree().
*                               Same shape as the Rust port's GuiComponentRef so the
*                               two can be diffed against one another.
*
*********************************************************************/
 
#ifndef fsCGuiParseTreehdr
#define fsCGuiParseTreehdr
 
#include <map>
#include <memory>
#include <vector>
 
#include <fsCore/fsStr.h>
 
struct fsCGuiParseNode
{
        fsStr mComponentTypeName;
        fsCGuiParseNode* mParent;
        std::map<fsStr, fsStr> mParams;
        std::vector<std::unique_ptr<fsCGuiParseNode>> mChildren;
 
        fsCGuiParseNode(const fsStr& pComponentTypeName, fsCGuiParseNode* pParent) :
                mComponentTypeName(pComponentTypeName),
                mParent(pParent)
        {
        }
};
 
// A layout file's commands can contain more than one top-level element
// (only the last one is treated as "the" gui by callers) so the tree
// keeps every root in file order rather than assuming exactly one.
struct fsCGuiParseTree
{
        std::vector<std::unique_ptr<fsCGuiParseNode>> mRoots;
};
 
#endif