kson_parser.h

Go to the documentation of this file.

 
#ifndef _KSON_H_
#define _KSON_H_
 
#include "defines.h"
#include "math/math_types.h"
#include "strings/kname.h"
#include "strings/kstring_id.h"
 
typedef enum kson_token_type {
    KSON_TOKEN_TYPE_UNKNOWN,
    KSON_TOKEN_TYPE_WHITESPACE,
    KSON_TOKEN_TYPE_COMMENT,
    KSON_TOKEN_TYPE_IDENTIFIER,
    KSON_TOKEN_TYPE_OPERATOR_EQUAL,
    KSON_TOKEN_TYPE_OPERATOR_MINUS,
    KSON_TOKEN_TYPE_OPERATOR_PLUS,
    KSON_TOKEN_TYPE_OPERATOR_SLASH,
    KSON_TOKEN_TYPE_OPERATOR_ASTERISK,
    KSON_TOKEN_TYPE_OPERATOR_DOT,
    KSON_TOKEN_TYPE_STRING_LITERAL,
    KSON_TOKEN_TYPE_NUMERIC_LITERAL,
    KSON_TOKEN_TYPE_BOOLEAN,
    KSON_TOKEN_TYPE_CURLY_BRACE_OPEN,
    KSON_TOKEN_TYPE_CURLY_BRACE_CLOSE,
    KSON_TOKEN_TYPE_BRACKET_OPEN,
    KSON_TOKEN_TYPE_BRACKET_CLOSE,
    KSON_TOKEN_TYPE_NEWLINE,
    KSON_TOKEN_TYPE_EOF
} kson_token_type;
 
typedef struct kson_token {
    kson_token_type type;
    u32 start;
    u32 end;
#ifdef KOHI_DEBUG
    const char* content;
#endif
} kson_token;
 
typedef struct kson_parser {
    const char* file_content;
    u32 position;
    u32 current_line;
    u32 current_col;
 
    // darray
    kson_token* tokens;
} kson_parser;
 
typedef enum kson_property_type {
    // TODO: Do we want to support undefined/null types. If so, pick one and just use that, no defining both.
    KSON_PROPERTY_TYPE_UNKNOWN,
    KSON_PROPERTY_TYPE_INT,
    KSON_PROPERTY_TYPE_FLOAT,
    KSON_PROPERTY_TYPE_STRING,
    KSON_PROPERTY_TYPE_OBJECT,
    KSON_PROPERTY_TYPE_ARRAY,
    KSON_PROPERTY_TYPE_BOOLEAN,
} kson_property_type;
 
struct kson_property;
 
typedef enum kson_object_type {
    KSON_OBJECT_TYPE_OBJECT,
    KSON_OBJECT_TYPE_ARRAY
} kson_object_type;
 
// An object which can contain properties. Objects
// represent both "object" types as well as "array"
// types. These types are identical with one key
// difference: An object's properties are required to
// be named, whereas array properties are unnamed.
typedef struct kson_object {
    kson_object_type type;
    // darray
    struct kson_property* properties;
} kson_object;
 
// An alias to represent kson arrays, which are really just
// kson_objects that contain properties without names.
typedef kson_object kson_array;
 
// Represents a property value for a kson property.
typedef union kson_property_value {
    // Signed 64-bit int value.
    i64 i;
    // 32-bit float value.
    f32 f;
    // String value.
    const char* s;
    // Array or object value.
    kson_object o;
    // Boolean value.
    b8 b;
} kson_property_value;
 
// Represents a singe property for a kson object or array.
typedef struct kson_property {
    // The type of property.
    kson_property_type type;
    // The name of the property. If this belongs to an array, it should be INVALID_KSTRING_ID.
    kstring_id name;
#ifdef KOHI_DEBUG
    // The original named string. Only used in debug builds.
    const char* name_str;
#endif
    // The property value.
    kson_property_value value;
} kson_property;
 
// Represents a hierarchy of kson objects.
typedef struct kson_tree {
    // The root object, which always must exist.
    kson_object root;
} kson_tree;
 
