lib/libform/internals.h

   1 /*      $NetBSD: internals.h,v 1.10 2004/11/24 11:57:09 blymn Exp $     */
   2
   3 /*-
   4  * Copyright (c) 1998-1999 Brett Lymn
   5  *                         (blymn@baea.com.au, brett_lymn@yahoo.com.au)
   6  * All rights reserved.
   7  *
   8  * This code has been donated to The NetBSD Foundation by the Author.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  *
  30  */
  31
  32 #include <stdio.h>
  33 #include "form.h"
  34
  35 #ifndef FORMI_INTERNALS_H
  36 #define FORMI_INTERNALS_H 1
  37
  38 #ifdef DEBUG
  39 extern FILE *dbg;
  40 #endif
  41
  42 /* direction definitions for _formi_pos_new_field */
  43 #define _FORMI_BACKWARD 1
  44 #define _FORMI_FORWARD  2
  45
  46 /* define the default options for a form... */
  47 #define DEFAULT_FORM_OPTS (O_VISIBLE | O_ACTIVE | O_PUBLIC | O_EDIT | \
  48                            O_WRAP | O_BLANK | O_AUTOSKIP | O_NULLOK | \
  49                            O_PASSOK | O_STATIC)
  50
  51 /* definitions of the flags for the FIELDTYPE structure */
  52 #define _TYPE_NO_FLAGS   0
  53 #define _TYPE_HAS_ARGS   0x01
  54 #define _TYPE_IS_LINKED  0x02
  55 #define _TYPE_IS_BUILTIN 0x04
  56 #define _TYPE_HAS_CHOICE 0x08
  57
  58 typedef struct formi_type_link_struct formi_type_link;
  59
  60 struct formi_type_link_struct
  61 {
  62         FIELDTYPE *next;
  63         FIELDTYPE *prev;
  64 };
  65
  66
  67 struct _formi_page_struct
  68 {
  69         int in_use;
  70         int first;
  71         int last;
  72         int top_left;
  73         int bottom_right;
  74 };
  75
  76 struct _formi_tab_stops
  77 {
  78         struct _formi_tab_stops *fwd;
  79         struct _formi_tab_stops *back;
  80         unsigned char in_use;
  81         unsigned pos;
  82         unsigned size;
  83 };
  84
  85 typedef struct _formi_tab_stops _formi_tab_t;
  86
  87 /* lines structure for the field - keeps start and ends and length of the
  88  * lines in a field.
  89  */
  90 struct _formi_field_lines
  91 {
  92         _FORMI_FIELD_LINES *prev;
  93         _FORMI_FIELD_LINES *next;
  94         unsigned allocated;
  95         unsigned length;
  96         unsigned expanded;
  97         char *string;
  98         unsigned char hard_ret; /* line contains hard return */
  99         _formi_tab_t *tabs;
 100 };
 101
 102
 103 /* function prototypes */
 104 unsigned
 105 _formi_skip_blanks(char *string, unsigned int start);
 106 int
 107 _formi_add_char(FIELD *cur, unsigned pos, char c);
 108 void
 109 _formi_calculate_tabs(_FORMI_FIELD_LINES *row);
 110 int
 111 _formi_draw_page(FORM *form);
 112 int
 113 _formi_find_pages(FORM *form);
 114 int
 115 _formi_field_choice(FORM *form, int c);
 116 void
 117 _formi_init_field_xpos(FIELD *field);
 118 int
 119 _formi_manipulate_field(FORM *form, int c);
 120 int
 121 _formi_pos_first_field(FORM *form);
 122 int
 123 _formi_pos_new_field(FORM *form, unsigned direction, unsigned use_sorted);
 124 void
 125 _formi_redraw_field(FORM *form, int field);
 126 void
 127 _formi_sort_fields(FORM *form);
 128 void
 129 _formi_stitch_fields(FORM *form);
 130 int
 131 _formi_tab_expanded_length(char *str, unsigned int start, unsigned int end);
 132 int
 133 _formi_update_field(FORM *form, int old_field);
 134 int
 135 _formi_validate_char(FIELD *field, char c);
 136 int
 137 _formi_validate_field(FORM *form);
 138 int
 139 _formi_wrap_field(FIELD *field, _FORMI_FIELD_LINES *pos);
 140 int
 141 _formi_sync_buffer(FIELD *field);
 142
 143 #ifdef DEBUG
 144 int
 145 _formi_create_dbg_file(void);
 146 #endif /* DEBUG */
 147
 148 #endif
 149
 150
 151