lempty
Return 1 if it argument is empty
lempty list => return 1 if list is empty, 0 otherwise
one can use insteed : if ![llength $my_list] {...}
insteed of : if [lempty $my_list] {...}
recursive_glob
Retourne une liste récursive d'éléments d'un répertoire
Retourne une liste récursive de fichiers ou répertoires
sous la forme dir/relativeFilePath.
Attention la liste optenue peut contenir des répertoires ou des
doublons (de la meme façon que la commande UNIX "ls * *)"
- Arguments
- dirlist Répertoire de base où va s'effectuer la recherche
- globlist Pattern permettant de selectionner les fichiers
- Exemple
recursive_glob . *
retourne {./rep1 ./fich1 ./fich2 ./rep1/fic11 ./rep1/fic12 ....}
- Remarque
Attention si globlist contient ".*" alors les répertoires
de la forme ".../." et .../.." font partie du résultat !!
- Exemple d'utilisation
set ABS [recursive_glob [pwd] $listOfPatterns]
: liste
de noms absolus
set REL [lcutleft $ABS [expr [string length [pwd]] + 1]]
: liste de noms relatifs
- Modif 10/06/96
compatibilité Mac et Windows (utilisation de la commande file join...).
Problemes potentiels
avec les fichiers invisibles pour unix (* et .*)
showHelp
Imprime l'aide pour utiliser html2htcl.
addLine
Parse une chaîne TCL, pour en extraire les commentaires
Cette fonction supprime les "#" en début de ligne
- Arguments
- dop Nom du fichier où les infos en HTML doivent être sauvées
- comment Contenu du commentaire
- Effets de bord
- Calls
- Outputs
Ajoute des informations dans le fichier pointé par dop
- Returns
insereInfo
Parse une chaîne TCL, pour en extraire les commentaires
Procédure permettant de parser une chaîne Tcl, pour en extraire des
données HTML en vue de générer une documentation automatique.
Si categorie vaut "Arguments" parse une chaine du type
"# arg1 - Infos sur l'argument 1
Complément d'information sur l'argument 1
# arg2 - Infos sur l'argument 2
etc..."
pour générer une liste en HTML.
Sinon renvoie le simplement le texte en supprimant les "#" en tête de ligne
- Arguments
- dop Nom du fichier où les infos en HTML doivent être sauvées
- categorie Catégorie du commentaire
- categorieComment Contenu du commentaire
- Effets de bord
- Calls
addLine
- Outputs
Ajoute des informations dans le fichier pointé par dop
- Returns
parseTCLFile
Parse un fichier TCL, pour en extraire les commentaires
Procédure permettant de parser un fichier Tcl, pour en extraire des
données HTML en vue de générer une documentation automatique.
- Arguments
- fileName Nom du fichier HTML à parser
- Effets de bord
Crée 2 fichier temporaire dans le repertoire temporaire pointé par
pistMkDoc(tmpDir)
- Calls
insereInfo
- Outputs
remplit les fichiers dont les noms sont contenus dans les variables :
pistMkDoc(ldop) et pistMkDoc(lof)
- Returns
pistMkDoc
Permet de tester les arguments passes au package pistMkDoc
- Arguments
- -files "Liste de fichier" Specifier une liste de fichier+un pattern
Permet de specifier une liste de fichier+un pattern
Exemple : "-files ./*.tcl ./*.tk"
- -f a force l'effacement des fichiers
- -out FileName Nom du fichier HTML de sortie
- -tmp Directory Emplacement des fichiers temporaires
Si cette option n'est pas précisée, les fichiers temporaires seront
placés dans les répertoire courant, ou bien dans le même répretoire
que le fichier HTML de sortie si l'option -out est précisée.
- -h Affiche l'aide concernant l'utilisation de pistMkDoc
- Effets de bord
remplit le tableau global "pistMkDoc" avec les paramètres passés
au programme
- Calls
pistMkDocInit, recursive_glob, showHelp, parseTCLFile, pistMkDocClose.
- Outputs
- Returns