Merge pull request #8 from msoucy/master

Examples and documentation

Author: WalterBright

README

@@ -4,12 +4,6 @@ There will be bugs.  This is simply too large of a library for me to test every
 If you have any trouble, or think that something should be fixed, create a bug report and I'll get right on it.
 
 WARNINGS:
-	ACS vars currently break from the norm, I'm looking into it, but I'm not sure if It can
-	be done exactly the same that C does it.
-	////instead of writing "addch(ACS_ULCORNER);", Instead write "addch(acs_map[ACS.ULCORNER]);". fixed
-	Instead of writing "addch(ACS_ULCORNER);", Instead write "addch(ACS_ULCORNER());"
-	I think that this is as close as we are going to get without digging through the source to extract what acs_map[] really is.
-
 	This should work for most of your needs, however there are still one or two more things that need to be done.
 	I plan on having those completed in the next few days.
 	I'm actually not entirely sure what still needs to be done.  Someone told me that this was a macro library.

deimos/ncurses/form.d

@@ -32,6 +32,8 @@
 
 /* $Id: form.h,v 0.21 2009/11/07 19:31:11 tom Exp $ */
 
+module deimos.ncurses.form;
+
 
 import std.c.stdarg;
 public import deimos.ncurses.ncurses;

deimos/ncurses/ncurses.d

@@ -32,3 +32,4 @@
 module deimos.ncurses.ncurses;
 
 public import deimos.ncurses.curses;
+alias deimos.ncurses.curses.clear nclear;

examples/hello_unicode.d

@@ -0,0 +1,34 @@
+/**  hello_unicode.d
+ *
+ * This is a demonstration of Unicode output with ncurses in D.
+ *
+ * The functionality of this code is otherwise identical to hello_world.d
+ *
+ * Requirements for Unicode in ncurses:
+ *  - You need to link against ncursesw instead of ncurses.  If you don't have ncursesw, rebuild
+ *    ncurses with --enable-widec (and file a bug with your distro where applicable).
+ *  - You need to be using a Unicode locale. If your $LANG looks something like `en_US.utf8`,
+ *    then you're in good shape.  Keep in mind that users don't like when you force a locale; do
+ *    it only if you think it's really necessary.
+ *
+ * Modified by: Wyatt
+ */
+import std.string: toStringz;
+import std.c.locale; // Need setlocale()
+import deimos.ncurses.ncurses;
+
+void main()
+{
+    setlocale(LC_CTYPE,""); // You need to set the empty locale to use upper-plane glyphs
+                            // This sets the locale based on local variables. On most Unix-
+                            // like systems, you can use the `locale` command to show the 
+                            // current settings for your environment.
+
+    auto hello = toStringz("日本語からの「Hello World!」");
+
+    initscr();              //initialize the screen
+    printw(hello);          //prints the char[] hello to the screen
+    refresh();              //actually does the writing to the physical screen
+    getch();                //gets a single character from the screen.
+    endwin();               //Routine to call before exiting, or leaving curses mode temporarily
+}

examples/menu_scroll.d

@@ -55,9 +55,9 @@ int main()
     /* Print a border around the main window and print a title */
         box(my_menu_win, 0, 0);
     print_in_middle(my_menu_win, 1, 0, 40, "My Menu", COLOR_PAIR(1));
-    mvwaddch(my_menu_win, 2, 0, acs_map[ACS.LTEE]);
-    mvwhline(my_menu_win, 2, 1, acs_map[ACS.HLINE], 38);
-    mvwaddch(my_menu_win, 2, 39, acs_map[ACS.RTEE]);
+    mvwaddch(my_menu_win, 2, 0, ACS_LTEE);
+    mvwhline(my_menu_win, 2, 1, ACS_HLINE, 38);
+    mvwaddch(my_menu_win, 2, 39, ACS_RTEE);
 
     /* Post the menu */
     post_menu(my_menu);
@@ -99,7 +99,7 @@ int main()
 }
 
 void print_in_middle(WINDOW *win, int starty, int startx, int width, string strtemp, chtype color)
