*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index 28427456115ff2807ce123fa32173d3a71b792bb..815e8b44a24044d9506352415664ec0a7c475c01 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -24,6 +24,10 @@ FILESETS
         #define EV_STANDALONE   1
         #include "ev.h"
 
         #define EV_STANDALONE   1
         #include "ev.h"
 

+    Both header files and implementation files can be compiled with a C++
+    compiler (at least, thats a stated goal, and breakage will be treated
+    as a bug).
+

     You need the following files in your source tree, or in a directory
     in your include path (e.g. in libev/ when using -Ilibev):
 
     You need the following files in your source tree, or in a directory
     in your include path (e.g. in libev/ when using -Ilibev):
 


@@ -33,7 +37,7 @@ FILESETS
         ev_wrap.h
         ev_win32.c
 
         ev_wrap.h
         ev_win32.c
 

-        ev_select.c     only when select backend is enabled (which is by default)
+        ev_select.c     only when select backend is enabled (which is is by default)

         ev_poll.c       only when poll backend is enabled (disabled by default)
         ev_epoll.c      only when the epoll backend is enabled (disabled by default)
         ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)
         ev_poll.c       only when poll backend is enabled (disabled by default)
         ev_epoll.c      only when the epoll backend is enabled (disabled by default)
         ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)


@@ -126,6 +130,18 @@ PREPROCESSOR SYMBOLS
        will be detected at runtime and routed around by disabling this
        backend.
 
        will be detected at runtime and routed around by disabling this
        backend.
 

+    EV_H
+
+        The name of the ev.h header file used to include it. The default
+        if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
+        be used to virtually rename the ev.h header file in case of
+        conflicts.
+
+    EV_EVENT_H
+
+        Similarly to EV_H, this macro cna be used to override event.c's idea
+        of how the event.h header can be found.
+

     EV_COMMON
  
        By default, all watchers have a "void *data" member. By redefining
     EV_COMMON
  
        By default, all watchers have a "void *data" member. By redefining


@@ -154,6 +170,18 @@ PREPROCESSOR SYMBOLS
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 

+    EV_CB_DECLARE(type)
+    EV_CB_INVOKE(watcher,revents)
+    ev_set_cb(ev,cb)
+
+       Can be used to change the callback member declaration in each
+       watcher, and the way callbacks are invoked and set. Must expand
+       to a struct member definition and a statement, respectively. See
+       the ev.v header file for their default definitions. One possible
+       use for overriding these is to avoid the ev_loop pointer as first
+       argument in all cases, or to use method calls instead of plain
+       function calls in C++.
+

 EXAMPLES
 
     For a real-world example of a program the includes libev
 EXAMPLES
 
     For a real-world example of a program the includes libev