mirror of
https://github.com/neovim/neovim.git
synced 2025-09-08 04:18:18 +00:00
efb0896f21
problem: can we have Serde?
solution: we have Serde at home
This by itself is just a change of notation, that could be quickly
merged to avoid messy merge conflicts, but upcoming changes are planned:
- keysets no longer need to be defined in one single file. `keysets.h` is
just the initial automatic conversion of the previous `keysets.lua`.
keysets just used in a single api/{scope}.h can be moved to that file, later on.
- Typed dicts will have more specific types than Object. this will
enable most of the existing manual typechecking boilerplate to be eliminated.
We will need some annotation for missing value, i e a boolean will
need to be represented as a TriState (none/false/true) in some cases.
- Eventually: optional parameters in form of a `Dict opts` final
parameter will get added in some form to metadata. this will require
a discussion/desicion about type forward compatibility.
134 lines
2.8 KiB
C
134 lines
2.8 KiB
C
#ifndef NVIM_API_PRIVATE_DEFS_H
|
|
#define NVIM_API_PRIVATE_DEFS_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
#include "klib/kvec.h"
|
|
#include "nvim/func_attr.h"
|
|
#include "nvim/types.h"
|
|
|
|
#define ARRAY_DICT_INIT KV_INITIAL_VALUE
|
|
#define STRING_INIT { .data = NULL, .size = 0 }
|
|
#define OBJECT_INIT { .type = kObjectTypeNil }
|
|
#define ERROR_INIT ((Error) { .type = kErrorTypeNone, .msg = NULL })
|
|
#define REMOTE_TYPE(type) typedef handle_T type
|
|
|
|
#define ERROR_SET(e) ((e)->type != kErrorTypeNone)
|
|
|
|
#ifdef INCLUDE_GENERATED_DECLARATIONS
|
|
# define ArrayOf(...) Array
|
|
# define DictionaryOf(...) Dictionary
|
|
# define Dict(name) KeyDict_##name
|
|
#endif
|
|
|
|
// Basic types
|
|
typedef enum {
|
|
kErrorTypeNone = -1,
|
|
kErrorTypeException,
|
|
kErrorTypeValidation,
|
|
} ErrorType;
|
|
|
|
typedef enum {
|
|
kMessageTypeUnknown = -1,
|
|
// Per msgpack-rpc spec.
|
|
kMessageTypeRequest = 0,
|
|
kMessageTypeResponse = 1,
|
|
kMessageTypeNotification = 2,
|
|
kMessageTypeRedrawEvent = 3,
|
|
} MessageType;
|
|
|
|
/// Mask for all internal calls
|
|
#define INTERNAL_CALL_MASK (((uint64_t)1) << (sizeof(uint64_t) * 8 - 1))
|
|
|
|
/// Internal call from VimL code
|
|
#define VIML_INTERNAL_CALL INTERNAL_CALL_MASK
|
|
|
|
/// Internal call from lua code
|
|
#define LUA_INTERNAL_CALL (VIML_INTERNAL_CALL + 1)
|
|
|
|
static inline bool is_internal_call(uint64_t channel_id)
|
|
REAL_FATTR_ALWAYS_INLINE REAL_FATTR_CONST;
|
|
|
|
/// Check whether call is internal
|
|
///
|
|
/// @param[in] channel_id Channel id.
|
|
///
|
|
/// @return true if channel_id refers to internal channel.
|
|
static inline bool is_internal_call(const uint64_t channel_id)
|
|
{
|
|
return !!(channel_id & INTERNAL_CALL_MASK);
|
|
}
|
|
|
|
typedef struct {
|
|
ErrorType type;
|
|
char *msg;
|
|
} Error;
|
|
|
|
typedef bool Boolean;
|
|
typedef int64_t Integer;
|
|
typedef double Float;
|
|
|
|
/// Maximum value of an Integer
|
|
#define API_INTEGER_MAX INT64_MAX
|
|
|
|
/// Minimum value of an Integer
|
|
#define API_INTEGER_MIN INT64_MIN
|
|
|
|
typedef struct {
|
|
char *data;
|
|
size_t size;
|
|
} String;
|
|
|
|
REMOTE_TYPE(Buffer);
|
|
REMOTE_TYPE(Window);
|
|
REMOTE_TYPE(Tabpage);
|
|
|
|
typedef struct object Object;
|
|
typedef kvec_t(Object) Array;
|
|
|
|
typedef struct key_value_pair KeyValuePair;
|
|
typedef kvec_t(KeyValuePair) Dictionary;
|
|
|
|
typedef enum {
|
|
kObjectTypeNil = 0,
|
|
kObjectTypeBoolean,
|
|
kObjectTypeInteger,
|
|
kObjectTypeFloat,
|
|
kObjectTypeString,
|
|
kObjectTypeArray,
|
|
kObjectTypeDictionary,
|
|
kObjectTypeLuaRef,
|
|
// EXT types, cannot be split or reordered, see #EXT_OBJECT_TYPE_SHIFT
|
|
kObjectTypeBuffer,
|
|
kObjectTypeWindow,
|
|
kObjectTypeTabpage,
|
|
} ObjectType;
|
|
|
|
struct object {
|
|
ObjectType type;
|
|
union {
|
|
Boolean boolean;
|
|
Integer integer;
|
|
Float floating;
|
|
String string;
|
|
Array array;
|
|
Dictionary dictionary;
|
|
LuaRef luaref;
|
|
} data;
|
|
};
|
|
|
|
struct key_value_pair {
|
|
String key;
|
|
Object value;
|
|
};
|
|
|
|
typedef Object *(*field_hash)(void *retval, const char *str, size_t len);
|
|
typedef struct {
|
|
char *str;
|
|
size_t ptr_off;
|
|
} KeySetLink;
|
|
|
|
#endif // NVIM_API_PRIVATE_DEFS_H
|