-{   int length, x, y;
+{   int x, y;
     float temp;
 
     if(win == null)
@@ -112,7 +112,7 @@ void print_in_middle(WINDOW *win, int starty, int startx, int width, string strt
     if(width == 0)
         width = 80;
 
-    length = strtemp.length;
+    auto length = strtemp.length;
     temp = (width - length)/ 2;
     x = startx + cast(int)temp;
     wattron(win, color);

examples/mouse_menu.d

@@ -1,4 +1,3 @@
-
 import std.string: toStringz;
 import deimos.ncurses.ncurses;
 
@@ -18,7 +17,7 @@ void main()
     MEVENT event;
 
     initscr();                      //hopefully you've seen all of this before.
-    clear();
+    nclear();
     noecho();
     cbreak();
     keypad(stdscr, true);
@@ -83,7 +82,7 @@ void print_menu(WINDOW* menu_win, int highlight)
 
     box(menu_win, 0, 0);
 
-    foreach(i, choice; choices)
+    foreach(int i, choice; choices)
     {
         if(highlight == i + 1)
             wattron(menu_win, A_REVERSE);
@@ -100,7 +99,7 @@ int report_choice(int mouse_x, int mouse_y)
     int i = startx + 2;
     int j = starty + 3;
     int report = 0;
-    foreach(choice, str; choices)
+    foreach(int choice, str; choices)
     {
         if((mouse_y == j + choice) && (mouse_x >= i) && (mouse_x <= i+str.length))
         {

examples/printw_example.d

@@ -1,5 +1,6 @@
 //Modified by: 1100110
 
+import std.conv;
 import std.string;
 import deimos.ncurses.ncurses;				/* ncurses.h includes stdio.h */  
 
@@ -11,7 +12,7 @@ void main()
 	initscr();								//start the curses mode 
 	getmaxyx(stdscr, row, col);				//get the number of rows and columns
 	//print the message at the center of the screen 
-	mvprintw(row/2, (col-(mesg.length - 1))/2, "%s", toStringz(mesg));
+	mvprintw(row/2, to!uint((col-(mesg.length - 1))/2), "%s", toStringz(mesg));
 	//Did you notice? there is a '%s' not toStringified.
 	//In one of those great weird blips, D2 will pass small characters
 	//like that, and yet will choke on larger strings.

examples/simple_key.d

@@ -17,7 +17,7 @@ int main()
     int c;
 
     initscr();
-    clear();
+    nclear();
     noecho();
     cbreak();   /* Line buffering disabled. pass on everything */
     scope(exit) endwin();

examples/simple_spectrum.d

@@ -0,0 +1,59 @@
+//simple_spectrum: Sample of 256-colour ncurses output in D.
+//Modified by: Wyatt
+
+import std.stdio: writeln;
+import std.conv;
+import deimos.ncurses.ncurses;
+
+//Extended colour support was added in ncurses 5.5 for the wncurses
+//library.  wncurses has generally been shipped by default in Linux
+//distros for roughly the last decade as of this writing (often as the
+//only version installed); if this doesn't work, check that your TERM
+//is compatible with 256-colour modes, that your terminal emulator
+//supports it, and that your copy of ncurses is built with
+//--enable-ext-colors.  If the latter is false, you may wish to file a
+//bug with your distro.
+
+int main()
+{
+    initscr();
+    if(has_colors() == false)
+    {
+        endwin();
+        writeln("Your terminal does not support color...");
+        return 1;                           //ends the program
+    }
+    start_color();
+    foreach(ushort i; 0 .. 256){ // Define all the colours with the default palette
+        init_pair(i, 0, i);      // We're only setting the background here;
+    }                            // The space is rendered as nothing.
+
+    auto w = COLS/9; // Let's just fill all the horizontal space
+    
+    // Basic colours
+    foreach(ushort i; 0 .. 16){
+        attron(COLOR_PAIR(i));
+        mvwhline(stdscr, cast(int)(i%8),w*(i/8),to!size_t(' '),w);//chtype is a size_t by spec.
+        attroff(COLOR_PAIR(i));
+    }
+    
+    // 6x6x6 cubemap
+    foreach(ushort i; 16 .. 232){
+        attron(COLOR_PAIR(i));
+        mvwhline(stdscr, cast(int)((i-16)%36),(2*w+w*((i-16)/36)),to!size_t(' '),w);
+        attroff(COLOR_PAIR(i));
+    }
+    
+    // Greyscale
+    foreach(ushort i; 232 .. 256){
+        attron(COLOR_PAIR(i));
+        mvwhline(stdscr, cast(int)(i-232),(8*w),to!size_t(' '),w);
+        attroff(COLOR_PAIR(i));
+    }
+    
+    wmove(stdscr, LINES-1, COLS-1);//Moving this out of the way
+    getch();
+    endwin();
+
+    return 0;
+}

examples/with_chgat.d

@@ -7,7 +7,7 @@ void main()
 
     init_pair(1, COLOR_CYAN, COLOR_BLACK);
     printw(toStringz("A Big string which i didn't care to type fully... "));
-    mvchgat(0, 0, -1, cast(attr_t)A_BLINK, cast(short)1, null);
+    mvchgat(0, 0, -1, cast(attr_t)A_BLINK, cast(short)1, cast(void*)null);
     /*
      * First two parameters specify the position at which to start
      * Third parameter number of characters to update. -1 means till