vcl/unx/gtk3/gtk3glomenu.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <unx/gtk/glomenu.h>
  11
  12 struct GLOMenu
  13 {
  14     GMenuModel const  parent_instance;
  15
  16     GArray      *items;
  17 };
  18
  19 typedef GMenuModelClass GLOMenuClass;
  20
  21 #ifdef __GNUC__
  22 #pragma GCC diagnostic push
  23 #pragma GCC diagnostic ignored "-Wunused-function"
  24 #if defined __clang__
  25 #if __has_warning("-Wdeprecated-volatile")
  26 #pragma clang diagnostic ignored "-Wdeprecated-volatile"
  27 #endif
  28 #endif
  29 #endif
  30 G_DEFINE_TYPE (GLOMenu, g_lo_menu, G_TYPE_MENU_MODEL);
  31 #ifdef __GNUC__
  32 #pragma GCC diagnostic pop
  33 #endif
  34
  35 namespace {
  36
  37 struct item
  38 {
  39     GHashTable*     attributes;     // Item attributes.
  40     GHashTable*     links;          // Item links.
  41 };
  42
  43 }
  44
  45 static void
  46 g_lo_menu_struct_item_init (struct item *menu_item)
  47 {
  48     menu_item->attributes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, reinterpret_cast<GDestroyNotify>(g_variant_unref));
  49     menu_item->links = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
  50 }
  51
  52 /* We treat attribute names the same as GSettings keys:
  53  * - only lowercase ascii, digits and '-'
  54  * - must start with lowercase
  55  * - must not end with '-'
  56  * - no consecutive '-'
  57  * - not longer than 1024 chars
  58  */
  59 static bool
  60 valid_attribute_name (const gchar *name)
  61 {
  62     gint i;
  63
  64     if (!g_ascii_islower (name[0]))
  65         return false;
  66
  67     for (i = 1; name[i]; i++)
  68     {
  69         if (name[i] != '-' &&
  70                 !g_ascii_islower (name[i]) &&
  71                 !g_ascii_isdigit (name[i]))
  72             return false;
  73
  74         if (name[i] == '-' && name[i + 1] == '-')
  75             return false;
  76     }
  77
  78     if (name[i - 1] == '-')
  79         return false;
  80
  81     if (i > 1024)
  82         return false;
  83
  84     return true;
  85 }
  86
  87 /*
  88  * GLOMenu
  89  */
  90
  91 static gboolean
  92 g_lo_menu_is_mutable (GMenuModel*)
  93 {
  94     // Menu is always mutable.
  95     return true;
  96 }
  97
  98 static gint
  99 g_lo_menu_get_n_items (GMenuModel *model)
 100 {
 101     g_return_val_if_fail (model != nullptr, 0);
 102     GLOMenu *menu = G_LO_MENU (model);
 103     g_return_val_if_fail (menu->items != nullptr, 0);
 104
 105     return menu->items->len;
 106 }
 107
 108 gint
 109 g_lo_menu_get_n_items_from_section (GLOMenu *menu,
 110                                     gint     section)
 111 {
 112     g_return_val_if_fail (0 <= section && section < static_cast<gint>(menu->items->len), 0);
 113
 114     GLOMenu *model = g_lo_menu_get_section (menu, section);
 115
 116     g_return_val_if_fail (model != nullptr, 0);
 117
 118     gint length = model->items->len;
 119
 120     g_object_unref (model);
 121
 122     return length;
 123 }
 124
 125 static void
 126 g_lo_menu_get_item_attributes (GMenuModel  *model,
 127                                gint         position,
 128                                GHashTable **table)
 129 {
 130     GLOMenu *menu = G_LO_MENU (model);
 131     *table = g_hash_table_ref (g_array_index (menu->items, struct item, position).attributes);
 132 }
 133
 134 static void
 135 g_lo_menu_get_item_links (GMenuModel  *model,
 136                           gint         position,
 137                           GHashTable **table)
 138 {
 139     GLOMenu *menu = G_LO_MENU (model);
 140     *table = g_hash_table_ref (g_array_index (menu->items, struct item, position).links);
 141 }
 142
 143 void
 144 g_lo_menu_insert (GLOMenu     *menu,
 145                   gint         position,
 146                   const gchar *label)
 147 {
 148     g_lo_menu_insert_section (menu, position, label, nullptr);
 149 }
 150
 151 void
 152 g_lo_menu_insert_in_section (GLOMenu     *menu,
 153                              gint         section,
 154                              gint         position,
 155                              const gchar *label)
 156 {
 157     g_return_if_fail (G_IS_LO_MENU (menu));
 158     g_return_if_fail (0 <= section && section < static_cast<gint>(menu->items->len));
 159
 160     GLOMenu *model = g_lo_menu_get_section (menu, section);
 161
 162     g_return_if_fail (model != nullptr);
 163
 164     g_lo_menu_insert (model, position, label);
 165
 166     g_object_unref (model);
 167 }
 168
 169 GLOMenu *
 170 g_lo_menu_new()
 171 {
 172     return G_LO_MENU( g_object_new (G_TYPE_LO_MENU, nullptr) );
 173 }
 174
 175 static void
 176 g_lo_menu_set_attribute_value (GLOMenu     *menu,
 177                                gint         position,
 178                                const gchar *attribute,
 179                                GVariant    *value)
 180 {
 181     g_return_if_fail (G_IS_LO_MENU (menu));
 182     g_return_if_fail (attribute != nullptr);
 183     g_return_if_fail (valid_attribute_name (attribute));
 184
 185     if (position >= static_cast<gint>(menu->items->len))
 186         return;
 187
 188     struct item menu_item = g_array_index (menu->items, struct item, position);
 189
 190     if (value != nullptr)
 191         g_hash_table_insert (menu_item.attributes, g_strdup (attribute), g_variant_ref_sink (value));
 192     else
 193         g_hash_table_remove (menu_item.attributes, attribute);
 194 }
 195
 196 static GVariant*
 197 g_lo_menu_get_attribute_value_from_item_in_section (GLOMenu            *menu,
 198                                                     gint                section,
 199                                                     gint                position,
 200                                                     const gchar        *attribute,
 201                                                     const GVariantType *type)
 202 {
 203     GMenuModel *model = G_MENU_MODEL (g_lo_menu_get_section (menu, section));
 204
 205     g_return_val_if_fail (model != nullptr, nullptr);
 206
 207     GVariant *value = g_menu_model_get_item_attribute_value (model,
 208                                                              position,
 209                                                              attribute,
 210                                                              type);
 211
 212     g_object_unref (model);
 213
 214     return value;
 215 }
 216
 217 void
 218 g_lo_menu_set_label (GLOMenu     *menu,
 219                      gint         position,
 220                      const gchar *label)
 221 {
 222     g_return_if_fail (G_IS_LO_MENU (menu));
 223
 224     GVariant *value;
 225
 226     if (label != nullptr)
 227         value = g_variant_new_string (label);
 228     else
 229         value = nullptr;
 230
 231     g_lo_menu_set_attribute_value (menu, position, G_MENU_ATTRIBUTE_LABEL, value);
 232 }
 233
 234 void
 235 g_lo_menu_set_icon (GLOMenu     *menu,
 236                     gint         position,
 237                     const GIcon *icon)
 238 {
 239     g_return_if_fail (G_IS_LO_MENU (menu));
 240
 241     GVariant *value;
 242
 243     if (icon != nullptr)
 244     {
 245 #if GLIB_CHECK_VERSION(2,38,0)
 246         value = g_icon_serialize (const_cast<GIcon*>(icon));
 247 #else
 248         value = nullptr;
 249 #endif
 250     }
 251     else
 252         value = nullptr;
 253
 254 #ifndef G_MENU_ATTRIBUTE_ICON
 255 #    define G_MENU_ATTRIBUTE_ICON "icon"
 256 #endif
 257
 258     g_lo_menu_set_attribute_value (menu, position, G_MENU_ATTRIBUTE_ICON, value);
 259     if (value)
 260       g_variant_unref (value);
 261 }
 262
 263 void
 264 g_lo_menu_set_label_to_item_in_section (GLOMenu     *menu,
 265                                         gint         section,
 266                                         gint         position,
 267                                         const gchar *label)
 268 {
 269     g_return_if_fail (G_IS_LO_MENU (menu));
 270
 271     GLOMenu *model = g_lo_menu_get_section (menu, section);
 272
 273     g_return_if_fail (model != nullptr);
 274
 275     g_lo_menu_set_label (model, position, label);
 276
 277     // Notify the update.
 278     g_menu_model_items_changed (G_MENU_MODEL (model), position, 1, 1);
 279
 280     g_object_unref (model);
 281 }
 282
 283 void
 284 g_lo_menu_set_icon_to_item_in_section (GLOMenu     *menu,
 285                                        gint         section,
 286                                        gint         position,
 287                                        const GIcon *icon)
 288 {
 289     g_return_if_fail (G_IS_LO_MENU (menu));
 290
 291     GLOMenu *model = g_lo_menu_get_section (menu, section);
 292
 293     g_return_if_fail (model != nullptr);
 294
 295     g_lo_menu_set_icon (model, position, icon);
 296
 297     // Notify the update.
 298     g_menu_model_items_changed (G_MENU_MODEL (model), position, 1, 1);
 299
 300     g_object_unref (model);
 301 }
 302
 303 gchar *
 304 g_lo_menu_get_label_from_item_in_section (GLOMenu *menu,
 305                                           gint     section,
 306                                           gint     position)
 307 {
 308     g_return_val_if_fail (G_IS_LO_MENU (menu), nullptr);
 309
 310     GVariant *label_value = g_lo_menu_get_attribute_value_from_item_in_section (menu,
 311                                                                                 section,
 312                                                                                 position,
 313                                                                                 G_MENU_ATTRIBUTE_LABEL,
 314                                                                                 G_VARIANT_TYPE_STRING);
 315
 316     gchar *label = nullptr;
 317
 318     if (label_value)
 319     {
 320         label = g_variant_dup_string (label_value, nullptr);
 321         g_variant_unref (label_value);
 322     }
 323
 324     return label;
 325 }
 326
 327 void
 328 g_lo_menu_set_action_and_target_value (GLOMenu     *menu,
 329                                        gint         position,
 330                                        const gchar *action,
 331                                        GVariant    *target_value)
 332 {
 333     g_return_if_fail (G_IS_LO_MENU (menu));
 334
 335     GVariant *action_value;
 336
 337     if (action != nullptr)
 338     {
 339         action_value = g_variant_new_string (action);
 340     }
 341     else
 342     {
 343         action_value = nullptr;
 344         target_value = nullptr;
 345     }
 346
 347     g_lo_menu_set_attribute_value (menu, position, G_MENU_ATTRIBUTE_ACTION, action_value);
 348     g_lo_menu_set_attribute_value (menu, position, G_MENU_ATTRIBUTE_TARGET, target_value);
 349     g_lo_menu_set_attribute_value (menu, position, G_LO_MENU_ATTRIBUTE_SUBMENU_ACTION, nullptr);
 350
 351     g_menu_model_items_changed (G_MENU_MODEL (menu), position, 1, 1);
 352 }
 353
 354 void
 355 g_lo_menu_set_action_and_target_value_to_item_in_section (GLOMenu     *menu,
 356                                                           gint         section,
 357                                                           gint         position,
 358                                                           const gchar *command,
 359                                                           GVariant    *target_value)
 360 {
 361     g_return_if_fail (G_IS_LO_MENU (menu));
 362
 363     GLOMenu *model = g_lo_menu_get_section (menu, section);
 364
 365     g_return_if_fail (model != nullptr);
 366
 367     g_lo_menu_set_action_and_target_value (model, position, command, target_value);
 368
 369     g_object_unref (model);
 370 }
 371
 372 void
 373 g_lo_menu_set_accelerator_to_item_in_section (GLOMenu     *menu,
 374                                               gint         section,
 375                                               gint         position,
 376                                               const gchar *accelerator)
 377 {
 378     g_return_if_fail (G_IS_LO_MENU (menu));
 379
 380     GLOMenu *model = g_lo_menu_get_section (menu, section);
 381
 382     g_return_if_fail (model != nullptr);
 383
 384     GVariant *value;
 385
 386     if (accelerator != nullptr)
 387         value = g_variant_new_string (accelerator);
 388     else
 389         value = nullptr;
 390
 391     g_lo_menu_set_attribute_value (model, position, G_LO_MENU_ATTRIBUTE_ACCELERATOR, value);
 392
 393     // Notify the update.
 394     g_menu_model_items_changed (G_MENU_MODEL (model), position, 1, 1);
 395
 396     g_object_unref (model);
 397 }
 398
 399 gchar *
 400 g_lo_menu_get_accelerator_from_item_in_section (GLOMenu *menu,
 401                                                 gint     section,
 402                                                 gint     position)
 403 {
 404     g_return_val_if_fail (G_IS_LO_MENU (menu), nullptr);
 405
 406     GVariant *accel_value = g_lo_menu_get_attribute_value_from_item_in_section (menu,
 407                                                                                 section,
 408                                                                                 position,
 409                                                                                 G_LO_MENU_ATTRIBUTE_ACCELERATOR,
 410                                                                                 G_VARIANT_TYPE_STRING);
 411
 412     gchar *accel = nullptr;
 413
 414     if (accel_value != nullptr)
 415     {
 416         accel = g_variant_dup_string (accel_value, nullptr);
 417         g_variant_unref (accel_value);
 418     }
 419
 420     return accel;
 421 }
 422
 423 void
 424 g_lo_menu_set_command_to_item_in_section (GLOMenu     *menu,
 425                                           gint         section,
 426                                           gint         position,
 427                                           const gchar *command)
 428 {
 429     g_return_if_fail (G_IS_LO_MENU (menu));
 430
 431     GLOMenu *model = g_lo_menu_get_section (menu, section);
 432
 433     g_return_if_fail (model != nullptr);
 434
 435     GVariant *value;
 436
 437     if (command != nullptr)
 438         value = g_variant_new_string (command);
 439     else
 440         value = nullptr;
 441
 442     g_lo_menu_set_attribute_value (model, position, G_LO_MENU_ATTRIBUTE_COMMAND, value);
 443
 444     // Notify the update.
 445     g_menu_model_items_changed (G_MENU_MODEL (model), position, 1, 1);
 446
 447     g_object_unref (model);
 448 }
 449
 450 gchar *
 451 g_lo_menu_get_command_from_item_in_section (GLOMenu *menu,
 452                                             gint     section,
 453                                             gint     position)
 454 {
 455     g_return_val_if_fail (G_IS_LO_MENU (menu), nullptr);
 456
 457     GVariant *command_value = g_lo_menu_get_attribute_value_from_item_in_section (menu,
 458                                                                                   section,
 459                                                                                   position,
 460                                                                                   G_LO_MENU_ATTRIBUTE_COMMAND,
 461                                                                                   G_VARIANT_TYPE_STRING);
 462
 463     gchar *command = nullptr;
 464
 465     if (command_value != nullptr)
 466     {
 467         command = g_variant_dup_string (command_value, nullptr);
 468         g_variant_unref (command_value);
 469     }
 470
 471     return command;
 472 }
 473
 474 static void
 475 g_lo_menu_set_link (GLOMenu     *menu,
 476                     gint         position,
 477                     const gchar *link,
 478                     GMenuModel  *model)
 479 {
 480     g_return_if_fail (G_IS_LO_MENU (menu));
 481     g_return_if_fail (link != nullptr);
 482     g_return_if_fail (valid_attribute_name (link));
 483
 484     if (position < 0 || position >= static_cast<gint>(menu->items->len))
 485         position = menu->items->len - 1;
 486
 487     struct item menu_item = g_array_index (menu->items, struct item, position);
 488
 489     if (model != nullptr)
 490         g_hash_table_insert (menu_item.links, g_strdup (link), g_object_ref (model));
 491     else
 492         g_hash_table_remove (menu_item.links, link);
 493 }
 494
 495 void
 496 g_lo_menu_insert_section (GLOMenu     *menu,
 497                           gint         position,
 498                           const gchar *label,
 499                           GMenuModel  *section)
 500 {
 501     g_return_if_fail (G_IS_LO_MENU (menu));
 502
 503     if (position < 0 || position > static_cast<gint>(menu->items->len))
 504         position = menu->items->len;
 505
 506     struct item menu_item;
 507
 508     g_lo_menu_struct_item_init(&menu_item);
 509
 510     g_array_insert_val (menu->items, position, menu_item);
 511
 512     g_lo_menu_set_label (menu, position, label);
 513     g_lo_menu_set_link (menu, position, G_MENU_LINK_SECTION, section);
 514
 515     g_menu_model_items_changed (G_MENU_MODEL (menu), position, 0, 1);
 516 }
 517
 518 void
 519 g_lo_menu_new_section (GLOMenu     *menu,
 520                        gint         position,
 521                        const gchar *label)
 522 {
 523     GMenuModel *section = G_MENU_MODEL (g_lo_menu_new());
 524
 525     g_lo_menu_insert_section (menu, position, label, section);
 526
 527     g_object_unref (section);
 528 }
 529
 530 GLOMenu *
 531 g_lo_menu_get_section (GLOMenu *menu,
 532                        gint section)
 533 {
 534     g_return_val_if_fail (G_IS_LO_MENU (menu), nullptr);
 535
 536     return G_LO_MENU (G_MENU_MODEL_CLASS (g_lo_menu_parent_class)
 537                       ->get_item_link (G_MENU_MODEL (menu), section, G_MENU_LINK_SECTION));
 538 }
 539
 540 void
 541 g_lo_menu_new_submenu_in_item_in_section (GLOMenu *menu,
 542                                           gint     section,
 543                                           gint     position)
 544 {
 545     g_return_if_fail (G_IS_LO_MENU (menu));
 546     g_return_if_fail (0 <= section && section < static_cast<gint>(menu->items->len));
 547
 548     GLOMenu* model = g_lo_menu_get_section (menu, section);
 549
 550     g_return_if_fail (model != nullptr);
 551
 552     if (0 <= position && position < static_cast<gint>(model->items->len)) {
 553         GMenuModel* submenu = G_MENU_MODEL (g_lo_menu_new());
 554
 555         g_lo_menu_set_link (model, position, G_MENU_LINK_SUBMENU, submenu);
 556
 557         g_object_unref (submenu);
 558
 559         g_menu_model_items_changed (G_MENU_MODEL (model), position, 1, 1);
 560
 561         g_object_unref (model);
 562     }
 563 }
 564
 565 GLOMenu *
 566 g_lo_menu_get_submenu_from_item_in_section (GLOMenu *menu,
 567                                             gint     section,
 568                                             gint     position)
 569 {
 570     g_return_val_if_fail (G_IS_LO_MENU (menu), nullptr);
 571     g_return_val_if_fail (0 <= section && section < static_cast<gint>(menu->items->len), nullptr);
 572
 573     GLOMenu *model = g_lo_menu_get_section (menu, section);
 574
 575     g_return_val_if_fail (model != nullptr, nullptr);
 576
 577     GLOMenu *submenu = nullptr;
 578
 579     if (0 <= position && position < static_cast<gint>(model->items->len))
 580         submenu = G_LO_MENU (G_MENU_MODEL_CLASS (g_lo_menu_parent_class)
 581                 ->get_item_link (G_MENU_MODEL (model), position, G_MENU_LINK_SUBMENU));
 582         //submenu = g_menu_model_get_item_link (G_MENU_MODEL (model), position, G_MENU_LINK_SUBMENU);
 583
 584     g_object_unref (model);
 585
 586     return submenu;
 587 }
 588
 589 void
 590 g_lo_menu_set_submenu_action_to_item_in_section (GLOMenu     *menu,
 591                                                  gint         section,
 592                                                  gint         position,
 593                                                  const gchar *action)
 594 {
 595     g_return_if_fail (G_IS_LO_MENU (menu));
 596
 597     GMenuModel *model = G_MENU_MODEL (g_lo_menu_get_section (menu, section));
 598
 599     g_return_if_fail (model != nullptr);
 600
 601     GVariant *value;
 602
 603     if (action != nullptr)
 604         value = g_variant_new_string (action);
 605     else
 606         value = nullptr;
 607
 608     g_lo_menu_set_attribute_value (G_LO_MENU (model), position, G_LO_MENU_ATTRIBUTE_SUBMENU_ACTION, value);
 609
 610     // Notify the update.
 611     g_menu_model_items_changed (model, position, 1, 1);
 612
 613     g_object_unref (model);
 614 }
 615
 616 static void
 617 g_lo_menu_clear_item (struct item *menu_item)
 618 {
 619     if (menu_item->attributes != nullptr)
 620         g_hash_table_unref (menu_item->attributes);
 621     if (menu_item->links != nullptr)
 622         g_hash_table_unref (menu_item->links);
 623 }
 624
 625 void
 626 g_lo_menu_remove (GLOMenu *menu,
 627                   gint     position)
 628 {
 629     g_return_if_fail (G_IS_LO_MENU (menu));
 630     g_return_if_fail (0 <= position && position < static_cast<gint>(menu->items->len));
 631
 632     g_lo_menu_clear_item (&g_array_index (menu->items, struct item, position));
 633     g_array_remove_index (menu->items, position);
 634     g_menu_model_items_changed (G_MENU_MODEL (menu), position, 1, 0);
 635 }
 636
 637 void
 638 g_lo_menu_remove_from_section (GLOMenu *menu,
 639                                gint     section,
 640                                gint     position)
 641 {
 642     g_return_if_fail (G_IS_LO_MENU (menu));
 643     g_return_if_fail (0 <= section && section < static_cast<gint>(menu->items->len));
 644
 645     GLOMenu *model = g_lo_menu_get_section (menu, section);
 646
 647     g_return_if_fail (model != nullptr);
 648
 649     g_lo_menu_remove (model, position);
 650
 651     g_object_unref (model);
 652 }
 653
 654 static void
 655 g_lo_menu_finalize (GObject *object)
 656 {
 657     GLOMenu *menu = G_LO_MENU (object);
 658     struct item *items;
 659     gint n_items;
 660     gint i;
 661
 662     n_items = menu->items->len;
 663     items = reinterpret_cast<struct item *>(g_array_free (menu->items, FALSE));
 664     for (i = 0; i < n_items; i++)
 665         g_lo_menu_clear_item (&items[i]);
 666     g_free (items);
 667
 668     G_OBJECT_CLASS (g_lo_menu_parent_class)
 669             ->finalize (object);
 670 }
 671
 672 static void
 673 g_lo_menu_init (GLOMenu *menu)
 674 {
 675     menu->items = g_array_new (FALSE, FALSE, sizeof (struct item));
 676 }
 677
 678 static void
 679 g_lo_menu_class_init (GLOMenuClass *klass)
 680 {
 681     GMenuModelClass *model_class = G_MENU_MODEL_CLASS (klass);
 682     GObjectClass *object_class = G_OBJECT_CLASS (klass);
 683
 684     object_class->finalize = g_lo_menu_finalize;
 685
 686     model_class->is_mutable = g_lo_menu_is_mutable;
 687     model_class->get_n_items = g_lo_menu_get_n_items;
 688     model_class->get_item_attributes = g_lo_menu_get_item_attributes;
 689     model_class->get_item_links = g_lo_menu_get_item_links;
 690 }
 691
 692 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */