girara
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
completion.c
Go to the documentation of this file.
1 /* See LICENSE file for license and copyright information */
2 
3 #include <math.h>
4 #include <string.h>
5 #include <stdlib.h>
6 
7 #include "completion.h"
8 #include "internal.h"
9 #include "session.h"
10 #include "settings.h"
11 #include "datastructures.h"
12 #include "utils.h"
13 
14 static GtkEventBox* girara_completion_row_create(const char*, const char*, bool);
15 static void girara_completion_row_set_color(girara_session_t*, GtkEventBox*, int);
16 
17 /* completion */
19 {
20  bool group;
21  char* value;
22  GtkEventBox* widget;
23 };
24 
29 {
30  char *value;
31  char *description;
32 };
33 
38 {
39  char *value;
40  girara_list_t *elements;
41 };
42 
47 {
48  girara_list_t *groups;
49 };
50 
51 typedef struct girara_internal_completion_entry_s girara_internal_completion_entry_t;
52 
53 static void
54 completion_element_free(girara_completion_element_t* element)
55 {
56  if (element == NULL) {
57  return;
58  }
59 
60  /* free element */
61  g_free(element->value);
62  g_free(element->description);
63  g_slice_free(girara_completion_element_t, element);
64 }
65 
66 girara_completion_t*
68 {
69  girara_completion_t *completion = g_slice_new(girara_completion_t);
70  completion->groups = girara_list_new2(
72 
73  return completion;
74 }
75 
76 girara_completion_group_t*
77 girara_completion_group_create(girara_session_t* UNUSED(session), const char* name)
78 {
79  girara_completion_group_t* group = g_slice_new(girara_completion_group_t);
80 
81  group->value = name ? g_strdup(name) : NULL;
82  group->elements = girara_list_new2(
83  (girara_free_function_t) completion_element_free);
84 
85  if (group->elements == NULL) {
86  g_slice_free(girara_completion_group_t, group);
87  return NULL;
88  }
89 
90  return group;
91 }
92 
93 void
94 girara_completion_add_group(girara_completion_t* completion, girara_completion_group_t* group)
95 {
96  g_return_if_fail(completion != NULL);
97  g_return_if_fail(group != NULL);
98 
99  girara_list_append(completion->groups, group);
100 }
101 
102 void
103 girara_completion_group_free(girara_completion_group_t* group)
104 {
105  if (group == NULL) {
106  return;
107  }
108 
109  g_free(group->value);
110  girara_list_free(group->elements);
111  g_slice_free(girara_completion_group_t, group);
112 }
113 
114 void
115 girara_completion_free(girara_completion_t* completion)
116 {
117  g_return_if_fail(completion != NULL);
118 
119  girara_list_free(completion->groups);
120  /* free completion */
121  g_slice_free(girara_completion_t, completion);
122 }
123 
124 void
125 girara_completion_group_add_element(girara_completion_group_t* group, const char* name, const char* description)
126 {
127  g_return_if_fail(group != NULL);
128  g_return_if_fail(name != NULL);
129 
130  girara_completion_element_t* new_element = g_slice_new(girara_completion_element_t);
131 
132  new_element->value = g_strdup(name);
133  new_element->description = description ? g_strdup(description) : NULL;
134 
135  girara_list_append(group->elements, new_element);
136 }
137 
138 bool
139 girara_isc_completion(girara_session_t* session, girara_argument_t* argument, girara_event_t* UNUSED(event), unsigned int UNUSED(t))
140 {
141  g_return_val_if_fail(session != NULL, false);
142 
143  /* get current text */
144  gchar *input = gtk_editable_get_chars(GTK_EDITABLE(session->gtk.inputbar_entry), 0, -1);
145  if (input == NULL) {
146  return false;
147  }
148 
149  const size_t input_length = strlen(input);
150 
151  if (input_length == 0 || input[0] != ':') {
152  g_free(input);
153  return false;
154  }
155 
156  gchar** elements = NULL;
157  gint n_parameter = 0;
158  if (input_length > 1) {
159  if (g_shell_parse_argv(input + 1, &n_parameter, &elements, NULL) == FALSE) {
160  g_free(input);
161  return false;
162  }
163  } else {
164  elements = g_try_malloc0(2 * sizeof(char*));
165  if (elements == NULL) {
166  g_free(input);
167  return false;
168  }
169  elements[0] = g_strdup("");
170  }
171 
172  if (n_parameter == 1 && input[input_length-1] == ' ') {
173  n_parameter += 1;
174  }
175 
176  g_free(input);
177 
178  /* get current values */
179  gchar *current_command = (elements[0] != NULL && elements[0][0] != '\0') ? g_strdup(elements[0]) : NULL;
180  gchar *current_parameter = (elements[0] != NULL && elements[1] != NULL) ? g_strdup(elements[1]) : NULL;
181 
182  size_t current_command_length = current_command ? strlen(current_command) : 0;
183 
184  static GList* entries = NULL;
185  static GList* entries_current = NULL;
186  static char *previous_command = NULL;
187  static char *previous_parameter = NULL;
188  static bool command_mode = true;
189  static size_t previous_length = 0;
190 
191  /* delete old list iff
192  * the completion should be hidden
193  * the current command differs from the previous one
194  * the current parameter differs from the previous one
195  * no current command is given
196  */
197  if ( (argument->n == GIRARA_HIDE) ||
198  (current_parameter && previous_parameter && strcmp(current_parameter, previous_parameter)) ||
199  (current_command && previous_command && strcmp(current_command, previous_command)) ||
200  input_length != previous_length
201  )
202  {
203  if (session->gtk.results != NULL) {
204  /* destroy elements */
205  for (GList* element = entries; element; element = g_list_next(element)) {
206  girara_internal_completion_entry_t* entry = (girara_internal_completion_entry_t*) element->data;
207 
208  if (entry != NULL) {
209  gtk_widget_destroy(GTK_WIDGET(entry->widget));
210  g_free(entry->value);
211  g_slice_free(girara_internal_completion_entry_t, entry);
212  }
213  }
214 
215  g_list_free(entries);
216  entries = NULL;
217  entries_current = NULL;
218 
219  /* delete row box */
220  gtk_widget_destroy(GTK_WIDGET(session->gtk.results));
221  session->gtk.results = NULL;
222  }
223 
224  command_mode = true;
225 
226  if (argument->n == GIRARA_HIDE) {
227  g_free(previous_command);
228  previous_command = NULL;
229 
230  g_free(previous_parameter);
231  previous_parameter = NULL;
232 
233  g_strfreev(elements);
234 
235  g_free(current_command);
236  g_free(current_parameter);
237 
238  return false;
239  }
240  }
241 
242  /* create new list iff
243  * there is no current list
244  */
245  if (session->gtk.results == NULL) {
246  session->gtk.results = GTK_BOX(gtk_box_new(GTK_ORIENTATION_VERTICAL, 0));
247  widget_add_class(GTK_WIDGET(session->gtk.results), "completion-box");
248 
249  if (session->gtk.results == NULL) {
250  g_free(current_command);
251  g_free(current_parameter);
252 
253  g_strfreev(elements);
254  return false;
255  }
256 
257  if (n_parameter <= 1) {
258  /* based on commands */
259  command_mode = true;
260 
261  /* create command rows */
262  GIRARA_LIST_FOREACH(session->bindings.commands, girara_command_t*, iter, command)
263  if (current_command == NULL ||
264  (command->command != NULL && !strncmp(current_command, command->command, current_command_length)) ||
265  (command->abbr != NULL && !strncmp(current_command, command->abbr, current_command_length))
266  )
267  {
268  /* create entry */
269  girara_internal_completion_entry_t* entry = g_slice_new(girara_internal_completion_entry_t);
270  entry->group = FALSE;
271  entry->value = g_strdup(command->command);
272  entry->widget = girara_completion_row_create(command->command, command->description, FALSE);
273 
274  entries = g_list_append(entries, entry);
275 
276  /* show entry row */
277  gtk_box_pack_start(session->gtk.results, GTK_WIDGET(entry->widget), FALSE, FALSE, 0);
278  }
279  GIRARA_LIST_FOREACH_END(session->bindings.commands, girara_command_t*, iter, command);
280  }
281 
282  /* based on parameters */
283  if (n_parameter > 1 || g_list_length(entries) == 1) {
284  /* if only one command exists try to run parameter completion */
285  if (g_list_length(entries) == 1) {
286  girara_internal_completion_entry_t* entry = g_list_first(entries)->data;
287 
288  /* unset command mode */
289  command_mode = false;
290  current_command = entry->value;
291  current_command_length = strlen(current_command);
292 
293  /* clear list */
294  gtk_widget_destroy(GTK_WIDGET(entry->widget));
295 
296  entries = g_list_remove(entries, g_list_first(entries)->data);
297  g_slice_free(girara_internal_completion_entry_t, entry);
298  }
299 
300  /* search matching command */
301  girara_command_t* command = NULL;
302  GIRARA_LIST_FOREACH(session->bindings.commands, girara_command_t*, iter, command_it)
303  if ( (current_command != NULL && command_it->command != NULL && !strncmp(current_command, command_it->command, current_command_length)) ||
304  (current_command != NULL && command_it->abbr != NULL && !strncmp(current_command, command_it->abbr, current_command_length))
305  )
306  {
307  g_free(previous_command);
308  previous_command = g_strdup(command_it->command);
309  command = command_it;
310  break;
311  }
312  GIRARA_LIST_FOREACH_END(session->bindings.commands, girara_command_t*, iter, command_it);
313 
314  if (command == NULL) {
315  g_free(current_command);
316  g_free(current_parameter);
317 
318  g_strfreev(elements);
319  return false;
320  }
321 
322  if (command->completion == NULL) {
323  girara_internal_completion_entry_t* entry = g_slice_new(girara_internal_completion_entry_t);
324  entry->group = FALSE;
325  entry->value = g_strdup(command->command);
326  entry->widget = girara_completion_row_create(command->command, command->description, FALSE);
327 
328  entries = g_list_append(entries, entry);
329 
330  gtk_box_pack_start(session->gtk.results, GTK_WIDGET(entry->widget), FALSE, FALSE, 0);
331  command_mode = true;
332  } else {
333  /* generate completion result
334  * XXX: the last argument should only be current_paramater ... but
335  * therefore the completion functions would need to handle NULL correctly
336  * (see cc_open in zathura). */
337  girara_completion_t *result = command->completion(session, current_parameter ? current_parameter : "");
338 
339  if (result == NULL || result->groups == NULL) {
340  g_free(current_command);
341  g_free(current_parameter);
342 
343  g_strfreev(elements);
344  return false;
345  }
346 
347  GIRARA_LIST_FOREACH(result->groups, girara_completion_group_t*, iter, group)
348  /* create group entry */
349  if (group->value != NULL) {
350  girara_internal_completion_entry_t* entry = g_slice_new(girara_internal_completion_entry_t);
351  entry->group = TRUE;
352  entry->value = g_strdup(group->value);
353  entry->widget = girara_completion_row_create(group->value, NULL, TRUE);
354 
355  entries = g_list_append(entries, entry);
356 
357  gtk_box_pack_start(session->gtk.results, GTK_WIDGET(entry->widget), FALSE, FALSE, 0);
358  }
359 
360  GIRARA_LIST_FOREACH(group->elements, girara_completion_element_t*, iter2, element)
361  girara_internal_completion_entry_t* entry = g_slice_new(girara_internal_completion_entry_t);
362  entry->group = FALSE;
363  entry->value = g_strdup(element->value);
364  entry->widget = girara_completion_row_create(element->value, element->description, FALSE);
365 
366  entries = g_list_append(entries, entry);
367 
368  gtk_box_pack_start(session->gtk.results, GTK_WIDGET(entry->widget), FALSE, FALSE, 0);
369 
370  GIRARA_LIST_FOREACH_END(group->elements, girara_completion_element_t*, iter2, element);
371  GIRARA_LIST_FOREACH_END(result->groups, girara_completion_group_t*, iter, group);
372  girara_completion_free(result);
373 
374  command_mode = false;
375  }
376  }
377 
378  if (entries != NULL) {
379  entries_current = (argument->n == GIRARA_NEXT) ? g_list_last(entries) : entries;
380  gtk_box_pack_start(session->private_data->gtk.bottom_box, GTK_WIDGET(session->gtk.results), FALSE, FALSE, 0);
381  gtk_widget_show(GTK_WIDGET(session->gtk.results));
382  }
383  }
384 
385  /* update entries */
386  unsigned int n_elements = g_list_length(entries);
387  if (entries != NULL && n_elements > 0) {
388  if (n_elements > 1) {
389  girara_completion_row_set_color(session, ((girara_internal_completion_entry_t *) entries_current->data)->widget, GIRARA_NORMAL);
390 
391  bool next_group = FALSE;
392 
393  for (unsigned int i = 0; i < n_elements; i++) {
394  if (argument->n == GIRARA_NEXT || argument->n == GIRARA_NEXT_GROUP) {
395  GList* entry = g_list_next(entries_current);
396  if (entry == NULL) {
397  entry = g_list_first(entries);
398  }
399 
400  entries_current = entry;
401  } else if (argument->n == GIRARA_PREVIOUS || argument->n == GIRARA_PREVIOUS_GROUP) {
402  GList* entry = g_list_previous(entries_current);
403  if (entry == NULL) {
404  entry = g_list_last(entries);
405  }
406 
407  entries_current = entry;
408  }
409 
410  if (((girara_internal_completion_entry_t*) entries_current->data)->group) {
411  if (command_mode == false && (argument->n == GIRARA_NEXT_GROUP || argument->n == GIRARA_PREVIOUS_GROUP)) {
412  next_group = TRUE;
413  }
414  continue;
415  } else {
416  if (command_mode == false && (next_group == 0) && (argument->n == GIRARA_NEXT_GROUP || argument->n == GIRARA_PREVIOUS_GROUP)) {
417  continue;
418  }
419  break;
420  }
421  }
422 
423  girara_completion_row_set_color(session, ((girara_internal_completion_entry_t *) entries_current->data)->widget, GIRARA_HIGHLIGHT);
424 
425  /* hide other items */
426  unsigned int n_completion_items = 15;
427  girara_setting_get(session, "n-completion-items", &n_completion_items);
428  unsigned int uh = ceil( n_completion_items / 2);
429  unsigned int lh = floor(n_completion_items / 2);
430 
431  unsigned int current_item = g_list_position(entries, entries_current);
432 
433  GList* tmpentry = entries;
434  for (unsigned int i = 0; i < n_elements; i++) {
435  if (
436  (i >= (current_item - lh) && (i <= current_item + uh)) ||
437  (i < n_completion_items && current_item < lh) ||
438  (i >= (n_elements - n_completion_items) && (current_item >= (n_elements - uh)))
439  )
440  {
441  gtk_widget_show(GTK_WIDGET(((girara_internal_completion_entry_t*) tmpentry->data)->widget));
442  } else {
443  gtk_widget_hide(GTK_WIDGET(((girara_internal_completion_entry_t*) tmpentry->data)->widget));
444  }
445 
446  tmpentry = g_list_next(tmpentry);
447  }
448  } else {
449  gtk_widget_hide(GTK_WIDGET(((girara_internal_completion_entry_t*) (g_list_nth(entries, 0))->data)->widget));
450  }
451 
452  /* update text */
453  char* temp;
454  char* escaped_value = girara_escape_string(((girara_internal_completion_entry_t *) entries_current->data)->value);
455  if (command_mode == true) {
456  char* space = (n_elements == 1) ? " " : "";
457  temp = g_strconcat(":", escaped_value, space, NULL);
458  } else {
459  temp = g_strconcat(":", previous_command, " ", escaped_value, NULL);
460  }
461 
462  gtk_entry_set_text(session->gtk.inputbar_entry, temp);
463  gtk_editable_set_position(GTK_EDITABLE(session->gtk.inputbar_entry), -1);
464  g_free(escaped_value);
465 
466  /* update previous */
467  g_free(previous_command);
468  g_free(previous_parameter);
469  previous_command = g_strdup((command_mode) ? ((girara_internal_completion_entry_t*) entries_current->data)->value : current_command);
470  previous_parameter = g_strdup((command_mode) ? current_parameter : ((girara_internal_completion_entry_t*) entries_current->data)->value);
471  previous_length = strlen(temp);
472  g_free(temp);
473  }
474 
475  g_free(current_command);
476  g_free(current_parameter);
477 
478  g_strfreev(elements);
479 
480  return false;
481 }
482 
483 static GtkEventBox*
484 girara_completion_row_create(const char* command, const char* description, bool group)
485 {
486  GtkBox *col = GTK_BOX(gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0));
487 
488  GtkEventBox *row = GTK_EVENT_BOX(gtk_event_box_new());
489 
490  GtkLabel *show_command = GTK_LABEL(gtk_label_new(NULL));
491  GtkLabel *show_description = GTK_LABEL(gtk_label_new(NULL));
492 
493  gtk_misc_set_alignment(GTK_MISC(show_command), 0.0, 0.0);
494  gtk_misc_set_alignment(GTK_MISC(show_description), 1.0, 0.0);
495 
496  gtk_label_set_use_markup(show_command, TRUE);
497  gtk_label_set_use_markup(show_description, TRUE);
498 
499  gtk_label_set_ellipsize(show_command, PANGO_ELLIPSIZE_END);
500  gtk_label_set_ellipsize(show_description, PANGO_ELLIPSIZE_END);
501 
502  gchar* c = g_markup_printf_escaped(FORMAT_COMMAND, command ? command : "");
503  gchar* d = g_markup_printf_escaped(FORMAT_DESCRIPTION, description ? description : "");
504  gtk_label_set_markup(show_command, c);
505  gtk_label_set_markup(show_description, d);
506  g_free(c);
507  g_free(d);
508 
509  const char* class = group == true ? "completion-group" : "completion";
510  widget_add_class(GTK_WIDGET(show_command), class);
511  widget_add_class(GTK_WIDGET(show_description), class);
512  widget_add_class(GTK_WIDGET(row), class);
513 
514  gtk_box_pack_start(GTK_BOX(col), GTK_WIDGET(show_command), TRUE, TRUE, 0);
515  gtk_box_pack_start(GTK_BOX(col), GTK_WIDGET(show_description), TRUE, TRUE, 0);
516 
517  gtk_container_add(GTK_CONTAINER(row), GTK_WIDGET(col));
518  gtk_widget_show_all(GTK_WIDGET(row));
519 
520  return row;
521 }
522 
523 static void
524 girara_completion_row_set_color(girara_session_t* session, GtkEventBox* row, int mode)
525 {
526  g_return_if_fail(session != NULL);
527  g_return_if_fail(row != NULL);
528 
529  GtkBox* col = GTK_BOX(gtk_bin_get_child(GTK_BIN(row)));
530  GList* items = gtk_container_get_children(GTK_CONTAINER(col));
531  GtkWidget* cmd = GTK_WIDGET(g_list_nth_data(items, 0));
532  GtkWidget* desc = GTK_WIDGET(g_list_nth_data(items, 1));
533 
534  if (mode == GIRARA_HIGHLIGHT) {
535  gtk_widget_set_state_flags(cmd, GTK_STATE_FLAG_SELECTED, false);
536  gtk_widget_set_state_flags(desc, GTK_STATE_FLAG_SELECTED, false);
537  gtk_widget_set_state_flags(GTK_WIDGET(row), GTK_STATE_FLAG_SELECTED, false);
538  } else {
539  gtk_widget_unset_state_flags(cmd, GTK_STATE_FLAG_SELECTED);
540  gtk_widget_unset_state_flags(desc, GTK_STATE_FLAG_SELECTED);
541  gtk_widget_unset_state_flags(GTK_WIDGET(row), GTK_STATE_FLAG_SELECTED);
542  }
543 
544  g_list_free(items);
545 }
void girara_completion_group_free(girara_completion_group_t *group)
Definition: completion.c:103
void girara_list_append(girara_list_t *list, void *data)
void(* girara_free_function_t)(void *data)
Definition: types.h:118
#define UNUSED(x)
Definition: internal.h:15
girara_list_t * girara_list_new2(girara_free_function_t gfree)
#define FORMAT_DESCRIPTION
Definition: internal.h:13
girara_completion_t * girara_completion_init()
Definition: completion.c:67
Definition: completion.c:18
void girara_list_free(girara_list_t *list)
girara_list_t * groups
Definition: completion.c:48
bool girara_isc_completion(girara_session_t *session, girara_argument_t *argument, girara_event_t *UNUSED(event), unsigned int UNUSED(t))
Definition: completion.c:139
#define FORMAT_COMMAND
Definition: internal.h:12
void girara_completion_add_group(girara_completion_t *completion, girara_completion_group_t *group)
Definition: completion.c:94
char * value
Definition: completion.c:21
HIDDEN void widget_add_class(GtkWidget *widget, const char *styleclass)
Definition: utils.c:528
void girara_completion_group_add_element(girara_completion_group_t *group, const char *name, const char *description)
Definition: completion.c:125
bool girara_setting_get(girara_session_t *session, const char *name, void *dest)
Definition: settings.c:140
bool group
Definition: completion.c:20
void girara_completion_free(girara_completion_t *completion)
Definition: completion.c:115
GtkEventBox * widget
Definition: completion.c:22
girara_list_t * elements
Definition: completion.c:40
char * girara_escape_string(const char *value)
Definition: utils.c:421
girara_completion_group_t * girara_completion_group_create(girara_session_t *UNUSED(session), const char *name)
Definition: completion.c:77
#define GIRARA_LIST_FOREACH_END(list, type, iter, data)
#define GIRARA_LIST_FOREACH(list, type, iter, data)