1
mirror of https://github.com/neovim/neovim.git synced 2024-12-31 17:13:26 -07:00
Vim-fork focused on extensibility and usability
Go to file
bfredl 5970157e1d refactor(map): enhanced implementation, Clean Code™, etc etc
This involves two redesigns of the map.c implementations:

1. Change of macro style and code organization

The old khash.h and map.c implementation used huge #define blocks with a
lot of backslash line continuations.

This instead uses the "implementation file" .c.h pattern. Such a file is
meant to be included multiple times, with different macros set prior to
inclusion as parameters. we already use this pattern e.g. for
eval/typval_encode.c.h to implement different typval encoders reusing a
similar structure.

We can structure this code into two parts. one that only depends on key
type and is enough to implement sets, and one which depends on both key
and value to implement maps (as a wrapper around sets, with an added
value[] array)

2. Separate the main hash buckets from the key / value arrays

Change the hack buckets to only contain an index into separate key /
value arrays
This is a common pattern in modern, state of the art hashmap
implementations. Even though this leads to one more allocated array, it
is this often is a net reduction of memory consumption. Consider
key+value consuming at least 12 bytes per pair. On average, we will have
twice as many buckets per item.
Thus old implementation:

  2*12 = 24 bytes per item

New implementation

  1*12 + 2*4 = 20 bytes per item

And the difference gets bigger with larger items.
One might think we have pulled a fast one here, as wouldn't the average size of
the new key/value arrays be 1.5 slots per items due to amortized grows?
But remember, these arrays are fully dense, and thus the accessed memory,
measured in _cache lines_, the unit which actually matters, will be the
fully used memory but just rounded up to the nearest cache line
boundary.

This has some other interesting properties, such as an insert-only
set/map will be fully ordered by insert only. Preserving this ordering
in face of deletions is more tricky tho. As we currently don't use
ordered maps, the "delete" operation maintains compactness of the item
arrays in the simplest way by breaking the ordering. It would be
possible to implement an order-preserving delete although at some cost,
like allowing the items array to become non-dense until the next rehash.

Finally, in face of these two major changes, all code used in khash.h
has been integrated into map.c and friends. Given the heavy edits it
makes no sense to "layer" the code into a vendored and a wrapper part.
Rather, the layered cake follows the specialization depth: code shared
for all maps, code specialized to a key type (and its equivalence
relation), and finally code specialized to value+key type.
2023-09-08 12:48:46 +02:00
.github ci: bump actions/checkout from 3 to 4 2023-09-04 23:20:30 +02:00
cmake refactor(build): derocksify luacheck 2023-09-07 15:26:30 +02:00
cmake.config build: remove LOG_LIST_ACTIONS option and related code 2023-05-28 16:34:47 +02:00
cmake.deps build: bump lpeg to 1.1.0 () 2023-09-04 22:42:47 +02:00
cmake.packaging build!: remove neovim qt 2023-06-06 19:19:00 +02:00
contrib feat: add .luarc.json () 2023-08-07 16:27:53 +01:00
runtime feat(lsp): add original LSP Location as item's user_data in locations_to_items () 2023-09-07 10:12:02 +02:00
scripts build(vim-patch.sh): don't use control chars in command () 2023-09-08 07:51:53 +08:00
src refactor(map): enhanced implementation, Clean Code™, etc etc 2023-09-08 12:48:46 +02:00
test refactor(map): enhanced implementation, Clean Code™, etc etc 2023-09-08 12:48:46 +02:00
.cirrus.yml ci: move external_deps job from cirrus-ci back to github actions 2023-09-03 12:06:32 +02:00
.clang-format build: align .clang-format rules with uncrustify config 2023-05-28 15:39:43 +02:00
.clang-tidy build: treat clang-tidy warnings as errors () 2023-02-12 17:41:54 +01:00
.clangd Adding clangd language serever config file to point to build/ directory for compile_commands.json 2021-06-28 11:03:09 -04:00
.editorconfig build(editorconfig): set indent_size to 4 for python files () 2022-11-21 06:53:29 -07:00
.git-blame-ignore-revs docs: .git-blame-ignore-revs () 2022-10-27 20:31:09 +02:00
.gitattributes docs(options): take ownership of options.txt () 2023-08-04 21:26:53 +01:00
.gitignore feat: add .luarc.json () 2023-08-07 16:27:53 +01:00
.luacheckrc feat(lua-types): types for vim.api.* () 2023-08-01 14:20:44 +01:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.luarc.json fix(luarc.json): ignore test directory to save memory 2023-08-23 14:25:36 +01:00
.mailmap docs: update .mailmap () 2022-09-06 08:57:03 +02:00
.stylua.toml refactor(lua): reformat with stylua 0.14.0 () 2022-07-07 18:27:18 +02:00
.styluaignore docs(options): take ownership of options.txt () 2023-08-04 21:26:53 +01:00
BACKERS.md Update backer URL 2015-11-11 19:50:33 -08:00
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
CMakeLists.txt refactor(build): derocksify luacheck 2023-09-07 15:26:30 +02:00
CMakePresets.json build: add "ci" configure preset to reduce verbosity 2023-04-23 17:12:46 +02:00
CONTRIBUTING.md build: fix "make iwyu" not working () 2023-08-26 17:20:40 +08:00
LICENSE.txt vim-patch:e978b4534a5e () 2023-08-13 13:25:10 +01:00
MAINTAIN.md docs(MAINTAIN): update deprecation policy () 2023-08-09 16:49:52 +01:00
Makefile build: fix "make iwyu" not working () 2023-08-26 17:20:40 +08:00
README.md fix(messages): use "Vimscript" instead of "VimL" 2023-06-22 04:09:14 -07:00

Neovim

Documentation | Chat

Coverity Scan analysis Clang analysis PVS-Studio analysis Packages Debian CI Downloads

Neovim is a project that seeks to aggressively refactor Vim in order to:

See the Introduction wiki page and Roadmap for more information.

Features

See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!

Install from package

Pre-built packages for Windows, macOS, and Linux are found on the Releases page.

Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!

Install from source

See the Building Neovim wiki page and supported platforms for details.

The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install

CMake hints for inspecting the build:

  • cmake --build build --target help lists all build targets.
  • build/CMakeCache.txt (or cmake -LAH build/) contains the resolved values of all CMake variables.
  • build/compile_commands.json shows the full compiler invocations for each translation unit.

Transitioning from Vim

See :help nvim-from-vim for instructions.

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

License

Neovim contributions since b17d96 are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the vim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you are
encouraged to make a donation for needy children in Uganda.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        https://iccf-holland.org/
        https://www.vim.org/iccf/
        https://www.iccf.nl/

You can also sponsor the development of Vim.  Vim sponsors can vote for
features.  The money goes to Uganda anyway.