schema.h

Go to the documentation of this file.

/* This file is part of LibT2FS.
 *
 * LibT2FS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * LibT2FS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef H_T2FS_SCHEMA
#define H_T2FS_SCHEMA
 
#include <stdint.h>
 
#define NODE_TYPE_UNDEFINED       0
#define NODE_TYPE_BRANCH_DYNAMIC  1
#define NODE_TYPE_BRANCH_FIXED    2
#define NODE_TYPE_BRANCH_MIXED    3 // first one or more fixed child nodes, others dynamic
#define NODE_TYPE_BRANCH_REPEATED 4 // repeat fixed branch
#define NODE_TYPE_DATA            5
 
typedef struct s_T2FSSchemaNode T2FSSchemaNode;
 
typedef struct s_T2FSSchemaNode {
  char *name;
 
  // fixedCount equals childCount on any childType except for NODE_TYPE_BRANCH_MIXED
  uint32_t fixedCount;
 
  // total child node count
  uint32_t childCount;
 
  // child schema nodes, when fixedCount is set, then the first fixedCount
  // child nodes are fixed, following are dynamic (variable).
  T2FSSchemaNode *childNodes;
 
  uint8_t childType;
 
  // stuff for constraining data (only when childType is NODE_TYPE_DATA)
  uint8_t isArray;
  // when isArray this is the array value size, else it's fixed size.
  // to ignore the size check set dataSize to 0.
  uint32_t dataSize;
  // when the data is an interleaved array
  uint8_t interleaved;
} T2FSSchemaNode;
 
 
void
t2fs_schema_node_init(T2FSSchemaNode *schemaNode);
 
void
t2fs_schema_node_free_childeren(T2FSSchemaNode *schemaNode);
 
int
t2fs_schema_parse_from_json(const char *jsonPath, T2FSSchemaNode *root);
 
void
t2fs_schema_print(T2FSSchemaNode *schema);
 
#endif