From e4075153def021c3405accb19ffcdc3247d98807 Mon Sep 17 00:00:00 2001 From: Pixel Date: Sun, 2 Dec 2001 18:55:35 +0000 Subject: Comments and so... --- include/Action.h | 24 ------------------------ include/Confirm.h | 10 ---------- include/Exceptions.h | 26 -------------------------- include/Form.h | 16 ---------------- include/Handle.h | 17 ----------------- include/HttpServ.h | 8 -------- include/Input.h | 4 ---- include/Menu.h | 10 ---------- include/Message.h | 9 --------- include/Output.h | 4 ---- include/Socket.h | 21 --------------------- include/String.h | 33 --------------------------------- include/Table.h | 12 ------------ include/Variables.h | 20 -------------------- 14 files changed, 214 deletions(-) (limited to 'include') diff --git a/include/Action.h b/include/Action.h index fd8b204..99ad7ea 100644 --- a/include/Action.h +++ b/include/Action.h @@ -7,30 +7,6 @@ #include #include -/* - * La classe Action defini les actions HTTP possibles. - * Le constructeur indique l'URL de l'action. Si aucune URL n'est specifiee, - * alors une URL aléatoire sera générée. - * - * Lors de la construction d'une Action, elle sera rajoutée dans une liste chaînée - * interne à la classe. De ce fait, la fonction Look4URL recherchera une Action - * associée a une URL donnée en paramètre dans la liste chaînée. Le destructeur - * va remettre en place la liste chaînée. - * - * Les dérivés doivent surcharger la méthode Do, qui recevra les variables transportées - * par l'action (si nous avions une méthode POST juste avant) et le handle d'écriture - * vers le socket HTTP. Ils devront aussi surcharger GetTitle, qui sert à écrire le - * titre de la page HTML dans les méthodes SendHead et SendFoot. Ces deux méthodes sont - * d'ailleurs surchargeables, pour créer de nouvelles skins HTML dans des classes dérivées. - * - * La méthode ShowButton sert à afficher un bouton sur la page. Par défaut, ce bouton reviendra - * vers la page principale. - * - * Une action peut être "temporaire", c'est à dire accessible uniquement une seule fois. - * Dans ce cas, après création, il faut faire appel à la méthode CleanUp, et la méthode - * Do devra terminer par un appel a Accessed, afin de supprimer cette Action. - */ - class Action : public Base { public: Action(const String & = ""); diff --git a/include/Confirm.h b/include/Confirm.h index 9e2cc7b..be0b659 100644 --- a/include/Confirm.h +++ b/include/Confirm.h @@ -6,16 +6,6 @@ #include #include -/* - * Cette classe sert à afficher une boîte de dialogue de confirmation. - * Constructeur: - * - titre = titre de la boite de dialogue - * - msg = message a afficher - * - url = url de cette boite - * - yes = action a effectuer si on clique sur Oui - * - no = action a effectuer si on clique sur Non. - */ - class Confirm : public Action { public: Confirm(const String & titre, const String & msg, const String & url, Action * yes, Action * no = 0); diff --git a/include/Exceptions.h b/include/Exceptions.h index 9c87714..e5d24e6 100644 --- a/include/Exceptions.h +++ b/include/Exceptions.h @@ -6,31 +6,7 @@ #include #include #include - -/* - * Gère les exceptions du système. Le programme principal devrait tenter - * de les récupérer afin de les afficher. - * GeneralExecption: exception de base. Construite sur une string. - * MemoryException: plus assez de mémoire. Construit une string sur la taille mémoire - * qui a fait défaut. - * IOException: erreur de lecture/écriture. Construite sur le nombre d'octets - * et sur l'opération qui a générée l'erreur. - * IOGeneral: erreur générale sur une opération IO (erreur à l'ouverture notemment) - * IOInternal: erreur interne du programme. En particulier, le programme - * a voulu lire ou écrire alors que le Handle n'était pas prévu pour. - * - * Nous définissons les fonctions xmalloc, xfree et xstrdup. Elles devraient être - * utilisées en lieu et place des fonctions malloc, free et strdup. La fonction realloc - * étant désapréciée, elle n'est pas surchargée. - */ - -// Impossible de surcharger free(void *). Les compilateurs -// refuseront de passer un char * par exemple. -#ifdef OVER_FREE -#define free(p) xfree((void*)p) -#else #include -#endif class GeneralException; @@ -41,8 +17,6 @@ void * xrealloc(void *, size_t); int xpipe(int *, int = 0) throw (GeneralException); pid_t xfork() throw (GeneralException); -// On prédéfinit la classe String, pour éviter -// les deadlocks de compilation... class String; class Base { diff --git a/include/Form.h b/include/Form.h index dd923be..77498a8 100644 --- a/include/Form.h +++ b/include/Form.h @@ -6,22 +6,6 @@ #include #include -/* - * Cette classe sert à afficher un formulaire de saisie. - * Constructeur: - * - titre = titre de la page - * - url = url de ce formulaire - * - inv = invite du formulaire - * - names = liste des noms des variables pour chaque champs - * - invs = liste des invites pour chaque champs - * - defaults = listes des valeurs par defaut pour chaque champs - * - lists = liste des listes de valeurs pour les menus deroulants. Si une liste déroulante = 0, - * alors il s'agira d'un champ de saisie manuel. - * - descs = liste des listes de descriptions pour les menus deroulants. - * - nb = nombre de champs - * - ok = Action a effectuer lorsque l'on clique sur le bouton Ok. - */ - class Form : public Action { public: Form(const String & titre, const String & url, const String & inv, diff --git a/include/Handle.h b/include/Handle.h index 45a9432..dd1cfd7 100644 --- a/include/Handle.h +++ b/include/Handle.h @@ -7,23 +7,6 @@ #include #include -/* - * Pour les classes qui vont deriver: le constructeur Handle(int) specifie - * le handle a stocker. De meme, GetHandle sert a lire le handle stocke. - * - * Les operateurs >> et << ne fonctionnent qu'avec des String. Vu que la - * classe String possede des constructeurs pour tous les types utiles, cela - * ne posera pas de problemes. >> va lire une ligne en supprimant les caractères - * '\n' des fins de lignes et en ignorant '\r'. - * - * Les fonctions read et write sont les memes que les fonctions systeme read - * et write. - * - * Les booleens CanRead et CanWrite indiquent si le handle peut lire ou ecrire. - * - * GetName donne le nom associe au handle. (nom de fichier ou autre) - */ - #include #include diff --git a/include/HttpServ.h b/include/HttpServ.h index 5860dd7..a51a16e 100644 --- a/include/HttpServ.h +++ b/include/HttpServ.h @@ -9,14 +9,6 @@ #include #include -/* - * La classe HttpServ. Le constructueur (int, const String &) indique le port - * et le nom du serveur à indiquer dans les entetes HTTP. - * - * Une fois lance, il suffit de lancer MainLoop en indiquant le menu principal, - * qui est obligatoirement statique et doit posseder l'url /bin/start. - */ - class HttpServ : public Task { public: HttpServ(Action *, int = 1500, const String & = String("GruiK Server v0.1")) throw (GeneralException); diff --git a/include/Input.h b/include/Input.h index ae8ef09..7aa0ff2 100644 --- a/include/Input.h +++ b/include/Input.h @@ -7,10 +7,6 @@ #include #include -/* - * Cette classe sert à créer un fichier ouvert en lecture. - */ - class Input : public Handle { public: Input(String = "") throw (GeneralException); diff --git a/include/Menu.h b/include/Menu.h index bb0b74c..6e77c70 100644 --- a/include/Menu.h +++ b/include/Menu.h @@ -6,16 +6,6 @@ #include #include -/* - * Cette classe permet d'afficher un menu. - * Constructeur: - * - titre = titre de la page - * - url = url de la page - * - labels = labels de items du menu - * - listac = liste des pointeurs sur les actions - * - nb = nombre d'items - */ - class Menu : public Action { public: Menu(const String & titre, const String & url, String * labels, Action ** listac, int nb); diff --git a/include/Message.h b/include/Message.h index 41ca841..043f4d6 100644 --- a/include/Message.h +++ b/include/Message.h @@ -6,15 +6,6 @@ #include #include -/* - * Cette classe sert a afficher un message. - * Constructeur: - * - titre = titre de la page - * - msg = message de la boite de dialogue - * - url = url de la page - * - ok = action a effectuer lorsque l'on clique sur Ok. - */ - class Message : public Action { public: Message(const String & titre, const String & msg, const String & url, Action * ok = 0); diff --git a/include/Output.h b/include/Output.h index 10a1849..6c4fdec 100644 --- a/include/Output.h +++ b/include/Output.h @@ -5,10 +5,6 @@ #include #include -/* - * Ouvre un fichier en ecriture. - */ - class Output : public Handle { public: Output(String = "", int trunc = 1) throw (GeneralException); diff --git a/include/Socket.h b/include/Socket.h index c6402cb..a8076e3 100644 --- a/include/Socket.h +++ b/include/Socket.h @@ -8,27 +8,6 @@ #include #include -/* - * Cree un socket. - * - * SetLocal(hostname, port) définit le hostname local et le port a écouter, si le - * socket est destine a etre un socket serveur, ou la vhost et le port source si - * le socket est destine a se etre un socket client. Renvoie faux si probleme quelconque. - * - * Connect(hostname, port) passe le socket en mode client et va se connecter sur - * l'adresse hostname:port specifiee. - * - * Listen passe le socket en mode serveur. - * - * Accept permet de récuperer un client qui se connecte sur un socket server, et - * renvoie le socket de lecture/ecriture correspondant. - * - * Les methodes IsConnected et IsListening permettent de verifier l'etat du socket. - * - * Les fonctions WriteFile et ReadFile permettent de transmettre un fichier sur le socket. - * Tres utile pour l'upload ou le download. - */ - class Socket : public Handle { public: Socket() throw (GeneralException); diff --git a/include/String.h b/include/String.h index fbeb9fc..a0d9220 100644 --- a/include/String.h +++ b/include/String.h @@ -6,39 +6,6 @@ #include #include -/* - * Cette classe permet de stocker des chaînes de caractères simplement. - * Elle est une base essentielle et permet d'effectuer énormément d'opérations: - * - set fonctionne comme sprintf, et réassigne la chaîne. - * - to_charp() transforme la chaîne en pointeur. - * - to_charp(from) extrait la chaîne depuis le caractère numéro from - * - to_charp(from, to) extrait la chaîne depuis le caractère numéro from - * jusqu'au caractère numéro to. - * ATTENTION: les fonctions to_charp renvoie un pointeur sur un tableau - * statique, et ce tableau sera modifié au prochain - * appel à to_charp ou a set. - * - to_int transforme la chaîne en int. - * - to_double transforme la chaîne en double - * - to_sqldate effectue la conversion suivante: DD/MM/YYYY ==> YYYYMMDD - * - to_sqltime effectue la conversion suivante: h:m ==> h * 60 + m - * - from_sqldate et from_sqltime effectue les conversions inverses. - * - datedif calcule la différence en jours entre deux dates. Si le résultat - * est négatif, alors une des deux dates étaient invalide. - * - is_date, is_number, is_float, is_time renvoient des booléens de test. - * - strlen renvoie la longueur de la chaine - * - strchr(c) renvoie la position du caractère c - * - strchr(c, p) recherche le caractère c à partir de la position p - * - strrchr(c) renvoie la position du caractère c, en recherchant depuis la droite. - * - strstr(s) renvoie la position de la chaine s - * NOTE: les fonctions de recherche renvoient un résultat négatif si pas trouvé. - * - strchrcnt(c) compte le nombre d'occurences du caractère c. - * - * Les opérateurs !=, ==, <=, >=, < et > permettent de comparer deux chaînes, en mode - * 'case sensitive'. L'operateur [] renvoie un caractère de la chaîne. - * - * Les opérateurs << et >> vers un ostream ou depuis un istream sont supportés. - */ - class String : public Base { public: String(const String &); diff --git a/include/Table.h b/include/Table.h index 97b1503..5b01aab 100644 --- a/include/Table.h +++ b/include/Table.h @@ -6,18 +6,6 @@ #include #include -/* - * Affiche une table. - * Constructeurs: - * - titre = titre de la page - * - url = url de la page - * - heads = liste des titres des colonnes. Si = 0, la ligne de titre est désactivée. - * - cells = liste de toutes les cellules. Notez qu'il s'agit d'une liste linéaire. - * - nbcol = nombre de colonnes - * - nblig = nombre de lignes - * - ok = action à effectuer si on clique sur le bouton Ok. Page principale par défaut. - */ - class Table : public Action { public: Table(const String & titre, const String & url, String * heads, String * cells, int nbcol, int nblgn, Action * ok = 0); diff --git a/include/Variables.h b/include/Variables.h index f24daa0..f3471bd 100644 --- a/include/Variables.h +++ b/include/Variables.h @@ -7,26 +7,6 @@ #include #include -/* - * Cette classe nous sert a gérer les variables transportées par les formulaires. - * Elle sera initialisée dans la classe HttpServ et sera passée en paramètre aux - * actions. Le constructeur indique le nombre de variables qu'il faut allouer. - * - * SetTo sert à définir une variable suivant son numéro. On indique la string sous - * la forme "Nom=Valeur". - * - * L'opérateur [] est surchargé deux fois et permet: - * - si on indique un int, de récupérer la variable sous la forme "Nom=Valeur" - * - si on indique une string, de récupérer la valeur de la variable. - * - * La fonction Dump sert à sortir toutes les variables en un formulaire HTML, de - * sorte à faire transiter les variables d'un formulaire à l'autre. Toutes les actions - * implémentées ici possèdant des boutons font appel à cette méthode. En particulier, - * les formulaires en cascadent cumulent leurs variables. - * - * GetNb sert à lire le nombre de variables stockés dans l'instance. - */ - class Variables : public Base { public: Variables(int = 0); -- cgit v1.2.3