001    /*
002     * Copyright (C) 2012 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    package org.crsh.repl;
020    
021    import org.crsh.cli.impl.completion.CompletionMatch;
022    
023    /**
024     * Read–eval–print loop.
025     *
026     * @author Julien Viet
027     */
028    public interface Repl {
029    
030      /**
031       * Return true if this REPL is active. Implementation can decide based on the runtime, for instance the
032       * Groovy REPL can be inactive when Groovy is not available at runtime.
033       *
034       * @return the active status
035       */
036      boolean isActive();
037    
038      /**
039       * Return the repl name.
040       *
041       * @return the repl name
042       */
043      String getName();
044    
045      /**
046       * Returns a descripton of the REPL.
047       *
048       * @return the repl description
049       */
050      String getDescription();
051    
052      /**
053       * Evaluate a request
054       *
055       * @param session the session
056       * @param request the request to evaluate
057       * @return the evaluation response
058       */
059      EvalResponse eval(ReplSession session, String request);
060    
061      /**
062       * Perform completion.
063       *
064       * @param session the session
065       * @param prefix the prefix to complete
066       * @return the completion match
067       */
068      CompletionMatch complete(ReplSession session, String prefix);
069    
070    }