query.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_QUERY_H
#define MAPLIBRE_NATIVE_C_QUERY_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "completion.h"
#include "map.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum mln_rendered_query_geometry_type : uint32_t {
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_POINT = 1,
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_BOX = 2,
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_LINE_STRING = 3,
} mln_rendered_query_geometry_type;

typedef struct mln_screen_box {
  mln_screen_point min;
  mln_screen_point max;
} mln_screen_box;

typedef struct mln_screen_line_string {
  const mln_screen_point* points MLN_BINDING("length=point_count");
  size_t point_count;
} mln_screen_line_string;

typedef union mln_rendered_query_geometry_data {
  mln_screen_point point
    MLN_BINDING("variant=MLN_RENDERED_QUERY_GEOMETRY_TYPE_POINT");
  mln_screen_box box
    MLN_BINDING("variant=MLN_RENDERED_QUERY_GEOMETRY_TYPE_BOX");
  mln_screen_line_string line_string
    MLN_BINDING("variant=MLN_RENDERED_QUERY_GEOMETRY_TYPE_LINE_STRING");
} mln_rendered_query_geometry_data;

typedef struct mln_rendered_query_geometry {
  uint32_t size;
  uint32_t type MLN_BINDING("enum=mln_rendered_query_geometry_type");
  mln_rendered_query_geometry_data data MLN_BINDING("tag=type");
} mln_rendered_query_geometry;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_rendered_feature_query_option_field : uint32_t {
  MLN_RENDERED_FEATURE_QUERY_OPTION_LAYER_IDS = 1U << 0U,
  MLN_RENDERED_FEATURE_QUERY_OPTION_FILTER = 1U << 1U,
} mln_rendered_feature_query_option_field;

typedef struct mln_rendered_feature_query_options {
  uint32_t size;
  uint32_t fields MLN_BINDING("enum=mln_rendered_feature_query_option_field");
  const mln_buffer_view* layer_ids MLN_BINDING(
    "length=layer_id_count;mask=fields;"
    "bit=MLN_RENDERED_FEATURE_QUERY_OPTION_LAYER_IDS"
  );
  size_t layer_id_count;
  mln_buffer_view filter MLN_BINDING(
    "encoding=json;mask=fields;bit=MLN_RENDERED_FEATURE_QUERY_OPTION_FILTER"
  );
} mln_rendered_feature_query_options;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_source_feature_query_option_field : uint32_t {
  MLN_SOURCE_FEATURE_QUERY_OPTION_SOURCE_LAYER_IDS = 1U << 0U,
  MLN_SOURCE_FEATURE_QUERY_OPTION_FILTER = 1U << 1U,
} mln_source_feature_query_option_field;

typedef struct mln_source_feature_query_options {
  uint32_t size;
  uint32_t fields MLN_BINDING("enum=mln_source_feature_query_option_field");
  const mln_buffer_view* source_layer_ids MLN_BINDING(
    "length=source_layer_id_count;mask=fields;"
    "bit=MLN_SOURCE_FEATURE_QUERY_OPTION_SOURCE_LAYER_IDS"
  );
  size_t source_layer_id_count;
  mln_buffer_view filter MLN_BINDING(
    "encoding=json;mask=fields;bit=MLN_SOURCE_FEATURE_QUERY_OPTION_FILTER"
  );
} mln_source_feature_query_options;

typedef enum MLN_BINDING("kind=bitmask") mln_rendered_feature_field : uint32_t {
  MLN_RENDERED_FEATURE_SOURCE_ID = 1U << 0U,
  MLN_RENDERED_FEATURE_SOURCE_LAYER_ID = 1U << 1U,
  MLN_RENDERED_FEATURE_STATE = 1U << 2U,
} mln_rendered_feature_field;

typedef struct mln_rendered_feature {
  uint32_t fields MLN_BINDING("enum=mln_rendered_feature_field");
  mln_buffer_view feature MLN_BINDING("encoding=json");
  mln_buffer_view layer_id;
  mln_buffer_view source_id
    MLN_BINDING("mask=fields;bit=MLN_RENDERED_FEATURE_SOURCE_ID");
  mln_buffer_view source_layer_id
    MLN_BINDING("mask=fields;bit=MLN_RENDERED_FEATURE_SOURCE_LAYER_ID");
  mln_buffer_view state
    MLN_BINDING("encoding=json;mask=fields;bit=MLN_RENDERED_FEATURE_STATE");
} mln_rendered_feature;

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

typedef struct mln_source_feature {
  uint32_t fields MLN_BINDING("enum=mln_source_feature_field");
  mln_buffer_view feature MLN_BINDING("encoding=json");
  mln_buffer_view source_layer_id
    MLN_BINDING("mask=fields;bit=MLN_SOURCE_FEATURE_SOURCE_LAYER_ID");
} mln_source_feature;

MLN_API mln_rendered_feature_query_options
mln_rendered_feature_query_options_default(void) MLN_NOEXCEPT;

MLN_API mln_source_feature_query_options
mln_source_feature_query_options_default(void) MLN_NOEXCEPT;

MLN_BINDING("execution=query;result=mln_rendered_feature;shape=array")
MLN_API mln_status mln_render_session_query_rendered_features(
  mln_render_session session, const mln_rendered_query_geometry* geometry,
  const mln_rendered_feature_query_options* options
    MLN_BINDING("nullable=true"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=query;result=mln_source_feature;shape=array")
MLN_API mln_status mln_render_session_query_source_features(
  mln_render_session session, mln_buffer_view source_id,
  const mln_source_feature_query_options* options MLN_BINDING("nullable=true"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=query;result=mln_buffer_view;encoding=json")
MLN_API mln_status mln_render_session_query_feature_extensions(
  mln_render_session session, mln_buffer_view source_id,
  mln_buffer_view feature MLN_BINDING("encoding=json"),
  mln_buffer_view extension, mln_buffer_view extension_field,
  const mln_buffer_view* arguments MLN_BINDING("encoding=json;nullable=true"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_QUERY_H