Changeset 2138 for libcaca/trunk/cacaTweet

Timestamp:

Dec 16, 2007, 2:50:41 AM (12 years ago)

Author:

Sam Hocevar

Message:

• Implement caca_create_display_with_driver() to specify an output driver without using environment variables..
• Implement caca_get_display_driver() to return the current display's output driver.
• Add a simple example program to test caca_create_display_with_driver().

Location:

libcaca/trunk/caca

Files:

• caca.c (modified) (8 diffs)
• caca.h (modified) (1 diff)
• caca_internals.h (modified) (1 diff)
• driver_cocoa.m (modified) (1 diff)
• driver_conio.c (modified) (1 diff)
• driver_gl.c (modified) (1 diff)
• driver_ncurses.c (modified) (1 diff)
• driver_raw.c (modified) (1 diff)
• driver_slang.c (modified) (1 diff)
• driver_vga.c (modified) (1 diff)
• driver_win32.c (modified) (1 diff)
• driver_x11.c (modified) (1 diff)
• event.c (modified) (1 diff)

libcaca/trunk/caca/caca.c

@@ -38 +38 @@
 
 #if defined(USE_PLUGINS)
-#   define gl_install(p) caca_plugin_install("gl", p)
-#   define x11_install(p) caca_plugin_install("x11", p)
+#   define gl_install(p) caca_plugin_install(p, "gl")
+#   define x11_install(p) caca_plugin_install(p, "x11")
 #endif
 
 static int caca_can_resize(caca_display_t *);
-static int caca_select_driver(caca_display_t *);
+static int caca_select_driver(caca_display_t *, char const *);
 #if defined(USE_PLUGINS)
 static int caca_plugin_install(char const *, caca_display_t *);
@@ -59 +59 @@
  *  caca_free_display() is called.
  *
+ *  See also caca_create_display_with_driver().
+ *
  *  If an error occurs, NULL is returned and \b errno is set accordingly:
  *  - \c ENOMEM Not enough memory.
  *  - \c ENODEV Graphical device could not be initialised.
  *
- *  \param cv The cucul cavas.
+ *  \param cv The cucul canvas or NULL to create a canvas automatically.
  *  \return The caca graphical context or NULL if an error occurred.
  */
 caca_display_t * caca_create_display(cucul_canvas_t *cv)
