/* ** menudef.cpp ** MENUDEF parser amd menu generation code ** **--------------------------------------------------------------------------- ** Copyright 2010 Christoph Oelckers ** All rights reserved. ** ** Redistribution and use in source and binary forms, with or without ** modification, are permitted provided that the following conditions ** are met: ** ** 1. Redistributions of source code must retain the above copyright ** notice, this list of conditions and the following disclaimer. ** 2. Redistributions in binary form must reproduce the above copyright ** notice, this list of conditions and the following disclaimer in the ** documentation and/or other materials provided with the distribution. ** 3. The name of the author may not be used to endorse or promote products ** derived from this software without specific prior written permission. ** ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR ** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, ** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT ** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF ** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. **--------------------------------------------------------------------------- ** */ #include #include "menu.h" #include "filesystem.h" #include "c_bind.h" #include "i_music.h" #include "i_sound.h" #include "cmdlib.h" #include "vm.h" #include "types.h" #include "m_argv.h" #include "i_soundfont.h" #include "i_system.h" #include "v_video.h" #include "gstrings.h" #include #include "texturemanager.h" #include "printf.h" #include "i_interface.h" bool CheckSkipGameOptionBlock(FScanner& sc); MenuDescriptorList MenuDescriptors; static DListMenuDescriptor *DefaultListMenuSettings; // contains common settings for all list menus static DOptionMenuDescriptor *DefaultOptionMenuSettings; // contains common settings for all Option menus FOptionMenuSettings OptionSettings; FOptionMap OptionValues; bool mustPrintErrors; PClass *DefaultListMenuClass; PClass *DefaultOptionMenuClass; void I_BuildALDeviceList(FOptionValues *opt); void I_BuildALResamplersList(FOptionValues *opt); DEFINE_GLOBAL_NAMED(OptionSettings, OptionMenuSettings) DEFINE_ACTION_FUNCTION(FOptionValues, GetCount) { PARAM_PROLOGUE; PARAM_NAME(grp); int cnt = 0; FOptionValues **pGrp = OptionValues.CheckKey(grp); if (pGrp != nullptr) { cnt = (*pGrp)->mValues.Size(); } ACTION_RETURN_INT(cnt); } DEFINE_ACTION_FUNCTION(FOptionValues, GetValue) { PARAM_PROLOGUE; PARAM_NAME(grp); PARAM_UINT(index); double val = 0; FOptionValues **pGrp = OptionValues.CheckKey(grp); if (pGrp != nullptr) { if (index < (*pGrp)->mValues.Size()) { val = (*pGrp)->mValues[index].Value; } } ACTION_RETURN_FLOAT(val); } DEFINE_ACTION_FUNCTION(FOptionValues, GetTextValue) { PARAM_PROLOGUE; PARAM_NAME(grp); PARAM_UINT(index); FString val; FOptionValues **pGrp = OptionValues.CheckKey(grp); if (pGrp != nullptr) { if (index < (*pGrp)->mValues.Size()) { val = (*pGrp)->mValues[index].TextValue; } } ACTION_RETURN_STRING(val); } DEFINE_ACTION_FUNCTION(FOptionValues, GetText) { PARAM_PROLOGUE; PARAM_NAME(grp); PARAM_UINT(index); FString val; FOptionValues **pGrp = OptionValues.CheckKey(grp); if (pGrp != nullptr) { if (index < (*pGrp)->mValues.Size()) { val = (*pGrp)->mValues[index].Text; } } ACTION_RETURN_STRING(val); } void DeinitMenus() { M_ClearMenus(); { FOptionMap::Iterator it(OptionValues); FOptionMap::Pair *pair; while (it.NextPair(pair)) { delete pair->Value; pair->Value = nullptr; } } if (menuDelegate) { menuDelegate->Destroy(); menuDelegate = nullptr; } MenuDescriptors.Clear(); OptionValues.Clear(); } FTextureID GetMenuTexture(const char* const name) { const FTextureID texture = TexMan.CheckForTexture(name, ETextureType::MiscPatch); if (!texture.Exists() && mustPrintErrors) { Printf("Missing menu texture: \"%s\"\n", name); } return texture; } //============================================================================= // // // //============================================================================= static void SkipSubBlock(FScanner &sc) { sc.MustGetStringName("{"); sc.SkipToEndOfBlock(); } //============================================================================= // // // //============================================================================= static bool CheckSkipGameBlock(FScanner &sc, bool yes = true) { bool filter = false; sc.MustGetStringName("("); do { sc.MustGetString(); if (sysCallbacks.CheckGame) filter |= sysCallbacks.CheckGame(sc.String); } while (sc.CheckString(",")); sc.MustGetStringName(")"); if (filter != yes) { SkipSubBlock(sc); return !sc.CheckString("else"); } return false; } //============================================================================= // // // //============================================================================= static bool CheckSkipOptionBlock(FScanner &sc) { bool filter = false; sc.MustGetStringName("("); do { sc.MustGetString(); if (sysCallbacks.CheckMenudefOption && sysCallbacks.CheckMenudefOption(sc.String)) filter = true; else if (sc.Compare("Windows")) { #ifdef _WIN32 filter = true; #endif } else if (sc.Compare("unix")) { #ifdef __unix__ filter = true; #endif } else if (sc.Compare("Mac")) { #ifdef __APPLE__ filter = true; #endif } else if (sc.Compare("OpenAL")) { filter |= IsOpenALPresent(); } else if (sc.Compare("MMX")) { #ifdef HAVE_MMX filter = true; #endif } else if (sc.Compare("SWRender")) { #ifndef NO_SWRENDERER filter = true; #endif } } while (sc.CheckString(",")); sc.MustGetStringName(")"); if (!filter) { SkipSubBlock(sc); return !sc.CheckString("else"); } return false; } //============================================================================= // // // //============================================================================= static void DoParseListMenuBody(FScanner &sc, DListMenuDescriptor *desc, bool &sizecompatible, int insertIndex) { sc.MustGetStringName("{"); while (!sc.CheckString("}")) { sc.MustGetString(); if (sc.Compare("else")) { SkipSubBlock(sc); } else if (sc.Compare("ifgame")) { if (!CheckSkipGameBlock(sc)) { // recursively parse sub-block DoParseListMenuBody(sc, desc, sizecompatible, insertIndex); } } else if (sc.Compare("ifnotgame")) { if (!CheckSkipGameBlock(sc, false)) { // recursively parse sub-block DoParseListMenuBody(sc, desc, sizecompatible, insertIndex); } } else if (sc.Compare("ifoption")) { if (!CheckSkipOptionBlock(sc)) { // recursively parse sub-block DoParseListMenuBody(sc, desc, sizecompatible, insertIndex); } } else if (sc.Compare("Class")) { sc.MustGetString(); PClass *cls = PClass::FindClass(sc.String); if (cls == nullptr || !cls->IsDescendantOf("ListMenu")) { sc.ScriptError("Unknown menu class '%s'", sc.String); } desc->mClass = cls; sizecompatible = false; } else if (sc.Compare("Selector")) { sc.MustGetString(); desc->mSelector = GetMenuTexture(sc.String); sc.MustGetStringName(","); sc.MustGetFloat(); desc->mSelectOfsX = sc.Float; sc.MustGetStringName(","); sc.MustGetFloat(); desc->mSelectOfsY = sc.Float; } else if (sc.Compare("Linespacing")) { sc.MustGetNumber(); desc->mLinespacing = sc.Number; } else if (sc.Compare("Position")) { sc.MustGetFloat(); desc->mXpos = sc.Float; sc.MustGetStringName(","); sc.MustGetFloat(); desc->mYpos = sc.Float; } else if (sc.Compare("Centermenu")) { desc->mCenter = true; } else if (sc.Compare("Selecteditem")) { desc->mSelectedItem = desc->mItems.Size() - 1; } else if (sc.Compare("animatedtransition")) { desc->mAnimatedTransition = true; } else if (sc.Compare("animated")) { desc->mAnimated = true; } else if (sc.Compare("DontDim")) { desc->mDontDim = true; } else if (sc.Compare("DontBlur")) { desc->mDontBlur = true; } else if (sc.Compare("MouseWindow")) { sc.MustGetNumber(); desc->mWLeft = sc.Number; sc.MustGetStringName(","); sc.MustGetNumber(); desc->mWRight = sc.Number; } else if (sc.Compare("Font")) { sc.MustGetString(); FFont *newfont = V_GetFont(sc.String); if (newfont != nullptr) desc->mFont = newfont; if (sc.CheckString(",")) { sc.MustGetString(); desc->mFontColor2 = desc->mFontColor = V_FindFontColor((FName)sc.String); if (sc.CheckString(",")) { sc.MustGetString(); desc->mFontColor2 = V_FindFontColor((FName)sc.String); } } else { desc->mFontColor = OptionSettings.mFontColor; desc->mFontColor2 = OptionSettings.mFontColorValue; } } else if (sc.Compare("NetgameMessage")) { sc.MustGetString(); desc->mNetgameMessage = sc.String; } else if (sc.Compare("size")) { desc->mCustomSizeSet = true; if (sc.CheckNumber()) { desc->mVirtWidth = sc.Number; sc.MustGetStringName(","); sc.MustGetNumber(); desc->mVirtHeight = sc.Number; } else { sc.MustGetString(); if (sc.Compare("clean")) { desc->mVirtWidth = -1; } else if (sc.Compare("optclean")) { desc->mVirtWidth = -2; } else { sc.ScriptError("Invalid value '%s' for 'size'", sc.String); } } } else if (sc.Compare("ForceList")) { desc->mForceList = true; } else { // all item classes from which we know that they support sized scaling. // If anything else comes through here the option to swich scaling mode is disabled for this menu. static const char* const compatibles[] = { "StaticPatch", "StaticText", "StaticTextCentered", "TextItem", "PatchItem", "PlayerDisplay", nullptr }; if (sc.MatchString(compatibles) < 0) sizecompatible = false; bool success = false; FStringf buildname("ListMenuItem%s", sc.String); PClass *cls = PClass::FindClass(buildname); if (cls != nullptr && cls->IsDescendantOf("ListMenuItem")) { bool inserting = insertIndex >= 0; bool isSelectable = cls->IsDescendantOf("ListMenuItemSelectable"); double oldYpos = desc->mYpos; // [Player701] If this is a selectable item and we're inserting in the middle, // set the Y position of the descriptor to the Y of the item we're inserting before. if (isSelectable && inserting) { desc->mYpos = desc->mItems[insertIndex]->mYpos; } auto func = dyn_cast(cls->FindSymbol("Init", true)); if (func != nullptr && !(func->Variants[0].Flags & (VARF_Protected | VARF_Private))) // skip internal classes which have a protected init method. { auto &args = func->Variants[0].Proto->ArgumentTypes; TArray params; int start = 1; params.Push(0); if (args.Size() > 1 && args[1] == NewPointer(PClass::FindClass("ListMenuDescriptor"))) { params.Push(desc); start = 2; } auto TypeCVar = NewPointer(NewStruct("CVar", nullptr, true)); // Note that this array may not be reallocated so its initial size must be the maximum possible elements. TArray strings(args.Size()); for (unsigned i = start; i < args.Size(); i++) { sc.MustGetString(); if (args[i] == TypeString) { strings.Push(sc.String); params.Push(&strings.Last()); } else if (args[i] == TypeName) { params.Push(FName(sc.String).GetIndex()); } else if (args[i] == TypeColor) { params.Push(V_GetColor(sc)); } else if (args[i] == TypeFont) { auto f = V_GetFont(sc.String); if (f == nullptr) { sc.ScriptError("Unknown font %s", sc.String); } params.Push(f); } else if (args[i] == TypeTextureID) { auto f = TexMan.CheckForTexture(sc.String, ETextureType::MiscPatch); if (!f.Exists()) { sc.ScriptMessage("Unknown texture %s", sc.String); } params.Push(f.GetIndex()); } else if (args[i]->isIntCompatible()) { char *endp; int v = (int)strtoll(sc.String, &endp, 0); if (*endp != 0) { // special check for font color ranges. v = V_FindFontColor(sc.String); if (v == CR_UNTRANSLATED && !sc.Compare("untranslated")) { // todo: check other data types that may get used. sc.ScriptError("Integer expected, got %s", sc.String); } } if (args[i] == TypeBool) v = !!v; params.Push(v); } else if (args[i]->isFloat()) { char *endp; double v = strtod(sc.String, &endp); if (*endp != 0) { sc.ScriptError("Float expected, got %s", sc.String); } params.Push(v); } else if (args[i] == TypeCVar) { auto cv = FindCVar(sc.String, nullptr); if (cv == nullptr && *sc.String) { sc.ScriptError("Unknown CVar %s", sc.String); } params.Push(cv); } else { sc.ScriptError("Invalid parameter type %s for menu item", args[i]->DescriptiveName()); } if (sc.CheckString(",")) { if (i == args.Size() - 1) { sc.ScriptError("Too many parameters for %s", cls->TypeName.GetChars()); } } else { if (i < args.Size() - 1 && !(func->Variants[0].ArgFlags[i + 1] & VARF_Optional)) { sc.ScriptError("Insufficient parameters for %s", cls->TypeName.GetChars()); } break; } } DMenuItemBase *item = (DMenuItemBase*)cls->CreateNew(); params[0] = item; VMCallWithDefaults(func->Variants[0].Implementation, params, nullptr, 0); if (!inserting) { desc->mItems.Push(item); } else { // [Player701] Insert item in between desc->mItems.Insert(insertIndex, item); insertIndex++; } if (isSelectable) { if (inserting) { // [Player701] If we've inserted a selectable item, // shift all following selectable items downwards // NB: index has been incremented, so we're not affecting the newly inserted item here. for (unsigned int i = insertIndex; i < desc->mItems.Size(); i++) { auto litem = desc->mItems[i]; if (litem->GetClass()->IsDescendantOf("ListMenuItemSelectable")) { desc->mItems[i]->mYpos += desc->mLinespacing; } } } desc->mYpos = oldYpos + desc->mLinespacing; if (desc->mSelectedItem == -1) desc->mSelectedItem = desc->mItems.Size() - 1; } success = true; } } if (!success) { sc.ScriptError("Unknown keyword '%s'", sc.String); } } } for (auto &p : desc->mItems) { GC::WriteBarrier(p); } } static void ParseListMenuBody(FScanner& sc, DListMenuDescriptor* desc, int insertIndex) { bool sizecompatible = true; DoParseListMenuBody(sc, desc, sizecompatible, insertIndex); if (!desc->mCustomSizeSet && !sizecompatible) { // No custom size and incompatible items, // so force clean scaling for this menu desc->mVirtWidth = -1; } } //============================================================================= // // // //============================================================================= static bool CheckCompatible(DMenuDescriptor *newd, DMenuDescriptor *oldd) { if (oldd->mClass == nullptr) return true; return newd->mClass->IsDescendantOf(oldd->mClass); } static int GetGroup(DMenuItemBase *desc) { if (desc->IsKindOf(NAME_OptionMenuItemCommand)) return 2; if (desc->IsKindOf(NAME_OptionMenuItemSubmenu)) return 1; if (desc->IsKindOf(NAME_OptionMenuItemControlBase)) return 3; if (desc->IsKindOf(NAME_OptionMenuItemOptionBase)) return 4; if (desc->IsKindOf(NAME_OptionMenuSliderBase)) return 4; if (desc->IsKindOf(NAME_OptionMenuFieldBase)) return 4; if (desc->IsKindOf(NAME_OptionMenuItemColorPicker)) return 4; if (desc->IsKindOf(NAME_OptionMenuItemStaticText)) return 5; if (desc->IsKindOf(NAME_OptionMenuItemStaticTextSwitchable)) return 5; return 0; } static bool FindMatchingItem(DMenuItemBase *desc) { int grp = GetGroup(desc); if (grp == 0) return false; // no idea what this is. if (grp == 5) return true; // static texts always match FName name = desc->mAction; if (grp == 1) { // Check for presence of menu auto menu = MenuDescriptors.CheckKey(name); if (menu == nullptr) return false; } else if (grp == 4) { static const FName CVarBlacklist[] = { NAME_snd_waterlp, NAME_snd_output, NAME_snd_output_format, NAME_snd_speakermode, NAME_snd_resampler, NAME_AlwaysRun }; // Check for presence of CVAR and blacklist auto cv = FindCVar(name.GetChars(), nullptr); if (cv == nullptr) return true; for (auto bname : CVarBlacklist) { if (name == bname) return true; } } MenuDescriptorList::Iterator it(MenuDescriptors); MenuDescriptorList::Pair *pair; while (it.NextPair(pair)) { for (auto item : pair->Value->mItems) { if (item->mAction == name && GetGroup(item) == grp) return true; } } return false; } static bool ReplaceMenu(FScanner &sc, DMenuDescriptor *desc) { DMenuDescriptor **pOld = MenuDescriptors.CheckKey(desc->mMenuName); if (pOld != nullptr && *pOld != nullptr) { if ((*pOld)->mProtected) { // If this tries to replace an option menu with an option menu, let's append all new entries to the old menu. // Otherwise bail out because for list menus it's not that simple. if (!desc->IsKindOf(RUNTIME_CLASS(DOptionMenuDescriptor)) || !(*pOld)->IsKindOf(RUNTIME_CLASS(DOptionMenuDescriptor))) { sc.ScriptMessage("Cannot replace protected menu %s.", desc->mMenuName.GetChars()); return true; } for (int i = desc->mItems.Size()-1; i >= 0; i--) { if (FindMatchingItem(desc->mItems[i])) { desc->mItems.Delete(i); } } if (desc->mItems.Size() > 0) { auto sep = CreateOptionMenuItemStaticText(" "); (*pOld)->mItems.Push(sep); sep = CreateOptionMenuItemStaticText("---------------", 1); (*pOld)->mItems.Push(sep); for (auto it : desc->mItems) { (*pOld)->mItems.Push(it); } desc->mItems.Clear(); //sc.ScriptMessage("Merged %d items into %s", desc->mItems.Size(), desc->mMenuName.GetChars()); } return true; } if (!CheckCompatible(desc, *pOld)) { sc.ScriptMessage("Tried to replace menu '%s' with a menu of different type", desc->mMenuName.GetChars()); return true; } } MenuDescriptors[desc->mMenuName] = desc; GC::WriteBarrier(desc); return false; } //============================================================================= // // // //============================================================================= static void ParseListMenu(FScanner &sc) { sc.MustGetString(); DListMenuDescriptor *desc = Create(); desc->Reset(); desc->mMenuName = sc.String; desc->mSelectedItem = -1; desc->mAutoselect = -1; desc->mSelectOfsX = DefaultListMenuSettings->mSelectOfsX; desc->mSelectOfsY = DefaultListMenuSettings->mSelectOfsY; desc->mSelector = DefaultListMenuSettings->mSelector; desc->mDisplayTop = DefaultListMenuSettings->mDisplayTop; desc->mXpos = DefaultListMenuSettings->mXpos; desc->mYpos = DefaultListMenuSettings->mYpos; desc->mLinespacing = DefaultListMenuSettings->mLinespacing; desc->mNetgameMessage = DefaultListMenuSettings->mNetgameMessage; desc->mFont = DefaultListMenuSettings->mFont; desc->mFontColor = DefaultListMenuSettings->mFontColor; desc->mFontColor2 = DefaultListMenuSettings->mFontColor2; desc->mClass = nullptr; desc->mWLeft = 0; desc->mWRight = 0; desc->mCenter = false; desc->mFromEngine = fileSystem.GetFileContainer(sc.LumpNum) == 0; // flags menu if the definition is from the IWAD. desc->mVirtWidth = -2; desc->mCustomSizeSet = false; desc->mAnimatedTransition = false; desc->mAnimated = false; desc->mDontDim = false; desc->mDontBlur = false; desc->mForceList = false; if (DefaultListMenuSettings->mCustomSizeSet) { desc->mVirtHeight = DefaultListMenuSettings->mVirtHeight; desc->mVirtWidth = DefaultListMenuSettings->mVirtWidth; desc->mCustomSizeSet = true; } ParseListMenuBody(sc, desc, -1); ReplaceMenu(sc, desc); } //============================================================================= // // [Player701] Common function for figuring out where to insert items // for AddListMenu and AddOptionMenu // //============================================================================= static int GetInsertIndex(FScanner& sc, DMenuDescriptor* desc) { bool before = sc.CheckString("BEFORE"); bool after = sc.CheckString("AFTER"); int insertIndex = -1; if (before || after) { // Find an existing menu item to use as insertion point sc.MustGetString(); int n = desc->mItems.Size(); for (int i = 0; i < n; i++) { auto item = desc->mItems[i]; if (item->mAction == sc.String) { insertIndex = before ? i : i + 1; break; } } // Inserting after the last item is the same as inserting at the end if (insertIndex == n) insertIndex = -1; // Don't error out if we haven't found a suitable item // to avoid backwards compatibility issues. } return insertIndex; } //============================================================================= // // [Player701] Allow extending list menus // //============================================================================= static void ParseAddListMenu(FScanner& sc) { sc.MustGetString(); DMenuDescriptor** pOld = MenuDescriptors.CheckKey(sc.String); if (pOld == nullptr || *pOld == nullptr || !(*pOld)->IsKindOf(RUNTIME_CLASS(DListMenuDescriptor))) { sc.ScriptError("%s is not a list menu that can be extended", sc.String); return; } ParseListMenuBody(sc, (DListMenuDescriptor*)(*pOld), GetInsertIndex(sc, *pOld)); } //============================================================================= // // // //============================================================================= static void ParseOptionValue(FScanner &sc) { FOptionValues *val = new FOptionValues; sc.MustGetString(); FName optname = sc.String; sc.MustGetStringName("{"); while (!sc.CheckString("}")) { FOptionValues::Pair &pair = val->mValues[val->mValues.Reserve(1)]; sc.MustGetFloat(); pair.Value = sc.Float; sc.MustGetStringName(","); sc.MustGetString(); pair.Text = strbin1(sc.String); } FOptionValues **pOld = OptionValues.CheckKey(optname); if (pOld != nullptr && *pOld != nullptr) { delete *pOld; } OptionValues[optname] = val; } //============================================================================= // // // //============================================================================= static void ParseOptionString(FScanner &sc) { FOptionValues *val = new FOptionValues; sc.MustGetString(); FName optname = sc.String; sc.MustGetStringName("{"); while (!sc.CheckString("}")) { FOptionValues::Pair &pair = val->mValues[val->mValues.Reserve(1)]; sc.MustGetString(); pair.Value = DBL_MAX; pair.TextValue = sc.String; sc.MustGetStringName(","); sc.MustGetString(); pair.Text = strbin1(sc.String); } FOptionValues **pOld = OptionValues.CheckKey(optname); if (pOld != nullptr && *pOld != nullptr) { delete *pOld; } OptionValues[optname] = val; } //============================================================================= // // // //============================================================================= static void ParseOptionSettings(FScanner &sc) { sc.MustGetStringName("{"); while (!sc.CheckString("}")) { sc.MustGetString(); if (sc.Compare("else")) { SkipSubBlock(sc); } else if (sc.Compare("ifgame")) { if (!CheckSkipGameBlock(sc)) { // recursively parse sub-block ParseOptionSettings(sc); } } else if (sc.Compare("ifnotgame")) { if (!CheckSkipGameBlock(sc, false)) { // recursively parse sub-block ParseOptionSettings(sc); } } else if (sc.Compare("Linespacing")) { sc.MustGetNumber(); // ignored } else if (sc.Compare("LabelOffset")) { sc.MustGetNumber(); // ignored } else { sc.ScriptError("Unknown keyword '%s'", sc.String); } } } //============================================================================= // // // //============================================================================= static void ParseOptionMenuBody(FScanner &sc, DOptionMenuDescriptor *desc, int insertIndex) { sc.MustGetStringName("{"); while (!sc.CheckString("}")) { sc.MustGetString(); if (sc.Compare("else")) { SkipSubBlock(sc); } else if (sc.Compare("ifgame")) { if (!CheckSkipGameBlock(sc)) { // recursively parse sub-block ParseOptionMenuBody(sc, desc, insertIndex); } } else if (sc.Compare("ifnotgame")) { if (!CheckSkipGameBlock(sc, false)) { // recursively parse sub-block ParseOptionMenuBody(sc, desc, insertIndex); } } else if (sc.Compare("ifoption")) { if (!CheckSkipOptionBlock(sc)) { // recursively parse sub-block ParseOptionMenuBody(sc, desc, insertIndex); } } else if (sc.Compare("Class")) { sc.MustGetString(); PClass *cls = PClass::FindClass(sc.String); if (cls == nullptr || !cls->IsDescendantOf("OptionMenu")) { sc.ScriptError("Unknown menu class '%s'", sc.String); } desc->mClass = cls; } else if (sc.Compare({ "Title", "Caption" })) { sc.MustGetString(); desc->mTitle = sc.String; } else if (sc.Compare("Position")) { sc.MustGetNumber(); desc->mPosition = sc.Number; } else if (sc.Compare("DefaultSelection")) { sc.MustGetNumber(); desc->mSelectedItem = sc.Number; } else if (sc.Compare("ScrollTop")) { sc.MustGetNumber(); desc->mScrollTop = sc.Number; } else if (sc.Compare("Indent")) { sc.MustGetNumber(); desc->mIndent = sc.Number; } else if (sc.Compare("AnimatedTransition")) { desc->mAnimatedTransition = true; } else if (sc.Compare("Animated")) { desc->mAnimated = true; } else if (sc.Compare("DontDim")) { desc->mDontDim = true; } else if (sc.Compare("DontBlur")) { desc->mDontBlur = true; } else { bool success = false; FStringf buildname("OptionMenuItem%s", sc.String); // Handle one special case: MapControl maps to Control with one parameter different PClass *cls = PClass::FindClass(buildname); if (cls != nullptr && cls->IsDescendantOf("OptionMenuItem")) { auto func = dyn_cast(cls->FindSymbol("Init", true)); if (func != nullptr && !(func->Variants[0].Flags & (VARF_Protected | VARF_Private))) // skip internal classes which have a protexted init method. { auto &args = func->Variants[0].Proto->ArgumentTypes; TArray params; int start = 1; params.Push(0); if (args.Size() > 1 && args[1] == NewPointer(PClass::FindClass("OptionMenuDescriptor"))) { params.Push(desc); start = 2; } auto TypeCVar = NewPointer(NewStruct("CVar", nullptr, true)); // Note that this array may not be reallocated so its initial size must be the maximum possible elements. TArray strings(args.Size()); for (unsigned i = start; i < args.Size(); i++) { sc.MustGetString(); if (args[i] == TypeString) { strings.Push(sc.String); params.Push(&strings.Last()); } else if (args[i] == TypeName) { params.Push(FName(sc.String).GetIndex()); } else if (args[i] == TypeColor) { params.Push(V_GetColor(sc)); } else if (args[i] == TypeFont) { auto f = V_GetFont(sc.String); if (f == nullptr) { sc.ScriptError("Unknown font %s", sc.String); } params.Push(f); } else if (args[i] == TypeTextureID) { auto f = TexMan.CheckForTexture(sc.String, ETextureType::MiscPatch); if (!f.Exists()) { sc.ScriptMessage("Unknown texture %s", sc.String); } params.Push(f.GetIndex()); } else if (args[i]->isIntCompatible()) { char *endp; int v = (int)strtoll(sc.String, &endp, 0); if (*endp != 0) { // special check for font color ranges. v = V_FindFontColor(sc.String); if (v == CR_UNTRANSLATED && !sc.Compare("untranslated")) { // todo: check other data types that may get used. sc.ScriptError("Integer expected, got %s", sc.String); } // Color ranges need to be marked for option menu items to support an older feature where a boolean number could be passed instead. v |= 0x12340000; } if (args[i] == TypeBool) v = !!v; params.Push(v); } else if (args[i]->isFloat()) { char *endp; double v = strtod(sc.String, &endp); if (*endp != 0) { sc.ScriptError("Float expected, got %s", sc.String); } params.Push(v); } else if (args[i] == TypeCVar) { auto cv = FindCVar(sc.String, nullptr); if (cv == nullptr && *sc.String) { if (func->Variants[0].ArgFlags[i] & VARF_Optional) sc.ScriptMessage("Unknown CVar %s", sc.String); else sc.ScriptError("Unknown CVar %s", sc.String); } params.Push(cv); } else { sc.ScriptError("Invalid parameter type %s for menu item", args[i]->DescriptiveName()); } if (sc.CheckString(",")) { if (i == args.Size() - 1) { sc.ScriptError("Too many parameters for %s", cls->TypeName.GetChars()); } } else { if (i < args.Size() - 1 && !(func->Variants[0].ArgFlags[i + 1] & VARF_Optional)) { sc.ScriptError("Insufficient parameters for %s", cls->TypeName.GetChars()); } break; } } DMenuItemBase *item = (DMenuItemBase*)cls->CreateNew(); params[0] = item; VMCallWithDefaults(func->Variants[0].Implementation, params, nullptr, 0); if (insertIndex == -1) { desc->mItems.Push(item); } else { desc->mItems.Insert(insertIndex, item); insertIndex++; } success = true; } } if (!success) { sc.ScriptError("Unknown keyword '%s'", sc.String); } } } for (auto &p : desc->mItems) { GC::WriteBarrier(p); } } //============================================================================= // // // //============================================================================= static void ParseOptionMenu(FScanner &sc) { sc.MustGetString(); DOptionMenuDescriptor *desc = Create(); desc->mFont = BigUpper; desc->mMenuName = sc.String; desc->mSelectedItem = -1; desc->mScrollPos = 0; desc->mClass = nullptr; desc->mPosition = DefaultOptionMenuSettings->mPosition; desc->mScrollTop = DefaultOptionMenuSettings->mScrollTop; desc->mIndent = DefaultOptionMenuSettings->mIndent; desc->mDontDim = false; desc->mDontBlur = false; desc->mAnimatedTransition = false; desc->mAnimated = false; desc->mProtected = sc.CheckString("protected"); ParseOptionMenuBody(sc, desc, -1); ReplaceMenu(sc, desc); } //============================================================================= // // // //============================================================================= static void ParseAddOptionMenu(FScanner &sc) { sc.MustGetString(); DMenuDescriptor **pOld = MenuDescriptors.CheckKey(sc.String); if (pOld == nullptr || *pOld == nullptr || !(*pOld)->IsKindOf(RUNTIME_CLASS(DOptionMenuDescriptor))) { sc.ScriptError("%s is not an option menu that can be extended", sc.String); return; } ParseOptionMenuBody(sc, (DOptionMenuDescriptor*)(*pOld), GetInsertIndex(sc, *pOld)); } //============================================================================= // // // //============================================================================= static void ParseImageScrollerBody(FScanner& sc, DImageScrollerDescriptor* desc) { sc.MustGetStringName("{"); while (!sc.CheckString("}")) { sc.MustGetString(); if (sc.Compare("else")) { SkipSubBlock(sc); } else if (sc.Compare("ifgame")) { if (!CheckSkipGameBlock(sc)) { // recursively parse sub-block ParseImageScrollerBody(sc, desc); } } else if (sc.Compare("ifnotgame")) { if (!CheckSkipGameBlock(sc, false)) { // recursively parse sub-block ParseImageScrollerBody(sc, desc); } } else if (sc.Compare("ifoption")) { if (!CheckSkipOptionBlock(sc)) { // recursively parse sub-block ParseImageScrollerBody(sc, desc); } } else if (sc.Compare("Class")) { sc.MustGetString(); PClass* cls = PClass::FindClass(sc.String); if (cls == nullptr || !cls->IsDescendantOf("ImageScrollerMenu")) { sc.ScriptError("Unknown menu class '%s'", sc.String); } desc->mClass = cls; } else if (sc.Compare("animatedtransition")) { desc->mAnimatedTransition = true; } else if (sc.Compare("animated")) { desc->mAnimated = true; } else if (sc.Compare("DontDim")) { desc->mDontDim = true; } else if (sc.Compare("DontBlur")) { desc->mDontBlur = true; } else if (sc.Compare("textBackground")) { sc.MustGetString(); desc->textBackground = GetMenuTexture(sc.String); } else if (sc.Compare("textBackgroundBrightness")) { sc.MustGetFloat(); int bb = clamp(int(sc.Float * 255), 0, 255); desc->textBackgroundBrightness = PalEntry(255, bb, bb, bb); } else if (sc.Compare("textScale")) { sc.MustGetFloat(); desc->textScale = sc.Float; } else if (sc.Compare("textFont")) { sc.MustGetString(); FFont* newfont = V_GetFont(sc.String); if (newfont != nullptr) desc->textFont = newfont; } else { bool success = false; FStringf buildname("ImageScrollerPage%s", sc.String); // Handle one special case: MapControl maps to Control with one parameter different PClass* cls = PClass::FindClass(buildname); if (cls != nullptr && cls->IsDescendantOf("ImageScrollerPage")) { auto func = dyn_cast(cls->FindSymbol("Init", true)); if (func != nullptr && !(func->Variants[0].Flags & (VARF_Protected | VARF_Private))) // skip internal classes which have a protected init method. { auto& args = func->Variants[0].Proto->ArgumentTypes; TArray params; int start = 1; params.Push(0); if (args.Size() > 1 && args[1] == NewPointer(PClass::FindClass("ImageScrollerDescriptor"))) { params.Push(desc); start = 2; } auto TypeCVar = NewPointer(NewStruct("CVar", nullptr, true)); // Note that this array may not be reallocated so its initial size must be the maximum possible elements. TArray strings(args.Size()); for (unsigned i = start; i < args.Size(); i++) { sc.MustGetString(); if (args[i] == TypeString) { strings.Push(sc.String); params.Push(&strings.Last()); } else if (args[i] == TypeName) { params.Push(FName(sc.String).GetIndex()); } else if (args[i] == TypeColor) { params.Push(V_GetColor(sc)); } else if (args[i] == TypeFont) { auto f = V_GetFont(sc.String); if (f == nullptr) { sc.ScriptError("Unknown font %s", sc.String); } params.Push(f); } else if (args[i] == TypeTextureID) { auto f = TexMan.CheckForTexture(sc.String, ETextureType::MiscPatch); if (!f.Exists()) { sc.ScriptMessage("Unknown texture %s", sc.String); } params.Push(f.GetIndex()); } else if (args[i]->isIntCompatible()) { char* endp; int v = (int)strtoll(sc.String, &endp, 0); if (*endp != 0) { // special check for font color ranges. v = V_FindFontColor(sc.String); if (v == CR_UNTRANSLATED && !sc.Compare("untranslated")) { // todo: check other data types that may get used. sc.ScriptError("Integer expected, got %s", sc.String); } } if (args[i] == TypeBool) v = !!v; params.Push(v); } else if (args[i]->isFloat()) { char* endp; double v = strtod(sc.String, &endp); if (*endp != 0) { sc.ScriptError("Float expected, got %s", sc.String); } params.Push(v); } else if (args[i] == TypeCVar) { auto cv = FindCVar(sc.String, nullptr); if (cv == nullptr && *sc.String) { if (func->Variants[0].ArgFlags[i] & VARF_Optional) sc.ScriptMessage("Unknown CVar %s", sc.String); else sc.ScriptError("Unknown CVar %s", sc.String); } params.Push(cv); } else { sc.ScriptError("Invalid parameter type %s for image page", args[i]->DescriptiveName()); } if (sc.CheckString(",")) { if (i == args.Size() - 1) { sc.ScriptError("Too many parameters for %s", cls->TypeName.GetChars()); } } else { if (i < args.Size() - 1 && !(func->Variants[0].ArgFlags[i + 1] & VARF_Optional)) { sc.ScriptError("Insufficient parameters for %s", cls->TypeName.GetChars()); } break; } } DMenuItemBase* item = (DMenuItemBase*)cls->CreateNew(); params[0] = item; VMCallWithDefaults(func->Variants[0].Implementation, params, nullptr, 0); desc->mItems.Push((DMenuItemBase*)item); success = true; } } if (!success) { sc.ScriptError("Unknown keyword '%s'", sc.String); } } } } //============================================================================= // // // //============================================================================= static void ParseImageScroller(FScanner& sc) { sc.MustGetString(); DImageScrollerDescriptor* desc = Create(); desc->mMenuName = sc.String; desc->textBackground.SetInvalid(); desc->textBackgroundBrightness = 0xffffffff; desc->textFont = SmallFont; desc->textScale = 1; desc->mDontDim = false; desc->mDontBlur = false; desc->mAnimatedTransition = false; desc->mAnimated = false; desc->virtWidth = 320; desc->virtHeight = 200; ParseImageScrollerBody(sc, desc); bool scratch = ReplaceMenu(sc, desc); if (scratch) delete desc; } //============================================================================= // // // //============================================================================= void M_ParseMenuDefs() { int lump, lastlump = 0; // these are supposed to get GC'd after parsing is complete. DefaultListMenuSettings = Create(); DefaultOptionMenuSettings = Create(); DefaultListMenuSettings->Reset(); DefaultOptionMenuSettings->Reset(); OptionSettings.mLinespacing = 17; int IWADMenu = fileSystem.CheckNumForName("MENUDEF", FileSys::ns_global, fileSystem.GetIwadNum()); while ((lump = fileSystem.FindLump ("MENUDEF", &lastlump)) != -1) { FScanner sc(lump); mustPrintErrors = lump >= IWADMenu; sc.SetCMode(true); while (sc.GetString()) { if (sc.Compare("LISTMENU")) { ParseListMenu(sc); } else if (sc.Compare("DEFAULTLISTMENU")) { bool s = false; DoParseListMenuBody(sc, DefaultListMenuSettings, s, -1); if (DefaultListMenuSettings->mItems.Size() > 0) { I_FatalError("You cannot add menu items to the menu default settings."); } } else if (sc.Compare("ADDLISTMENU")) { ParseAddListMenu(sc); } else if (sc.Compare("OPTIONVALUE")) { ParseOptionValue(sc); } else if (sc.Compare("OPTIONSTRING")) { ParseOptionString(sc); } else if (sc.Compare("OPTIONMENUSETTINGS")) { ParseOptionSettings(sc); } else if (sc.Compare("OPTIONMENU")) { ParseOptionMenu(sc); } else if (sc.Compare("ADDOPTIONMENU")) { ParseAddOptionMenu(sc); } else if (sc.Compare("DEFAULTOPTIONMENU")) { ParseOptionMenuBody(sc, DefaultOptionMenuSettings, -1); if (DefaultOptionMenuSettings->mItems.Size() > 0) { I_FatalError("You cannot add menu items to the menu default settings."); } } else if (sc.Compare("IMAGESCROLLER")) { ParseImageScroller(sc); } else { sc.ScriptError("Unknown keyword '%s'", sc.String); } } if (Args->CheckParm("-nocustommenu")) break; } DefaultListMenuClass = DefaultListMenuSettings->mClass; DefaultListMenuSettings = nullptr; DefaultOptionMenuClass = DefaultOptionMenuSettings->mClass; DefaultOptionMenuSettings = nullptr; } //============================================================================= // // Initialize the music configuration submenus // //============================================================================= extern "C" { extern int adl_getBanksCount(); extern const char *const *adl_getBankNames(); } static void InitMusicMenus() { DMenuDescriptor **advmenu = MenuDescriptors.CheckKey("AdvSoundOptions"); auto soundfonts = sfmanager.GetList(); std::tuple sfmenus[] = { std::make_tuple("GusConfigMenu", SF_GUS, "midi_config"), std::make_tuple("WildMidiConfigMenu", SF_GUS, "wildmidi_config"), std::make_tuple("TimidityConfigMenu", SF_SF2 | SF_GUS, "timidity_config"), std::make_tuple("FluidPatchsetMenu", SF_SF2, "fluid_patchset"), std::make_tuple("ADLMIDICustomBanksMenu", SF_WOPL, "adl_custom_bank"), std::make_tuple("OPNMIDICustomBanksMenu", SF_WOPN, "opn_custom_bank")}; for (auto &p : sfmenus) { DMenuDescriptor **menu = MenuDescriptors.CheckKey(std::get<0>(p)); if (menu != nullptr) { if (soundfonts.Size() > 0) { for (auto &entry : soundfonts) { if (entry.type & std::get<1>(p)) { FString display = entry.mName; display.ReplaceChars("_", ' '); auto it = CreateOptionMenuItemCommand(display.GetChars(), FStringf("%s \"%s\"", std::get<2>(p), entry.mName.GetChars()), true); static_cast(*menu)->mItems.Push(it); } } } else if (advmenu != nullptr) { // Remove the item for this submenu auto d = static_cast(*advmenu); auto it = d->GetItem(std::get<0>(p)); if (it != nullptr) d->mItems.Delete(d->mItems.Find(it)); } } } DMenuDescriptor **menu = MenuDescriptors.CheckKey("ADLBankMenu"); if (menu != nullptr) { const char* const* adl_bank_names; int adl_banks_count = ZMusic_GetADLBanks(&adl_bank_names); for (int i=0; i < adl_banks_count; i++) { auto it = CreateOptionMenuItemCommand(adl_bank_names[i], FStringf("adl_bank %d", i), true); static_cast(*menu)->mItems.Push(it); } } } //============================================================================= // // Special menus will be created once all engine data is loaded // //============================================================================= void I_BuildMIDIMenuList(FOptionValues*); void M_CreateMenus() { InitMusicMenus(); FOptionValues **opt = OptionValues.CheckKey(NAME_Mididevices); if (opt != nullptr) { I_BuildMIDIMenuList(*opt); } opt = OptionValues.CheckKey(NAME_Aldevices); if (opt != nullptr) { I_BuildALDeviceList(*opt); } opt = OptionValues.CheckKey(NAME_Alresamplers); if (opt != nullptr) { I_BuildALResamplersList(*opt); } }