libchafa: Move new terminal classes to backend library

hpjansson · hpjansson · commit 949c47045863 · 2025-11-28T23:26:25.000+01:00
This will expose API for:

ChafaByteFifo
ChafaParser
ChafaStreamReader
ChafaStreamWriter
ChafaTerm
diff --git a/chafa/Makefile.am b/chafa/Makefile.am
@@ -13,31 +13,41 @@ libchafa_la_LDFLAGS = $(LIBCHAFA_LDFLAGS) -no-undefined -version-info 11:0:11
 libchafa_la_LIBADD = $(GLIB_LIBS) internal/libchafa-internal.la -lm
 
 libchafa_la_SOURCES = \
-	chafa-canvas.c \
+	chafa-byte-fifo.c \
 	chafa-canvas-config.c \
+	chafa-canvas.c \
 	chafa-features.c \
 	chafa-frame.c \
 	chafa-image.c \
+	chafa-parser.c \
 	chafa-placement.c \
+	chafa-stream-reader.c \
+	chafa-stream-writer.c \
 	chafa-symbol-map.c \
 	chafa-term-db.c \
 	chafa-term-info.c \
+	chafa-term.c \
 	chafa-util.c
 
 chafaincludedir=$(includedir)/chafa
 chafainclude_HEADERS = \
 	chafa.h \
-	chafa-canvas.h \
+	chafa-byte-fifo.h \
 	chafa-canvas-config.h \
+	chafa-canvas.h \
 	chafa-common.h \
 	chafa-features.h \
 	chafa-frame.h \
 	chafa-image.h \
+	chafa-parser.h \
 	chafa-placement.h \
+	chafa-stream-reader.h \
+	chafa-stream-writer.h \
 	chafa-symbol-map.h \
 	chafa-term-db.h \
 	chafa-term-info.h \
 	chafa-term-seq-def.h \
+	chafa-term.h \
 	chafa-util.h \
 	chafa-version-macros.h
 
diff --git a/chafa/chafa-byte-fifo.c b/chafa/chafa-byte-fifo.c
@@ -19,7 +19,7 @@
 
 #include "config.h"
 
-#include "chafa-byte-fifo.h"
+#include "chafa.h"
 
 #define BUFFER_SIZE_MAX 16384
 
diff --git a/chafa/chafa-byte-fifo.h b/chafa/chafa-byte-fifo.h
@@ -20,24 +20,38 @@
 #ifndef __CHAFA_BYTE_FIFO_H__
 #define __CHAFA_BYTE_FIFO_H__
 
+#if !defined (__CHAFA_H_INSIDE__) && !defined (CHAFA_COMPILATION)
+# error "Only <chafa.h> can be included directly."
+#endif
+
 #include <glib.h>
 
 G_BEGIN_DECLS
 
 typedef struct ChafaByteFifo ChafaByteFifo;
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaByteFifo *chafa_byte_fifo_new (void);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_byte_fifo_destroy (ChafaByteFifo *byte_fifo);
 
