callback_adapter.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_CALLBACK_ADAPTER_H
#define MAPLIBRE_NATIVE_C_CALLBACK_ADAPTER_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "maplibre_native_c/base.h"     // IWYU pragma: export
#include "maplibre_native_c/runtime.h"  // IWYU pragma: export
#include "maplibre_native_c/style.h"    // IWYU pragma: export
 
#ifdef __cplusplus
extern "C" {
#endif
 
// NOLINTBEGIN(modernize-use-using,modernize-use-trailing-return-type)

#define MLN_ADAPTER_RESOURCE_KIND_ANY UINT32_MAX
 
// This block uses line comments because its examples contain URL patterns that
// a block comment cannot carry.

typedef enum mln_adapter_url_match_flags : uint32_t {
  MLN_ADAPTER_URL_MATCH_FLAGS_NONE = 0U,
  MLN_ADAPTER_URL_MATCH_GLOB = 1U << 0U,
} mln_adapter_url_match_flags;

typedef struct mln_adapter_resource_rewrite_rule {
  uint32_t kind;
  uint32_t flags;
  const char* url;
  const char* replacement_url;
} mln_adapter_resource_rewrite_rule;

typedef struct mln_adapter_resource_rewrite_rules {
  const mln_adapter_resource_rewrite_rule* rules;
  size_t count;
} mln_adapter_resource_rewrite_rules;

typedef struct mln_adapter_http_header {
  const char* name;
  const char* value;
} mln_adapter_http_header;

typedef struct mln_adapter_http_header_transform_rule {
  uint32_t kind;
  uint32_t flags;
  const char* url;
  const mln_adapter_http_header* headers;
  size_t header_count;
} mln_adapter_http_header_transform_rule;

typedef struct mln_adapter_http_header_transform_rules {
  const mln_adapter_http_header_transform_rule* rules;
  size_t count;
} mln_adapter_http_header_transform_rules;

typedef struct mln_adapter_resource_provider_rule {
  uint32_t kind;
  uint32_t flags;
  const char* requested_url;
  mln_resource_response response;
} mln_adapter_resource_provider_rule;

typedef struct mln_adapter_resource_provider_rules {
  const mln_adapter_resource_provider_rule* rules;
  size_t count;
} mln_adapter_resource_provider_rules;

typedef enum mln_adapter_resource_route_flags : uint32_t {
  MLN_ADAPTER_RESOURCE_ROUTE_FLAGS_NONE = 0U,
  MLN_ADAPTER_RESOURCE_ROUTE_MATCH_GLOB = 1U << 0U,
  MLN_ADAPTER_RESOURCE_ROUTE_USE_REQUESTED_URL = 1U << 1U,
} mln_adapter_resource_route_flags;

typedef struct mln_adapter_queued_resource_provider_route {
  uint32_t kind;
  uint32_t flags;
  const char* url;
} mln_adapter_queued_resource_provider_route;

typedef void (*mln_adapter_queued_resource_request_listener)(void* request);

typedef struct mln_adapter_queued_resource_provider {
  const mln_adapter_queued_resource_provider_route* routes;
  size_t route_count;
  mln_adapter_queued_resource_request_listener listener;
} mln_adapter_queued_resource_provider;

typedef struct mln_adapter_queued_resource_request {
  void* owner;
  mln_resource_request_handle handle;
  const char* requested_url;
  const char* resolved_url;
  uint32_t kind;
  uint32_t loading_method;
  uint32_t priority;
  uint32_t usage;
  uint32_t storage_policy;
  bool has_range;
  uint64_t range_start;
  uint64_t range_end;
  bool has_prior_modified;
  int64_t prior_modified_unix_ms;
  bool has_prior_expires;
  int64_t prior_expires_unix_ms;
  const char* prior_etag;
  const uint8_t* prior_data;
  size_t prior_data_size;
} mln_adapter_queued_resource_request;

typedef void (*mln_adapter_log_record_listener)(void* record);

typedef struct mln_adapter_log_callback_state {
  mln_adapter_log_record_listener listener;
  uint32_t consume;
} mln_adapter_log_callback_state;

typedef struct mln_adapter_log_record {
  void* owner;
  bool retire_callback;
  uint32_t severity;
  uint32_t event;
  int64_t code;
  const char* message;
} mln_adapter_log_record;

MLN_API void* mln_adapter_handle_leak_token_create(
  const char* type_name, uint64_t handle
) MLN_NOEXCEPT;

MLN_API void mln_adapter_handle_leak_token_destroy(void* token) MLN_NOEXCEPT;

MLN_API void mln_adapter_handle_leak_report(void* token) MLN_NOEXCEPT;

MLN_API uint32_t mln_adapter_log_callback(
  void* user_data, uint32_t severity, uint32_t event, int64_t code,
  const char* message
) MLN_NOEXCEPT;

MLN_API mln_status mln_adapter_log_set_callback(
  mln_adapter_log_callback_state* state
) MLN_NOEXCEPT;

MLN_API void mln_adapter_log_record_destroy(void* record) MLN_NOEXCEPT;

MLN_API mln_status mln_adapter_resource_transform_rewrite_callback(
  void* user_data, uint32_t kind, const char* url,
  mln_resource_transform_response* out_response
) MLN_NOEXCEPT;

MLN_API mln_status mln_adapter_http_header_transform_callback(
  void* user_data, uint32_t kind, const char* url,
  mln_http_header_transform_response* out_response
) MLN_NOEXCEPT;

MLN_API mln_status mln_adapter_http_header_validate(
  const char* name, const char* value
) MLN_NOEXCEPT;

MLN_API uint32_t mln_adapter_resource_provider_rules_callback(
  void* user_data, const mln_resource_request* request,
  mln_resource_request_handle handle
) MLN_NOEXCEPT;

MLN_API uint32_t mln_adapter_queued_resource_provider_callback(
  void* user_data, const mln_resource_request* request,
  mln_resource_request_handle handle
) MLN_NOEXCEPT;

MLN_API void mln_adapter_resource_provider_request_destroy(
  void* request
) MLN_NOEXCEPT;

MLN_API void mln_adapter_queued_resource_provider_retire(
  mln_adapter_queued_resource_provider* provider
) MLN_NOEXCEPT;

MLN_API void mln_adapter_custom_geometry_callbacks_retire(
  mln_custom_geometry_source_tile_callback fetch_tile,
  mln_custom_geometry_source_tile_callback cancel_tile, void* user_data
) MLN_NOEXCEPT;

MLN_API void mln_adapter_custom_mvt_vector_callbacks_retire(
  mln_custom_mvt_vector_source_tile_callback fetch_tile,
  mln_custom_mvt_vector_source_tile_callback cancel_tile, void* user_data
) MLN_NOEXCEPT;
 
// NOLINTEND(modernize-use-using,modernize-use-trailing-return-type)
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_CALLBACK_ADAPTER_H