<commit_before>/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2009 Collabora Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Authors: <NAME> <<EMAIL>>
 */

#ifndef __TPL_LOG_ENTRY_H__
#define __TPL_LOG_ENTRY_H__

#include <glib-object.h>

#include <telepathy-logger/contact.h>

G_BEGIN_DECLS
#define TPL_TYPE_LOG_ENTRY (tpl_log_entry_get_type ())
#define TPL_LOG_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TPL_TYPE_LOG_ENTRY, TplLogEntry))
#define TPL_LOG_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TPL_TYPE_LOG_ENTRY, TplLogEntryClass))
#define TPL_IS_LOG_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TPL_TYPE_LOG_ENTRY))
#define TPL_IS_LOG_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TPL_TYPE_LOG_ENTRY))
#define TPL_LOG_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TPL_TYPE_LOG_ENTRY, TplLogEntryClass))

#define TPL_LOG_ENTRY_MSG_ID_IS_VALID(msg) (msg >= 0)

#define TPL_LOG_ENTRY_MSG_ID_UNKNOWN -2

#define TPL_LOG_ENTRY_MSG_ID_ACKNOWLEDGED -1

typedef enum
{
  TPL_LOG_ENTRY_DIRECTION_NONE = 0,

  TPL_LOG_ENTRY_DIRECTION_IN,
  TPL_LOG_ENTRY_DIRECTION_OUT
} TplLogEntryDirection;

typedef enum
{
  TPL_LOG_ENTRY_SIGNAL_NONE = 0,

  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_SENT,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_RECEIVED,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_SEND_ERROR,
  TPL_LOG_ENTRY_CHANELL_TEXT_SIGNAL_LOST_MESSAGE,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_CHAT_STATUS_CHANGED,

  TPL_LOG_ENTRY_CHANNEL_SIGNAL_CHANNEL_CLOSED

} TplLogEntrySignalType;

typedef enum
{
  TPL_LOG_ENTRY_ERROR,
  TPL_LOG_ENTRY_TEXT
} TplLogEntryType;

typedef struct _TplLogEntryPriv TplLogEntryPriv;

typedef struct
{
  GObject parent;

  /* Private */
  TplLogEntryPriv *priv;
} TplLogEntry;

typedef struct
{
  GObjectClass parent_class;

  void (*dispose) (GObject *obj);
  void (*finalize) (GObject *obj);

  gint64 (*get_timestamp) (TplLogEntry *self);
  gint (*get_pending_msg_id) (TplLogEntry *self);
  gboolean (*is_pending) (TplLogEntry *self);
  TplLogEntrySignalType (*get_signal_type) (TplLogEntry *self);
  const gchar* (*get_log_id) (TplLogEntry *self);
  TplLogEntryDirection (*get_direction) (TplLogEntry *self);
  TplContact * (*get_sender) (TplLogEntry *self);
  TplContact * (*get_receiver) (TplLogEntry *self);
  const gchar * (*get_chat_id) (TplLogEntry *self);
  const gchar * (*get_account_path) (TplLogEntry *self);
  const gchar * (*get_channel_path) (TplLogEntry *self);

  void (*set_timestamp) (TplLogEntry *self, gint64 data);
  void (*set_pending_msg_id) (TplLogEntry *self, gint data);
  void (*set_signal_type) (TplLogEntry *self, TplLogEntrySignalType data);
  void (*set_log_id) (TplLogEntry *self, guint data);
  void (*set_direction) (TplLogEntry *self, TplLogEntryDirection data);
  void (*set_sender) (TplLogEntry *self, TplContact *data);
  void (*set_receiver) (TplLogEntry *self, TplContact *data);
  void (*set_chat_id) (TplLogEntry *self, const gchar *data);
  void (*set_channel_path) (TplLogEntry *self, const gchar *data);

  /* to be implemented only by subclasses */
  gboolean (*equal) (TplLogEntry *entry1, TplLogEntry *entry2);
} TplLogEntryClass;

GType tpl_log_entry_get_type (void);
gint64 tpl_log_entry_get_timestamp (TplLogEntry *self);
gint tpl_log_entry_get_pending_msg_id (TplLogEntry *self);
gboolean tpl_log_entry_is_pending (TplLogEntry *self);
TplLogEntrySignalType tpl_log_entry_get_signal_type (TplLogEntry *self);
const gchar* tpl_log_entry_get_log_id (TplLogEntry *self);
const gchar *tpl_log_entry_get_chat_id (TplLogEntry * self);<commit_msg>Adjust TplLogEntry declaration so it gets documented correctly<commit_after>/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2009 Collabora Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Authors: <NAME> <<EMAIL>>
 */

#ifndef __TPL_LOG_ENTRY_H__
#define __TPL_LOG_ENTRY_H__

