fsCRunningOrderGrammar.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCRunningOrderGrammar.h
*
*       Purpose:        Parse + resolve for the consolidated runningOrder.gui
*                               (RUNNING_ORDER_GUI_PLAN.md Phase 4). A `.gui` running
*                               order holds the whole sequence plus each scene's config,
*                               with editions/languages as `exclude` membership tags and
*                               shared config hoisted into `default <group>` blocks.
*
*                               This is NOT the GUI parser (fsIGuiComponent::parseToTree):
*                               running-order tokens are scene names, not registered
*                               component types, so that parser can't build this tree. It
*                               is an engine-free port of the tooling resolver
*                               (gui-grammar-tool/src/running_order.rs), verified against
*                               tests/gui_grammar_golden_corpus/running_order.
*
*********************************************************************/
 
#ifndef fsCRunningOrderGrammarhdr
#define fsCRunningOrderGrammarhdr
 
#include <vector>
 
#include <fsCore/fsStr.h>
#include <fsCore/src/fsCVariableTable.h> // VarTableMap
 
namespace fsCRunningOrderGrammar
{
 
struct ResolvedScene
{
        fsStr mName;
        VarTableMap mConfig; // keys in source case (loader is case-sensitive), layered default* -> group -> own
        // Reached via the map screen first. Derived, not stored: true for every
        // map-routed HOG room - a numHogItems scene in the `normal` group (prefix-
        // less or sequence-numbered like `01_`) - except the first in the sequence.
        // Minigames, link/end, and alphabetically-prefixed direct-access HOGs
        // (`hog_`) are never map-first. Only the HOG genre acts on it (see
        // fsIRunningOrder's map-navigation gate).
        fsBool mGoesToMap = false;
};
 
// Parse pText and resolve for (pFlavour, pLanguage): filter entries whose
// `exclude` tags match, layer each surviving scene's config
// `default * -> default <group> -> own` (last-set-wins, keys in source case),
// and derive mGoesToMap. pFlavour is "standard"/"collectors"; pLanguage is
// the locale code ("en"/"de"/...). Entries keep declaration order.
std::vector<ResolvedScene> resolve(const fsStr& pText, const fsStr& pFlavour, const fsStr& pLanguage);
 
} // namespace fsCRunningOrderGrammar
 
#endif