octave_packages/m/time/calendar.m

   1 ## Copyright (C) 2004-2012 Paul Kienzle
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {@var{c} =} calendar ()
  21 ## @deftypefnx {Function File} {@var{c} =} calendar (@var{d})
  22 ## @deftypefnx {Function File} {@var{c} =} calendar (@var{y}, @var{m})
  23 ## @deftypefnx {Function File} {} calendar (@dots{})
  24 ## Return the current monthly calendar in a 6x7 matrix.
  25 ##
  26 ## If @var{d} is specified, return the calendar for the month containing
  27 ## the date @var{d}, which must be a serial date number or a date string.
  28 ##
  29 ## If @var{y} and @var{m} are specified, return the calendar for year @var{y}
  30 ## and month @var{m}.
  31 ##
  32 ## If no output arguments are specified, print the calendar on the screen
  33 ## instead of returning a matrix.
  34 ## @seealso{datenum, datestr}
  35 ## @end deftypefn
  36
  37 ## Author: pkienzle <pkienzle@users.sf.net>
  38 ## Created: 25 July 2004
  39 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
  40
  41 function varargout = calendar (varargin)
  42
  43   switch (nargin)
  44     case 0
  45       v = clock ();
  46       y = v(1);
  47       m = v(2);
  48       d = v(3);
  49     case 1
  50       v = datevec (varargin{1});
  51       y = v(1);
  52       m = v(2);
  53       d = v(3);
  54     case 2
  55       y = varargin{1};
  56       m = varargin{2};
  57       d = [];
  58     otherwise
  59       print_usage ();
  60   endswitch
  61
  62   c = zeros (7, 6);
  63   dayone = datenum (y, m, 1);
  64   ndays = eomday (y, m);
  65   c(weekday (dayone) - 1 + [1:ndays]) = 1:ndays;
  66
  67   if (nargout > 0)
  68     varargout{1} = c';
  69   else
  70     ## Layout the calendar days, 6 columns per day, 7 days per row.
  71     str = sprintf ("    %2d    %2d    %2d    %2d    %2d    %2d    %2d\n", c);
  72
  73     ## Print an asterisk before the specified date
  74     if (! isempty (d))
  75       pos = weekday (dayone) + d - 1;
  76       idx = 6*pos + fix (pos / 7.1) - ifelse (d < 10, 1, 2);
  77       str(idx) = "*";
  78     endif
  79
  80     ## Display the calendar.
  81     s.year = y - 1900;
  82     s.mon = m - 1;
  83     puts (strftime ("                    %b %Y\n", s));
  84     puts ("     S     M    Tu     W    Th     F     S\n");
  85     puts (str);
  86   endif
  87
  88 endfunction
  89
  90
  91 ## demos
  92 %!demo
  93 %! ## Calendar for current month
  94 %! calendar ()
  95 %!demo
  96 %! calendar (1957, 10)
  97
  98 ## tests
  99 %!assert ((calendar(2000,2))'(2:31), [0:29])
 100 %!assert ((calendar(1957,10))'(2:33), [0:31])
 101
 102 %% Test input validation
 103 %!error calendar (1,2,3)
 104