+{
+    return caca_create_display_with_driver(cv, NULL);
+}
+
+/** \brief Attach a caca graphical context to a cucul canvas.
+ *
+ *  Create a graphical context using device-dependent features (ncurses for
+ *  terminals, an X11 window, a DOS command window...) that attaches to a
+ *  libcucul canvas. Everything that gets drawn in the libcucul canvas can
+ *  then be displayed by the libcaca driver.
+ *
+ *  If no cucul canvas is provided, a new one is created. Its handle can be
+ *  retrieved using caca_get_canvas() and it is automatically destroyed when
+ *  caca_free_display() is called.
+ *
+ *  See also caca_create_display().
+ *
+ *  If an error occurs, NULL is returned and \b errno is set accordingly:
+ *  - \c ENOMEM Not enough memory.
+ *  - \c ENODEV Graphical device could not be initialised.
+ *
+ *  \param cv The cucul canvas or NULL to create a canvas automatically.
+ *  \param driver A string describing the desired output driver or NULL to
+ *                choose the best driver automatically.
+ *  \return The caca graphical context or NULL if an error occurred.
+ */
+caca_display_t * caca_create_display_with_driver(cucul_canvas_t *cv,
+                                                 char const *driver)
 {
     caca_display_t *dp = malloc(sizeof(caca_display_t));
@@ -96 +126 @@
 #endif
 
-    if(caca_select_driver(dp))
+    if(caca_select_driver(dp, driver))
     {
 #if defined(USE_PLUGINS)
@@ -155 +185 @@
 }
 
+/** \brief Return the current output driver
+ *
+ *  Return the given display's current output driver.
+ *
+ *  This function never fails.
+ *
+ *  \param dp The caca display.
+ *  \return A static string.
+ */
+char const * caca_get_display_driver(caca_display_t *dp)
+{
+    return dp->drv.driver;
+}
+
 /** \brief Detach a caca graphical context from a cucul backend context.
  *
@@ -224 +268 @@
  *  \return An array of strings.
  */
-char const * const * caca_get_display_driver_list(caca_display_t *dp)
+char const * const * caca_get_display_driver_list(void)
 {
     static char const * const list[] =
@@ -270 +314 @@
 }
 
-static int caca_select_driver(caca_display_t *dp)
-{
-#if defined(HAVE_GETENV) && defined(HAVE_STRCASECMP)
-    char *var = getenv("CACA_DRIVER");
-
+static int caca_select_driver(caca_display_t *dp, char const *driver)
+{
+    char const *var = driver;
+#if defined(HAVE_GETENV)
+    if(!var)
+        var = getenv("CACA_DRIVER");
+#endif
+
+#if defined(HAVE_STRCASECMP)
     /* If the environment variable was set, use it */
     if(var && *var)
@@ -340 +388 @@
 
 #if defined(USE_PLUGINS)
-static int caca_plugin_install(char const *name, caca_display_t *dp)
+static int caca_plugin_install(caca_display_t *dp, char const *driver)
 {
     char buf[512];
     int (*sym) (caca_display_t *);
 
-    sprintf(buf, "%s/lib%s_plugin.so", PLUGINDIR, name);
+    sprintf(buf, "%s/lib%s_plugin.so", PLUGINDIR, driver);
     dp->plugin = dlopen(buf, RTLD_NOW);
     if(!dp->plugin)
     {
-        sprintf(buf, "lib%s_plugin.so", name);
+        sprintf(buf, "lib%s_plugin.so", driver);
         dp->plugin = dlopen(buf, RTLD_NOW);
         if(!dp->plugin)
@@ -355 +403 @@
     }
 
-    sprintf(buf, "%s_install", name);
+    sprintf(buf, "%s_install", driver);
     sym = dlsym(dp->plugin, buf);
     if(!sym)

libcaca/trunk/caca/caca.h

@@ -155 +155 @@
  *  @{ */
 __extern caca_display_t * caca_create_display(cucul_canvas_t *);
+__extern caca_display_t * caca_create_display_with_driver(cucul_canvas_t *,
+                                                          char const *);
+__extern char const * caca_get_display_driver(caca_display_t *);
 __extern int caca_free_display(caca_display_t *);
 __extern cucul_canvas_t * caca_get_canvas(caca_display_t *);
 __extern int caca_refresh_display(caca_display_t *);
-__extern char const * const * caca_get_display_driver_list(caca_display_t *);
+__extern char const * const * caca_get_display_driver_list(void);
 __extern int caca_set_display_time(caca_display_t *, unsigned int);
 __extern unsigned int caca_get_display_time(caca_display_t const *);

libcaca/trunk/caca/caca_internals.h

@@ -118 +118 @@
     struct drv
     {
-        enum caca_driver driver;
+        char const * driver;
+        enum caca_driver id;
         struct driver_private *p;
 

libcaca/trunk/caca/driver_cocoa.m

@@ -998 +998 @@
 int cocoa_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_RAW;
+    dp->drv.id = CACA_DRIVER_COCOA;
+    dp->drv.driver = "cocoa";
 
     dp->drv.init_graphics = cocoa_init_graphics;

libcaca/trunk/caca/driver_conio.c

@@ -167 +167 @@
 int conio_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_CONIO;
+    dp->drv.id = CACA_DRIVER_CONIO;
+    dp->drv.driver = "conio";
 
     dp->drv.init_graphics = conio_init_graphics;

libcaca/trunk/caca/driver_gl.c

@@ -598 +598 @@
 #endif
 
-    dp->drv.driver = CACA_DRIVER_GL;
+    dp->drv.id = CACA_DRIVER_GL;
+    dp->drv.driver = "gl";
 
     dp->drv.init_graphics = gl_init_graphics;

libcaca/trunk/caca/driver_ncurses.c

@@ -809 +809 @@
 int ncurses_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_NCURSES;
+    dp->drv.id = CACA_DRIVER_NCURSES;
+    dp->drv.driver = "ncurses";
 
     dp->drv.init_graphics = ncurses_init_graphics;

libcaca/trunk/caca/driver_raw.c

@@ -98 +98 @@
 int raw_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_RAW;
+    dp->drv.id = CACA_DRIVER_RAW;
+    dp->drv.driver = "raw";
 
     dp->drv.init_graphics = raw_init_graphics;

libcaca/trunk/caca/driver_slang.c

@@ -523 +523 @@
 int slang_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_SLANG;
+    dp->drv.id = CACA_DRIVER_SLANG;
+    dp->drv.driver = "slang";
 
     dp->drv.init_graphics = slang_init_graphics;

libcaca/trunk/caca/driver_vga.c

@@ -160 +160 @@
 int vga_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_VGA;
+    dp->drv.id = CACA_DRIVER_VGA;
+    dp->drv.driver = "vga";
 
     dp->drv.init_graphics = vga_init_graphics;

libcaca/trunk/caca/driver_win32.c

@@ -350 +350 @@
 int win32_install(caca_display_t *dp)
 {
-    dp->drv.driver = CACA_DRIVER_WIN32;
+    dp->drv.id = CACA_DRIVER_WIN32;
+    dp->drv.driver = "win32";
 
     dp->drv.init_graphics = win32_init_graphics;

libcaca/trunk/caca/driver_x11.c

@@ -790 +790 @@
 #endif
 
-    dp->drv.driver = CACA_DRIVER_X11;
+    dp->drv.id = CACA_DRIVER_X11;
+    dp->drv.driver = "x11";
 
     dp->drv.init_graphics = x11_init_graphics;

libcaca/trunk/caca/event.c

@@ -345 +345 @@
 
 #if defined(USE_SLANG)
-    if(dp->drv.driver != CACA_DRIVER_SLANG)
+    if(dp->drv.id != CACA_DRIVER_SLANG)
 #endif
 #if defined(USE_NCURSES)
-    if(dp->drv.driver != CACA_DRIVER_NCURSES)
+    if(dp->drv.id != CACA_DRIVER_NCURSES)
 #endif
     return ret;