xenocara/app/xlockmore/docs/HACKERS.GUIDE.fr
2006-11-26 11:07:42 +00:00

287 lines
14 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

I translate a part of the HACKER.DOC in french
first in text
second in html
bye
--
charles / \
vidal / ..|\
(_\ |_)cvidal@ivsweb.com
/ \@'
/ \ http://www.chez.com/vidalc
_ / ` |
\\/ \ | _\
\ /_ || \\
\____)|_) \_)
-----------------------------------------
LA DOC DU BIDOUILLEUR
INTRODUCTION
________________________________________________________________________________
Ce document est pour tous ceux qui veulent modifier xlock (more), ajouter de
nouveaux modes, debugger , etc....
xlock kesako ?
xlock est une application pour X-windows qui empˆche l'accŠs d'un ou plusieurs
crans. Il peut ˆtre envoy manuellement ou plus communment envoy
automatiquement par un dmon aprŠs une priodes d'inactivit.
Xlock cr une fenˆtre couvrant entiŠrement l'cran, et capte tous vnements
prvenant ainsi l'accŠs extrieur.
Quand une touche est presse alors xlock affiche un message mais aussi le mode
dans une icone
(MODE_ICONIQUE) et demande votre mot de passe.
Lorsque l'cran est lock ( ferm ), des images, des dessins, ou des animations
sont affiches servant de screen-saver vitant la dgradation du phosphore.
Xlock fut dvelopp chez Sun Micro System par Pack J Naughton.David Bagley l'a
repris et maintenu sous le nom de Xlockmore dans lequel d'innombrable mode ont
t ajout, ainsi que la possibilit d'afficher un mode dans une fenˆtre et
aussi sur la root window.
________________________________________________________________________________
ORGANISATION GENERALE
xlock est organiser en deux partie.
1. le traitement de la ligne de commande, la cration de fenˆtre, le mot de
passe, etc ...
2 les modes: ils peuvent ˆtre coder de tel maniŠre qu'il n'y a pas besoin de
faire appel … X pour la taille de la fenˆtre, les couleurs ...
Une API est comprise dans xlock pour avoir tout les renseignements en ce qui
concerne l'cran.
C'est dans cette partie que vous allez pouvoir ajouter d'autres modes.
L'architecture logiciel d'un mode est structur en 4 sortes de fonctions:
-init:
celle-ci devra ˆtre appelle pour prparer le droulement d'un mode. Le mode
devra initialiser des tables de sinus
par exemple, allouer des ressources, mmoire entre autre, tablir l'tat initial
par des variables etc. ...
Cette fonction peut ˆtre appel plusieurs fois et la fenˆtre ou l'cran peuvent avoir des taille diffrentes.
-callback:
C'est la principale fonction, c'est la que est implement le corps du mode.
Elle est appel priodiquement.
Cette fonction ne doit pas occuper beaucoup de temps a s'excuter.
Cette fonction peut etre appele dans deux contextes diffrents:
plein cran ou en version icon. La fonction MI_IS_ICONIC vous dira dans
quelle contexte on se trouve.
-release:
Ici, cette fonction sera appel si un autre mode est appel ( random , et bouton
droit ), ou si xlock se termine.
Dans cette fonction, il faut dsallouer la mmoire, X ressource, Pixmaps et
graphics context.
-refresh:
Celle ci est appel lorsque le dessin peut ˆtre abim. Le mode doit repeindre
l'ensemble de la fenˆtre.
-change: ???? <A FINIR>
________________________________________________________________________________
CONVERSION:
Le prototype de ces fonctions est dfini dans mode.h et ressemble …:
void typefonction _mode( ModeInfo *mode_info)
La structure mode_info est en lecture seule, et contient l'ensemble des
informations sur l'cran.
Ne regardez pas les variables globales, n'crasez pas ce pointeur.
Au lieu de faire des requetes pour connaŒtre le numro de la couleur blanche
etc... , il y a des fonctions propres a xlock: utilisez les.
________________________________________________________________________________
L'AJOUT D'UN NOUVEAU MODE:
Ajoutons un nouveau mode appel fadeplot:
Pour ce faire il faut d'abords ajouter dans mode.h
® extern ModeHook init_fadeplot;
extern ModeHook draw_fadeplot;
extern ModeHook release_fadeplot;
extern ModeHook refresh_fadeplot; ¯
les fonctions qui vont ˆtre crs.
® extern ModeSpecOpt fadeplot_opts; ¯
une structure qui ne m'a pas rvl tous ces secrets.
mais aussi dans mode.c … cot des autres fonctions , dans ce que j'appelle la
tableau des modes:
{"fadeplot", init_fadeplot, draw_fadeplot, release_fadeplot,
refresh_fadeplot, init_fadeplot, NULL, &blank_opts, 17000, 1, 20, 1.0,
"fadeplot", 0, NULL},
On passe ensuite … l'implmentation des fonctions proprement dit dans un fichier
que l'on appellera fadeplot.c.
Il est vident qu'il faudra modifier le Makefile ( Pour cela je vous laisse
faire :).
Dans ces fonctions, … partir de la structure ModeInfo, on va obtenir des
informations sur l'cran qui sont indispensables pour la suite
MI_WIDTH(mi) et MI_HEIGHT(mi) vont nous donn la taille de l'cran.
Display *display = MI_DISPLAY(mi); dlivre le display
Window window = MI_WINDOW(mi); dlivre l'identificateur de la fenˆtre
GC gc = MI_GC(mi); donne le graphics context courant
XSetForeground(display, gc, MI_BLACK_PIXEL(mi));
Mettre la couleur du trac en noir
XSetForeground(display, gc, MI_WHITE_PIXEL(mi));
Mettre la couleur du trac en blanc
MI_IS_ICONIC(mi) permet de savoir si on est pass en phase
password.
NUMCOLORS Donne le nombre de couleur
Oubliez pas aprŠs avoir dessin l'ensemble de faire Xflush(display),
ce qui permettra d'afficher rellement votre graphisme sur l'cran.
La cration d'un nouveau mode s'ffectue souvent en rcuprant le squelette
d'un autre et de le modifier … sa volont.
N'hsitez pas a … regarder le code des autres modes, c'est souvent trs
instructifs.
Dernierement on peut utiliser la librairie mesa (la libraire GNU OpenGL de
silicon Graphics) dans xlock.
Voila j'espere que vous prendrez plaisir a ajouter des nouveaux modes … xlock,
un petit conseil le mainteneur de xlock est un fan de casse tˆte et compagnie.
Bon Xlock.
Charles VIDAL: cvidal@ivsweb.com
mode flag, fadeplot, circle
createur de xmxlock : GUI launcher de xlockmore.
------------------------------------------------------
<HTML>
<HEAD>
<TITLE>Xlock french hacker</TITLE>
</HEAD>
<BODY>
<Center><H1>XLOCK FRENCH HACKER</H1></Center>
<BR>
<H2>INTRODUCTION</H2>
<HR>
Ce document est pour tous ceux qui veulent modifier xlock (more), ajouter de nouveaux modes, debugger , etc....
<H2>xlock kesako ?</H2>
xlock est une application pour X-windows qui empêche laccès dun ou plusieurs écrans. Il peut être envoyé manuellement ou plus communément envoyé automatiquement par un démon après une périodes dinactivité.
Xlock créé une fenêtre couvrant entièrement lécran, et capte tous événements prévenant ainsi laccès extérieur.
Quand une touche est pressée alors xlock affiche un message mais aussi le mode dans une icone (MODE_ICONIQUE) et demande votre mot de passe.<p>
Lorsque lécran est locké ( fermé ), des images, des dessins, ou des animations sont affichées servant de screen-saver évitant la dégradation du phosphore.
Xlock fut développé chez Sun Micro System par Pack J Naughton.David Bagley la repris et maintenu sous le nom de Xlockmore dans lequel dinnombrable mode ont été ajouté, ainsi que la possibilité dafficher un mode dans une fenêtre et aussi sur la root window ou dafficher sequentiellement plusieur mode par loption random et par lappuis du bouton du millieu.<p>
Il existe des terminaux X avec plusieur ecrans gere par un seul terminal, alors le même mode saffichera sur plusieur ecran. On peut toutefois faire des effets, comme une balle passant de lui a lautre.
<HR>
<H2>ORGANISATION GENERALE</H2>
xlock est organiser en deux partie.<p>
<OL>
<LI> le traitement de la ligne de commande, la création de fenêtre(s), le mot de passe, etc ...
<LI> les modes: ils peuvent être coder de tel manière quil ny a pas besoin de faire appel à X pour la taille de la fenêtre, les couleurs ... Une API est comprise dans xlock pour avoir tout les renseignements en ce qui concerne lécran.Cest dans cette
</OL>
<HR>
<B>Larchitecture logiciel dun mode est structuré en 4 sortes de fonctions:</B>
<UL>
<LI><U><B>-init:</B></U>
celle-ci devra être appelle pour préparer le déroulement dun mode. Le mode devra initialiser des tables de sinus par exemple, allouer des ressources, mémoire entre autre, établir létat initial par des variables etc. ...
Cette fonction peut être appelé plusieurs fois et la fenêtre ou lécran peuvent avoir des taille différentes.<p>
<LI><U><B>-callback:</B></U>
Cest la principale fonction, cest la que est implementé le corps du mode. Elle est appelé périodiquement. Cette fonction ne doit pas occuper beaucoup de temps a sexécuter surtout si elle a plusieur ecran soccuper.
Cette fonction peut etre appele dans deux contextes différents:
plein écran ou en version icon. La fonction MI_IS_ICONIC vous dira dans quelle contexte on se trouve.
la fonction init_mode est toujours appelle avant la fonction callback.
On peut choisir de faire quelque chose a chaque appelle, ou de compter le nombre dappelle, et puis de modifier lecran periodiquement.<p>
<LI><U><B>-release: </B></U>
Ici, cette fonction sera appelé si un autre mode est appelé ( random , et bouton droit ), ou si xlock se termine. Dans cette fonction, il faut désallouer la mémoire, X ressource, Pixmaps et graphics context.
<p>
<LI><U><B>-refresh:</B></U>
Celle ci est appelé lorsque le dessin peut être abimé. Le mode doit repeindre lensemble de la fenêtre.
Aucun information sur la partie de lecran endomage nest delivre.
<p>
<LI><U><B>-change:</B></U> Dans la version courante, seule le mode random utilise cette fonctionnalite. Cet fonction est appele lorsque que lon change de mode par lappuie du boutton du millieu. Il est laisse a limagination de chacun en ce qui conserne
</UL>
<HR>
<H2>CONVENTION:</H2>
Le prototype de ces fonctions est défini dans mode.h et ressemble à:<p>
<Center> void typefonction _mode( ModeInfo *mode_info)</Center>
La structure mode_info est en lecture seule, et contient lensemble des informations sur lécran. Ne regardez pas les variables globales, nécrasez pas ce pointeur. Au lieu de faire des requetes pour connaître le numéro de la couleur blanche etc... , il y a des fonctions propres a xlock: utilisez les. Si vous utilisez les informations passe en parametre des fonctions du modes ( voir ci dessus ), votre code sera toujours correcte.
Le temps entre chaque appelle de fonctions est en milliseconde.
<HR>
<H2>LAJOUT DUN NOUVEAU MODE:</H2>
Ajoutons un nouveau mode appelé <A HREF="file:fadeplot.txt">fadeplot</A>:<p>
Pour ce faire il faut dabords ajouter dans mode.h<p>
« extern ModeHook init_fadeplot;<p>
extern ModeHook draw_fadeplot;<p>
extern ModeHook release_fadeplot;<p>
extern ModeHook refresh_fadeplot; »<p>
les fonctions qui vont être créés.
<p>
« extern ModeSpecOpt fadeplot_opts; »<p>
une structure qui ne ma pas révélé tous ces secrets.<p>
mais aussi dans mode.c à coté des autres fonctions , dans ce que jappelle le tableau des modes:<p>
{"fadeplot", init_fadeplot, draw_fadeplot, release_fadeplot,
refresh_fadeplot, init_fadeplot, NULL, &blank_opts, 17000, 1, 20, 1.0,
"fadeplot", 0, NULL},<p>
On passe ensuite à limplémentation des fonctions proprement dit dans un fichier que lon appellera fadeplot.c.<p>
Il est évident quil faudra modifier le Makefile ( Pour cela je vous laisse faire :).<p>
Dans ces fonctions, à partir de la structure ModeInfo ( mode.h ) , on va obtenir des informations sur lécran qui sont indispensables pour la suite.<p>
<TABLE Border=1>
<CAPTION><B>fonction</B></CAPTION>
<TR><TD>MI_WIDTH(mi) et MI_HEIGHT(mi)</TD> <TD>vont nous donné la taille de lécran</TD></TR>.
<TR><TD>Display *display = MI_DISPLAY(mi);</TD> <TD>délivre le display</TD></TR>
<TR> <TD> MI_SCREEN </TD> <TD>délivre le screen</TD></TR>
<TR><TD>Window window = MI_WINDOW(mi)</TD>; <TD>délivre lidentificateur de la fenêtre</TD></TR>
<TR><TD>GC gc = MI_GC(mi);</TD> <TD>donne le graphics context courant</TD></TR>
<TR> <TD>MI_DELAY</TD> <TD> donne le delai (microsec.) entre callbacks</TD></TR>
<TR> <TD>MI_CMAP</TD> <TD>donne la table des couleurs</TD></TR>
<TR><TD>XSetForeground(display, gc, MI_BLACK_PIXEL(mi));</TD> <TD>Mettre la couleur du tracé en noir</TD></TR>
<TR><TD>XSetForeground(display, gc, MI_WHITE_PIXEL(mi));</TD> <TD>Mettre la couleur du tracé en blanc</TD></TR>
<TR><TD>MI_IS_ICONIC(mi) </TD> <TD>permet de savoir si on est passé en phase password. </TD></TR>
</TABLE>
<TABLE Border=1>
<CAPTION><B>variable</B></CAPTION>
<TR><TD>MI_IS_MONO </TD> <TD>lecran est monochrome</TD></TR>
<TR><TD>MI_IS_INWINDOW</TD> <TD>le mode saffiche dans un fenetre reguliere</TD></TR>
<TR><TD>MI_IS_INROOT </TD> <TD>le mode saffiche sur la root windows</TD></TR>
<TR><TD>NUMCOLORS</TD> <TD>Donne le nombre de couleur</TD></TR>
</TABLE>
Oubliez pas après avoir dessiné lensemble de faire Xflush(display), ce qui permettra dafficher réellement votre graphisme sur lécran.
La création dun nouveau mode séffectue souvent en récupérant le squelette dun autre et de le modifier à sa volonté.
Nhésitez pas a à regarder le code des autres modes, cest souvent trés instructifs.
<HR>
<H2>Perspective:</H2>
Dernierement on peut utiliser la librairie mesa (la libraire OpenGL de silicon GNU) dans xlock, quelquun sest propose de faire le screen-saver tube de Win NT.
Je pense quil serait interressant de joindre a xlock un langage simple ( genre logo un peu plus evolue).
<HR>
<H2>Reference: </H2>
HACKERS.GUIDE qui se trouve dans le repertoire docs ( jai essaye de le traduire :)<p>
X_Window programmation avec les Xt-Intrinsics Douglas A YOUNG MASSON PARIS.<p>
<HR>
Voila jespere que vous prendrez plaisir a ajouter des nouveaux modes à xlock; cest une maniere de programmer facilement des graphismes sous X11. Un petit conseil le mainteneur de xlock est un fan de casse tête et compagnie.
Bon Xlock.
<p>
Charles VIDAL: cvidal@ivsweb.com<p>
mode flag, fadeplot, bubble<p>
createur de xmxlock : GUI launcher de xlockmore.<p>
</BODY>
</HTML>