From: Vincent Le Gallic <legallic@crans.org>
Date: Fri, 15 Nov 2013 12:22:09 +0000 (+0100)
Subject: [.bashrc] Commentaires pour la génération du prompt
X-Git-Url: http://gitweb.pimeys.fr/?a=commitdiff_plain;h=59d7e4df6dc413d89346050a0cc8da0ef8cfd16b;p=config-20-100.git

[.bashrc] Commentaires pour la génération du prompt
---

diff --git a/.bashrc b/.bashrc
index 9574b79..d89108c 100644
--- a/.bashrc
+++ b/.bashrc
@@ -183,6 +183,8 @@ function gen_minus_line
     local i
 
     MINUS_LINE=""
+    # Pas la peine de refaire le travail tant qu'on ne change
+    # pas le nombre de colonnes.
     SAVE_COLUMNS=$COLUMNS
 
     for ((i = COLUMNS-23; i>0; i--)); do
@@ -193,17 +195,25 @@ function gen_minus_line
 # Génération du prompt après chaque commande
 function prompt_command
 {
-    # Attention aux hacks pour que la couleur (et sa taille)
-    #  soient évaluées au moment de l'affichage du prompt
     local pwd ERR DATE PROMPT DIR POST_DIR
+    # Cette fonction génère un prompt sur deux lignes
+    # ayant cette allure :
+    # ─( 12:59:05 )─< ~ >───────────────────────────────────────────────────────[ 0 ]─
+    # user@host $
+    
+    # Attention aux hacks (échappement, interprétation des variables)
+    # pour que les couleurs (et leurs tailles)
+    # soient évaluées au moment de l'affichage du prompt
+    # Si le terminal a été redimensionné, on régénère la ligne de tirets
     (( SAVE_COLUMNS == COLUMNS )) || gen_minus_line
-
-    # À décommenter si on veut des infos
+    
+    # À décommenter si on veut afficher des infos
     # quand on se trouve dans un dépôt versionné
     if [ "$display_vcs_info" = yes ]; then
         get_vcs_info
     fi
     
+    # Chemin courant, en faisant attention à la largeur de la fenêtre
     pwd=${PWD/#$HOME/'~'}
     if (( ${#pwd} + ${VCS_size} + 27 > COLUMNS )); then
  	    if (( COLUMNS >= 33 )); then
@@ -217,14 +227,21 @@ function prompt_command
 	    DIR=$pwd
         POST_DIR='${MINUS_LINE:'${#pwd}+${VCS_size}+1'+${#?}}'
     fi
+    
+    # Génération des différents morceaux du prompt, avec ou sans la couleur
     if [ "$color_prompt" = yes ]; then
         DIR="< ${pwd_color}"$DIR"${line_color_prompt} >"
         # On affiche le code de retour en "no color" si c'est 0, en rouge sinon
         # Ceci n'est pas customizable à coup de variable,
         # il faut changer $((31+($?==0)*6)) si vous y tenez vraiment et que vous comprenez ce que vous faites
         ERR='[ \[\e[1;$((31+($?==0)*6))m\]$?'${line_color_prompt}' ]'$MINUS_CHAR
+        # Affichage de l'heure courante
+        # pratique pour savoir quand on a tapé la commande précédente
         DATE="( ${date_color}\D{%H:%M:%S}${line_color_prompt} )"
+        # Deuxième ligne du prompt "user@host $"
+        # Attention "\\\$" devient \$, c'est-à-dire # pour root, $ pour les autres
         PROMPT="${username_color}\u${symbols_color}@${host_color}\h ${symbols_color}\\\$ ${nocolor_prompt}"
+        # On fusionne tout ça
         PS1=$TITLE${line_color_prompt}$MINUS_CHAR$DATE$MINUS_CHAR$DIR$MINUS_CHAR$VCS_info${line_color_prompt}$POST_DIR$ERR'\n'$PROMPT
     else
         DIR="< "$DIR" >"
@@ -242,7 +259,7 @@ else
     TITLE=''
 fi
 
-# On regénére le prompt après chaque commande
+# On régénère le prompt après chaque commande
 PROMPT_COMMAND=prompt_command
 
 # +-------------------+
@@ -251,10 +268,15 @@ PROMPT_COMMAND=prompt_command
 
 function welcome_message ()
 {
+    # Si on supporte l'utf-8 et qu'on n'est pas dans un screen,
+    # on affiche un joli cadre avec la date.
+    # On utilise aussi un caractère plus sympa pour faire les lignes de tirets
     if [[ $(uname) == Linux && ( $(locale charmap) == UTF-8 && $TERM != screen ) ]]; then
         MINUS_CHAR=─
         gen_minus_line
         date=$(/bin/date +"%R, %A %d %B %Y")
+        # ${redate} sert à connaître la taille de la chaine $date,
+        # mais sans se planter sur le nombre d'octet/nombre de caractères
         redate=${date//é/e}
         redate=${redate//û/u}
         if [ "$color_prompt" = yes ]; then
@@ -263,6 +285,7 @@ function welcome_message ()
             echo -e "┬─${redate//?/─}──┬${MINUS_LINE:${#date}-18}\n│ $date  │\n└─${redate//?/─}──┘\n"
         fi
         unset date
+    # Sinon, on se contente d'une ligne de tirets
     else
         MINUS_CHAR=-
         gen_minus_line