Merge pull request #785 from LedgerHQ/tdj/nbgl_use_case_cleanup

nbgl use case cleanup

Author: tdejoigny-ledger

lib_nbgl/doc/nbgl_use_case.dox

@@ -58,22 +58,12 @@ A few APIs are available to draw typical Use-Cases, such as:
 
 Some APIs have also been kept for backward compatibility, and for some rare cases:
 
-- for Home Screen:
- - @ref nbgl_useCaseHome() to draw the home screen of an application.
- - @ref nbgl_useCaseHomeExt() to draw an extended version of home screen of an application (with action button)
- - @ref nbgl_useCasePlugInHome() to draw the home screen of a Plug-In application
 - for Settings:
  - @ref nbgl_useCaseSettings() to draw a level of settings pages
 - for most used reviews:
  - @ref nbgl_useCaseReviewStart() to draw the cover page of a review (initial page, without data)
  - @ref nbgl_useCaseStaticReview() to draw the data pages of a regular review, when all info are available from the beginning (all pages but the cover one)
  - @ref nbgl_useCaseRegularReview() to draw the data pages of a regular review (all pages but the cover one)
-- for address verification:
- - @ref nbgl_useCaseAddressConfirmation() to draw an address confirmation page, with a possibility to see it as QR Code
- - @ref nbgl_useCaseAddressConfirmationExt() to draw an address confirmation page, with a possibility to see it as QR Code and some extra tag/value pairs
-- for rare reviews:
- - @ref nbgl_useCaseForwardOnlyReview() to draw the pages of a forward-only review (without back key)
- - @ref nbgl_useCaseViewDetails() to draw the pages displaying the full value of a given long data of a review
 
 @subsection use_case_home_settings Home & Settings screen Use Case
 

lib_nbgl/doc/nbgl_use_case_nanos.dox

@@ -46,11 +46,6 @@ A few APIs are available to draw typical Use-Cases, such as:
 - for most used reviews:
  - @ref nbgl_useCaseStaticReview() to draw the pages of a regular review, when all info are available from the beginning (see @subpage use_case_static_review)
  - @ref nbgl_useCaseRegularReview() to draw the pages of a regular review (all pages but the cover one) (see @subpage use_case_regular_review)
-- for rare reviews:
- - @ref nbgl_useCaseForwardOnlyReview() to draw the pages of a forward-only review (without back) (see @subpage use_case_forward_only_review)
-- for address verification:
- - @ref nbgl_useCaseAddressConfirmation() to draw an address confirmation page (see @subpage use_case_addr_confirm)
- - @ref nbgl_useCaseAddressConfirmationExt() to draw an address confirmation page, with some extra tag/value pairs (see @subpage use_case_addr_confirm_ext)
 
 @subsection use_case_home Home screen Use Case
 
@@ -247,79 +242,6 @@ void startReview(void) {
 }
 @endcode
 
-@subsection use_case_forward_only_review Forward only Review Use Case
-
-Some message/transaction reviews may be too long to be memorized, so it is only possible to move forward.
-
-In this case, no backward navigation is possible, and the number of pages cannot be defined at start-up.
-
-The API to initiate the display of the series of forward-only review pages is @ref nbgl_useCaseForwardOnlyReview(), providing:
-
-- a navigation callback called when to retrieve the content of the next page. It is also called to fill the initial page.
-
-Here is an example code:
-
-@code
-
-static uint8_t last_transaction_page;
-
-static void onApprove(void) {
-  // confirm transaction
-
-  // and go back to main
-  appMain();
-}
-
-static void onReject(void) {
-  // reject transaction
-
-  // and go back to main
-  appMain();
-}
-
-// called to get the content of the given page
-static bool navCallback(uint8_t page, nbgl_pageContent_t *content) {
-  memset(content, 0, sizeof(nbgl_pageContent_t));
-  if (page == 0) {
-    // the first page is used to display the title of the review
-    content->text = "Review\ntransaction";
-    content->icon = &C_icon_eye;
-  }
-  else if (page == (last_transaction+1)) {
-    // try to get a new tag/value pair in this transaction
-    char *tag;
-    char *value;
-    if (getNextTagValuePair(&tag, &value)) {
-      content->text = tag;
-      content->subText = value;
-      last_transaction_page = page;
-    }
-    else {
-      // this page is for approval
-      content->text =  "Approve";
-      content->icon = &C_icon_validate;
-      content->callback = onApprove;
-    }
-  }
-  else if (page == (last_transaction+2)) {
-    // this page is for rejection
-    content->text =  "Reject";
-    content->icon = &C_icon_crossmark;
-    content->callback = onReject;
-  }
-  else {
-    return false;
-  }
-  // valid page so return true
-  return true;
-}
-
-void startForwardOnlyTransaction(void) {
-  last_transaction_page = 0;
-  nbgl_useCaseForwardOnlyReview(navCallback);
-}
-@endcode
-
 @subsection use_case_static_review Static Review Use Case
 
 \image{inline} html UseCase-Nano-Review1.png "caption" width=1000

