Changeset 1006Tweet

Timestamp:

Aug 2, 2006, 3:12:43 PM (14 years ago)

Author:

Sam Hocevar

Message:

• Fixed libcaca prototypes so that all functions use the errno mechanism and return a value.

Location:

libcaca/trunk/caca

Files:

• caca.c (modified) (7 diffs)
• caca.h (modified) (2 diffs)
• driver_conio.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)
• event.c (modified) (4 diffs)
• graphics.c (modified) (9 diffs)

libcaca/trunk/caca/caca.c

@@ -24 +24 @@
 #   include <stdlib.h>
 #   include <string.h>
+#   if defined(HAVE_ERRNO_H)
+#       include <errno.h>
+#   endif
 #endif
 
@@ -31 +34 @@
 #include "caca_internals.h"
 
-static int caca_init_driver(caca_display_t *dp);
+static int caca_select_driver(caca_display_t *dp);
 
 /** \brief Attach a caca graphical context to a cucul canvas.
@@ -40 +43 @@
  *  then be displayed by the libcaca 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.
  *  \return The caca graphical context or NULL if an error occurred.
@@ -47 +54 @@
     caca_display_t *dp = malloc(sizeof(caca_display_t));
 
+    if(!dp)
+    {
+#if defined(HAVE_ERRNO_H)
+        errno = ENOMEM;
+#endif
+        return NULL;
+    }
+
     dp->cv = cv;
 
-    if(caca_init_driver(dp))
+    if(caca_select_driver(dp))
     {
         free(dp);
+#if defined(HAVE_ERRNO_H)
+        errno = ENODEV;
+#endif
         return NULL;
     }
@@ -58 +76 @@
     {
         free(dp);
+#if defined(HAVE_ERRNO_H)
+        errno = ENODEV;
+#endif
         return NULL;
     }
@@ -100 +121 @@
  *  attached to it afterwards.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca graphical context.
- */
-void caca_free_display(caca_display_t *dp)
+ *  \return This function always returns 0.
+ */
+int caca_free_display(caca_display_t *dp)
 {
     dp->drv.end_graphics(dp);
     dp->cv->refcount--;
     free(dp);
+
+    return 0;
 }
 
@@ -113 +139 @@
  */
 
