interpose Class Reference

#include <interpose.h>

Inheritance diagram for interpose:

List of all members.

Public Types
typedef boost::shared_ptr < interpose >	pointer
Public Member Functions
virtual	~interpose ()
virtual void	on_opcode (opcode_t op, const location::pointer &where)=0
virtual bool	strict_memory_number_checking_required (void) const =0
virtual void	on_error_v (const char *fmt, va_list ap)=0
Protected Member Functions
void	on_error (const char *fmt,...)
	interpose ()
Private Member Functions
	interpose (const interpose &)
interpose &	operator= (const interpose &)

---

Detailed Description

The interpose class is used to represent the state of interpreting key strokes, based on the preceeding keystrokes. This permits state-ful keystroke processing to be flattened into a single state-less stream.

Definition at line 34 of file interpose.h.

---

Member Typedef Documentation

typedef boost::shared_ptr<interpose> interpose::pointer

Definition at line 37 of file interpose.h.

---

Constructor & Destructor Documentation

interpose::~interpose

(

)

[virtual]

The destructor.

Definition at line 21 of file interpose.cc.

interpose::interpose

(

)

[protected]

The default constructor. For use by derived classes only.

Definition at line 26 of file interpose.cc.

interpose::interpose

(

const interpose &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

void interpose::on_error	(	const char *	fmt,
			...
	)		[protected]

The on_error method is used to report errors processing the key stream.

Parameters:

fmt	The format of the error. This controls the numer and types of the following arguments.

Definition at line 32 of file interpose.cc.

virtual void interpose::on_error_v	(	const char *	fmt,
		va_list	ap
	)		[pure virtual]

The on_error_v method is used to report errors processing the key stream.

Parameters:

fmt	The format of the error. This controls the numer and types of the following arguments.
ap	The following arguments.

Implemented in interpose_stateful, interpose_goto, interpose_ope, interpose_ope_che, interpose_pro_che, interpose_learn, and interpose_memory.

virtual void interpose::on_opcode	(	opcode_t	op,
		const location::pointer &	where
	)		[pure virtual]

The on_opcode method is used to process keys that have a corresponding opcode.

Parameters:

op	The opcode (usually a key stroke) of interest
where	The source file location, or NULL if not available.

Implemented in interpose_stateful, interpose_ope, interpose_ope_che, interpose_pro_che, interpose_learn, interpose_goto, and interpose_memory.

interpose& interpose::operator=

(

const interpose &

)

[private]

The assignment operator. Do not use.

virtual bool interpose::strict_memory_number_checking_required

(

void

)

const [pure virtual]

The strict_memory_number_checking_required method is used to determine whether or not the number keys following M3~ keys (et al) must be followed by a digit key (true) or any key (false). The actual 1614P silently permits any key, and uses only the lower 4 bits.

Implemented in interpose_memory, interpose_stateful, interpose_ope, interpose_ope_che, interpose_pro_che, interpose_learn, and interpose_goto.

---

The documentation for this class was generated from the following files:

• lib/interpose.h
• lib/interpose.cc