src/basic/calendarspec.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2012 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 /* A structure for specifying (possibly repetitive) points in calendar
  24  * time, a la cron */
  25
  26 #include <stdbool.h>
  27
  28 #include "time-util.h"
  29 #include "util.h"
  30
  31 typedef struct CalendarComponent {
  32         int start;
  33         int stop;
  34         int repeat;
  35
  36         struct CalendarComponent *next;
  37 } CalendarComponent;
  38
  39 typedef struct CalendarSpec {
  40         int weekdays_bits;
  41         bool end_of_month;
  42         bool utc;
  43         int dst;
  44         char *timezone;
  45
  46         CalendarComponent *year;
  47         CalendarComponent *month;
  48         CalendarComponent *day;
  49
  50         CalendarComponent *hour;
  51         CalendarComponent *minute;
  52         CalendarComponent *microsecond;
  53 } CalendarSpec;
  54
  55 void calendar_spec_free(CalendarSpec *c);
  56
  57 int calendar_spec_normalize(CalendarSpec *spec);
  58 bool calendar_spec_valid(CalendarSpec *spec);
  59
  60 int calendar_spec_to_string(const CalendarSpec *spec, char **p);
  61 int calendar_spec_from_string(const char *p, CalendarSpec **spec);
  62
  63 int calendar_spec_next_usec(const CalendarSpec *spec, usec_t usec, usec_t *next);