Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / systat / mode.c
1 /*
2  * Copyright 1997 Massachusetts Institute of Technology
3  *
4  * Permission to use, copy, modify, and distribute this software and
5  * its documentation for any purpose and without fee is hereby
6  * granted, provided that both the above copyright notice and this
7  * permission notice appear in all copies, that both the above
8  * copyright notice and this permission notice appear in all
9  * supporting documentation, and that the name of M.I.T. not be used
10  * in advertising or publicity pertaining to distribution of the
11  * software without specific, written prior permission.  M.I.T. makes
12  * no representations about the suitability of this software for any
13  * purpose.  It is provided "as is" without express or implied
14  * warranty.
15  * 
16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: src/usr.bin/systat/mode.c,v 1.2 1999/08/28 01:06:03 peter Exp $
30  */
31
32 /*
33  * mode.c - mechanisms for dealing with SGI-style modal displays.
34  *
35  * There are four generally-understood useful modes for status displays
36  * of the sort exemplified by the IRIX ``netstat -C'' and ``osview''
37  * programs.  We try to follow their example, although the user interface
38  * and terminology slightly differ.
39  *
40  * RATE - the default mode - displays the precise rate of change in
41  * each statistic in units per second, regardless of the actual display
42  * update interval.
43  *
44  * DELTA - displays the change in each statistic over the entire
45  * display update interval (i.e., RATE * interval).
46  *
47  * SINCE - displays the total change in each statistic since the module
48  * was last initialized or reset.
49  *
50  * ABSOLUTE - displays the current value of each statistic.
51  *
52  * In the SGI programs, these modes are selected by the single-character
53  * commands D, W, N, and A.  In systat, they are the slightly-harder-to-type
54  * ``mode delta'', etc.  The initial value for SINCE mode is initialized
55  * when the module is first started and can be reset using the ``reset''
56  * command (as opposed to the SGI way where changing modes implicitly
57  * resets).  A ``mode'' command with no arguments displays the current
58  * mode in the command line.
59  */
60
61 #include <sys/types.h>
62
63 #include "systat.h"
64 #include "extern.h"
65 #include "mode.h"
66
67 enum mode currentmode = display_RATE;
68
69 static const char *const modes[] = { "rate", "delta", "since", "absolute" };
70
71 int
72 cmdmode(char *cmd, char *args)
73 {
74         if (prefix(cmd, "mode")) {
75                 if (args[0] == '\0') {
76                         move(CMDLINE, 0);
77                         clrtoeol();
78                         printw("%s", modes[currentmode]);
79                 } else if (prefix(args, "rate")) {
80                         currentmode = display_RATE;
81                 } else if (prefix(args, "delta")) {
82                         currentmode = display_DELTA;
83                 } else if (prefix(args, "since")) {
84                         currentmode = display_SINCE;
85                 } else if (prefix(args, "absolute")) {
86                         currentmode = display_ABS;
87                 } else {
88                         printw("unknown mode `%s'", args);
89                 }
90                 return 1;
91         }
92         if(prefix(cmd, "reset")) {
93                 curcmd->c_reset();
94                 return 1;
95         }
96         return 0;
97 }