Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

projectorganizer: Use the word "symbol" instead of "tag" #351

Merged
merged 2 commits into from
Feb 18, 2016
Merged

projectorganizer: Use the word "symbol" instead of "tag" #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d65e1f
projectorganizer: Use the word "symbol" instead of "tag"
techee Feb 17, 2016
050199a
projectorganizer: Fix documentation regarding the number of auto-pars…
techee Feb 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions projectorganizer/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ About

Project Organizer is an extension of Geany's project management displaying a tree of
files belonging to the project in the sidebar. In addition, it enables complete indexing
of the project files (and having code completion, syntax highlighting and tag
of the project files (and having code completion, syntax highlighting and symbol
definition/declaration jumps for the whole project) quick swapping between header
and source files, improved opening of includes, searching project files by name
and more. External directories can be attached to the project to extend the plugin's
Expand Down Expand Up @@ -93,12 +93,12 @@ In addition, you can define patterns for files and directories that should be ig
searching for files belonging to the project. These will typically be various binary
files and VCS or hidden directories.

Finally, you can specify whether the tag manager should be used to index all the project
files or not. The default settings is Auto which means that if the total number
of project (and external directory) files is less than 500, tags are generated.
Finally, you can specify whether all the project files should be indexed or not.
The default settings is Auto which means that if the total number
of project (and external directory) files is less than 300, indexing is performed.
This is a rather conservative number, at least for an SSD disk - Project Organizer
was tested with tens of thousands project files and even though the initial scanning
may take some time (for the linux kernel with 35000 files and 2300000 tags it takes
may take some time (for the linux kernel with 35000 files and 2300000 symbols it takes
about 20s with an SSD disk), the work with the project is completely normal afterwards.
However, with ordinary HDD expect only around 100 scanned files per second because
of slow random access time.
Expand All @@ -116,21 +116,21 @@ files. When a sidebar item is right-clicked, a context menu appears:
to the clicked directory
* Find file - opens the Find file dialog and sets the search directory to the
clicked directory
* Find tag - opens the Find tag dialog and sets the search directory to the
* Find symbol - opens the Find symbol dialog and sets the search directory to the
clicked directory
* Remove external directory - removes a previously added external directory from
the project

The following actions can be invoked from the sidebar's toolbar:

* Reload all - reloads the project file tree and reindexes the files (if tag generation
* Reload all - reloads the project file tree and reindexes the files (if symbol generation
enabled). This is useful when files were added, modified externally or removed from
the project.
* Add external directory - adds an additional directory related to the project (e.g.
it is useful to have the geany project as an external directory for the geany-plugins
project). External directories are indexed using the tag manager, and basically
project). External directories are indexed, and basically
all Project Organizer features work with external directories too (find file or
find in files from the context menu, swap header/source, open selected file, tag
find in files from the context menu, swap header/source, open selected file, symbol
definition/declaration jumps, and active editor following). Apart from adding related
projects, one of the possible uses is the addition of system header directories,
e.g. /usr/include/gtk-2.0, and having them indexed for code completion and syntax
Expand All @@ -150,7 +150,7 @@ Project Organizer adds some extra entries under the Project menu:
to the base directory of the project
* Find Project File - opens the Find file dialog which can be used to find files
within the project or external directories
* Find Project Tag - opens the Find tag dialog which can be used to find tags
* Find Project Symbol - opens the Find symbol dialog which can be used to find symbols
within the project or external directories
* Swap Header/Source - if the current file matches one of the source patterns from
the properties, it opens a project file with the same base name (without extension)
Expand All @@ -172,18 +172,18 @@ The following search properties are configurable:
* Search in full path - when not checked, the search is performed in the file
name only (excluding path); when checked, the search is performed in the full path

Find tag dialog
Find symbol dialog
----------------

The Find tag dialog can be invoked either from the Project menu or from the
The Find symbol dialog can be invoked either from the Project menu or from the
sidebar's context menu. Searches are performed within the "Search inside" directory.
There are several search types:

* prefix (default) - finds all tags with the specified prefix
* exact - finds all tags matching the name exactly
* pattern - finds all tags matching the provided glob pattern
* prefix (default) - finds all symbols with the specified prefix
* exact - finds all symbols matching the name exactly
* pattern - finds all symbols matching the provided glob pattern

By default, tag definitions are searched; to search tag declarations, select the
By default, symbol definitions are searched; to search symbol declarations, select the
Declaration option.

Editor context menu
Expand Down
4 changes: 2 additions & 2 deletions projectorganizer/src/prjorg-menu.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,13 +403,13 @@ void prjorg_menu_init(void)

image = gtk_image_new_from_stock(GTK_STOCK_FIND, GTK_ICON_SIZE_MENU);
gtk_widget_show(image);
s_ft_item = gtk_image_menu_item_new_with_mnemonic(_("Find Project Tag..."));
s_ft_item = gtk_image_menu_item_new_with_mnemonic(_("Find Project Symbol..."));
gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(s_ft_item), image);
gtk_widget_show(s_ft_item);
gtk_container_add(GTK_CONTAINER(geany->main_widgets->project_menu), s_ft_item);
g_signal_connect((gpointer) s_ft_item, "activate", G_CALLBACK(on_find_tag), NULL);
keybindings_set_item(key_group, KB_FIND_TAG, NULL,
0, 0, "find_tag", _("Find project tag"), s_ft_item);
0, 0, "find_tag", _("Find project symbol"), s_ft_item);

