rewtguy/pidgin

Collapsed revision
draft history-api tip
2021-10-08, Gary Kramlich
00e6f98b4243
Collapsed revision
* Bootstrap the PurpleHistoryAdapter class
* HistoryApi - added name property and added write, query, remove methods
* Fix minor issues in purplehistoryadapter.
* Add unit tests for purple_history_adapter. Initial scaffolding for purple_history_manager.
* Add history manager. Start of adding unit tests for history manager. Slight modification of formatting of test_histroy_adapter. Add classes to POTFILES.in.
* Updates to history manager and unit tests
* Add test_purple_history_manager.c
* Fixed history manager and unit tests. Should be in a better state now.
* Fixed missing curly brace in history manager.
* Made changes to purplehistorymanager.h documentation.
* Add a dependency on sqlite3. 3.27.0 is kind of an arbitrary version we can adjust if necessary.
* Update _purple_conversation_write_common to use the history api.
* Initial implementation of purplesqlitehistoryadapter
* Add in activate and deactivate for purplesqlitehistoryadapter
* Embed our sqlite history schema into libpurple and run it during startup
* Implement shutdown in purplehistorymanager, implement write in purplesqlitehistoryadapter, modify schema for history adapter.
* Finish purplesqlitehistoryadapter write functionality. Changed api to include PurpleConversation.
* History API - flushed out sqlite query builder, query, and remove.
* Create a stub purple-history command line tool
* Add a simple cli for the history api and fix a few bugs
* Fixed signatures for query and remove
* Fixed memory leaks in sqlite history adapter
* Add remove function in purplehistorycore and update unit test for history adapter
* Fixed purple history core not printing results from query
* Addressed PR comments
* Add additional docs, fixed error messages, finished implementing query in purple history.
* Addressed PR comments. Fixed style, some objects weren't being dereferenced but now are, fixed issues in documentation.
* Fixed docs, grouped sqlite3 dependency check with libpurple, enabled g_option set help for history core.
* Fixed style issues. Fixed unfreed references. Add in checks against empty strings for sqlite adapter. Fixed documentation.
* Address PR comments. Fixed incorrect parameters in activate signal. Fix some styling problems. Removed unnecessary frees. Fixed compiler warnings.
* Address additional PR comments for history adapter.
* Address review findings
* Fix up the unit tests
/*
* finch
*
* Finch is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
# error "only <finch.h> may be included directly"
#endif
#ifndef FINCH_PLUGIN_H
#define FINCH_PLUGIN_H
/**
* SECTION:gntplugin
* @section_id: finch-gntplugin
* @short_description: <filename>gntplugin.h</filename>
* @title: Plugin API
*/
#include <gnt.h>
#include <purple.h>
#include <string.h>
#define FINCH_TYPE_PLUGIN_INFO (finch_plugin_info_get_type())
#define FINCH_PLUGIN_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfo))
#define FINCH_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
#define FINCH_IS_PLUGIN_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), FINCH_TYPE_PLUGIN_INFO))
#define FINCH_IS_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), FINCH_TYPE_PLUGIN_INFO))
#define FINCH_PLUGIN_INFO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
typedef struct _FinchPluginInfo FinchPluginInfo;
typedef struct _FinchPluginInfoClass FinchPluginInfoClass;
typedef GntWidget* (*FinchPluginPrefFrameCb) (void);
/**
* FinchPluginInfo:
*
* Extends #PurplePluginInfo to hold UI information for finch.
*/
struct _FinchPluginInfo {
PurplePluginInfo parent;
};
/**
* FinchPluginInfoClass:
*
* The base class for all #FinchPluginInfo's.
*/
struct _FinchPluginInfoClass {
PurplePluginInfoClass parent_class;
/*< private >*/
void (*_gnt_reserved1)(void);
void (*_gnt_reserved2)(void);
void (*_gnt_reserved3)(void);
void (*_gnt_reserved4)(void);
};
/**********************************************************************
* Plugin Info API
**********************************************************************/
/**
* finch_plugin_info_get_type:
*
* Returns: The #GType for the #FinchPluginInfo object.
*/
GType finch_plugin_info_get_type(void);
/**
* finch_plugin_info_new:
* @first_property: The first property name
* @...: The value of the first property, followed optionally by more
* name/value pairs, followed by %NULL
*
* Creates a new #FinchPluginInfo instance to be returned from
* #plugin_query of a finch plugin, using the provided name/value
* pairs.
*
* See purple_plugin_info_new() for a list of available property names.
* Additionally, you can provide the property
* <literal>"gnt-pref-frame-cb"</literal>, which should be a callback that
* returns a #GntWidget for the plugin's preferences
* (see #FinchPluginPrefFrameCb).
*
* See purple_plugin_info_new().
*
* Returns: A new #FinchPluginInfo instance.
*/
GPluginPluginInfo *finch_plugin_info_new(const char *first_property, ...) G_GNUC_NULL_TERMINATED;
/**********************************************************************
* GNT Plugins API
**********************************************************************/
/**
* finch_plugins_show_all:
*
* Show a list of plugins.
*/
void finch_plugins_show_all(void);
/**
* finch_plugins_save_loaded:
*
* Save the list of loaded plugins.
*/
void finch_plugins_save_loaded(void);
#endif /* FINCH_PLUGIN_H */