Elixir Code.Fragment.cursor_context用法及代码示例

@spec cursor_context(
  List.Chars.t(),
  keyword()
) ::
  {:alias, charlist()}
  | {:dot, inside_dot, charlist()}
  | {:dot_arity, inside_dot, charlist()}
  | {:dot_call, inside_dot, charlist()}
  | :expr
  | {:local_or_var, charlist()}
  | {:local_arity, charlist()}
  | {:local_call, charlist()}
  | {:module_attribute, charlist()}
  | {:operator, charlist()}
  | {:operator_arity, charlist()}
  | {:operator_call, charlist()}
  | :none
  | {:sigil, charlist()}
  | {:struct, charlist()}
  | {:unquoted_atom, charlist()}
when inside_dot:
       {:alias, charlist()}
       | {:dot, inside_dot, charlist()}
       | {:module_attribute, charlist()}
       | {:unquoted_atom, charlist()}
       | {:var, charlist()}

接收一个字符串并返回游标上下文。

此函数接收带有 Elixir 代码片段的字符串，表示光标位置，并基于该字符串提供有关所述位置的上下文信息。然后可以使用此函数的返返回提供提示、建议和自动完成函数。

此函数提供了尽力而为的检测，并且可能并非在所有情况下都准确。请参阅下面的"Limitations" 部分。

考虑在处理此函数的返回类型时添加 catch-all 子句，因为新的游标信息可能会在未来版本中添加。

例子

iex> Code.Fragment.cursor_context("")
:expr

iex> Code.Fragment.cursor_context("hello_wor")
{:local_or_var, 'hello_wor'}

返回值

• {:alias, charlist} - 上下文是别名，可能是嵌套的，例如 Hello.Wor 或 HelloWor

• {:dot, inside_dot, charlist} - 上下文是一个点，其中 inside_dot 是 {:var, charlist} 、 {:alias, charlist} 、 {:module_attribute, charlist} 、 {:unquoted_atom, charlist} 或 dot 本身。如果给出了 var，这可能是远程调用或映射字段访问。例如 Hello.wor 、 :hello.wor 、 hello.wor 、 Hello.nested.wor 、 hello.nested.wor 和 @hello.world

• {:dot_arity, inside_dot, charlist} - 上下文是一个点，其中 inside_dot 是 {:var, charlist} 、 {:alias, charlist} 、 {:module_attribute, charlist} 、 {:unquoted_atom, charlist} 或 dot 本身。如果给出了一个 var，它必须是一个远程的 arity。例如 Hello.world/ 、 :hello.world/ 、 hello.world/2 和 @hello.world/2

• {:dot_call, inside_dot, charlist} - 上下文是一个点调用。这意味着在表达式之后添加了括号或空格。其中 inside_dot 是 {:var, charlist} 、 {:alias, charlist} 、 {:module_attribute, charlist} 、 {:unquoted_atom, charlist} 或 dot 本身。如果给出了 var，则它必须是远程调用。例如 Hello.world( 、 :hello.world( 、 Hello.world 、 hello.world( 、 hello.world 和 @hello.world(

• :expr - 可以是任何表达式。自动完成可能会建议一个别名、本地或 var

• {:local_or_var, charlist} - 上下文是变量或本地(导入或本地)调用，例如 hello_wor

• {:local_arity, charlist} - 上下文是本地(导入或本地)arity，例如 hello_world/

• {:local_call, charlist} - 上下文是本地(导入或本地)调用，例如 hello_world( 和 hello_world

• {:module_attribute, charlist} - 上下文是模块属性，例如@hello_wor

• {:operator, charlist} - 上下文是一个运算符，例如 + 或 == 。请注意文本运算符，例如 when 不会显示为运算符，而是显示为 :local_or_var 。 @ 永远不是 :operator 并且始终是 :module_attribute

• {:operator_arity, charlist} - 上下文是一个运算符，它是一个后跟 /的运算符，例如 +/ 、 not/ 或 when/

• {:operator_call, charlist} - 上下文是一个运算符调用，它是一个运算符后跟空格，例如 left + 、 not 或 x when

• :none - 没有上下文可能

• {:sigil, charlist} - 上下文是一个印记。它可以是符号的开头，例如 ~ 或 ~s ，也可以是以 ~ 开头的运算符，例如 ~> 和 ~>>

• {:struct, charlist} - 上下文是一个结构，例如 % 、 %UR 或 %URI

• {:unquoted_atom, charlist} - 上下文是一个未引用的原子。这可以是任何原子或表示模块的原子

限制

当前算法只考虑输入的最后一行。这意味着它还将在字符串、heredocs 等中显示建议，这是有意的，因为它有助于文档测试、引用等。