opcodes.c File Reference

All user-callable functions. More...

#include "config.h"
#include <stddef.h>
#include "opcodes.h"

Include dependency graph for opcodes.c:

Go to the source code of this file.

Macros
#define	DEFINE_HELP_MESSAGE(opcode, op_string)

Functions
const char *	opcodes_get_name (int op)
	Get the name of an opcode.
const char *	opcodes_get_description (int op)
	Get the description of an opcode.

Variables
static const char *	OpStrings [][2]
	Lookup table mapping an opcode to its name and description e.g.

Detailed Description

All user-callable functions.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file opcodes.c.

Macro Definition Documentation

DEFINE_HELP_MESSAGE

#define DEFINE_HELP_MESSAGE	(		opcode,
			op_string )

Value:

{ #opcode, op_string },

Definition at line 33 of file opcodes.c.

Function Documentation

opcodes_get_name()

const char * opcodes_get_name

(

int

op

)

Get the name of an opcode.

Parameters

op	Opcode, e.g. OP_HELP

Return values

str	Name of the opcode

Definition at line 48 of file opcodes.c.

{
  if ((op < OP_REPAINT) || (op >= OP_MAX))
    return "[UNKNOWN]";
 
  if (op == OP_ABORT)
    return "OP_ABORT";
  if (op == OP_TIMEOUT)
    return "OP_TIMEOUT";
  if (op == OP_REPAINT)
    return "OP_REPAINT";
 
  return OpStrings[op][0];
}

Here is the caller graph for this function:

opcodes_get_description()

const char * opcodes_get_description

(

int

op

)

Get the description of an opcode.

Parameters

op	Opcode, e.g. OP_HELP

Return values

str	Description of the opcode

Definition at line 68 of file opcodes.c.

{
  if ((op < OP_REPAINT) || (op >= OP_MAX))
    return "[UNKNOWN]";
 
  if (op == OP_ABORT)
    return "abort the current action";
  if (op == OP_TIMEOUT)
    return "timeout occurred";
  if (op == OP_REPAINT)
    return "repaint required";
 
  return OpStrings[op][1];
}

Here is the caller graph for this function:

Variable Documentation

OpStrings

const char* OpStrings[][2]

static

Initial value:

= {
  OPS(DEFINE_HELP_MESSAGE){ NULL, NULL },
}

Lookup table mapping an opcode to its name and description e.g.

OpStrings[OP_EDIT_LABEL] = { "OP_EDIT_LABEL", "edit an email's label" }

Definition at line 37 of file opcodes.c.

                                    {
  OPS(DEFINE_HELP_MESSAGE){ NULL, NULL },
};