Add multiplexer passthrough for graphics protocols

chafa/Makefile.am

@@ -16,6 +16,8 @@ libchafa_la_SOURCES = \
 	chafa-canvas.c \
 	chafa-canvas-config.c \
 	chafa-features.c \
+	chafa-frame.c \
+	chafa-image.c \
 	chafa-symbol-map.c \
 	chafa-term-db.c \
 	chafa-term-info.c \
@@ -28,6 +30,8 @@ chafainclude_HEADERS = \
 	chafa-canvas-config.h \
 	chafa-common.h \
 	chafa-features.h \
+	chafa-frame.h \
+	chafa-image.h \
 	chafa-symbol-map.h \
 	chafa-term-db.h \
 	chafa-term-info.h \

chafa/chafa-canvas-config.c

@@ -92,6 +92,14 @@
  * @CHAFA_OPTIMIZATION_ALL: All optimizations enabled.
  **/
 
+/**
+ * ChafaPassthrough:
+ * @CHAFA_PASSTHROUGH_NONE: No passthrough guards will be used.
+ * @CHAFA_PASSTHROUGH_SCREEN: Passthrough guards for GNU Screen will be used.
+ * @CHAFA_PASSTHROUGH_TMUX: Passthrough guards for tmux will be used.
+ * @CHAFA_PASSTHROUGH_MAX: Last supported passthrough mode plus one.
+ **/
+
 /* Private */
 
 void
@@ -937,3 +945,52 @@ chafa_canvas_config_set_fg_only_enabled (ChafaCanvasConfig *config, gboolean fg_
 
     config->fg_only_enabled = fg_only_enabled;
 }
+
+/**
+ * chafa_canvas_config_get_passthrough:
+ * @config: A #ChafaCanvasConfig
+ *
+ * Returns @config's #ChafaPassthrough setting. This defaults to
+ * #CHAFA_PASSTHROUGH_NONE.
+ *
+ * Passthrough is needed to transmit certain escape codes to the outer terminal
+ * when running in an inner terminal environment like tmux. When enabled, this
+ * will happen automatically as needed, dictated by information contained in a
+ * #ChafaTermInfo.
+ *
+ * Returns: The #ChafaPassthrough setting
+ *
+ * Since: 1.14
+ **/
+ChafaPassthrough
+chafa_canvas_config_get_passthrough (const ChafaCanvasConfig *config)
+{
+    g_return_val_if_fail (config != NULL, CHAFA_PASSTHROUGH_NONE);
+    g_return_val_if_fail (config->refs > 0, CHAFA_PASSTHROUGH_NONE);
+
+    return config->passthrough;
+}
+
+/**
+ * chafa_canvas_config_set_passthrough:
+ * @config: A #ChafaCanvasConfig
+ * @passthrough: A #ChafaPassthrough value
+ *
+ * Indicates which passthrough mode to use. This defaults to
+ * #CHAFA_PASSTHROUGH_NONE.
+ *
+ * Passthrough is needed to transmit certain escape codes to the outer terminal
+ * when running in an inner terminal environment like tmux. When enabled, this
+ * will happen automatically as needed, dictated by information contained in a
+ * #ChafaTermInfo.
+ *
+ * Since: 1.14
+ **/
+void
+chafa_canvas_config_set_passthrough (ChafaCanvasConfig *config, ChafaPassthrough passthrough)
+{
+    g_return_if_fail (config != NULL);
+    g_return_if_fail (config->refs > 0);
+
+    config->passthrough = passthrough;
+}

chafa/chafa-canvas-config.h

@@ -107,6 +107,18 @@ typedef enum
 }
 ChafaOptimizations;
 
+/* Passthrough modes */
+
+typedef enum
+{
+    CHAFA_PASSTHROUGH_NONE,
+    CHAFA_PASSTHROUGH_SCREEN,
+    CHAFA_PASSTHROUGH_TMUX,
+
+    CHAFA_PASSTHROUGH_MAX
+}
+ChafaPassthrough;
+
 /* Canvas config */
 
 typedef struct ChafaCanvasConfig ChafaCanvasConfig;
@@ -210,6 +222,11 @@ gboolean chafa_canvas_config_get_fg_only_enabled (const ChafaCanvasConfig *confi
 CHAFA_AVAILABLE_IN_1_8
 void chafa_canvas_config_set_fg_only_enabled (ChafaCanvasConfig *config, gboolean fg_only_enabled);
 
+CHAFA_AVAILABLE_IN_1_14
+ChafaPassthrough chafa_canvas_config_get_passthrough (const ChafaCanvasConfig *config);
+CHAFA_AVAILABLE_IN_1_14
+void chafa_canvas_config_set_passthrough (ChafaCanvasConfig *config, ChafaPassthrough passthrough);
+
 G_END_DECLS
 
 #endif /* __CHAFA_CANVAS_CONFIG_H__ */