#include <glib-object.h>

#include <telepathy-logger/contact.h>

G_BEGIN_DECLS
#define TPL_TYPE_LOG_ENTRY (tpl_log_entry_get_type ())
#define TPL_LOG_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TPL_TYPE_LOG_ENTRY, TplLogEntry))
#define TPL_LOG_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TPL_TYPE_LOG_ENTRY, TplLogEntryClass))
#define TPL_IS_LOG_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TPL_TYPE_LOG_ENTRY))
#define TPL_IS_LOG_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TPL_TYPE_LOG_ENTRY))
#define TPL_LOG_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TPL_TYPE_LOG_ENTRY, TplLogEntryClass))

#define TPL_LOG_ENTRY_MSG_ID_IS_VALID(msg) (msg >= 0)

#define TPL_LOG_ENTRY_MSG_ID_UNKNOWN -2

#define TPL_LOG_ENTRY_MSG_ID_ACKNOWLEDGED -1

typedef enum
{
  TPL_LOG_ENTRY_DIRECTION_NONE = 0,

  TPL_LOG_ENTRY_DIRECTION_IN,
  TPL_LOG_ENTRY_DIRECTION_OUT
} TplLogEntryDirection;

typedef enum
{
  TPL_LOG_ENTRY_SIGNAL_NONE = 0,

  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_SENT,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_RECEIVED,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_SEND_ERROR,
  TPL_LOG_ENTRY_CHANELL_TEXT_SIGNAL_LOST_MESSAGE,
  TPL_LOG_ENTRY_CHANNEL_TEXT_SIGNAL_CHAT_STATUS_CHANGED,

  TPL_LOG_ENTRY_CHANNEL_SIGNAL_CHANNEL_CLOSED

} TplLogEntrySignalType;

typedef enum
{
  TPL_LOG_ENTRY_ERROR,
  TPL_LOG_ENTRY_TEXT
} TplLogEntryType;

typedef struct _TplLogEntry TplLogEntry;
typedef struct _TplLogEntryClass TplLogEntryClass;
typedef struct _TplLogEntryPriv TplLogEntryPriv;

struct _TplLogEntry
{
  GObject parent;

  /* Private */
  TplLogEntryPriv *priv;
};

struct _TplLogEntryClass {
  GObjectClass parent_class;

  void (*dispose) (GObject *obj);
  void (*finalize) (GObject *obj);

  gint64 (*get_timestamp) (TplLogEntry *self);
  gint (*get_pending_msg_id) (TplLogEntry *self);
  gboolean (*is_pending) (TplLogEntry *self);
  TplLogEntrySignalType (*get_signal_type) (TplLogEntry *self);
  const gchar* (*get_log_id) (TplLogEntry *self);
  TplLogEntryDirection (*get_direction) (TplLogEntry *self);
  TplContact * (*get_sender) (TplLogEntry *self);
  TplContact * (*get_receiver) (TplLogEntry *self);
  const gchar * (*get_chat_id) (TplLogEntry *self);
  const gchar * (*get_account_path) (TplLogEntry *self);
  const gchar * (*get_channel_path) (TplLogEntry *self);

  void (*set_timestamp) (TplLogEntry *self, gint64 data);
  void (*set_pending_msg_id) (TplLogEntry *self, gint data);
  void (*set_signal_type) (TplLogEntry *self, TplLogEntrySignalType data);
  void (*set_log_id) (TplLogEntry *self, guint data);
  void (*set_direction) (TplLogEntry *self, TplLogEntryDirection data);
  void (*set_sender) (TplLogEntry *self, TplContact *data);
  void (*set_receiver) (TplLogEntry *self, TplContact *data);
  void (*set_chat_id) (TplLogEntry *self, const gchar *data);
  void (*set_channel_path) (TplLogEntry *self, const gchar *data);

  /* to be implemented only by subclasses */
  gboolean (*equal) (TplLogEntry *entry1, TplLogEntry *entry2);
};

GType tpl_log_entry_get_type (void);
gint64 tpl_log_entry_get_timestamp (TplLogEntry *self);
gint tpl_log_entry_get_pending_msg_id (TplLogEntry *self);
gboolean tpl_log_entry_is_pending (TplLogEntry *self);
TplLogEntrySignalType tpl_log_entry_get_signal_type (TplLogEntry *self);
const gchar* tpl_log_entry_get_log_id (TplLogEntry *self);
const gchar *tpl_log_entry_get_chat_id (TplLogEntry * self);
{'fraction_non_alphanumeric': 0.09435047750546542, 'fraction_numerical': 0.007363939707743643, 'mean_word_length': 6.441780821917808, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6618835', 'n_tokens_mistral': 3252, 'n_tokens_neox': 3187, 'n_words': 764}