// * This makes emacs happy -*-Mode: C++;-*-
/****************************************************************************
* Copyright (c) 1998-2012,2014 Free Software Foundation, Inc. *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
****************************************************************************/
/****************************************************************************
* Author: Juergen Pfeifer, 1997 *
****************************************************************************/
// $Id: cursesf.h,v 1.32 2014/08/09 22:06:11 Adam.Jiang Exp $
#ifndef NCURSES_CURSESF_H_incl
#define NCURSES_CURSESF_H_incl 1
// -------------------------------------------------------------------------
// The abstract base class for buitin and user defined Fieldtypes.
// -------------------------------------------------------------------------
class NCURSES_IMPEXP NCursesFormField; // forward declaration
// Class to represent builtin field types as well as C++ written new
// fieldtypes (see classes UserDefineFieldType...
class NCURSES_IMPEXP NCursesFieldType
friend class NCursesFormField;
inline void OnError(int err) const THROW2(NCursesException const, NCursesFormException) {
THROW(new NCursesFormException (err));
NCursesFieldType(FIELDTYPE *f) : fieldtype(f) {
virtual ~NCursesFieldType() {}
// Set the fields f fieldtype to this one.
virtual void set(NCursesFormField& f) = 0;
: fieldtype(STATIC_CAST(FIELDTYPE*)(0))
NCursesFieldType& operator=(const NCursesFieldType& rhs)
NCursesFieldType(const NCursesFieldType& rhs)
: fieldtype(rhs.fieldtype)
// -------------------------------------------------------------------------
// The class representing a forms field, wrapping the lowlevel FIELD struct
// -------------------------------------------------------------------------
class NCURSES_IMPEXP NCursesFormField
friend class NCursesForm;
FIELD *field; // lowlevel structure
NCursesFieldType* ftype; // Associated field type
inline void OnError (int err) const THROW2(NCursesException const, NCursesFormException) {
THROW(new NCursesFormException (err));
// Create a 'Null' field. Can be used to delimit a field list
: field(STATIC_CAST(FIELD*)(0)),
ftype(STATIC_CAST(NCursesFieldType*)(0))
NCursesFormField (int rows,
int additional_buffers = 0)
ftype(STATIC_CAST(NCursesFieldType*)(0))
field = ::new_field(rows, ncols, first_row, first_col,
offscreen_rows, additional_buffers);
NCursesFormField& operator=(const NCursesFormField& rhs)
NCursesFormField(const NCursesFormField& rhs)
: field(rhs.field), ftype(rhs.ftype)
virtual ~NCursesFormField ();
// Duplicate the field at a new position
inline NCursesFormField* dup(int first_row, int first_col)
NCursesFormField* f = new NCursesFormField();
f->field = ::dup_field(field,first_row,first_col);
// Link the field to a new location
inline NCursesFormField* link(int first_row, int first_col) {
NCursesFormField* f = new NCursesFormField();
f->field = ::link_field(field,first_row,first_col);
// Get the lowlevel field representation
inline FIELD* get_field() const {
// Retrieve info about the field
inline void info(int& rows, int& ncols,
int& first_row, int& first_col,
int& offscreen_rows, int& additional_buffers) const {
OnError(::field_info(field, &rows, &ncols,
&offscreen_rows, &additional_buffers));
// Retrieve info about the fields dynamic properties.
inline void dynamic_info(int& dynamic_rows, int& dynamic_cols,
OnError(::dynamic_field_info(field, &dynamic_rows, &dynamic_cols,
// For a dynamic field you may set the maximum growth limit.
// A zero means unlimited growth.
inline void set_maximum_growth(int growth = 0) {
OnError(::set_max_field(field,growth));
// Move the field to a new position
inline void move(int row, int col) {
OnError(::move_field(field,row,col));
// Mark the field to start a new page
inline void new_page(bool pageFlag = FALSE) {
OnError(::set_new_page(field,pageFlag));
// Retrieve whether or not the field starts a new page.
inline bool is_new_page() const {
return ::new_page(field);
// Set the justification for the field
inline void set_justification(int just) {
OnError(::set_field_just(field,just));
// Retrieve the fields justification
inline int justification() const {
return ::field_just(field);
// Set the foreground attribute for the field
inline void set_foreground(chtype foreground) {
OnError(::set_field_fore(field,foreground));
// Retrieve the fields foreground attribute
inline chtype fore() const {
return ::field_fore(field);
// Set the background attribute for the field
inline void set_background(chtype background) {
OnError(::set_field_back(field,background));
// Retrieve the fields background attribute
inline chtype back() const {
return ::field_back(field);
// Set the padding character for the field
inline void set_pad_character(int padding) {
OnError(::set_field_pad(field, padding));
// Retrieve the fields padding character
return ::field_pad(field);
// Switch on the fields options
inline void options_on (Field_Options opts) {
OnError (::field_opts_on (field, opts));
// Switch off the fields options
inline void options_off (Field_Options opts) {
OnError (::field_opts_off (field, opts));
// Retrieve the fields options
inline Field_Options options () const {
return ::field_opts (field);
// Set the fields options
inline void set_options (Field_Options opts) {
OnError (::set_field_opts (field, opts));
// Mark the field as changed
inline void set_changed(bool changeFlag = TRUE) {
OnError(::set_field_status(field,changeFlag));
// Test whether or not the field is marked as changed
inline bool changed() const {
return ::field_status(field);
// Return the index of the field in the field array of a form
// or -1 if the field is not associated to a form
inline int (index)() const {
return ::field_index(field);
// Store a value in a fields buffer. The default buffer is nr. 0
inline void set_value(const char *val, int buffer = 0) {
OnError(::set_field_buffer(field,buffer,val));
// Retrieve the value of a fields buffer. The default buffer is nr. 0
inline char* value(int buffer = 0) const {
return ::field_buffer(field,buffer);
// Set the validation type of the field.
inline void set_fieldtype(NCursesFieldType& f) {
f.set(*this); // A good friend may do that...
// Retrieve the validation type of the field.
inline NCursesFieldType* fieldtype() const {
// This are the built-in hook functions in this C++ binding. In C++ we use
// virtual member functions (see below On_..._Init and On_..._Termination)
// to provide this functionality in an object oriented manner.
void _nc_xx_frm_init(FORM *);
void _nc_xx_frm_term(FORM *);
void _nc_xx_fld_init(FORM *);
void _nc_xx_fld_term(FORM *);
// -------------------------------------------------------------------------
// The class representing a form, wrapping the lowlevel FORM struct
// -------------------------------------------------------------------------
class NCURSES_IMPEXP NCursesForm : public NCursesPanel
FORM* form; // the lowlevel structure
NCursesWindow* sub; // the subwindow object
bool b_sub_owner; // is this our own subwindow?
bool b_framed; // has the form a border?
bool b_autoDelete; // Delete fields when deleting form?
NCursesFormField** my_fields; // The array of fields for this form
// This structure is used for the form's user data field to link the
// FORM* to the C++ object and to provide extra space for a user pointer.
void* m_user; // the pointer for the user's data
const NCursesForm* m_back; // backward pointer to C++ object
// Get the backward pointer to the C++ object from a FORM
static inline NCursesForm* getHook(const FORM *f) {
UserHook* hook = reinterpret_cast<UserHook*>(::form_userptr(f));
assert(hook != 0 && hook->m_owner==f);
return const_cast<NCursesForm*>(hook->m_back);
friend void _nc_xx_frm_init(FORM *);
friend void _nc_xx_frm_term(FORM *);
friend void _nc_xx_fld_init(FORM *);
friend void _nc_xx_fld_term(FORM *);
// Calculate FIELD* array for the menu
FIELD** mapFields(NCursesFormField* nfields[]);
inline void set_user(void *user) {
UserHook* uptr = reinterpret_cast<UserHook*>(::form_userptr (form));
assert (uptr != 0 && uptr->m_back==this && uptr->m_owner==form);
inline void *get_user() {
UserHook* uptr = reinterpret_cast<UserHook*>(::form_userptr (form));
assert (uptr != 0 && uptr->m_back==this && uptr->m_owner==form);
void InitForm (NCursesFormField* Fields[],
inline void OnError (int err) const THROW2(NCursesException const, NCursesFormException) {
THROW(new NCursesFormException (err));
// this wraps the form_driver call.
virtual int driver (int c) ;
// 'Internal' constructor, builds an object without association to a
: NCursesPanel(nlines, ncols, begin_y, begin_x),
form (STATIC_CAST(FORM*)(0)),
// Create form for the default panel.
NCursesForm (NCursesFormField* Fields[],
bool with_frame=FALSE, // reserve space for a frame?
bool autoDelete_Fields=FALSE) // do automatic cleanup?
InitForm(Fields, with_frame, autoDelete_Fields);
// Create a form in a panel with the given position and size.
NCursesForm (NCursesFormField* Fields[],
bool with_frame=FALSE, // reserve space for a frame?
bool autoDelete_Fields=FALSE) // do automatic cleanup?
: NCursesPanel(nlines, ncols, begin_y, begin_x),
InitForm(Fields, with_frame, autoDelete_Fields);
NCursesForm& operator=(const NCursesForm& rhs)
NCursesPanel::operator=(rhs);
NCursesForm(const NCursesForm& rhs)
b_sub_owner(rhs.b_sub_owner),
b_autoDelete(rhs.b_autoDelete),
// Set the default attributes for the form
virtual void setDefaultAttributes();
// Retrieve current field of the form.
inline NCursesFormField* current_field() const {
return my_fields[::field_index(::current_field(form))];
// Set the forms subwindow
void setSubWindow(NCursesWindow& sub);
// Set these fields for the form
inline void setFields(NCursesFormField* Fields[]) {
OnError(::set_form_fields(form,mapFields(Fields)));
// Remove the form from the screen
inline void unpost (void) {
OnError (::unpost_form (form));
// Post the form to the screen if flag is true, unpost it otherwise
inline void post(bool flag = TRUE) {
OnError (flag ? ::post_form(form) : ::unpost_form (form));