| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente |
| refmodule [2026/10/18 14:33] – root | refmodule [2026/10/18 14:47] (Version actuelle) – [random] root |
|---|
| * ''set(path, content)'' : écrit la variable Dynamic ''content'' dans le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le chemin est inconnu, inaccessible, ou si les données ne peuvent pas être écrites (droits,…) | * ''set(path, content)'' : écrit la variable Dynamic ''content'' dans le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le chemin est inconnu, inaccessible, ou si les données ne peuvent pas être écrites (droits,…) |
| * ''size(path, length)'' : renvoie la taille, dans la variable Number ''length'' du fichier dont le chemin complet est donné par ''path'' | * ''size(path, length)'' : renvoie la taille, dans la variable Number ''length'' du fichier dont le chemin complet est donné par ''path'' |
| * ''delete(path)'' : supprimer le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le fichier ne peut pas être supprimé. | * ''delete(path)'' : supprime le fichier dont le chemin complet est donné dans ''path''. Génère une exception si le fichier ne peut pas être supprimé. |
| * ''rename(oldPath, newPath)'' : renomme/déplace le fichier ''oldPath'' en ''newPath''. Génère une exception en cas d'erreur (droits, FS différents, chemin cible inexistant). | * ''rename(oldPath, newPath)'' : renomme/déplace le fichier ''oldPath'' en ''newPath''. Génère une exception en cas d'erreur (droits, FS différents, chemin cible inexistant). |
| * ''append(path, content)'' : écrit la variable Dynamic ''content'' à la fin du fichier dont le chemin complet est donné dans ''path''. S'il n'existait pas, le fichier est créé. Génère une exception en cas d'erreur. | * ''append(path, content)'' : écrit la variable Dynamic ''content'' à la fin du fichier dont le chemin complet est donné dans ''path''. S'il n'existait pas, le fichier est créé. Génère une exception en cas d'erreur. |
| * ''dir(path, fileList)'' : prend en compte le chemin donné par ''path'' et renvoi, dans la variable ''fileList'' , la liste des fichiers et répertoires trouvés dans le répertoire indiqué, en multi-champs. Les fichiers //spéciaux// ne sont pas retournés (Unix seulement), ni les pseudo fichiers ''.'' et ''..'' | * ''dir(path, fileList)'' : prend en compte le chemin donné par ''path'' et renvoie, dans la variable ''fileList'' , la liste des fichiers et répertoires trouvés dans le répertoire indiqué, en multi-champs. Les fichiers //spéciaux// ne sont pas retournés (Unix seulement), ni les pseudo fichiers ''.'' et ''..'' |
| |
| |
| |
| * ''set(plaintextThenCompressed)'' : compresse les données contenues dans la variable Dynamic ''plaintextThenCompressed'', et renvoie dans la même variable les données compressées, compatibles Lzw-PDF. | * ''set(plaintextThenCompressed)'' : compresse les données contenues dans la variable Dynamic ''plaintextThenCompressed'', et renvoie dans la même variable les données compressées, compatibles Lzw-PDF. |
| * ''get(compressedThenPlaintext, reverse)'' : décompresse les données fournies dans la variable Dynamic ''compressedThenPlaintext'', et renvoie dans la même variable les données en clair. Mettre le paramètre ''reverse'' à ''@true'' pour décompresser des données spécifiquement au format GIF ; par défaut à ''@false'' (compatible Lzw-PDF). | * ''get(compressedThenPlaintext, [reverse])'' : décompresse les données fournies dans la variable Dynamic ''compressedThenPlaintext'', et renvoie dans la même variable les données en clair. Mettre le paramètre ''reverse'' à ''@true'' pour décompresser des données spécifiquement au format GIF ; par défaut à ''@false'' (compatible Lzw-PDF). |
| |
| |
| NOTA : revoir la gestion des numéros des images (del_image change les numéros) | NOTA : revoir la gestion des numéros des images (del_image change les numéros) |
| |
| * ''beginDoc(pdfParameterSet)'' : démarre un nouveau document Pdf. ''parameterSet'' est une hashtable qui doit contenir les champs suivants, permettant d'initialiser le document : | * ''beginDoc(pdfParameterSet)'' : démarre un nouveau document Pdf. ''pdfParameterSet'' est une hashtable qui doit contenir les champs suivants, permettant d'initialiser le document : |
| * ''.Title'' : titre du document (string) | * ''.Title'' : titre du document (string) |
| * ''.Fonts'' : liste des fontes qui seront utilisées dans le document, chaîne contenant les noms des fontes en multi-champs (cf. tableau, le n° associé est le compteur interne du format PDF, à ignorer) | * ''.Fonts'' : liste des fontes qui seront utilisées dans le document, chaîne contenant les noms des fontes en multi-champs (cf. tableau, le n° associé est le compteur interne du format PDF, à ignorer) |
| * ''.Format'' : nombre donnant la taille de chaque page - A4P A4L A3P A3L (1 2 3 4) | * ''.Format'' : nombre donnant la taille de chaque page - A4P A4L A3P A3L (1 2 3 4) |
| * ''endDoc(pdfContent)'' : clôture le document Pdf en cours, et renvoie tout son contenu dans la chaine ''pdfContent'' | * ''endDoc(pdfContent)'' : clôture le document Pdf en cours, et renvoie tout son contenu dans la chaine ''pdfContent'' |
| * ''addPage()'' : valide l'ajout d'une page au document Pdf en cours, à appeler après avoir ajouté les éléments de la page grâce aux fonctions qui suivent. Les pages sont toutes compactées avec l'algorithme Lzw. | * ''addPage'' : valide l'ajout d'une page au document Pdf en cours, à appeler après avoir ajouté les éléments de la page grâce aux fonctions qui suivent. Les pages sont toutes compactées avec l'algorithme Lzw. |
| * ''addText(pdfParameterSet, string)'' : ajoute à la page courante la chaine ''string'' selon le formatage décrit dans la hashtable ''pdfParameterSet'' qui doit contenir les champs suivants : | * ''addText(pdfParameterSet, string)'' : ajoute à la page courante la chaine ''string'' selon le formatage décrit dans la hashtable ''pdfParameterSet'' qui doit contenir les champs suivants : |
| * ''.X'', ''.Y'', ''.W'', ''.H'' : position x,y et dimension w,h du cadre englobant la chaîne | * ''.X'', ''.Y'', ''.W'', ''.H'' : position x,y et dimension w,h du cadre englobant la chaîne |
| |
| * ''setSeed(seedValue)'' : utilise le nombre ''seedValue'' donné, pour initialiser le générateur de nombres pseudo-aléatoires | * ''setSeed(seedValue)'' : utilise le nombre ''seedValue'' donné, pour initialiser le générateur de nombres pseudo-aléatoires |
| * ''get(nextRandomNumber)'' : renvoie dans ''nextRandomNumber'' le prochain nombre pseudo-aléatoire calculé par le générateur (nombre entier) | * ''get(nextRandomNumber)'' : renvoie dans ''nextRandomNumber'' le prochain nombre pseudo-aléatoire calculé par le générateur (nombre entier compris entre 0 et 4 294 967 295) |
| |
| |
| //NOTA// : module à finir, revoir doc (newprocessshmreader/writer) Module gérant la communication inter-processus, basée sur des messages textes. Chaque processus possède une //queue// qui permet de recevoir les messages émis par les autres processus. | //NOTA// : module à finir, revoir doc (newprocessshmreader/writer) Module gérant la communication inter-processus, basée sur des messages textes. Chaque processus possède une //queue// qui permet de recevoir les messages émis par les autres processus. |
| |
| * ''get(content)'' : renvoie dans ''content'' le prochain message reçu depuis la queue interne du processus en cours. S'il n'y a pas de message à lire, renvoie //vide//. Si le programme n'a pas de nom (identifiant mis à la suite de //prog// ou //back//, seul le premier process lisant ces messages pourra les recevoir, via un nom vide. Les autres ne les recevront pas car en interne la zone mémoire est déjà utilisée. | * ''get(content)'' : renvoie dans ''content'' le prochain message reçu depuis la queue interne du processus en cours. S'il n'y a pas de message à lire, renvoie //vide//. Si le programme n'a pas de nom (identifiant mis à la suite de ''begin'' ou ''background''), seul le premier process lisant ces messages pourra les recevoir, via un nom vide. Les autres ne les recevront pas car en interne la zone mémoire est déjà utilisée. |
| * ''set(textMessage, processName)'' : envoi le message texte ''textMessage'' au processus identifié par ''processName''. L'identifiant d'un process est le nom donné au module principal dans l'instruction ''begin'' ou ''background'' du programme W. | * ''set(textMessage, processName)'' : envoie le message texte ''textMessage'' au processus identifié par ''processName''. L'identifiant d'un process est le nom donné au module principal dans l'instruction ''begin'' ou ''background'' du programme W. |
| |
| |
| * ''server(portNumber)'' : crée un point d'entrée //serveur// sur le n° de ''portNumber'' indiqué (n° autorisés : 1024 à 65535 uniquement). Le module ne gère qu'un seul serveur actif au même moment. | * ''server(portNumber)'' : crée un point d'entrée //serveur// sur le n° de ''portNumber'' indiqué (n° autorisés : 1024 à 65535 uniquement). Le module ne gère qu'un seul serveur actif au même moment. |
| * ''wait(timeout, clientSock)'' : attend une demande de connexion entrante depuis un client. Si une demande de connexion est acceptée, ''clientSock'' contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get'' et écritures ''set'' entre ce client et le serveur. Si aucune connexion n'est demandée au bout du délai ''timeout'' (en secondes), l'id renvoyé dans ''clientSock'' est négatif, confirmant qu'aucune de demande de connexion n'est arrivée dans le délai indiqué. Le module gère plusieurs connexions entrantes simultanées. | * ''wait(timeout, clientSock)'' : attend une demande de connexion entrante depuis un client. Si une demande de connexion est acceptée, ''clientSock'' contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get'' et écritures ''set'' entre ce client et le serveur. Si aucune connexion n'est demandée au bout du délai ''timeout'' (en secondes), l'id renvoyé dans ''clientSock'' est négatif, confirmant qu'aucune de demande de connexion n'est arrivée dans le délai indiqué. Le module gère plusieurs connexions entrantes simultanées. |
| * ''stopServer'' : supprime le point d'entrée serveur crée avec ''server''. | * ''stopServer'' : supprime le point d'entrée serveur créé avec ''server''. |
| * ''connect(host, portNumber, socket)'' : initie une connexion socket au serveur ''host'' sur le n° de ''portNumber'' (sans limitation de numéro). ''host'' peut contenir un nom de serveur, mais aussi une adresse IP v4. Quand la demande est acceptée par le serveur, ''socket'' contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get'' / écritures ''set'' entre ce client et le serveur. Quand la demande est refusée, une exception est générée. Le module gère plusieurs connexions sortantes simultanées. | * ''connect(host, portNumber, socket)'' : initie une connexion socket au serveur ''host'' sur le n° de ''portNumber'' (sans limitation de numéro). ''host'' peut contenir un nom de serveur, mais aussi une adresse IP v4. Quand la demande est acceptée par le serveur, ''socket'' contient en retour un id de connexion, à mémoriser car il servira a identifier la connexion à utiliser lors des lectures ''get'' / écritures ''set'' entre ce client et le serveur. Quand la demande est refusée, une exception est générée. Le module gère plusieurs connexions sortantes simultanées. |
| * ''stop(socket)'' : arrête la connexion identifiée par l'id ''socket'', que ce soit la partie cliente donnée par ''connect'' aussi bien que la partie serveur donnée par ''wait''. | * ''stop(socket)'' : arrête la connexion identifiée par l'id ''socket'', que ce soit la partie cliente donnée par ''connect'' aussi bien que la partie serveur donnée par ''wait''. |
| Module gérant les liens avec le shell et l'OS hôte. | Module gérant les liens avec le shell et l'OS hôte. |
| |
| * ''execute(command, returnCode, [capturing])'' : execute la commande OS ''command'' dans un shell. Renvoie le code retour de la commande dans ''returnCode''. Si le 3ème paramètre ''capturing'' est fourni, il contient en retour la sortie générée par la commande dans le terminal (sortie standard) | * ''execute(command, returnCode, [capturing])'' : exécute la commande OS ''command'' dans un shell. Renvoie le code retour de la commande dans ''returnCode''. Si le 3ème paramètre ''capturing'' est fourni, il contient en retour la sortie générée par la commande dans le terminal (sortie standard) |
| * ''getEnv(varName, value)'' : renvoie dans ''value'' le contenu de la variable d'environnement (dans la session courante) nommée ''varName''. Génère l'exception EXMOD_SYSTEM_UNKNOWNVARENV si la variable d'environnement est inconnue | * ''getEnv(varName, value)'' : renvoie dans ''value'' le contenu de la variable d'environnement (dans la session courante) nommée ''varName''. Génère l'exception EXMOD_SYSTEM_UNKNOWNVARENV si la variable d'environnement est inconnue |
| * ''createEnv(varName, value)'' : crée la variable d'environnement nommée ''varName'' dans la session courante, avec la valeur ''value''. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est déjà présente (utiliser ''updateEnv'' dans ce cas) | * ''createEnv(varName, value)'' : crée la variable d'environnement nommée ''varName'' dans la session courante, avec la valeur ''value''. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est déjà présente (utiliser ''updateEnv'' dans ce cas) |
| * ''deleteEnv(varName)'' : supprime la variable d'environnement nommée ''varName'' de la session courante. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue | * ''deleteEnv(varName)'' : supprime la variable d'environnement nommée ''varName'' de la session courante. Génère l'exception EXMOD_SYSTEM_SETENV si la variable est inconnue |
| * ''getOS(OScode)'' : renvoie un code, dans le paramètre ''OScode'', indiquant le type de l'OS hôte du programme en cours (de type chaîne) : //Windows//, //Linux// (__différent__ du contenu de la variable système //@os//) | * ''getOS(OScode)'' : renvoie un code, dans le paramètre ''OScode'', indiquant le type de l'OS hôte du programme en cours (de type chaîne) : //Windows//, //Linux// (__différent__ du contenu de la variable système //@os//) |
| * ''sendSignal(pid, signalNumber)'' : envoi le signal numéro ''signalNumber'' au processus identifié par son numéro ''pid''. Seuls les 3 signaux SIGTERM, SIGINT, SIGUSR1 sont pris en charge. Les autres sont ignorés. Fonction compatible Unix/Windows mais sous Windows, ce sont des évènements qui sont générés, pas des signaux ; SIGTERM et SIGINT génèrent un évènement ''Global\\wterm<pid>'' et SIGUSR1 génère un évènement ''Global\\wdebug<pid>'' | * ''sendSignal(pid, signalNumber)'' : envoie le signal numéro ''signalNumber'' au processus identifié par son numéro ''pid''. Seuls les 3 signaux SIGTERM, SIGINT, SIGUSR1 sont pris en charge. Les autres sont ignorés. Fonction compatible Unix/Windows mais sous Windows, ce sont des évènements qui sont générés, pas des signaux ; SIGTERM et SIGINT génèrent un évènement ''Global\\wterm<pid>'' et SIGUSR1 génère un évènement ''Global\\wdebug<pid>'' |
| * ''sleep(duration)'' : endort le process en cours, pour une durée de ''duration'' secondes | * ''sleep(duration)'' : endort le process en cours, pour une durée de ''duration'' secondes |
| |
| ==== time ==== | ==== time ==== |
| |
| Module permettant de manipuler des horodates, en TU et temps local, de mesurer le temps passé (chrono) et de gérer des alarmes temporelles. | Module permettant de manipuler des horodates, en TU et temps local, de mesurer le temps passé (chrono) et de gérer des alarmes temporelles. Nota : TU, UTC et GMT ont la même signification ici : temps universel méridien de Greenwich. |
| |
| * ''startChrono'' : démarre le chronomètre, pour mesurer une durée | * ''startChrono'' : démarre le chronomètre, pour mesurer une durée |
| * ''lapChrono(duration)'' : donne le temps passé en secondes depuis le dernier appel de start ou lap (variable Number ''duration'') | * ''lapChrono(duration)'' : donne le temps passé en secondes depuis le dernier appel de start ou lap (variable Number ''duration'') |
| |
| * ''set(timeParameterSet, timestamp, offset, string, stringFormat)'' : mémorise dans la hashtable ''timeParameterSet'' (obligatoire dans tous les cas) la date ; deux combinaisons de paramètres en entrée sont prises en charge, selon la présence ou non de paramètres : | * ''set(timeParameterSet, timestamp, offset, string, stringFormat)'' : mémorise dans la hashtable ''timeParameterSet'' (obligatoire dans tous les cas) la date ; deux combinaisons de paramètres en entrée sont prises en charge, selon la présence ou non de paramètres (travailler avec des paramètres nommés ici, et ne pas passer ceux à ignorer) : |
| * ''timestamp'' seul ou ''timestamp'' et ''offset'' : date passée dans ''timestamp'' (au sens Unix) et donc en TU, ou ''offset'' en plus, permettant une date locale (offset ajouté au timestamp) | * ''timestamp'' seul ou ''timestamp'' et ''offset'' : date passée dans ''timestamp'' (au sens Unix) et donc en TU, ou ''offset'' en plus, permettant une date locale (offset ajouté au timestamp) |
| * ''string'' seul (le format est le standard ISO8601 A-M-JTh:m:SF) ou ''string'' et ''stringFormat'' ; dans ce dernier cas, en l'absence du fuseau, le traitement considère que la chaine représente une date locale | * ''string'' seul (le format est le standard ISO8601 A-M-JTh:m:SF) ou ''string'' et ''stringFormat'' ; dans ce dernier cas, en l'absence du fuseau, le traitement considère que la chaine représente une date locale |