typedef struct kson_tree_to_string_options {
    // Use tabs instead of spaces?
    b8 use_tabs;
    // Number of tabs/space characters per indent level.
    u8 indent_count;
} kson_tree_to_string_options;
 
KAPI const char* kson_property_type_to_string(kson_property_type type);
 
KAPI b8 kson_parser_create(kson_parser* out_parser);
 
KAPI void kson_parser_destroy(kson_parser* parser);
 
KAPI b8 kson_parser_tokenize(kson_parser* parser, const char* source);
 
KAPI b8 kson_parser_parse(kson_parser* parser, kson_tree* out_tree);
 
KAPI b8 kson_tree_from_string(const char* source, kson_tree* out_tree);
 
KAPI const char* kson_tree_to_string(kson_tree* tree);
 
KAPI const char* kson_tree_to_string_with_options(kson_tree* tree, kson_tree_to_string_options options);
 
KAPI void kson_object_cleanup(kson_object* obj);
 
KAPI void kson_tree_cleanup(kson_tree* tree);
 
KAPI b8 kson_array_value_add_int(kson_array* array, i64 value);
 
KAPI b8 kson_array_value_add_float(kson_array* array, f32 value);
 
KAPI b8 kson_array_value_add_boolean(kson_array* array, b8 value);
 
KAPI b8 kson_array_value_add_string(kson_array* array, const char* value);
 
KAPI b8 kson_array_value_add_mat4(kson_array* array, mat4 value);
 
KAPI b8 kson_array_value_add_rect_2di(kson_array* array, rect_2di value);
 
KAPI b8 kson_array_value_add_vec4(kson_array* array, vec4 value);
 
KAPI b8 kson_array_value_add_vec3(kson_array* array, vec3 value);
 
KAPI b8 kson_array_value_add_vec2(kson_array* array, vec2 value);
 
KAPI b8 kson_array_value_add_kname_as_string(kson_array* array, kname value);
 
KAPI b8 kson_array_value_add_kstring_id_as_string(kson_array* array, kstring_id value);
 
KAPI b8 kson_array_value_add_object(kson_array* array, kson_object value);
 
KAPI b8 kson_array_value_add_object_empty(kson_array* array);
 
KAPI b8 kson_array_value_add_array(kson_array* array, kson_array value);
 
KAPI b8 kson_array_value_add_array_empty(kson_array* array);
 
// Object functions.
 
KAPI b8 kson_object_value_add_int(kson_object* object, const char* name, i64 value);
 
KAPI b8 kson_object_value_add_float(kson_object* object, const char* name, f32 value);
 
KAPI b8 kson_object_value_add_boolean(kson_object* object, const char* name, b8 value);
 
KAPI b8 kson_object_value_add_string(kson_object* object, const char* name, const char* value);
 
KAPI b8 kson_object_value_add_mat4(kson_object* object, const char* name, mat4 value);
 
KAPI b8 kson_object_value_add_rect_2di(kson_object* object, const char* name, rect_2di value);
 
KAPI b8 kson_object_value_add_vec4(kson_object* object, const char* name, vec4 value);
 
KAPI b8 kson_object_value_add_vec3(kson_object* object, const char* name, vec3 value);
 
KAPI b8 kson_object_value_add_vec2(kson_object* object, const char* name, vec2 value);
 
KAPI b8 kson_object_value_add_kname_as_string(kson_object* object, const char* name, kname value);
 
KAPI b8 kson_object_value_add_kstring_id_as_string(kson_object* object, const char* name, kstring_id value);
 
KAPI b8 kson_object_value_add_object(kson_object* object, const char* name, kson_object value);
 
KAPI b8 kson_object_value_add_object_empty(kson_object* object, const char* name);
 
KAPI b8 kson_object_value_add_array(kson_object* object, const char* name, kson_array value);
 
KAPI b8 kson_object_value_add_array_empty(kson_object* object, const char* name);
 
