style_expression.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_STYLE_EXPRESSION_H
#define MAPLIBRE_NATIVE_C_STYLE_EXPRESSION_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "style.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum mln_style_expression_type_kind : uint32_t {
  MLN_STYLE_EXPRESSION_TYPE_VALUE = 0,
  MLN_STYLE_EXPRESSION_TYPE_NUMBER = 1,
  MLN_STYLE_EXPRESSION_TYPE_STRING = 2,
  MLN_STYLE_EXPRESSION_TYPE_BOOLEAN = 3,
  MLN_STYLE_EXPRESSION_TYPE_COLOR = 4,
  MLN_STYLE_EXPRESSION_TYPE_OBJECT = 5,
  MLN_STYLE_EXPRESSION_TYPE_FORMATTED = 6,
  MLN_STYLE_EXPRESSION_TYPE_IMAGE = 7,
  MLN_STYLE_EXPRESSION_TYPE_PADDING = 8,
  MLN_STYLE_EXPRESSION_TYPE_VARIABLE_ANCHOR_OFFSET_COLLECTION = 9,
  MLN_STYLE_EXPRESSION_TYPE_ARRAY = 10,
} mln_style_expression_type_kind;

typedef struct mln_style_expression_type {
  uint32_t kind MLN_BINDING("enum=mln_style_expression_type_kind");
  uint32_t item_kind MLN_BINDING("enum=mln_style_expression_type_kind");
  uint32_t item_count;
} mln_style_expression_type;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_style_expression_option_field : uint32_t {
  MLN_STYLE_EXPRESSION_OPTION_EXPECTED_TYPE = 1U << 0U,
} mln_style_expression_option_field;

typedef struct mln_style_expression_options {
  uint32_t size;
  uint32_t fields MLN_BINDING("enum=mln_style_expression_option_field");
  mln_style_expression_type expected_type
    MLN_BINDING("mask=fields;bit=MLN_STYLE_EXPRESSION_OPTION_EXPECTED_TYPE");
} mln_style_expression_options;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_style_expression_input_field : uint32_t {
  MLN_STYLE_EXPRESSION_INPUT_ZOOM = 1U << 0U,
  MLN_STYLE_EXPRESSION_INPUT_COLOR_RAMP_PARAMETER = 1U << 1U,
  MLN_STYLE_EXPRESSION_INPUT_ELEVATION = 1U << 2U,
  MLN_STYLE_EXPRESSION_INPUT_FEATURE = 1U << 3U,
  MLN_STYLE_EXPRESSION_INPUT_FEATURE_STATE = 1U << 4U,
  MLN_STYLE_EXPRESSION_INPUT_GLOBAL_STATE = 1U << 5U,
  MLN_STYLE_EXPRESSION_INPUT_CANONICAL_TILE_ID = 1U << 6U,
} mln_style_expression_input_field;

typedef struct mln_style_expression_inputs {
  uint32_t size;
  uint32_t fields MLN_BINDING("enum=mln_style_expression_input_field");
  double zoom MLN_BINDING("mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_ZOOM");
  double color_ramp_parameter MLN_BINDING(
    "mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_COLOR_RAMP_PARAMETER"
  );
  double elevation
    MLN_BINDING("mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_ELEVATION");
  mln_buffer_view feature MLN_BINDING(
    "encoding=json;mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_FEATURE"
  );
  mln_buffer_view feature_state MLN_BINDING(
    "encoding=json;mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_FEATURE_STATE"
  );
  mln_buffer_view global_state MLN_BINDING(
    "encoding=json;mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_GLOBAL_STATE"
  );
  mln_canonical_tile_id canonical_tile_id
    MLN_BINDING("mask=fields;bit=MLN_STYLE_EXPRESSION_INPUT_CANONICAL_TILE_ID");
  const mln_buffer_view* available_images
    MLN_BINDING("length=available_image_count");
  size_t available_image_count;
} mln_style_expression_inputs;

typedef struct mln_style_expression_info {
  uint32_t size;
  bool is_feature_constant;
  bool is_zoom_constant;
} mln_style_expression_info;

MLN_API mln_style_expression_options
mln_style_expression_options_default(void) MLN_NOEXCEPT;

MLN_API mln_style_expression_inputs
mln_style_expression_inputs_default(void) MLN_NOEXCEPT;

MLN_API mln_status mln_style_expression_create(
  mln_buffer_view expression MLN_BINDING("encoding=json"),
  const mln_style_expression_options* options MLN_BINDING("nullable=true"),
  mln_style_expression* out_expression MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API void mln_style_expression_release(
  mln_style_expression expression
) MLN_NOEXCEPT;

MLN_API mln_status mln_style_expression_get_info(
  mln_style_expression expression,
  mln_style_expression_info* out_info MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_style_expression_evaluate(
  mln_style_expression expression,
  const mln_style_expression_inputs* inputs MLN_BINDING("nullable=true"),
  char* out_json MLN_BINDING(
    "direction=out;encoding=json;length=json_capacity;"
    "result_length=out_json_length"
  ),
  size_t json_capacity, size_t* out_json_length MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_STYLE_EXPRESSION_H