Difference between revisions of "SCI/TODO"

From ScummVM :: Wiki
< SCI
Jump to navigation Jump to search
(Removed some implemented/obsolete TODOs)
(Group TODOs by rough estimated difficulty)
Line 1: Line 1:
* check for places that use char or unsigned char for boolean values, and change those to bool. Even nicer would be to change it to use enum types whose value names express the intention (SearchOptions.RECURSIVE, GraphicsScaleOptions.2X, etc), but just going for bool will already be a big improvement.
+
* Easy
* Change #define lists into enums
+
** rename the sfx/ dir to sound/ or audio/ (it doesn't just deal with "sound effects).
* Rearrange the files under engines/sci. Some source files should also be renamed for clarity.
+
** change the many nice existing function documentation comments to use doxygen syntax
* Convert stuff from "C pseudo classes" to real classes.
+
** Change #define lists into enums
* Replace various generic FreeSCI code by their ScummVM counterparts, where it make sense.
+
 
* Not specific to SCI, but: Replace "struct tm" in common/system.h (and places that implement/use it) by a custom struct, which would be a (partial) clone of struct tm, something like Common::OSystem::Time. That way, we wouldn't have to use <time.h> anymore anywhere.
+
* Medium
* change the many nice existing function documentation comments to use doxygen syntax
+
** Convert stuff from "C pseudo classes" to real classes.
* Turn code into templates in following files (now they generate code via #defines):
+
** check for places that use char or unsigned char for boolean values, and change those to bool. Even nicer would be to change it to use enum types whose value names express the intention (SearchOptions.RECURSIVE, GraphicsScaleOptions.2X, etc), but just going for bool will already be a big improvement.
** gfx/gfx_pixmap_scale.cpp
+
** Replace various generic FreeSCI code by their ScummVM counterparts, where it make sense.
** gfx/picfill.cpp
+
** Check old FreeSCI-scummvm branch / repos by Jordi for change that could be salvaged, e.g. the files <code>sfx/device/scumm-midi.cpp</code> and <code>sfx/softseq/scumm-adlib.cpp</code>, or the modifications to the SCI debugger to use the ScummVM console, and stuff.
* Check old FreeSCI-scummvm branch / repos by Jordi for change that could be salvaged, e.g. the files <code>sfx/device/scumm-midi.cpp</code> and <code>sfx/softseq/scumm-adlib.cpp</code>, or the modifications to the SCI debugger to use the ScummVM console, and stuff.
+
 
* make the SCI tools compilable (to avoid bitrot, while we change code that they depend on), and finally usable again.
+
* Difficult
* rename the sfx/ dir to sound/ or audio/ (it doesn't just deal with "sound effects).
+
** Turn code into templates in following files (now they generate code via #defines):
 +
*** gfx/gfx_pixmap_scale.cpp
 +
*** gfx/picfill.cpp
 +
** make the SCI tools compilable (to avoid bitrot, while we change code that they depend on), and finally usable again.

Revision as of 12:49, 24 March 2009

  • Easy
    • rename the sfx/ dir to sound/ or audio/ (it doesn't just deal with "sound effects).
    • change the many nice existing function documentation comments to use doxygen syntax
    • Change #define lists into enums
  • Medium
    • Convert stuff from "C pseudo classes" to real classes.
    • check for places that use char or unsigned char for boolean values, and change those to bool. Even nicer would be to change it to use enum types whose value names express the intention (SearchOptions.RECURSIVE, GraphicsScaleOptions.2X, etc), but just going for bool will already be a big improvement.
    • Replace various generic FreeSCI code by their ScummVM counterparts, where it make sense.
    • Check old FreeSCI-scummvm branch / repos by Jordi for change that could be salvaged, e.g. the files sfx/device/scumm-midi.cpp and sfx/softseq/scumm-adlib.cpp, or the modifications to the SCI debugger to use the ScummVM console, and stuff.
  • Difficult
    • Turn code into templates in following files (now they generate code via #defines):
      • gfx/gfx_pixmap_scale.cpp
      • gfx/picfill.cpp
    • make the SCI tools compilable (to avoid bitrot, while we change code that they depend on), and finally usable again.