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.lang.spi; 020 021 import org.crsh.cli.impl.completion.CompletionMatch; 022 import org.crsh.shell.impl.command.ShellSession; 023 024 /** 025 * Read–eval–print loop. 026 * 027 * @author Julien Viet 028 */ 029 public interface Repl { 030 031 /** 032 * @return the language this repl belongs to 033 */ 034 Language getLanguage(); 035 036 /** 037 * @return a descripton of the Repl 038 */ 039 String getDescription(); 040 041 /** 042 * Evaluate a request. 043 * 044 * @param session the session 045 * @param request the request to evaluate 046 * @return the evaluation response 047 */ 048 ReplResponse eval(ShellSession session, String request); 049 050 /** 051 * Perform completion. 052 * 053 * @param session the session 054 * @param prefix the prefix to complete 055 * @return the completion match 056 */ 057 CompletionMatch complete(ShellSession session, String prefix); 058 059 }