+CHAFA_AVAILABLE_IN_1_20
 gint64 chafa_byte_fifo_get_pos (ChafaByteFifo *byte_fifo);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_byte_fifo_get_len (ChafaByteFifo *byte_fifo);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_byte_fifo_push (ChafaByteFifo *byte_fifo, gconstpointer src, gint src_len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_byte_fifo_pop (ChafaByteFifo *byte_fifo, gpointer dest, gint dest_len);
+CHAFA_AVAILABLE_IN_1_20
 gconstpointer chafa_byte_fifo_peek (ChafaByteFifo *byte_fifo, gint *len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_byte_fifo_drop (ChafaByteFifo *byte_fifo, gint len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_byte_fifo_search (ChafaByteFifo *byte_fifo,
                              gconstpointer data, gint data_len,
                              gint64 *pos);
+CHAFA_AVAILABLE_IN_1_20
 gpointer chafa_byte_fifo_split_next (ChafaByteFifo *byte_fifo,
                                      gconstpointer separator, gint separator_len,
                                      gint64 *restart_pos, gint *len_out);
diff --git a/chafa/chafa-parser.c b/chafa/chafa-parser.c
@@ -21,7 +21,6 @@
 
 #include <string.h>  /* memcpy, memset */
 #include "chafa.h"
-#include "chafa-parser.h"
 
 struct ChafaEvent
 {
diff --git a/chafa/chafa-parser.h b/chafa/chafa-parser.h
@@ -20,6 +20,10 @@
 #ifndef __CHAFA_PARSER_H__
 #define __CHAFA_PARSER_H__
 
+#if !defined (__CHAFA_H_INSIDE__) && !defined (CHAFA_COMPILATION)
+# error "Only <chafa.h> can be included directly."
+#endif
+
 #include <glib.h>
 
 G_BEGIN_DECLS
@@ -35,19 +39,31 @@ ChafaEventType;
 typedef struct ChafaEvent ChafaEvent;
 typedef struct ChafaParser ChafaParser;
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaEventType chafa_event_get_type (ChafaEvent *event);
+CHAFA_AVAILABLE_IN_1_20
 gunichar chafa_event_get_unichar (ChafaEvent *event);
+CHAFA_AVAILABLE_IN_1_20
 ChafaTermSeq chafa_event_get_seq (ChafaEvent *event);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_event_get_seq_arg (ChafaEvent *event, gint n);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_event_get_n_seq_args (ChafaEvent *event);
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaParser *chafa_parser_new (ChafaTermInfo *term_info);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_parser_destroy (ChafaParser *parser);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_parser_init (ChafaParser *parser_out, ChafaTermInfo *term_info);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_parser_deinit (ChafaParser *parser);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_parser_push_data (ChafaParser *parser, gconstpointer data, gint data_len);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_parser_push_eof (ChafaParser *parser);
+CHAFA_AVAILABLE_IN_1_20
 ChafaEvent *chafa_parser_pop_event (ChafaParser *parser);
 
 G_END_DECLS
diff --git a/chafa/chafa-stream-reader.c b/chafa/chafa-stream-reader.c
@@ -24,12 +24,8 @@
 #include <fcntl.h>  /* open */
 #include <unistd.h>  /* STDOUT_FILENO */
 
-/* Our copy of glib's internal GWakeup */
-#include "chafa-wakeup.h"
-
 #include "chafa.h"
-#include "chafa-byte-fifo.h"
-#include "chafa-stream-reader.h"
+#include "internal/chafa-wakeup.h"
 
 /* Include after glib.h for G_OS_WIN32 */
 #ifdef G_OS_WIN32
diff --git a/chafa/chafa-stream-reader.h b/chafa/chafa-stream-reader.h
@@ -20,28 +20,43 @@
 #ifndef __CHAFA_STREAM_READER_H__
 #define __CHAFA_STREAM_READER_H__
 
+#if !defined (__CHAFA_H_INSIDE__) && !defined (CHAFA_COMPILATION)
+# error "Only <chafa.h> can be included directly."
+#endif
+
 #include <glib.h>
 
 G_BEGIN_DECLS
 
 typedef struct ChafaStreamReader ChafaStreamReader;
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaStreamReader *chafa_stream_reader_new_from_fd (gint fd);
+CHAFA_AVAILABLE_IN_1_20
 ChafaStreamReader *chafa_stream_reader_new_from_fd_full (gint fd,
                                                          gconstpointer token_separator,
                                                          gint token_separator_len);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_reader_ref (ChafaStreamReader *stream_reader);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_reader_unref (ChafaStreamReader *stream_reader);
 
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_reader_get_fd (ChafaStreamReader *stream_reader);
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_stream_reader_is_console (ChafaStreamReader *stream_reader);
 
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_reader_read (ChafaStreamReader *stream_reader, gpointer out, gint max_len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_reader_read_token (ChafaStreamReader *stream_reader, gpointer *out, gint max_len);
 
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_stream_reader_wait_until (ChafaStreamReader *stream_reader, gint64 end_time_us);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_reader_wait (ChafaStreamReader *stream_reader, gint timeout_ms);
 
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_stream_reader_is_eof (ChafaStreamReader *stream_reader);
 
 G_END_DECLS
diff --git a/chafa/chafa-stream-writer.c b/chafa/chafa-stream-writer.c
@@ -25,12 +25,8 @@
 #include <unistd.h>  /* STDOUT_FILENO */
 #include <glib/gprintf.h>  /* g_vasprintf */
 
-/* Our copy of glib's internal GWakeup */
-#include "chafa-wakeup.h"
-
 #include "chafa.h"
-#include "chafa-byte-fifo.h"
-#include "chafa-stream-writer.h"
+#include "internal/chafa-wakeup.h"
 
 /* Include after glib.h for G_OS_WIN32 */
 #ifdef G_OS_WIN32
diff --git a/chafa/chafa-stream-writer.h b/chafa/chafa-stream-writer.h
@@ -20,24 +20,38 @@
 #ifndef __CHAFA_STREAM_WRITER_H__
 #define __CHAFA_STREAM_WRITER_H__
 
+#if !defined (__CHAFA_H_INSIDE__) && !defined (CHAFA_COMPILATION)
+# error "Only <chafa.h> can be included directly."
+#endif
+
 #include <glib.h>
 
 G_BEGIN_DECLS
 
 typedef struct ChafaStreamWriter ChafaStreamWriter;
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaStreamWriter *chafa_stream_writer_new_from_fd (gint fd);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_writer_ref (ChafaStreamWriter *stream_writer);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_writer_unref (ChafaStreamWriter *stream_writer);
 
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_writer_get_fd (ChafaStreamWriter *stream_writer);
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_stream_writer_is_console (ChafaStreamWriter *stream_writer);
 
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_writer_get_buffer_max (ChafaStreamWriter *stream_writer);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_writer_set_buffer_max (ChafaStreamWriter *stream_writer, gint buf_max);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_stream_writer_write (ChafaStreamWriter *stream_writer, gconstpointer data, gint len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_stream_writer_print (ChafaStreamWriter *stream_writer, const gchar *format, ...);
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_stream_writer_flush (ChafaStreamWriter *stream_writer);
 
 G_END_DECLS
diff --git a/chafa/chafa-term.c b/chafa/chafa-term.c
@@ -33,10 +33,6 @@
 #include <glib/gstdio.h>  /* g_open, g_close */
 
 #include "chafa.h"
-#include "chafa-byte-fifo.h"
-#include "chafa-stream-reader.h"
-#include "chafa-stream-writer.h"
-#include "chafa-term.h"
 
 /* Include after glib.h for G_OS_WIN32 */
 #ifdef G_OS_WIN32
diff --git a/chafa/chafa-term.h b/chafa/chafa-term.h
@@ -20,41 +20,64 @@
 #ifndef __CHAFA_TERM_H__
 #define __CHAFA_TERM_H__
 
+#if !defined (__CHAFA_H_INSIDE__) && !defined (CHAFA_COMPILATION)
+# error "Only <chafa.h> can be included directly."
+#endif
+
 #include <glib.h>
 #include "chafa-parser.h"
 
 G_BEGIN_DECLS
 
 typedef struct ChafaTerm ChafaTerm;
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaTerm *chafa_term_new (ChafaTermInfo *term_info, gint in_fd, gint out_fd, gint err_fd);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_destroy (ChafaTerm *term);
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaTerm *chafa_term_get_default (void);
 
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_term_get_buffer_max (ChafaTerm *term);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_set_buffer_max (ChafaTerm *term, gint max);
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaTermInfo *chafa_term_get_term_info (ChafaTerm *term);
 
+CHAFA_AVAILABLE_IN_1_20
 ChafaEvent *chafa_term_read_event (ChafaTerm *term, guint timeout_ms);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_write (ChafaTerm *term, gconstpointer data, gint len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_term_print (ChafaTerm *term, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_term_print_seq (ChafaTerm *term, ChafaTermSeq seq, ...);
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_term_flush (ChafaTerm *term);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_write_err (ChafaTerm *term, gconstpointer data, gint len);
+CHAFA_AVAILABLE_IN_1_20
 gint chafa_term_print_err (ChafaTerm *term, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_get_size_px (ChafaTerm *term, gint *width_px_out, gint *height_px_out);
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_get_size_cells (ChafaTerm *term, gint *width_cells_out, gint *height_cells_out);
 
+CHAFA_AVAILABLE_IN_1_20
 gboolean chafa_term_sync_probe (ChafaTerm *term, gint timeout_ms);
 
+CHAFA_AVAILABLE_IN_1_20
 void chafa_term_notify_size_changed (ChafaTerm *term);
 
+CHAFA_AVAILABLE_IN_1_20
 gint32 chafa_term_get_default_fg_color (ChafaTerm *term);
+CHAFA_AVAILABLE_IN_1_20
 gint32 chafa_term_get_default_bg_color (ChafaTerm *term);
 
 G_END_DECLS
diff --git a/chafa/chafa-version-macros.h b/chafa/chafa-version-macros.h
@@ -42,6 +42,7 @@ G_BEGIN_DECLS
 #define CHAFA_VERSION_1_14 (G_ENCODE_VERSION (1, 14))
 #define CHAFA_VERSION_1_16 (G_ENCODE_VERSION (1, 16))
 #define CHAFA_VERSION_1_18 (G_ENCODE_VERSION (1, 18))
+#define CHAFA_VERSION_1_20 (G_ENCODE_VERSION (1, 20))
 
 /* Evaluates to the current stable version; for development cycles,
  * this means the next stable target. */
@@ -261,6 +262,20 @@ G_BEGIN_DECLS
 # define CHAFA_AVAILABLE_IN_1_18                _CHAFA_EXTERN
 #endif
 
+#if CHAFA_VERSION_MIN_REQUIRED >= CHAFA_VERSION_1_20
+# define CHAFA_DEPRECATED_IN_1_20               G_DEPRECATED
+# define CHAFA_DEPRECATED_IN_1_20_FOR(f)        G_DEPRECATED_FOR(f)
+#else
+# define CHAFA_DEPRECATED_IN_1_20               _CHAFA_EXTERN
+# define CHAFA_DEPRECATED_IN_1_20_FOR(f)        _CHAFA_EXTERN
+#endif
+
+#if CHAFA_VERSION_MAX_ALLOWED < CHAFA_VERSION_1_20
+# define CHAFA_AVAILABLE_IN_1_20                G_UNAVAILABLE(1, 20)
+#else
+# define CHAFA_AVAILABLE_IN_1_20                _CHAFA_EXTERN
+#endif
+
 G_END_DECLS
 
 #endif /* __CHAFA_VERSION_MACROS_H__ */
diff --git a/chafa/chafa.h b/chafa/chafa.h
@@ -39,6 +39,11 @@ G_BEGIN_DECLS
 #include <chafa-term-info.h>
 #include <chafa-term-db.h>
 #include <chafa-util.h>
+#include <chafa-byte-fifo.h>
+#include <chafa-parser.h>
+#include <chafa-stream-reader.h>
+#include <chafa-stream-writer.h>
+#include <chafa-term.h>
 
 G_END_DECLS
 
diff --git a/chafa/internal/Makefile.am b/chafa/internal/Makefile.am
@@ -55,6 +55,8 @@ libchafa_internal_la_SOURCES = \
 	chafa-symbols-latin.h \
 	chafa-symbols-misc-narrow.h \
 	chafa-vector.h \
+	chafa-wakeup.c \
+	chafa-wakeup.h \
 	chafa-work-cell.c \
 	chafa-work-cell.h
 
diff --git a/chafa/internal/chafa-wakeup.c b/chafa/internal/chafa-wakeup.c
@@ -28,8 +28,8 @@
  * includes warnings.  We have to manually include its dependencies here
  * (and at all other use sites).
  */
-#include <glib.h>
-#include "chafa-wakeup.h"
+#include "chafa.h"
+#include "internal/chafa-wakeup.h"
 
 /*< private >
  * SECTION:gwakeup
diff --git a/chafa/internal/chafa-wakeup.h b/chafa/internal/chafa-wakeup.h
diff --git a/tools/chafa/Makefile.am b/tools/chafa/Makefile.am
diff --git a/tools/chafa/chafa.c b/tools/chafa/chafa.c

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,6 @@`
`21`	`21`
`22`	`22`	`#include <string.h> /* memcpy, memset */`
`23`	`23`	`#include "chafa.h"`
`24`		`-#include "chafa-parser.h"`
`25`	`24`
`26`	`25`	`struct ChafaEvent`
`27`	`26`	`{`