KAPI b8 kson_array_element_count_get(kson_array* array, u32* out_count);
 
KAPI b8 kson_array_element_type_at(kson_array* array, u32 index, kson_property_type* out_type);
 
KAPI b8 kson_array_element_value_get_int(const kson_array* array, u32 index, i64* out_value);
 
KAPI b8 kson_array_element_value_get_float(const kson_array* array, u32 index, f32* out_value);
 
KAPI b8 kson_array_element_value_get_bool(const kson_array* array, u32 index, b8* out_value);
 
KAPI b8 kson_array_element_value_get_string(const kson_array* array, u32 index, const char** out_value);
 
KAPI b8 kson_array_element_value_get_mat4(const kson_array* array, u32 index, mat4* out_value);
 
KAPI b8 kson_array_element_value_get_rect_2di(const kson_array* array, u32 index, rect_2di* out_value);
 
KAPI b8 kson_array_element_value_get_vec4(const kson_array* array, u32 index, vec4* out_value);
 
KAPI b8 kson_array_element_value_get_vec3(const kson_array* array, u32 index, vec3* out_value);
 
KAPI b8 kson_array_element_value_get_vec2(const kson_array* array, u32 index, vec2* out_value);
 
KAPI b8 kson_array_element_value_get_string_as_kname(const kson_array* array, u32 index, kname* out_value);
 
KAPI b8 kson_array_element_value_get_string_as_kstring_id(const kson_array* array, u32 index, kstring_id* out_value);
 
KAPI b8 kson_array_element_value_get_object(const kson_array* array, u32 index, kson_object* out_value);
 
KAPI b8 kson_array_element_value_get_array(const kson_array* array, u32 index, kson_array* out_value);
 
KAPI b8 kson_object_property_type_get(const kson_object* object, const char* name, kson_property_type* out_type);
 
KAPI b8 kson_object_property_count_get(const kson_object* object, u32* out_count);
 
KAPI b8 kson_object_property_value_type_get(const kson_object* object, const char* name, kson_property_type* out_type);
 
KAPI b8 kson_object_property_value_get_int(const kson_object* object, const char* name, i64* out_value);
 
KAPI b8 kson_object_property_value_get_float(const kson_object* object, const char* name, f32* out_value);
 
KAPI b8 kson_object_property_value_get_bool(const kson_object* object, const char* name, b8* out_value);
 
KAPI b8 kson_object_property_value_get_string(const kson_object* object, const char* name, const char** out_value);
 
KAPI b8 kson_object_property_value_get_mat4(const kson_object* object, const char* name, mat4* out_value);
 
KAPI b8 kson_object_property_value_get_rect_2di(const kson_object* object, const char* name, rect_2di* out_value);
 
KAPI b8 kson_object_property_value_get_vec4(const kson_object* object, const char* name, vec4* out_value);
 
KAPI b8 kson_object_property_value_get_vec3(const kson_object* object, const char* name, vec3* out_value);
 
KAPI b8 kson_object_property_value_get_vec2(const kson_object* object, const char* name, vec2* out_value);
 
KAPI b8 kson_object_property_value_get_extents_3d(const kson_object* object, const char* name, extents_3d* out_value);
 
KAPI b8 kson_object_property_value_get_extents_2d(const kson_object* object, const char* name, extents_2d* out_value);
 
KAPI b8 kson_object_property_value_get_string_as_kname(const kson_object* object, const char* name, kname* out_value);
 
KAPI b8 kson_object_property_value_get_string_as_kstring_id(const kson_object* object, const char* name, kstring_id* out_value);
 
KAPI b8 kson_object_property_value_get_object(const kson_object* object, const char* name, kson_object* out_value);
 
KAPI b8 kson_object_property_value_get_array(const kson_object* object, const char* name, kson_array* out_value);
 
KAPI kson_property kson_object_property_create(const char* name);
 
KAPI kson_property kson_array_property_create(const char* name);
 
KAPI kson_object kson_object_create(void);
 
KAPI kson_array kson_array_create(void);
 
#endif