/**
 * This file is part of DCD, a development tool for the D programming language.
 * Copyright (C) 2013 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 messages;

/**
 * Identifies the kind of the item in an identifier completion list
 */
enum CompletionKind : char
{
    /// Invalid completion kind. This is used internally and will never
    /// be returned in a completion response.
    dummy = '?',

    /// class names
    className = 'c',

    /// interface names
    interfaceName = 'i',

    /// structure names
    structName = 's',

	/// union name
	unionName = 'u',

    /// variable name
    variableName = 'v',

    /// member variable
    memberVariableName = 'm',

    /// keyword, built-in version, scope statement
    keyword = 'k',

    /// function or method
    functionName = 'f',

    /// enum name
    enumName = 'g',

	/// enum member
    enumMember = 'e',

    /// package name
    packageName = 'P',

    /// module name
    moduleName = 'M',

	/// array
	array = 'a',

	/// associative array
	assocArray = 'A',

	/// alias name
	aliasName = 'l',

	/// template name
	templateName = 't',

	/// mixin template name
	mixinTemplateName = 'T'
}

/**
 * The type of completion list being returned
 */
enum CompletionType : string
{
    /**
     * The completion list contains a listing of identifier/kind pairs.
     */
    identifiers = "identifiers",

    /**
     * The auto-completion list consists of a listing of functions and their
     * parameters.
     */
    calltips = "calltips",

    /**
     * The response contains the location of a symbol declaration.
     */
    location = "location"
}

/**
 * Request kind
 */
enum RequestKind : ubyte
{
	/// Autocompletion
	autocomplete,
	/// Clear the completion cache
	clearCache,
	/// Add import directory to server
	addImport,
	/// Shut down the server
	shutdown,
	/// Get declaration location of given symbol
	symbolLocation
}

/**
 * Autocompletion request message
 */
struct AutocompleteRequest
{
    /**
     * File name used for error reporting
     */
    string fileName;

	/**
	 * Command coming from the client
	 */
	RequestKind kind;

    /**
     * Paths to be searched for import files
     */
    string[] importPaths;

    /**
     * The source code to auto complete
     */
    ubyte[] sourceCode;

    /**
     * The cursor position
     */
    size_t cursorPosition;
}

/**
 * Autocompletion response message
 */
struct AutocompleteResponse
{
    /**
     * The autocompletion type. (Parameters or identifier)
     */
    string completionType;

    /**
     * The path to the file that contains the symbol.
     */
    string symbolFilePath;

    /**
     * The byte offset at which the symbol is located.
     */
    size_t symbolLocation;

    /**
     * The completions
     */
    string[] completions;

    /**
     * The kinds of the items in the completions array. Will be empty if the
     * completion type is a function argument list.
     */
    char[] completionKinds;
}