X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=TODO;h=ff546a032cf7257719b48333c4afff81e0bbc274;hb=ae95118467c6af962f8eb3ea0cb06c27f56d59af;hp=7326d48909fdffe89fb5b108fdff05e039fde4ff;hpb=2388a02493831f3ec11f1df66a0cf7b09995279b;p=supertux.git

diff --git a/TODO b/TODO
index 7326d4890..ff546a032 100644
--- a/TODO
+++ b/TODO
@@ -1,42 +1,109 @@
+Note: Controversial list of things currently broken and controversial
+solutions for them.
 
-- To do for Milestone1 -
-http://super-tux.sf.net/
+Coding Standard
+===============
 
-Last update: April 26, 2004
+* no external libraries in src/, they go to external/
 
-These are mostly bugs:
+* proper separation between engine and game specific code (especially
+  sound and video handling)
 
-Todo
-----
+* normalize #include directives (all refer to top level dir)
 
-- tux sometimes makes short jumps in the endsequence, mostly when
-  going through the goal with a small jump, might be old_up related
-- fadein/out for intro/extro would be nice
-- the can_jump flag should be based on a time instead of the 2 tiles check.
-  Since the 2 tiles flag won't help when you're jumping over a hole. Better use
-  a timer that is started when up is pressed, when you then land and the timer
-  is below a certain time, you can do the jump.
-- when bumping a special with 2 blocks at once, it won't change direction
+* use SCons instead of CMake
 
-- leveleditor lacks enemies support (will be fixed soon by Tobias)
-- sometimes you die after being in pause modus and unpausing - still true?
+* make code clean: "-O2", "-g3",
+                     "-ansi",
+                     "-pedantic",
+                     "-Wall",
+                     "-Wextra",
+                     "-Wnon-virtual-dtor",
+                     "-Weffc++",
+                     "-Wconversion",
+                     "-Werror",
+                     "-Wshadow",
+                     "-Wcast-qual",
+                     "-Winit-self", # only works with >= -O1
+                     "-Wno-unused-parameter",
 
+* do not use raw pointer, especially not for Sprite and Surface
 
-Fixed
------
+* properly separate data members and member functions, don't mix them
+  in the same section
 
-- points aren't reset when gameover
-- when jumping into the exit with a star, the endgame music will change back to
-  levelmusic after a short time
-- when jupming against the 2nd multiple coin block in a level only 1 coin will
-  come out.
-- when you interrupted the intro (by going to credits for example) and go back
-  to it, tux doesn't jump anymore
-- supertux crashs from time to time - fixed
-- mriceblock doesn't fall down when being squished in the air - fixed
-- It's not possible to duck while jumping - fixed
-- Intro/Extro textspeed is CPU dependent - fixed
-- sometimes the level restarts/you die after collecing a growup - fixed
-- mriceblock doesn't disapear after being kicked my another iceblock,
-  not sure when exactly it happens, might depend on direction or so - fixed
+* write namespaces like: "namespace NameSpace {", no newline before the {
 
+* only do one variable initialization per line, not multiple as its
+  currently often done in initialization list
+
+* conditional includes should be indended (makes it easier to handle
+  in include optimization):
+
+#ifdef FOOBAR
+#  include "foobar.hpp"
+#endif
+
+* remove overuse of multi-inheritance 
+
+* remove overuse of friend'ship
+
+* maybe mark interfaces as interfaces (ISerializable or SerializableInterface)
+
+* split files with multiple classes into multiple files with one class each
+
+
+TODO
+====
+
+* GameObject::RemoveListenerListEntry: Ughs, somebody trying to
+  implement a list class within in the GameObject?!
+
+* replace random generator with mersene twister and/or move to external/
+
+* check the code with Valgrind
+
+* cleanup doxygen comments, use /** */, nothing else
+
+* static vs anonymous namespace
+
+* use Vector in Physics for 'a' and 'v'
+
+* add --datadir DIR (data/) and --userdir DIR (~/.supertux/)
+
+* make gravity a constant
+
+* funky side effect of too much global variables: when having a
+  savegame with large or firetux and then starting that game, Tux in
+  the menu background will grow and be visible that way for a fraction
+  of a second
+
+* write scripts for include sorting and include guard checking that
+  can be run automatically
+
+* md5.hpp and random_generator.hpp could go to external/
+
+* rename Vector -> Vector2f
+
+* get rid of global SDL_Screen* screen variable
+
+* identify all global variables and make them ugly (g_ or globals::)
+
+* get rid of SCREEN_WIDTH/SCREEN_HEIGHT
+
+* is version.h actually needed?
+
+* resolution menu entry moves the wrong way around
+
+* write scripts to automatically check for:
+
+  - all includes are relative to top level dir
+
+  - include guards are proper
+
+* move SVN to http://code.google.com (maybe one day)
+
+* move bugtracker to http://code.google.com (much simpler, less useless)
+
+
+# EOF #