fr.cenotelie.commons.lsp.structures.Hover Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2017 Association Cénotélie (cenotelie.fr)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 ******************************************************************************/

package fr.cenotelie.commons.lsp.structures;

import fr.cenotelie.commons.utils.Serializable;
import fr.cenotelie.commons.utils.TextUtils;
import fr.cenotelie.commons.utils.json.JsonLexer;
import fr.cenotelie.commons.utils.json.JsonParser;
import fr.cenotelie.hime.redist.ASTNode;

/**
 * The result of a hover request
 *
 * @author Laurent Wouters
 */
public class Hover implements Serializable {
    /**
     * The hover's content
     */
    private final MarkedString[] contents;
    /**
     * An optional range inside a text document that is used to visualize a hover, e.g. by changing the background color.
     */
    private final Range range;

    /**
     * Gets the hover's content
     *
     * @return The hover's content
     */
    public MarkedString[] getContents() {
        return contents;
    }

    /**
     * Gets the range inside a text document that is used to visualize a hover
     *
     * @return The range inside a text document that is used to visualize a hover
     */
    public Range getRange() {
        return range;
    }

    /**
     * Initializes this structure
     */
    public Hover() {
        this(new MarkedString[0], null);
    }

    /**
     * Initializes this structure
     *
     * @param content The hover's content
     */
    public Hover(MarkedString content) {
        this(content, null);
    }

    /**
     * Initializes this structure
     *
     * @param content The hover's content
     * @param range   The range inside a text document that is used to visualize a hover
     */
    public Hover(MarkedString content, Range range) {
        this(new MarkedString[]{content}, range);
    }

    /**
     * Initializes this structure
     *
     * @param content The hover's content
     */
    public Hover(MarkedString[] content) {
        this(content, null);
    }

    /**
     * Initializes this structure
     *
     * @param content The hover's content
     * @param range   The range inside a text document that is used to visualize a hover
     */
    public Hover(MarkedString[] content, Range range) {
        this.contents = content;
        this.range = range;
    }

    /**
     * Initializes this structure
     *
     * @param definition The serialized definition
     */
    public Hover(ASTNode definition) {
        MarkedString[] contents = null;
        Range range = null;
        for (ASTNode child : definition.getChildren()) {
            ASTNode nodeMemberName = child.getChildren().get(0);
            String name = TextUtils.unescape(nodeMemberName.getValue());
            name = name.substring(1, name.length() - 1);
            ASTNode nodeValue = child.getChildren().get(1);
            switch (name) {
                case "contents": {
                    if (nodeValue.getSymbol().getID() == JsonParser.ID.array) {
                        contents = new MarkedString[nodeValue.getChildren().size()];
                        int index = 0;
                        for (ASTNode nodeItem : nodeValue.getChildren())
                            contents[index++] = loadMarkedString(nodeItem);
                    } else {
                        contents = new MarkedString[]{loadMarkedString(nodeValue)};
                    }
                    break;
                }
                case "range": {
                    range = new Range(nodeValue);
                    break;
                }
            }
        }
        this.contents = contents == null ? new MarkedString[0] : contents;
        this.range = range;
    }

    /**
     * Loads a marked string from a serialized definition
     *
     * @param definition The serialized definition
     * @return The marked string
     */
    private static MarkedString loadMarkedString(ASTNode definition) {
        switch (definition.getSymbol().getID()) {
            case JsonLexer.ID.LITERAL_STRING:
                return new MarkedStringMarkdown(definition);
            case JsonParser.ID.object:
                return new MarkedStringCodeBlock(definition);
        }
        return null;
    }

    @Override
    public String serializedString() {
        return serializedJSON();
    }

    @Override
    public String serializedJSON() {
        StringBuilder builder = new StringBuilder();
        builder.append("{\"contents\": ");
        if (contents.length == 0)
            builder.append("[]");
        else if (contents.length == 1)
            builder.append(contents[0].serializedJSON());
        else {
            builder.append("[");
            for (int i = 0; i != contents.length; i++) {
                if (i == 0)
                    builder.append(", ");
                builder.append(contents[i].serializedJSON());
            }
            builder.append("]");
        }
        if (range != null) {
            builder.append(", \"range\": ");
            builder.append(range.serializedJSON());
        }
        builder.append("}");
        return builder.toString();
    }
}