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 the repl name.
032       *
033       * @return the repl name
034       */
035      String getName();
036    
037      /**
038       * Evaluate a request
039       *
040       * @param session the session
041       * @param request the request to evaluate
042       * @return the evaluation response
043       */
044      EvalResponse eval(REPLSession session, String request);
045    
046      CompletionMatch complete(REPLSession session, String prefix);
047    
048    }