2 * htmlchars.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2009-2010 Frank Lanitz <frank(at)frank(dot)uvena(dot)de>
5 * Copyright 2006-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
6 * Copyright 2007-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
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.
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., 51 Franklin Street, Fifth Floor, Boston,
26 /* HTML Characters plugin (Inserts HTML character entities like '&') */
28 #include "geanyplugin.h"
32 GeanyData
*geany_data
;
33 GeanyFunctions
*geany_functions
;
36 PLUGIN_VERSION_CHECK(GEANY_API_VERSION
)
38 PLUGIN_SET_INFO(_("HTML Characters"), _("Inserts HTML character entities like '&'."), VERSION
,
39 _("The Geany developer team"))
46 KB_REPLACE_HTML_ENTITIES
,
51 PLUGIN_KEY_GROUP(html_chars
, KB_COUNT
)
61 static GtkWidget
*main_menu_item
= NULL
;
62 static GtkWidget
*main_menu
= NULL
;
63 static GtkWidget
*main_menu_submenu
= NULL
;
64 static GtkWidget
*menu_bulk_replace
= NULL
;
65 static GtkWidget
*sc_dialog
= NULL
;
66 static GtkTreeStore
*sc_store
= NULL
;
67 static GtkTreeView
*sc_tree
= NULL
;
68 static GtkWidget
*menu_htmltoggle
= NULL
;
69 static gboolean plugin_active
= FALSE
;
71 /* Configuration file */
72 static gchar
*config_file
= NULL
;
74 const gchar
*chars
[][2] ={
75 { N_("HTML characters"), NULL
},
81 { N_("ISO 8859-1 characters"), NULL
},
179 { N_("Greek characters"), NULL
},
189 { "Ε", "Ε" },
190 { "ε", "ε" },
209 { "Ο", "Ο" },
210 { "ο", "ο" },
220 { "Υ", "Υ" },
221 { "υ", "υ" },
230 { "ϑ", "ϑ" },
234 { N_("Mathematical characters"), NULL
},
275 { N_("Technical characters"), NULL
},
283 { N_("Arrow characters"), NULL
},
296 { N_("Punctuation characters"), NULL
},
312 { N_("Miscellaneous characters"), NULL
},
323 { "ℵ", "ℵ" },
336 static gboolean
ht_editor_notify_cb(GObject
*object
, GeanyEditor
*editor
,
337 SCNotification
*nt
, gpointer data
);
340 PluginCallback plugin_callbacks
[] =
342 { "editor-notify", (GCallback
) &ht_editor_notify_cb
, FALSE
, NULL
},
343 { NULL
, NULL
, FALSE
, NULL
}
347 /* Functions to toggle the status of plugin */
348 void set_status(gboolean new_status
)
350 if (plugin_active
!= new_status
)
352 GKeyFile
*config
= g_key_file_new();
354 gchar
*config_dir
= g_path_get_dirname(config_file
);
356 plugin_active
= new_status
;
358 /* Now we save the new status into configuration file to
359 * remember next time */
360 g_key_file_set_boolean(config
, "general", "replacement_on_typing_active",
363 if (!g_file_test(config_dir
, G_FILE_TEST_IS_DIR
)
364 && utils_mkdir(config_dir
, TRUE
) != 0)
366 dialogs_show_msgbox(GTK_MESSAGE_ERROR
,
367 _("Plugin configuration directory could not be created."));
371 /* write config to file */
372 data
= g_key_file_to_data(config
, NULL
, NULL
);
373 utils_write_file(config_file
, data
);
377 g_key_file_free(config
);
382 static void toggle_status(G_GNUC_UNUSED GtkMenuItem
* menuitem
)
384 if (plugin_active
== TRUE
)
391 static void sc_on_tools_show_dialog_insert_special_chars_response
392 (GtkDialog
*dialog
, gint response
, gpointer user_data
);
393 static void sc_on_tree_row_activated
394 (GtkTreeView
*treeview
, GtkTreePath
*path
, GtkTreeViewColumn
*col
, gpointer user_data
);
395 static void sc_fill_store(GtkTreeStore
*store
);
396 static gboolean
sc_insert(GtkTreeModel
*model
, GtkTreeIter
*iter
);
399 /* Function takes over value of key which was pressed and returns
400 * HTML/SGML entity if any */
401 const gchar
*get_entity(gchar
*letter
)
405 len
= G_N_ELEMENTS(chars
);
407 /* Ignore tags marking caracters as well as spaces*/
408 for (i
= 7; i
< len
; i
++)
410 if (utils_str_equal(chars
[i
][0], letter
) &&
411 !utils_str_equal(" ", letter
))
417 /* if the char is not in the list */
422 static gboolean
ht_editor_notify_cb(GObject
*object
, GeanyEditor
*editor
,
423 SCNotification
*nt
, gpointer data
)
425 g_return_val_if_fail(editor
!= NULL
, FALSE
);
427 if (plugin_active
!= TRUE
)
430 if (nt
->nmhdr
.code
== SCN_CHARADDED
)
435 len
= g_unichar_to_utf8(nt
->ch
, buf
);
440 entity
= get_entity(buf
);
444 gint pos
= sci_get_current_position(editor
->sci
);
446 sci_set_selection_start(editor
->sci
, pos
- len
);
447 sci_set_selection_end(editor
->sci
, pos
);
449 sci_replace_sel(editor
->sci
, entity
);
458 /* Called when keys were pressed */
459 static void kbhtmltoggle_toggle(G_GNUC_UNUSED guint key_id
)
461 if (plugin_active
== TRUE
)
472 static void tools_show_dialog_insert_special_chars(void)
474 if (sc_dialog
== NULL
)
477 GtkCellRenderer
*renderer
;
478 GtkTreeViewColumn
*column
;
479 GtkWidget
*swin
, *vbox
, *label
;
481 sc_dialog
= gtk_dialog_new_with_buttons(
482 _("Special Characters"), GTK_WINDOW(geany
->main_widgets
->window
),
483 GTK_DIALOG_DESTROY_WITH_PARENT
, GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
484 _("_Insert"), GTK_RESPONSE_OK
, NULL
);
485 vbox
= ui_dialog_vbox_new(GTK_DIALOG(sc_dialog
));
486 gtk_box_set_spacing(GTK_BOX(vbox
), 6);
487 gtk_widget_set_name(sc_dialog
, "GeanyDialog");
489 height
= GEANY_DEFAULT_DIALOG_HEIGHT
;
490 gtk_window_set_default_size(GTK_WINDOW(sc_dialog
), height
* 8 / 10, height
);
491 gtk_dialog_set_default_response(GTK_DIALOG(sc_dialog
), GTK_RESPONSE_CANCEL
);
493 label
= gtk_label_new(_("Choose a special character from the list below and double click on it or use the button to insert it at the current cursor position."));
494 gtk_label_set_line_wrap(GTK_LABEL(label
), TRUE
);
495 gtk_misc_set_alignment(GTK_MISC(label
), 0, 0.5);
496 gtk_box_pack_start(GTK_BOX(vbox
), label
, FALSE
, FALSE
, 0);
498 sc_tree
= GTK_TREE_VIEW(gtk_tree_view_new());
500 sc_store
= gtk_tree_store_new(N_COLUMNS
, G_TYPE_STRING
, G_TYPE_STRING
);
501 gtk_tree_view_set_model(GTK_TREE_VIEW(sc_tree
),
502 GTK_TREE_MODEL(sc_store
));
503 g_object_unref(sc_store
);
505 renderer
= gtk_cell_renderer_text_new();
506 column
= gtk_tree_view_column_new_with_attributes(
507 _("Character"), renderer
, "text", COLUMN_CHARACTER
, NULL
);
508 gtk_tree_view_column_set_resizable(column
, TRUE
);
509 gtk_tree_view_append_column(GTK_TREE_VIEW(sc_tree
), column
);
511 renderer
= gtk_cell_renderer_text_new();
512 column
= gtk_tree_view_column_new_with_attributes(
513 _("HTML (name)"), renderer
, "text", COLUMN_HTML_NAME
, NULL
);
514 gtk_tree_view_column_set_resizable(column
, TRUE
);
515 gtk_tree_view_append_column(GTK_TREE_VIEW(sc_tree
), column
);
517 swin
= gtk_scrolled_window_new(NULL
, NULL
);
518 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(swin
), GTK_POLICY_AUTOMATIC
,
519 GTK_POLICY_AUTOMATIC
);
520 gtk_scrolled_window_add_with_viewport(
521 GTK_SCROLLED_WINDOW(swin
), GTK_WIDGET(sc_tree
));
523 gtk_box_pack_start(GTK_BOX(vbox
), swin
, TRUE
, TRUE
, 0);
525 g_signal_connect(sc_tree
, "row-activated", G_CALLBACK(sc_on_tree_row_activated
), NULL
);
527 g_signal_connect(sc_dialog
, "response",
528 G_CALLBACK(sc_on_tools_show_dialog_insert_special_chars_response
), NULL
);
530 g_signal_connect(sc_dialog
, "delete-event", G_CALLBACK(gtk_widget_hide_on_delete
), NULL
);
532 sc_fill_store(sc_store
);
534 /*gtk_tree_view_expand_all(special_characters_tree);*/
535 gtk_tree_view_set_search_column(sc_tree
, COLUMN_HTML_NAME
);
537 gtk_widget_show_all(sc_dialog
);
541 /* fill the tree model with data
542 ** TODO move this in a file and make it extendable for more data types */
543 static void sc_fill_store(GtkTreeStore
*store
)
546 GtkTreeIter
*parent_iter
= NULL
;
549 len
= G_N_ELEMENTS(chars
);
550 for (i
= 0; i
< len
; i
++)
552 if (chars
[i
][1] == NULL
)
553 { /* add a category */
554 gtk_tree_store_append(store
, &iter
, NULL
);
555 gtk_tree_store_set(store
, &iter
, COLUMN_CHARACTER
, chars
[i
][0], -1);
556 if (parent_iter
!= NULL
) gtk_tree_iter_free(parent_iter
);
557 parent_iter
= gtk_tree_iter_copy(&iter
);
560 { /* add child to parent_iter */
561 gtk_tree_store_append(store
, &iter
, parent_iter
);
562 gtk_tree_store_set(store
, &iter
, COLUMN_CHARACTER
, chars
[i
][0],
563 COLUMN_HTML_NAME
, chars
[i
][1], -1);
569 /* just inserts the HTML_NAME coloumn of the selected row at current position
570 * returns only TRUE if a valid selection(i.e. no category) could be found */
571 static gboolean
sc_insert(GtkTreeModel
*model
, GtkTreeIter
*iter
)
573 GeanyDocument
*doc
= document_get_current();
574 gboolean result
= FALSE
;
579 gint pos
= sci_get_current_position(doc
->editor
->sci
);
581 gtk_tree_model_get(model
, iter
, COLUMN_HTML_NAME
, &str
, -1);
584 sci_insert_text(doc
->editor
->sci
, pos
, str
);
593 static void sc_on_tools_show_dialog_insert_special_chars_response(GtkDialog
*dialog
, gint response
,
596 if (response
== GTK_RESPONSE_OK
)
598 GtkTreeSelection
*selection
;
602 selection
= gtk_tree_view_get_selection(sc_tree
);
604 if (gtk_tree_selection_get_selected(selection
, &model
, &iter
))
606 /* only hide dialog if selection was not a category */
607 if (sc_insert(model
, &iter
))
608 gtk_widget_hide(GTK_WIDGET(dialog
));
612 gtk_widget_hide(GTK_WIDGET(dialog
));
616 static void sc_on_tree_row_activated(GtkTreeView
*treeview
, GtkTreePath
*path
,
617 GtkTreeViewColumn
*col
, gpointer user_data
)
620 GtkTreeModel
*model
= GTK_TREE_MODEL(sc_store
);
622 if (gtk_tree_model_get_iter(model
, &iter
, path
))
624 /* only hide dialog if selection was not a category */
625 if (sc_insert(model
, &iter
))
626 gtk_widget_hide(sc_dialog
);
628 { /* double click on a category to toggle the expand or collapse it */
629 if (gtk_tree_view_row_expanded(sc_tree
, path
))
630 gtk_tree_view_collapse_row(sc_tree
, path
);
632 gtk_tree_view_expand_row(sc_tree
, path
, FALSE
);
638 static void replace_special_character()
640 GeanyDocument
*doc
= NULL
;
641 doc
= document_get_current();
643 if (doc
!= NULL
&& sci_has_selection(doc
->editor
->sci
))
647 GString
*replacement
= g_string_new(NULL
);
650 const gchar
*entity
= NULL
;
654 selection
= sci_get_selection_contents(doc
->editor
->sci
);
656 selection_len
= strlen(selection
);
657 for (i
= 0; i
< selection_len
; i
++)
659 len
= g_unichar_to_utf8(g_utf8_get_char(selection
+ i
), buf
);
663 entity
= get_entity(buf
);
667 replacement
= g_string_append(replacement
, entity
);
671 replacement
= g_string_append(replacement
, buf
);
674 new = g_string_free(replacement
, FALSE
);
675 sci_replace_sel(doc
->editor
->sci
, new);
682 /* Callback for special chars menu */
684 item_activate(GtkMenuItem
*menuitem
, gpointer gdata
)
686 tools_show_dialog_insert_special_chars();
690 static void kb_activate(G_GNUC_UNUSED guint key_id
)
692 item_activate(NULL
, NULL
);
696 /* Callback for bulk replacement of selected text */
698 replace_special_character_activated(GtkMenuItem
*menuitem
, gpointer gdata
)
700 replace_special_character();
704 static void kb_special_chars_replacement(G_GNUC_UNUSED guint key_id
)
706 replace_special_character();
710 static void init_configuration()
712 GKeyFile
*config
= g_key_file_new();
714 /* loading configurations from file ...*/
715 config_file
= g_strconcat(geany
->app
->configdir
, G_DIR_SEPARATOR_S
,
716 "plugins", G_DIR_SEPARATOR_S
,
717 "htmchars", G_DIR_SEPARATOR_S
, "general.conf", NULL
);
719 /* ... and initialising options from config file */
720 g_key_file_load_from_file(config
, config_file
, G_KEY_FILE_NONE
, NULL
);
722 plugin_active
= utils_get_setting_boolean(config
, "general",
723 "replacement_on_typing_active", FALSE
);
727 /* Called by Geany to initialise the plugin */
728 void plugin_init(GeanyData
*data
)
730 GtkWidget
*menu_item
;
731 const gchar
*menu_text
= _("_Insert Special HTML Characters");
733 /* First we catch the configuration and initialize them */
734 init_configuration();
736 /* Add an item to the Tools menu for html chars dialog*/
737 menu_item
= gtk_menu_item_new_with_mnemonic(menu_text
);
738 gtk_widget_show(menu_item
);
739 gtk_container_add(GTK_CONTAINER(geany
->main_widgets
->tools_menu
), menu_item
);
740 g_signal_connect(menu_item
, "activate", G_CALLBACK(item_activate
), NULL
);
742 /* disable menu_item when there are no documents open */
743 ui_add_document_sensitive(menu_item
);
745 /* Add menuitem for html replacement functions*/
746 main_menu
= gtk_menu_item_new_with_mnemonic(_("HTML Replacement"));
747 gtk_widget_show_all(main_menu
);
748 gtk_container_add(GTK_CONTAINER(geany
->main_widgets
->tools_menu
), main_menu
);
750 main_menu_submenu
= gtk_menu_new();
751 gtk_menu_item_set_submenu(GTK_MENU_ITEM(main_menu
), main_menu_submenu
);
753 menu_htmltoggle
= gtk_check_menu_item_new_with_mnemonic(_("_HTMLToggle"));
754 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM(menu_htmltoggle
),
756 gtk_container_add(GTK_CONTAINER(main_menu_submenu
), menu_htmltoggle
);
758 g_signal_connect((gpointer
) menu_htmltoggle
, "activate",
759 G_CALLBACK(toggle_status
), NULL
);
761 menu_bulk_replace
= gtk_menu_item_new_with_mnemonic(
762 _("Bulk replacement of special chars"));
763 g_signal_connect((gpointer
) menu_bulk_replace
, "activate",
764 G_CALLBACK(replace_special_character_activated
), NULL
);
766 gtk_container_add(GTK_CONTAINER(main_menu_submenu
), menu_bulk_replace
);
768 ui_add_document_sensitive(main_menu
);
769 gtk_widget_show(menu_bulk_replace
);
770 gtk_widget_show(menu_htmltoggle
);
772 main_menu_item
= menu_item
;
774 /* setup keybindings */
775 keybindings_set_item(plugin_key_group
, KB_INSERT_HTML_CHARS
,
776 kb_activate
, 0, 0, "insert_html_chars",
777 _("Insert Special HTML Characters"), menu_item
);
778 keybindings_set_item(plugin_key_group
, KB_REPLACE_HTML_ENTITIES
,
779 kb_special_chars_replacement
, 0, 0, "replace_special_characters",
780 _("Replace special characters"), NULL
);
781 keybindings_set_item(plugin_key_group
, KB_HTMLTOGGLE_ACTIVE
,
782 kbhtmltoggle_toggle
, 0, 0, "htmltoogle_toggle_plugin_status",
783 _("Toggle plugin status"), menu_htmltoggle
);
787 /* Destroy widgets */
788 void plugin_cleanup(void)
790 gtk_widget_destroy(main_menu_item
);
791 gtk_widget_destroy(main_menu
);
793 if (sc_dialog
!= NULL
)
794 gtk_widget_destroy(sc_dialog
);
796 if (config_file
!= NULL
)