form/form.priv.h

   1 /****************************************************************************
   2  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  31  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
  32  ****************************************************************************/
  33
  34 #include "mf_common.h"
  35 #include "form.h"
  36
  37 /* form  status values */
  38 #define _OVLMODE         (0x04) /* Form is in overlay mode                */
  39 #define _WINDOW_MODIFIED (0x10) /* Current field window has been modified */
  40 #define _FCHECK_REQUIRED (0x20) /* Current field needs validation         */
  41
  42 /* field status values */
  43 #define _CHANGED         (0x01) /* Field has been changed                 */
  44 #define _NEWTOP          (0x02) /* Vertical scrolling occured             */
  45 #define _NEWPAGE         (0x04) /* field begins new page of form          */
  46 #define _MAY_GROW        (0x08) /* dynamic field may still grow           */
  47
  48 /* fieldtype status values */
  49 #define _LINKED_TYPE     (0x01) /* Type is a linked type                  */
  50 #define _HAS_ARGS        (0x02) /* Type has arguments                     */
  51 #define _HAS_CHOICE      (0x04) /* Type has choice methods                */
  52 #define _RESIDENT        (0x08) /* Type is builtin                        */
  53
  54 /* This are the field options required to be a selectable field in field
  55    navigation requests */
  56 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE)
  57
  58 /* If form is NULL replace form argument by default-form */
  59 #define Normalize_Form(form)  ((form)=(form)?(form):_nc_Default_Form)
  60
  61 /* If field is NULL replace field argument by default-field */
  62 #define Normalize_Field(field)  ((field)=(field)?(field):_nc_Default_Field)
  63
  64 /* Retrieve forms window */
  65 #define Get_Form_Window(form) \
  66   ((form)->sub?(form)->sub:((form)->win?(form)->win:stdscr))
  67
  68 /* Calculate the size for a single buffer for this field */
  69 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
  70
  71 /* Calculate the total size of all buffers for this field */
  72 #define Total_Buffer_Size(field) \
  73    ( (Buffer_Length(field) + 1) * (1+(field)->nbuf) )
  74
  75 /* Logic to determine whether or not a field is single lined */
  76 #define Single_Line_Field(field) \
  77    (((field)->rows + (field)->nrow) == 1)
  78
  79 /* Logic to determine whether or not a field is selectable */
  80 #define Field_Is_Selectable(f)     (((f)->opts & O_SELECTABLE)==O_SELECTABLE)
  81 #define Field_Is_Not_Selectable(f) (((f)->opts & O_SELECTABLE)!=O_SELECTABLE)
  82
  83 typedef struct typearg {
  84   struct typearg *left;
  85   struct typearg *right;
  86 } TypeArgument;
  87
  88 /* This is a dummy request code (normally invalid) to be used internally
  89    with the form_driver() routine to position to the first active field
  90    on the form
  91 */
  92 #define FIRST_ACTIVE_MAGIC (-291056)
  93
  94 #define ALL_FORM_OPTS  (                \
  95                         O_NL_OVERLOAD  |\
  96                         O_BS_OVERLOAD   )
  97
  98 #define ALL_FIELD_OPTS (           \
  99                         O_VISIBLE |\
 100                         O_ACTIVE  |\
 101                         O_PUBLIC  |\
 102                         O_EDIT    |\
 103                         O_WRAP    |\
 104                         O_BLANK   |\
 105                         O_AUTOSKIP|\
 106                         O_NULLOK  |\
 107                         O_PASSOK  |\
 108                         O_STATIC   )
 109
 110
 111 #define C_BLANK ' '
 112 #define is_blank(c) ((c)==C_BLANK)
 113
 114 extern NCURSES_EXPORT_VAR(const FIELDTYPE *) _nc_Default_FieldType;
 115
 116 extern NCURSES_EXPORT(TypeArgument *) _nc_Make_Argument (const FIELDTYPE*,va_list*,int*);
 117 extern NCURSES_EXPORT(TypeArgument *) _nc_Copy_Argument (const FIELDTYPE*,const TypeArgument*, int*);
 118 extern NCURSES_EXPORT(void) _nc_Free_Argument (const FIELDTYPE*,TypeArgument*);
 119 extern NCURSES_EXPORT(bool) _nc_Copy_Type (FIELD*, FIELD const *);
 120 extern NCURSES_EXPORT(void) _nc_Free_Type (FIELD *);
 121
 122 extern NCURSES_EXPORT(int) _nc_Synchronize_Attributes (FIELD*);
 123 extern NCURSES_EXPORT(int) _nc_Synchronize_Options (FIELD*,Field_Options);
 124 extern NCURSES_EXPORT(int) _nc_Set_Form_Page (FORM*,int,FIELD*);
 125 extern NCURSES_EXPORT(int) _nc_Refresh_Current_Field (FORM*);
 126 extern NCURSES_EXPORT(FIELD *) _nc_First_Active_Field (FORM*);
 127 extern NCURSES_EXPORT(bool) _nc_Internal_Validation (FORM*);
 128 extern NCURSES_EXPORT(int) _nc_Set_Current_Field (FORM*,FIELD*);
 129 extern NCURSES_EXPORT(int) _nc_Position_Form_Cursor (FORM*);