Links and chars standalone

docs/source/command-sheet.rst

@@ -36,5 +36,9 @@ Below is a chart outlining the different request commands you can give and the d
         current_word: ``str`` (the word being searched for),
 
         definition_starters: ``list[tuple[str, str]]`` (list of regexes to search for and a string associated (see :doc:`examples/simple_definitions_example`))
+    * - ``LINKS_AND_CHARS``
+      - file: ``str``,
+
+        text_range: ``tuple[int, int]`` (the lower and upper line bounds (inclusively) of what text to highlight (optional))
 
 To see how to use any given one of these in more detail, visit the :doc:`examples` page! Otherwise move on to the :doc:`special-classes` page instead.

docs/source/examples/simple_links_and_hidden_chars_example.rst

@@ -0,0 +1,31 @@
+=====================================
+Simple Links And Hidden Chars Example
+=====================================
+
+.. code-block:: python
+
+    from time import sleep
+
+    from salve import IPC, LINKS_AND_CHARS, Response
+
+
+    def main():
+        context = IPC()
+
+        context.update_file(
+            "test",
+            open(__file__, "r+").read(),
+        )
+
+        context.request(LINKS_AND_CHARS, file="test", text_range=(1, 30))
+
+        sleep(1)
+        output: Response | None = context.get_response(LINKS_AND_CHARS)
+        print(output)
+        context.kill_IPC()
+
+
+    if __name__ == "__main__":
+        main()
+
+See the file example file `here <https://github.com/salve-org/salve/blob/master/examples/simple_links_and_hidden_chars_example.py>`_.

docs/source/variables.rst

@@ -28,6 +28,7 @@ The ``COMMAND`` variable is a ``str`` type alias's used to prevent spelling mist
 - ``HIGHLIGHT``
 - ``EDITORCONFIG``
 - ``DEFINITION``
+- ``LINKS_AND_CHARS``
 
 .. _Hidden Chars Overview:
 

examples/simple_links_and_hidden_chars_example.py

@@ -0,0 +1,23 @@
+from time import sleep
+
+from salve import IPC, LINKS_AND_CHARS, Response
+
+
+def main():
+    context = IPC()
+
+    context.update_file(
+        "test",
+        open(__file__, "r+").read(),
+    )
+
+    context.request(LINKS_AND_CHARS, file="test", text_range=(1, 30))
+
+    sleep(1)
+    output: Response | None = context.get_response(LINKS_AND_CHARS)
+    print(output)
+    context.kill_IPC()
+
+
+if __name__ == "__main__":
+    main()

salve/__init__.py

@@ -9,6 +9,7 @@
     DEFINITION,
     EDITORCONFIG,
     HIGHLIGHT,
+    LINKS_AND_CHARS,
     REPLACEMENTS,
     Response,
 )

salve/misc.py

@@ -10,6 +10,7 @@
     "highlight",
     "editorconfig",
     "definition",
+    "links_and_chars",
 ]
 
 COMMAND = str
@@ -18,6 +19,7 @@
 HIGHLIGHT: COMMAND = COMMANDS[2]
 EDITORCONFIG: COMMAND = COMMANDS[3]
 DEFINITION: COMMAND = COMMANDS[4]
+LINKS_AND_CHARS: COMMAND = COMMANDS[5]
 
 
 class Message(TypedDict):
@@ -35,7 +37,7 @@ class Request(Message):
     expected_keywords: NotRequired[list[str]]  # autocomplete, replacements
     current_word: NotRequired[str]  # autocomplete, replacements, definition
     language: NotRequired[str]  # highlight
-    text_range: NotRequired[tuple[int, int]]  # highlight
+    text_range: NotRequired[tuple[int, int]]  # highlight, links_and_chars
     file_path: NotRequired[Path | str]  # editorconfig
     definition_starters: NotRequired[
         list[tuple[str, str]]

salve/server.py

@@ -3,7 +3,7 @@
 from time import sleep
 
 from pyeditorconfig import get_config
-from token_tools import Token
+from token_tools import Token, normal_text_range
 
 from .misc import (
     COMMANDS,
@@ -18,6 +18,7 @@
     get_definition,
     get_highlights,
     get_replacements,
+    get_special_tokens,
 )
 
 
@@ -154,7 +155,14 @@ def handle_request(self, request: Request) -> None:
                     request["definition_starters"],  # type: ignore
                     request["current_word"],  # type: ignore
                 )
-
+            case "links_and_chars":
+                self.logger.info("Searching for Links and chars")
+                result = get_special_tokens(
+                    self.files[file],
+                    normal_text_range(self.files[file], request["text_range"])[  # type: ignore
+                        1
+                    ],
+                )
             case _:
                 self.logger.warning(f"Command {command} not recognized")
                 cancelled = True

salve/server_functions/__init__.py

@@ -1,5 +1,6 @@
 from .autocompletions import find_autocompletions  # noqa: F401
 from .definitions import get_definition  # noqa: F401
 from .highlight import get_highlights  # noqa: F401
+from .links_and_hidden_chars import get_special_tokens  # noqa: F401
 from .misc import is_unicode_letter  # noqa: F401
 from .replacements import get_replacements  # noqa: F401

salve/server_functions/highlight/highlight.py