lib_nbgl/include/nbgl_use_case.h

@@ -379,14 +379,6 @@ void nbgl_useCaseHomeExt(const char                *appName,
                          nbgl_callback_t            actionCallback,
                          nbgl_callback_t            topRightCallback,
                          nbgl_callback_t            quitCallback);
-void nbgl_useCasePlugInHome(const char                *plugInName,
-                            const char                *appName,
-                            const nbgl_icon_details_t *appIcon,
-                            const char                *tagline,
-                            const char                *subTagline,
-                            bool                       withSettings,
-                            nbgl_callback_t            topRightCallback,
-                            nbgl_callback_t            quitCallback);
 void nbgl_useCaseSettings(const char                *settingsTitle,
                           uint8_t                    initPage,
                           uint8_t                    nbPages,
@@ -416,14 +408,6 @@ void nbgl_useCaseRegularReview(uint8_t                    initPage,
                                nbgl_layoutTouchCallback_t buttonCallback,
                                nbgl_navCallback_t         navCallback,
                                nbgl_choiceCallback_t      choiceCallback);
-void nbgl_useCaseForwardOnlyReview(const char                *rejectText,
-                                   nbgl_layoutTouchCallback_t buttonCallback,
-                                   nbgl_navCallback_t         navCallback,
-                                   nbgl_choiceCallback_t      choiceCallback);
-void nbgl_useCaseForwardOnlyReviewNoSkip(const char                *rejectText,
-                                         nbgl_layoutTouchCallback_t buttonCallback,
-                                         nbgl_navCallback_t         navCallback,
-                                         nbgl_choiceCallback_t      choiceCallback);
 void nbgl_useCaseStaticReview(const nbgl_contentTagValueList_t *tagValueList,
                               const nbgl_pageInfoLongPress_t   *infoLongPress,
                               const char                       *rejectText,
@@ -432,7 +416,6 @@ void nbgl_useCaseStaticReviewLight(const nbgl_contentTagValueList_t *tagValueLis
                                    const nbgl_pageInfoLongPress_t   *infoLongPress,
                                    const char                       *rejectText,
                                    nbgl_choiceCallback_t             callback);
-void nbgl_useCaseViewDetails(const char *tag, const char *value, bool wrapping);
 void nbgl_useCaseAddressConfirmation(const char *address, nbgl_choiceCallback_t callback);
 void nbgl_useCaseAddressConfirmationExt(const char                       *address,
                                         nbgl_choiceCallback_t             callback,
@@ -454,28 +437,6 @@ void nbgl_useCaseKeypadPIN(const char                *title,
                            tune_index_e               tuneId,
                            nbgl_pinValidCallback_t    validatePinCallback,
                            nbgl_layoutTouchCallback_t actionCallback);
-/**
- * @deprecated
- * See #nbgl_useCaseKeypadPIN
- */
-DEPRECATED static inline void nbgl_useCaseKeypad(const char                *title,
-                                                 uint8_t                    minDigits,
-                                                 uint8_t                    maxDigits,
-                                                 uint8_t                    backToken,
-                                                 bool                       shuffled,
-                                                 tune_index_e               tuneId,
-                                                 nbgl_pinValidCallback_t    validatePinCallback,
-                                                 nbgl_layoutTouchCallback_t actionCallback)
-{
-    nbgl_useCaseKeypadPIN(title,
-                          minDigits,
-                          maxDigits,
-                          backToken,
-                          shuffled,
-                          tuneId,
-                          validatePinCallback,
-                          actionCallback);
-}
 #endif  // NBGL_KEYPAD
 #endif  // HAVE_SE_TOUCH