Improve openings database code

TODO.md

@@ -9,7 +9,7 @@
  - [x] Disable the save button in GameTab after saving (and re-enable it on new changes)
  - [ ] Make PGNGameBase use GotoNextGame() instead of ParseNextGame() in the NextGame() method to improve performance
  - [x] Clean and debug DragNDrop in BoardCanvas
- - [ ] Disable the "Analyze entire game" button (Not Yet Implemented)
+ - [x] Disable the "Analyze entire game" button (Not Yet Implemented)
  - [x] Keep engine evaluation bar visible (and best move arrows) as long as the live engine dialog is open
  
  ## Additional Features
@@ -17,7 +17,7 @@
  - [x] Be able to draw arrows on the Board
  - [x] Highlight the last played move
  - [ ] Be able to play against an engine
- - [ ] Implement full chess engine game analyzer/annotator
+ - [ ] Implement full chess engine game analyzer/annotator (analyze entire game)
  - [ ] Handle .si4 databases
  - [ ] Implement a page system for large databases (load massive databases per pages instead of entirely)
  - [ ] Add a tool in the toolbar of GameTabLeftPanel to run the live engine analysis using the last engine

libs/pgnp

@@ -1 +1 @@
-Subproject commit bebbc7982482a2271096ef53c778cd93a4bbff7a
+Subproject commit 2ac42558f2b6269ad4d8e0809519f96aae1fd342

src/Openings.cpp

@@ -0,0 +1,106 @@
+#include "Openings.hpp"
+#include <sstream>
+
+/**
+ * @brief Count the number of similar moves in between two lines
+ * 
+ * @param m1 
+ * @param m2 
+ * @return int 
+ */
+inline int CompareMainlines(const pgnp::HalfMove *m1,const  pgnp::HalfMove *m2){
+    int count=0;
+    const pgnp::HalfMove *n1=m1;
+    const pgnp::HalfMove *n2=m2;
+    while(n1 && n2 != nullptr){
+        if(n1->move == n2->move)
+            count++;
+        else
+            break;
+        n1=n1->MainLine;
+        n2=n2->MainLine;
+    }
+    return count;
+}
+
+Openings::Openings() {
+    std::string tsv(a_tsv);
+    LoadVolume(tsv,&A);
+    tsv=std::string(b_tsv);
+    LoadVolume(tsv,&B);
+    tsv=std::string(c_tsv);
+    LoadVolume(tsv,&C);
+    tsv=std::string(d_tsv);
+    LoadVolume(tsv,&D);
+    tsv=std::string(e_tsv);
+    LoadVolume(tsv,&E);
+}
+
+void Openings::SearchOpening(const pgnp::HalfMove *moves,std::string &name, std::string &eco){
+    // Now goto the right volume
+    std::vector<Volume*> vols={&A,&B,&C,&D,&E};
+    if(moves->GetLength()>=2){
+        if(moves->move == "e4"){
+            if(moves->MainLine->move == "e6"|| moves->MainLine->move == "e5")
+                vols={&C};
+            else
+                vols={&B};
+        }
+        // TODO: Improve volumes filtering
+    }
+    // Then search for opening name:
+    int matches=0;
+    for(Volume *v: vols){
+        for(auto &entry: *v){
+            std::string &eco_=std::get<0>(entry);
+            std::string &name_=std::get<1>(entry);
+            std::string &pgn_=std::get<2>(entry);
+            pgnp::HalfMove *moves_=new pgnp::HalfMove();
+            pgnp::ParseSANMoves(pgn_,moves_);
+            int nmatches=CompareMainlines(moves,moves_);
+            if(nmatches>matches && nmatches == moves_->GetLength()){
+                name=name_;
+                eco=eco_;
+                matches=nmatches;
+                if(moves->GetLength()==moves_->GetLength()){
+                    delete moves_;
+                    return;
+                }
+            }
+            delete moves_;
+        }
+    }
+}
+
+void Openings::GuessOpening(const std::string &SANMoves, std::string &name, std::string &eco){
+    pgnp::HalfMove *m=new pgnp::HalfMove();
+    pgnp::ParseSANMoves(SANMoves,m);
+    SearchOpening(m,name,eco);
+    delete m;
+}
+
+void Openings::GuessOpening(const pgnp::HalfMove *moves, std::string &name, std::string &eco){
+    SearchOpening(moves,name,eco);
+}
+
+void Openings::LoadVolume(const std::string &tsv, Volume *vol){
+    std::istringstream f(tsv);
+    std::string line;    
+    while (std::getline(f, line)) {
+        int eco=-1,name=-1,pgn=-1;
+        for(int i=0;i<line.size();i++){
+            if(line[i]=='\t'){
+                if(eco == -1)
+                    eco=i-1;
+                else if(name==-1)
+                    name=i-1;
+                else
+                    pgn=i;
+            }
+        }
+        vol->push_back(std::make_tuple(
+        line.substr(0,eco+1),
+        line.substr(eco+2,name-eco-1),
+        line.substr(name+2,pgn-name)));
+    }
+}

