projects/pwm: cmd.h annotate

annotate cmd.h @ 19:5c6155c8e9b6

Handle signals Handled signals are generally blocked and only unblocked when doing blocking I/O, i.e. either when reading commands or printing results. A (possibly queued) signal will then interrupt I/O and can be dealt with in the main loop.

author	Guido Berhoerster <guido+pwm@berhoerster.name>
date	Fri, 01 Sep 2017 22:33:41 +0200
parents	a07665727c19
children

rev	line source
0 a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	1 /*
16 a07665727c19 Add status command Guido Berhoerster <guido+pwm@berhoerster.name> parents: 0 diff changeset	2 * Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
0 a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	3 *
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	4 * Permission is hereby granted, free of charge, to any person obtaining
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	5 * a copy of this software and associated documentation files (the
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	6 * "Software"), to deal in the Software without restriction, including
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	7 * without limitation the rights to use, copy, modify, merge, publish,
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	8 * distribute, sublicense, and/or sell copies of the Software, and to
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	9 * permit persons to whom the Software is furnished to do so, subject to
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	10 * the following conditions:
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	11 *
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	12 * The above copyright notice and this permission notice shall be included
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	13 * in all copies or substantial portions of the Software.
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	14 *
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	18 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	19 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	20 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	21 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	22 */
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	23
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	24 #ifndef CMD_H
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	25 #define CMD_H
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	26
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	27 #include "pwm.h"
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	28
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	29 enum cmd_return {
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	30 CMD_OK,
16 a07665727c19 Add status command Guido Berhoerster <guido+pwm@berhoerster.name> parents: 0 diff changeset	31 CMD_STATUS,
0 a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	32 CMD_ERR,
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	33 CMD_USAGE,
19 5c6155c8e9b6 Handle signals Guido Berhoerster <guido+pwm@berhoerster.name> parents: 16 diff changeset	34 CMD_SIGNAL,
0 a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	35 CMD_QUIT
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	36 };
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	37
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	38 struct cmd {
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	39 const char *abbrev_cmd;
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	40 const char *full_cmd;
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	41 const char *usage;
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	42 const char *description;
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	43 enum cmd_return (cmd_func)(struct pwm_ctx , int argc, char *argv[]);
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	44 };
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	45
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	46 struct cmd * cmd_match(const char *);
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	47
a7e41e1a79c8 Initial revision Guido Berhoerster <guido+pwm@berhoerster.name> parents: diff changeset	48 #endif /* CMD_H */

Mercurial > projects > pwm

annotate cmd.h @ 19:5c6155c8e9b6