dsymbol.symbol

This file is part of DCD, a development tool for the D programming language. Copyright (C) 2014 Brian Schott

Discussion

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see .

  • CompletionKind

    Declaration

    enum CompletionKind: char;

    Identifies the kind of the item in an identifier completion list

    • dummy

      Declaration

      dummy

      Invalid completion kind. This is used internally and will never be returned in a completion response.

    • importSymbol

      Declaration

      importSymbol

      Import symbol. This is used internally and will never be returned in a completion response.

    • withSymbol

      Declaration

      withSymbol

      With symbol. This is used internally and will never be returned in a completion response.

    • className

      Declaration

      className

      class names

    • interfaceName

      Declaration

      interfaceName

      interface names

    • structName

      Declaration

      structName

      structure names

    • unionName

      Declaration

      unionName

      union name

    • variableName

      Declaration

      variableName

      variable name

    • memberVariableName

      Declaration

      memberVariableName

      member variable

    • keyword

      Declaration

      keyword

      keyword, built-in version, scope statement

    • functionName

      Declaration

      functionName

      function or method

    • enumName

      Declaration

      enumName

      enum name

    • enumMember

      Declaration

      enumMember

      enum member

    • packageName

      Declaration

      packageName

      package name

    • moduleName

      Declaration

      moduleName

      module name

    • aliasName

      Declaration

      aliasName

      alias name

    • templateName

      Declaration

      templateName

      template name

    • mixinTemplateName

      Declaration

      mixinTemplateName

      mixin template name

  • isPublicCompletionKind

    Declaration

    pure nothrow @nogc @safe bool isPublicCompletionKind(CompletionKind kind);

    Return Value

    true if kind is something that can be returned to the client

  • SymbolQualifier

    Declaration

    enum SymbolQualifier: ubyte;

    Any special information about a variable declaration symbol.

    • none

      Declaration

      none

      None

    • array

      Declaration

      array

      The symbol is an array

    • assocArray

      Declaration

      assocArray

      The symbol is a associative array

    • func

      Declaration

      func

      The symbol is a function or delegate pointer

    • selectiveImport

      Declaration

      selectiveImport

      Selective import

  • DSymbol

    Declaration

    struct DSymbol;

    Autocompletion symbol

    • this

      Declaration

      this();
      this(istring name);

      Copying is disabled.

    • this

      Declaration

      this(string name, CompletionKind kind);
      this(istring name, CompletionKind kind);

      Parameters

      string name

      the symbol's name

      CompletionKind kind

      the symbol's completion kind

    • this

      Declaration

      this(string name, CompletionKind kind, DSymbol* type);
      this(istring name, CompletionKind kind, DSymbol* type);

      Parameters

      string name

      the symbol's name

      CompletionKind kind

      the symbol's completion kind

      resolvedType

      the resolved type of the symbol

    • getPartsByName

      Declaration

      inout inout(DSymbol)*[] getPartsByName(istring name);

      Gets all parts whose name matches the given string.

    • getParts

      Declaration

      inout void getParts(OR)(istring name, ref OR app, ref HashSet!size_t visited, bool onlyOne = false) if (isOutputRange!(OR, DSymbol*));

      Gets all parts and imported parts. Filters based on the part's name if the name argument is not null. Stores results in app.

    • opSlice

      Declaration

      inout inout(DSymbol)*[] opSlice(this This)();

      Return Value

      a range over this symbol's parts and publicly visible imports

    • updateTypes

      Declaration

      void updateTypes(ref UpdatePairCollection collection);

      Updates the type field based on the mappings contained in the given collection.

    • name

      Declaration

      istring name;

      DSymbol's name

    • callTip

      Declaration

      istring callTip;

      Calltip to display if this is a function

    • altFile

      Declaration

      alias altFile = callTip;

      Used for storing information for selective renamed imports

    • symbolFile

      Declaration

      istring symbolFile;

      Module containing the symbol.

    • doc

      Declaration

      istring doc;

      Documentation for the symbol.

    • type

      Declaration

      DSymbol* type;

      The symbol that represents the type.

    • argNames

      Declaration

      UnrolledList!istring argNames;

      Names of function arguments

    • location

      Declaration

      const pure nothrow @nogc @property @safe size_t location();

      DSymbol location

    • kind

      Declaration

      CompletionKind kind;

      The kind of symbol

    • qualifier

      Declaration

      SymbolQualifier qualifier;

      DSymbol qualifier