From 4f74b6d8494231910ead2a7fd1b195597f4c7cde Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A9a=20Saviot?= <lea.saviot@numworks.com>
Date: Fri, 10 Nov 2017 17:49:05 +0100
Subject: [PATCH] [code] The addScript button disappears when needed.

When there is already the maximal number of scripts or when the
ScriptStore accordion buffer is full.

Change-Id: I0d43d42626da7f060a2309c66f1806b35a29bf38
---
 apps/code/menu_controller.cpp     | 17 +++++++++++------
 apps/code/menu_controller.h       |  4 +++-
 apps/code/script_store.cpp        |  5 ++++-
 apps/code/script_store.h          |  4 ++++
 escher/include/escher/accordion.h |  2 +-
 escher/src/accordion.cpp          | 28 ++++++++++++++--------------
 6 files changed, 37 insertions(+), 23 deletions(-)

diff --git a/apps/code/menu_controller.cpp b/apps/code/menu_controller.cpp
index 680603e56..5e3263f4a 100644
--- a/apps/code/menu_controller.cpp
+++ b/apps/code/menu_controller.cpp
@@ -40,7 +40,7 @@ void MenuController::didBecomeFirstResponder() {
     app()->setFirstResponder(&m_consoleButton);
     return;
   }
-  assert(m_selectableTableView.selectedRow() < numberOfRows());
+  assert(m_selectableTableView.selectedRow() < m_scriptStore->numberOfScripts());
   app()->setFirstResponder(&m_selectableTableView);
 }
 
