Adding the Cygwin/mingw documentation from Jean-Seb (see e-mail dated Thu 7/9/2009...
[freeglut] / LISEZMOI.cygwin_mingw
diff --git a/LISEZMOI.cygwin_mingw b/LISEZMOI.cygwin_mingw
new file mode 100644 (file)
index 0000000..6a2f27f
--- /dev/null
@@ -0,0 +1,218 @@
+Glut alors!\r
+\r
+Par Jean-Seb le vendredi 10 juillet 2009, 00:18\r
+\r
+\r
+Freeglut est une évolution open-source de Glut.\r
+Sous Windows, on peut l'utiliser avec Cygwin.\r
+Facile ? Oui, si on accepte de distribuer "cygwin1.dll"\r
+Aidons Freeglut à conquérir son indépendance !\r
+m.à.j 10/7/2009 : génération d'une librairie pour linker depuis la dll.\r
+\r
+\r
+Récupération des sources\r
+\r
+    * Reprenez les sources de la version 2.6.0 qui intègre les changements\r
+      récents.\r
+    * Pour l'instant, il s'agit d'une RC (Release Candidate), mais la version\r
+      finale ne saurait tarder.\r
+    * L'utilisation de la 2.6 est préférable à la branche 2.4-stable, de\r
+      nombreux bugs étant corrigés.\r
+    * Vous trouverez les sources sur le site de Freeglut:\r
+          o http://freeglut.sourceforge.net/\r
+\r
+\r
+Principe\r
+Objectif\r
+\r
+    * Nous allons créer une dll liée à Cygwin, et une bibliothèque statique\r
+      indépendante\r
+    * Nous créerons également une librairie dynamique, permettant de linker avec\r
+      la dll.\r
+\r
+Liste des fichiers générés\r
+\r
+    * freeglut.dll : une dll classique pour le linkage dynamique.\r
+    * libfreeglut.a : la bibliothèque statique. Le programme final est autonome\r
+      (du moins pour OpenGL).\r
+    * libfreeglutdll.a : la bibliothèque dynamique. Le programme final a besoin\r
+      de freeglut.dll.\r
+\r
+\r
+Préparation\r
+\r
+    * Dépliez l'archive freeglut.\r
+    * Allez dans le répertoire src (situé à la racine du répertoire Freeglut),\r
+      et créez un sous-répertoire "Gl"\r
+          o Dans ce sous-répertoire, copiez les fichiers du répertoire\r
+            "include/Gl"\r
+\r
+    * Pourquoi faut-il créer un répertoire "Gl" pour la compilation ?\r
+          o C'était juste pour simplifier les choses lors de mes essais.\r
+          o Sinon vous pouvez créer directement les répertoires, et copier les\r
+            fichiers comme indiqué au point installation (lire plus loin).\r
+\r
+    * Faites un peu de ménage dans /lib :\r
+          o Effacez toutes les références à la glut, pour ne pas avoir de\r
+            conflit au linkage.\r
+          o Cette étape est facultative, vous pouvez également choisir de ne\r
+            faire le ménage qu' après une compilation réussie de Freeglut.\r
+          o Attention à ne pas effacer, dans un enthousiasme rédempteur, la\r
+            bibliothèque glu32.lib (à ne pas confondre avec glut32.lib).\r
+\r
+\r
+Compilation\r
+\r
+    * Oubliez le triptyque ./configure , make , make install.\r
+          o Ca ne marche pas du tout avec Cygwin.\r
+\r
+    * Voici un Makefile qui fera l'affaire:\r
+\r
+#Makefile pour Freeglut 2.6.0-rc et Cygwin\r
+#A placer dans le répertoire "src"\r
+\r
+sources=$(wildcard *.c)\r
+objs=$(sources:.c=.o)\r
+libname=freeglut\r
+\r
+\r
+CFLAGS=-O2 -DTARGET_HOST_MS_WINDOWS -DX_DISPLAY_MISSING -DFREEGLUT_STATIC -I./\r
+LDFLAGS=-lopengl32 -lgdi32 -lwinmm\r
+\r
+nocyg=-mno-cygwin -mwindows\r
+\r
+all: $(objs)\r
+        #construction dll liée à cygwin1.dll\r
+        gcc $(nocyg) $(objs) -shared $(LDFLAGS) -o $(libname).dll\r
+        nm $(libname).dll  | awk 'BEGIN { print "EXPORTS" } /T _glut/ {sub( /^.*T _/, "\t"); print}' > $(libname).def\r
+        dlltool --dllname $(libname).dll --input-def $(libname).def --output-lib lib$(libname)dll.a\r
+\r
+        #construction bibliothèque statique indépendante de cygwin\r
+        ar cr lib$(libname).a $(objs)\r
+        #pas forcément obligatoire (création d'un index pour accélérer les accès)\r
+        ranlib lib$(libname).a\r
+\r
+%.o: %.c\r
+        gcc $(nocyg) -c $(CFLAGS) $<\r
+\r
+clean:\r
+        rm -f *.o $(libname).dll $(libname).def lib$(libname)dll.a lib$(libname).a\r
+\r
+\r
+\r
+\r
+Quelques remarques sur le makefile\r
+\r
+    * Ce makefile crée une dll, une bibliothèque statique (une archive, en\r
+      d'autres termes) et la bibliothèque dynamique qui permettra l'utilisation\r
+      de la dll.\r
+\r
+    * Ne cherchez pas à stripper la bibliothèque statique! Vous ne pourriez plus\r
+      compiler en statique.\r
+          o Par contre, vous pouvez stripper l'exécutable final obtenu lors de\r
+            la compilation de votre application.\r
+\r
+    * J'ai choisi d'appeller la dll et les bibliothèques par leurs "vrais noms":\r
+      freeglut.dll libfreeglutdll.a et libfreeglut.a.\r
+          o Le script configure recréait (pour des raisons de compatibilité avec\r
+            l'ancienne bibliothèque Glut) glut.dll et libglut.a.\r
+          o Lors des mes essais, j'ai eu des conflits avec une authentique\r
+            "glut" qui trainait dans mon "/lib". J'ai décidé d'appeller les\r
+            choses par leur nom, afin d'éviter les confusions.\r
+          o Rien ne vous empêche de renommer la dll, si vous avez besoin\r
+            d'utiliser des programmes Glut que vous ne pouvez pas recompiler.\r
+\r
+    * La bibliothèque dynamique est générée à partir de la dll.\r
+          o Par souci de concision, j'ai utilisé awk. Il génère le fichier\r
+            d'exports utilisé par dlltool.\r
+          o La seule chose notable est la sélection des fonctions dont le nom\r
+            commence par _glut, afin d'éviter d'inclure dans la librairie\r
+            dynamique des fonctions sans rapport avec freeglut.\r
+          o ensuite, on utilise dlltool de façon très classique.\r
+\r
+nm $(libname).dll  | awk 'BEGIN { print "EXPORTS" } /T _glut/ {sub( /^.*T _/, "\t"); print}' > $(libname).def\r
+dlltool --dllname $(libname).dll --input-def $(libname).def --output-lib lib$(libname)dll.a\r
+\r
+\r
+\r
+\r
+Installation\r
+\r
+    * Copiez libfreeglut.a, libfreeglutdll.a dans le répertoire /lib de Cygwin.\r
+    * Copiez freglut.dll dans le system32 de Windows (ce qui est pratique, mais\r
+      pas propre!).\r
+    * Copiez les fichiers headers de Freeglut (/include/gl) dans /usr/include/Gl\r
+      de Cygwin.\r
+    * Copiez les fichiers headers (toujours /include/gl) dans\r
+      /usr/include/mingw/Gl : ceci sert aux compilations avec le flag\r
+      -mno-cygwin, qui utilise alors les includes de mingw.\r
+          o Vous aurez éventuellement besoin d'écraser d'anciens fichiers\r
+            include, correspondants à Glut, si vous l'avez installé avec Cygwin.\r
+\r
+\r
+Utilisation de la librairie\r
+\r
+    * Nous allons tester avec le programme shapes, présent dans\r
+      progs/demos/shapes\r
+          o -mno-cygwin sert à forcer l'utilisation de Mingw sans la grosse\r
+            dépendance cygwin1.dll.\r
+          o -mwindows sert uniquement à enlever l'horrible fenêtre shell (très\r
+            utile pour la mise au point, par contre).\r
+          o -L. (notez le point après le "L") : j'ai laissé libfreeglut.a,\r
+            libfreeglutdll.a et freeglut.dll dans le répertoire de test, le\r
+            temps des tests justement.\r
+\r
+\r
+Compilation en librairie statique freeglut, sans cygwin\r
+\r
+    * Toute l'astuce réside dans le define : -DFREEGLUT_STATIC\r
+          o Il sert à obtenir la bonne décoration des noms de fonctions dans les \r
+            imports de la lib Freeglut.\r
+          o Vous pouvez essayer sans et prendre un éditeur hexa pour voir les\r
+            différences dans l'objet.\r
+    * attention à l'ordre des bibliothèques : -lfreeglut (statique) doit se\r
+      trouver avant la déclaration des bibliothèques dynamiques.\r
+\r
+    * gcc shapes.c -L. -lfreeglut -lopengl32 -lwinmm -lgdi32 -mno-cygwin\r
+      -mwindows -DFREEGLUT_STATIC\r
+\r
+\r
+Compilation avec dll freeglut, sans cygwin\r
+\r
+    * Pour le define, même remarque que ci-dessus\r
+    * L'ordre des bibliothèques n'a plus d'importance.\r
+\r
+    * gcc shapes.c -L. -lopengl32 -lwinmm -lgdi32 -lfreeglut -mno-cygwin\r
+      -DFREEGLUT_STATIC\r
+\r
+\r
+Compilation avec dll freeglut, avec Cygwin\r
+\r
+    * Cet exemple est donné uniquement pour référence, le thème de ce billet étant de se débarrasser de Cygwin.\r
+          o Disons que ça peut servir pendant la mise au point (et encore).\r
+\r
+    * gcc shapes.c -L. -lopengl32 -lwinmm -lgdi32 -lfreeglut\r
+\r
+\r
+\r
+Où sont les dooooocs ?\r
+\r
+    * Freeglut est livré avec sa documentation, plus très à jour.\r
+          o Il semble qu'il y ait un problème avec la doc Glut originale. Non\r
+            seulement elle ne correspond pas forcément au fonctionnement de\r
+            Freeglut, mais de plus, son auteur (Mark Kilgard) l'a copyrighté. Sa\r
+            distribution est donc difficile.\r
+\r
+    * Jocelyn Fréchot a entrepris une mise à niveau des docs pour la version\r
+      2.6.0. On peut les trouver sur son site pour l'instant:\r
+          o http://jocelyn.frechot.free.fr/freeglut/\r
+\r
+\r
+Quelque chose a survécu ...\r
+\r
+    * J'ai également testé la recompilation des démos de la lib Glut originelle\r
+      (paix à ses cendres).\r
+          o Rien de particulier à signaler.\r
+\r
+    * Merci à tous les mainteneurs courageux de Freeglut, qu'on croyait mort,\r
+      mais qui bouge encore.\r