gschem/src/gschem_options.c

   1 /* gEDA - GPL Electronic Design Automation
   2  * gschem - gEDA Schematic Capture
   3  * Copyright (C) 1998-2010 Ales Hvezda
   4  * Copyright (C) 1998-2020 gEDA Contributors (see ChangeLog for details)
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20 /*!
  21  * \file gschem_options.c
  22  *
  23  * \brief
  24  */
  25
  26 #include <config.h>
  27
  28 #include <stdio.h>
  29 #ifdef HAVE_STDLIB_H
  30 #include <stdlib.h>
  31 #endif
  32 #ifdef HAVE_STRING_H
  33 #include <string.h>
  34 #endif
  35
  36 #include "gschem.h"
  37 #include "actions.decl.x"
  38
  39
  40
  41 /*! \private
  42  */
  43 enum
  44 {
  45   PROP_GSCHEM_TOPLEVEL = 1,
  46   PROP_GRID_MODE,
  47   PROP_SHOW_ORIGIN,
  48   PROP_MAGNETIC_NET_MODE,
  49   PROP_NET_RUBBER_BAND_MODE,
  50   PROP_SNAP_MODE,
  51   PROP_SNAP_SIZE
  52 };
  53
  54
  55
  56 static void
  57 class_init (GschemOptionsClass *klass);
  58
  59 static void
  60 get_property (GObject *object, guint param_id, GValue *value, GParamSpec *pspec);
  61
  62 static void
  63 instance_init (GschemOptions *adapter);
  64
  65 static void
  66 set_property (GObject *object, guint param_id, const GValue *value, GParamSpec *pspec);
  67
  68
  69
  70 /*! \brief Cycle grid mode to the next option
  71  *
  72  *  \param options These options
  73  */
  74 void
  75 gschem_options_cycle_grid_mode (GschemOptions *options)
  76 {
  77   GRID_MODE next_grid_mode;
  78
  79   g_return_if_fail (options != NULL);
  80
  81   next_grid_mode = (options->grid_mode + 1) % GRID_MODE_COUNT;
  82
  83   gschem_options_set_grid_mode (options, next_grid_mode);
  84 }
  85
  86
  87
  88 /*! \brief Cycle show origin to the next option
  89  *
  90  *  \param options These options
  91  */
  92 void
  93 gschem_options_cycle_show_origin (GschemOptions *options)
  94 {
  95   gboolean next_show_origin;
  96
  97   g_return_if_fail (options != NULL);
  98
  99   next_show_origin = !options->show_origin;
 100
 101   gschem_options_set_show_origin (options, next_show_origin);
 102 }
 103
 104
 105
 106 /*! \brief Cycle magnetic net mode to the next option
 107  *
 108  *  \param options These options
 109  */
 110 void
 111 gschem_options_cycle_magnetic_net_mode (GschemOptions *options)
 112 {
 113   gboolean next_magnetic_net_mode;
 114
 115   g_return_if_fail (options != NULL);
 116
 117   next_magnetic_net_mode = !options->magnetic_net_mode;
 118
 119   gschem_options_set_magnetic_net_mode (options, next_magnetic_net_mode);
 120 }
 121
 122
 123
 124 /*! \brief Cycle net rubber band mode to the next option
 125  *
 126  *  \param options These options
 127  */
 128 void
 129 gschem_options_cycle_net_rubber_band_mode (GschemOptions *options)
 130 {
 131   gboolean next_net_rubber_band_mode;
 132
 133   g_return_if_fail (options != NULL);
 134
 135   next_net_rubber_band_mode = !options->net_rubber_band_mode;
 136
 137   gschem_options_set_net_rubber_band_mode (options, next_net_rubber_band_mode);
 138 }
 139
 140
 141
 142 /*! \brief Cycle snap mode to the next option
 143  *
 144  *  \param options These options
 145  */
 146 void
 147 gschem_options_cycle_snap_mode (GschemOptions *options)
 148 {
 149   SNAP_STATE next_snap_mode;
 150
 151   g_return_if_fail (options != NULL);
 152
 153   /* toggle to the next snap state */
 154   next_snap_mode = (options->snap_mode + 1) % SNAP_STATE_COUNT;
 155
 156   gschem_options_set_snap_mode (options, next_snap_mode);
 157 }
 158
 159
 160
 161 /*! \brief Get the grid mode
 162  *
 163  *  \param [in] options These options
 164  *  \return The grid mode
 165  */
 166 GRID_MODE
 167 gschem_options_get_grid_mode (GschemOptions *options)
 168 {
 169   g_return_val_if_fail (options != NULL, GRID_MODE_MESH);
 170
 171   return options->grid_mode;
 172 }
 173
 174
 175
 176 /*! \brief Get whether to show origin
 177  *
 178  *  \param [in] options These options
 179  *  \return Whether to show the origin
 180  */
 181 gboolean
 182 gschem_options_get_show_origin (GschemOptions *options)
 183 {
 184   g_return_val_if_fail (options != NULL, DEFAULT_SHOW_ORIGIN);
 185
 186   return options->show_origin;
 187 }
 188
 189
 190
 191 /*! \brief Get the magnetic net mode
 192  *
 193  *  \param [in] options These options
 194  *  \return The magnetic net mode
 195  */
 196 gboolean
 197 gschem_options_get_magnetic_net_mode (GschemOptions *options)
 198 {
 199   g_return_val_if_fail (options != NULL, DEFAULT_MAGNETIC_NET_MODE);
 200
 201   return options->magnetic_net_mode;
 202 }
 203
 204
 205
 206 /*! \brief Get the net rubber band mode
 207  *
 208  *  \param [in] options These options
 209  *  \return The net rubber band mode
 210  */
 211 gboolean
 212 gschem_options_get_net_rubber_band_mode (GschemOptions *options)
 213 {
 214   g_return_val_if_fail (options != NULL, DEFAULT_NET_RUBBER_BAND_MODE);
 215
 216   return options->net_rubber_band_mode;
 217 }
 218
 219
 220
 221 /*! \brief Get the snap mode
 222  *
 223  *  \param [in] options These options
 224  *  \return The snap mode
 225  */
 226 SNAP_STATE
 227 gschem_options_get_snap_mode (GschemOptions *options)
 228 {
 229   g_return_val_if_fail (options != NULL, SNAP_GRID);
 230
 231   return options->snap_mode;
 232 }
 233
 234
 235
 236 /*! \brief Get the snap size
 237  *
 238  *  \param [in] options These options
 239  *  \return The snap size
 240  */
 241 int
 242 gschem_options_get_snap_size (GschemOptions *options)
 243 {
 244   g_return_val_if_fail (options != NULL, DEFAULT_SNAP_SIZE);
 245
 246   return options->snap_size;
 247 }
 248
 249
 250
 251 /*! \brief Get/register GschemSelection type.
 252  */
 253 GType
 254 gschem_options_get_type ()
 255 {
 256   static GType type = 0;
 257
 258   if (type == 0) {
 259     static const GTypeInfo info = {
 260       sizeof(GschemOptionsClass),
 261       NULL,                                  /* base_init */
 262       NULL,                                  /* base_finalize */
 263       (GClassInitFunc) class_init,
 264       NULL,                                  /* class_finalize */
 265       NULL,                                  /* class_data */
 266       sizeof(GschemOptions),
 267       0,                                     /* n_preallocs */
 268       (GInstanceInitFunc) instance_init,
 269     };
 270
 271     type = g_type_register_static (G_TYPE_OBJECT, "GschemOptions", &info, 0);
 272   }
 273
 274   return type;
 275 }
 276
 277
 278
 279 /*! \brief Create a new gschem options
 280  *
 281  *  \returns A new set of options
 282  */
 283 GschemOptions*
 284 gschem_options_new (GschemToplevel *w_current)
 285 {
 286   return g_object_new (GSCHEM_TYPE_OPTIONS,
 287                        "gschem-toplevel", w_current,
 288                        NULL);
 289 }
 290
 291
 292 /*! \brief Scale the snap size down
 293  *
 294  *  \param [in] options These options
 295  */
 296 void
 297 gschem_options_scale_snap_down (GschemOptions *options)
 298 {
 299   g_return_if_fail (options != NULL);
 300
 301   if ((options->snap_size % 2) == 0) {
 302     gschem_options_set_snap_size (options, options->snap_size / 2);
 303   }
 304 }
 305
 306
 307
 308 /*! \brief Scale the snap size up
 309  *
 310  *  \param [in] options These options
 311  */
 312 void
 313 gschem_options_scale_snap_up (GschemOptions *options)
 314 {
 315   g_return_if_fail (options != NULL);
 316
 317   gschem_options_set_snap_size (options, options->snap_size * 2);
 318 }
 319
 320
 321
 322 /*! \brief Set the grid mode
 323  *
 324  *  If the grid mode is invalid the default grid mode is set.
 325  *
 326  *  \param [in] options These options
 327  *  \param [in] grid_mode The grid mode
 328  */
 329 void
 330 gschem_options_set_grid_mode (GschemOptions *options, GRID_MODE grid_mode)
 331 {
 332   g_return_if_fail (options != NULL);
 333
 334   switch (grid_mode) {
 335     case GRID_MODE_NONE:
 336     case GRID_MODE_DOTS:
 337     case GRID_MODE_MESH:
 338       options->grid_mode = grid_mode;
 339       break;
 340     default:
 341       options->grid_mode = default_grid_mode;
 342       break;
 343   }
 344
 345   gschem_action_set_active (action_options_grid_none,
 346                             options->grid_mode == GRID_MODE_NONE,
 347                             options->w_current);
 348   gschem_action_set_active (action_options_grid_dots,
 349                             options->grid_mode == GRID_MODE_DOTS,
 350                             options->w_current);
 351   gschem_action_set_active (action_options_grid_mesh,
 352                             options->grid_mode == GRID_MODE_MESH,
 353                             options->w_current);
 354
 355   g_object_notify (G_OBJECT (options), "grid-mode");
 356 }
 357
 358
 359
 360 /*! \brief Set whether to show origin
 361  *
 362  *  \param [in] options These options
 363  *  \param [in] show_origin Whether to show the origin
 364  */
 365 void
 366 gschem_options_set_show_origin (GschemOptions *options, gboolean show_origin)
 367 {
 368   g_return_if_fail (options != NULL);
 369
 370   options->show_origin = show_origin;
 371
 372   gschem_action_set_active (action_view_show_origin,
 373                             options->show_origin,
 374                             options->w_current);
 375
 376   g_object_notify (G_OBJECT (options), "show-origin");
 377 }
 378
 379
 380
 381 /*! \brief Set the magnetic net mode
 382  *
 383  *  \param [in] options These options
 384  *  \param [in] enabled Magnetic net mode
 385  */
 386 void
 387 gschem_options_set_magnetic_net_mode (GschemOptions *options, gboolean enabled)
 388 {
 389   g_return_if_fail (options != NULL);
 390
 391   options->magnetic_net_mode = enabled;
 392
 393   gschem_action_set_active (action_options_magneticnet,
 394                             options->magnetic_net_mode,
 395                             options->w_current);
 396
 397   g_object_notify (G_OBJECT (options), "magnetic-net-mode");
 398 }
 399
 400
 401
 402 /*! \brief Set the net rubber band mode
 403  *
 404  *  Sets whether nets rubberband as you move them (or connecting comps)
 405  *
 406  *  \param [in] options These options
 407  *  \param [in] enabled Net rubber band mode
 408  */
 409 void
 410 gschem_options_set_net_rubber_band_mode (GschemOptions *options, gboolean enabled)
 411 {
 412   g_return_if_fail (options != NULL);
 413
 414   options->net_rubber_band_mode = enabled;
 415
 416   gschem_action_set_active (action_options_rubberband,
 417                             options->net_rubber_band_mode,
 418                             options->w_current);
 419
 420   g_object_notify (G_OBJECT (options), "net-rubber-band-mode");
 421 }
 422
 423
 424
 425 /*! \brief Set the snap mode
 426  *
 427  *  \param [in] options These options
 428  *  \param [in] snap_mode The snap mode
 429  */
 430 void
 431 gschem_options_set_snap_mode (GschemOptions *options, SNAP_STATE snap_mode)
 432 {
 433   g_return_if_fail (options != NULL);
 434
 435   options->snap_mode = snap_mode;
 436
 437   gschem_action_set_active (action_options_snap_off,
 438                             options->snap_mode == SNAP_OFF,
 439                             options->w_current);
 440   gschem_action_set_active (action_options_snap_grid,
 441                             options->snap_mode == SNAP_GRID,
 442                             options->w_current);
 443   gschem_action_set_active (action_options_snap_resnap,
 444                             options->snap_mode == SNAP_RESNAP,
 445                             options->w_current);
 446
 447   g_object_notify (G_OBJECT (options), "snap-mode");
 448 }
 449
 450
 451
 452 /*! \brief Set the snap size
 453  *
 454  *  If the snap size is outside the range of valid values, the value will be
 455  *  assigned to the closest limit.
 456  *
 457  *  \param [in] options These options
 458  *  \param [in] snap_size The snap size
 459  */
 460 void
 461 gschem_options_set_snap_size (GschemOptions *options, int snap_size)
 462 {
 463   g_return_if_fail (options != NULL);
 464
 465   if (snap_size < MINIMUM_SNAP_SIZE) {
 466     snap_size = MINIMUM_SNAP_SIZE;
 467   }
 468
 469   if (snap_size > MAXIMUM_SNAP_SIZE) {
 470     snap_size = MAXIMUM_SNAP_SIZE;
 471   }
 472
 473   options->snap_size = snap_size;
 474
 475   g_object_notify (G_OBJECT (options), "snap-size");
 476 }
 477
 478
 479
 480 /*! \private
 481  *  \brief Initialize gschem options class
 482  *
 483  *  \param [in] klass The class for the gschem options
 484  */
 485 static void
 486 class_init (GschemOptionsClass *klass)
 487 {
 488   G_OBJECT_CLASS (klass)->get_property = get_property;
 489   G_OBJECT_CLASS (klass)->set_property = set_property;
 490
 491   g_object_class_install_property (G_OBJECT_CLASS (klass),
 492                                    PROP_GSCHEM_TOPLEVEL,
 493                                    g_param_spec_pointer ("gschem-toplevel",
 494                                                          "gschem Toplevel",
 495                                                          "gschem Toplevel",
 496                                                          G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE));
 497
 498   g_object_class_install_property (G_OBJECT_CLASS (klass),
 499                                    PROP_GRID_MODE,
 500                                    g_param_spec_int ("grid-mode",
 501                                                      "Grid Mode",
 502                                                      "Grid Mode",
 503                                                      0,
 504                                                      (GRID_MODE_COUNT - 1),
 505                                                      DEFAULT_GRID_MODE,
 506                                                      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 507
 508   g_object_class_install_property (G_OBJECT_CLASS (klass),
 509                                    PROP_SHOW_ORIGIN,
 510                                    g_param_spec_boolean ("show-origin",
 511                                                          "Show Origin",
 512                                                          "Show Origin",
 513                                                          DEFAULT_SHOW_ORIGIN,
 514                                                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 515
 516   g_object_class_install_property (G_OBJECT_CLASS (klass),
 517                                    PROP_MAGNETIC_NET_MODE,
 518                                    g_param_spec_boolean ("magnetic-net-mode",
 519                                                          "Magnetic Net Mode",
 520                                                          "magnetic Net Mode",
 521                                                          DEFAULT_MAGNETIC_NET_MODE,
 522                                                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 523
 524   g_object_class_install_property (G_OBJECT_CLASS (klass),
 525                                    PROP_NET_RUBBER_BAND_MODE,
 526                                    g_param_spec_boolean ("net-rubber-band-mode",
 527                                                          "Net Rubber Band Mode",
 528                                                          "Net Rubber Band Mode",
 529                                                          DEFAULT_NET_RUBBER_BAND_MODE,
 530                                                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 531
 532   g_object_class_install_property (G_OBJECT_CLASS (klass),
 533                                    PROP_SNAP_MODE,
 534                                    g_param_spec_int ("snap-mode",
 535                                                      "Snap Mode",
 536                                                      "Snap Mode",
 537                                                      0,
 538                                                      SNAP_STATE_COUNT - 1,
 539                                                      SNAP_GRID,
 540                                                      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 541
 542   g_object_class_install_property (G_OBJECT_CLASS (klass),
 543                                    PROP_SNAP_SIZE,
 544                                    g_param_spec_int ("snap-size",
 545                                                      "Snap Size",
 546                                                      "Snap Size",
 547                                                      MINIMUM_SNAP_SIZE,
 548                                                      MAXIMUM_SNAP_SIZE,
 549                                                      DEFAULT_SNAP_SIZE,
 550                                                      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
 551 }
 552
 553
 554
 555 /*! \private
 556  *  \brief Get a property
 557  *
 558  *  \param [in]     object
 559  *  \param [in]     param_id
 560  *  \param [in,out] value
 561  *  \param [in]     pspec
 562  */
 563 static void
 564 get_property (GObject *object, guint param_id, GValue *value, GParamSpec *pspec)
 565 {
 566   GschemOptions *options = GSCHEM_OPTIONS (object);
 567
 568   switch (param_id) {
 569     case PROP_GSCHEM_TOPLEVEL:
 570       g_value_set_pointer (value, options->w_current);
 571       break;
 572
 573     case PROP_GRID_MODE:
 574       g_value_set_int (value, gschem_options_get_grid_mode (options));
 575       break;
 576
 577     case PROP_SHOW_ORIGIN:
 578       g_value_set_boolean (value, gschem_options_get_show_origin (options));
 579       break;
 580
 581     case PROP_MAGNETIC_NET_MODE:
 582       g_value_set_boolean (value, gschem_options_get_magnetic_net_mode (options));
 583       break;
 584
 585     case PROP_NET_RUBBER_BAND_MODE:
 586       g_value_set_boolean (value, gschem_options_get_net_rubber_band_mode (options));
 587       break;
 588
 589     case PROP_SNAP_MODE:
 590       g_value_set_int (value, gschem_options_get_snap_mode (options));
 591       break;
 592
 593     case PROP_SNAP_SIZE:
 594       g_value_set_int (value, gschem_options_get_snap_size (options));
 595       break;
 596
 597     default:
 598       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 599   }
 600 }
 601
 602
 603
 604 /*! \brief Initialize GschemOptions instance
 605  *
 606  *  \param [in,out] selection
 607  */
 608 static void
 609 instance_init (GschemOptions *options)
 610 {
 611 }
 612
 613
 614
 615 /*! \brief Set a property
 616  *
 617  *  \param [in,out] object
 618  *  \param [in]     param_id
 619  *  \param [in]     value
 620  *  \param [in]     pspec
 621  */
 622 static void
 623 set_property (GObject *object, guint param_id, const GValue *value, GParamSpec *pspec)
 624 {
 625   GschemOptions *options = GSCHEM_OPTIONS (object);
 626
 627   switch (param_id) {
 628     case PROP_GSCHEM_TOPLEVEL:
 629       options->w_current = GSCHEM_TOPLEVEL (g_value_get_pointer (value));
 630       break;
 631
 632     case PROP_GRID_MODE:
 633       gschem_options_set_grid_mode (options, g_value_get_int (value));
 634       break;
 635
 636     case PROP_SHOW_ORIGIN:
 637       gschem_options_set_show_origin (options, g_value_get_boolean (value));
 638       break;
 639
 640     case PROP_MAGNETIC_NET_MODE:
 641       gschem_options_set_magnetic_net_mode (options, g_value_get_boolean (value));
 642       break;
 643
 644     case PROP_NET_RUBBER_BAND_MODE:
 645       gschem_options_set_net_rubber_band_mode (options, g_value_get_boolean (value));
 646       break;
 647
 648     case PROP_SNAP_MODE:
 649       gschem_options_set_snap_mode (options, g_value_get_int (value));
 650       break;
 651
 652     case PROP_SNAP_SIZE:
 653       gschem_options_set_snap_size (options, g_value_get_int (value));
 654       break;
 655
 656     default:
 657       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 658   }
 659 }