@@ -11,7 +11,6 @@
 )
 
 from .docstring_highlight import _LexReturnTokens, proper_docstring_tokens
-from .links_and_hidden_chars import get_special_tokens
 from .misc import get_new_token_type
 
 
@@ -63,6 +62,5 @@ def get_highlights(
             new_tokens, proper_docstring_tokens(lexer, full_text)
         )
 
-    new_tokens.extend(get_special_tokens(full_text, split_text, text_range[0]))
     new_tokens = only_tokens_in_text_range(new_tokens, text_range)
     return new_tokens

salve/server_functions/highlight/links_and_hidden_chars.py → salve/server_functions/links_and_hidden_chars.py

@@ -5,13 +5,14 @@
 url_regex: Pattern = compile(r"(ftp|http|https)://[a-zA-Z0-9_-]")
 
 
-def get_urls(lines: list[str], start_line: int = 1) -> list[Token]:
-    start_pos: tuple[int, int] = (start_line, 0)
+def get_urls(whole_text: str, text_range: tuple[int, int]) -> list[Token]:
+    lines: list[str] = whole_text.splitlines()
+    start_pos: tuple[int, int] = (text_range[0], 0)
     url_toks: list[Token] = []
     while True:
-        if start_pos[0] >= len(lines) + start_line:
+        if start_pos[0] > text_range[1]:
             break
-        line: str = lines[start_pos[0] - start_line][start_pos[1] :]
+        line: str = lines[start_pos[0] - text_range[0]][start_pos[1] :]
         match_start: Match[str] | None = url_regex.search(line)
         if match_start is None:
             start_pos = (start_pos[0] + 1, 0)
@@ -95,9 +96,12 @@ def get_urls(lines: list[str], start_line: int = 1) -> list[Token]:
 }
 
 
-def find_hidden_chars(lines: list[str], start_line: int = 1) -> list[Token]:
+def find_hidden_chars(
+    whole_text: str, text_range: tuple[int, int]
+) -> list[Token]:
+    lines: list[str] = whole_text.splitlines()
     hidden_char_indexes: list[tuple[tuple[int, int], str]] = [
-        ((line_index + start_line, char_index), char)
+        ((line_index + text_range[0], char_index), char)
         for line_index, line in enumerate(lines)
         for char_index, char in enumerate(line)
         if char in list(hidden_chars.keys())
@@ -109,11 +113,11 @@ def find_hidden_chars(lines: list[str], start_line: int = 1) -> list[Token]:
 
 
 def get_special_tokens(
-    whole_text: str, split_text: list[str], start_offset: int
+    whole_text: str, text_range: tuple[int, int]
 ) -> list[Token]:
     return_tokens: list[Token] = []
-    return_tokens.extend(get_urls(split_text, start_offset))
+    return_tokens.extend(get_urls(whole_text, text_range))
     if [char for char in hidden_chars if char in whole_text]:
         # If there are no hidden chars we don't want to needlessly compute this
-        return_tokens.extend(find_hidden_chars(split_text, start_offset))
+        return_tokens.extend(find_hidden_chars(whole_text, text_range))
     return return_tokens

tests/test_ipc.py

@@ -8,6 +8,7 @@
     EDITORCONFIG,
     HIGHLIGHT,
     IPC,
+    LINKS_AND_CHARS,
     REPLACEMENTS,
     Response,
 )
@@ -48,7 +49,7 @@ def test_IPC():
             (r":?.*=.*", "before"),
         ],
     )
-
+    context.request(LINKS_AND_CHARS, file="test", text_range=(1, 18))
     sleep(1)
 
     # Check output
@@ -118,11 +119,8 @@ def test_IPC():
             ((17, 0), 3, "Name"),
             ((17, 3), 2, "Punctuation"),
             ((18, 0), 24, "Comment"),
-            ((18, 2), 22, "Link"),
-            ((5, 7), 1, "Hidden_Char"),
         ],
     }
-
     # Deal with Windows weirdness
     if platform == "win32":
         expected_output = {
@@ -162,12 +160,34 @@ def test_IPC():
                 ((17, 0), 3, "Name"),
                 ((17, 3), 2, "Punctuation"),
                 ((18, 0), 24, "Comment"),
-                ((18, 2), 22, "Link"),
             ],
         }
 
     assert highlight_output == expected_output
 
+    links_and_hidden_chars_result: Response | None = context.get_response(
+        LINKS_AND_CHARS
+    )
+    if links_and_hidden_chars_result is None:
+        raise AssertionError("links_and_hidden_chars_result output is None")
+    links_and_hidden_chars_result["id"] = 0
+    expected_output = {
+        "id": 0,
+        "type": "response",
+        "cancelled": False,
+        "command": LINKS_AND_CHARS,
+        "result": [((18, 2), 22, "Link"), ((5, 7), 1, "Hidden_Char")],
+    }
+    if platform == "win32":
+        expected_output = {
+            "id": 0,
+            "type": "response",
+            "cancelled": False,
+            "command": LINKS_AND_CHARS,
+            "result": [((18, 2), 22, "Link")],
+        }
+    assert links_and_hidden_chars_result == expected_output
+
     context.update_file(
         "foo", open(Path("tests/testing_file2.py"), "r+").read()
     )