summaryrefslogtreecommitdiff
path: root/logview/src/logview-log.h
blob: d0ae3ef45b58a98d4ab1b18e7a9e3c42bbd7dd79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/* Copyright (C) 1998 Cesar Miquel <miquel@df.uba.ar>
 * Copyright (C) 2008 Cosimo Cecchi <cosimoc@gnome.org>
 * Copyright (C) 2012-2021 MATE Developers
 *
 * This file is part of MATE Utils.
 *
 * MATE Utils 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.
 *
 * MATE Utils 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 MATE Utils.  If not, see <https://www.gnu.org/licenses/>.
 */

/* logview-log.h */

#ifndef __LOGVIEW_LOG_H__
#define __LOGVIEW_LOG_H__

#include <glib-object.h>
#include <gio/gio.h>

G_BEGIN_DECLS

#define LOGVIEW_TYPE_LOG logview_log_get_type()
#define LOGVIEW_LOG(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LOGVIEW_TYPE_LOG, LogviewLog))
#define LOGVIEW_LOG_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), LOGVIEW_TYPE_LOG, LogviewLogClass))
#define LOGVIEW_IS_LOG(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LOGVIEW_TYPE_LOG))
#define LOGVIEW_IS_LOG_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), LOGVIEW_TYPE_LOG))
#define LOGVIEW_LOG_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), LOGVIEW_TYPE_LOG, LogviewLogClass))

typedef struct _LogviewLog LogviewLog;
typedef struct _LogviewLogClass LogviewLogClass;
typedef struct _LogviewLogPrivate LogviewLogPrivate;

/* callback signatures for async I/O operations */

typedef void (* LogviewCreateCallback) (LogviewLog *log,
                                        GError *error,
                                        gpointer user_data);
typedef void (* LogviewNewLinesCallback) (LogviewLog *log,
                                          const char **lines,
                                          GSList *new_days,
                                          GError *error,
                                          gpointer user_data);

#define LOGVIEW_ERROR_QUARK g_quark_from_static_string ("logview-error")

typedef enum {
  LOGVIEW_ERROR_FAILED,
  LOGVIEW_ERROR_PERMISSION_DENIED,
  LOGVIEW_ERROR_ZLIB,
  LOGVIEW_ERROR_NOT_SUPPORTED,
  LOGVIEW_ERROR_NOT_A_LOG
} LogviewErrorEnum;

struct _LogviewLog {
  GObject parent;
  LogviewLogPrivate *priv;
};

struct _LogviewLogClass {
  GObjectClass parent_class;

  /* signals */
  void (* log_changed) (LogviewLog *log);
};

GType logview_log_get_type      (void);

/* public methods */

/* these two do I/O, so they are wrapped async */
void          logview_log_create                   (const char *filename,
                                                    LogviewCreateCallback callback,
                                                    gpointer user_data);
void          logview_log_create_from_gfile        (GFile *file,
                                                    LogviewCreateCallback callback,
                                                    gpointer user_data);
void          logview_log_read_new_lines           (LogviewLog *log,
                                                    GCancellable *cancellable,
                                                    LogviewNewLinesCallback callback,
                                                    gpointer user_data);

const char *  logview_log_get_display_name          (LogviewLog *log);
time_t        logview_log_get_timestamp             (LogviewLog *log);
goffset       logview_log_get_file_size             (LogviewLog *log);
const char ** logview_log_get_cached_lines          (LogviewLog *log);
guint         logview_log_get_cached_lines_number   (LogviewLog *log);
GSList *      logview_log_get_days_for_cached_lines (LogviewLog *log);
gboolean      logview_log_has_new_lines             (LogviewLog *log);
char *        logview_log_get_uri                   (LogviewLog *log);
GFile *       logview_log_get_gfile                 (LogviewLog *log);
gboolean      logview_log_get_has_days              (LogviewLog *log);

G_END_DECLS

#endif /* __LOGVIEW_LOG_H__ */