diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/NCURSES-Programming-HOWTO.sgml b/LDP/howto/docbook/NCURSES-Programming-HOWTO/NCURSES-Programming-HOWTO.sgml new file mode 100644 index 00000000..16b08eef --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/NCURSES-Programming-HOWTO.sgml @@ -0,0 +1,3966 @@ + + + + +
+ + NCURSES Programming HOWTO + + Pradeep + Padala + +
p_padala@yahoo.com
+ + + + + + 1.7.1 + 2002-06-25 + ppadala + Added a README file for building and instructions + for building from source. + + + + + 1.7 + 2002-06-25 + ppadala + Added "Other formats" section and made lot of fancy + changes to the programs. Inlining of programs is gone. + + + + + 1.6.1 + 2002-02-24 + ppadala + Removed the old Changelog section, cleaned the makefiles + + + + + 1.6 + 2002-02-16 + ppadala + Corrected lot of spelling mistakes, added ACS variables + section + + + + 1.5 + 2002-01-05 + ppadala + Changed structure to present proper TOC + + + + 1.3.1 + 2001-07-26 + ppadala + Corrected maintainers paragraph, Corrected stable release number + + + + + 1.3 + 2001-07-24 + ppadala + Added copyright notice(LDP license) to main document, + Put copyright notice (GPL) for programs as well, Corrected + printw_example. + + + + + 1.2 + 2001-06-05 + ppadala + Incorporated ravi's changes. Mainly to introduction, menu, + form, justforfun sections + + + + + 1.1 + 2001-05-22 + ppadala + Added "a word about window" section, Added scanw_example. + + + + + v1.7.1, 2002-06-25 + + + +This document is intended to be an "All in One" guide for programming with +ncurses and its sister libraries. We graduate from a simple "Hello World" +program to more complex form manipulation. No prior experience in ncurses is +assumed. Latest version of the document can always be found at +my web site +. Send comments to this address + + + + + + + + Introduction + +In the olden days of teletype terminals, terminals were away from computers and +were connected to them through serial cables. The terminals could be configured +by sending a series of bytes to each of them. All the capabilities (such as +moving the cursor to a new location, erasing part of the screen, scrolling the +screen, changing modes, changing appearance, colors, brightness, blinking, +underlining, reverse video etc.) of terminals could be accessed through these +series of bytes which are usually called escape sequences because they start +with an escape(0x1B) character. Even today, with proper emulation, we can send +escape sequences to the emulator and achieve the same effect on the terminal +window. + + + +Suppose you wanted to print a line in color. Try typing this on your console. + + + +echo "^[[0;31;40mIn Color" + + + +The first character is an escape character, which looks like two characters ^ +and [. To be able to print that you have to press CTRL+V and then the ESC key. +All the others are normal printable characters. You should be able to see the +string "In Color" in red. It stays that way and to revert back to the original +mode type this. + + + +echo "^[[0;37;40m" + + + +Now, what do those magic characters mean? Difficult to comprehend? They might +even be different for different terminals. So the designers of UNIX invented a +mechanism named termcap. It is a file that +lists all the capabilities of a particular terminal, along with the escape +sequences needed to achieve a particular effect. In the later years, this was +replaced by terminfo. Without delving too +much into details, the concept of the mechanism is to allow application +programs query the terminfo database and obtain the control characters to be +sent to the terminal or terminal emulator. + + + What is NCURSES? + +You might be wondering, what the import of all this technical gibberish is. In +the above scenario, every application program is supposed to query the terminfo +and do the necessary stuff(sending control characters etc.). It soon became +difficult to manage this complexity and this gave birth to 'CURSES'. Curses is +a pun on the name "cursor optimization". The Curses library forms a wrapper +over working with raw terminal codes, and provides highly flexible and +efficient API (Application Programming Interface). It provides functions to +move the cursor, create windows, produce colors, play with mouse etc. The +Application programs need not worry about the underlying terminal capabilities. + + + +So what is NCURSES? NCURSES is a clone of the original System V Release 4.0 +(SVr4) curses. It is a freely distributable library, fully compatible with +older version of curses. In short, it is a library of functions that manages +an application's display on character-cell terminals. In the remainder of the +document, the terms curses and ncurses are used interchangeably. + + + +The ncurses package was originated by Pavel +Curtis. The original maintainer of this package is Zeyd Ben-Halim +zmbenhal@netcom.com. Eric S. Raymond +esr@snark.thyrsus.com wrote many of the new features in versions +after 1.8.1. Jürgen +Pfeifer wrote all of the menu and forms code as well as the Ada95 binding. Ongoing work is being done +by Thomas Dickey and +Jürgen Pfeifer. +Florian La Roche acts as the +maintainer for the Free Software Foundation, which holds the copyright on +ncurses. Contact the current maintainers at bug-ncurses@gnu.org. + + + + + What we can do with NCURSES + + +Ncurses not only creates a wrapper over terminal capabilities, but also gives a +robust framework to create nice looking UI (User Interface)s in text mode. It +provides functions to create windows etc. Its sister libraries panel, menu and +form provide an extension to the basic curses library. These libraries usually +come along with curses. One can create applications that contain multiple +windows, menus, panels and forms. Windows can be managed independently, can +provide 'scrollability' and even can be hidden. + + + +Menus provide the user with an easy command selection option. Forms allow the +creation of easy-to-use data entry and display windows. Panels extend the +capabilities of ncurses to deal with overlapping and stacked windows. + + + +These are just some of the basic things we can do with ncurses. As we move +along, We will see all the capabilities of these libraries. + + + +Where to get it + + +All right, now that you know what you can do with ncurses, you must be rearing +to get started. Ncurses is usually shipped with your installation. In case +you don't have the library or want to compile it on your own, read on. + + +Compiling the package + + +Ncurses can be obtained from +ftp://ftp.gnu.org/pub/gnu/ncurses/ncurses.tar.gz or any of the ftp +sites mentioned in +http://www.gnu.org/order/ftp.html. The latest stable release is 5.2 +20001021. + + + +Read the README and INSTALL files for details on to how to install it. It +usually involves the following operations. + + + + tar zxvf ncurses<version>.tar.gz # unzip and untar the archive + cd ncurses<version> # cd to the directory + ./configure # configure the build according to your + # environment + make # make it + su root # become root + make install # install it + + +Using the RPM + + +Ncurses RPM can be found and downloaded from +http://rpmfind.net . The RPM can be installed with the following +command after becoming root. + + + + rpm -i <downloaded rpm> + + + +Purpose/Scope of the document + +This document is intended to be a "All in One" guide for programming with +ncurses and its sister libraries. We graduate from a simple "Hello World" +program to more complex form manipulation. No prior experience in ncurses is +assumed. + + + +About the Programs + +All the programs in the document are available in zipped form + +here. Unzip and untar it. The directory structure looks like this. + + + +ncurses + | + |----> JustForFun -- just for fun programs + |----> basics -- basic programs + |----> demo -- output files go into this directory after make + | | + | |----> exe -- exe files of all example programs + |----> forms -- programs related to form library + |----> menus -- programs related to menus library + |----> panels -- programs related to panels library + |----> Makefile -- the top level Makefile + |----> README -- the top level README file. contains instructions + |----> COPYING -- copyright notice + + + +The individual directories contain the following files. + + + +Description of files in each directory +-------------------------------------- +JustForFun + | + |----> hanoi.c -- The Towers of Hanoi Solver + |----> life.c -- The Game of Life demo + |----> magic.c -- An Odd Order Magic Square builder + |----> queens.c -- The famous N-Queens Solver + |----> shuffle.c -- A fun game, if you have time to kill + |----> tt.c -- A very trivial typing tutor + + basics + | + |----> acs_vars.c -- ACS_ variables example + |----> hello_world.c -- Simple "Hello World" Program + |----> init_func_example.c -- Initialization functions example + |----> key_code.c -- Shows the scan code of the key pressed + |----> mouse_menu.c -- A menu accessible by mouse + |----> other_border.c -- Shows usage of other border functions apa + | -- rt from box() + |----> printw_example.c -- A very simple printw() example + |----> scanw_example.c -- A very simple getstr() example + |----> simple_attr.c -- A program that can print a c file with + | -- comments in attribute + |----> simple_color.c -- A simple example demonstrating colors + |----> simple_key.c -- A menu accessible with keyboard UP, DOWN + | -- arrows + |----> temp_leave.c -- Demonstrates temporarily leaving curses mode + |----> win_border.c -- Shows Creation of windows and borders + |----> with_chgat.c -- chgat() usage example + + forms + | + |----> form_attrib.c -- Usage of field attributes + |----> form_options.c -- Usage of field options + |----> form_simple.c -- A simple form example + |----> form_win.c -- Demo of windows associated with forms + + menus + | + |----> menu_attrib.c -- Usage of menu attributes + |----> menu_item_data.c -- Usage of item_name() etc.. functions + |----> menu_multi_column.c -- Creates multi columnar menus + |----> menu_scroll.c -- Demonstrates scrolling capability of menus + |----> menu_simple.c -- A simple menu accessed by arrow keys + |----> menu_toggle.c -- Creates multi valued menus and explains + | -- REQ_TOGGLE_ITEM + |----> menu_userptr.c -- Usage of user pointer + |----> menu_win.c -- Demo of windows associated with menus + + panels + | + |----> panel_browse.c -- Panel browsing through tab. Usage of user + | -- pointer + |----> panel_hide.c -- Hiding and Un hiding of panels + |----> panel_resize.c -- Moving and resizing of panels + |----> panel_simple.c -- A simple panel example + + + +There is a top level Makefile included in the main directory. It builds all the +files and puts the ready-to-use exes in demo/exe directory. You can also +do selective make by going into the corresponding directory. Each directory +contains a README file explaining the purpose of each c file in the directory. + + + +For every example I have given the path name for the file relative to the +ncurses directory. + + + If you prefer you can browse individual programs at +http://tldp.org/HOWTO/NCURSES-Programming-HOWTO/ncurses_programs/ + + + +All the programs are released under GPL and you can use them for any +thing you like. + + + +Other Formats of the document + + +This howto is also availabe in various other formats on the tldp.org site. +Here are the links to other formats of this document. + + +Readily available formats from tldp.org + + + + +Acrobat PDF Format + + + + + +PostScript Format + + + + + +In Multiple HTML pages + + + + + +In One big HTML format + + + + + + + Building from source + +If above links are broken or if you want to experiment with sgml read on. + + + Get both the source and the tar,gzipped programs, available at + http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/ + NCURSES-HOWTO/NCURSES-Programming-HOWTO.sgml + http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/ + NCURSES-HOWTO/ncurses_programs.tar.gz + + Unzip ncurses_programs.tar.gz with + tar zxvf ncurses_programs.tar.gz + + Use jade to create various formats. For example if you just want to create + the multiple html files, you would use + jade -t sgml -i html -d <path to docbook html stylesheet> + NCURSES-Programming-HOWTO.sgml + to get pdf, first create a single html file of the HOWTO with + jade -t sgml -i html -d <path to docbook html stylesheet> -V nochunks + NCURSES-Programming-HOWTO.sgml > NCURSES-ONE-BIG-FILE.html + then use htmldoc to get pdf file with + htmldoc --size universal -t pdf --firstpage p1 -f <output file name.pdf> + NCURSES-ONE-BIG-FILE.html + for ps, you would use + htmldoc --size universal -t ps --firstpage p1 -f <output file name.ps> + NCURSES-ONE-BIG-FILE.html + + + + +See +LDP Author guide for more details. If all else failes, mail me at +p_padala@yahoo.com + + + + + +Credits + + +I thank Sharath and Emre Akbas for +helping me with few sections. The introduction was initially written by sharath. +I rewrote it with few excerpts taken from his initial work. Emre helped in +writing printw and scanw sections. + + + +Then comes Ravi Parimi, my +dearest friend, who has been on this project before even one line was written. +He constantly bombarded me with suggestions and patiently reviewed the whole +text. He also checked each program on Linux and Solaris. See his notes to check +on your problems. + + + + +Wish List + + +This is the wish list, in the order of priority. If you have a wish or you want +to work on completing the wish, mail me +. + + + + + +Add examples to last parts of forms section. (I am working on it) + + + + +Prepare a Demo showing all the programs and allow the user to browse through +description of each program. Let the user compile and see the program in action. +A dialog based interface is preferred. (My friend N.N.Ashok is working on it) + + + + +Add debug info. _tracef, _tracemouse stuff. + + + +Accessing termcap, terminfo using functions provided by ncurses +package. + + +Working on two terminals simultaneously. +Add things in miscellaneous section. + + + +Copyright + +Copyright (c) 2001 by Pradeep Padala. This document may be distributed under the +terms set forth in the LDP license at linuxdoc.org/COPYRIGHT.html. + + + +This HOWTO is free documentation; you can redistribute it and/or modify it under +the terms of the LDP license. This document is distributed in the hope that it +will be useful, but without any warranty; +without even the implied warranty of merchantability + or fitness for a particular purpose +. See the LDP license for more details. + + + + +The Hello World Program + + +Welcome to the world of curses. Before we plunge into the library and look into +its various features, bells and whistles, let's write a simple program and say +hello to the world. + + + Compiling With the Ncurses Library + + +To use ncurses library functions, you have to include ncurses.h and to link the +program with ncurses library the flag -lncurses should be added. ncurses.h +already includes stdio.h. + + + + #include <ncurses.h> + . + . + . + + compile and link: gcc <program file> -lncurses + + + The Hello World !!! Program + + + + + + +Dissection + +The above program prints "Hello World !!!" to the screen and exits. This +program shows how to initialize curses and do screen manipulation and +end curses mode. Let's dissect it line by line. + + +About initscr() + +The function initscr() initializes the terminal in curses mode. In some +implementations it clears the screen and presents a blank screen. To do any +screen manipulation using curses package this has to be called first. This +function initializes the curses system and allocates memory for our present +window which is called 'stdscr' and some other data-structures. Under extreme +cases this function might fail due to insufficient memory to allocate memory +for curses library's data structures. + + + +After this is done we can do a variety of initializations to customize +our curses settings. These details will be explained +later . + + + + +The mysterious refresh() + + +The next line printw prints the string "Hello World !!!" on to the screen. This +function is analogous to normal printf in all respects except that it prints +the data in a window called stdscr at the current (y,x) co-ordinates. Since our +present co-ordinates are at 0,0 the string is printed at the left hand corner +of the window. + + + +This brings us to that mysterious refresh(). Well, when we did printw actually +the data is written to an imaginary window called stdscr, which is not updated +on the screen yet. The job of printw is to update a few flags +and data structures and write the data to a buffer corresponding to stdscr. +In order to bring it to the screen we need to call refresh() and tell the +curses system to dump the contents on the screen. + + + +The philosophy behind all this is to allow the programmer to do multiple updates +on the imaginary screen or windows and do a refresh once all his screen update +is done. refresh() checks the window and updates only the portion which has been +changed. This gives good response and offers greater flexibility too. But it is +sometimes frustrating to beginners. A common mistake committed by beginners is +to forget to call refresh() after they did some update through printw() class of +functions. I still forget to add it sometimes :-) + + + +About endwin() + +And finally don't forget to end the curses mode. Otherwise your terminal might +behave strangely after the program quits. endwin() frees the memory taken by +curses sub-system and it's data structures and puts the terminal in normal +mode. This function must be called after you are done with the curses mode. + + + + + +The Gory Details + + +Now that we have seen how to write a simple curses program let's get into the +details. There are many functions that help customize what you see on screen and +many features which can be put to full use. + + +Here we go... + + + Initialization + +We now know that to initialize curses system the function initscr() has to be +called. There are functions which can be called after this initialization to +customize our curses session. We may ask the curses system to set the terminal +in raw mode or initialize color or initialize the mouse etc.. Let's discuss some +of the functions that are normally called immediately after initscr(); + + +About Initialization functions like raw() etc... + + + +raw() and cbreak() + +Normally the terminal driver buffers the characters a user types until a new +line or carriage return is encountered. But most programs require that the +characters be available as soon as the user types them. The above two functions +are used to disable line buffering. The difference between these two functions +is in the way control characters like suspend (CTRL-Z), interrupt and quit +(CTRL-C) are passed to the program. In the raw() mode these characters are +directly passed to the program without generating a signal. In the +cbreak() mode these control characters are +interpreted as any other character by the terminal driver. I personally prefer +to use raw() as I can exercise greater control over what the user does. + + + +echo() and noecho() + +These functions control the echoing of characters typed by the user to the +terminal. noecho() switches off echoing. The +reason you might want to do this is to gain more control over echoing or to +suppress unnecessary echoing while taking input from the user through the +getch() etc. functions. Most of the interactive programs call +noecho() at initialization and do the echoing +of characters in a controlled manner. It gives the programmer the flexibility +of echoing characters at any place in the window without updating current (y,x) +co-ordinates. + + + +keypad() + +This is my favorite initialization function. It enables the reading of function +keys like F1, F2, arrow keys etc. Almost every interactive program enables this, +as arrow keys are a major part of any User Interface. Do +keypad(stdscr, TRUE) to enable this feature +for the regular screen (stdscr). You will learn more about key management in +later sections of this document. + + + +halfdelay() + +This function, though not used very often, is a useful one at times. +halfdelay()is called to enable the half-delay mode, which is similar to the +cbreak() mode in that characters typed are immediately available to program. +However, it waits for 'X' tenths of a second for input and then returns ERR, if +no input is available. 'X' is the timeout value passed to the function +halfdelay(). This function is useful when you want to ask the user for input, +and if he doesn't respond with in certain time, we can do some thing else. One +possible example is a timeout at the password prompt. + + + +Miscellaneous Initialization functions + +There are few more functions which are called at initialization to +customize curses behavior. They are not used as extensively as those mentioned +above. Some of them are explained where appropriate. + + + +An Example + + +Let's write a program which will clarify the usage of these functions. + + + Initialization Function Usage example + + + + + +This program is self-explanatory. But I used functions which aren't explained +yet. The function getch() is used to get a +character from user. It is equivalent to normal +getchar() except that we can disable the line +buffering to avoid <enter> after input. Look for more about +getch()and reading keys in the key management section . The functions attron and attroff +are used to switch some attributes on and off respectively. In the example I +used them to print the character in bold. These functions are explained in detail +later. + + + + +A Word about Windows + + +Before we plunge into the myriad ncurses functions, let me clear few things +about windows. Windows are explained in detail in following sections + + + +A Window is an imaginary screen defined by curses system. A window does not mean +a bordered window which you usually see on Win9X platforms. When curses is +initialized, it creates a default window named +stdscr which represents your 80x25 (or the size +of window in which you are running) screen. If you are doing simple tasks like +printing few strings, reading input etc., you can safely use this single window +for all of your purposes. You can also create windows and call functions which +explicitly work on the specified window. + + + +For example, if you call + + + + printw("Hi There !!!"); + refresh(); + + + +It prints the string on stdscr at the present cursor position. Similarly the +call to refresh(), works on stdscr only. + + + +Say you have created windows then you have to +call a function with a 'w' added to the usual function. + + + + wprintw(win, "Hi There !!!"); + wrefresh(win); + + + +As you will see in the rest of the document, naming of functions follow the +same convention. For each function there usually are three more functions. + + + + printw(string); /* Print on stdscr at present cursor position */ + mvprintw(y, x, string);/* Move to (y, x) then print string */ + wprintw(win, string); /* Print on window win at present cursor position */ + /* in the window */ + mvwprintw(win, y, x, string); /* Move to (y, x) relative to window */ + /* co-ordinates and then print */ + + + +Usually the w-less functions are macros which expand to corresponding w-function +with stdscr as the window parameter. + + + +About output functions like printw() + + +I guess you can't wait any more to see some action. Back to our odyssey of +curses functions. Now that curses is initialized, let's interact with +world. + + + +There are three classes of functions which you can use to do output on screen. + +addch() class: Print single character with attributes + +printw() class: Print formatted output similar to printf() + +addstr() class: Print strings + + + + +These functions can be used interchangeably and it's a matter of style as to +which class is used. Let's see each one in detail. + + + addch() class of functions + + +These functions put a single character into the current cursor location and +advance the position of the cursor. You can give the character to be printed but +they usually are used to print a character with some attributes. Attributes are +explained in detail in later sections of the +document. If a character is associated with an attribute(bold, reverse video +etc.), when curses prints the character, it is printed in that attribute. + + + +In order to combine a character with some attributes, you have two options: + + + + + +By OR'ing a single character with the desired attribute macros. These attribute +macros could be found in the header file +ncurses.h. For example, you want to print a +character ch(of type char) bold and underlined, you would call addch() as below. + + addch(ch | A_BOLD | A_UNDERLINE); + + + + + + +By using functions like attrset(),attron(),attroff() +. These functions are explained in the +Attributes section. Briefly, they manipulate the current attributes of +the given window. Once set, the character printed in the window are associated +with the attributes until it is turned off. + + + + + + +Additionally, curses provides some special +characters for character-based graphics. You can draw tables, horizontal or +vertical lines, etc. You can find all avaliable characters in the header file +ncurses.h. Try looking for macros beginning +with ACS_ in this file. + + + +mvaddch(), waddch() and mvwaddch() + + +mvaddch() is used to move the cursor to a +given point, and then print. Thus, the calls: + + move(row,col); /* moves the cursor to rowth row and colth column */ + addch(ch); + +can be replaced by + + mvaddch(row,col,ch); + + + + +waddch() is similar to +addch(), except that it adds a character into +the given window. (Note that addch() adds a +character into the window stdscr.) + + + +In a similar fashion mvwaddch() function is +used to add a character into the given window at the given coordinates. + + + +Now, we are familiar with the basic output function +addch(). But, if we want to print a string, it +would be very annoying to print it character by character. Fortunately, +ncurses provides +printf-like or +puts-like functions. + + + +printw() class of functions + + +These functions are similar to printf() with +the added capability of printing at any position on the screen. + + + printw() and mvprintw + +These two functions work much like printf(). +mvprintw() can be used to move the cursor to a +position and then print. If you want to move the cursor first and then print +using printw() function, use +move() first and then use +printw() though I see no point why one should +avoid using mvprintw(), you have the +flexibility to manipulate. + + + +wprintw() and mvwprintw + +These two functions are similar to above two except that they print in the +corresponding window given as argument. + + + +vwprintw() + +This function is similar to vprintf(). This can +be used when variable number of arguments are to be printed. + + + + A Simple printw example + A Simple printw example + + + + + + +Above program demonstrates how easy it is to use printw +. You just feed the coordinates and the message to be appeared +on the screen, then it does what you want. + + + +The above program introduces us to a new function +getmaxyx(), a macro defined in +ncurses.h. It gives the number of columns and +the number of rows in a given window. +getmaxyx() does this by updating the variables +given to it. Since getmaxyx() is not a function +we don't pass pointers to it, we just give two integer variables. + + + + +addstr() class of functions + + +addstr() is used to put a character string into +a given window. This function is similar to calling +addch() once for each character in a given +string. This is true for all output functions. There are other functions from +this family such as mvaddstr(),mvwaddstr() and +waddstr(), which obey the naming convention of +curses.(e.g. mvaddstr() is similar to the respective calls move() and then +addstr().) Another function of this family is addnstr(), which takes an integer +parameter(say n) additionally. This function puts at most n characters into the +screen. If n is negative, then the entire string will be added. + + + +A word of caution + +All these functions take y co-ordinate first and then x in their arguments. +A common mistake by beginners is to pass x,y in that order. If you are +doing too many manipulations of (y,x) co-ordinates, think of dividing the +screen into windows and manipulate each one separately. Windows are explained +in the windows section. + + + + +About input functions like scanw() + + +Well, printing without taking input, is boring. Let's see functions which +allow us to get input from user. These functions also can be divided into +three categories. + + + +getch() class: Get a character +scanw() class: Get formatted input +getstr() class: Get strings + + +getch() class of functions + +These functions read a single character from the terminal. But there are several +subtle facts to consider. For example if you don't use the function cbreak(), +curses will not read your input characters contiguously but will begin read them +only after a new line or an EOF is encountered. In order to avoid this, the +cbreak() function must used so that characters are immediately available to your +program. Another widely used function is noecho(). As the name suggests, when +this function is set (used), the characters that are keyed in by the user will +not show up on the screen. The two functions cbreak() and noecho() are typical +examples of key management. Functions of this genre are explained in the +key management section . + + + +scanw() class of functions + +These functions are similar to scanf() with the +added capability of getting the input from any location on the screen. + + +scanw() and mvscanw + +The usage of these functions is similar to that of +sscanf(), where the line to be scanned is +provided by wgetstr() function. That is, these +functions call to wgetstr() function(explained +below) and uses the resulting line for a scan. + + + +wscanw() and mvwscanw() + +These are similar to above two functions except that they read from a window, +which is supplied as one of the arguments to these functions. + + + +vwscanw() + +This function is similar to vscanf(). This can +be used when a variable number of arguments are to be scanned. + + + + +getstr() class of functions + +These functions are used to get strings from the terminal. In essence, this +function performs the same task as would be achieved by a series of calls to +getch() until a newline, carriage return, or +end-of-file is received. The resulting string of characters are pointed to by +str, which is a character pointer provided by +the user. + + + +Some examples + A Simple scanw example + + + + + + + +Attributes + +We have seen an example of how attributes can be used to print characters with +some special effects. Attributes, when set prudently, can present information in +an easy, understandable manner. The following program takes a C file as input +and prints the file with comments in bold. Scan through the code. + + + A Simple Attributes example + + + + + + +Don't worry about all those initialization and other crap. Concentrate on +the while loop. It reads each character in the file and searches for the +pattern /*. Once it spots the pattern, it switches the BOLD attribute on with + attron() . When we get the pattern */ it is +switched off by attroff() . + + + +The above program also introduces us to two useful functions +getyx() and +move(). The first function gets the +co-ordinates of the present cursor into the variables y, x. Since getyx() is a +macro we don't have to pass pointers to variables. The function +move() moves the cursor to the co-ordinates +given to it. + + + +The above program is really a simple one which doesn't do much. On these lines +one could write a more useful program which reads a C file, parses it and prints +it in different colors. One could even extend it to other languages as well. + + +The details + + +Let's get into more details of attributes. The functions +attron(), attroff(), attrset() , and their sister functions + attr_get() etc.. can be used to switch +attributes on/off , get attributes and produce a colorful display. + + + +The functions attron and attroff take a bit-mask of attributes and switch them +on or off, respectively. The following video attributes, which are defined in +<curses.h> can be passed to these functions. + + + + + A_NORMAL Normal display (no highlight) + A_STANDOUT Best highlighting mode of the terminal. + A_UNDERLINE Underlining + A_REVERSE Reverse video + A_BLINK Blinking + A_DIM Half bright + A_BOLD Extra bright or bold + A_PROTECT Protected mode + A_INVIS Invisible or blank mode + A_ALTCHARSET Alternate character set + A_CHARTEXT Bit-mask to extract a character + COLOR_PAIR(n) Color-pair number n + + + + +The last one is the most colorful one :-) Colors are explained in the +next sections. + + + +We can OR(|) any number of above attributes to get a combined effect. If you +wanted reverse video with blinking characters you can use + + + + attron(A_REVERSE | A_BLINK); + + + +attron() vs attrset() + + +Then what is the difference between attron() and attrset()? attrset sets the +attributes of window whereas attron just switches on the attribute given to it. +So attrset() fully overrides whatever attributes the window previously had and +sets it to the new attribute(s). Similarly attroff() just switches off the +attribute(s) given to it as an argument. This gives us the flexibility of +managing attributes easily.But if you use them carelessly you may loose track of +what attributes the window has and garble the display. This is especially true +while managing menus with colors and highlighting. So decide on a consistent +policy and stick to it. You can always use standend() + which is equivalent to attrset(A_NORMAL) + which turns off all attributes and brings you to normal mode. + + + +attr_get() + + + +The function attr_get() gets the current attributes and color pair of the +window. Though we might not use this as often as the above functions, this is +useful in scanning areas of screen. Say we wanted to do some complex update on +screen and we are not sure what attribute each character is associated with. +Then this function can be used with either attrset or attron to produce the +desired effect. + + + + +attr_ functions + +There are series of functions like attr_set(), attr_on etc.. These are similar +to above functions except that they take parameters of type +attr_t. + + + +wattr functions + +For each of the above functions we have a corresponding function with 'w' which +operates on a particular window. The above functions operate on stdscr. + + + +chgat() functions + +The function chgat() is listed in the end of the man page curs_attr. It actually +is a useful one. This function can be used to set attributes for a group of +characters without moving. I mean it !!! without moving the cursor :-) It +changes the attributes of a given number of characters starting at the current +cursor location. + + + +We can give -1 as the character count to update till end of line. If you want to +change attributes of characters from current position to end of line, just use +this. + + + + chgat(-1, A_REVERSE, 0, NULL); + + + +This function is useful when changing attributes for characters that are +already on the screen. Move to the character from which you want to change and +change the attribute. + + + +Other functions wchgat(), mvchgat(), wchgat() behave similarly except that the w +functions operate on the particular window. The mv functions first move the +cursor then perform the work given to them. Actually chgat is a macro which is +replaced by a wchgat() with stdscr as the window. Most of the "w-less" functions +are macros. + + + Chgat() Usage example + + + + + + +This example also introduces us to the color world of curses. Colors will be +explained in detail later. Use 0 for no color. + + + + +All about window functions + +Windows form the most important concept in curses. You have seen the standard +window stdscr above where all the functions implicitly operated on this window. +Now to make design even a simplest GUI, you need to resort to windows. The main +reason you may want to use windows is to manipulate parts of the screen +separately, for better efficiency, by updating only the windows that need to be +changed and for a better design. I would say the last reason is the most +important in going for windows. You should always strive for a better and +easy-to-manage design in your programs. If you are writing big, complex GUIs +this is of pivotal importance before you start doing anything. + + +The basics + + +A Window can be created by calling the function +newwin(). It doesn't create any thing on the +screen actually. It allocates memory for a structure to manipulate the window +and updates the structure with data regarding the window like it's size, beginy, +beginx etc.. Hence in curses, a window is just an abstraction of an imaginary +window, which can be manipulated independent of other parts of screen. The +function newwin() returns a pointer to structure WINDOW, which can be passed to +window related functions like wprintw() etc.. Finally the window can be +destroyed with delwin(). It will deallocate the memory associated with the +window structure. + + + +Let there be a Window !!! + +What fun is it, if a window is created and we can't see it. So the fun part +begins by displaying the window. The function +box() can be used to draw a border around the +window. Let's explore these functions in more detail in this example. + + + Window Border example + + + + + + + +Explanation + + +Don't scream. I know it's a big example. But I have to explain some important +things here :-). This program creates a rectangular window that can be moved +with left, right, up, down arrow keys. It repeatedly creates and destroys +windows as user press a key. Don't go beyond the screen limits. Checking for +those limits is left as an exercise for the reader. Let's dissect it by line by line. + + + +The create_newwin() function creates a window +with newwin() and displays a border around it +with box. The function destroy_win() first +erases the window from screen by painting a border with ' ' character and then +calling delwin() to deallocate memory related +to it. Depending on the key the user presses, starty or startx is changed and a +new window is created. + + + +In the destroy_win, as you can see, I used wborder instead of box. The reason is +written in the comments (You missed it. I know. Read the code :-)). wborder +draws a border around the window with the characters given to it as the 4 corner +points and the 4 lines. To put it clearly, if you have called wborder as below: + + wborder(win, '|', '|', '-', '-', '+', '+', '+', '+'); + + + + +it produces some thing like + + + + +-----------------------+ + | | + | | + | | + | | + | | + | | + +-----------------------+ + + + +The other stuff in the example + +You can also see in the above examples, that I have used the variables COLS, +LINES which are initialized to the screen sizes after initscr(). They can be +useful in finding screen dimensions and finding the center co-ordinate of the +screen as above. The function getch() as usual +gets the key from keyboard and according to the key it does the corresponding +work. This type of switch- case is very common in any GUI based programs. + + + +Other Border functions + +Above program is grossly inefficient in that with each press of a key, a window +is destroyed and another is created. So let's write a more efficient program +which uses other border related functions. + + + +The following program uses mvhline() and +mvvline() to achieve similar effect. These two +functions are simple. They create a horizontal or vertical line of the specified +length at the specified position. + + + More border functions + + + + + + + +All about color + The basics + +Life seems dull with no colors. Curses has a nice mechanism to handle colors. +Let's get into the thick of the things with a small program. + + A Simple Color example + + + + + + +As you can see, to start using color, you should first call the function + start_color(). After that you can use color +capabilities of your terminals by various functions. To find out whether +terminal has color capabilities or not, you can use +has_colors() function, which returns FALSE if +the terminal does not support color. + + + +Curses initializes all the colors supported by terminal when start_color() is +called. These can be accessed by the define constants like +COLOR_BLACK etc. Now to actually start using +colors, you have to define pairs. Colors are always used in pairs. That means +you have to use the function init_pair() to +define the foreground and background for the pair number you give. After that +that pair number can be used as a normal attribute with +COLOR_PAIR()function. This may seem to be cumbersome at first. +But this elegant solution allows us to manage color pairs very easily. To +appreciate it, you have to look into the the source code of "dialog", a utility +for displaying dialog boxes from shell scripts. The developers have defined +foreground and background combinations for all the colors they might need and +initialized at the beginning. This makes it very easy to set attributes just by +accessing a pair which we already have defined as a constant. + + + +The following colors are defined in curses.h. +You can use these as parameters for various color functions. + + COLOR_BLACK 0 + COLOR_RED 1 + COLOR_GREEN 2 + COLOR_YELLOW 3 + COLOR_BLUE 4 + COLOR_MAGENTA 5 + COLOR_CYAN 6 + COLOR_WHITE 7 + + + + +Changing Color Definitions + + +The function init_color()can be used to change +the rgb values for the colors defined by curses initially. Say you wanted to +lighten the intensity of red color by a minuscule. Then you can use this +function as + + + + init_color(COLOR_RED, 700, 0, 0); + /* param 1 : color name + * param 2, 3, 4 : rgb content min = 0, max = 1000 */ + + + +If your terminal cannot change the color definitions, the function returns ERR. +The function can_change_color() can be used to +find out whether the terminal has the capability of changing color content or +not. The rgb content is scaled from 0 to 1000. Initially RED color is defined +with content 1000(r), 0(g), 0(b). + + + +Color Content + +The functions color_content() and +pair_content() can be used to find the color +content and foreground, background combination for the pair. + + + + + Key management. How to read function keys, arrow keys etc.. + + +The Basics + + +No GUI is complete without a strong user interface and to interact with the +user, a curses program should be sensitive to key presses or the mouse actions +done by the user. Let's deal with the keys first. + + + +As you have seen in almost all of the above examples, it's very easy to get key +input from the user. A simple way of getting key presses is to use +getch() function. The cbreak mode should be +enabled to read keys when you are interested in reading individual key hits +rather than complete lines of text (which usually end with a carriage return). +keypad should be enabled to get the Functions keys, arrow keys etc. See the +initialization section for details. + + + +getch() returns an integer corresponding to the +key pressed. If it is a normal character, the integer value will be equivalent +to the character. Otherwise it returns a number which can be matched with the +constants defined in curses.h. For example if +the user presses F1, the integer returned is 265. This can be checked using the +macro KEY_F() defined in curses.h. This makes reading keys portable and easy to +manage. + + + +For example, if you call getch() like this + + + + int ch; + + ch = getch(); + + + +getch() will wait for the user to press a key, (unless you specified a timeout) +and when user presses a key, the corresponding integer is returned. Then you can +check the value returned with the constants defined in curses.h to match against +the keys you want. + + + +The following code piece will do that job. + + + + if(ch == KEY_LEFT) + printw("Left arrow is pressed\n"); + + + +Let's write a small program which creates a menu which can be navigated by up +and down arrows. + + + + A Simple Key Usage example + A Simple Key Usage example + + + + + + + + Interfacing with the mouse + + +Now that you have seen how to get keys, lets do the same thing from mouse. +Usually each UI allows the user to interact with both keyboard and mouse. + + + The Basics + + +Before you do any thing else, the events you want to receive have to be enabled +with mousemask(). + + + + mousemask( mmask_t newmask, /* The events you want to listen to */ + mmask_t *oldmask) /* The old events mask */ + + + +The first parameter to above function is a bit mask of events you would like to +listen. By default, all the events are turned off. The bit mask ALL_MOUSE_EVENTS can be used to get all the events. + + + +The following are all the event masks: + + + + Name Description + --------------------------------------------------------------------- + BUTTON1_PRESSED mouse button 1 down + BUTTON1_RELEASED mouse button 1 up + BUTTON1_CLICKED mouse button 1 clicked + BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked + BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked + BUTTON2_PRESSED mouse button 2 down + BUTTON2_RELEASED mouse button 2 up + BUTTON2_CLICKED mouse button 2 clicked + BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked + BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked + BUTTON3_PRESSED mouse button 3 down + BUTTON3_RELEASED mouse button 3 up + BUTTON3_CLICKED mouse button 3 clicked + BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked + BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked + BUTTON4_PRESSED mouse button 4 down + BUTTON4_RELEASED mouse button 4 up + BUTTON4_CLICKED mouse button 4 clicked + BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked + BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked + BUTTON_SHIFT shift was down during button state change + BUTTON_CTRL control was down during button state change + BUTTON_ALT alt was down during button state change + ALL_MOUSE_EVENTS report all button state changes + REPORT_MOUSE_POSITION report mouse movement + + + + Getting the events + +Once a class of mouse events have been enabled, getch() class of functions +return KEY_MOUSE every time some mouse event happens. Then the mouse event can +be retrieved with getmouse(). + + + +The code approximately looks like this: + + + + MEVENT event; + + ch = getch(); + if(ch == KEY_MOUSE) + if(getmouse(&event) == OK) + . /* Do some thing with the event */ + . + . + + + +getmouse() returns the event into the pointer given to it. It's a structure +which contains + + + + typedef struct + { + short id; /* ID to distinguish multiple devices */ + int x, y, z; /* event coordinates */ + mmask_t bstate; /* button state bits */ + } + + + +The bstate is the main variable we are +interested in. It tells the button state of the mouse. + + + +Then with a code snippet like the following, we can find out what happened. + + + + if(event.bstate & BUTTON1_PRESSED) + printw("Left Button Pressed"); + + + + Putting it all Together + + +That's pretty much interfacing with mouse. Let's create the same menu and enable +mouse interaction. To make things simpler, key handling is removed. + + + Access the menu with mouse !!! + + + + + + + Miscellaneous Functions + + +The functions mouse_trafo() and wmouse_trafo() can be used to convert to mouse +co-ordinates to screen relative co-ordinates. See curs_mouse(3X) man page for details. + + + +The mouseinterval function sets the maximum time (in thousands of a +second) that can elapse between press and release events in order for +them to be recognized as a click. This function returns the previous +interval value. The default is one fifth of a second. + + + + +Screen Manipulation + +In this section, we will look into some functions, which allow us to manage the +screen efficiently and to write some fancy programs. This is especially +important in writing games. + + +getyx() functions + + +The function getyx() can be used to find out +the present cursor co-ordinates. It will fill the values of x and y co-ordinates +in the arguments given to it. Since getyx() is a macro you don't have to pass +the address of the variables. It can be called as + + + + getyx(win, y, x); + /* win: window pointer + * y, x: y, x co-ordinates will be put into this variables + */ + + + +The function getparyx() gets the beginning co-ordinates of the sub window +relative to the main window. This is some times useful to update a sub window. +When designing fancy stuff like writing multiple menus, it becomes difficult to +store the menu positions, their first option co-ordinates etc. A simple solution +to this problem, is to create menus in sub windows and later find the starting +co-ordinates of the menus by using getparyx(). + + + +The functions getbegyx() and getmaxyx() store current window's beginning and +maximum co-ordinates. These functions are useful in the same way as above in +managing the windows and sub windows effectively. + + + +Screen Dumping + +While writing games, some times it becomes necessary to store the state of the +screen and restore it back to the same state. The function scr_dump() can be +used to dump the screen contents to a file given as an argument. Later it can be +restored by scr_restore function. These two simple functions can be used +effectively to maintain a fast moving game with changing scenarios. + + + +Window Dumping + +To store and restore windows, the functions +putwin() and getwin() + can be used. putwin() puts +the present window state into a file, which can be later restored by +getwin(). + + + +The function copywin() can be used to copy a +window completely onto another window. It takes the source and destination +windows as parameters and according to the rectangle specified, it copies the +rectangular region from source to destination window. It's last parameter +specifies whether to overwrite or just overlay the contents on to the +destination window. If this argument is true, then the copying is +non-destructive. + + + + +Miscellaneous features + + +Now you know enough features to write a good curses program, with all bells and +whistles. There are some miscellaneous functions which are useful in various +cases. Let's go headlong into some of those. + + +curs_set() + +This function can be used to make the cursor invisible. The parameter to this +function should be + + + + 0 : invisible or + 1 : normal or + 2 : very visible. + + + +Temporarily Leaving Curses mode + + +Some times you may want to get back to cooked mode (normal line buffering mode) +temporarily. In such a case you will first need to save the tty modes with a +call to def_prog_mode() and then call +endwin() to end the curses mode. This will +leave you in the original tty mode. To get back to curses once you are done, +call reset_prog_mode() . This function returns +the tty to the state stored by def_prog_mode() +. Then do refresh(), and you are back to the curses mode. Here +is an example showing the sequence of things to be done. + + + Temporarily Leaving Curses Mode + + + + + + +ACS_ variables + + +If you have ever programmed in DOS, you know about those nifty characters in +extended character set. They are printable only on some terminals. NCURSES +functions like box() use these characters. All +these variables start with ACS meaning alternative character set. You might have +noticed me using these characters in some of the programs above. Here's an example +showing all the characters. + + + ACS Variables Example + + + + + + + + Other libraries + + +Apart from the curses library, there are few text mode libraries, which provide +more functionality and a lot of features. The following sections explain three +standard libraries which are usually distributed along with curses. + + + + Panel Library + + +Now that you are proficient in curses, you wanted to do some thing big. You +created a lot of overlapping windows to give a professional windows-type look. +Unfortunately, it soon becomes difficult to manage these. The multiple +refreshes, updates plunge you into a nightmare. The overlapping windows create +blotches, whenever you forget to refresh the windows in the proper order. + + + +Don't despair. There's an elegant solution provided in panels library. In the +words of developers of ncurses + + + + +When your interface design is such that windows may dive deeper into the +visibility stack or pop to the top at runtime, the resulting book-keeping can be +tedious and difficult to get right. Hence the panels library. + + + + +If you have lot of overlapping windows, then panels library is the way to go. It +obviates the need of doing series of wnoutrefresh(), doupdate() and relieves the +burden of doing it correctly(bottom up). The library maintains information about +the order of windows, their overlapping and update the screen properly. So why +wait? Let's take a close peek into panels. + + + The Basics + +Panel object is a window that is implicitly treated as part of a deck including +all other panel objects. The deck is treated as a stack with the top panel being +completely visible and the other panels may or may not be obscured according to +their positions. So the basic idea is to create a stack of overlapping panels +and use panels library to display them correctly. There is a function similar to +refresh() which, when called , displays panels in the correct order. Functions +are provided to hide or show panels, move panels, change its size etc.. The +overlapping problem is managed by the panels library during all the calls to +these functions. + + + +The general flow of a panel program goes like this: + + + +Create the windows (with newwin()) to be attached to the panels. + + + + +Create panels with the chosen visibility order. Stack them up according to the +desired visibility. The function new_panel() is used to created panels. + + + + + +Call update_panels() to write the panels to the virtual screen in correct +visibility order. Do a doupdate() to show it on the screen. + + + + + +Mainpulate the panels with show_panel(), hide_panel(), move_panel() etc. Make +use of helper functions like panel_hidden() and panel_window(). Make use of user +pointer to store custom data for a panel. Use the functions set_panel_userptr() +and panel_userptr() to set and get the user pointer for a panel. + + + + + +When you are done with the panel use del_panel() to delete the panel. + + + + + + +Let's make the concepts clear, with some programs. The following is a simple +program which creates 3 overlapping panels and shows them on the screen. + + + + Compiling With the Panels Library + + +To use panels library functions, you have to include panel.h and to link the +program with panels library the flag -lpanel should be added along with +-lncurses in that order. + + + + #include <panel.h> + . + . + . + + compile and link: gcc <program file> -lpanel -lncurses + + + Panel basics + + + + + + +As you can see, above program follows a simple flow as explained. The windows +are created with newwin() and then they are attached to panels with new_panel(). +As we attach one panel after another, the stack of panels gets updated. To put +them on screen update_panels() and doupdate() are called. + + + + Panel Window Browsing + +A slightly complicated example is given below. This program creates 3 +windows which can be cycled through using tab. Have a look at the code. + + + Panel Window Browsing Example + + + + + + + Using User Pointers + +In the above example I used user pointers to find out the next window in the +cycle. We can attach custom information to the panel by specifying a user +pointer, which can point to any information you want to store. In this case I +stored the pointer to the next panel in the cycle. User pointer for a panel can +be set with the function set_panel_userptr(). +It can be accessed using the function panel_userptr() + which will return the user pointer for the panel given as +argument. After finding the next panel in the cycle It's brought to the top by +the function top_panel(). This function brings the panel given as argument to +the top of the panel stack. + + + + Moving and Resizing Panels + +The function move_panel() can be used to move a +panel to the desired location. It does not change the position of the panel in +the stack. Make sure that you use move_panel() instead mvwin() on the window +associated with the panel. + + + +Resizing a panel is slightly complex. There is no straight forward function +just to resize the window associated with a panel. A solution to resize a panel +is to create a new window with the desired sizes, change the window associated +with the panel using replace_panel(). Don't forget to delete the old window. The +window associated with a panel can be found by using the function +panel_window(). + + + +The following program shows these concepts, in supposedly simple program. You +can cycle through the window with <TAB> as usual. To resize or move the +active panel press 'r' for resize 'm' for moving. Then use arrow keys to resize +or move it to the desired way and press enter to end your resizing or moving. +This example makes use of user data to get the required data to do the +operations. + + + Panel Moving and Resizing example + + + + + + +Concentrate on the main while loop. Once it finds out the type of key pressed, +it takes appropriate action. If 'r' is pressed resizing mode is started. After +this the new sizes are updated as the user presses the arrow keys. When the user +presses <ENTER> present selection ends and panel is resized by using the +concept explained. While in resizing mode the program doesn't show how the +window is getting resized. It's left as an exercise to the reader to print a +dotted border while it gets resized to a new position. + + + +When the user presses 'm' the move mode starts. This is a bit simpler than +resizing. As the arrow keys are pressed the new position is updated and +pressing of <ENTER> causes the panel to be moved by calling the function +move_panel(). + + + +In this program the user data which is represented as PANEL_DATA, plays very +important role in finding the associated information with a panel. As written in +the comments, the PANEL_DATA stores the panel sizes, label, label color and a +pointer to the next panel in the cycle. + + + + Hiding and Showing Panels + + +A Panel can be hidden by using the function hide_panel(). This function merely +removes it form the stack of panels, thus hiding it on the screen once you do +update_panels() and doupdate(). It doesn't destroy the PANEL structure +associated with the hidden panel. It can be shown again by using the +show_panel() function. + + + +The following program shows the hiding of panels. Press 'a' or 'b' or 'c' to +show or hide first, second and third windows respectively. It uses a user data +with a small variable hide, which keeps track of whether the window is hidden or +not. For some reason the function +panel_hidden() which tells whether a panel is +hidden or not is not working. A bug report was also presented by Michael Andres + here + + + + Panel Hiding and Showing example + + + + + + + panel_above() and panel_below() Functions + +The functions panel_above() and +panel_below() can be used to find out the panel +above and below a panel. If the argument to these functions is NULL, then they +return a pointer to bottom panel and top panel respectively. + + + + + Menus Library + +The menus library provides a nice extension to basic curses, through which you +can create menus. It provides a set of functions to create menus. But they have +to be customized to give a nicer look, with colors etc. Let's get into the +details. + + + +A menu is a screen display that assists the user to choose some subset of a +given set of items. To put it simple, a menu is a collection of items from which +one or more items can be chosen. Some readers might not be aware of multiple +item selection capability. Menu library provides functionality to write menus +from which the user can chose more than one item as the preferred choice. This +is dealt with in a later section. Now it is time for some rudiments. + + + The Basics + +To create menus, you first create items, and then post the menu to the display. +After that, all the processing of user responses is done in an elegant function +menu_driver() which is the work horse of any menu program. + + + +The general flow of control of a menu program looks like this. + +Initialize curses + + + +Create items using new_item(). You can specify a name and description for the +items. + + + + + +Create the menu with new_menu() by specifying the items to be attached with. + + + + +Post the menu with menu_post() and refresh the screen. + + + + +Process the user requests with a loop and do necessary updates to menu with +menu_driver. + + + +Unpost the menu with menu_unpost() +Free the memory allocated to menu by free_menu() + +Free the memory allocated to the items with free_item() + +End curses + + + + +Let's see a program which prints a simple menu and updates the current selection +with up, down arrows. + + + + + Compiling With the Menu Library + + +To use menu library functions, you have to include menu.h and to link the +program with menu library the flag -lmenu should be added along with -lncurses +in that order. + + + + #include <menu.h> + . + . + . + + compile and link: gcc <program file> -lmenu -lncurses + + + Menu Basics + + + + + + +This program demonstrates the basic concepts involved in creating a menu using +menus library. First we create the items using new_item() and then attach them +to the menu with new_menu() function. After posting the menu and refreshing the +screen, the main processing loop starts. It reads user input and takes +corresponding action. The function menu_driver() is the main work horse of the +menu system. The second parameter to this function tells what's to be done with +the menu. According to the parameter, menu_driver() does the corresponding task. +The value can be either a menu navigational request, an ascii character, or a +KEY_MOUSE special key associated with a mouse event. + + + +The menu_driver accepts following navigational requests. + + + REQ_LEFT_ITEM Move left to an item. + REQ_RIGHT_ITEM Move right to an item. + REQ_UP_ITEM Move up to an item. + REQ_DOWN_ITEM Move down to an item. + REQ_SCR_ULINE Scroll up a line. + REQ_SCR_DLINE Scroll down a line. + REQ_SCR_DPAGE Scroll down a page. + REQ_SCR_UPAGE Scroll up a page. + REQ_FIRST_ITEM Move to the first item. + REQ_LAST_ITEM Move to the last item. + REQ_NEXT_ITEM Move to the next item. + REQ_PREV_ITEM Move to the previous item. + REQ_TOGGLE_ITEM Select/deselect an item. + REQ_CLEAR_PATTERN Clear the menu pattern buffer. + REQ_BACK_PATTERN Delete the previous character from the pattern buffer. + REQ_NEXT_MATCH Move to the next item matching the pattern match. + REQ_PREV_MATCH Move to the previous item matching the pattern match. + + + + + +Don't get overwhelmed by the number of options. We will see them slowly one +after another. The options of interest in this example are REQ_UP_ITEM and +REQ_DOWN_ITEM. These two options when passed to menu_driver, menu driver +updates the current item to one item up or down respectively. + + + + Menu Driver: The work horse of the menu system + + +As you have seen in the above example, menu_driver plays an important role in +updating the menu. It is very important to understand various options it takes +and what they do. As explained above, the second parameter to menu_driver() can +be either a navigational request, a printable character or a KEY_MOUSE key. +Let's dissect the different navigational requests. + + + +REQ_LEFT_ITEM and REQ_RIGHT_ITEM + +A Menu can be displayed with multiple columns for more than one item. This can +be done by using the menu_format()function. +When a multi columnar menu is displayed these requests cause the menu driver to +move the current selection to left or right. + + + +REQ_UP_ITEM and REQ_DOWN_ITEM + +These two options you have seen in the above example. These options when given, +makes the menu_driver to move the current selection to an item up or down. + + + + REQ_SCR_* options + +The four options REQ_SCR_ULINE, REQ_SCR_DLINE, REQ_SCR_DPAGE, REQ_SCR_UPAGE are +related to scrolling. If all the items in the menu cannot be displayed in the +menu sub window, then the menu is scrollable. These requests can be given to the +menu_driver to do the scrolling either one line up, down or one page down or up +respectively. + + + +REQ_FIRST_ITEM, REQ_LAST_ITEM, REQ_NEXT_ITEM and +REQ_PREV_ITEM + +These requests are self explanatory. + + + + REQ_TOGGLE_ITEM + +This request when given, toggles the present selection. This option is to be +used only in a multi valued menu. So to use this request the option O_ONEVALUE +must be off. This option can be made off or on with set_menu_opts(). + + + + Pattern Requests + +Every menu has an associated pattern buffer, which is used to find the nearest +match to the ascii characters entered by the user. Whenever ascii characters are +given to menu_driver, it puts in to the pattern buffer. It also tries to find +the nearest match to the pattern in the items list and moves current selection +to that item. The request REQ_CLEAR_PATTERN clears the pattern buffer. The +request REQ_BACK_PATTERN deletes the previous character in the pattern buffer. +In case the pattern matches more than one item then the matched items can be +cycled through REQ_NEXT_MATCH and REQ_PREV_MATCH which move the current +selection to the next and previous matches respectively. + + + + Mouse Requests + +In case of KEY_MOUSE requests, according to the mouse position an action is +taken accordingly. The action to be taken is explained in the man page as, + + + + If the second argument is the KEY_MOUSE special key, the + associated mouse event is translated into one of the above + pre-defined requests. Currently only clicks in the user + window (e.g. inside the menu display area or the decora­ + tion window) are handled. If you click above the display + region of the menu, a REQ_SCR_ULINE is generated, if you + doubleclick a REQ_SCR_UPAGE is generated and if you + tripleclick a REQ_FIRST_ITEM is generated. If you click + below the display region of the menu, a REQ_SCR_DLINE is + generated, if you doubleclick a REQ_SCR_DPAGE is generated + and if you tripleclick a REQ_LAST_ITEM is generated. If + you click at an item inside the display area of the menu, + the menu cursor is positioned to that item. + + + + + + +Each of the above requests will be explained in the following lines with several +examples whenever appropriate. + + + + Menu Windows + +Every menu created is associated with a window and a sub window. The menu window +displays any title or border associated with the menu. The menu sub window +displays the menu items currently available for selection. But we didn't specify +any window or sub window in the simple example. When a window is not specified, +stdscr is taken as the main window, and then menu system calculates the sub +window size required for the display of items. Then items are displayed in the +calculated sub window. So let's play with these windows and display a menu with +a border and a title. + + + Menu Windows Usage example + + + + + + +This example creates a menu with a title, border, a fancy line separating title +and the items. As you can see, in order to attach a window to a menu the +function set_menu_win() has to be used. Then we attach the sub window also. This +displays the items in the sub window. You can also set the mark string which +gets displayed to the left of the selected item with set_menu_mark(). + + + + Scrolling Menus + +If the sub window given for a window is not big enough to show all the items, +then the menu will be scrollable. When you are on the last item in the present +list, if you send REQ_DOWN_ITEM, it gets translated into REQ_SCR_DLINE and the +menu scrolls by one item. You can manually give REQ_SCR_ operations to do +scrolling. Let's see how it can be done. + + + Scrolling Menus example + + + + + +This program is self-explanatory. In this example the number of choices has been +increased to ten, which is larger than our sub window size which can hold 6 +items. This message has to be explicitly conveyed to the menu system with the +function set_menu_format(). In here we specify the number of rows and columns we +want to be displayed for a single page. We can specify any number of items to be +shown, in the rows variables, if it is less than the height of the sub window. +If the key pressed by the user is a PAGE UP or PAGE DOWN, the menu is scrolled a +page due to the requests (REQ_SCR_DPAGE and REQ_SCR_UPAGE) given to +menu_driver(). + + + + Multi Columnar Menus + +In the above example you have seen how to use the function set_menu_format(). I +didn't mention what the cols variable (third parameter) does. Well, If your sub +window is wide enough, you can opt to display more than one item per row. This +can be specified in the cols variable. To make things simpler, the following +example doesn't show descriptions for the items. + + + Milt Columnar Menus Example + + + + + +Watch the function call to set_menu_format(). It specifies the number of columns +to be 3, thus displaying 3 items per row. We have also switched off the showing +descriptions with the function menu_opts_off(). There are couple of functions +set_menu_opts(), menu_opts_on() and menu_opts() which can be used to manipulate +menu options. The following menu options can be specified. + + + + O_ONEVALUE + Only one item can be selected for this menu. + + O_SHOWDESC + Display the item descriptions when the menu is + posted. + + O_ROWMAJOR + Display the menu in row-major order. + + O_IGNORECASE + Ignore the case when pattern-matching. + + O_SHOWMATCH + Move the cursor to within the item name while pat­ + tern-matching. + + O_NONCYCLIC + Don't wrap around next-item and previous-item, + requests to the other end of the menu. + + + +All options are on by default. You can switch specific attributes on or off with +menu_opts_on() and menu_opts_off() functions. You can also use set_menu_opts() +to directly specify the options. The argument to this function should be a OR ed +value of some of those above constants. The function menu_opts() can be used to +find out a menu's present options. + + + + Multi Valued Menus + +You might be wondering what if you switch off the option O_ONEVALUE. Then the +menu becomes multi-valued. That means you can select more than one item. This +brings us to the request REQ_TOGGLE_ITEM. Let's see it in action. + + + Multi Valued Menus example + + + + + +Whew, A lot of new functions. Let's take them one after another. Firstly, the +REQ_TOGGLE_ITEM. In a multi-valued menu, the user should be allowed to select +or un select more than one item. The request REQ_TOGGLE_ITEM toggles the present +selection. In this case when space is pressed REQ_TOGGLE_ITEM request is sent to +menu_driver to achieve the result. + + + +Now when the user presses <ENTER> we show the items he presently selected. +First we find out the items associated with the menu using the function +menu_items(). Then we loop through the items to find out if the item is selected +or not. The function item_value() returns TRUE if an item is selected. The +function item_count() returns the number of items in the menu. The item name can +be found with item_name(). You can also find the description associated with an +item using item_description(). + + + + Menu Options + + +Well, by this time you must be itching for some difference in your menu, with +lots of functionality. I know. You want Colors !!!. You want to create nice +menus similar to those text mode dos games. The functions +set_menu_fore() and set_menu_back() can be used to change the attribute of the +selected item and unselected item. The names are misleading. They don't change +menu's foreground or background which would have been useless. + + + +The function set_menu_grey() can be used to set the display attribute for the +non-selectable items in the menu. This brings us to the interesting option for +an item the one and only O_SELECTABLE. We can turn it off by the function +item_opts_off() and after that that item is not selectable. It's like a grayed +item in those fancy windows menus. Let's put these concepts in practice with +this example + + + Menu Options example + + + + + + + The useful User Pointer + +We can associate a user pointer with each item in the menu. It works the same +way as user pointer in panels. It's not touched by menu system. You can store +any thing you like in that. I usually use it to store the function to be +executed when the menu option is chosen (It's selected and may be the user +pressed <ENTER>); + + + Menu User Pointer Usage + + + + + + + + Forms Library + + +Well. If you have seen those forms on web pages which take input from users and +do various kinds of things, you might be wondering how would any one create such +forms in text mode display. It's quite difficult to write those nifty forms in +plain ncurses. Forms library tries to provide a basic frame work to build and +maintain forms with ease. It has lot of features(functions) which manage +validation, dynamic expansion of fields etc.. Let's see it in full flow. + + + +A form is a collection of fields; each field can be either a label(static text) +or a data-entry location. The forms also library provides functions to divide +forms into multiple pages. + + + The Basics + + +Forms are created in much the same way as menus. First the fields related to the +form are created with new_field(). You can set options for the fields, so that +they can be displayed with some fancy attributes, validated before the field +looses focus etc.. Then the fields are attached to form. After this, the form +can be posted to display and is ready to receive inputs. On the similar lines to +menu_driver(), the form is manipulated with form_driver(). We can send requests +to form_driver to move focus to a certain field, move cursor to end of the field +etc.. After the user enters values in the fields and validation done, form can +be unposted and memory allocated can be freed. + + + +The general flow of control of a forms program looks like this. + + +Initialize curses + +Create fields using new_field(). You can specify the height and +width of the field, and its position on the form. + +Create the forms with new_form() by specifying the fields to be +attached with. + +Post the form with form_post() and refresh the screen. + + +Process the user requests with a loop and do necessary updates +to form with form_driver. + +Unpost the menu with form_unpost() + +Free the memory allocated to menu by free_form() + + +Free the memory allocated to the items with free_field() + +End curses + + + + + +As you can see, working with forms library is much similar to handling menu +library. The following examples will explore various aspects of form +processing. Let's start the journey with a simple example. first. + + + + Compiling With the Forms Library + + +To use forms library functions, you have to include form.h and to link the +program with forms library the flag -lform should be added along with -lncurses +in that order. + + + + #include <form.h> + . + . + . + + compile and link: gcc <program file> -lform -lncurses + + + Forms Basics + + + + + + +Above example is pretty straight forward. It creates two fields with +new_field(). new_field() takes height, width, +starty, startx, number of offscreen rows and number of additional working +buffers. The fifth argument number of offscreen rows specifies how much of the +field to be shown. If it is zero, the entire field is always displayed otherwise +the form will be scrollable when the user accesses not displayed parts of the +field. The forms library allocates one buffer per field to store the data user +enters. Using the last parameter to new_field() we can specify it to allocate +some additional buffers. These can be used for any purpose you like. + + + +After creating the fields, back ground attribute of both of them is set to an +underscore with set_field_back(). The AUTOSKIP option is turned off using +field_opts_off(). If this option is turned on, focus will move to the next +field in the form once the active field is filled up completely. + + + +After attaching the fields to the form, it is posted. Here on, user inputs are +processed in the while loop, by making corresponding requests to form_driver. +The details of all the requests to the form_driver() are explained later. + + + + Playing with Fields + +Each form field is associated with a lot of attributes. They can be manipulated +to get the required effect and to have fun !!!. So why wait? + + + Fetching Size and Location of Field + + +The parameters we have given at the time of creation of a field can be retrieved +with field_info(). It returns height, width, starty, startx, number of offscreen +rows, and number of additional buffers into the parameters given to it. It is a +sort of inverse of new_field(). + + + +int field_info( FIELD *field, /* field from which to fetch */ + int *height, *int width, /* field size */ + int *top, int *left, /* upper left corner */ + int *offscreen, /* number of offscreen rows */ + int *nbuf); /* number of working buffers */ + + + + Moving the field + + +The location of the field can be moved to a different position with +move_field(). + + + +int move_field( FIELD *field, /* field to alter */ + int top, int left); /* new upper-left corner */ + + + +As usual, the changed position can be queried with field_infor(). + + + + Field Justification + + +The justification to be done for the field can be fixed using the function +set_field_just(). + + + + int set_field_just(FIELD *field, /* field to alter */ + int justmode); /* mode to set */ + int field_just(FIELD *field); /* fetch justify mode of field */ + + + +The justification mode valued accepted and returned by these functions are +NO_JUSTIFICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER. + + + + Field Display Attributes + +As you have seen, in the above example, display attribute for the fields can be +set with set_field_fore() and setfield_back(). These functions set foreground +and background attribute of the fields. You can also specify a pad character +which will be filled in the unfilled portion of the field. The pad character is +set with a call to set_field_pad(). Default pad value is a space. The functions +field_fore(), field_back, field_pad() can be used to query the present +foreground, background attributes and pad character for the field. The following +list gives the usage of functions. + + + + +int set_field_fore(FIELD *field, /* field to alter */ + chtype attr); /* attribute to set */ + +chtype field_fore(FIELD *field); /* field to query */ + /* returns foreground attribute */ + +int set_field_back(FIELD *field, /* field to alter */ + chtype attr); /* attribute to set */ + +chtype field_back(FIELD *field); /* field to query */ + /* returns background attribute */ + +int set_field_pad(FIELD *field, /* field to alter */ + int pad); /* pad character to set */ + +chtype field_pad(FIELD *field); /* field to query */ + /* returns present pad character */ + + + + +Though above functions seem quite simple, using colors with set_field_fore() may +be frustrating in the beginning. Let me first explain about foreground and +background attributes of a field. The foreground attribute is associated with +the character. That means a character in the field is printed with the attribute +you have set with set_field_fore(). Background attribute is the attribute used +to fill background of field, whether any character is there or not. So what +about colors? Since colors are always defined in pairs, what is the right way to +display colored fields? Here's an example clarifying color attributes. + + + Form Attributes example + + + + + + +Play with the color pairs and try to understand the foreground and background +attributes. In my programs using color attributes, I usually set only the +background with set_field_back(). Curses simply doesn't allow defining +individual color attributes. + + + + Field Option Bits + +There is also a large collection of field option bits you can set to control +various aspects of forms processing. You can manipulate them with these +functions: + + + +int set_field_opts(FIELD *field, /* field to alter */ + int attr); /* attribute to set */ + +int field_opts_on(FIELD *field, /* field to alter */ + int attr); /* attributes to turn on */ + +int field_opts_off(FIELD *field, /* field to alter */ + int attr); /* attributes to turn off */ + +int field_opts(FIELD *field); /* field to query */ + + + +The function set_field_opts() can be used to directly set attributes of a field +or you can choose to switch a few attributes on and off with field_opts_on() and +field_opts_off() selectively. Anytime you can query the attributes of a field +with field_opts(). The following is the list of available options. By default, +all options are on. + + + + + O_VISIBLE + + +Controls whether the field is visible on the screen. Can be used +during form processing to hide or pop up fields depending on the value +of parent fields. + + + + + O_ACTIVE + + +Controls whether the field is active during forms processing (i.e. +visited by form navigation keys). Can be used to make labels or derived +fields with buffer values alterable by the forms application, not the user. + + + + + + O_PUBLIC + + +Controls whether data is displayed during field entry. If this option is +turned off on a field, the library will accept and edit data in that field, +but it will not be displayed and the visible field cursor will not move. +You can turn off the O_PUBLIC bit to define password fields. + + + + + + O_EDIT + + +Controls whether the field's data can be modified. When this option is +off, all editing requests except REQ_PREV_CHOICE + and REQ_NEXT_CHOICEwill +fail. Such read-only fields may be useful for help messages. + + + + + + O_WRAP + + +Controls word-wrapping in multi-line fields. Normally, when any +character of a (blank-separated) word reaches the end of the current line, the +entire word is wrapped to the next line (assuming there is one). When this +option is off, the word will be split across the line break. + + + + + O_BLANK + + +Controls field blanking. When this option is on, entering a character at +the first field position erases the entire field (except for the just-entered +character). + + + + + O_AUTOSKIP + + +Controls automatic skip to next field when this one fills. Normally, +when the forms user tries to type more data into a field than will fit, +the editing location jumps to next field. When this option is off, the +user's cursor will hang at the end of the field. This option is ignored +in dynamic fields that have not reached their size limit. + + + + + + O_NULLOK + + +Controls whether validation is applied to +blank fields. Normally, it is not; the user can leave a field blank +without invoking the usual validation check on exit. If this option is +off on a field, exit from it will invoke a validation check. + + + + + O_PASSOK + + +Controls whether validation occurs on every exit, or only after +the field is modified. Normally the latter is true. Setting O_PASSOK +may be useful if your field's validation function may change during +forms processing. + + + + + O_STATIC + + +Controls whether the field is fixed to its initial dimensions. If you +turn this off, the field becomes dynamic and will +stretch to fit entered data. + + + + + + +A field's options cannot be changed while the field is currently selected. +However, options may be changed on posted fields that are not current. + + + +The option values are bit-masks and can be composed with logical-or in +the obvious way. You have seen the usage of switching off O_AUTOSKIP option. +The following example clarifies usage of some more options. Other options +are explained where appropriate. + + + Field Options Usage example + + + + + + +This example, though useless, shows the usage of options. If used properly, they +can present information very effectively in a form. The second field being not +O_PUBLIC, does not show the characters you are typing. + + + + Field Status + + +The field status specifies whether the field has got edited or not. It is +initially set to FALSE and when user enters something and the data buffer gets +modified it becomes TRUE. So a field's status can be queried to find out whether +it has been modified or not. The following functions can assist in those +operations. + + + +int set_field_status(FIELD *field, /* field to alter */ + int status); /* status to set */ + +int field_status(FIELD *field); /* fetch status of field */ + + + +It's better to check the field's status only after after leaving the field, as +data buffer might not have been updated yet as the validation is still due. To +guarantee that right status is returned, call field_status() either (1) in the +field's exit validation check routine, (2) from the field's or form's +initialization or termination hooks, or (3) just after a REQ_VALIDATION request +has been processed by the forms driver + + + + Field User Pointer + + +Every field structure contains one pointer that can be used by the user for +various purposes. It is not touched by forms library and can be used for any +purpose by the user. The following functions set and fetch user pointer. + + + +int set_field_userptr(FIELD *field, + char *userptr); /* the user pointer you wish to associate */ + /* with the field */ + +char *field_userptr(FIELD *field); /* fetch user pointer of the field */ + + + + Variable-Sized Fields + +If you want a dynamically changing field with variable width, this is the +feature you want to put to full use. This will allow the user to enter more data +than the original size of the field and let the field grow. According to the +field orientation it will scroll horizontally or vertically to incorporate the +new data. + + + +To make a field dynamically growable, the option O_STATIC should be turned off. +This can be done with a + + field_opts_off(field_pointer, O_STATIC); + + + + +But it's usually not advisable to allow a field to grow infinitely. You can set +a maximum limit to the growth of the field with + +int set_max_field(FIELD *field, /* Field on which to operate */ + int max_growth); /* maximum growth allowed for the field */ + + + + +The field info for a dynamically growable field can be retrieved by + +int dynamic_field_info( FIELD *field, /* Field on which to operate */ + int *prows, /* number of rows will be filled in this */ + int *pcols, /* number of columns will be filled in this*/ + int *pmax) /* maximum allowable growth will be filled */ + /* in this */ + +Though field_info work as usual, it is advisable to use this function to get the +proper attributes of a dynamically growable field. + + + +Recall the library routine new_field; a new field created with height set to one +will be defined to be a one line field. A new field created with height greater +than one will be defined to be a multi line field. + + + +A one line field with O_STATIC turned off (dynamically growable field) will +contain a single fixed row, but the number of columns can increase if the user +enters more data than the initial field will hold. The number of columns +displayed will remain fixed and the additional data will scroll horizontally. + + + +A multi line field with O_STATIC turned off (dynamically growable field) will +contain a fixed number of columns, but the number of rows can increase if the +user enters more data than the initial field will hold. The number of rows +displayed will remain fixed and the additional data will scroll vertically. + + + +The above two paragraphs pretty much describe a dynamically growable field's +behavior. The way other parts of forms library behaves is described below: + + + + +The field option O_AUTOSKIP will be ignored if the option O_STATIC is off and +there is no maximum growth specified for the field. Currently, O_AUTOSKIP +generates an automatic REQ_NEXT_FIELD form driver request when the user types in +the last character position of a field. On a growable field with no maximum +growth specified, there is no last character position. If a maximum growth is +specified, the O_AUTOSKIP option will work as normal if the field has grown to +its maximum size. + + + + +The field justification will be ignored if the option O_STATIC is off. +Currently, set_field_just can be used to JUSTIFY_LEFT, JUSTIFY_RIGHT, +JUSTIFY_CENTER the contents of a one line field. A growable one line field will, +by definition, grow and scroll horizontally and may contain more data than can +be justified. The return from field_just will be unchanged. + + + + +The overloaded form driver request REQ_NEW_LINE will operate the same way +regardless of the O_NL_OVERLOAD form option if the field option O_STATIC is off +and there is no maximum growth specified for the field. Currently, if the form +option O_NL_OVERLOAD is on, REQ_NEW_LINE implicitly generates a REQ_NEXT_FIELD +if called from the last line of a field. If a field can grow without bound, +there is no last line, so REQ_NEW_LINE will never implicitly generate a +REQ_NEXT_FIELD. If a maximum growth limit is specified and the O_NL_OVERLOAD +form option is on, REQ_NEW_LINE will only implicitly generate REQ_NEXT_FIELD if +the field has grown to its maximum size and the user is on the last line. + + + + +The library call dup_field will work as usual; it will duplicate the field, +including the current buffer size and contents of the field being duplicated. +Any specified maximum growth will also be duplicated. + + + +The library call link_field will work as usual; it will duplicate all field +attributes and share buffers with the field being linked. If the O_STATIC field +option is subsequently changed by a field sharing buffers, how the system reacts +to an attempt to enter more data into the field than the buffer will currently +hold will depend on the setting of the option in the current field. + + + +The library call field_info will work as usual; the variable nrow will contain +the value of the original call to new_field. The user should use +dynamic_field_info, described above, to query the current size of the buffer. + + + + +Some of the above points make sense only after explaining form driver. We will +be looking into that in next few sections. + + + + + Form Windows + +The form windows concept is pretty much similar to menu windows. Every form is +associated with a main window and a sub window. The form main window displays +any title or border associated or whatever the user wishes. Then the sub window +contains all the fields and displays them according to their position. This +gives the flexibility of manipulating fancy form displaying very easily. + + + +Since this is pretty much similar to menu windows, I am providing an example +with out much explanation. The functions are similar and they work the same way. + + + Form Windows Example + + + + + + + Field Validation + +By default, a field will accept any data input by the user. It is possible to +attach validation to the field. Then any attempt by the user to leave the field, +while it contains data that doesn't match the validation type will fail. Some +validation types also have a character-validity check for each time a character +is entered in the field. + + + +Validation can be attached to a field with the following function. + +int set_field_type(FIELD *field, /* field to alter */ + FIELDTYPE *ftype, /* type to associate */ + ...); /* additional arguments*/ + +Once set, the validation type for a field can be queried with + +FIELDTYPE *field_type(FIELD *field); /* field to query */ + + + + +The form driver validates the data in a field only when data is entered by the +end-user. Validation does not occur when + + + + + +the application program changes the field value by calling set_field_buffer. + + + +linked field values are changed indirectly -- by changing the field to which +they are linked + + + + + +The following are the pre-defined validation types. You can also specify custom +validation, though it's a bit tricky and cumbersome. + + +TYPE_ALPHA + +This field type accepts alphabetic data; no blanks, no digits, no special +characters (this is checked at character-entry time). It is set up with: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_ALPHA, /* type to associate */ + int width); /* maximum width of field */ + + + +The width argument sets a minimum width of data. The user has to enter at-least +width number of characters before he can leave the field. Typically +you'll want to set this to the field width; if it's greater than the +field width, the validation check will always fail. A minimum width +of zero makes field completion optional. + + +TYPE_ALNUM + + +This field type accepts alphabetic data and digits; no blanks, no special +characters (this is checked at character-entry time). It is set up with: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_ALNUM, /* type to associate */ + int width); /* maximum width of field */ + + + +The width argument sets a minimum width of data. As with +TYPE_ALPHA, typically you'll want to set this to the field width; if it's +greater than the field width, the validation check will always fail. A +minimum width of zero makes field completion optional. + + +TYPE_ENUM + +This type allows you to restrict a field's values to be among a specified +set of string values (for example, the two-letter postal codes for U.S. +states). It is set up with: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_ENUM, /* type to associate */ + char **valuelist; /* list of possible values */ + int checkcase; /* case-sensitive? */ + int checkunique); /* must specify uniquely? */ + + + +The valuelist parameter must point at a NULL-terminated list of +valid strings. The checkcase argument, if true, makes comparison +with the string case-sensitive. + + + +When the user exits a TYPE_ENUM field, the validation procedure tries to +complete the data in the buffer to a valid entry. If a complete choice string +has been entered, it is of course valid. But it is also possible to enter a +prefix of a valid string and have it completed for you. + + + +By default, if you enter such a prefix and it matches more than one value +in the string list, the prefix will be completed to the first matching +value. But the checkunique argument, if true, requires prefix +matches to be unique in order to be valid. + + + +The REQ_NEXT_CHOICE and REQ_PREV_CHOICE input requests can be particularly +useful with these fields. + + +TYPE_INTEGER + + +This field type accepts an integer. It is set up as follows: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_INTEGER, /* type to associate */ + int padding, /* # places to zero-pad to */ + int vmin, int vmax); /* valid range */ + + + +Valid characters consist of an optional leading minus and digits. +The range check is performed on exit. If the range maximum is less +than or equal to the minimum, the range is ignored. + + + +If the value passes its range check, it is padded with as many leading +zero digits as necessary to meet the padding argument. + + + +A TYPE_INTEGER value buffer can conveniently be interpreted with the C library +function atoi(3). + + +TYPE_NUMERIC + +This field type accepts a decimal number. It is set up as follows: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_NUMERIC, /* type to associate */ + int padding, /* # places of precision */ + int vmin, int vmax); /* valid range */ + + + +Valid characters consist of an optional leading minus and digits. possibly +including a decimal point. The range check is performed on exit. If the +range maximum is less than or equal to the minimum, the range is +ignored. + + + +If the value passes its range check, it is padded with as many trailing +zero digits as necessary to meet the padding argument. + + + +A TYPE_NUMERIC value buffer can conveniently be interpreted with the C library +function atof(3). + + +TYPE_REGEXP + +This field type accepts data matching a regular expression. It is set up +as follows: + + + +int set_field_type(FIELD *field, /* field to alter */ + TYPE_REGEXP, /* type to associate */ + char *regexp); /* expression to match */ + + + +The syntax for regular expressions is that of regcomp(3). +The check for regular-expression match is performed on exit. + + + + Form Driver: The work horse of the forms system + +As in the menu system, form_driver() plays a very important role in forms +system. All types of requests to forms system should be funneled through +form_driver(). + + + +int form_driver(FORM *form, /* form on which to operate */ + int request) /* form request code */ + + + +As you have seen some of the examples above, you have to be in a loop looking +for user input and then decide whether it's a field data or a form request. The +form requests are then passed to form_driver() to do the work. + + + +The requests roughly can be divided into following categories. Different +requests and their usage is explained below: + + + Page Navigation Requests + +These requests cause page-level moves through the form, triggering display of a +new form screen. A form can be made of multiple pages. If you have a big form +with lot of fields and logical sections, then you can divide the form into +pages. The function set_new_page() to set a new page at the field specified. + + + +int set_new_page(FIELD *field,/* Field at which page break to be set or unset */ + bool new_page_flag); /* should be TRUE to put a break */ + + + +The following requests allow you to move to different pages + + + +REQ_NEXT_PAGE Move to the next form page. + + +REQ_PREV_PAGE Move to the previous +form page. + +REQ_FIRST_PAGE Move to the first form page. + + +REQ_LAST_PAGE Move to the last form page. + + + + +These requests treat the list as cyclic; that is, REQ_NEXT_PAGE from the +last page goes to the first, and REQ_PREV_PAGE from the first page goes to +the last. + + + + Inter-Field Navigation Requests + +These requests handle navigation between fields on the same page. + + + +REQ_NEXT_FIELD + Move to next field. +REQ_PREV_FIELD + Move to previous field. +REQ_FIRST_FIELD + Move to the first field. +REQ_LAST_FIELD + Move to the last field. +REQ_SNEXT_FIELD + Move to sorted next field. +REQ_SPREV_FIELD + Move to sorted previous field. +REQ_SFIRST_FIELD + Move to the sorted first field. +REQ_SLAST_FIELD + Move to the sorted last field. +REQ_LEFT_FIELD + Move left to field. +REQ_RIGHT_FIELD + Move right to field. +REQ_UP_FIELD + Move up to field. +REQ_DOWN_FIELD + Move down to field. + + + +These requests treat the list of fields on a page as cyclic; that is, +REQ_NEXT_FIELD from the last field goes to the first, and REQ_PREV_FIELD +from the first field goes to the last. The order of the fields for these +(and the REQ_FIRST_FIELD and REQ_LAST_FIELD requests) is simply the order of +the field pointers in the form array (as set up by new_form() or +set_form_fields() + + + +It is also possible to traverse the fields as if they had been sorted in +screen-position order, so the sequence goes left-to-right and top-to-bottom. +To do this, use the second group of four sorted-movement requests. + + + +Finally, it is possible to move between fields using visual directions up, +down, right, and left. To accomplish this, use the third group of four +requests. Note, however, that the position of a form for purposes of these +requests is its upper-left corner. + + + +For example, suppose you have a multi-line field B, and two single-line +fields A and C on the same line with B, with A to the left of B and C to the +right of B. A REQ_MOVE_RIGHT from A will go to B only if A, B, and C all +share the same first line; otherwise it will skip over B to C. + + + + Intra-Field Navigation Requests + +These requests drive movement of the edit cursor within the currently +selected field. + + + +REQ_NEXT_CHAR + Move to next character. +REQ_PREV_CHAR + Move to previous character. +REQ_NEXT_LINE + Move to next line. +REQ_PREV_LINE + Move to previous line. +REQ_NEXT_WORD + Move to next word. +REQ_PREV_WORD + Move to previous word. +REQ_BEG_FIELD + Move to beginning of field. +REQ_END_FIELD + Move to end of field. +REQ_BEG_LINE + Move to beginning of line. +REQ_END_LINE + Move to end of line. +REQ_LEFT_CHAR + Move left in field. +REQ_RIGHT_CHAR + Move right in field. +REQ_UP_CHAR + Move up in field. +REQ_DOWN_CHAR + Move down in field. + + + +Each word is separated from the previous and next characters by whitespace. +The commands to move to beginning and end of line or field look for the +first or last non-pad character in their ranges. + + + + Scrolling Requests + +Fields that are dynamic and have grown and fields explicitly created with +offscreen rows are scrollable. One-line fields scroll horizontally; +multi-line fields scroll vertically. Most scrolling is triggered by editing +and intra-field movement (the library scrolls the field to keep the cursor +visible). It is possible to explicitly request scrolling with the following +requests: + + + +REQ_SCR_FLINE + Scroll vertically forward a line. +REQ_SCR_BLINE + Scroll vertically backward a line. +REQ_SCR_FPAGE + Scroll vertically forward a page. +REQ_SCR_BPAGE + Scroll vertically backward a page. +REQ_SCR_FHPAGE + Scroll vertically forward half a page. +REQ_SCR_BHPAGE + Scroll vertically backward half a page. +REQ_SCR_FCHAR + Scroll horizontally forward a character. +REQ_SCR_BCHAR + Scroll horizontally backward a character. +REQ_SCR_HFLINE + Scroll horizontally one field width forward. +REQ_SCR_HBLINE + Scroll horizontally one field width backward. +REQ_SCR_HFHALF + Scroll horizontally one half field width forward. +REQ_SCR_HBHALF + Scroll horizontally one half field width backward. + + + +For scrolling purposes, a page of a field is the height of its visible part. + + + + Editing Requests + +When you pass the forms driver an ASCII character, it is treated as a +request to add the character to the field's data buffer. Whether this is an +insertion or a replacement depends on the field's edit mode (insertion is +the default. + + + +The following requests support editing the field and changing the edit mode: + + + +REQ_INS_MODE + Set insertion mode. +REQ_OVL_MODE + Set overlay mode. +REQ_NEW_LINE + New line request (see below for explanation). +REQ_INS_CHAR + Insert space at character location. +REQ_INS_LINE + Insert blank line at character location. +REQ_DEL_CHAR + Delete character at cursor. +REQ_DEL_PREV + Delete previous word at cursor. +REQ_DEL_LINE + Delete line at cursor. +REQ_DEL_WORD + Delete word at cursor. +REQ_CLR_EOL + Clear to end of line. +REQ_CLR_EOF + Clear to end of field. +REQ_CLEAR_FIELD + Clear entire field. + + + +The behavior of the REQ_NEW_LINE and REQ_DEL_PREV requests is complicated +and partly controlled by a pair of forms options. The special cases are +triggered when the cursor is at the beginning of a field, or on the last +line of the field. + + + +First, we consider REQ_NEW_LINE: + + + +The normal behavior of REQ_NEW_LINE in insert mode is to break the current +line at the position of the edit cursor, inserting the portion of the +current line after the cursor as a new line following the current and moving +the cursor to the beginning of that new line (you may think of this as +inserting a newline in the field buffer). + + + +The normal behavior of REQ_NEW_LINE in overlay mode is to clear the current +line from the position of the edit cursor to end of line. The cursor is then +moved to the beginning of the next line. + + + +However, REQ_NEW_LINE at the beginning of a field, or on the last line of a +field, instead does a REQ_NEXT_FIELD. O_NL_OVERLOAD option is off, this +special action is disabled. + + + +Now, let us consider REQ_DEL_PREV: + + + +The normal behavior of REQ_DEL_PREV is to delete the previous character. If +insert mode is on, and the cursor is at the start of a line, and the text on +that line will fit on the previous one, it instead appends the contents of +the current line to the previous one and deletes the current line (you may +think of this as deleting a newline from the field buffer). + + + +However, REQ_DEL_PREV at the beginning of a field is instead treated as a +REQ_PREV_FIELD. + + + +If the O_BS_OVERLOAD option is off, this special action is disabled and the +forms driver just returns E_REQUEST_DENIED. + + + + Order Requests + +If the type of your field is ordered, and has associated functions for +getting the next and previous values of the type from a given value, there +are requests that can fetch that value into the field buffer: + + + +REQ_NEXT_CHOICE + Place the successor value of the current value in the buffer. + +REQ_PREV_CHOICE + Place the predecessor value of the current value in the buffer. + + + + +Of the built-in field types, only TYPE_ENUM has built-in successor and +predecessor functions. When you define a field type of your own (see Custom +Validation Types), you can associate our own ordering functions. + + + + Application Commands + +Form requests are represented as integers above the curses value greater than +KEY_MAX and less than or equal to the constant MAX_COMMAND. A value within this +range gets ignored by form_driver(). So this can be used for any purpose by the +application. It can be treated as an application specific action and take +corresponding action. + + + + + + Tools and Widget Libraries + +Now that you have seen the capabilities of ncurses and its sister libraries, you +are rolling your sleeves up and gearing for a project that heavily manipulates +screen. But wait.. It can be pretty difficult to write and maintain complex GUI +widgets in plain ncurses or even with the additional libraries. There are some +ready-to-use tools and widget libraries that can be used instead of writing your +own widgets. You can use some of them, get ideas from the code, or even extend +them. + + + CDK (Curses Development Kit) + +In the author's words + + + + +CDK stands for 'Curses Development Kit' and it currently contains 21 ready +to use widgets which facilitate the speedy development of full screen +curses programs. + + + + +The kit provides some useful widgets, which can be used in your programs +directly. It's pretty well written and the documentation is very good. The +examples in the examples directory can be a good place to start for beginners. +The CDK can be downloaded from +http://www.vexus.ca/release/cdk.tar.gz . Follow the instructions in +README file to install it. + + + Widget List + + +The following is the list of widgets provided with cdk and their description. + + + +Widget Type Quick Description +=========================================================================== +Alphalist Allows a user to select from a list of words, with + the ability to narrow the search list by typing in a + few characters of the desired word. +Buttonbox This creates a multiple button widget. +Calendar Creates a little simple calendar widget. +Dialog Prompts the user with a message, and the user + can pick an answer from the buttons provided. +Entry Allows the user to enter various types of information. +File Selector A file selector built from Cdk base widgets. This + example shows how to create more complicated widgets + using the Cdk widget library. +Graph Draws a graph. +Histogram Draws a histogram. +Item List Creates a pop up field which allows the user to select + one of several choices in a small field. Very useful + for things like days of the week or month names. +Label Displays messages in a pop up box, or the label can be + considered part of the screen. +Marquee Displays a message in a scrolling marquee. +Matrix Creates a complex matrix with lots of options. +Menu Creates a pull-down menu interface. +Multiple Line Entry A multiple line entry field. Very useful + for long fields. (like a description + field) +Radio List Creates a radio button list. +Scale Creates a numeric scale. Used for allowing a user to + pick a numeric value and restrict them to a range of + values. +Scrolling List Creates a scrolling list/menu list. +Scrolling Window Creates a scrolling log file viewer. Can add + information into the window while its running. + A good widget for displaying the progress of + something. (akin to a console window) +Selection List Creates a multiple option selection list. +Slider Akin to the scale widget, this widget provides a + visual slide bar to represent the numeric value. +Template Creates a entry field with character sensitive + positions. Used for pre-formatted fields like + dates and phone numbers. +Viewer This is a file/information viewer. Very useful + when you need to display loads of information. +=========================================================================== + + + + Some Attractive Features + +Apart from making our life easier with readily usable widgets, cdk solves one +frustrating problem with printing multi colored strings, justified strings +elegantly. Special formatting tags can be embedded in the strings which are +passed to CDK functions. For Example + + + +If the string + + + +"</B/1>This line should have a yellow foreground and a blue +background.<!1>" + + + +given as a parameter to newCDKLabel(), it prints the line with yellow foreground +and blue background. There are other tags available for justifying string, +embedding special drawing characters etc.. Please refer to the man page +cdk_display(3X) for details. The man page explains the usage with nice examples. + + + + Conclusion + +All in all, CDK is a well-written package of widgets, which if used properly can +form a strong frame work for developing complex GUI. + + + + + The dialog + +Long long ago, in September 1994, when few people knew linux, Jeff Tranter wrote +an article + on dialog in Linux Journal. He starts the article with these words.. + + + + +Linux is based on the Unix operating system, but also features a number of +unique and useful kernel features and application programs that often go beyond +what is available under Unix. One little-known gem is "dialog", a utility for +creating professional-looking dialog boxes from within shell scripts. This +article presents a tutorial introduction to the dialog utility, and shows +examples of how and where it can be used + + + + +As he explains, dialog is a real gem in making professional-looking dialog boxes +with ease. It creates a variety of dialog boxes, menus, check lists etc.. It is +usually installed by default. If not, you can find it at ibiblio +linux archive. + + + +The above-mentioned article gives a very good overview of its uses and +capabilites. The man page has more details. It can be used in variety of +situations. One good example is building of linux kernel in text mode. Linux +kernel uses a modified version of dialog tailored for its needs. + + + +dialog was initially designed to be used with shell scripts. If you want to use +its functionality in a c program, then you can use libdialog. The documentation +regarding this is sparse. Definitive reference is the dialog.h header file which +comes with the library. You may need to hack here and there to get the required +output. The source is easily customizable. I have used it on a number of +occasions by modifying the code. + + + + Perl Curses Modules CURSES::FORM and CURSES::WIDGETS + +The perl module Curses, Curses::Form and Curses::Widgets give access to curses +from perl. If you have curses and basic perl is installed, you can get these +modules from CPAN +All Modules page. Get the three zipped modules in the Curses category. +Once installed you can use these modules from perl scripts like any other +module. For more information on perl modules see perlmod man page. The above +modules come with good documentation and they have some demo scripts to test the +functionality. Though the widgets provided are very rudimentary, these modules +provide good access to curses library from perl. + + + +For more information see man pages Curses(3) , Curses::Form(3) and +Curses::Widgets(3). These pages are installed only when the above modules are +acquired and installed. + + + + + Just For Fun !!! + + +This section contains few programs written by me just for fun. They don't +signify a better programming practice or the best way of using ncurses. They are +provided here so as to allow beginners to get ideas and add more programs to +this section. If you have written a couple of nice, simple programs in curses +and want them to included here, contact +me. + + +The Game of Life + +Game of life is a wonder of math. In + +Paul Callahan's words + + + + +The Game of Life (or simply Life) is not a game in the conventional sense. There +are no players, and no winning or losing. Once the "pieces" are placed in the +starting position, the rules determine everything that happens later. +Nevertheless, Life is full of surprises! In most cases, it is impossible to look +at a starting position (or pattern) and see what will happen in the future. The +only way to find out is to follow the rules of the game. + + + + +This program starts with a simple inverted U pattern and shows how wonderful +life works. There is a lot of room for improvement in the program. You can let +the user enter pattern of his choice or even take input from a file. You can +also change rules and play with a lot of variations. Search on google for interesting information on game +of life. + + + +File Path: JustForFun/life.c + + + +Magic Square + +Magic Square, another wonder of math, is very simple to understand but very +difficult to make. In a magic square sum of the numbers in each row, each column +is equal. Even diagnol sum can be equal. There are many variations which have +special properties. + + + +This program creates a simple magic square of odd order. + + + +File Path: JustForFun/magic.c + + + + Towers of Hanoi + +The famous towers of hanoi solver. The aim of the game is to move the disks on +the first peg to last peg, using middle peg as a temporary stay. The catch is +not to place a larger disk over a small disk at any time. + + + +File Path: JustForFun/hanoi.c + + + + Queens Puzzle + +The objective of the famous N-Queen puzzle is to put N queens on a N X N chess +board without attacking each other. + + + +This program solves it with a simple backtracking technique. + + + +File Path: JustForFun/queens.c + + + + Shuffle + +A fun game, if you have time to kill. + + + +File Path: JustForFun/shuffle.c + + + + Typing Tutor + +A simple typing tutor, I created more out of need than for ease of use. If you +know how to put your fingers correctly on the keyboard, but lack practice, this +can be helpful. + + + +File Path: JustForFun/tt.c + + + +
+ + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/README new file mode 100644 index 00000000..d60a2ecc --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/README @@ -0,0 +1,45 @@ +This directory is structured as follows: + +LDP/howto/docbook/NCURSES-HOWTO + | + |----> NCURSES-Programming-HOWTO.sgml -- the sgml source of the howto + |----> ncurses_programs -- directory containing example + | -- programs. See README in the + | -- directory for details + |----> ncurses_programs.tar.gz -- tar, gzipped programs. Generated + | -- with command + | -- tar --exclude CVS -cvf ncurses_programs.tar.gz + | -- ncurses_programs/* + |----> insert.pl -- a script used to remove inlined programs + | -- it is used only once. + |----> README -- this file + +Bulding from source +------------------- +If you are planning to download the sgml source and build various formats +of the document, follow these instructions. + + Get both the source and the tar,gzipped programs, available at + http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/ + NCURSES-HOWTO/NCURSES-Programming-HOWTO.sgml + http://cvsview.tldp.org/index.cgi/LDP/howto/docbook/ + NCURSES-HOWTO/ncurses_programs.tar.gz + + Unzip ncurses_programs.tar.gz with + tar zxvf ncurses_programs.tar.gz + + Use jade to create various formats. For example if you just want to create + the multiple html files, you would use + jade -t sgml -i html -d + NCURSES-Programming-HOWTO.sgml + to get pdf, first create a single html file of the HOWTO with + jade -t sgml -i html -d -V nochunks + NCURSES-Programming-HOWTO.sgml > NCURSES-ONE-BIG-FILE.html + then use htmldoc to get pdf file with + htmldoc --size universal -t pdf --firstpage p1 -f + NCURSES-ONE-BIG-FILE.html + for ps, you would use + htmldoc --size universal -t ps --firstpage p1 -f + NCURSES-ONE-BIG-FILE.html + +For more details on jade usage see the section on jade in LDP-Author-Guide diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/insert.pl b/LDP/howto/docbook/NCURSES-Programming-HOWTO/insert.pl new file mode 100755 index 00000000..acd12d01 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/insert.pl @@ -0,0 +1,59 @@ +#!/usr/local/bin/perl +# Converts the inline programlistings into filerefs +# The original source should contain some thing like +# +# /* File Path: adir/filename */ +# .. +# .. +# .. +# +# +# this gets converted to +# +# +# +# +# + +if(@ARGV != 1) { + print "Usage: $0 \n"; + exit(1); +} + +open(ORIG, "<$ARGV[0]") || die("Cannot open input file"); +open(TMP, ">tmp.out"); + +$ready = 0; + +while() { + chomp; + + if(/^\/) { + $ready = 1; + } + elsif ($ready == 1) { + if(/^\/\*.*:\s([\w\/\.]+)\s/) { + print TMP "\n"; + print TMP " \n"; + $ready = 2; + } + else { + print TMP "\n"; + print TMP "$_\n"; + $ready = 0; + } + } + elsif($ready == 2 && /\<\/programlisting\>/) { + print TMP "\n"; + $ready = 0; + } + elsif($ready != 2) { + print TMP $_, "\n"; + next; + } +} +close(TMP); +close(ORIG); + +#system("mv tmp.out $ARGV[0]"); diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs.tar.gz b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs.tar.gz new file mode 100644 index 00000000..61c02093 Binary files /dev/null and b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs.tar.gz differ diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/COPYING b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/COPYING new file mode 100644 index 00000000..858e1e32 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/COPYING @@ -0,0 +1,18 @@ +Copyright (c) 2001, Pradeep Padala. + +All the programs in this directory and sub directories are free +software; you can redistribute them and/or modify them under the +terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + +Please send comments to p_padala@yahoo.com diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/Makefile new file mode 100644 index 00000000..3f0890e2 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/Makefile @@ -0,0 +1,28 @@ +# Makefile for JustForFun Files + +# A few variables + +CC=gcc +LIBS=-lncurses + +SRC_DIR=. +EXE_DIR=../demo/exe + +EXES = \ + ${EXE_DIR}/hanoi \ + ${EXE_DIR}/life\ + ${EXE_DIR}/magic \ + ${EXE_DIR}/queens \ + ${EXE_DIR}/shuffle \ + ${EXE_DIR}/tt + +${EXE_DIR}/%: %.o + ${CC} -o $@ $< ${LIBS} + +%.o: ${SRC_DIR}/%.c + ${CC} -o $@ -c $< + +all: ${EXES} + +clean: + @rm -f ${EXES} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/README new file mode 100644 index 00000000..a5d743ff --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/README @@ -0,0 +1,10 @@ +Description of files +-------------------- +JustForFun + | + |----> hanoi.c -- The Towers of Hanoi Solver + |----> life.c -- The Game of Life demo + |----> magic.c -- An Odd Order Magic Square builder + |----> queens.c -- The famous N-Queens Solver + |----> shuffle.c -- A fun game, if you have time to kill + |----> tt.c -- A very trivial typing tutor diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/hanoi.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/hanoi.c new file mode 100644 index 00000000..b57b0b71 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/hanoi.c @@ -0,0 +1,178 @@ +#include + +#define POSX 10 +#define POSY 5 +#define DISC_CHAR '*' +#define PEG_CHAR '#' +#define TIME_OUT 300 + +typedef struct _peg_struct { + int n_discs; /* Number of discs at present */ + int bottomx, bottomy; /* bottom x, bottom y co-ord */ + int *sizes; /* The disc sizes array */ +}peg; + +void init_pegs(peg *p_my_pegs, int n_discs); +void show_pegs(WINDOW *win, peg *p_my_pegs, int n_discs); +void free_pegs(peg *p_my_pegs, int n_discs); +void solve_hanoi(peg *p_my_pegs, int n, int src, int aux, int dst); +void move_disc(peg *p_my_pegs, int n_discs, int src, int dst); +void print_in_middle(int startx, int starty, int width, char *string, WINDOW *win); +void check_usr_response(peg *p_my_pegs, int n_discs); + +int store_n_discs; +char *welcome_string = "Enter the number of discs you want to be solved: "; + +int main(int argc, char *argv[]) +{ int n_discs; + peg my_pegs[3]; + + initscr(); /* Start curses mode */ + cbreak(); /* Line buffering disabled. Pass on every thing */ + keypad(stdscr, TRUE); + curs_set(FALSE); + + print_in_middle(0, LINES / 2, COLS, welcome_string, NULL); + scanw("%d", &n_discs); + + timeout(TIME_OUT); + noecho(); + store_n_discs = n_discs; + + init_pegs(my_pegs, n_discs); + show_pegs(stdscr, my_pegs, n_discs); + solve_hanoi(my_pegs, n_discs, 0, 1, 2); + + free_pegs(my_pegs, n_discs); + endwin(); /* End curses mode */ + return 0; +} + +void solve_hanoi(peg *p_my_pegs, int n_discs, int src, int aux, int dst) +{ if(n_discs == 0) + return; + solve_hanoi(p_my_pegs, n_discs - 1, src, dst, aux); + move_disc(p_my_pegs, store_n_discs, src, dst); + show_pegs(stdscr, p_my_pegs, store_n_discs); + check_usr_response(p_my_pegs, store_n_discs); + solve_hanoi(p_my_pegs, n_discs - 1, aux, src, dst); +} + +void check_usr_response(peg *p_my_pegs, int n_discs) +{ int ch; + + ch = getch(); /* Waits for TIME_OUT milliseconds */ + if(ch == ERR) + return; + else + if(ch == KEY_F(1)) + { free_pegs(p_my_pegs, n_discs); + endwin(); + exit(0); + } +} + +void move_disc(peg *p_my_pegs, int n_discs, int src, int dst) +{ int temp, index; + + --p_my_pegs[src].n_discs; + index = 0; + while(p_my_pegs[src].sizes[index] == 0 && index != n_discs) + ++index; + temp = p_my_pegs[src].sizes[index]; + p_my_pegs[src].sizes[index] = 0; + + index = 0; + while(p_my_pegs[dst].sizes[index] == 0 && index != n_discs) + ++index; + --index; + p_my_pegs[dst].sizes[index] = temp; + ++p_my_pegs[dst].n_discs; +} + +void init_pegs(peg *p_my_pegs, int n_discs) +{ int size, temp, i; + + p_my_pegs[0].n_discs = n_discs; + + /* Allocate memory for size array + * atmost the number of discs on a peg can be n_discs + */ + for(i = 0; i < n_discs; ++i) + p_my_pegs[i].sizes = (int *)calloc(n_discs, sizeof(int)); + size = 3; + for(i = 0;i < n_discs; ++i, size += 2) + p_my_pegs[0].sizes[i] = size; + + temp = (p_my_pegs[0].sizes[n_discs - 1] / 2); + p_my_pegs[0].bottomx = POSX + 1 + temp; + p_my_pegs[0].bottomy = POSY + 2 + n_discs; + + p_my_pegs[1].bottomx = p_my_pegs[0].bottomx + 2 + 2 * temp; + p_my_pegs[1].bottomy = POSY + 2 + n_discs; + + p_my_pegs[2].bottomx = p_my_pegs[1].bottomx + 2 + 2 * temp; + p_my_pegs[2].bottomy = POSY + 2 + n_discs; +} + +void show_pegs(WINDOW *win, peg *p_my_pegs, int n_discs) +{ int i, j, k, x, y, size; + + wclear(win); + attron(A_REVERSE); + mvprintw(24, 0, "Press F1 to Exit"); + attroff(A_REVERSE); + for(i = 0;i < 3; ++i) + mvwprintw( win, p_my_pegs[i].bottomy - n_discs - 1, + p_my_pegs[i].bottomx, "%c", PEG_CHAR); + y = p_my_pegs[0].bottomy - n_discs; + for(i = 0; i < 3; ++i) /* For each peg */ + { for(j = 0; j < n_discs; ++ j) /* For each row */ + { if(p_my_pegs[i].sizes[j] != 0) + { size = p_my_pegs[i].sizes[j]; + x = p_my_pegs[i].bottomx - (size / 2); + for(k = 0; k < size; ++k) + mvwprintw(win, y, x + k, "%c", DISC_CHAR); + } + else + mvwprintw(win, y, p_my_pegs[i].bottomx, "%c", PEG_CHAR); + ++y; + } + y = p_my_pegs[0].bottomy - n_discs; + } + wrefresh(win); +} + +void free_pegs(peg *p_my_pegs, int n_discs) +{ int i; + + for(i = 0;i < n_discs; ++i) + free(p_my_pegs[i].sizes); +} + +/* -------------------------------------------------------------* + * startx = 0 means at present x * + * starty = 0 means at present y * + * win = NULL means take stdscr * + * -------------------------------------------------------------*/ + +void print_in_middle(int startx, int starty, int width, char *string, WINDOW *win) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + mvwprintw(win, y, x, "%s", string); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/life.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/life.c new file mode 100644 index 00000000..07d54ab1 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/life.c @@ -0,0 +1,107 @@ +#include + +int STARTX = 0; +int STARTY = 0; +int ENDX = 79; +int ENDY = 24; + +#define CELL_CHAR '#' +#define TIME_OUT 300 + +typedef struct _state { + int oldstate; + int newstate; +}state; + +void display(WINDOW *win, state **area, int startx, int starty, int endx, int endy); +void calc(state **area, int x, int y); +void update_state(state **area, int startx, int starty, int endx, int endy); + +int main() +{ state **workarea; + int i, j; + + initscr(); + cbreak(); + timeout(TIME_OUT); + keypad(stdscr, TRUE); + + ENDX = COLS - 1; + ENDY = LINES - 1; + + workarea = (state **)calloc(COLS, sizeof(state *)); + for(i = 0;i < COLS; ++i) + workarea[i] = (state *)calloc(LINES, sizeof(state)); + + /* For inverted U */ + workarea[39][15].newstate = TRUE; + workarea[40][15].newstate = TRUE; + workarea[41][15].newstate = TRUE; + workarea[39][16].newstate = TRUE; + workarea[39][17].newstate = TRUE; + workarea[41][16].newstate = TRUE; + workarea[41][17].newstate = TRUE; + update_state(workarea, STARTX, STARTY, ENDX, ENDY); + + /* For block */ +/* + workarea[37][13].newstate = TRUE; + workarea[37][14].newstate = TRUE; + workarea[38][13].newstate = TRUE; + workarea[38][14].newstate = TRUE; + + update_state(workarea, STARTX, STARTY, ENDX, ENDY); +*/ + display(stdscr, workarea, STARTX, STARTY, ENDX, ENDY); + while(getch() != KEY_F(1)) + { for(i = STARTX; i <= ENDX; ++i) + for(j = STARTY; j <= ENDY; ++j) + calc(workarea, i, j); + update_state(workarea, STARTX, STARTY, ENDX, ENDY); + display(stdscr, workarea, STARTX, STARTY, ENDX, ENDY); + } + + endwin(); + return 0; +} + +void display(WINDOW *win, state **area, int startx, int starty, int endx, int endy) +{ int i, j; + wclear(win); + for(i = startx; i <= endx; ++i) + for(j = starty;j <= endy; ++j) + if(area[i][j].newstate == TRUE) + mvwaddch(win, j, i, CELL_CHAR); + wrefresh(win); +} + +void calc(state **area, int i, int j) +{ int neighbours; + int newstate; + + neighbours = + area[(i - 1 + COLS) % COLS][j].oldstate + + area[(i - 1 + COLS) % COLS][(j - 1 + LINES) % LINES].oldstate + + area[(i - 1 + COLS) % COLS][(j + 1) % LINES].oldstate + + area[(i + 1) % COLS][j].oldstate + + area[(i + 1) % COLS][(j - 1 + LINES) % LINES].oldstate + + area[(i + 1) % COLS][(j + 1) % LINES].oldstate + + area[i][(j - 1 + LINES) % LINES].oldstate + + area[i][(j + 1) % LINES].oldstate; + + newstate = FALSE; + if(area[i][j].oldstate == TRUE && (neighbours == 2 || neighbours == 3)) + newstate = TRUE; + else + if(area[i][j].oldstate == FALSE && neighbours == 3) + newstate = TRUE; + area[i][j].newstate = newstate; +} + +void update_state(state **area, int startx, int starty, int endx, int endy) +{ int i, j; + + for(i = startx; i <= endx; ++i) + for(j = starty; j <= endy; ++j) + area[i][j].oldstate = area[i][j].newstate; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/magic.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/magic.c new file mode 100644 index 00000000..09dc2ad9 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/magic.c @@ -0,0 +1,160 @@ +#include + +#define STARTX 9 +#define STARTY 3 +#define WIDTH 6 +#define HEIGHT 4 + +#define TRACE_VALUE TRACE_MAXIMUM + +void board( WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height); +void magic(int **, int); +void print(int **, int); +void magic_board(int **a,int n); + +int main(int argc, char *argv[]) +{ + + int **a,n,i; + + if(argc != 2) + { printf("Usage: %s \n", argv[0]); + exit(0); + } + n = atoi(argv[1]); + if(n % 2 == 0) + { printf("Sorry !!! I don't know how to create magic square of even order\n"); + printf("The order should be an odd number\n"); + exit(0); + } + a = (int **) malloc(n * sizeof(int*)); + for(i = 0;i < n;++i) + a[i] = (int *)malloc(n * sizeof(int)); + + magic(a,n); + + initscr(); + curs_set(0); + noecho(); + magic_board(a,n); + getch(); + endwin(); + + return; +} + +void magic(int **a, int n) +{ + int i,j,k; + int row,col; + for(i = 0;i < n;++i) + for(j = 0;j < n;++j) + a[i][j] = -1; + row = 0; + col = n / 2; + + k = 1; + a[row][col] = k; + + while(k != n * n) + { + if(row == 0 && col != n - 1) + { row = n - 1; + col ++; + a[row][col] = ++k; + } + else if(row != 0 && col != n - 1) + { if(a[row - 1][col + 1] == -1) + { row --; + col ++; + a[row][col] = ++k; + } + else + { + row ++; + a[row][col] = ++k; + } + } + else if(row != 0 && col == n - 1) + { + row --; + col = 0; + a[row][col] = ++k; + } + else if(row == 0 && col == n - 1) + { row ++; + a[row][col] = ++k; + } + + } + return; +} + +void print(int **a,int n) +{ int i,j; + int x,y; + x = STARTX; + y = STARTY; + mvprintw(1,30,"MAGIC SQUARE"); + for(i = 0;i < n;++i) + { for(j = 0;j < n;++j) + { mvprintw(y,x,"%d",a[i][j]); + if(n > 9) + x += 4; + else + x += 6; + } + x = STARTX; + if(n > 7) + y += 2; + else + y += 3; + } + refresh(); +} +void board(WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height) +{ int endy, endx, i, j; + + endy = starty + lines * tile_height; + endx = startx + cols * tile_width; + + for(j = starty; j <= endy; j += tile_height) + for(i = startx; i <= endx; ++i) + mvwaddch(win, j, i, ACS_HLINE); + for(i = startx; i <= endx; i += tile_width) + for(j = starty; j <= endy; ++j) + mvwaddch(win, j, i, ACS_VLINE); + mvwaddch(win, starty, startx, ACS_ULCORNER); + mvwaddch(win, endy, startx, ACS_LLCORNER); + mvwaddch(win, starty, endx, ACS_URCORNER); + mvwaddch(win, endy, endx, ACS_LRCORNER); + for(j = starty + tile_height; j <= endy - tile_height; j += tile_height) + { mvwaddch(win, j, startx, ACS_LTEE); + mvwaddch(win, j, endx, ACS_RTEE); + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + mvwaddch(win, j, i, ACS_PLUS); + } + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + { mvwaddch(win, starty, i, ACS_TTEE); + mvwaddch(win, endy, i, ACS_BTEE); + } + wrefresh(win); +} + +void magic_board(int **a,int n) +{ int i,j, deltax, deltay; + int startx, starty; + + starty = (LINES - n * HEIGHT) / 2; + startx = (COLS - n * WIDTH) / 2; + board(stdscr, starty, startx, n, n, WIDTH, HEIGHT); + deltay = HEIGHT / 2; + deltax = WIDTH / 2; + for(i = 0;i < n; ++i) + for(j = 0; j < n; ++j) + mvprintw(starty + j * HEIGHT + deltay, + startx + i * WIDTH + deltax, + "%d", a[i][j]); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/queens.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/queens.c new file mode 100644 index 00000000..a7c01890 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/queens.c @@ -0,0 +1,122 @@ +#include +#include + +#define QUEEN_CHAR '*' + +int *nqueens(int num); +int place(int current, int *position); +int print(int *positions, int num_queens); +void board(WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height); + +int main(int argc, char *argv[]) +{ + int num_queens, *positions, count; + + if(argc != 2) + { printf("Usage: %s \n", argv[0]); + exit(1); + } + + num_queens = atoi(argv[1]); + initscr(); + cbreak(); + keypad(stdscr, TRUE); + positions = nqueens(num_queens); + free(positions); + endwin(); + return 0; +} + +int *nqueens(int num) +{ + int current, *position, num_solutions = 0; + + position = (int *) calloc(num + 1, sizeof(int)); + + position[1] = 0; + current = 1; /* current queen is being checked */ + /* position[current] is the coloumn*/ + while(current > 0){ + position[current] += 1; + while(position[current] <= num && !place(current, position) ) + position[current] += 1; + if(position[current] <= num){ + if(current == num) { + ++num_solutions; + print(position, num); + } + else { + current += 1; + position[current] = 0; + } + } + else current -= 1; /* backtrack */ + } + printf("Total Number of Solutions : %d\n", num_solutions); + return(position); +} + +int place(int current, int *position) +{ + int i; + if(current == 1) return(1); + for(i = 1; i < current; ++i) + if(position[i] == position[current]) return(0); + else if(abs(position[i] - position[current]) == + abs(i - current)) + return(0); + + return(1); +} + +int print(int *positions, int num_queens) +{ int count; + int y = 2, x = 2, w = 4, h = 2; + static int solution = 1; + + mvprintw(0, 0, "Solution No: %d", solution++); + board(stdscr, y, x, num_queens, num_queens, w, h); + for(count = 1; count <= num_queens; ++count) + { int tempy = y + (count - 1) * h + h / 2; + int tempx = x + (positions[count] - 1) * w + w / 2; + mvaddch(tempy, tempx, QUEEN_CHAR); + } + refresh(); + mvprintw(LINES - 2, 0, "Press Any Key to See next solution (F1 to Exit)"); + if(getch() == KEY_F(1)) + { endwin(); + exit(0); + } + clear(); +} + +void board(WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height) +{ int endy, endx, i, j; + + endy = starty + lines * tile_height; + endx = startx + cols * tile_width; + + for(j = starty; j <= endy; j += tile_height) + for(i = startx; i <= endx; ++i) + mvwaddch(win, j, i, ACS_HLINE); + for(i = startx; i <= endx; i += tile_width) + for(j = starty; j <= endy; ++j) + mvwaddch(win, j, i, ACS_VLINE); + mvwaddch(win, starty, startx, ACS_ULCORNER); + mvwaddch(win, endy, startx, ACS_LLCORNER); + mvwaddch(win, starty, endx, ACS_URCORNER); + mvwaddch(win, endy, endx, ACS_LRCORNER); + for(j = starty + tile_height; j <= endy - tile_height; j += tile_height) + { mvwaddch(win, j, startx, ACS_LTEE); + mvwaddch(win, j, endx, ACS_RTEE); + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + mvwaddch(win, j, i, ACS_PLUS); + } + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + { mvwaddch(win, starty, i, ACS_TTEE); + mvwaddch(win, endy, i, ACS_BTEE); + } + wrefresh(win); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/shuffle.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/shuffle.c new file mode 100644 index 00000000..f816f7f1 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/shuffle.c @@ -0,0 +1,205 @@ +#include + +#define STARTX 9 +#define STARTY 3 +#define WIDTH 6 +#define HEIGHT 4 + +#define BLANK 0 + +typedef struct _tile { + int x; + int y; +}tile; + +void init_board(int **board, int n, tile *blank); +void board(WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height); +void shuffle_board(int **board, int n); +void move_blank(int direction, int **s_board, int n, tile *blank); +int check_win(int **s_board, int n, tile *blank); + +enum { LEFT, RIGHT, UP, DOWN }; + +int main(int argc, char *argv[]) +{ int **s_board; + int n, i, ch; + tile blank; + + if(argc != 2) + { printf("Usage: %s \n", argv[0]); + exit(1); + } + n = atoi(argv[1]); + + s_board = (int **)calloc(n, sizeof(int *)); + for(i = 0;i < n; ++i) + s_board[i] = (int *)calloc(n, sizeof(int)); + init_board(s_board, n, &blank); + initscr(); + keypad(stdscr, TRUE); + cbreak(); + shuffle_board(s_board, n); + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_LEFT: + move_blank(RIGHT, s_board, n, &blank); + break; + case KEY_RIGHT: + move_blank(LEFT, s_board, n, &blank); + break; + case KEY_UP: + move_blank(DOWN, s_board, n, &blank); + break; + case KEY_DOWN: + move_blank(UP, s_board, n, &blank); + break; + } + shuffle_board(s_board, n); + if(check_win(s_board, n, &blank) == TRUE) + { mvprintw(24, 0, "You Win !!!\n"); + refresh(); + break; + } + } + endwin(); + return 0; +} + +void move_blank(int direction, int **s_board, int n, tile *blank) +{ int temp; + + switch(direction) + { case LEFT: + { if(blank->x != 0) + { --blank->x; + temp = s_board[blank->x][blank->y]; + s_board[blank->x + 1][blank->y] = temp; + s_board[blank->x][blank->y] = BLANK; + } + } + break; + case RIGHT: + { if(blank->x != n - 1) + { ++blank->x; + temp = s_board[blank->x][blank->y]; + s_board[blank->x - 1][blank->y] = temp; + s_board[blank->x][blank->y] = BLANK; + } + } + break; + case UP: + { if(blank->y != 0) + { --blank->y; + temp = s_board[blank->x][blank->y]; + s_board[blank->x][blank->y + 1] = temp; + s_board[blank->x][blank->y] = BLANK; + } + } + break; + case DOWN: + { if(blank->y != n - 1) + { ++blank->y; + temp = s_board[blank->x][blank->y]; + s_board[blank->x][blank->y - 1] = temp; + s_board[blank->x][blank->y] = BLANK; + } + } + break; + } +} + +int check_win(int **s_board, int n, tile *blank) +{ int i, j; + + s_board[blank->x][blank->y] = n * n; + for(i = 0;i < n; ++i) + for(j = 0;j < n; ++j) + if(s_board[i][j] != j * n + i + 1) + { s_board[blank->x][blank->y] = BLANK; + return FALSE; + } + + s_board[blank->x][blank->y] = BLANK; + return TRUE; +} + +void init_board(int **s_board, int n, tile *blank) +{ int i, j, k; + int *temp_board; + + temp_board = (int *)calloc(n * n, sizeof(int)); + srand(time(NULL)); + for(i = 0;i < n * n; ++i) + { +repeat : + k = rand() % (n * n); + for(j = 0;j <= i - 1; ++j) + if (k == temp_board[j]) + goto repeat; + else + temp_board[i] = k; + } + k = 0; + for (i = 0;i < n;++i) + for(j = 0;j < n; ++j,++k) + { if(temp_board[k] == 0) + { blank->x = i; + blank->y = j; + } + s_board[i][j] = temp_board[k]; + } + free(temp_board); +} + +void board(WINDOW *win, int starty, int startx, int lines, int cols, + int tile_width, int tile_height) +{ int endy, endx, i, j; + + endy = starty + lines * tile_height; + endx = startx + cols * tile_width; + + for(j = starty; j <= endy; j += tile_height) + for(i = startx; i <= endx; ++i) + mvwaddch(win, j, i, ACS_HLINE); + for(i = startx; i <= endx; i += tile_width) + for(j = starty; j <= endy; ++j) + mvwaddch(win, j, i, ACS_VLINE); + mvwaddch(win, starty, startx, ACS_ULCORNER); + mvwaddch(win, endy, startx, ACS_LLCORNER); + mvwaddch(win, starty, endx, ACS_URCORNER); + mvwaddch(win, endy, endx, ACS_LRCORNER); + for(j = starty + tile_height; j <= endy - tile_height; j += tile_height) + { mvwaddch(win, j, startx, ACS_LTEE); + mvwaddch(win, j, endx, ACS_RTEE); + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + mvwaddch(win, j, i, ACS_PLUS); + } + for(i = startx + tile_width; i <= endx - tile_width; i += tile_width) + { mvwaddch(win, starty, i, ACS_TTEE); + mvwaddch(win, endy, i, ACS_BTEE); + } + wrefresh(win); +} + +void shuffle_board(int **s_board, int n) +{ int i,j, deltax, deltay; + int startx, starty; + + starty = (LINES - n * HEIGHT) / 2; + startx = (COLS - n * WIDTH) / 2; + clear(); + mvprintw(24, 0, "Press F1 to Exit"); + board(stdscr, starty, startx, n, n, WIDTH, HEIGHT); + deltay = HEIGHT / 2; + deltax = WIDTH / 2; + for(j = 0; j < n; ++j) + for(i = 0;i < n; ++i) + if(s_board[i][j] != BLANK) + mvprintw(starty + j * HEIGHT + deltay, + startx + i * WIDTH + deltax, + "%-2d", s_board[i][j]); + refresh(); +} + + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/tt.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/tt.c new file mode 100644 index 00000000..4b6ddbeb --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/JustForFun/tt.c @@ -0,0 +1,223 @@ +#include +#include +#include +#include + +#define HSIZE 60 +#define LENGTH 75 +#define WIDTH 10 +#define STARTX 1 +#define STARTY 5 +#define STATUSX 1 +#define STATUSY 25 + +#define KEY_F1 265 + +int print_menu(); +void print_byebye(); +void create_test_string(); +void print_time(time_t startt, time_t endt, int mistakes); +void print_in_middle(int startx, int starty, int width, char *string, WINDOW *win); + +char *groups[] = { "`123456" , + "7890-=" , + "~!@#$%^" , + "&*()_+" , + "<>?" , + ",./\\" , + "asdfg", + "jkl;'", + "qwer", + "uiop", + "tyur", + "zxcv", + "bnm", + }; +int n_groups; + +int main() +{ int choice, i; + char *test_array; + int ch = KEY_F1; + int mistakes; + int x, y; + time_t start_t, end_t; + WINDOW *typing_win; + char string[80]; + + string[0] = '\0'; + + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + intrflush(stdscr, FALSE); + + srandom(time(NULL)); + n_groups = sizeof(groups) / sizeof(char *); + test_array = (char *)calloc(HSIZE + 1, sizeof(char)); + + while(1) + { + if(ch == KEY_F1) + { choice = print_menu(); + choice -= 1; + if(choice == n_groups) + { print_byebye(); + free(test_array); + endwin(); + exit(0); + } + } + clear(); + strcpy(string, "Typing window"); + print_in_middle(STARTX, STARTY - 2, LENGTH, string, NULL); + attron(A_REVERSE); + mvprintw(STATUSY, STATUSX, "Press F1 to Main Menu"); + refresh(); + attroff(A_REVERSE); + + create_test_string(test_array, choice); + typing_win = newwin(WIDTH, LENGTH, STARTY, STARTX); + keypad(typing_win, TRUE); + intrflush(typing_win, FALSE); + box(typing_win, 0, 0); + + x = 1; + y = 1; + mvwprintw(typing_win, y, x, "%s", test_array); + wrefresh(typing_win); + y += 1; + + mistakes = 0; + i = 0; + time(&start_t); + wmove(typing_win, y, x); + wrefresh(typing_win); + ch = 0; + while(ch != KEY_F1 && i != HSIZE + 1) + { ch = wgetch(typing_win); + mvwprintw(typing_win, y, x, "%c", ch); + wrefresh(typing_win); + ++x; + if(ch == test_array[i]) + { ++i; + continue; + } + else + { ++mistakes; + ++i; + } + } + + time(&end_t); + print_time(start_t, end_t, mistakes); + } + free(test_array); + endwin(); + return 0; +} + + +int print_menu() +{ int choice, i; + + choice = 0; + while(1) + { clear(); + printw("\n\n"); + print_in_middle(1, 1, 0, "* * * Welcome to typing practice (Version 1.0) * * * ", NULL); + printw("\n\n\n"); + for(i = 0;i <= n_groups - 1; ++i) + printw("\t%3d: \tPractice %s\n", i + 1, groups[i]); + printw("\t%3d: \tExit\n", i + 1); + + printw("\n\n\tChoice: "); + refresh(); + echo(); + scanw("%d", &choice); + noecho(); + + if(choice >= 1 && choice <= n_groups + 1) + break; + else + { attron(A_REVERSE); + mvprintw(STATUSY, STATUSX, "Wrong choice\tPress any key to continue"); + attroff(A_REVERSE); + getch(); + } + } + return choice; +} + +void create_test_string(char *test_array, int choice) +{ int i, index, length; + + length = strlen(groups[choice]); + for(i = 0;i <= HSIZE - 1; ++i) + { if(i%5 == 0) + test_array[i] = ' '; + else + { index = (int)(random() % length); + test_array[i] = groups[choice][index]; + } + } + test_array[i] = '\0'; +} + +void print_byebye() +{ printw("\n"); + print_in_middle(0,0,0,"Thank you for using my typing tutor\n", NULL); + print_in_middle(0,0,0,"Bye Bye ! ! !\n", NULL); + refresh(); +} + +void print_time(time_t start_t, time_t end_t, int mistakes) +{ long int diff; + int h,m,s; + float wpm; + + diff = end_t - start_t; + wpm = ((HSIZE / 5)/(double)diff)*60; + + h = (int)(diff / 3600); + diff -= h * 3600; + m = (int)(diff / 60); + diff -= m * 60; + s = (int)diff; + + attron(A_REVERSE); + mvprintw(STATUSY, STATUSX, "Mistakes made : %d time taken: %d:%d:%d WPM : %.2f Press any Key to continue", mistakes, h, m, s, wpm); + attroff(A_REVERSE); + + refresh(); + getch(); + +} + +/* ---------------------------------------------------------------- * + * startx = 0 means at present x * + * starty = 0 means at present y * + * win = NULL means take stdscr * + * ---------------------------------------------------------------- */ + +void print_in_middle(int startx, int starty, int width, char *string, WINDOW *win) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + mvwprintw(win, y, x, "%s", string); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/Makefile new file mode 100644 index 00000000..dff988ee --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/Makefile @@ -0,0 +1,21 @@ +# The top level Makefile + +all: + cd JustForFun && $(MAKE) + cd basics && $(MAKE) + cd forms && $(MAKE) + cd menus && $(MAKE) + cd panels && $(MAKE) + @echo + @echo "*********************************************" + @echo "All files Built" + @echo "Please move to demo/exe directory" + @echo "Execute each file to see examples in action" + @echo "*********************************************" + @echo +clean: + cd JustForFun && $(MAKE) clean + cd basics && $(MAKE) clean + cd forms && $(MAKE) clean + cd menus && $(MAKE) clean + cd panels && $(MAKE) clean diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/README new file mode 100644 index 00000000..8eb580b5 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/README @@ -0,0 +1,82 @@ +This is the top level README file. +This directory is structured as follows: + +ncurses + | + |----> JustForFun -- just for fun programs + |----> basics -- basic programs + |----> demo -- output files go into this directory after make + | | + | |----> exe -- exe files of all example programs + |----> forms -- programs related to form library + |----> menus -- programs related to menus library + |----> panels -- programs related to panels library + |----> Makefile -- the top level Makefile + |----> README -- the top level README file. contains instructions + | -- to create executables for example programs + +To compile and install all example programs, just run make in this directory. + + make + +It installs all the exe files in demo/exe directory. You can go to that direcory +and see the examples in action. + +Have Fun !!! + -- Pradeep Padala + +Description of files in each directory +-------------------------------------- +JustForFun + | + |----> hanoi.c -- The Towers of Hanoi Solver + |----> life.c -- The Game of Life demo + |----> magic.c -- An Odd Order Magic Square builder + |----> queens.c -- The famous N-Queens Solver + |----> shuffle.c -- A fun game, if you have time to kill + |----> tt.c -- A very trivial typing tutor + + basics + | + |----> acs_vars.c -- ACS_ variables example + |----> hello_world.c -- Simple "Hello World" Program + |----> init_func_example.c -- Initialization functions example + |----> key_code.c -- Shows the scan code of the key pressed + |----> mouse_menu.c -- A menu accessible by mouse + |----> other_border.c -- Shows usage of other border functions apart + | -- box() + |----> printw_example.c -- A very simple printw() example + |----> scanw_example.c -- A very simple getstr() example + |----> simple_attr.c -- A program that can print a c file with comments + | -- in attribute + |----> simple_color.c -- A simple example demonstrating colors + |----> simple_key.c -- A menu accessible with keyboard UP, DOWN arrows + |----> temp_leave.c -- Demonstrates temporarily leaving curses mode + |----> win_border.c -- Shows Creation of windows and borders + |----> with_chgat.c -- chgat() usage example + + forms + | + |----> form_attrib.c -- Usage of field attributes + |----> form_options.c -- Usage of field options + |----> form_simple.c -- A simple form example + |----> form_win.c -- Demo of windows associated with forms + + menus + | + |----> menu_attrib.c -- Usage of menu attributes + |----> menu_item_data.c -- Usage of item_name() etc.. functions + |----> menu_multi_column.c -- Creates multi columnar menus + |----> menu_scroll.c -- Demonstrates scrolling capability of menus + |----> menu_simple.c -- A simple menu accessed by arrow keys + |----> menu_toggle.c -- Creates multi valued menus and explains + | -- REQ_TOGGLE_ITEM + |----> menu_userptr.c -- Usage of user pointer + |----> menu_win.c -- Demo of windows associated with menus + + panels + | + |----> panel_browse.c -- Panel browsing through tab. Usage of user pointer + |----> panel_hide.c -- Hiding and Un hiding of panels + |----> panel_resize.c -- Moving and resizing of panels + |----> panel_simple.c -- A simple panel example diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/Makefile new file mode 100644 index 00000000..90ec1fb3 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/Makefile @@ -0,0 +1,35 @@ +# Makefile for JustForFun Files + +# A few variables + +CC=gcc +LIBS=-lncurses + +SRC_DIR=. +EXE_DIR=../demo/exe + +EXES = \ + ${EXE_DIR}/hello_world \ + ${EXE_DIR}/init_func_example \ + ${EXE_DIR}/key_code \ + ${EXE_DIR}/mouse_menu \ + ${EXE_DIR}/other_border \ + ${EXE_DIR}/printw_example \ + ${EXE_DIR}/scanw_example \ + ${EXE_DIR}/simple_attr \ + ${EXE_DIR}/simple_color \ + ${EXE_DIR}/simple_key \ + ${EXE_DIR}/temp_leave \ + ${EXE_DIR}/win_border \ + ${EXE_DIR}/with_chgat + +${EXE_DIR}/%: %.o + ${CC} -o $@ $< ${LIBS} + +%.o: ${SRC_DIR}/%.c + ${CC} -o $@ -c $< + +all: ${EXES} + +clean: + @rm -f ${EXES} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/README new file mode 100644 index 00000000..0760867d --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/README @@ -0,0 +1,20 @@ +Description of files +-------------------- + basics + | + |----> acs_vars.c -- ACS_ variables example + |----> hello_world.c -- Simple "Hello World" Program + |----> init_func_example.c -- Initialization functions example + |----> key_code.c -- Shows the scan code of the key pressed + |----> mouse_menu.c -- A menu accessible by mouse + |----> other_border.c -- Shows usage of other border functions apart + | -- box() + |----> printw_example.c -- A very simple printw() example + |----> scanw_example.c -- A very simple getstr() example + |----> simple_attr.c -- A program that can print a c file with comments + | -- in attribute + |----> simple_color.c -- A simple example demonstrating colors + |----> simple_key.c -- A menu accessible with keyboard UP, DOWN arrows + |----> temp_leave.c -- Demonstrates temporarily leaving curses mode + |----> win_border.c -- Shows Creation of windows and borders + |----> with_chgat.c -- chgat() usage example diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/acs_vars.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/acs_vars.c new file mode 100644 index 00000000..23ff693e --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/acs_vars.c @@ -0,0 +1,44 @@ +#include + +int main() +{ + initscr(); + + printw("Upper left corner "); addch(ACS_ULCORNER); printw("\n"); + printw("Lower left corner "); addch(ACS_LLCORNER); printw("\n"); + printw("Lower right corner "); addch(ACS_LRCORNER); printw("\n"); + printw("Tee pointing right "); addch(ACS_LTEE); printw("\n"); + printw("Tee pointing left "); addch(ACS_RTEE); printw("\n"); + printw("Tee pointing up "); addch(ACS_BTEE); printw("\n"); + printw("Tee pointing down "); addch(ACS_TTEE); printw("\n"); + printw("Horizontal line "); addch(ACS_HLINE); printw("\n"); + printw("Vertical line "); addch(ACS_VLINE); printw("\n"); + printw("Large Plus or cross over "); addch(ACS_PLUS); printw("\n"); + printw("Scan Line 1 "); addch(ACS_S1); printw("\n"); + printw("Scan Line 3 "); addch(ACS_S3); printw("\n"); + printw("Scan Line 7 "); addch(ACS_S7); printw("\n"); + printw("Scan Line 9 "); addch(ACS_S9); printw("\n"); + printw("Diamond "); addch(ACS_DIAMOND); printw("\n"); + printw("Checker board (stipple) "); addch(ACS_CKBOARD); printw("\n"); + printw("Degree Symbol "); addch(ACS_DEGREE); printw("\n"); + printw("Plus/Minus Symbol "); addch(ACS_PLMINUS); printw("\n"); + printw("Bullet "); addch(ACS_BULLET); printw("\n"); + printw("Arrow Pointing Left "); addch(ACS_LARROW); printw("\n"); + printw("Arrow Pointing Right "); addch(ACS_RARROW); printw("\n"); + printw("Arrow Pointing Down "); addch(ACS_DARROW); printw("\n"); + printw("Arrow Pointing Up "); addch(ACS_UARROW); printw("\n"); + printw("Board of squares "); addch(ACS_BOARD); printw("\n"); + printw("Lantern Symbol "); addch(ACS_LANTERN); printw("\n"); + printw("Solid Square Block "); addch(ACS_BLOCK); printw("\n"); + printw("Less/Equal sign "); addch(ACS_LEQUAL); printw("\n"); + printw("Greater/Equal sign "); addch(ACS_GEQUAL); printw("\n"); + printw("Pi "); addch(ACS_PI); printw("\n"); + printw("Not equal "); addch(ACS_NEQUAL); printw("\n"); + printw("UK pound sign "); addch(ACS_STERLING); printw("\n"); + + refresh(); + getch(); + endwin(); + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/hello_world.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/hello_world.c new file mode 100644 index 00000000..c58efccf --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/hello_world.c @@ -0,0 +1,12 @@ +#include + +int main() +{ + initscr(); /* Start curses mode */ + printw("Hello World !!!"); /* Print Hello World */ + refresh(); /* Print it on to the real screen */ + getch(); /* Wait for user input */ + endwin(); /* End curses mode */ + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/init_func_example.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/init_func_example.c new file mode 100644 index 00000000..1b2d025c --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/init_func_example.c @@ -0,0 +1,31 @@ +#include + +int main() +{ int ch; + + initscr(); /* Start curses mode */ + raw(); /* Line buffering disabled */ + keypad(stdscr, TRUE); /* We get F1, F2 etc.. */ + noecho(); /* Don't echo() while we do getch */ + + printw("Type any character to see it in bold\n"); + ch = getch(); /* If raw() hadn't been called + * we have to press enter before it + * gets to the program */ + if(ch == KEY_F(1)) /* Without keypad enabled this will */ + printw("F1 Key pressed");/* not get to us either */ + /* Without noecho() some ugly escape + * charachters might have been printed + * on screen */ + else + { printw("The pressed key is "); + attron(A_BOLD); + printw("%c", ch); + attroff(A_BOLD); + } + refresh(); /* Print it on to the real screen */ + getch(); /* Wait for user input */ + endwin(); /* End curses mode */ + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/key_code.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/key_code.c new file mode 100644 index 00000000..43ca7295 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/key_code.c @@ -0,0 +1,14 @@ +#include + +int main() +{ int ch; + + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + ch = getch(); + endwin(); + printf("The key pressed is %d\n", ch); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/mouse_menu.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/mouse_menu.c new file mode 100644 index 00000000..19d4379e --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/mouse_menu.c @@ -0,0 +1,106 @@ +#include + +#define WIDTH 30 +#define HEIGHT 10 + +int startx = 0; +int starty = 0; + +char *choices[] = { "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Exit", + }; + +int n_choices = sizeof(choices) / sizeof(char *); + +void print_menu(WINDOW *menu_win, int highlight); +void report_choice(int mouse_x, int mouse_y, int *p_choice); + +int main() +{ int c, choice = 0; + WINDOW *menu_win; + MEVENT event; + + /* Initialize curses */ + initscr(); + clear(); + noecho(); + cbreak(); //Line buffering disabled. pass on everything + + /* Try to put the window in the middle of screen */ + startx = (80 - WIDTH) / 2; + starty = (24 - HEIGHT) / 2; + + attron(A_REVERSE); + mvprintw(23, 1, "Click on Exit to quit (Works best in a virtual console)"); + refresh(); + attroff(A_REVERSE); + + /* Print the menu for the first time */ + menu_win = newwin(HEIGHT, WIDTH, starty, startx); + print_menu(menu_win, 1); + /* Get all the mouse events */ + mousemask(ALL_MOUSE_EVENTS, NULL); + + while(1) + { c = wgetch(menu_win); + switch(c) + { case KEY_MOUSE: + if(getmouse(&event) == OK) + { /* When the user clicks left mouse button */ + if(event.bstate & BUTTON1_PRESSED) + { report_choice(event.x + 1, event.y + 1, &choice); + if(choice == -1) //Exit chosen + goto end; + mvprintw(22, 1, "Choice made is : %d String Chosen is \"%10s\"", choice, choices[choice - 1]); + refresh(); + } + } + print_menu(menu_win, choice); + break; + } + } +end: + endwin(); + return 0; +} + + +void print_menu(WINDOW *menu_win, int highlight) +{ + int x, y, i; + + x = 2; + y = 2; + box(menu_win, 0, 0); + for(i = 0; i < n_choices; ++i) + { if(highlight == i + 1) + { wattron(menu_win, A_REVERSE); + mvwprintw(menu_win, y, x, "%s", choices[i]); + wattroff(menu_win, A_REVERSE); + } + else + mvwprintw(menu_win, y, x, "%s", choices[i]); + ++y; + } + wrefresh(menu_win); +} + +/* Report the choice according to mouse position */ +void report_choice(int mouse_x, int mouse_y, int *p_choice) +{ int i,j, choice; + + i = startx + 2; + j = starty + 3; + + for(choice = 0; choice < n_choices; ++choice) + if(mouse_y == j + choice && mouse_x >= i && mouse_x <= i + strlen(choices[choice])) + { if(choice == n_choices - 1) + *p_choice = -1; + else + *p_choice = choice + 1; + break; + } +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/other_border.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/other_border.c new file mode 100644 index 00000000..057ccb6a --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/other_border.c @@ -0,0 +1,121 @@ +#include + +typedef struct _win_border_struct { + chtype ls, rs, ts, bs, + tl, tr, bl, br; +}WIN_BORDER; + +typedef struct _WIN_struct { + + int startx, starty; + int height, width; + WIN_BORDER border; +}WIN; + +void init_win_params(WIN *p_win); +void print_win_params(WIN *p_win); +void create_box(WIN *win, int bool); + +int main(int argc, char *argv[]) +{ WIN win; + int ch; + + initscr(); /* Start curses mode */ + start_color(); /* Start the color functionality */ + cbreak(); /* Line buffering disabled, Pass on + * everty thing to me */ + keypad(stdscr, TRUE); /* I need that nifty F1 */ + noecho(); + init_pair(1, COLOR_CYAN, COLOR_BLACK); + + /* Initialize the window parameters */ + init_win_params(&win); + print_win_params(&win); + + attron(COLOR_PAIR(1)); + printw("Press F1 to exit"); + refresh(); + attroff(COLOR_PAIR(1)); + + create_box(&win, TRUE); + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_LEFT: + create_box(&win, FALSE); + --win.startx; + create_box(&win, TRUE); + break; + case KEY_RIGHT: + create_box(&win, FALSE); + ++win.startx; + create_box(&win, TRUE); + break; + case KEY_UP: + create_box(&win, FALSE); + --win.starty; + create_box(&win, TRUE); + break; + case KEY_DOWN: + create_box(&win, FALSE); + ++win.starty; + create_box(&win, TRUE); + break; + } + } + endwin(); /* End curses mode */ + return 0; +} +void init_win_params(WIN *p_win) +{ + p_win->height = 3; + p_win->width = 10; + p_win->starty = (LINES - p_win->height)/2; + p_win->startx = (COLS - p_win->width)/2; + + p_win->border.ls = '|'; + p_win->border.rs = '|'; + p_win->border.ts = '-'; + p_win->border.bs = '-'; + p_win->border.tl = '+'; + p_win->border.tr = '+'; + p_win->border.bl = '+'; + p_win->border.br = '+'; + +} +void print_win_params(WIN *p_win) +{ +#ifdef _DEBUG + mvprintw(25, 0, "%d %d %d %d", p_win->startx, p_win->starty, + p_win->width, p_win->height); + refresh(); +#endif +} +void create_box(WIN *p_win, int bool) +{ int i, j; + int x, y, w, h; + + x = p_win->startx; + y = p_win->starty; + w = p_win->width; + h = p_win->height; + + if(bool == TRUE) + { mvaddch(y, x, p_win->border.tl); + mvaddch(y, x + w, p_win->border.tr); + mvaddch(y + h, x, p_win->border.bl); + mvaddch(y + h, x + w, p_win->border.br); + mvhline(y, x + 1, p_win->border.ts, w - 1); + mvhline(y + h, x + 1, p_win->border.bs, w - 1); + mvvline(y + 1, x, p_win->border.ls, h - 1); + mvvline(y + 1, x + w, p_win->border.rs, h - 1); + + } + else + for(j = y; j <= y + h; ++j) + for(i = x; i <= x + w; ++i) + mvaddch(j, i, ' '); + + refresh(); + +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/printw_example.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/printw_example.c new file mode 100644 index 00000000..797a63ca --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/printw_example.c @@ -0,0 +1,20 @@ +#include /* ncurses.h includes stdio.h */ +#include + +int main() +{ + char mesg[]="Just a string"; /* message to be appeared on the screen */ + int row,col; /* to store the number of rows and * + * the number of colums of the screen */ + initscr(); /* start the curses mode */ + getmaxyx(stdscr,row,col); /* get the number of rows and columns */ + mvprintw(row/2,(col-strlen(mesg))/2,"%s",mesg); + /* print the message at the center of the screen */ + mvprintw(row-2,0,"This screen has %d rows and %d columns\n",row,col); + printw("Try resizing your window(if possible) and then run this program again"); + refresh(); + getch(); + endwin(); + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/scanw_example.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/scanw_example.c new file mode 100644 index 00000000..eec0dfbc --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/scanw_example.c @@ -0,0 +1,20 @@ +#include /* ncurses.h includes stdio.h */ +#include + +int main() +{ + char mesg[]="Enter a string: "; /* message to be appeared on the screen */ + char str[80]; + int row,col; /* to store the number of rows and * + * the number of colums of the screen */ + initscr(); /* start the curses mode */ + getmaxyx(stdscr,row,col); /* get the number of rows and columns */ + mvprintw(row/2,(col-strlen(mesg))/2,"%s",mesg); + /* print the message at the center of the screen */ + getstr(str); + mvprintw(LINES - 2, 0, "You Entered: %s", str); + getch(); + endwin(); + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_attr.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_attr.c new file mode 100644 index 00000000..9288487e --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_attr.c @@ -0,0 +1,50 @@ +#include + +int main(int argc, char *argv[]) +{ + int ch, prev; + FILE *fp; + int goto_prev = FALSE, y, x; + + if(argc != 2) + { printf("Usage: %s \n", argv[0]); + exit(1); + } + fp = fopen(argv[1], "r"); + if(fp == NULL) + { perror("Cannot open input file"); + exit(1); + } + + initscr(); /* Start curses mode */ + + prev = EOF; + while((ch = fgetc(fp)) != EOF) + { if(prev == '/' && ch == '*') /* If it is / and * then olny + * switch bold on */ + { attron(A_BOLD); + goto_prev = TRUE; /* Go to previous char / and + * print it in BOLD */ + } + if(goto_prev == TRUE) + { getyx(stdscr, y, x); + move(y, x - 1); + printw("%c%c", '/', ch); /* The actual printing is done + * here */ + ch = 'a'; /* 'a' is just a dummy + * character to prevent */ + // "/*/" comments. + goto_prev = FALSE; /* Set it to FALSE or every + * thing from here will be / */ + } else + printw("%c", ch); + refresh(); + if(prev == '*' && ch == '/') + attroff(A_BOLD); /* Switch it off once we got * + and then / */ + prev = ch; + } + getch(); + endwin(); /* End curses mode */ + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_color.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_color.c new file mode 100644 index 00000000..c7da6b73 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_color.c @@ -0,0 +1,40 @@ +#include + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string); +int main(int argc, char *argv[]) +{ initscr(); /* Start curses mode */ + if(has_colors() == FALSE) + { endwin(); + printf("You terminal does not support color\n"); + exit(1); + } + start_color(); /* Start color */ + init_pair(1, COLOR_RED, COLOR_BLACK); + + attron(COLOR_PAIR(1)); + print_in_middle(stdscr, LINES / 2, 0, 0, "Viola !!! In color ..."); + attroff(COLOR_PAIR(1)); + getch(); + endwin(); +} +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + mvwprintw(win, y, x, "%s", string); + refresh(); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_key.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_key.c new file mode 100644 index 00000000..48db7758 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/simple_key.c @@ -0,0 +1,92 @@ +#include +#include + +#define WIDTH 30 +#define HEIGHT 10 + +int startx = 0; +int starty = 0; + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Exit", + }; +int n_choices = sizeof(choices) / sizeof(char *); +void print_menu(WINDOW *menu_win, int highlight); + +int main() +{ WINDOW *menu_win; + int highlight = 1; + int choice = 0; + int c; + + initscr(); + clear(); + noecho(); + cbreak(); /* Line buffering disabled. pass on everything */ + startx = (80 - WIDTH) / 2; + starty = (24 - HEIGHT) / 2; + + menu_win = newwin(HEIGHT, WIDTH, starty, startx); + keypad(menu_win, TRUE); + mvprintw(0, 0, "Use arrow keys to go up and down, Press enter to select a choice"); + refresh(); + print_menu(menu_win, highlight); + while(1) + { c = wgetch(menu_win); + switch(c) + { case KEY_UP: + if(highlight == 1) + highlight = n_choices; + else + --highlight; + break; + case KEY_DOWN: + if(highlight == n_choices) + highlight = 1; + else + ++highlight; + break; + case 10: + choice = highlight; + break; + default: + mvprintw(24, 0, "Charcter pressed is = %3d Hopefully it can be printed as '%c'", c, c); + refresh(); + break; + } + print_menu(menu_win, highlight); + if(choice != 0) /* User did a choice come out of the infinite loop */ + break; + } + mvprintw(23, 0, "You chose choice %d with choice string %s\n", choice, choices[choice - 1]); + clrtoeol(); + refresh(); + endwin(); + return 0; +} + + +void print_menu(WINDOW *menu_win, int highlight) +{ + int x, y, i; + + x = 2; + y = 2; + box(menu_win, 0, 0); + for(i = 0; i < n_choices; ++i) + { if(highlight == i + 1) /* High light the present choice */ + { wattron(menu_win, A_REVERSE); + mvwprintw(menu_win, y, x, "%s", choices[i]); + wattroff(menu_win, A_REVERSE); + } + else + mvwprintw(menu_win, y, x, "%s", choices[i]); + ++y; + } + wrefresh(menu_win); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/temp_leave.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/temp_leave.c new file mode 100644 index 00000000..93504648 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/temp_leave.c @@ -0,0 +1,20 @@ +#include + +int main() +{ + initscr(); /* Start curses mode */ + printw("Hello World !!!\n"); /* Print Hello World */ + refresh(); /* Print it on to the real screen */ + def_prog_mode(); /* Save the tty modes */ + endwin(); /* End curses mode temporarily */ + system("/bin/sh"); /* Do whatever you like in cooked mode */ + reset_prog_mode(); /* Return to the previous tty mode*/ + /* stored by def_prog_mode() */ + refresh(); /* Do refresh() to restore the */ + /* Screen contents */ + printw("Another String\n"); /* Back to curses use the full */ + refresh(); /* capabilities of curses */ + endwin(); /* End curses mode */ + + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/win_border.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/win_border.c new file mode 100644 index 00000000..7f3fe32c --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/win_border.c @@ -0,0 +1,82 @@ +#include + + +WINDOW *create_newwin(int height, int width, int starty, int startx); +void destroy_win(WINDOW *local_win); + +int main(int argc, char *argv[]) +{ WINDOW *my_win; + int startx, starty, width, height; + int ch; + + initscr(); /* Start curses mode */ + cbreak(); /* Line buffering disabled, Pass on + * everty thing to me */ + keypad(stdscr, TRUE); /* I need that nifty F1 */ + + height = 3; + width = 10; + starty = (LINES - height) / 2; /* Calculating for a center placement */ + startx = (COLS - width) / 2; /* of the window */ + printw("Press F1 to exit"); + refresh(); + my_win = create_newwin(height, width, starty, startx); + + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_LEFT: + destroy_win(my_win); + my_win = create_newwin(height, width, starty,--startx); + break; + case KEY_RIGHT: + destroy_win(my_win); + my_win = create_newwin(height, width, starty,++startx); + break; + case KEY_UP: + destroy_win(my_win); + my_win = create_newwin(height, width, --starty,startx); + break; + case KEY_DOWN: + destroy_win(my_win); + my_win = create_newwin(height, width, ++starty,startx); + break; + } + } + + endwin(); /* End curses mode */ + return 0; +} + +WINDOW *create_newwin(int height, int width, int starty, int startx) +{ WINDOW *local_win; + + local_win = newwin(height, width, starty, startx); + box(local_win, 0 , 0); /* 0, 0 gives default characters + * for the vertical and horizontal + * lines */ + wrefresh(local_win); /* Show that box */ + + return local_win; +} + +void destroy_win(WINDOW *local_win) +{ + /* box(local_win, ' ', ' '); : This won't produce the desired + * result of erasing the window. It will leave it's four corners + * and so an ugly remnant of window. + */ + wborder(local_win, ' ', ' ', ' ',' ',' ',' ',' ',' '); + /* The parameters taken are + * 1. win: the window on which to operate + * 2. ls: character to be used for the left side of the window + * 3. rs: character to be used for the right side of the window + * 4. ts: character to be used for the top side of the window + * 5. bs: character to be used for the bottom side of the window + * 6. tl: character to be used for the top left corner of the window + * 7. tr: character to be used for the top right corner of the window + * 8. bl: character to be used for the bottom left corner of the window + * 9. br: character to be used for the bottom right corner of the window + */ + wrefresh(local_win); + delwin(local_win); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/with_chgat.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/with_chgat.c new file mode 100644 index 00000000..aa88967d --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/basics/with_chgat.c @@ -0,0 +1,24 @@ +#include + +int main(int argc, char *argv[]) +{ initscr(); /* Start curses mode */ + start_color(); /* Start color functionality */ + + init_pair(1, COLOR_CYAN, COLOR_BLACK); + printw("A Big string which i didn't care to type fully "); + mvchgat(0, 0, -1, A_BLINK, 1, NULL); + /* + * First two parameters specify the position at which to start + * Third parameter number of characters to update. -1 means till + * end of line + * Forth parameter is the normal attribute you wanted to give + * to the charcter + * Fifth is the color index. It is the index given during init_pair() + * use 0 if you didn't want color + * Sixth one is always NULL + */ + refresh(); + getch(); + endwin(); /* End curses mode */ + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/Makefile new file mode 100644 index 00000000..4ed1b985 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/Makefile @@ -0,0 +1,27 @@ +# Makefile for JustForFun Files + +# A few variables + +CC=gcc +LIBS=-lform -lncurses + +SRC_DIR=. +EXE_DIR=../demo/exe + +EXES = \ + ${EXE_DIR}/form_attrib\ + ${EXE_DIR}/form_options\ + ${EXE_DIR}/form_simple\ + ${EXE_DIR}/form_win \ + +${EXE_DIR}/%: %.o + ${CC} -o $@ $< ${LIBS} + +%.o: ${SRC_DIR}/%.c + ${CC} -o $@ -c $< + +all: ${EXES} + + +clean: + @rm -f ${EXES} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/README new file mode 100644 index 00000000..6e9a218d --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/README @@ -0,0 +1,9 @@ +Description of files +-------------------- + forms + | + |----> form_attrib.c -- Usage of field attributes + |----> form_options.c -- Usage of field options + |----> form_simple.c -- A simple form example + |----> form_win.c -- Demo of windows associated with forms + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_attrib.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_attrib.c new file mode 100644 index 00000000..90695e6a --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_attrib.c @@ -0,0 +1,75 @@ +#include + +int main() +{ FIELD *field[3]; + FORM *my_form; + int ch; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize few color pairs */ + init_pair(1, COLOR_WHITE, COLOR_BLUE); + init_pair(2, COLOR_WHITE, COLOR_BLUE); + + /* Initialize the fields */ + field[0] = new_field(1, 10, 4, 18, 0, 0); + field[1] = new_field(1, 10, 6, 18, 0, 0); + field[2] = NULL; + + /* Set field options */ + set_field_fore(field[0], COLOR_PAIR(1));/* Put the field with blue background */ + set_field_back(field[0], COLOR_PAIR(2));/* and white foreground (characters */ + /* are printed in white */ + field_opts_off(field[0], O_AUTOSKIP); /* Don't go to next field when this */ + /* Field is filled up */ + set_field_back(field[1], A_UNDERLINE); + field_opts_off(field[1], O_AUTOSKIP); + + /* Create the form and post it */ + my_form = new_form(field); + post_form(my_form); + refresh(); + + set_current_field(my_form, field[0]); /* Set focus to the colored field */ + mvprintw(4, 10, "Value 1:"); + mvprintw(6, 10, "Value 2:"); + mvprintw(LINES - 2, 0, "Use UP, DOWN arrow keys to switch between fields"); + refresh(); + + /* Loop through to get user requests */ + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_DOWN: + /* Go to next field */ + form_driver(my_form, REQ_NEXT_FIELD); + /* Go to the end of the present buffer */ + /* Leaves nicely at the last character */ + form_driver(my_form, REQ_END_LINE); + break; + case KEY_UP: + /* Go to previous field */ + form_driver(my_form, REQ_PREV_FIELD); + form_driver(my_form, REQ_END_LINE); + break; + default: + /* If this is a normal character, it gets */ + /* Printed */ + form_driver(my_form, ch); + break; + } + } + + /* Un post form and free the memory */ + unpost_form(my_form); + free_form(my_form); + free_field(field[0]); + free_field(field[1]); + + endwin(); + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_options.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_options.c new file mode 100644 index 00000000..b59c8a33 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_options.c @@ -0,0 +1,76 @@ +#include + +#define STARTX 15 +#define STARTY 4 +#define WIDTH 25 + +#define N_FIELDS 3 + +int main() +{ FIELD *field[N_FIELDS]; + FORM *my_form; + int ch, i; + + /* Initialize curses */ + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize the fields */ + for(i = 0; i < N_FIELDS - 1; ++i) + field[i] = new_field(1, WIDTH, STARTY + i * 2, STARTX, 0, 0); + field[N_FIELDS - 1] = NULL; + + /* Set field options */ + set_field_back(field[1], A_UNDERLINE); /* Print a line for the option */ + + field_opts_off(field[0], O_ACTIVE); /* This field is a static label */ + field_opts_off(field[1], O_PUBLIC); /* This filed is like a password field*/ + field_opts_off(field[1], O_AUTOSKIP); /* To avoid entering the same field */ + /* after last character is entered */ + + /* Create the form and post it */ + my_form = new_form(field); + post_form(my_form); + refresh(); + + set_field_just(field[0], JUSTIFY_CENTER); /* Center Justification */ + set_field_buffer(field[0], 0, "This is a static Field"); + /* Initialize the field */ + mvprintw(STARTY, STARTX - 10, "Field 1:"); + mvprintw(STARTY + 2, STARTX - 10, "Field 2:"); + refresh(); + + /* Loop through to get user requests */ + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_DOWN: + /* Go to next field */ + form_driver(my_form, REQ_NEXT_FIELD); + /* Go to the end of the present buffer */ + /* Leaves nicely at the last character */ + form_driver(my_form, REQ_END_LINE); + break; + case KEY_UP: + /* Go to previous field */ + form_driver(my_form, REQ_PREV_FIELD); + form_driver(my_form, REQ_END_LINE); + break; + default: + /* If this is a normal character, it gets */ + /* Printed */ + form_driver(my_form, ch); + break; + } + } + + /* Un post form and free the memory */ + unpost_form(my_form); + free_form(my_form); + free_field(field[0]); + free_field(field[1]); + + endwin(); + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_simple.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_simple.c new file mode 100644 index 00000000..c4ae5ac4 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_simple.c @@ -0,0 +1,66 @@ +#include + +int main() +{ FIELD *field[3]; + FORM *my_form; + int ch; + + /* Initialize curses */ + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize the fields */ + field[0] = new_field(1, 10, 4, 18, 0, 0); + field[1] = new_field(1, 10, 6, 18, 0, 0); + field[2] = NULL; + + /* Set field options */ + set_field_back(field[0], A_UNDERLINE); /* Print a line for the option */ + field_opts_off(field[0], O_AUTOSKIP); /* Don't go to next field when this */ + /* Field is filled up */ + set_field_back(field[1], A_UNDERLINE); + field_opts_off(field[1], O_AUTOSKIP); + + /* Create the form and post it */ + my_form = new_form(field); + post_form(my_form); + refresh(); + + mvprintw(4, 10, "Value 1:"); + mvprintw(6, 10, "Value 2:"); + refresh(); + + /* Loop through to get user requests */ + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case KEY_DOWN: + /* Go to next field */ + form_driver(my_form, REQ_NEXT_FIELD); + /* Go to the end of the present buffer */ + /* Leaves nicely at the last character */ + form_driver(my_form, REQ_END_LINE); + break; + case KEY_UP: + /* Go to previous field */ + form_driver(my_form, REQ_PREV_FIELD); + form_driver(my_form, REQ_END_LINE); + break; + default: + /* If this is a normal character, it gets */ + /* Printed */ + form_driver(my_form, ch); + break; + } + } + + /* Un post form and free the memory */ + unpost_form(my_form); + free_form(my_form); + free_field(field[0]); + free_field(field[1]); + + endwin(); + return 0; +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_win.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_win.c new file mode 100644 index 00000000..6b01ceaf --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/forms/form_win.c @@ -0,0 +1,112 @@ +#include + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); + +int main() +{ + FIELD *field[3]; + FORM *my_form; + WINDOW *my_form_win; + int ch, rows, cols; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize few color pairs */ + init_pair(1, COLOR_RED, COLOR_BLACK); + + /* Initialize the fields */ + field[0] = new_field(1, 10, 6, 1, 0, 0); + field[1] = new_field(1, 10, 8, 1, 0, 0); + field[2] = NULL; + + /* Set field options */ + set_field_back(field[0], A_UNDERLINE); + field_opts_off(field[0], O_AUTOSKIP); /* Don't go to next field when this */ + /* Field is filled up */ + set_field_back(field[1], A_UNDERLINE); + field_opts_off(field[1], O_AUTOSKIP); + + /* Create the form and post it */ + my_form = new_form(field); + + /* Calculate the area required for the form */ + scale_form(my_form, &rows, &cols); + + /* Create the window to be associated with the form */ + my_form_win = newwin(rows + 4, cols + 4, 4, 4); + keypad(my_form_win, TRUE); + + /* Set main window and sub window */ + set_form_win(my_form, my_form_win); + set_form_sub(my_form, derwin(my_form_win, rows, cols, 2, 2)); + + /* Print a border around the main window and print a title */ + box(my_form_win, 0, 0); + print_in_middle(my_form_win, 1, 0, cols + 4, "My Form", COLOR_PAIR(1)); + + post_form(my_form); + wrefresh(my_form_win); + + mvprintw(LINES - 2, 0, "Use UP, DOWN arrow keys to switch between fields"); + refresh(); + + /* Loop through to get user requests */ + while((ch = wgetch(my_form_win)) != KEY_F(1)) + { switch(ch) + { case KEY_DOWN: + /* Go to next field */ + form_driver(my_form, REQ_NEXT_FIELD); + /* Go to the end of the present buffer */ + /* Leaves nicely at the last character */ + form_driver(my_form, REQ_END_LINE); + break; + case KEY_UP: + /* Go to previous field */ + form_driver(my_form, REQ_PREV_FIELD); + form_driver(my_form, REQ_END_LINE); + break; + default: + /* If this is a normal character, it gets */ + /* Printed */ + form_driver(my_form, ch); + break; + } + } + + /* Un post form and free the memory */ + unpost_form(my_form); + free_form(my_form); + free_field(field[0]); + free_field(field[1]); + + endwin(); + return 0; +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gpl.txt b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gpl.txt new file mode 100644 index 00000000..5b6e7c66 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gpl.txt @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gui.sh b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gui.sh new file mode 100755 index 00000000..19f65b73 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/gui.sh @@ -0,0 +1,902 @@ +#!/bin/bash + + +# Front end to the ncurses programs compilation and run +# Implemented using 'dialog' which inturn uses ncurses + + +# Author: N N Ashok (nnashok@yahoo.com) +# Date: 07/15/2002 +# +# Modified by: Pradeep Padala (ppadala@cise.ufl.edu) + +# Notes: +# Basics: +# Makefile does not build acs_vars +# Done: hello_world: Nothing displayed to user?? +# Done: init_func_example: Nothing displayed to user?? +# Done: key_code: Does not exit with status 0 +# mouse_menu: Didnot work for me. Had to hit ^C +# Done: simple_attr: The output does not stay, is scrolled fast +# Done: simple_color: Nothing displayed to user?? +# temp_leave: When executed using the gui, the tty is not reset. Nothing +# echos to the screen +# Done: with_chgat: Nothing displayed to user?? +# with_chgat: Does not indicate how to exit +# +# Forms: +# None of the programs indicate how to exit. F1 exits the program. +# Menus: +# menu_simple does not indicate how to exit. F1 exits the program. +# menu_win does not indicate how to exit. F1 exits the program. +# Panels: +# panel_resize: It seg faulted when I was resizing. Probably +# the size had gone to negative value (I cant see the size being reduced, +# only after I press the Enter do I see the new size). +# panel_simple: Exists as soon as I press any key. + +# Modified source files: +# basics/hello_world.c +# basics/init_func_example.c +# basics/key_code.c +# basics/simple_attr.c +# basics/simple_color.c +# basics/with_chgat.c + + + +# Constants used +TRUE=0; +FALSE=-1; +EXEC_DIR="../demo/exe"; +TEMP_FILE="/tmp/make.out"; +tmp="tmp.out" + + +# Function declarations + +# execMake: Function to execute 'make' +# Arguments: +# clean: Spcifies to do a 'make clean' +execMake() +{ + local clean; + local result; + + # Check for arguments + if [ "$1" == "clean" ] + then + clean="clean"; + else + clean=""; + fi + + make $clean > $TEMP_FILE 2>&1 + result=$?; + + return $result; +} + + +# source_menu: Function to display the source code menu +# Arguments: None +source_menu() +{ + + local menu_items; + + files_c=`ls *.c`; + files=`echo $files_c | sed -e 's/\.c//g'`; + + title="Source code"; + + command_options=""; + # Set to 1 to include the "Previous" entry and an extra space at the end + menu_items=2; + for i in $files + do + command_options="$command_options $i $i.c"; + menu_items=`expr $menu_items + 1`; + done; + + if [ $menu_items -gt 13 ] + then + menu_items=13; + fi + + # While the user selects some menu option, repeat + statusSource=0; + while (test "$statusSource" = "0") + do + dialog --clear --menu "$title" 20 60 $menu_items $command_options Previous "Return to previous screen" 2>$tmp + resultSource=`cat $tmp`; + statusSource=`echo $?`; + + # None of the programs need additional arguments and all exit + # normally (^C not required to exit) + if [ $statusSource -eq 0 ] + then + if [ "$resultSource" == "Previous" ] + then + statusSource=1; + else + if [ -n "$EDITOR" ] + then + $EDITOR $resultSource.c; + else + dialog --clear --msgbox "EDITOR environment variable is not set. Please set it to your favorite editor and rerun the program." 10 40; + return $FALSE; + fi + fi + fi + done + + return $TRUE; +} + + + +# runBasics: Function to run the programs in the Basics category +# Arguments: None +runBasics() +{ + local cwd; + local progs_array; + local title; + local count; + local command_options; + local statusRunBasics; + local resultRunBasics; + local string_args; + + + # Programs to run + progs_array[1]="acs_vars"; + progs_array[2]="hello_world"; + progs_array[3]="init_func_example"; + progs_array[4]="key_code"; + progs_array[5]="mouse_menu"; + progs_array[6]="other_border"; + progs_array[7]="printw_example"; + progs_array[8]="scanw_example"; + progs_array[9]="simple_attr"; + progs_array[10]="simple_color"; + progs_array[11]="simple_key"; + progs_array[12]="temp_leave"; + progs_array[13]="win_border"; + progs_array[14]="with_chgat"; + + + # Save current directory + cwd=`pwd`; + + cd $EXEC_DIR; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $EXEC_DIR" 5 40; + return $FALSE; + fi + + title="Basics"; + + # Number of programs + count=14; + command_options=""; + while [ $count -gt 0 ] + do + command_options="$command_options ${progs_array[$count]} ${progs_array[$count]}"; + count=`expr $count - 1`; + done + + + # While the user selects some menu option, repeat + statusRunBasics=0; + while (test "$statusRunBasics" = "0") + do + dialog --clear --menu "$title" 20 60 12 $command_options Previous "Return to previous screen" 2>$tmp + resultRunBasics=`cat $tmp`; + statusRunBasics=`echo $?`; + + # None of the programs except "simple_attr" need additional + # arguments and all exit normally (^C not required to exit) + if [ $statusRunBasics -eq 0 ] + then + if [ "$resultRunBasics" == "Previous" ] + then + statusRunBasics=1; + elif [ "$resultRunBasics" == "simple_attr" ] + then + dialog --clear --inputbox "Enter the name of a C file (pwd: demo/exe)" 10 60 2>$tmp + string_arg=`cat $tmp`; + if [ $? -eq 0 ] + then + ./$resultRunBasics $string_arg 2>$TEMP_FILE; + if [ $? -ne 0 ] + then + echo " +Unable to run './$resultRunBasics'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + else + ./$resultRunBasics 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './$resultRunBasics'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + fi + done + + cd $cwd; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $cwd" 5 40; + return $FALSE; + fi + + return $TRUE; +} + + +# runForms: Function to run the programs in the Forms category +# Arguments: None +runForms() +{ + local cwd; + local progs_array; + local title; + local count; + local command_options; + local statusRunForms; + local resultRunForms; + + + + # Programs to run + progs_array[1]="form_attrib"; + progs_array[2]="form_options"; + progs_array[3]="form_simple"; + progs_array[4]="form_win"; + + + # Save current directory + cwd=`pwd`; + + cd $EXEC_DIR; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $EXEC_DIR" 5 40; + return $FALSE; + fi + + title="Forms"; + + # Number of programs + count=4; + command_options=""; + while [ $count -gt 0 ] + do + command_options="$command_options ${progs_array[$count]} ${progs_array[$count]}"; + count=`expr $count - 1`; + done + + + # While the user selects some menu option, repeat + statusRunForms=0; + while (test "$statusRunForms" = "0") + do + dialog --clear --menu "$title" 20 60 7 $command_options Previous "Return to previous screen" 2>$tmp + resultRunForms=`cat $tmp`; + statusRunForms=`echo $?`; + + # None of the programs need additional arguments and all exit + # normally (^C not required to exit) + if [ $statusRunForms -eq 0 ] + then + if [ "$resultRunForms" == "Previous" ] + then + statusRunForms=1; + else + ./$resultRunForms 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './$resultRunForms'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + fi + done + + cd $cwd; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $cwd" 5 40; + return $FALSE; + fi + + return $TRUE; +} + + +# runMenus: Function to run the programs in the Menus category +# Arguments: None +runMenus() +{ + local cwd; + local progs_array; + local title; + local count; + local command_options; + local statusRunMenus; + local resultRunMenus; + + + + # Programs to run + progs_array[1]="menu_attrib"; + progs_array[2]="menu_item_data"; + progs_array[3]="menu_multi_column"; + progs_array[4]="menu_scroll"; + progs_array[5]="menu_simple"; + progs_array[6]="menu_toggle"; + progs_array[7]="menu_userptr"; + progs_array[8]="menu_win"; + + + # Save current directory + cwd=`pwd`; + + cd $EXEC_DIR; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $EXEC_DIR" 5 40; + return $FALSE; + fi + + title="Menus"; + + # Number of programs + count=8; + command_options=""; + while [ $count -gt 0 ] + do + command_options="$command_options ${progs_array[$count]} ${progs_array[$count]}"; + count=`expr $count - 1`; + done + + + # While the user selects some menu option, repeat + statusRunMenus=0; + while (test "$statusRunMenus" = "0") + do + dialog --clear --menu "$title" 20 60 10 $command_options Previous "Return to previous screen" 2>$tmp + resultRunMenus=`cat $tmp`; + statusRunMenus=`echo $?`; + + # None of the programs need additional arguments and all exit + # normally (^C not required to exit) + if [ $statusRunMenus -eq 0 ] + then + if [ "$resultRunMenus" == "Previous" ] + then + statusRunMenus=1; + else + ./$resultRunMenus 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './$resultRunMenus'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + fi + done + + cd $cwd; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $cwd" 5 40; + return $FALSE; + fi + + return $TRUE; +} + + +# runPanels: Function to run the programs in the Panels category +# Arguments: None +runPanels() +{ + local cwd; + local progs_array; + local title; + local count; + local command_options; + local statusRunPanels; + local resultRunPanels; + + + + # Programs to run + progs_array[1]="panel_browse"; + progs_array[2]="panel_hide"; + progs_array[3]="panel_resize"; + progs_array[4]="panel_simple"; + + + # Save current directory + cwd=`pwd`; + + cd $EXEC_DIR; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $EXEC_DIR" 5 40; + return $FALSE; + fi + + title="Panels"; + + # Number of programs + count=8; + command_options=""; + while [ $count -gt 0 ] + do + command_options="$command_options ${progs_array[$count]} ${progs_array[$count]}"; + count=`expr $count - 1`; + done + + + # While the user selects some menu option, repeat + statusRunPanels=0; + while (test "$statusRunPanels" = "0") + do + dialog --clear --menu "$title" 20 60 7 $command_options Previous "Return to previous screen" 2>$tmp + resultRunPanels=`cat $tmp`; + statusRunPanels=`echo $?`; + + # None of the programs need additional arguments and all exit + # normally (^C not required to exit) + if [ $statusRunPanels -eq 0 ] + then + if [ "$resultRunPanels" == "Previous" ] + then + statusRunPanels=1; + else + ./$resultRunPanels 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './$resultRunPanels'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + fi + done + + cd $cwd; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $cwd" 5 40; + return $FALSE; + fi + + return $TRUE; +} + + +# runJustForFun: Function to run the programs in the JustForFun category +# Arguments: None +runJustForFun() +{ + local cwd; + local progs_array; + local title; + local count; + local command_options; + local statusRunJustForFun; + local resultRunJustForFun; + local num_arg; + + + + # Programs to run + progs_array[1]="hanoi"; + progs_array[2]="life"; + progs_array[3]="magic"; + progs_array[4]="queens"; + progs_array[5]="shuffle"; + progs_array[6]="tt"; + + + # Save current directory + cwd=`pwd`; + + cd $EXEC_DIR; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $EXEC_DIR" 5 40; + return $FALSE; + fi + + title="Just For Fun"; + + # Number of programs + count=6; + command_options=""; + while [ $count -gt 0 ] + do + command_options="$command_options ${progs_array[$count]} ${progs_array[$count]}"; + count=`expr $count - 1`; + done + + + # While the user selects some menu option, repeat + statusRunJustForFun=0; + while (test "$statusRunJustForFun" = "0") + do + resultRunJustForFun=`dialog --clear --menu "$title" 20 60 10 $command_options Previous "Return to previous screen" 2>&1`; + statusRunJustForFun=`echo $?`; + + case "$resultRunJustForFun" in + "hanoi") + ./hanoi 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + echo " +Unable to run './hanoi'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + + ;; + "life") + ./life 2> $TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './hanoi'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + + ;; + "magic") + num_arg=`dialog --clear --inputbox "Enter the size of the magic square" 10 40 2>&1`; + if [ $? -eq 0 ] + then + # Check if an integer + echo $num_arg | grep -E -e [^0-9]; + if [ $? -ne 0 ] + then + ./magic $num_arg 2>$TEMP_FILE; + if [ $? -ne 0 ] + then + echo " +Unable to run './magic'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + + ;; + "queens") + num_arg=`dialog --clear --inputbox "Enter the number of qeens (chess board order) ( > 3)" 10 40 2>&1`; + if [ $? -eq 0 ] + then + # Check if an integer + echo $num_arg | grep -E -e [^0-9]; + if [ $? -ne 0 ] + then + ./queens $num_arg 2>$TEMP_FILE; + if [ $? -ne 0 ] + then + echo " +Unable to run './queens'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + + ;; + "shuffle") + num_arg=`dialog --clear --inputbox "Enter the order of the shuffle board" 10 40 2>&1`; + if [ $? -eq 0 ] + then + # Check if an integer + echo $num_arg | grep -E -e [^0-9]; + if [ $? -ne 0 ] + then + ./shuffle $num_arg 2>$TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './shuffle'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + fi + fi + + ;; + "tt") + ./tt 2>$TEMP_FILE; + if [ $? -ne 0 ] + then + if [ `wc -c $TEMP_FILE | awk {'print \$1'}` -ne 0 ] + then + echo " +Unable to run './tt'" >> $TEMP_FILE; + dialog --clear --textbox $TEMP_FILE 15 60; + fi + fi + ;; + Previous) + statusRunJustForFun="1"; + ;; + esac + done + + cd $cwd; + if [ $? -ne 0 ] + then + dialog --clear --msgbox "Unable to change to $cwd" 5 40; + return $FALSE; + fi + + return $TRUE; +} + + + +# submenu: Generic function to process submenus (display submenu for a +# category +# Arguments: Title, run_function +# run_function: This function is invoked when the 'Run' item is choosen +submenu() +{ + local cwdSubmenu; + local statusSubmenu; + local title + local resultSubmenu; + + # Save current working directory + cwdSubmenu=`pwd`; + + #While the user selects some menu option, repeat + statusSubmenu=0 + title="$1"; + while (test "$statusSubmenu" = "0") + do + # Create the main menu dialog box + dialog --clear --menu "NCURSES Programming HOWTO $title Sample Programs" 20 60 8 Make "Make programs" Clean "Clean programs" Run "Run programs" Source "View source code for programs" readme "View the readme file" makefile "View the Makefile" Previous "Return to previous screen" 2>$tmp + resultSubmenu=`cat $tmp` + statusSubmenu=`echo $?` + case $resultSubmenu in + Make) + execMake + if [ $? -eq 0 ] + then + echo " +'make' successful" >> $TEMP_FILE; + else + echo " +Unable to run 'make'" >> $TEMP_FILE; + fi + dialog --clear --textbox $TEMP_FILE 15 60; + + ;; + Clean) + execMake "clean"; + if [ $? -eq 0 ] + then + echo " +'make clean' successful" >> $TEMP_FILE; + else + echo " +Unable to run 'make clean'" >> $TEMP_FILE; + fi + dialog --clear --textbox $TEMP_FILE 15 60; + + ;; + Run) + # Run the programs: The function name passed + # to this function as $2 + $2; + + ;; + Source) + # Bring up the source code menu + source_menu; + + ;; + readme) + if [ -n "$EDITOR" ] + then + $EDITOR README; + else + dialog --clear --msgbox "EDITOR environment variable is not set. Please set it to your favorite editor and rerun the program." 10 40; + fi + + ;; + makefile) + if [ -n "$EDITOR" ] + then + $EDITOR Makefile; + else + dialog --clear --msgbox "EDITOR environment variable is not set. Please set it to your favorite editor and rerun the program." 10 40; + fi + + ;; + Previous) + statusSubmenu="1"; + ;; + esac + done + + return $TRUE; +} + + + + +# Code starts + +# Initialize the variables +basics="basics"; +forms="forms"; +menus="menus"; +panels="panels"; +JustForFun="JustForFun"; + +# Save the current working directory +cwd=`pwd`; + + +#While the user selects some menu option, repeat +status=0 +while (test "$status" = "0") +do + #Create the main menu dialog box + dialog --clear --menu "NCURSES Programming HOWTO Sample Programs" 20 60 10 basics "Basics" forms "Forms" menus "Menus" panels "Panels" JustForFun "Just For Fun" makeall "Make all programs" cleanall "Make clean all programs" readme "View the readme file" makefile "View the Makefile" Quit "Quit" 2>$tmp + status=`echo $?` + result=`cat $tmp` + case $result in + basics) + cd $basics || dialog --clear --msgbox "Unable to change to directory $basics" 5 40; + + # Call the basics function + submenu "Basics" runBasics; + if [ $? -ne 0 ]; + then + dialog --clear --msgbox "Error processing basics" 5 40; + fi + + # Change back to the earlier working directory + cd $cwd; + ;; + forms) + cd $forms || dialog --clear --msgbox "Unable to change to directory $forms" 5 40; + + # Call the forms function + submenu "Forms" runForms; + if [ $? -ne 0 ]; + then + dialog --clear --msgbox "Error processing forms" 5 40; + fi + + # Change back to the earlier working directory + cd $cwd; + ;; + menus) + cd $menus || dialog --clear --msgbox "Unable to change to directory $menus" 5 40; + + # Call the menus function + submenu "Menus" runMenus; + if [ $? -ne 0 ]; + then + dialog --clear --msgbox "Error processing menus" 5 40; + fi + + # Change back to the earlier working directory + cd $cwd; + ;; + panels) + cd $panels || dialog --clear --msgbox "Unable to change to directory $panels" 5 40; + + # Call the menus function + submenu "Panels" runPanels; + if [ $? -ne 0 ]; + then + dialog --clear --msgbox "Error processing panels" 5 40; + fi + + # Change back to the earlier working directory + cd $cwd; + ;; + JustForFun) + cd $JustForFun || dialog --clear --msgbox "Unable to change to directory $JustForFun" 5 40; + + # Call the JustForFun function + submenu "JustForFun" runJustForFun; + if [ $? -ne 0 ]; + then + dialog --clear --msgbox "Error processing JustForFun" 5 40; + fi + + # Change back to the earlier working directory + cd $cwd; + ;; + makeall) + # Call the execMake function + execMake; + if [ $? -eq 0 ] + then + echo " +'make' successful" >> $TEMP_FILE; + else + echo " +Unable to run 'make'" >> $TEMP_FILE; + fi + dialog --clear --textbox $TEMP_FILE 15 60; + + ;; + cleanall) + # Call the execMake function + execMake "clean"; + if [ $? -eq 0 ] + then + echo " +'make clean' successful" >> $TEMP_FILE; + else + echo " +Unable to run 'make clean'" >> $TEMP_FILE; + fi + dialog --clear --textbox $TEMP_FILE 15 60; + + ;; + readme) + if [ -n "$EDITOR" ] + then + $EDITOR README; + else + dialog --clear --msgbox "EDITOR environment variable is not set. Please set it to your favorite editor and rerun the program." 10 40; + fi + + ;; + makefile) + if [ -n "$EDITOR" ] + then + $EDITOR Makefile; + else + dialog --clear --msgbox "EDITOR environment variable is not set. Please set it to your favorite editor and rerun the program." 10 40; + fi + + ;; + Quit) + # Remove the TEMP_FILE + rm -f $TEMP_FILE; + rm -f $tmp; + + status="1"; + ;; + esac +done diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/Makefile new file mode 100644 index 00000000..73626e79 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/Makefile @@ -0,0 +1,31 @@ +# Makefile for JustForFun Files + +# A few variables + +CC=gcc +LIBS=-lmenu -lncurses + +SRC_DIR=. +EXE_DIR=../demo/exe + +EXES = \ + ${EXE_DIR}/menu_attrib\ + ${EXE_DIR}/menu_item_data\ + ${EXE_DIR}/menu_multi_column \ + ${EXE_DIR}/menu_scroll \ + ${EXE_DIR}/menu_simple \ + ${EXE_DIR}/menu_toggle \ + ${EXE_DIR}/menu_userptr \ + ${EXE_DIR}/menu_win + +${EXE_DIR}/%: %.o + ${CC} -o $@ $< ${LIBS} + +%.o: ${SRC_DIR}/%.c + ${CC} -o $@ -c $< + +all: ${EXES} + + +clean: + @rm -f ${EXES} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/README new file mode 100644 index 00000000..211bfa38 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/README @@ -0,0 +1,13 @@ +Description of files +-------------------- + menus + | + |----> menu_attrib.c -- Usage of menu attributes + |----> menu_item_data.c -- Usage of item_name() etc.. functions + |----> menu_multi_column.c -- Creates multi columnar menus + |----> menu_scroll.c -- Demonstrates scrolling capability of menus + |----> menu_simple.c -- A simple menu accessed by arrow keys + |----> menu_toggle.c -- Creates multi valued menus and explains + | -- REQ_TOGGLE_ITEM + |----> menu_userptr.c -- Usage of user pointer + |----> menu_win.c -- Demo of windows associated with menus diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_attrib.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_attrib.c new file mode 100644 index 00000000..9c278dcd --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_attrib.c @@ -0,0 +1,80 @@ +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Choice 5", + "Choice 6", + "Choice 7", + "Exit", + }; + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + int n_choices, i; + ITEM *cur_item; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_GREEN, COLOR_BLACK); + init_pair(3, COLOR_MAGENTA, COLOR_BLACK); + + /* Initialize items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + my_items[n_choices] = (ITEM *)NULL; + item_opts_off(my_items[3], O_SELECTABLE); + item_opts_off(my_items[6], O_SELECTABLE); + + /* Create menu */ + my_menu = new_menu((ITEM **)my_items); + + /* Set fore ground and back ground of the menu */ + set_menu_fore(my_menu, COLOR_PAIR(1) | A_REVERSE); + set_menu_back(my_menu, COLOR_PAIR(2)); + set_menu_grey(my_menu, COLOR_PAIR(3)); + + /* Post the menu */ + mvprintw(LINES - 3, 0, "Press to see the option selected"); + mvprintw(LINES - 2, 0, "Up and Down arrow keys to naviage (F1 to Exit)"); + post_menu(my_menu); + refresh(); + + while((c = getch()) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case 10: /* Enter */ + move(20, 0); + clrtoeol(); + mvprintw(20, 0, "Item selected is : %s", + item_name(current_item(my_menu))); + pos_menu_cursor(my_menu); + break; + } + } + unpost_menu(my_menu); + for(i = 0; i < n_choices; ++i) + free_item(my_items[i]); + free_menu(my_menu); + endwin(); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_item_data.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_item_data.c new file mode 100644 index 00000000..3bec4d09 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_item_data.c @@ -0,0 +1,66 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Exit", + }; + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + int n_choices, i; + ITEM *cur_item; + + + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *)); + + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + my_items[n_choices] = (ITEM *)NULL; + + my_menu = new_menu((ITEM **)my_items); + post_menu(my_menu); + refresh(); + + while((c = getch()) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case 10: /* Enter */ + cur_item = current_item(my_menu); + move(LINES - 2, 0); + clrtoeol(); + mvprintw(LINES - 2, 0, "You have chosen %d item with name %s and description %s", + item_index(cur_item) + 1, item_name(cur_item), + item_description(cur_item)); + + refresh(); + pos_menu_cursor(my_menu); + break; + } + } + + free_item(my_items[0]); + free_item(my_items[1]); + free_menu(my_menu); + endwin(); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_multi_column.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_multi_column.c new file mode 100644 index 00000000..5a5456b4 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_multi_column.c @@ -0,0 +1,97 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", "Choice 2", "Choice 3", "Choice 4", "Choice 5", + "Choice 6", "Choice 7", "Choice 8", "Choice 9", "Choice 10", + "Choice 11", "Choice 12", "Choice 13", "Choice 14", "Choice 15", + "Choice 16", "Choice 17", "Choice 18", "Choice 19", "Choice 20", + "Exit", + (char *)NULL, + }; + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + WINDOW *my_menu_win; + int n_choices, i; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_CYAN, COLOR_BLACK); + + /* Create items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + + /* Crate menu */ + my_menu = new_menu((ITEM **)my_items); + + /* Set menu option not to show the description */ + menu_opts_off(my_menu, O_SHOWDESC); + + /* Create the window to be associated with the menu */ + my_menu_win = newwin(10, 70, 4, 4); + keypad(my_menu_win, TRUE); + + /* Set main window and sub window */ + set_menu_win(my_menu, my_menu_win); + set_menu_sub(my_menu, derwin(my_menu_win, 6, 68, 3, 1)); + set_menu_format(my_menu, 5, 3); + set_menu_mark(my_menu, " * "); + + /* Print a border around the main window and print a title */ + box(my_menu_win, 0, 0); + + attron(COLOR_PAIR(2)); + mvprintw(LINES - 3, 0, "Use PageUp and PageDown to scroll"); + mvprintw(LINES - 2, 0, "Use Arrow Keys to navigate (F1 to Exit)"); + attroff(COLOR_PAIR(2)); + refresh(); + + /* Post the menu */ + post_menu(my_menu); + wrefresh(my_menu_win); + + while((c = wgetch(my_menu_win)) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case KEY_LEFT: + menu_driver(my_menu, REQ_LEFT_ITEM); + break; + case KEY_RIGHT: + menu_driver(my_menu, REQ_RIGHT_ITEM); + break; + case KEY_NPAGE: + menu_driver(my_menu, REQ_SCR_DPAGE); + break; + case KEY_PPAGE: + menu_driver(my_menu, REQ_SCR_UPAGE); + break; + } + wrefresh(my_menu_win); + } + + /* Unpost and free all the memory taken up */ + unpost_menu(my_menu); + free_menu(my_menu); + for(i = 0; i < n_choices; ++i) + free_item(my_items[i]); + endwin(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_scroll.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_scroll.c new file mode 100644 index 00000000..5d7e742a --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_scroll.c @@ -0,0 +1,124 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Choice 5", + "Choice 6", + "Choice 7", + "Choice 8", + "Choice 9", + "Choice 10", + "Exit", + (char *)NULL, + }; +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + WINDOW *my_menu_win; + int n_choices, i; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_CYAN, COLOR_BLACK); + + /* Create items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + + /* Crate menu */ + my_menu = new_menu((ITEM **)my_items); + + /* Create the window to be associated with the menu */ + my_menu_win = newwin(10, 40, 4, 4); + keypad(my_menu_win, TRUE); + + /* Set main window and sub window */ + set_menu_win(my_menu, my_menu_win); + set_menu_sub(my_menu, derwin(my_menu_win, 6, 38, 3, 1)); + set_menu_format(my_menu, 5, 1); + + /* Set menu mark to the string " * " */ + set_menu_mark(my_menu, " * "); + + /* 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_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); + wrefresh(my_menu_win); + + attron(COLOR_PAIR(2)); + mvprintw(LINES - 2, 0, "Use PageUp and PageDown to scoll down or up a page of items"); + mvprintw(LINES - 1, 0, "Arrow Keys to navigate (F1 to Exit)"); + attroff(COLOR_PAIR(2)); + refresh(); + + while((c = wgetch(my_menu_win)) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case KEY_NPAGE: + menu_driver(my_menu, REQ_SCR_DPAGE); + break; + case KEY_PPAGE: + menu_driver(my_menu, REQ_SCR_UPAGE); + break; + } + wrefresh(my_menu_win); + } + + /* Unpost and free all the memory taken up */ + unpost_menu(my_menu); + free_menu(my_menu); + for(i = 0; i < n_choices; ++i) + free_item(my_items[i]); + endwin(); +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_simple.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_simple.c new file mode 100644 index 00000000..2487968b --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_simple.c @@ -0,0 +1,56 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Exit", + }; + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + int n_choices, i; + ITEM *cur_item; + + + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *)); + + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + my_items[n_choices] = (ITEM *)NULL; + + my_menu = new_menu((ITEM **)my_items); + mvprintw(LINES - 2, 0, "F1 to Exit"); + post_menu(my_menu); + refresh(); + + while((c = getch()) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + } + } + + free_item(my_items[0]); + free_item(my_items[1]); + free_menu(my_menu); + endwin(); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_toggle.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_toggle.c new file mode 100644 index 00000000..e252f974 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_toggle.c @@ -0,0 +1,84 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Choice 5", + "Choice 6", + "Choice 7", + "Exit", + }; + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + int n_choices, i; + ITEM *cur_item; + + /* Initialize curses */ + initscr(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + my_items[n_choices] = (ITEM *)NULL; + + my_menu = new_menu((ITEM **)my_items); + + /* Make the menu multi valued */ + menu_opts_off(my_menu, O_ONEVALUE); + + mvprintw(LINES - 3, 0, "Use to select or unselect an item."); + mvprintw(LINES - 2, 0, " to see presently selected items(F1 to Exit)"); + post_menu(my_menu); + refresh(); + + while((c = getch()) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case ' ': + menu_driver(my_menu, REQ_TOGGLE_ITEM); + break; + case 10: /* Enter */ + { char temp[200]; + ITEM **items; + + items = menu_items(my_menu); + temp[0] = '\0'; + for(i = 0; i < item_count(my_menu); ++i) + if(item_value(items[i]) == TRUE) + { strcat(temp, item_name(items[i])); + strcat(temp, " "); + } + move(20, 0); + clrtoeol(); + mvprintw(20, 0, temp); + refresh(); + } + break; + } + } + + free_item(my_items[0]); + free_item(my_items[1]); + free_menu(my_menu); + endwin(); +} + diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_userptr.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_userptr.c new file mode 100644 index 00000000..79a25faa --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_userptr.c @@ -0,0 +1,87 @@ +#include +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Choice 5", + "Choice 6", + "Choice 7", + "Exit", + }; +void func(char *name); + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + int n_choices, i; + ITEM *cur_item; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_GREEN, COLOR_BLACK); + init_pair(3, COLOR_MAGENTA, COLOR_BLACK); + + /* Initialize items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices + 1, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + { my_items[i] = new_item(choices[i], choices[i]); + /* Set the user pointer */ + set_item_userptr(my_items[i], func); + } + my_items[n_choices] = (ITEM *)NULL; + + /* Create menu */ + my_menu = new_menu((ITEM **)my_items); + + /* Post the menu */ + mvprintw(LINES - 3, 0, "Press to see the option selected"); + mvprintw(LINES - 2, 0, "Up and Down arrow keys to naviage (F1 to Exit)"); + post_menu(my_menu); + refresh(); + + while((c = getch()) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + case 10: /* Enter */ + { ITEM *cur; + void (*p)(char *); + + cur = current_item(my_menu); + p = item_userptr(cur); + p((char *)item_name(cur)); + pos_menu_cursor(my_menu); + break; + } + break; + } + } + unpost_menu(my_menu); + for(i = 0; i < n_choices; ++i) + free_item(my_items[i]); + free_menu(my_menu); + endwin(); +} + +void func(char *name) +{ move(20, 0); + clrtoeol(); + mvprintw(20, 0, "Item selected is : %s", name); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_win.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_win.c new file mode 100644 index 00000000..cd43643b --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/menus/menu_win.c @@ -0,0 +1,105 @@ +#include + +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) +#define CTRLD 4 + +char *choices[] = { + "Choice 1", + "Choice 2", + "Choice 3", + "Choice 4", + "Exit", + (char *)NULL, + }; +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); + +int main() +{ ITEM **my_items; + int c; + MENU *my_menu; + WINDOW *my_menu_win; + int n_choices, i; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + init_pair(1, COLOR_RED, COLOR_BLACK); + + /* Create items */ + n_choices = ARRAY_SIZE(choices); + my_items = (ITEM **)calloc(n_choices, sizeof(ITEM *)); + for(i = 0; i < n_choices; ++i) + my_items[i] = new_item(choices[i], choices[i]); + + /* Crate menu */ + my_menu = new_menu((ITEM **)my_items); + + /* Create the window to be associated with the menu */ + my_menu_win = newwin(10, 40, 4, 4); + keypad(my_menu_win, TRUE); + + /* Set main window and sub window */ + set_menu_win(my_menu, my_menu_win); + set_menu_sub(my_menu, derwin(my_menu_win, 6, 38, 3, 1)); + + /* Set menu mark to the string " * " */ + set_menu_mark(my_menu, " * "); + + /* 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_LTEE); + mvwhline(my_menu_win, 2, 1, ACS_HLINE, 38); + mvwaddch(my_menu_win, 2, 39, ACS_RTEE); + mvprintw(LINES - 2, 0, "F1 to exit"); + refresh(); + + /* Post the menu */ + post_menu(my_menu); + wrefresh(my_menu_win); + + while((c = wgetch(my_menu_win)) != KEY_F(1)) + { switch(c) + { case KEY_DOWN: + menu_driver(my_menu, REQ_DOWN_ITEM); + break; + case KEY_UP: + menu_driver(my_menu, REQ_UP_ITEM); + break; + } + wrefresh(my_menu_win); + } + + /* Unpost and free all the memory taken up */ + unpost_menu(my_menu); + free_menu(my_menu); + for(i = 0; i < n_choices; ++i) + free_item(my_items[i]); + endwin(); +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/Makefile b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/Makefile new file mode 100644 index 00000000..242df7c1 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/Makefile @@ -0,0 +1,27 @@ +# Makefile for JustForFun Files + +# A few variables + +CC=gcc +LIBS=-lpanel -lncurses + +SRC_DIR=. +EXE_DIR=../demo/exe + +EXES = \ + ${EXE_DIR}/panel_browse \ + ${EXE_DIR}/panel_hide \ + ${EXE_DIR}/panel_resize \ + ${EXE_DIR}/panel_simple + +${EXE_DIR}/%: %.o + ${CC} -o $@ $< ${LIBS} + +%.o: ${SRC_DIR}/%.c + ${CC} -o $@ -c $< + +all: ${EXES} + + +clean: + @rm -f ${EXES} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/README b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/README new file mode 100644 index 00000000..ed346780 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/README @@ -0,0 +1,8 @@ +Description of files +-------------------- + panels + | + |----> panel_browse.c -- Panel browsing through tab. Usage of user pointer + |----> panel_hide.c -- Hiding and Un hiding of panels + |----> panel_resize.c -- Moving and resizing of panels + |----> panel_simple.c -- A simple panel example diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_browse.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_browse.c new file mode 100644 index 00000000..49a8c280 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_browse.c @@ -0,0 +1,117 @@ +#include + +#define NLINES 10 +#define NCOLS 40 + +void init_wins(WINDOW **wins, int n); +void win_show(WINDOW *win, char *label, int label_color); +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); + +int main() +{ WINDOW *my_wins[3]; + PANEL *my_panels[3]; + PANEL *top; + int ch; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize all the colors */ + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_GREEN, COLOR_BLACK); + init_pair(3, COLOR_BLUE, COLOR_BLACK); + init_pair(4, COLOR_CYAN, COLOR_BLACK); + + init_wins(my_wins, 3); + + /* Attach a panel to each window */ /* Order is bottom up */ + my_panels[0] = new_panel(my_wins[0]); /* Push 0, order: stdscr-0 */ + my_panels[1] = new_panel(my_wins[1]); /* Push 1, order: stdscr-0-1 */ + my_panels[2] = new_panel(my_wins[2]); /* Push 2, order: stdscr-0-1-2 */ + + /* Set up the user pointers to the next panel */ + set_panel_userptr(my_panels[0], my_panels[1]); + set_panel_userptr(my_panels[1], my_panels[2]); + set_panel_userptr(my_panels[2], my_panels[0]); + + /* Update the stacking order. 2nd panel will be on top */ + update_panels(); + + /* Show it on the screen */ + attron(COLOR_PAIR(4)); + mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)"); + attroff(COLOR_PAIR(4)); + doupdate(); + + top = my_panels[2]; + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case 9: + top = (PANEL *)panel_userptr(top); + top_panel(top); + break; + } + update_panels(); + doupdate(); + } + endwin(); + return 0; +} + +/* Put all the windows */ +void init_wins(WINDOW **wins, int n) +{ int x, y, i; + char label[80]; + + y = 2; + x = 10; + for(i = 0; i < n; ++i) + { wins[i] = newwin(NLINES, NCOLS, y, x); + sprintf(label, "Window Number %d", i + 1); + win_show(wins[i], label, i + 1); + y += 3; + x += 7; + } +} + +/* Show the window with a border and a label */ +void win_show(WINDOW *win, char *label, int label_color) +{ int startx, starty, height, width; + + getbegyx(win, starty, startx); + getmaxyx(win, height, width); + + box(win, 0, 0); + mvwaddch(win, 2, 0, ACS_LTEE); + mvwhline(win, 2, 1, ACS_HLINE, width - 2); + mvwaddch(win, 2, width - 1, ACS_RTEE); + + print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color)); +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_hide.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_hide.c new file mode 100644 index 00000000..8e6e0d4e --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_hide.c @@ -0,0 +1,156 @@ +#include + +typedef struct _PANEL_DATA { + int hide; /* TRUE if panel is hidden */ +}PANEL_DATA; + +#define NLINES 10 +#define NCOLS 40 + +void init_wins(WINDOW **wins, int n); +void win_show(WINDOW *win, char *label, int label_color); +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); + +int main() +{ WINDOW *my_wins[3]; + PANEL *my_panels[3]; + PANEL_DATA panel_datas[3]; + PANEL_DATA *temp; + int ch; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize all the colors */ + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_GREEN, COLOR_BLACK); + init_pair(3, COLOR_BLUE, COLOR_BLACK); + init_pair(4, COLOR_CYAN, COLOR_BLACK); + + init_wins(my_wins, 3); + + /* Attach a panel to each window */ /* Order is bottom up */ + my_panels[0] = new_panel(my_wins[0]); /* Push 0, order: stdscr-0 */ + my_panels[1] = new_panel(my_wins[1]); /* Push 1, order: stdscr-0-1 */ + my_panels[2] = new_panel(my_wins[2]); /* Push 2, order: stdscr-0-1-2 */ + + /* Initialize panel datas saying that nothing is hidden */ + panel_datas[0].hide = FALSE; + panel_datas[1].hide = FALSE; + panel_datas[2].hide = FALSE; + + set_panel_userptr(my_panels[0], &panel_datas[0]); + set_panel_userptr(my_panels[1], &panel_datas[1]); + set_panel_userptr(my_panels[2], &panel_datas[2]); + + /* Update the stacking order. 2nd panel will be on top */ + update_panels(); + + /* Show it on the screen */ + attron(COLOR_PAIR(4)); + mvprintw(LINES - 3, 0, "Show or Hide a window with 'a'(first window) 'b'(Second Window) 'c'(Third Window)"); + mvprintw(LINES - 2, 0, "F1 to Exit"); + + attroff(COLOR_PAIR(4)); + doupdate(); + + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case 'a': + temp = (PANEL_DATA *)panel_userptr(my_panels[0]); + if(temp->hide == FALSE) + { hide_panel(my_panels[0]); + temp->hide = TRUE; + } + else + { show_panel(my_panels[0]); + temp->hide = FALSE; + } + break; + case 'b': + temp = (PANEL_DATA *)panel_userptr(my_panels[1]); + if(temp->hide == FALSE) + { hide_panel(my_panels[1]); + temp->hide = TRUE; + } + else + { show_panel(my_panels[1]); + temp->hide = FALSE; + } + break; + case 'c': + temp = (PANEL_DATA *)panel_userptr(my_panels[2]); + if(temp->hide == FALSE) + { hide_panel(my_panels[2]); + temp->hide = TRUE; + } + else + { show_panel(my_panels[2]); + temp->hide = FALSE; + } + break; + } + update_panels(); + doupdate(); + } + endwin(); + return 0; +} + +/* Put all the windows */ +void init_wins(WINDOW **wins, int n) +{ int x, y, i; + char label[80]; + + y = 2; + x = 10; + for(i = 0; i < n; ++i) + { wins[i] = newwin(NLINES, NCOLS, y, x); + sprintf(label, "Window Number %d", i + 1); + win_show(wins[i], label, i + 1); + y += 3; + x += 7; + } +} + +/* Show the window with a border and a label */ +void win_show(WINDOW *win, char *label, int label_color) +{ int startx, starty, height, width; + + getbegyx(win, starty, startx); + getmaxyx(win, height, width); + + box(win, 0, 0); + mvwaddch(win, 2, 0, ACS_LTEE); + mvwhline(win, 2, 1, ACS_HLINE, width - 2); + mvwaddch(win, 2, width - 1, ACS_RTEE); + + print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color)); +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_resize.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_resize.c new file mode 100644 index 00000000..804acae2 --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_resize.c @@ -0,0 +1,234 @@ +#include + +typedef struct _PANEL_DATA { + int x, y, w, h; + char label[80]; + int label_color; + PANEL *next; +}PANEL_DATA; + +#define NLINES 10 +#define NCOLS 40 + +void init_wins(WINDOW **wins, int n); +void win_show(WINDOW *win, char *label, int label_color); +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color); +void set_user_ptrs(PANEL **panels, int n); + +int main() +{ WINDOW *my_wins[3]; + PANEL *my_panels[3]; + PANEL_DATA *top; + PANEL *stack_top; + WINDOW *temp_win, *old_win; + int ch; + int newx, newy, neww, newh; + int size = FALSE, move = FALSE; + + /* Initialize curses */ + initscr(); + start_color(); + cbreak(); + noecho(); + keypad(stdscr, TRUE); + + /* Initialize all the colors */ + init_pair(1, COLOR_RED, COLOR_BLACK); + init_pair(2, COLOR_GREEN, COLOR_BLACK); + init_pair(3, COLOR_BLUE, COLOR_BLACK); + init_pair(4, COLOR_CYAN, COLOR_BLACK); + + init_wins(my_wins, 3); + + /* Attach a panel to each window */ /* Order is bottom up */ + my_panels[0] = new_panel(my_wins[0]); /* Push 0, order: stdscr-0 */ + my_panels[1] = new_panel(my_wins[1]); /* Push 1, order: stdscr-0-1 */ + my_panels[2] = new_panel(my_wins[2]); /* Push 2, order: stdscr-0-1-2 */ + + set_user_ptrs(my_panels, 3); + /* Update the stacking order. 2nd panel will be on top */ + update_panels(); + + /* Show it on the screen */ + attron(COLOR_PAIR(4)); + mvprintw(LINES - 3, 0, "Use 'm' for moving, 'r' for resizing"); + mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)"); + attroff(COLOR_PAIR(4)); + doupdate(); + + stack_top = my_panels[2]; + top = (PANEL_DATA *)panel_userptr(stack_top); + newx = top->x; + newy = top->y; + neww = top->w; + newh = top->h; + while((ch = getch()) != KEY_F(1)) + { switch(ch) + { case 9: /* Tab */ + top = (PANEL_DATA *)panel_userptr(stack_top); + top_panel(top->next); + stack_top = top->next; + top = (PANEL_DATA *)panel_userptr(stack_top); + newx = top->x; + newy = top->y; + neww = top->w; + newh = top->h; + break; + case 'r': /* Re-Size*/ + size = TRUE; + attron(COLOR_PAIR(4)); + mvprintw(LINES - 4, 0, "Entered Resizing :Use Arrow Keys to resize and press to end resizing"); + refresh(); + attroff(COLOR_PAIR(4)); + break; + case 'm': /* Move */ + attron(COLOR_PAIR(4)); + mvprintw(LINES - 4, 0, "Entered Moving: Use Arrow Keys to Move and press to end moving"); + refresh(); + attroff(COLOR_PAIR(4)); + move = TRUE; + break; + case KEY_LEFT: + if(size == TRUE) + { --newx; + ++neww; + } + if(move == TRUE) + --newx; + break; + case KEY_RIGHT: + if(size == TRUE) + { ++newx; + --neww; + } + if(move == TRUE) + ++newx; + break; + case KEY_UP: + if(size == TRUE) + { --newy; + ++newh; + } + if(move == TRUE) + --newy; + break; + case KEY_DOWN: + if(size == TRUE) + { ++newy; + --newh; + } + if(move == TRUE) + ++newy; + break; + case 10: /* Enter */ + move(LINES - 4, 0); + clrtoeol(); + refresh(); + if(size == TRUE) + { old_win = panel_window(stack_top); + temp_win = newwin(newh, neww, newy, newx); + replace_panel(stack_top, temp_win); + win_show(temp_win, top->label, top->label_color); + delwin(old_win); + size = FALSE; + } + if(move == TRUE) + { move_panel(stack_top, newy, newx); + move = FALSE; + } + break; + + } + attron(COLOR_PAIR(4)); + mvprintw(LINES - 3, 0, "Use 'm' for moving, 'r' for resizing"); + mvprintw(LINES - 2, 0, "Use tab to browse through the windows (F1 to Exit)"); + attroff(COLOR_PAIR(4)); + refresh(); + update_panels(); + doupdate(); + } + endwin(); + return 0; +} + +/* Put all the windows */ +void init_wins(WINDOW **wins, int n) +{ int x, y, i; + char label[80]; + + y = 2; + x = 10; + for(i = 0; i < n; ++i) + { wins[i] = newwin(NLINES, NCOLS, y, x); + sprintf(label, "Window Number %d", i + 1); + win_show(wins[i], label, i + 1); + y += 3; + x += 7; + } +} + +/* Set the PANEL_DATA structures for individual panels */ +void set_user_ptrs(PANEL **panels, int n) +{ PANEL_DATA *ptrs; + WINDOW *win; + int x, y, w, h, i; + char temp[80]; + + ptrs = (PANEL_DATA *)calloc(n, sizeof(PANEL_DATA)); + + for(i = 0;i < n; ++i) + { win = panel_window(panels[i]); + getbegyx(win, y, x); + getmaxyx(win, h, w); + ptrs[i].x = x; + ptrs[i].y = y; + ptrs[i].w = w; + ptrs[i].h = h; + sprintf(temp, "Window Number %d", i + 1); + strcpy(ptrs[i].label, temp); + ptrs[i].label_color = i + 1; + if(i + 1 == n) + ptrs[i].next = panels[0]; + else + ptrs[i].next = panels[i + 1]; + set_panel_userptr(panels[i], &ptrs[i]); + } +} + +/* Show the window with a border and a label */ +void win_show(WINDOW *win, char *label, int label_color) +{ int startx, starty, height, width; + + getbegyx(win, starty, startx); + getmaxyx(win, height, width); + + box(win, 0, 0); + mvwaddch(win, 2, 0, ACS_LTEE); + mvwhline(win, 2, 1, ACS_HLINE, width - 2); + mvwaddch(win, 2, width - 1, ACS_RTEE); + + print_in_middle(win, 1, 0, width, label, COLOR_PAIR(label_color)); +} + +void print_in_middle(WINDOW *win, int starty, int startx, int width, char *string, chtype color) +{ int length, x, y; + float temp; + + if(win == NULL) + win = stdscr; + getyx(win, y, x); + if(startx != 0) + x = startx; + if(starty != 0) + y = starty; + if(width == 0) + width = 80; + + length = strlen(string); + temp = (width - length)/ 2; + x = startx + (int)temp; + wattron(win, color); + mvwprintw(win, y, x, "%s", string); + wattroff(win, color); + refresh(); +} diff --git a/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_simple.c b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_simple.c new file mode 100644 index 00000000..47fcb67b --- /dev/null +++ b/LDP/howto/docbook/NCURSES-Programming-HOWTO/ncurses_programs/panels/panel_simple.c @@ -0,0 +1,38 @@ +#include + +int main() +{ WINDOW *my_wins[3]; + PANEL *my_panels[3]; + int lines = 10, cols = 40, y = 2, x = 4, i; + + initscr(); + cbreak(); + noecho(); + + /* Create windows for the panels */ + my_wins[0] = newwin(lines, cols, y, x); + my_wins[1] = newwin(lines, cols, y + 1, x + 5); + my_wins[2] = newwin(lines, cols, y + 2, x + 10); + + /* + * Create borders around the windows so that you can see the effect + * of panels + */ + for(i = 0; i < 3; +++i) + box(my_wins[i], 0, 0); + + /* Attach a panel to each window */ /* Order is bottom up */ + my_panels[0] = new_panel(my_wins[0]); /* Push 0, order: stdscr-0 */ + my_panels[1] = new_panel(my_wins[1]); /* Push 1, order: stdscr-0-1 */ + my_panels[2] = new_panel(my_wins[2]); /* Push 2, order: stdscr-0-1-2 */ + + /* Update the stacking order. 2nd panel will be on top */ + update_panels(); + + /* Show it on the screen */ + doupdate(); + + getch(); + endwin(); +} + diff --git a/LDP/howto/linuxdoc/archived/VPN.sgml b/LDP/howto/linuxdoc/archived/VPN.sgml new file mode 100644 index 00000000..a5e07fb2 --- /dev/null +++ b/LDP/howto/linuxdoc/archived/VPN.sgml @@ -0,0 +1,360 @@ + + +
+ +The VPN HOWTO +<author>Arpad Magosanyi <mag@bunuel.tii.matav.hu> v0.2,7 Aug1997 +<date>v0.3, 2001-12-01 + +<p> +<bf>Archived Document Notice:</bf> This document has been archived by the LDP +because it does not apply to modern Linux systems. It is no longer +being actively maintained. +</p> + +<sect>Changes +<p> + +The 'no controlling tty problem' -> -o 'BatchMode yes' by Zot O'Connor <zot@crl.com> + +warning about kernel 2.0.30 by mag +<sect>Blurb +<p> + +This is the Linux VPN howto, a collection of information on how to set up a Virtual Protected Network in Linux (and other unices in general). +<sect1>Copyright +<p> + +This document is part of the Linux Documentation Project. The copyright notice is the following: +<p> +The VPN mini HOWTO written by me can be copied, +distributed, and/or modified under the terms of the GNU Free Documentation +License, Version 1.1 or any later version published by the Free Software +Foundation; with the Invariant Section being the section entitled "About +the ppp over ssh vpn technique", with any Front-Cover Text containing the p= +hrase +"Based on the work of Arpad Magosanyi", and with any Back-Cover Text. + +<sect1>Disclaimer +<p> + +As usual: the author not responsible for any damage. For the correct wording, see the relevant part of the GNU GPL 0.1.1 +<sect1>Disclaimer +<p> + +We are dealing with security: you are not safe if you haven't got good security policy, and other rather boring things. +<sect1>Credits +<p> + +Thanks to all of who has written the tools used. + +Thanks to Zot O'Connor <zot@crl.com> for pointing out the "no controlling tty" problem, and it's solution. +<sect1>State of this document +<p> + +This is very preliminary. You should have thorough knowledge of administrating IP, at least some knowledge of firewalls, ppp and ssh. You should know them anyway if you want to set up a VPN. I just decided to write down my experiences not to forget them. There are possibly some security holes indeed. To be fair I've tried it on hosts configured as routers not firewalls, saying: It's simple from that point. +<sect1>Related documentations +<p> +<itemize> +<item>The Linux Firewall-HOWTO /usr/doc/HOWTO/Firewall-HOWTO +<item>The Linux PPP-HOWTO /usr/doc/HOWTO/PPP-HOWTO.gz +<item>The ssh documentations /usr/doc/ssh/* +<item>The Linux Network Admins' Guide +<item>NIST Computer Security Special Publications http://csrc.ncsl.nist.gov/nistpubs/ +<item>Firewall list (majordomo@greatcircle.com) +</itemize> +<sect>Introduction +<p> + +As firewalls are in more and more widely use in internet and intranet security, the ability to do nice VPNs is important. Here are my experiences. Comments are welcome. +<sect1>Naming conventions +<p> + +I will use the terms "master firewall" and "slave firewall", though making a VPN has nothing to do with client-server architecture. I simply refer to them as the active and passive participants of the connection's setup. The host which is starts the setup will be referred as the master, and the passive participant will be the slave. +<sect>Doing it +<p> +<sect1>Planning +<p> + +Before you start to set up your system, you should know the networking details. I assume you have two firewalls protecting one intranet per firewall, and they are both connected to the internet. So now you should have two network interfaces (at least) per firewall. Take a sheet of paper, write down their IP addresses and network mask. You will need one more IP adresses per firewall for the VPN you want to do now. Those addresses should be outside of your existing subnets. I suggest using addresses from the "private" address ranges. They are the followings: +<itemize> +<item>10.0.0.0 - 10.255.255.255 +<item>172.16.0.0 - 172.31.255.255 +<item>192.168.0.0 - 192.168.255.255 +</itemize> + +For the sake of example, here's a sample configuration: The two bastions are called fellini and polanski. They have one interface for the internet (-out), one for the intranet (-in), and one for the vpn (-vpn). The addresses and netmasks: +<itemize> +<item>fellini-out: 193.6.34.12 255.255.255.0 +<item>fellini-in: 193.6.35.12 255.255.255.0 +<item>fellini-vpn: 192.168.0.1 point-to-point +<item>polanski-out: 193.6.36.12 255.255.255.0 +<item>polanski-in: 193.6.37.12 255.255.255.0 +<item>polanski-vpn: 192.168.0.2 point-to-point +</itemize> + +So we have the plan. +<sect1>Gathering the tools +<p> + +You will need a +<itemize> +<item>Linux firewall +<item>kernel +<item>very minimal configuration +<item>ipfwadm +<item>fwtk +<item>Tools for the VPN +<item>ssh +<item>pppd +<item>sudo +<item>pty-redir +</itemize> + +Current versions: +<itemize> +<item>kernel: 2.0.29 Use a stable kernel, and it must be newer than 2.0.20, because the ping'o'death bug. At the time of writing 2.0.30 is the last "stable" kernel, but it has some bugs. If you want to have the fast and cool networking code introduced in it, try a prepatch. the 3rd is working for me nicely. +<item>base system: I prefer Debian. YMMV. You absolutely don't want to use any big packages, and you never even tought of using sendmail, of course. You also definitely don't want to enable telnet, ftp, and the 'r' commands (as usual in case of any other unix hosts). +<item>ipfwadm: I've used 2.3.0 +<item>fwtk: I've used 1.3 +<item>ssh: >= 1.2.20. There are problems with the underlying protocol in the older versions. +<item>pppd: I've used 2.2.0f for the tests, but I'm not sure if is it secure, this is why I turned the setuid bit off, and used sudo to launch it. +<item>sudo: 1.5.2 the newest I am aware of +<item>pty-redir: It is written by me. Try ftp://ftp.vein.hu/ssa/contrib/mag/pty-redir-0.1.tar.gz. Its version number is 0.1 now. Tell me it there is any problem with it. +</itemize> +<sect1>Compile and install +<p> + +Compile or otherwise install the gathered tools. Look at every one's documentation (and the firewall-howto) for details. Now we have the tools. +<sect1>Configure the other subsystems +<p> + +Configure your firewall rules, etc. You need to enable ssh traffic between the two firewll hosts. It means a connection to port 22 on the slave from the master. Start sshd on the slave and verify if you can login. This step is untested, please tell me your results. +<sect1>Set up the accounts for the VPN +<p> + +Create an account on the slave firewall use your favourite tool (e.g. vi, mkdir, chown, chmod) you might create an account on the master also, but I think you want to set up the connection at boot time, so your ordinary root account will do. Can anyone point out risks on using the root account on the master? +<sect1>Generate an ssh key for your master account +<p> + +Use the ssh-keygen program. Set empty password for the private key if you want to do automatic setup of the VPN. +<sect1>Set up automatic ssh login for the slave account +<p> + +Copy the newly generated public key in the slave account under .ssh/authorized_keys, and set up file permissions like the following: +<verb> +drwx------ 2 slave slave 1024 Apr 7 23:49 ./ +drwx------ 4 slave slave 1024 Apr 24 14:05 ../ +-rwx------ 1 slave slave 328 Apr 7 03:04 authorized_keys +-rw------- 1 slave slave 660 Apr 14 15:23 known_hosts +-rw------- 1 slave slave 512 Apr 21 10:03 random_seed +</verb> + +The first row being ˜slave/.ssh, and the second is ˜slave. +<sect1>Tighten ssh security on the bastions. +<p> + +It means the followings on my setup in sshd_conf: +<verb> +PermitRootLogin no +IgnoreRhosts yes +StrictModes yes +QuietMode no +FascistLogging yes +KeepAlive yes +RhostsAuthentication no +RhostsRSAAuthentication no +RSAAuthentication yes +PasswordAuthentication no +PermitEmptyPasswords no +</verb> + +Password authentication is turned off, so login is only possible with authorized keys. (You've turned off telnet and the 'r' commands of course). +<sect1>Enable execution of ppp and route for both accounts. +<p> + +As the master account is the root in my case, it has nothing to do. For the slave account, the following lines appear in /etc/sudoers: +<verb> +Cmnd_Alias VPN=/usr/sbin/pppd,/usr/local/vpn/route +slave ALL=NOPASSWD: VPN +</verb> + +As you can see, I am using some scripts to set up ppp and the routing tables on the slave host. +<sect1>Do the scripting +<p> + +On the master host there is a full-blown init script I am using: +<verb> +#! /bin/sh +# skeleton example file to build /etc/init.d/ scripts. +# This file should be used to construct scripts for /etc/init.d. +# +# Written by Miquel van Smoorenburg <miquels@cistron.nl>. +# Modified for Debian GNU/Linux +# by Ian Murdock <imurdock@gnu.ai.mit.edu>. +# +# Version: @(#)skeleton 1.6 11-Nov-1996 miquels@cistron.nl +# + +PATH=/usr/local/sbin:/sbin:/bin:/usr/sbin:/usr/bin:/usr/bin/X11/: +PPPAPP=/home/slave/ppp +ROUTEAPP=/home/slave/route +PPPD=/usr/sbin/pppd +NAME=VPN +REDIR=/usr/local/bin/pty-redir +SSH=/usr/bin/ssh +MYPPPIP=192.168.0.1 +TARGETIP=192.168.0.2 +TARGETNET=193.6.37.0 +MYNET=193.6.35.0 +SLAVEWALL=polanski-out +SLAVEACC=slave + +test -f $PPPD || exit 0 + +set -e + +case "$1" in + start) + echo setting up vpn + $REDIR $SSH -o 'Batchmode yes' -t -l $SLAVEACC $SLAVEWALL sudo $PPPAPP >/tmp/device + TTYNAME=`cat /tmp/device` +echo tty is $TTYNAME + sleep 10s + if [ ! -z $TTYNAME ] + then + $PPPD $TTYNAME ${MYPPPIP}:${TARGETIP} + else + echo FAILED! + logger "vpn setup failed" + fi + sleep 5s + route add -net $TARGETNET gw $TARGETIP + $SSH -o 'Batchmode yes' -l $SLAVEACC $SLAVEWALL sudo $ROUTEAPP + ;; + stop) + ps -ax | grep "ssh -t -l $SLAVEACC " | grep -v grep | awk '{print $1}' | xargs kill + ;; + *) + # echo "Usage: /etc/init.d/$NAME {start|stop|reload}" + echo "Usage: /etc/init.d/$NAME {start|stop}" + exit 1 + ;; +esac + +exit 0 + +</verb> + +The slave uses one script for routing setup (/usr/local/vpn/route): +<verb> +#!/bin/bash +/sbin/route add -net 193.6.35.0 gw 192.168.0.1 +</verb> + +and its .ppprc consists of the following: +<verb> +passive +</verb> +<sect>Look at what's happening: +<p> + +The master logs in into the slave, starts pppd, and redirects this all thing into a local pty. It consists of the following steps: +<itemize> +<item>allocating a new pty +<item>sshing into the slave +<item>running pppd on the slave +<item>the master runs pppd in this local pty +<item>and sets up the routing table on the client. +</itemize> + +There are (not very tight) timing considerations involved, this is why that 'sleep 10s'. +<sect>Doing it by hand. +<p> +<sect1>Logging in +<p> + +You've already tried if ssh works well, aren't you? If the slave refuses to log you in, read the logs. Perhaps there are problems with file permissions or the sshd setup. +<sect1>Firing up ppp +<p> + +Log in into slave, and issue: +<verb>sudo /usr/sbin/pppd passive + +</verb> + +You should see garbage coming at this point. If it works good, if not, there is some problem either with sudo, either with pppd. Look what the commands had said, and at the logs and at the <em>/etc/ppp/options</em>, and the <em>.ppprc </em>file. If it works, write this 'passive' word into .ppprc, and try again. To get rid off the garbage and continue working, press enter,'˜' and '^Z'. You should have the master's prompt now, and kill %1. See the section about tuning if you want to know more of the escape character. +<sect1>Together the two +<p> + +Well, then +<verb>ssh -l slave polanski sudo /usr/sbin/pppd + +</verb> + +should work also, and deliver the garbage right into your face. +<sect1>Pty redirecting +<p> + +Try to redirect this whole thing this time: +<verb>/usr/local/bin/pty-redir /usr/bin/ssh -l slave polanski sudo /usr/sbin/pppd + +</verb> + +Nice long sentence isn't it? You should use the full path into the ssh executable, as the pty-redir program allows only this form for security reasons. Now you've got a device name from the program. Let's say, you've got <em>/dev/ttyp0 </em> You can use the ps command to look what has happened. Look for 'p0' +<sect1>Is anything on the device? +<p> + +Try +<verb>/usr/sbin/pppd /dev/ttyp0 local 192.168.0.1:192.168.0.2 + +</verb> + +to establish the connection. Look at the output of the ifconfig command to see if the device has established, and use ping to check your virtual net. +<sect1>Setting up the routes +<p> + +Set up the routes on the master host, and on the slave also. Now you should be able to ping one host in one intranet from other host in the other intranet. Set up the additional firewalling rules. Now as you have the VPN, you can set up the rules concerning the connectivity of the two intranets. +<sect>Tuning +<p> +<sect1>Configuration tuning +<p> + +As I said this HOWTO is mainly a quick memo on how I had set up a VPN. There are things in the configuration I didn't experiment yet. These things will go into their place when I try them, or anyone tells me "it works in the following way" The most important thing is that the connection ppp uses is not 8-bit yet. I believe it has something to do either with ssh configuration or the pty setup. In this configuration ssh uses the tilde (˜) character as an escape character. It might stop or slow down the communication, as any newline-tilde sequence causes ssh to give a prompt. Ssh documentation said: <On most systems, setting the escape character to ``none'' will also make the session transparent even if a tty is used.> The corresponding flag to ssh is '<em>-e</em>', and you can also set it in the configuration file. +<sect1>Bandwith vs. cicles +<p> + +Creating anything virtual comes with utilization of real-world resources. A VPN eats up bandwidth and computing resources. The goal would be to get balance between the two. You can tune it with the '-C' switch or the 'CompressionLevel' option. You might try using another cipher, but I don't recommend it. Also note that the round-trip-time can be longer if you use better compression. Any experiments on it are welcome. +<sect>Vulnerability analisis +<p> + +I try to cover here the vulnerability issues arising from this particular setup and VPNs in general. Any comments are warmly welcome. +<itemize> +<item>sudo: Well, I'm excessively using sudo. I believe it's still safer than using setuid bits. It's still a backdraw of Linux that it hasn't got more fine-grained access control. Waiting for POSIX.6 compatibility <http://www.xarius.demon.co.uk/software/posix6/>. What is worse, there are shell scripts which are getting called through sudo. Bad enough. Any idea out there? +<item>pppd: It runs suid root also. It can be configured by user's .ppprc. There might be some nice buffer overruns in it. The bottom line: secure your slave account as tightly as you can. +<item>ssh: Beware that ssh older than 1.2.20 has security holes. What is worse, we made a configuration such when the master account had been compromised, the slave account is also compromised, and wide open to attacks using the two sudoed programs. It is because I've choosen not to have password on the master's secret key to enable automatic setup of the VPN. +<item>firewall: With inproperly set firewall rules on one bastion, you open both of the intranets. I recommend using IP masquerading (as setting up incorrect routes is a bit less trivial), and doing hard control on the VPN interfaces. +</itemize> + + +<sect1>About the ppp over ssh VPN technique +<p> +I developed this technique when there was no usable, standard +VPN for Linux. Now this is no longer the case. +At the time of writing this, you have the following alternatives: +If you want to use standard IPSEC VPN, you can use FreeS/WAN or pipsecd. +For PPTP you can use PoPToP (but be aware that PPTP protocol has +weaknesses). It is also worth to mention CIPE which is a lightweight +alternative for IPSEC. +<p> +This wide range of alternatives means that the ssh/ppp implementation +described in this howto is in the most cases not the best solution. +This is due the fact that this implementation is complex to set up +and has performance problems because of its tcp based nature. +<p> +I believe that the ssh/ppp technique is no longer beneficial for +building a VPN for non-illegal purposes in most cases, so I have +discontinued maintaining this HOWTO. + + +</article>