2012-10-21 15:02:20 -04:00
|
|
|
/*
|
2013-01-24 20:11:49 -05:00
|
|
|
* autocomplete.h
|
2019-11-13 06:11:05 -05:00
|
|
|
* vim: expandtab:ts=4:sts=4:sw=4
|
2012-05-13 16:40:39 -04:00
|
|
|
*
|
2019-01-22 05:31:45 -05:00
|
|
|
* Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
|
2012-10-21 15:02:20 -04:00
|
|
|
*
|
2012-05-13 16:40:39 -04:00
|
|
|
* This file is part of Profanity.
|
|
|
|
*
|
|
|
|
* Profanity is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* Profanity is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
2016-07-23 20:14:49 -04:00
|
|
|
* along with Profanity. If not, see <https://www.gnu.org/licenses/>.
|
2012-05-13 16:40:39 -04:00
|
|
|
*
|
2014-08-24 15:57:39 -04:00
|
|
|
* In addition, as a special exception, the copyright holders give permission to
|
|
|
|
* link the code of portions of this program with the OpenSSL library under
|
|
|
|
* certain conditions as described in each individual source file, and
|
|
|
|
* distribute linked combinations including the two.
|
|
|
|
*
|
|
|
|
* You must obey the GNU General Public License in all respects for all of the
|
|
|
|
* code used other than OpenSSL. If you modify file(s) with this exception, you
|
|
|
|
* may extend this exception to your version of the file(s), but you are not
|
|
|
|
* obligated to do so. If you do not wish to do so, delete this exception
|
|
|
|
* statement from your version. If you delete this exception statement from all
|
|
|
|
* source files in the program, then also delete it here.
|
|
|
|
*
|
2012-05-13 16:40:39 -04:00
|
|
|
*/
|
|
|
|
|
2016-07-24 09:51:39 -04:00
|
|
|
#ifndef TOOLS_AUTOCOMPLETE_H
|
|
|
|
#define TOOLS_AUTOCOMPLETE_H
|
2012-05-13 16:40:39 -04:00
|
|
|
|
|
|
|
#include <glib.h>
|
|
|
|
|
2020-01-30 17:44:43 -05:00
|
|
|
typedef char* (*autocomplete_func)(const char* const, gboolean, void*);
|
2013-01-24 20:11:49 -05:00
|
|
|
typedef struct autocomplete_t* Autocomplete;
|
2012-05-13 16:40:39 -04:00
|
|
|
|
2013-12-09 19:06:00 -05:00
|
|
|
// allocate new autocompleter with no items
|
2013-01-24 20:11:49 -05:00
|
|
|
Autocomplete autocomplete_new(void);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2013-12-09 19:06:00 -05:00
|
|
|
// Remove all items from the autocompleter
|
2013-01-24 20:11:49 -05:00
|
|
|
void autocomplete_clear(Autocomplete ac);
|
2013-12-09 19:06:00 -05:00
|
|
|
|
|
|
|
// free all memory used by the autocompleter
|
2013-01-24 20:11:49 -05:00
|
|
|
void autocomplete_free(Autocomplete ac);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2013-12-09 18:51:13 -05:00
|
|
|
void autocomplete_add(Autocomplete ac, const char* item);
|
2016-07-05 16:46:36 -04:00
|
|
|
void autocomplete_add_all(Autocomplete ac, char** items);
|
2019-07-13 13:08:10 -04:00
|
|
|
void autocomplete_update(Autocomplete ac, char** items);
|
2015-10-25 18:47:42 -04:00
|
|
|
void autocomplete_remove(Autocomplete ac, const char* const item);
|
2016-07-05 16:46:36 -04:00
|
|
|
void autocomplete_remove_all(Autocomplete ac, char** items);
|
2023-02-13 16:40:58 -05:00
|
|
|
void autocomplete_add_unsorted(Autocomplete ac, const char* item, const gboolean is_reversed);
|
2013-12-09 19:06:00 -05:00
|
|
|
|
|
|
|
// find the next item prefixed with search string
|
2017-03-31 19:27:11 -04:00
|
|
|
gchar* autocomplete_complete(Autocomplete ac, const gchar* search_str, gboolean quote, gboolean previous);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2017-03-31 19:27:11 -04:00
|
|
|
GList* autocomplete_create_list(Autocomplete ac);
|
2013-04-24 18:50:47 -04:00
|
|
|
gint autocomplete_length(Autocomplete ac);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2015-10-25 18:47:42 -04:00
|
|
|
char* autocomplete_param_with_func(const char* const input, char* command,
|
2020-01-30 17:44:43 -05:00
|
|
|
autocomplete_func func, gboolean previous, void* context);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2015-10-25 18:47:42 -04:00
|
|
|
char* autocomplete_param_with_ac(const char* const input, char* command,
|
2017-03-31 19:27:11 -04:00
|
|
|
Autocomplete ac, gboolean quote, gboolean previous);
|
2013-12-09 18:53:52 -05:00
|
|
|
|
2015-10-25 18:47:42 -04:00
|
|
|
char* autocomplete_param_no_with_func(const char* const input, char* command,
|
2020-01-30 17:44:43 -05:00
|
|
|
int arg_number, autocomplete_func func, gboolean previous, void* context);
|
2012-05-13 16:40:39 -04:00
|
|
|
|
2013-12-09 19:06:00 -05:00
|
|
|
void autocomplete_reset(Autocomplete ac);
|
2014-01-24 20:39:12 -05:00
|
|
|
|
2014-02-01 20:05:52 -05:00
|
|
|
gboolean autocomplete_contains(Autocomplete ac, const char* value);
|
2020-05-20 04:26:48 -04:00
|
|
|
|
2020-05-29 05:26:18 -04:00
|
|
|
void autocomplete_remove_older_than_max_reverse(Autocomplete ac, int maxsize);
|
2012-05-13 16:40:39 -04:00
|
|
|
#endif
|