src/Openings.hpp

@@ -0,0 +1,21 @@
+#pragma once
+
+#include "binres/openings.hpp"
+#include "pgnp.hpp"
+
+/**
+ * @brief Guess the opening using the Lichess Opening Database
+ * See: https://github.com/lichess-org/chess-openings
+ */
+class Openings {
+    typedef std::vector<std::string> MoveList;
+    typedef std::vector<std::tuple<std::string,std::string,std::string>> Volume;
+
+    Volume A,B,C,D,E;
+    void SearchOpening(const pgnp::HalfMove *moves,std::string &name, std::string &eco);
+    void LoadVolume(const std::string &tsv, Volume *vol);
+public:
+    void GuessOpening(const std::string &SANMoves, std::string &name, std::string &eco);
+    void GuessOpening(const pgnp::HalfMove *moves, std::string &name, std::string &eco);
+    Openings();
+};

src/binres/binres.cpp

@@ -23,4 +23,5 @@ wxBitmap LoadPNG(std::string icon) {
     return (wxBITMAP_PNG(mat));
   }
   return (wxNullBitmap);
-}
+}
+

src/binres/binres.hpp

@@ -10,4 +10,5 @@
 #include "mat_png.hpp"
 
 wxBitmap LoadPNG(std::string icon, wxSize size);
-wxBitmap LoadPNG(std::string icon);
+wxBitmap LoadPNG(std::string icon);
+

src/game_tab/Game.cpp

@@ -131,6 +131,39 @@ bool Game::Play(std::string move,char promotion) {
   return (false);
 }
 
