1 /* 2 Copyright 2021 Northern.tech AS 3 4 This file is part of CFEngine 3 - written and maintained by Northern.tech AS. 5 6 This program is free software; you can redistribute it and/or modify it 7 under the terms of the GNU General Public License as published by the 8 Free Software Foundation; version 3. 9 10 This program is distributed in the hope that it will be useful, 11 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 GNU General Public License for more details. 14 15 You should have received a copy of the GNU General Public License 16 along with this program; if not, write to the Free Software 17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA 18 19 To the extent this program is licensed as part of the Enterprise 20 versions of CFEngine, the applicable Commercial Open Source License 21 (COSL) may apply to this file if you as a licensee so wish it. See 22 included file COSL.txt. 23 */ 24 25 #ifndef CFENGINE_SYNTAX_H 26 #define CFENGINE_SYNTAX_H 27 28 #include <cf3.defs.h> 29 30 #include <sequence.h> 31 #include <json.h> 32 #include <parser_helpers.h> 33 34 #include <stdio.h> 35 36 /* 37 * WARNING: This file is in need of serious cleanup. 38 */ 39 40 41 typedef enum 42 { 43 SYNTAX_TYPE_MATCH_OK, 44 45 SYNTAX_TYPE_MATCH_ERROR_UNEXPANDED, 46 SYNTAX_TYPE_MATCH_ERROR_RANGE_BRACKETED, 47 SYNTAX_TYPE_MATCH_ERROR_RANGE_MULTIPLE_ITEMS, 48 SYNTAX_TYPE_MATCH_ERROR_GOT_SCALAR, 49 SYNTAX_TYPE_MATCH_ERROR_GOT_LIST, 50 SYNTAX_TYPE_MATCH_ERROR_GOT_NULL, 51 52 SYNTAX_TYPE_MATCH_ERROR_SCALAR_OUT_OF_RANGE, 53 SYNTAX_TYPE_MATCH_ERROR_EMPTY_SCALAR_OUT_OF_RANGE, 54 55 SYNTAX_TYPE_MATCH_ERROR_STRING_UNIX_PERMISSION, 56 57 SYNTAX_TYPE_MATCH_ERROR_INT_PARSE, 58 SYNTAX_TYPE_MATCH_ERROR_INT_OUT_OF_RANGE, 59 60 SYNTAX_TYPE_MATCH_ERROR_REAL_INF, 61 SYNTAX_TYPE_MATCH_ERROR_REAL_OUT_OF_RANGE, 62 63 SYNTAX_TYPE_MATCH_ERROR_OPTS_OUT_OF_RANGE, 64 65 SYNTAX_TYPE_MATCH_ERROR_FNCALL_RETURN_TYPE, 66 SYNTAX_TYPE_MATCH_ERROR_FNCALL_UNKNOWN, 67 68 SYNTAX_TYPE_MATCH_ERROR_CONTEXT_OUT_OF_RANGE, 69 70 SYNTAX_TYPE_MATCH_ERROR_ABSOLUTE_PATH, 71 72 SYNTAX_TYPE_MATCH_MAX 73 } SyntaxTypeMatch; 74 75 const char *SyntaxTypeMatchToString(SyntaxTypeMatch result); 76 77 bool CheckParseVariableName(const char *name); 78 SyntaxTypeMatch CheckConstraintTypeMatch(const char *lval, Rval rval, DataType dt, const char *range, int level); 79 SyntaxTypeMatch CheckParseContext(const char *context, const char *range); 80 DataType StringDataType(EvalContext *ctx, const char *string); 81 DataType ExpectedDataType(const char *lvalname); 82 83 bool IsBuiltInPromiseType(const char *const promise_type); 84 const PromiseTypeSyntax *PromiseTypeSyntaxGet(const char *bundle_type, const char *promise_type); 85 const ConstraintSyntax *PromiseTypeSyntaxGetConstraintSyntax(const PromiseTypeSyntax *promise_type_syntax, const char *lval); 86 87 const BodySyntax *BodySyntaxGet(ParserBlock block, const char *body_type); 88 const ConstraintSyntax *BodySyntaxGetConstraintSyntax(const ConstraintSyntax *body_syntax, const char *lval); 89 90 const char *SyntaxStatusToString(SyntaxStatus status); 91 92 JsonElement *SyntaxToJson(void); 93 94 #define ConstraintSyntaxNewNull() { NULL, CF_DATA_TYPE_NONE, .range.validation_string = NULL, .status = SYNTAX_STATUS_NORMAL } 95 #define ConstraintSyntaxNewBool(lval, description, status) { lval, CF_DATA_TYPE_OPTION, .range.validation_string = CF_BOOL, description, status } 96 97 #define ConstraintSyntaxNewOption(lval, options, description, status) { lval, CF_DATA_TYPE_OPTION, .range.validation_string = options, description, status } 98 #define ConstraintSyntaxNewOptionList(lval, item_range, description, status) { lval, CF_DATA_TYPE_OPTION_LIST, .range.validation_string = item_range, description, status } 99 100 #define ConstraintSyntaxNewString(lval, regex, description, status) { lval, CF_DATA_TYPE_STRING, .range.validation_string = regex, description, status } 101 #define ConstraintSyntaxNewStringList(lval, item_range, description, status) { lval, CF_DATA_TYPE_STRING_LIST, .range.validation_string = item_range, description, status } 102 103 #define ConstraintSyntaxNewInt(lval, int_range, description, status) { lval, CF_DATA_TYPE_INT, .range.validation_string = int_range, description, status } 104 #define ConstraintSyntaxNewIntRange(lval, int_range, description, status ) { lval , CF_DATA_TYPE_INT_RANGE, .range.validation_string = int_range, description, status } 105 #define ConstraintSyntaxNewIntList(lval, description, status) { lval, CF_DATA_TYPE_INT_LIST, .range.validation_string = CF_INTRANGE, description, status } 106 107 #define ConstraintSyntaxNewReal(lval, real_range, description, status) { lval, CF_DATA_TYPE_REAL, .range.validation_string = real_range, description, status } 108 #define ConstraintSyntaxNewRealList(lval, description, status) { lval, CF_DATA_TYPE_REAL_LIST, .range.validation_string = CF_REALRANGE, description, status } 109 110 #define ConstraintSyntaxNewContext(lval, description, status) { lval, CF_DATA_TYPE_CONTEXT, .range.validation_string = CF_CLASSRANGE, description, status } 111 #define ConstraintSyntaxNewContextList(lval, description, status) { lval, CF_DATA_TYPE_CONTEXT_LIST, .range.validation_string = CF_CLASSRANGE, description, status } 112 113 #define ConstraintSyntaxNewContainer(lval, description, status) { lval, CF_DATA_TYPE_CONTAINER, .range.validation_string = "", description, status } 114 115 #define ConstraintSyntaxNewBody(lval, body_syntax, description, status) { lval, CF_DATA_TYPE_BODY, .range.body_type_syntax = body_syntax, description, status } 116 #define ConstraintSyntaxNewBundle(lval, description, status) { lval, CF_DATA_TYPE_BUNDLE, .range.validation_string = CF_BUNDLE, description, status } 117 118 #define BodySyntaxNew(body_type, constraints, check_fn, status) { body_type, constraints, check_fn, status } 119 #define BodySyntaxNewNull() { NULL, NULL, NULL, SYNTAX_STATUS_NORMAL } 120 121 #define PromiseTypeSyntaxNew(agent_type, promise_type, constraints, check_fn, status) { agent_type, promise_type, constraints, check_fn, status } 122 #define PromiseTypeSyntaxNewNull() PromiseTypeSyntaxNew(NULL, NULL, NULL, NULL, SYNTAX_STATUS_NORMAL) 123 124 #define FnCallTypeNew(name, return_type, arguments, implementation, description, opts, category, status) { name, return_type, arguments, implementation, description, .options = opts, category, status } 125 #define FnCallTypeNewNull() FnCallTypeNew(NULL, CF_DATA_TYPE_NONE, NULL, NULL, NULL, false, FNCALL_CATEGORY_UTILS, SYNTAX_STATUS_NORMAL) 126 127 #define CONSTRAINT_SYNTAX_GLOBAL { "meta", CF_DATA_TYPE_STRING_LIST, .range.validation_string = "", "Tags describing the body", SYNTAX_STATUS_NORMAL }, \ 128 { "inherit_from", CF_DATA_TYPE_BODY, .range.validation_string = "", "Body from which attributes will be inherited", SYNTAX_STATUS_NORMAL } 129 130 #endif 131