DCD/src/dcd/server/autocomplete/doc.d
2022-10-13 18:18:53 +02:00

73 lines
2.2 KiB
D

/**
* This file is part of DCD, a development tool for the D programming language.
* Copyright (C) 2014 Brian Schott
*
* 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 <http://www.gnu.org/licenses/>.
*/
module dcd.server.autocomplete.doc;
import std.algorithm;
import std.array;
import std.experimental.allocator;
import std.experimental.logger;
import std.typecons;
import dcd.server.autocomplete.util;
import dparse.lexer;
import dparse.rollback_allocator;
import dsymbol.modulecache;
import dcd.common.messages;
/**
* Gets documentation for the symbol at the cursor
* Params:
* request = the autocompletion request
* Returns:
* the autocompletion response
*/
public AutocompleteResponse getDoc(const AutocompleteRequest request,
ref ModuleCache moduleCache)
{
// trace("Getting doc comments");
AutocompleteResponse response;
RollbackAllocator rba;
scope allocator = new ASTAllocator();
auto cache = StringCache(request.sourceCode.length.optimalBucketCount);
SymbolStuff stuff = getSymbolsForCompletion(request, CompletionType.ddoc,
allocator.allocatorObject, &rba, cache, moduleCache);
if (stuff.symbols.length == 0)
warning("Could not find symbol");
else
{
// first symbol allows ditto if it's the first documentation,
// because then it takes documentation from a symbol with different name
// which isn't inside the stuff.symbols range.
bool firstSymbol = true;
foreach(ref symbol; stuff.symbols.filter!(a => !a.doc.empty))
{
if (!firstSymbol && symbol.doc.ditto)
continue;
firstSymbol = false;
AutocompleteResponse.Completion c;
c.documentation = symbol.doc;
response.completions ~= c;
}
}
return response;
}