libamxp  1.4.0
Patterns C Implementation
amxp_cron_parser_priv.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 
55 #if !defined(__AMXP_CRON_PARSER_PRIV_H__)
56 #define __AMXP_CRON_PARSER_PRIV_H__
57 
58 #ifdef __cplusplus
59 extern "C"
60 {
61 #endif
62 
63 #include <stdbool.h>
64 #include <stdint.h>
65 
66 #include <amxc/amxc_macros.h>
67 
68 typedef int (* amxp_cron_set_hits_fn_t) (amxc_var_t* value,
69  uint8_t* target,
70  uint32_t min,
71  uint32_t max,
72  const char** error);
73 
74 typedef struct _amxp_cron_hits {
76  uint32_t offset;
77  uint32_t min;
78  uint32_t max;
80 
81 PRIVATE
82 uint8_t cron_get_bit(const uint8_t* rbyte, int idx);
83 
84 PRIVATE
85 int amxp_cron_set_hits(amxc_var_t* value,
86  uint8_t* target,
87  uint32_t min,
88  uint32_t max,
89  const char** error);
90 
91 PRIVATE
92 int amxp_cron_reset(amxp_cron_expr_t* cron_expr);
93 
94 PRIVATE
95 int amxp_cron_set_months(amxc_var_t* value,
96  uint8_t* target,
97  uint32_t min,
98  uint32_t max,
99  const char** error);
100 PRIVATE
101 int amxp_cron_set_days_of_week(amxc_var_t* value,
102  uint8_t* target,
103  uint32_t min,
104  uint32_t max,
105  const char** error);
106 PRIVATE
107 int amxp_cron_set_days_of_month(amxc_var_t* value,
108  uint8_t* target,
109  uint32_t min,
110  uint32_t max,
111  const char** error);
112 
113 #ifdef __cplusplus
114 }
115 #endif
116 
117 #endif // __AMXP_CRON_PARSER_PRIV_H__
PRIVATE uint8_t cron_get_bit(const uint8_t *rbyte, int idx)
PRIVATE int amxp_cron_set_months(amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
int(* amxp_cron_set_hits_fn_t)(amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
PRIVATE int amxp_cron_set_hits(amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
PRIVATE int amxp_cron_set_days_of_month(amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
PRIVATE int amxp_cron_set_days_of_week(amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
struct _amxp_cron_hits amxp_cron_hits_t
PRIVATE int amxp_cron_reset(amxp_cron_expr_t *cron_expr)
amxp_cron_set_hits_fn_t fn
Structure containing parsed cron expression.
Definition: amxp_cron.h:103