aboutsummaryrefslogtreecommitdiff
path: root/devel.but
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2017-10-01 12:52:12 +0100
committerSimon Tatham <anakin@pobox.com>2017-10-01 15:18:14 +0100
commiteeb2db283de9115f7256fa4cc49597d63e06b0ab (patch)
tree48de59795d6a338ef56c5a0f1e1247478c6ad6b9 /devel.but
parentedcf839d4c557c3993d681665829390697353344 (diff)
downloadpuzzles-eeb2db283de9115f7256fa4cc49597d63e06b0ab.zip
puzzles-eeb2db283de9115f7256fa4cc49597d63e06b0ab.tar.gz
puzzles-eeb2db283de9115f7256fa4cc49597d63e06b0ab.tar.bz2
puzzles-eeb2db283de9115f7256fa4cc49597d63e06b0ab.tar.xz
New name UI_UPDATE for interpret_move's return "".
Now midend.c directly tests the returned pointer for equality to this value, instead of checking whether it's the empty string. A minor effect of this is that games may now return a dynamically allocated empty string from interpret_move() and treat it as just another legal move description. But I don't expect anyone to be perverse enough to actually do that! The main purpose is that it avoids returning a string literal from a function whose return type is a pointer to _non-const_ char, i.e. we are now one step closer to being able to make this code base clean under -Wwrite-strings.
Diffstat (limited to 'devel.but')
-rw-r--r--devel.but8
1 files changed, 4 insertions, 4 deletions
diff --git a/devel.but b/devel.but
index 25a6c62..16aaf02 100644
--- a/devel.but
+++ b/devel.but
@@ -907,10 +907,10 @@ divide mouse coordinates by it.)
in response to the input event; the puzzle was not interested in it
at all.
-\b Returning the empty string (\cw{""}) indicates that the input
+\b Returning the special value \cw{UI_UPDATE} indicates that the input
event has resulted in a change being made to the \c{game_ui} which
-will require a redraw of the game window, but that no actual
-\e{move} was made (i.e. no new \c{game_state} needs to be created).
+will require a redraw of the game window, but that no actual \e{move}
+was made (i.e. no new \c{game_state} needs to be created).
\b Returning anything else indicates that a move was made and that a
new \c{game_state} must be created. However, instead of actually
@@ -925,7 +925,7 @@ strings can be written to disk when saving the game and fed to
The return value from \cw{interpret_move()} is expected to be
dynamically allocated if and only if it is not either \cw{NULL}
-\e{or} the empty string.
+\e{or} the special string constant \c{UI_UPDATE}.
After this function is called, the back end is permitted to rely on
some subsequent operations happening in sequence: