1 // * this is for making emacs happy: -*-Mode: C++;-*-
2 /****************************************************************************
3 * Copyright (c) 1998-2005,2011 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Juergen Pfeifer, 1997 *
32 ****************************************************************************/
36 #include "cursesapp.h"
38 MODULE_ID("$Id: cursesf.cc,v 1.22 2011/09/17 22:12:10 tom Exp $")
40 NCursesFormField::~NCursesFormField ()
43 OnError(::free_field (field));
46 /* Construct a FIELD* array from an array of NCursesFormField
50 NCursesForm::mapFields(NCursesFormField* nfields[])
52 int fieldCount = 0,lcv;
57 for (lcv=0; nfields[lcv]->field; ++lcv)
60 FIELD** fields = new FIELD*[fieldCount + 1];
62 for (lcv=0;nfields[lcv]->field;++lcv) {
63 fields[lcv] = nfields[lcv]->field;
69 if (form && (old_fields = ::form_fields(form))) {
70 ::set_form_fields(form, static_cast<FIELD**>(0));
76 void NCursesForm::setDefaultAttributes()
78 NCursesApplication* S = NCursesApplication::getApplication();
82 for(int i=0; i<n; i++) {
83 NCursesFormField* f = (*this)[i];
84 if ((f->options() & (O_EDIT|O_ACTIVE))==(O_EDIT|O_ACTIVE)) {
86 f->set_foreground(S->foregrounds());
87 f->set_background(S->backgrounds());
89 f->set_pad_character('_');
93 f->set_background(S->labels());
99 bkgd(' '|S->dialog_backgrounds());
101 sub->bkgd(' '|S->dialog_backgrounds());
106 NCursesForm::InitForm(NCursesFormField* nfields[],
108 bool autoDelete_Fields)
115 b_framed = with_frame;
116 b_autoDelete = autoDelete_Fields;
118 form = static_cast<FORM*>(0);
119 form = ::new_form(mapFields(nfields));
121 OnError (E_SYSTEM_ERROR);
123 UserHook* hook = new UserHook;
126 hook->m_owner = form;
127 ::set_form_userptr(form, reinterpret_cast<void*>(hook));
129 ::set_form_init (form, _nc_xx_frm_init);
130 ::set_form_term (form, _nc_xx_frm_term);
131 ::set_field_init (form, _nc_xx_fld_init);
132 ::set_field_term (form, _nc_xx_fld_term);
135 ::set_form_win(form, w);
138 if ((mrows > height()-2) || (mcols > width()-2))
140 sub = new NCursesWindow(*this,mrows,mcols,1,1,'r');
141 ::set_form_sub(form, sub->w);
145 sub = static_cast<NCursesWindow*>(0);
148 options_on(O_NL_OVERLOAD);
149 setDefaultAttributes();
152 NCursesForm::~NCursesForm()
154 UserHook* hook = reinterpret_cast<UserHook*>(::form_userptr(form));
158 ::set_form_sub(form, static_cast<WINDOW *>(0));
161 FIELD** fields = ::form_fields(form);
164 OnError(::set_form_fields(form, static_cast<FIELD**>(0)));
168 for (int i=0; i <= cnt; i++)
175 // It's essential to do this after free_form()
181 NCursesForm::setSubWindow(NCursesWindow& nsub)
183 if (!isDescendant(nsub))
184 OnError(E_SYSTEM_ERROR);
189 ::set_form_sub(form,sub->w);
193 /* Internal hook functions. They will route the hook
194 * calls to virtual methods of the NCursesForm class,
195 * so in C++ providing a hook is done simply by
196 * implementing a virtual method in a derived class
199 _nc_xx_frm_init(FORM *f)
201 NCursesForm::getHook(f)->On_Form_Init();
205 _nc_xx_frm_term(FORM *f)
207 NCursesForm::getHook(f)->On_Form_Termination();
211 _nc_xx_fld_init(FORM *f)
213 NCursesForm* F = NCursesForm::getHook(f);
214 F->On_Field_Init (*(F->current_field ()));
218 _nc_xx_fld_term(FORM *f)
220 NCursesForm* F = NCursesForm::getHook(f);
221 F->On_Field_Termination (*(F->current_field ()));
225 NCursesForm::On_Form_Init()
230 NCursesForm::On_Form_Termination()
235 NCursesForm::On_Field_Init(NCursesFormField& field)
241 NCursesForm::On_Field_Termination(NCursesFormField& field)
246 // call the form driver and do basic error checking.
248 NCursesForm::driver (int c)
250 int res = ::form_driver (form, c);
253 case E_REQUEST_DENIED:
254 case E_INVALID_FIELD:
255 case E_UNKNOWN_COMMAND:
263 void NCursesForm::On_Request_Denied(int c) const
269 void NCursesForm::On_Invalid_Field(int c) const
275 void NCursesForm::On_Unknown_Command(int c) const
281 static const int CMD_QUIT = MAX_COMMAND + 1;
284 NCursesForm::operator()(void)
294 while (((drvCmnd = virtualize((c=getKey()))) != CMD_QUIT)) {
295 switch((err=driver(drvCmnd))) {
296 case E_REQUEST_DENIED:
297 On_Request_Denied(c);
299 case E_INVALID_FIELD:
302 case E_UNKNOWN_COMMAND:
303 On_Unknown_Command(c);
315 return my_fields[::field_index (::current_field (form))];
318 // Provide a default key virtualization. Translate the keyboard
319 // code c into a form request code.
320 // The default implementation provides a hopefully straightforward
321 // mapping for the most common keystrokes and form requests.
323 NCursesForm::virtualize(int c)
327 case KEY_HOME : return(REQ_FIRST_FIELD);
328 case KEY_END : return(REQ_LAST_FIELD);
330 case KEY_DOWN : return(REQ_DOWN_CHAR);
331 case KEY_UP : return(REQ_UP_CHAR);
332 case KEY_LEFT : return(REQ_PREV_CHAR);
333 case KEY_RIGHT : return(REQ_NEXT_CHAR);
335 case KEY_NPAGE : return(REQ_NEXT_PAGE);
336 case KEY_PPAGE : return(REQ_PREV_PAGE);
338 case KEY_BACKSPACE : return(REQ_DEL_PREV);
339 case KEY_ENTER : return(REQ_NEW_LINE);
340 case KEY_CLEAR : return(REQ_CLR_FIELD);
342 case CTRL('X') : return(CMD_QUIT); // eXit
344 case CTRL('F') : return(REQ_NEXT_FIELD); // Forward
345 case CTRL('B') : return(REQ_PREV_FIELD); // Backward
346 case CTRL('L') : return(REQ_LEFT_FIELD); // Left
347 case CTRL('R') : return(REQ_RIGHT_FIELD); // Right
348 case CTRL('U') : return(REQ_UP_FIELD); // Up
349 case CTRL('D') : return(REQ_DOWN_FIELD); // Down
351 case CTRL('W') : return(REQ_NEXT_WORD);
352 case CTRL('T') : return(REQ_PREV_WORD);
354 case CTRL('A') : return(REQ_BEG_FIELD);
355 case CTRL('E') : return(REQ_END_FIELD);
357 case CTRL('I') : return(REQ_INS_CHAR);
359 case CTRL('J') : return(REQ_NEW_LINE);
360 case CTRL('O') : return(REQ_INS_LINE);
361 case CTRL('V') : return(REQ_DEL_CHAR);
362 case CTRL('H') : return(REQ_DEL_PREV);
363 case CTRL('Y') : return(REQ_DEL_LINE);
364 case CTRL('G') : return(REQ_DEL_WORD);
365 case CTRL('K') : return(REQ_CLR_EOF);
367 case CTRL('N') : return(REQ_NEXT_CHOICE);
368 case CTRL('P') : return(REQ_PREV_CHOICE);
375 // -------------------------------------------------------------------------
376 // User Defined Fieldtypes
377 // -------------------------------------------------------------------------
379 bool _nc_xx_fld_fcheck(FIELD *f, const void *u)
382 NCursesFormField* F = reinterpret_cast<NCursesFormField*>(const_cast<void *>(u));
384 UserDefinedFieldType* udf = reinterpret_cast<UserDefinedFieldType*>(F->fieldtype());
386 return udf->field_check(*F);
389 bool _nc_xx_fld_ccheck(int c, const void *u)
391 NCursesFormField* F = reinterpret_cast<NCursesFormField*>(const_cast<void *>(u));
393 UserDefinedFieldType* udf =
394 reinterpret_cast<UserDefinedFieldType*>(F->fieldtype());
396 return udf->char_check(c);
399 void* _nc_xx_fld_makearg(va_list* va)
401 return va_arg(*va,NCursesFormField*);
404 FIELDTYPE* UserDefinedFieldType::generic_fieldtype =
405 ::new_fieldtype(_nc_xx_fld_fcheck,
408 FIELDTYPE* UserDefinedFieldType_With_Choice::generic_fieldtype_with_choice =
409 ::new_fieldtype(_nc_xx_fld_fcheck,
412 bool _nc_xx_next_choice(FIELD *f, const void *u)
415 NCursesFormField* F = reinterpret_cast<NCursesFormField*>(const_cast<void *>(u));
417 UserDefinedFieldType_With_Choice* udf =
418 reinterpret_cast<UserDefinedFieldType_With_Choice*>(F->fieldtype());
420 return udf->next(*F);
423 bool _nc_xx_prev_choice(FIELD *f, const void *u)
426 NCursesFormField* F = reinterpret_cast<NCursesFormField*>(const_cast<void *>(u));
428 UserDefinedFieldType_With_Choice* udf =
429 reinterpret_cast<UserDefinedFieldType_With_Choice*>(F->fieldtype());
431 return udf->previous(*F);
444 code = ::set_fieldtype_arg(UserDefinedFieldType::generic_fieldtype,
449 code = ::set_fieldtype_arg
450 (UserDefinedFieldType_With_Choice::generic_fieldtype_with_choice,
455 code = ::set_fieldtype_choice
456 (UserDefinedFieldType_With_Choice::generic_fieldtype_with_choice,
462 UDF_Init* UDF_Init::I = new UDF_Init();