benches/strings: add .gitignore and `make clean`
[nit.git] / lib / curses / curses.nit
index 158d957..084b68a 100644 (file)
 # limitations under the License.
 
 # Curses for Nit
-module curses
+module curses is pkgconfig("ncurses")
 
 in "C header" `{
        #include <ncurses.h>
 `}
 
 # A curse windows
-extern Window `{WINDOW *`}
+extern class Window `{WINDOW *`}
        # Initialize the screen
        new `{
                WINDOW *res;
@@ -35,22 +35,29 @@ extern Window `{WINDOW *`}
                return res;
        `}
 
-       # print a string somewhere
+       # Move the cursor at the position (y,x) and print a string
        # NOTE: as with the curses API, the position is (y,x)
        fun mvaddstr(y,x: Int, str: String) import String.to_cstring `{
                char *c_string = String_to_cstring( str );
                mvaddstr(y, x, c_string);
        `}
 
+       # Update the window
        fun refresh `{
                refresh();
        `}
+
+       # Clear the entire window so it can be repainted from scratch with a refresh
        fun wclear `{
                wclear(recv);
        `}
+
+       # Delete the window
        fun delwin `{
                delwin(recv);
        `}
+
+       # Suspend the curses session and restore the previous terminal
        fun endwin `{
                endwin();
        `}