gstream-set_input_error_handler man page



#include <gstream.h>

void set_input_error_handler(int error);


Sets an error handler that will be called of the inputter encounter any unusual, erratic behaviour, e.g. the user trying to move the cursor off the string or pressing invalid keys. The handler is passed a constant which currently can be one of the following:


The inputted key couldn't be used for anything, i.e. it wasn't one of the recognized control keys (for example KEY_LEFT, but not KEY_PGDN) and the input approver didn't accept it as a valid char either.


The user tried to move the cursor off the input string, e.g. if the cursor is at the beginning of the string and the user presses KEY_LEFT or KEY_HOME. Note that pressing KEY_UP and KEY_DOWN currently returns IE_CURSOR_EXCEEDING_LIMITS, no matter where the cursor is.


There was no room for the inputted char. This often occurs if the length of the input string has been limited to a certain maximum with set_max_input_length, but may also happen if the buffer that the inputter puts the data in is full. The latter is not likely to happen unless you, for instance, force the gstream to use your own buffer, as the standard buffer is rather large.

Note that these constants are defined in 'gbuf' so you have to put 'gbuf' and the scope operator in front of them:

int stupid_mistakes = 0;

void ieh_for_my_number_inputter(int e)
  switch (e) {
    case gbuf::IE_UNRECOGNIZED_KEY:  // note: gbuf::
         if (stupid_mistakes > MUST_BE_BRAIN_DEAD) {
           say_to_user("Sorry, you can only input numbers!");
           user_characteristics = FOOL;
           stupid_mistakes = 0;
    case gbuf::IE_NO_ROOM_FOR_CHAR:
   } // in all other situations: do nothing

You should be aware that the inputter automatically will take care of any problems encountered and solve them with much elegance (often simply by ignoring the user if the result of the action would be illegal), so your error handler doesn't really deal with the problem or handle the situation - it is merely a way for you to warn or tell the user that he is doing something wrong.

Some advices concerning the style is given here - of course, you don't have to follow them, you are free to have you own opinion and the advices are general so they might not fit your particular situation, but please at least read them through before you begin designing your own error handler:

Often the best thing to do is not to do anything. For example, simply ignoring that the user is pressing an unrecognized key is often better than complaining, unless you have a specific reason for warning him - in the example above the user should be aware that he was supposed to enter a number

If you decide to do something, remember the KISS principle: keep it simple. If you as a user have made a mistake, you're probably already irritated because of that and then it doesn't help the situation that you have to watch the screen go beserk (or hear an entire symphony) before you can continue

If you play a sound, such as a beep, make it a short, quiet one. Personally I can't stand a hysterical "BEEEEEEEEEP" if I accidentally hit the wrong key

Generally don't use large special effects. If you have invented a new kind of plasma generator, you're probably better off releasing a demo that shows it, instead of making your users annoyed by forcing them to look at it everytime they make the slightest fault

If you display a message, consider implementing a system like in the example above where the user is given a few tries before the message is displayed, to ensure it is only (or mostly) sent to newbies. If the example should be perfect, it would even reset the mistake counter now and then

At last a practical advice: keep in mind that future versions of gstream may have more error codes added, so design the function in a way that it won't break as soon as that happens (e.g. don't count on that if you test for the first constants, then the remaining has to be the last)

There is a typedef, 'input_error_handler', in 'gbuf' for the type of a pointer to a handler function:

gbuf::input_error_handler tmp_ieh;


tmp_ieh = gs1.get_input_error_handler();

The default input error handler is 'ieh_never_complain'.

See Also

gstream-get_input_error_handler(3), gstream-set_input_approver(3), gstream-set_max_input_length(3), gstream-ieh_never_complain(3)

Referenced By

gstream-get_input_error_handler(3), gstream-ia_allow_decimal(3), gstream-ia_allow_everything(3), gstream-ia_allow_hexadigits(3), gstream-ia_allow_integer(3), gstream-ia_allow_word_chars(3), gstream-ia_block_spaces(3), gstream-ieh_led_flasher(3), gstream-ieh_never_complain(3).

Explore man page connections for gstream-set_input_error_handler(3).

gstream version 1.6 gstream manual