♻️ changed the parameter of some log func

Author: jcaillon

commands.d/self-build.sh

@@ -283,7 +283,7 @@ function extractCommandDefinitionsToVariables() {
 
       if log::isTraceEnabled; then
         log::trace "Extracting command definition for:"
-        log::printFileString "${content%%$'\n'*}"
+        log::printFileString content
       fi
 
       selfBuild_extractCommandDefinitionToVariables "${content}"
@@ -320,8 +320,9 @@ function extractCommandDefinitionsToVariables() {
       if log::isTraceEnabled; then
         # shellcheck disable=SC2086
         exe::captureOutput declare -p ${!TEMP_CMD_BUILD_*}
+        local declaredVariables="${RETURNED_VALUE}"
         log::trace "Declared variables for this command:"
-        log::printFileString "${RETURNED_VALUE}"
+        log::printFileString declaredVariables
       fi
 
       # verify that the command definition is valid

commands.d/self-document.sh

@@ -138,7 +138,10 @@ function selfDocument::getAllFunctionsDocumentation() {
   local IFS=$'\n'
   if log::isDebugEnabled; then
     log::debug "Analyzing the following files:"
-    log::printFileString "${filesToAnalyze[*]}"
+    local file
+    for file in "${filesToAnalyze[@]}"; do
+      log::printString "- ${file}"
+    done
   fi
 
   unset -v RETURNED_ASSOCIATIVE_ARRAY SORTED_FUNCTION_NAMES
@@ -188,7 +191,8 @@ function selfDocument::getAllFunctionsDocumentation() {
     local key
     for key in "${!RETURNED_ASSOCIATIVE_ARRAY[@]}"; do
       log::trace "Function: ⌜${key}⌝"
-      log::printFileString "${RETURNED_ASSOCIATIVE_ARRAY[${key}]}"
+      local documentationString="${RETURNED_ASSOCIATIVE_ARRAY[${key}]}"
+      log::printFileString documentationString
     done
   fi
 

commands.d/self-release.sh

@@ -184,7 +184,7 @@ function selfRelease::createRelease() {
   done
   IFS=$' '
   log::info "The tag message is:"
-  log::printFileString "${tagMessage}"
+  log::printFileString tagMessage
 
   if [[ "${uploadExistingTag:-}" != "true" ]]; then
 

libraries.d/core

@@ -498,30 +498,31 @@ function log::printFile() {
 # Display a file content with line numbers in the logs.
 # The file content will be aligned with the current log output and hard wrapped if necessary.
 #
-# - $1: **content** _as string_:
-#       the file content.
+# - $1: **content variable name** _as string_:
+#       The name of the variable containing the file content to print.
 # - $2: max lines _as int_:
 #       (optional) Can be set using the variable `_OPTION_MAX_LINES`.
 #       Max lines to display, can be set to 0 to display all lines.
 #       (defaults to 0)
 #
 # ```bash
-# log::printFileString "myfilecontent"
+# log::printFileString "myvar"
 # ```
 #
 # > This function is not at all suited for large strings, print the content to a file instead.
 # shellcheck disable=SC2317
 function log::printFileString() {
-  local content="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
+  local -n contentToPrint="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
   local -i maxLines="${2:-${_OPTION_MAX_LINES:-0}}"
 
   local line toPrint lineNumberPadding="   "
   local -i lineNumber=1 currentLineNumberLength=1
-  while (( ${#content} > 0 )); do
-    line="${content%%$'\n'*}"
-    content="${content:${#line} + 1}"
+
+  local IFS
+  while IFS=$'\n' read -rd $'\n' line; do
     log::printFileInternalLoop || break;
-  done
+  done <<<"${contentToPrint}"
+
   # evaluated the print statement built in log::init; it uses the local var toPrint defined above
   eval "${GLOBAL_LOG_PRINT_STATEMENT_STANDARD}"
 }
@@ -629,8 +630,8 @@ function log::saveFile() {
 # (using `core::createNewStateFilePath`).
 # Useful for debugging purposes, to save the state of a string during execution.
 #
-# - $1: **content** _as string_:
-#       The content to save.
+# - $1: **content variable name** _as string_:
+#       The variable name of the content to save.
 # - $2: **suffix** _as string_:
 #       The suffix to add to the file name.
 # - $3: log path _as bool_:
@@ -645,12 +646,12 @@ function log::saveFile() {
 # log::saveFileString "my content" "suffix" "important result file"
 # ```
 function log::saveFileString() {
-  local content="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
+  local -n contentToSave="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
   local suffix="${2?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
   local logPath="${3:-"true"}"
   core::createNewStateFilePath "${suffix}"
   local newFilePath="${RETURNED_VALUE}"
-  printf '%s' "${content}" >"${newFilePath}"
+  printf '%s' "${contentToSave}" >"${newFilePath}"
   if [[ ${logPath} == "true" ]]; then
     log::printString "⌜${newFilePath}⌝"
   fi
@@ -662,17 +663,17 @@ function log::saveFileString() {
 # Display something in the log stream.
 # Does not check the log level.
 #
-# - $1: **content** _as string_:
-#       the content to print (can contain new lines)
+# - $1: **content variable name** _as string_:
+#       The variable name containing the content to print (can contain new lines).
 #
 # ```bash
 # log::printRaw "my line"
 # ```
 # shellcheck disable=SC2317
 function log::printRaw() {
-  local IFS=$'\n'
+  local -n toPrint="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
   # shellcheck disable=SC2034
-  local toPrint="$*"
+
   # evaluated the print statement built in log::init; it uses the local var toPrint defined above
   eval "${GLOBAL_LOG_PRINT_STATEMENT_STANDARD}"
 }

libraries.d/lib-curl

@@ -76,7 +76,7 @@ function curl::download() {
     exitCode=1
     if log::isDebugEnabled || [[ ${failIfFails} == "true" ]]; then
       log::errorTrace "Curl error output stream:"
-      log::printFileString "${errors}"
+      log::printFileString errors
     fi
     local message="The http return code ⌜${httpStatusCode}⌝ is not acceptable for url ⌜${url}⌝."
     if [[ ${failIfFails} == "true" ]]; then

libraries.d/lib-exe

@@ -70,7 +70,7 @@ function exe::invokef5() {
         log::saveFile "${stdIn}" "${executable^}-stdin"
       else
         log::trace "${executable^} standard input from string:"
-        log::saveFileString "${stdIn}" "${executable^}-stdin"
+        log::saveFileString stdIn "${executable^}-stdin"
       fi
     else
       log::trace "No standard input."

libraries.d/lib-http

@@ -173,7 +173,7 @@ function http::request() {
   if (( exitCode != 0 )); then
     if log::isDebugEnabled || [[ ${failOnError} == "true" ]]; then
       log::errorTrace "HTTP response:"
-      log::printFileString "${headers}"$'\n'"${body:-}"
+      log::printString "${headers}"$'\n'"${body:-}"
     fi
     local message="The HTTP return code ⌜${httpCode}⌝ is not acceptable for url ⌜${url}⌝."
     if [[ ${failOnError} == "true" ]]; then

libraries.d/lib-multi-line-prompt

@@ -1239,3 +1239,96 @@ function prompt_getDisplayedPromptString() {
   RETURNED_VALUE2=${screenIndex}
 }
 
+
+# Clear the multi-line prompt
+function prompt_clearMultiLinePrompt() {
+  tui::clearBox "${_PROMPT_START_LINE}" "${_PROMPT_START_COLUMN}" "${_PROMPT_WIDTH}" "${_PROMPT_NB_PROMPT_LINES}"
+}
+
+function prompt_drawMultiLinePrompt() {
+  # we need to draw the prompt on multiple lines
+  local promptLines=()
+  local promptLinesStartIndex=()
+  prompt_drawMultiLinePromptRefreshLines _PROMPT_STRING
+
+  prompt_getMultiLinePrompt
+  printf '%s' "${ESC__CURSOR_HIDE}${ESC__CURSOR_MOVE__}${_PROMPT_START_LINE};${_PROMPT_START_COLUMN}${__ESC__TO}${RETURNED_VALUE}${ESC__CURSOR_MOVE__}${GLOBAL_CURSOR_LINE};${GLOBAL_CURSOR_COLUMN}${__ESC__TO}${ESC__CURSOR_SHOW}"
+}
+
+function prompt_drawMultiLinePromptRefreshLines() {
+  local -n textToWrapAtWords="${1}"
+
+  local -i linesIndex=0
+
+  # short cut in case the text is already shorter than the width
+  if [[ ${#textToWrapAtWords} -le ${_PROMPT_STRING_SCREEN_WIDTH} && ${textToWrapAtWords} != *$'\n'* ]]; then
+    RETURNED_VALUE="${textToWrapAtWords}"
+    return 0
+  fi
+
+  local text="${textToWrapAtWords}"
+  local IFS=$' \t' line word realWord RETURNED_VALUE2
+  local -i realWordLength=0 firstWord=1
+  local -i lineLength=0
+
+  while ((${#text} > 0)); do
+    line="${text%%$'\n'*}"
+    text="${text:${#line}+1}"
+
+    output+=$'\n'""
+
+    # short cut in case the text is already shorter than the width
+    if ((lineLength + ${#line} <= _PROMPT_STRING_SCREEN_WIDTH)); then
+      output+="${line}"
+      continue
+    fi
+
+    firstWord=1
+
+    for word in ${line}; do
+      if [[ ${word} == *$'\e'* ]]; then
+        realWord="${word//$'\e['[0-9][0-9]m/}"
+        realWord="${realWord//$'\e['[0-9]m/}"
+        realWordLength="${#realWord}"
+      else
+        realWordLength="${#word}"
+      fi
+
+      if ((lineLength < _PROMPT_STRING_SCREEN_WIDTH && firstWord == 0)); then
+        output+=" "
+        lineLength+=1
+      else
+        firstWord=0
+      fi
+
+      if ((lineLength + realWordLength <= _PROMPT_STRING_SCREEN_WIDTH)); then
+        # add the word to the current line
+        output+="${word}"
+        lineLength+=realWordLength
+      else
+        # not enough space left, check if the word fits on the next line
+        if ((realWordLength <= _PROMPT_STRING_SCREEN_WIDTH)); then
+          output+=$'\n'"${word}"
+          lineLength=realWordLength
+        else
+          # the word is too long to fit on a line, split it in multiple lines
+          string::wrapCharacters word "${_PROMPT_STRING_SCREEN_WIDTH}" "" "$((_PROMPT_STRING_SCREEN_WIDTH - lineLength))"
+          output+="${RETURNED_VALUE}"
+          lineLength=${RETURNED_VALUE2}
+        fi
+      fi
+
+    done
+
+    lineLength=0
+  done
+
+  RETURNED_VALUE="${output#$'\n'""}"
+
+
+
+  string::wrapWords _PROMPT_STRING "${_PROMPT_STRING_SCREEN_WIDTH}" "  " "$((_PROMPT_STRING_SCREEN_WIDTH - _PROMPT_SYMBOL_LENGTH))"
+
+  prompt_getMultiLinePrompt
+  printf '%s' "${ESC__CURSOR_HIDE}${ESC__CURSOR_MOVE__}${_PROMPT_START_LINE};${_PROMPT_START_COLUMN}${__ESC__TO}${RETURNED_VALUE}${ESC__CURSOR_MOVE__}${GLOBAL_CURSOR_LINE};${GLOBAL_CURSOR_COLUMN}${__ESC__TO}${ESC__CURSOR_SHOW}"
+}

libraries.d/lib-prompt

@@ -11,6 +11,8 @@ source tui
 source exe
 # shellcheck source=lib-array
 source array
+# shellcheck source=lib-list
+source list
 
 #===============================================================
 # >>> Customization
@@ -361,6 +363,9 @@ function drawLeftPane() {
     toPrint+="${ESC__CURSOR_MOVE__}$((SFZF_LEFT_PANE_FIRST_LINE + 1));$((SFZF_LEFT_PANE_WIDTH - itemCounterLength))${__ESC__TO}${itemsCounter}"
   fi
 
+  _PROMPT_ITEMS_BOX_ITEM_WIDTH=$((SFZF_LEFT_PANE_WIDTH - 3))
+  _PROMPT_ITEMS_BOX_FILTER_STRING="${SFZF_SEARCH_STRING}"
+
   # draw the items
   local itemPrefix
   local -i index line=${SFZF_LEFT_PANE_FIRST_CONTENT_LINE}
@@ -372,7 +377,10 @@ function drawLeftPane() {
     else
       itemPrefix="  "
     fi
-    toPrint+="${ESC__CURSOR_MOVE__}${line};${SFZF_LEFT_PANE_WIDTH}${__ESC__TO}${ESC__ERASE_CHARS_LEFT}"$'\r'"${itemPrefix}${SFZF_FILTERED_ITEMS[index]}${SFZF_COLOR_SELECTED_ITEM_RESET}"
+
+    _PROMPT_ITEMS_BOX_ITEM_DISPLAYED="${SFZF_FILTERED_ITEMS[index]}"
+    list::getItemDisplayedString
+    toPrint+="${ESC__CURSOR_MOVE__}${line};${SFZF_LEFT_PANE_WIDTH}${__ESC__TO}${ESC__ERASE_CHARS_LEFT}"$'\r'"${itemPrefix}${_PROMPT_ITEMS_BOX_ITEM_DISPLAYED}${SFZF_COLOR_SELECTED_ITEM_RESET}"
     line+=1
   done