s_shs_item = gtk_menu_item_new_with_mnemonic(_("Swap Header/Source"));
gtk_widget_show(s_shs_item);
Expand Down
6 changes: 3 additions & 3 deletions projectorganizer/src/prjorg-project.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,16 +620,16 @@ gint prjorg_project_add_properties_tab(GtkWidget *notebook)
gtk_entry_set_text(GTK_ENTRY(e->ignored_dirs_patterns), str);
g_free(str);

label = gtk_label_new(_("Generate tags for all project files:"));
label = gtk_label_new(_("Index all project files:"));
gtk_misc_set_alignment(GTK_MISC(label), 0, 0);
e->generate_tag_prefs = gtk_combo_box_text_new();
gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(e->generate_tag_prefs), _("Auto (generate if less than 300 files)"));
gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(e->generate_tag_prefs), _("Auto (index if less than 300 files)"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, it says 300 here, but 500 in the docs.

gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(e->generate_tag_prefs), _("Yes"));
gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(e->generate_tag_prefs), _("No"));
gtk_combo_box_set_active(GTK_COMBO_BOX(e->generate_tag_prefs), prj_org->generate_tag_prefs);
ui_table_add_row(GTK_TABLE(table), 4, label, e->generate_tag_prefs, NULL);
ui_widget_set_tooltip_text(e->generate_tag_prefs,
_("Generate tag list for all project files instead of only for the currently opened files. "
_("Generate symbol list for all project files instead of only for the currently opened files. "
"Might be slow for big projects."));

gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 6);
Expand Down
4 changes: 2 additions & 2 deletions projectorganizer/src/prjorg-sidebar.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ static void create_dialog_find_tag(void)
return;

s_ft_dialog.widget = gtk_dialog_new_with_buttons(
_("Find Tag"), GTK_WINDOW(geany->main_widgets->window),
_("Find Symbol"), GTK_WINDOW(geany->main_widgets->window),
GTK_DIALOG_DESTROY_WITH_PARENT,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL, NULL);
gtk_dialog_add_button(GTK_DIALOG(s_ft_dialog.widget), "gtk-find", GTK_RESPONSE_ACCEPT);
Expand Down Expand Up @@ -1389,7 +1389,7 @@ void prjorg_sidebar_init(void)

image = gtk_image_new_from_stock(GTK_STOCK_FIND, GTK_ICON_SIZE_MENU);
gtk_widget_show(image);
item = gtk_image_menu_item_new_with_mnemonic(_("Find Tag..."));
item = gtk_image_menu_item_new_with_mnemonic(_("Find Symbol..."));
gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(item), image);
gtk_widget_show(item);
gtk_container_add(GTK_CONTAINER(s_popup_menu.widget), item);
Expand Down