Auto store items on container based on inscribed regex

FeLib/Include/festring.h

@@ -15,6 +15,7 @@
 
 #include <climits>
 #include <vector>
+#include <pcre.h>
 
 #include "felibdef.h"
 
@@ -119,6 +120,7 @@ class festring
   void ExtractWord(festring&);
   long GetCheckSum() const;
   void EnsureOwnsData(bool = false);
+  static pcre* CompilePCRE(pcre *pcreExistingRegexWorker, cfestring &fsPattern, festring *pfsErrorMsg=NULL);
  private:
   static void InstallIntegerMap();
   static void DeInstallIntegerMap();

FeLib/Source/festring.cpp

@@ -13,6 +13,8 @@
 #include <cctype>
 #include <cstdlib>
 #include <cstring>
+#include <iostream>
+
 #include "festring.h"
 #include "allocate.h"
 #include "error.h"
@@ -713,8 +715,13 @@ festring::sizetype festring::IgnoreCaseFind(cfestring& Where,
   return NPos;
 }
 
-/* Replaces all occurances of What in Where after Begin with With */
-
+/**
+ * Replaces all occurances of What in Where after Begin with With 
+ * @param Where
+ * @param What
+ * @param With
+ * @param Begin
+ */
 void festring::SearchAndReplace(festring& Where, cfestring& What,
                                 cfestring& With, sizetype Begin)
 {
@@ -907,3 +914,43 @@ void festring::EnsureOwnsData(bool Unique)
     CreateOwnData(Data, Size);
   }
 }
+
+/**
+ * 
+ * @param pcreExistingRegexWorker it has to be freed if was already set
+ * @param fsPattern
+ * @param bWarnOnError
+ * @return 
+ */
+pcre* festring::CompilePCRE(pcre *pcreExistingRegexWorker, cfestring &fsPattern, festring *pfsErrorMsg)
+{
+  if(pcreExistingRegexWorker)
+    pcre_free(pcreExistingRegexWorker);
+
+  if(fsPattern.IsEmpty())
+    return NULL;
+
+  const char *errMsg;
+  int iErrOffset;
+  pcreExistingRegexWorker = pcre_compile(
+    fsPattern.CStr(),
+    0, // no options
+    &errMsg, &iErrOffset,
+    0  // default char tables
+  );
+
+  if (!pcreExistingRegexWorker){
+    festring fsErr;
+    fsErr<<"Regex validation failed, if ignored will just not work at all.\n"
+         <<errMsg<<",\n"
+         <<"offset:"<<iErrOffset<<".";
+
+    DBG1(fsErr.CStr());
+    //TODO let this work with travis-ci compilation...: std::cerr<<fsErr.CStr()<<std::endl;
+
+    if(pfsErrorMsg)
+      (*pfsErrorMsg)=fsErr;
+  }
+
+  return pcreExistingRegexWorker;
+}

Main/Include/game.h

@@ -182,6 +182,8 @@ class game
   static void UpdateSRegionsXBRZ(bool bIsXBRZScale);
   static void RegionSilhouetteEnable(bool b);
   static void RegionListItemEnable(bool b);
+  static cchar* StoreMatchNameKey(item* it,bool bUnarticled=false);
+  static void AutoStoreItemInContainer(item* itToStore,character* C);
   static void UpdatePosAroundForXBRZ(v2 ScreenPos);
   static void SRegionAroundDisable();
   static void SRegionAroundAllow();
@@ -393,7 +395,7 @@ class game
   static bool ToggleShowMapNotes();
   static bool CheckAddAutoMapNote(square* =NULL);
   static int CheckAutoPickup(square* sqr = NULL);
-  static void UpdateAutoPickUpMatching();
+  static void UpdateAutoPickUpRegex();
   static int RotateMapNotes();
   static char MapNoteToken();
   static bool IsAutoPickupMatch(cfestring fsName);

Main/Include/ivandef.h

@@ -240,6 +240,7 @@ const name##prototype name::ProtoType
 #define INDEFINE_BIT 4
 #define INDEFINITE 6
 #define STRIPPED 8
+#define UNLABELED 16
 
 #define TRANSPARENT_COLOR 0xF81F // pink
 

Main/Include/miscitem.h

@@ -442,6 +442,7 @@ ITEM(itemcontainer, lockableitem)
  public:
   itemcontainer();
   itemcontainer(const itemcontainer&);