+void Game::GetOpening(std::string &name,std::string &eco){
+  HalfMove *m=current;
+  if(m == nullptr)
+    m=moves;
+  if(m!=nullptr){
+    // First check if opening already set
+    std::string cname,ceco;
+    m->GetOpening(cname,ceco);
+    if(ceco.size()>0){
+      name=cname;
+      eco=ceco;
+    }else {
+      // If not, get the current move line (or first move)
+      // and try to guess opening
+      auto line=m->GetLine(); // Vector of HalfMove
+      std::string pgn;
+      int count=1;
+      for(int i=0;i<line.size();i++){
+        if(i%2==0){
+          pgn+=std::to_string(count)+".";
+          count+=1;
+        }
+        pgn+=line[i]->move +" ";
+      }
+      // If there is a line, try to guess the opening
+      if(pgn.size()>0){
+        wxGetApp().GetBook().GuessOpening(pgn,name,eco);
+        m->SetOpening(name,eco);
+      }
+    }
+  }
+}
+
 void Game::Previous() {
   if (current != nullptr) {
     current = current->GetParent();

src/game_tab/Game.hpp

@@ -35,6 +35,7 @@ public:
   HalfMove *GetMoves();
   std::string GetFen();
   std::string GetResult();
+  void GetOpening(std::string &name,std::string &eco);
   /// @brief Play the given absolute move
   bool Play(std::string move,char promotion='q');
   bool IsBlackToPlay();

src/game_tab/HalfMove.cpp

@@ -20,6 +20,38 @@ HalfMove::~HalfMove() {
   }
 }
 
+void HalfMove::SetOpening(const std::string &name, const std::string &eco){
+  HalfMove *m=this;
+  while(m!=nullptr){
+    m->opening=name;
+    m->eco=eco;
+    if(m->parent != nullptr && m->parent->mainline==m)
+      m=m->parent;
+    else
+      break;
+  }
+}
+
+void HalfMove::GetOpening(std::string &name, std::string &eco){
+  name=this->opening;
+  eco=this->eco;
+}
+
+std::vector<HalfMove *> HalfMove::GetLine(){
+  std::vector<HalfMove *> line;
+  HalfMove *m=this;
+  while(m!=nullptr){
+    line.push_back(m);
+    // Check if in a variation:
+    if(m->parent!=nullptr && m->parent->mainline!=m)
+      m=m->parent->parent; // Because we are in a variation
+    else
+      m=m->parent;
+  }
+  std::reverse(line.begin(), line.end());
+  return line;
+}
+
 HalfMove::HalfMove(HalfMove *m){
   src=m->src;
   dst=m->dst;

src/game_tab/HalfMove.hpp

@@ -20,6 +20,8 @@ class HalfMove : public cgeditor::CGEHalfMove {
   void BuildAndVerify(HalfMove *m, std::string fen);
   /// @brief Store the source and destination square of the current move (mainly used for pieces animation)
   std::string src,dst;
+  /// @brief Opening reach by that move while taking into account all the parents
+  std::string opening, eco;
 
 public:
   HalfMove(HalfMove *m);
@@ -49,9 +51,13 @@ public:
   HalfMove *GetParent();
   HalfMove *GetMainline();
   std::vector<HalfMove *> GetVariations();
-
+  /// @brief Retrieve the list of moves from the current one to the first one
+  std::vector<HalfMove *> GetLine();
   std::map<char, std::uint8_t> GetLineCaptures();
-
+  /// @brief The opening name of current line
+  void SetOpening(const std::string &name, const std::string &eco);
+  /// @brief Getters for name and eco
+  void GetOpening(std::string &name, std::string &eco);
   /// @brief Set parent of the current move
   void SetParent(HalfMove *m);
   std::string GetFen();

src/game_tab/left_panel/GameTabLeftPanel.cpp

@@ -81,7 +81,6 @@ void GameTabLeftPanel::OnPlay(wxCommandEvent &event) {
       ProcessEvent(event);
     }
   }
-
   Notify(true); // Redraw event is move failed! Otherwise piece not resets to it initial position after dragging
 }
 

src/game_tab/right_panel/GameTabRightPanel.cpp

@@ -11,7 +11,7 @@ GameTabRightPanel::GameTabRightPanel(wxFrame *parent, std::shared_ptr<Game> game
   tags_list->InsertColumn(1, L"Value", wxLIST_FORMAT_LEFT, 500);
   tagTextCtrl->SetHint("Tag");
   valueTextCtrl->SetHint("Value");
-
+  opening_label->SetHint("Current opening");
   RefreshTagsList();
 
   // Bind events
@@ -42,6 +42,7 @@ GameTabRightPanel::GameTabRightPanel(wxFrame *parent, std::shared_ptr<Game> game
   Bind(wxEVT_KEY_UP, [p=this](wxKeyEvent &e){e.ResumePropagation(1);e.Skip();});
 
   ApplyPreferences();
+  analyze_game_button->Disable();
 }
 
 void GameTabRightPanel::OnLiveAnalysis(wxCommandEvent &event) {
@@ -156,6 +157,11 @@ void GameTabRightPanel::Notify() {
   if (live_engine != nullptr) {
     live_engine->SetFEN(game->GetFen());
   }
+  // Update opening name
+  std::string opening,eco;
+  game->GetOpening(opening,eco);
+  if(eco.size()>0)
+    opening_label->SetValue(eco+": "+opening);
 }
 
 void GameTabRightPanel::ApplyPreferences() {

src/gui.cpp

@@ -434,6 +434,9 @@ TabGameRightPanel::TabGameRightPanel( wxWindow* parent, wxWindowID id, const wxP
 	editor_page = new wxPanel( notebook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
 	editor_page_sizer = new wxBoxSizer( wxVERTICAL );
 
+	opening_label = new wxTextCtrl( editor_page, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxTE_READONLY );
+	editor_page_sizer->Add( opening_label, 0, wxALL|wxEXPAND, 5 );
+
 	editor_canvas_sizer = new wxBoxSizer( wxVERTICAL );
 
 

src/gui.h

@@ -284,6 +284,7 @@ class TabGameRightPanel : public wxPanel
 		wxNotebook* notebook;
 		wxPanel* editor_page;
 		wxBoxSizer* editor_page_sizer;
+		wxTextCtrl* opening_label;
 		wxBoxSizer* editor_canvas_sizer;
 		wxStaticLine* m_staticline1;
 		wxStaticText* comment_label;

src/ochess.cpp

@@ -19,6 +19,8 @@ std::vector<TabInfos *> MyApp::ListTabInfos() {
   return (tinfos);
 }
 
+Openings& MyApp::GetBook() { return Book; }
+
 void MyApp::NewGame(TabInfos *tabsrc,std::shared_ptr<Game> g){
   MainWindow *w=((MainWindow *)this->GetTopWindow());
   TabInfos *i=w->NewGame(g);

src/ochess.hpp

@@ -6,6 +6,7 @@
 #endif
 
 #include "binres/binres.hpp"
+#include "Openings.hpp"
 #include "gui.h"
 #include <memory>
 #include <wx/app.h>
@@ -72,10 +73,12 @@ public:
  */
 class MyApp : public wxApp {
 public:
+  Openings Book;
   virtual bool OnInit();
   std::vector<TabInfos *> ListTabInfos();
   void NewGame(TabInfos *tabsrc,std::shared_ptr<Game> g);
   void NewGame(std::shared_ptr<Game> g);
+  Openings& GetBook();
 };
 
 wxDECLARE_APP(MyApp);

tools/openings.sh

@@ -10,21 +10,32 @@ dst="${wai}/../src/binres/"
 
 # Fetch database
 git clone "$urldb" "$tmp"
-
-# Generate c_str from database
 cd $tmp
-wxbin2c a.tsv a_tsv.hpp
-wxbin2c b.tsv b_tsv.hpp
-wxbin2c c.tsv c_tsv.hpp
-wxbin2c d.tsv d_tsv.hpp
-wxbin2c e.tsv e_tsv.hpp
 
-# Combine c_str files
+# a.tsv
-cat a_tsv.hpp > openings.hpp
+echo -n "static const char a_tsv[] =" > openings.hpp
-cat b_tsv.hpp >> openings.hpp
+sed -i '1d' a.tsv # remove header
-cat c_tsv.hpp >> openings.hpp
+cat a.tsv | sed -e "s/^/\"/g" -e "s/$/\\\n\"/g" -e '$ s/\\n"/";/g' >> openings.hpp;
-cat d_tsv.hpp >> openings.hpp
+
-cat e_tsv.hpp >> openings.hpp
+# b.tsv
+echo -n "static const char b_tsv[] =" >> openings.hpp
+sed -i '1d' b.tsv
+cat b.tsv | sed -e "s/^/\"/g" -e "s/$/\\\n\"/g" -e '$ s/\\n"/";/g' >> openings.hpp;
+
+# c.tsv
+echo -n "static const char c_tsv[] =" >> openings.hpp
+sed -i '1d' c.tsv
+cat c.tsv | sed -e "s/^/\"/g" -e "s/$/\\\n\"/g" -e '$ s/\\n"/";/g' >> openings.hpp;
+
+# d.tsv
+echo -n "static const char d_tsv[] =" >> openings.hpp
+sed -i '1d' d.tsv
+cat d.tsv | sed -e "s/^/\"/g" -e "s/$/\\\n\"/g" -e '$ s/\\n"/";/g' >> openings.hpp;
+
+# e.tsv
+echo -n "static const char e_tsv[] =" >> openings.hpp
+sed -i '1d' e.tsv
+cat e.tsv | sed -e "s/^/\"/g" -e "s/$/\\\n\"/g" -e '$ s/\\n"/";/g' >> openings.hpp;
 
 # Save
 mv openings.hpp "$dst"

tools/wxFrameBuilder.fbp

@@ -4097,7 +4097,7 @@
                 </object>
             </object>
         </object>
-        <object class="Panel" expanded="0">
+        <object class="Panel" expanded="1">
             <property name="aui_managed">0</property>
             <property name="aui_manager_style">wxAUI_MGR_DEFAULT</property>
             <property name="bg"></property>
@@ -4120,16 +4120,16 @@
             <property name="window_extra_style"></property>
             <property name="window_name"></property>
             <property name="window_style">wxTAB_TRAVERSAL</property>
-            <object class="wxBoxSizer" expanded="0">
+            <object class="wxBoxSizer" expanded="1">
                 <property name="minimum_size"></property>
                 <property name="name">main_sizer</property>
                 <property name="orient">wxVERTICAL</property>
                 <property name="permission">none</property>
-                <object class="sizeritem" expanded="0">
+                <object class="sizeritem" expanded="1">
                     <property name="border">5</property>
                     <property name="flag">wxEXPAND | wxALL</property>
                     <property name="proportion">1</property>
-                    <object class="wxNotebook" expanded="0">
+                    <object class="wxNotebook" expanded="1">
                         <property name="BottomDockable">1</property>
                         <property name="LeftDockable">1</property>
                         <property name="RightDockable">1</property>
@@ -4182,11 +4182,11 @@
                         <property name="window_extra_style"></property>
                         <property name="window_name"></property>
                         <property name="window_style"></property>
-                        <object class="notebookpage" expanded="0">
+                        <object class="notebookpage" expanded="1">
                             <property name="bitmap"></property>
                             <property name="label">Editor</property>
                             <property name="select">0</property>
-                            <object class="wxPanel" expanded="0">
+                            <object class="wxPanel" expanded="1">
                                 <property name="BottomDockable">1</property>
                                 <property name="LeftDockable">1</property>
                                 <property name="RightDockable">1</property>
@@ -4237,11 +4237,75 @@
                                 <property name="window_extra_style"></property>
                                 <property name="window_name"></property>
                                 <property name="window_style">wxTAB_TRAVERSAL</property>
-                                <object class="wxBoxSizer" expanded="0">
+                                <object class="wxBoxSizer" expanded="1">
                                     <property name="minimum_size"></property>
                                     <property name="name">editor_page_sizer</property>
                                     <property name="orient">wxVERTICAL</property>
                                     <property name="permission">protected</property>
+                                    <object class="sizeritem" expanded="1">
+                                        <property name="border">5</property>
+                                        <property name="flag">wxALL|wxEXPAND</property>
+                                        <property name="proportion">0</property>
+                                        <object class="wxTextCtrl" expanded="1">
+                                            <property name="BottomDockable">1</property>
+                                            <property name="LeftDockable">1</property>
+                                            <property name="RightDockable">1</property>
+                                            <property name="TopDockable">1</property>
+                                            <property name="aui_layer"></property>
+                                            <property name="aui_name"></property>
+                                            <property name="aui_position"></property>
+                                            <property name="aui_row"></property>
+                                            <property name="best_size"></property>
+                                            <property name="bg"></property>
+                                            <property name="caption"></property>
+                                            <property name="caption_visible">1</property>
+                                            <property name="center_pane">0</property>
+                                            <property name="close_button">1</property>
+                                            <property name="context_help"></property>
+                                            <property name="context_menu">1</property>
+                                            <property name="default_pane">0</property>
+                                            <property name="dock">Dock</property>
+                                            <property name="dock_fixed">0</property>
+                                            <property name="docking">Left</property>
+                                            <property name="enabled">1</property>
+                                            <property name="fg"></property>
+                                            <property name="floatable">1</property>
+                                            <property name="font"></property>
+                                            <property name="gripper">0</property>
+                                            <property name="hidden">0</property>
+                                            <property name="id">wxID_ANY</property>
+                                            <property name="max_size"></property>
+                                            <property name="maximize_button">0</property>
+                                            <property name="maximum_size"></property>
+                                            <property name="maxlength"></property>
+                                            <property name="min_size"></property>
+                                            <property name="minimize_button">0</property>
+                                            <property name="minimum_size"></property>
+                                            <property name="moveable">1</property>
+                                            <property name="name">opening_label</property>
+                                            <property name="pane_border">1</property>
+                                            <property name="pane_position"></property>
+                                            <property name="pane_size"></property>
+                                            <property name="permission">protected</property>
+                                            <property name="pin_button">1</property>
+                                            <property name="pos"></property>
+                                            <property name="resize">Resizable</property>
+                                            <property name="show">1</property>
+                                            <property name="size"></property>
+                                            <property name="style">wxTE_READONLY</property>
+                                            <property name="subclass">; ; forward_declare</property>
+                                            <property name="toolbar_pane">0</property>
+                                            <property name="tooltip"></property>
+                                            <property name="validator_data_type"></property>
+                                            <property name="validator_style">wxFILTER_NONE</property>
+                                            <property name="validator_type">wxDefaultValidator</property>
+                                            <property name="validator_variable"></property>
+                                            <property name="value"></property>
+                                            <property name="window_extra_style"></property>
+                                            <property name="window_name"></property>
+                                            <property name="window_style"></property>
+                                        </object>
+                                    </object>
                                     <object class="sizeritem" expanded="0">
                                         <property name="border">5</property>
                                         <property name="flag">wxEXPAND</property>