From e3912a4b3ac2c202d89face3fef3d41eb1d7fcd6 Mon Sep 17 00:00:00 2001
From: Songchen Tan <i@tansongchen.com>
Date: Fri, 20 Dec 2024 21:01:52 -0500
Subject: [PATCH] Add type definitions (#379)

---
 contrib/librime.lua | 717 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 717 insertions(+)
 create mode 100644 contrib/librime.lua

diff --git a/contrib/librime.lua b/contrib/librime.lua
new file mode 100644
index 0000000..9f784af
--- /dev/null
+++ b/contrib/librime.lua
@@ -0,0 +1,717 @@
+-- Last Change: 2024-12-15
+---@meta rime
+
+--- 全局对象
+
+---@class RimeAPI
+---@field get_rime_version fun(): string
+---@field get_shared_data_dir fun(): string
+---@field get_user_data_dir fun(): string
+---@field get_sync_dir fun(): string
+---@field get_distribution_name fun(): string
+---@field get_distribution_code_name fun(): string
+---@field get_distribution_version fun(): string
+---@field get_user_id fun(): string
+---@field regex_match fun(input: string, pattern: string): boolean
+---@field regex_search fun(input: string, pattern: string): string[] | nil
+---@field regex_replace fun(input: string, pattern: string, fmt: string): string
+rime_api = {}
+
+---@class Log
+---@field info fun(string)
+---@field warning fun(string)
+---@field error fun(string)
+log = {}
+
+---@param cand Candidate
+function yield(cand) end
+
+--- 常量
+
+---@enum ConfigType
+config_types = {
+  kNull = "kNull",
+  kScalar = "kScalar",
+  kList = "kList",
+  kMap = "kMap",
+}
+
+---@enum SegmentType
+segment_types = {
+  kVoid = "kVoid",
+  kGuess = "kGuess",
+  kSelected = "kSelected",
+  kConfirmed = "kConfirmed",
+}
+
+---@enum CandidateDynamicType
+candidate_dynamic_types = {
+  kSentence = "Sentence",
+  kPhrase = "Phrase",
+  kSimple = "Simple",
+  kShadow = "Shadow",
+  kUniquified = "Uniquified",
+  kOther = "Other",
+}
+
+---@enum ProcessResult
+process_results = {
+  kRejected = 0,
+  kAccepted = 1,
+  kNoop = 2,
+}
+
+---@enum ModifierMask
+modifier_masks = {
+  kShift = 0x1,
+  kLock = 0x2,
+  kControl = 0x4,
+  kAlt = 0x8,
+}
+
+--- 工具
+
+---@class Set
+---@field empty fun(self: self): boolean
+---@field __index function
+---@field __add function
+---@field __sub function
+---@field __mul function
+---@field __set function
+
+---@param values any[]
+---@return Set
+function Set(values) end
+
+--- 对象接口及构造函数
+
+---@class Env
+---@field engine Engine
+---@field name_space string
+
+---@class Engine
+---@field schema Schema
+---@field context Context
+---@field active_engine Engine
+---@field process_key fun(self: self, key_event: KeyEvent): boolean
+---@field compose fun(self: self, ctx: Context)
+---@field commit_text fun(self: self, text: string)
+---@field apply_schema fun(self: self, schema: Schema)
+
+---@class Context
+---@field composition Composition
+---@field input string
+---@field caret_pos integer
+---@field commit_notifier Notifier
+---@field select_notifier Notifier
+---@field update_notifier Notifier
+---@field delete_notifier Notifier
+---@field option_update_notifier OptionUpdateNotifier
+---@field property_update_notifier PropertyUpdateNotifier
+---@field unhandled_key_notifier KeyEventNotifier
+---@field commit_history CommitHistory
+---@field commit fun(self: self)
+---@field get_commit_text fun(self: self): string
+---@field get_script_text fun(self: self): string
+---@field get_preedit fun(self: self): Preedit
+---@field is_composing fun(self: self): boolean
+---@field has_menu fun(self: self): boolean
+---@field get_selected_candidate fun(self: self): Candidate
+---@field push_input fun(self: self, text: string)
+---@field pop_input fun(self: self, len: integer): boolean
+---@field delete_input fun(self: self, len: integer): boolean
+---@field clear fun(self: self)
+---@field select fun(self: self, index: integer): boolean
+---@field confirm_current_selection fun(self: self): boolean
+---@field delete_current_selection fun(self: self): boolean
+---@field confirm_previous_selection fun(self: self): boolean
+---@field reopen_previous_selection fun(self: self): boolean
+---@field clear_previous_segment fun(self: self): boolean
+---@field reopen_previous_segment fun(self: self): boolean
+---@field clear_non_confirmed_composition fun(self: self): boolean
+---@field refresh_non_confirmed_composition fun(self: self): boolean
+---@field set_option fun(self: self, name: string, value: boolean)
+---@field get_option fun(self: self, name: string): boolean
+---@field set_property fun(self: self, key: string, value: string)
+---@field get_property fun(self: self, key: string): string
+---@field clear_transient_options fun(self: self)
+
+---@class Preedit
+---@field text string
+---@field caret_pos integer
+---@field sel_start integer
+---@field sel_end integer
+
+---@class Composition
+---@field empty fun(self: self): boolean
+---@field back fun(self: self): Segment
+---@field pop_back fun(self: self)
+---@field push_back fun(self: self)
+---@field has_finished_composition fun(self: self): boolean
+---@field get_prompt fun(self: self): string
+---@field toSegmentation fun(self: self): Segmentation
+---@field spans fun(self: self): Spans
+
+---@class Segmentation
+---@field input string
+---@field size integer
+---@field empty fun(self: self): boolean
+---@field back fun(self: self): Segment | nil
+---@field pop_back fun(self: self)
+---@field reset_length fun(self: self, length: integer)
+---@field add_segment fun(self: self, seg: Segment): boolean
+---@field forward fun(self: self): boolean
+---@field trim fun(self: self): boolean
+---@field has_finished_segmentation fun(self: self): boolean
+---@field get_current_start_position fun(self: self): integer
+---@field get_current_end_position fun(self: self): integer
+---@field get_current_segment_length fun(self: self): integer
+---@field get_confirmed_position fun(self: self): integer
+---@field get_segments fun(self: self): Segment[]
+---@field get_at fun(self: self, index: integer): Segment
+
+---@class Segment
+---@field status SegmentType
+---@field start integer
+---@field _start integer
+---@field _end integer
+---@field length integer
+---@field tags Set
+---@field menu Menu
+---@field selected_index integer
+---@field prompt string
+---@field clear fun(self: self)
+---@field close fun(self: self)
+---@field reopen fun(self: self, caret_pos: integer)
+---@field has_tag fun(self: self, tag: string): boolean
+---@field get_candidate_at fun(self: self, index: integer): Candidate
+---@field get_selected_candidate fun(self: self): Candidate
+---@field active_text fun(self: self, text: string): string
+---@field spans fun(self: self): Spans
+
+---@param start_pos integer
+---@param end_pos integer
+---@return Segment
+function Segment(start_pos, end_pos) end
+
+---@class Spans
+---@field _start integer
+---@field _end integer
+---@field count integer
+---@field vertices integer[]
+---@field add_span fun(self: self, start: integer, end: integer)
+---@field add_spans fun(self: self, spans: Spans)
+---@field add_vertex fun(self: self, vertex: integer)
+---@field previous_stop fun(self: self, caret_pos: integer): integer
+---@field next_stop fun(self: self, caret_pos: integer): integer
+---@field has_vertex fun(self: self, vertex: integer): boolean
+---@field count_between fun(self: self, start: integer, end: integer): integer
+---@field clear fun(self: self)
+
+---@return Spans
+function Spans() end
+
+---@class Schema
+---@field schema_id string
+---@field schema_name string
+---@field config Config
+---@field page_size integer
+---@field select_keys string
+
+---@param schema_id string
+---@return Schema
+function Schema(schema_id) end
+
+---@class Config
+---@field load_from_file fun(self: self, filename: string): boolean
+---@field save_to_file fun(self: self, filename: string): boolean
+---@field is_null fun(self: self, conf_path: string): boolean
+---@field is_value fun(self: self, conf_path: string): boolean
+---@field is_list fun(self: self, conf_path: string): boolean
+---@field is_map fun(self: self, conf_path: string): boolean
+---@field get_bool fun(self: self, conf_path: string): boolean|nil
+---@field set_bool fun(self: self, conf_path: string, b: boolean): boolean
+---@field get_int fun(self: self, conf_path: string): integer|nil
+---@field set_int fun(self: self, conf_path: string, i: integer): boolean
+---@field get_double fun(self: self, conf_path: string): number|nil
+---@field set_double fun(self: self, conf_path: string, f: number): boolean
+---@field get_string fun(self: self, conf_path: string): string|nil
+---@field set_string fun(self: self, conf_path: string, s: string): boolean
+---@field get_item fun(self: self, conf_path: string): ConfigItem|nil
+---@field set_item fun(self: self, conf_path: string, item: ConfigItem): boolean
+---@field get_value fun(self: self, conf_path: string): ConfigValue|nil
+---@field set_value fun(self: self, conf_path: string, value: ConfigValue): boolean
+---@field get_list fun(self: self, conf_path: string): ConfigList|nil
+---@field set_list fun(self: self, conf_path: string, list: ConfigList): boolean
+---@field get_map fun(self: self, conf_path: string): ConfigMap|nil
+---@field set_map fun(self: self, conf_path: string, map: ConfigMap): boolean
+---@field get_list_size fun(self: self, conf_path: string): integer|nil
+
+---@class ConfigMap
+---@field type ConfigType
+---@field size integer
+---@field element ConfigItem
+---@field empty fun(self: self): boolean
+---@field has_key fun(self: self, key: string): boolean
+---@field keys fun(self: self): string[]
+---@field get fun(self: self, key: string): ConfigItem|nil
+---@field get_value fun(self: self, key: string): ConfigValue|nil
+---@field set fun(self: self, key: string, item: ConfigItem)
+---@field clear fun(self: self)
+
+---@return ConfigMap
+function ConfigMap() end
+
+---@class ConfigList
+---@field type ConfigType
+---@field size integer
+---@field element ConfigItem
+---@field get_at fun(self: self, index: integer): ConfigItem|nil
+---@field get_value_at fun(self: self, index: integer): ConfigValue|nil
+---@field set_at fun(self: self, index: integer, item: ConfigItem): boolean
+---@field append fun(self: self, item: ConfigItem): boolean
+---@field insert fun(self: self, i: integer, item: ConfigItem): boolean
+---@field clear fun(self: self): boolean
+---@field empty fun(self: self): boolean
+---@field resize fun(self: self, size: integer): boolean
+
+---@return ConfigList
+function ConfigList() end
+
+---@class ConfigValue
+---@field type ConfigType
+---@field value string
+---@field element ConfigItem
+---@field get_bool fun(self: self): boolean|nil
+---@field get_int fun(self: self): integer|nil
+---@field get_double fun(self: self): number|nil
+---@field get_string fun(self: self): string|nil
+---@field set_bool fun(self: self, b: boolean)
+---@field set_int fun(self: self, i: integer)
+---@field set_double fun(self: self, f: number)
+---@field set_string fun(self: self, s: string)
+
+---@param value string | boolean
+---@return ConfigValue
+function ConfigValue(value) end
+
+---@class ConfigItem
+---@field type ConfigType
+---@field empty boolean
+---@field get_value fun(self: self): ConfigValue|nil
+---@field get_map fun(self: self): ConfigMap|nil
+---@field get_list fun(self: self): ConfigList|nil
+---@field get_obj fun(self: self): ConfigMap|ConfigList|ConfigValue|nil
+
+---@class KeyEvent
+---@field keycode integer
+---@field modifier integer
+---@field shift fun(self: self): boolean
+---@field ctrl fun(self: self): boolean
+---@field alt fun(self: self): boolean
+---@field caps fun(self: self): boolean
+---@field super fun(self: self): boolean
+---@field release fun(self: self): boolean
+---@field repr fun(self: self): string
+---@field eq fun(self: self, key: KeyEvent): boolean
+---@field lt fun(self: self, key: KeyEvent): boolean
+
+---@param repr string
+---@return KeyEvent
+function KeyEvent(repr) end
+
+---@param keycode integer
+---@param modifier integer
+---@return KeyEvent
+function KeyEvent(keycode, modifier) end
+
+---@class KeySequence
+---@field parse fun(self: self, repr: string): boolean
+---@field repr fun(self: self): string
+---@field toKeyEvent fun(self: self): KeyEvent[]
+
+---@param repr string?
+---@return KeySequence
+function KeySequence(repr) end
+
+---@class Candidate
+---@field type string
+---@field start integer
+---@field _start integer
+---@field _end integer
+---@field quality number
+---@field text string
+---@field comment string
+---@field preedit string
+---@field get_dynamic_type fun(self: self): CandidateDynamicType
+---@field get_genuine fun(self: self): Candidate
+---@field get_genuines fun(self: self): Candidate[]
+---@field to_shadow_candidate fun(self: self, type: string?, text: string?, comment: string?, inherit_comment: boolean?): ShadowCandidate
+---@field to_uniquified_candidate fun(self: self, type: string?, text: string?, comment: string?): UniquifiedCandidate
+---@field to_phrase fun(self: self): Phrase
+---@field to_sentence fun(self: self): Sentence
+---@field append fun(self: self, cand: Candidate)
+---@field spans fun(self: self): Spans
+
+---@param type string
+---@param start integer
+---@param _end integer
+---@param text string
+---@param comment string
+---@return Candidate
+function Candidate(type, start, _end, text, comment) end
+
+---@class UniquifiedCandidate: Candidate
+
+---@param candidate Candidate
+---@param type string?
+---@param text string?
+---@param comment string?
+function UniquifiedCandidate(candidate, type, text, comment) end
+
+---@class ShadowCandidate: Candidate
+
+---@param candidate Candidate
+---@param type string?
+---@param text string?
+---@param comment string?
+---@param inherit_comment boolean?
+---@return ShadowCandidate
+function ShadowCandidate(candidate, type, text, comment, inherit_comment) end
+
+---@class Phrase
+-----@field language Language 暂时不支持
+---@field lang_name string
+---@field type string
+---@field start integer
+---@field _start integer
+---@field _end integer
+---@field quality number
+---@field text string
+---@field comment string
+---@field preedit string
+---@field weight number
+---@field code Code
+---@field entry DictEntry
+---@field toCandidate fun(self: self): Candidate
+---@field spans fun(self: self): Spans
+
+---@param memory Memory
+---@param type string
+---@param start integer
+---@param _end integer
+---@param entry DictEntry
+---@return Phrase
+function Phrase(memory, type, start, _end, entry) end
+
+---@class Sentence
+-----@field language Language 暂时不支持
+---@field lang_name string
+---@field type string
+---@field start integer
+---@field _start integer
+---@field _end integer
+---@field quality number
+---@field text string
+---@field comment string
+---@field preedit string
+---@field weight number
+---@field code Code
+---@field entry DictEntry
+---@field word_lengths integer[]
+---@field entrys DictEntry[]
+---@field entrys_size integer
+---@field entrys_empty boolean
+---@field toCandidate fun(self: self): Candidate
+
+---@class Menu
+---@field add_translation fun(self: self, translation: Translation)
+---@field prepare fun(self: self, candidate_count: integer): integer
+---@field get_candidate_at fun(self: self, i: integer): Candidate|nil
+---@field candidate_count fun(self: self): integer
+---@field empty fun(self: self): boolean
+
+---@return Menu
+function Menu() end
+
+---@class Opencc
+---@field convert fun(self: self, text: string): string
+---@field convert_text fun(self: self, text: string): string
+---@field random_convert_text fun(self: self, text: string): string
+---@field convert_word fun(self: self, text: string): string[]
+
+---@param filename string
+---@return Opencc
+function Opencc(filename) end
+
+---@class Dictionary
+---@field name string
+---@field loaded boolean
+---@field lookup_words fun(self: self, code: string, predictive: boolean, limit: integer): boolean
+---@field decode fun(self: self, code: Code): string[]
+
+---@class DictEntryIterator
+---@field exhausted boolean
+---@field size integer
+---@field iter fun(self: self): fun(): DictEntry|nil
+
+---@class UserDictionary
+---@field name string
+---@field loaded boolean
+---@field tick integer
+---@field lookup_words fun(self: self, code: string, predictive: boolean, limit: integer): boolean
+---@field update_entry fun(self: self, entry: DictEntry, commits: integer, prefix: string, lang_name: string): boolean
+
+---@class UserDictEntryIterator
+---@field exhausted boolean
+---@field size integer
+---@field iter fun(self: self): fun(): DictEntry|nil
+
+---@class ReverseDb
+---@field lookup fun(self: self, key: string): string
+
+---@param file_name string
+---@return ReverseDb
+function ReverseDb(file_name) end
+
+---@class ReverseLookup
+---@field lookup fun(self: self, key: string): string
+---@field lookup_stems fun(self: self, key: string): string
+
+---@param dict_name string
+---@return ReverseLookup
+function ReverseLookup(dict_name) end
+
+---@class DictEntry
+---@field text string
+---@field comment string
+---@field preedit string
+---@field weight number
+---@field commit_count integer `2`
+---@field custom_code string "hao", "ni hao"
+---@field remaining_code_length integer "~ao"
+---@field code Code
+
+---@return DictEntry
+function DictEntry() end
+
+---@class CommitEntry: DictEntry
+---@field get fun(self: self): DictEntry[]
+---@field update_entry fun(self: self, entry: DictEntry, commit: integer, prefix: string): boolean
+---@field update fun(self: self, commit: integer): boolean
+
+---@class Code
+---@field push fun(self: self, syllable_id: integer)
+---@field print fun(self: self): string
+
+---@return Code
+function Code() end
+
+---@class Translation
+---@field exhausted boolean
+---@field iter fun(self: self): fun(): Candidate|nil
+
+function Translation() end
+
+---@class Memory
+---@field lang_name string
+---@field dict Dictionary
+---@field user_dict UserDictionary
+---@field start_session fun(self: self): boolean
+---@field finish_session fun(self: self): boolean
+---@field discard_session fun(self: self): boolean
+---@field dict_lookup fun(self: self, input: string, predictive: boolean, limit: integer): boolean
+---@field user_lookup fun(self: self, input: string, predictive: boolean): boolean
+---@field dictiter_lookup fun(self: self, input: string, predictive: boolean, limit: integer): DictEntryIterator
+---@field useriter_lookup fun(self: self, input: string, predictive: boolean): UserDictEntryIterator
+---@field memorize fun(self: self, callback: fun(ce: CommitEntry))
+---@field decode fun(self: self, code: Code): string[]
+---@field iter_dict fun(self: self): fun(): DictEntry|nil
+---@field iter_user fun(self: self): fun(): DictEntry|nil
+---@field update_userdict fun(self: self, entry: DictEntry, commits: integer, prefix: string): boolean
+---@field update_entry fun(self: self, entry: DictEntry, commits: integer, prefix: string, lang_name?: string): boolean
+---@field update_candidate fun(self: self, candidate: Candidate, commits: integer): boolean
+---@field disconnect fun(self: self)
+
+---@param engine Engine
+---@param schema Schema
+---@param namespace string?
+---@return Memory
+function Memory(engine, schema, namespace) end
+
+---@class Projection
+---@field load fun(self: self, rules: ConfigList): boolean
+---@field apply fun(self: self, str: string, ret_org_str?: boolean): string
+
+---@return Projection
+function Projection() end
+
+---@class Component
+---@field Processor fun(engine: Engine, namespace: string, klass: string): Processor
+---@field Translator fun(engine: Engine, namespace: string, klass: string): Translator
+---@field Segmentor fun(engine: Engine, namespace: string, klass: string): Segmentor
+---@field Filter fun(engine: Engine, namespace: string, klass: string): Filter
+---@field ScriptTranslator fun(engine: Engine, namespace: string, klass: string): ScriptTranslator
+---@field TableTranslator fun(engine: Engine, namespace: string, klass: string): TableTranslator
+Component = {}
+
+---@class Processor
+---@field name_space string
+---@field process_key_event fun(self: self, key_event: KeyEvent): ProcessResult
+
+---@class Segmentor
+---@field name_space string
+---@field proceed fun(self: self, segmentation: Segmentation): boolean
+
+---@class Translator
+---@field name_space string
+---@field query fun(self: self, input: string, segment: Segment): Translation
+
+---@class ScriptTranslator
+---@field name_space string
+---@field lang_name string
+---@field memorize_callback fun(ce: CommitEntry)
+---@field max_homophones integer
+---@field spelling_hints integer
+---@field always_show_comments boolean
+---@field enable_correction boolean
+---@field delimiters string
+---@field tag string
+---@field enable_completion boolean
+---@field contextual_suggestions boolean
+---@field strict_spelling boolean
+---@field initial_quality number
+---@field preedit_formatter Projection
+---@field comment_formatter Projection
+---@field dict Dictionary
+---@field user_dict UserDictionary
+---@field translator Translator
+---@field query fun(self: self, input: string, segment: Segment): Translation
+---@field start_session fun(self: self): boolean
+---@field finish_session fun(self: self): boolean
+---@field discard_session fun(self: self): boolean
+---@field memorize fun(self: self, callback: fun(ce: CommitEntry))
+---@field update_entry fun(self: self, entry: DictEntry, commits: integer, prefix: string): boolean
+---@field reload_user_dict_disabling_patterns fun(self: self, config_list: ConfigList): boolean
+---@field set_memorize_callback fun(self: self, callback: fun(ce: CommitEntry))
+---@field disconnect fun(self: self)
+
+---@class TableTranslator
+---@field name_space string
+---@field lang_name string
+---@field memorize_callback fun(ce: CommitEntry)
+---@field enable_charset_filter boolean
+---@field enable_encoder boolean
+---@field enable_sentence boolean
+---@field sentence_over_completion boolean
+---@field encode_commit_history boolean
+---@field max_phrase_length integer
+---@field max_homographs integer
+---@field delimiters string
+---@field tag string
+---@field enable_completion boolean
+---@field contextual_suggestions boolean
+---@field strict_spelling boolean
+---@field initial_quality number
+---@field preedit_formatter Projection
+---@field comment_formatter Projection
+---@field dict Dictionary
+---@field user_dict UserDictionary
+---@field translator Translator
+---@field query fun(self: self, input: string, segment: Segment): Translation
+---@field start_session fun(self: self): boolean
+---@field finish_session fun(self: self): boolean
+---@field discard_session fun(self: self): boolean
+---@field memorize fun(self: self, callback: fun(ce: CommitEntry))
+---@field update_entry fun(self: self, entry: DictEntry, commits: integer, prefix: string): boolean
+---@field reload_user_dict_disabling_patterns fun(self: self, config_list: ConfigList): boolean
+---@field set_memorize_callback fun(self: self, callback: fun(ce: CommitEntry))
+---@field disconnect fun(self: self)
+
+---@class Filter
+---@field name_space string
+---@field apply fun(self: self, translation: Translation): Translation
+
+---@class Notifier
+---@field connect fun(self: self, f: fun(ctx: Context), group: integer|nil): Connection
+
+---@class OptionUpdateNotifier: Notifier
+---@field connect fun(self: self, f: fun(ctx: Context, name: string), group:integer|nil): function[]
+
+---@class PropertyUpdateNotifier: Notifier
+---@field connect fun(self: self, f: fun(ctx: Context, name: string), group:integer|nil): function[]
+
+---@class KeyEventNotifier: Notifier
+---@field connect fun(self: self, f: fun(ctx: Context, key: string), group:integer|nil): function[]
+
+---@class Connection
+---@field disconnect fun(self: self)
+
+---@class Switcher
+---@field attached_engine Engine
+---@field user_config Config
+---@field active boolean
+---@field process_key fun(self: self, key_event: KeyEvent): boolean
+---@field select_next_schema fun(self: self)
+---@field is_auto_save fun(self: self, option: string): boolean
+---@field refresh_menu fun(self: self)
+---@field activate fun(self: self)
+---@field deactivate fun(self: self)
+
+---@param engine Engine
+---@return Switcher
+function Switcher(engine) end
+
+---@class CommitRecord
+---@field text string
+---@field type string
+
+---@class CommitHistory
+---@field size integer
+---@field push fun(self: self, key_event: KeyEvent)
+---@field back fun(self: self): CommitRecord|nil
+---@field to_table fun(self: self): CommitRecord[]
+---@field iter fun(self: self): fun(): (number, CommitRecord)|nil
+---@field latest_text fun(self: self): string
+---@field empty fun(self: self): boolean
+---@field clear fun(self: self)
+---@field pop_back fun(self: self)
+
+---@class DbAccessor
+---@field reset fun(self: self): boolean
+---@field jump fun(self: self, prefix: string): boolean
+---@field iter fun(self: self): fun(): (string, string) | nil
+
+---@class UserDb
+---@field _loaded boolean
+---@field read_only boolean
+---@field disabled boolean
+---@field name string
+---@field file_name string
+---@field open fun(self: self): boolean
+---@field open_read_only fun(self: self): boolean
+---@field close fun(self: self): boolean
+---@field query fun(self: self, prefix: string): DbAccessor
+---@field fetch fun(self: self, key: string): string|nil
+---@field update fun(self: self, key: string, value: string): boolean
+---@field erase fun(self: self, key: string): boolean
+---@field loaded fun(self: self): boolean
+---@field disable fun(self: self): boolean
+---@field enable fun(self: self): boolean
+
+---@param db_name string
+---@param db_class string
+---@return UserDb
+function UserDb(db_name, db_class) end
+
+---@class LevelDb: UserDb
+
+---@param db_name string
+---@return LevelDb
+function LevelDb(db_name) end
+
+---@class TableDb: UserDb
+
+---@param db_name string
+---@return TableDb
+function TableDb(db_name) end