+  static truth OpenGeneric(character* Opener, stack* Stk, festring fsName, long volume, ulong ID);
   virtual ~itemcontainer();
   virtual truth Open(character*);
   virtual void Load(inputfile&);
@@ -469,10 +470,14 @@ ITEM(itemcontainer, lockableitem)
   virtual void SetParameters(int);
   virtual void Disappear();
   virtual stack* GetContained() const { return Contained; }
+  virtual void SetLabel(cfestring& What);
+  truth IsAutoStoreMatch(cfestring fs);
  protected:
   virtual col16 GetMaterialColorB(int) const;
   virtual void PostConstruct();
   stack* Contained;
+  pcre* pcreAutoStoreRegex;
+  bool bLazyInitPcre;
 };
 
 ITEM(beartrap, itemtrap<item>)

Main/Source/cmdcraft.cpp

@@ -100,16 +100,16 @@ bool craftcore::EmptyContentsIfPossible(recipedata& rpd,item* itContainer, bool
 
 /**
  * Why this is important?
- *
- * Because if the item remain on slot, and 1 turn has not passed,
+ * 
+ * Because if the item remain on slot, and 1 turn has not passed, 
  * what may happpen on crafting code in case user gives up on crafting action,
  * it will provide inconsistent inventory contents (something that was sent to hell
  * but is still on inventory as the turn has not passed to properly send it to hell).
- *
+ * 
  * If all the above is correctly understood as "it is how thing work",
  * then crafting should be fixed to always pass one turn even if user giveup?
  * But that doesnt looks good, giveup = cancel, should not pass a turn at all.
- *
+ * 
  * This shall be used for anything related to crafting until something better is coded.
  */
 void craftcore::SendToHellSafely(item* it)
@@ -2096,7 +2096,10 @@ struct srpInspect : public recipe{
     material* matM = it0->GetMainMaterial();
     material* matS = it0->GetSecondaryMaterial();
     festring fs;
-    fs<<it0->GetName(DEFINITE)<<" is made of ";
+    fs << it0->GetName(DEFINITE) 
+       << " (" << game::StoreMatchNameKey(it0) << " or " //used by auto-store items on containers, so here is the place to determine it's value
+       <<         game::StoreMatchNameKey(it0,true) << ")"
+       << " is made of ";
     if(matM)fs<<matM->GetName(UNARTICLED);
     if(matS){
       if(matM)fs<<" and "; //actually, there is only 2nd material if there is main but anyway...

Main/Source/command.cpp

@@ -686,6 +686,8 @@ truth commandsystem::PickUp(character* Char)
           if(game::IsAutoPickupMatch(PileVector[0][c]->GetName(DEFINITE))){
             PileVector[0][c]->ClearTag('d'); //intentionally drop tag dismissed for autopickup regex match
           }
+
+          game::AutoStoreItemInContainer(PileVector[0][c],Char);
         }
 
         ADD_MESSAGE("%s picked up.", PileVector[0][0]->GetName(INDEFINITE, Amount).CStr());
@@ -1145,7 +1147,8 @@ truth commandsystem::WhatToEngrave(character* Char,bool bEngraveMapNote,v2 v2Eng
           break;
 
         festring What = ToAddLabel[0]->GetLabel();
-        if(game::StringQuestion(What, CONST_S("What would you like to inscribe on this item?"), WHITE, 0, 20, true) == NORMAL_EXIT)
+        int iMaxChars=150; // item labels can contain user custom hints to let the algorithm use these to perform automatic actions
+        if(game::StringQuestion(What, CONST_S("What would you like to inscribe on this item?"), WHITE, 0, iMaxChars, true) == NORMAL_EXIT)
           for(int i=0;i<ToAddLabel.size();i++)
             ToAddLabel[i]->SetLabel(What);
       }

Main/Source/game.cpp

@@ -1324,40 +1324,70 @@ int game::RotateMapNotes()
   return iMapNotesRotation;
 }
 
-std::vector<festring> afsAutoPickupMatch;
-pcre *reAutoPickup=NULL;
-void game::UpdateAutoPickUpMatching() //simple matching syntax
+/**
+ * 
+ * @param it
+ * @param bUnarticled if false is GetNameSingular()
+ * @return 
+ */
+cchar* game::StoreMatchNameKey(item* it,bool bUnarticled)
 {
-  afsAutoPickupMatch.clear();
-
-  bool bSimple=false;
-  if(bSimple){ //TODO just drop the simple code? or start the string with something to let it be used instead of regex? tho is cool to let ppl learn regex :)
-    if(ivanconfig::GetAutoPickUpMatching().GetSize()==0 || ivanconfig::GetAutoPickUpMatching()[0]=='!')return;
+  static festring fsRet,fsSpace=" ",fsEmpty="";
+  static cchar* cToken="+";
+
+  fsRet="";
+  fsRet<<cToken;
+  if(bUnarticled)
+    fsRet<<it->GetName(UNARTICLED|UNLABELED);
+  else
+    fsRet<<it->GetNameSingular()<<cToken;
+
+  festring::SearchAndReplace(fsRet,fsSpace,fsEmpty,0);
+
+  return fsRet.CStr();
+}
 
-    std::stringstream ss(ivanconfig::GetAutoPickUpMatching().CStr());
-    std::string match;
-    while(std::getline(ss,match,'|'))
-      afsAutoPickupMatch.push_back(festring(match.c_str()));
-  }else{
-    //TODO test regex about: ignoring broken lanterns and bottles, ignore sticks on fire but pickup scrolls on fire
-  //  static bool bDummyInit = [](){reAutoPickup=NULL;return true;}();
-    const char *errMsg;
-    int iErrOffset;
-    if(reAutoPickup)pcre_free(reAutoPickup);
-    reAutoPickup = pcre_compile(
-      ivanconfig::GetAutoPickUpMatching().CStr(), //pattern
-      0, //no options
-      &errMsg,    &iErrOffset,
-      0); // default char tables
-    if (!reAutoPickup){
-      std::vector<festring> afsFullProblems;
-      afsFullProblems.push_back(festring(errMsg));
-      afsFullProblems.push_back(festring()+"offset:"+iErrOffset);
-      bool bDummy = iosystem::AlertConfirmMsg("regex validation failed, if ignored will just not work at all",afsFullProblems,false);
+void game::AutoStoreItemInContainer(item* itToStore,character* C)
+{
+  if(!C->IsPlayer())
+    return;
+
+  static itemvector vit;vit.clear();
+  C->GetStack()->FillItemVector(vit);
+  for(int i=0;i<vit.size();i++){
+    DBGITEM(vit[i],"checkingIfIsAContainer");
+    itemcontainer* itc = dynamic_cast<itemcontainer*>(vit[i]);
+    if(itc){
+      long lRemainingVol = itc->GetStorageVolume() - itc->GetContained()->GetVolume();
+      DBG3(lRemainingVol,itToStore->GetVolume(),itc->GetLabel().CStr());
+      if(lRemainingVol<itToStore->GetVolume())
+        continue;
+
+      if(itc->IsAutoStoreMatch(itToStore->GetName(DEFINITE))){
+        itToStore->RemoveFromSlot();
+        itc->GetContained()->AddItem(itToStore);
+        ADD_MESSAGE("%s was safely stored in %s",itToStore->GetName(DEFINITE).CStr(),itc->GetName(DEFINITE).CStr());
+        break;
+      }
     }
   }
 }
+
+pcre *reAutoPickup=NULL;
+void game::UpdateAutoPickUpRegex()
+{
+  //TODO test regex about: ignoring broken lanterns and bottles, ignore sticks on fire but pickup scrolls on fire
+  festring fsErr;
+  reAutoPickup = festring::CompilePCRE(reAutoPickup,ivanconfig::GetAutoPickUpMatching(),&fsErr);
+  if(!fsErr.IsEmpty()){
+    std::vector<festring> afsFullProblems;
+    afsFullProblems.push_back(fsErr);
+    bool bDummy = iosystem::AlertConfirmMsg("Failed updating auto-pickup regex.",afsFullProblems,false);
+  }
+}
 bool game::IsAutoPickupMatch(cfestring fsName) {
+  if(!reAutoPickup)
+    return false;
   return pcre_exec(reAutoPickup, 0, fsName.CStr(), fsName.GetSize(), 0, 0, NULL, 0) >= 0;
 }
 int game::CheckAutoPickup(square* sqr)
@@ -1370,34 +1400,31 @@ int game::CheckAutoPickup(square* sqr)
 
   lsquare* lsqr = (lsquare*)sqr;
 
-  static bool bDummyInit = [](){UpdateAutoPickUpMatching();return true;}();
+  static bool bDummyInit = [](){UpdateAutoPickUpRegex();return true;}();
   itemvector iv;
   lsqr->GetStack()->FillItemVector(iv);
   int iTot=0;
   for(int i=0;i<iv.size();i++){
     item* it = iv[i];
     if(it->GetRoom() && it->GetRoom()->GetMaster())continue; //not from owned rooms
-    if(it->GetSpoilLevel()>0)continue;
+    if(it->GetSpoilLevel()>0)continue; //just a guess no one auto-wants it
+
     bool b=false;
     if(!b && ivanconfig::IsAutoPickupThrownItems() && it->HasTag('t') )b=true; //was thrown
-    if(!b && !it->HasTag('d')){
-      if(reAutoPickup!=NULL){
-        if(IsAutoPickupMatch(it->GetName(DEFINITE))){
-          b=true;
-        }
-      }
-    }
-    if(!b){ //TODO use player's perception, in case of a stack of items, to allow random pickup based on item volume (size) where smaller = harder like tiny rings, to compensate for the easiness of not losing a round having to pick up the item interactively
-      for(int i=0;i<afsAutoPickupMatch.size();i++){ //each simple match
-        if(it->GetNameSingular().Find(afsAutoPickupMatch[i].CStr(),0) != festring::NPos){
-          b=true;
-          break; //each simple match loop
-        }
-      }
+    if(!b && !it->HasTag('d')){ //was NOT intentionally dropped (dropping adds such tag)
+      /**
+       * TODO ?
+       * Use player's perception, in case of a stack of items, 
+       * to allow random pickup based on item volume (size) where smaller = harder like tiny rings, 
+       * to compensate for the easiness of not losing a round having to pick up the item interactively.
+       * But it may just be annnoying...
+       */
+      b = IsAutoPickupMatch(it->GetName(DEFINITE));
     }
     if(b){
       it->MoveTo(PLAYER->GetStack());
       ADD_MESSAGE("%s picked up.", it->GetName(INDEFINITE).CStr());
+      AutoStoreItemInContainer(it,PLAYER);
       iTot++;
     }
   }

Main/Source/iconf.cpp

@@ -52,7 +52,12 @@ stringoption ivanconfig::SelectedBkgColor("SelectedBkgColor",
                                           &SelectedBkgColorChanger);
 stringoption ivanconfig::AutoPickUpMatching("AutoPickUpMatching",
                                           "Auto pick up regex",
-                                          "Automatically pick up items according to a regular expression. To disable something, you can invalidate it with '_' without removing it from the expression (eg. '_dagger'). To disable everything at once, begin this config option with '!'. Due to current constraints on length of options, editing is easier to do externally for now.",  //TODO if multiline text editing is implemented, remove the last help statement.
+                                          "Automatically pick up items according to a regular expression.\n"
+                                            " To disable something, you can invalidate it with '_' without removing it from the expression (eg. '_dagger').\n"
+                                            " To disable everything at once, begin this config option with '!'.\n"
+                                            " Containers inscribed with eg. '+key+ring+scroll' will auto store such items,\n"
+                                            "  and you can determine what to inscribe by craft/inspecting the items.\n"
+                                            " Due to current constraints on length of options, editing is easier to do externally for now.",  //TODO if multiline text editing is implemented, remove the last help statement.
                                           "!((book|can|dagger|grenade|horn of|kiwi|key|ring|scroll|wand|whistle)|^(?:(?!(broken|empty)).)*(bottle|vial)|sol stone)",
                                           &configsystem::NormalStringDisplayer,
                                           &AutoPickUpMatchingChangeInterface,
@@ -911,7 +916,7 @@ void ivanconfig::AutoPickUpMatchingChanger(stringoption* O, cfestring& What)
   if(O!=NULL){
     O->Value.Empty();
     O->Value<<What;
-    game::UpdateAutoPickUpMatching();
+    game::UpdateAutoPickUpRegex();
   }
 }
 

Main/Source/item.cpp

@@ -530,7 +530,7 @@ void item::AddName(festring& Name, int Case) const
 {
   object::AddName(Name,Case);
 
-  if(label.GetSize())
+  if(!(Case&UNLABELED) && label.GetSize())
     Name << " inscribed " << label;
 }