-static int caca_init_driver(caca_display_t *dp)
+static int caca_select_driver(caca_display_t *dp)
 {
 #if defined(HAVE_GETENV) && defined(HAVE_STRCASECMP)

libcaca/trunk/caca/caca.h

@@ -151 +151 @@
  *  @{ */
 caca_display_t * caca_create_display(cucul_canvas_t *);
-void caca_free_display(caca_display_t *);
-void caca_refresh_display(caca_display_t *);
-void caca_set_display_time(caca_display_t *, unsigned int);
+int caca_free_display(caca_display_t *);
+int caca_refresh_display(caca_display_t *);
+int caca_set_display_time(caca_display_t *, unsigned int);
 unsigned int caca_get_display_time(caca_display_t *);
 unsigned int caca_get_display_width(caca_display_t *);
@@ -169 +169 @@
 unsigned int caca_get_mouse_x(caca_display_t *);
 unsigned int caca_get_mouse_y(caca_display_t *);
-void caca_set_mouse(caca_display_t *, int);
+int caca_set_mouse(caca_display_t *, int);
 /*  @} */
 

libcaca/trunk/caca/driver_conio.c

@@ -80 +80 @@
 static int conio_set_display_title(caca_display_t *dp, char const *title)
 {
-    return 0;
+    return -1;
 }
 

libcaca/trunk/caca/driver_ncurses.c

@@ -179 +179 @@
 static int ncurses_set_display_title(caca_display_t *dp, char const *title)
 {
-    return 0;
+    return -1;
 }
 

libcaca/trunk/caca/driver_raw.c

@@ -40 +40 @@
 static int raw_set_display_title(caca_display_t *dp, char const *title)
 {
-    return 0;
+    return -1;
 }
 

libcaca/trunk/caca/driver_slang.c

@@ -184 +184 @@
 {
     /* FIXME */
-    return 0;
+    return -1;
 }
 

libcaca/trunk/caca/driver_vga.c

@@ -98 +98 @@
 {
     /* Unsupported, of course. */
-    return 0;
+    return -1;
 }
 

libcaca/trunk/caca/event.c

@@ -45 +45 @@
  *  This function polls the event queue for mouse or keyboard events matching
  *  the event mask and returns the first matching event. Non-matching events
- *  are discarded. \c event_mask must have a non-zero value.
+ *  are discarded. If \c event_mask is zero, the function returns immediately.
  *
  *  The timeout value tells how long this function needs to wait for an
@@ -55 +55 @@
  *  received. If null, the function will return but no information about
  *  the event will be sent.
+ *
+ *  This function never fails.
  *
  *  \param dp The libcaca graphical context.
@@ -118 +120 @@
  *  the mouse is clicked. Other drivers such as X11 work well.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca graphical context.
  *  \return The X mouse coordinate.
@@ -135 +139 @@
  *  drivers are being used, because mouse position is only detected when
  *  the mouse is clicked. Other drivers such as X11 work well.
+ *
+ *  This function never fails.
  *
  *  \param dp The libcaca graphical context.

libcaca/trunk/caca/graphics.c

@@ -19 +19 @@
 #include "common.h"
 
+#if !defined(__KERNEL__)
+#   if defined(HAVE_ERRNO_H)
+#       include <errno.h>
+#   endif
+#endif
+
 #include "caca.h"
 #include "caca_internals.h"
@@ -27 +33 @@
  *
  *  If libcaca runs in a window, try to change its title. This works with
- *  the X11 and Win32 drivers.
+ *  the OpenGL, X11 and Win32 drivers.
+ *
+ *  If an error occurs, -1 is returned and \b errno is set accordingly:
+ *  - \c ENOSYS Display driver does not support setting the window title.
  *
  *  \param dp The libcaca display context.
  *  \param title The desired display title.
- *  \return 0 upon success, a non-zero value if an error occurs.
+ *  \return 0 upon success, -1 if an error occurred.
  */
 int caca_set_display_title(caca_display_t *dp, char const *title)
 {
-    return dp->drv.set_display_title(dp, title);
+    int ret = dp->drv.set_display_title(dp, title);
+
+#if defined(HAVE_ERRNO_H)
+    if(ret)
+        errno = ENOSYS;
+#endif
+
+    return ret;
 }
 
@@ -45 +61 @@
  *  6x10 font is being used. Note that the units are not necessarily pixels.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca display context.
  *  \return The display width.
@@ -60 +78 @@
  *  used. Note that the units are not necessarily pixels.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca display context.
  *  \return The display height.
@@ -77 +97 @@
  *  default behaviour.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca display context.
  *  \param usec The refresh delay in microseconds.
- */
-void caca_set_display_time(caca_display_t *dp, unsigned int usec)
+ *  \return This function always returns 0.
+ */
+int caca_set_display_time(caca_display_t *dp, unsigned int usec)
 {
     dp->delay = usec;
+    return 0;
 }
 
@@ -93 +117 @@
  *  delay even if the real rendering time was shorter.
  *
+ *  This function never fails.
+ *
  *  \param dp The libcaca display context.
  *  \return The render time in microseconds.
@@ -113 +139 @@
  *  the second call will be delayed before performing the screen refresh.
  *
- *  \param dp The libcaca display context.
- */
-void caca_refresh_display(caca_display_t *dp)
+ *  This function never fails.
+ *
+ *  \param dp The libcaca display context.
+ *  \return This function always returns 0.
+ */
+int caca_refresh_display(caca_display_t *dp)
 {
 #if !defined(_DOXYGEN_SKIP_ME)
@@ -148 +177 @@
     if(dp->lastticks > (int)dp->delay)
         dp->lastticks = 0;
+
+    return 0;
 }
 
@@ -155 +186 @@
  *  support it.
  *
+ *  If an error occurs, -1 is returned and \b errno is set accordingly:
+ *  - \c ENOSYS Display driver does not support hiding the mouse pointer.
+ *
  *  \param dp The libcaca display context.
  *  \param flag 0 hides the pointer, 1 shows the system's default pointer
  *              (usually an arrow). Other values are reserved for future use.
- */
-void caca_set_mouse(caca_display_t *dp, int flag)
-{
-    if(dp->drv.set_mouse)
-        dp->drv.set_mouse(dp, flag);
+ *  \return 0 upon success, -1 if an error occurred.
+ */
+int caca_set_mouse(caca_display_t *dp, int flag)
+{
+    if(!dp->drv.set_mouse)
+    {
+#if defined(HAVE_ERRNO_H)
+        errno = ENOSYS;
+#endif
+        return -1;
+    }
+
+    dp->drv.set_mouse(dp, flag);
+    return 0;
 }