One entry of a completion list. More...

#include <undoAppSTSemantic.hpp>

Collaboration diagram for undoApp::ST::Suggestion:

Public Types
enum class	Kind { Parameter , State , Method , Constant , Function , Block , Type , Enumerator }
	What kind of thing this is, which is also what its colour means. More...

Public Member Functions
bool	matches (const std::string &prefix) const
	True when the pattern occurs in this name, fuzzily and case-insensitively.

Public Attributes
std::string	name
	Identifier as spelled in the source.

std::string	typeText
	Declared type, or the return type of a method.

Kind	kind = Kind::State

bool	isConstant = false

bool	isRetain = false

bool	isAbstract = false

bool	isOverride = false

bool	inherited = false
	Declared by a base block, not by this one.

std::string	declaredIn
	Base block name, set when inherited.

std::vector< std::string >	parameterTypes
	Method parameter types, for display.

std::vector< std::string >	parameterNames
	Method parameter names, for signature help.

std::vector< std::string >	parameterDirs
	"IN", "OUT" or "IN_OUT", empty when unknown

std::string	note
	Short remark after the name, such as "given".

std::vector< int >	matchPositions
	Indices of `name` that the last `matches` call matched, for highlighting.

Detailed Description

One entry of a completion list.

The same struct carries both kinds of completion: the members reachable through a '.' on a function block instance, and the plain names visible from where the caret is. They are shown in the same list, filtered and ranked the same way, so they share a type; only the set of Kind values is wider than a member needs.

Member Enumeration Documentation

◆ Kind

enum class undoApp::ST::Suggestion::Kind

strong

What kind of thing this is, which is also what its colour means.

Enumerator
Parameter	VAR_INPUT / VAR_OUTPUT / VAR_IN_OUT.
State	VAR / VAR_TEMP / VAR RETAIN.
Method	METHOD.
Constant	VAR CONSTANT.
Function	FUNCTION.
Block	A FUNCTION_BLOCK instance, or the block's type name.
Type	A type name.
Enumerator	An enumerator of an enum.

Member Function Documentation

◆ matches()

bool undoApp::ST::Suggestion::matches ( const std::string & prefix ) const

True when the pattern occurs in this name, fuzzily and case-insensitively.

Member Data Documentation

◆ declaredIn

std::string undoApp::ST::Suggestion::declaredIn

Base block name, set when inherited.

◆ inherited

bool undoApp::ST::Suggestion::inherited = false

Declared by a base block, not by this one.

◆ isAbstract

bool undoApp::ST::Suggestion::isAbstract = false

◆ isConstant

bool undoApp::ST::Suggestion::isConstant = false

◆ isOverride

bool undoApp::ST::Suggestion::isOverride = false

◆ isRetain

bool undoApp::ST::Suggestion::isRetain = false

◆ kind

Kind undoApp::ST::Suggestion::kind = Kind::State

◆ matchPositions

std::vector<int> undoApp::ST::Suggestion::matchPositions

Indices of name that the last matches call matched, for highlighting.

◆ name

std::string undoApp::ST::Suggestion::name

Identifier as spelled in the source.

◆ note

std::string undoApp::ST::Suggestion::note

Short remark after the name, such as "given".

◆ parameterDirs

std::vector<std::string> undoApp::ST::Suggestion::parameterDirs

"IN", "OUT" or "IN_OUT", empty when unknown

◆ parameterNames

std::vector<std::string> undoApp::ST::Suggestion::parameterNames

Method parameter names, for signature help.

◆ parameterTypes

std::vector<std::string> undoApp::ST::Suggestion::parameterTypes

Method parameter types, for display.

◆ typeText

std::string undoApp::ST::Suggestion::typeText

Declared type, or the return type of a method.

The documentation for this struct was generated from the following file:

undoApps/undoApp.Editor/include/undoAppSTSemantic.hpp

Public Types

Public Member Functions

Public Attributes