/* ** loadsavemenu.cpp ** The load game and save game menus ** **--------------------------------------------------------------------------- ** Copyright 2001-2010 Randy Heit ** 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 "menu/menu.h" #include "i_system.h" #include "version.h" #include "g_game.h" #include "m_png.h" #include "w_wad.h" #include "v_text.h" #include "d_event.h" #include "gstrings.h" #include "v_palette.h" #include "doomstat.h" #include "gi.h" #include "d_gui.h" class DLoadSaveMenu : public DListMenu { DECLARE_CLASS(DLoadSaveMenu, DListMenu) friend void ClearSaveGames(); protected: static TArray SaveGames; static int LastSaved; static int LastAccessed; int Selected; int TopItem; int savepicLeft; int savepicTop; int savepicWidth; int savepicHeight; int rowHeight; int listboxLeft; int listboxTop; int listboxWidth; int listboxRows; int listboxHeight; int listboxRight; int listboxBottom; int commentLeft; int commentTop; int commentWidth; int commentHeight; int commentRight; int commentBottom; static int InsertSaveNode (FSaveGameNode *node); static void ReadSaveStrings (); FTexture *SavePic; FBrokenLines *SaveComment; bool mEntering; char savegamestring[SAVESTRINGSIZE]; DLoadSaveMenu(DMenu *parent = NULL, FListMenuDescriptor *desc = NULL); void Destroy(); int RemoveSaveSlot (int index); void UnloadSaveData (); void ClearSaveStuff (); void ExtractSaveData (int index); void Drawer (); bool MenuEvent (int mkey, bool fromcontroller); bool MouseEvent(int type, int x, int y); bool Responder(event_t *ev); public: static void NotifyNewSave (const char *file, const char *title, bool okForQuicksave); }; IMPLEMENT_CLASS(DLoadSaveMenu) TArray DLoadSaveMenu::SaveGames; int DLoadSaveMenu::LastSaved = -1; int DLoadSaveMenu::LastAccessed = -1; FSaveGameNode *quickSaveSlot; //============================================================================= // // Save data maintenance (stored statically) // //============================================================================= void ClearSaveGames() { for(unsigned i=0;ibNoDelete) delete file; SaveGames.Delete(index); if ((unsigned)index >= SaveGames.Size()) index--; return index; } //============================================================================= // // // //============================================================================= int DLoadSaveMenu::InsertSaveNode (FSaveGameNode *node) { if (SaveGames.Size() == 0) { return SaveGames.Push(node); } if (node->bOldVersion) { // Add node at bottom of list return SaveGames.Push(node); } else { // Add node at top of list unsigned int i; for(i = 0; i < SaveGames.Size(); i++) { if (SaveGames[i]->bOldVersion || stricmp (node->Title, SaveGames[i]->Title) <= 0) { break; } } SaveGames.Insert(i, node); return i; } } //============================================================================= // // M_ReadSaveStrings // // Find savegames and read their titles // //============================================================================= void DLoadSaveMenu::ReadSaveStrings () { if (SaveGames.Size() == 0) { void *filefirst; findstate_t c_file; FString filter; LastSaved = LastAccessed = -1; quickSaveSlot = NULL; filter = G_BuildSaveName ("*.zds", -1); filefirst = I_FindFirst (filter.GetChars(), &c_file); if (filefirst != ((void *)(-1))) { do { // I_FindName only returns the file's name and not its full path FString filepath = G_BuildSaveName (I_FindName(&c_file), -1); FILE *file = fopen (filepath, "rb"); if (file != NULL) { PNGHandle *png; char sig[16]; char title[SAVESTRINGSIZE+1]; bool oldVer = true; bool addIt = false; bool missing = false; // ZDoom 1.23 betas 21-33 have the savesig first. // Earlier versions have the savesig second. // Later versions have the savegame encapsulated inside a PNG. // // Old savegame versions are always added to the menu so // the user can easily delete them if desired. title[SAVESTRINGSIZE] = 0; if (NULL != (png = M_VerifyPNG (file))) { char *ver = M_GetPNGText (png, "ZDoom Save Version"); char *engine = M_GetPNGText (png, "Engine"); if (ver != NULL) { if (!M_GetPNGText (png, "Title", title, SAVESTRINGSIZE)) { strncpy (title, I_FindName(&c_file), SAVESTRINGSIZE); } if (strncmp (ver, SAVESIG, 9) == 0 && atoi (ver+9) >= MINSAVEVER && engine != NULL) { // Was saved with a compatible ZDoom version, // so check if it's for the current game. // If it is, add it. Otherwise, ignore it. char *iwad = M_GetPNGText (png, "Game WAD"); if (iwad != NULL) { if (stricmp (iwad, Wads.GetWadName (FWadCollection::IWAD_FILENUM)) == 0) { addIt = true; oldVer = false; missing = !G_CheckSaveGameWads (png, false); } delete[] iwad; } } else { // An old version addIt = true; } delete[] ver; } if (engine != NULL) { delete[] engine; } delete png; } else { fseek (file, 0, SEEK_SET); if (fread (sig, 1, 16, file) == 16) { if (strncmp (sig, "ZDOOMSAVE", 9) == 0) { if (fread (title, 1, SAVESTRINGSIZE, file) == SAVESTRINGSIZE) { addIt = true; } } else { memcpy (title, sig, 16); if (fread (title + 16, 1, SAVESTRINGSIZE-16, file) == SAVESTRINGSIZE-16 && fread (sig, 1, 16, file) == 16 && strncmp (sig, "ZDOOMSAVE", 9) == 0) { addIt = true; } } } } if (addIt) { FSaveGameNode *node = new FSaveGameNode; node->Filename = filepath; node->bOldVersion = oldVer; node->bMissingWads = missing; memcpy (node->Title, title, SAVESTRINGSIZE); InsertSaveNode (node); } fclose (file); } } while (I_FindNext (filefirst, &c_file) == 0); I_FindClose (filefirst); } } } //============================================================================= // // // //============================================================================= void DLoadSaveMenu::NotifyNewSave (const char *file, const char *title, bool okForQuicksave) { FSaveGameNode *node; if (file == NULL) return; ReadSaveStrings (); // See if the file is already in our list for (unsigned i=0; iFilename.Compare (file) == 0) #else if (node->Filename.CompareNoCase (file) == 0) #endif { strcpy (node->Title, title); node->bOldVersion = false; node->bMissingWads = false; if (okForQuicksave) { if (quickSaveSlot == NULL) quickSaveSlot = node; LastAccessed = LastSaved = i; } return; } } node = new FSaveGameNode; strcpy (node->Title, title); node->Filename = file; node->bOldVersion = false; node->bMissingWads = false; int index = InsertSaveNode (node); if (okForQuicksave) { if (quickSaveSlot == NULL) quickSaveSlot = node; LastAccessed = LastSaved = index; } } void M_NotifyNewSave (const char *file, const char *title, bool okForQuicksave) { DLoadSaveMenu::NotifyNewSave(file, title, okForQuicksave); } //============================================================================= // // End of static savegame maintenance code // //============================================================================= DLoadSaveMenu::DLoadSaveMenu(DMenu *parent, FListMenuDescriptor *desc) : DListMenu(parent, desc) { ReadSaveStrings(); savepicLeft = 10; savepicTop = 54*CleanYfac; savepicWidth = 216*screen->GetWidth()/640; savepicHeight = 135*screen->GetHeight()/400; rowHeight = (SmallFont->GetHeight() + 1) * CleanYfac; listboxLeft = savepicLeft + savepicWidth + 14; listboxTop = savepicTop; listboxWidth = screen->GetWidth() - listboxLeft - 10; int listboxHeight1 = screen->GetHeight() - listboxTop - 10; listboxRows = (listboxHeight1 - 1) / rowHeight; listboxHeight = listboxRows * rowHeight + 1; listboxRight = listboxLeft + listboxWidth; listboxBottom = listboxTop + listboxHeight; commentLeft = savepicLeft; commentTop = savepicTop + savepicHeight + 16; commentWidth = savepicWidth; commentHeight = (51+(screen->GetHeight()>200?10:0))*CleanYfac; commentRight = commentLeft + commentWidth; commentBottom = commentTop + commentHeight; } void DLoadSaveMenu::Destroy() { ClearSaveStuff (); } //============================================================================= // // // //============================================================================= void DLoadSaveMenu::UnloadSaveData () { if (SavePic != NULL) { delete SavePic; } if (SaveComment != NULL) { V_FreeBrokenLines (SaveComment); } SavePic = NULL; SaveComment = NULL; } //============================================================================= // // // //============================================================================= void DLoadSaveMenu::ClearSaveStuff () { UnloadSaveData(); if (quickSaveSlot == (FSaveGameNode*)1) { quickSaveSlot = NULL; } } //============================================================================= // // // //============================================================================= void DLoadSaveMenu::ExtractSaveData (int index) { FILE *file; PNGHandle *png; FSaveGameNode *node; UnloadSaveData (); if ((unsigned)index < SaveGames.Size() && (node = SaveGames[index]) && !node->Filename.IsEmpty() && !node->bOldVersion && (file = fopen (node->Filename.GetChars(), "rb")) != NULL) { if (NULL != (png = M_VerifyPNG (file))) { char *time, *pcomment, *comment; size_t commentlen, totallen, timelen; // Extract comment time = M_GetPNGText (png, "Creation Time"); pcomment = M_GetPNGText (png, "Comment"); if (pcomment != NULL) { commentlen = strlen (pcomment); } else { commentlen = 0; } if (time != NULL) { timelen = strlen (time); totallen = timelen + commentlen + 3; } else { timelen = 0; totallen = commentlen + 1; } if (totallen != 0) { comment = new char[totallen]; if (timelen) { memcpy (comment, time, timelen); comment[timelen] = '\n'; comment[timelen+1] = '\n'; timelen += 2; } if (commentlen) { memcpy (comment + timelen, pcomment, commentlen); } comment[timelen+commentlen] = 0; SaveComment = V_BreakLines (SmallFont, 216*screen->GetWidth()/640/CleanXfac, comment); delete[] comment; delete[] time; delete[] pcomment; } // Extract pic SavePic = PNGTexture_CreateFromFile(png, node->Filename); delete png; if (SavePic->GetWidth() == 1 && SavePic->GetHeight() == 1) { delete SavePic; SavePic = NULL; } } fclose (file); } } //============================================================================= // // // //============================================================================= void DLoadSaveMenu::Drawer () { Super::Drawer(); FSaveGameNode *node; int i; unsigned j; bool didSeeSelected = false; // Draw picture area if (gameaction == ga_loadgame || gameaction == ga_savegame) { return; } V_DrawFrame (savepicLeft, savepicTop, savepicWidth, savepicHeight); if (SavePic != NULL) { screen->DrawTexture(SavePic, savepicLeft, savepicTop, DTA_DestWidth, savepicWidth, DTA_DestHeight, savepicHeight, DTA_Masked, false, TAG_DONE); } else { screen->Clear (savepicLeft, savepicTop, savepicLeft+savepicWidth, savepicTop+savepicHeight, 0, 0); if (SaveGames.Size() > 0) { const char *text = (Selected == -1 || !SaveGames[Selected]->bOldVersion) ? GStrings("MNU_NOPICTURE") : GStrings("MNU_DIFFVERSION"); const int textlen = SmallFont->StringWidth (text)*CleanXfac; screen->DrawText (SmallFont, CR_GOLD, savepicLeft+(savepicWidth-textlen)/2, savepicTop+(savepicHeight-rowHeight)/2, text, DTA_CleanNoMove, true, TAG_DONE); } } // Draw comment area V_DrawFrame (commentLeft, commentTop, commentWidth, commentHeight); screen->Clear (commentLeft, commentTop, commentRight, commentBottom, 0, 0); if (SaveComment != NULL) { // I'm not sure why SaveComment would go NULL in this loop, but I got // a crash report where it was NULL when i reached 1, so now I check // for that. for (i = 0; SaveComment != NULL && SaveComment[i].Width >= 0 && i < 6; ++i) { screen->DrawText (SmallFont, CR_GOLD, commentLeft, commentTop + SmallFont->GetHeight()*i*CleanYfac, SaveComment[i].Text, DTA_CleanNoMove, true, TAG_DONE); } } // Draw file area V_DrawFrame (listboxLeft, listboxTop, listboxWidth, listboxHeight); screen->Clear (listboxLeft, listboxTop, listboxRight, listboxBottom, 0, 0); if (SaveGames.Size() == 0) { const char * text = GStrings("MNU_NOFILES"); const int textlen = SmallFont->StringWidth (text)*CleanXfac; screen->DrawText (SmallFont, CR_GOLD, listboxLeft+(listboxWidth-textlen)/2, listboxTop+(listboxHeight-rowHeight)/2, text, DTA_CleanNoMove, true, TAG_DONE); return; } for (i = 0, j = TopItem; i < listboxRows && j < SaveGames.Size(); i++,j++) { int color; node = SaveGames[j]; if (node->bOldVersion) { color = CR_BLUE; } else if (node->bMissingWads) { color = CR_ORANGE; } else if ((int)j == Selected) { color = CR_WHITE; } else { color = CR_TAN; } if ((int)j == Selected) { screen->Clear (listboxLeft, listboxTop+rowHeight*i, listboxRight, listboxTop+rowHeight*(i+1), -1, mEntering ? MAKEARGB(255,255,0,0) : MAKEARGB(255,0,0,255)); didSeeSelected = true; if (!mEntering) { screen->DrawText (SmallFont, color, listboxLeft+1, listboxTop+rowHeight*i+CleanYfac, node->Title, DTA_CleanNoMove, true, TAG_DONE); } else { screen->DrawText (SmallFont, CR_WHITE, listboxLeft+1, listboxTop+rowHeight*i+CleanYfac, savegamestring, DTA_CleanNoMove, true, TAG_DONE); char curs[2] = { SmallFont->GetCursor(), 0 }; screen->DrawText (SmallFont, CR_WHITE, listboxLeft+1+SmallFont->StringWidth (savegamestring)*CleanXfac, listboxTop+rowHeight*i+CleanYfac, curs, DTA_CleanNoMove, true, TAG_DONE); } } else { screen->DrawText (SmallFont, color, listboxLeft+1, listboxTop+rowHeight*i+CleanYfac, node->Title, DTA_CleanNoMove, true, TAG_DONE); } } } //============================================================================= // // // //============================================================================= bool DLoadSaveMenu::MenuEvent (int mkey, bool fromcontroller) { switch (mkey) { case MKEY_Up: if (SaveGames.Size() > 1) { if (Selected == -1) Selected = TopItem; else { if (--Selected < 0) Selected = SaveGames.Size()-1; if (Selected < TopItem) TopItem = Selected; else if (Selected >= TopItem + listboxRows) TopItem = MAX(0, Selected - listboxRows + 1); } UnloadSaveData (); ExtractSaveData (Selected); } return true; case MKEY_Down: if (SaveGames.Size() > 1) { if (Selected == -1) Selected = TopItem; else { if (unsigned(++Selected) >= SaveGames.Size()) Selected = 0; if (Selected < TopItem) TopItem = Selected; else if (Selected >= TopItem + listboxRows) TopItem = MAX(0, Selected - listboxRows + 1); } UnloadSaveData (); ExtractSaveData (Selected); } return true; case MKEY_PageDown: if (SaveGames.Size() > 1) { if (TopItem >= (int)SaveGames.Size() - listboxRows) { TopItem = 0; if (Selected != -1) Selected = 0; } else { TopItem = MIN(TopItem + listboxRows, SaveGames.Size() - listboxRows); if (TopItem > Selected && Selected != -1) Selected = TopItem; } UnloadSaveData (); ExtractSaveData (Selected); } return true; case MKEY_PageUp: if (SaveGames.Size() > 1) { if (TopItem == 0) { TopItem = SaveGames.Size() - listboxRows; if (Selected != -1) Selected = TopItem; } else { TopItem = MAX(TopItem - listboxRows, 0); if (Selected >= TopItem + listboxRows) Selected = TopItem; } UnloadSaveData (); ExtractSaveData (Selected); } return true; case MKEY_Enter: return false; // This event will be handled by the subclasses case MKEY_MBYes: { if (Selected != -1) { int listindex = SaveGames[0]->bNoDelete? Selected-1 : Selected; remove (SaveGames[Selected]->Filename.GetChars()); UnloadSaveData (); Selected = RemoveSaveSlot (Selected); ExtractSaveData (Selected); if (LastSaved == listindex) LastSaved = -1; else if (LastSaved > listindex) LastSaved--; if (LastAccessed == listindex) LastAccessed = -1; else if (LastAccessed > listindex) LastAccessed--; } return true; } default: return Super::MenuEvent(mkey, fromcontroller); } } //============================================================================= // // // //============================================================================= bool DLoadSaveMenu::MouseEvent(int type, int x, int y) { if (x >= listboxLeft && x < listboxLeft + listboxWidth && y >= listboxTop && y < listboxTop + listboxHeight) { int lineno = (y - listboxTop) / rowHeight; if (TopItem + lineno < (int)SaveGames.Size()) { Selected = TopItem + lineno; UnloadSaveData (); ExtractSaveData (Selected); if (type == MOUSE_Release) { if (MenuEvent(MKEY_Enter, true)) { return true; } } } else Selected = -1; } else Selected = -1; return Super::MouseEvent(type, x, y); } //============================================================================= // // // //============================================================================= bool DLoadSaveMenu::Responder (event_t *ev) { if (ev->type == EV_GUI_Event) { if (ev->subtype == EV_GUI_KeyDown) { if (Selected != -1) { switch (ev->data1) { case GK_F1: if (!SaveGames[Selected]->Filename.IsEmpty()) { char workbuf[512]; mysnprintf (workbuf, countof(workbuf), "File on disk:\n%s", SaveGames[Selected]->Filename.GetChars()); if (SaveComment != NULL) { V_FreeBrokenLines (SaveComment); } SaveComment = V_BreakLines (SmallFont, 216*screen->GetWidth()/640/CleanXfac, workbuf); } return true; case GK_DEL: case '\b': { FString EndString; EndString.Format("%s" TEXTCOLOR_WHITE "%s" TEXTCOLOR_NORMAL "?\n\n%s", GStrings("MNU_DELETESG"), SaveGames[Selected]->Title, GStrings("PRESSYN")); M_StartMessage (EndString, 0); } return true; } } } else if (ev->subtype == EV_GUI_WheelUp) { if (TopItem > 0) TopItem--; return true; } else if (ev->subtype == EV_GUI_WheelDown) { if (TopItem < (int)SaveGames.Size() - listboxRows) TopItem++; return true; } } return Super::Responder(ev); } //============================================================================= // // // //============================================================================= class DSaveMenu : public DLoadSaveMenu { DECLARE_CLASS(DSaveMenu, DLoadSaveMenu) FSaveGameNode NewSaveNode; public: DSaveMenu(DMenu *parent = NULL, FListMenuDescriptor *desc = NULL); void Destroy(); void DoSave (FSaveGameNode *node); bool Responder (event_t *ev); bool MenuEvent (int mkey, bool fromcontroller); }; IMPLEMENT_CLASS(DSaveMenu) //============================================================================= // // // //============================================================================= DSaveMenu::DSaveMenu(DMenu *parent, FListMenuDescriptor *desc) : DLoadSaveMenu(parent, desc) { strcpy (NewSaveNode.Title, ""); NewSaveNode.bNoDelete = true; SaveGames.Insert(0, &NewSaveNode); TopItem = 0; if (LastSaved == -1) { Selected = 0; } else { Selected = LastSaved + 1; } ExtractSaveData (Selected); } //============================================================================= // // // //============================================================================= void DSaveMenu::Destroy() { if (SaveGames[0] == &NewSaveNode) { SaveGames.Delete(0); if (Selected == 0) Selected = -1; else Selected--; } } //============================================================================= // // // //============================================================================= void DSaveMenu::DoSave (FSaveGameNode *node) { if (node != &NewSaveNode) { G_SaveGame (node->Filename.GetChars(), savegamestring); } else { // Find an unused filename and save as that FString filename; int i; FILE *test; for (i = 0;; ++i) { filename = G_BuildSaveName ("save", i); test = fopen (filename, "rb"); if (test == NULL) { break; } fclose (test); } G_SaveGame (filename, savegamestring); } M_ClearMenus(); BorderNeedRefresh = screen->GetPageCount (); } //============================================================================= // // // //============================================================================= bool DSaveMenu::MenuEvent (int mkey, bool fromcontroller) { if (Super::MenuEvent(mkey, fromcontroller)) { return true; } if (Selected == -1) { return false; } if (mkey == MKEY_Enter) { if (Selected != 0) { strcpy (savegamestring, SaveGames[Selected]->Title); } else { savegamestring[0] = 0; } DMenu *input = new DTextEnterMenu(this, savegamestring, SAVESTRINGSIZE, 1, fromcontroller); M_ActivateMenu(input); mEntering = true; } else if (mkey == MKEY_Input) { mEntering = false; DoSave(SaveGames[Selected]); } else if (mkey == MKEY_Abort) { mEntering = false; } return false; } //============================================================================= // // // //============================================================================= bool DSaveMenu::Responder (event_t *ev) { if (ev->subtype == EV_GUI_KeyDown) { if (Selected != -1) { switch (ev->data1) { case GK_DEL: case '\b': // cannot delete 'new save game' item if (Selected == 0) return true; break; case 'N': Selected = TopItem = 0; UnloadSaveData (); return true; } } } return Super::Responder(ev); } //============================================================================= // // // //============================================================================= class DLoadMenu : public DLoadSaveMenu { DECLARE_CLASS(DLoadMenu, DLoadSaveMenu) public: DLoadMenu(DMenu *parent = NULL, FListMenuDescriptor *desc = NULL); bool MenuEvent (int mkey, bool fromcontroller); }; IMPLEMENT_CLASS(DLoadMenu) //============================================================================= // // // //============================================================================= DLoadMenu::DLoadMenu(DMenu *parent, FListMenuDescriptor *desc) : DLoadSaveMenu(parent, desc) { TopItem = 0; if (LastAccessed != -1) { Selected = LastAccessed; } ExtractSaveData (Selected); } //============================================================================= // // // //============================================================================= bool DLoadMenu::MenuEvent (int mkey, bool fromcontroller) { if (Super::MenuEvent(mkey, fromcontroller)) { return true; } if (Selected == -1 || SaveGames.Size() == 0) { return false; } if (mkey == MKEY_Enter) { G_LoadGame (SaveGames[Selected]->Filename.GetChars()); if (gamestate == GS_FULLCONSOLE) { gamestate = GS_HIDECONSOLE; } if (quickSaveSlot == (FSaveGameNode*)1) { quickSaveSlot = SaveGames[Selected]; } M_ClearMenus(); BorderNeedRefresh = screen->GetPageCount (); LastAccessed = Selected; return true; } return false; }