src/Form/Util.cpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #include "Form/Util.hpp"
  25 #include "Form/SubForm.hpp"
  26 #include "Form/Edit.hpp"
  27 #include "DataField/Base.hpp"
  28 #include "DataField/Boolean.hpp"
  29 #include "DataField/Float.hpp"
  30 #include "DataField/Enum.hpp"
  31 #include "DataField/String.hpp"
  32 #include "DataField/FileReader.hpp"
  33
  34 #include <assert.h>
  35
  36 void
  37 ShowFormControl(SubForm &form, const TCHAR *control_name, bool visible)
  38 {
  39   Window *window = form.FindByName(control_name);
  40   assert(window != NULL);
  41   window->SetVisible(visible);
  42 }
  43
  44 void
  45 ShowOptionalFormControl(SubForm &form, const TCHAR *control_name,
  46                         bool visible)
  47 {
  48   Window *window = form.FindByName(control_name);
  49   if (window != NULL)
  50     window->SetVisible(visible);
  51 }
  52
  53 void
  54 SetFormControlEnabled(SubForm &form, const TCHAR *control_name, bool enabled)
  55 {
  56   Window *window = form.FindByName(control_name);
  57   assert(window != NULL);
  58   window->SetEnabled(enabled);
  59 }
  60
  61 void
  62 SetFormValue(SubForm &form, const TCHAR *control_name, const TCHAR *value)
  63 {
  64   assert(control_name != NULL);
  65   assert(value != NULL);
  66
  67   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
  68   assert(ctl != NULL);
  69
  70   ctl->SetText(value);
  71 }
  72
  73 void
  74 LoadFormProperty(SubForm &form, const TCHAR *control_name, bool value)
  75 {
  76   assert(control_name != NULL);
  77
  78   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
  79   if (ctl == NULL)
  80     return;
  81
  82   DataFieldBoolean &df = *(DataFieldBoolean *)ctl->GetDataField();
  83   assert(df.GetType() == DataField::Type::BOOLEAN);
  84   df.Set(value);
  85   ctl->RefreshDisplay();
  86 }
  87
  88 void
  89 LoadFormProperty(SubForm &form, const TCHAR *control_name, unsigned int value)
  90 {
  91   assert(control_name != NULL);
  92
  93   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
  94   if (ctl == NULL)
  95     return;
  96
  97   ctl->GetDataField()->SetAsInteger(value);
  98   ctl->RefreshDisplay();
  99 }
 100
 101 void
 102 LoadFormPropertyEnum(SubForm &form, const TCHAR *control_name, int value)
 103 {
 104   assert(control_name != NULL);
 105
 106   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
 107   assert(ctl != NULL);
 108
 109   DataFieldEnum &df = *(DataFieldEnum *)ctl->GetDataField();
 110   assert(df.GetType() == DataField::Type::ENUM);
 111   df.Set(value);
 112   ctl->RefreshDisplay();
 113 }
 114
 115 void
 116 LoadFormProperty(SubForm &form, const TCHAR *control_name,
 117                  const StaticEnumChoice *list, unsigned value)
 118 {
 119   assert(control_name != NULL);
 120
 121   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
 122   assert(ctl != NULL);
 123
 124   DataFieldEnum &df = *(DataFieldEnum *)ctl->GetDataField();
 125   assert(df.GetType() == DataField::Type::ENUM);
 126   if (list[0].help != NULL)
 127     df.EnableItemHelp(true);
 128
 129   df.AddChoices(list);
 130   df.Set(value);
 131
 132   ctl->RefreshDisplay();
 133 }
 134
 135 void
 136 LoadFormProperty(SubForm &form, const TCHAR *control_name, fixed value)
 137 {
 138   assert(control_name != NULL);
 139
 140   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
 141   assert(ctl != NULL);
 142
 143   DataFieldFloat &df = *(DataFieldFloat *)ctl->GetDataField();
 144   assert(df.GetType() == DataField::Type::REAL);
 145   df.Set(value);
 146   ctl->RefreshDisplay();
 147 }
 148
 149 void
 150 LoadOptionalFormProperty(SubForm &form, const TCHAR *control_name,
 151                          fixed value)
 152 {
 153   assert(control_name != NULL);
 154
 155   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
 156   if (ctl == NULL)
 157     return;
 158
 159   DataFieldFloat &df = *(DataFieldFloat *)ctl->GetDataField();
 160   assert(df.GetType() == DataField::Type::REAL);
 161   df.Set(value);
 162   ctl->RefreshDisplay();
 163 }
 164
 165 void
 166 LoadFormProperty(SubForm &form, const TCHAR *control_name,
 167                  const TCHAR *value)
 168 {
 169   assert(control_name != NULL);
 170   assert(value != NULL);
 171
 172   WndProperty *ctl = (WndProperty *)form.FindByName(control_name);
 173   assert(ctl != NULL);
 174
 175   DataFieldString &df = *(DataFieldString *)ctl->GetDataField();
 176   assert(df.GetType() == DataField::Type::STRING);
 177
 178   df.Set(value);
 179   ctl->RefreshDisplay();
 180 }
 181
 182 int
 183 GetFormValueInteger(const SubForm &form, const TCHAR *control_name)
 184 {
 185   assert(control_name != NULL);
 186
 187   const WndProperty *control =
 188     (const WndProperty *)form.FindByName(control_name);
 189   assert(control != NULL);
 190
 191   return control->GetDataField()->GetAsInteger();
 192 }
 193
 194 fixed
 195 GetFormValueFixed(const SubForm &form, const TCHAR *control_name)
 196 {
 197   const WndProperty *control =
 198     (const WndProperty *)form.FindByName(control_name);
 199   assert(control != NULL);
 200
 201   const DataFieldFloat &df = *(const DataFieldFloat *)control->GetDataField();
 202   assert(df.GetType() == DataField::Type::REAL);
 203   return df.GetAsFixed();
 204 }
 205
 206 bool
 207 GetFormValueBoolean(const SubForm &form, const TCHAR *control_name)
 208 {
 209   assert(control_name != NULL);
 210
 211   const WndProperty *control =
 212     (const WndProperty *)form.FindByName(control_name);
 213   assert(control != NULL);
 214
 215   const DataFieldBoolean &df =
 216     *(const DataFieldBoolean *)control->GetDataField();
 217   assert(df.GetType() == DataField::Type::BOOLEAN);
 218   return df.GetAsBoolean();
 219 }
 220
 221 const TCHAR *
 222 GetFormValueString(const SubForm &form, const TCHAR *control_name)
 223 {
 224   assert(control_name != NULL);
 225
 226   const WndProperty *control =
 227     (const WndProperty *)form.FindByName(control_name);
 228   assert(control != NULL);
 229
 230   const DataFieldString &df = *(const DataFieldString *)control->GetDataField();
 231   assert(df.GetType() == DataField::Type::STRING);
 232
 233   return df.GetAsString();
 234 }
 235
 236 const TCHAR *
 237 GetFormValueFile(const SubForm &form, const TCHAR *control_name)
 238 {
 239   assert(control_name != NULL);
 240
 241   const WndProperty *control =
 242     (const WndProperty *)form.FindByName(control_name);
 243   assert(control != NULL);
 244
 245   const DataFieldFileReader &df =
 246     *(const DataFieldFileReader *)control->GetDataField();
 247   assert(df.GetType() == DataField::Type::FILE);
 248
 249   return df.GetPathFile();
 250 }
 251
 252 bool
 253 SaveFormProperty(const SubForm &form, const TCHAR *field, bool &value)
 254 {
 255   bool new_value = GetFormValueBoolean(form, field);
 256   if (new_value == value)
 257     return false;
 258
 259   value = new_value;
 260   return true;
 261 }
 262
 263 bool
 264 SaveFormProperty(const SubForm &form, const TCHAR *field, unsigned int &value)
 265 {
 266   unsigned new_value = (unsigned)GetFormValueInteger(form, field);
 267   if (new_value == value)
 268     return false;
 269
 270   value = new_value;
 271   return true;
 272 }
 273
 274 bool
 275 SaveFormProperty(SubForm &form, const TCHAR *control_name, fixed &value)
 276 {
 277   fixed new_value = GetFormValueFixed(form, control_name);
 278   if (new_value == value)
 279     return false;
 280
 281   value = new_value;
 282   return true;
 283 }
 284
 285 #ifdef FIXED_MATH
 286 bool
 287 SaveFormProperty(SubForm &form, const TCHAR *control_name, double &value)
 288 {
 289   double new_value = (double)GetFormValueFixed(form, control_name);
 290   if (new_value == value)
 291     return false;
 292
 293   value = new_value;
 294   return true;
 295 }
 296 #endif
 297
 298 bool
 299 SaveFormProperty(const SubForm &form, const TCHAR *control_name,
 300                  TCHAR *buffer, size_t max_size)
 301 {
 302   assert(max_size > 0);
 303
 304   const TCHAR *value = GetFormValueString(form, control_name);
 305   assert(value != NULL);
 306
 307   size_t length = _tcslen(value);
 308   if (length >= max_size)
 309     length = max_size - 1;
 310
 311   if (_tcsncmp(value, buffer, length) == 0 && buffer[length] == _T('\0'))
 312     /* not modified */
 313     return false;
 314
 315   std::copy(value, value + length, buffer);
 316   buffer[length] = _T('\0');
 317   return true;
 318 }