@@ -62,7 +62,7 @@ bool MenuController::handleEvent(Ion::Events::Event event) {
     if (selectedRow >= 0 && selectedRow < m_scriptStore->numberOfScripts()) {
       configureScript();
       return true;
-    } else if (selectedRow == m_scriptStore->numberOfScripts()) {
+    } else if (shouldDisplayAddScriptRow() && selectedRow == m_scriptStore->numberOfScripts()) {
       addScript();
       return true;
     }
@@ -80,6 +80,7 @@ void MenuController::setParameteredScript() {
 }
 
 void MenuController::addScript() {
+  assert(m_scriptStore->numberOfScripts() < k_maxNumberOfScripts);
   if (m_scriptStore->addNewScript()) {
     m_selectableTableView.reloadData();
     renameScriptAtIndex(m_scriptStore->numberOfScripts()-1);
@@ -109,10 +110,14 @@ void MenuController::reloadConsole() {
   m_consoleController.unloadPythonEnvironment();
 }
 
+bool MenuController::shouldDisplayAddScriptRow() {
+  return (m_scriptStore->numberOfScripts() < k_maxNumberOfScripts
+        && !m_scriptStore->isFull());
+}
+
 int MenuController::numberOfRows() {
-  return m_scriptStore->numberOfScripts() + 1;
-  //TODO do not add the addScript row if there can be no more scripts stored.
-};
+  return m_scriptStore->numberOfScripts() + shouldDisplayAddScriptRow();
+}
 
 KDCoordinate MenuController::rowHeight(int j) {
   return cellHeight();
@@ -152,7 +157,7 @@ int MenuController::reusableCellCount(int type) {
 int MenuController::typeAtLocation(int i, int j) {
   assert(i==0);
   assert(j>=0 && j<numberOfRows());
-  if (j == numberOfRows()-1) {
+  if (j == numberOfRows()-1 && shouldDisplayAddScriptRow()) {
     return AddScriptCellType;
   } else {
     return ScriptCellType;
diff --git a/apps/code/menu_controller.h b/apps/code/menu_controller.h
index 5d785b669..e0cf829f1 100644
--- a/apps/code/menu_controller.h
+++ b/apps/code/menu_controller.h
@@ -23,6 +23,7 @@ public:
   void renameScriptAtIndex(int i);
   void deleteScriptAtIndex(int i);
   void reloadConsole();
+  bool shouldDisplayAddScriptRow();
 
   /* ViewController */
   View * view() override { return &m_selectableTableView; }
@@ -55,7 +56,8 @@ public:
   }
 
 private:
-  static constexpr int k_maxNumberOfDisplayableScriptCells = 7; //TODO
+  static constexpr int k_maxNumberOfScripts = 8;
+  static constexpr int k_maxNumberOfDisplayableScriptCells = 5; // = 240/50
   static constexpr int AddScriptCellType = 0;
   static constexpr int ScriptCellType = 1;
   static constexpr KDCoordinate k_rowHeight = 50; //TODO create common parent class with Shared::ListController
diff --git a/apps/code/script_store.cpp b/apps/code/script_store.cpp
index c3691f040..4a8ed46e3 100644
--- a/apps/code/script_store.cpp
+++ b/apps/code/script_store.cpp
@@ -99,6 +99,10 @@ void ScriptStore::deleteAllScripts() {
   m_accordion.deleteAll();
 }
 
+bool ScriptStore::isFull() {
+  return (m_accordion.freeSpaceSize() < k_fullFreeSpaceSizeLimit);
+}
+
 const char * ScriptStore::contentOfScript(const char * name) {
   Script script = scriptNamed(name);
   if (script.isNull()) {
@@ -107,7 +111,6 @@ const char * ScriptStore::contentOfScript(const char * name) {
   return script.content();
 }
 
-
 bool ScriptStore::addScriptFromTemplate(const ScriptTemplate * scriptTemplate) {
   const char autoImportationString[2] = {Script::DefaultAutoImportationMarker, 0};
   if (!m_accordion.appendBuffer(autoImportationString)) {
diff --git a/apps/code/script_store.h b/apps/code/script_store.h
index 567a67c89..b798d1241 100644
--- a/apps/code/script_store.h
+++ b/apps/code/script_store.h
@@ -28,11 +28,15 @@ public:
   void switchAutoImportAtIndex(int index);
   void deleteScriptAtIndex(int index);
   void deleteAllScripts();
+  bool isFull();
 
   /* MicroPython::ScriptProvider */
   const char * contentOfScript(const char * name) override;
 
 private:
+  static constexpr int k_fullFreeSpaceSizeLimit = 50;
+  // If m_accordion's free space has a size smaller than
+  // k_fullFreeSpaceSizeLimit, we consider the script store as full.
   static constexpr size_t k_scriptDataSize = 4096;
   bool addScriptFromTemplate(const ScriptTemplate * scriptTemplate);
   bool copyStaticScriptOnFreeSpace(const ScriptTemplate * scriptTemplate);
diff --git a/escher/include/escher/accordion.h b/escher/include/escher/accordion.h
index 5c6a241b7..d6998d776 100644
--- a/escher/include/escher/accordion.h
+++ b/escher/include/escher/accordion.h
@@ -20,12 +20,12 @@ public:
   void deleteBufferAtIndex(int index);
   void deleteLastBuffer();
   void deleteAll();
+  int freeSpaceSize();
 private:
   static constexpr char k_freeSpaceMarker = 0x01;
   int startOfBufferAtIndex(int index);
   int endOfBufferAtIndex(int index);
   int startOfFreeSpace();
-  int freeSpaceSize();
   void cleanFreeSpace();
   /* When a buffer is edited, there is garbage after the first null char of the
    * buffer. cleanFreeSpace() declares the space after this null char as free,
diff --git a/escher/src/accordion.cpp b/escher/src/accordion.cpp
index 07f71bcf2..af97730c4 100644
--- a/escher/src/accordion.cpp
+++ b/escher/src/accordion.cpp
@@ -101,6 +101,20 @@ void Accordion::deleteAll() {
   m_numberOfBuffers = 0;
 }
 
+int Accordion::freeSpaceSize() {
+  cleanFreeSpace();
+  int sizeOfFreeSpace = 0;
+  int freeSpaceStart = startOfFreeSpace();
+  for (int i = freeSpaceStart; i < m_historySize; i++) {
+    if (m_history[i] == k_freeSpaceMarker) {
+      sizeOfFreeSpace++;
+    } else {
+      return sizeOfFreeSpace;
+    }
+  }
+  return sizeOfFreeSpace;
+}
+
 int Accordion::startOfBufferAtIndex(int index) {
   assert(index >= 0 && index < numberOfBuffers());
   cleanFreeSpace();
@@ -148,20 +162,6 @@ int Accordion::startOfFreeSpace() {
   return 0;
 }
 
-int Accordion::freeSpaceSize() {
-  cleanFreeSpace();
-  int sizeOfFreeSpace = 0;
-  int freeSpaceStart = startOfFreeSpace();
-  for (int i = freeSpaceStart; i < m_historySize; i++) {
-    if (m_history[i] == k_freeSpaceMarker) {
-      sizeOfFreeSpace++;
-    } else {
-      return sizeOfFreeSpace;
-    }
-  }
-  return sizeOfFreeSpace;
-}
-
 void Accordion::cleanFreeSpace() {
   if (m_history[m_startOfLastEditedBuffer] == k_freeSpaceMarker) {
     return;