Completer

* completion popup

* egui 0.33

Author: p4ymak

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "egui_code_editor"
 authors = ["Roman Chumak <[email protected]>"]
-version = "0.2.17"
-edition = "2021"
+version = "0.2.18"
+edition = "2024"
 license = "MIT"
 repository = "https://github.com/p4ymak/egui_code_editor"
 description = "egui Code Editor widget with numbered lines and syntax highlighting.."
@@ -11,7 +11,7 @@ categories = ["gui", "text-editors"]
 keywords = ["egui", "GUI", "editor", "syntax", "highlighting"]
 
 [dependencies]
-egui = { version = "0.32", optional = true }
+egui = { version = "0.33", optional = true }
 serde = { version = "1", optional = true}
 
 [lib]
@@ -33,5 +33,5 @@ name = "tui"
 test = true
 
 [dev-dependencies]
-eframe = "0.32"
+eframe = "0.33"
 colorful = "0.3"

README.md

@@ -1,21 +1,36 @@
 # Egui Code Editor
 [![Latest version](https://img.shields.io/crates/v/egui_code_editor.svg)](https://crates.io/crates/egui_code_editor)
 
-Text Editor Widget for [egui](https://github.com/emilk/egui) with numbered lines and simple syntax highlighting based on keywords sets.
+![Completer](screenshots/completer.gif)
+
+Text Editor Widget for [egui](https://github.com/emilk/egui) with numbered lines, simple syntax highlighting based on keywords sets and auto-completion feature.
+
+### Auto-completion
+![Completer](screenshots/completer_demo.gif)
+
+Offers completions from the syntax dictionary and optionally from words previously entered by the user.
+
+*Usage:*
+- UP/DOWN Arrows: Select
+- TAB: Complete
+- ESC: Hide
 
 ## Usage with egui
 
 ```rust
-use egui_code_editor::{CodeEditor, ColorTheme, Syntax};
+use egui_code_editor::{CodeEditor, Completer, ColorTheme, Syntax};
+let syntax = Syntax::rust();
+let mut completer = Completer::new_with_syntax(&syntax).with_user_words();
 
 CodeEditor::default()
   .id_source("code editor")
   .with_rows(12)
   .with_fontsize(14.0)
   .with_theme(ColorTheme::GRUVBOX)
-  .with_syntax(Syntax::rust())
+  .with_syntax(syntax)
   .with_numlines(true)
-  .show(ui, &mut self.code);
+  .show_with_completer(ui, &mut self.code, &mut completer);
+  // .show(ui, &mut self.code); // to use without completer
 ```
 
 ## Usage as lexer without egui

examples/demo.rs

@@ -1,7 +1,7 @@
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
 
-use eframe::{self, egui, CreationContext};
-use egui_code_editor::{self, highlighting::Token, CodeEditor, ColorTheme, Syntax};
+use eframe::{self, CreationContext, egui};
+use egui_code_editor::{self, CodeEditor, ColorTheme, Completer, Syntax, highlighting::Token};
 
 const THEMES: [ColorTheme; 8] = [
     ColorTheme::AYU,
@@ -114,7 +114,7 @@ impl SyntaxDemo {
 
 fn main() -> Result<(), eframe::Error> {
     #[cfg(debug_assertions)]
-    {
+    unsafe {
         std::env::set_var("RUST_BACKTRACE", "1");
     }
 
@@ -143,6 +143,7 @@ struct CodeEditorDemo {
     code: String,
     theme: ColorTheme,
     syntax: Syntax,
+    completer: Completer,
     example: bool,
     shift: isize,
     numlines_only_natural: bool,
@@ -154,6 +155,7 @@ impl CodeEditorDemo {
             code: rust.example.to_string(),
             theme: ColorTheme::GRUVBOX,
             syntax: rust.syntax(),
+            completer: Completer::new_with_syntax(&rust.syntax()).with_user_words(),
             example: true,
             shift: 0,
             numlines_only_natural: false,
@@ -192,6 +194,8 @@ impl eframe::App for CodeEditorDemo {
                         .clicked()
                     {
                         self.syntax = syntax.syntax();
+                        self.completer =
+                            Completer::new_with_syntax(&syntax.syntax()).with_user_words();
                         if self.example {
                             self.code = syntax.example.to_string()
                         }
@@ -206,6 +210,7 @@ impl eframe::App for CodeEditorDemo {
                 h.add(egui::DragValue::new(&mut self.shift));
                 h.checkbox(&mut self.numlines_only_natural, "Only Natural Numbering");
             });
+
             let mut editor = CodeEditor::default()
                 .id_source("code editor")
                 .with_rows(10)
@@ -216,7 +221,7 @@ impl eframe::App for CodeEditorDemo {
                 .with_numlines_shift(self.shift)
                 .with_numlines_only_natural(self.numlines_only_natural)
                 .vscroll(true);
-            editor.show(ui, &mut self.code);
+            editor.show_with_completer(ui, &mut self.code, &mut self.completer);
 
             ui.separator();
 
@@ -225,7 +230,7 @@ impl eframe::App for CodeEditorDemo {
                 .show(ui, |ui| {
                     for token in Token::default().tokens(&self.syntax, &self.code) {
                         ui.horizontal(|h| {
-                            let fmt = editor.format(token.ty());
+                            let fmt = editor.format_token(token.ty());
                             h.label(egui::text::LayoutJob::single_section(
                                 format!("{:?}", token.ty()),
                                 fmt,