/*
 *
  ***** BEGIN LICENSE BLOCK *****
 
  Copyright (C) 2009-2010 Olof Hagsand
  Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)

  This file is part of CLIXON.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  Alternatively, the contents of this file may be used under the terms of
  the GNU General Public License Version 3 or later (the "GPL"),
  in which case the provisions of the GPL are applicable instead
  of those above. If you wish to allow use of your version of this file only
  under the terms of the GPL, and not to allow others to
  use your version of this file under the terms of Apache License version 2, 
  indicate your decision by deleting the provisions above and replace them with
  the  notice and other provisions required by the GPL. If you do not delete
  the provisions above, a recipient may use your version of this file under
  the terms of any one of the Apache License version 2 or the GPL.

  ***** END LICENSE BLOCK *****

  *
  * This file defines the internal YANG data structures used by the Clixon implementation
  * This file SHOULD ONLY be included by clixon_yang.h.
  * Accesses should be made via the API defined in clixon_yang.h
  */

#ifndef _CLIXON_YANG_INTERNAL_H_
#define _CLIXON_YANG_INTERNAL_H_

/*! Yang type cache. Yang type statements can cache all typedef info here
 * @note unions not cached
*/
struct yang_type_cache{
    int        yc_options;  /* See YANG_OPTIONS_* that determines pattern/
                               fraction fields. */
    cvec      *yc_cvv;      /* Range and length restriction. (if YANG_OPTION_
                               LENGTH|RANGE. Can be a vector if multiple 
                               ranges*/
    cvec      *yc_patterns; /* list of regexp, if cvec_len() > 0 */
    int        yc_rxmode; /* need to store mode for freeing since handle may not be available */
    cvec      *yc_regexps;  /* list of _compiled_ regexp, if cvec_len() > 0 */
    uint8_t    yc_fraction; /* Fraction digits for decimal64 (if 
                               YANG_OPTIONS_FRACTION_DIGITS */
    yang_stmt *yc_resolved; /* Resolved type object, can be NULL - note direct ptr */
};
typedef struct yang_type_cache yang_type_cache;

/*! yang statement 
 * This is an internal type, not exposed in the API
 * The external type is "yang_stmt" defined in clixon_yang.h
 */
struct yang_stmt{
    int                ys_len;       /* Number of children */
    struct yang_stmt **ys_stmt;      /* Vector of children statement pointers */
    struct yang_stmt  *ys_parent;    /* Backpointer to parent: yang-stmt or yang-spec */
    enum rfc_6020      ys_keyword;   /*  */

    char              *ys_argument;  /* String / argument depending on keyword */   
    uint16_t           ys_flags;     /* Flags according to YANG_FLAG_MARK and others */
    yang_stmt         *ys_mymodule;  /* Shortcut to "my" module. Used by:
                                        1) Augmented nodes "belong" to the module where the 
                                           augment is declared, which may be differnt from
                                           the direct ancestor module 
                                        2) Unknown nodes "belong" to where the extension is
                                           declared
                                      */
    cg_var            *ys_cv;        /* cligen variable. See ys_populate()
                                        Following stmts have cv:s:
                                        leaf: for default value
                                        leaf-list, 
                                        config: boolean true or false
                                        mandatory: boolean true or false
                                        require-instance: true or false
                                        fraction-digits for fraction-digits
                                        revision (uint32)
                                        unknown-stmt (optional argument)
                                        spec: mount-point xpath
                                     */
    cvec              *ys_cvec;      /* List of stmt-specific variables 
                                        Y_RANGE: range_min, range_max 
                                        Y_LIST: vector of keys
                                        Y_TYPE & identity: store all derived 
                                           types as <module>:<id> list
                                        Y_UNIQUE: vector of descendant schema node ids
                                        Y_EXTENSION: vector of instantiated UNKNOWNSo
                                        Y_UNKNOWN: app-dep: yang-mount-points
                                     */
    yang_type_cache   *ys_typecache; /* If ys_keyword==Y_TYPE, cache all typedef data except unions */
    char              *ys_when_xpath; /* Special conditional for a "when"-associated augment/uses xpath */
    cvec              *ys_when_nsc;   /* Special conditional for a "when"-associated augment/uses namespace ctx */
    char              *ys_filename;   /* For debug/errors: filename (only (sub)modules) */
    int                ys_linenum;    /* For debug/errors: line number (in ys_filename) */
    rpc_callback_t    *ys_action_cb;  /* Action callback list, only for Y_ACTION */
    /* Internal use */
    int               _ys_vector_i;   /* internal use: yn_each */
};

#endif  /* _CLIXON_YANG_INTERNAL_H_ */

