2 * htmlchars.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2009-2012 Frank Lanitz <frank(at)frank(dot)uvena(dot)de>
5 * Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
6 * Copyright 2007-2012 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 along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 /* HTML Characters plugin (Inserts HTML character entities like '&') */
29 #include "geanyplugin.h"
34 GeanyData
*geany_data
;
37 PLUGIN_VERSION_CHECK(GEANY_API_VERSION
)
39 PLUGIN_SET_INFO(_("HTML Characters"), _("Inserts HTML character entities like '&'."), VERSION
,
40 _("The Geany developer team"))
47 KB_REPLACE_HTML_ENTITIES
,
52 PLUGIN_KEY_GROUP(html_chars
, KB_COUNT
)
62 static GtkWidget
*main_menu_item
= NULL
;
63 static GtkWidget
*main_menu
= NULL
;
64 static GtkWidget
*main_menu_submenu
= NULL
;
65 static GtkWidget
*menu_bulk_replace
= NULL
;
66 static GtkWidget
*sc_dialog
= NULL
;
67 static GtkTreeStore
*sc_store
= NULL
;
68 static GtkTreeView
*sc_tree
= NULL
;
69 static GtkWidget
*menu_htmltoggle
= NULL
;
70 static gboolean plugin_active
= FALSE
;
72 /* Configuration file */
73 static gchar
*config_file
= NULL
;
75 const gchar
*chars
[][2] ={
76 { N_("HTML characters"), NULL
},
82 { N_("ISO 8859-1 characters"), NULL
},
180 { N_("Greek characters"), NULL
},
190 { "Ε", "Ε" },
191 { "ε", "ε" },
210 { "Ο", "Ο" },
211 { "ο", "ο" },
221 { "Υ", "Υ" },
222 { "υ", "υ" },
231 { "ϑ", "ϑ" },
235 { N_("Mathematical characters"), NULL
},
276 { N_("Technical characters"), NULL
},
284 { N_("Arrow characters"), NULL
},
297 { N_("Punctuation characters"), NULL
},
313 { N_("Miscellaneous characters"), NULL
},
324 { "ℵ", "ℵ" },
337 static gboolean
ht_editor_notify_cb(GObject
*object
, GeanyEditor
*editor
,
338 SCNotification
*nt
, gpointer data
);
341 PluginCallback plugin_callbacks
[] =
343 { "editor-notify", (GCallback
) &ht_editor_notify_cb
, FALSE
, NULL
},
344 { NULL
, NULL
, FALSE
, NULL
}
348 /* Functions to toggle the status of plugin */
349 static void set_status(gboolean new_status
)
351 if (plugin_active
!= new_status
)
353 GKeyFile
*config
= g_key_file_new();
355 gchar
*config_dir
= g_path_get_dirname(config_file
);
357 plugin_active
= new_status
;
359 /* Now we save the new status into configuration file to
360 * remember next time */
361 g_key_file_set_boolean(config
, "general", "replacement_on_typing_active",
364 if (!g_file_test(config_dir
, G_FILE_TEST_IS_DIR
)
365 && utils_mkdir(config_dir
, TRUE
) != 0)
367 dialogs_show_msgbox(GTK_MESSAGE_ERROR
,
368 _("Plugin configuration directory could not be created."));
372 /* write config to file */
373 data
= g_key_file_to_data(config
, NULL
, NULL
);
374 utils_write_file(config_file
, data
);
378 g_key_file_free(config
);
383 static void toggle_status(G_GNUC_UNUSED GtkMenuItem
* menuitem
)
385 if (plugin_active
== TRUE
)
392 static void sc_on_tools_show_dialog_insert_special_chars_response
393 (GtkDialog
*dialog
, gint response
, gpointer user_data
);
394 static void sc_on_tree_row_activated
395 (GtkTreeView
*treeview
, GtkTreePath
*path
, GtkTreeViewColumn
*col
, gpointer user_data
);
396 static void sc_fill_store(GtkTreeStore
*store
);
397 static gboolean
sc_insert(GtkTreeModel
*model
, GtkTreeIter
*iter
);
400 /* Function takes over value of key which was pressed and returns
401 * HTML/SGML entity if any */
402 static const gchar
*get_entity(gchar
*letter
)
406 len
= G_N_ELEMENTS(chars
);
408 /* Ignore tags marking caracters as well as spaces*/
409 for (i
= 7; i
< len
; i
++)
411 if (utils_str_equal(chars
[i
][0], letter
) &&
412 !utils_str_equal(" ", letter
))
418 /* if the char is not in the list */
423 static gboolean
ht_editor_notify_cb(GObject
*object
, GeanyEditor
*editor
,
424 SCNotification
*nt
, gpointer data
)
428 g_return_val_if_fail(editor
!= NULL
, FALSE
);
433 lexer
= sci_get_lexer(editor
->sci
);
434 if (lexer
!= SCLEX_HTML
&& lexer
!= SCLEX_XML
)
437 if (nt
->nmhdr
.code
== SCN_CHARADDED
)
442 len
= g_unichar_to_utf8(nt
->ch
, buf
);
447 entity
= get_entity(buf
);
451 gint pos
= sci_get_current_position(editor
->sci
);
453 sci_set_selection_start(editor
->sci
, pos
- len
);
454 sci_set_selection_end(editor
->sci
, pos
);
456 sci_replace_sel(editor
->sci
, entity
);
465 /* Called when keys were pressed */
466 static void kbhtmltoggle_toggle(G_GNUC_UNUSED guint key_id
)
468 if (plugin_active
== TRUE
)
479 static void tools_show_dialog_insert_special_chars(void)
481 if (sc_dialog
== NULL
)
484 GtkCellRenderer
*renderer
;
485 GtkTreeViewColumn
*column
;
486 GtkWidget
*swin
, *vbox
, *label
;
488 sc_dialog
= gtk_dialog_new_with_buttons(
489 _("Special Characters"), GTK_WINDOW(geany
->main_widgets
->window
),
490 GTK_DIALOG_DESTROY_WITH_PARENT
, GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
491 _("_Insert"), GTK_RESPONSE_OK
, NULL
);
492 vbox
= ui_dialog_vbox_new(GTK_DIALOG(sc_dialog
));
493 gtk_box_set_spacing(GTK_BOX(vbox
), 6);
494 gtk_widget_set_name(sc_dialog
, "GeanyDialog");
496 height
= GEANY_DEFAULT_DIALOG_HEIGHT
;
497 gtk_window_set_default_size(GTK_WINDOW(sc_dialog
), height
* 8 / 10, height
);
498 gtk_dialog_set_default_response(GTK_DIALOG(sc_dialog
), GTK_RESPONSE_CANCEL
);
500 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."));
501 gtk_label_set_line_wrap(GTK_LABEL(label
), TRUE
);
502 gtk_misc_set_alignment(GTK_MISC(label
), 0, 0.5);
503 gtk_box_pack_start(GTK_BOX(vbox
), label
, FALSE
, FALSE
, 0);
505 sc_tree
= GTK_TREE_VIEW(gtk_tree_view_new());
507 sc_store
= gtk_tree_store_new(N_COLUMNS
, G_TYPE_STRING
, G_TYPE_STRING
);
508 gtk_tree_view_set_model(GTK_TREE_VIEW(sc_tree
),
509 GTK_TREE_MODEL(sc_store
));
510 g_object_unref(sc_store
);
512 renderer
= gtk_cell_renderer_text_new();
513 column
= gtk_tree_view_column_new_with_attributes(
514 _("Character"), renderer
, "text", COLUMN_CHARACTER
, NULL
);
515 gtk_tree_view_column_set_resizable(column
, TRUE
);
516 gtk_tree_view_append_column(GTK_TREE_VIEW(sc_tree
), column
);
518 renderer
= gtk_cell_renderer_text_new();
519 column
= gtk_tree_view_column_new_with_attributes(
520 _("HTML (name)"), renderer
, "text", COLUMN_HTML_NAME
, NULL
);
521 gtk_tree_view_column_set_resizable(column
, TRUE
);
522 gtk_tree_view_append_column(GTK_TREE_VIEW(sc_tree
), column
);
524 swin
= gtk_scrolled_window_new(NULL
, NULL
);
525 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(swin
), GTK_POLICY_AUTOMATIC
,
526 GTK_POLICY_AUTOMATIC
);
527 gtk_container_add(GTK_CONTAINER(swin
), GTK_WIDGET(sc_tree
));
528 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(swin
), GTK_SHADOW_IN
);
530 gtk_box_pack_start(GTK_BOX(vbox
), swin
, TRUE
, TRUE
, 0);
532 g_signal_connect(sc_tree
, "row-activated", G_CALLBACK(sc_on_tree_row_activated
), NULL
);
534 g_signal_connect(sc_dialog
, "response",
535 G_CALLBACK(sc_on_tools_show_dialog_insert_special_chars_response
), NULL
);
537 g_signal_connect(sc_dialog
, "delete-event", G_CALLBACK(gtk_widget_hide_on_delete
), NULL
);
539 sc_fill_store(sc_store
);
541 /*gtk_tree_view_expand_all(special_characters_tree);*/
542 gtk_tree_view_set_search_column(sc_tree
, COLUMN_HTML_NAME
);
544 gtk_widget_show_all(sc_dialog
);
548 /* fill the tree model with data
549 ** TODO move this in a file and make it extendable for more data types */
550 static void sc_fill_store(GtkTreeStore
*store
)
553 GtkTreeIter
*parent_iter
= NULL
;
556 len
= G_N_ELEMENTS(chars
);
557 for (i
= 0; i
< len
; i
++)
559 if (chars
[i
][1] == NULL
)
560 { /* add a category */
561 gtk_tree_store_append(store
, &iter
, NULL
);
562 gtk_tree_store_set(store
, &iter
, COLUMN_CHARACTER
, _(chars
[i
][0]), -1);
563 if (parent_iter
!= NULL
) gtk_tree_iter_free(parent_iter
);
564 parent_iter
= gtk_tree_iter_copy(&iter
);
567 { /* add child to parent_iter */
568 gtk_tree_store_append(store
, &iter
, parent_iter
);
569 gtk_tree_store_set(store
, &iter
, COLUMN_CHARACTER
, chars
[i
][0],
570 COLUMN_HTML_NAME
, chars
[i
][1], -1);
576 /* just inserts the HTML_NAME coloumn of the selected row at current position
577 * returns only TRUE if a valid selection(i.e. no category) could be found */
578 static gboolean
sc_insert(GtkTreeModel
*model
, GtkTreeIter
*iter
)
580 GeanyDocument
*doc
= document_get_current();
581 gboolean result
= FALSE
;
586 gint pos
= sci_get_current_position(doc
->editor
->sci
);
588 gtk_tree_model_get(model
, iter
, COLUMN_HTML_NAME
, &str
, -1);
591 sci_insert_text(doc
->editor
->sci
, pos
, str
);
600 static void sc_on_tools_show_dialog_insert_special_chars_response(GtkDialog
*dialog
, gint response
,
603 if (response
== GTK_RESPONSE_OK
)
605 GtkTreeSelection
*selection
;
609 selection
= gtk_tree_view_get_selection(sc_tree
);
611 if (gtk_tree_selection_get_selected(selection
, &model
, &iter
))
613 /* only hide dialog if selection was not a category */
614 if (sc_insert(model
, &iter
))
615 gtk_widget_hide(GTK_WIDGET(dialog
));
619 gtk_widget_hide(GTK_WIDGET(dialog
));
623 static void sc_on_tree_row_activated(GtkTreeView
*treeview
, GtkTreePath
*path
,
624 GtkTreeViewColumn
*col
, gpointer user_data
)
627 GtkTreeModel
*model
= GTK_TREE_MODEL(sc_store
);
629 if (gtk_tree_model_get_iter(model
, &iter
, path
))
631 /* only hide dialog if selection was not a category */
632 if (sc_insert(model
, &iter
))
633 gtk_widget_hide(sc_dialog
);
635 { /* double click on a category to toggle the expand or collapse it */
636 if (gtk_tree_view_row_expanded(sc_tree
, path
))
637 gtk_tree_view_collapse_row(sc_tree
, path
);
639 gtk_tree_view_expand_row(sc_tree
, path
, FALSE
);
645 static void replace_special_character(void)
647 GeanyDocument
*doc
= NULL
;
648 doc
= document_get_current();
650 if (doc
!= NULL
&& sci_has_selection(doc
->editor
->sci
))
654 GString
*replacement
= g_string_new(NULL
);
657 const gchar
*entity
= NULL
;
661 selection
= sci_get_selection_contents(doc
->editor
->sci
);
663 selection_len
= strlen(selection
);
664 for (i
= 0; i
< selection_len
; i
++)
666 len
= g_unichar_to_utf8(g_utf8_get_char(selection
+ i
), buf
);
667 i
= (guint
)len
- 1 + i
;
670 entity
= get_entity(buf
);
674 replacement
= g_string_append(replacement
, entity
);
678 replacement
= g_string_append(replacement
, buf
);
681 new = g_string_free(replacement
, FALSE
);
682 sci_replace_sel(doc
->editor
->sci
, new);
689 /* Callback for special chars menu */
691 item_activate(GtkMenuItem
*menuitem
, gpointer gdata
)
693 tools_show_dialog_insert_special_chars();
697 static void kb_activate(G_GNUC_UNUSED guint key_id
)
699 item_activate(NULL
, NULL
);
703 /* Callback for bulk replacement of selected text */
705 replace_special_character_activated(GtkMenuItem
*menuitem
, gpointer gdata
)
707 replace_special_character();
711 static void kb_special_chars_replacement(G_GNUC_UNUSED guint key_id
)
713 replace_special_character();
717 static void init_configuration(void)
719 GKeyFile
*config
= g_key_file_new();
721 /* loading configurations from file ...*/
722 config_file
= g_strconcat(geany
->app
->configdir
, G_DIR_SEPARATOR_S
,
723 "plugins", G_DIR_SEPARATOR_S
,
724 "htmchars", G_DIR_SEPARATOR_S
, "general.conf", NULL
);
726 /* ... and initialising options from config file */
727 g_key_file_load_from_file(config
, config_file
, G_KEY_FILE_NONE
, NULL
);
729 plugin_active
= utils_get_setting_boolean(config
, "general",
730 "replacement_on_typing_active", FALSE
);
734 /* Called by Geany to initialise the plugin */
735 void plugin_init(GeanyData
*data
)
737 GtkWidget
*menu_item
;
738 const gchar
*menu_text
= _("_Insert Special HTML Characters...");
740 /* First we catch the configuration and initialize them */
741 init_configuration();
743 /* Add an item to the Tools menu for html chars dialog*/
744 menu_item
= gtk_menu_item_new_with_mnemonic(menu_text
);
745 gtk_widget_show(menu_item
);
746 gtk_container_add(GTK_CONTAINER(geany
->main_widgets
->tools_menu
), menu_item
);
747 g_signal_connect(menu_item
, "activate", G_CALLBACK(item_activate
), NULL
);
749 /* disable menu_item when there are no documents open */
750 ui_add_document_sensitive(menu_item
);
752 /* Add menuitem for html replacement functions*/
753 main_menu
= gtk_menu_item_new_with_mnemonic(_("_HTML Replacement"));
754 gtk_widget_show_all(main_menu
);
755 gtk_container_add(GTK_CONTAINER(geany
->main_widgets
->tools_menu
), main_menu
);
757 main_menu_submenu
= gtk_menu_new();
758 gtk_menu_item_set_submenu(GTK_MENU_ITEM(main_menu
), main_menu_submenu
);
760 menu_htmltoggle
= gtk_check_menu_item_new_with_mnemonic(_("_Auto-replace Special Characters"));
761 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM(menu_htmltoggle
),
763 gtk_container_add(GTK_CONTAINER(main_menu_submenu
), menu_htmltoggle
);
765 g_signal_connect((gpointer
) menu_htmltoggle
, "activate",
766 G_CALLBACK(toggle_status
), NULL
);
768 menu_bulk_replace
= gtk_menu_item_new_with_mnemonic(
769 _("_Replace Characters in Selection"));
770 g_signal_connect((gpointer
) menu_bulk_replace
, "activate",
771 G_CALLBACK(replace_special_character_activated
), NULL
);
773 gtk_container_add(GTK_CONTAINER(main_menu_submenu
), menu_bulk_replace
);
775 ui_add_document_sensitive(main_menu
);
776 gtk_widget_show(menu_bulk_replace
);
777 gtk_widget_show(menu_htmltoggle
);
779 main_menu_item
= menu_item
;
781 /* setup keybindings */
782 keybindings_set_item(plugin_key_group
, KB_INSERT_HTML_CHARS
,
783 kb_activate
, 0, 0, "insert_html_chars",
784 _("Insert Special HTML Characters"), menu_item
);
785 keybindings_set_item(plugin_key_group
, KB_REPLACE_HTML_ENTITIES
,
786 kb_special_chars_replacement
, 0, 0, "replace_special_characters",
787 _("Replace special characters"), NULL
);
788 keybindings_set_item(plugin_key_group
, KB_HTMLTOGGLE_ACTIVE
,
789 kbhtmltoggle_toggle
, 0, 0, "htmltoogle_toggle_plugin_status",
790 _("Toggle plugin status"), menu_htmltoggle
);
794 /* Destroy widgets */
795 void plugin_cleanup(void)
797 gtk_widget_destroy(main_menu_item
);
798 gtk_widget_destroy(main_menu
);
800 if (sc_dialog
!= NULL
)
801 gtk_widget_destroy(sc_dialog
);
803 if (config_file
!= NULL
)